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