xref: /wlan-driver/fw-api/hw/qca5332/vht_sig_b_mu40_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_MU40_INFO_H_
27*5113495bSYour Name #define _VHT_SIG_B_MU40_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_MU40_INFO 2
32*5113495bSYour Name 
33*5113495bSYour Name 
34*5113495bSYour Name struct vht_sig_b_mu40_info {
35*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36*5113495bSYour Name              uint32_t length                                                  : 17, // [16:0]
37*5113495bSYour Name                       mcs                                                     :  4, // [20:17]
38*5113495bSYour Name                       tail                                                    :  6, // [26:21]
39*5113495bSYour Name                       reserved_0                                              :  2, // [28:27]
40*5113495bSYour Name                       mu_user_number                                          :  3; // [31:29]
41*5113495bSYour Name              uint32_t length_copy                                             : 17, // [16:0]
42*5113495bSYour Name                       mcs_copy                                                :  4, // [20:17]
43*5113495bSYour Name                       tail_copy                                               :  6, // [26:21]
44*5113495bSYour Name                       reserved_1                                              :  5; // [31:27]
45*5113495bSYour Name #else
46*5113495bSYour Name              uint32_t mu_user_number                                          :  3, // [31:29]
47*5113495bSYour Name                       reserved_0                                              :  2, // [28:27]
48*5113495bSYour Name                       tail                                                    :  6, // [26:21]
49*5113495bSYour Name                       mcs                                                     :  4, // [20:17]
50*5113495bSYour Name                       length                                                  : 17; // [16:0]
51*5113495bSYour Name              uint32_t reserved_1                                              :  5, // [31:27]
52*5113495bSYour Name                       tail_copy                                               :  6, // [26:21]
53*5113495bSYour Name                       mcs_copy                                                :  4, // [20:17]
54*5113495bSYour Name                       length_copy                                             : 17; // [16:0]
55*5113495bSYour Name #endif
56*5113495bSYour Name };
57*5113495bSYour Name 
58*5113495bSYour Name 
59*5113495bSYour Name /* Description		LENGTH
60*5113495bSYour Name 
61*5113495bSYour Name 			VHT-SIG-B Length (in units of 4 octets) = ceiling (LENGTH/4) <legal
62*5113495bSYour Name 			 all>
63*5113495bSYour Name */
64*5113495bSYour Name 
65*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_LENGTH_OFFSET                                           0x00000000
66*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_LENGTH_LSB                                              0
67*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_LENGTH_MSB                                              16
68*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_LENGTH_MASK                                             0x0001ffff
69*5113495bSYour Name 
70*5113495bSYour Name 
71*5113495bSYour Name /* Description		MCS
72*5113495bSYour Name 
73*5113495bSYour Name 			Modulation as described in vht_sig_a mcs field
74*5113495bSYour Name 			<legal 0-11>
75*5113495bSYour Name */
76*5113495bSYour Name 
77*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_MCS_OFFSET                                              0x00000000
78*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_MCS_LSB                                                 17
79*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_MCS_MSB                                                 20
80*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_MCS_MASK                                                0x001e0000
81*5113495bSYour Name 
82*5113495bSYour Name 
83*5113495bSYour Name /* Description		TAIL
84*5113495bSYour Name 
85*5113495bSYour Name 			Used to terminate the trellis of the convolutional decoder.
86*5113495bSYour Name 
87*5113495bSYour Name 			Set to 0.
88*5113495bSYour Name 			<legal 0>
89*5113495bSYour Name */
90*5113495bSYour Name 
91*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_TAIL_OFFSET                                             0x00000000
92*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_TAIL_LSB                                                21
93*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_TAIL_MSB                                                26
94*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_TAIL_MASK                                               0x07e00000
95*5113495bSYour Name 
96*5113495bSYour Name 
97*5113495bSYour Name /* Description		RESERVED_0
98*5113495bSYour Name 
99*5113495bSYour Name 			Not part of VHT-SIG-B.
100*5113495bSYour Name 			Reserved: Set to 0 and ignored on receive  <legal 0>
101*5113495bSYour Name */
102*5113495bSYour Name 
103*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_RESERVED_0_OFFSET                                       0x00000000
104*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_RESERVED_0_LSB                                          27
105*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_RESERVED_0_MSB                                          28
106*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_RESERVED_0_MASK                                         0x18000000
107*5113495bSYour Name 
108*5113495bSYour Name 
109*5113495bSYour Name /* Description		MU_USER_NUMBER
110*5113495bSYour Name 
111*5113495bSYour Name 			Not part of VHT-SIG-B.
112*5113495bSYour Name 			Mapping from user number (BFer hardware specific) to mu_user_number.
113*5113495bSYour Name 			The reader is directed to the previous chapter (User Number)
114*5113495bSYour Name 			for a definition of the terms user and mu_user.   <legal
115*5113495bSYour Name 			 0-3>
116*5113495bSYour Name */
117*5113495bSYour Name 
118*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_MU_USER_NUMBER_OFFSET                                   0x00000000
119*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_MU_USER_NUMBER_LSB                                      29
120*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_MU_USER_NUMBER_MSB                                      31
121*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_MU_USER_NUMBER_MASK                                     0xe0000000
122*5113495bSYour Name 
123*5113495bSYour Name 
124*5113495bSYour Name /* Description		LENGTH_COPY
125*5113495bSYour Name 
126*5113495bSYour Name 			Same as "length". This field is not valid for RX packets. <legal
127*5113495bSYour Name 			 all>
128*5113495bSYour Name */
129*5113495bSYour Name 
130*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_LENGTH_COPY_OFFSET                                      0x00000004
131*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_LENGTH_COPY_LSB                                         0
132*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_LENGTH_COPY_MSB                                         16
133*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_LENGTH_COPY_MASK                                        0x0001ffff
134*5113495bSYour Name 
135*5113495bSYour Name 
136*5113495bSYour Name /* Description		MCS_COPY
137*5113495bSYour Name 
138*5113495bSYour Name 			Same as "mcs". This field is not valid for RX packets. <legal
139*5113495bSYour Name 			 0-11>
140*5113495bSYour Name */
141*5113495bSYour Name 
142*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_MCS_COPY_OFFSET                                         0x00000004
143*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_MCS_COPY_LSB                                            17
144*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_MCS_COPY_MSB                                            20
145*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_MCS_COPY_MASK                                           0x001e0000
146*5113495bSYour Name 
147*5113495bSYour Name 
148*5113495bSYour Name /* Description		TAIL_COPY
149*5113495bSYour Name 
150*5113495bSYour Name 			Same as "tail". This field is not valid for RX packets.
151*5113495bSYour Name 			 <legal 0>
152*5113495bSYour Name */
153*5113495bSYour Name 
154*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_TAIL_COPY_OFFSET                                        0x00000004
155*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_TAIL_COPY_LSB                                           21
156*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_TAIL_COPY_MSB                                           26
157*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_TAIL_COPY_MASK                                          0x07e00000
158*5113495bSYour Name 
159*5113495bSYour Name 
160*5113495bSYour Name /* Description		RESERVED_1
161*5113495bSYour Name 
162*5113495bSYour Name 			<legal 0>
163*5113495bSYour Name */
164*5113495bSYour Name 
165*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_RESERVED_1_OFFSET                                       0x00000004
166*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_RESERVED_1_LSB                                          27
167*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_RESERVED_1_MSB                                          31
168*5113495bSYour Name #define VHT_SIG_B_MU40_INFO_RESERVED_1_MASK                                         0xf8000000
169*5113495bSYour Name 
170*5113495bSYour Name 
171*5113495bSYour Name 
172*5113495bSYour Name #endif   // VHT_SIG_B_MU40_INFO
173