1*5113495bSYour Name /* 2*5113495bSYour Name * Copyright (c) 2016-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 _RX_MPDU_END_H_ 20*5113495bSYour Name #define _RX_MPDU_END_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 rxpcu_mpdu_filter_in_category[1:0], sw_frame_group_id[8:2], reserved_0[15:9], phy_ppdu_id[31:16] 29*5113495bSYour Name // 1 reserved_1a[10:0], unsup_ktype_short_frame[11], rx_in_tx_decrypt_byp[12], overflow_err[13], mpdu_length_err[14], tkip_mic_err[15], decrypt_err[16], unencrypted_frame_err[17], pn_fields_contain_valid_info[18], fcs_err[19], msdu_length_err[20], rxdma0_destination_ring[22:21], rxdma1_destination_ring[24:23], decrypt_status_code[27:25], rx_bitmap_not_updated[28], reserved_1b[31:29] 30*5113495bSYour Name // 31*5113495bSYour Name // ################ END SUMMARY ################# 32*5113495bSYour Name 33*5113495bSYour Name #define NUM_OF_DWORDS_RX_MPDU_END 2 34*5113495bSYour Name 35*5113495bSYour Name struct rx_mpdu_end { 36*5113495bSYour Name uint32_t rxpcu_mpdu_filter_in_category : 2, //[1:0] 37*5113495bSYour Name sw_frame_group_id : 7, //[8:2] 38*5113495bSYour Name reserved_0 : 7, //[15:9] 39*5113495bSYour Name phy_ppdu_id : 16; //[31:16] 40*5113495bSYour Name uint32_t reserved_1a : 11, //[10:0] 41*5113495bSYour Name unsup_ktype_short_frame : 1, //[11] 42*5113495bSYour Name rx_in_tx_decrypt_byp : 1, //[12] 43*5113495bSYour Name overflow_err : 1, //[13] 44*5113495bSYour Name mpdu_length_err : 1, //[14] 45*5113495bSYour Name tkip_mic_err : 1, //[15] 46*5113495bSYour Name decrypt_err : 1, //[16] 47*5113495bSYour Name unencrypted_frame_err : 1, //[17] 48*5113495bSYour Name pn_fields_contain_valid_info : 1, //[18] 49*5113495bSYour Name fcs_err : 1, //[19] 50*5113495bSYour Name msdu_length_err : 1, //[20] 51*5113495bSYour Name rxdma0_destination_ring : 2, //[22:21] 52*5113495bSYour Name rxdma1_destination_ring : 2, //[24:23] 53*5113495bSYour Name decrypt_status_code : 3, //[27:25] 54*5113495bSYour Name rx_bitmap_not_updated : 1, //[28] 55*5113495bSYour Name reserved_1b : 3; //[31:29] 56*5113495bSYour Name }; 57*5113495bSYour Name 58*5113495bSYour Name /* 59*5113495bSYour Name 60*5113495bSYour Name rxpcu_mpdu_filter_in_category 61*5113495bSYour Name 62*5113495bSYour Name Field indicates what the reason was that this MPDU frame 63*5113495bSYour Name was allowed to come into the receive path by RXPCU 64*5113495bSYour Name 65*5113495bSYour Name <enum 0 rxpcu_filter_pass> This MPDU passed the normal 66*5113495bSYour Name frame filter programming of rxpcu 67*5113495bSYour Name 68*5113495bSYour Name <enum 1 rxpcu_monitor_client> This MPDU did NOT pass the 69*5113495bSYour Name regular frame filter and would have been dropped, were it 70*5113495bSYour Name not for the frame fitting into the 'monitor_client' 71*5113495bSYour Name category. 72*5113495bSYour Name 73*5113495bSYour Name <enum 2 rxpcu_monitor_other> This MPDU did NOT pass the 74*5113495bSYour Name regular frame filter and also did not pass the 75*5113495bSYour Name rxpcu_monitor_client filter. It would have been dropped 76*5113495bSYour Name accept that it did pass the 'monitor_other' category. 77*5113495bSYour Name 78*5113495bSYour Name <legal 0-2> 79*5113495bSYour Name 80*5113495bSYour Name sw_frame_group_id 81*5113495bSYour Name 82*5113495bSYour Name SW processes frames based on certain classifications. 83*5113495bSYour Name This field indicates to what sw classification this MPDU is 84*5113495bSYour Name mapped. 85*5113495bSYour Name 86*5113495bSYour Name The classification is given in priority order 87*5113495bSYour Name 88*5113495bSYour Name 89*5113495bSYour Name 90*5113495bSYour Name <enum 0 sw_frame_group_NDP_frame> 91*5113495bSYour Name 92*5113495bSYour Name 93*5113495bSYour Name 94*5113495bSYour Name <enum 1 sw_frame_group_Multicast_data> 95*5113495bSYour Name 96*5113495bSYour Name <enum 2 sw_frame_group_Unicast_data> 97*5113495bSYour Name 98*5113495bSYour Name <enum 3 sw_frame_group_Null_data > This includes mpdus 99*5113495bSYour Name of type Data Null as well as QoS Data Null 100*5113495bSYour Name 101*5113495bSYour Name 102*5113495bSYour Name 103*5113495bSYour Name <enum 4 sw_frame_group_mgmt_0000 > 104*5113495bSYour Name 105*5113495bSYour Name <enum 5 sw_frame_group_mgmt_0001 > 106*5113495bSYour Name 107*5113495bSYour Name <enum 6 sw_frame_group_mgmt_0010 > 108*5113495bSYour Name 109*5113495bSYour Name <enum 7 sw_frame_group_mgmt_0011 > 110*5113495bSYour Name 111*5113495bSYour Name <enum 8 sw_frame_group_mgmt_0100 > 112*5113495bSYour Name 113*5113495bSYour Name <enum 9 sw_frame_group_mgmt_0101 > 114*5113495bSYour Name 115*5113495bSYour Name <enum 10 sw_frame_group_mgmt_0110 > 116*5113495bSYour Name 117*5113495bSYour Name <enum 11 sw_frame_group_mgmt_0111 > 118*5113495bSYour Name 119*5113495bSYour Name <enum 12 sw_frame_group_mgmt_1000 > 120*5113495bSYour Name 121*5113495bSYour Name <enum 13 sw_frame_group_mgmt_1001 > 122*5113495bSYour Name 123*5113495bSYour Name <enum 14 sw_frame_group_mgmt_1010 > 124*5113495bSYour Name 125*5113495bSYour Name <enum 15 sw_frame_group_mgmt_1011 > 126*5113495bSYour Name 127*5113495bSYour Name <enum 16 sw_frame_group_mgmt_1100 > 128*5113495bSYour Name 129*5113495bSYour Name <enum 17 sw_frame_group_mgmt_1101 > 130*5113495bSYour Name 131*5113495bSYour Name <enum 18 sw_frame_group_mgmt_1110 > 132*5113495bSYour Name 133*5113495bSYour Name <enum 19 sw_frame_group_mgmt_1111 > 134*5113495bSYour Name 135*5113495bSYour Name 136*5113495bSYour Name 137*5113495bSYour Name <enum 20 sw_frame_group_ctrl_0000 > 138*5113495bSYour Name 139*5113495bSYour Name <enum 21 sw_frame_group_ctrl_0001 > 140*5113495bSYour Name 141*5113495bSYour Name <enum 22 sw_frame_group_ctrl_0010 > 142*5113495bSYour Name 143*5113495bSYour Name <enum 23 sw_frame_group_ctrl_0011 > 144*5113495bSYour Name 145*5113495bSYour Name <enum 24 sw_frame_group_ctrl_0100 > 146*5113495bSYour Name 147*5113495bSYour Name <enum 25 sw_frame_group_ctrl_0101 > 148*5113495bSYour Name 149*5113495bSYour Name <enum 26 sw_frame_group_ctrl_0110 > 150*5113495bSYour Name 151*5113495bSYour Name <enum 27 sw_frame_group_ctrl_0111 > 152*5113495bSYour Name 153*5113495bSYour Name <enum 28 sw_frame_group_ctrl_1000 > 154*5113495bSYour Name 155*5113495bSYour Name <enum 29 sw_frame_group_ctrl_1001 > 156*5113495bSYour Name 157*5113495bSYour Name <enum 30 sw_frame_group_ctrl_1010 > 158*5113495bSYour Name 159*5113495bSYour Name <enum 31 sw_frame_group_ctrl_1011 > 160*5113495bSYour Name 161*5113495bSYour Name <enum 32 sw_frame_group_ctrl_1100 > 162*5113495bSYour Name 163*5113495bSYour Name <enum 33 sw_frame_group_ctrl_1101 > 164*5113495bSYour Name 165*5113495bSYour Name <enum 34 sw_frame_group_ctrl_1110 > 166*5113495bSYour Name 167*5113495bSYour Name <enum 35 sw_frame_group_ctrl_1111 > 168*5113495bSYour Name 169*5113495bSYour Name 170*5113495bSYour Name 171*5113495bSYour Name <enum 36 sw_frame_group_unsupported> This covers type 3 172*5113495bSYour Name and protocol version != 0 173*5113495bSYour Name 174*5113495bSYour Name 175*5113495bSYour Name 176*5113495bSYour Name 177*5113495bSYour Name 178*5113495bSYour Name 179*5113495bSYour Name <legal 0-37> 180*5113495bSYour Name 181*5113495bSYour Name reserved_0 182*5113495bSYour Name 183*5113495bSYour Name <legal 0> 184*5113495bSYour Name 185*5113495bSYour Name phy_ppdu_id 186*5113495bSYour Name 187*5113495bSYour Name A ppdu counter value that PHY increments for every PPDU 188*5113495bSYour Name received. The counter value wraps around 189*5113495bSYour Name 190*5113495bSYour Name <legal all> 191*5113495bSYour Name 192*5113495bSYour Name reserved_1a 193*5113495bSYour Name 194*5113495bSYour Name <legal 0> 195*5113495bSYour Name 196*5113495bSYour Name unsup_ktype_short_frame 197*5113495bSYour Name 198*5113495bSYour Name This bit will be '1' when WEP or TKIP or WAPI key type 199*5113495bSYour Name is received for 11ah short frame. Crypto will bypass the 200*5113495bSYour Name received packet without decryption to RxOLE after setting 201*5113495bSYour Name this bit. 202*5113495bSYour Name 203*5113495bSYour Name rx_in_tx_decrypt_byp 204*5113495bSYour Name 205*5113495bSYour Name Indicates that RX packet is not decrypted as Crypto is 206*5113495bSYour Name busy with TX packet processing. 207*5113495bSYour Name 208*5113495bSYour Name overflow_err 209*5113495bSYour Name 210*5113495bSYour Name RXPCU Receive FIFO ran out of space to receive the full 211*5113495bSYour Name MPDU. Therefor this MPDU is terminated early and is thus 212*5113495bSYour Name corrupted. 213*5113495bSYour Name 214*5113495bSYour Name 215*5113495bSYour Name 216*5113495bSYour Name This MPDU will not be ACKed. 217*5113495bSYour Name 218*5113495bSYour Name RXPCU might still be able to correctly receive the 219*5113495bSYour Name following MPDUs in the PPDU if enough fifo space became 220*5113495bSYour Name available in time 221*5113495bSYour Name 222*5113495bSYour Name mpdu_length_err 223*5113495bSYour Name 224*5113495bSYour Name Set by RXPCU if the expected MPDU length does not 225*5113495bSYour Name correspond with the actually received number of bytes in the 226*5113495bSYour Name MPDU. 227*5113495bSYour Name 228*5113495bSYour Name tkip_mic_err 229*5113495bSYour Name 230*5113495bSYour Name Set by RX CRYPTO when CRYPTO detected a TKIP MIC error 231*5113495bSYour Name for this MPDU 232*5113495bSYour Name 233*5113495bSYour Name decrypt_err 234*5113495bSYour Name 235*5113495bSYour Name Set by RX CRYPTO when CRYPTO detected a decrypt error 236*5113495bSYour Name for this MPDU or CRYPTO received an encrypted frame, but did 237*5113495bSYour Name not get a valid corresponding key id in the peer entry. 238*5113495bSYour Name 239*5113495bSYour Name unencrypted_frame_err 240*5113495bSYour Name 241*5113495bSYour Name Set by RX CRYPTO when CRYPTO detected an unencrypted 242*5113495bSYour Name frame while in the peer entry field 243*5113495bSYour Name 'All_frames_shall_be_encrypted' is set. 244*5113495bSYour Name 245*5113495bSYour Name pn_fields_contain_valid_info 246*5113495bSYour Name 247*5113495bSYour Name Set by RX CRYPTO to indicate that there is a valid PN 248*5113495bSYour Name field present in this MPDU 249*5113495bSYour Name 250*5113495bSYour Name fcs_err 251*5113495bSYour Name 252*5113495bSYour Name Set by RXPCU when there is an FCS error detected for 253*5113495bSYour Name this MPDU 254*5113495bSYour Name 255*5113495bSYour Name NOTE that when this field is set, all other (error) 256*5113495bSYour Name field settings should be ignored as modules could have made 257*5113495bSYour Name wrong decisions based on the corrupted data. 258*5113495bSYour Name 259*5113495bSYour Name msdu_length_err 260*5113495bSYour Name 261*5113495bSYour Name Set by RXOLE when there is an msdu length error detected 262*5113495bSYour Name in at least 1 of the MSDUs embedded within the MPDU 263*5113495bSYour Name 264*5113495bSYour Name rxdma0_destination_ring 265*5113495bSYour Name 266*5113495bSYour Name The ring to which RXDMA0 shall push the frame, assuming 267*5113495bSYour Name no MPDU level errors are detected. In case of MPDU level 268*5113495bSYour Name errors, RXDMA0 might change the RXDMA0 destination 269*5113495bSYour Name 270*5113495bSYour Name 271*5113495bSYour Name 272*5113495bSYour Name <enum 0 rxdma_release_ring > RXDMA0 shall push the 273*5113495bSYour Name frame to the Release ring. Effectively this means the frame 274*5113495bSYour Name needs to be dropped. 275*5113495bSYour Name 276*5113495bSYour Name 277*5113495bSYour Name 278*5113495bSYour Name <enum 1 rxdma2fw_ring > RXDMA0 shall push the frame to 279*5113495bSYour Name the FW ring 280*5113495bSYour Name 281*5113495bSYour Name 282*5113495bSYour Name 283*5113495bSYour Name <enum 2 rxdma2sw_ring > RXDMA0 shall push the frame to 284*5113495bSYour Name the SW ring 285*5113495bSYour Name 286*5113495bSYour Name 287*5113495bSYour Name 288*5113495bSYour Name <enum 3 rxdma2reo_ring > RXDMA0 shall push the frame 289*5113495bSYour Name to the REO entrance ring 290*5113495bSYour Name 291*5113495bSYour Name 292*5113495bSYour Name 293*5113495bSYour Name <legal all> 294*5113495bSYour Name 295*5113495bSYour Name rxdma1_destination_ring 296*5113495bSYour Name 297*5113495bSYour Name The ring to which RXDMA1 shall push the frame, assuming 298*5113495bSYour Name no MPDU level errors are detected. In case of MPDU level 299*5113495bSYour Name errors, RXDMA1 might change the RXDMA destination 300*5113495bSYour Name 301*5113495bSYour Name 302*5113495bSYour Name 303*5113495bSYour Name <enum 0 rxdma_release_ring > RXDMA1 shall push the 304*5113495bSYour Name frame to the Release ring. Effectively this means the frame 305*5113495bSYour Name needs to be dropped. 306*5113495bSYour Name 307*5113495bSYour Name 308*5113495bSYour Name 309*5113495bSYour Name <enum 1 rxdma2fw_ring > RXDMA1 shall push the frame to 310*5113495bSYour Name the FW ring 311*5113495bSYour Name 312*5113495bSYour Name 313*5113495bSYour Name 314*5113495bSYour Name <enum 2 rxdma2sw_ring > RXDMA1 shall push the frame to 315*5113495bSYour Name the SW ring 316*5113495bSYour Name 317*5113495bSYour Name 318*5113495bSYour Name 319*5113495bSYour Name <enum 3 rxdma2reo_ring > RXDMA1 shall push the frame 320*5113495bSYour Name to the REO entrance ring 321*5113495bSYour Name 322*5113495bSYour Name 323*5113495bSYour Name 324*5113495bSYour Name <legal all> 325*5113495bSYour Name 326*5113495bSYour Name decrypt_status_code 327*5113495bSYour Name 328*5113495bSYour Name Field provides insight into the decryption performed 329*5113495bSYour Name 330*5113495bSYour Name 331*5113495bSYour Name 332*5113495bSYour Name <enum 0 decrypt_ok> Frame had protection enabled and 333*5113495bSYour Name decrypted properly 334*5113495bSYour Name 335*5113495bSYour Name <enum 1 decrypt_unprotected_frame > Frame is unprotected 336*5113495bSYour Name and hence bypassed 337*5113495bSYour Name 338*5113495bSYour Name <enum 2 decrypt_data_err > Frame has protection enabled 339*5113495bSYour Name and could not be properly decrypted due to MIC/ICV mismatch 340*5113495bSYour Name etc. 341*5113495bSYour Name 342*5113495bSYour Name <enum 3 decrypt_key_invalid > Frame has protection 343*5113495bSYour Name enabled but the key that was required to decrypt this frame 344*5113495bSYour Name was not valid 345*5113495bSYour Name 346*5113495bSYour Name <enum 4 decrypt_peer_entry_invalid > Frame has 347*5113495bSYour Name protection enabled but the key that was required to decrypt 348*5113495bSYour Name this frame was not valid 349*5113495bSYour Name 350*5113495bSYour Name <enum 5 decrypt_other > Reserved for other indications 351*5113495bSYour Name 352*5113495bSYour Name 353*5113495bSYour Name 354*5113495bSYour Name <legal 0 - 5> 355*5113495bSYour Name 356*5113495bSYour Name rx_bitmap_not_updated 357*5113495bSYour Name 358*5113495bSYour Name Frame is received, but RXPCU could not update the 359*5113495bSYour Name receive bitmap due to (temporary) fifo contraints. 360*5113495bSYour Name 361*5113495bSYour Name <legal all> 362*5113495bSYour Name 363*5113495bSYour Name reserved_1b 364*5113495bSYour Name 365*5113495bSYour Name <legal 0> 366*5113495bSYour Name */ 367*5113495bSYour Name 368*5113495bSYour Name 369*5113495bSYour Name /* Description RX_MPDU_END_0_RXPCU_MPDU_FILTER_IN_CATEGORY 370*5113495bSYour Name 371*5113495bSYour Name Field indicates what the reason was that this MPDU frame 372*5113495bSYour Name was allowed to come into the receive path by RXPCU 373*5113495bSYour Name 374*5113495bSYour Name <enum 0 rxpcu_filter_pass> This MPDU passed the normal 375*5113495bSYour Name frame filter programming of rxpcu 376*5113495bSYour Name 377*5113495bSYour Name <enum 1 rxpcu_monitor_client> This MPDU did NOT pass the 378*5113495bSYour Name regular frame filter and would have been dropped, were it 379*5113495bSYour Name not for the frame fitting into the 'monitor_client' 380*5113495bSYour Name category. 381*5113495bSYour Name 382*5113495bSYour Name <enum 2 rxpcu_monitor_other> This MPDU did NOT pass the 383*5113495bSYour Name regular frame filter and also did not pass the 384*5113495bSYour Name rxpcu_monitor_client filter. It would have been dropped 385*5113495bSYour Name accept that it did pass the 'monitor_other' category. 386*5113495bSYour Name 387*5113495bSYour Name <legal 0-2> 388*5113495bSYour Name */ 389*5113495bSYour Name #define RX_MPDU_END_0_RXPCU_MPDU_FILTER_IN_CATEGORY_OFFSET 0x00000000 390*5113495bSYour Name #define RX_MPDU_END_0_RXPCU_MPDU_FILTER_IN_CATEGORY_LSB 0 391*5113495bSYour Name #define RX_MPDU_END_0_RXPCU_MPDU_FILTER_IN_CATEGORY_MASK 0x00000003 392*5113495bSYour Name 393*5113495bSYour Name /* Description RX_MPDU_END_0_SW_FRAME_GROUP_ID 394*5113495bSYour Name 395*5113495bSYour Name SW processes frames based on certain classifications. 396*5113495bSYour Name This field indicates to what sw classification this MPDU is 397*5113495bSYour Name mapped. 398*5113495bSYour Name 399*5113495bSYour Name The classification is given in priority order 400*5113495bSYour Name 401*5113495bSYour Name 402*5113495bSYour Name 403*5113495bSYour Name <enum 0 sw_frame_group_NDP_frame> 404*5113495bSYour Name 405*5113495bSYour Name 406*5113495bSYour Name 407*5113495bSYour Name <enum 1 sw_frame_group_Multicast_data> 408*5113495bSYour Name 409*5113495bSYour Name <enum 2 sw_frame_group_Unicast_data> 410*5113495bSYour Name 411*5113495bSYour Name <enum 3 sw_frame_group_Null_data > This includes mpdus 412*5113495bSYour Name of type Data Null as well as QoS Data Null 413*5113495bSYour Name 414*5113495bSYour Name 415*5113495bSYour Name 416*5113495bSYour Name <enum 4 sw_frame_group_mgmt_0000 > 417*5113495bSYour Name 418*5113495bSYour Name <enum 5 sw_frame_group_mgmt_0001 > 419*5113495bSYour Name 420*5113495bSYour Name <enum 6 sw_frame_group_mgmt_0010 > 421*5113495bSYour Name 422*5113495bSYour Name <enum 7 sw_frame_group_mgmt_0011 > 423*5113495bSYour Name 424*5113495bSYour Name <enum 8 sw_frame_group_mgmt_0100 > 425*5113495bSYour Name 426*5113495bSYour Name <enum 9 sw_frame_group_mgmt_0101 > 427*5113495bSYour Name 428*5113495bSYour Name <enum 10 sw_frame_group_mgmt_0110 > 429*5113495bSYour Name 430*5113495bSYour Name <enum 11 sw_frame_group_mgmt_0111 > 431*5113495bSYour Name 432*5113495bSYour Name <enum 12 sw_frame_group_mgmt_1000 > 433*5113495bSYour Name 434*5113495bSYour Name <enum 13 sw_frame_group_mgmt_1001 > 435*5113495bSYour Name 436*5113495bSYour Name <enum 14 sw_frame_group_mgmt_1010 > 437*5113495bSYour Name 438*5113495bSYour Name <enum 15 sw_frame_group_mgmt_1011 > 439*5113495bSYour Name 440*5113495bSYour Name <enum 16 sw_frame_group_mgmt_1100 > 441*5113495bSYour Name 442*5113495bSYour Name <enum 17 sw_frame_group_mgmt_1101 > 443*5113495bSYour Name 444*5113495bSYour Name <enum 18 sw_frame_group_mgmt_1110 > 445*5113495bSYour Name 446*5113495bSYour Name <enum 19 sw_frame_group_mgmt_1111 > 447*5113495bSYour Name 448*5113495bSYour Name 449*5113495bSYour Name 450*5113495bSYour Name <enum 20 sw_frame_group_ctrl_0000 > 451*5113495bSYour Name 452*5113495bSYour Name <enum 21 sw_frame_group_ctrl_0001 > 453*5113495bSYour Name 454*5113495bSYour Name <enum 22 sw_frame_group_ctrl_0010 > 455*5113495bSYour Name 456*5113495bSYour Name <enum 23 sw_frame_group_ctrl_0011 > 457*5113495bSYour Name 458*5113495bSYour Name <enum 24 sw_frame_group_ctrl_0100 > 459*5113495bSYour Name 460*5113495bSYour Name <enum 25 sw_frame_group_ctrl_0101 > 461*5113495bSYour Name 462*5113495bSYour Name <enum 26 sw_frame_group_ctrl_0110 > 463*5113495bSYour Name 464*5113495bSYour Name <enum 27 sw_frame_group_ctrl_0111 > 465*5113495bSYour Name 466*5113495bSYour Name <enum 28 sw_frame_group_ctrl_1000 > 467*5113495bSYour Name 468*5113495bSYour Name <enum 29 sw_frame_group_ctrl_1001 > 469*5113495bSYour Name 470*5113495bSYour Name <enum 30 sw_frame_group_ctrl_1010 > 471*5113495bSYour Name 472*5113495bSYour Name <enum 31 sw_frame_group_ctrl_1011 > 473*5113495bSYour Name 474*5113495bSYour Name <enum 32 sw_frame_group_ctrl_1100 > 475*5113495bSYour Name 476*5113495bSYour Name <enum 33 sw_frame_group_ctrl_1101 > 477*5113495bSYour Name 478*5113495bSYour Name <enum 34 sw_frame_group_ctrl_1110 > 479*5113495bSYour Name 480*5113495bSYour Name <enum 35 sw_frame_group_ctrl_1111 > 481*5113495bSYour Name 482*5113495bSYour Name 483*5113495bSYour Name 484*5113495bSYour Name <enum 36 sw_frame_group_unsupported> This covers type 3 485*5113495bSYour Name and protocol version != 0 486*5113495bSYour Name 487*5113495bSYour Name 488*5113495bSYour Name 489*5113495bSYour Name 490*5113495bSYour Name 491*5113495bSYour Name 492*5113495bSYour Name <legal 0-37> 493*5113495bSYour Name */ 494*5113495bSYour Name #define RX_MPDU_END_0_SW_FRAME_GROUP_ID_OFFSET 0x00000000 495*5113495bSYour Name #define RX_MPDU_END_0_SW_FRAME_GROUP_ID_LSB 2 496*5113495bSYour Name #define RX_MPDU_END_0_SW_FRAME_GROUP_ID_MASK 0x000001fc 497*5113495bSYour Name 498*5113495bSYour Name /* Description RX_MPDU_END_0_RESERVED_0 499*5113495bSYour Name 500*5113495bSYour Name <legal 0> 501*5113495bSYour Name */ 502*5113495bSYour Name #define RX_MPDU_END_0_RESERVED_0_OFFSET 0x00000000 503*5113495bSYour Name #define RX_MPDU_END_0_RESERVED_0_LSB 9 504*5113495bSYour Name #define RX_MPDU_END_0_RESERVED_0_MASK 0x0000fe00 505*5113495bSYour Name 506*5113495bSYour Name /* Description RX_MPDU_END_0_PHY_PPDU_ID 507*5113495bSYour Name 508*5113495bSYour Name A ppdu counter value that PHY increments for every PPDU 509*5113495bSYour Name received. The counter value wraps around 510*5113495bSYour Name 511*5113495bSYour Name <legal all> 512*5113495bSYour Name */ 513*5113495bSYour Name #define RX_MPDU_END_0_PHY_PPDU_ID_OFFSET 0x00000000 514*5113495bSYour Name #define RX_MPDU_END_0_PHY_PPDU_ID_LSB 16 515*5113495bSYour Name #define RX_MPDU_END_0_PHY_PPDU_ID_MASK 0xffff0000 516*5113495bSYour Name 517*5113495bSYour Name /* Description RX_MPDU_END_1_RESERVED_1A 518*5113495bSYour Name 519*5113495bSYour Name <legal 0> 520*5113495bSYour Name */ 521*5113495bSYour Name #define RX_MPDU_END_1_RESERVED_1A_OFFSET 0x00000004 522*5113495bSYour Name #define RX_MPDU_END_1_RESERVED_1A_LSB 0 523*5113495bSYour Name #define RX_MPDU_END_1_RESERVED_1A_MASK 0x000007ff 524*5113495bSYour Name 525*5113495bSYour Name /* Description RX_MPDU_END_1_UNSUP_KTYPE_SHORT_FRAME 526*5113495bSYour Name 527*5113495bSYour Name This bit will be '1' when WEP or TKIP or WAPI key type 528*5113495bSYour Name is received for 11ah short frame. Crypto will bypass the 529*5113495bSYour Name received packet without decryption to RxOLE after setting 530*5113495bSYour Name this bit. 531*5113495bSYour Name */ 532*5113495bSYour Name #define RX_MPDU_END_1_UNSUP_KTYPE_SHORT_FRAME_OFFSET 0x00000004 533*5113495bSYour Name #define RX_MPDU_END_1_UNSUP_KTYPE_SHORT_FRAME_LSB 11 534*5113495bSYour Name #define RX_MPDU_END_1_UNSUP_KTYPE_SHORT_FRAME_MASK 0x00000800 535*5113495bSYour Name 536*5113495bSYour Name /* Description RX_MPDU_END_1_RX_IN_TX_DECRYPT_BYP 537*5113495bSYour Name 538*5113495bSYour Name Indicates that RX packet is not decrypted as Crypto is 539*5113495bSYour Name busy with TX packet processing. 540*5113495bSYour Name */ 541*5113495bSYour Name #define RX_MPDU_END_1_RX_IN_TX_DECRYPT_BYP_OFFSET 0x00000004 542*5113495bSYour Name #define RX_MPDU_END_1_RX_IN_TX_DECRYPT_BYP_LSB 12 543*5113495bSYour Name #define RX_MPDU_END_1_RX_IN_TX_DECRYPT_BYP_MASK 0x00001000 544*5113495bSYour Name 545*5113495bSYour Name /* Description RX_MPDU_END_1_OVERFLOW_ERR 546*5113495bSYour Name 547*5113495bSYour Name RXPCU Receive FIFO ran out of space to receive the full 548*5113495bSYour Name MPDU. Therefor this MPDU is terminated early and is thus 549*5113495bSYour Name corrupted. 550*5113495bSYour Name 551*5113495bSYour Name 552*5113495bSYour Name 553*5113495bSYour Name This MPDU will not be ACKed. 554*5113495bSYour Name 555*5113495bSYour Name RXPCU might still be able to correctly receive the 556*5113495bSYour Name following MPDUs in the PPDU if enough fifo space became 557*5113495bSYour Name available in time 558*5113495bSYour Name */ 559*5113495bSYour Name #define RX_MPDU_END_1_OVERFLOW_ERR_OFFSET 0x00000004 560*5113495bSYour Name #define RX_MPDU_END_1_OVERFLOW_ERR_LSB 13 561*5113495bSYour Name #define RX_MPDU_END_1_OVERFLOW_ERR_MASK 0x00002000 562*5113495bSYour Name 563*5113495bSYour Name /* Description RX_MPDU_END_1_MPDU_LENGTH_ERR 564*5113495bSYour Name 565*5113495bSYour Name Set by RXPCU if the expected MPDU length does not 566*5113495bSYour Name correspond with the actually received number of bytes in the 567*5113495bSYour Name MPDU. 568*5113495bSYour Name */ 569*5113495bSYour Name #define RX_MPDU_END_1_MPDU_LENGTH_ERR_OFFSET 0x00000004 570*5113495bSYour Name #define RX_MPDU_END_1_MPDU_LENGTH_ERR_LSB 14 571*5113495bSYour Name #define RX_MPDU_END_1_MPDU_LENGTH_ERR_MASK 0x00004000 572*5113495bSYour Name 573*5113495bSYour Name /* Description RX_MPDU_END_1_TKIP_MIC_ERR 574*5113495bSYour Name 575*5113495bSYour Name Set by RX CRYPTO when CRYPTO detected a TKIP MIC error 576*5113495bSYour Name for this MPDU 577*5113495bSYour Name */ 578*5113495bSYour Name #define RX_MPDU_END_1_TKIP_MIC_ERR_OFFSET 0x00000004 579*5113495bSYour Name #define RX_MPDU_END_1_TKIP_MIC_ERR_LSB 15 580*5113495bSYour Name #define RX_MPDU_END_1_TKIP_MIC_ERR_MASK 0x00008000 581*5113495bSYour Name 582*5113495bSYour Name /* Description RX_MPDU_END_1_DECRYPT_ERR 583*5113495bSYour Name 584*5113495bSYour Name Set by RX CRYPTO when CRYPTO detected a decrypt error 585*5113495bSYour Name for this MPDU or CRYPTO received an encrypted frame, but did 586*5113495bSYour Name not get a valid corresponding key id in the peer entry. 587*5113495bSYour Name */ 588*5113495bSYour Name #define RX_MPDU_END_1_DECRYPT_ERR_OFFSET 0x00000004 589*5113495bSYour Name #define RX_MPDU_END_1_DECRYPT_ERR_LSB 16 590*5113495bSYour Name #define RX_MPDU_END_1_DECRYPT_ERR_MASK 0x00010000 591*5113495bSYour Name 592*5113495bSYour Name /* Description RX_MPDU_END_1_UNENCRYPTED_FRAME_ERR 593*5113495bSYour Name 594*5113495bSYour Name Set by RX CRYPTO when CRYPTO detected an unencrypted 595*5113495bSYour Name frame while in the peer entry field 596*5113495bSYour Name 'All_frames_shall_be_encrypted' is set. 597*5113495bSYour Name */ 598*5113495bSYour Name #define RX_MPDU_END_1_UNENCRYPTED_FRAME_ERR_OFFSET 0x00000004 599*5113495bSYour Name #define RX_MPDU_END_1_UNENCRYPTED_FRAME_ERR_LSB 17 600*5113495bSYour Name #define RX_MPDU_END_1_UNENCRYPTED_FRAME_ERR_MASK 0x00020000 601*5113495bSYour Name 602*5113495bSYour Name /* Description RX_MPDU_END_1_PN_FIELDS_CONTAIN_VALID_INFO 603*5113495bSYour Name 604*5113495bSYour Name Set by RX CRYPTO to indicate that there is a valid PN 605*5113495bSYour Name field present in this MPDU 606*5113495bSYour Name */ 607*5113495bSYour Name #define RX_MPDU_END_1_PN_FIELDS_CONTAIN_VALID_INFO_OFFSET 0x00000004 608*5113495bSYour Name #define RX_MPDU_END_1_PN_FIELDS_CONTAIN_VALID_INFO_LSB 18 609*5113495bSYour Name #define RX_MPDU_END_1_PN_FIELDS_CONTAIN_VALID_INFO_MASK 0x00040000 610*5113495bSYour Name 611*5113495bSYour Name /* Description RX_MPDU_END_1_FCS_ERR 612*5113495bSYour Name 613*5113495bSYour Name Set by RXPCU when there is an FCS error detected for 614*5113495bSYour Name this MPDU 615*5113495bSYour Name 616*5113495bSYour Name NOTE that when this field is set, all other (error) 617*5113495bSYour Name field settings should be ignored as modules could have made 618*5113495bSYour Name wrong decisions based on the corrupted data. 619*5113495bSYour Name */ 620*5113495bSYour Name #define RX_MPDU_END_1_FCS_ERR_OFFSET 0x00000004 621*5113495bSYour Name #define RX_MPDU_END_1_FCS_ERR_LSB 19 622*5113495bSYour Name #define RX_MPDU_END_1_FCS_ERR_MASK 0x00080000 623*5113495bSYour Name 624*5113495bSYour Name /* Description RX_MPDU_END_1_MSDU_LENGTH_ERR 625*5113495bSYour Name 626*5113495bSYour Name Set by RXOLE when there is an msdu length error detected 627*5113495bSYour Name in at least 1 of the MSDUs embedded within the MPDU 628*5113495bSYour Name */ 629*5113495bSYour Name #define RX_MPDU_END_1_MSDU_LENGTH_ERR_OFFSET 0x00000004 630*5113495bSYour Name #define RX_MPDU_END_1_MSDU_LENGTH_ERR_LSB 20 631*5113495bSYour Name #define RX_MPDU_END_1_MSDU_LENGTH_ERR_MASK 0x00100000 632*5113495bSYour Name 633*5113495bSYour Name /* Description RX_MPDU_END_1_RXDMA0_DESTINATION_RING 634*5113495bSYour Name 635*5113495bSYour Name The ring to which RXDMA0 shall push the frame, assuming 636*5113495bSYour Name no MPDU level errors are detected. In case of MPDU level 637*5113495bSYour Name errors, RXDMA0 might change the RXDMA0 destination 638*5113495bSYour Name 639*5113495bSYour Name 640*5113495bSYour Name 641*5113495bSYour Name <enum 0 rxdma_release_ring > RXDMA0 shall push the 642*5113495bSYour Name frame to the Release ring. Effectively this means the frame 643*5113495bSYour Name needs to be dropped. 644*5113495bSYour Name 645*5113495bSYour Name 646*5113495bSYour Name 647*5113495bSYour Name <enum 1 rxdma2fw_ring > RXDMA0 shall push the frame to 648*5113495bSYour Name the FW ring 649*5113495bSYour Name 650*5113495bSYour Name 651*5113495bSYour Name 652*5113495bSYour Name <enum 2 rxdma2sw_ring > RXDMA0 shall push the frame to 653*5113495bSYour Name the SW ring 654*5113495bSYour Name 655*5113495bSYour Name 656*5113495bSYour Name 657*5113495bSYour Name <enum 3 rxdma2reo_ring > RXDMA0 shall push the frame 658*5113495bSYour Name to the REO entrance ring 659*5113495bSYour Name 660*5113495bSYour Name 661*5113495bSYour Name 662*5113495bSYour Name <legal all> 663*5113495bSYour Name */ 664*5113495bSYour Name #define RX_MPDU_END_1_RXDMA0_DESTINATION_RING_OFFSET 0x00000004 665*5113495bSYour Name #define RX_MPDU_END_1_RXDMA0_DESTINATION_RING_LSB 21 666*5113495bSYour Name #define RX_MPDU_END_1_RXDMA0_DESTINATION_RING_MASK 0x00600000 667*5113495bSYour Name 668*5113495bSYour Name /* Description RX_MPDU_END_1_RXDMA1_DESTINATION_RING 669*5113495bSYour Name 670*5113495bSYour Name The ring to which RXDMA1 shall push the frame, assuming 671*5113495bSYour Name no MPDU level errors are detected. In case of MPDU level 672*5113495bSYour Name errors, RXDMA1 might change the RXDMA destination 673*5113495bSYour Name 674*5113495bSYour Name 675*5113495bSYour Name 676*5113495bSYour Name <enum 0 rxdma_release_ring > RXDMA1 shall push the 677*5113495bSYour Name frame to the Release ring. Effectively this means the frame 678*5113495bSYour Name needs to be dropped. 679*5113495bSYour Name 680*5113495bSYour Name 681*5113495bSYour Name 682*5113495bSYour Name <enum 1 rxdma2fw_ring > RXDMA1 shall push the frame to 683*5113495bSYour Name the FW ring 684*5113495bSYour Name 685*5113495bSYour Name 686*5113495bSYour Name 687*5113495bSYour Name <enum 2 rxdma2sw_ring > RXDMA1 shall push the frame to 688*5113495bSYour Name the SW ring 689*5113495bSYour Name 690*5113495bSYour Name 691*5113495bSYour Name 692*5113495bSYour Name <enum 3 rxdma2reo_ring > RXDMA1 shall push the frame 693*5113495bSYour Name to the REO entrance ring 694*5113495bSYour Name 695*5113495bSYour Name 696*5113495bSYour Name 697*5113495bSYour Name <legal all> 698*5113495bSYour Name */ 699*5113495bSYour Name #define RX_MPDU_END_1_RXDMA1_DESTINATION_RING_OFFSET 0x00000004 700*5113495bSYour Name #define RX_MPDU_END_1_RXDMA1_DESTINATION_RING_LSB 23 701*5113495bSYour Name #define RX_MPDU_END_1_RXDMA1_DESTINATION_RING_MASK 0x01800000 702*5113495bSYour Name 703*5113495bSYour Name /* Description RX_MPDU_END_1_DECRYPT_STATUS_CODE 704*5113495bSYour Name 705*5113495bSYour Name Field provides insight into the decryption performed 706*5113495bSYour Name 707*5113495bSYour Name 708*5113495bSYour Name 709*5113495bSYour Name <enum 0 decrypt_ok> Frame had protection enabled and 710*5113495bSYour Name decrypted properly 711*5113495bSYour Name 712*5113495bSYour Name <enum 1 decrypt_unprotected_frame > Frame is unprotected 713*5113495bSYour Name and hence bypassed 714*5113495bSYour Name 715*5113495bSYour Name <enum 2 decrypt_data_err > Frame has protection enabled 716*5113495bSYour Name and could not be properly decrypted due to MIC/ICV mismatch 717*5113495bSYour Name etc. 718*5113495bSYour Name 719*5113495bSYour Name <enum 3 decrypt_key_invalid > Frame has protection 720*5113495bSYour Name enabled but the key that was required to decrypt this frame 721*5113495bSYour Name was not valid 722*5113495bSYour Name 723*5113495bSYour Name <enum 4 decrypt_peer_entry_invalid > Frame has 724*5113495bSYour Name protection enabled but the key that was required to decrypt 725*5113495bSYour Name this frame was not valid 726*5113495bSYour Name 727*5113495bSYour Name <enum 5 decrypt_other > Reserved for other indications 728*5113495bSYour Name 729*5113495bSYour Name 730*5113495bSYour Name 731*5113495bSYour Name <legal 0 - 5> 732*5113495bSYour Name */ 733*5113495bSYour Name #define RX_MPDU_END_1_DECRYPT_STATUS_CODE_OFFSET 0x00000004 734*5113495bSYour Name #define RX_MPDU_END_1_DECRYPT_STATUS_CODE_LSB 25 735*5113495bSYour Name #define RX_MPDU_END_1_DECRYPT_STATUS_CODE_MASK 0x0e000000 736*5113495bSYour Name 737*5113495bSYour Name /* Description RX_MPDU_END_1_RX_BITMAP_NOT_UPDATED 738*5113495bSYour Name 739*5113495bSYour Name Frame is received, but RXPCU could not update the 740*5113495bSYour Name receive bitmap due to (temporary) fifo contraints. 741*5113495bSYour Name 742*5113495bSYour Name <legal all> 743*5113495bSYour Name */ 744*5113495bSYour Name #define RX_MPDU_END_1_RX_BITMAP_NOT_UPDATED_OFFSET 0x00000004 745*5113495bSYour Name #define RX_MPDU_END_1_RX_BITMAP_NOT_UPDATED_LSB 28 746*5113495bSYour Name #define RX_MPDU_END_1_RX_BITMAP_NOT_UPDATED_MASK 0x10000000 747*5113495bSYour Name 748*5113495bSYour Name /* Description RX_MPDU_END_1_RESERVED_1B 749*5113495bSYour Name 750*5113495bSYour Name <legal 0> 751*5113495bSYour Name */ 752*5113495bSYour Name #define RX_MPDU_END_1_RESERVED_1B_OFFSET 0x00000004 753*5113495bSYour Name #define RX_MPDU_END_1_RESERVED_1B_LSB 29 754*5113495bSYour Name #define RX_MPDU_END_1_RESERVED_1B_MASK 0xe0000000 755*5113495bSYour Name 756*5113495bSYour Name 757*5113495bSYour Name #endif // _RX_MPDU_END_H_ 758