xref: /wlan-driver/fw-api/hw/qca5332/mactx_u_sig_eht_tb.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 _MACTX_U_SIG_EHT_TB_H_
27*5113495bSYour Name #define _MACTX_U_SIG_EHT_TB_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #include "u_sig_eht_tb_info.h"
32*5113495bSYour Name #define NUM_OF_DWORDS_MACTX_U_SIG_EHT_TB 2
33*5113495bSYour Name 
34*5113495bSYour Name #define NUM_OF_QWORDS_MACTX_U_SIG_EHT_TB 1
35*5113495bSYour Name 
36*5113495bSYour Name 
37*5113495bSYour Name struct mactx_u_sig_eht_tb {
38*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
39*5113495bSYour Name              struct   u_sig_eht_tb_info                                         mactx_u_sig_eht_tb_info_details;
40*5113495bSYour Name #else
41*5113495bSYour Name              struct   u_sig_eht_tb_info                                         mactx_u_sig_eht_tb_info_details;
42*5113495bSYour Name #endif
43*5113495bSYour Name };
44*5113495bSYour Name 
45*5113495bSYour Name 
46*5113495bSYour Name /* Description		MACTX_U_SIG_EHT_TB_INFO_DETAILS
47*5113495bSYour Name 
48*5113495bSYour Name 			See detailed description of the STRUCT
49*5113495bSYour Name */
50*5113495bSYour Name 
51*5113495bSYour Name 
52*5113495bSYour Name /* Description		PHY_VERSION
53*5113495bSYour Name 
54*5113495bSYour Name 			<enum 0 U_SIG_VERSION_EHT>
55*5113495bSYour Name 			Values 1 - 7 are reserved.
56*5113495bSYour Name 			<legal 0>
57*5113495bSYour Name */
58*5113495bSYour Name 
59*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_PHY_VERSION_OFFSET       0x0000000000000000
60*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_PHY_VERSION_LSB          0
61*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_PHY_VERSION_MSB          2
62*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_PHY_VERSION_MASK         0x0000000000000007
63*5113495bSYour Name 
64*5113495bSYour Name 
65*5113495bSYour Name /* Description		TRANSMIT_BW
66*5113495bSYour Name 
67*5113495bSYour Name 			Bandwidth of the PPDU, as indicated in the trigger frame
68*5113495bSYour Name 
69*5113495bSYour Name 
70*5113495bSYour Name 			<enum 0 U_SIG_BW20> 20 MHz
71*5113495bSYour Name 			<enum 1 U_SIG_BW40> 40 MHz
72*5113495bSYour Name 			<enum 2 U_SIG_BW80> 80 MHz
73*5113495bSYour Name 			<enum 3 U_SIG_BW160> 160 MHz
74*5113495bSYour Name 			<enum 4 U_SIG_BW320> 320 MHz channelization scheme 1
75*5113495bSYour Name 			<enum 5 U_SIG_BW320_2> 320 MHz channelization scheme 2
76*5113495bSYour Name 
77*5113495bSYour Name 			On RX side, field used by MAC HW
78*5113495bSYour Name 			<legal all>
79*5113495bSYour Name */
80*5113495bSYour Name 
81*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_TRANSMIT_BW_OFFSET       0x0000000000000000
82*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_TRANSMIT_BW_LSB          3
83*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_TRANSMIT_BW_MSB          5
84*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_TRANSMIT_BW_MASK         0x0000000000000038
85*5113495bSYour Name 
86*5113495bSYour Name 
87*5113495bSYour Name /* Description		DL_UL_FLAG
88*5113495bSYour Name 
89*5113495bSYour Name 			Differentiates between DL and UL transmission
90*5113495bSYour Name 
91*5113495bSYour Name 			<enum 0 DL_UL_FLAG_IS_DL_OR_TDLS>
92*5113495bSYour Name 			<enum 1 DL_UL_FLAG_IS_UL>
93*5113495bSYour Name 			<legal all>
94*5113495bSYour Name */
95*5113495bSYour Name 
96*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_DL_UL_FLAG_OFFSET        0x0000000000000000
97*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_DL_UL_FLAG_LSB           6
98*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_DL_UL_FLAG_MSB           6
99*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_DL_UL_FLAG_MASK          0x0000000000000040
100*5113495bSYour Name 
101*5113495bSYour Name 
102*5113495bSYour Name /* Description		BSS_COLOR_ID
103*5113495bSYour Name 
104*5113495bSYour Name 			BSS color ID
105*5113495bSYour Name 
106*5113495bSYour Name 			Field used by MAC HW
107*5113495bSYour Name 			<legal all>
108*5113495bSYour Name */
109*5113495bSYour Name 
110*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_BSS_COLOR_ID_OFFSET      0x0000000000000000
111*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_BSS_COLOR_ID_LSB         7
112*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_BSS_COLOR_ID_MSB         12
113*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_BSS_COLOR_ID_MASK        0x0000000000001f80
114*5113495bSYour Name 
115*5113495bSYour Name 
116*5113495bSYour Name /* Description		TXOP_DURATION
117*5113495bSYour Name 
118*5113495bSYour Name 			Indicates the remaining time in the current TXOP
119*5113495bSYour Name 
120*5113495bSYour Name 			Field used by MAC HW
121*5113495bSYour Name 			 <legal all>
122*5113495bSYour Name */
123*5113495bSYour Name 
124*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_TXOP_DURATION_OFFSET     0x0000000000000000
125*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_TXOP_DURATION_LSB        13
126*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_TXOP_DURATION_MSB        19
127*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_TXOP_DURATION_MASK       0x00000000000fe000
128*5113495bSYour Name 
129*5113495bSYour Name 
130*5113495bSYour Name /* Description		DISREGARD_0A
131*5113495bSYour Name 
132*5113495bSYour Name 			Set to value indicated in the trigger frame
133*5113495bSYour Name 			<legal all>
134*5113495bSYour Name */
135*5113495bSYour Name 
136*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_DISREGARD_0A_OFFSET      0x0000000000000000
137*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_DISREGARD_0A_LSB         20
138*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_DISREGARD_0A_MSB         25
139*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_DISREGARD_0A_MASK        0x0000000003f00000
140*5113495bSYour Name 
141*5113495bSYour Name 
142*5113495bSYour Name /* Description		RESERVED_0C
143*5113495bSYour Name 
144*5113495bSYour Name 			<legal 0>
145*5113495bSYour Name */
146*5113495bSYour Name 
147*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_RESERVED_0C_OFFSET       0x0000000000000000
148*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_RESERVED_0C_LSB          26
149*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_RESERVED_0C_MSB          31
150*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_RESERVED_0C_MASK         0x00000000fc000000
151*5113495bSYour Name 
152*5113495bSYour Name 
153*5113495bSYour Name /* Description		EHT_PPDU_SIG_CMN_TYPE
154*5113495bSYour Name 
155*5113495bSYour Name 			<enum 3 EHT_PPDU_SIG_rsvd> DO NOT USE
156*5113495bSYour Name 			<enum 0 EHT_PPDU_SIG_TB_or_DL_OFDMA> Need to look at both
157*5113495bSYour Name 			 EHT-SIG content channels for DL OFDMA (including OFDMA+MU-MIMO)
158*5113495bSYour Name 
159*5113495bSYour Name 			<enum 2 EHT_PPDU_SIG_DL_MU_MIMO> Need to look at both EHT-SIG
160*5113495bSYour Name 			 content channels
161*5113495bSYour Name 			<enum 1 EHT_PPDU_SIG_SU> Need to look at only one EHT-SIG
162*5113495bSYour Name 			 content channel
163*5113495bSYour Name 			<legal all>
164*5113495bSYour Name */
165*5113495bSYour Name 
166*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_EHT_PPDU_SIG_CMN_TYPE_OFFSET 0x0000000000000000
167*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_EHT_PPDU_SIG_CMN_TYPE_LSB 32
168*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_EHT_PPDU_SIG_CMN_TYPE_MSB 33
169*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_EHT_PPDU_SIG_CMN_TYPE_MASK 0x0000000300000000
170*5113495bSYour Name 
171*5113495bSYour Name 
172*5113495bSYour Name /* Description		VALIDATE_1A
173*5113495bSYour Name 
174*5113495bSYour Name 			Set to value indicated in the trigger frame
175*5113495bSYour Name 			<legal 1>
176*5113495bSYour Name */
177*5113495bSYour Name 
178*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_VALIDATE_1A_OFFSET       0x0000000000000000
179*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_VALIDATE_1A_LSB          34
180*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_VALIDATE_1A_MSB          34
181*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_VALIDATE_1A_MASK         0x0000000400000000
182*5113495bSYour Name 
183*5113495bSYour Name 
184*5113495bSYour Name /* Description		SPATIAL_REUSE
185*5113495bSYour Name 
186*5113495bSYour Name 			TODO: Placeholder
187*5113495bSYour Name 			<legal all>
188*5113495bSYour Name */
189*5113495bSYour Name 
190*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_SPATIAL_REUSE_OFFSET     0x0000000000000000
191*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_SPATIAL_REUSE_LSB        35
192*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_SPATIAL_REUSE_MSB        42
193*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_SPATIAL_REUSE_MASK       0x000007f800000000
194*5113495bSYour Name 
195*5113495bSYour Name 
196*5113495bSYour Name /* Description		DISREGARD_1B
197*5113495bSYour Name 
198*5113495bSYour Name 			Set to value indicated in the trigger frame
199*5113495bSYour Name 			<legal all>
200*5113495bSYour Name */
201*5113495bSYour Name 
202*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_DISREGARD_1B_OFFSET      0x0000000000000000
203*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_DISREGARD_1B_LSB         43
204*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_DISREGARD_1B_MSB         47
205*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_DISREGARD_1B_MASK        0x0000f80000000000
206*5113495bSYour Name 
207*5113495bSYour Name 
208*5113495bSYour Name /* Description		CRC
209*5113495bSYour Name 
210*5113495bSYour Name 			CRC for U-SIG contents
211*5113495bSYour Name 			<legal all>
212*5113495bSYour Name */
213*5113495bSYour Name 
214*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_CRC_OFFSET               0x0000000000000000
215*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_CRC_LSB                  48
216*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_CRC_MSB                  51
217*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_CRC_MASK                 0x000f000000000000
218*5113495bSYour Name 
219*5113495bSYour Name 
220*5113495bSYour Name /* Description		TAIL
221*5113495bSYour Name 
222*5113495bSYour Name 			<legal 0>
223*5113495bSYour Name */
224*5113495bSYour Name 
225*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_TAIL_OFFSET              0x0000000000000000
226*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_TAIL_LSB                 52
227*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_TAIL_MSB                 57
228*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_TAIL_MASK                0x03f0000000000000
229*5113495bSYour Name 
230*5113495bSYour Name 
231*5113495bSYour Name /* Description		RESERVED_1C
232*5113495bSYour Name 
233*5113495bSYour Name 			<legal 0>
234*5113495bSYour Name */
235*5113495bSYour Name 
236*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_RESERVED_1C_OFFSET       0x0000000000000000
237*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_RESERVED_1C_LSB          58
238*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_RESERVED_1C_MSB          62
239*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_RESERVED_1C_MASK         0x7c00000000000000
240*5113495bSYour Name 
241*5113495bSYour Name 
242*5113495bSYour Name /* Description		RX_INTEGRITY_CHECK_PASSED
243*5113495bSYour Name 
244*5113495bSYour Name 			TX side: Set to 0
245*5113495bSYour Name 			RX side: Set to 1 if PHY determines the U-SIG CRC check
246*5113495bSYour Name 			has passed, else set to 0
247*5113495bSYour Name 
248*5113495bSYour Name 			<legal all>
249*5113495bSYour Name */
250*5113495bSYour Name 
251*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_OFFSET 0x0000000000000000
252*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_LSB 63
253*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_MSB 63
254*5113495bSYour Name #define MACTX_U_SIG_EHT_TB_MACTX_U_SIG_EHT_TB_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_MASK 0x8000000000000000
255*5113495bSYour Name 
256*5113495bSYour Name 
257*5113495bSYour Name 
258*5113495bSYour Name #endif   // MACTX_U_SIG_EHT_TB
259