xref: /wlan-driver/fw-api/hw/qca6290/v2/uniform_reo_status_header.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2016-2017 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 _UNIFORM_REO_STATUS_HEADER_H_
25*5113495bSYour Name #define _UNIFORM_REO_STATUS_HEADER_H_
26*5113495bSYour Name #if !defined(__ASSEMBLER__)
27*5113495bSYour Name #endif
28*5113495bSYour Name 
29*5113495bSYour Name 
30*5113495bSYour Name // ################ START SUMMARY #################
31*5113495bSYour Name //
32*5113495bSYour Name //	Dword	Fields
33*5113495bSYour Name //	0	reo_status_number[15:0], cmd_execution_time[25:16], reo_cmd_execution_status[27:26], reserved_0a[31:28]
34*5113495bSYour Name //	1	timestamp[31:0]
35*5113495bSYour Name //
36*5113495bSYour Name // ################ END SUMMARY #################
37*5113495bSYour Name 
38*5113495bSYour Name #define NUM_OF_DWORDS_UNIFORM_REO_STATUS_HEADER 2
39*5113495bSYour Name 
40*5113495bSYour Name struct uniform_reo_status_header {
41*5113495bSYour Name              uint32_t reo_status_number               : 16, //[15:0]
42*5113495bSYour Name                       cmd_execution_time              : 10, //[25:16]
43*5113495bSYour Name                       reo_cmd_execution_status        :  2, //[27:26]
44*5113495bSYour Name                       reserved_0a                     :  4; //[31:28]
45*5113495bSYour Name              uint32_t timestamp                       : 32; //[31:0]
46*5113495bSYour Name };
47*5113495bSYour Name 
48*5113495bSYour Name /*
49*5113495bSYour Name 
50*5113495bSYour Name reo_status_number
51*5113495bSYour Name 
52*5113495bSYour Name 			Consumer: SW , DEBUG
53*5113495bSYour Name 
54*5113495bSYour Name 			Producer: REO
55*5113495bSYour Name 
56*5113495bSYour Name 
57*5113495bSYour Name 
58*5113495bSYour Name 			The value in this field is equal to value of the
59*5113495bSYour Name 			'REO_CMD_Number' field the REO command
60*5113495bSYour Name 
61*5113495bSYour Name 
62*5113495bSYour Name 
63*5113495bSYour Name 			This field helps to correlate the statuses with the REO
64*5113495bSYour Name 			commands.
65*5113495bSYour Name 
66*5113495bSYour Name 
67*5113495bSYour Name 
68*5113495bSYour Name 			<legal all>
69*5113495bSYour Name 
70*5113495bSYour Name cmd_execution_time
71*5113495bSYour Name 
72*5113495bSYour Name 			Consumer: DEBUG
73*5113495bSYour Name 
74*5113495bSYour Name 			Producer: REO
75*5113495bSYour Name 
76*5113495bSYour Name 
77*5113495bSYour Name 
78*5113495bSYour Name 			The amount of time REO took to excecute the command.
79*5113495bSYour Name 			Note that this time does not include the duration of the
80*5113495bSYour Name 			command waiting in the command ring, before the execution
81*5113495bSYour Name 			started.
82*5113495bSYour Name 
83*5113495bSYour Name 
84*5113495bSYour Name 
85*5113495bSYour Name 			In us.
86*5113495bSYour Name 
87*5113495bSYour Name 
88*5113495bSYour Name 
89*5113495bSYour Name 			<legal all>
90*5113495bSYour Name 
91*5113495bSYour Name reo_cmd_execution_status
92*5113495bSYour Name 
93*5113495bSYour Name 			Consumer: DEBUG
94*5113495bSYour Name 
95*5113495bSYour Name 			Producer: REO
96*5113495bSYour Name 
97*5113495bSYour Name 
98*5113495bSYour Name 
99*5113495bSYour Name 			Execution status of the command.
100*5113495bSYour Name 
101*5113495bSYour Name 
102*5113495bSYour Name 
103*5113495bSYour Name 			<enum 0 reo_successful_execution> Command has
104*5113495bSYour Name 			successfully be executed
105*5113495bSYour Name 
106*5113495bSYour Name 			<enum 1 reo_blocked_execution> Command could not be
107*5113495bSYour Name 			executed as the queue or cache was blocked
108*5113495bSYour Name 
109*5113495bSYour Name 			<enum 2 reo_failed_execution> Command has encountered
110*5113495bSYour Name 			problems when executing, like the queue descriptor not being
111*5113495bSYour Name 			valid. None of the status fields in the entire STATUS TLV
112*5113495bSYour Name 			are valid.
113*5113495bSYour Name 
114*5113495bSYour Name 			<enum 3 reo_resource_blocked> Command is NOT  executed
115*5113495bSYour Name 			because one or more descriptors were blocked. This is SW
116*5113495bSYour Name 			programming mistake.
117*5113495bSYour Name 
118*5113495bSYour Name 			None of the status fields in the entire STATUS TLV are
119*5113495bSYour Name 			valid.
120*5113495bSYour Name 
121*5113495bSYour Name 
122*5113495bSYour Name 
123*5113495bSYour Name 			<legal  0-3>
124*5113495bSYour Name 
125*5113495bSYour Name reserved_0a
126*5113495bSYour Name 
127*5113495bSYour Name 			<legal 0>
128*5113495bSYour Name 
129*5113495bSYour Name timestamp
130*5113495bSYour Name 
131*5113495bSYour Name 			Timestamp at the moment that this status report is
132*5113495bSYour Name 			written.
133*5113495bSYour Name 
134*5113495bSYour Name 
135*5113495bSYour Name 
136*5113495bSYour Name 			<legal all>
137*5113495bSYour Name */
138*5113495bSYour Name 
139*5113495bSYour Name 
140*5113495bSYour Name /* Description		UNIFORM_REO_STATUS_HEADER_0_REO_STATUS_NUMBER
141*5113495bSYour Name 
142*5113495bSYour Name 			Consumer: SW , DEBUG
143*5113495bSYour Name 
144*5113495bSYour Name 			Producer: REO
145*5113495bSYour Name 
146*5113495bSYour Name 
147*5113495bSYour Name 
148*5113495bSYour Name 			The value in this field is equal to value of the
149*5113495bSYour Name 			'REO_CMD_Number' field the REO command
150*5113495bSYour Name 
151*5113495bSYour Name 
152*5113495bSYour Name 
153*5113495bSYour Name 			This field helps to correlate the statuses with the REO
154*5113495bSYour Name 			commands.
155*5113495bSYour Name 
156*5113495bSYour Name 
157*5113495bSYour Name 
158*5113495bSYour Name 			<legal all>
159*5113495bSYour Name */
160*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_0_REO_STATUS_NUMBER_OFFSET         0x00000000
161*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_0_REO_STATUS_NUMBER_LSB            0
162*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_0_REO_STATUS_NUMBER_MASK           0x0000ffff
163*5113495bSYour Name 
164*5113495bSYour Name /* Description		UNIFORM_REO_STATUS_HEADER_0_CMD_EXECUTION_TIME
165*5113495bSYour Name 
166*5113495bSYour Name 			Consumer: DEBUG
167*5113495bSYour Name 
168*5113495bSYour Name 			Producer: REO
169*5113495bSYour Name 
170*5113495bSYour Name 
171*5113495bSYour Name 
172*5113495bSYour Name 			The amount of time REO took to excecute the command.
173*5113495bSYour Name 			Note that this time does not include the duration of the
174*5113495bSYour Name 			command waiting in the command ring, before the execution
175*5113495bSYour Name 			started.
176*5113495bSYour Name 
177*5113495bSYour Name 
178*5113495bSYour Name 
179*5113495bSYour Name 			In us.
180*5113495bSYour Name 
181*5113495bSYour Name 
182*5113495bSYour Name 
183*5113495bSYour Name 			<legal all>
184*5113495bSYour Name */
185*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_0_CMD_EXECUTION_TIME_OFFSET        0x00000000
186*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_0_CMD_EXECUTION_TIME_LSB           16
187*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_0_CMD_EXECUTION_TIME_MASK          0x03ff0000
188*5113495bSYour Name 
189*5113495bSYour Name /* Description		UNIFORM_REO_STATUS_HEADER_0_REO_CMD_EXECUTION_STATUS
190*5113495bSYour Name 
191*5113495bSYour Name 			Consumer: DEBUG
192*5113495bSYour Name 
193*5113495bSYour Name 			Producer: REO
194*5113495bSYour Name 
195*5113495bSYour Name 
196*5113495bSYour Name 
197*5113495bSYour Name 			Execution status of the command.
198*5113495bSYour Name 
199*5113495bSYour Name 
200*5113495bSYour Name 
201*5113495bSYour Name 			<enum 0 reo_successful_execution> Command has
202*5113495bSYour Name 			successfully be executed
203*5113495bSYour Name 
204*5113495bSYour Name 			<enum 1 reo_blocked_execution> Command could not be
205*5113495bSYour Name 			executed as the queue or cache was blocked
206*5113495bSYour Name 
207*5113495bSYour Name 			<enum 2 reo_failed_execution> Command has encountered
208*5113495bSYour Name 			problems when executing, like the queue descriptor not being
209*5113495bSYour Name 			valid. None of the status fields in the entire STATUS TLV
210*5113495bSYour Name 			are valid.
211*5113495bSYour Name 
212*5113495bSYour Name 			<enum 3 reo_resource_blocked> Command is NOT  executed
213*5113495bSYour Name 			because one or more descriptors were blocked. This is SW
214*5113495bSYour Name 			programming mistake.
215*5113495bSYour Name 
216*5113495bSYour Name 			None of the status fields in the entire STATUS TLV are
217*5113495bSYour Name 			valid.
218*5113495bSYour Name 
219*5113495bSYour Name 
220*5113495bSYour Name 
221*5113495bSYour Name 			<legal  0-3>
222*5113495bSYour Name */
223*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_0_REO_CMD_EXECUTION_STATUS_OFFSET  0x00000000
224*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_0_REO_CMD_EXECUTION_STATUS_LSB     26
225*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_0_REO_CMD_EXECUTION_STATUS_MASK    0x0c000000
226*5113495bSYour Name 
227*5113495bSYour Name /* Description		UNIFORM_REO_STATUS_HEADER_0_RESERVED_0A
228*5113495bSYour Name 
229*5113495bSYour Name 			<legal 0>
230*5113495bSYour Name */
231*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_0_RESERVED_0A_OFFSET               0x00000000
232*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_0_RESERVED_0A_LSB                  28
233*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_0_RESERVED_0A_MASK                 0xf0000000
234*5113495bSYour Name 
235*5113495bSYour Name /* Description		UNIFORM_REO_STATUS_HEADER_1_TIMESTAMP
236*5113495bSYour Name 
237*5113495bSYour Name 			Timestamp at the moment that this status report is
238*5113495bSYour Name 			written.
239*5113495bSYour Name 
240*5113495bSYour Name 
241*5113495bSYour Name 
242*5113495bSYour Name 			<legal all>
243*5113495bSYour Name */
244*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_1_TIMESTAMP_OFFSET                 0x00000004
245*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_1_TIMESTAMP_LSB                    0
246*5113495bSYour Name #define UNIFORM_REO_STATUS_HEADER_1_TIMESTAMP_MASK                   0xffffffff
247*5113495bSYour Name 
248*5113495bSYour Name 
249*5113495bSYour Name #endif // _UNIFORM_REO_STATUS_HEADER_H_
250