xref: /wlan-driver/fw-api/hw/qca5332/vht_sig_b_mu80_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_MU80_INFO_H_
27*5113495bSYour Name #define _VHT_SIG_B_MU80_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_MU80_INFO 4
32*5113495bSYour Name 
33*5113495bSYour Name 
34*5113495bSYour Name struct vht_sig_b_mu80_info {
35*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36*5113495bSYour Name              uint32_t length                                                  : 19, // [18:0]
37*5113495bSYour Name                       mcs                                                     :  4, // [22:19]
38*5113495bSYour Name                       tail                                                    :  6, // [28:23]
39*5113495bSYour Name                       reserved_0                                              :  3; // [31:29]
40*5113495bSYour Name              uint32_t length_copy_a                                           : 19, // [18:0]
41*5113495bSYour Name                       mcs_copy_a                                              :  4, // [22:19]
42*5113495bSYour Name                       tail_copy_a                                             :  6, // [28:23]
43*5113495bSYour Name                       reserved_1                                              :  3; // [31:29]
44*5113495bSYour Name              uint32_t length_copy_b                                           : 19, // [18:0]
45*5113495bSYour Name                       mcs_copy_b                                              :  4, // [22:19]
46*5113495bSYour Name                       tail_copy_b                                             :  6, // [28:23]
47*5113495bSYour Name                       mu_user_number                                          :  3; // [31:29]
48*5113495bSYour Name              uint32_t length_copy_c                                           : 19, // [18:0]
49*5113495bSYour Name                       mcs_copy_c                                              :  4, // [22:19]
50*5113495bSYour Name                       tail_copy_c                                             :  6, // [28:23]
51*5113495bSYour Name                       reserved_3                                              :  3; // [31:29]
52*5113495bSYour Name #else
53*5113495bSYour Name              uint32_t reserved_0                                              :  3, // [31:29]
54*5113495bSYour Name                       tail                                                    :  6, // [28:23]
55*5113495bSYour Name                       mcs                                                     :  4, // [22:19]
56*5113495bSYour Name                       length                                                  : 19; // [18:0]
57*5113495bSYour Name              uint32_t reserved_1                                              :  3, // [31:29]
58*5113495bSYour Name                       tail_copy_a                                             :  6, // [28:23]
59*5113495bSYour Name                       mcs_copy_a                                              :  4, // [22:19]
60*5113495bSYour Name                       length_copy_a                                           : 19; // [18:0]
61*5113495bSYour Name              uint32_t mu_user_number                                          :  3, // [31:29]
62*5113495bSYour Name                       tail_copy_b                                             :  6, // [28:23]
63*5113495bSYour Name                       mcs_copy_b                                              :  4, // [22:19]
64*5113495bSYour Name                       length_copy_b                                           : 19; // [18:0]
65*5113495bSYour Name              uint32_t reserved_3                                              :  3, // [31:29]
66*5113495bSYour Name                       tail_copy_c                                             :  6, // [28:23]
67*5113495bSYour Name                       mcs_copy_c                                              :  4, // [22:19]
68*5113495bSYour Name                       length_copy_c                                           : 19; // [18:0]
69*5113495bSYour Name #endif
70*5113495bSYour Name };
71*5113495bSYour Name 
72*5113495bSYour Name 
73*5113495bSYour Name /* Description		LENGTH
74*5113495bSYour Name 
75*5113495bSYour Name 			VHT-SIG-B Length (in units of 4 octets) = ceiling (LENGTH/4)
76*5113495bSYour Name 			 <legal all>
77*5113495bSYour Name */
78*5113495bSYour Name 
79*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_OFFSET                                           0x00000000
80*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_LSB                                              0
81*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_MSB                                              18
82*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_MASK                                             0x0007ffff
83*5113495bSYour Name 
84*5113495bSYour Name 
85*5113495bSYour Name /* Description		MCS
86*5113495bSYour Name 
87*5113495bSYour Name 			Modulation as described in vht_sig_a mcs field  <legal 0-11>
88*5113495bSYour Name 
89*5113495bSYour Name */
90*5113495bSYour Name 
91*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_OFFSET                                              0x00000000
92*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_LSB                                                 19
93*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_MSB                                                 22
94*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_MASK                                                0x00780000
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_MU80_INFO_TAIL_OFFSET                                             0x00000000
105*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_TAIL_LSB                                                23
106*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_TAIL_MSB                                                28
107*5113495bSYour Name #define VHT_SIG_B_MU80_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_MU80_INFO_RESERVED_0_OFFSET                                       0x00000000
117*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_RESERVED_0_LSB                                          29
118*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_RESERVED_0_MSB                                          31
119*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_RESERVED_0_MASK                                         0xe0000000
120*5113495bSYour Name 
121*5113495bSYour Name 
122*5113495bSYour Name /* Description		LENGTH_COPY_A
123*5113495bSYour Name 
124*5113495bSYour Name 			Same as "length". This field is not valid for RX packets
125*5113495bSYour Name 			 <legal all>
126*5113495bSYour Name */
127*5113495bSYour Name 
128*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_COPY_A_OFFSET                                    0x00000004
129*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_COPY_A_LSB                                       0
130*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_COPY_A_MSB                                       18
131*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_COPY_A_MASK                                      0x0007ffff
132*5113495bSYour Name 
133*5113495bSYour Name 
134*5113495bSYour Name /* Description		MCS_COPY_A
135*5113495bSYour Name 
136*5113495bSYour Name 			Same as "mcs". This field is not valid for RX packets  <legal
137*5113495bSYour Name 			 0-11>
138*5113495bSYour Name */
139*5113495bSYour Name 
140*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_COPY_A_OFFSET                                       0x00000004
141*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_COPY_A_LSB                                          19
142*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_COPY_A_MSB                                          22
143*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_COPY_A_MASK                                         0x00780000
144*5113495bSYour Name 
145*5113495bSYour Name 
146*5113495bSYour Name /* Description		TAIL_COPY_A
147*5113495bSYour Name 
148*5113495bSYour Name 			Same as "tail". This field is not valid for RX packets  <legal
149*5113495bSYour Name 			 0>
150*5113495bSYour Name */
151*5113495bSYour Name 
152*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_TAIL_COPY_A_OFFSET                                      0x00000004
153*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_TAIL_COPY_A_LSB                                         23
154*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_TAIL_COPY_A_MSB                                         28
155*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_TAIL_COPY_A_MASK                                        0x1f800000
156*5113495bSYour Name 
157*5113495bSYour Name 
158*5113495bSYour Name /* Description		RESERVED_1
159*5113495bSYour Name 
160*5113495bSYour Name 			Not part of VHT-SIG-B.
161*5113495bSYour Name 			Reserved: Set to 0 and ignored on receive  <legal 0>
162*5113495bSYour Name */
163*5113495bSYour Name 
164*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_RESERVED_1_OFFSET                                       0x00000004
165*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_RESERVED_1_LSB                                          29
166*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_RESERVED_1_MSB                                          31
167*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_RESERVED_1_MASK                                         0xe0000000
168*5113495bSYour Name 
169*5113495bSYour Name 
170*5113495bSYour Name /* Description		LENGTH_COPY_B
171*5113495bSYour Name 
172*5113495bSYour Name 			Same as "length". This field is not valid for RX packets. <legal
173*5113495bSYour Name 			 all>
174*5113495bSYour Name */
175*5113495bSYour Name 
176*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_COPY_B_OFFSET                                    0x00000008
177*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_COPY_B_LSB                                       0
178*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_COPY_B_MSB                                       18
179*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_COPY_B_MASK                                      0x0007ffff
180*5113495bSYour Name 
181*5113495bSYour Name 
182*5113495bSYour Name /* Description		MCS_COPY_B
183*5113495bSYour Name 
184*5113495bSYour Name 			Same as "mcs". This field is not valid for RX packets.
185*5113495bSYour Name 
186*5113495bSYour Name 			<legal 0-11>
187*5113495bSYour Name */
188*5113495bSYour Name 
189*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_COPY_B_OFFSET                                       0x00000008
190*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_COPY_B_LSB                                          19
191*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_COPY_B_MSB                                          22
192*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_COPY_B_MASK                                         0x00780000
193*5113495bSYour Name 
194*5113495bSYour Name 
195*5113495bSYour Name /* Description		TAIL_COPY_B
196*5113495bSYour Name 
197*5113495bSYour Name 			Same as "tail". This field is not valid for RX packets.
198*5113495bSYour Name 			 <legal 0>
199*5113495bSYour Name */
200*5113495bSYour Name 
201*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_TAIL_COPY_B_OFFSET                                      0x00000008
202*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_TAIL_COPY_B_LSB                                         23
203*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_TAIL_COPY_B_MSB                                         28
204*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_TAIL_COPY_B_MASK                                        0x1f800000
205*5113495bSYour Name 
206*5113495bSYour Name 
207*5113495bSYour Name /* Description		MU_USER_NUMBER
208*5113495bSYour Name 
209*5113495bSYour Name 			Not part of VHT-SIG-B.
210*5113495bSYour Name 			Mapping from user number (BFer hardware specific) to mu_user_number.
211*5113495bSYour Name 			The reader is directed to the previous chapter (User Number)
212*5113495bSYour Name 			for a definition of the terms user and mu_user.  <legal
213*5113495bSYour Name 			0-3>
214*5113495bSYour Name */
215*5113495bSYour Name 
216*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MU_USER_NUMBER_OFFSET                                   0x00000008
217*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MU_USER_NUMBER_LSB                                      29
218*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MU_USER_NUMBER_MSB                                      31
219*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MU_USER_NUMBER_MASK                                     0xe0000000
220*5113495bSYour Name 
221*5113495bSYour Name 
222*5113495bSYour Name /* Description		LENGTH_COPY_C
223*5113495bSYour Name 
224*5113495bSYour Name 			Same as "length". This field is not valid for RX packets. <legal
225*5113495bSYour Name 			 all>
226*5113495bSYour Name */
227*5113495bSYour Name 
228*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_COPY_C_OFFSET                                    0x0000000c
229*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_COPY_C_LSB                                       0
230*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_COPY_C_MSB                                       18
231*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_LENGTH_COPY_C_MASK                                      0x0007ffff
232*5113495bSYour Name 
233*5113495bSYour Name 
234*5113495bSYour Name /* Description		MCS_COPY_C
235*5113495bSYour Name 
236*5113495bSYour Name 			Same as "mcs". This field is not valid for RX packets.
237*5113495bSYour Name 
238*5113495bSYour Name 			<legal 0-11>
239*5113495bSYour Name */
240*5113495bSYour Name 
241*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_COPY_C_OFFSET                                       0x0000000c
242*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_COPY_C_LSB                                          19
243*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_COPY_C_MSB                                          22
244*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_MCS_COPY_C_MASK                                         0x00780000
245*5113495bSYour Name 
246*5113495bSYour Name 
247*5113495bSYour Name /* Description		TAIL_COPY_C
248*5113495bSYour Name 
249*5113495bSYour Name 			Same as "tail". This field is not valid for RX packets.
250*5113495bSYour Name 			 <legal 0>
251*5113495bSYour Name */
252*5113495bSYour Name 
253*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_TAIL_COPY_C_OFFSET                                      0x0000000c
254*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_TAIL_COPY_C_LSB                                         23
255*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_TAIL_COPY_C_MSB                                         28
256*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_TAIL_COPY_C_MASK                                        0x1f800000
257*5113495bSYour Name 
258*5113495bSYour Name 
259*5113495bSYour Name /* Description		RESERVED_3
260*5113495bSYour Name 
261*5113495bSYour Name 			<legal 0>
262*5113495bSYour Name */
263*5113495bSYour Name 
264*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_RESERVED_3_OFFSET                                       0x0000000c
265*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_RESERVED_3_LSB                                          29
266*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_RESERVED_3_MSB                                          31
267*5113495bSYour Name #define VHT_SIG_B_MU80_INFO_RESERVED_3_MASK                                         0xe0000000
268*5113495bSYour Name 
269*5113495bSYour Name 
270*5113495bSYour Name 
271*5113495bSYour Name #endif   // VHT_SIG_B_MU80_INFO
272