xref: /wlan-driver/fw-api/hw/qca6390/v1/reo_flush_timeout_list.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2018 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 #ifndef _REO_FLUSH_TIMEOUT_LIST_H_
20*5113495bSYour Name #define _REO_FLUSH_TIMEOUT_LIST_H_
21*5113495bSYour Name #if !defined(__ASSEMBLER__)
22*5113495bSYour Name #endif
23*5113495bSYour Name 
24*5113495bSYour Name #include "uniform_reo_cmd_header.h"
25*5113495bSYour Name 
26*5113495bSYour Name // ################ START SUMMARY #################
27*5113495bSYour Name //
28*5113495bSYour Name //	Dword	Fields
29*5113495bSYour Name //	0	struct uniform_reo_cmd_header cmd_header;
30*5113495bSYour Name //	1	ac_timout_list[1:0], reserved_1[31:2]
31*5113495bSYour Name //	2	minimum_release_desc_count[15:0], minimum_forward_buf_count[31:16]
32*5113495bSYour Name //	3	reserved_3a[31:0]
33*5113495bSYour Name //	4	reserved_4a[31:0]
34*5113495bSYour Name //	5	reserved_5a[31:0]
35*5113495bSYour Name //	6	reserved_6a[31:0]
36*5113495bSYour Name //	7	reserved_7a[31:0]
37*5113495bSYour Name //	8	reserved_8a[31:0]
38*5113495bSYour Name //
39*5113495bSYour Name // ################ END SUMMARY #################
40*5113495bSYour Name 
41*5113495bSYour Name #define NUM_OF_DWORDS_REO_FLUSH_TIMEOUT_LIST 9
42*5113495bSYour Name 
43*5113495bSYour Name struct reo_flush_timeout_list {
44*5113495bSYour Name     struct            uniform_reo_cmd_header                       cmd_header;
45*5113495bSYour Name              uint32_t ac_timout_list                  :  2, //[1:0]
46*5113495bSYour Name                       reserved_1                      : 30; //[31:2]
47*5113495bSYour Name              uint32_t minimum_release_desc_count      : 16, //[15:0]
48*5113495bSYour Name                       minimum_forward_buf_count       : 16; //[31:16]
49*5113495bSYour Name              uint32_t reserved_3a                     : 32; //[31:0]
50*5113495bSYour Name              uint32_t reserved_4a                     : 32; //[31:0]
51*5113495bSYour Name              uint32_t reserved_5a                     : 32; //[31:0]
52*5113495bSYour Name              uint32_t reserved_6a                     : 32; //[31:0]
53*5113495bSYour Name              uint32_t reserved_7a                     : 32; //[31:0]
54*5113495bSYour Name              uint32_t reserved_8a                     : 32; //[31:0]
55*5113495bSYour Name };
56*5113495bSYour Name 
57*5113495bSYour Name /*
58*5113495bSYour Name 
59*5113495bSYour Name struct uniform_reo_cmd_header cmd_header
60*5113495bSYour Name 
61*5113495bSYour Name 			Consumer: REO
62*5113495bSYour Name 
63*5113495bSYour Name 			Producer: SW
64*5113495bSYour Name 
65*5113495bSYour Name 
66*5113495bSYour Name 
67*5113495bSYour Name 			Details for command execution tracking purposes.
68*5113495bSYour Name 
69*5113495bSYour Name ac_timout_list
70*5113495bSYour Name 
71*5113495bSYour Name 			Consumer: REO
72*5113495bSYour Name 
73*5113495bSYour Name 			Producer: SW
74*5113495bSYour Name 
75*5113495bSYour Name 
76*5113495bSYour Name 
77*5113495bSYour Name 			The AC_timeout list to be used for this command
78*5113495bSYour Name 
79*5113495bSYour Name 			<legal all>
80*5113495bSYour Name 
81*5113495bSYour Name reserved_1
82*5113495bSYour Name 
83*5113495bSYour Name 			<legal 0>
84*5113495bSYour Name 
85*5113495bSYour Name minimum_release_desc_count
86*5113495bSYour Name 
87*5113495bSYour Name 			Consumer: REO
88*5113495bSYour Name 
89*5113495bSYour Name 			Producer: SW
90*5113495bSYour Name 
91*5113495bSYour Name 
92*5113495bSYour Name 
93*5113495bSYour Name 			The minimum number of link descriptors requested to be
94*5113495bSYour Name 			released. If set to 0, only buffer release counts seems to
95*5113495bSYour Name 			be important... When set to very high value, likely the
96*5113495bSYour Name 			entire timeout list will be exhausted before this count is
97*5113495bSYour Name 			reached or maybe this count will not get reached. REO
98*5113495bSYour Name 			however will stop here as it can not do anything else.
99*5113495bSYour Name 
100*5113495bSYour Name 
101*5113495bSYour Name 
102*5113495bSYour Name 			When both this field and field Minimum_forward_buf_count
103*5113495bSYour Name 			are > 0, REO needs to meet both requirements. When both
104*5113495bSYour Name 			entries are 0 (which should be a programming error), REO
105*5113495bSYour Name 			does not need to do anything.
106*5113495bSYour Name 
107*5113495bSYour Name 
108*5113495bSYour Name 
109*5113495bSYour Name 			Note that this includes counts of MPDU link Desc as well
110*5113495bSYour Name 			as MSDU link Desc. Where the count of MSDU link Desc is not
111*5113495bSYour Name 			known to REO it's approximated by deriving from MSDU count
112*5113495bSYour Name 
113*5113495bSYour Name 			<legal all>
114*5113495bSYour Name 
115*5113495bSYour Name minimum_forward_buf_count
116*5113495bSYour Name 
117*5113495bSYour Name 			Consumer: REO
118*5113495bSYour Name 
119*5113495bSYour Name 			Producer: SW
120*5113495bSYour Name 
121*5113495bSYour Name 
122*5113495bSYour Name 
123*5113495bSYour Name 			The minimum number of buffer descriptors requested to be
124*5113495bSYour Name 			passed on to the REO destination rings.
125*5113495bSYour Name 
126*5113495bSYour Name 
127*5113495bSYour Name 
128*5113495bSYour Name 			If set to 0, only descriptor release counts seems to be
129*5113495bSYour Name 			important...
130*5113495bSYour Name 
131*5113495bSYour Name 
132*5113495bSYour Name 
133*5113495bSYour Name 			When set to very high value, likely the entire timeout
134*5113495bSYour Name 			list will be exhausted before this count is reached or maybe
135*5113495bSYour Name 			this count will not get reached. REO however will stop here
136*5113495bSYour Name 			as it can not do anything else.
137*5113495bSYour Name 
138*5113495bSYour Name 
139*5113495bSYour Name 
140*5113495bSYour Name 			Note that REO does not know the exact buffer count. This
141*5113495bSYour Name 			can be approximated by using the MSDU_COUNT
142*5113495bSYour Name 
143*5113495bSYour Name 			<legal all>
144*5113495bSYour Name 
145*5113495bSYour Name reserved_3a
146*5113495bSYour Name 
147*5113495bSYour Name 			<legal 0>
148*5113495bSYour Name 
149*5113495bSYour Name reserved_4a
150*5113495bSYour Name 
151*5113495bSYour Name 			<legal 0>
152*5113495bSYour Name 
153*5113495bSYour Name reserved_5a
154*5113495bSYour Name 
155*5113495bSYour Name 			<legal 0>
156*5113495bSYour Name 
157*5113495bSYour Name reserved_6a
158*5113495bSYour Name 
159*5113495bSYour Name 			<legal 0>
160*5113495bSYour Name 
161*5113495bSYour Name reserved_7a
162*5113495bSYour Name 
163*5113495bSYour Name 			<legal 0>
164*5113495bSYour Name 
165*5113495bSYour Name reserved_8a
166*5113495bSYour Name 
167*5113495bSYour Name 			<legal 0>
168*5113495bSYour Name */
169*5113495bSYour Name 
170*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_0_UNIFORM_REO_CMD_HEADER_CMD_HEADER_OFFSET 0x00000000
171*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_0_UNIFORM_REO_CMD_HEADER_CMD_HEADER_LSB 0
172*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_0_UNIFORM_REO_CMD_HEADER_CMD_HEADER_MASK 0xffffffff
173*5113495bSYour Name 
174*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_1_AC_TIMOUT_LIST
175*5113495bSYour Name 
176*5113495bSYour Name 			Consumer: REO
177*5113495bSYour Name 
178*5113495bSYour Name 			Producer: SW
179*5113495bSYour Name 
180*5113495bSYour Name 
181*5113495bSYour Name 
182*5113495bSYour Name 			The AC_timeout list to be used for this command
183*5113495bSYour Name 
184*5113495bSYour Name 			<legal all>
185*5113495bSYour Name */
186*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_1_AC_TIMOUT_LIST_OFFSET               0x00000004
187*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_1_AC_TIMOUT_LIST_LSB                  0
188*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_1_AC_TIMOUT_LIST_MASK                 0x00000003
189*5113495bSYour Name 
190*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_1_RESERVED_1
191*5113495bSYour Name 
192*5113495bSYour Name 			<legal 0>
193*5113495bSYour Name */
194*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_1_RESERVED_1_OFFSET                   0x00000004
195*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_1_RESERVED_1_LSB                      2
196*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_1_RESERVED_1_MASK                     0xfffffffc
197*5113495bSYour Name 
198*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_RELEASE_DESC_COUNT
199*5113495bSYour Name 
200*5113495bSYour Name 			Consumer: REO
201*5113495bSYour Name 
202*5113495bSYour Name 			Producer: SW
203*5113495bSYour Name 
204*5113495bSYour Name 
205*5113495bSYour Name 
206*5113495bSYour Name 			The minimum number of link descriptors requested to be
207*5113495bSYour Name 			released. If set to 0, only buffer release counts seems to
208*5113495bSYour Name 			be important... When set to very high value, likely the
209*5113495bSYour Name 			entire timeout list will be exhausted before this count is
210*5113495bSYour Name 			reached or maybe this count will not get reached. REO
211*5113495bSYour Name 			however will stop here as it can not do anything else.
212*5113495bSYour Name 
213*5113495bSYour Name 
214*5113495bSYour Name 
215*5113495bSYour Name 			When both this field and field Minimum_forward_buf_count
216*5113495bSYour Name 			are > 0, REO needs to meet both requirements. When both
217*5113495bSYour Name 			entries are 0 (which should be a programming error), REO
218*5113495bSYour Name 			does not need to do anything.
219*5113495bSYour Name 
220*5113495bSYour Name 
221*5113495bSYour Name 
222*5113495bSYour Name 			Note that this includes counts of MPDU link Desc as well
223*5113495bSYour Name 			as MSDU link Desc. Where the count of MSDU link Desc is not
224*5113495bSYour Name 			known to REO it's approximated by deriving from MSDU count
225*5113495bSYour Name 
226*5113495bSYour Name 			<legal all>
227*5113495bSYour Name */
228*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_RELEASE_DESC_COUNT_OFFSET   0x00000008
229*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_RELEASE_DESC_COUNT_LSB      0
230*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_RELEASE_DESC_COUNT_MASK     0x0000ffff
231*5113495bSYour Name 
232*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_FORWARD_BUF_COUNT
233*5113495bSYour Name 
234*5113495bSYour Name 			Consumer: REO
235*5113495bSYour Name 
236*5113495bSYour Name 			Producer: SW
237*5113495bSYour Name 
238*5113495bSYour Name 
239*5113495bSYour Name 
240*5113495bSYour Name 			The minimum number of buffer descriptors requested to be
241*5113495bSYour Name 			passed on to the REO destination rings.
242*5113495bSYour Name 
243*5113495bSYour Name 
244*5113495bSYour Name 
245*5113495bSYour Name 			If set to 0, only descriptor release counts seems to be
246*5113495bSYour Name 			important...
247*5113495bSYour Name 
248*5113495bSYour Name 
249*5113495bSYour Name 
250*5113495bSYour Name 			When set to very high value, likely the entire timeout
251*5113495bSYour Name 			list will be exhausted before this count is reached or maybe
252*5113495bSYour Name 			this count will not get reached. REO however will stop here
253*5113495bSYour Name 			as it can not do anything else.
254*5113495bSYour Name 
255*5113495bSYour Name 
256*5113495bSYour Name 
257*5113495bSYour Name 			Note that REO does not know the exact buffer count. This
258*5113495bSYour Name 			can be approximated by using the MSDU_COUNT
259*5113495bSYour Name 
260*5113495bSYour Name 			<legal all>
261*5113495bSYour Name */
262*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_FORWARD_BUF_COUNT_OFFSET    0x00000008
263*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_FORWARD_BUF_COUNT_LSB       16
264*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_2_MINIMUM_FORWARD_BUF_COUNT_MASK      0xffff0000
265*5113495bSYour Name 
266*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_3_RESERVED_3A
267*5113495bSYour Name 
268*5113495bSYour Name 			<legal 0>
269*5113495bSYour Name */
270*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_3_RESERVED_3A_OFFSET                  0x0000000c
271*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_3_RESERVED_3A_LSB                     0
272*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_3_RESERVED_3A_MASK                    0xffffffff
273*5113495bSYour Name 
274*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_4_RESERVED_4A
275*5113495bSYour Name 
276*5113495bSYour Name 			<legal 0>
277*5113495bSYour Name */
278*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_4_RESERVED_4A_OFFSET                  0x00000010
279*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_4_RESERVED_4A_LSB                     0
280*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_4_RESERVED_4A_MASK                    0xffffffff
281*5113495bSYour Name 
282*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_5_RESERVED_5A
283*5113495bSYour Name 
284*5113495bSYour Name 			<legal 0>
285*5113495bSYour Name */
286*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_5_RESERVED_5A_OFFSET                  0x00000014
287*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_5_RESERVED_5A_LSB                     0
288*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_5_RESERVED_5A_MASK                    0xffffffff
289*5113495bSYour Name 
290*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_6_RESERVED_6A
291*5113495bSYour Name 
292*5113495bSYour Name 			<legal 0>
293*5113495bSYour Name */
294*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_6_RESERVED_6A_OFFSET                  0x00000018
295*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_6_RESERVED_6A_LSB                     0
296*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_6_RESERVED_6A_MASK                    0xffffffff
297*5113495bSYour Name 
298*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_7_RESERVED_7A
299*5113495bSYour Name 
300*5113495bSYour Name 			<legal 0>
301*5113495bSYour Name */
302*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_7_RESERVED_7A_OFFSET                  0x0000001c
303*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_7_RESERVED_7A_LSB                     0
304*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_7_RESERVED_7A_MASK                    0xffffffff
305*5113495bSYour Name 
306*5113495bSYour Name /* Description		REO_FLUSH_TIMEOUT_LIST_8_RESERVED_8A
307*5113495bSYour Name 
308*5113495bSYour Name 			<legal 0>
309*5113495bSYour Name */
310*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_8_RESERVED_8A_OFFSET                  0x00000020
311*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_8_RESERVED_8A_LSB                     0
312*5113495bSYour Name #define REO_FLUSH_TIMEOUT_LIST_8_RESERVED_8A_MASK                    0xffffffff
313*5113495bSYour Name 
314*5113495bSYour Name 
315*5113495bSYour Name #endif // _REO_FLUSH_TIMEOUT_LIST_H_
316