xref: /wlan-driver/fw-api/hw/qcn6432/mactx_he_sig_b2_ofdma.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 _MACTX_HE_SIG_B2_OFDMA_H_
18*5113495bSYour Name #define _MACTX_HE_SIG_B2_OFDMA_H_
19*5113495bSYour Name #if !defined(__ASSEMBLER__)
20*5113495bSYour Name #endif
21*5113495bSYour Name 
22*5113495bSYour Name #include "he_sig_b2_ofdma_info.h"
23*5113495bSYour Name #define NUM_OF_DWORDS_MACTX_HE_SIG_B2_OFDMA 2
24*5113495bSYour Name 
25*5113495bSYour Name #define NUM_OF_QWORDS_MACTX_HE_SIG_B2_OFDMA 1
26*5113495bSYour Name 
27*5113495bSYour Name 
28*5113495bSYour Name struct mactx_he_sig_b2_ofdma {
29*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
30*5113495bSYour Name              struct   he_sig_b2_ofdma_info                                      mactx_he_sig_b2_ofdma_info_details;
31*5113495bSYour Name #else
32*5113495bSYour Name              struct   he_sig_b2_ofdma_info                                      mactx_he_sig_b2_ofdma_info_details;
33*5113495bSYour Name #endif
34*5113495bSYour Name };
35*5113495bSYour Name 
36*5113495bSYour Name 
37*5113495bSYour Name /* Description		MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS
38*5113495bSYour Name 
39*5113495bSYour Name 			See detailed description of the STRUCT
40*5113495bSYour Name */
41*5113495bSYour Name 
42*5113495bSYour Name 
43*5113495bSYour Name /* Description		STA_ID
44*5113495bSYour Name 
45*5113495bSYour Name 			Identifies the STA that is addressed. Details of STA ID
46*5113495bSYour Name 			are TBD
47*5113495bSYour Name */
48*5113495bSYour Name 
49*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_ID_OFFSET      0x0000000000000000
50*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_ID_LSB         0
51*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_ID_MSB         10
52*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_ID_MASK        0x00000000000007ff
53*5113495bSYour Name 
54*5113495bSYour Name 
55*5113495bSYour Name /* Description		NSTS
56*5113495bSYour Name 
57*5113495bSYour Name 			MAC RX side usage only:
58*5113495bSYour Name 
59*5113495bSYour Name 			Number of spatial streams for this user
60*5113495bSYour Name 
61*5113495bSYour Name 			<enum 0 1_spatial_stream>Single spatial stream
62*5113495bSYour Name 			<enum 1 2_spatial_streams>2 spatial streams
63*5113495bSYour Name 			<enum 2 3_spatial_streams>3 spatial streams
64*5113495bSYour Name 			<enum 3 4_spatial_streams>4 spatial streams
65*5113495bSYour Name 			<enum 4 5_spatial_streams>5 spatial streams
66*5113495bSYour Name 			<enum 5 6_spatial_streams>6 spatial streams
67*5113495bSYour Name 			<enum 6 7_spatial_streams>7 spatial streams
68*5113495bSYour Name 			<enum 7 8_spatial_streams>8 spatial streams
69*5113495bSYour Name */
70*5113495bSYour Name 
71*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_NSTS_OFFSET        0x0000000000000000
72*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_NSTS_LSB           11
73*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_NSTS_MSB           13
74*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_NSTS_MASK          0x0000000000003800
75*5113495bSYour Name 
76*5113495bSYour Name 
77*5113495bSYour Name /* Description		TXBF
78*5113495bSYour Name 
79*5113495bSYour Name 			Indicates whether beamforming is applied
80*5113495bSYour Name 			0: No beamforming
81*5113495bSYour Name 			1: beamforming
82*5113495bSYour Name 			<legal all>
83*5113495bSYour Name */
84*5113495bSYour Name 
85*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_TXBF_OFFSET        0x0000000000000000
86*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_TXBF_LSB           14
87*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_TXBF_MSB           14
88*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_TXBF_MASK          0x0000000000004000
89*5113495bSYour Name 
90*5113495bSYour Name 
91*5113495bSYour Name /* Description		STA_MCS
92*5113495bSYour Name 
93*5113495bSYour Name 			Indicates the data MCS
94*5113495bSYour Name */
95*5113495bSYour Name 
96*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_MCS_OFFSET     0x0000000000000000
97*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_MCS_LSB        15
98*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_MCS_MSB        18
99*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_MCS_MASK       0x0000000000078000
100*5113495bSYour Name 
101*5113495bSYour Name 
102*5113495bSYour Name /* Description		STA_DCM
103*5113495bSYour Name 
104*5113495bSYour Name 			Indicates whether dual sub-carrier modulation is applied
105*5113495bSYour Name 
106*5113495bSYour Name 			0: No DCM
107*5113495bSYour Name 			1:DCM
108*5113495bSYour Name 			<legal all>
109*5113495bSYour Name */
110*5113495bSYour Name 
111*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_DCM_OFFSET     0x0000000000000000
112*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_DCM_LSB        19
113*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_DCM_MSB        19
114*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_DCM_MASK       0x0000000000080000
115*5113495bSYour Name 
116*5113495bSYour Name 
117*5113495bSYour Name /* Description		STA_CODING
118*5113495bSYour Name 
119*5113495bSYour Name 			Distinguishes between BCC/LDPC
120*5113495bSYour Name 
121*5113495bSYour Name 			0: BCC
122*5113495bSYour Name 			1: LDPC
123*5113495bSYour Name 			<legal all>
124*5113495bSYour Name */
125*5113495bSYour Name 
126*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_CODING_OFFSET  0x0000000000000000
127*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_CODING_LSB     20
128*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_CODING_MSB     20
129*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_STA_CODING_MASK    0x0000000000100000
130*5113495bSYour Name 
131*5113495bSYour Name 
132*5113495bSYour Name /* Description		RESERVED_0
133*5113495bSYour Name 
134*5113495bSYour Name 			<legal 0>
135*5113495bSYour Name */
136*5113495bSYour Name 
137*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_RESERVED_0_OFFSET  0x0000000000000000
138*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_RESERVED_0_LSB     21
139*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_RESERVED_0_MSB     30
140*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_RESERVED_0_MASK    0x000000007fe00000
141*5113495bSYour Name 
142*5113495bSYour Name 
143*5113495bSYour Name /* Description		RX_INTEGRITY_CHECK_PASSED
144*5113495bSYour Name 
145*5113495bSYour Name 			TX side: Set to 0
146*5113495bSYour Name 			RX side: Set to 1 if PHY determines the CRC check of the
147*5113495bSYour Name 			 codeblock containing this HE-SIG-B user info has passed,
148*5113495bSYour Name 			else set to 0
149*5113495bSYour Name 
150*5113495bSYour Name 			<legal all>
151*5113495bSYour Name */
152*5113495bSYour Name 
153*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_OFFSET 0x0000000000000000
154*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_LSB 31
155*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_MSB 31
156*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_MASK 0x0000000080000000
157*5113495bSYour Name 
158*5113495bSYour Name 
159*5113495bSYour Name /* Description		USER_ORDER
160*5113495bSYour Name 
161*5113495bSYour Name 			RX side: Set to 0
162*5113495bSYour Name 			TX side: Ordering index of the User field
163*5113495bSYour Name 			Gaps between the ordering indices of User fields indicate
164*5113495bSYour Name 			 that the microcode shall generate "unallocated RU" User
165*5113495bSYour Name 			 fields (STAID=2046) to fill the gaps.
166*5113495bSYour Name 			<legal all>
167*5113495bSYour Name */
168*5113495bSYour Name 
169*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_USER_ORDER_OFFSET  0x0000000000000000
170*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_USER_ORDER_LSB     32
171*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_USER_ORDER_MSB     39
172*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_USER_ORDER_MASK    0x000000ff00000000
173*5113495bSYour Name 
174*5113495bSYour Name 
175*5113495bSYour Name /* Description		CC_MASK
176*5113495bSYour Name 
177*5113495bSYour Name 			RX side: Set to 0
178*5113495bSYour Name 			TX side: Indicates what content channel this User field
179*5113495bSYour Name 			can go to
180*5113495bSYour Name 			Bit 0: content channel 0
181*5113495bSYour Name 			Bit 1: content channel 1
182*5113495bSYour Name 			The other bits are unused, but could repeat the above pattern
183*5113495bSYour Name 			 for compatibility with 'EHT_SIG_USR_OFDMA_INFO.'
184*5113495bSYour Name 			<legal all>
185*5113495bSYour Name */
186*5113495bSYour Name 
187*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_CC_MASK_OFFSET     0x0000000000000000
188*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_CC_MASK_LSB        40
189*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_CC_MASK_MSB        47
190*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_CC_MASK_MASK       0x0000ff0000000000
191*5113495bSYour Name 
192*5113495bSYour Name 
193*5113495bSYour Name /* Description		RESERVED_1A
194*5113495bSYour Name 
195*5113495bSYour Name 			<legal 0>
196*5113495bSYour Name */
197*5113495bSYour Name 
198*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_RESERVED_1A_OFFSET 0x0000000000000000
199*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_RESERVED_1A_LSB    48
200*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_RESERVED_1A_MSB    63
201*5113495bSYour Name #define MACTX_HE_SIG_B2_OFDMA_MACTX_HE_SIG_B2_OFDMA_INFO_DETAILS_RESERVED_1A_MASK   0xffff000000000000
202*5113495bSYour Name 
203*5113495bSYour Name 
204*5113495bSYour Name 
205*5113495bSYour Name #endif   // MACTX_HE_SIG_B2_OFDMA
206