xref: /wlan-driver/fw-api/hw/qcn6432/reo_get_queue_stats.h (revision 5113495b16420b49004c444715d2daae2066e7dc)
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2023 Qualcomm Innovation Center, Inc. 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_GET_QUEUE_STATS_H_
18*5113495bSYour Name #define _REO_GET_QUEUE_STATS_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 #define NUM_OF_DWORDS_REO_GET_QUEUE_STATS 10
24*5113495bSYour Name 
25*5113495bSYour Name #define NUM_OF_QWORDS_REO_GET_QUEUE_STATS 5
26*5113495bSYour Name 
27*5113495bSYour Name 
28*5113495bSYour Name struct reo_get_queue_stats {
29*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN
30*5113495bSYour Name              struct   uniform_reo_cmd_header                                    cmd_header;
31*5113495bSYour Name              uint32_t rx_reo_queue_desc_addr_31_0                             : 32; // [31:0]
32*5113495bSYour Name              uint32_t rx_reo_queue_desc_addr_39_32                            :  8, // [7:0]
33*5113495bSYour Name                       clear_stats                                             :  1, // [8:8]
34*5113495bSYour Name                       reserved_2a                                             : 23; // [31:9]
35*5113495bSYour Name              uint32_t reserved_3a                                             : 32; // [31:0]
36*5113495bSYour Name              uint32_t reserved_4a                                             : 32; // [31:0]
37*5113495bSYour Name              uint32_t reserved_5a                                             : 32; // [31:0]
38*5113495bSYour Name              uint32_t reserved_6a                                             : 32; // [31:0]
39*5113495bSYour Name              uint32_t reserved_7a                                             : 32; // [31:0]
40*5113495bSYour Name              uint32_t reserved_8a                                             : 32; // [31:0]
41*5113495bSYour Name              uint32_t tlv64_padding                                           : 32; // [31:0]
42*5113495bSYour Name #else
43*5113495bSYour Name              struct   uniform_reo_cmd_header                                    cmd_header;
44*5113495bSYour Name              uint32_t rx_reo_queue_desc_addr_31_0                             : 32; // [31:0]
45*5113495bSYour Name              uint32_t reserved_2a                                             : 23, // [31:9]
46*5113495bSYour Name                       clear_stats                                             :  1, // [8:8]
47*5113495bSYour Name                       rx_reo_queue_desc_addr_39_32                            :  8; // [7:0]
48*5113495bSYour Name              uint32_t reserved_3a                                             : 32; // [31:0]
49*5113495bSYour Name              uint32_t reserved_4a                                             : 32; // [31:0]
50*5113495bSYour Name              uint32_t reserved_5a                                             : 32; // [31:0]
51*5113495bSYour Name              uint32_t reserved_6a                                             : 32; // [31:0]
52*5113495bSYour Name              uint32_t reserved_7a                                             : 32; // [31:0]
53*5113495bSYour Name              uint32_t reserved_8a                                             : 32; // [31:0]
54*5113495bSYour Name              uint32_t tlv64_padding                                           : 32; // [31:0]
55*5113495bSYour Name #endif
56*5113495bSYour Name };
57*5113495bSYour Name 
58*5113495bSYour Name 
59*5113495bSYour Name /* Description		CMD_HEADER
60*5113495bSYour Name 
61*5113495bSYour Name 			Consumer: REO
62*5113495bSYour Name 			Producer: SW
63*5113495bSYour Name 
64*5113495bSYour Name 			Details for command execution tracking purposes.
65*5113495bSYour Name */
66*5113495bSYour Name 
67*5113495bSYour Name 
68*5113495bSYour Name /* Description		REO_CMD_NUMBER
69*5113495bSYour Name 
70*5113495bSYour Name 			Consumer: REO/SW/DEBUG
71*5113495bSYour Name 			Producer: SW
72*5113495bSYour Name 
73*5113495bSYour Name 			This number can be used by SW to track, identify and link
74*5113495bSYour Name 			 the created commands with the command statusses
75*5113495bSYour Name 
76*5113495bSYour Name 
77*5113495bSYour Name 			<legal all>
78*5113495bSYour Name */
79*5113495bSYour Name 
80*5113495bSYour Name #define REO_GET_QUEUE_STATS_CMD_HEADER_REO_CMD_NUMBER_OFFSET                        0x0000000000000000
81*5113495bSYour Name #define REO_GET_QUEUE_STATS_CMD_HEADER_REO_CMD_NUMBER_LSB                           0
82*5113495bSYour Name #define REO_GET_QUEUE_STATS_CMD_HEADER_REO_CMD_NUMBER_MSB                           15
83*5113495bSYour Name #define REO_GET_QUEUE_STATS_CMD_HEADER_REO_CMD_NUMBER_MASK                          0x000000000000ffff
84*5113495bSYour Name 
85*5113495bSYour Name 
86*5113495bSYour Name /* Description		REO_STATUS_REQUIRED
87*5113495bSYour Name 
88*5113495bSYour Name 			Consumer: REO
89*5113495bSYour Name 			Producer: SW
90*5113495bSYour Name 
91*5113495bSYour Name 			<enum 0 NoStatus> REO does not need to generate a status
92*5113495bSYour Name 			 TLV for the execution of this command
93*5113495bSYour Name 			<enum 1 StatusRequired> REO shall generate a status TLV
94*5113495bSYour Name 			for the execution of this command
95*5113495bSYour Name 
96*5113495bSYour Name 			<legal all>
97*5113495bSYour Name */
98*5113495bSYour Name 
99*5113495bSYour Name #define REO_GET_QUEUE_STATS_CMD_HEADER_REO_STATUS_REQUIRED_OFFSET                   0x0000000000000000
100*5113495bSYour Name #define REO_GET_QUEUE_STATS_CMD_HEADER_REO_STATUS_REQUIRED_LSB                      16
101*5113495bSYour Name #define REO_GET_QUEUE_STATS_CMD_HEADER_REO_STATUS_REQUIRED_MSB                      16
102*5113495bSYour Name #define REO_GET_QUEUE_STATS_CMD_HEADER_REO_STATUS_REQUIRED_MASK                     0x0000000000010000
103*5113495bSYour Name 
104*5113495bSYour Name 
105*5113495bSYour Name /* Description		RESERVED_0A
106*5113495bSYour Name 
107*5113495bSYour Name 			<legal 0>
108*5113495bSYour Name */
109*5113495bSYour Name 
110*5113495bSYour Name #define REO_GET_QUEUE_STATS_CMD_HEADER_RESERVED_0A_OFFSET                           0x0000000000000000
111*5113495bSYour Name #define REO_GET_QUEUE_STATS_CMD_HEADER_RESERVED_0A_LSB                              17
112*5113495bSYour Name #define REO_GET_QUEUE_STATS_CMD_HEADER_RESERVED_0A_MSB                              31
113*5113495bSYour Name #define REO_GET_QUEUE_STATS_CMD_HEADER_RESERVED_0A_MASK                             0x00000000fffe0000
114*5113495bSYour Name 
115*5113495bSYour Name 
116*5113495bSYour Name /* Description		RX_REO_QUEUE_DESC_ADDR_31_0
117*5113495bSYour Name 
118*5113495bSYour Name 			Consumer: REO
119*5113495bSYour Name 			Producer: SW
120*5113495bSYour Name 
121*5113495bSYour Name 			Address (lower 32 bits) of the REO queue descriptor
122*5113495bSYour Name 			<legal all>
123*5113495bSYour Name */
124*5113495bSYour Name 
125*5113495bSYour Name #define REO_GET_QUEUE_STATS_RX_REO_QUEUE_DESC_ADDR_31_0_OFFSET                      0x0000000000000000
126*5113495bSYour Name #define REO_GET_QUEUE_STATS_RX_REO_QUEUE_DESC_ADDR_31_0_LSB                         32
127*5113495bSYour Name #define REO_GET_QUEUE_STATS_RX_REO_QUEUE_DESC_ADDR_31_0_MSB                         63
128*5113495bSYour Name #define REO_GET_QUEUE_STATS_RX_REO_QUEUE_DESC_ADDR_31_0_MASK                        0xffffffff00000000
129*5113495bSYour Name 
130*5113495bSYour Name 
131*5113495bSYour Name /* Description		RX_REO_QUEUE_DESC_ADDR_39_32
132*5113495bSYour Name 
133*5113495bSYour Name 			Consumer: REO
134*5113495bSYour Name 			Producer: SW
135*5113495bSYour Name 
136*5113495bSYour Name 			Address (upper 8 bits) of the REO queue descriptor
137*5113495bSYour Name 			<legal all>
138*5113495bSYour Name */
139*5113495bSYour Name 
140*5113495bSYour Name #define REO_GET_QUEUE_STATS_RX_REO_QUEUE_DESC_ADDR_39_32_OFFSET                     0x0000000000000008
141*5113495bSYour Name #define REO_GET_QUEUE_STATS_RX_REO_QUEUE_DESC_ADDR_39_32_LSB                        0
142*5113495bSYour Name #define REO_GET_QUEUE_STATS_RX_REO_QUEUE_DESC_ADDR_39_32_MSB                        7
143*5113495bSYour Name #define REO_GET_QUEUE_STATS_RX_REO_QUEUE_DESC_ADDR_39_32_MASK                       0x00000000000000ff
144*5113495bSYour Name 
145*5113495bSYour Name 
146*5113495bSYour Name /* Description		CLEAR_STATS
147*5113495bSYour Name 
148*5113495bSYour Name 			Clear stat settings....
149*5113495bSYour Name 
150*5113495bSYour Name 			<enum 0 no_clear> Do NOT clear the stats after generating
151*5113495bSYour Name 			 the status
152*5113495bSYour Name 			<enum 1 clear_the_stats> Clear the stats after generating
153*5113495bSYour Name 			 the status.
154*5113495bSYour Name 
155*5113495bSYour Name 			The stats actually cleared are:
156*5113495bSYour Name 			Timeout_count
157*5113495bSYour Name 			Forward_due_to_bar_count
158*5113495bSYour Name 			Duplicate_count
159*5113495bSYour Name 			Frames_in_order_count
160*5113495bSYour Name 			BAR_received_count
161*5113495bSYour Name 			MPDU_Frames_processed_count
162*5113495bSYour Name 			MSDU_Frames_processed_count
163*5113495bSYour Name 			Total_processed_byte_count
164*5113495bSYour Name 			Late_receive_MPDU_count
165*5113495bSYour Name 			window_jump_2k
166*5113495bSYour Name 			Hole_count
167*5113495bSYour Name 			<legal 0-1>
168*5113495bSYour Name */
169*5113495bSYour Name 
170*5113495bSYour Name #define REO_GET_QUEUE_STATS_CLEAR_STATS_OFFSET                                      0x0000000000000008
171*5113495bSYour Name #define REO_GET_QUEUE_STATS_CLEAR_STATS_LSB                                         8
172*5113495bSYour Name #define REO_GET_QUEUE_STATS_CLEAR_STATS_MSB                                         8
173*5113495bSYour Name #define REO_GET_QUEUE_STATS_CLEAR_STATS_MASK                                        0x0000000000000100
174*5113495bSYour Name 
175*5113495bSYour Name 
176*5113495bSYour Name /* Description		RESERVED_2A
177*5113495bSYour Name 
178*5113495bSYour Name 			<legal 0>
179*5113495bSYour Name */
180*5113495bSYour Name 
181*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_2A_OFFSET                                      0x0000000000000008
182*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_2A_LSB                                         9
183*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_2A_MSB                                         31
184*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_2A_MASK                                        0x00000000fffffe00
185*5113495bSYour Name 
186*5113495bSYour Name 
187*5113495bSYour Name /* Description		RESERVED_3A
188*5113495bSYour Name 
189*5113495bSYour Name 			<legal 0>
190*5113495bSYour Name */
191*5113495bSYour Name 
192*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_3A_OFFSET                                      0x0000000000000008
193*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_3A_LSB                                         32
194*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_3A_MSB                                         63
195*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_3A_MASK                                        0xffffffff00000000
196*5113495bSYour Name 
197*5113495bSYour Name 
198*5113495bSYour Name /* Description		RESERVED_4A
199*5113495bSYour Name 
200*5113495bSYour Name 			<legal 0>
201*5113495bSYour Name */
202*5113495bSYour Name 
203*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_4A_OFFSET                                      0x0000000000000010
204*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_4A_LSB                                         0
205*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_4A_MSB                                         31
206*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_4A_MASK                                        0x00000000ffffffff
207*5113495bSYour Name 
208*5113495bSYour Name 
209*5113495bSYour Name /* Description		RESERVED_5A
210*5113495bSYour Name 
211*5113495bSYour Name 			<legal 0>
212*5113495bSYour Name */
213*5113495bSYour Name 
214*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_5A_OFFSET                                      0x0000000000000010
215*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_5A_LSB                                         32
216*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_5A_MSB                                         63
217*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_5A_MASK                                        0xffffffff00000000
218*5113495bSYour Name 
219*5113495bSYour Name 
220*5113495bSYour Name /* Description		RESERVED_6A
221*5113495bSYour Name 
222*5113495bSYour Name 			<legal 0>
223*5113495bSYour Name */
224*5113495bSYour Name 
225*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_6A_OFFSET                                      0x0000000000000018
226*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_6A_LSB                                         0
227*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_6A_MSB                                         31
228*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_6A_MASK                                        0x00000000ffffffff
229*5113495bSYour Name 
230*5113495bSYour Name 
231*5113495bSYour Name /* Description		RESERVED_7A
232*5113495bSYour Name 
233*5113495bSYour Name 			<legal 0>
234*5113495bSYour Name */
235*5113495bSYour Name 
236*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_7A_OFFSET                                      0x0000000000000018
237*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_7A_LSB                                         32
238*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_7A_MSB                                         63
239*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_7A_MASK                                        0xffffffff00000000
240*5113495bSYour Name 
241*5113495bSYour Name 
242*5113495bSYour Name /* Description		RESERVED_8A
243*5113495bSYour Name 
244*5113495bSYour Name 			<legal 0>
245*5113495bSYour Name */
246*5113495bSYour Name 
247*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_8A_OFFSET                                      0x0000000000000020
248*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_8A_LSB                                         0
249*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_8A_MSB                                         31
250*5113495bSYour Name #define REO_GET_QUEUE_STATS_RESERVED_8A_MASK                                        0x00000000ffffffff
251*5113495bSYour Name 
252*5113495bSYour Name 
253*5113495bSYour Name /* Description		TLV64_PADDING
254*5113495bSYour Name 
255*5113495bSYour Name 			Automatic DWORD padding inserted while converting TLV32
256*5113495bSYour Name 			to TLV64 for 64 bit ARCH
257*5113495bSYour Name 			<legal 0>
258*5113495bSYour Name */
259*5113495bSYour Name 
260*5113495bSYour Name #define REO_GET_QUEUE_STATS_TLV64_PADDING_OFFSET                                    0x0000000000000020
261*5113495bSYour Name #define REO_GET_QUEUE_STATS_TLV64_PADDING_LSB                                       32
262*5113495bSYour Name #define REO_GET_QUEUE_STATS_TLV64_PADDING_MSB                                       63
263*5113495bSYour Name #define REO_GET_QUEUE_STATS_TLV64_PADDING_MASK                                      0xffffffff00000000
264*5113495bSYour Name 
265*5113495bSYour Name 
266*5113495bSYour Name 
267*5113495bSYour Name #endif   // REO_GET_QUEUE_STATS
268