xref: /wlan-driver/fw-api/hw/qca5332/phyrx_he_sig_b2_mu.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 _PHYRX_HE_SIG_B2_MU_H_
27*5113495bSYour Name #define _PHYRX_HE_SIG_B2_MU_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #include "he_sig_b2_mu_info.h"
32*5113495bSYour Name #define NUM_OF_DWORDS_PHYRX_HE_SIG_B2_MU 2
33*5113495bSYour Name 
34*5113495bSYour Name #define NUM_OF_QWORDS_PHYRX_HE_SIG_B2_MU 1
35*5113495bSYour Name 
36*5113495bSYour Name 
37*5113495bSYour Name struct phyrx_he_sig_b2_mu {
38*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
39*5113495bSYour Name              struct   he_sig_b2_mu_info                                         phyrx_he_sig_b2_mu_info_details;
40*5113495bSYour Name #else
41*5113495bSYour Name              struct   he_sig_b2_mu_info                                         phyrx_he_sig_b2_mu_info_details;
42*5113495bSYour Name #endif
43*5113495bSYour Name };
44*5113495bSYour Name 
45*5113495bSYour Name 
46*5113495bSYour Name /* Description		PHYRX_HE_SIG_B2_MU_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		STA_ID
53*5113495bSYour Name 
54*5113495bSYour Name 			Identifies the STA that is addressed. Details of STA ID
55*5113495bSYour Name 			are TBD
56*5113495bSYour Name */
57*5113495bSYour Name 
58*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_ID_OFFSET            0x0000000000000000
59*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_ID_LSB               0
60*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_ID_MSB               10
61*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_ID_MASK              0x00000000000007ff
62*5113495bSYour Name 
63*5113495bSYour Name 
64*5113495bSYour Name /* Description		STA_SPATIAL_CONFIG
65*5113495bSYour Name 
66*5113495bSYour Name 			Number of assigned spatial streams and their corresponding
67*5113495bSYour Name 			 index.
68*5113495bSYour Name 			Total number of spatial streams assigned for the MU-MIMO
69*5113495bSYour Name 			 allocation is also signaled.
70*5113495bSYour Name */
71*5113495bSYour Name 
72*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_SPATIAL_CONFIG_OFFSET 0x0000000000000000
73*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_SPATIAL_CONFIG_LSB   11
74*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_SPATIAL_CONFIG_MSB   14
75*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_SPATIAL_CONFIG_MASK  0x0000000000007800
76*5113495bSYour Name 
77*5113495bSYour Name 
78*5113495bSYour Name /* Description		STA_MCS
79*5113495bSYour Name 
80*5113495bSYour Name 			Indicates the data MCS
81*5113495bSYour Name */
82*5113495bSYour Name 
83*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_MCS_OFFSET           0x0000000000000000
84*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_MCS_LSB              15
85*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_MCS_MSB              18
86*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_MCS_MASK             0x0000000000078000
87*5113495bSYour Name 
88*5113495bSYour Name 
89*5113495bSYour Name /* Description		RESERVED_SET_TO_1
90*5113495bSYour Name 
91*5113495bSYour Name 			<legal 1>
92*5113495bSYour Name */
93*5113495bSYour Name 
94*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_SET_TO_1_OFFSET 0x0000000000000000
95*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_SET_TO_1_LSB    19
96*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_SET_TO_1_MSB    19
97*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_SET_TO_1_MASK   0x0000000000080000
98*5113495bSYour Name 
99*5113495bSYour Name 
100*5113495bSYour Name /* Description		STA_CODING
101*5113495bSYour Name 
102*5113495bSYour Name 			Distinguishes between BCC/LDPC
103*5113495bSYour Name 
104*5113495bSYour Name 			0: BCC
105*5113495bSYour Name 			1: LDPC
106*5113495bSYour Name 			<legal all>
107*5113495bSYour Name */
108*5113495bSYour Name 
109*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_CODING_OFFSET        0x0000000000000000
110*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_CODING_LSB           20
111*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_CODING_MSB           20
112*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_STA_CODING_MASK          0x0000000000100000
113*5113495bSYour Name 
114*5113495bSYour Name 
115*5113495bSYour Name /* Description		RESERVED_0A
116*5113495bSYour Name 
117*5113495bSYour Name 			<legal 0>
118*5113495bSYour Name */
119*5113495bSYour Name 
120*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_0A_OFFSET       0x0000000000000000
121*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_0A_LSB          21
122*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_0A_MSB          27
123*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_0A_MASK         0x000000000fe00000
124*5113495bSYour Name 
125*5113495bSYour Name 
126*5113495bSYour Name /* Description		NSTS
127*5113495bSYour Name 
128*5113495bSYour Name 			MAC RX side usage only:
129*5113495bSYour Name 			Needed by RXPCU. Provided by PHY so that RXPCU does not
130*5113495bSYour Name 			need to have the RU number decoding logic.
131*5113495bSYour Name 
132*5113495bSYour Name 			Number of spatial streams for this user
133*5113495bSYour Name 
134*5113495bSYour Name 			<enum 0 1_spatial_stream>Single spatial stream
135*5113495bSYour Name 			<enum 1 2_spatial_streams>2 spatial streams
136*5113495bSYour Name 			<enum 2 3_spatial_streams>3 spatial streams
137*5113495bSYour Name 			<enum 3 4_spatial_streams>4 spatial streams
138*5113495bSYour Name 			<enum 4 5_spatial_streams>5 spatial streams
139*5113495bSYour Name 			<enum 5 6_spatial_streams>6 spatial streams
140*5113495bSYour Name 			<enum 6 7_spatial_streams>7 spatial streams
141*5113495bSYour Name 			<enum 7 8_spatial_streams>8 spatial streams
142*5113495bSYour Name */
143*5113495bSYour Name 
144*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_NSTS_OFFSET              0x0000000000000000
145*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_NSTS_LSB                 28
146*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_NSTS_MSB                 30
147*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_NSTS_MASK                0x0000000070000000
148*5113495bSYour Name 
149*5113495bSYour Name 
150*5113495bSYour Name /* Description		RX_INTEGRITY_CHECK_PASSED
151*5113495bSYour Name 
152*5113495bSYour Name 			TX side: Set to 0
153*5113495bSYour Name 			RX side: Set to 1 if PHY determines the CRC check of the
154*5113495bSYour Name 			 codeblock containing this HE-SIG-B user info has passed,
155*5113495bSYour Name 			else set to 0
156*5113495bSYour Name 
157*5113495bSYour Name 			<legal all>
158*5113495bSYour Name */
159*5113495bSYour Name 
160*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_OFFSET 0x0000000000000000
161*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_LSB 31
162*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_MSB 31
163*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RX_INTEGRITY_CHECK_PASSED_MASK 0x0000000080000000
164*5113495bSYour Name 
165*5113495bSYour Name 
166*5113495bSYour Name /* Description		USER_ORDER
167*5113495bSYour Name 
168*5113495bSYour Name 			RX side: Set to 0
169*5113495bSYour Name 			TX side: Ordering index of the User field
170*5113495bSYour Name 			Gaps between the ordering indices of User fields indicate
171*5113495bSYour Name 			 that the microcode shall generate "unallocated RU" User
172*5113495bSYour Name 			 fields (STAID=2046) to fill the gaps.
173*5113495bSYour Name 			<legal all>
174*5113495bSYour Name */
175*5113495bSYour Name 
176*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_USER_ORDER_OFFSET        0x0000000000000000
177*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_USER_ORDER_LSB           32
178*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_USER_ORDER_MSB           39
179*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_USER_ORDER_MASK          0x000000ff00000000
180*5113495bSYour Name 
181*5113495bSYour Name 
182*5113495bSYour Name /* Description		CC_MASK
183*5113495bSYour Name 
184*5113495bSYour Name 			RX side: Set to 0
185*5113495bSYour Name 			TX side: Indicates what content channel this User field
186*5113495bSYour Name 			can go to
187*5113495bSYour Name 			Bit 0: content channel 0
188*5113495bSYour Name 			Bit 1: content channel 1
189*5113495bSYour Name 			The other bits are unused, but could repeat the above pattern
190*5113495bSYour Name 			 for compatibility with 'EHT_SIG_USR_MU_MIMO_INFO.'
191*5113495bSYour Name 			<legal all>
192*5113495bSYour Name */
193*5113495bSYour Name 
194*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_CC_MASK_OFFSET           0x0000000000000000
195*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_CC_MASK_LSB              40
196*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_CC_MASK_MSB              47
197*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_CC_MASK_MASK             0x0000ff0000000000
198*5113495bSYour Name 
199*5113495bSYour Name 
200*5113495bSYour Name /* Description		RESERVED_1A
201*5113495bSYour Name 
202*5113495bSYour Name 			<legal 0>
203*5113495bSYour Name */
204*5113495bSYour Name 
205*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_1A_OFFSET       0x0000000000000000
206*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_1A_LSB          48
207*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_1A_MSB          63
208*5113495bSYour Name #define PHYRX_HE_SIG_B2_MU_PHYRX_HE_SIG_B2_MU_INFO_DETAILS_RESERVED_1A_MASK         0xffff000000000000
209*5113495bSYour Name 
210*5113495bSYour Name 
211*5113495bSYour Name 
212*5113495bSYour Name #endif   // PHYRX_HE_SIG_B2_MU
213