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