xref: /wlan-driver/fw-api/hw/qca5332/reo_unblock_cache.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name 
2*5113495bSYour Name /* Copyright (c) 2022, Qualcomm Innovation Center, Inc. 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 
18*5113495bSYour Name 
19*5113495bSYour Name 
20*5113495bSYour Name 
21*5113495bSYour Name 
22*5113495bSYour Name 
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name 
26*5113495bSYour Name #ifndef _REO_UNBLOCK_CACHE_H_
27*5113495bSYour Name #define _REO_UNBLOCK_CACHE_H_
28*5113495bSYour Name #if !defined(__ASSEMBLER__)
29*5113495bSYour Name #endif
30*5113495bSYour Name 
31*5113495bSYour Name #include "uniform_reo_cmd_header.h"
32*5113495bSYour Name #define NUM_OF_DWORDS_REO_UNBLOCK_CACHE 10
33*5113495bSYour Name 
34*5113495bSYour Name #define NUM_OF_QWORDS_REO_UNBLOCK_CACHE 5
35*5113495bSYour Name 
36*5113495bSYour Name 
37*5113495bSYour Name struct reo_unblock_cache {
38*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
39*5113495bSYour Name              struct   uniform_reo_cmd_header                                    cmd_header;
40*5113495bSYour Name              uint32_t unblock_type                                            :  1, // [0:0]
41*5113495bSYour Name                       cache_block_resource_index                              :  2, // [2:1]
42*5113495bSYour Name                       reserved_1a                                             : 29; // [31:3]
43*5113495bSYour Name              uint32_t reserved_2a                                             : 32; // [31:0]
44*5113495bSYour Name              uint32_t reserved_3a                                             : 32; // [31:0]
45*5113495bSYour Name              uint32_t reserved_4a                                             : 32; // [31:0]
46*5113495bSYour Name              uint32_t reserved_5a                                             : 32; // [31:0]
47*5113495bSYour Name              uint32_t reserved_6a                                             : 32; // [31:0]
48*5113495bSYour Name              uint32_t reserved_7a                                             : 32; // [31:0]
49*5113495bSYour Name              uint32_t reserved_8a                                             : 32; // [31:0]
50*5113495bSYour Name              uint32_t tlv64_padding                                           : 32; // [31:0]
51*5113495bSYour Name #else
52*5113495bSYour Name              struct   uniform_reo_cmd_header                                    cmd_header;
53*5113495bSYour Name              uint32_t reserved_1a                                             : 29, // [31:3]
54*5113495bSYour Name                       cache_block_resource_index                              :  2, // [2:1]
55*5113495bSYour Name                       unblock_type                                            :  1; // [0:0]
56*5113495bSYour Name              uint32_t reserved_2a                                             : 32; // [31:0]
57*5113495bSYour Name              uint32_t reserved_3a                                             : 32; // [31:0]
58*5113495bSYour Name              uint32_t reserved_4a                                             : 32; // [31:0]
59*5113495bSYour Name              uint32_t reserved_5a                                             : 32; // [31:0]
60*5113495bSYour Name              uint32_t reserved_6a                                             : 32; // [31:0]
61*5113495bSYour Name              uint32_t reserved_7a                                             : 32; // [31:0]
62*5113495bSYour Name              uint32_t reserved_8a                                             : 32; // [31:0]
63*5113495bSYour Name              uint32_t tlv64_padding                                           : 32; // [31:0]
64*5113495bSYour Name #endif
65*5113495bSYour Name };
66*5113495bSYour Name 
67*5113495bSYour Name 
68*5113495bSYour Name /* Description		CMD_HEADER
69*5113495bSYour Name 
70*5113495bSYour Name 			Consumer: REO
71*5113495bSYour Name 			Producer: SW
72*5113495bSYour Name 
73*5113495bSYour Name 			Details for command execution tracking purposes.
74*5113495bSYour Name */
75*5113495bSYour Name 
76*5113495bSYour Name 
77*5113495bSYour Name /* Description		REO_CMD_NUMBER
78*5113495bSYour Name 
79*5113495bSYour Name 			Consumer: REO/SW/DEBUG
80*5113495bSYour Name 			Producer: SW
81*5113495bSYour Name 
82*5113495bSYour Name 			This number can be used by SW to track, identify and link
83*5113495bSYour Name 			 the created commands with the command statusses
84*5113495bSYour Name 
85*5113495bSYour Name 
86*5113495bSYour Name 			<legal all>
87*5113495bSYour Name */
88*5113495bSYour Name 
89*5113495bSYour Name #define REO_UNBLOCK_CACHE_CMD_HEADER_REO_CMD_NUMBER_OFFSET                          0x0000000000000000
90*5113495bSYour Name #define REO_UNBLOCK_CACHE_CMD_HEADER_REO_CMD_NUMBER_LSB                             0
91*5113495bSYour Name #define REO_UNBLOCK_CACHE_CMD_HEADER_REO_CMD_NUMBER_MSB                             15
92*5113495bSYour Name #define REO_UNBLOCK_CACHE_CMD_HEADER_REO_CMD_NUMBER_MASK                            0x000000000000ffff
93*5113495bSYour Name 
94*5113495bSYour Name 
95*5113495bSYour Name /* Description		REO_STATUS_REQUIRED
96*5113495bSYour Name 
97*5113495bSYour Name 			Consumer: REO
98*5113495bSYour Name 			Producer: SW
99*5113495bSYour Name 
100*5113495bSYour Name 			<enum 0 NoStatus> REO does not need to generate a status
101*5113495bSYour Name 			 TLV for the execution of this command
102*5113495bSYour Name 			<enum 1 StatusRequired> REO shall generate a status TLV
103*5113495bSYour Name 			for the execution of this command
104*5113495bSYour Name 
105*5113495bSYour Name 			<legal all>
106*5113495bSYour Name */
107*5113495bSYour Name 
108*5113495bSYour Name #define REO_UNBLOCK_CACHE_CMD_HEADER_REO_STATUS_REQUIRED_OFFSET                     0x0000000000000000
109*5113495bSYour Name #define REO_UNBLOCK_CACHE_CMD_HEADER_REO_STATUS_REQUIRED_LSB                        16
110*5113495bSYour Name #define REO_UNBLOCK_CACHE_CMD_HEADER_REO_STATUS_REQUIRED_MSB                        16
111*5113495bSYour Name #define REO_UNBLOCK_CACHE_CMD_HEADER_REO_STATUS_REQUIRED_MASK                       0x0000000000010000
112*5113495bSYour Name 
113*5113495bSYour Name 
114*5113495bSYour Name /* Description		RESERVED_0A
115*5113495bSYour Name 
116*5113495bSYour Name 			<legal 0>
117*5113495bSYour Name */
118*5113495bSYour Name 
119*5113495bSYour Name #define REO_UNBLOCK_CACHE_CMD_HEADER_RESERVED_0A_OFFSET                             0x0000000000000000
120*5113495bSYour Name #define REO_UNBLOCK_CACHE_CMD_HEADER_RESERVED_0A_LSB                                17
121*5113495bSYour Name #define REO_UNBLOCK_CACHE_CMD_HEADER_RESERVED_0A_MSB                                31
122*5113495bSYour Name #define REO_UNBLOCK_CACHE_CMD_HEADER_RESERVED_0A_MASK                               0x00000000fffe0000
123*5113495bSYour Name 
124*5113495bSYour Name 
125*5113495bSYour Name /* Description		UNBLOCK_TYPE
126*5113495bSYour Name 
127*5113495bSYour Name 			Unblock type
128*5113495bSYour Name 
129*5113495bSYour Name 			<enum 0 unblock_resource_index> Unblock a block resource,
130*5113495bSYour Name 			whose index is given in field 'cache_block_resource_index'.
131*5113495bSYour Name 
132*5113495bSYour Name 			If the indicated blocking resource is not in use (=> not
133*5113495bSYour Name 			 blocking an address at the moment), the command status
134*5113495bSYour Name 			will indicate an error.
135*5113495bSYour Name 
136*5113495bSYour Name 			<enum 1 unblock_cache> The entire cache usage is unblocked.
137*5113495bSYour Name 
138*5113495bSYour Name 			If the entire cache is not in a blocked mode at the moment
139*5113495bSYour Name 			 this command is received, the command status will indicate
140*5113495bSYour Name 			 an error.
141*5113495bSYour Name 			Note that unlocking the "entire cache" has no changes to
142*5113495bSYour Name 			 the current settings of the blocking resource settings
143*5113495bSYour Name 
144*5113495bSYour Name 			<legal all>
145*5113495bSYour Name */
146*5113495bSYour Name 
147*5113495bSYour Name #define REO_UNBLOCK_CACHE_UNBLOCK_TYPE_OFFSET                                       0x0000000000000000
148*5113495bSYour Name #define REO_UNBLOCK_CACHE_UNBLOCK_TYPE_LSB                                          32
149*5113495bSYour Name #define REO_UNBLOCK_CACHE_UNBLOCK_TYPE_MSB                                          32
150*5113495bSYour Name #define REO_UNBLOCK_CACHE_UNBLOCK_TYPE_MASK                                         0x0000000100000000
151*5113495bSYour Name 
152*5113495bSYour Name 
153*5113495bSYour Name /* Description		CACHE_BLOCK_RESOURCE_INDEX
154*5113495bSYour Name 
155*5113495bSYour Name 			Field not valid when field Unblock_type is set to unblock_cache.
156*5113495bSYour Name 
157*5113495bSYour Name 
158*5113495bSYour Name 			Indicates which of the four blocking resources in REO should
159*5113495bSYour Name 			 be released from blocking a (descriptor) address.
160*5113495bSYour Name 			<legal all>
161*5113495bSYour Name */
162*5113495bSYour Name 
163*5113495bSYour Name #define REO_UNBLOCK_CACHE_CACHE_BLOCK_RESOURCE_INDEX_OFFSET                         0x0000000000000000
164*5113495bSYour Name #define REO_UNBLOCK_CACHE_CACHE_BLOCK_RESOURCE_INDEX_LSB                            33
165*5113495bSYour Name #define REO_UNBLOCK_CACHE_CACHE_BLOCK_RESOURCE_INDEX_MSB                            34
166*5113495bSYour Name #define REO_UNBLOCK_CACHE_CACHE_BLOCK_RESOURCE_INDEX_MASK                           0x0000000600000000
167*5113495bSYour Name 
168*5113495bSYour Name 
169*5113495bSYour Name /* Description		RESERVED_1A
170*5113495bSYour Name 
171*5113495bSYour Name 			<legal 0>
172*5113495bSYour Name */
173*5113495bSYour Name 
174*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_1A_OFFSET                                        0x0000000000000000
175*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_1A_LSB                                           35
176*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_1A_MSB                                           63
177*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_1A_MASK                                          0xfffffff800000000
178*5113495bSYour Name 
179*5113495bSYour Name 
180*5113495bSYour Name /* Description		RESERVED_2A
181*5113495bSYour Name 
182*5113495bSYour Name 			<legal 0>
183*5113495bSYour Name */
184*5113495bSYour Name 
185*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_2A_OFFSET                                        0x0000000000000008
186*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_2A_LSB                                           0
187*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_2A_MSB                                           31
188*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_2A_MASK                                          0x00000000ffffffff
189*5113495bSYour Name 
190*5113495bSYour Name 
191*5113495bSYour Name /* Description		RESERVED_3A
192*5113495bSYour Name 
193*5113495bSYour Name 			<legal 0>
194*5113495bSYour Name */
195*5113495bSYour Name 
196*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_3A_OFFSET                                        0x0000000000000008
197*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_3A_LSB                                           32
198*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_3A_MSB                                           63
199*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_3A_MASK                                          0xffffffff00000000
200*5113495bSYour Name 
201*5113495bSYour Name 
202*5113495bSYour Name /* Description		RESERVED_4A
203*5113495bSYour Name 
204*5113495bSYour Name 			<legal 0>
205*5113495bSYour Name */
206*5113495bSYour Name 
207*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_4A_OFFSET                                        0x0000000000000010
208*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_4A_LSB                                           0
209*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_4A_MSB                                           31
210*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_4A_MASK                                          0x00000000ffffffff
211*5113495bSYour Name 
212*5113495bSYour Name 
213*5113495bSYour Name /* Description		RESERVED_5A
214*5113495bSYour Name 
215*5113495bSYour Name 			<legal 0>
216*5113495bSYour Name */
217*5113495bSYour Name 
218*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_5A_OFFSET                                        0x0000000000000010
219*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_5A_LSB                                           32
220*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_5A_MSB                                           63
221*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_5A_MASK                                          0xffffffff00000000
222*5113495bSYour Name 
223*5113495bSYour Name 
224*5113495bSYour Name /* Description		RESERVED_6A
225*5113495bSYour Name 
226*5113495bSYour Name 			<legal 0>
227*5113495bSYour Name */
228*5113495bSYour Name 
229*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_6A_OFFSET                                        0x0000000000000018
230*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_6A_LSB                                           0
231*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_6A_MSB                                           31
232*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_6A_MASK                                          0x00000000ffffffff
233*5113495bSYour Name 
234*5113495bSYour Name 
235*5113495bSYour Name /* Description		RESERVED_7A
236*5113495bSYour Name 
237*5113495bSYour Name 			<legal 0>
238*5113495bSYour Name */
239*5113495bSYour Name 
240*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_7A_OFFSET                                        0x0000000000000018
241*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_7A_LSB                                           32
242*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_7A_MSB                                           63
243*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_7A_MASK                                          0xffffffff00000000
244*5113495bSYour Name 
245*5113495bSYour Name 
246*5113495bSYour Name /* Description		RESERVED_8A
247*5113495bSYour Name 
248*5113495bSYour Name 			<legal 0>
249*5113495bSYour Name */
250*5113495bSYour Name 
251*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_8A_OFFSET                                        0x0000000000000020
252*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_8A_LSB                                           0
253*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_8A_MSB                                           31
254*5113495bSYour Name #define REO_UNBLOCK_CACHE_RESERVED_8A_MASK                                          0x00000000ffffffff
255*5113495bSYour Name 
256*5113495bSYour Name 
257*5113495bSYour Name /* Description		TLV64_PADDING
258*5113495bSYour Name 
259*5113495bSYour Name 			Automatic DWORD padding inserted while converting TLV32
260*5113495bSYour Name 			to TLV64 for 64 bit ARCH
261*5113495bSYour Name 			<legal 0>
262*5113495bSYour Name */
263*5113495bSYour Name 
264*5113495bSYour Name #define REO_UNBLOCK_CACHE_TLV64_PADDING_OFFSET                                      0x0000000000000020
265*5113495bSYour Name #define REO_UNBLOCK_CACHE_TLV64_PADDING_LSB                                         32
266*5113495bSYour Name #define REO_UNBLOCK_CACHE_TLV64_PADDING_MSB                                         63
267*5113495bSYour Name #define REO_UNBLOCK_CACHE_TLV64_PADDING_MASK                                        0xffffffff00000000
268*5113495bSYour Name 
269*5113495bSYour Name 
270*5113495bSYour Name 
271*5113495bSYour Name #endif   // REO_UNBLOCK_CACHE
272