xref: /wlan-driver/fw-api/hw/qcn9000/he_sig_b2_mu_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2019, The Linux Foundation. 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 
23*5113495bSYour Name // ################ START SUMMARY #################
24*5113495bSYour Name //
25*5113495bSYour Name //	Dword	Fields
26*5113495bSYour Name //	0	sta_id[10:0], sta_spatial_config[14:11], sta_mcs[18:15], reserved_set_to_1[19], sta_coding[20], reserved_0a[28:21], nsts[31:29]
27*5113495bSYour Name //
28*5113495bSYour Name // ################ END SUMMARY #################
29*5113495bSYour Name 
30*5113495bSYour Name #define NUM_OF_DWORDS_HE_SIG_B2_MU_INFO 1
31*5113495bSYour Name 
32*5113495bSYour Name struct he_sig_b2_mu_info {
33*5113495bSYour Name              uint32_t sta_id                          : 11, //[10:0]
34*5113495bSYour Name                       sta_spatial_config              :  4, //[14:11]
35*5113495bSYour Name                       sta_mcs                         :  4, //[18:15]
36*5113495bSYour Name                       reserved_set_to_1               :  1, //[19]
37*5113495bSYour Name                       sta_coding                      :  1, //[20]
38*5113495bSYour Name                       reserved_0a                     :  8, //[28:21]
39*5113495bSYour Name                       nsts                            :  3; //[31:29]
40*5113495bSYour Name };
41*5113495bSYour Name 
42*5113495bSYour Name /*
43*5113495bSYour Name 
44*5113495bSYour Name sta_id
45*5113495bSYour Name 
46*5113495bSYour Name 			Identifies the STA that is addressed. Details of STA ID
47*5113495bSYour Name 			are TBD
48*5113495bSYour Name 
49*5113495bSYour Name sta_spatial_config
50*5113495bSYour Name 
51*5113495bSYour Name 			Number of assigned spatial streams and their
52*5113495bSYour Name 			corresponding index.
53*5113495bSYour Name 
54*5113495bSYour Name 			Total number of spatial streams assigned for the MU-MIMO
55*5113495bSYour Name 			allocation is also signaled.
56*5113495bSYour Name 
57*5113495bSYour Name sta_mcs
58*5113495bSYour Name 
59*5113495bSYour Name 			Indicates the data MCS
60*5113495bSYour Name 
61*5113495bSYour Name reserved_set_to_1
62*5113495bSYour Name 
63*5113495bSYour Name 			<legal 1>
64*5113495bSYour Name 
65*5113495bSYour Name sta_coding
66*5113495bSYour Name 
67*5113495bSYour Name 			Distinguishes between BCC/LDPC
68*5113495bSYour Name 
69*5113495bSYour Name 
70*5113495bSYour Name 
71*5113495bSYour Name 			0: BCC
72*5113495bSYour Name 
73*5113495bSYour Name 			1: LDPC
74*5113495bSYour Name 
75*5113495bSYour Name 			<legal all>
76*5113495bSYour Name 
77*5113495bSYour Name reserved_0a
78*5113495bSYour Name 
79*5113495bSYour Name 			<legal 0>
80*5113495bSYour Name 
81*5113495bSYour Name nsts
82*5113495bSYour Name 
83*5113495bSYour Name 			MAC RX side usage only:
84*5113495bSYour Name 
85*5113495bSYour Name 			Needed by RXPCU. Provided by PHY so that RXPCU does not
86*5113495bSYour Name 			need to have the RU number decoding logic.
87*5113495bSYour Name 
88*5113495bSYour Name 
89*5113495bSYour Name 
90*5113495bSYour Name 			Number of spatial streams for this user
91*5113495bSYour Name 
92*5113495bSYour Name 
93*5113495bSYour Name 
94*5113495bSYour Name 			<enum 0 1_spatial_stream>Single spatial stream
95*5113495bSYour Name 
96*5113495bSYour Name 			<enum 1 2_spatial_streams>2 spatial streams
97*5113495bSYour Name 
98*5113495bSYour Name 			<enum 2 3_spatial_streams>3 spatial streams
99*5113495bSYour Name 
100*5113495bSYour Name 			<enum 3 4_spatial_streams>4 spatial streams
101*5113495bSYour Name 
102*5113495bSYour Name 			<enum 4 5_spatial_streams>5 spatial streams
103*5113495bSYour Name 
104*5113495bSYour Name 			<enum 5 6_spatial_streams>6 spatial streams
105*5113495bSYour Name 
106*5113495bSYour Name 			<enum 6 7_spatial_streams>7 spatial streams
107*5113495bSYour Name 
108*5113495bSYour Name 			<enum 7 8_spatial_streams>8 spatial streams
109*5113495bSYour Name */
110*5113495bSYour Name 
111*5113495bSYour Name 
112*5113495bSYour Name /* Description		HE_SIG_B2_MU_INFO_0_STA_ID
113*5113495bSYour Name 
114*5113495bSYour Name 			Identifies the STA that is addressed. Details of STA ID
115*5113495bSYour Name 			are TBD
116*5113495bSYour Name */
117*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_STA_ID_OFFSET                            0x00000000
118*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_STA_ID_LSB                               0
119*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_STA_ID_MASK                              0x000007ff
120*5113495bSYour Name 
121*5113495bSYour Name /* Description		HE_SIG_B2_MU_INFO_0_STA_SPATIAL_CONFIG
122*5113495bSYour Name 
123*5113495bSYour Name 			Number of assigned spatial streams and their
124*5113495bSYour Name 			corresponding index.
125*5113495bSYour Name 
126*5113495bSYour Name 			Total number of spatial streams assigned for the MU-MIMO
127*5113495bSYour Name 			allocation is also signaled.
128*5113495bSYour Name */
129*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_STA_SPATIAL_CONFIG_OFFSET                0x00000000
130*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_STA_SPATIAL_CONFIG_LSB                   11
131*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_STA_SPATIAL_CONFIG_MASK                  0x00007800
132*5113495bSYour Name 
133*5113495bSYour Name /* Description		HE_SIG_B2_MU_INFO_0_STA_MCS
134*5113495bSYour Name 
135*5113495bSYour Name 			Indicates the data MCS
136*5113495bSYour Name */
137*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_STA_MCS_OFFSET                           0x00000000
138*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_STA_MCS_LSB                              15
139*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_STA_MCS_MASK                             0x00078000
140*5113495bSYour Name 
141*5113495bSYour Name /* Description		HE_SIG_B2_MU_INFO_0_RESERVED_SET_TO_1
142*5113495bSYour Name 
143*5113495bSYour Name 			<legal 1>
144*5113495bSYour Name */
145*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_RESERVED_SET_TO_1_OFFSET                 0x00000000
146*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_RESERVED_SET_TO_1_LSB                    19
147*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_RESERVED_SET_TO_1_MASK                   0x00080000
148*5113495bSYour Name 
149*5113495bSYour Name /* Description		HE_SIG_B2_MU_INFO_0_STA_CODING
150*5113495bSYour Name 
151*5113495bSYour Name 			Distinguishes between BCC/LDPC
152*5113495bSYour Name 
153*5113495bSYour Name 
154*5113495bSYour Name 
155*5113495bSYour Name 			0: BCC
156*5113495bSYour Name 
157*5113495bSYour Name 			1: LDPC
158*5113495bSYour Name 
159*5113495bSYour Name 			<legal all>
160*5113495bSYour Name */
161*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_STA_CODING_OFFSET                        0x00000000
162*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_STA_CODING_LSB                           20
163*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_STA_CODING_MASK                          0x00100000
164*5113495bSYour Name 
165*5113495bSYour Name /* Description		HE_SIG_B2_MU_INFO_0_RESERVED_0A
166*5113495bSYour Name 
167*5113495bSYour Name 			<legal 0>
168*5113495bSYour Name */
169*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_RESERVED_0A_OFFSET                       0x00000000
170*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_RESERVED_0A_LSB                          21
171*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_RESERVED_0A_MASK                         0x1fe00000
172*5113495bSYour Name 
173*5113495bSYour Name /* Description		HE_SIG_B2_MU_INFO_0_NSTS
174*5113495bSYour Name 
175*5113495bSYour Name 			MAC RX side usage only:
176*5113495bSYour Name 
177*5113495bSYour Name 			Needed by RXPCU. Provided by PHY so that RXPCU does not
178*5113495bSYour Name 			need to have the RU number decoding logic.
179*5113495bSYour Name 
180*5113495bSYour Name 
181*5113495bSYour Name 
182*5113495bSYour Name 			Number of spatial streams for this user
183*5113495bSYour Name 
184*5113495bSYour Name 
185*5113495bSYour Name 
186*5113495bSYour Name 			<enum 0 1_spatial_stream>Single spatial stream
187*5113495bSYour Name 
188*5113495bSYour Name 			<enum 1 2_spatial_streams>2 spatial streams
189*5113495bSYour Name 
190*5113495bSYour Name 			<enum 2 3_spatial_streams>3 spatial streams
191*5113495bSYour Name 
192*5113495bSYour Name 			<enum 3 4_spatial_streams>4 spatial streams
193*5113495bSYour Name 
194*5113495bSYour Name 			<enum 4 5_spatial_streams>5 spatial streams
195*5113495bSYour Name 
196*5113495bSYour Name 			<enum 5 6_spatial_streams>6 spatial streams
197*5113495bSYour Name 
198*5113495bSYour Name 			<enum 6 7_spatial_streams>7 spatial streams
199*5113495bSYour Name 
200*5113495bSYour Name 			<enum 7 8_spatial_streams>8 spatial streams
201*5113495bSYour Name */
202*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_NSTS_OFFSET                              0x00000000
203*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_NSTS_LSB                                 29
204*5113495bSYour Name #define HE_SIG_B2_MU_INFO_0_NSTS_MASK                                0xe0000000
205*5113495bSYour Name 
206*5113495bSYour Name 
207*5113495bSYour Name #endif // _HE_SIG_B2_MU_INFO_H_
208