xref: /wlan-driver/fw-api/hw/qca5018/reo_flush_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 #ifndef _REO_FLUSH_CACHE_H_
18*5113495bSYour Name #define _REO_FLUSH_CACHE_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_addr_31_0[31:0]
29*5113495bSYour Name //	2	flush_addr_39_32[7:0], forward_all_mpdus_in_queue[8], release_cache_block_index[9], cache_block_resource_index[11:10], flush_without_invalidate[12], block_cache_usage_after_flush[13], flush_entire_cache[14], reserved_2b[31:15]
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_CACHE 9
40*5113495bSYour Name 
41*5113495bSYour Name struct reo_flush_cache {
42*5113495bSYour Name     struct            uniform_reo_cmd_header                       cmd_header;
43*5113495bSYour Name              uint32_t flush_addr_31_0                 : 32; //[31:0]
44*5113495bSYour Name              uint32_t flush_addr_39_32                :  8, //[7:0]
45*5113495bSYour Name                       forward_all_mpdus_in_queue      :  1, //[8]
46*5113495bSYour Name                       release_cache_block_index       :  1, //[9]
47*5113495bSYour Name                       cache_block_resource_index      :  2, //[11:10]
48*5113495bSYour Name                       flush_without_invalidate        :  1, //[12]
49*5113495bSYour Name                       block_cache_usage_after_flush   :  1, //[13]
50*5113495bSYour Name                       flush_entire_cache              :  1, //[14]
51*5113495bSYour Name                       reserved_2b                     : 17; //[31:15]
52*5113495bSYour Name              uint32_t reserved_3a                     : 32; //[31:0]
53*5113495bSYour Name              uint32_t reserved_4a                     : 32; //[31:0]
54*5113495bSYour Name              uint32_t reserved_5a                     : 32; //[31:0]
55*5113495bSYour Name              uint32_t reserved_6a                     : 32; //[31:0]
56*5113495bSYour Name              uint32_t reserved_7a                     : 32; //[31:0]
57*5113495bSYour Name              uint32_t reserved_8a                     : 32; //[31:0]
58*5113495bSYour Name };
59*5113495bSYour Name 
60*5113495bSYour Name /*
61*5113495bSYour Name 
62*5113495bSYour Name struct uniform_reo_cmd_header cmd_header
63*5113495bSYour Name 
64*5113495bSYour Name 			Consumer: REO
65*5113495bSYour Name 
66*5113495bSYour Name 			Producer: SW
67*5113495bSYour Name 
68*5113495bSYour Name 
69*5113495bSYour Name 
70*5113495bSYour Name 			Details for command execution tracking purposes.
71*5113495bSYour Name 
72*5113495bSYour Name flush_addr_31_0
73*5113495bSYour Name 
74*5113495bSYour Name 			Consumer: REO
75*5113495bSYour Name 
76*5113495bSYour Name 			Producer: SW
77*5113495bSYour Name 
78*5113495bSYour Name 
79*5113495bSYour Name 
80*5113495bSYour Name 			Address (lower 32 bits) of the descriptor to flush
81*5113495bSYour Name 
82*5113495bSYour Name 			<legal all>
83*5113495bSYour Name 
84*5113495bSYour Name flush_addr_39_32
85*5113495bSYour Name 
86*5113495bSYour Name 			Consumer: REO
87*5113495bSYour Name 
88*5113495bSYour Name 			Producer: SW
89*5113495bSYour Name 
90*5113495bSYour Name 
91*5113495bSYour Name 
92*5113495bSYour Name 			Address (upper 8 bits) of the descriptor to flush
93*5113495bSYour Name 
94*5113495bSYour Name 			<legal all>
95*5113495bSYour Name 
96*5113495bSYour Name forward_all_mpdus_in_queue
97*5113495bSYour Name 
98*5113495bSYour Name 			Is only allowed to be set when the flush address
99*5113495bSYour Name 			corresponds with a REO descriptor.
100*5113495bSYour Name 
101*5113495bSYour Name 
102*5113495bSYour Name 
103*5113495bSYour Name 			When set, REO shall first forward all the MPDUs held in
104*5113495bSYour Name 			the indicated re-order queue, before flushing the descriptor
105*5113495bSYour Name 			from the cache.
106*5113495bSYour Name 
107*5113495bSYour Name 			<legal all>
108*5113495bSYour Name 
109*5113495bSYour Name release_cache_block_index
110*5113495bSYour Name 
111*5113495bSYour Name 			Field not valid when Flush_entire_cache is set.
112*5113495bSYour Name 
113*5113495bSYour Name 
114*5113495bSYour Name 
115*5113495bSYour Name 			If SW has previously used a blocking resource that it
116*5113495bSYour Name 			now wants to re-use for this command, this bit shall be set.
117*5113495bSYour Name 			It prevents SW from having to send a separate
118*5113495bSYour Name 			REO_UNBLOCK_CACHE command.
119*5113495bSYour Name 
120*5113495bSYour Name 
121*5113495bSYour Name 
122*5113495bSYour Name 			When set, HW will first release the blocking resource
123*5113495bSYour Name 			(indicated in field 'Cache_block_resouce_index') before this
124*5113495bSYour Name 			command gets executed.
125*5113495bSYour Name 
126*5113495bSYour Name 			If that resource was already unblocked, this will be
127*5113495bSYour Name 			considered an error. This command will not be executed, and
128*5113495bSYour Name 			an error shall be returned.
129*5113495bSYour Name 
130*5113495bSYour Name 			<legal all>
131*5113495bSYour Name 
132*5113495bSYour Name cache_block_resource_index
133*5113495bSYour Name 
134*5113495bSYour Name 			Field not valid when Flush_entire_cache is set.
135*5113495bSYour Name 
136*5113495bSYour Name 
137*5113495bSYour Name 
138*5113495bSYour Name 			Indicates which of the four blocking resources in REO
139*5113495bSYour Name 			will be assigned for managing the blocking of this
140*5113495bSYour Name 			(descriptor) address
141*5113495bSYour Name 
142*5113495bSYour Name 			<legal all>
143*5113495bSYour Name 
144*5113495bSYour Name flush_without_invalidate
145*5113495bSYour Name 
146*5113495bSYour Name 			Field not valid when Flush_entire_cache is set.
147*5113495bSYour Name 
148*5113495bSYour Name 
149*5113495bSYour Name 
150*5113495bSYour Name 			When set, REO shall flush the cache line contents from
151*5113495bSYour Name 			the cache, but there is NO need to invalidate the cache line
152*5113495bSYour Name 			entry... The contents in the cache can be maintained. This
153*5113495bSYour Name 			feature can be used by SW (and DV) to get a current snapshot
154*5113495bSYour Name 			of the contents in the cache
155*5113495bSYour Name 
156*5113495bSYour Name 
157*5113495bSYour Name 
158*5113495bSYour Name 			<legal all>
159*5113495bSYour Name 
160*5113495bSYour Name block_cache_usage_after_flush
161*5113495bSYour Name 
162*5113495bSYour Name 			Field not valid when Flush_entire_cache is set.
163*5113495bSYour Name 
164*5113495bSYour Name 
165*5113495bSYour Name 
166*5113495bSYour Name 			When set, REO shall block any cache accesses to this
167*5113495bSYour Name 			address till explicitly unblocked.
168*5113495bSYour Name 
169*5113495bSYour Name 
170*5113495bSYour Name 
171*5113495bSYour Name 			Whenever SW sets this bit, SW shall also set bit
172*5113495bSYour Name 			'Forward_all_mpdus_in_queue' to ensure all packets are
173*5113495bSYour Name 			flushed out in order to make sure this queue desc is not in
174*5113495bSYour Name 			one of the aging link lists. In case SW does not want to
175*5113495bSYour Name 			flush the MPDUs in the queue, see the recipe description
176*5113495bSYour Name 			below this TLV definition.
177*5113495bSYour Name 
178*5113495bSYour Name 
179*5113495bSYour Name 
180*5113495bSYour Name 			The 'blocking' index to be used for this is indicated in
181*5113495bSYour Name 			field 'cache_block_resource_index'. If SW had previously
182*5113495bSYour Name 			used this blocking resource and was not freed up yet, SW
183*5113495bSYour Name 			shall first unblock that index (by setting bit
184*5113495bSYour Name 			Release_cache_block_index) or use an unblock command.
185*5113495bSYour Name 
186*5113495bSYour Name 
187*5113495bSYour Name 
188*5113495bSYour Name 			If the resource indicated here was already blocked (and
189*5113495bSYour Name 			did not get unblocked in this command), it is considered an
190*5113495bSYour Name 			error scenario...
191*5113495bSYour Name 
192*5113495bSYour Name 			No flush shall happen. The status for this command shall
193*5113495bSYour Name 			indicate error.
194*5113495bSYour Name 
195*5113495bSYour Name 
196*5113495bSYour Name 
197*5113495bSYour Name 			<legal all>
198*5113495bSYour Name 
199*5113495bSYour Name flush_entire_cache
200*5113495bSYour Name 
201*5113495bSYour Name 			When set, the entire cache shall be flushed. The entire
202*5113495bSYour Name 			cache will also remain blocked, till the
203*5113495bSYour Name 			'REO_UNBLOCK_COMMAND' is received with bit unblock type set
204*5113495bSYour Name 			to unblock_cache. All other fields in this command are to be
205*5113495bSYour Name 			ignored.
206*5113495bSYour Name 
207*5113495bSYour Name 
208*5113495bSYour Name 
209*5113495bSYour Name 			Note that flushing the entire cache has no changes to
210*5113495bSYour Name 			the current settings of the blocking resource settings
211*5113495bSYour Name 
212*5113495bSYour Name 
213*5113495bSYour Name 
214*5113495bSYour Name 			<legal all>
215*5113495bSYour Name 
216*5113495bSYour Name reserved_2b
217*5113495bSYour Name 
218*5113495bSYour Name 			<legal 0>
219*5113495bSYour Name 
220*5113495bSYour Name reserved_3a
221*5113495bSYour Name 
222*5113495bSYour Name 			<legal 0>
223*5113495bSYour Name 
224*5113495bSYour Name reserved_4a
225*5113495bSYour Name 
226*5113495bSYour Name 			<legal 0>
227*5113495bSYour Name 
228*5113495bSYour Name reserved_5a
229*5113495bSYour Name 
230*5113495bSYour Name 			<legal 0>
231*5113495bSYour Name 
232*5113495bSYour Name reserved_6a
233*5113495bSYour Name 
234*5113495bSYour Name 			<legal 0>
235*5113495bSYour Name 
236*5113495bSYour Name reserved_7a
237*5113495bSYour Name 
238*5113495bSYour Name 			<legal 0>
239*5113495bSYour Name 
240*5113495bSYour Name reserved_8a
241*5113495bSYour Name 
242*5113495bSYour Name 			<legal 0>
243*5113495bSYour Name */
244*5113495bSYour Name 
245*5113495bSYour Name 
246*5113495bSYour Name  /* EXTERNAL REFERENCE : struct uniform_reo_cmd_header cmd_header */
247*5113495bSYour Name 
248*5113495bSYour Name 
249*5113495bSYour Name /* Description		REO_FLUSH_CACHE_0_CMD_HEADER_REO_CMD_NUMBER
250*5113495bSYour Name 
251*5113495bSYour Name 			Consumer: REO/SW/DEBUG
252*5113495bSYour Name 
253*5113495bSYour Name 			Producer: SW
254*5113495bSYour Name 
255*5113495bSYour Name 
256*5113495bSYour Name 
257*5113495bSYour Name 			This number can be used by SW to track, identify and
258*5113495bSYour Name 			link the created commands with the command statusses
259*5113495bSYour Name 
260*5113495bSYour Name 
261*5113495bSYour Name 
262*5113495bSYour Name 
263*5113495bSYour Name 
264*5113495bSYour Name 			<legal all>
265*5113495bSYour Name */
266*5113495bSYour Name #define REO_FLUSH_CACHE_0_CMD_HEADER_REO_CMD_NUMBER_OFFSET           0x00000000
267*5113495bSYour Name #define REO_FLUSH_CACHE_0_CMD_HEADER_REO_CMD_NUMBER_LSB              0
268*5113495bSYour Name #define REO_FLUSH_CACHE_0_CMD_HEADER_REO_CMD_NUMBER_MASK             0x0000ffff
269*5113495bSYour Name 
270*5113495bSYour Name /* Description		REO_FLUSH_CACHE_0_CMD_HEADER_REO_STATUS_REQUIRED
271*5113495bSYour Name 
272*5113495bSYour Name 			Consumer: REO
273*5113495bSYour Name 
274*5113495bSYour Name 			Producer: SW
275*5113495bSYour Name 
276*5113495bSYour Name 
277*5113495bSYour Name 
278*5113495bSYour Name 			<enum 0 NoStatus> REO does not need to generate a status
279*5113495bSYour Name 			TLV for the execution of this command
280*5113495bSYour Name 
281*5113495bSYour Name 			<enum 1 StatusRequired> REO shall generate a status TLV
282*5113495bSYour Name 			for the execution of this command
283*5113495bSYour Name 
284*5113495bSYour Name 
285*5113495bSYour Name 
286*5113495bSYour Name 			<legal all>
287*5113495bSYour Name */
288*5113495bSYour Name #define REO_FLUSH_CACHE_0_CMD_HEADER_REO_STATUS_REQUIRED_OFFSET      0x00000000
289*5113495bSYour Name #define REO_FLUSH_CACHE_0_CMD_HEADER_REO_STATUS_REQUIRED_LSB         16
290*5113495bSYour Name #define REO_FLUSH_CACHE_0_CMD_HEADER_REO_STATUS_REQUIRED_MASK        0x00010000
291*5113495bSYour Name 
292*5113495bSYour Name /* Description		REO_FLUSH_CACHE_0_CMD_HEADER_RESERVED_0A
293*5113495bSYour Name 
294*5113495bSYour Name 			<legal 0>
295*5113495bSYour Name */
296*5113495bSYour Name #define REO_FLUSH_CACHE_0_CMD_HEADER_RESERVED_0A_OFFSET              0x00000000
297*5113495bSYour Name #define REO_FLUSH_CACHE_0_CMD_HEADER_RESERVED_0A_LSB                 17
298*5113495bSYour Name #define REO_FLUSH_CACHE_0_CMD_HEADER_RESERVED_0A_MASK                0xfffe0000
299*5113495bSYour Name 
300*5113495bSYour Name /* Description		REO_FLUSH_CACHE_1_FLUSH_ADDR_31_0
301*5113495bSYour Name 
302*5113495bSYour Name 			Consumer: REO
303*5113495bSYour Name 
304*5113495bSYour Name 			Producer: SW
305*5113495bSYour Name 
306*5113495bSYour Name 
307*5113495bSYour Name 
308*5113495bSYour Name 			Address (lower 32 bits) of the descriptor to flush
309*5113495bSYour Name 
310*5113495bSYour Name 			<legal all>
311*5113495bSYour Name */
312*5113495bSYour Name #define REO_FLUSH_CACHE_1_FLUSH_ADDR_31_0_OFFSET                     0x00000004
313*5113495bSYour Name #define REO_FLUSH_CACHE_1_FLUSH_ADDR_31_0_LSB                        0
314*5113495bSYour Name #define REO_FLUSH_CACHE_1_FLUSH_ADDR_31_0_MASK                       0xffffffff
315*5113495bSYour Name 
316*5113495bSYour Name /* Description		REO_FLUSH_CACHE_2_FLUSH_ADDR_39_32
317*5113495bSYour Name 
318*5113495bSYour Name 			Consumer: REO
319*5113495bSYour Name 
320*5113495bSYour Name 			Producer: SW
321*5113495bSYour Name 
322*5113495bSYour Name 
323*5113495bSYour Name 
324*5113495bSYour Name 			Address (upper 8 bits) of the descriptor to flush
325*5113495bSYour Name 
326*5113495bSYour Name 			<legal all>
327*5113495bSYour Name */
328*5113495bSYour Name #define REO_FLUSH_CACHE_2_FLUSH_ADDR_39_32_OFFSET                    0x00000008
329*5113495bSYour Name #define REO_FLUSH_CACHE_2_FLUSH_ADDR_39_32_LSB                       0
330*5113495bSYour Name #define REO_FLUSH_CACHE_2_FLUSH_ADDR_39_32_MASK                      0x000000ff
331*5113495bSYour Name 
332*5113495bSYour Name /* Description		REO_FLUSH_CACHE_2_FORWARD_ALL_MPDUS_IN_QUEUE
333*5113495bSYour Name 
334*5113495bSYour Name 			Is only allowed to be set when the flush address
335*5113495bSYour Name 			corresponds with a REO descriptor.
336*5113495bSYour Name 
337*5113495bSYour Name 
338*5113495bSYour Name 
339*5113495bSYour Name 			When set, REO shall first forward all the MPDUs held in
340*5113495bSYour Name 			the indicated re-order queue, before flushing the descriptor
341*5113495bSYour Name 			from the cache.
342*5113495bSYour Name 
343*5113495bSYour Name 			<legal all>
344*5113495bSYour Name */
345*5113495bSYour Name #define REO_FLUSH_CACHE_2_FORWARD_ALL_MPDUS_IN_QUEUE_OFFSET          0x00000008
346*5113495bSYour Name #define REO_FLUSH_CACHE_2_FORWARD_ALL_MPDUS_IN_QUEUE_LSB             8
347*5113495bSYour Name #define REO_FLUSH_CACHE_2_FORWARD_ALL_MPDUS_IN_QUEUE_MASK            0x00000100
348*5113495bSYour Name 
349*5113495bSYour Name /* Description		REO_FLUSH_CACHE_2_RELEASE_CACHE_BLOCK_INDEX
350*5113495bSYour Name 
351*5113495bSYour Name 			Field not valid when Flush_entire_cache is set.
352*5113495bSYour Name 
353*5113495bSYour Name 
354*5113495bSYour Name 
355*5113495bSYour Name 			If SW has previously used a blocking resource that it
356*5113495bSYour Name 			now wants to re-use for this command, this bit shall be set.
357*5113495bSYour Name 			It prevents SW from having to send a separate
358*5113495bSYour Name 			REO_UNBLOCK_CACHE command.
359*5113495bSYour Name 
360*5113495bSYour Name 
361*5113495bSYour Name 
362*5113495bSYour Name 			When set, HW will first release the blocking resource
363*5113495bSYour Name 			(indicated in field 'Cache_block_resouce_index') before this
364*5113495bSYour Name 			command gets executed.
365*5113495bSYour Name 
366*5113495bSYour Name 			If that resource was already unblocked, this will be
367*5113495bSYour Name 			considered an error. This command will not be executed, and
368*5113495bSYour Name 			an error shall be returned.
369*5113495bSYour Name 
370*5113495bSYour Name 			<legal all>
371*5113495bSYour Name */
372*5113495bSYour Name #define REO_FLUSH_CACHE_2_RELEASE_CACHE_BLOCK_INDEX_OFFSET           0x00000008
373*5113495bSYour Name #define REO_FLUSH_CACHE_2_RELEASE_CACHE_BLOCK_INDEX_LSB              9
374*5113495bSYour Name #define REO_FLUSH_CACHE_2_RELEASE_CACHE_BLOCK_INDEX_MASK             0x00000200
375*5113495bSYour Name 
376*5113495bSYour Name /* Description		REO_FLUSH_CACHE_2_CACHE_BLOCK_RESOURCE_INDEX
377*5113495bSYour Name 
378*5113495bSYour Name 			Field not valid when Flush_entire_cache is set.
379*5113495bSYour Name 
380*5113495bSYour Name 
381*5113495bSYour Name 
382*5113495bSYour Name 			Indicates which of the four blocking resources in REO
383*5113495bSYour Name 			will be assigned for managing the blocking of this
384*5113495bSYour Name 			(descriptor) address
385*5113495bSYour Name 
386*5113495bSYour Name 			<legal all>
387*5113495bSYour Name */
388*5113495bSYour Name #define REO_FLUSH_CACHE_2_CACHE_BLOCK_RESOURCE_INDEX_OFFSET          0x00000008
389*5113495bSYour Name #define REO_FLUSH_CACHE_2_CACHE_BLOCK_RESOURCE_INDEX_LSB             10
390*5113495bSYour Name #define REO_FLUSH_CACHE_2_CACHE_BLOCK_RESOURCE_INDEX_MASK            0x00000c00
391*5113495bSYour Name 
392*5113495bSYour Name /* Description		REO_FLUSH_CACHE_2_FLUSH_WITHOUT_INVALIDATE
393*5113495bSYour Name 
394*5113495bSYour Name 			Field not valid when Flush_entire_cache is set.
395*5113495bSYour Name 
396*5113495bSYour Name 
397*5113495bSYour Name 
398*5113495bSYour Name 			When set, REO shall flush the cache line contents from
399*5113495bSYour Name 			the cache, but there is NO need to invalidate the cache line
400*5113495bSYour Name 			entry... The contents in the cache can be maintained. This
401*5113495bSYour Name 			feature can be used by SW (and DV) to get a current snapshot
402*5113495bSYour Name 			of the contents in the cache
403*5113495bSYour Name 
404*5113495bSYour Name 
405*5113495bSYour Name 
406*5113495bSYour Name 			<legal all>
407*5113495bSYour Name */
408*5113495bSYour Name #define REO_FLUSH_CACHE_2_FLUSH_WITHOUT_INVALIDATE_OFFSET            0x00000008
409*5113495bSYour Name #define REO_FLUSH_CACHE_2_FLUSH_WITHOUT_INVALIDATE_LSB               12
410*5113495bSYour Name #define REO_FLUSH_CACHE_2_FLUSH_WITHOUT_INVALIDATE_MASK              0x00001000
411*5113495bSYour Name 
412*5113495bSYour Name /* Description		REO_FLUSH_CACHE_2_BLOCK_CACHE_USAGE_AFTER_FLUSH
413*5113495bSYour Name 
414*5113495bSYour Name 			Field not valid when Flush_entire_cache is set.
415*5113495bSYour Name 
416*5113495bSYour Name 
417*5113495bSYour Name 
418*5113495bSYour Name 			When set, REO shall block any cache accesses to this
419*5113495bSYour Name 			address till explicitly unblocked.
420*5113495bSYour Name 
421*5113495bSYour Name 
422*5113495bSYour Name 
423*5113495bSYour Name 			Whenever SW sets this bit, SW shall also set bit
424*5113495bSYour Name 			'Forward_all_mpdus_in_queue' to ensure all packets are
425*5113495bSYour Name 			flushed out in order to make sure this queue desc is not in
426*5113495bSYour Name 			one of the aging link lists. In case SW does not want to
427*5113495bSYour Name 			flush the MPDUs in the queue, see the recipe description
428*5113495bSYour Name 			below this TLV definition.
429*5113495bSYour Name 
430*5113495bSYour Name 
431*5113495bSYour Name 
432*5113495bSYour Name 			The 'blocking' index to be used for this is indicated in
433*5113495bSYour Name 			field 'cache_block_resource_index'. If SW had previously
434*5113495bSYour Name 			used this blocking resource and was not freed up yet, SW
435*5113495bSYour Name 			shall first unblock that index (by setting bit
436*5113495bSYour Name 			Release_cache_block_index) or use an unblock command.
437*5113495bSYour Name 
438*5113495bSYour Name 
439*5113495bSYour Name 
440*5113495bSYour Name 			If the resource indicated here was already blocked (and
441*5113495bSYour Name 			did not get unblocked in this command), it is considered an
442*5113495bSYour Name 			error scenario...
443*5113495bSYour Name 
444*5113495bSYour Name 			No flush shall happen. The status for this command shall
445*5113495bSYour Name 			indicate error.
446*5113495bSYour Name 
447*5113495bSYour Name 
448*5113495bSYour Name 
449*5113495bSYour Name 			<legal all>
450*5113495bSYour Name */
451*5113495bSYour Name #define REO_FLUSH_CACHE_2_BLOCK_CACHE_USAGE_AFTER_FLUSH_OFFSET       0x00000008
452*5113495bSYour Name #define REO_FLUSH_CACHE_2_BLOCK_CACHE_USAGE_AFTER_FLUSH_LSB          13
453*5113495bSYour Name #define REO_FLUSH_CACHE_2_BLOCK_CACHE_USAGE_AFTER_FLUSH_MASK         0x00002000
454*5113495bSYour Name 
455*5113495bSYour Name /* Description		REO_FLUSH_CACHE_2_FLUSH_ENTIRE_CACHE
456*5113495bSYour Name 
457*5113495bSYour Name 			When set, the entire cache shall be flushed. The entire
458*5113495bSYour Name 			cache will also remain blocked, till the
459*5113495bSYour Name 			'REO_UNBLOCK_COMMAND' is received with bit unblock type set
460*5113495bSYour Name 			to unblock_cache. All other fields in this command are to be
461*5113495bSYour Name 			ignored.
462*5113495bSYour Name 
463*5113495bSYour Name 
464*5113495bSYour Name 
465*5113495bSYour Name 			Note that flushing the entire cache has no changes to
466*5113495bSYour Name 			the current settings of the blocking resource settings
467*5113495bSYour Name 
468*5113495bSYour Name 
469*5113495bSYour Name 
470*5113495bSYour Name 			<legal all>
471*5113495bSYour Name */
472*5113495bSYour Name #define REO_FLUSH_CACHE_2_FLUSH_ENTIRE_CACHE_OFFSET                  0x00000008
473*5113495bSYour Name #define REO_FLUSH_CACHE_2_FLUSH_ENTIRE_CACHE_LSB                     14
474*5113495bSYour Name #define REO_FLUSH_CACHE_2_FLUSH_ENTIRE_CACHE_MASK                    0x00004000
475*5113495bSYour Name 
476*5113495bSYour Name /* Description		REO_FLUSH_CACHE_2_RESERVED_2B
477*5113495bSYour Name 
478*5113495bSYour Name 			<legal 0>
479*5113495bSYour Name */
480*5113495bSYour Name #define REO_FLUSH_CACHE_2_RESERVED_2B_OFFSET                         0x00000008
481*5113495bSYour Name #define REO_FLUSH_CACHE_2_RESERVED_2B_LSB                            15
482*5113495bSYour Name #define REO_FLUSH_CACHE_2_RESERVED_2B_MASK                           0xffff8000
483*5113495bSYour Name 
484*5113495bSYour Name /* Description		REO_FLUSH_CACHE_3_RESERVED_3A
485*5113495bSYour Name 
486*5113495bSYour Name 			<legal 0>
487*5113495bSYour Name */
488*5113495bSYour Name #define REO_FLUSH_CACHE_3_RESERVED_3A_OFFSET                         0x0000000c
489*5113495bSYour Name #define REO_FLUSH_CACHE_3_RESERVED_3A_LSB                            0
490*5113495bSYour Name #define REO_FLUSH_CACHE_3_RESERVED_3A_MASK                           0xffffffff
491*5113495bSYour Name 
492*5113495bSYour Name /* Description		REO_FLUSH_CACHE_4_RESERVED_4A
493*5113495bSYour Name 
494*5113495bSYour Name 			<legal 0>
495*5113495bSYour Name */
496*5113495bSYour Name #define REO_FLUSH_CACHE_4_RESERVED_4A_OFFSET                         0x00000010
497*5113495bSYour Name #define REO_FLUSH_CACHE_4_RESERVED_4A_LSB                            0
498*5113495bSYour Name #define REO_FLUSH_CACHE_4_RESERVED_4A_MASK                           0xffffffff
499*5113495bSYour Name 
500*5113495bSYour Name /* Description		REO_FLUSH_CACHE_5_RESERVED_5A
501*5113495bSYour Name 
502*5113495bSYour Name 			<legal 0>
503*5113495bSYour Name */
504*5113495bSYour Name #define REO_FLUSH_CACHE_5_RESERVED_5A_OFFSET                         0x00000014
505*5113495bSYour Name #define REO_FLUSH_CACHE_5_RESERVED_5A_LSB                            0
506*5113495bSYour Name #define REO_FLUSH_CACHE_5_RESERVED_5A_MASK                           0xffffffff
507*5113495bSYour Name 
508*5113495bSYour Name /* Description		REO_FLUSH_CACHE_6_RESERVED_6A
509*5113495bSYour Name 
510*5113495bSYour Name 			<legal 0>
511*5113495bSYour Name */
512*5113495bSYour Name #define REO_FLUSH_CACHE_6_RESERVED_6A_OFFSET                         0x00000018
513*5113495bSYour Name #define REO_FLUSH_CACHE_6_RESERVED_6A_LSB                            0
514*5113495bSYour Name #define REO_FLUSH_CACHE_6_RESERVED_6A_MASK                           0xffffffff
515*5113495bSYour Name 
516*5113495bSYour Name /* Description		REO_FLUSH_CACHE_7_RESERVED_7A
517*5113495bSYour Name 
518*5113495bSYour Name 			<legal 0>
519*5113495bSYour Name */
520*5113495bSYour Name #define REO_FLUSH_CACHE_7_RESERVED_7A_OFFSET                         0x0000001c
521*5113495bSYour Name #define REO_FLUSH_CACHE_7_RESERVED_7A_LSB                            0
522*5113495bSYour Name #define REO_FLUSH_CACHE_7_RESERVED_7A_MASK                           0xffffffff
523*5113495bSYour Name 
524*5113495bSYour Name /* Description		REO_FLUSH_CACHE_8_RESERVED_8A
525*5113495bSYour Name 
526*5113495bSYour Name 			<legal 0>
527*5113495bSYour Name */
528*5113495bSYour Name #define REO_FLUSH_CACHE_8_RESERVED_8A_OFFSET                         0x00000020
529*5113495bSYour Name #define REO_FLUSH_CACHE_8_RESERVED_8A_LSB                            0
530*5113495bSYour Name #define REO_FLUSH_CACHE_8_RESERVED_8A_MASK                           0xffffffff
531*5113495bSYour Name 
532*5113495bSYour Name 
533*5113495bSYour Name #endif // _REO_FLUSH_CACHE_H_
534