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