/* Copyright (c) 2022, Qualcomm Innovation Center, Inc. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #ifndef _HE_SIG_A_SU_INFO_H_ #define _HE_SIG_A_SU_INFO_H_ #if !defined(__ASSEMBLER__) #endif #define NUM_OF_DWORDS_HE_SIG_A_SU_INFO 2 struct he_sig_a_su_info { #ifndef WIFI_BIT_ORDER_BIG_ENDIAN uint32_t format_indication : 1, // [0:0] beam_change : 1, // [1:1] dl_ul_flag : 1, // [2:2] transmit_mcs : 4, // [6:3] dcm : 1, // [7:7] bss_color_id : 6, // [13:8] reserved_0a : 1, // [14:14] spatial_reuse : 4, // [18:15] transmit_bw : 2, // [20:19] cp_ltf_size : 2, // [22:21] nsts : 3, // [25:23] reserved_0b : 6; // [31:26] uint32_t txop_duration : 7, // [6:0] coding : 1, // [7:7] ldpc_extra_symbol : 1, // [8:8] stbc : 1, // [9:9] txbf : 1, // [10:10] packet_extension_a_factor : 2, // [12:11] packet_extension_pe_disambiguity : 1, // [13:13] reserved_1a : 1, // [14:14] doppler_indication : 1, // [15:15] crc : 4, // [19:16] tail : 6, // [25:20] dot11ax_su_extended : 1, // [26:26] dot11ax_ext_ru_size : 3, // [29:27] rx_ndp : 1, // [30:30] rx_integrity_check_passed : 1; // [31:31] #else uint32_t reserved_0b : 6, // [31:26] nsts : 3, // [25:23] cp_ltf_size : 2, // [22:21] transmit_bw : 2, // [20:19] spatial_reuse : 4, // [18:15] reserved_0a : 1, // [14:14] bss_color_id : 6, // [13:8] dcm : 1, // [7:7] transmit_mcs : 4, // [6:3] dl_ul_flag : 1, // [2:2] beam_change : 1, // [1:1] format_indication : 1; // [0:0] uint32_t rx_integrity_check_passed : 1, // [31:31] rx_ndp : 1, // [30:30] dot11ax_ext_ru_size : 3, // [29:27] dot11ax_su_extended : 1, // [26:26] tail : 6, // [25:20] crc : 4, // [19:16] doppler_indication : 1, // [15:15] reserved_1a : 1, // [14:14] packet_extension_pe_disambiguity : 1, // [13:13] packet_extension_a_factor : 2, // [12:11] txbf : 1, // [10:10] stbc : 1, // [9:9] ldpc_extra_symbol : 1, // [8:8] coding : 1, // [7:7] txop_duration : 7; // [6:0] #endif }; /* Description FORMAT_INDICATION */ #define HE_SIG_A_SU_INFO_FORMAT_INDICATION_OFFSET 0x00000000 #define HE_SIG_A_SU_INFO_FORMAT_INDICATION_LSB 0 #define HE_SIG_A_SU_INFO_FORMAT_INDICATION_MSB 0 #define HE_SIG_A_SU_INFO_FORMAT_INDICATION_MASK 0x00000001 /* Description BEAM_CHANGE Indicates whether spatial mapping is changed between legacy and HE portion of preamble. If not, channel estimation can include legacy preamble to improve accuracy */ #define HE_SIG_A_SU_INFO_BEAM_CHANGE_OFFSET 0x00000000 #define HE_SIG_A_SU_INFO_BEAM_CHANGE_LSB 1 #define HE_SIG_A_SU_INFO_BEAM_CHANGE_MSB 1 #define HE_SIG_A_SU_INFO_BEAM_CHANGE_MASK 0x00000002 /* Description DL_UL_FLAG Differentiates between DL and UL transmission */ #define HE_SIG_A_SU_INFO_DL_UL_FLAG_OFFSET 0x00000000 #define HE_SIG_A_SU_INFO_DL_UL_FLAG_LSB 2 #define HE_SIG_A_SU_INFO_DL_UL_FLAG_MSB 2 #define HE_SIG_A_SU_INFO_DL_UL_FLAG_MASK 0x00000004 /* Description TRANSMIT_MCS Indicates the data MCS Field Used by MAC HW */ #define HE_SIG_A_SU_INFO_TRANSMIT_MCS_OFFSET 0x00000000 #define HE_SIG_A_SU_INFO_TRANSMIT_MCS_LSB 3 #define HE_SIG_A_SU_INFO_TRANSMIT_MCS_MSB 6 #define HE_SIG_A_SU_INFO_TRANSMIT_MCS_MASK 0x00000078 /* Description DCM Indicates whether dual sub-carrier modulation is applied 0: No DCM 1:DCM */ #define HE_SIG_A_SU_INFO_DCM_OFFSET 0x00000000 #define HE_SIG_A_SU_INFO_DCM_LSB 7 #define HE_SIG_A_SU_INFO_DCM_MSB 7 #define HE_SIG_A_SU_INFO_DCM_MASK 0x00000080 /* Description BSS_COLOR_ID BSS color ID Field Used by MAC HW */ #define HE_SIG_A_SU_INFO_BSS_COLOR_ID_OFFSET 0x00000000 #define HE_SIG_A_SU_INFO_BSS_COLOR_ID_LSB 8 #define HE_SIG_A_SU_INFO_BSS_COLOR_ID_MSB 13 #define HE_SIG_A_SU_INFO_BSS_COLOR_ID_MASK 0x00003f00 /* Description RESERVED_0A Note: spec indicates this shall be set to 1 */ #define HE_SIG_A_SU_INFO_RESERVED_0A_OFFSET 0x00000000 #define HE_SIG_A_SU_INFO_RESERVED_0A_LSB 14 #define HE_SIG_A_SU_INFO_RESERVED_0A_MSB 14 #define HE_SIG_A_SU_INFO_RESERVED_0A_MASK 0x00004000 /* Description SPATIAL_REUSE Spatial reuse For 20MHz one SR field corresponding to entire 20MHz (other 3 fields indicate identical values) For 40MHz two SR fields for each 20MHz (other 2 fields indicate identical values) For 80MHz four SR fields for each 20MHz For 160MHz four SR fields for each 40MHz */ #define HE_SIG_A_SU_INFO_SPATIAL_REUSE_OFFSET 0x00000000 #define HE_SIG_A_SU_INFO_SPATIAL_REUSE_LSB 15 #define HE_SIG_A_SU_INFO_SPATIAL_REUSE_MSB 18 #define HE_SIG_A_SU_INFO_SPATIAL_REUSE_MASK 0x00078000 /* Description TRANSMIT_BW Bandwidth of the PPDU. For HE SU PPDU 20 Mhz 40 Mhz 80 Mhz 160 MHz or 80+80 MHz For HE Extended Range SU PPDU Set to 0 for 242-tone RU Set to 1 for right 106-tone RU within the primary 20 MHz On RX side, Field Used by MAC HW */ #define HE_SIG_A_SU_INFO_TRANSMIT_BW_OFFSET 0x00000000 #define HE_SIG_A_SU_INFO_TRANSMIT_BW_LSB 19 #define HE_SIG_A_SU_INFO_TRANSMIT_BW_MSB 20 #define HE_SIG_A_SU_INFO_TRANSMIT_BW_MASK 0x00180000 /* Description CP_LTF_SIZE Indicates the CP and HE-LTF type 1xLTF + 0.8 us CP 2x LTF + 0.8 µs CP 2x LTF + 1.6 µs CP When DCM == 0 OR STBC == 0: 4x LTF + 3.2 µs CP When DCM == 1 AND STBC == 1: 4x LTF + 0.8 µs CP. Note: In this scenario, Neither DCM nor STBC is applied to HE data field. NOTE: If ( DCM == 1 ) and ( MCS > 0 ) and (STBC == 0) 0 = 1xLTF + 0.4 usec 1 = 2xLTF + 0.4 usec 2~3 = Reserved */ #define HE_SIG_A_SU_INFO_CP_LTF_SIZE_OFFSET 0x00000000 #define HE_SIG_A_SU_INFO_CP_LTF_SIZE_LSB 21 #define HE_SIG_A_SU_INFO_CP_LTF_SIZE_MSB 22 #define HE_SIG_A_SU_INFO_CP_LTF_SIZE_MASK 0x00600000 /* Description NSTS Indicates number of streams used for the SU transmission For HE SU PPDU Set to n for n+1 space time stream, where n = 0, 1, 2,.....,7. For HE Extended Range PPDU Set to 0 for 1 space time stream. Value 1 is TBD Values 2 - 7 are reserved */ #define HE_SIG_A_SU_INFO_NSTS_OFFSET 0x00000000 #define HE_SIG_A_SU_INFO_NSTS_LSB 23 #define HE_SIG_A_SU_INFO_NSTS_MSB 25 #define HE_SIG_A_SU_INFO_NSTS_MASK 0x03800000 /* Description RESERVED_0B */ #define HE_SIG_A_SU_INFO_RESERVED_0B_OFFSET 0x00000000 #define HE_SIG_A_SU_INFO_RESERVED_0B_LSB 26 #define HE_SIG_A_SU_INFO_RESERVED_0B_MSB 31 #define HE_SIG_A_SU_INFO_RESERVED_0B_MASK 0xfc000000 /* Description TXOP_DURATION Indicates the remaining time in the current TXOP Field Used by MAC HW */ #define HE_SIG_A_SU_INFO_TXOP_DURATION_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_TXOP_DURATION_LSB 0 #define HE_SIG_A_SU_INFO_TXOP_DURATION_MSB 6 #define HE_SIG_A_SU_INFO_TXOP_DURATION_MASK 0x0000007f /* Description CODING Distinguishes between BCC and LDPC coding. 0: BCC 1: LDPC */ #define HE_SIG_A_SU_INFO_CODING_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_CODING_LSB 7 #define HE_SIG_A_SU_INFO_CODING_MSB 7 #define HE_SIG_A_SU_INFO_CODING_MASK 0x00000080 /* Description LDPC_EXTRA_SYMBOL If LDPC, 0: LDPC extra symbol not present 1: LDPC extra symbol present Else Set to 1 */ #define HE_SIG_A_SU_INFO_LDPC_EXTRA_SYMBOL_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_LDPC_EXTRA_SYMBOL_LSB 8 #define HE_SIG_A_SU_INFO_LDPC_EXTRA_SYMBOL_MSB 8 #define HE_SIG_A_SU_INFO_LDPC_EXTRA_SYMBOL_MASK 0x00000100 /* Description STBC Indicates whether STBC is applied 0: No STBC 1: STBC */ #define HE_SIG_A_SU_INFO_STBC_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_STBC_LSB 9 #define HE_SIG_A_SU_INFO_STBC_MSB 9 #define HE_SIG_A_SU_INFO_STBC_MASK 0x00000200 /* Description TXBF Indicates whether beamforming is applied 0: No beamforming 1: beamforming */ #define HE_SIG_A_SU_INFO_TXBF_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_TXBF_LSB 10 #define HE_SIG_A_SU_INFO_TXBF_MSB 10 #define HE_SIG_A_SU_INFO_TXBF_MASK 0x00000400 /* Description PACKET_EXTENSION_A_FACTOR Common trigger info the packet extension duration of the trigger-based PPDU response with these two bits indicating the "a-factor" */ #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_A_FACTOR_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_A_FACTOR_LSB 11 #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_A_FACTOR_MSB 12 #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_A_FACTOR_MASK 0x00001800 /* Description PACKET_EXTENSION_PE_DISAMBIGUITY Common trigger info the packet extension duration of the trigger-based PPDU response with this bit indicating the PE-Disambiguity */ #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_LSB 13 #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_MSB 13 #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_MASK 0x00002000 /* Description RESERVED_1A Note: per standard, set to 1 */ #define HE_SIG_A_SU_INFO_RESERVED_1A_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_RESERVED_1A_LSB 14 #define HE_SIG_A_SU_INFO_RESERVED_1A_MSB 14 #define HE_SIG_A_SU_INFO_RESERVED_1A_MASK 0x00004000 /* Description DOPPLER_INDICATION 0: No Doppler support 1: Doppler support */ #define HE_SIG_A_SU_INFO_DOPPLER_INDICATION_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_DOPPLER_INDICATION_LSB 15 #define HE_SIG_A_SU_INFO_DOPPLER_INDICATION_MSB 15 #define HE_SIG_A_SU_INFO_DOPPLER_INDICATION_MASK 0x00008000 /* Description CRC CRC for HE-SIG-A contents. */ #define HE_SIG_A_SU_INFO_CRC_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_CRC_LSB 16 #define HE_SIG_A_SU_INFO_CRC_MSB 19 #define HE_SIG_A_SU_INFO_CRC_MASK 0x000f0000 /* Description TAIL */ #define HE_SIG_A_SU_INFO_TAIL_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_TAIL_LSB 20 #define HE_SIG_A_SU_INFO_TAIL_MSB 25 #define HE_SIG_A_SU_INFO_TAIL_MASK 0x03f00000 /* Description DOT11AX_SU_EXTENDED TX side: Set to 0 RX side: On RX side, evaluated by MAC HW. This is the only way for MAC RX to know that this was an HE_SIG_A_SU received in 'extended' format When set, the 11ax frame is of the extended range format */ #define HE_SIG_A_SU_INFO_DOT11AX_SU_EXTENDED_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_DOT11AX_SU_EXTENDED_LSB 26 #define HE_SIG_A_SU_INFO_DOT11AX_SU_EXTENDED_MSB 26 #define HE_SIG_A_SU_INFO_DOT11AX_SU_EXTENDED_MASK 0x04000000 /* Description DOT11AX_EXT_RU_SIZE TX side: Set to 0 RX side: Field only contains valid info when dot11ax_su_extended is set. On RX side, evaluated by MAC HW. This is the only way for MAC RX to know what the number of based RUs was in this extended range reception. It is used by the MAC to determine the RU size for the response... */ #define HE_SIG_A_SU_INFO_DOT11AX_EXT_RU_SIZE_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_DOT11AX_EXT_RU_SIZE_LSB 27 #define HE_SIG_A_SU_INFO_DOT11AX_EXT_RU_SIZE_MSB 29 #define HE_SIG_A_SU_INFO_DOT11AX_EXT_RU_SIZE_MASK 0x38000000 /* Description RX_NDP TX side: Set to 0 RX side:Valid on RX side only, and looked at by MAC HW When set, PHY has received (expected) NDP frame */ #define HE_SIG_A_SU_INFO_RX_NDP_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_RX_NDP_LSB 30 #define HE_SIG_A_SU_INFO_RX_NDP_MSB 30 #define HE_SIG_A_SU_INFO_RX_NDP_MASK 0x40000000 /* Description RX_INTEGRITY_CHECK_PASSED TX side: Set to 0 RX side: Set to 1 if PHY determines the HE-SIG-A CRC check has passed, else set to 0 */ #define HE_SIG_A_SU_INFO_RX_INTEGRITY_CHECK_PASSED_OFFSET 0x00000004 #define HE_SIG_A_SU_INFO_RX_INTEGRITY_CHECK_PASSED_LSB 31 #define HE_SIG_A_SU_INFO_RX_INTEGRITY_CHECK_PASSED_MSB 31 #define HE_SIG_A_SU_INFO_RX_INTEGRITY_CHECK_PASSED_MASK 0x80000000 #endif // HE_SIG_A_SU_INFO