xref: /wlan-driver/fw-api/hw/qca6290/v1/reo_unblock_cache_status.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1 /*
2  * Copyright (c) 2016-2017 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 _REO_UNBLOCK_CACHE_STATUS_H_
25 #define _REO_UNBLOCK_CACHE_STATUS_H_
26 #if !defined(__ASSEMBLER__)
27 #endif
28 
29 #include "uniform_reo_status_header.h"
30 
31 // ################ START SUMMARY #################
32 //
33 //	Dword	Fields
34 //	0-1	struct uniform_reo_status_header status_header;
35 //	2	error_detected[0], unblock_type[1], reserved_2a[31:2]
36 //	3	reserved_3a[31:0]
37 //	4	reserved_4a[31:0]
38 //	5	reserved_5a[31:0]
39 //	6	reserved_6a[31:0]
40 //	7	reserved_7a[31:0]
41 //	8	reserved_8a[31:0]
42 //	9	reserved_9a[31:0]
43 //	10	reserved_10a[31:0]
44 //	11	reserved_11a[31:0]
45 //	12	reserved_12a[31:0]
46 //	13	reserved_13a[31:0]
47 //	14	reserved_14a[31:0]
48 //	15	reserved_15a[31:0]
49 //	16	reserved_16a[31:0]
50 //	17	reserved_17a[31:0]
51 //	18	reserved_18a[31:0]
52 //	19	reserved_19a[31:0]
53 //	20	reserved_20a[31:0]
54 //	21	reserved_21a[31:0]
55 //	22	reserved_22a[31:0]
56 //	23	reserved_23a[31:0]
57 //	24	reserved_24a[27:0], looping_count[31:28]
58 //
59 // ################ END SUMMARY #################
60 
61 #define NUM_OF_DWORDS_REO_UNBLOCK_CACHE_STATUS 25
62 
63 struct reo_unblock_cache_status {
64     struct            uniform_reo_status_header                       status_header;
65              uint32_t error_detected                  :  1, //[0]
66                       unblock_type                    :  1, //[1]
67                       reserved_2a                     : 30; //[31:2]
68              uint32_t reserved_3a                     : 32; //[31:0]
69              uint32_t reserved_4a                     : 32; //[31:0]
70              uint32_t reserved_5a                     : 32; //[31:0]
71              uint32_t reserved_6a                     : 32; //[31:0]
72              uint32_t reserved_7a                     : 32; //[31:0]
73              uint32_t reserved_8a                     : 32; //[31:0]
74              uint32_t reserved_9a                     : 32; //[31:0]
75              uint32_t reserved_10a                    : 32; //[31:0]
76              uint32_t reserved_11a                    : 32; //[31:0]
77              uint32_t reserved_12a                    : 32; //[31:0]
78              uint32_t reserved_13a                    : 32; //[31:0]
79              uint32_t reserved_14a                    : 32; //[31:0]
80              uint32_t reserved_15a                    : 32; //[31:0]
81              uint32_t reserved_16a                    : 32; //[31:0]
82              uint32_t reserved_17a                    : 32; //[31:0]
83              uint32_t reserved_18a                    : 32; //[31:0]
84              uint32_t reserved_19a                    : 32; //[31:0]
85              uint32_t reserved_20a                    : 32; //[31:0]
86              uint32_t reserved_21a                    : 32; //[31:0]
87              uint32_t reserved_22a                    : 32; //[31:0]
88              uint32_t reserved_23a                    : 32; //[31:0]
89              uint32_t reserved_24a                    : 28, //[27:0]
90                       looping_count                   :  4; //[31:28]
91 };
92 
93 /*
94 
95 struct uniform_reo_status_header status_header
96 
97 			Consumer: SW
98 
99 			Producer: REO
100 
101 
102 
103 			Details that can link this status with the original
104 			command. It also contains info on how long REO took to
105 			execute this command.
106 
107 error_detected
108 
109 			Status for blocking resource handling
110 
111 
112 
113 			0: No error has been detected while executing this
114 			command
115 
116 			1: The blocking resource was not in use, and therefor it
117 			could not be 'unblocked'
118 
119 unblock_type
120 
121 			Reference to the type of Unblock command type...
122 
123 
124 
125 			<enum 0 unblock_resource_index> Unblock a blocking
126 			resource
127 
128 
129 
130 			<enum 1 unblock_cache> The entire cache usage is
131 			unblock.
132 
133 
134 
135 			<legal all>
136 
137 reserved_2a
138 
139 			<legal 0>
140 
141 reserved_3a
142 
143 			<legal 0>
144 
145 reserved_4a
146 
147 			<legal 0>
148 
149 reserved_5a
150 
151 			<legal 0>
152 
153 reserved_6a
154 
155 			<legal 0>
156 
157 reserved_7a
158 
159 			<legal 0>
160 
161 reserved_8a
162 
163 			<legal 0>
164 
165 reserved_9a
166 
167 			<legal 0>
168 
169 reserved_10a
170 
171 			<legal 0>
172 
173 reserved_11a
174 
175 			<legal 0>
176 
177 reserved_12a
178 
179 			<legal 0>
180 
181 reserved_13a
182 
183 			<legal 0>
184 
185 reserved_14a
186 
187 			<legal 0>
188 
189 reserved_15a
190 
191 			<legal 0>
192 
193 reserved_16a
194 
195 			<legal 0>
196 
197 reserved_17a
198 
199 			<legal 0>
200 
201 reserved_18a
202 
203 			<legal 0>
204 
205 reserved_19a
206 
207 			<legal 0>
208 
209 reserved_20a
210 
211 			<legal 0>
212 
213 reserved_21a
214 
215 			<legal 0>
216 
217 reserved_22a
218 
219 			<legal 0>
220 
221 reserved_23a
222 
223 			<legal 0>
224 
225 reserved_24a
226 
227 			<legal 0>
228 
229 looping_count
230 
231 			A count value that indicates the number of times the
232 			producer of entries into this Ring has looped around the
233 			ring.
234 
235 			At initialization time, this value is set to 0. On the
236 			first loop, this value is set to 1. After the max value is
237 			reached allowed by the number of bits for this field, the
238 			count value continues with 0 again.
239 
240 
241 
242 			In case SW is the consumer of the ring entries, it can
243 			use this field to figure out up to where the producer of
244 			entries has created new entries. This eliminates the need to
245 			check where the head pointer' of the ring is located once
246 			the SW starts processing an interrupt indicating that new
247 			entries have been put into this ring...
248 
249 
250 
251 			Also note that SW if it wants only needs to look at the
252 			LSB bit of this count value.
253 
254 			<legal all>
255 */
256 
257 #define REO_UNBLOCK_CACHE_STATUS_0_UNIFORM_REO_STATUS_HEADER_STATUS_HEADER_OFFSET 0x00000000
258 #define REO_UNBLOCK_CACHE_STATUS_0_UNIFORM_REO_STATUS_HEADER_STATUS_HEADER_LSB 28
259 #define REO_UNBLOCK_CACHE_STATUS_0_UNIFORM_REO_STATUS_HEADER_STATUS_HEADER_MASK 0xffffffff
260 #define REO_UNBLOCK_CACHE_STATUS_1_UNIFORM_REO_STATUS_HEADER_STATUS_HEADER_OFFSET 0x00000004
261 #define REO_UNBLOCK_CACHE_STATUS_1_UNIFORM_REO_STATUS_HEADER_STATUS_HEADER_LSB 28
262 #define REO_UNBLOCK_CACHE_STATUS_1_UNIFORM_REO_STATUS_HEADER_STATUS_HEADER_MASK 0xffffffff
263 
264 /* Description		REO_UNBLOCK_CACHE_STATUS_2_ERROR_DETECTED
265 
266 			Status for blocking resource handling
267 
268 
269 
270 			0: No error has been detected while executing this
271 			command
272 
273 			1: The blocking resource was not in use, and therefor it
274 			could not be 'unblocked'
275 */
276 #define REO_UNBLOCK_CACHE_STATUS_2_ERROR_DETECTED_OFFSET             0x00000008
277 #define REO_UNBLOCK_CACHE_STATUS_2_ERROR_DETECTED_LSB                0
278 #define REO_UNBLOCK_CACHE_STATUS_2_ERROR_DETECTED_MASK               0x00000001
279 
280 /* Description		REO_UNBLOCK_CACHE_STATUS_2_UNBLOCK_TYPE
281 
282 			Reference to the type of Unblock command type...
283 
284 
285 
286 			<enum 0 unblock_resource_index> Unblock a blocking
287 			resource
288 
289 
290 
291 			<enum 1 unblock_cache> The entire cache usage is
292 			unblock.
293 
294 
295 
296 			<legal all>
297 */
298 #define REO_UNBLOCK_CACHE_STATUS_2_UNBLOCK_TYPE_OFFSET               0x00000008
299 #define REO_UNBLOCK_CACHE_STATUS_2_UNBLOCK_TYPE_LSB                  1
300 #define REO_UNBLOCK_CACHE_STATUS_2_UNBLOCK_TYPE_MASK                 0x00000002
301 
302 /* Description		REO_UNBLOCK_CACHE_STATUS_2_RESERVED_2A
303 
304 			<legal 0>
305 */
306 #define REO_UNBLOCK_CACHE_STATUS_2_RESERVED_2A_OFFSET                0x00000008
307 #define REO_UNBLOCK_CACHE_STATUS_2_RESERVED_2A_LSB                   2
308 #define REO_UNBLOCK_CACHE_STATUS_2_RESERVED_2A_MASK                  0xfffffffc
309 
310 /* Description		REO_UNBLOCK_CACHE_STATUS_3_RESERVED_3A
311 
312 			<legal 0>
313 */
314 #define REO_UNBLOCK_CACHE_STATUS_3_RESERVED_3A_OFFSET                0x0000000c
315 #define REO_UNBLOCK_CACHE_STATUS_3_RESERVED_3A_LSB                   0
316 #define REO_UNBLOCK_CACHE_STATUS_3_RESERVED_3A_MASK                  0xffffffff
317 
318 /* Description		REO_UNBLOCK_CACHE_STATUS_4_RESERVED_4A
319 
320 			<legal 0>
321 */
322 #define REO_UNBLOCK_CACHE_STATUS_4_RESERVED_4A_OFFSET                0x00000010
323 #define REO_UNBLOCK_CACHE_STATUS_4_RESERVED_4A_LSB                   0
324 #define REO_UNBLOCK_CACHE_STATUS_4_RESERVED_4A_MASK                  0xffffffff
325 
326 /* Description		REO_UNBLOCK_CACHE_STATUS_5_RESERVED_5A
327 
328 			<legal 0>
329 */
330 #define REO_UNBLOCK_CACHE_STATUS_5_RESERVED_5A_OFFSET                0x00000014
331 #define REO_UNBLOCK_CACHE_STATUS_5_RESERVED_5A_LSB                   0
332 #define REO_UNBLOCK_CACHE_STATUS_5_RESERVED_5A_MASK                  0xffffffff
333 
334 /* Description		REO_UNBLOCK_CACHE_STATUS_6_RESERVED_6A
335 
336 			<legal 0>
337 */
338 #define REO_UNBLOCK_CACHE_STATUS_6_RESERVED_6A_OFFSET                0x00000018
339 #define REO_UNBLOCK_CACHE_STATUS_6_RESERVED_6A_LSB                   0
340 #define REO_UNBLOCK_CACHE_STATUS_6_RESERVED_6A_MASK                  0xffffffff
341 
342 /* Description		REO_UNBLOCK_CACHE_STATUS_7_RESERVED_7A
343 
344 			<legal 0>
345 */
346 #define REO_UNBLOCK_CACHE_STATUS_7_RESERVED_7A_OFFSET                0x0000001c
347 #define REO_UNBLOCK_CACHE_STATUS_7_RESERVED_7A_LSB                   0
348 #define REO_UNBLOCK_CACHE_STATUS_7_RESERVED_7A_MASK                  0xffffffff
349 
350 /* Description		REO_UNBLOCK_CACHE_STATUS_8_RESERVED_8A
351 
352 			<legal 0>
353 */
354 #define REO_UNBLOCK_CACHE_STATUS_8_RESERVED_8A_OFFSET                0x00000020
355 #define REO_UNBLOCK_CACHE_STATUS_8_RESERVED_8A_LSB                   0
356 #define REO_UNBLOCK_CACHE_STATUS_8_RESERVED_8A_MASK                  0xffffffff
357 
358 /* Description		REO_UNBLOCK_CACHE_STATUS_9_RESERVED_9A
359 
360 			<legal 0>
361 */
362 #define REO_UNBLOCK_CACHE_STATUS_9_RESERVED_9A_OFFSET                0x00000024
363 #define REO_UNBLOCK_CACHE_STATUS_9_RESERVED_9A_LSB                   0
364 #define REO_UNBLOCK_CACHE_STATUS_9_RESERVED_9A_MASK                  0xffffffff
365 
366 /* Description		REO_UNBLOCK_CACHE_STATUS_10_RESERVED_10A
367 
368 			<legal 0>
369 */
370 #define REO_UNBLOCK_CACHE_STATUS_10_RESERVED_10A_OFFSET              0x00000028
371 #define REO_UNBLOCK_CACHE_STATUS_10_RESERVED_10A_LSB                 0
372 #define REO_UNBLOCK_CACHE_STATUS_10_RESERVED_10A_MASK                0xffffffff
373 
374 /* Description		REO_UNBLOCK_CACHE_STATUS_11_RESERVED_11A
375 
376 			<legal 0>
377 */
378 #define REO_UNBLOCK_CACHE_STATUS_11_RESERVED_11A_OFFSET              0x0000002c
379 #define REO_UNBLOCK_CACHE_STATUS_11_RESERVED_11A_LSB                 0
380 #define REO_UNBLOCK_CACHE_STATUS_11_RESERVED_11A_MASK                0xffffffff
381 
382 /* Description		REO_UNBLOCK_CACHE_STATUS_12_RESERVED_12A
383 
384 			<legal 0>
385 */
386 #define REO_UNBLOCK_CACHE_STATUS_12_RESERVED_12A_OFFSET              0x00000030
387 #define REO_UNBLOCK_CACHE_STATUS_12_RESERVED_12A_LSB                 0
388 #define REO_UNBLOCK_CACHE_STATUS_12_RESERVED_12A_MASK                0xffffffff
389 
390 /* Description		REO_UNBLOCK_CACHE_STATUS_13_RESERVED_13A
391 
392 			<legal 0>
393 */
394 #define REO_UNBLOCK_CACHE_STATUS_13_RESERVED_13A_OFFSET              0x00000034
395 #define REO_UNBLOCK_CACHE_STATUS_13_RESERVED_13A_LSB                 0
396 #define REO_UNBLOCK_CACHE_STATUS_13_RESERVED_13A_MASK                0xffffffff
397 
398 /* Description		REO_UNBLOCK_CACHE_STATUS_14_RESERVED_14A
399 
400 			<legal 0>
401 */
402 #define REO_UNBLOCK_CACHE_STATUS_14_RESERVED_14A_OFFSET              0x00000038
403 #define REO_UNBLOCK_CACHE_STATUS_14_RESERVED_14A_LSB                 0
404 #define REO_UNBLOCK_CACHE_STATUS_14_RESERVED_14A_MASK                0xffffffff
405 
406 /* Description		REO_UNBLOCK_CACHE_STATUS_15_RESERVED_15A
407 
408 			<legal 0>
409 */
410 #define REO_UNBLOCK_CACHE_STATUS_15_RESERVED_15A_OFFSET              0x0000003c
411 #define REO_UNBLOCK_CACHE_STATUS_15_RESERVED_15A_LSB                 0
412 #define REO_UNBLOCK_CACHE_STATUS_15_RESERVED_15A_MASK                0xffffffff
413 
414 /* Description		REO_UNBLOCK_CACHE_STATUS_16_RESERVED_16A
415 
416 			<legal 0>
417 */
418 #define REO_UNBLOCK_CACHE_STATUS_16_RESERVED_16A_OFFSET              0x00000040
419 #define REO_UNBLOCK_CACHE_STATUS_16_RESERVED_16A_LSB                 0
420 #define REO_UNBLOCK_CACHE_STATUS_16_RESERVED_16A_MASK                0xffffffff
421 
422 /* Description		REO_UNBLOCK_CACHE_STATUS_17_RESERVED_17A
423 
424 			<legal 0>
425 */
426 #define REO_UNBLOCK_CACHE_STATUS_17_RESERVED_17A_OFFSET              0x00000044
427 #define REO_UNBLOCK_CACHE_STATUS_17_RESERVED_17A_LSB                 0
428 #define REO_UNBLOCK_CACHE_STATUS_17_RESERVED_17A_MASK                0xffffffff
429 
430 /* Description		REO_UNBLOCK_CACHE_STATUS_18_RESERVED_18A
431 
432 			<legal 0>
433 */
434 #define REO_UNBLOCK_CACHE_STATUS_18_RESERVED_18A_OFFSET              0x00000048
435 #define REO_UNBLOCK_CACHE_STATUS_18_RESERVED_18A_LSB                 0
436 #define REO_UNBLOCK_CACHE_STATUS_18_RESERVED_18A_MASK                0xffffffff
437 
438 /* Description		REO_UNBLOCK_CACHE_STATUS_19_RESERVED_19A
439 
440 			<legal 0>
441 */
442 #define REO_UNBLOCK_CACHE_STATUS_19_RESERVED_19A_OFFSET              0x0000004c
443 #define REO_UNBLOCK_CACHE_STATUS_19_RESERVED_19A_LSB                 0
444 #define REO_UNBLOCK_CACHE_STATUS_19_RESERVED_19A_MASK                0xffffffff
445 
446 /* Description		REO_UNBLOCK_CACHE_STATUS_20_RESERVED_20A
447 
448 			<legal 0>
449 */
450 #define REO_UNBLOCK_CACHE_STATUS_20_RESERVED_20A_OFFSET              0x00000050
451 #define REO_UNBLOCK_CACHE_STATUS_20_RESERVED_20A_LSB                 0
452 #define REO_UNBLOCK_CACHE_STATUS_20_RESERVED_20A_MASK                0xffffffff
453 
454 /* Description		REO_UNBLOCK_CACHE_STATUS_21_RESERVED_21A
455 
456 			<legal 0>
457 */
458 #define REO_UNBLOCK_CACHE_STATUS_21_RESERVED_21A_OFFSET              0x00000054
459 #define REO_UNBLOCK_CACHE_STATUS_21_RESERVED_21A_LSB                 0
460 #define REO_UNBLOCK_CACHE_STATUS_21_RESERVED_21A_MASK                0xffffffff
461 
462 /* Description		REO_UNBLOCK_CACHE_STATUS_22_RESERVED_22A
463 
464 			<legal 0>
465 */
466 #define REO_UNBLOCK_CACHE_STATUS_22_RESERVED_22A_OFFSET              0x00000058
467 #define REO_UNBLOCK_CACHE_STATUS_22_RESERVED_22A_LSB                 0
468 #define REO_UNBLOCK_CACHE_STATUS_22_RESERVED_22A_MASK                0xffffffff
469 
470 /* Description		REO_UNBLOCK_CACHE_STATUS_23_RESERVED_23A
471 
472 			<legal 0>
473 */
474 #define REO_UNBLOCK_CACHE_STATUS_23_RESERVED_23A_OFFSET              0x0000005c
475 #define REO_UNBLOCK_CACHE_STATUS_23_RESERVED_23A_LSB                 0
476 #define REO_UNBLOCK_CACHE_STATUS_23_RESERVED_23A_MASK                0xffffffff
477 
478 /* Description		REO_UNBLOCK_CACHE_STATUS_24_RESERVED_24A
479 
480 			<legal 0>
481 */
482 #define REO_UNBLOCK_CACHE_STATUS_24_RESERVED_24A_OFFSET              0x00000060
483 #define REO_UNBLOCK_CACHE_STATUS_24_RESERVED_24A_LSB                 0
484 #define REO_UNBLOCK_CACHE_STATUS_24_RESERVED_24A_MASK                0x0fffffff
485 
486 /* Description		REO_UNBLOCK_CACHE_STATUS_24_LOOPING_COUNT
487 
488 			A count value that indicates the number of times the
489 			producer of entries into this Ring has looped around the
490 			ring.
491 
492 			At initialization time, this value is set to 0. On the
493 			first loop, this value is set to 1. After the max value is
494 			reached allowed by the number of bits for this field, the
495 			count value continues with 0 again.
496 
497 
498 
499 			In case SW is the consumer of the ring entries, it can
500 			use this field to figure out up to where the producer of
501 			entries has created new entries. This eliminates the need to
502 			check where the head pointer' of the ring is located once
503 			the SW starts processing an interrupt indicating that new
504 			entries have been put into this ring...
505 
506 
507 
508 			Also note that SW if it wants only needs to look at the
509 			LSB bit of this count value.
510 
511 			<legal all>
512 */
513 #define REO_UNBLOCK_CACHE_STATUS_24_LOOPING_COUNT_OFFSET             0x00000060
514 #define REO_UNBLOCK_CACHE_STATUS_24_LOOPING_COUNT_LSB                28
515 #define REO_UNBLOCK_CACHE_STATUS_24_LOOPING_COUNT_MASK               0xf0000000
516 
517 
518 #endif // _REO_UNBLOCK_CACHE_STATUS_H_
519