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