xref: /wlan-driver/fw-api/hw/qca5332/he_sig_b2_ofdma_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_B2_OFDMA_INFO_H_
27*5113495bSYour Name #define _HE_SIG_B2_OFDMA_INFO_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #define NUM_OF_DWORDS_HE_SIG_B2_OFDMA_INFO 2
32*5113495bSYour Name 
33*5113495bSYour Name 
34*5113495bSYour Name struct he_sig_b2_ofdma_info {
35*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
36*5113495bSYour Name              uint32_t sta_id                                                  : 11, // [10:0]
37*5113495bSYour Name                       nsts                                                    :  3, // [13:11]
38*5113495bSYour Name                       txbf                                                    :  1, // [14:14]
39*5113495bSYour Name                       sta_mcs                                                 :  4, // [18:15]
40*5113495bSYour Name                       sta_dcm                                                 :  1, // [19:19]
41*5113495bSYour Name                       sta_coding                                              :  1, // [20:20]
42*5113495bSYour Name                       reserved_0                                              : 10, // [30:21]
43*5113495bSYour Name                       rx_integrity_check_passed                               :  1; // [31:31]
44*5113495bSYour Name              uint32_t user_order                                              :  8, // [7:0]
45*5113495bSYour Name                       cc_mask                                                 :  8, // [15:8]
46*5113495bSYour Name                       reserved_1a                                             : 16; // [31:16]
47*5113495bSYour Name #else
48*5113495bSYour Name              uint32_t rx_integrity_check_passed                               :  1, // [31:31]
49*5113495bSYour Name                       reserved_0                                              : 10, // [30:21]
50*5113495bSYour Name                       sta_coding                                              :  1, // [20:20]
51*5113495bSYour Name                       sta_dcm                                                 :  1, // [19:19]
52*5113495bSYour Name                       sta_mcs                                                 :  4, // [18:15]
53*5113495bSYour Name                       txbf                                                    :  1, // [14:14]
54*5113495bSYour Name                       nsts                                                    :  3, // [13:11]
55*5113495bSYour Name                       sta_id                                                  : 11; // [10:0]
56*5113495bSYour Name              uint32_t reserved_1a                                             : 16, // [31:16]
57*5113495bSYour Name                       cc_mask                                                 :  8, // [15:8]
58*5113495bSYour Name                       user_order                                              :  8; // [7:0]
59*5113495bSYour Name #endif
60*5113495bSYour Name };
61*5113495bSYour Name 
62*5113495bSYour Name 
63*5113495bSYour Name /* Description		STA_ID
64*5113495bSYour Name 
65*5113495bSYour Name 			Identifies the STA that is addressed. Details of STA ID
66*5113495bSYour Name 			are TBD
67*5113495bSYour Name */
68*5113495bSYour Name 
69*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_ID_OFFSET                                          0x00000000
70*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_ID_LSB                                             0
71*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_ID_MSB                                             10
72*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_ID_MASK                                            0x000007ff
73*5113495bSYour Name 
74*5113495bSYour Name 
75*5113495bSYour Name /* Description		NSTS
76*5113495bSYour Name 
77*5113495bSYour Name 			MAC RX side usage only:
78*5113495bSYour Name 
79*5113495bSYour Name 			Number of spatial streams for this user
80*5113495bSYour Name 
81*5113495bSYour Name 			<enum 0 1_spatial_stream>Single spatial stream
82*5113495bSYour Name 			<enum 1 2_spatial_streams>2 spatial streams
83*5113495bSYour Name 			<enum 2 3_spatial_streams>3 spatial streams
84*5113495bSYour Name 			<enum 3 4_spatial_streams>4 spatial streams
85*5113495bSYour Name 			<enum 4 5_spatial_streams>5 spatial streams
86*5113495bSYour Name 			<enum 5 6_spatial_streams>6 spatial streams
87*5113495bSYour Name 			<enum 6 7_spatial_streams>7 spatial streams
88*5113495bSYour Name 			<enum 7 8_spatial_streams>8 spatial streams
89*5113495bSYour Name */
90*5113495bSYour Name 
91*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_NSTS_OFFSET                                            0x00000000
92*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_NSTS_LSB                                               11
93*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_NSTS_MSB                                               13
94*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_NSTS_MASK                                              0x00003800
95*5113495bSYour Name 
96*5113495bSYour Name 
97*5113495bSYour Name /* Description		TXBF
98*5113495bSYour Name 
99*5113495bSYour Name 			Indicates whether beamforming is applied
100*5113495bSYour Name 			0: No beamforming
101*5113495bSYour Name 			1: beamforming
102*5113495bSYour Name 			<legal all>
103*5113495bSYour Name */
104*5113495bSYour Name 
105*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_TXBF_OFFSET                                            0x00000000
106*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_TXBF_LSB                                               14
107*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_TXBF_MSB                                               14
108*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_TXBF_MASK                                              0x00004000
109*5113495bSYour Name 
110*5113495bSYour Name 
111*5113495bSYour Name /* Description		STA_MCS
112*5113495bSYour Name 
113*5113495bSYour Name 			Indicates the data MCS
114*5113495bSYour Name */
115*5113495bSYour Name 
116*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_MCS_OFFSET                                         0x00000000
117*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_MCS_LSB                                            15
118*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_MCS_MSB                                            18
119*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_MCS_MASK                                           0x00078000
120*5113495bSYour Name 
121*5113495bSYour Name 
122*5113495bSYour Name /* Description		STA_DCM
123*5113495bSYour Name 
124*5113495bSYour Name 			Indicates whether dual sub-carrier modulation is applied
125*5113495bSYour Name 
126*5113495bSYour Name 			0: No DCM
127*5113495bSYour Name 			1:DCM
128*5113495bSYour Name 			<legal all>
129*5113495bSYour Name */
130*5113495bSYour Name 
131*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_DCM_OFFSET                                         0x00000000
132*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_DCM_LSB                                            19
133*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_DCM_MSB                                            19
134*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_DCM_MASK                                           0x00080000
135*5113495bSYour Name 
136*5113495bSYour Name 
137*5113495bSYour Name /* Description		STA_CODING
138*5113495bSYour Name 
139*5113495bSYour Name 			Distinguishes between BCC/LDPC
140*5113495bSYour Name 
141*5113495bSYour Name 			0: BCC
142*5113495bSYour Name 			1: LDPC
143*5113495bSYour Name 			<legal all>
144*5113495bSYour Name */
145*5113495bSYour Name 
146*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_CODING_OFFSET                                      0x00000000
147*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_CODING_LSB                                         20
148*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_CODING_MSB                                         20
149*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_STA_CODING_MASK                                        0x00100000
150*5113495bSYour Name 
151*5113495bSYour Name 
152*5113495bSYour Name /* Description		RESERVED_0
153*5113495bSYour Name 
154*5113495bSYour Name 			<legal 0>
155*5113495bSYour Name */
156*5113495bSYour Name 
157*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_RESERVED_0_OFFSET                                      0x00000000
158*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_RESERVED_0_LSB                                         21
159*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_RESERVED_0_MSB                                         30
160*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_RESERVED_0_MASK                                        0x7fe00000
161*5113495bSYour Name 
162*5113495bSYour Name 
163*5113495bSYour Name /* Description		RX_INTEGRITY_CHECK_PASSED
164*5113495bSYour Name 
165*5113495bSYour Name 			TX side: Set to 0
166*5113495bSYour Name 			RX side: Set to 1 if PHY determines the CRC check of the
167*5113495bSYour Name 			 codeblock containing this HE-SIG-B user info has passed,
168*5113495bSYour Name 			else set to 0
169*5113495bSYour Name 
170*5113495bSYour Name 			<legal all>
171*5113495bSYour Name */
172*5113495bSYour Name 
173*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_RX_INTEGRITY_CHECK_PASSED_OFFSET                       0x00000000
174*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_RX_INTEGRITY_CHECK_PASSED_LSB                          31
175*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_RX_INTEGRITY_CHECK_PASSED_MSB                          31
176*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_RX_INTEGRITY_CHECK_PASSED_MASK                         0x80000000
177*5113495bSYour Name 
178*5113495bSYour Name 
179*5113495bSYour Name /* Description		USER_ORDER
180*5113495bSYour Name 
181*5113495bSYour Name 			RX side: Set to 0
182*5113495bSYour Name 			TX side: Ordering index of the User field
183*5113495bSYour Name 			Gaps between the ordering indices of User fields indicate
184*5113495bSYour Name 			 that the microcode shall generate "unallocated RU" User
185*5113495bSYour Name 			 fields (STAID=2046) to fill the gaps.
186*5113495bSYour Name 			<legal all>
187*5113495bSYour Name */
188*5113495bSYour Name 
189*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_USER_ORDER_OFFSET                                      0x00000004
190*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_USER_ORDER_LSB                                         0
191*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_USER_ORDER_MSB                                         7
192*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_USER_ORDER_MASK                                        0x000000ff
193*5113495bSYour Name 
194*5113495bSYour Name 
195*5113495bSYour Name /* Description		CC_MASK
196*5113495bSYour Name 
197*5113495bSYour Name 			RX side: Set to 0
198*5113495bSYour Name 			TX side: Indicates what content channel this User field
199*5113495bSYour Name 			can go to
200*5113495bSYour Name 			Bit 0: content channel 0
201*5113495bSYour Name 			Bit 1: content channel 1
202*5113495bSYour Name 			The other bits are unused, but could repeat the above pattern
203*5113495bSYour Name 			 for compatibility with 'EHT_SIG_USR_OFDMA_INFO.'
204*5113495bSYour Name 			<legal all>
205*5113495bSYour Name */
206*5113495bSYour Name 
207*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_CC_MASK_OFFSET                                         0x00000004
208*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_CC_MASK_LSB                                            8
209*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_CC_MASK_MSB                                            15
210*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_CC_MASK_MASK                                           0x0000ff00
211*5113495bSYour Name 
212*5113495bSYour Name 
213*5113495bSYour Name /* Description		RESERVED_1A
214*5113495bSYour Name 
215*5113495bSYour Name 			<legal 0>
216*5113495bSYour Name */
217*5113495bSYour Name 
218*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_RESERVED_1A_OFFSET                                     0x00000004
219*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_RESERVED_1A_LSB                                        16
220*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_RESERVED_1A_MSB                                        31
221*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_RESERVED_1A_MASK                                       0xffff0000
222*5113495bSYour Name 
223*5113495bSYour Name 
224*5113495bSYour Name 
225*5113495bSYour Name #endif   // HE_SIG_B2_OFDMA_INFO
226