xref: /wlan-driver/fw-api/hw/kiwi/v2/he_sig_a_su_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name 
2*5113495bSYour Name /*
3*5113495bSYour Name  * Copyright (c) 2022 Qualcomm Innovation Center, Inc. All rights reserved.
4*5113495bSYour Name  *
5*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
6*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
7*5113495bSYour Name  * above copyright notice and this permission notice appear in all
8*5113495bSYour Name  * copies.
9*5113495bSYour Name  *
10*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
18*5113495bSYour Name  */
19*5113495bSYour Name 
20*5113495bSYour Name 
21*5113495bSYour Name 
22*5113495bSYour Name #ifndef _HE_SIG_A_SU_INFO_H_
23*5113495bSYour Name #define _HE_SIG_A_SU_INFO_H_
24*5113495bSYour Name #if !defined(__ASSEMBLER__)
25*5113495bSYour Name #endif
26*5113495bSYour Name 
27*5113495bSYour Name #define NUM_OF_DWORDS_HE_SIG_A_SU_INFO 2
28*5113495bSYour Name 
29*5113495bSYour Name struct he_sig_a_su_info {
30*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
31*5113495bSYour Name              uint32_t format_indication                                       :  1,
32*5113495bSYour Name                       beam_change                                             :  1,
33*5113495bSYour Name                       dl_ul_flag                                              :  1,
34*5113495bSYour Name                       transmit_mcs                                            :  4,
35*5113495bSYour Name                       dcm                                                     :  1,
36*5113495bSYour Name                       bss_color_id                                            :  6,
37*5113495bSYour Name                       reserved_0a                                             :  1,
38*5113495bSYour Name                       spatial_reuse                                           :  4,
39*5113495bSYour Name                       transmit_bw                                             :  2,
40*5113495bSYour Name                       cp_ltf_size                                             :  2,
41*5113495bSYour Name                       nsts                                                    :  3,
42*5113495bSYour Name                       reserved_0b                                             :  6;
43*5113495bSYour Name              uint32_t txop_duration                                           :  7,
44*5113495bSYour Name                       coding                                                  :  1,
45*5113495bSYour Name                       ldpc_extra_symbol                                       :  1,
46*5113495bSYour Name                       stbc                                                    :  1,
47*5113495bSYour Name                       txbf                                                    :  1,
48*5113495bSYour Name                       packet_extension_a_factor                               :  2,
49*5113495bSYour Name                       packet_extension_pe_disambiguity                        :  1,
50*5113495bSYour Name                       reserved_1a                                             :  1,
51*5113495bSYour Name                       doppler_indication                                      :  1,
52*5113495bSYour Name                       crc                                                     :  4,
53*5113495bSYour Name                       tail                                                    :  6,
54*5113495bSYour Name                       dot11ax_su_extended                                     :  1,
55*5113495bSYour Name                       dot11ax_ext_ru_size                                     :  3,
56*5113495bSYour Name                       rx_ndp                                                  :  1,
57*5113495bSYour Name                       rx_integrity_check_passed                               :  1;
58*5113495bSYour Name #else
59*5113495bSYour Name              uint32_t reserved_0b                                             :  6,
60*5113495bSYour Name                       nsts                                                    :  3,
61*5113495bSYour Name                       cp_ltf_size                                             :  2,
62*5113495bSYour Name                       transmit_bw                                             :  2,
63*5113495bSYour Name                       spatial_reuse                                           :  4,
64*5113495bSYour Name                       reserved_0a                                             :  1,
65*5113495bSYour Name                       bss_color_id                                            :  6,
66*5113495bSYour Name                       dcm                                                     :  1,
67*5113495bSYour Name                       transmit_mcs                                            :  4,
68*5113495bSYour Name                       dl_ul_flag                                              :  1,
69*5113495bSYour Name                       beam_change                                             :  1,
70*5113495bSYour Name                       format_indication                                       :  1;
71*5113495bSYour Name              uint32_t rx_integrity_check_passed                               :  1,
72*5113495bSYour Name                       rx_ndp                                                  :  1,
73*5113495bSYour Name                       dot11ax_ext_ru_size                                     :  3,
74*5113495bSYour Name                       dot11ax_su_extended                                     :  1,
75*5113495bSYour Name                       tail                                                    :  6,
76*5113495bSYour Name                       crc                                                     :  4,
77*5113495bSYour Name                       doppler_indication                                      :  1,
78*5113495bSYour Name                       reserved_1a                                             :  1,
79*5113495bSYour Name                       packet_extension_pe_disambiguity                        :  1,
80*5113495bSYour Name                       packet_extension_a_factor                               :  2,
81*5113495bSYour Name                       txbf                                                    :  1,
82*5113495bSYour Name                       stbc                                                    :  1,
83*5113495bSYour Name                       ldpc_extra_symbol                                       :  1,
84*5113495bSYour Name                       coding                                                  :  1,
85*5113495bSYour Name                       txop_duration                                           :  7;
86*5113495bSYour Name #endif
87*5113495bSYour Name };
88*5113495bSYour Name 
89*5113495bSYour Name #define HE_SIG_A_SU_INFO_FORMAT_INDICATION_OFFSET                                   0x00000000
90*5113495bSYour Name #define HE_SIG_A_SU_INFO_FORMAT_INDICATION_LSB                                      0
91*5113495bSYour Name #define HE_SIG_A_SU_INFO_FORMAT_INDICATION_MSB                                      0
92*5113495bSYour Name #define HE_SIG_A_SU_INFO_FORMAT_INDICATION_MASK                                     0x00000001
93*5113495bSYour Name 
94*5113495bSYour Name #define HE_SIG_A_SU_INFO_BEAM_CHANGE_OFFSET                                         0x00000000
95*5113495bSYour Name #define HE_SIG_A_SU_INFO_BEAM_CHANGE_LSB                                            1
96*5113495bSYour Name #define HE_SIG_A_SU_INFO_BEAM_CHANGE_MSB                                            1
97*5113495bSYour Name #define HE_SIG_A_SU_INFO_BEAM_CHANGE_MASK                                           0x00000002
98*5113495bSYour Name 
99*5113495bSYour Name #define HE_SIG_A_SU_INFO_DL_UL_FLAG_OFFSET                                          0x00000000
100*5113495bSYour Name #define HE_SIG_A_SU_INFO_DL_UL_FLAG_LSB                                             2
101*5113495bSYour Name #define HE_SIG_A_SU_INFO_DL_UL_FLAG_MSB                                             2
102*5113495bSYour Name #define HE_SIG_A_SU_INFO_DL_UL_FLAG_MASK                                            0x00000004
103*5113495bSYour Name 
104*5113495bSYour Name #define HE_SIG_A_SU_INFO_TRANSMIT_MCS_OFFSET                                        0x00000000
105*5113495bSYour Name #define HE_SIG_A_SU_INFO_TRANSMIT_MCS_LSB                                           3
106*5113495bSYour Name #define HE_SIG_A_SU_INFO_TRANSMIT_MCS_MSB                                           6
107*5113495bSYour Name #define HE_SIG_A_SU_INFO_TRANSMIT_MCS_MASK                                          0x00000078
108*5113495bSYour Name 
109*5113495bSYour Name #define HE_SIG_A_SU_INFO_DCM_OFFSET                                                 0x00000000
110*5113495bSYour Name #define HE_SIG_A_SU_INFO_DCM_LSB                                                    7
111*5113495bSYour Name #define HE_SIG_A_SU_INFO_DCM_MSB                                                    7
112*5113495bSYour Name #define HE_SIG_A_SU_INFO_DCM_MASK                                                   0x00000080
113*5113495bSYour Name 
114*5113495bSYour Name #define HE_SIG_A_SU_INFO_BSS_COLOR_ID_OFFSET                                        0x00000000
115*5113495bSYour Name #define HE_SIG_A_SU_INFO_BSS_COLOR_ID_LSB                                           8
116*5113495bSYour Name #define HE_SIG_A_SU_INFO_BSS_COLOR_ID_MSB                                           13
117*5113495bSYour Name #define HE_SIG_A_SU_INFO_BSS_COLOR_ID_MASK                                          0x00003f00
118*5113495bSYour Name 
119*5113495bSYour Name #define HE_SIG_A_SU_INFO_RESERVED_0A_OFFSET                                         0x00000000
120*5113495bSYour Name #define HE_SIG_A_SU_INFO_RESERVED_0A_LSB                                            14
121*5113495bSYour Name #define HE_SIG_A_SU_INFO_RESERVED_0A_MSB                                            14
122*5113495bSYour Name #define HE_SIG_A_SU_INFO_RESERVED_0A_MASK                                           0x00004000
123*5113495bSYour Name 
124*5113495bSYour Name #define HE_SIG_A_SU_INFO_SPATIAL_REUSE_OFFSET                                       0x00000000
125*5113495bSYour Name #define HE_SIG_A_SU_INFO_SPATIAL_REUSE_LSB                                          15
126*5113495bSYour Name #define HE_SIG_A_SU_INFO_SPATIAL_REUSE_MSB                                          18
127*5113495bSYour Name #define HE_SIG_A_SU_INFO_SPATIAL_REUSE_MASK                                         0x00078000
128*5113495bSYour Name 
129*5113495bSYour Name #define HE_SIG_A_SU_INFO_TRANSMIT_BW_OFFSET                                         0x00000000
130*5113495bSYour Name #define HE_SIG_A_SU_INFO_TRANSMIT_BW_LSB                                            19
131*5113495bSYour Name #define HE_SIG_A_SU_INFO_TRANSMIT_BW_MSB                                            20
132*5113495bSYour Name #define HE_SIG_A_SU_INFO_TRANSMIT_BW_MASK                                           0x00180000
133*5113495bSYour Name 
134*5113495bSYour Name #define HE_SIG_A_SU_INFO_CP_LTF_SIZE_OFFSET                                         0x00000000
135*5113495bSYour Name #define HE_SIG_A_SU_INFO_CP_LTF_SIZE_LSB                                            21
136*5113495bSYour Name #define HE_SIG_A_SU_INFO_CP_LTF_SIZE_MSB                                            22
137*5113495bSYour Name #define HE_SIG_A_SU_INFO_CP_LTF_SIZE_MASK                                           0x00600000
138*5113495bSYour Name 
139*5113495bSYour Name #define HE_SIG_A_SU_INFO_NSTS_OFFSET                                                0x00000000
140*5113495bSYour Name #define HE_SIG_A_SU_INFO_NSTS_LSB                                                   23
141*5113495bSYour Name #define HE_SIG_A_SU_INFO_NSTS_MSB                                                   25
142*5113495bSYour Name #define HE_SIG_A_SU_INFO_NSTS_MASK                                                  0x03800000
143*5113495bSYour Name 
144*5113495bSYour Name #define HE_SIG_A_SU_INFO_RESERVED_0B_OFFSET                                         0x00000000
145*5113495bSYour Name #define HE_SIG_A_SU_INFO_RESERVED_0B_LSB                                            26
146*5113495bSYour Name #define HE_SIG_A_SU_INFO_RESERVED_0B_MSB                                            31
147*5113495bSYour Name #define HE_SIG_A_SU_INFO_RESERVED_0B_MASK                                           0xfc000000
148*5113495bSYour Name 
149*5113495bSYour Name #define HE_SIG_A_SU_INFO_TXOP_DURATION_OFFSET                                       0x00000004
150*5113495bSYour Name #define HE_SIG_A_SU_INFO_TXOP_DURATION_LSB                                          0
151*5113495bSYour Name #define HE_SIG_A_SU_INFO_TXOP_DURATION_MSB                                          6
152*5113495bSYour Name #define HE_SIG_A_SU_INFO_TXOP_DURATION_MASK                                         0x0000007f
153*5113495bSYour Name 
154*5113495bSYour Name #define HE_SIG_A_SU_INFO_CODING_OFFSET                                              0x00000004
155*5113495bSYour Name #define HE_SIG_A_SU_INFO_CODING_LSB                                                 7
156*5113495bSYour Name #define HE_SIG_A_SU_INFO_CODING_MSB                                                 7
157*5113495bSYour Name #define HE_SIG_A_SU_INFO_CODING_MASK                                                0x00000080
158*5113495bSYour Name 
159*5113495bSYour Name #define HE_SIG_A_SU_INFO_LDPC_EXTRA_SYMBOL_OFFSET                                   0x00000004
160*5113495bSYour Name #define HE_SIG_A_SU_INFO_LDPC_EXTRA_SYMBOL_LSB                                      8
161*5113495bSYour Name #define HE_SIG_A_SU_INFO_LDPC_EXTRA_SYMBOL_MSB                                      8
162*5113495bSYour Name #define HE_SIG_A_SU_INFO_LDPC_EXTRA_SYMBOL_MASK                                     0x00000100
163*5113495bSYour Name 
164*5113495bSYour Name #define HE_SIG_A_SU_INFO_STBC_OFFSET                                                0x00000004
165*5113495bSYour Name #define HE_SIG_A_SU_INFO_STBC_LSB                                                   9
166*5113495bSYour Name #define HE_SIG_A_SU_INFO_STBC_MSB                                                   9
167*5113495bSYour Name #define HE_SIG_A_SU_INFO_STBC_MASK                                                  0x00000200
168*5113495bSYour Name 
169*5113495bSYour Name #define HE_SIG_A_SU_INFO_TXBF_OFFSET                                                0x00000004
170*5113495bSYour Name #define HE_SIG_A_SU_INFO_TXBF_LSB                                                   10
171*5113495bSYour Name #define HE_SIG_A_SU_INFO_TXBF_MSB                                                   10
172*5113495bSYour Name #define HE_SIG_A_SU_INFO_TXBF_MASK                                                  0x00000400
173*5113495bSYour Name 
174*5113495bSYour Name #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_A_FACTOR_OFFSET                           0x00000004
175*5113495bSYour Name #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_A_FACTOR_LSB                              11
176*5113495bSYour Name #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_A_FACTOR_MSB                              12
177*5113495bSYour Name #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_A_FACTOR_MASK                             0x00001800
178*5113495bSYour Name 
179*5113495bSYour Name #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_OFFSET                    0x00000004
180*5113495bSYour Name #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_LSB                       13
181*5113495bSYour Name #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_MSB                       13
182*5113495bSYour Name #define HE_SIG_A_SU_INFO_PACKET_EXTENSION_PE_DISAMBIGUITY_MASK                      0x00002000
183*5113495bSYour Name 
184*5113495bSYour Name #define HE_SIG_A_SU_INFO_RESERVED_1A_OFFSET                                         0x00000004
185*5113495bSYour Name #define HE_SIG_A_SU_INFO_RESERVED_1A_LSB                                            14
186*5113495bSYour Name #define HE_SIG_A_SU_INFO_RESERVED_1A_MSB                                            14
187*5113495bSYour Name #define HE_SIG_A_SU_INFO_RESERVED_1A_MASK                                           0x00004000
188*5113495bSYour Name 
189*5113495bSYour Name #define HE_SIG_A_SU_INFO_DOPPLER_INDICATION_OFFSET                                  0x00000004
190*5113495bSYour Name #define HE_SIG_A_SU_INFO_DOPPLER_INDICATION_LSB                                     15
191*5113495bSYour Name #define HE_SIG_A_SU_INFO_DOPPLER_INDICATION_MSB                                     15
192*5113495bSYour Name #define HE_SIG_A_SU_INFO_DOPPLER_INDICATION_MASK                                    0x00008000
193*5113495bSYour Name 
194*5113495bSYour Name #define HE_SIG_A_SU_INFO_CRC_OFFSET                                                 0x00000004
195*5113495bSYour Name #define HE_SIG_A_SU_INFO_CRC_LSB                                                    16
196*5113495bSYour Name #define HE_SIG_A_SU_INFO_CRC_MSB                                                    19
197*5113495bSYour Name #define HE_SIG_A_SU_INFO_CRC_MASK                                                   0x000f0000
198*5113495bSYour Name 
199*5113495bSYour Name #define HE_SIG_A_SU_INFO_TAIL_OFFSET                                                0x00000004
200*5113495bSYour Name #define HE_SIG_A_SU_INFO_TAIL_LSB                                                   20
201*5113495bSYour Name #define HE_SIG_A_SU_INFO_TAIL_MSB                                                   25
202*5113495bSYour Name #define HE_SIG_A_SU_INFO_TAIL_MASK                                                  0x03f00000
203*5113495bSYour Name 
204*5113495bSYour Name #define HE_SIG_A_SU_INFO_DOT11AX_SU_EXTENDED_OFFSET                                 0x00000004
205*5113495bSYour Name #define HE_SIG_A_SU_INFO_DOT11AX_SU_EXTENDED_LSB                                    26
206*5113495bSYour Name #define HE_SIG_A_SU_INFO_DOT11AX_SU_EXTENDED_MSB                                    26
207*5113495bSYour Name #define HE_SIG_A_SU_INFO_DOT11AX_SU_EXTENDED_MASK                                   0x04000000
208*5113495bSYour Name 
209*5113495bSYour Name #define HE_SIG_A_SU_INFO_DOT11AX_EXT_RU_SIZE_OFFSET                                 0x00000004
210*5113495bSYour Name #define HE_SIG_A_SU_INFO_DOT11AX_EXT_RU_SIZE_LSB                                    27
211*5113495bSYour Name #define HE_SIG_A_SU_INFO_DOT11AX_EXT_RU_SIZE_MSB                                    29
212*5113495bSYour Name #define HE_SIG_A_SU_INFO_DOT11AX_EXT_RU_SIZE_MASK                                   0x38000000
213*5113495bSYour Name 
214*5113495bSYour Name #define HE_SIG_A_SU_INFO_RX_NDP_OFFSET                                              0x00000004
215*5113495bSYour Name #define HE_SIG_A_SU_INFO_RX_NDP_LSB                                                 30
216*5113495bSYour Name #define HE_SIG_A_SU_INFO_RX_NDP_MSB                                                 30
217*5113495bSYour Name #define HE_SIG_A_SU_INFO_RX_NDP_MASK                                                0x40000000
218*5113495bSYour Name 
219*5113495bSYour Name #define HE_SIG_A_SU_INFO_RX_INTEGRITY_CHECK_PASSED_OFFSET                           0x00000004
220*5113495bSYour Name #define HE_SIG_A_SU_INFO_RX_INTEGRITY_CHECK_PASSED_LSB                              31
221*5113495bSYour Name #define HE_SIG_A_SU_INFO_RX_INTEGRITY_CHECK_PASSED_MSB                              31
222*5113495bSYour Name #define HE_SIG_A_SU_INFO_RX_INTEGRITY_CHECK_PASSED_MASK                             0x80000000
223*5113495bSYour Name 
224*5113495bSYour Name #endif
225