xref: /wlan-driver/fw-api/hw/qca6290/11ax/v1/he_sig_b2_ofdma_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2016-2017 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name #ifndef _HE_SIG_B2_OFDMA_INFO_H_
20*5113495bSYour Name #define _HE_SIG_B2_OFDMA_INFO_H_
21*5113495bSYour Name #if !defined(__ASSEMBLER__)
22*5113495bSYour Name #endif
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name // ################ START SUMMARY #################
26*5113495bSYour Name //
27*5113495bSYour Name //	Dword	Fields
28*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]
29*5113495bSYour Name //
30*5113495bSYour Name // ################ END SUMMARY #################
31*5113495bSYour Name 
32*5113495bSYour Name #define NUM_OF_DWORDS_HE_SIG_B2_OFDMA_INFO 1
33*5113495bSYour Name 
34*5113495bSYour Name struct he_sig_b2_ofdma_info {
35*5113495bSYour Name              uint32_t sta_id                          : 11, //[10:0]
36*5113495bSYour Name                       nsts                            :  3, //[13:11]
37*5113495bSYour Name                       txbf                            :  1, //[14]
38*5113495bSYour Name                       sta_mcs                         :  4, //[18:15]
39*5113495bSYour Name                       sta_dcm                         :  1, //[19]
40*5113495bSYour Name                       sta_coding                      :  1, //[20]
41*5113495bSYour Name                       reserved_0                      : 11; //[31:21]
42*5113495bSYour Name };
43*5113495bSYour Name 
44*5113495bSYour Name /*
45*5113495bSYour Name 
46*5113495bSYour Name sta_id
47*5113495bSYour Name 
48*5113495bSYour Name 			Identifies the STA that is addressed. Details of STA ID
49*5113495bSYour Name 			are TBD
50*5113495bSYour Name 
51*5113495bSYour Name nsts
52*5113495bSYour Name 
53*5113495bSYour Name 			MAC RX side usage only:
54*5113495bSYour Name 
55*5113495bSYour Name 
56*5113495bSYour Name 
57*5113495bSYour Name 			Number of spatial streams for this user
58*5113495bSYour Name 
59*5113495bSYour Name 
60*5113495bSYour Name 
61*5113495bSYour Name 			<enum 0 1_spatial_stream>Single spatial stream
62*5113495bSYour Name 
63*5113495bSYour Name 			<enum 1 2_spatial_streams>2 spatial streams
64*5113495bSYour Name 
65*5113495bSYour Name 			<enum 2 3_spatial_streams>3 spatial streams
66*5113495bSYour Name 
67*5113495bSYour Name 			<enum 3 4_spatial_streams>4 spatial streams
68*5113495bSYour Name 
69*5113495bSYour Name 			<enum 4 5_spatial_streams>5 spatial streams
70*5113495bSYour Name 
71*5113495bSYour Name 			<enum 5 6_spatial_streams>6 spatial streams
72*5113495bSYour Name 
73*5113495bSYour Name 			<enum 6 7_spatial_streams>7 spatial streams
74*5113495bSYour Name 
75*5113495bSYour Name 			<enum 7 8_spatial_streams>8 spatial streams
76*5113495bSYour Name 
77*5113495bSYour Name txbf
78*5113495bSYour Name 
79*5113495bSYour Name 			Indicates whether beamforming is applied
80*5113495bSYour Name 
81*5113495bSYour Name 			0: No beamforming
82*5113495bSYour Name 
83*5113495bSYour Name 			1: beamforming
84*5113495bSYour Name 
85*5113495bSYour Name 			<legal all>
86*5113495bSYour Name 
87*5113495bSYour Name sta_mcs
88*5113495bSYour Name 
89*5113495bSYour Name 			Indicates the data MCS
90*5113495bSYour Name 
91*5113495bSYour Name sta_dcm
92*5113495bSYour Name 
93*5113495bSYour Name 
94*5113495bSYour Name 			0: No DCM
95*5113495bSYour Name 
96*5113495bSYour Name 			1:DCM
97*5113495bSYour Name 
98*5113495bSYour Name 			<legal all>
99*5113495bSYour Name 
100*5113495bSYour Name sta_coding
101*5113495bSYour Name 
102*5113495bSYour Name 			Distinguishes between BCC/LDPC
103*5113495bSYour Name 
104*5113495bSYour Name 
105*5113495bSYour Name 
106*5113495bSYour Name 			0: BCC
107*5113495bSYour Name 
108*5113495bSYour Name 			1: LDPC
109*5113495bSYour Name 
110*5113495bSYour Name 			<legal all>
111*5113495bSYour Name 
112*5113495bSYour Name reserved_0
113*5113495bSYour Name 
114*5113495bSYour Name 			<legal 0>
115*5113495bSYour Name */
116*5113495bSYour Name 
117*5113495bSYour Name 
118*5113495bSYour Name /* Description		HE_SIG_B2_OFDMA_INFO_0_STA_ID
119*5113495bSYour Name 
120*5113495bSYour Name 			Identifies the STA that is addressed. Details of STA ID
121*5113495bSYour Name 			are TBD
122*5113495bSYour Name */
123*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_ID_OFFSET                         0x00000000
124*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_ID_LSB                            0
125*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_ID_MASK                           0x000007ff
126*5113495bSYour Name 
127*5113495bSYour Name /* Description		HE_SIG_B2_OFDMA_INFO_0_NSTS
128*5113495bSYour Name 
129*5113495bSYour Name 			MAC RX side usage only:
130*5113495bSYour Name 
131*5113495bSYour Name 
132*5113495bSYour Name 
133*5113495bSYour Name 			Number of spatial streams for this user
134*5113495bSYour Name 
135*5113495bSYour Name 
136*5113495bSYour Name 
137*5113495bSYour Name 			<enum 0 1_spatial_stream>Single spatial stream
138*5113495bSYour Name 
139*5113495bSYour Name 			<enum 1 2_spatial_streams>2 spatial streams
140*5113495bSYour Name 
141*5113495bSYour Name 			<enum 2 3_spatial_streams>3 spatial streams
142*5113495bSYour Name 
143*5113495bSYour Name 			<enum 3 4_spatial_streams>4 spatial streams
144*5113495bSYour Name 
145*5113495bSYour Name 			<enum 4 5_spatial_streams>5 spatial streams
146*5113495bSYour Name 
147*5113495bSYour Name 			<enum 5 6_spatial_streams>6 spatial streams
148*5113495bSYour Name 
149*5113495bSYour Name 			<enum 6 7_spatial_streams>7 spatial streams
150*5113495bSYour Name 
151*5113495bSYour Name 			<enum 7 8_spatial_streams>8 spatial streams
152*5113495bSYour Name */
153*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_NSTS_OFFSET                           0x00000000
154*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_NSTS_LSB                              11
155*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_NSTS_MASK                             0x00003800
156*5113495bSYour Name 
157*5113495bSYour Name /* Description		HE_SIG_B2_OFDMA_INFO_0_TXBF
158*5113495bSYour Name 
159*5113495bSYour Name 			Indicates whether beamforming is applied
160*5113495bSYour Name 
161*5113495bSYour Name 			0: No beamforming
162*5113495bSYour Name 
163*5113495bSYour Name 			1: beamforming
164*5113495bSYour Name 
165*5113495bSYour Name 			<legal all>
166*5113495bSYour Name */
167*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_TXBF_OFFSET                           0x00000000
168*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_TXBF_LSB                              14
169*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_TXBF_MASK                             0x00004000
170*5113495bSYour Name 
171*5113495bSYour Name /* Description		HE_SIG_B2_OFDMA_INFO_0_STA_MCS
172*5113495bSYour Name 
173*5113495bSYour Name 			Indicates the data MCS
174*5113495bSYour Name */
175*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_MCS_OFFSET                        0x00000000
176*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_MCS_LSB                           15
177*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_MCS_MASK                          0x00078000
178*5113495bSYour Name 
179*5113495bSYour Name /* Description		HE_SIG_B2_OFDMA_INFO_0_STA_DCM
180*5113495bSYour Name 
181*5113495bSYour Name 
182*5113495bSYour Name 			0: No DCM
183*5113495bSYour Name 
184*5113495bSYour Name 			1:DCM
185*5113495bSYour Name 
186*5113495bSYour Name 			<legal all>
187*5113495bSYour Name */
188*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_DCM_OFFSET                        0x00000000
189*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_DCM_LSB                           19
190*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_DCM_MASK                          0x00080000
191*5113495bSYour Name 
192*5113495bSYour Name /* Description		HE_SIG_B2_OFDMA_INFO_0_STA_CODING
193*5113495bSYour Name 
194*5113495bSYour Name 			Distinguishes between BCC/LDPC
195*5113495bSYour Name 
196*5113495bSYour Name 
197*5113495bSYour Name 
198*5113495bSYour Name 			0: BCC
199*5113495bSYour Name 
200*5113495bSYour Name 			1: LDPC
201*5113495bSYour Name 
202*5113495bSYour Name 			<legal all>
203*5113495bSYour Name */
204*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_CODING_OFFSET                     0x00000000
205*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_CODING_LSB                        20
206*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_STA_CODING_MASK                       0x00100000
207*5113495bSYour Name 
208*5113495bSYour Name /* Description		HE_SIG_B2_OFDMA_INFO_0_RESERVED_0
209*5113495bSYour Name 
210*5113495bSYour Name 			<legal 0>
211*5113495bSYour Name */
212*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_RESERVED_0_OFFSET                     0x00000000
213*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_RESERVED_0_LSB                        21
214*5113495bSYour Name #define HE_SIG_B2_OFDMA_INFO_0_RESERVED_0_MASK                       0xffe00000
215*5113495bSYour Name 
216*5113495bSYour Name 
217*5113495bSYour Name #endif // _HE_SIG_B2_OFDMA_INFO_H_
218