xref: /wlan-driver/fw-api/hw/qca9574/l_sig_a_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 _L_SIG_A_INFO_H_
24*5113495bSYour Name #define _L_SIG_A_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	rate[3:0], lsig_reserved[4], length[16:5], parity[17], tail[23:18], pkt_type[27:24], captured_implicit_sounding[28], reserved[31:29]
33*5113495bSYour Name //
34*5113495bSYour Name // ################ END SUMMARY #################
35*5113495bSYour Name 
36*5113495bSYour Name #define NUM_OF_DWORDS_L_SIG_A_INFO 1
37*5113495bSYour Name 
38*5113495bSYour Name struct l_sig_a_info {
39*5113495bSYour Name              uint32_t rate                            :  4, //[3:0]
40*5113495bSYour Name                       lsig_reserved                   :  1, //[4]
41*5113495bSYour Name                       length                          : 12, //[16:5]
42*5113495bSYour Name                       parity                          :  1, //[17]
43*5113495bSYour Name                       tail                            :  6, //[23:18]
44*5113495bSYour Name                       pkt_type                        :  4, //[27:24]
45*5113495bSYour Name                       captured_implicit_sounding      :  1, //[28]
46*5113495bSYour Name                       reserved                        :  3; //[31:29]
47*5113495bSYour Name };
48*5113495bSYour Name 
49*5113495bSYour Name /*
50*5113495bSYour Name 
51*5113495bSYour Name rate
52*5113495bSYour Name 
53*5113495bSYour Name 			This format is originally defined for OFDM as a 4 bit
54*5113495bSYour Name 			field but the 5th bit was added to indicate 11b formatted
55*5113495bSYour Name 			frames.  In the standard bit [4] is specified as reserved.
56*5113495bSYour Name 			For 11b frames this L-SIG is transformed in the PHY into the
57*5113495bSYour Name 			11b preamble format.  The following are the rates:
58*5113495bSYour Name 
59*5113495bSYour Name 			<enum 8     ofdm_48_mbps> 64-QAM 2/3 (48 Mbps)
60*5113495bSYour Name 
61*5113495bSYour Name 			<enum 9     ofdm_24_mbps> 16-QAM 1/2 (24 Mbps)
62*5113495bSYour Name 
63*5113495bSYour Name 			<enum 10     ofdm_12_mbps> QPSK 1/2 (12 Mbps)
64*5113495bSYour Name 
65*5113495bSYour Name 			<enum 11     ofdm_6_mbps> BPSK 1/2 (6 Mbps)
66*5113495bSYour Name 
67*5113495bSYour Name 			<enum 12     ofdm_54_mbps> 64-QAM 3/4 (54 Mbps)
68*5113495bSYour Name 
69*5113495bSYour Name 			<enum 13     ofdm_36_mbps> 16-QAM 3/4 (36 Mbps)
70*5113495bSYour Name 
71*5113495bSYour Name 			<enum 14     ofdm_18_mbps> QPSK 1/2 (18 Mbps)
72*5113495bSYour Name 
73*5113495bSYour Name 			<enum 15     ofdm_9_mbps> BPSK 3/4 (9 Mbps)
74*5113495bSYour Name 
75*5113495bSYour Name 			<legal 8-15>
76*5113495bSYour Name 
77*5113495bSYour Name lsig_reserved
78*5113495bSYour Name 
79*5113495bSYour Name 			Reserved: Should be set to 0 by the MAC and ignored by
80*5113495bSYour Name 			the PHY
81*5113495bSYour Name 
82*5113495bSYour Name 			<legal 0>
83*5113495bSYour Name 
84*5113495bSYour Name length
85*5113495bSYour Name 
86*5113495bSYour Name 			The length indicates the number of octets in this MPDU.
87*5113495bSYour Name 			Note that when using mixed mode 11n preamble this length
88*5113495bSYour Name 			provides the spoofed length for the PPDU.  This length
89*5113495bSYour Name 			provides part of the information to derive the actually PPDU
90*5113495bSYour Name 			length.  For legacy OFDM and 11B frames the maximum length
91*5113495bSYour Name 			is
92*5113495bSYour Name 
93*5113495bSYour Name 			<legal all>
94*5113495bSYour Name 
95*5113495bSYour Name parity
96*5113495bSYour Name 
97*5113495bSYour Name 			11a/n/ac TX: This field provides even parity over the
98*5113495bSYour Name 			first 18 bits of the signal field which means that the sum
99*5113495bSYour Name 			of 1s in the signal field will always be even on
100*5113495bSYour Name 
101*5113495bSYour Name 			11a/n/ac RX: this field contains the received parity
102*5113495bSYour Name 			field from the L-SIG symbol for the current packet.
103*5113495bSYour Name 
104*5113495bSYour Name 			<legal 0-1>
105*5113495bSYour Name 
106*5113495bSYour Name tail
107*5113495bSYour Name 
108*5113495bSYour Name 			The 6 bits of tail is always set to 0 is used to flush
109*5113495bSYour Name 			the BCC encoder and decoder.  <legal 0>
110*5113495bSYour Name 
111*5113495bSYour Name pkt_type
112*5113495bSYour Name 
113*5113495bSYour Name 			Only used on the RX side.
114*5113495bSYour Name 
115*5113495bSYour Name 			Note: This is not really part of L-SIG
116*5113495bSYour Name 
117*5113495bSYour Name 
118*5113495bSYour Name 
119*5113495bSYour Name 			Packet type:
120*5113495bSYour Name 
121*5113495bSYour Name 			<enum 0 dot11a>802.11a PPDU type
122*5113495bSYour Name 
123*5113495bSYour Name 			<enum 1 dot11b>802.11b PPDU type
124*5113495bSYour Name 
125*5113495bSYour Name 			<enum 2 dot11n_mm>802.11n Mixed Mode PPDU type
126*5113495bSYour Name 
127*5113495bSYour Name 			<enum 3 dot11ac>802.11ac PPDU type
128*5113495bSYour Name 
129*5113495bSYour Name 			<enum 4 dot11ax>802.11ax PPDU type
130*5113495bSYour Name 
131*5113495bSYour Name captured_implicit_sounding
132*5113495bSYour Name 
133*5113495bSYour Name 			Only used on the RX side.
134*5113495bSYour Name 
135*5113495bSYour Name 			Note: This is not really part of L-SIG
136*5113495bSYour Name 
137*5113495bSYour Name 
138*5113495bSYour Name 
139*5113495bSYour Name 			This indicates that the PHY has captured implicit
140*5113495bSYour Name 			sounding.
141*5113495bSYour Name 
142*5113495bSYour Name reserved
143*5113495bSYour Name 
144*5113495bSYour Name 			Reserved: Should be set to 0 by the transmitting MAC and
145*5113495bSYour Name 			ignored by the PHY <legal 0>
146*5113495bSYour Name */
147*5113495bSYour Name 
148*5113495bSYour Name 
149*5113495bSYour Name /* Description		L_SIG_A_INFO_0_RATE
150*5113495bSYour Name 
151*5113495bSYour Name 			This format is originally defined for OFDM as a 4 bit
152*5113495bSYour Name 			field but the 5th bit was added to indicate 11b formatted
153*5113495bSYour Name 			frames.  In the standard bit [4] is specified as reserved.
154*5113495bSYour Name 			For 11b frames this L-SIG is transformed in the PHY into the
155*5113495bSYour Name 			11b preamble format.  The following are the rates:
156*5113495bSYour Name 
157*5113495bSYour Name 			<enum 8     ofdm_48_mbps> 64-QAM 2/3 (48 Mbps)
158*5113495bSYour Name 
159*5113495bSYour Name 			<enum 9     ofdm_24_mbps> 16-QAM 1/2 (24 Mbps)
160*5113495bSYour Name 
161*5113495bSYour Name 			<enum 10     ofdm_12_mbps> QPSK 1/2 (12 Mbps)
162*5113495bSYour Name 
163*5113495bSYour Name 			<enum 11     ofdm_6_mbps> BPSK 1/2 (6 Mbps)
164*5113495bSYour Name 
165*5113495bSYour Name 			<enum 12     ofdm_54_mbps> 64-QAM 3/4 (54 Mbps)
166*5113495bSYour Name 
167*5113495bSYour Name 			<enum 13     ofdm_36_mbps> 16-QAM 3/4 (36 Mbps)
168*5113495bSYour Name 
169*5113495bSYour Name 			<enum 14     ofdm_18_mbps> QPSK 1/2 (18 Mbps)
170*5113495bSYour Name 
171*5113495bSYour Name 			<enum 15     ofdm_9_mbps> BPSK 3/4 (9 Mbps)
172*5113495bSYour Name 
173*5113495bSYour Name 			<legal 8-15>
174*5113495bSYour Name */
175*5113495bSYour Name #define L_SIG_A_INFO_0_RATE_OFFSET                                   0x00000000
176*5113495bSYour Name #define L_SIG_A_INFO_0_RATE_LSB                                      0
177*5113495bSYour Name #define L_SIG_A_INFO_0_RATE_MASK                                     0x0000000f
178*5113495bSYour Name 
179*5113495bSYour Name /* Description		L_SIG_A_INFO_0_LSIG_RESERVED
180*5113495bSYour Name 
181*5113495bSYour Name 			Reserved: Should be set to 0 by the MAC and ignored by
182*5113495bSYour Name 			the PHY
183*5113495bSYour Name 
184*5113495bSYour Name 			<legal 0>
185*5113495bSYour Name */
186*5113495bSYour Name #define L_SIG_A_INFO_0_LSIG_RESERVED_OFFSET                          0x00000000
187*5113495bSYour Name #define L_SIG_A_INFO_0_LSIG_RESERVED_LSB                             4
188*5113495bSYour Name #define L_SIG_A_INFO_0_LSIG_RESERVED_MASK                            0x00000010
189*5113495bSYour Name 
190*5113495bSYour Name /* Description		L_SIG_A_INFO_0_LENGTH
191*5113495bSYour Name 
192*5113495bSYour Name 			The length indicates the number of octets in this MPDU.
193*5113495bSYour Name 			Note that when using mixed mode 11n preamble this length
194*5113495bSYour Name 			provides the spoofed length for the PPDU.  This length
195*5113495bSYour Name 			provides part of the information to derive the actually PPDU
196*5113495bSYour Name 			length.  For legacy OFDM and 11B frames the maximum length
197*5113495bSYour Name 			is
198*5113495bSYour Name 
199*5113495bSYour Name 			<legal all>
200*5113495bSYour Name */
201*5113495bSYour Name #define L_SIG_A_INFO_0_LENGTH_OFFSET                                 0x00000000
202*5113495bSYour Name #define L_SIG_A_INFO_0_LENGTH_LSB                                    5
203*5113495bSYour Name #define L_SIG_A_INFO_0_LENGTH_MASK                                   0x0001ffe0
204*5113495bSYour Name 
205*5113495bSYour Name /* Description		L_SIG_A_INFO_0_PARITY
206*5113495bSYour Name 
207*5113495bSYour Name 			11a/n/ac TX: This field provides even parity over the
208*5113495bSYour Name 			first 18 bits of the signal field which means that the sum
209*5113495bSYour Name 			of 1s in the signal field will always be even on
210*5113495bSYour Name 
211*5113495bSYour Name 			11a/n/ac RX: this field contains the received parity
212*5113495bSYour Name 			field from the L-SIG symbol for the current packet.
213*5113495bSYour Name 
214*5113495bSYour Name 			<legal 0-1>
215*5113495bSYour Name */
216*5113495bSYour Name #define L_SIG_A_INFO_0_PARITY_OFFSET                                 0x00000000
217*5113495bSYour Name #define L_SIG_A_INFO_0_PARITY_LSB                                    17
218*5113495bSYour Name #define L_SIG_A_INFO_0_PARITY_MASK                                   0x00020000
219*5113495bSYour Name 
220*5113495bSYour Name /* Description		L_SIG_A_INFO_0_TAIL
221*5113495bSYour Name 
222*5113495bSYour Name 			The 6 bits of tail is always set to 0 is used to flush
223*5113495bSYour Name 			the BCC encoder and decoder.  <legal 0>
224*5113495bSYour Name */
225*5113495bSYour Name #define L_SIG_A_INFO_0_TAIL_OFFSET                                   0x00000000
226*5113495bSYour Name #define L_SIG_A_INFO_0_TAIL_LSB                                      18
227*5113495bSYour Name #define L_SIG_A_INFO_0_TAIL_MASK                                     0x00fc0000
228*5113495bSYour Name 
229*5113495bSYour Name /* Description		L_SIG_A_INFO_0_PKT_TYPE
230*5113495bSYour Name 
231*5113495bSYour Name 			Only used on the RX side.
232*5113495bSYour Name 
233*5113495bSYour Name 			Note: This is not really part of L-SIG
234*5113495bSYour Name 
235*5113495bSYour Name 
236*5113495bSYour Name 
237*5113495bSYour Name 			Packet type:
238*5113495bSYour Name 
239*5113495bSYour Name 			<enum 0 dot11a>802.11a PPDU type
240*5113495bSYour Name 
241*5113495bSYour Name 			<enum 1 dot11b>802.11b PPDU type
242*5113495bSYour Name 
243*5113495bSYour Name 			<enum 2 dot11n_mm>802.11n Mixed Mode PPDU type
244*5113495bSYour Name 
245*5113495bSYour Name 			<enum 3 dot11ac>802.11ac PPDU type
246*5113495bSYour Name 
247*5113495bSYour Name 			<enum 4 dot11ax>802.11ax PPDU type
248*5113495bSYour Name */
249*5113495bSYour Name #define L_SIG_A_INFO_0_PKT_TYPE_OFFSET                               0x00000000
250*5113495bSYour Name #define L_SIG_A_INFO_0_PKT_TYPE_LSB                                  24
251*5113495bSYour Name #define L_SIG_A_INFO_0_PKT_TYPE_MASK                                 0x0f000000
252*5113495bSYour Name 
253*5113495bSYour Name /* Description		L_SIG_A_INFO_0_CAPTURED_IMPLICIT_SOUNDING
254*5113495bSYour Name 
255*5113495bSYour Name 			Only used on the RX side.
256*5113495bSYour Name 
257*5113495bSYour Name 			Note: This is not really part of L-SIG
258*5113495bSYour Name 
259*5113495bSYour Name 
260*5113495bSYour Name 
261*5113495bSYour Name 			This indicates that the PHY has captured implicit
262*5113495bSYour Name 			sounding.
263*5113495bSYour Name */
264*5113495bSYour Name #define L_SIG_A_INFO_0_CAPTURED_IMPLICIT_SOUNDING_OFFSET             0x00000000
265*5113495bSYour Name #define L_SIG_A_INFO_0_CAPTURED_IMPLICIT_SOUNDING_LSB                28
266*5113495bSYour Name #define L_SIG_A_INFO_0_CAPTURED_IMPLICIT_SOUNDING_MASK               0x10000000
267*5113495bSYour Name 
268*5113495bSYour Name /* Description		L_SIG_A_INFO_0_RESERVED
269*5113495bSYour Name 
270*5113495bSYour Name 			Reserved: Should be set to 0 by the transmitting MAC and
271*5113495bSYour Name 			ignored by the PHY <legal 0>
272*5113495bSYour Name */
273*5113495bSYour Name #define L_SIG_A_INFO_0_RESERVED_OFFSET                               0x00000000
274*5113495bSYour Name #define L_SIG_A_INFO_0_RESERVED_LSB                                  29
275*5113495bSYour Name #define L_SIG_A_INFO_0_RESERVED_MASK                                 0xe0000000
276*5113495bSYour Name 
277*5113495bSYour Name 
278*5113495bSYour Name #endif // _L_SIG_A_INFO_H_
279