xref: /wlan-driver/fw-api/hw/qcn6432/vht_sig_b_su80_info.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 /*
2  * Copyright (c) 2023 Qualcomm Innovation Center, Inc. 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 #ifndef _VHT_SIG_B_SU80_INFO_H_
18 #define _VHT_SIG_B_SU80_INFO_H_
19 #if !defined(__ASSEMBLER__)
20 #endif
21 
22 #define NUM_OF_DWORDS_VHT_SIG_B_SU80_INFO 4
23 
24 
25 struct vht_sig_b_su80_info {
26 #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
27              uint32_t length                                                  : 21, // [20:0]
28                       vhtb_reserved                                           :  2, // [22:21]
29                       tail                                                    :  6, // [28:23]
30                       reserved_0                                              :  2, // [30:29]
31                       rx_ndp                                                  :  1; // [31:31]
32              uint32_t length_copy_a                                           : 21, // [20:0]
33                       vhtb_reserved_copy_a                                    :  2, // [22:21]
34                       tail_copy_a                                             :  6, // [28:23]
35                       reserved_1                                              :  2, // [30:29]
36                       rx_ndp_copy_a                                           :  1; // [31:31]
37              uint32_t length_copy_b                                           : 21, // [20:0]
38                       vhtb_reserved_copy_b                                    :  2, // [22:21]
39                       tail_copy_b                                             :  6, // [28:23]
40                       reserved_2                                              :  2, // [30:29]
41                       rx_ndp_copy_b                                           :  1; // [31:31]
42              uint32_t length_copy_c                                           : 21, // [20:0]
43                       vhtb_reserved_copy_c                                    :  2, // [22:21]
44                       tail_copy_c                                             :  6, // [28:23]
45                       reserved_3                                              :  2, // [30:29]
46                       rx_ndp_copy_c                                           :  1; // [31:31]
47 #else
48              uint32_t rx_ndp                                                  :  1, // [31:31]
49                       reserved_0                                              :  2, // [30:29]
50                       tail                                                    :  6, // [28:23]
51                       vhtb_reserved                                           :  2, // [22:21]
52                       length                                                  : 21; // [20:0]
53              uint32_t rx_ndp_copy_a                                           :  1, // [31:31]
54                       reserved_1                                              :  2, // [30:29]
55                       tail_copy_a                                             :  6, // [28:23]
56                       vhtb_reserved_copy_a                                    :  2, // [22:21]
57                       length_copy_a                                           : 21; // [20:0]
58              uint32_t rx_ndp_copy_b                                           :  1, // [31:31]
59                       reserved_2                                              :  2, // [30:29]
60                       tail_copy_b                                             :  6, // [28:23]
61                       vhtb_reserved_copy_b                                    :  2, // [22:21]
62                       length_copy_b                                           : 21; // [20:0]
63              uint32_t rx_ndp_copy_c                                           :  1, // [31:31]
64                       reserved_3                                              :  2, // [30:29]
65                       tail_copy_c                                             :  6, // [28:23]
66                       vhtb_reserved_copy_c                                    :  2, // [22:21]
67                       length_copy_c                                           : 21; // [20:0]
68 #endif
69 };
70 
71 
72 /* Description		LENGTH
73 
74 			VHT-SIG-B Length (in units of 4 octets) = ceiling (LENGTH/4)
75 
76 			<legal all>
77 */
78 
79 #define VHT_SIG_B_SU80_INFO_LENGTH_OFFSET                                           0x00000000
80 #define VHT_SIG_B_SU80_INFO_LENGTH_LSB                                              0
81 #define VHT_SIG_B_SU80_INFO_LENGTH_MSB                                              20
82 #define VHT_SIG_B_SU80_INFO_LENGTH_MASK                                             0x001fffff
83 
84 
85 /* Description		VHTB_RESERVED
86 
87 			Reserved:  Set  to all ones for non-NDP frames and ignored
88 			 on receive  <legal 1,3>
89 */
90 
91 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_OFFSET                                    0x00000000
92 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_LSB                                       21
93 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_MSB                                       22
94 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_MASK                                      0x00600000
95 
96 
97 /* Description		TAIL
98 
99 			Used to terminate the trellis of the convolutional decoder.
100 
101 			Set to 0.  <legal 0>
102 */
103 
104 #define VHT_SIG_B_SU80_INFO_TAIL_OFFSET                                             0x00000000
105 #define VHT_SIG_B_SU80_INFO_TAIL_LSB                                                23
106 #define VHT_SIG_B_SU80_INFO_TAIL_MSB                                                28
107 #define VHT_SIG_B_SU80_INFO_TAIL_MASK                                               0x1f800000
108 
109 
110 /* Description		RESERVED_0
111 
112 			Not part of VHT-SIG-B.
113 			Reserved: Set to 0 and ignored on receive  <legal 0>
114 */
115 
116 #define VHT_SIG_B_SU80_INFO_RESERVED_0_OFFSET                                       0x00000000
117 #define VHT_SIG_B_SU80_INFO_RESERVED_0_LSB                                          29
118 #define VHT_SIG_B_SU80_INFO_RESERVED_0_MSB                                          30
119 #define VHT_SIG_B_SU80_INFO_RESERVED_0_MASK                                         0x60000000
120 
121 
122 /* Description		RX_NDP
123 
124 			Not part of VHT-SIG-B.
125 			Used to identify received NDP frame
126 			<legal 0,1>
127 */
128 
129 #define VHT_SIG_B_SU80_INFO_RX_NDP_OFFSET                                           0x00000000
130 #define VHT_SIG_B_SU80_INFO_RX_NDP_LSB                                              31
131 #define VHT_SIG_B_SU80_INFO_RX_NDP_MSB                                              31
132 #define VHT_SIG_B_SU80_INFO_RX_NDP_MASK                                             0x80000000
133 
134 
135 /* Description		LENGTH_COPY_A
136 
137 			Same as "length" <legal all>
138 */
139 
140 #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_A_OFFSET                                    0x00000004
141 #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_A_LSB                                       0
142 #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_A_MSB                                       20
143 #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_A_MASK                                      0x001fffff
144 
145 
146 /* Description		VHTB_RESERVED_COPY_A
147 
148 			Same as "vhtb_reserved"  <legal 1,3>
149 */
150 
151 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_A_OFFSET                             0x00000004
152 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_A_LSB                                21
153 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_A_MSB                                22
154 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_A_MASK                               0x00600000
155 
156 
157 /* Description		TAIL_COPY_A
158 
159 			Same as "tail"  <legal 0>
160 */
161 
162 #define VHT_SIG_B_SU80_INFO_TAIL_COPY_A_OFFSET                                      0x00000004
163 #define VHT_SIG_B_SU80_INFO_TAIL_COPY_A_LSB                                         23
164 #define VHT_SIG_B_SU80_INFO_TAIL_COPY_A_MSB                                         28
165 #define VHT_SIG_B_SU80_INFO_TAIL_COPY_A_MASK                                        0x1f800000
166 
167 
168 /* Description		RESERVED_1
169 
170 			Reserved: Set to 0 and ignored on receive  <legal 0>
171 */
172 
173 #define VHT_SIG_B_SU80_INFO_RESERVED_1_OFFSET                                       0x00000004
174 #define VHT_SIG_B_SU80_INFO_RESERVED_1_LSB                                          29
175 #define VHT_SIG_B_SU80_INFO_RESERVED_1_MSB                                          30
176 #define VHT_SIG_B_SU80_INFO_RESERVED_1_MASK                                         0x60000000
177 
178 
179 /* Description		RX_NDP_COPY_A
180 
181 			Not part of VHT-SIG-B.
182 			Used to identify received NDP frame
183 			<legal 0,1>
184 */
185 
186 #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_A_OFFSET                                    0x00000004
187 #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_A_LSB                                       31
188 #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_A_MSB                                       31
189 #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_A_MASK                                      0x80000000
190 
191 
192 /* Description		LENGTH_COPY_B
193 
194 			Same as "length" <legal all>
195 */
196 
197 #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_B_OFFSET                                    0x00000008
198 #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_B_LSB                                       0
199 #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_B_MSB                                       20
200 #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_B_MASK                                      0x001fffff
201 
202 
203 /* Description		VHTB_RESERVED_COPY_B
204 
205 			Same as "vhtb_reserved"  <legal 1,3>
206 */
207 
208 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_B_OFFSET                             0x00000008
209 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_B_LSB                                21
210 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_B_MSB                                22
211 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_B_MASK                               0x00600000
212 
213 
214 /* Description		TAIL_COPY_B
215 
216 			Same as "tail"  <legal 0>
217 */
218 
219 #define VHT_SIG_B_SU80_INFO_TAIL_COPY_B_OFFSET                                      0x00000008
220 #define VHT_SIG_B_SU80_INFO_TAIL_COPY_B_LSB                                         23
221 #define VHT_SIG_B_SU80_INFO_TAIL_COPY_B_MSB                                         28
222 #define VHT_SIG_B_SU80_INFO_TAIL_COPY_B_MASK                                        0x1f800000
223 
224 
225 /* Description		RESERVED_2
226 
227 			Reserved: Set to 0 and ignored on receive <legal 0>
228 */
229 
230 #define VHT_SIG_B_SU80_INFO_RESERVED_2_OFFSET                                       0x00000008
231 #define VHT_SIG_B_SU80_INFO_RESERVED_2_LSB                                          29
232 #define VHT_SIG_B_SU80_INFO_RESERVED_2_MSB                                          30
233 #define VHT_SIG_B_SU80_INFO_RESERVED_2_MASK                                         0x60000000
234 
235 
236 /* Description		RX_NDP_COPY_B
237 
238 			Not part of VHT-SIG-B.
239 			Used to identify received NDP frame
240 			<legal 0,1>
241 */
242 
243 #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_B_OFFSET                                    0x00000008
244 #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_B_LSB                                       31
245 #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_B_MSB                                       31
246 #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_B_MASK                                      0x80000000
247 
248 
249 /* Description		LENGTH_COPY_C
250 
251 			Same as "length" <legal all>
252 */
253 
254 #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_C_OFFSET                                    0x0000000c
255 #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_C_LSB                                       0
256 #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_C_MSB                                       20
257 #define VHT_SIG_B_SU80_INFO_LENGTH_COPY_C_MASK                                      0x001fffff
258 
259 
260 /* Description		VHTB_RESERVED_COPY_C
261 
262 			Same as "vhtb_reserved"  <legal 1,3>
263 */
264 
265 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_C_OFFSET                             0x0000000c
266 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_C_LSB                                21
267 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_C_MSB                                22
268 #define VHT_SIG_B_SU80_INFO_VHTB_RESERVED_COPY_C_MASK                               0x00600000
269 
270 
271 /* Description		TAIL_COPY_C
272 
273 			Same as "tail"  <legal 0>
274 */
275 
276 #define VHT_SIG_B_SU80_INFO_TAIL_COPY_C_OFFSET                                      0x0000000c
277 #define VHT_SIG_B_SU80_INFO_TAIL_COPY_C_LSB                                         23
278 #define VHT_SIG_B_SU80_INFO_TAIL_COPY_C_MSB                                         28
279 #define VHT_SIG_B_SU80_INFO_TAIL_COPY_C_MASK                                        0x1f800000
280 
281 
282 /* Description		RESERVED_3
283 
284 			Reserved: Set to 0 and ignored on receive <legal 0>
285 */
286 
287 #define VHT_SIG_B_SU80_INFO_RESERVED_3_OFFSET                                       0x0000000c
288 #define VHT_SIG_B_SU80_INFO_RESERVED_3_LSB                                          29
289 #define VHT_SIG_B_SU80_INFO_RESERVED_3_MSB                                          30
290 #define VHT_SIG_B_SU80_INFO_RESERVED_3_MASK                                         0x60000000
291 
292 
293 /* Description		RX_NDP_COPY_C
294 
295 			Not part of VHT-SIG-B.
296 			Used to identify received NDP frame
297 			<legal 0,1>
298 */
299 
300 #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_C_OFFSET                                    0x0000000c
301 #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_C_LSB                                       31
302 #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_C_MSB                                       31
303 #define VHT_SIG_B_SU80_INFO_RX_NDP_COPY_C_MASK                                      0x80000000
304 
305 
306 
307 #endif   // VHT_SIG_B_SU80_INFO
308