xref: /wlan-driver/fw-api/hw/qca6750/v1/ht_sig_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2020 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 //
20*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
21*5113495bSYour Name //               These definitions are tied to a particular hardware layout
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name #ifndef _HT_SIG_INFO_H_
25*5113495bSYour Name #define _HT_SIG_INFO_H_
26*5113495bSYour Name #if !defined(__ASSEMBLER__)
27*5113495bSYour Name #endif
28*5113495bSYour Name 
29*5113495bSYour Name 
30*5113495bSYour Name // ################ START SUMMARY #################
31*5113495bSYour Name //
32*5113495bSYour Name //	Dword	Fields
33*5113495bSYour Name //	0	mcs[6:0], cbw[7], length[23:8], reserved_0[31:24]
34*5113495bSYour Name //	1	smoothing[0], not_sounding[1], ht_reserved[2], aggregation[3], stbc[5:4], fec_coding[6], short_gi[7], num_ext_sp_str[9:8], crc[17:10], signal_tail[23:18], reserved_1[31:24]
35*5113495bSYour Name //
36*5113495bSYour Name // ################ END SUMMARY #################
37*5113495bSYour Name 
38*5113495bSYour Name #define NUM_OF_DWORDS_HT_SIG_INFO 2
39*5113495bSYour Name 
40*5113495bSYour Name struct ht_sig_info {
41*5113495bSYour Name              uint32_t mcs                             :  7, //[6:0]
42*5113495bSYour Name                       cbw                             :  1, //[7]
43*5113495bSYour Name                       length                          : 16, //[23:8]
44*5113495bSYour Name                       reserved_0                      :  8; //[31:24]
45*5113495bSYour Name              uint32_t smoothing                       :  1, //[0]
46*5113495bSYour Name                       not_sounding                    :  1, //[1]
47*5113495bSYour Name                       ht_reserved                     :  1, //[2]
48*5113495bSYour Name                       aggregation                     :  1, //[3]
49*5113495bSYour Name                       stbc                            :  2, //[5:4]
50*5113495bSYour Name                       fec_coding                      :  1, //[6]
51*5113495bSYour Name                       short_gi                        :  1, //[7]
52*5113495bSYour Name                       num_ext_sp_str                  :  2, //[9:8]
53*5113495bSYour Name                       crc                             :  8, //[17:10]
54*5113495bSYour Name                       signal_tail                     :  6, //[23:18]
55*5113495bSYour Name                       reserved_1                      :  8; //[31:24]
56*5113495bSYour Name };
57*5113495bSYour Name 
58*5113495bSYour Name /*
59*5113495bSYour Name 
60*5113495bSYour Name mcs
61*5113495bSYour Name 
62*5113495bSYour Name 			Modulation Coding Scheme:
63*5113495bSYour Name 
64*5113495bSYour Name 			0-7 are used for single stream
65*5113495bSYour Name 
66*5113495bSYour Name 			8-15 are used for 2 streams
67*5113495bSYour Name 
68*5113495bSYour Name 			16-23 are used for 3 streams
69*5113495bSYour Name 
70*5113495bSYour Name 			24-31 are used for 4 streams
71*5113495bSYour Name 
72*5113495bSYour Name 			32 is used for duplicate HT20 (unsupported)
73*5113495bSYour Name 
74*5113495bSYour Name 			33-76 is used for unequal modulation (unsupported)
75*5113495bSYour Name 
76*5113495bSYour Name 			77-127 is reserved.
77*5113495bSYour Name 
78*5113495bSYour Name 			<legal 0-31>
79*5113495bSYour Name 
80*5113495bSYour Name cbw
81*5113495bSYour Name 
82*5113495bSYour Name 			Packet bandwidth:
83*5113495bSYour Name 
84*5113495bSYour Name 			<enum 0     ht_20_mhz>
85*5113495bSYour Name 
86*5113495bSYour Name 			<enum 1     ht_40_mhz>
87*5113495bSYour Name 
88*5113495bSYour Name 			<legal 0-1>
89*5113495bSYour Name 
90*5113495bSYour Name length
91*5113495bSYour Name 
92*5113495bSYour Name 			This is the MPDU or A-MPDU length in octets of the PPDU
93*5113495bSYour Name 
94*5113495bSYour Name 			<legal all>
95*5113495bSYour Name 
96*5113495bSYour Name reserved_0
97*5113495bSYour Name 
98*5113495bSYour Name 			This field is not part of HT-SIG
99*5113495bSYour Name 
100*5113495bSYour Name 			Reserved: Should be set to 0 by the MAC and ignored by
101*5113495bSYour Name 			the PHY <legal 0>
102*5113495bSYour Name 
103*5113495bSYour Name smoothing
104*5113495bSYour Name 
105*5113495bSYour Name 			Field indicates if smoothing is needed
106*5113495bSYour Name 
107*5113495bSYour Name 			E_num 0     do_smoothing Unsupported setting: indicates
108*5113495bSYour Name 			smoothing is often used for beamforming
109*5113495bSYour Name 
110*5113495bSYour Name 
111*5113495bSYour Name 			<legal 1>
112*5113495bSYour Name 
113*5113495bSYour Name not_sounding
114*5113495bSYour Name 
115*5113495bSYour Name 			E_num 0     sounding Unsupported setting: indicates
116*5113495bSYour Name 			sounding is used
117*5113495bSYour Name 
118*5113495bSYour Name 			<enum 1     no_sounding>  Indicates no sounding is used
119*5113495bSYour Name 
120*5113495bSYour Name 			<legal 1>
121*5113495bSYour Name 
122*5113495bSYour Name ht_reserved
123*5113495bSYour Name 
124*5113495bSYour Name 			Reserved: Should be set to 1 by the MAC and ignored by
125*5113495bSYour Name 			the PHY
126*5113495bSYour Name 
127*5113495bSYour Name 			<legal 1>
128*5113495bSYour Name 
129*5113495bSYour Name aggregation
130*5113495bSYour Name 
131*5113495bSYour Name 			<enum 0     mpdu> Indicates MPDU format
132*5113495bSYour Name 
133*5113495bSYour Name 			<enum 1     a_mpdu> Indicates A-MPDU format
134*5113495bSYour Name 
135*5113495bSYour Name 			<legal 0-1>
136*5113495bSYour Name 
137*5113495bSYour Name stbc
138*5113495bSYour Name 
139*5113495bSYour Name 			<enum 0     no_stbc> Indicates no STBC
140*5113495bSYour Name 
141*5113495bSYour Name 			<enum 1     1_str_stbc> Indicates 1 stream STBC
142*5113495bSYour Name 
143*5113495bSYour Name 			E_num 2     2_str_stbc Indicates 2 stream STBC
144*5113495bSYour Name 			(Unsupported)
145*5113495bSYour Name 
146*5113495bSYour Name 			<legal 0-1>
147*5113495bSYour Name 
148*5113495bSYour Name fec_coding
149*5113495bSYour Name 
150*5113495bSYour Name 			<enum 0     ht_bcc>  Indicates BCC coding
151*5113495bSYour Name 
152*5113495bSYour Name 			<enum 1     ht_ldpc>  Indicates LDPC coding
153*5113495bSYour Name 
154*5113495bSYour Name 			<legal 0-1>
155*5113495bSYour Name 
156*5113495bSYour Name short_gi
157*5113495bSYour Name 
158*5113495bSYour Name 			<enum 0     ht_normal_gi>  Indicates normal guard
159*5113495bSYour Name 			interval
160*5113495bSYour Name 
161*5113495bSYour Name 
162*5113495bSYour Name 			<legal 0-1>
163*5113495bSYour Name 
164*5113495bSYour Name num_ext_sp_str
165*5113495bSYour Name 
166*5113495bSYour Name 			Number of extension spatial streams: (Used for TxBF)
167*5113495bSYour Name 
168*5113495bSYour Name 			<enum 0     0_ext_sp_str>  No extension spatial streams
169*5113495bSYour Name 
170*5113495bSYour Name 			E_num 1     1_ext_sp_str  Not supported: 1 extension
171*5113495bSYour Name 			spatial streams
172*5113495bSYour Name 
173*5113495bSYour Name 			E_num 2     2_ext_sp_str  Not supported:  2 extension
174*5113495bSYour Name 			spatial streams
175*5113495bSYour Name 
176*5113495bSYour Name 			<legal 0>
177*5113495bSYour Name 
178*5113495bSYour Name crc
179*5113495bSYour Name 
180*5113495bSYour Name 			The CRC protects the HT-SIG (HT-SIG[0][23:0] and
181*5113495bSYour Name 			HT-SIG[1][9:0]. The generator polynomial is G(D) = D8 + D2 +
182*5113495bSYour Name 			D + 1.  <legal all>
183*5113495bSYour Name 
184*5113495bSYour Name signal_tail
185*5113495bSYour Name 
186*5113495bSYour Name 			The 6 bits of tail is always set to 0 is used to flush
187*5113495bSYour Name 			the BCC encoder and decoder.  <legal 0>
188*5113495bSYour Name 
189*5113495bSYour Name reserved_1
190*5113495bSYour Name 
191*5113495bSYour Name 			This field is not part of HT-SIG:
192*5113495bSYour Name 
193*5113495bSYour Name 			Reserved: Should be set to 0 by the MAC and ignored by
194*5113495bSYour Name 			the PHY.  <legal 0>
195*5113495bSYour Name */
196*5113495bSYour Name 
197*5113495bSYour Name 
198*5113495bSYour Name /* Description		HT_SIG_INFO_0_MCS
199*5113495bSYour Name 
200*5113495bSYour Name 			Modulation Coding Scheme:
201*5113495bSYour Name 
202*5113495bSYour Name 			0-7 are used for single stream
203*5113495bSYour Name 
204*5113495bSYour Name 			8-15 are used for 2 streams
205*5113495bSYour Name 
206*5113495bSYour Name 			16-23 are used for 3 streams
207*5113495bSYour Name 
208*5113495bSYour Name 			24-31 are used for 4 streams
209*5113495bSYour Name 
210*5113495bSYour Name 			32 is used for duplicate HT20 (unsupported)
211*5113495bSYour Name 
212*5113495bSYour Name 			33-76 is used for unequal modulation (unsupported)
213*5113495bSYour Name 
214*5113495bSYour Name 			77-127 is reserved.
215*5113495bSYour Name 
216*5113495bSYour Name 			<legal 0-31>
217*5113495bSYour Name */
218*5113495bSYour Name #define HT_SIG_INFO_0_MCS_OFFSET                                     0x00000000
219*5113495bSYour Name #define HT_SIG_INFO_0_MCS_LSB                                        0
220*5113495bSYour Name #define HT_SIG_INFO_0_MCS_MASK                                       0x0000007f
221*5113495bSYour Name 
222*5113495bSYour Name /* Description		HT_SIG_INFO_0_CBW
223*5113495bSYour Name 
224*5113495bSYour Name 			Packet bandwidth:
225*5113495bSYour Name 
226*5113495bSYour Name 			<enum 0     ht_20_mhz>
227*5113495bSYour Name 
228*5113495bSYour Name 			<enum 1     ht_40_mhz>
229*5113495bSYour Name 
230*5113495bSYour Name 			<legal 0-1>
231*5113495bSYour Name */
232*5113495bSYour Name #define HT_SIG_INFO_0_CBW_OFFSET                                     0x00000000
233*5113495bSYour Name #define HT_SIG_INFO_0_CBW_LSB                                        7
234*5113495bSYour Name #define HT_SIG_INFO_0_CBW_MASK                                       0x00000080
235*5113495bSYour Name 
236*5113495bSYour Name /* Description		HT_SIG_INFO_0_LENGTH
237*5113495bSYour Name 
238*5113495bSYour Name 			This is the MPDU or A-MPDU length in octets of the PPDU
239*5113495bSYour Name 
240*5113495bSYour Name 			<legal all>
241*5113495bSYour Name */
242*5113495bSYour Name #define HT_SIG_INFO_0_LENGTH_OFFSET                                  0x00000000
243*5113495bSYour Name #define HT_SIG_INFO_0_LENGTH_LSB                                     8
244*5113495bSYour Name #define HT_SIG_INFO_0_LENGTH_MASK                                    0x00ffff00
245*5113495bSYour Name 
246*5113495bSYour Name /* Description		HT_SIG_INFO_0_RESERVED_0
247*5113495bSYour Name 
248*5113495bSYour Name 			This field is not part of HT-SIG
249*5113495bSYour Name 
250*5113495bSYour Name 			Reserved: Should be set to 0 by the MAC and ignored by
251*5113495bSYour Name 			the PHY <legal 0>
252*5113495bSYour Name */
253*5113495bSYour Name #define HT_SIG_INFO_0_RESERVED_0_OFFSET                              0x00000000
254*5113495bSYour Name #define HT_SIG_INFO_0_RESERVED_0_LSB                                 24
255*5113495bSYour Name #define HT_SIG_INFO_0_RESERVED_0_MASK                                0xff000000
256*5113495bSYour Name 
257*5113495bSYour Name /* Description		HT_SIG_INFO_1_SMOOTHING
258*5113495bSYour Name 
259*5113495bSYour Name 			Field indicates if smoothing is needed
260*5113495bSYour Name 
261*5113495bSYour Name 			E_num 0     do_smoothing Unsupported setting: indicates
262*5113495bSYour Name 			smoothing is often used for beamforming
263*5113495bSYour Name 
264*5113495bSYour Name 
265*5113495bSYour Name 			<legal 1>
266*5113495bSYour Name */
267*5113495bSYour Name #define HT_SIG_INFO_1_SMOOTHING_OFFSET                               0x00000004
268*5113495bSYour Name #define HT_SIG_INFO_1_SMOOTHING_LSB                                  0
269*5113495bSYour Name #define HT_SIG_INFO_1_SMOOTHING_MASK                                 0x00000001
270*5113495bSYour Name 
271*5113495bSYour Name /* Description		HT_SIG_INFO_1_NOT_SOUNDING
272*5113495bSYour Name 
273*5113495bSYour Name 			E_num 0     sounding Unsupported setting: indicates
274*5113495bSYour Name 			sounding is used
275*5113495bSYour Name 
276*5113495bSYour Name 			<enum 1     no_sounding>  Indicates no sounding is used
277*5113495bSYour Name 
278*5113495bSYour Name 			<legal 1>
279*5113495bSYour Name */
280*5113495bSYour Name #define HT_SIG_INFO_1_NOT_SOUNDING_OFFSET                            0x00000004
281*5113495bSYour Name #define HT_SIG_INFO_1_NOT_SOUNDING_LSB                               1
282*5113495bSYour Name #define HT_SIG_INFO_1_NOT_SOUNDING_MASK                              0x00000002
283*5113495bSYour Name 
284*5113495bSYour Name /* Description		HT_SIG_INFO_1_HT_RESERVED
285*5113495bSYour Name 
286*5113495bSYour Name 			Reserved: Should be set to 1 by the MAC and ignored by
287*5113495bSYour Name 			the PHY
288*5113495bSYour Name 
289*5113495bSYour Name 			<legal 1>
290*5113495bSYour Name */
291*5113495bSYour Name #define HT_SIG_INFO_1_HT_RESERVED_OFFSET                             0x00000004
292*5113495bSYour Name #define HT_SIG_INFO_1_HT_RESERVED_LSB                                2
293*5113495bSYour Name #define HT_SIG_INFO_1_HT_RESERVED_MASK                               0x00000004
294*5113495bSYour Name 
295*5113495bSYour Name /* Description		HT_SIG_INFO_1_AGGREGATION
296*5113495bSYour Name 
297*5113495bSYour Name 			<enum 0     mpdu> Indicates MPDU format
298*5113495bSYour Name 
299*5113495bSYour Name 			<enum 1     a_mpdu> Indicates A-MPDU format
300*5113495bSYour Name 
301*5113495bSYour Name 			<legal 0-1>
302*5113495bSYour Name */
303*5113495bSYour Name #define HT_SIG_INFO_1_AGGREGATION_OFFSET                             0x00000004
304*5113495bSYour Name #define HT_SIG_INFO_1_AGGREGATION_LSB                                3
305*5113495bSYour Name #define HT_SIG_INFO_1_AGGREGATION_MASK                               0x00000008
306*5113495bSYour Name 
307*5113495bSYour Name /* Description		HT_SIG_INFO_1_STBC
308*5113495bSYour Name 
309*5113495bSYour Name 			<enum 0     no_stbc> Indicates no STBC
310*5113495bSYour Name 
311*5113495bSYour Name 			<enum 1     1_str_stbc> Indicates 1 stream STBC
312*5113495bSYour Name 
313*5113495bSYour Name 			E_num 2     2_str_stbc Indicates 2 stream STBC
314*5113495bSYour Name 			(Unsupported)
315*5113495bSYour Name 
316*5113495bSYour Name 			<legal 0-1>
317*5113495bSYour Name */
318*5113495bSYour Name #define HT_SIG_INFO_1_STBC_OFFSET                                    0x00000004
319*5113495bSYour Name #define HT_SIG_INFO_1_STBC_LSB                                       4
320*5113495bSYour Name #define HT_SIG_INFO_1_STBC_MASK                                      0x00000030
321*5113495bSYour Name 
322*5113495bSYour Name /* Description		HT_SIG_INFO_1_FEC_CODING
323*5113495bSYour Name 
324*5113495bSYour Name 			<enum 0     ht_bcc>  Indicates BCC coding
325*5113495bSYour Name 
326*5113495bSYour Name 			<enum 1     ht_ldpc>  Indicates LDPC coding
327*5113495bSYour Name 
328*5113495bSYour Name 			<legal 0-1>
329*5113495bSYour Name */
330*5113495bSYour Name #define HT_SIG_INFO_1_FEC_CODING_OFFSET                              0x00000004
331*5113495bSYour Name #define HT_SIG_INFO_1_FEC_CODING_LSB                                 6
332*5113495bSYour Name #define HT_SIG_INFO_1_FEC_CODING_MASK                                0x00000040
333*5113495bSYour Name 
334*5113495bSYour Name /* Description		HT_SIG_INFO_1_SHORT_GI
335*5113495bSYour Name 
336*5113495bSYour Name 			<enum 0     ht_normal_gi>  Indicates normal guard
337*5113495bSYour Name 			interval
338*5113495bSYour Name 
339*5113495bSYour Name 
340*5113495bSYour Name 			<legal 0-1>
341*5113495bSYour Name */
342*5113495bSYour Name #define HT_SIG_INFO_1_SHORT_GI_OFFSET                                0x00000004
343*5113495bSYour Name #define HT_SIG_INFO_1_SHORT_GI_LSB                                   7
344*5113495bSYour Name #define HT_SIG_INFO_1_SHORT_GI_MASK                                  0x00000080
345*5113495bSYour Name 
346*5113495bSYour Name /* Description		HT_SIG_INFO_1_NUM_EXT_SP_STR
347*5113495bSYour Name 
348*5113495bSYour Name 			Number of extension spatial streams: (Used for TxBF)
349*5113495bSYour Name 
350*5113495bSYour Name 			<enum 0     0_ext_sp_str>  No extension spatial streams
351*5113495bSYour Name 
352*5113495bSYour Name 			E_num 1     1_ext_sp_str  Not supported: 1 extension
353*5113495bSYour Name 			spatial streams
354*5113495bSYour Name 
355*5113495bSYour Name 			E_num 2     2_ext_sp_str  Not supported:  2 extension
356*5113495bSYour Name 			spatial streams
357*5113495bSYour Name 
358*5113495bSYour Name 			<legal 0>
359*5113495bSYour Name */
360*5113495bSYour Name #define HT_SIG_INFO_1_NUM_EXT_SP_STR_OFFSET                          0x00000004
361*5113495bSYour Name #define HT_SIG_INFO_1_NUM_EXT_SP_STR_LSB                             8
362*5113495bSYour Name #define HT_SIG_INFO_1_NUM_EXT_SP_STR_MASK                            0x00000300
363*5113495bSYour Name 
364*5113495bSYour Name /* Description		HT_SIG_INFO_1_CRC
365*5113495bSYour Name 
366*5113495bSYour Name 			The CRC protects the HT-SIG (HT-SIG[0][23:0] and
367*5113495bSYour Name 			HT-SIG[1][9:0]. The generator polynomial is G(D) = D8 + D2 +
368*5113495bSYour Name 			D + 1.  <legal all>
369*5113495bSYour Name */
370*5113495bSYour Name #define HT_SIG_INFO_1_CRC_OFFSET                                     0x00000004
371*5113495bSYour Name #define HT_SIG_INFO_1_CRC_LSB                                        10
372*5113495bSYour Name #define HT_SIG_INFO_1_CRC_MASK                                       0x0003fc00
373*5113495bSYour Name 
374*5113495bSYour Name /* Description		HT_SIG_INFO_1_SIGNAL_TAIL
375*5113495bSYour Name 
376*5113495bSYour Name 			The 6 bits of tail is always set to 0 is used to flush
377*5113495bSYour Name 			the BCC encoder and decoder.  <legal 0>
378*5113495bSYour Name */
379*5113495bSYour Name #define HT_SIG_INFO_1_SIGNAL_TAIL_OFFSET                             0x00000004
380*5113495bSYour Name #define HT_SIG_INFO_1_SIGNAL_TAIL_LSB                                18
381*5113495bSYour Name #define HT_SIG_INFO_1_SIGNAL_TAIL_MASK                               0x00fc0000
382*5113495bSYour Name 
383*5113495bSYour Name /* Description		HT_SIG_INFO_1_RESERVED_1
384*5113495bSYour Name 
385*5113495bSYour Name 			This field is not part of HT-SIG:
386*5113495bSYour Name 
387*5113495bSYour Name 			Reserved: Should be set to 0 by the MAC and ignored by
388*5113495bSYour Name 			the PHY.  <legal 0>
389*5113495bSYour Name */
390*5113495bSYour Name #define HT_SIG_INFO_1_RESERVED_1_OFFSET                              0x00000004
391*5113495bSYour Name #define HT_SIG_INFO_1_RESERVED_1_LSB                                 24
392*5113495bSYour Name #define HT_SIG_INFO_1_RESERVED_1_MASK                                0xff000000
393*5113495bSYour Name 
394*5113495bSYour Name 
395*5113495bSYour Name #endif // _HT_SIG_INFO_H_
396