1*5113495bSYour Name /* 2*5113495bSYour Name * Copyright (c) 2023 Qualcomm Innovation Center, Inc. All rights reserved. 3*5113495bSYour Name * 4*5113495bSYour Name * Permission to use, copy, modify, and/or distribute this software for any 5*5113495bSYour Name * purpose with or without fee is hereby granted, provided that the above 6*5113495bSYour Name * copyright notice and this permission notice appear in all copies. 7*5113495bSYour Name * 8*5113495bSYour Name * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 9*5113495bSYour Name * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 10*5113495bSYour Name * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 11*5113495bSYour Name * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 12*5113495bSYour Name * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 13*5113495bSYour Name * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 14*5113495bSYour Name * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15*5113495bSYour Name */ 16*5113495bSYour Name 17*5113495bSYour Name #ifndef _RX_MSDU_DESC_INFO_H_ 18*5113495bSYour Name #define _RX_MSDU_DESC_INFO_H_ 19*5113495bSYour Name #if !defined(__ASSEMBLER__) 20*5113495bSYour Name #endif 21*5113495bSYour Name 22*5113495bSYour Name #define NUM_OF_DWORDS_RX_MSDU_DESC_INFO 1 23*5113495bSYour Name 24*5113495bSYour Name 25*5113495bSYour Name struct rx_msdu_desc_info { 26*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN 27*5113495bSYour Name uint32_t first_msdu_in_mpdu_flag : 1, // [0:0] 28*5113495bSYour Name last_msdu_in_mpdu_flag : 1, // [1:1] 29*5113495bSYour Name msdu_continuation : 1, // [2:2] 30*5113495bSYour Name msdu_length : 14, // [16:3] 31*5113495bSYour Name msdu_drop : 1, // [17:17] 32*5113495bSYour Name sa_is_valid : 1, // [18:18] 33*5113495bSYour Name da_is_valid : 1, // [19:19] 34*5113495bSYour Name da_is_mcbc : 1, // [20:20] 35*5113495bSYour Name l3_header_padding_msb : 1, // [21:21] 36*5113495bSYour Name tcp_udp_chksum_fail : 1, // [22:22] 37*5113495bSYour Name ip_chksum_fail : 1, // [23:23] 38*5113495bSYour Name fr_ds : 1, // [24:24] 39*5113495bSYour Name to_ds : 1, // [25:25] 40*5113495bSYour Name intra_bss : 1, // [26:26] 41*5113495bSYour Name dest_chip_id : 2, // [28:27] 42*5113495bSYour Name decap_format : 2, // [30:29] 43*5113495bSYour Name dest_chip_pmac_id : 1; // [31:31] 44*5113495bSYour Name #else 45*5113495bSYour Name uint32_t dest_chip_pmac_id : 1, // [31:31] 46*5113495bSYour Name decap_format : 2, // [30:29] 47*5113495bSYour Name dest_chip_id : 2, // [28:27] 48*5113495bSYour Name intra_bss : 1, // [26:26] 49*5113495bSYour Name to_ds : 1, // [25:25] 50*5113495bSYour Name fr_ds : 1, // [24:24] 51*5113495bSYour Name ip_chksum_fail : 1, // [23:23] 52*5113495bSYour Name tcp_udp_chksum_fail : 1, // [22:22] 53*5113495bSYour Name l3_header_padding_msb : 1, // [21:21] 54*5113495bSYour Name da_is_mcbc : 1, // [20:20] 55*5113495bSYour Name da_is_valid : 1, // [19:19] 56*5113495bSYour Name sa_is_valid : 1, // [18:18] 57*5113495bSYour Name msdu_drop : 1, // [17:17] 58*5113495bSYour Name msdu_length : 14, // [16:3] 59*5113495bSYour Name msdu_continuation : 1, // [2:2] 60*5113495bSYour Name last_msdu_in_mpdu_flag : 1, // [1:1] 61*5113495bSYour Name first_msdu_in_mpdu_flag : 1; // [0:0] 62*5113495bSYour Name #endif 63*5113495bSYour Name }; 64*5113495bSYour Name 65*5113495bSYour Name 66*5113495bSYour Name /* Description FIRST_MSDU_IN_MPDU_FLAG 67*5113495bSYour Name 68*5113495bSYour Name Parsed from RX_MSDU_END TLV . In the case MSDU spans over 69*5113495bSYour Name multiple buffers, this field will be valid in the Last 70*5113495bSYour Name buffer used by the MSDU 71*5113495bSYour Name 72*5113495bSYour Name <enum 0 Not_first_msdu> This is not the first MSDU in the 73*5113495bSYour Name MPDU. 74*5113495bSYour Name <enum 1 first_msdu> This MSDU is the first one in the MPDU. 75*5113495bSYour Name 76*5113495bSYour Name 77*5113495bSYour Name <legal all> 78*5113495bSYour Name */ 79*5113495bSYour Name 80*5113495bSYour Name #define RX_MSDU_DESC_INFO_FIRST_MSDU_IN_MPDU_FLAG_OFFSET 0x00000000 81*5113495bSYour Name #define RX_MSDU_DESC_INFO_FIRST_MSDU_IN_MPDU_FLAG_LSB 0 82*5113495bSYour Name #define RX_MSDU_DESC_INFO_FIRST_MSDU_IN_MPDU_FLAG_MSB 0 83*5113495bSYour Name #define RX_MSDU_DESC_INFO_FIRST_MSDU_IN_MPDU_FLAG_MASK 0x00000001 84*5113495bSYour Name 85*5113495bSYour Name 86*5113495bSYour Name /* Description LAST_MSDU_IN_MPDU_FLAG 87*5113495bSYour Name 88*5113495bSYour Name Consumer: WBM/REO/SW/FW 89*5113495bSYour Name Producer: RXDMA 90*5113495bSYour Name 91*5113495bSYour Name Parsed from RX_MSDU_END TLV . In the case MSDU spans over 92*5113495bSYour Name multiple buffers, this field will be valid in the Last 93*5113495bSYour Name buffer used by the MSDU 94*5113495bSYour Name 95*5113495bSYour Name <enum 0 Not_last_msdu> There are more MSDUs linked to this 96*5113495bSYour Name MSDU that belongs to this MPDU 97*5113495bSYour Name <enum 1 Last_msdu> this MSDU is the last one in the MPDU. 98*5113495bSYour Name This setting is only allowed in combination with 'Msdu_continuation' 99*5113495bSYour Name set to 0. This implies that when an msdu is spread out over 100*5113495bSYour Name multiple buffers and thus msdu_continuation is set, only 101*5113495bSYour Name for the very last buffer of the msdu, can the 'last_msdu_in_mpdu_flag' 102*5113495bSYour Name be set. 103*5113495bSYour Name 104*5113495bSYour Name When both first_msdu_in_mpdu_flag and last_msdu_in_mpdu_flag 105*5113495bSYour Name are set, the MPDU that this MSDU belongs to only contains 106*5113495bSYour Name a single MSDU. 107*5113495bSYour Name 108*5113495bSYour Name 109*5113495bSYour Name <legal all> 110*5113495bSYour Name */ 111*5113495bSYour Name 112*5113495bSYour Name #define RX_MSDU_DESC_INFO_LAST_MSDU_IN_MPDU_FLAG_OFFSET 0x00000000 113*5113495bSYour Name #define RX_MSDU_DESC_INFO_LAST_MSDU_IN_MPDU_FLAG_LSB 1 114*5113495bSYour Name #define RX_MSDU_DESC_INFO_LAST_MSDU_IN_MPDU_FLAG_MSB 1 115*5113495bSYour Name #define RX_MSDU_DESC_INFO_LAST_MSDU_IN_MPDU_FLAG_MASK 0x00000002 116*5113495bSYour Name 117*5113495bSYour Name 118*5113495bSYour Name /* Description MSDU_CONTINUATION 119*5113495bSYour Name 120*5113495bSYour Name When set, this MSDU buffer was not able to hold the entire 121*5113495bSYour Name MSDU. The next buffer will therefor contain additional 122*5113495bSYour Name information related to this MSDU. 123*5113495bSYour Name 124*5113495bSYour Name <legal all> 125*5113495bSYour Name */ 126*5113495bSYour Name 127*5113495bSYour Name #define RX_MSDU_DESC_INFO_MSDU_CONTINUATION_OFFSET 0x00000000 128*5113495bSYour Name #define RX_MSDU_DESC_INFO_MSDU_CONTINUATION_LSB 2 129*5113495bSYour Name #define RX_MSDU_DESC_INFO_MSDU_CONTINUATION_MSB 2 130*5113495bSYour Name #define RX_MSDU_DESC_INFO_MSDU_CONTINUATION_MASK 0x00000004 131*5113495bSYour Name 132*5113495bSYour Name 133*5113495bSYour Name /* Description MSDU_LENGTH 134*5113495bSYour Name 135*5113495bSYour Name Parsed from RX_MSDU_START TLV . In the case MSDU spans over 136*5113495bSYour Name multiple buffers, this field will be valid in the First 137*5113495bSYour Name buffer used by MSDU. 138*5113495bSYour Name 139*5113495bSYour Name Full MSDU length in bytes after decapsulation. 140*5113495bSYour Name 141*5113495bSYour Name This field is still valid for MPDU frames without A-MSDU. 142*5113495bSYour Name It still represents MSDU length after decapsulation 143*5113495bSYour Name 144*5113495bSYour Name Or in case of RAW MPDUs, it indicates the length of the 145*5113495bSYour Name entire MPDU (without FCS field) 146*5113495bSYour Name <legal all> 147*5113495bSYour Name */ 148*5113495bSYour Name 149*5113495bSYour Name #define RX_MSDU_DESC_INFO_MSDU_LENGTH_OFFSET 0x00000000 150*5113495bSYour Name #define RX_MSDU_DESC_INFO_MSDU_LENGTH_LSB 3 151*5113495bSYour Name #define RX_MSDU_DESC_INFO_MSDU_LENGTH_MSB 16 152*5113495bSYour Name #define RX_MSDU_DESC_INFO_MSDU_LENGTH_MASK 0x0001fff8 153*5113495bSYour Name 154*5113495bSYour Name 155*5113495bSYour Name /* Description MSDU_DROP 156*5113495bSYour Name 157*5113495bSYour Name Parsed from RX_MSDU_END TLV . In the case MSDU spans over 158*5113495bSYour Name multiple buffers, this field will be valid in the Last 159*5113495bSYour Name buffer used by the MSDU 160*5113495bSYour Name 161*5113495bSYour Name When set, REO shall drop this MSDU and not forward it to 162*5113495bSYour Name any other ring... 163*5113495bSYour Name <legal all> 164*5113495bSYour Name */ 165*5113495bSYour Name 166*5113495bSYour Name #define RX_MSDU_DESC_INFO_MSDU_DROP_OFFSET 0x00000000 167*5113495bSYour Name #define RX_MSDU_DESC_INFO_MSDU_DROP_LSB 17 168*5113495bSYour Name #define RX_MSDU_DESC_INFO_MSDU_DROP_MSB 17 169*5113495bSYour Name #define RX_MSDU_DESC_INFO_MSDU_DROP_MASK 0x00020000 170*5113495bSYour Name 171*5113495bSYour Name 172*5113495bSYour Name /* Description SA_IS_VALID 173*5113495bSYour Name 174*5113495bSYour Name Parsed from RX_MSDU_END TLV . In the case MSDU spans over 175*5113495bSYour Name multiple buffers, this field will be valid in the Last 176*5113495bSYour Name buffer used by the MSDU 177*5113495bSYour Name 178*5113495bSYour Name Indicates that OLE found a valid SA entry for this MSDU 179*5113495bSYour Name <legal all> 180*5113495bSYour Name */ 181*5113495bSYour Name 182*5113495bSYour Name #define RX_MSDU_DESC_INFO_SA_IS_VALID_OFFSET 0x00000000 183*5113495bSYour Name #define RX_MSDU_DESC_INFO_SA_IS_VALID_LSB 18 184*5113495bSYour Name #define RX_MSDU_DESC_INFO_SA_IS_VALID_MSB 18 185*5113495bSYour Name #define RX_MSDU_DESC_INFO_SA_IS_VALID_MASK 0x00040000 186*5113495bSYour Name 187*5113495bSYour Name 188*5113495bSYour Name /* Description DA_IS_VALID 189*5113495bSYour Name 190*5113495bSYour Name Parsed from RX_MSDU_END TLV . In the case MSDU spans over 191*5113495bSYour Name multiple buffers, this field will be valid in the Last 192*5113495bSYour Name buffer used by the MSDU 193*5113495bSYour Name 194*5113495bSYour Name Indicates that OLE found a valid DA entry for this MSDU 195*5113495bSYour Name <legal all> 196*5113495bSYour Name */ 197*5113495bSYour Name 198*5113495bSYour Name #define RX_MSDU_DESC_INFO_DA_IS_VALID_OFFSET 0x00000000 199*5113495bSYour Name #define RX_MSDU_DESC_INFO_DA_IS_VALID_LSB 19 200*5113495bSYour Name #define RX_MSDU_DESC_INFO_DA_IS_VALID_MSB 19 201*5113495bSYour Name #define RX_MSDU_DESC_INFO_DA_IS_VALID_MASK 0x00080000 202*5113495bSYour Name 203*5113495bSYour Name 204*5113495bSYour Name /* Description DA_IS_MCBC 205*5113495bSYour Name 206*5113495bSYour Name Field Only valid if "da_is_valid" is set 207*5113495bSYour Name 208*5113495bSYour Name Indicates the DA address was a Multicast of Broadcast address 209*5113495bSYour Name for this MSDU 210*5113495bSYour Name <legal all> 211*5113495bSYour Name */ 212*5113495bSYour Name 213*5113495bSYour Name #define RX_MSDU_DESC_INFO_DA_IS_MCBC_OFFSET 0x00000000 214*5113495bSYour Name #define RX_MSDU_DESC_INFO_DA_IS_MCBC_LSB 20 215*5113495bSYour Name #define RX_MSDU_DESC_INFO_DA_IS_MCBC_MSB 20 216*5113495bSYour Name #define RX_MSDU_DESC_INFO_DA_IS_MCBC_MASK 0x00100000 217*5113495bSYour Name 218*5113495bSYour Name 219*5113495bSYour Name /* Description L3_HEADER_PADDING_MSB 220*5113495bSYour Name 221*5113495bSYour Name Passed on from 'RX_MSDU_END' TLV (only the MSB is reported 222*5113495bSYour Name as the LSB is always zero) 223*5113495bSYour Name Number of bytes padded to make sure that the L3 header will 224*5113495bSYour Name always start of a Dword boundary 225*5113495bSYour Name <legal all> 226*5113495bSYour Name */ 227*5113495bSYour Name 228*5113495bSYour Name #define RX_MSDU_DESC_INFO_L3_HEADER_PADDING_MSB_OFFSET 0x00000000 229*5113495bSYour Name #define RX_MSDU_DESC_INFO_L3_HEADER_PADDING_MSB_LSB 21 230*5113495bSYour Name #define RX_MSDU_DESC_INFO_L3_HEADER_PADDING_MSB_MSB 21 231*5113495bSYour Name #define RX_MSDU_DESC_INFO_L3_HEADER_PADDING_MSB_MASK 0x00200000 232*5113495bSYour Name 233*5113495bSYour Name 234*5113495bSYour Name /* Description TCP_UDP_CHKSUM_FAIL 235*5113495bSYour Name 236*5113495bSYour Name Passed on from 'RX_ATTENTION' TLV 237*5113495bSYour Name Indicates that the computed checksum did not match the checksum 238*5113495bSYour Name in the TCP/UDP header. 239*5113495bSYour Name <legal all> 240*5113495bSYour Name */ 241*5113495bSYour Name 242*5113495bSYour Name #define RX_MSDU_DESC_INFO_TCP_UDP_CHKSUM_FAIL_OFFSET 0x00000000 243*5113495bSYour Name #define RX_MSDU_DESC_INFO_TCP_UDP_CHKSUM_FAIL_LSB 22 244*5113495bSYour Name #define RX_MSDU_DESC_INFO_TCP_UDP_CHKSUM_FAIL_MSB 22 245*5113495bSYour Name #define RX_MSDU_DESC_INFO_TCP_UDP_CHKSUM_FAIL_MASK 0x00400000 246*5113495bSYour Name 247*5113495bSYour Name 248*5113495bSYour Name /* Description IP_CHKSUM_FAIL 249*5113495bSYour Name 250*5113495bSYour Name Passed on from 'RX_ATTENTION' TLV 251*5113495bSYour Name Indicates that the computed checksum did not match the checksum 252*5113495bSYour Name in the IP header. 253*5113495bSYour Name <legal all> 254*5113495bSYour Name */ 255*5113495bSYour Name 256*5113495bSYour Name #define RX_MSDU_DESC_INFO_IP_CHKSUM_FAIL_OFFSET 0x00000000 257*5113495bSYour Name #define RX_MSDU_DESC_INFO_IP_CHKSUM_FAIL_LSB 23 258*5113495bSYour Name #define RX_MSDU_DESC_INFO_IP_CHKSUM_FAIL_MSB 23 259*5113495bSYour Name #define RX_MSDU_DESC_INFO_IP_CHKSUM_FAIL_MASK 0x00800000 260*5113495bSYour Name 261*5113495bSYour Name 262*5113495bSYour Name /* Description FR_DS 263*5113495bSYour Name 264*5113495bSYour Name Passed on from 'RX_MPDU_INFO' structure in 'RX_MPDU_START' 265*5113495bSYour Name TLV 266*5113495bSYour Name Set if the 'from DS' bit is set in the frame control. 267*5113495bSYour Name <legal all> 268*5113495bSYour Name */ 269*5113495bSYour Name 270*5113495bSYour Name #define RX_MSDU_DESC_INFO_FR_DS_OFFSET 0x00000000 271*5113495bSYour Name #define RX_MSDU_DESC_INFO_FR_DS_LSB 24 272*5113495bSYour Name #define RX_MSDU_DESC_INFO_FR_DS_MSB 24 273*5113495bSYour Name #define RX_MSDU_DESC_INFO_FR_DS_MASK 0x01000000 274*5113495bSYour Name 275*5113495bSYour Name 276*5113495bSYour Name /* Description TO_DS 277*5113495bSYour Name 278*5113495bSYour Name Passed on from 'RX_MPDU_INFO' structure in 'RX_MPDU_START' 279*5113495bSYour Name TLV 280*5113495bSYour Name Set if the 'to DS' bit is set in the frame control. 281*5113495bSYour Name <legal all> 282*5113495bSYour Name */ 283*5113495bSYour Name 284*5113495bSYour Name #define RX_MSDU_DESC_INFO_TO_DS_OFFSET 0x00000000 285*5113495bSYour Name #define RX_MSDU_DESC_INFO_TO_DS_LSB 25 286*5113495bSYour Name #define RX_MSDU_DESC_INFO_TO_DS_MSB 25 287*5113495bSYour Name #define RX_MSDU_DESC_INFO_TO_DS_MASK 0x02000000 288*5113495bSYour Name 289*5113495bSYour Name 290*5113495bSYour Name /* Description INTRA_BSS 291*5113495bSYour Name 292*5113495bSYour Name This packet needs intra-BSS routing by SW as the 'vdev_id' 293*5113495bSYour Name for the destination is the same as the 'vdev_id' (from 'RX_MPDU_PCU_START') 294*5113495bSYour Name that this MSDU was got in. 295*5113495bSYour Name 296*5113495bSYour Name <legal all> 297*5113495bSYour Name */ 298*5113495bSYour Name 299*5113495bSYour Name #define RX_MSDU_DESC_INFO_INTRA_BSS_OFFSET 0x00000000 300*5113495bSYour Name #define RX_MSDU_DESC_INFO_INTRA_BSS_LSB 26 301*5113495bSYour Name #define RX_MSDU_DESC_INFO_INTRA_BSS_MSB 26 302*5113495bSYour Name #define RX_MSDU_DESC_INFO_INTRA_BSS_MASK 0x04000000 303*5113495bSYour Name 304*5113495bSYour Name 305*5113495bSYour Name /* Description DEST_CHIP_ID 306*5113495bSYour Name 307*5113495bSYour Name If intra_bss is set, copied by RXOLE/RXDMA from 'ADDR_SEARCH_ENTRY' 308*5113495bSYour Name to support intra-BSS routing with multi-chip multi-link 309*5113495bSYour Name operation. 310*5113495bSYour Name 311*5113495bSYour Name This indicates into which chip's TCL the packet should be 312*5113495bSYour Name queued. 313*5113495bSYour Name 314*5113495bSYour Name <legal all> 315*5113495bSYour Name */ 316*5113495bSYour Name 317*5113495bSYour Name #define RX_MSDU_DESC_INFO_DEST_CHIP_ID_OFFSET 0x00000000 318*5113495bSYour Name #define RX_MSDU_DESC_INFO_DEST_CHIP_ID_LSB 27 319*5113495bSYour Name #define RX_MSDU_DESC_INFO_DEST_CHIP_ID_MSB 28 320*5113495bSYour Name #define RX_MSDU_DESC_INFO_DEST_CHIP_ID_MASK 0x18000000 321*5113495bSYour Name 322*5113495bSYour Name 323*5113495bSYour Name /* Description DECAP_FORMAT 324*5113495bSYour Name 325*5113495bSYour Name Indicates the format after decapsulation: 326*5113495bSYour Name 327*5113495bSYour Name <enum 0 RAW> No encapsulation 328*5113495bSYour Name <enum 1 Native_WiFi> 329*5113495bSYour Name <enum 2 Ethernet> Ethernet 2 (DIX) or 802.3 (uses SNAP/LLC) 330*5113495bSYour Name 331*5113495bSYour Name <enum 3 802_3> Indicate Ethernet 332*5113495bSYour Name 333*5113495bSYour Name <legal all> 334*5113495bSYour Name */ 335*5113495bSYour Name 336*5113495bSYour Name #define RX_MSDU_DESC_INFO_DECAP_FORMAT_OFFSET 0x00000000 337*5113495bSYour Name #define RX_MSDU_DESC_INFO_DECAP_FORMAT_LSB 29 338*5113495bSYour Name #define RX_MSDU_DESC_INFO_DECAP_FORMAT_MSB 30 339*5113495bSYour Name #define RX_MSDU_DESC_INFO_DECAP_FORMAT_MASK 0x60000000 340*5113495bSYour Name 341*5113495bSYour Name 342*5113495bSYour Name /* Description DEST_CHIP_PMAC_ID 343*5113495bSYour Name 344*5113495bSYour Name If intra_bss is set, copied by RXOLE/RXDMA from 'ADDR_SEARCH_ENTRY' 345*5113495bSYour Name to support intra-BSS routing with multi-chip multi-link 346*5113495bSYour Name operation. 347*5113495bSYour Name 348*5113495bSYour Name This indicates into which link/'vdev' the packet should 349*5113495bSYour Name be queued in TCL. 350*5113495bSYour Name 351*5113495bSYour Name <legal all> 352*5113495bSYour Name */ 353*5113495bSYour Name 354*5113495bSYour Name #define RX_MSDU_DESC_INFO_DEST_CHIP_PMAC_ID_OFFSET 0x00000000 355*5113495bSYour Name #define RX_MSDU_DESC_INFO_DEST_CHIP_PMAC_ID_LSB 31 356*5113495bSYour Name #define RX_MSDU_DESC_INFO_DEST_CHIP_PMAC_ID_MSB 31 357*5113495bSYour Name #define RX_MSDU_DESC_INFO_DEST_CHIP_PMAC_ID_MASK 0x80000000 358*5113495bSYour Name 359*5113495bSYour Name 360*5113495bSYour Name 361*5113495bSYour Name #endif // RX_MSDU_DESC_INFO 362