xref: /wlan-driver/fw-api/hw/qca9574/he_sig_a_su_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2021 The Linux Foundation. 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 // $ATH_LICENSE_HW_HDR_C$
18*5113495bSYour Name //
19*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
20*5113495bSYour Name //               These definitions are tied to a particular hardware layout
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name #ifndef _HE_SIG_A_SU_INFO_H_
24*5113495bSYour Name #define _HE_SIG_A_SU_INFO_H_
25*5113495bSYour Name #if !defined(__ASSEMBLER__)
26*5113495bSYour Name #endif
27*5113495bSYour Name 
28*5113495bSYour Name 
29*5113495bSYour Name // ################ START SUMMARY #################
30*5113495bSYour Name //
31*5113495bSYour Name //	Dword	Fields
32*5113495bSYour Name //	0	format_indication[0], beam_change[1], dl_ul_flag[2], transmit_mcs[6:3], dcm[7], bss_color_id[13:8], reserved_0a[14], spatial_reuse[18:15], transmit_bw[20:19], cp_ltf_size[22:21], nsts[25:23], reserved_0b[31:26]
33*5113495bSYour Name //	1	txop_duration[6:0], coding[7], ldpc_extra_symbol[8], stbc[9], txbf[10], packet_extension_a_factor[12:11], packet_extension_pe_disambiguity[13], reserved_1a[14], doppler_indication[15], crc[19:16], tail[25:20], dot11ax_su_extended[26], dot11ax_ext_ru_size[30:27], rx_ndp[31]
34*5113495bSYour Name //
35*5113495bSYour Name // ################ END SUMMARY #################
36*5113495bSYour Name 
37*5113495bSYour Name #define NUM_OF_DWORDS_HE_SIG_A_SU_INFO 2
38*5113495bSYour Name 
39*5113495bSYour Name struct he_sig_a_su_info {
40*5113495bSYour Name              uint32_t format_indication               :  1, //[0]
41*5113495bSYour Name                       beam_change                     :  1, //[1]
42*5113495bSYour Name                       dl_ul_flag                      :  1, //[2]
43*5113495bSYour Name                       transmit_mcs                    :  4, //[6:3]
44*5113495bSYour Name                       dcm                             :  1, //[7]
45*5113495bSYour Name                       bss_color_id                    :  6, //[13:8]
46*5113495bSYour Name                       reserved_0a                     :  1, //[14]
47*5113495bSYour Name                       spatial_reuse                   :  4, //[18:15]
48*5113495bSYour Name                       transmit_bw                     :  2, //[20:19]
49*5113495bSYour Name                       cp_ltf_size                     :  2, //[22:21]
50*5113495bSYour Name                       nsts                            :  3, //[25:23]
51*5113495bSYour Name                       reserved_0b                     :  6; //[31:26]
52*5113495bSYour Name              uint32_t txop_duration                   :  7, //[6:0]
53*5113495bSYour Name                       coding                          :  1, //[7]
54*5113495bSYour Name                       ldpc_extra_symbol               :  1, //[8]
55*5113495bSYour Name                       stbc                            :  1, //[9]
56*5113495bSYour Name                       txbf                            :  1, //[10]
57*5113495bSYour Name                       packet_extension_a_factor       :  2, //[12:11]
58*5113495bSYour Name                       packet_extension_pe_disambiguity:  1, //[13]
59*5113495bSYour Name                       reserved_1a                     :  1, //[14]
60*5113495bSYour Name                       doppler_indication              :  1, //[15]
61*5113495bSYour Name                       crc                             :  4, //[19:16]
62*5113495bSYour Name                       tail                            :  6, //[25:20]
63*5113495bSYour Name                       dot11ax_su_extended             :  1, //[26]
64*5113495bSYour Name                       dot11ax_ext_ru_size             :  4, //[30:27]
65*5113495bSYour Name                       rx_ndp                          :  1; //[31]
66*5113495bSYour Name };
67*5113495bSYour Name 
68*5113495bSYour Name /*
69*5113495bSYour Name 
70*5113495bSYour Name format_indication
71*5113495bSYour Name 
72*5113495bSYour Name 			<enum 0 HE_SIGA_FORMAT_HE_TRIG>
73*5113495bSYour Name 
74*5113495bSYour Name 			<enum 1 HE_SIGA_FORMAT_SU_OR_EXT_SU>
75*5113495bSYour Name 
76*5113495bSYour Name 			<legal all>
77*5113495bSYour Name 
78*5113495bSYour Name beam_change
79*5113495bSYour Name 
80*5113495bSYour Name 			Indicates whether spatial mapping is changed between
81*5113495bSYour Name 			legacy and HE portion of preamble. If not, channel
82*5113495bSYour Name 			estimation can include legacy preamble to improve accuracy
83*5113495bSYour Name 
84*5113495bSYour Name 			<legal all>
85*5113495bSYour Name 
86*5113495bSYour Name dl_ul_flag
87*5113495bSYour Name 
88*5113495bSYour Name 			Differentiates between DL and UL transmission
89*5113495bSYour Name 
90*5113495bSYour Name 
91*5113495bSYour Name 
92*5113495bSYour Name 			<enum 0 DL_UL_FLAG_IS_DL_OR_TDLS>
93*5113495bSYour Name 
94*5113495bSYour Name 			<enum 1 DL_UL_FLAG_IS_UL>
95*5113495bSYour Name 
96*5113495bSYour Name 			<legal all>
97*5113495bSYour Name 
98*5113495bSYour Name transmit_mcs
99*5113495bSYour Name 
100*5113495bSYour Name 			Indicates the data MCS
101*5113495bSYour Name 
102*5113495bSYour Name 
103*5113495bSYour Name 
104*5113495bSYour Name 			Field Used by MAC HW
105*5113495bSYour Name 
106*5113495bSYour Name 			<legal all>
107*5113495bSYour Name 
108*5113495bSYour Name dcm
109*5113495bSYour Name 
110*5113495bSYour Name 
111*5113495bSYour Name 			0: No DCM
112*5113495bSYour Name 
113*5113495bSYour Name 			1:DCM
114*5113495bSYour Name 
115*5113495bSYour Name 			<legal all>
116*5113495bSYour Name 
117*5113495bSYour Name bss_color_id
118*5113495bSYour Name 
119*5113495bSYour Name 			BSS color ID
120*5113495bSYour Name 
121*5113495bSYour Name 
122*5113495bSYour Name 
123*5113495bSYour Name 			Field Used by MAC HW
124*5113495bSYour Name 
125*5113495bSYour Name 			<legal all>
126*5113495bSYour Name 
127*5113495bSYour Name reserved_0a
128*5113495bSYour Name 
129*5113495bSYour Name 			Note: spec indicates this shall be set to 1
130*5113495bSYour Name 
131*5113495bSYour Name 			<legal 1>
132*5113495bSYour Name 
133*5113495bSYour Name spatial_reuse
134*5113495bSYour Name 
135*5113495bSYour Name 			Spatial reuse
136*5113495bSYour Name 
137*5113495bSYour Name 
138*5113495bSYour Name 
139*5113495bSYour Name 			For 20MHz one SR field corresponding to entire 20MHz
140*5113495bSYour Name 			(other 3 fields indicate identical values)
141*5113495bSYour Name 
142*5113495bSYour Name 			For 40MHz two SR fields for each 20MHz (other 2 fields
143*5113495bSYour Name 			indicate identical values)
144*5113495bSYour Name 
145*5113495bSYour Name 			For 80MHz four SR fields for each 20MHz
146*5113495bSYour Name 
147*5113495bSYour Name 			For 160MHz four SR fields for each 40MHz
148*5113495bSYour Name 
149*5113495bSYour Name 			<legal all>
150*5113495bSYour Name 
151*5113495bSYour Name transmit_bw
152*5113495bSYour Name 
153*5113495bSYour Name 			Bandwidth of the PPDU.
154*5113495bSYour Name 
155*5113495bSYour Name 
156*5113495bSYour Name 
157*5113495bSYour Name 			For HE SU PPDU
158*5113495bSYour Name 
159*5113495bSYour Name 
160*5113495bSYour Name 			<enum 0 HE_SIG_A_BW20> 20 Mhz
161*5113495bSYour Name 
162*5113495bSYour Name 			<enum 1 HE_SIG_A_BW40> 40 Mhz
163*5113495bSYour Name 
164*5113495bSYour Name 			<enum 2 HE_SIG_A_BW80> 80 Mhz
165*5113495bSYour Name 
166*5113495bSYour Name 			<enum 3 HE_SIG_A_BW160> 160 MHz or 80+80 MHz
167*5113495bSYour Name 
168*5113495bSYour Name 
169*5113495bSYour Name 
170*5113495bSYour Name 			For HE Extended Range SU PPDU
171*5113495bSYour Name 
172*5113495bSYour Name 			Set to 0 for 242-tone RU
173*5113495bSYour Name 			 Set to 1 for right 106-tone RU within the primary 20 MHz
174*5113495bSYour Name 
175*5113495bSYour Name 
176*5113495bSYour Name 
177*5113495bSYour Name 			On RX side, Field Used by MAC HW
178*5113495bSYour Name 
179*5113495bSYour Name 			<legal all>
180*5113495bSYour Name 
181*5113495bSYour Name cp_ltf_size
182*5113495bSYour Name 
183*5113495bSYour Name 			Indicates the CP and HE-LTF type
184*5113495bSYour Name 
185*5113495bSYour Name 
186*5113495bSYour Name 
187*5113495bSYour Name 			<enum 0 OneX_LTF_0_8CP> 1xLTF + 0.8 us CP
188*5113495bSYour Name 
189*5113495bSYour Name 			<enum 1 TwoX_LTF_0_8CP> 2x LTF + 0.8 µs CP
190*5113495bSYour Name 
191*5113495bSYour Name 			<enum 2 TwoX_LTF_1_6CP> 2x LTF + 1.6 µs CP
192*5113495bSYour Name 
193*5113495bSYour Name 
194*5113495bSYour Name 
195*5113495bSYour Name 			<enum 3 FourX_LTF_0_8CP_3_2CP>
196*5113495bSYour Name 
197*5113495bSYour Name 			When DCM == 0 OR STBC == 0: 4x LTF + 3.2 µs CP
198*5113495bSYour Name 
199*5113495bSYour Name 			When DCM == 1 AND STBC == 1: 4x LTF + 0.8 µs CP. Note:
200*5113495bSYour Name 			In this scenario, Neither DCM nor STBC is applied to HE data
201*5113495bSYour Name 			field.
202*5113495bSYour Name 
203*5113495bSYour Name 
204*5113495bSYour Name 			NOTE:
205*5113495bSYour Name 
206*5113495bSYour Name 			If ( DCM == 1 ) and ( MCS > 0 ) and (STBC == 0)
207*5113495bSYour Name 
208*5113495bSYour Name 			0      = 1xLTF + 0.4 usec
209*5113495bSYour Name 
210*5113495bSYour Name 			1      = 2xLTF + 0.4 usec
211*5113495bSYour Name 
212*5113495bSYour Name 			2~3 = Reserved
213*5113495bSYour Name 
214*5113495bSYour Name 
215*5113495bSYour Name 
216*5113495bSYour Name 			<legal all>
217*5113495bSYour Name 
218*5113495bSYour Name nsts
219*5113495bSYour Name 
220*5113495bSYour Name 
221*5113495bSYour Name 
222*5113495bSYour Name 
223*5113495bSYour Name 			For HE SU PPDU
224*5113495bSYour Name 
225*5113495bSYour Name 
226*5113495bSYour Name 
227*5113495bSYour Name 			For HE Extended Range PPDU
228*5113495bSYour Name 
229*5113495bSYour Name 			<legal all>
230*5113495bSYour Name 
231*5113495bSYour Name reserved_0b
232*5113495bSYour Name 
233*5113495bSYour Name 			<legal 0>
234*5113495bSYour Name 
235*5113495bSYour Name txop_duration
236*5113495bSYour Name 
237*5113495bSYour Name 			Indicates the remaining time in the current TXOP
238*5113495bSYour Name 
239*5113495bSYour Name 
240*5113495bSYour Name 
241*5113495bSYour Name 			Field Used by MAC HW
242*5113495bSYour Name 
243*5113495bSYour Name 			 <legal all>
244*5113495bSYour Name 
245*5113495bSYour Name coding
246*5113495bSYour Name 
247*5113495bSYour Name 			Distinguishes between BCC and LDPC coding.
248*5113495bSYour Name 
249*5113495bSYour Name 
250*5113495bSYour Name 
251*5113495bSYour Name 			0: BCC
252*5113495bSYour Name 
253*5113495bSYour Name 			1: LDPC
254*5113495bSYour Name 
255*5113495bSYour Name 			<legal all>
256*5113495bSYour Name 
257*5113495bSYour Name ldpc_extra_symbol
258*5113495bSYour Name 
259*5113495bSYour Name 			If LDPC,
260*5113495bSYour Name 
261*5113495bSYour Name 			  0: LDPC extra symbol not present
262*5113495bSYour Name 
263*5113495bSYour Name 			  1: LDPC extra symbol present
264*5113495bSYour Name 
265*5113495bSYour Name 			Else
266*5113495bSYour Name 
267*5113495bSYour Name 			  Set to 1
268*5113495bSYour Name 
269*5113495bSYour Name 			<legal all>
270*5113495bSYour Name 
271*5113495bSYour Name stbc
272*5113495bSYour Name 
273*5113495bSYour Name 			Indicates whether STBC is applied
274*5113495bSYour Name 
275*5113495bSYour Name 			0: No STBC
276*5113495bSYour Name 
277*5113495bSYour Name 			1: STBC
278*5113495bSYour Name 
279*5113495bSYour Name 			<legal all>
280*5113495bSYour Name 
281*5113495bSYour Name txbf
282*5113495bSYour Name 
283*5113495bSYour Name 			Indicates whether beamforming is applied
284*5113495bSYour Name 
285*5113495bSYour Name 			0: No beamforming
286*5113495bSYour Name 
287*5113495bSYour Name 			1: beamforming
288*5113495bSYour Name 
289*5113495bSYour Name 			<legal all>
290*5113495bSYour Name 
291*5113495bSYour Name packet_extension_a_factor
292*5113495bSYour Name 
293*5113495bSYour Name 			Common trigger info
294*5113495bSYour Name 
295*5113495bSYour Name 
296*5113495bSYour Name 
297*5113495bSYour Name 			the packet extension duration of the trigger-based PPDU
298*5113495bSYour Name 			response with these two bits indicating the a-factor
299*5113495bSYour Name 
300*5113495bSYour Name 
301*5113495bSYour Name 
302*5113495bSYour Name 			<enum 0 a_factor_4>
303*5113495bSYour Name 
304*5113495bSYour Name 			<enum 1 a_factor_1>
305*5113495bSYour Name 
306*5113495bSYour Name 			<enum 2 a_factor_2>
307*5113495bSYour Name 
308*5113495bSYour Name 			<enum 3 a_factor_3>
309*5113495bSYour Name 
310*5113495bSYour Name 
311*5113495bSYour Name 
312*5113495bSYour Name 			<legal all>
313*5113495bSYour Name 
314*5113495bSYour Name packet_extension_pe_disambiguity
315*5113495bSYour Name 
316*5113495bSYour Name 			Common trigger info
317*5113495bSYour Name 
318*5113495bSYour Name 
319*5113495bSYour Name 
320*5113495bSYour Name 			the packet extension duration of the trigger-based PPDU
321*5113495bSYour Name 			response with this bit indicating the PE-Disambiguity
322*5113495bSYour Name 
323*5113495bSYour Name 			<legal all>
324*5113495bSYour Name 
325*5113495bSYour Name reserved_1a
326*5113495bSYour Name 
327*5113495bSYour Name 			Note: per standard, set to 1
328*5113495bSYour Name 
329*5113495bSYour Name 			<legal 1>
330*5113495bSYour Name 
331*5113495bSYour Name doppler_indication
332*5113495bSYour Name 
333*5113495bSYour Name 			0: No Doppler support
334*5113495bSYour Name 
335*5113495bSYour Name 			1: Doppler support
336*5113495bSYour Name 
337*5113495bSYour Name 			<legal all>
338*5113495bSYour Name 
339*5113495bSYour Name crc
340*5113495bSYour Name 
341*5113495bSYour Name 			CRC for HE-SIG-A contents.
342*5113495bSYour Name 
343*5113495bSYour Name 			<legal all>
344*5113495bSYour Name 
345*5113495bSYour Name tail
346*5113495bSYour Name 
347*5113495bSYour Name 			<legal 0>
348*5113495bSYour Name 
349*5113495bSYour Name dot11ax_su_extended
350*5113495bSYour Name 
351*5113495bSYour Name 			TX side:
352*5113495bSYour Name 
353*5113495bSYour Name 			Set to 0
354*5113495bSYour Name 
355*5113495bSYour Name 
356*5113495bSYour Name 
357*5113495bSYour Name 			RX side:
358*5113495bSYour Name 
359*5113495bSYour Name 			On RX side, evaluated by MAC HW. This is the only way
360*5113495bSYour Name 			for MAC RX to know that this was an HE_SIG_A_SU received in
361*5113495bSYour Name 			'extended' format
362*5113495bSYour Name 
363*5113495bSYour Name 
364*5113495bSYour Name 
365*5113495bSYour Name 
366*5113495bSYour Name 			<legal all>
367*5113495bSYour Name 
368*5113495bSYour Name dot11ax_ext_ru_size
369*5113495bSYour Name 
370*5113495bSYour Name 			TX side:
371*5113495bSYour Name 
372*5113495bSYour Name 			Set to 0
373*5113495bSYour Name 
374*5113495bSYour Name 
375*5113495bSYour Name 
376*5113495bSYour Name 			RX side:
377*5113495bSYour Name 
378*5113495bSYour Name 			Field only contains valid info when dot11ax_su_extended
379*5113495bSYour Name 			is set.
380*5113495bSYour Name 
381*5113495bSYour Name 
382*5113495bSYour Name 
383*5113495bSYour Name 			On RX side, evaluated by MAC HW. This is the only way
384*5113495bSYour Name 			for MAC RX to know what the number of based RUs was in this
385*5113495bSYour Name 			extended range reception. It is used by the MAC to determine
386*5113495bSYour Name 			the RU size for the response...
387*5113495bSYour Name 
388*5113495bSYour Name 			<legal all>
389*5113495bSYour Name 
390*5113495bSYour Name rx_ndp
391*5113495bSYour Name 
392*5113495bSYour Name 			TX side:
393*5113495bSYour Name 
394*5113495bSYour Name 			Set to 0
395*5113495bSYour Name 
396*5113495bSYour Name 
397*5113495bSYour Name 
398*5113495bSYour Name 			RX side:Valid on RX side only, and looked at by MAC HW
399*5113495bSYour Name 
400*5113495bSYour Name 
401*5113495bSYour Name 
402*5113495bSYour Name 			When set, PHY has received (expected) NDP frame
403*5113495bSYour Name 
404*5113495bSYour Name 			<legal all>
405*5113495bSYour Name */
406*5113495bSYour Name 
407*5113495bSYour Name 
408*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_0_FORMAT_INDICATION
409*5113495bSYour Name 
410*5113495bSYour Name 			<enum 0 HE_SIGA_FORMAT_HE_TRIG>
411*5113495bSYour Name 
412*5113495bSYour Name 			<enum 1 HE_SIGA_FORMAT_SU_OR_EXT_SU>
413*5113495bSYour Name 
414*5113495bSYour Name 			<legal all>
415*5113495bSYour Name */
416*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_FORMAT_INDICATION_OFFSET                  0x00000000
417*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_FORMAT_INDICATION_LSB                     0
418*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_FORMAT_INDICATION_MASK                    0x00000001
419*5113495bSYour Name 
420*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_0_BEAM_CHANGE
421*5113495bSYour Name 
422*5113495bSYour Name 			Indicates whether spatial mapping is changed between
423*5113495bSYour Name 			legacy and HE portion of preamble. If not, channel
424*5113495bSYour Name 			estimation can include legacy preamble to improve accuracy
425*5113495bSYour Name 
426*5113495bSYour Name 			<legal all>
427*5113495bSYour Name */
428*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_BEAM_CHANGE_OFFSET                        0x00000000
429*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_BEAM_CHANGE_LSB                           1
430*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_BEAM_CHANGE_MASK                          0x00000002
431*5113495bSYour Name 
432*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_0_DL_UL_FLAG
433*5113495bSYour Name 
434*5113495bSYour Name 			Differentiates between DL and UL transmission
435*5113495bSYour Name 
436*5113495bSYour Name 
437*5113495bSYour Name 
438*5113495bSYour Name 			<enum 0 DL_UL_FLAG_IS_DL_OR_TDLS>
439*5113495bSYour Name 
440*5113495bSYour Name 			<enum 1 DL_UL_FLAG_IS_UL>
441*5113495bSYour Name 
442*5113495bSYour Name 			<legal all>
443*5113495bSYour Name */
444*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_DL_UL_FLAG_OFFSET                         0x00000000
445*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_DL_UL_FLAG_LSB                            2
446*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_DL_UL_FLAG_MASK                           0x00000004
447*5113495bSYour Name 
448*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_0_TRANSMIT_MCS
449*5113495bSYour Name 
450*5113495bSYour Name 			Indicates the data MCS
451*5113495bSYour Name 
452*5113495bSYour Name 
453*5113495bSYour Name 
454*5113495bSYour Name 			Field Used by MAC HW
455*5113495bSYour Name 
456*5113495bSYour Name 			<legal all>
457*5113495bSYour Name */
458*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_TRANSMIT_MCS_OFFSET                       0x00000000
459*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_TRANSMIT_MCS_LSB                          3
460*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_TRANSMIT_MCS_MASK                         0x00000078
461*5113495bSYour Name 
462*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_0_DCM
463*5113495bSYour Name 
464*5113495bSYour Name 
465*5113495bSYour Name 			0: No DCM
466*5113495bSYour Name 
467*5113495bSYour Name 			1:DCM
468*5113495bSYour Name 
469*5113495bSYour Name 			<legal all>
470*5113495bSYour Name */
471*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_DCM_OFFSET                                0x00000000
472*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_DCM_LSB                                   7
473*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_DCM_MASK                                  0x00000080
474*5113495bSYour Name 
475*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_0_BSS_COLOR_ID
476*5113495bSYour Name 
477*5113495bSYour Name 			BSS color ID
478*5113495bSYour Name 
479*5113495bSYour Name 
480*5113495bSYour Name 
481*5113495bSYour Name 			Field Used by MAC HW
482*5113495bSYour Name 
483*5113495bSYour Name 			<legal all>
484*5113495bSYour Name */
485*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_BSS_COLOR_ID_OFFSET                       0x00000000
486*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_BSS_COLOR_ID_LSB                          8
487*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_BSS_COLOR_ID_MASK                         0x00003f00
488*5113495bSYour Name 
489*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_0_RESERVED_0A
490*5113495bSYour Name 
491*5113495bSYour Name 			Note: spec indicates this shall be set to 1
492*5113495bSYour Name 
493*5113495bSYour Name 			<legal 1>
494*5113495bSYour Name */
495*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_RESERVED_0A_OFFSET                        0x00000000
496*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_RESERVED_0A_LSB                           14
497*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_RESERVED_0A_MASK                          0x00004000
498*5113495bSYour Name 
499*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_0_SPATIAL_REUSE
500*5113495bSYour Name 
501*5113495bSYour Name 			Spatial reuse
502*5113495bSYour Name 
503*5113495bSYour Name 
504*5113495bSYour Name 
505*5113495bSYour Name 			For 20MHz one SR field corresponding to entire 20MHz
506*5113495bSYour Name 			(other 3 fields indicate identical values)
507*5113495bSYour Name 
508*5113495bSYour Name 			For 40MHz two SR fields for each 20MHz (other 2 fields
509*5113495bSYour Name 			indicate identical values)
510*5113495bSYour Name 
511*5113495bSYour Name 			For 80MHz four SR fields for each 20MHz
512*5113495bSYour Name 
513*5113495bSYour Name 			For 160MHz four SR fields for each 40MHz
514*5113495bSYour Name 
515*5113495bSYour Name 			<legal all>
516*5113495bSYour Name */
517*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_SPATIAL_REUSE_OFFSET                      0x00000000
518*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_SPATIAL_REUSE_LSB                         15
519*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_SPATIAL_REUSE_MASK                        0x00078000
520*5113495bSYour Name 
521*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_0_TRANSMIT_BW
522*5113495bSYour Name 
523*5113495bSYour Name 			Bandwidth of the PPDU.
524*5113495bSYour Name 
525*5113495bSYour Name 
526*5113495bSYour Name 
527*5113495bSYour Name 			For HE SU PPDU
528*5113495bSYour Name 
529*5113495bSYour Name 
530*5113495bSYour Name 			<enum 0 HE_SIG_A_BW20> 20 Mhz
531*5113495bSYour Name 
532*5113495bSYour Name 			<enum 1 HE_SIG_A_BW40> 40 Mhz
533*5113495bSYour Name 
534*5113495bSYour Name 			<enum 2 HE_SIG_A_BW80> 80 Mhz
535*5113495bSYour Name 
536*5113495bSYour Name 			<enum 3 HE_SIG_A_BW160> 160 MHz or 80+80 MHz
537*5113495bSYour Name 
538*5113495bSYour Name 
539*5113495bSYour Name 
540*5113495bSYour Name 			For HE Extended Range SU PPDU
541*5113495bSYour Name 
542*5113495bSYour Name 			Set to 0 for 242-tone RU
543*5113495bSYour Name 			 Set to 1 for right 106-tone RU within the primary 20 MHz
544*5113495bSYour Name 
545*5113495bSYour Name 
546*5113495bSYour Name 
547*5113495bSYour Name 			On RX side, Field Used by MAC HW
548*5113495bSYour Name 
549*5113495bSYour Name 			<legal all>
550*5113495bSYour Name */
551*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_TRANSMIT_BW_OFFSET                        0x00000000
552*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_TRANSMIT_BW_LSB                           19
553*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_TRANSMIT_BW_MASK                          0x00180000
554*5113495bSYour Name 
555*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_0_CP_LTF_SIZE
556*5113495bSYour Name 
557*5113495bSYour Name 			Indicates the CP and HE-LTF type
558*5113495bSYour Name 
559*5113495bSYour Name 
560*5113495bSYour Name 
561*5113495bSYour Name 			<enum 0 OneX_LTF_0_8CP> 1xLTF + 0.8 us CP
562*5113495bSYour Name 
563*5113495bSYour Name 			<enum 1 TwoX_LTF_0_8CP> 2x LTF + 0.8 µs CP
564*5113495bSYour Name 
565*5113495bSYour Name 			<enum 2 TwoX_LTF_1_6CP> 2x LTF + 1.6 µs CP
566*5113495bSYour Name 
567*5113495bSYour Name 
568*5113495bSYour Name 
569*5113495bSYour Name 			<enum 3 FourX_LTF_0_8CP_3_2CP>
570*5113495bSYour Name 
571*5113495bSYour Name 			When DCM == 0 OR STBC == 0: 4x LTF + 3.2 µs CP
572*5113495bSYour Name 
573*5113495bSYour Name 			When DCM == 1 AND STBC == 1: 4x LTF + 0.8 µs CP. Note:
574*5113495bSYour Name 			In this scenario, Neither DCM nor STBC is applied to HE data
575*5113495bSYour Name 			field.
576*5113495bSYour Name 
577*5113495bSYour Name 
578*5113495bSYour Name 			NOTE:
579*5113495bSYour Name 
580*5113495bSYour Name 			If ( DCM == 1 ) and ( MCS > 0 ) and (STBC == 0)
581*5113495bSYour Name 
582*5113495bSYour Name 			0      = 1xLTF + 0.4 usec
583*5113495bSYour Name 
584*5113495bSYour Name 			1      = 2xLTF + 0.4 usec
585*5113495bSYour Name 
586*5113495bSYour Name 			2~3 = Reserved
587*5113495bSYour Name 
588*5113495bSYour Name 
589*5113495bSYour Name 
590*5113495bSYour Name 			<legal all>
591*5113495bSYour Name */
592*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_CP_LTF_SIZE_OFFSET                        0x00000000
593*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_CP_LTF_SIZE_LSB                           21
594*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_CP_LTF_SIZE_MASK                          0x00600000
595*5113495bSYour Name 
596*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_0_NSTS
597*5113495bSYour Name 
598*5113495bSYour Name 
599*5113495bSYour Name 
600*5113495bSYour Name 
601*5113495bSYour Name 			For HE SU PPDU
602*5113495bSYour Name 
603*5113495bSYour Name 
604*5113495bSYour Name 
605*5113495bSYour Name 			For HE Extended Range PPDU
606*5113495bSYour Name 
607*5113495bSYour Name 			<legal all>
608*5113495bSYour Name */
609*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_NSTS_OFFSET                               0x00000000
610*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_NSTS_LSB                                  23
611*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_NSTS_MASK                                 0x03800000
612*5113495bSYour Name 
613*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_0_RESERVED_0B
614*5113495bSYour Name 
615*5113495bSYour Name 			<legal 0>
616*5113495bSYour Name */
617*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_RESERVED_0B_OFFSET                        0x00000000
618*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_RESERVED_0B_LSB                           26
619*5113495bSYour Name #define HE_SIG_A_SU_INFO_0_RESERVED_0B_MASK                          0xfc000000
620*5113495bSYour Name 
621*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_1_TXOP_DURATION
622*5113495bSYour Name 
623*5113495bSYour Name 			Indicates the remaining time in the current TXOP
624*5113495bSYour Name 
625*5113495bSYour Name 
626*5113495bSYour Name 
627*5113495bSYour Name 			Field Used by MAC HW
628*5113495bSYour Name 
629*5113495bSYour Name 			 <legal all>
630*5113495bSYour Name */
631*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_TXOP_DURATION_OFFSET                      0x00000004
632*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_TXOP_DURATION_LSB                         0
633*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_TXOP_DURATION_MASK                        0x0000007f
634*5113495bSYour Name 
635*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_1_CODING
636*5113495bSYour Name 
637*5113495bSYour Name 			Distinguishes between BCC and LDPC coding.
638*5113495bSYour Name 
639*5113495bSYour Name 
640*5113495bSYour Name 
641*5113495bSYour Name 			0: BCC
642*5113495bSYour Name 
643*5113495bSYour Name 			1: LDPC
644*5113495bSYour Name 
645*5113495bSYour Name 			<legal all>
646*5113495bSYour Name */
647*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_CODING_OFFSET                             0x00000004
648*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_CODING_LSB                                7
649*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_CODING_MASK                               0x00000080
650*5113495bSYour Name 
651*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_1_LDPC_EXTRA_SYMBOL
652*5113495bSYour Name 
653*5113495bSYour Name 			If LDPC,
654*5113495bSYour Name 
655*5113495bSYour Name 			  0: LDPC extra symbol not present
656*5113495bSYour Name 
657*5113495bSYour Name 			  1: LDPC extra symbol present
658*5113495bSYour Name 
659*5113495bSYour Name 			Else
660*5113495bSYour Name 
661*5113495bSYour Name 			  Set to 1
662*5113495bSYour Name 
663*5113495bSYour Name 			<legal all>
664*5113495bSYour Name */
665*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_LDPC_EXTRA_SYMBOL_OFFSET                  0x00000004
666*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_LDPC_EXTRA_SYMBOL_LSB                     8
667*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_LDPC_EXTRA_SYMBOL_MASK                    0x00000100
668*5113495bSYour Name 
669*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_1_STBC
670*5113495bSYour Name 
671*5113495bSYour Name 			Indicates whether STBC is applied
672*5113495bSYour Name 
673*5113495bSYour Name 			0: No STBC
674*5113495bSYour Name 
675*5113495bSYour Name 			1: STBC
676*5113495bSYour Name 
677*5113495bSYour Name 			<legal all>
678*5113495bSYour Name */
679*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_STBC_OFFSET                               0x00000004
680*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_STBC_LSB                                  9
681*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_STBC_MASK                                 0x00000200
682*5113495bSYour Name 
683*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_1_TXBF
684*5113495bSYour Name 
685*5113495bSYour Name 			Indicates whether beamforming is applied
686*5113495bSYour Name 
687*5113495bSYour Name 			0: No beamforming
688*5113495bSYour Name 
689*5113495bSYour Name 			1: beamforming
690*5113495bSYour Name 
691*5113495bSYour Name 			<legal all>
692*5113495bSYour Name */
693*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_TXBF_OFFSET                               0x00000004
694*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_TXBF_LSB                                  10
695*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_TXBF_MASK                                 0x00000400
696*5113495bSYour Name 
697*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_1_PACKET_EXTENSION_A_FACTOR
698*5113495bSYour Name 
699*5113495bSYour Name 			Common trigger info
700*5113495bSYour Name 
701*5113495bSYour Name 
702*5113495bSYour Name 
703*5113495bSYour Name 			the packet extension duration of the trigger-based PPDU
704*5113495bSYour Name 			response with these two bits indicating the a-factor
705*5113495bSYour Name 
706*5113495bSYour Name 
707*5113495bSYour Name 
708*5113495bSYour Name 			<enum 0 a_factor_4>
709*5113495bSYour Name 
710*5113495bSYour Name 			<enum 1 a_factor_1>
711*5113495bSYour Name 
712*5113495bSYour Name 			<enum 2 a_factor_2>
713*5113495bSYour Name 
714*5113495bSYour Name 			<enum 3 a_factor_3>
715*5113495bSYour Name 
716*5113495bSYour Name 
717*5113495bSYour Name 
718*5113495bSYour Name 			<legal all>
719*5113495bSYour Name */
720*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_PACKET_EXTENSION_A_FACTOR_OFFSET          0x00000004
721*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_PACKET_EXTENSION_A_FACTOR_LSB             11
722*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_PACKET_EXTENSION_A_FACTOR_MASK            0x00001800
723*5113495bSYour Name 
724*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_1_PACKET_EXTENSION_PE_DISAMBIGUITY
725*5113495bSYour Name 
726*5113495bSYour Name 			Common trigger info
727*5113495bSYour Name 
728*5113495bSYour Name 
729*5113495bSYour Name 
730*5113495bSYour Name 			the packet extension duration of the trigger-based PPDU
731*5113495bSYour Name 			response with this bit indicating the PE-Disambiguity
732*5113495bSYour Name 
733*5113495bSYour Name 			<legal all>
734*5113495bSYour Name */
735*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_PACKET_EXTENSION_PE_DISAMBIGUITY_OFFSET   0x00000004
736*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_PACKET_EXTENSION_PE_DISAMBIGUITY_LSB      13
737*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_PACKET_EXTENSION_PE_DISAMBIGUITY_MASK     0x00002000
738*5113495bSYour Name 
739*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_1_RESERVED_1A
740*5113495bSYour Name 
741*5113495bSYour Name 			Note: per standard, set to 1
742*5113495bSYour Name 
743*5113495bSYour Name 			<legal 1>
744*5113495bSYour Name */
745*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_RESERVED_1A_OFFSET                        0x00000004
746*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_RESERVED_1A_LSB                           14
747*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_RESERVED_1A_MASK                          0x00004000
748*5113495bSYour Name 
749*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_1_DOPPLER_INDICATION
750*5113495bSYour Name 
751*5113495bSYour Name 			0: No Doppler support
752*5113495bSYour Name 
753*5113495bSYour Name 			1: Doppler support
754*5113495bSYour Name 
755*5113495bSYour Name 			<legal all>
756*5113495bSYour Name */
757*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_DOPPLER_INDICATION_OFFSET                 0x00000004
758*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_DOPPLER_INDICATION_LSB                    15
759*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_DOPPLER_INDICATION_MASK                   0x00008000
760*5113495bSYour Name 
761*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_1_CRC
762*5113495bSYour Name 
763*5113495bSYour Name 			CRC for HE-SIG-A contents.
764*5113495bSYour Name 
765*5113495bSYour Name 			<legal all>
766*5113495bSYour Name */
767*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_CRC_OFFSET                                0x00000004
768*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_CRC_LSB                                   16
769*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_CRC_MASK                                  0x000f0000
770*5113495bSYour Name 
771*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_1_TAIL
772*5113495bSYour Name 
773*5113495bSYour Name 			<legal 0>
774*5113495bSYour Name */
775*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_TAIL_OFFSET                               0x00000004
776*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_TAIL_LSB                                  20
777*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_TAIL_MASK                                 0x03f00000
778*5113495bSYour Name 
779*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_1_DOT11AX_SU_EXTENDED
780*5113495bSYour Name 
781*5113495bSYour Name 			TX side:
782*5113495bSYour Name 
783*5113495bSYour Name 			Set to 0
784*5113495bSYour Name 
785*5113495bSYour Name 
786*5113495bSYour Name 
787*5113495bSYour Name 			RX side:
788*5113495bSYour Name 
789*5113495bSYour Name 			On RX side, evaluated by MAC HW. This is the only way
790*5113495bSYour Name 			for MAC RX to know that this was an HE_SIG_A_SU received in
791*5113495bSYour Name 			'extended' format
792*5113495bSYour Name 
793*5113495bSYour Name 
794*5113495bSYour Name 
795*5113495bSYour Name 
796*5113495bSYour Name 			<legal all>
797*5113495bSYour Name */
798*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_DOT11AX_SU_EXTENDED_OFFSET                0x00000004
799*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_DOT11AX_SU_EXTENDED_LSB                   26
800*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_DOT11AX_SU_EXTENDED_MASK                  0x04000000
801*5113495bSYour Name 
802*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_1_DOT11AX_EXT_RU_SIZE
803*5113495bSYour Name 
804*5113495bSYour Name 			TX side:
805*5113495bSYour Name 
806*5113495bSYour Name 			Set to 0
807*5113495bSYour Name 
808*5113495bSYour Name 
809*5113495bSYour Name 
810*5113495bSYour Name 			RX side:
811*5113495bSYour Name 
812*5113495bSYour Name 			Field only contains valid info when dot11ax_su_extended
813*5113495bSYour Name 			is set.
814*5113495bSYour Name 
815*5113495bSYour Name 
816*5113495bSYour Name 
817*5113495bSYour Name 			On RX side, evaluated by MAC HW. This is the only way
818*5113495bSYour Name 			for MAC RX to know what the number of based RUs was in this
819*5113495bSYour Name 			extended range reception. It is used by the MAC to determine
820*5113495bSYour Name 			the RU size for the response...
821*5113495bSYour Name 
822*5113495bSYour Name 			<legal all>
823*5113495bSYour Name */
824*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_DOT11AX_EXT_RU_SIZE_OFFSET                0x00000004
825*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_DOT11AX_EXT_RU_SIZE_LSB                   27
826*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_DOT11AX_EXT_RU_SIZE_MASK                  0x78000000
827*5113495bSYour Name 
828*5113495bSYour Name /* Description		HE_SIG_A_SU_INFO_1_RX_NDP
829*5113495bSYour Name 
830*5113495bSYour Name 			TX side:
831*5113495bSYour Name 
832*5113495bSYour Name 			Set to 0
833*5113495bSYour Name 
834*5113495bSYour Name 
835*5113495bSYour Name 
836*5113495bSYour Name 			RX side:Valid on RX side only, and looked at by MAC HW
837*5113495bSYour Name 
838*5113495bSYour Name 
839*5113495bSYour Name 
840*5113495bSYour Name 			When set, PHY has received (expected) NDP frame
841*5113495bSYour Name 
842*5113495bSYour Name 			<legal all>
843*5113495bSYour Name */
844*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_RX_NDP_OFFSET                             0x00000004
845*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_RX_NDP_LSB                                31
846*5113495bSYour Name #define HE_SIG_A_SU_INFO_1_RX_NDP_MASK                               0x80000000
847*5113495bSYour Name 
848*5113495bSYour Name 
849*5113495bSYour Name #endif // _HE_SIG_A_SU_INFO_H_
850