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