xref: /wlan-driver/fw-api/hw/qca5332/he_sig_a_mu_ul_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 _HE_SIG_A_MU_UL_INFO_H_
27*5113495bSYour Name #define _HE_SIG_A_MU_UL_INFO_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #define NUM_OF_DWORDS_HE_SIG_A_MU_UL_INFO 2
32*5113495bSYour Name 
33*5113495bSYour Name 
34*5113495bSYour Name struct he_sig_a_mu_ul_info {
35*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36*5113495bSYour Name              uint32_t format_indication                                       :  1, // [0: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: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                                             :  5, // [30:26]
47*5113495bSYour Name                       rx_integrity_check_passed                               :  1; // [31:31]
48*5113495bSYour Name #else
49*5113495bSYour Name              uint32_t reserved_0b                                             :  6, // [31:26]
50*5113495bSYour Name                       transmit_bw                                             :  2, // [25:24]
51*5113495bSYour Name                       reserved_0a                                             :  1, // [23:23]
52*5113495bSYour Name                       spatial_reuse                                           : 16, // [22:7]
53*5113495bSYour Name                       bss_color_id                                            :  6, // [6:1]
54*5113495bSYour Name                       format_indication                                       :  1; // [0:0]
55*5113495bSYour Name              uint32_t rx_integrity_check_passed                               :  1, // [31:31]
56*5113495bSYour Name                       reserved_1b                                             :  5, // [30:26]
57*5113495bSYour Name                       tail                                                    :  6, // [25:20]
58*5113495bSYour Name                       crc                                                     :  4, // [19:16]
59*5113495bSYour Name                       reserved_1a                                             :  9, // [15:7]
60*5113495bSYour Name                       txop_duration                                           :  7; // [6:0]
61*5113495bSYour Name #endif
62*5113495bSYour Name };
63*5113495bSYour Name 
64*5113495bSYour Name 
65*5113495bSYour Name /* Description		FORMAT_INDICATION
66*5113495bSYour Name 
67*5113495bSYour Name 			Indicates whether the transmission is SU PPDU or a trigger
68*5113495bSYour Name 			 based UL MU PDDU
69*5113495bSYour Name 			<enum 0 HE_SIGA_FORMAT_HE_TRIG>
70*5113495bSYour Name 			<enum 1 HE_SIGA_FORMAT_SU_OR_EXT_SU>
71*5113495bSYour Name 			<legal all>
72*5113495bSYour Name */
73*5113495bSYour Name 
74*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_FORMAT_INDICATION_OFFSET                                0x00000000
75*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_FORMAT_INDICATION_LSB                                   0
76*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_FORMAT_INDICATION_MSB                                   0
77*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_FORMAT_INDICATION_MASK                                  0x00000001
78*5113495bSYour Name 
79*5113495bSYour Name 
80*5113495bSYour Name /* Description		BSS_COLOR_ID
81*5113495bSYour Name 
82*5113495bSYour Name 			BSS color ID
83*5113495bSYour Name 			<legal all>
84*5113495bSYour Name */
85*5113495bSYour Name 
86*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_BSS_COLOR_ID_OFFSET                                     0x00000000
87*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_BSS_COLOR_ID_LSB                                        1
88*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_BSS_COLOR_ID_MSB                                        6
89*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_BSS_COLOR_ID_MASK                                       0x0000007e
90*5113495bSYour Name 
91*5113495bSYour Name 
92*5113495bSYour Name /* Description		SPATIAL_REUSE
93*5113495bSYour Name 
94*5113495bSYour Name 			Spatial reuse
95*5113495bSYour Name 
96*5113495bSYour Name 			<legal all>
97*5113495bSYour Name */
98*5113495bSYour Name 
99*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_SPATIAL_REUSE_OFFSET                                    0x00000000
100*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_SPATIAL_REUSE_LSB                                       7
101*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_SPATIAL_REUSE_MSB                                       22
102*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_SPATIAL_REUSE_MASK                                      0x007fff80
103*5113495bSYour Name 
104*5113495bSYour Name 
105*5113495bSYour Name /* Description		RESERVED_0A
106*5113495bSYour Name 
107*5113495bSYour Name 			Note: spec indicates this shall be set to 1
108*5113495bSYour Name 			<legal 1>
109*5113495bSYour Name */
110*5113495bSYour Name 
111*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_0A_OFFSET                                      0x00000000
112*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_0A_LSB                                         23
113*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_0A_MSB                                         23
114*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_0A_MASK                                        0x00800000
115*5113495bSYour Name 
116*5113495bSYour Name 
117*5113495bSYour Name /* Description		TRANSMIT_BW
118*5113495bSYour Name 
119*5113495bSYour Name 			Bandwidth of the PPDU.
120*5113495bSYour Name 
121*5113495bSYour Name 			<enum 0 HE_SIG_A_MU_UL_BW20> 20 Mhz
122*5113495bSYour Name 			<enum 1 HE_SIG_A_MU_UL_BW40> 40 Mhz
123*5113495bSYour Name 			<enum 2 HE_SIG_A_MU_UL_BW80> 80 Mhz
124*5113495bSYour Name 			<enum 3 HE_SIG_A_MU_UL_BW160> 160 MHz or 80+80 MHz
125*5113495bSYour Name 
126*5113495bSYour Name 			On RX side, Field Used by MAC HW
127*5113495bSYour Name 			<legal 0-3>
128*5113495bSYour Name */
129*5113495bSYour Name 
130*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_TRANSMIT_BW_OFFSET                                      0x00000000
131*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_TRANSMIT_BW_LSB                                         24
132*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_TRANSMIT_BW_MSB                                         25
133*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_TRANSMIT_BW_MASK                                        0x03000000
134*5113495bSYour Name 
135*5113495bSYour Name 
136*5113495bSYour Name /* Description		RESERVED_0B
137*5113495bSYour Name 
138*5113495bSYour Name 			<legal 0>
139*5113495bSYour Name */
140*5113495bSYour Name 
141*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_0B_OFFSET                                      0x00000000
142*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_0B_LSB                                         26
143*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_0B_MSB                                         31
144*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_0B_MASK                                        0xfc000000
145*5113495bSYour Name 
146*5113495bSYour Name 
147*5113495bSYour Name /* Description		TXOP_DURATION
148*5113495bSYour Name 
149*5113495bSYour Name 			Indicates the remaining time in the current TXOP <legal
150*5113495bSYour Name 			all>
151*5113495bSYour Name */
152*5113495bSYour Name 
153*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_TXOP_DURATION_OFFSET                                    0x00000004
154*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_TXOP_DURATION_LSB                                       0
155*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_TXOP_DURATION_MSB                                       6
156*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_TXOP_DURATION_MASK                                      0x0000007f
157*5113495bSYour Name 
158*5113495bSYour Name 
159*5113495bSYour Name /* Description		RESERVED_1A
160*5113495bSYour Name 
161*5113495bSYour Name 			Set to value indicated in the trigger frame
162*5113495bSYour Name 			<legal 255>
163*5113495bSYour Name */
164*5113495bSYour Name 
165*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_1A_OFFSET                                      0x00000004
166*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_1A_LSB                                         7
167*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_1A_MSB                                         15
168*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_1A_MASK                                        0x0000ff80
169*5113495bSYour Name 
170*5113495bSYour Name 
171*5113495bSYour Name /* Description		CRC
172*5113495bSYour Name 
173*5113495bSYour Name 			CRC for HE-SIG-A contents.
174*5113495bSYour Name 			This CRC may also cover some fields of L-SIG (TBD)
175*5113495bSYour Name 			<legal all>
176*5113495bSYour Name */
177*5113495bSYour Name 
178*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_CRC_OFFSET                                              0x00000004
179*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_CRC_LSB                                                 16
180*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_CRC_MSB                                                 19
181*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_CRC_MASK                                                0x000f0000
182*5113495bSYour Name 
183*5113495bSYour Name 
184*5113495bSYour Name /* Description		TAIL
185*5113495bSYour Name 
186*5113495bSYour Name 			BCC encoding (similar to VHT-SIG-A) with 6 tail bits is
187*5113495bSYour Name 			used
188*5113495bSYour Name 			<legal 0>
189*5113495bSYour Name */
190*5113495bSYour Name 
191*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_TAIL_OFFSET                                             0x00000004
192*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_TAIL_LSB                                                20
193*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_TAIL_MSB                                                25
194*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_TAIL_MASK                                               0x03f00000
195*5113495bSYour Name 
196*5113495bSYour Name 
197*5113495bSYour Name /* Description		RESERVED_1B
198*5113495bSYour Name 
199*5113495bSYour Name 			<legal 0>
200*5113495bSYour Name */
201*5113495bSYour Name 
202*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_1B_OFFSET                                      0x00000004
203*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_1B_LSB                                         26
204*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_1B_MSB                                         30
205*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RESERVED_1B_MASK                                        0x7c000000
206*5113495bSYour Name 
207*5113495bSYour Name 
208*5113495bSYour Name /* Description		RX_INTEGRITY_CHECK_PASSED
209*5113495bSYour Name 
210*5113495bSYour Name 			TX side: Set to 0
211*5113495bSYour Name 			RX side: Set to 1 if PHY determines the HE-SIG-A CRC check
212*5113495bSYour Name 			 has passed, else set to 0
213*5113495bSYour Name 
214*5113495bSYour Name 			<legal all>
215*5113495bSYour Name */
216*5113495bSYour Name 
217*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RX_INTEGRITY_CHECK_PASSED_OFFSET                        0x00000004
218*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RX_INTEGRITY_CHECK_PASSED_LSB                           31
219*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RX_INTEGRITY_CHECK_PASSED_MSB                           31
220*5113495bSYour Name #define HE_SIG_A_MU_UL_INFO_RX_INTEGRITY_CHECK_PASSED_MASK                          0x80000000
221*5113495bSYour Name 
222*5113495bSYour Name 
223*5113495bSYour Name 
224*5113495bSYour Name #endif   // HE_SIG_A_MU_UL_INFO
225