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