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