xref: /wlan-driver/fw-api/hw/qca5332/vht_sig_b_su80_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name 
2*5113495bSYour Name /* Copyright (c) 2022, Qualcomm Innovation Center, Inc. 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 
18*5113495bSYour Name 
19*5113495bSYour Name 
20*5113495bSYour Name 
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name 
26*5113495bSYour Name #ifndef _VHT_SIG_B_SU80_INFO_H_
27*5113495bSYour Name #define _VHT_SIG_B_SU80_INFO_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #define NUM_OF_DWORDS_VHT_SIG_B_SU80_INFO 4
32*5113495bSYour Name 
33*5113495bSYour Name 
34*5113495bSYour Name struct vht_sig_b_su80_info {
35*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36*5113495bSYour Name              uint32_t length                                                  : 21, // [20:0]
37*5113495bSYour Name                       vhtb_reserved                                           :  2, // [22:21]
38*5113495bSYour Name                       tail                                                    :  6, // [28:23]
39*5113495bSYour Name                       reserved_0                                              :  2, // [30:29]
40*5113495bSYour Name                       rx_ndp                                                  :  1; // [31:31]
41*5113495bSYour Name              uint32_t length_copy_a                                           : 21, // [20:0]
42*5113495bSYour Name                       vhtb_reserved_copy_a                                    :  2, // [22:21]
43*5113495bSYour Name                       tail_copy_a                                             :  6, // [28:23]
44*5113495bSYour Name                       reserved_1                                              :  2, // [30:29]
45*5113495bSYour Name                       rx_ndp_copy_a                                           :  1; // [31:31]
46*5113495bSYour Name              uint32_t length_copy_b                                           : 21, // [20:0]
47*5113495bSYour Name                       vhtb_reserved_copy_b                                    :  2, // [22:21]
48*5113495bSYour Name                       tail_copy_b                                             :  6, // [28:23]
49*5113495bSYour Name                       reserved_2                                              :  2, // [30:29]
50*5113495bSYour Name                       rx_ndp_copy_b                                           :  1; // [31:31]
51*5113495bSYour Name              uint32_t length_copy_c                                           : 21, // [20:0]
52*5113495bSYour Name                       vhtb_reserved_copy_c                                    :  2, // [22:21]
53*5113495bSYour Name                       tail_copy_c                                             :  6, // [28:23]
54*5113495bSYour Name                       reserved_3                                              :  2, // [30:29]
55*5113495bSYour Name                       rx_ndp_copy_c                                           :  1; // [31:31]
56*5113495bSYour Name #else
57*5113495bSYour Name              uint32_t rx_ndp                                                  :  1, // [31:31]
58*5113495bSYour Name                       reserved_0                                              :  2, // [30:29]
59*5113495bSYour Name                       tail                                                    :  6, // [28:23]
60*5113495bSYour Name                       vhtb_reserved                                           :  2, // [22:21]
61*5113495bSYour Name                       length                                                  : 21; // [20:0]
62*5113495bSYour Name              uint32_t rx_ndp_copy_a                                           :  1, // [31:31]
63*5113495bSYour Name                       reserved_1                                              :  2, // [30:29]
64*5113495bSYour Name                       tail_copy_a                                             :  6, // [28:23]
65*5113495bSYour Name                       vhtb_reserved_copy_a                                    :  2, // [22:21]
66*5113495bSYour Name                       length_copy_a                                           : 21; // [20:0]
67*5113495bSYour Name              uint32_t rx_ndp_copy_b                                           :  1, // [31:31]
68*5113495bSYour Name                       reserved_2                                              :  2, // [30:29]
69*5113495bSYour Name                       tail_copy_b                                             :  6, // [28:23]
70*5113495bSYour Name                       vhtb_reserved_copy_b                                    :  2, // [22:21]
71*5113495bSYour Name                       length_copy_b                                           : 21; // [20:0]
72*5113495bSYour Name              uint32_t rx_ndp_copy_c                                           :  1, // [31:31]
73*5113495bSYour Name                       reserved_3                                              :  2, // [30:29]
74*5113495bSYour Name                       tail_copy_c                                             :  6, // [28:23]
75*5113495bSYour Name                       vhtb_reserved_copy_c                                    :  2, // [22:21]
76*5113495bSYour Name                       length_copy_c                                           : 21; // [20:0]
77*5113495bSYour Name #endif
78*5113495bSYour Name };
79*5113495bSYour Name 
80*5113495bSYour Name 
81*5113495bSYour Name /* Description		LENGTH
82*5113495bSYour Name 
83*5113495bSYour Name 			VHT-SIG-B Length (in units of 4 octets) = ceiling (LENGTH/4)
84*5113495bSYour Name 
85*5113495bSYour Name 			<legal all>
86*5113495bSYour Name */
87*5113495bSYour Name 
88*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_OFFSET                                           0x00000000
89*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_LSB                                              0
90*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_MSB                                              20
91*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_MASK                                             0x001fffff
92*5113495bSYour Name 
93*5113495bSYour Name 
94*5113495bSYour Name /* Description		VHTB_RESERVED
95*5113495bSYour Name 
96*5113495bSYour Name 			Reserved:  Set  to all ones for non-NDP frames and ignored
97*5113495bSYour Name 			 on receive  <legal 1,3>
98*5113495bSYour Name */
99*5113495bSYour Name 
100*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_OFFSET                                    0x00000000
101*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_LSB                                       21
102*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_MSB                                       22
103*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_MASK                                      0x00600000
104*5113495bSYour Name 
105*5113495bSYour Name 
106*5113495bSYour Name /* Description		TAIL
107*5113495bSYour Name 
108*5113495bSYour Name 			Used to terminate the trellis of the convolutional decoder.
109*5113495bSYour Name 
110*5113495bSYour Name 			Set to 0.  <legal 0>
111*5113495bSYour Name */
112*5113495bSYour Name 
113*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_OFFSET                                             0x00000000
114*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_LSB                                                23
115*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_MSB                                                28
116*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_MASK                                               0x1f800000
117*5113495bSYour Name 
118*5113495bSYour Name 
119*5113495bSYour Name /* Description		RESERVED_0
120*5113495bSYour Name 
121*5113495bSYour Name 			Not part of VHT-SIG-B.
122*5113495bSYour Name 			Reserved: Set to 0 and ignored on receive  <legal 0>
123*5113495bSYour Name */
124*5113495bSYour Name 
125*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_0_OFFSET                                       0x00000000
126*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_0_LSB                                          29
127*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_0_MSB                                          30
128*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_0_MASK                                         0x60000000
129*5113495bSYour Name 
130*5113495bSYour Name 
131*5113495bSYour Name /* Description		RX_NDP
132*5113495bSYour Name 
133*5113495bSYour Name 			Not part of VHT-SIG-B.
134*5113495bSYour Name 			Used to identify received NDP frame
135*5113495bSYour Name 			<legal 0,1>
136*5113495bSYour Name */
137*5113495bSYour Name 
138*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_OFFSET                                           0x00000000
139*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_LSB                                              31
140*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_MSB                                              31
141*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_MASK                                             0x80000000
142*5113495bSYour Name 
143*5113495bSYour Name 
144*5113495bSYour Name /* Description		LENGTH_COPY_A
145*5113495bSYour Name 
146*5113495bSYour Name 			Same as "length" <legal all>
147*5113495bSYour Name */
148*5113495bSYour Name 
149*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_A_OFFSET                                    0x00000004
150*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_A_LSB                                       0
151*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_A_MSB                                       20
152*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_A_MASK                                      0x001fffff
153*5113495bSYour Name 
154*5113495bSYour Name 
155*5113495bSYour Name /* Description		VHTB_RESERVED_COPY_A
156*5113495bSYour Name 
157*5113495bSYour Name 			Same as "vhtb_reserved"  <legal 1,3>
158*5113495bSYour Name */
159*5113495bSYour Name 
160*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_A_OFFSET                             0x00000004
161*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_A_LSB                                21
162*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_A_MSB                                22
163*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_A_MASK                               0x00600000
164*5113495bSYour Name 
165*5113495bSYour Name 
166*5113495bSYour Name /* Description		TAIL_COPY_A
167*5113495bSYour Name 
168*5113495bSYour Name 			Same as "tail"  <legal 0>
169*5113495bSYour Name */
170*5113495bSYour Name 
171*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_COPY_A_OFFSET                                      0x00000004
172*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_COPY_A_LSB                                         23
173*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_COPY_A_MSB                                         28
174*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_COPY_A_MASK                                        0x1f800000
175*5113495bSYour Name 
176*5113495bSYour Name 
177*5113495bSYour Name /* Description		RESERVED_1
178*5113495bSYour Name 
179*5113495bSYour Name 			Reserved: Set to 0 and ignored on receive  <legal 0>
180*5113495bSYour Name */
181*5113495bSYour Name 
182*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_1_OFFSET                                       0x00000004
183*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_1_LSB                                          29
184*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_1_MSB                                          30
185*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_1_MASK                                         0x60000000
186*5113495bSYour Name 
187*5113495bSYour Name 
188*5113495bSYour Name /* Description		RX_NDP_COPY_A
189*5113495bSYour Name 
190*5113495bSYour Name 			Not part of VHT-SIG-B.
191*5113495bSYour Name 			Used to identify received NDP frame
192*5113495bSYour Name 			<legal 0,1>
193*5113495bSYour Name */
194*5113495bSYour Name 
195*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_A_OFFSET                                    0x00000004
196*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_A_LSB                                       31
197*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_A_MSB                                       31
198*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_A_MASK                                      0x80000000
199*5113495bSYour Name 
200*5113495bSYour Name 
201*5113495bSYour Name /* Description		LENGTH_COPY_B
202*5113495bSYour Name 
203*5113495bSYour Name 			Same as "length" <legal all>
204*5113495bSYour Name */
205*5113495bSYour Name 
206*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_B_OFFSET                                    0x00000008
207*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_B_LSB                                       0
208*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_B_MSB                                       20
209*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_B_MASK                                      0x001fffff
210*5113495bSYour Name 
211*5113495bSYour Name 
212*5113495bSYour Name /* Description		VHTB_RESERVED_COPY_B
213*5113495bSYour Name 
214*5113495bSYour Name 			Same as "vhtb_reserved"  <legal 1,3>
215*5113495bSYour Name */
216*5113495bSYour Name 
217*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_B_OFFSET                             0x00000008
218*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_B_LSB                                21
219*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_B_MSB                                22
220*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_B_MASK                               0x00600000
221*5113495bSYour Name 
222*5113495bSYour Name 
223*5113495bSYour Name /* Description		TAIL_COPY_B
224*5113495bSYour Name 
225*5113495bSYour Name 			Same as "tail"  <legal 0>
226*5113495bSYour Name */
227*5113495bSYour Name 
228*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_COPY_B_OFFSET                                      0x00000008
229*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_COPY_B_LSB                                         23
230*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_COPY_B_MSB                                         28
231*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_COPY_B_MASK                                        0x1f800000
232*5113495bSYour Name 
233*5113495bSYour Name 
234*5113495bSYour Name /* Description		RESERVED_2
235*5113495bSYour Name 
236*5113495bSYour Name 			Reserved: Set to 0 and ignored on receive <legal 0>
237*5113495bSYour Name */
238*5113495bSYour Name 
239*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_2_OFFSET                                       0x00000008
240*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_2_LSB                                          29
241*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_2_MSB                                          30
242*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_2_MASK                                         0x60000000
243*5113495bSYour Name 
244*5113495bSYour Name 
245*5113495bSYour Name /* Description		RX_NDP_COPY_B
246*5113495bSYour Name 
247*5113495bSYour Name 			Not part of VHT-SIG-B.
248*5113495bSYour Name 			Used to identify received NDP frame
249*5113495bSYour Name 			<legal 0,1>
250*5113495bSYour Name */
251*5113495bSYour Name 
252*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_B_OFFSET                                    0x00000008
253*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_B_LSB                                       31
254*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_B_MSB                                       31
255*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_B_MASK                                      0x80000000
256*5113495bSYour Name 
257*5113495bSYour Name 
258*5113495bSYour Name /* Description		LENGTH_COPY_C
259*5113495bSYour Name 
260*5113495bSYour Name 			Same as "length" <legal all>
261*5113495bSYour Name */
262*5113495bSYour Name 
263*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_C_OFFSET                                    0x0000000c
264*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_C_LSB                                       0
265*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_C_MSB                                       20
266*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_C_MASK                                      0x001fffff
267*5113495bSYour Name 
268*5113495bSYour Name 
269*5113495bSYour Name /* Description		VHTB_RESERVED_COPY_C
270*5113495bSYour Name 
271*5113495bSYour Name 			Same as "vhtb_reserved"  <legal 1,3>
272*5113495bSYour Name */
273*5113495bSYour Name 
274*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_C_OFFSET                             0x0000000c
275*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_C_LSB                                21
276*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_C_MSB                                22
277*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_C_MASK                               0x00600000
278*5113495bSYour Name 
279*5113495bSYour Name 
280*5113495bSYour Name /* Description		TAIL_COPY_C
281*5113495bSYour Name 
282*5113495bSYour Name 			Same as "tail"  <legal 0>
283*5113495bSYour Name */
284*5113495bSYour Name 
285*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_COPY_C_OFFSET                                      0x0000000c
286*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_COPY_C_LSB                                         23
287*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_COPY_C_MSB                                         28
288*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_TAIL_COPY_C_MASK                                        0x1f800000
289*5113495bSYour Name 
290*5113495bSYour Name 
291*5113495bSYour Name /* Description		RESERVED_3
292*5113495bSYour Name 
293*5113495bSYour Name 			Reserved: Set to 0 and ignored on receive <legal 0>
294*5113495bSYour Name */
295*5113495bSYour Name 
296*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_3_OFFSET                                       0x0000000c
297*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_3_LSB                                          29
298*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_3_MSB                                          30
299*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RESERVED_3_MASK                                         0x60000000
300*5113495bSYour Name 
301*5113495bSYour Name 
302*5113495bSYour Name /* Description		RX_NDP_COPY_C
303*5113495bSYour Name 
304*5113495bSYour Name 			Not part of VHT-SIG-B.
305*5113495bSYour Name 			Used to identify received NDP frame
306*5113495bSYour Name 			<legal 0,1>
307*5113495bSYour Name */
308*5113495bSYour Name 
309*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_C_OFFSET                                    0x0000000c
310*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_C_LSB                                       31
311*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_C_MSB                                       31
312*5113495bSYour Name #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_C_MASK                                      0x80000000
313*5113495bSYour Name 
314*5113495bSYour Name 
315*5113495bSYour Name 
316*5113495bSYour Name #endif   // VHT_SIG_B_SU80_INFO
317