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