xref: /wlan-driver/fw-api/hw/qca6750/v1/he_sig_a_mu_ul_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2020 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name //
20*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
21*5113495bSYour Name //               These definitions are tied to a particular hardware layout
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name #ifndef _HE_SIG_A_MU_UL_INFO_H_
25*5113495bSYour Name #define _HE_SIG_A_MU_UL_INFO_H_
26*5113495bSYour Name #if !defined(__ASSEMBLER__)
27*5113495bSYour Name #endif
28*5113495bSYour Name 
29*5113495bSYour Name 
30*5113495bSYour Name // ################ START SUMMARY #################
31*5113495bSYour Name //
32*5113495bSYour Name //	Dword	Fields
33*5113495bSYour Name //	0	format_indication[0], bss_color_id[6:1], spatial_reuse[22:7], reserved_0a[23], transmit_bw[25:24], reserved_0b[31:26]
34*5113495bSYour Name //	1	txop_duration[6:0], reserved_1a[15:7], crc[19:16], tail[25:20], reserved_1b[31:26]
35*5113495bSYour Name //
36*5113495bSYour Name // ################ END SUMMARY #################
37*5113495bSYour Name 
38*5113495bSYour Name #define NUM_OF_DWORDS_HE_SIG_A_MU_UL_INFO 2
39*5113495bSYour Name 
40*5113495bSYour Name struct he_sig_a_mu_ul_info {
41*5113495bSYour Name              uint32_t format_indication               :  1, //[0]
42*5113495bSYour Name                       bss_color_id                    :  6, //[6:1]
43*5113495bSYour Name                       spatial_reuse                   : 16, //[22:7]
44*5113495bSYour Name                       reserved_0a                     :  1, //[23]
45*5113495bSYour Name                       transmit_bw                     :  2, //[25:24]
46*5113495bSYour Name                       reserved_0b                     :  6; //[31:26]
47*5113495bSYour Name              uint32_t txop_duration                   :  7, //[6:0]
48*5113495bSYour Name                       reserved_1a                     :  9, //[15:7]
49*5113495bSYour Name                       crc                             :  4, //[19:16]
50*5113495bSYour Name                       tail                            :  6, //[25:20]
51*5113495bSYour Name                       reserved_1b                     :  6; //[31:26]
52*5113495bSYour Name };
53*5113495bSYour Name 
54*5113495bSYour Name /*
55*5113495bSYour Name 
56*5113495bSYour Name format_indication
57*5113495bSYour Name 
58*5113495bSYour Name 			Indicates whether the transmission is SU PPDU or a
59*5113495bSYour Name 			trigger based UL MU PDDU
60*5113495bSYour Name 
61*5113495bSYour Name 			<enum 0 HE_SIGA_FORMAT_HE_TRIG>
62*5113495bSYour Name 
63*5113495bSYour Name 			<enum 1 HE_SIGA_FORMAT_SU_OR_EXT_SU>
64*5113495bSYour Name 
65*5113495bSYour Name 			<legal all>
66*5113495bSYour Name 
67*5113495bSYour Name bss_color_id
68*5113495bSYour Name 
69*5113495bSYour Name 			BSS color ID
70*5113495bSYour Name 
71*5113495bSYour Name 			<legal all>
72*5113495bSYour Name 
73*5113495bSYour Name spatial_reuse
74*5113495bSYour Name 
75*5113495bSYour Name 			Spatial reuse
76*5113495bSYour Name 
77*5113495bSYour Name 
78*5113495bSYour Name 
79*5113495bSYour Name 			<legal all>
80*5113495bSYour Name 
81*5113495bSYour Name reserved_0a
82*5113495bSYour Name 
83*5113495bSYour Name 			Note: spec indicates this shall be set to 1
84*5113495bSYour Name 
85*5113495bSYour Name 			<legal 1>
86*5113495bSYour Name 
87*5113495bSYour Name transmit_bw
88*5113495bSYour Name 
89*5113495bSYour Name 			Bandwidth of the PPDU.
90*5113495bSYour Name 
91*5113495bSYour Name 
92*5113495bSYour Name 
93*5113495bSYour Name 			<enum 0 HE_SIG_A_MU_UL_BW20> 20 Mhz
94*5113495bSYour Name 
95*5113495bSYour Name 			<enum 1 HE_SIG_A_MU_UL_BW40> 40 Mhz
96*5113495bSYour Name 
97*5113495bSYour Name 			<enum 2 HE_SIG_A_MU_UL_BW80> 80 Mhz
98*5113495bSYour Name 
99*5113495bSYour Name 			<enum 3 HE_SIG_A_MU_UL_BW160> 160 MHz or 80+80 MHz
100*5113495bSYour Name 
101*5113495bSYour Name 
102*5113495bSYour Name 
103*5113495bSYour Name 			On RX side, Field Used by MAC HW
104*5113495bSYour Name 
105*5113495bSYour Name 			<legal 0-3>
106*5113495bSYour Name 
107*5113495bSYour Name reserved_0b
108*5113495bSYour Name 
109*5113495bSYour Name 			<legal 0>
110*5113495bSYour Name 
111*5113495bSYour Name txop_duration
112*5113495bSYour Name 
113*5113495bSYour Name 			Indicates the remaining time in the current TXOP <legal
114*5113495bSYour Name 			all>
115*5113495bSYour Name 
116*5113495bSYour Name reserved_1a
117*5113495bSYour Name 
118*5113495bSYour Name 			Set to value indicated in the trigger frame
119*5113495bSYour Name 
120*5113495bSYour Name 			<legal 255>
121*5113495bSYour Name 
122*5113495bSYour Name crc
123*5113495bSYour Name 
124*5113495bSYour Name 			CRC for HE-SIG-A contents.
125*5113495bSYour Name 
126*5113495bSYour Name 			This CRC may also cover some fields of L-SIG (TBD)
127*5113495bSYour Name 
128*5113495bSYour Name 			<legal all>
129*5113495bSYour Name 
130*5113495bSYour Name tail
131*5113495bSYour Name 
132*5113495bSYour Name 			BCC encoding (similar to VHT-SIG-A) with 6 tail bits is
133*5113495bSYour Name 			used
134*5113495bSYour Name 
135*5113495bSYour Name 			<legal 0>
136*5113495bSYour Name 
137*5113495bSYour Name reserved_1b
138*5113495bSYour Name 
139*5113495bSYour Name 			<legal 0>
140*5113495bSYour Name */
141*5113495bSYour Name 
142*5113495bSYour Name 
143*5113495bSYour Name /* Description		HE_SIG_A_MU_UL_INFO_0_FORMAT_INDICATION
144*5113495bSYour Name 
145*5113495bSYour Name 			Indicates whether the transmission is SU PPDU or a
146*5113495bSYour Name 			trigger based UL MU PDDU
147*5113495bSYour Name 
148*5113495bSYour Name 			<enum 0 HE_SIGA_FORMAT_HE_TRIG>
149*5113495bSYour Name 
150*5113495bSYour Name 			<enum 1 HE_SIGA_FORMAT_SU_OR_EXT_SU>
151*5113495bSYour Name 
152*5113495bSYour Name 			<legal all>
153*5113495bSYour Name */
154*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_FORMAT_INDICATION_OFFSET               0x00000000
155*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_FORMAT_INDICATION_LSB                  0
156*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_FORMAT_INDICATION_MASK                 0x00000001
157*5113495bSYour Name 
158*5113495bSYour Name /* Description		HE_SIG_A_MU_UL_INFO_0_BSS_COLOR_ID
159*5113495bSYour Name 
160*5113495bSYour Name 			BSS color ID
161*5113495bSYour Name 
162*5113495bSYour Name 			<legal all>
163*5113495bSYour Name */
164*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_BSS_COLOR_ID_OFFSET                    0x00000000
165*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_BSS_COLOR_ID_LSB                       1
166*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_BSS_COLOR_ID_MASK                      0x0000007e
167*5113495bSYour Name 
168*5113495bSYour Name /* Description		HE_SIG_A_MU_UL_INFO_0_SPATIAL_REUSE
169*5113495bSYour Name 
170*5113495bSYour Name 			Spatial reuse
171*5113495bSYour Name 
172*5113495bSYour Name 
173*5113495bSYour Name 
174*5113495bSYour Name 			<legal all>
175*5113495bSYour Name */
176*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_SPATIAL_REUSE_OFFSET                   0x00000000
177*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_SPATIAL_REUSE_LSB                      7
178*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_SPATIAL_REUSE_MASK                     0x007fff80
179*5113495bSYour Name 
180*5113495bSYour Name /* Description		HE_SIG_A_MU_UL_INFO_0_RESERVED_0A
181*5113495bSYour Name 
182*5113495bSYour Name 			Note: spec indicates this shall be set to 1
183*5113495bSYour Name 
184*5113495bSYour Name 			<legal 1>
185*5113495bSYour Name */
186*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_RESERVED_0A_OFFSET                     0x00000000
187*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_RESERVED_0A_LSB                        23
188*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_RESERVED_0A_MASK                       0x00800000
189*5113495bSYour Name 
190*5113495bSYour Name /* Description		HE_SIG_A_MU_UL_INFO_0_TRANSMIT_BW
191*5113495bSYour Name 
192*5113495bSYour Name 			Bandwidth of the PPDU.
193*5113495bSYour Name 
194*5113495bSYour Name 
195*5113495bSYour Name 
196*5113495bSYour Name 			<enum 0 HE_SIG_A_MU_UL_BW20> 20 Mhz
197*5113495bSYour Name 
198*5113495bSYour Name 			<enum 1 HE_SIG_A_MU_UL_BW40> 40 Mhz
199*5113495bSYour Name 
200*5113495bSYour Name 			<enum 2 HE_SIG_A_MU_UL_BW80> 80 Mhz
201*5113495bSYour Name 
202*5113495bSYour Name 			<enum 3 HE_SIG_A_MU_UL_BW160> 160 MHz or 80+80 MHz
203*5113495bSYour Name 
204*5113495bSYour Name 
205*5113495bSYour Name 
206*5113495bSYour Name 			On RX side, Field Used by MAC HW
207*5113495bSYour Name 
208*5113495bSYour Name 			<legal 0-3>
209*5113495bSYour Name */
210*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_TRANSMIT_BW_OFFSET                     0x00000000
211*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_TRANSMIT_BW_LSB                        24
212*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_TRANSMIT_BW_MASK                       0x03000000
213*5113495bSYour Name 
214*5113495bSYour Name /* Description		HE_SIG_A_MU_UL_INFO_0_RESERVED_0B
215*5113495bSYour Name 
216*5113495bSYour Name 			<legal 0>
217*5113495bSYour Name */
218*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_RESERVED_0B_OFFSET                     0x00000000
219*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_RESERVED_0B_LSB                        26
220*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_0_RESERVED_0B_MASK                       0xfc000000
221*5113495bSYour Name 
222*5113495bSYour Name /* Description		HE_SIG_A_MU_UL_INFO_1_TXOP_DURATION
223*5113495bSYour Name 
224*5113495bSYour Name 			Indicates the remaining time in the current TXOP <legal
225*5113495bSYour Name 			all>
226*5113495bSYour Name */
227*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_TXOP_DURATION_OFFSET                   0x00000004
228*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_TXOP_DURATION_LSB                      0
229*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_TXOP_DURATION_MASK                     0x0000007f
230*5113495bSYour Name 
231*5113495bSYour Name /* Description		HE_SIG_A_MU_UL_INFO_1_RESERVED_1A
232*5113495bSYour Name 
233*5113495bSYour Name 			Set to value indicated in the trigger frame
234*5113495bSYour Name 
235*5113495bSYour Name 			<legal 255>
236*5113495bSYour Name */
237*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_RESERVED_1A_OFFSET                     0x00000004
238*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_RESERVED_1A_LSB                        7
239*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_RESERVED_1A_MASK                       0x0000ff80
240*5113495bSYour Name 
241*5113495bSYour Name /* Description		HE_SIG_A_MU_UL_INFO_1_CRC
242*5113495bSYour Name 
243*5113495bSYour Name 			CRC for HE-SIG-A contents.
244*5113495bSYour Name 
245*5113495bSYour Name 			This CRC may also cover some fields of L-SIG (TBD)
246*5113495bSYour Name 
247*5113495bSYour Name 			<legal all>
248*5113495bSYour Name */
249*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_CRC_OFFSET                             0x00000004
250*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_CRC_LSB                                16
251*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_CRC_MASK                               0x000f0000
252*5113495bSYour Name 
253*5113495bSYour Name /* Description		HE_SIG_A_MU_UL_INFO_1_TAIL
254*5113495bSYour Name 
255*5113495bSYour Name 			BCC encoding (similar to VHT-SIG-A) with 6 tail bits is
256*5113495bSYour Name 			used
257*5113495bSYour Name 
258*5113495bSYour Name 			<legal 0>
259*5113495bSYour Name */
260*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_TAIL_OFFSET                            0x00000004
261*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_TAIL_LSB                               20
262*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_TAIL_MASK                              0x03f00000
263*5113495bSYour Name 
264*5113495bSYour Name /* Description		HE_SIG_A_MU_UL_INFO_1_RESERVED_1B
265*5113495bSYour Name 
266*5113495bSYour Name 			<legal 0>
267*5113495bSYour Name */
268*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_RESERVED_1B_OFFSET                     0x00000004
269*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_RESERVED_1B_LSB                        26
270*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_1_RESERVED_1B_MASK                       0xfc000000
271*5113495bSYour Name 
272*5113495bSYour Name 
273*5113495bSYour Name #endif // _HE_SIG_A_MU_UL_INFO_H_
274