xref: /wlan-driver/fw-api/hw/qca6490/v1/reo_flush_timeout_list.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2019 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_FLUSH_TIMEOUT_LIST_H_
25*5113495bSYour Name #define _REO_FLUSH_TIMEOUT_LIST_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	ac_timout_list[1:0], reserved_1[31:2]
36*5113495bSYour Name //	2	minimum_release_desc_count[15:0], minimum_forward_buf_count[31:16]
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_FLUSH_TIMEOUT_LIST 9
47*5113495bSYour Name 
48*5113495bSYour Name struct reo_flush_timeout_list {
49*5113495bSYour Name     struct            uniform_reo_cmd_header                       cmd_header;
50*5113495bSYour Name              uint32_t ac_timout_list                  :  2, //[1:0]
51*5113495bSYour Name                       reserved_1                      : 30; //[31:2]
52*5113495bSYour Name              uint32_t minimum_release_desc_count      : 16, //[15:0]
53*5113495bSYour Name                       minimum_forward_buf_count       : 16; //[31:16]
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 ac_timout_list
75*5113495bSYour Name 
76*5113495bSYour Name 			Consumer: REO
77*5113495bSYour Name 
78*5113495bSYour Name 			Producer: SW
79*5113495bSYour Name 
80*5113495bSYour Name 
81*5113495bSYour Name 
82*5113495bSYour Name 			The AC_timeout list to be used for this command
83*5113495bSYour Name 
84*5113495bSYour Name 			<legal all>
85*5113495bSYour Name 
86*5113495bSYour Name reserved_1
87*5113495bSYour Name 
88*5113495bSYour Name 			<legal 0>
89*5113495bSYour Name 
90*5113495bSYour Name minimum_release_desc_count
91*5113495bSYour Name 
92*5113495bSYour Name 			Consumer: REO
93*5113495bSYour Name 
94*5113495bSYour Name 			Producer: SW
95*5113495bSYour Name 
96*5113495bSYour Name 
97*5113495bSYour Name 
98*5113495bSYour Name 			The minimum number of link descriptors requested to be
99*5113495bSYour Name 			released. If set to 0, only buffer release counts seems to
100*5113495bSYour Name 			be important... When set to very high value, likely the
101*5113495bSYour Name 			entire timeout list will be exhausted before this count is
102*5113495bSYour Name 			reached or maybe this count will not get reached. REO
103*5113495bSYour Name 			however will stop here as it can not do anything else.
104*5113495bSYour Name 
105*5113495bSYour Name 
106*5113495bSYour Name 
107*5113495bSYour Name 			When both this field and field Minimum_forward_buf_count
108*5113495bSYour Name 			are > 0, REO needs to meet both requirements. When both
109*5113495bSYour Name 			entries are 0 (which should be a programming error), REO
110*5113495bSYour Name 			does not need to do anything.
111*5113495bSYour Name 
112*5113495bSYour Name 
113*5113495bSYour Name 
114*5113495bSYour Name 			Note that this includes counts of MPDU link Desc as well
115*5113495bSYour Name 			as MSDU link Desc. Where the count of MSDU link Desc is not
116*5113495bSYour Name 			known to REO it's approximated by deriving from MSDU count
117*5113495bSYour Name 
118*5113495bSYour Name 			<legal all>
119*5113495bSYour Name 
120*5113495bSYour Name minimum_forward_buf_count
121*5113495bSYour Name 
122*5113495bSYour Name 			Consumer: REO
123*5113495bSYour Name 
124*5113495bSYour Name 			Producer: SW
125*5113495bSYour Name 
126*5113495bSYour Name 
127*5113495bSYour Name 
128*5113495bSYour Name 			The minimum number of buffer descriptors requested to be
129*5113495bSYour Name 			passed on to the REO destination rings.
130*5113495bSYour Name 
131*5113495bSYour Name 
132*5113495bSYour Name 
133*5113495bSYour Name 			If set to 0, only descriptor release counts seems to be
134*5113495bSYour Name 			important...
135*5113495bSYour Name 
136*5113495bSYour Name 
137*5113495bSYour Name 
138*5113495bSYour Name 			When set to very high value, likely the entire timeout
139*5113495bSYour Name 			list will be exhausted before this count is reached or maybe
140*5113495bSYour Name 			this count will not get reached. REO however will stop here
141*5113495bSYour Name 			as it can not do anything else.
142*5113495bSYour Name 
143*5113495bSYour Name 
144*5113495bSYour Name 
145*5113495bSYour Name 			Note that REO does not know the exact buffer count. This
146*5113495bSYour Name 			can be approximated by using the MSDU_COUNT
147*5113495bSYour Name 
148*5113495bSYour Name 			<legal all>
149*5113495bSYour Name 
150*5113495bSYour Name reserved_3a
151*5113495bSYour Name 
152*5113495bSYour Name 			<legal 0>
153*5113495bSYour Name 
154*5113495bSYour Name reserved_4a
155*5113495bSYour Name 
156*5113495bSYour Name 			<legal 0>
157*5113495bSYour Name 
158*5113495bSYour Name reserved_5a
159*5113495bSYour Name 
160*5113495bSYour Name 			<legal 0>
161*5113495bSYour Name 
162*5113495bSYour Name reserved_6a
163*5113495bSYour Name 
164*5113495bSYour Name 			<legal 0>
165*5113495bSYour Name 
166*5113495bSYour Name reserved_7a
167*5113495bSYour Name 
168*5113495bSYour Name 			<legal 0>
169*5113495bSYour Name 
170*5113495bSYour Name reserved_8a
171*5113495bSYour Name 
172*5113495bSYour Name 			<legal 0>
173*5113495bSYour Name */
174*5113495bSYour Name 
175*5113495bSYour Name 
176*5113495bSYour Name  /* EXTERNAL REFERENCE : struct uniform_reo_cmd_header cmd_header */
177*5113495bSYour Name 
178*5113495bSYour Name 
179*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_0_CMD_HEADER_REO_CMD_NUMBER
180*5113495bSYour Name 
181*5113495bSYour Name 			Consumer: REO/SW/DEBUG
182*5113495bSYour Name 
183*5113495bSYour Name 			Producer: SW
184*5113495bSYour Name 
185*5113495bSYour Name 
186*5113495bSYour Name 
187*5113495bSYour Name 			This number can be used by SW to track, identify and
188*5113495bSYour Name 			link the created commands with the command statusses
189*5113495bSYour Name 
190*5113495bSYour Name 
191*5113495bSYour Name 
192*5113495bSYour Name 
193*5113495bSYour Name 
194*5113495bSYour Name 			<legal all>
195*5113495bSYour Name */
196*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_0_CMD_HEADER_REO_CMD_NUMBER_OFFSET    0x00000000
197*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_0_CMD_HEADER_REO_CMD_NUMBER_LSB       0
198*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_0_CMD_HEADER_REO_CMD_NUMBER_MASK      0x0000ffff
199*5113495bSYour Name 
200*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_0_CMD_HEADER_REO_STATUS_REQUIRED
201*5113495bSYour Name 
202*5113495bSYour Name 			Consumer: REO
203*5113495bSYour Name 
204*5113495bSYour Name 			Producer: SW
205*5113495bSYour Name 
206*5113495bSYour Name 
207*5113495bSYour Name 
208*5113495bSYour Name 			<enum 0 NoStatus> REO does not need to generate a status
209*5113495bSYour Name 			TLV for the execution of this command
210*5113495bSYour Name 
211*5113495bSYour Name 			<enum 1 StatusRequired> REO shall generate a status TLV
212*5113495bSYour Name 			for the execution of this command
213*5113495bSYour Name 
214*5113495bSYour Name 
215*5113495bSYour Name 
216*5113495bSYour Name 			<legal all>
217*5113495bSYour Name */
218*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_0_CMD_HEADER_REO_STATUS_REQUIRED_OFFSET 0x00000000
219*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_0_CMD_HEADER_REO_STATUS_REQUIRED_LSB  16
220*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_0_CMD_HEADER_REO_STATUS_REQUIRED_MASK 0x00010000
221*5113495bSYour Name 
222*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_0_CMD_HEADER_RESERVED_0A
223*5113495bSYour Name 
224*5113495bSYour Name 			<legal 0>
225*5113495bSYour Name */
226*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_0_CMD_HEADER_RESERVED_0A_OFFSET       0x00000000
227*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_0_CMD_HEADER_RESERVED_0A_LSB          17
228*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_0_CMD_HEADER_RESERVED_0A_MASK         0xfffe0000
229*5113495bSYour Name 
230*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_1_AC_TIMOUT_LIST
231*5113495bSYour Name 
232*5113495bSYour Name 			Consumer: REO
233*5113495bSYour Name 
234*5113495bSYour Name 			Producer: SW
235*5113495bSYour Name 
236*5113495bSYour Name 
237*5113495bSYour Name 
238*5113495bSYour Name 			The AC_timeout list to be used for this command
239*5113495bSYour Name 
240*5113495bSYour Name 			<legal all>
241*5113495bSYour Name */
242*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_1_AC_TIMOUT_LIST_OFFSET               0x00000004
243*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_1_AC_TIMOUT_LIST_LSB                  0
244*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_1_AC_TIMOUT_LIST_MASK                 0x00000003
245*5113495bSYour Name 
246*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_1_RESERVED_1
247*5113495bSYour Name 
248*5113495bSYour Name 			<legal 0>
249*5113495bSYour Name */
250*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_1_RESERVED_1_OFFSET                   0x00000004
251*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_1_RESERVED_1_LSB                      2
252*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_1_RESERVED_1_MASK                     0xfffffffc
253*5113495bSYour Name 
254*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_RELEASE_DESC_COUNT
255*5113495bSYour Name 
256*5113495bSYour Name 			Consumer: REO
257*5113495bSYour Name 
258*5113495bSYour Name 			Producer: SW
259*5113495bSYour Name 
260*5113495bSYour Name 
261*5113495bSYour Name 
262*5113495bSYour Name 			The minimum number of link descriptors requested to be
263*5113495bSYour Name 			released. If set to 0, only buffer release counts seems to
264*5113495bSYour Name 			be important... When set to very high value, likely the
265*5113495bSYour Name 			entire timeout list will be exhausted before this count is
266*5113495bSYour Name 			reached or maybe this count will not get reached. REO
267*5113495bSYour Name 			however will stop here as it can not do anything else.
268*5113495bSYour Name 
269*5113495bSYour Name 
270*5113495bSYour Name 
271*5113495bSYour Name 			When both this field and field Minimum_forward_buf_count
272*5113495bSYour Name 			are > 0, REO needs to meet both requirements. When both
273*5113495bSYour Name 			entries are 0 (which should be a programming error), REO
274*5113495bSYour Name 			does not need to do anything.
275*5113495bSYour Name 
276*5113495bSYour Name 
277*5113495bSYour Name 
278*5113495bSYour Name 			Note that this includes counts of MPDU link Desc as well
279*5113495bSYour Name 			as MSDU link Desc. Where the count of MSDU link Desc is not
280*5113495bSYour Name 			known to REO it's approximated by deriving from MSDU count
281*5113495bSYour Name 
282*5113495bSYour Name 			<legal all>
283*5113495bSYour Name */
284*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_RELEASE_DESC_COUNT_OFFSET   0x00000008
285*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_RELEASE_DESC_COUNT_LSB      0
286*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_RELEASE_DESC_COUNT_MASK     0x0000ffff
287*5113495bSYour Name 
288*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_FORWARD_BUF_COUNT
289*5113495bSYour Name 
290*5113495bSYour Name 			Consumer: REO
291*5113495bSYour Name 
292*5113495bSYour Name 			Producer: SW
293*5113495bSYour Name 
294*5113495bSYour Name 
295*5113495bSYour Name 
296*5113495bSYour Name 			The minimum number of buffer descriptors requested to be
297*5113495bSYour Name 			passed on to the REO destination rings.
298*5113495bSYour Name 
299*5113495bSYour Name 
300*5113495bSYour Name 
301*5113495bSYour Name 			If set to 0, only descriptor release counts seems to be
302*5113495bSYour Name 			important...
303*5113495bSYour Name 
304*5113495bSYour Name 
305*5113495bSYour Name 
306*5113495bSYour Name 			When set to very high value, likely the entire timeout
307*5113495bSYour Name 			list will be exhausted before this count is reached or maybe
308*5113495bSYour Name 			this count will not get reached. REO however will stop here
309*5113495bSYour Name 			as it can not do anything else.
310*5113495bSYour Name 
311*5113495bSYour Name 
312*5113495bSYour Name 
313*5113495bSYour Name 			Note that REO does not know the exact buffer count. This
314*5113495bSYour Name 			can be approximated by using the MSDU_COUNT
315*5113495bSYour Name 
316*5113495bSYour Name 			<legal all>
317*5113495bSYour Name */
318*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_FORWARD_BUF_COUNT_OFFSET    0x00000008
319*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_FORWARD_BUF_COUNT_LSB       16
320*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_FORWARD_BUF_COUNT_MASK      0xffff0000
321*5113495bSYour Name 
322*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_3_RESERVED_3A
323*5113495bSYour Name 
324*5113495bSYour Name 			<legal 0>
325*5113495bSYour Name */
326*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_3_RESERVED_3A_OFFSET                  0x0000000c
327*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_3_RESERVED_3A_LSB                     0
328*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_3_RESERVED_3A_MASK                    0xffffffff
329*5113495bSYour Name 
330*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_4_RESERVED_4A
331*5113495bSYour Name 
332*5113495bSYour Name 			<legal 0>
333*5113495bSYour Name */
334*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_4_RESERVED_4A_OFFSET                  0x00000010
335*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_4_RESERVED_4A_LSB                     0
336*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_4_RESERVED_4A_MASK                    0xffffffff
337*5113495bSYour Name 
338*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_5_RESERVED_5A
339*5113495bSYour Name 
340*5113495bSYour Name 			<legal 0>
341*5113495bSYour Name */
342*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_5_RESERVED_5A_OFFSET                  0x00000014
343*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_5_RESERVED_5A_LSB                     0
344*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_5_RESERVED_5A_MASK                    0xffffffff
345*5113495bSYour Name 
346*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_6_RESERVED_6A
347*5113495bSYour Name 
348*5113495bSYour Name 			<legal 0>
349*5113495bSYour Name */
350*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_6_RESERVED_6A_OFFSET                  0x00000018
351*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_6_RESERVED_6A_LSB                     0
352*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_6_RESERVED_6A_MASK                    0xffffffff
353*5113495bSYour Name 
354*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_7_RESERVED_7A
355*5113495bSYour Name 
356*5113495bSYour Name 			<legal 0>
357*5113495bSYour Name */
358*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_7_RESERVED_7A_OFFSET                  0x0000001c
359*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_7_RESERVED_7A_LSB                     0
360*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_7_RESERVED_7A_MASK                    0xffffffff
361*5113495bSYour Name 
362*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_8_RESERVED_8A
363*5113495bSYour Name 
364*5113495bSYour Name 			<legal 0>
365*5113495bSYour Name */
366*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_8_RESERVED_8A_OFFSET                  0x00000020
367*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_8_RESERVED_8A_LSB                     0
368*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_8_RESERVED_8A_MASK                    0xffffffff
369*5113495bSYour Name 
370*5113495bSYour Name 
371*5113495bSYour Name #endif // _REO_FLUSH_TIMEOUT_LIST_H_
372