1*5113495bSYour Name /* 2*5113495bSYour Name * Copyright (c) 2017 The Linux Foundation. All rights reserved. 3*5113495bSYour Name * 4*5113495bSYour Name * Permission to use, copy, modify, and/or distribute this software for 5*5113495bSYour Name * any purpose with or without fee is hereby granted, provided that the 6*5113495bSYour Name * above copyright notice and this permission notice appear in all 7*5113495bSYour Name * copies. 8*5113495bSYour Name * 9*5113495bSYour Name * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL 10*5113495bSYour Name * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED 11*5113495bSYour Name * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE 12*5113495bSYour Name * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL 13*5113495bSYour Name * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR 14*5113495bSYour Name * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER 15*5113495bSYour Name * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR 16*5113495bSYour Name * PERFORMANCE OF THIS SOFTWARE. 17*5113495bSYour Name */ 18*5113495bSYour Name 19*5113495bSYour Name #ifndef _RECEIVE_USER_INFO_H_ 20*5113495bSYour Name #define _RECEIVE_USER_INFO_H_ 21*5113495bSYour Name #if !defined(__ASSEMBLER__) 22*5113495bSYour Name #endif 23*5113495bSYour Name 24*5113495bSYour Name 25*5113495bSYour Name // ################ START SUMMARY ################# 26*5113495bSYour Name // 27*5113495bSYour Name // Dword Fields 28*5113495bSYour Name // 0 phy_ppdu_id[15:0], user_rssi[23:16], pkt_type[27:24], stbc[28], sgi[30:29], reserved_0[31] 29*5113495bSYour Name // 1 rate_mcs[3:0], reception_type[5:4], receive_bandwidth[7:6], mimo_ss_bitmap[15:8], user_ru_allocation[23:16], nss[26:24], reserved_1b[31:27] 30*5113495bSYour Name // 31*5113495bSYour Name // ################ END SUMMARY ################# 32*5113495bSYour Name 33*5113495bSYour Name #define NUM_OF_DWORDS_RECEIVE_USER_INFO 2 34*5113495bSYour Name 35*5113495bSYour Name struct receive_user_info { 36*5113495bSYour Name uint32_t phy_ppdu_id : 16, //[15:0] 37*5113495bSYour Name user_rssi : 8, //[23:16] 38*5113495bSYour Name pkt_type : 4, //[27:24] 39*5113495bSYour Name stbc : 1, //[28] 40*5113495bSYour Name sgi : 2, //[30:29] 41*5113495bSYour Name reserved_0 : 1; //[31] 42*5113495bSYour Name uint32_t rate_mcs : 4, //[3:0] 43*5113495bSYour Name reception_type : 2, //[5:4] 44*5113495bSYour Name receive_bandwidth : 2, //[7:6] 45*5113495bSYour Name mimo_ss_bitmap : 8, //[15:8] 46*5113495bSYour Name user_ru_allocation : 8, //[23:16] 47*5113495bSYour Name nss : 3, //[26:24] 48*5113495bSYour Name reserved_1b : 5; //[31:27] 49*5113495bSYour Name }; 50*5113495bSYour Name 51*5113495bSYour Name /* 52*5113495bSYour Name 53*5113495bSYour Name phy_ppdu_id 54*5113495bSYour Name 55*5113495bSYour Name A ppdu counter value that PHY increments for every PPDU 56*5113495bSYour Name received. The counter value wraps around 57*5113495bSYour Name 58*5113495bSYour Name <legal all> 59*5113495bSYour Name 60*5113495bSYour Name user_rssi 61*5113495bSYour Name 62*5113495bSYour Name RSSI for this user 63*5113495bSYour Name 64*5113495bSYour Name Frequency domain RSSI measurement for this user. Based 65*5113495bSYour Name on the channel estimate. 66*5113495bSYour Name 67*5113495bSYour Name 68*5113495bSYour Name 69*5113495bSYour Name If PHY implementation runs into difficulties, the backup 70*5113495bSYour Name is to reuse the previously notified RSSI values. 71*5113495bSYour Name 72*5113495bSYour Name TODO PHY: request to update the text here based on the 73*5113495bSYour Name latest design insights 74*5113495bSYour Name 75*5113495bSYour Name 76*5113495bSYour Name 77*5113495bSYour Name <legal all> 78*5113495bSYour Name 79*5113495bSYour Name pkt_type 80*5113495bSYour Name 81*5113495bSYour Name Packet type: 82*5113495bSYour Name 83*5113495bSYour Name 84*5113495bSYour Name 85*5113495bSYour Name <enum 0 dot11a>802.11a PPDU type 86*5113495bSYour Name 87*5113495bSYour Name <enum 1 dot11b>802.11b PPDU type 88*5113495bSYour Name 89*5113495bSYour Name <enum 2 dot11n_mm>802.11n Mixed Mode PPDU type 90*5113495bSYour Name 91*5113495bSYour Name <enum 3 dot11ac>802.11ac PPDU type 92*5113495bSYour Name 93*5113495bSYour Name <enum 4 dot11ax>802.11ax PPDU type 94*5113495bSYour Name 95*5113495bSYour Name stbc 96*5113495bSYour Name 97*5113495bSYour Name When set, use STBC transmission rates 98*5113495bSYour Name 99*5113495bSYour Name sgi 100*5113495bSYour Name 101*5113495bSYour Name Field only valid when pkt type is HT, VHT or HE. 102*5113495bSYour Name 103*5113495bSYour Name 104*5113495bSYour Name 105*5113495bSYour Name <enum 0 gi_0_8_us > Legacy normal GI 106*5113495bSYour Name 107*5113495bSYour Name <enum 1 gi_0_4_us > Legacy short GI 108*5113495bSYour Name 109*5113495bSYour Name <enum 2 gi_1_6_us > HE related GI 110*5113495bSYour Name 111*5113495bSYour Name <enum 3 gi_3_2_us > HE related GI 112*5113495bSYour Name 113*5113495bSYour Name <legal 0 - 3> 114*5113495bSYour Name 115*5113495bSYour Name reserved_0 116*5113495bSYour Name 117*5113495bSYour Name <legal 0> 118*5113495bSYour Name 119*5113495bSYour Name rate_mcs 120*5113495bSYour Name 121*5113495bSYour Name For details, refer to MCS_TYPE description 122*5113495bSYour Name 123*5113495bSYour Name <legal all> 124*5113495bSYour Name 125*5113495bSYour Name reception_type 126*5113495bSYour Name 127*5113495bSYour Name Indicates what type of reception this is. 128*5113495bSYour Name 129*5113495bSYour Name <enum 0 reception_type_SU > 130*5113495bSYour Name 131*5113495bSYour Name <enum 1 reception_type_MU_MIMO > 132*5113495bSYour Name 133*5113495bSYour Name <enum 2 reception_type_MU_OFDMA > 134*5113495bSYour Name 135*5113495bSYour Name <enum 3 reception_type_MU_OFDMA_MIMO > 136*5113495bSYour Name 137*5113495bSYour Name <legal all> 138*5113495bSYour Name 139*5113495bSYour Name receive_bandwidth 140*5113495bSYour Name 141*5113495bSYour Name Full receive Bandwidth 142*5113495bSYour Name 143*5113495bSYour Name 144*5113495bSYour Name 145*5113495bSYour Name <enum 0 full_rx_bw_20_mhz> 146*5113495bSYour Name 147*5113495bSYour Name <enum 1 full_rx_bw_40_mhz> 148*5113495bSYour Name 149*5113495bSYour Name <enum 2 full_rx_bw_80_mhz> 150*5113495bSYour Name 151*5113495bSYour Name <enum 3 full_rx_bw_160_mhz> 152*5113495bSYour Name 153*5113495bSYour Name 154*5113495bSYour Name 155*5113495bSYour Name <legal 0-3> 156*5113495bSYour Name 157*5113495bSYour Name mimo_ss_bitmap 158*5113495bSYour Name 159*5113495bSYour Name Field only valid in case of MIMO type reception 160*5113495bSYour Name 161*5113495bSYour Name 162*5113495bSYour Name 163*5113495bSYour Name Bitmap, with each bit indicating if the related spatial 164*5113495bSYour Name stream is used for this STA 165*5113495bSYour Name 166*5113495bSYour Name LSB related to SS 0 167*5113495bSYour Name 168*5113495bSYour Name 169*5113495bSYour Name 170*5113495bSYour Name 0: spatial stream not used for this reception 171*5113495bSYour Name 172*5113495bSYour Name 1: spatial stream used for this reception 173*5113495bSYour Name 174*5113495bSYour Name 175*5113495bSYour Name 176*5113495bSYour Name <legal all> 177*5113495bSYour Name 178*5113495bSYour Name user_ru_allocation 179*5113495bSYour Name 180*5113495bSYour Name Field only valid in case of OFDMA uplink type reception 181*5113495bSYour Name 182*5113495bSYour Name 183*5113495bSYour Name 184*5113495bSYour Name Indicates the RU number for this user 185*5113495bSYour Name 186*5113495bSYour Name <legal 0-73> 187*5113495bSYour Name 188*5113495bSYour Name nss 189*5113495bSYour Name 190*5113495bSYour Name Number of Spatial Streams occupied by the User 191*5113495bSYour Name 192*5113495bSYour Name <enum 0 1_spatial_stream>Single spatial stream 193*5113495bSYour Name 194*5113495bSYour Name <enum 1 2_spatial_streams>2 spatial streams 195*5113495bSYour Name 196*5113495bSYour Name <enum 2 3_spatial_streams>3 spatial streams 197*5113495bSYour Name 198*5113495bSYour Name <enum 3 4_spatial_streams>4 spatial streams 199*5113495bSYour Name 200*5113495bSYour Name <enum 4 5_spatial_streams>5 spatial streams 201*5113495bSYour Name 202*5113495bSYour Name <enum 5 6_spatial_streams>6 spatial streams 203*5113495bSYour Name 204*5113495bSYour Name <enum 6 7_spatial_streams>7 spatial streams 205*5113495bSYour Name 206*5113495bSYour Name <enum 7 8_spatial_streams>8 spatial streams 207*5113495bSYour Name 208*5113495bSYour Name reserved_1b 209*5113495bSYour Name 210*5113495bSYour Name <legal 0> 211*5113495bSYour Name */ 212*5113495bSYour Name 213*5113495bSYour Name 214*5113495bSYour Name /* Description RECEIVE_USER_INFO_0_PHY_PPDU_ID 215*5113495bSYour Name 216*5113495bSYour Name A ppdu counter value that PHY increments for every PPDU 217*5113495bSYour Name received. The counter value wraps around 218*5113495bSYour Name 219*5113495bSYour Name <legal all> 220*5113495bSYour Name */ 221*5113495bSYour Name #define RECEIVE_USER_INFO_0_PHY_PPDU_ID_OFFSET 0x00000000 222*5113495bSYour Name #define RECEIVE_USER_INFO_0_PHY_PPDU_ID_LSB 0 223*5113495bSYour Name #define RECEIVE_USER_INFO_0_PHY_PPDU_ID_MASK 0x0000ffff 224*5113495bSYour Name 225*5113495bSYour Name /* Description RECEIVE_USER_INFO_0_USER_RSSI 226*5113495bSYour Name 227*5113495bSYour Name RSSI for this user 228*5113495bSYour Name 229*5113495bSYour Name Frequency domain RSSI measurement for this user. Based 230*5113495bSYour Name on the channel estimate. 231*5113495bSYour Name 232*5113495bSYour Name 233*5113495bSYour Name 234*5113495bSYour Name If PHY implementation runs into difficulties, the backup 235*5113495bSYour Name is to reuse the previously notified RSSI values. 236*5113495bSYour Name 237*5113495bSYour Name TODO PHY: request to update the text here based on the 238*5113495bSYour Name latest design insights 239*5113495bSYour Name 240*5113495bSYour Name 241*5113495bSYour Name 242*5113495bSYour Name <legal all> 243*5113495bSYour Name */ 244*5113495bSYour Name #define RECEIVE_USER_INFO_0_USER_RSSI_OFFSET 0x00000000 245*5113495bSYour Name #define RECEIVE_USER_INFO_0_USER_RSSI_LSB 16 246*5113495bSYour Name #define RECEIVE_USER_INFO_0_USER_RSSI_MASK 0x00ff0000 247*5113495bSYour Name 248*5113495bSYour Name /* Description RECEIVE_USER_INFO_0_PKT_TYPE 249*5113495bSYour Name 250*5113495bSYour Name Packet type: 251*5113495bSYour Name 252*5113495bSYour Name 253*5113495bSYour Name 254*5113495bSYour Name <enum 0 dot11a>802.11a PPDU type 255*5113495bSYour Name 256*5113495bSYour Name <enum 1 dot11b>802.11b PPDU type 257*5113495bSYour Name 258*5113495bSYour Name <enum 2 dot11n_mm>802.11n Mixed Mode PPDU type 259*5113495bSYour Name 260*5113495bSYour Name <enum 3 dot11ac>802.11ac PPDU type 261*5113495bSYour Name 262*5113495bSYour Name <enum 4 dot11ax>802.11ax PPDU type 263*5113495bSYour Name */ 264*5113495bSYour Name #define RECEIVE_USER_INFO_0_PKT_TYPE_OFFSET 0x00000000 265*5113495bSYour Name #define RECEIVE_USER_INFO_0_PKT_TYPE_LSB 24 266*5113495bSYour Name #define RECEIVE_USER_INFO_0_PKT_TYPE_MASK 0x0f000000 267*5113495bSYour Name 268*5113495bSYour Name /* Description RECEIVE_USER_INFO_0_STBC 269*5113495bSYour Name 270*5113495bSYour Name When set, use STBC transmission rates 271*5113495bSYour Name */ 272*5113495bSYour Name #define RECEIVE_USER_INFO_0_STBC_OFFSET 0x00000000 273*5113495bSYour Name #define RECEIVE_USER_INFO_0_STBC_LSB 28 274*5113495bSYour Name #define RECEIVE_USER_INFO_0_STBC_MASK 0x10000000 275*5113495bSYour Name 276*5113495bSYour Name /* Description RECEIVE_USER_INFO_0_SGI 277*5113495bSYour Name 278*5113495bSYour Name Field only valid when pkt type is HT, VHT or HE. 279*5113495bSYour Name 280*5113495bSYour Name 281*5113495bSYour Name 282*5113495bSYour Name <enum 0 gi_0_8_us > Legacy normal GI 283*5113495bSYour Name 284*5113495bSYour Name <enum 1 gi_0_4_us > Legacy short GI 285*5113495bSYour Name 286*5113495bSYour Name <enum 2 gi_1_6_us > HE related GI 287*5113495bSYour Name 288*5113495bSYour Name <enum 3 gi_3_2_us > HE related GI 289*5113495bSYour Name 290*5113495bSYour Name <legal 0 - 3> 291*5113495bSYour Name */ 292*5113495bSYour Name #define RECEIVE_USER_INFO_0_SGI_OFFSET 0x00000000 293*5113495bSYour Name #define RECEIVE_USER_INFO_0_SGI_LSB 29 294*5113495bSYour Name #define RECEIVE_USER_INFO_0_SGI_MASK 0x60000000 295*5113495bSYour Name 296*5113495bSYour Name /* Description RECEIVE_USER_INFO_0_RESERVED_0 297*5113495bSYour Name 298*5113495bSYour Name <legal 0> 299*5113495bSYour Name */ 300*5113495bSYour Name #define RECEIVE_USER_INFO_0_RESERVED_0_OFFSET 0x00000000 301*5113495bSYour Name #define RECEIVE_USER_INFO_0_RESERVED_0_LSB 31 302*5113495bSYour Name #define RECEIVE_USER_INFO_0_RESERVED_0_MASK 0x80000000 303*5113495bSYour Name 304*5113495bSYour Name /* Description RECEIVE_USER_INFO_1_RATE_MCS 305*5113495bSYour Name 306*5113495bSYour Name For details, refer to MCS_TYPE description 307*5113495bSYour Name 308*5113495bSYour Name <legal all> 309*5113495bSYour Name */ 310*5113495bSYour Name #define RECEIVE_USER_INFO_1_RATE_MCS_OFFSET 0x00000004 311*5113495bSYour Name #define RECEIVE_USER_INFO_1_RATE_MCS_LSB 0 312*5113495bSYour Name #define RECEIVE_USER_INFO_1_RATE_MCS_MASK 0x0000000f 313*5113495bSYour Name 314*5113495bSYour Name /* Description RECEIVE_USER_INFO_1_RECEPTION_TYPE 315*5113495bSYour Name 316*5113495bSYour Name Indicates what type of reception this is. 317*5113495bSYour Name 318*5113495bSYour Name <enum 0 reception_type_SU > 319*5113495bSYour Name 320*5113495bSYour Name <enum 1 reception_type_MU_MIMO > 321*5113495bSYour Name 322*5113495bSYour Name <enum 2 reception_type_MU_OFDMA > 323*5113495bSYour Name 324*5113495bSYour Name <enum 3 reception_type_MU_OFDMA_MIMO > 325*5113495bSYour Name 326*5113495bSYour Name <legal all> 327*5113495bSYour Name */ 328*5113495bSYour Name #define RECEIVE_USER_INFO_1_RECEPTION_TYPE_OFFSET 0x00000004 329*5113495bSYour Name #define RECEIVE_USER_INFO_1_RECEPTION_TYPE_LSB 4 330*5113495bSYour Name #define RECEIVE_USER_INFO_1_RECEPTION_TYPE_MASK 0x00000030 331*5113495bSYour Name 332*5113495bSYour Name /* Description RECEIVE_USER_INFO_1_RECEIVE_BANDWIDTH 333*5113495bSYour Name 334*5113495bSYour Name Full receive Bandwidth 335*5113495bSYour Name 336*5113495bSYour Name 337*5113495bSYour Name 338*5113495bSYour Name <enum 0 full_rx_bw_20_mhz> 339*5113495bSYour Name 340*5113495bSYour Name <enum 1 full_rx_bw_40_mhz> 341*5113495bSYour Name 342*5113495bSYour Name <enum 2 full_rx_bw_80_mhz> 343*5113495bSYour Name 344*5113495bSYour Name <enum 3 full_rx_bw_160_mhz> 345*5113495bSYour Name 346*5113495bSYour Name 347*5113495bSYour Name 348*5113495bSYour Name <legal 0-3> 349*5113495bSYour Name */ 350*5113495bSYour Name #define RECEIVE_USER_INFO_1_RECEIVE_BANDWIDTH_OFFSET 0x00000004 351*5113495bSYour Name #define RECEIVE_USER_INFO_1_RECEIVE_BANDWIDTH_LSB 6 352*5113495bSYour Name #define RECEIVE_USER_INFO_1_RECEIVE_BANDWIDTH_MASK 0x000000c0 353*5113495bSYour Name 354*5113495bSYour Name /* Description RECEIVE_USER_INFO_1_MIMO_SS_BITMAP 355*5113495bSYour Name 356*5113495bSYour Name Field only valid in case of MIMO type reception 357*5113495bSYour Name 358*5113495bSYour Name 359*5113495bSYour Name 360*5113495bSYour Name Bitmap, with each bit indicating if the related spatial 361*5113495bSYour Name stream is used for this STA 362*5113495bSYour Name 363*5113495bSYour Name LSB related to SS 0 364*5113495bSYour Name 365*5113495bSYour Name 366*5113495bSYour Name 367*5113495bSYour Name 0: spatial stream not used for this reception 368*5113495bSYour Name 369*5113495bSYour Name 1: spatial stream used for this reception 370*5113495bSYour Name 371*5113495bSYour Name 372*5113495bSYour Name 373*5113495bSYour Name <legal all> 374*5113495bSYour Name */ 375*5113495bSYour Name #define RECEIVE_USER_INFO_1_MIMO_SS_BITMAP_OFFSET 0x00000004 376*5113495bSYour Name #define RECEIVE_USER_INFO_1_MIMO_SS_BITMAP_LSB 8 377*5113495bSYour Name #define RECEIVE_USER_INFO_1_MIMO_SS_BITMAP_MASK 0x0000ff00 378*5113495bSYour Name 379*5113495bSYour Name /* Description RECEIVE_USER_INFO_1_USER_RU_ALLOCATION 380*5113495bSYour Name 381*5113495bSYour Name Field only valid in case of OFDMA uplink type reception 382*5113495bSYour Name 383*5113495bSYour Name 384*5113495bSYour Name 385*5113495bSYour Name Indicates the RU number for this user 386*5113495bSYour Name 387*5113495bSYour Name <legal 0-73> 388*5113495bSYour Name */ 389*5113495bSYour Name #define RECEIVE_USER_INFO_1_USER_RU_ALLOCATION_OFFSET 0x00000004 390*5113495bSYour Name #define RECEIVE_USER_INFO_1_USER_RU_ALLOCATION_LSB 16 391*5113495bSYour Name #define RECEIVE_USER_INFO_1_USER_RU_ALLOCATION_MASK 0x00ff0000 392*5113495bSYour Name 393*5113495bSYour Name /* Description RECEIVE_USER_INFO_1_NSS 394*5113495bSYour Name 395*5113495bSYour Name Number of Spatial Streams occupied by the User 396*5113495bSYour Name 397*5113495bSYour Name <enum 0 1_spatial_stream>Single spatial stream 398*5113495bSYour Name 399*5113495bSYour Name <enum 1 2_spatial_streams>2 spatial streams 400*5113495bSYour Name 401*5113495bSYour Name <enum 2 3_spatial_streams>3 spatial streams 402*5113495bSYour Name 403*5113495bSYour Name <enum 3 4_spatial_streams>4 spatial streams 404*5113495bSYour Name 405*5113495bSYour Name <enum 4 5_spatial_streams>5 spatial streams 406*5113495bSYour Name 407*5113495bSYour Name <enum 5 6_spatial_streams>6 spatial streams 408*5113495bSYour Name 409*5113495bSYour Name <enum 6 7_spatial_streams>7 spatial streams 410*5113495bSYour Name 411*5113495bSYour Name <enum 7 8_spatial_streams>8 spatial streams 412*5113495bSYour Name */ 413*5113495bSYour Name #define RECEIVE_USER_INFO_1_NSS_OFFSET 0x00000004 414*5113495bSYour Name #define RECEIVE_USER_INFO_1_NSS_LSB 24 415*5113495bSYour Name #define RECEIVE_USER_INFO_1_NSS_MASK 0x07000000 416*5113495bSYour Name 417*5113495bSYour Name /* Description RECEIVE_USER_INFO_1_RESERVED_1B 418*5113495bSYour Name 419*5113495bSYour Name <legal 0> 420*5113495bSYour Name */ 421*5113495bSYour Name #define RECEIVE_USER_INFO_1_RESERVED_1B_OFFSET 0x00000004 422*5113495bSYour Name #define RECEIVE_USER_INFO_1_RESERVED_1B_LSB 27 423*5113495bSYour Name #define RECEIVE_USER_INFO_1_RESERVED_1B_MASK 0xf8000000 424*5113495bSYour Name 425*5113495bSYour Name 426*5113495bSYour Name #endif // _RECEIVE_USER_INFO_H_ 427