xref: /wlan-driver/fw-api/hw/qcn6432/he_sig_b2_mu_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 _HE_SIG_B2_MU_INFO_H_
18*5113495bSYour Name #define _HE_SIG_B2_MU_INFO_H_
19*5113495bSYour Name #if !defined(__ASSEMBLER__)
20*5113495bSYour Name #endif
21*5113495bSYour Name 
22*5113495bSYour Name #define NUM_OF_DWORDS_HE_SIG_B2_MU_INFO 2
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name struct he_sig_b2_mu_info {
26*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
27*5113495bSYour Name              uint32_t sta_id                                                  : 11, // [10:0]
28*5113495bSYour Name                       sta_spatial_config                                      :  4, // [14:11]
29*5113495bSYour Name                       sta_mcs                                                 :  4, // [18:15]
30*5113495bSYour Name                       reserved_set_to_1                                       :  1, // [19:19]
31*5113495bSYour Name                       sta_coding                                              :  1, // [20:20]
32*5113495bSYour Name                       reserved_0a                                             :  7, // [27:21]
33*5113495bSYour Name                       nsts                                                    :  3, // [30:28]
34*5113495bSYour Name                       rx_integrity_check_passed                               :  1; // [31:31]
35*5113495bSYour Name              uint32_t user_order                                              :  8, // [7:0]
36*5113495bSYour Name                       cc_mask                                                 :  8, // [15:8]
37*5113495bSYour Name                       reserved_1a                                             : 16; // [31:16]
38*5113495bSYour Name #else
39*5113495bSYour Name              uint32_t rx_integrity_check_passed                               :  1, // [31:31]
40*5113495bSYour Name                       nsts                                                    :  3, // [30:28]
41*5113495bSYour Name                       reserved_0a                                             :  7, // [27:21]
42*5113495bSYour Name                       sta_coding                                              :  1, // [20:20]
43*5113495bSYour Name                       reserved_set_to_1                                       :  1, // [19:19]
44*5113495bSYour Name                       sta_mcs                                                 :  4, // [18:15]
45*5113495bSYour Name                       sta_spatial_config                                      :  4, // [14:11]
46*5113495bSYour Name                       sta_id                                                  : 11; // [10:0]
47*5113495bSYour Name              uint32_t reserved_1a                                             : 16, // [31:16]
48*5113495bSYour Name                       cc_mask                                                 :  8, // [15:8]
49*5113495bSYour Name                       user_order                                              :  8; // [7:0]
50*5113495bSYour Name #endif
51*5113495bSYour Name };
52*5113495bSYour Name 
53*5113495bSYour Name 
54*5113495bSYour Name /* Description		STA_ID
55*5113495bSYour Name 
56*5113495bSYour Name 			Identifies the STA that is addressed. Details of STA ID
57*5113495bSYour Name 			are TBD
58*5113495bSYour Name */
59*5113495bSYour Name 
60*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_ID_OFFSET                                             0x00000000
61*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_ID_LSB                                                0
62*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_ID_MSB                                                10
63*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_ID_MASK                                               0x000007ff
64*5113495bSYour Name 
65*5113495bSYour Name 
66*5113495bSYour Name /* Description		STA_SPATIAL_CONFIG
67*5113495bSYour Name 
68*5113495bSYour Name 			Number of assigned spatial streams and their corresponding
69*5113495bSYour Name 			 index.
70*5113495bSYour Name 			Total number of spatial streams assigned for the MU-MIMO
71*5113495bSYour Name 			 allocation is also signaled.
72*5113495bSYour Name */
73*5113495bSYour Name 
74*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_SPATIAL_CONFIG_OFFSET                                 0x00000000
75*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_SPATIAL_CONFIG_LSB                                    11
76*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_SPATIAL_CONFIG_MSB                                    14
77*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_SPATIAL_CONFIG_MASK                                   0x00007800
78*5113495bSYour Name 
79*5113495bSYour Name 
80*5113495bSYour Name /* Description		STA_MCS
81*5113495bSYour Name 
82*5113495bSYour Name 			Indicates the data MCS
83*5113495bSYour Name */
84*5113495bSYour Name 
85*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_MCS_OFFSET                                            0x00000000
86*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_MCS_LSB                                               15
87*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_MCS_MSB                                               18
88*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_MCS_MASK                                              0x00078000
89*5113495bSYour Name 
90*5113495bSYour Name 
91*5113495bSYour Name 
92*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RESERVED_SET_TO_1_OFFSET                                  0x00000000
93*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RESERVED_SET_TO_1_LSB                                     19
94*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RESERVED_SET_TO_1_MSB                                     19
95*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RESERVED_SET_TO_1_MASK                                    0x00080000
96*5113495bSYour Name 
97*5113495bSYour Name 
98*5113495bSYour Name /* Description		STA_CODING
99*5113495bSYour Name 
100*5113495bSYour Name 			Distinguishes between BCC/LDPC
101*5113495bSYour Name 
102*5113495bSYour Name 			0: BCC
103*5113495bSYour Name 			1: LDPC
104*5113495bSYour Name 			<legal all>
105*5113495bSYour Name */
106*5113495bSYour Name 
107*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_CODING_OFFSET                                         0x00000000
108*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_CODING_LSB                                            20
109*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_CODING_MSB                                            20
110*5113495bSYour Name #define HE_SIG_B2_MU_INFO_STA_CODING_MASK                                           0x00100000
111*5113495bSYour Name 
112*5113495bSYour Name 
113*5113495bSYour Name /* Description		RESERVED_0A
114*5113495bSYour Name 
115*5113495bSYour Name 			<legal 0>
116*5113495bSYour Name */
117*5113495bSYour Name 
118*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RESERVED_0A_OFFSET                                        0x00000000
119*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RESERVED_0A_LSB                                           21
120*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RESERVED_0A_MSB                                           27
121*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RESERVED_0A_MASK                                          0x0fe00000
122*5113495bSYour Name 
123*5113495bSYour Name 
124*5113495bSYour Name /* Description		NSTS
125*5113495bSYour Name 
126*5113495bSYour Name 			MAC RX side usage only:
127*5113495bSYour Name 			Needed by RXPCU. Provided by PHY so that RXPCU does not
128*5113495bSYour Name 			need to have the RU number decoding logic.
129*5113495bSYour Name 
130*5113495bSYour Name 			Number of spatial streams for this user
131*5113495bSYour Name 
132*5113495bSYour Name 			<enum 0 1_spatial_stream>Single spatial stream
133*5113495bSYour Name 			<enum 1 2_spatial_streams>2 spatial streams
134*5113495bSYour Name 			<enum 2 3_spatial_streams>3 spatial streams
135*5113495bSYour Name 			<enum 3 4_spatial_streams>4 spatial streams
136*5113495bSYour Name 			<enum 4 5_spatial_streams>5 spatial streams
137*5113495bSYour Name 			<enum 5 6_spatial_streams>6 spatial streams
138*5113495bSYour Name 			<enum 6 7_spatial_streams>7 spatial streams
139*5113495bSYour Name 			<enum 7 8_spatial_streams>8 spatial streams
140*5113495bSYour Name */
141*5113495bSYour Name 
142*5113495bSYour Name #define HE_SIG_B2_MU_INFO_NSTS_OFFSET                                               0x00000000
143*5113495bSYour Name #define HE_SIG_B2_MU_INFO_NSTS_LSB                                                  28
144*5113495bSYour Name #define HE_SIG_B2_MU_INFO_NSTS_MSB                                                  30
145*5113495bSYour Name #define HE_SIG_B2_MU_INFO_NSTS_MASK                                                 0x70000000
146*5113495bSYour Name 
147*5113495bSYour Name 
148*5113495bSYour Name /* Description		RX_INTEGRITY_CHECK_PASSED
149*5113495bSYour Name 
150*5113495bSYour Name 			TX side: Set to 0
151*5113495bSYour Name 			RX side: Set to 1 if PHY determines the CRC check of the
152*5113495bSYour Name 			 codeblock containing this HE-SIG-B user info has passed,
153*5113495bSYour Name 			else set to 0
154*5113495bSYour Name 
155*5113495bSYour Name 			<legal all>
156*5113495bSYour Name */
157*5113495bSYour Name 
158*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RX_INTEGRITY_CHECK_PASSED_OFFSET                          0x00000000
159*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RX_INTEGRITY_CHECK_PASSED_LSB                             31
160*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RX_INTEGRITY_CHECK_PASSED_MSB                             31
161*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RX_INTEGRITY_CHECK_PASSED_MASK                            0x80000000
162*5113495bSYour Name 
163*5113495bSYour Name 
164*5113495bSYour Name /* Description		USER_ORDER
165*5113495bSYour Name 
166*5113495bSYour Name 			RX side: Set to 0
167*5113495bSYour Name 			TX side: Ordering index of the User field
168*5113495bSYour Name 			Gaps between the ordering indices of User fields indicate
169*5113495bSYour Name 			 that the microcode shall generate "unallocated RU" User
170*5113495bSYour Name 			 fields (STAID=2046) to fill the gaps.
171*5113495bSYour Name 			<legal all>
172*5113495bSYour Name */
173*5113495bSYour Name 
174*5113495bSYour Name #define HE_SIG_B2_MU_INFO_USER_ORDER_OFFSET                                         0x00000004
175*5113495bSYour Name #define HE_SIG_B2_MU_INFO_USER_ORDER_LSB                                            0
176*5113495bSYour Name #define HE_SIG_B2_MU_INFO_USER_ORDER_MSB                                            7
177*5113495bSYour Name #define HE_SIG_B2_MU_INFO_USER_ORDER_MASK                                           0x000000ff
178*5113495bSYour Name 
179*5113495bSYour Name 
180*5113495bSYour Name /* Description		CC_MASK
181*5113495bSYour Name 
182*5113495bSYour Name 			RX side: Set to 0
183*5113495bSYour Name 			TX side: Indicates what content channel this User field
184*5113495bSYour Name 			can go to
185*5113495bSYour Name 			Bit 0: content channel 0
186*5113495bSYour Name 			Bit 1: content channel 1
187*5113495bSYour Name 			The other bits are unused, but could repeat the above pattern
188*5113495bSYour Name 			 for compatibility with 'EHT_SIG_USR_MU_MIMO_INFO.'
189*5113495bSYour Name 			<legal all>
190*5113495bSYour Name */
191*5113495bSYour Name 
192*5113495bSYour Name #define HE_SIG_B2_MU_INFO_CC_MASK_OFFSET                                            0x00000004
193*5113495bSYour Name #define HE_SIG_B2_MU_INFO_CC_MASK_LSB                                               8
194*5113495bSYour Name #define HE_SIG_B2_MU_INFO_CC_MASK_MSB                                               15
195*5113495bSYour Name #define HE_SIG_B2_MU_INFO_CC_MASK_MASK                                              0x0000ff00
196*5113495bSYour Name 
197*5113495bSYour Name 
198*5113495bSYour Name /* Description		RESERVED_1A
199*5113495bSYour Name 
200*5113495bSYour Name 			<legal 0>
201*5113495bSYour Name */
202*5113495bSYour Name 
203*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RESERVED_1A_OFFSET                                        0x00000004
204*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RESERVED_1A_LSB                                           16
205*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RESERVED_1A_MSB                                           31
206*5113495bSYour Name #define HE_SIG_B2_MU_INFO_RESERVED_1A_MASK                                          0xffff0000
207*5113495bSYour Name 
208*5113495bSYour Name 
209*5113495bSYour Name 
210*5113495bSYour Name #endif   // HE_SIG_B2_MU_INFO
211