xref: /wlan-driver/fw-api/hw/qca6490/v1/reo_flush_queue.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2019 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 //
20*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
21*5113495bSYour Name //               These definitions are tied to a particular hardware layout
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name #ifndef _REO_FLUSH_QUEUE_H_
25*5113495bSYour Name #define _REO_FLUSH_QUEUE_H_
26*5113495bSYour Name #if !defined(__ASSEMBLER__)
27*5113495bSYour Name #endif
28*5113495bSYour Name 
29*5113495bSYour Name #include "uniform_reo_cmd_header.h"
30*5113495bSYour Name 
31*5113495bSYour Name // ################ START SUMMARY #################
32*5113495bSYour Name //
33*5113495bSYour Name //	Dword	Fields
34*5113495bSYour Name //	0	struct uniform_reo_cmd_header cmd_header;
35*5113495bSYour Name //	1	flush_desc_addr_31_0[31:0]
36*5113495bSYour Name //	2	flush_desc_addr_39_32[7:0], block_desc_addr_usage_after_flush[8], block_resource_index[10:9], invalidate_queue_and_flush[11], reserved_2a[31:12]
37*5113495bSYour Name //	3	reserved_3a[31:0]
38*5113495bSYour Name //	4	reserved_4a[31:0]
39*5113495bSYour Name //	5	reserved_5a[31:0]
40*5113495bSYour Name //	6	reserved_6a[31:0]
41*5113495bSYour Name //	7	reserved_7a[31:0]
42*5113495bSYour Name //	8	reserved_8a[31:0]
43*5113495bSYour Name //
44*5113495bSYour Name // ################ END SUMMARY #################
45*5113495bSYour Name 
46*5113495bSYour Name #define NUM_OF_DWORDS_REO_FLUSH_QUEUE 9
47*5113495bSYour Name 
48*5113495bSYour Name struct reo_flush_queue {
49*5113495bSYour Name     struct            uniform_reo_cmd_header                       cmd_header;
50*5113495bSYour Name              uint32_t flush_desc_addr_31_0            : 32; //[31:0]
51*5113495bSYour Name              uint32_t flush_desc_addr_39_32           :  8, //[7:0]
52*5113495bSYour Name                       block_desc_addr_usage_after_flush:  1, //[8]
53*5113495bSYour Name                       block_resource_index            :  2, //[10:9]
54*5113495bSYour Name                       invalidate_queue_and_flush      :  1, //[11]
55*5113495bSYour Name                       reserved_2a                     : 20; //[31:12]
56*5113495bSYour Name              uint32_t reserved_3a                     : 32; //[31:0]
57*5113495bSYour Name              uint32_t reserved_4a                     : 32; //[31:0]
58*5113495bSYour Name              uint32_t reserved_5a                     : 32; //[31:0]
59*5113495bSYour Name              uint32_t reserved_6a                     : 32; //[31:0]
60*5113495bSYour Name              uint32_t reserved_7a                     : 32; //[31:0]
61*5113495bSYour Name              uint32_t reserved_8a                     : 32; //[31:0]
62*5113495bSYour Name };
63*5113495bSYour Name 
64*5113495bSYour Name /*
65*5113495bSYour Name 
66*5113495bSYour Name struct uniform_reo_cmd_header cmd_header
67*5113495bSYour Name 
68*5113495bSYour Name 			Consumer: REO
69*5113495bSYour Name 
70*5113495bSYour Name 			Producer: SW
71*5113495bSYour Name 
72*5113495bSYour Name 
73*5113495bSYour Name 
74*5113495bSYour Name 			Details for command execution tracking purposes.
75*5113495bSYour Name 
76*5113495bSYour Name flush_desc_addr_31_0
77*5113495bSYour Name 
78*5113495bSYour Name 			Consumer: REO
79*5113495bSYour Name 
80*5113495bSYour Name 			Producer: SW
81*5113495bSYour Name 
82*5113495bSYour Name 
83*5113495bSYour Name 
84*5113495bSYour Name 			Address (lower 32 bits) of the descriptor to flush
85*5113495bSYour Name 
86*5113495bSYour Name 			<legal all>
87*5113495bSYour Name 
88*5113495bSYour Name flush_desc_addr_39_32
89*5113495bSYour Name 
90*5113495bSYour Name 			Consumer: REO
91*5113495bSYour Name 
92*5113495bSYour Name 			Producer: SW
93*5113495bSYour Name 
94*5113495bSYour Name 
95*5113495bSYour Name 
96*5113495bSYour Name 			Address (upper 8 bits) of the descriptor to flush
97*5113495bSYour Name 
98*5113495bSYour Name 			<legal all>
99*5113495bSYour Name 
100*5113495bSYour Name block_desc_addr_usage_after_flush
101*5113495bSYour Name 
102*5113495bSYour Name 			When set, REO shall not re-fetch this address till SW
103*5113495bSYour Name 			explicitly unblocked this address
104*5113495bSYour Name 
105*5113495bSYour Name 
106*5113495bSYour Name 
107*5113495bSYour Name 			If the blocking resource was already used, this command
108*5113495bSYour Name 			shall fail and an error is reported
109*5113495bSYour Name 
110*5113495bSYour Name 
111*5113495bSYour Name 
112*5113495bSYour Name 			<legal all>
113*5113495bSYour Name 
114*5113495bSYour Name block_resource_index
115*5113495bSYour Name 
116*5113495bSYour Name 			Field only valid when 'Block_desc_addr_usage_after_flush
117*5113495bSYour Name 			' is set.
118*5113495bSYour Name 
119*5113495bSYour Name 
120*5113495bSYour Name 
121*5113495bSYour Name 			Indicates which of the four blocking resources in REO
122*5113495bSYour Name 			will be assigned for managing the blocking of this address.
123*5113495bSYour Name 
124*5113495bSYour Name 			<legal all>
125*5113495bSYour Name 
126*5113495bSYour Name invalidate_queue_and_flush
127*5113495bSYour Name 
128*5113495bSYour Name 			When set, after the queue has been completely flushed,
129*5113495bSYour Name 			invalidate the queue by clearing VLD and flush the queue
130*5113495bSYour Name 			descriptor from the cache.
131*5113495bSYour Name 
132*5113495bSYour Name 
133*5113495bSYour Name 
134*5113495bSYour Name 			<legal all>
135*5113495bSYour Name 
136*5113495bSYour Name reserved_2a
137*5113495bSYour Name 
138*5113495bSYour Name 			<legal 0>
139*5113495bSYour Name 
140*5113495bSYour Name reserved_3a
141*5113495bSYour Name 
142*5113495bSYour Name 			<legal 0>
143*5113495bSYour Name 
144*5113495bSYour Name reserved_4a
145*5113495bSYour Name 
146*5113495bSYour Name 			<legal 0>
147*5113495bSYour Name 
148*5113495bSYour Name reserved_5a
149*5113495bSYour Name 
150*5113495bSYour Name 			<legal 0>
151*5113495bSYour Name 
152*5113495bSYour Name reserved_6a
153*5113495bSYour Name 
154*5113495bSYour Name 			<legal 0>
155*5113495bSYour Name 
156*5113495bSYour Name reserved_7a
157*5113495bSYour Name 
158*5113495bSYour Name 			<legal 0>
159*5113495bSYour Name 
160*5113495bSYour Name reserved_8a
161*5113495bSYour Name 
162*5113495bSYour Name 			<legal 0>
163*5113495bSYour Name */
164*5113495bSYour Name 
165*5113495bSYour Name 
166*5113495bSYour Name  /* EXTERNAL REFERENCE : struct uniform_reo_cmd_header cmd_header */
167*5113495bSYour Name 
168*5113495bSYour Name 
169*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_0_CMD_HEADER_REO_CMD_NUMBER
170*5113495bSYour Name 
171*5113495bSYour Name 			Consumer: REO/SW/DEBUG
172*5113495bSYour Name 
173*5113495bSYour Name 			Producer: SW
174*5113495bSYour Name 
175*5113495bSYour Name 
176*5113495bSYour Name 
177*5113495bSYour Name 			This number can be used by SW to track, identify and
178*5113495bSYour Name 			link the created commands with the command statusses
179*5113495bSYour Name 
180*5113495bSYour Name 
181*5113495bSYour Name 
182*5113495bSYour Name 
183*5113495bSYour Name 
184*5113495bSYour Name 			<legal all>
185*5113495bSYour Name */
186*5113495bSYour Name #define REO_FLUSH_QUEUE_0_CMD_HEADER_REO_CMD_NUMBER_OFFSET           0x00000000
187*5113495bSYour Name #define REO_FLUSH_QUEUE_0_CMD_HEADER_REO_CMD_NUMBER_LSB              0
188*5113495bSYour Name #define REO_FLUSH_QUEUE_0_CMD_HEADER_REO_CMD_NUMBER_MASK             0x0000ffff
189*5113495bSYour Name 
190*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_0_CMD_HEADER_REO_STATUS_REQUIRED
191*5113495bSYour Name 
192*5113495bSYour Name 			Consumer: REO
193*5113495bSYour Name 
194*5113495bSYour Name 			Producer: SW
195*5113495bSYour Name 
196*5113495bSYour Name 
197*5113495bSYour Name 
198*5113495bSYour Name 			<enum 0 NoStatus> REO does not need to generate a status
199*5113495bSYour Name 			TLV for the execution of this command
200*5113495bSYour Name 
201*5113495bSYour Name 			<enum 1 StatusRequired> REO shall generate a status TLV
202*5113495bSYour Name 			for the execution of this command
203*5113495bSYour Name 
204*5113495bSYour Name 
205*5113495bSYour Name 
206*5113495bSYour Name 			<legal all>
207*5113495bSYour Name */
208*5113495bSYour Name #define REO_FLUSH_QUEUE_0_CMD_HEADER_REO_STATUS_REQUIRED_OFFSET      0x00000000
209*5113495bSYour Name #define REO_FLUSH_QUEUE_0_CMD_HEADER_REO_STATUS_REQUIRED_LSB         16
210*5113495bSYour Name #define REO_FLUSH_QUEUE_0_CMD_HEADER_REO_STATUS_REQUIRED_MASK        0x00010000
211*5113495bSYour Name 
212*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_0_CMD_HEADER_RESERVED_0A
213*5113495bSYour Name 
214*5113495bSYour Name 			<legal 0>
215*5113495bSYour Name */
216*5113495bSYour Name #define REO_FLUSH_QUEUE_0_CMD_HEADER_RESERVED_0A_OFFSET              0x00000000
217*5113495bSYour Name #define REO_FLUSH_QUEUE_0_CMD_HEADER_RESERVED_0A_LSB                 17
218*5113495bSYour Name #define REO_FLUSH_QUEUE_0_CMD_HEADER_RESERVED_0A_MASK                0xfffe0000
219*5113495bSYour Name 
220*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_1_FLUSH_DESC_ADDR_31_0
221*5113495bSYour Name 
222*5113495bSYour Name 			Consumer: REO
223*5113495bSYour Name 
224*5113495bSYour Name 			Producer: SW
225*5113495bSYour Name 
226*5113495bSYour Name 
227*5113495bSYour Name 
228*5113495bSYour Name 			Address (lower 32 bits) of the descriptor to flush
229*5113495bSYour Name 
230*5113495bSYour Name 			<legal all>
231*5113495bSYour Name */
232*5113495bSYour Name #define REO_FLUSH_QUEUE_1_FLUSH_DESC_ADDR_31_0_OFFSET                0x00000004
233*5113495bSYour Name #define REO_FLUSH_QUEUE_1_FLUSH_DESC_ADDR_31_0_LSB                   0
234*5113495bSYour Name #define REO_FLUSH_QUEUE_1_FLUSH_DESC_ADDR_31_0_MASK                  0xffffffff
235*5113495bSYour Name 
236*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_2_FLUSH_DESC_ADDR_39_32
237*5113495bSYour Name 
238*5113495bSYour Name 			Consumer: REO
239*5113495bSYour Name 
240*5113495bSYour Name 			Producer: SW
241*5113495bSYour Name 
242*5113495bSYour Name 
243*5113495bSYour Name 
244*5113495bSYour Name 			Address (upper 8 bits) of the descriptor to flush
245*5113495bSYour Name 
246*5113495bSYour Name 			<legal all>
247*5113495bSYour Name */
248*5113495bSYour Name #define REO_FLUSH_QUEUE_2_FLUSH_DESC_ADDR_39_32_OFFSET               0x00000008
249*5113495bSYour Name #define REO_FLUSH_QUEUE_2_FLUSH_DESC_ADDR_39_32_LSB                  0
250*5113495bSYour Name #define REO_FLUSH_QUEUE_2_FLUSH_DESC_ADDR_39_32_MASK                 0x000000ff
251*5113495bSYour Name 
252*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_2_BLOCK_DESC_ADDR_USAGE_AFTER_FLUSH
253*5113495bSYour Name 
254*5113495bSYour Name 			When set, REO shall not re-fetch this address till SW
255*5113495bSYour Name 			explicitly unblocked this address
256*5113495bSYour Name 
257*5113495bSYour Name 
258*5113495bSYour Name 
259*5113495bSYour Name 			If the blocking resource was already used, this command
260*5113495bSYour Name 			shall fail and an error is reported
261*5113495bSYour Name 
262*5113495bSYour Name 
263*5113495bSYour Name 
264*5113495bSYour Name 			<legal all>
265*5113495bSYour Name */
266*5113495bSYour Name #define REO_FLUSH_QUEUE_2_BLOCK_DESC_ADDR_USAGE_AFTER_FLUSH_OFFSET   0x00000008
267*5113495bSYour Name #define REO_FLUSH_QUEUE_2_BLOCK_DESC_ADDR_USAGE_AFTER_FLUSH_LSB      8
268*5113495bSYour Name #define REO_FLUSH_QUEUE_2_BLOCK_DESC_ADDR_USAGE_AFTER_FLUSH_MASK     0x00000100
269*5113495bSYour Name 
270*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_2_BLOCK_RESOURCE_INDEX
271*5113495bSYour Name 
272*5113495bSYour Name 			Field only valid when 'Block_desc_addr_usage_after_flush
273*5113495bSYour Name 			' is set.
274*5113495bSYour Name 
275*5113495bSYour Name 
276*5113495bSYour Name 
277*5113495bSYour Name 			Indicates which of the four blocking resources in REO
278*5113495bSYour Name 			will be assigned for managing the blocking of this address.
279*5113495bSYour Name 
280*5113495bSYour Name 			<legal all>
281*5113495bSYour Name */
282*5113495bSYour Name #define REO_FLUSH_QUEUE_2_BLOCK_RESOURCE_INDEX_OFFSET                0x00000008
283*5113495bSYour Name #define REO_FLUSH_QUEUE_2_BLOCK_RESOURCE_INDEX_LSB                   9
284*5113495bSYour Name #define REO_FLUSH_QUEUE_2_BLOCK_RESOURCE_INDEX_MASK                  0x00000600
285*5113495bSYour Name 
286*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_2_INVALIDATE_QUEUE_AND_FLUSH
287*5113495bSYour Name 
288*5113495bSYour Name 			When set, after the queue has been completely flushed,
289*5113495bSYour Name 			invalidate the queue by clearing VLD and flush the queue
290*5113495bSYour Name 			descriptor from the cache.
291*5113495bSYour Name 
292*5113495bSYour Name 
293*5113495bSYour Name 
294*5113495bSYour Name 			<legal all>
295*5113495bSYour Name */
296*5113495bSYour Name #define REO_FLUSH_QUEUE_2_INVALIDATE_QUEUE_AND_FLUSH_OFFSET          0x00000008
297*5113495bSYour Name #define REO_FLUSH_QUEUE_2_INVALIDATE_QUEUE_AND_FLUSH_LSB             11
298*5113495bSYour Name #define REO_FLUSH_QUEUE_2_INVALIDATE_QUEUE_AND_FLUSH_MASK            0x00000800
299*5113495bSYour Name 
300*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_2_RESERVED_2A
301*5113495bSYour Name 
302*5113495bSYour Name 			<legal 0>
303*5113495bSYour Name */
304*5113495bSYour Name #define REO_FLUSH_QUEUE_2_RESERVED_2A_OFFSET                         0x00000008
305*5113495bSYour Name #define REO_FLUSH_QUEUE_2_RESERVED_2A_LSB                            12
306*5113495bSYour Name #define REO_FLUSH_QUEUE_2_RESERVED_2A_MASK                           0xfffff000
307*5113495bSYour Name 
308*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_3_RESERVED_3A
309*5113495bSYour Name 
310*5113495bSYour Name 			<legal 0>
311*5113495bSYour Name */
312*5113495bSYour Name #define REO_FLUSH_QUEUE_3_RESERVED_3A_OFFSET                         0x0000000c
313*5113495bSYour Name #define REO_FLUSH_QUEUE_3_RESERVED_3A_LSB                            0
314*5113495bSYour Name #define REO_FLUSH_QUEUE_3_RESERVED_3A_MASK                           0xffffffff
315*5113495bSYour Name 
316*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_4_RESERVED_4A
317*5113495bSYour Name 
318*5113495bSYour Name 			<legal 0>
319*5113495bSYour Name */
320*5113495bSYour Name #define REO_FLUSH_QUEUE_4_RESERVED_4A_OFFSET                         0x00000010
321*5113495bSYour Name #define REO_FLUSH_QUEUE_4_RESERVED_4A_LSB                            0
322*5113495bSYour Name #define REO_FLUSH_QUEUE_4_RESERVED_4A_MASK                           0xffffffff
323*5113495bSYour Name 
324*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_5_RESERVED_5A
325*5113495bSYour Name 
326*5113495bSYour Name 			<legal 0>
327*5113495bSYour Name */
328*5113495bSYour Name #define REO_FLUSH_QUEUE_5_RESERVED_5A_OFFSET                         0x00000014
329*5113495bSYour Name #define REO_FLUSH_QUEUE_5_RESERVED_5A_LSB                            0
330*5113495bSYour Name #define REO_FLUSH_QUEUE_5_RESERVED_5A_MASK                           0xffffffff
331*5113495bSYour Name 
332*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_6_RESERVED_6A
333*5113495bSYour Name 
334*5113495bSYour Name 			<legal 0>
335*5113495bSYour Name */
336*5113495bSYour Name #define REO_FLUSH_QUEUE_6_RESERVED_6A_OFFSET                         0x00000018
337*5113495bSYour Name #define REO_FLUSH_QUEUE_6_RESERVED_6A_LSB                            0
338*5113495bSYour Name #define REO_FLUSH_QUEUE_6_RESERVED_6A_MASK                           0xffffffff
339*5113495bSYour Name 
340*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_7_RESERVED_7A
341*5113495bSYour Name 
342*5113495bSYour Name 			<legal 0>
343*5113495bSYour Name */
344*5113495bSYour Name #define REO_FLUSH_QUEUE_7_RESERVED_7A_OFFSET                         0x0000001c
345*5113495bSYour Name #define REO_FLUSH_QUEUE_7_RESERVED_7A_LSB                            0
346*5113495bSYour Name #define REO_FLUSH_QUEUE_7_RESERVED_7A_MASK                           0xffffffff
347*5113495bSYour Name 
348*5113495bSYour Name /* Description		REO_FLUSH_QUEUE_8_RESERVED_8A
349*5113495bSYour Name 
350*5113495bSYour Name 			<legal 0>
351*5113495bSYour Name */
352*5113495bSYour Name #define REO_FLUSH_QUEUE_8_RESERVED_8A_OFFSET                         0x00000020
353*5113495bSYour Name #define REO_FLUSH_QUEUE_8_RESERVED_8A_LSB                            0
354*5113495bSYour Name #define REO_FLUSH_QUEUE_8_RESERVED_8A_MASK                           0xffffffff
355*5113495bSYour Name 
356*5113495bSYour Name 
357*5113495bSYour Name #endif // _REO_FLUSH_QUEUE_H_
358