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