xref: /wlan-driver/fw-api/hw/qca5332/u_sig_eht_tb_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 _U_SIG_EHT_TB_INFO_H_
27*5113495bSYour Name #define _U_SIG_EHT_TB_INFO_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #define NUM_OF_DWORDS_U_SIG_EHT_TB_INFO 2
32*5113495bSYour Name 
33*5113495bSYour Name 
34*5113495bSYour Name struct u_sig_eht_tb_info {
35*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36*5113495bSYour Name              uint32_t phy_version                                             :  3, // [2:0]
37*5113495bSYour Name                       transmit_bw                                             :  3, // [5:3]
38*5113495bSYour Name                       dl_ul_flag                                              :  1, // [6:6]
39*5113495bSYour Name                       bss_color_id                                            :  6, // [12:7]
40*5113495bSYour Name                       txop_duration                                           :  7, // [19:13]
41*5113495bSYour Name                       disregard_0a                                            :  6, // [25:20]
42*5113495bSYour Name                       reserved_0c                                             :  6; // [31:26]
43*5113495bSYour Name              uint32_t eht_ppdu_sig_cmn_type                                   :  2, // [1:0]
44*5113495bSYour Name                       validate_1a                                             :  1, // [2:2]
45*5113495bSYour Name                       spatial_reuse                                           :  8, // [10:3]
46*5113495bSYour Name                       disregard_1b                                            :  5, // [15:11]
47*5113495bSYour Name                       crc                                                     :  4, // [19:16]
48*5113495bSYour Name                       tail                                                    :  6, // [25:20]
49*5113495bSYour Name                       reserved_1c                                             :  5, // [30:26]
50*5113495bSYour Name                       rx_integrity_check_passed                               :  1; // [31:31]
51*5113495bSYour Name #else
52*5113495bSYour Name              uint32_t reserved_0c                                             :  6, // [31:26]
53*5113495bSYour Name                       disregard_0a                                            :  6, // [25:20]
54*5113495bSYour Name                       txop_duration                                           :  7, // [19:13]
55*5113495bSYour Name                       bss_color_id                                            :  6, // [12:7]
56*5113495bSYour Name                       dl_ul_flag                                              :  1, // [6:6]
57*5113495bSYour Name                       transmit_bw                                             :  3, // [5:3]
58*5113495bSYour Name                       phy_version                                             :  3; // [2:0]
59*5113495bSYour Name              uint32_t rx_integrity_check_passed                               :  1, // [31:31]
60*5113495bSYour Name                       reserved_1c                                             :  5, // [30:26]
61*5113495bSYour Name                       tail                                                    :  6, // [25:20]
62*5113495bSYour Name                       crc                                                     :  4, // [19:16]
63*5113495bSYour Name                       disregard_1b                                            :  5, // [15:11]
64*5113495bSYour Name                       spatial_reuse                                           :  8, // [10:3]
65*5113495bSYour Name                       validate_1a                                             :  1, // [2:2]
66*5113495bSYour Name                       eht_ppdu_sig_cmn_type                                   :  2; // [1:0]
67*5113495bSYour Name #endif
68*5113495bSYour Name };
69*5113495bSYour Name 
70*5113495bSYour Name 
71*5113495bSYour Name /* Description		PHY_VERSION
72*5113495bSYour Name 
73*5113495bSYour Name 			<enum 0 U_SIG_VERSION_EHT>
74*5113495bSYour Name 			Values 1 - 7 are reserved.
75*5113495bSYour Name 			<legal 0>
76*5113495bSYour Name */
77*5113495bSYour Name 
78*5113495bSYour Name #define U_SIG_EHT_TB_INFO_PHY_VERSION_OFFSET                                        0x00000000
79*5113495bSYour Name #define U_SIG_EHT_TB_INFO_PHY_VERSION_LSB                                           0
80*5113495bSYour Name #define U_SIG_EHT_TB_INFO_PHY_VERSION_MSB                                           2
81*5113495bSYour Name #define U_SIG_EHT_TB_INFO_PHY_VERSION_MASK                                          0x00000007
82*5113495bSYour Name 
83*5113495bSYour Name 
84*5113495bSYour Name /* Description		TRANSMIT_BW
85*5113495bSYour Name 
86*5113495bSYour Name 			Bandwidth of the PPDU, as indicated in the trigger frame
87*5113495bSYour Name 
88*5113495bSYour Name 
89*5113495bSYour Name 			<enum 0 U_SIG_BW20> 20 MHz
90*5113495bSYour Name 			<enum 1 U_SIG_BW40> 40 MHz
91*5113495bSYour Name 			<enum 2 U_SIG_BW80> 80 MHz
92*5113495bSYour Name 			<enum 3 U_SIG_BW160> 160 MHz
93*5113495bSYour Name 			<enum 4 U_SIG_BW320> 320 MHz channelization scheme 1
94*5113495bSYour Name 			<enum 5 U_SIG_BW320_2> 320 MHz channelization scheme 2
95*5113495bSYour Name 
96*5113495bSYour Name 			On RX side, field used by MAC HW
97*5113495bSYour Name 			<legal all>
98*5113495bSYour Name */
99*5113495bSYour Name 
100*5113495bSYour Name #define U_SIG_EHT_TB_INFO_TRANSMIT_BW_OFFSET                                        0x00000000
101*5113495bSYour Name #define U_SIG_EHT_TB_INFO_TRANSMIT_BW_LSB                                           3
102*5113495bSYour Name #define U_SIG_EHT_TB_INFO_TRANSMIT_BW_MSB                                           5
103*5113495bSYour Name #define U_SIG_EHT_TB_INFO_TRANSMIT_BW_MASK                                          0x00000038
104*5113495bSYour Name 
105*5113495bSYour Name 
106*5113495bSYour Name /* Description		DL_UL_FLAG
107*5113495bSYour Name 
108*5113495bSYour Name 			Differentiates between DL and UL transmission
109*5113495bSYour Name 
110*5113495bSYour Name 			<enum 0 DL_UL_FLAG_IS_DL_OR_TDLS>
111*5113495bSYour Name 			<enum 1 DL_UL_FLAG_IS_UL>
112*5113495bSYour Name 			<legal all>
113*5113495bSYour Name */
114*5113495bSYour Name 
115*5113495bSYour Name #define U_SIG_EHT_TB_INFO_DL_UL_FLAG_OFFSET                                         0x00000000
116*5113495bSYour Name #define U_SIG_EHT_TB_INFO_DL_UL_FLAG_LSB                                            6
117*5113495bSYour Name #define U_SIG_EHT_TB_INFO_DL_UL_FLAG_MSB                                            6
118*5113495bSYour Name #define U_SIG_EHT_TB_INFO_DL_UL_FLAG_MASK                                           0x00000040
119*5113495bSYour Name 
120*5113495bSYour Name 
121*5113495bSYour Name /* Description		BSS_COLOR_ID
122*5113495bSYour Name 
123*5113495bSYour Name 			BSS color ID
124*5113495bSYour Name 
125*5113495bSYour Name 			Field used by MAC HW
126*5113495bSYour Name 			<legal all>
127*5113495bSYour Name */
128*5113495bSYour Name 
129*5113495bSYour Name #define U_SIG_EHT_TB_INFO_BSS_COLOR_ID_OFFSET                                       0x00000000
130*5113495bSYour Name #define U_SIG_EHT_TB_INFO_BSS_COLOR_ID_LSB                                          7
131*5113495bSYour Name #define U_SIG_EHT_TB_INFO_BSS_COLOR_ID_MSB                                          12
132*5113495bSYour Name #define U_SIG_EHT_TB_INFO_BSS_COLOR_ID_MASK                                         0x00001f80
133*5113495bSYour Name 
134*5113495bSYour Name 
135*5113495bSYour Name /* Description		TXOP_DURATION
136*5113495bSYour Name 
137*5113495bSYour Name 			Indicates the remaining time in the current TXOP
138*5113495bSYour Name 
139*5113495bSYour Name 			Field used by MAC HW
140*5113495bSYour Name 			 <legal all>
141*5113495bSYour Name */
142*5113495bSYour Name 
143*5113495bSYour Name #define U_SIG_EHT_TB_INFO_TXOP_DURATION_OFFSET                                      0x00000000
144*5113495bSYour Name #define U_SIG_EHT_TB_INFO_TXOP_DURATION_LSB                                         13
145*5113495bSYour Name #define U_SIG_EHT_TB_INFO_TXOP_DURATION_MSB                                         19
146*5113495bSYour Name #define U_SIG_EHT_TB_INFO_TXOP_DURATION_MASK                                        0x000fe000
147*5113495bSYour Name 
148*5113495bSYour Name 
149*5113495bSYour Name /* Description		DISREGARD_0A
150*5113495bSYour Name 
151*5113495bSYour Name 			Set to value indicated in the trigger frame
152*5113495bSYour Name 			<legal all>
153*5113495bSYour Name */
154*5113495bSYour Name 
155*5113495bSYour Name #define U_SIG_EHT_TB_INFO_DISREGARD_0A_OFFSET                                       0x00000000
156*5113495bSYour Name #define U_SIG_EHT_TB_INFO_DISREGARD_0A_LSB                                          20
157*5113495bSYour Name #define U_SIG_EHT_TB_INFO_DISREGARD_0A_MSB                                          25
158*5113495bSYour Name #define U_SIG_EHT_TB_INFO_DISREGARD_0A_MASK                                         0x03f00000
159*5113495bSYour Name 
160*5113495bSYour Name 
161*5113495bSYour Name /* Description		RESERVED_0C
162*5113495bSYour Name 
163*5113495bSYour Name 			<legal 0>
164*5113495bSYour Name */
165*5113495bSYour Name 
166*5113495bSYour Name #define U_SIG_EHT_TB_INFO_RESERVED_0C_OFFSET                                        0x00000000
167*5113495bSYour Name #define U_SIG_EHT_TB_INFO_RESERVED_0C_LSB                                           26
168*5113495bSYour Name #define U_SIG_EHT_TB_INFO_RESERVED_0C_MSB                                           31
169*5113495bSYour Name #define U_SIG_EHT_TB_INFO_RESERVED_0C_MASK                                          0xfc000000
170*5113495bSYour Name 
171*5113495bSYour Name 
172*5113495bSYour Name /* Description		EHT_PPDU_SIG_CMN_TYPE
173*5113495bSYour Name 
174*5113495bSYour Name 			<enum 3 EHT_PPDU_SIG_rsvd> DO NOT USE
175*5113495bSYour Name 			<enum 0 EHT_PPDU_SIG_TB_or_DL_OFDMA> Need to look at both
176*5113495bSYour Name 			 EHT-SIG content channels for DL OFDMA (including OFDMA+MU-MIMO)
177*5113495bSYour Name 
178*5113495bSYour Name 			<enum 2 EHT_PPDU_SIG_DL_MU_MIMO> Need to look at both EHT-SIG
179*5113495bSYour Name 			 content channels
180*5113495bSYour Name 			<enum 1 EHT_PPDU_SIG_SU> Need to look at only one EHT-SIG
181*5113495bSYour Name 			 content channel
182*5113495bSYour Name 			<legal all>
183*5113495bSYour Name */
184*5113495bSYour Name 
185*5113495bSYour Name #define U_SIG_EHT_TB_INFO_EHT_PPDU_SIG_CMN_TYPE_OFFSET                              0x00000004
186*5113495bSYour Name #define U_SIG_EHT_TB_INFO_EHT_PPDU_SIG_CMN_TYPE_LSB                                 0
187*5113495bSYour Name #define U_SIG_EHT_TB_INFO_EHT_PPDU_SIG_CMN_TYPE_MSB                                 1
188*5113495bSYour Name #define U_SIG_EHT_TB_INFO_EHT_PPDU_SIG_CMN_TYPE_MASK                                0x00000003
189*5113495bSYour Name 
190*5113495bSYour Name 
191*5113495bSYour Name /* Description		VALIDATE_1A
192*5113495bSYour Name 
193*5113495bSYour Name 			Set to value indicated in the trigger frame
194*5113495bSYour Name 			<legal 1>
195*5113495bSYour Name */
196*5113495bSYour Name 
197*5113495bSYour Name #define U_SIG_EHT_TB_INFO_VALIDATE_1A_OFFSET                                        0x00000004
198*5113495bSYour Name #define U_SIG_EHT_TB_INFO_VALIDATE_1A_LSB                                           2
199*5113495bSYour Name #define U_SIG_EHT_TB_INFO_VALIDATE_1A_MSB                                           2
200*5113495bSYour Name #define U_SIG_EHT_TB_INFO_VALIDATE_1A_MASK                                          0x00000004
201*5113495bSYour Name 
202*5113495bSYour Name 
203*5113495bSYour Name /* Description		SPATIAL_REUSE
204*5113495bSYour Name 
205*5113495bSYour Name 			TODO: Placeholder
206*5113495bSYour Name 			<legal all>
207*5113495bSYour Name */
208*5113495bSYour Name 
209*5113495bSYour Name #define U_SIG_EHT_TB_INFO_SPATIAL_REUSE_OFFSET                                      0x00000004
210*5113495bSYour Name #define U_SIG_EHT_TB_INFO_SPATIAL_REUSE_LSB                                         3
211*5113495bSYour Name #define U_SIG_EHT_TB_INFO_SPATIAL_REUSE_MSB                                         10
212*5113495bSYour Name #define U_SIG_EHT_TB_INFO_SPATIAL_REUSE_MASK                                        0x000007f8
213*5113495bSYour Name 
214*5113495bSYour Name 
215*5113495bSYour Name /* Description		DISREGARD_1B
216*5113495bSYour Name 
217*5113495bSYour Name 			Set to value indicated in the trigger frame
218*5113495bSYour Name 			<legal all>
219*5113495bSYour Name */
220*5113495bSYour Name 
221*5113495bSYour Name #define U_SIG_EHT_TB_INFO_DISREGARD_1B_OFFSET                                       0x00000004
222*5113495bSYour Name #define U_SIG_EHT_TB_INFO_DISREGARD_1B_LSB                                          11
223*5113495bSYour Name #define U_SIG_EHT_TB_INFO_DISREGARD_1B_MSB                                          15
224*5113495bSYour Name #define U_SIG_EHT_TB_INFO_DISREGARD_1B_MASK                                         0x0000f800
225*5113495bSYour Name 
226*5113495bSYour Name 
227*5113495bSYour Name /* Description		CRC
228*5113495bSYour Name 
229*5113495bSYour Name 			CRC for U-SIG contents
230*5113495bSYour Name 			<legal all>
231*5113495bSYour Name */
232*5113495bSYour Name 
233*5113495bSYour Name #define U_SIG_EHT_TB_INFO_CRC_OFFSET                                                0x00000004
234*5113495bSYour Name #define U_SIG_EHT_TB_INFO_CRC_LSB                                                   16
235*5113495bSYour Name #define U_SIG_EHT_TB_INFO_CRC_MSB                                                   19
236*5113495bSYour Name #define U_SIG_EHT_TB_INFO_CRC_MASK                                                  0x000f0000
237*5113495bSYour Name 
238*5113495bSYour Name 
239*5113495bSYour Name /* Description		TAIL
240*5113495bSYour Name 
241*5113495bSYour Name 			<legal 0>
242*5113495bSYour Name */
243*5113495bSYour Name 
244*5113495bSYour Name #define U_SIG_EHT_TB_INFO_TAIL_OFFSET                                               0x00000004
245*5113495bSYour Name #define U_SIG_EHT_TB_INFO_TAIL_LSB                                                  20
246*5113495bSYour Name #define U_SIG_EHT_TB_INFO_TAIL_MSB                                                  25
247*5113495bSYour Name #define U_SIG_EHT_TB_INFO_TAIL_MASK                                                 0x03f00000
248*5113495bSYour Name 
249*5113495bSYour Name 
250*5113495bSYour Name /* Description		RESERVED_1C
251*5113495bSYour Name 
252*5113495bSYour Name 			<legal 0>
253*5113495bSYour Name */
254*5113495bSYour Name 
255*5113495bSYour Name #define U_SIG_EHT_TB_INFO_RESERVED_1C_OFFSET                                        0x00000004
256*5113495bSYour Name #define U_SIG_EHT_TB_INFO_RESERVED_1C_LSB                                           26
257*5113495bSYour Name #define U_SIG_EHT_TB_INFO_RESERVED_1C_MSB                                           30
258*5113495bSYour Name #define U_SIG_EHT_TB_INFO_RESERVED_1C_MASK                                          0x7c000000
259*5113495bSYour Name 
260*5113495bSYour Name 
261*5113495bSYour Name /* Description		RX_INTEGRITY_CHECK_PASSED
262*5113495bSYour Name 
263*5113495bSYour Name 			TX side: Set to 0
264*5113495bSYour Name 			RX side: Set to 1 if PHY determines the U-SIG CRC check
265*5113495bSYour Name 			has passed, else set to 0
266*5113495bSYour Name 
267*5113495bSYour Name 			<legal all>
268*5113495bSYour Name */
269*5113495bSYour Name 
270*5113495bSYour Name #define U_SIG_EHT_TB_INFO_RX_INTEGRITY_CHECK_PASSED_OFFSET                          0x00000004
271*5113495bSYour Name #define U_SIG_EHT_TB_INFO_RX_INTEGRITY_CHECK_PASSED_LSB                             31
272*5113495bSYour Name #define U_SIG_EHT_TB_INFO_RX_INTEGRITY_CHECK_PASSED_MSB                             31
273*5113495bSYour Name #define U_SIG_EHT_TB_INFO_RX_INTEGRITY_CHECK_PASSED_MASK                            0x80000000
274*5113495bSYour Name 
275*5113495bSYour Name 
276*5113495bSYour Name 
277*5113495bSYour Name #endif   // U_SIG_EHT_TB_INFO
278