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