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