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