xref: /wlan-driver/fw-api/hw/qca5018/he_sig_b2_ofdma_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2020, 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_OFDMA_INFO_H_
18*5113495bSYour Name #define _HE_SIG_B2_OFDMA_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], nsts[13:11], txbf[14], sta_mcs[18:15], sta_dcm[19], sta_coding[20], reserved_0[31:21]
27*5113495bSYour Name //
28*5113495bSYour Name // ################ END SUMMARY #################
29*5113495bSYour Name 
30*5113495bSYour Name #define NUM_OF_DWORDS_HE_SIG_B2_OFDMA_INFO 1
31*5113495bSYour Name 
32*5113495bSYour Name struct he_sig_b2_ofdma_info {
33*5113495bSYour Name              uint32_t sta_id                          : 11, //[10:0]
34*5113495bSYour Name                       nsts                            :  3, //[13:11]
35*5113495bSYour Name                       txbf                            :  1, //[14]
36*5113495bSYour Name                       sta_mcs                         :  4, //[18:15]
37*5113495bSYour Name                       sta_dcm                         :  1, //[19]
38*5113495bSYour Name                       sta_coding                      :  1, //[20]
39*5113495bSYour Name                       reserved_0                      : 11; //[31:21]
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 nsts
50*5113495bSYour Name 
51*5113495bSYour Name 			MAC RX side usage only:
52*5113495bSYour Name 
53*5113495bSYour Name 
54*5113495bSYour Name 
55*5113495bSYour Name 			Number of spatial streams for this user
56*5113495bSYour Name 
57*5113495bSYour Name 
58*5113495bSYour Name 
59*5113495bSYour Name 			<enum 0 1_spatial_stream>Single spatial stream
60*5113495bSYour Name 
61*5113495bSYour Name 			<enum 1 2_spatial_streams>2 spatial streams
62*5113495bSYour Name 
63*5113495bSYour Name 			<enum 2 3_spatial_streams>3 spatial streams
64*5113495bSYour Name 
65*5113495bSYour Name 			<enum 3 4_spatial_streams>4 spatial streams
66*5113495bSYour Name 
67*5113495bSYour Name 			<enum 4 5_spatial_streams>5 spatial streams
68*5113495bSYour Name 
69*5113495bSYour Name 			<enum 5 6_spatial_streams>6 spatial streams
70*5113495bSYour Name 
71*5113495bSYour Name 			<enum 6 7_spatial_streams>7 spatial streams
72*5113495bSYour Name 
73*5113495bSYour Name 			<enum 7 8_spatial_streams>8 spatial streams
74*5113495bSYour Name 
75*5113495bSYour Name txbf
76*5113495bSYour Name 
77*5113495bSYour Name 			Indicates whether beamforming is applied
78*5113495bSYour Name 
79*5113495bSYour Name 			0: No beamforming
80*5113495bSYour Name 
81*5113495bSYour Name 			1: beamforming
82*5113495bSYour Name 
83*5113495bSYour Name 			<legal all>
84*5113495bSYour Name 
85*5113495bSYour Name sta_mcs
86*5113495bSYour Name 
87*5113495bSYour Name 			Indicates the data MCS
88*5113495bSYour Name 
89*5113495bSYour Name sta_dcm
90*5113495bSYour Name 
91*5113495bSYour Name 
92*5113495bSYour Name 			0: No DCM
93*5113495bSYour Name 
94*5113495bSYour Name 			1:DCM
95*5113495bSYour Name 
96*5113495bSYour Name 			<legal all>
97*5113495bSYour Name 
98*5113495bSYour Name sta_coding
99*5113495bSYour Name 
100*5113495bSYour Name 			Distinguishes between BCC/LDPC
101*5113495bSYour Name 
102*5113495bSYour Name 
103*5113495bSYour Name 
104*5113495bSYour Name 			0: BCC
105*5113495bSYour Name 
106*5113495bSYour Name 			1: LDPC
107*5113495bSYour Name 
108*5113495bSYour Name 			<legal all>
109*5113495bSYour Name 
110*5113495bSYour Name reserved_0
111*5113495bSYour Name 
112*5113495bSYour Name 			<legal 0>
113*5113495bSYour Name */
114*5113495bSYour Name 
115*5113495bSYour Name 
116*5113495bSYour Name /* Description		HE_SIG_B2_OFDMA_INFO_0_STA_ID
117*5113495bSYour Name 
118*5113495bSYour Name 			Identifies the STA that is addressed. Details of STA ID
119*5113495bSYour Name 			are TBD
120*5113495bSYour Name */
121*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_ID_OFFSET                         0x00000000
122*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_ID_LSB                            0
123*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_ID_MASK                           0x000007ff
124*5113495bSYour Name 
125*5113495bSYour Name /* Description		HE_SIG_B2_OFDMA_INFO_0_NSTS
126*5113495bSYour Name 
127*5113495bSYour Name 			MAC RX side usage only:
128*5113495bSYour Name 
129*5113495bSYour Name 
130*5113495bSYour Name 
131*5113495bSYour Name 			Number of spatial streams for this user
132*5113495bSYour Name 
133*5113495bSYour Name 
134*5113495bSYour Name 
135*5113495bSYour Name 			<enum 0 1_spatial_stream>Single spatial stream
136*5113495bSYour Name 
137*5113495bSYour Name 			<enum 1 2_spatial_streams>2 spatial streams
138*5113495bSYour Name 
139*5113495bSYour Name 			<enum 2 3_spatial_streams>3 spatial streams
140*5113495bSYour Name 
141*5113495bSYour Name 			<enum 3 4_spatial_streams>4 spatial streams
142*5113495bSYour Name 
143*5113495bSYour Name 			<enum 4 5_spatial_streams>5 spatial streams
144*5113495bSYour Name 
145*5113495bSYour Name 			<enum 5 6_spatial_streams>6 spatial streams
146*5113495bSYour Name 
147*5113495bSYour Name 			<enum 6 7_spatial_streams>7 spatial streams
148*5113495bSYour Name 
149*5113495bSYour Name 			<enum 7 8_spatial_streams>8 spatial streams
150*5113495bSYour Name */
151*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_NSTS_OFFSET                           0x00000000
152*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_NSTS_LSB                              11
153*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_NSTS_MASK                             0x00003800
154*5113495bSYour Name 
155*5113495bSYour Name /* Description		HE_SIG_B2_OFDMA_INFO_0_TXBF
156*5113495bSYour Name 
157*5113495bSYour Name 			Indicates whether beamforming is applied
158*5113495bSYour Name 
159*5113495bSYour Name 			0: No beamforming
160*5113495bSYour Name 
161*5113495bSYour Name 			1: beamforming
162*5113495bSYour Name 
163*5113495bSYour Name 			<legal all>
164*5113495bSYour Name */
165*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_TXBF_OFFSET                           0x00000000
166*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_TXBF_LSB                              14
167*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_TXBF_MASK                             0x00004000
168*5113495bSYour Name 
169*5113495bSYour Name /* Description		HE_SIG_B2_OFDMA_INFO_0_STA_MCS
170*5113495bSYour Name 
171*5113495bSYour Name 			Indicates the data MCS
172*5113495bSYour Name */
173*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_MCS_OFFSET                        0x00000000
174*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_MCS_LSB                           15
175*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_MCS_MASK                          0x00078000
176*5113495bSYour Name 
177*5113495bSYour Name /* Description		HE_SIG_B2_OFDMA_INFO_0_STA_DCM
178*5113495bSYour Name 
179*5113495bSYour Name 
180*5113495bSYour Name 			0: No DCM
181*5113495bSYour Name 
182*5113495bSYour Name 			1:DCM
183*5113495bSYour Name 
184*5113495bSYour Name 			<legal all>
185*5113495bSYour Name */
186*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_DCM_OFFSET                        0x00000000
187*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_DCM_LSB                           19
188*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_DCM_MASK                          0x00080000
189*5113495bSYour Name 
190*5113495bSYour Name /* Description		HE_SIG_B2_OFDMA_INFO_0_STA_CODING
191*5113495bSYour Name 
192*5113495bSYour Name 			Distinguishes between BCC/LDPC
193*5113495bSYour Name 
194*5113495bSYour Name 
195*5113495bSYour Name 
196*5113495bSYour Name 			0: BCC
197*5113495bSYour Name 
198*5113495bSYour Name 			1: LDPC
199*5113495bSYour Name 
200*5113495bSYour Name 			<legal all>
201*5113495bSYour Name */
202*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_CODING_OFFSET                     0x00000000
203*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_CODING_LSB                        20
204*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_CODING_MASK                       0x00100000
205*5113495bSYour Name 
206*5113495bSYour Name /* Description		HE_SIG_B2_OFDMA_INFO_0_RESERVED_0
207*5113495bSYour Name 
208*5113495bSYour Name 			<legal 0>
209*5113495bSYour Name */
210*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_RESERVED_0_OFFSET                     0x00000000
211*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_RESERVED_0_LSB                        21
212*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_RESERVED_0_MASK                       0xffe00000
213*5113495bSYour Name 
214*5113495bSYour Name 
215*5113495bSYour Name #endif // _HE_SIG_B2_OFDMA_INFO_H_
216