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