xref: /wlan-driver/fw-api/hw/qca6750/v1/reo_unblock_cache.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
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_UNBLOCK_CACHE_H_
25*5113495bSYour Name #define _REO_UNBLOCK_CACHE_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	unblock_type[0], cache_block_resource_index[2:1], reserved_1a[31:3]
36*5113495bSYour Name //	2	reserved_2a[31:0]
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_UNBLOCK_CACHE 9
47*5113495bSYour Name 
48*5113495bSYour Name struct reo_unblock_cache {
49*5113495bSYour Name     struct            uniform_reo_cmd_header                       cmd_header;
50*5113495bSYour Name              uint32_t unblock_type                    :  1, //[0]
51*5113495bSYour Name                       cache_block_resource_index      :  2, //[2:1]
52*5113495bSYour Name                       reserved_1a                     : 29; //[31:3]
53*5113495bSYour Name              uint32_t reserved_2a                     : 32; //[31:0]
54*5113495bSYour Name              uint32_t reserved_3a                     : 32; //[31:0]
55*5113495bSYour Name              uint32_t reserved_4a                     : 32; //[31:0]
56*5113495bSYour Name              uint32_t reserved_5a                     : 32; //[31:0]
57*5113495bSYour Name              uint32_t reserved_6a                     : 32; //[31:0]
58*5113495bSYour Name              uint32_t reserved_7a                     : 32; //[31:0]
59*5113495bSYour Name              uint32_t reserved_8a                     : 32; //[31:0]
60*5113495bSYour Name };
61*5113495bSYour Name 
62*5113495bSYour Name /*
63*5113495bSYour Name 
64*5113495bSYour Name struct uniform_reo_cmd_header cmd_header
65*5113495bSYour Name 
66*5113495bSYour Name 			Consumer: REO
67*5113495bSYour Name 
68*5113495bSYour Name 			Producer: SW
69*5113495bSYour Name 
70*5113495bSYour Name 
71*5113495bSYour Name 
72*5113495bSYour Name 			Details for command execution tracking purposes.
73*5113495bSYour Name 
74*5113495bSYour Name unblock_type
75*5113495bSYour Name 
76*5113495bSYour Name 			Unblock type
77*5113495bSYour Name 
78*5113495bSYour Name 
79*5113495bSYour Name 
80*5113495bSYour Name 			<enum 0 unblock_resource_index> Unblock a block
81*5113495bSYour Name 			resource, whose index is given in field
82*5113495bSYour Name 			'cache_block_resource_index'.
83*5113495bSYour Name 
84*5113495bSYour Name 			If the indicated blocking resource is not in use (=> not
85*5113495bSYour Name 			blocking an address at the moment), the command status will
86*5113495bSYour Name 			indicate an error.
87*5113495bSYour Name 
88*5113495bSYour Name 
89*5113495bSYour Name 
90*5113495bSYour Name 			<enum 1 unblock_cache> The entire cache usage is
91*5113495bSYour Name 			unblocked.
92*5113495bSYour Name 
93*5113495bSYour Name 			If the entire cache is not in a blocked mode at the
94*5113495bSYour Name 			moment this command is received, the command status will
95*5113495bSYour Name 			indicate an error.
96*5113495bSYour Name 
97*5113495bSYour Name 			Note that unlocking the entire cache has no changes to
98*5113495bSYour Name 			the current settings of the blocking resource settings
99*5113495bSYour Name 
100*5113495bSYour Name 
101*5113495bSYour Name 
102*5113495bSYour Name 			<legal all>
103*5113495bSYour Name 
104*5113495bSYour Name cache_block_resource_index
105*5113495bSYour Name 
106*5113495bSYour Name 			Field not valid when field Unblock_type is set to
107*5113495bSYour Name 			unblock_cache.
108*5113495bSYour Name 
109*5113495bSYour Name 
110*5113495bSYour Name 
111*5113495bSYour Name 			Indicates which of the four blocking resources in REO
112*5113495bSYour Name 			should be released from blocking a (descriptor) address.
113*5113495bSYour Name 
114*5113495bSYour Name 			<legal all>
115*5113495bSYour Name 
116*5113495bSYour Name reserved_1a
117*5113495bSYour Name 
118*5113495bSYour Name 			<legal 0>
119*5113495bSYour Name 
120*5113495bSYour Name reserved_2a
121*5113495bSYour Name 
122*5113495bSYour Name 			<legal 0>
123*5113495bSYour Name 
124*5113495bSYour Name reserved_3a
125*5113495bSYour Name 
126*5113495bSYour Name 			<legal 0>
127*5113495bSYour Name 
128*5113495bSYour Name reserved_4a
129*5113495bSYour Name 
130*5113495bSYour Name 			<legal 0>
131*5113495bSYour Name 
132*5113495bSYour Name reserved_5a
133*5113495bSYour Name 
134*5113495bSYour Name 			<legal 0>
135*5113495bSYour Name 
136*5113495bSYour Name reserved_6a
137*5113495bSYour Name 
138*5113495bSYour Name 			<legal 0>
139*5113495bSYour Name 
140*5113495bSYour Name reserved_7a
141*5113495bSYour Name 
142*5113495bSYour Name 			<legal 0>
143*5113495bSYour Name 
144*5113495bSYour Name reserved_8a
145*5113495bSYour Name 
146*5113495bSYour Name 			<legal 0>
147*5113495bSYour Name */
148*5113495bSYour Name 
149*5113495bSYour Name 
150*5113495bSYour Name  /* EXTERNAL REFERENCE : struct uniform_reo_cmd_header cmd_header */
151*5113495bSYour Name 
152*5113495bSYour Name 
153*5113495bSYour Name /* Description		REO_UNBLOCK_CACHE_0_CMD_HEADER_REO_CMD_NUMBER
154*5113495bSYour Name 
155*5113495bSYour Name 			Consumer: REO/SW/DEBUG
156*5113495bSYour Name 
157*5113495bSYour Name 			Producer: SW
158*5113495bSYour Name 
159*5113495bSYour Name 
160*5113495bSYour Name 
161*5113495bSYour Name 			This number can be used by SW to track, identify and
162*5113495bSYour Name 			link the created commands with the command statusses
163*5113495bSYour Name 
164*5113495bSYour Name 
165*5113495bSYour Name 
166*5113495bSYour Name 
167*5113495bSYour Name 
168*5113495bSYour Name 			<legal all>
169*5113495bSYour Name */
170*5113495bSYour Name #define REO_UNBLOCK_CACHE_0_CMD_HEADER_REO_CMD_NUMBER_OFFSET         0x00000000
171*5113495bSYour Name #define REO_UNBLOCK_CACHE_0_CMD_HEADER_REO_CMD_NUMBER_LSB            0
172*5113495bSYour Name #define REO_UNBLOCK_CACHE_0_CMD_HEADER_REO_CMD_NUMBER_MASK           0x0000ffff
173*5113495bSYour Name 
174*5113495bSYour Name /* Description		REO_UNBLOCK_CACHE_0_CMD_HEADER_REO_STATUS_REQUIRED
175*5113495bSYour Name 
176*5113495bSYour Name 			Consumer: REO
177*5113495bSYour Name 
178*5113495bSYour Name 			Producer: SW
179*5113495bSYour Name 
180*5113495bSYour Name 
181*5113495bSYour Name 
182*5113495bSYour Name 			<enum 0 NoStatus> REO does not need to generate a status
183*5113495bSYour Name 			TLV for the execution of this command
184*5113495bSYour Name 
185*5113495bSYour Name 			<enum 1 StatusRequired> REO shall generate a status TLV
186*5113495bSYour Name 			for the execution of this command
187*5113495bSYour Name 
188*5113495bSYour Name 
189*5113495bSYour Name 
190*5113495bSYour Name 			<legal all>
191*5113495bSYour Name */
192*5113495bSYour Name #define REO_UNBLOCK_CACHE_0_CMD_HEADER_REO_STATUS_REQUIRED_OFFSET    0x00000000
193*5113495bSYour Name #define REO_UNBLOCK_CACHE_0_CMD_HEADER_REO_STATUS_REQUIRED_LSB       16
194*5113495bSYour Name #define REO_UNBLOCK_CACHE_0_CMD_HEADER_REO_STATUS_REQUIRED_MASK      0x00010000
195*5113495bSYour Name 
196*5113495bSYour Name /* Description		REO_UNBLOCK_CACHE_0_CMD_HEADER_RESERVED_0A
197*5113495bSYour Name 
198*5113495bSYour Name 			<legal 0>
199*5113495bSYour Name */
200*5113495bSYour Name #define REO_UNBLOCK_CACHE_0_CMD_HEADER_RESERVED_0A_OFFSET            0x00000000
201*5113495bSYour Name #define REO_UNBLOCK_CACHE_0_CMD_HEADER_RESERVED_0A_LSB               17
202*5113495bSYour Name #define REO_UNBLOCK_CACHE_0_CMD_HEADER_RESERVED_0A_MASK              0xfffe0000
203*5113495bSYour Name 
204*5113495bSYour Name /* Description		REO_UNBLOCK_CACHE_1_UNBLOCK_TYPE
205*5113495bSYour Name 
206*5113495bSYour Name 			Unblock type
207*5113495bSYour Name 
208*5113495bSYour Name 
209*5113495bSYour Name 
210*5113495bSYour Name 			<enum 0 unblock_resource_index> Unblock a block
211*5113495bSYour Name 			resource, whose index is given in field
212*5113495bSYour Name 			'cache_block_resource_index'.
213*5113495bSYour Name 
214*5113495bSYour Name 			If the indicated blocking resource is not in use (=> not
215*5113495bSYour Name 			blocking an address at the moment), the command status will
216*5113495bSYour Name 			indicate an error.
217*5113495bSYour Name 
218*5113495bSYour Name 
219*5113495bSYour Name 
220*5113495bSYour Name 			<enum 1 unblock_cache> The entire cache usage is
221*5113495bSYour Name 			unblocked.
222*5113495bSYour Name 
223*5113495bSYour Name 			If the entire cache is not in a blocked mode at the
224*5113495bSYour Name 			moment this command is received, the command status will
225*5113495bSYour Name 			indicate an error.
226*5113495bSYour Name 
227*5113495bSYour Name 			Note that unlocking the entire cache has no changes to
228*5113495bSYour Name 			the current settings of the blocking resource settings
229*5113495bSYour Name 
230*5113495bSYour Name 
231*5113495bSYour Name 
232*5113495bSYour Name 			<legal all>
233*5113495bSYour Name */
234*5113495bSYour Name #define REO_UNBLOCK_CACHE_1_UNBLOCK_TYPE_OFFSET                      0x00000004
235*5113495bSYour Name #define REO_UNBLOCK_CACHE_1_UNBLOCK_TYPE_LSB                         0
236*5113495bSYour Name #define REO_UNBLOCK_CACHE_1_UNBLOCK_TYPE_MASK                        0x00000001
237*5113495bSYour Name 
238*5113495bSYour Name /* Description		REO_UNBLOCK_CACHE_1_CACHE_BLOCK_RESOURCE_INDEX
239*5113495bSYour Name 
240*5113495bSYour Name 			Field not valid when field Unblock_type is set to
241*5113495bSYour Name 			unblock_cache.
242*5113495bSYour Name 
243*5113495bSYour Name 
244*5113495bSYour Name 
245*5113495bSYour Name 			Indicates which of the four blocking resources in REO
246*5113495bSYour Name 			should be released from blocking a (descriptor) address.
247*5113495bSYour Name 
248*5113495bSYour Name 			<legal all>
249*5113495bSYour Name */
250*5113495bSYour Name #define REO_UNBLOCK_CACHE_1_CACHE_BLOCK_RESOURCE_INDEX_OFFSET        0x00000004
251*5113495bSYour Name #define REO_UNBLOCK_CACHE_1_CACHE_BLOCK_RESOURCE_INDEX_LSB           1
252*5113495bSYour Name #define REO_UNBLOCK_CACHE_1_CACHE_BLOCK_RESOURCE_INDEX_MASK          0x00000006
253*5113495bSYour Name 
254*5113495bSYour Name /* Description		REO_UNBLOCK_CACHE_1_RESERVED_1A
255*5113495bSYour Name 
256*5113495bSYour Name 			<legal 0>
257*5113495bSYour Name */
258*5113495bSYour Name #define REO_UNBLOCK_CACHE_1_RESERVED_1A_OFFSET                       0x00000004
259*5113495bSYour Name #define REO_UNBLOCK_CACHE_1_RESERVED_1A_LSB                          3
260*5113495bSYour Name #define REO_UNBLOCK_CACHE_1_RESERVED_1A_MASK                         0xfffffff8
261*5113495bSYour Name 
262*5113495bSYour Name /* Description		REO_UNBLOCK_CACHE_2_RESERVED_2A
263*5113495bSYour Name 
264*5113495bSYour Name 			<legal 0>
265*5113495bSYour Name */
266*5113495bSYour Name #define REO_UNBLOCK_CACHE_2_RESERVED_2A_OFFSET                       0x00000008
267*5113495bSYour Name #define REO_UNBLOCK_CACHE_2_RESERVED_2A_LSB                          0
268*5113495bSYour Name #define REO_UNBLOCK_CACHE_2_RESERVED_2A_MASK                         0xffffffff
269*5113495bSYour Name 
270*5113495bSYour Name /* Description		REO_UNBLOCK_CACHE_3_RESERVED_3A
271*5113495bSYour Name 
272*5113495bSYour Name 			<legal 0>
273*5113495bSYour Name */
274*5113495bSYour Name #define REO_UNBLOCK_CACHE_3_RESERVED_3A_OFFSET                       0x0000000c
275*5113495bSYour Name #define REO_UNBLOCK_CACHE_3_RESERVED_3A_LSB                          0
276*5113495bSYour Name #define REO_UNBLOCK_CACHE_3_RESERVED_3A_MASK                         0xffffffff
277*5113495bSYour Name 
278*5113495bSYour Name /* Description		REO_UNBLOCK_CACHE_4_RESERVED_4A
279*5113495bSYour Name 
280*5113495bSYour Name 			<legal 0>
281*5113495bSYour Name */
282*5113495bSYour Name #define REO_UNBLOCK_CACHE_4_RESERVED_4A_OFFSET                       0x00000010
283*5113495bSYour Name #define REO_UNBLOCK_CACHE_4_RESERVED_4A_LSB                          0
284*5113495bSYour Name #define REO_UNBLOCK_CACHE_4_RESERVED_4A_MASK                         0xffffffff
285*5113495bSYour Name 
286*5113495bSYour Name /* Description		REO_UNBLOCK_CACHE_5_RESERVED_5A
287*5113495bSYour Name 
288*5113495bSYour Name 			<legal 0>
289*5113495bSYour Name */
290*5113495bSYour Name #define REO_UNBLOCK_CACHE_5_RESERVED_5A_OFFSET                       0x00000014
291*5113495bSYour Name #define REO_UNBLOCK_CACHE_5_RESERVED_5A_LSB                          0
292*5113495bSYour Name #define REO_UNBLOCK_CACHE_5_RESERVED_5A_MASK                         0xffffffff
293*5113495bSYour Name 
294*5113495bSYour Name /* Description		REO_UNBLOCK_CACHE_6_RESERVED_6A
295*5113495bSYour Name 
296*5113495bSYour Name 			<legal 0>
297*5113495bSYour Name */
298*5113495bSYour Name #define REO_UNBLOCK_CACHE_6_RESERVED_6A_OFFSET                       0x00000018
299*5113495bSYour Name #define REO_UNBLOCK_CACHE_6_RESERVED_6A_LSB                          0
300*5113495bSYour Name #define REO_UNBLOCK_CACHE_6_RESERVED_6A_MASK                         0xffffffff
301*5113495bSYour Name 
302*5113495bSYour Name /* Description		REO_UNBLOCK_CACHE_7_RESERVED_7A
303*5113495bSYour Name 
304*5113495bSYour Name 			<legal 0>
305*5113495bSYour Name */
306*5113495bSYour Name #define REO_UNBLOCK_CACHE_7_RESERVED_7A_OFFSET                       0x0000001c
307*5113495bSYour Name #define REO_UNBLOCK_CACHE_7_RESERVED_7A_LSB                          0
308*5113495bSYour Name #define REO_UNBLOCK_CACHE_7_RESERVED_7A_MASK                         0xffffffff
309*5113495bSYour Name 
310*5113495bSYour Name /* Description		REO_UNBLOCK_CACHE_8_RESERVED_8A
311*5113495bSYour Name 
312*5113495bSYour Name 			<legal 0>
313*5113495bSYour Name */
314*5113495bSYour Name #define REO_UNBLOCK_CACHE_8_RESERVED_8A_OFFSET                       0x00000020
315*5113495bSYour Name #define REO_UNBLOCK_CACHE_8_RESERVED_8A_LSB                          0
316*5113495bSYour Name #define REO_UNBLOCK_CACHE_8_RESERVED_8A_MASK                         0xffffffff
317*5113495bSYour Name 
318*5113495bSYour Name 
319*5113495bSYour Name #endif // _REO_UNBLOCK_CACHE_H_
320