xref: /wlan-driver/fw-api/hw/qca6290/v1/ce_stat_desc.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 // $ATH_LICENSE_HW_HDR_C$
20*5113495bSYour Name //
21*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
22*5113495bSYour Name //               These definitions are tied to a particular hardware layout
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name #ifndef _CE_STAT_DESC_H_
26*5113495bSYour Name #define _CE_STAT_DESC_H_
27*5113495bSYour Name #if !defined(__ASSEMBLER__)
28*5113495bSYour Name #endif
29*5113495bSYour Name 
30*5113495bSYour Name 
31*5113495bSYour Name // ################ START SUMMARY #################
32*5113495bSYour Name //
33*5113495bSYour Name //	Dword	Fields
34*5113495bSYour Name //	0	ce_res_5[7:0], toeplitz_en[8], src_swap[9], dest_swap[10], gather[11], ce_res_6[15:12], length[31:16]
35*5113495bSYour Name //	1	toeplitz_hash_0[31:0]
36*5113495bSYour Name //	2	toeplitz_hash_1[31:0]
37*5113495bSYour Name //	3	fw_metadata[15:0], ce_res_7[19:16], ring_id[27:20], looping_count[31:28]
38*5113495bSYour Name //
39*5113495bSYour Name // ################ END SUMMARY #################
40*5113495bSYour Name 
41*5113495bSYour Name #define NUM_OF_DWORDS_CE_STAT_DESC 4
42*5113495bSYour Name 
43*5113495bSYour Name struct ce_stat_desc {
44*5113495bSYour Name              uint32_t ce_res_5                        :  8, //[7:0]
45*5113495bSYour Name                       toeplitz_en                     :  1, //[8]
46*5113495bSYour Name                       src_swap                        :  1, //[9]
47*5113495bSYour Name                       dest_swap                       :  1, //[10]
48*5113495bSYour Name                       gather                          :  1, //[11]
49*5113495bSYour Name                       ce_res_6                        :  4, //[15:12]
50*5113495bSYour Name                       length                          : 16; //[31:16]
51*5113495bSYour Name              uint32_t toeplitz_hash_0                 : 32; //[31:0]
52*5113495bSYour Name              uint32_t toeplitz_hash_1                 : 32; //[31:0]
53*5113495bSYour Name              uint32_t fw_metadata                     : 16, //[15:0]
54*5113495bSYour Name                       ce_res_7                        :  4, //[19:16]
55*5113495bSYour Name                       ring_id                         :  8, //[27:20]
56*5113495bSYour Name                       looping_count                   :  4; //[31:28]
57*5113495bSYour Name };
58*5113495bSYour Name 
59*5113495bSYour Name /*
60*5113495bSYour Name 
61*5113495bSYour Name ce_res_5
62*5113495bSYour Name 
63*5113495bSYour Name 			Reserved
64*5113495bSYour Name 
65*5113495bSYour Name 			<legal all>
66*5113495bSYour Name 
67*5113495bSYour Name toeplitz_en
68*5113495bSYour Name 
69*5113495bSYour Name 
70*5113495bSYour Name 			<legal all>
71*5113495bSYour Name 
72*5113495bSYour Name src_swap
73*5113495bSYour Name 
74*5113495bSYour Name 			Source memory buffer swapped
75*5113495bSYour Name 
76*5113495bSYour Name 			<legal all>
77*5113495bSYour Name 
78*5113495bSYour Name dest_swap
79*5113495bSYour Name 
80*5113495bSYour Name 			Destination  memory buffer swapped
81*5113495bSYour Name 
82*5113495bSYour Name 			<legal all>
83*5113495bSYour Name 
84*5113495bSYour Name gather
85*5113495bSYour Name 
86*5113495bSYour Name 			Gather of multiple copy engine source descriptors to one
87*5113495bSYour Name 			destination enabled
88*5113495bSYour Name 
89*5113495bSYour Name 			<legal all>
90*5113495bSYour Name 
91*5113495bSYour Name ce_res_6
92*5113495bSYour Name 
93*5113495bSYour Name 			Reserved
94*5113495bSYour Name 
95*5113495bSYour Name 			<legal all>
96*5113495bSYour Name 
97*5113495bSYour Name length
98*5113495bSYour Name 
99*5113495bSYour Name 			Sum of all the Lengths of the source descriptor in the
100*5113495bSYour Name 			gather chain
101*5113495bSYour Name 
102*5113495bSYour Name 			<legal all>
103*5113495bSYour Name 
104*5113495bSYour Name toeplitz_hash_0
105*5113495bSYour Name 
106*5113495bSYour Name 			32 LS bits of 64 bit Toeplitz LFSR hash result
107*5113495bSYour Name 
108*5113495bSYour Name 			<legal all>
109*5113495bSYour Name 
110*5113495bSYour Name toeplitz_hash_1
111*5113495bSYour Name 
112*5113495bSYour Name 			32 MS bits of 64 bit Toeplitz LFSR hash result
113*5113495bSYour Name 
114*5113495bSYour Name 			<legal all>
115*5113495bSYour Name 
116*5113495bSYour Name fw_metadata
117*5113495bSYour Name 
118*5113495bSYour Name 			Meta data used by FW
119*5113495bSYour Name 
120*5113495bSYour Name 			In case of gather field in first source ring entry of
121*5113495bSYour Name 			the gather copy cycle in taken into account.
122*5113495bSYour Name 
123*5113495bSYour Name 			<legal all>
124*5113495bSYour Name 
125*5113495bSYour Name ce_res_7
126*5113495bSYour Name 
127*5113495bSYour Name 			Reserved
128*5113495bSYour Name 
129*5113495bSYour Name 			<legal all>
130*5113495bSYour Name 
131*5113495bSYour Name ring_id
132*5113495bSYour Name 
133*5113495bSYour Name 			The buffer pointer ring ID.
134*5113495bSYour Name 
135*5113495bSYour Name 			0 refers to the IDLE ring
136*5113495bSYour Name 
137*5113495bSYour Name 			1 - N refers to other rings
138*5113495bSYour Name 
139*5113495bSYour Name 
140*5113495bSYour Name 
141*5113495bSYour Name 			Helps with debugging when dumping ring contents.
142*5113495bSYour Name 
143*5113495bSYour Name 			<legal all>
144*5113495bSYour Name 
145*5113495bSYour Name looping_count
146*5113495bSYour Name 
147*5113495bSYour Name 			A count value that indicates the number of times the
148*5113495bSYour Name 			producer of entries into the Ring has looped around the
149*5113495bSYour Name 			ring.
150*5113495bSYour Name 
151*5113495bSYour Name 			At initialization time, this value is set to 0. On the
152*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
153*5113495bSYour Name 			reached allowed by the number of bits for this field, the
154*5113495bSYour Name 			count value continues with 0 again.
155*5113495bSYour Name 
156*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
157*5113495bSYour Name 			use this field to figure out up to where the producer of
158*5113495bSYour Name 			entries has created new entries. This eliminates the need to
159*5113495bSYour Name 			check where the head pointer' of the ring is located once
160*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
161*5113495bSYour Name 			entries have been put into this ring...
162*5113495bSYour Name 
163*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
164*5113495bSYour Name 			LSB bit of this count value.
165*5113495bSYour Name 
166*5113495bSYour Name 			<legal all>
167*5113495bSYour Name */
168*5113495bSYour Name 
169*5113495bSYour Name 
170*5113495bSYour Name /* Description		CE_STAT_DESC_0_CE_RES_5
171*5113495bSYour Name 
172*5113495bSYour Name 			Reserved
173*5113495bSYour Name 
174*5113495bSYour Name 			<legal all>
175*5113495bSYour Name */
176*5113495bSYour Name #define CE_STAT_DESC_0_CE_RES_5_OFFSET                               0x00000000
177*5113495bSYour Name #define CE_STAT_DESC_0_CE_RES_5_LSB                                  0
178*5113495bSYour Name #define CE_STAT_DESC_0_CE_RES_5_MASK                                 0x000000ff
179*5113495bSYour Name 
180*5113495bSYour Name /* Description		CE_STAT_DESC_0_TOEPLITZ_EN
181*5113495bSYour Name 
182*5113495bSYour Name 
183*5113495bSYour Name 			<legal all>
184*5113495bSYour Name */
185*5113495bSYour Name #define CE_STAT_DESC_0_TOEPLITZ_EN_OFFSET                            0x00000000
186*5113495bSYour Name #define CE_STAT_DESC_0_TOEPLITZ_EN_LSB                               8
187*5113495bSYour Name #define CE_STAT_DESC_0_TOEPLITZ_EN_MASK                              0x00000100
188*5113495bSYour Name 
189*5113495bSYour Name /* Description		CE_STAT_DESC_0_SRC_SWAP
190*5113495bSYour Name 
191*5113495bSYour Name 			Source memory buffer swapped
192*5113495bSYour Name 
193*5113495bSYour Name 			<legal all>
194*5113495bSYour Name */
195*5113495bSYour Name #define CE_STAT_DESC_0_SRC_SWAP_OFFSET                               0x00000000
196*5113495bSYour Name #define CE_STAT_DESC_0_SRC_SWAP_LSB                                  9
197*5113495bSYour Name #define CE_STAT_DESC_0_SRC_SWAP_MASK                                 0x00000200
198*5113495bSYour Name 
199*5113495bSYour Name /* Description		CE_STAT_DESC_0_DEST_SWAP
200*5113495bSYour Name 
201*5113495bSYour Name 			Destination  memory buffer swapped
202*5113495bSYour Name 
203*5113495bSYour Name 			<legal all>
204*5113495bSYour Name */
205*5113495bSYour Name #define CE_STAT_DESC_0_DEST_SWAP_OFFSET                              0x00000000
206*5113495bSYour Name #define CE_STAT_DESC_0_DEST_SWAP_LSB                                 10
207*5113495bSYour Name #define CE_STAT_DESC_0_DEST_SWAP_MASK                                0x00000400
208*5113495bSYour Name 
209*5113495bSYour Name /* Description		CE_STAT_DESC_0_GATHER
210*5113495bSYour Name 
211*5113495bSYour Name 			Gather of multiple copy engine source descriptors to one
212*5113495bSYour Name 			destination enabled
213*5113495bSYour Name 
214*5113495bSYour Name 			<legal all>
215*5113495bSYour Name */
216*5113495bSYour Name #define CE_STAT_DESC_0_GATHER_OFFSET                                 0x00000000
217*5113495bSYour Name #define CE_STAT_DESC_0_GATHER_LSB                                    11
218*5113495bSYour Name #define CE_STAT_DESC_0_GATHER_MASK                                   0x00000800
219*5113495bSYour Name 
220*5113495bSYour Name /* Description		CE_STAT_DESC_0_CE_RES_6
221*5113495bSYour Name 
222*5113495bSYour Name 			Reserved
223*5113495bSYour Name 
224*5113495bSYour Name 			<legal all>
225*5113495bSYour Name */
226*5113495bSYour Name #define CE_STAT_DESC_0_CE_RES_6_OFFSET                               0x00000000
227*5113495bSYour Name #define CE_STAT_DESC_0_CE_RES_6_LSB                                  12
228*5113495bSYour Name #define CE_STAT_DESC_0_CE_RES_6_MASK                                 0x0000f000
229*5113495bSYour Name 
230*5113495bSYour Name /* Description		CE_STAT_DESC_0_LENGTH
231*5113495bSYour Name 
232*5113495bSYour Name 			Sum of all the Lengths of the source descriptor in the
233*5113495bSYour Name 			gather chain
234*5113495bSYour Name 
235*5113495bSYour Name 			<legal all>
236*5113495bSYour Name */
237*5113495bSYour Name #define CE_STAT_DESC_0_LENGTH_OFFSET                                 0x00000000
238*5113495bSYour Name #define CE_STAT_DESC_0_LENGTH_LSB                                    16
239*5113495bSYour Name #define CE_STAT_DESC_0_LENGTH_MASK                                   0xffff0000
240*5113495bSYour Name 
241*5113495bSYour Name /* Description		CE_STAT_DESC_1_TOEPLITZ_HASH_0
242*5113495bSYour Name 
243*5113495bSYour Name 			32 LS bits of 64 bit Toeplitz LFSR hash result
244*5113495bSYour Name 
245*5113495bSYour Name 			<legal all>
246*5113495bSYour Name */
247*5113495bSYour Name #define CE_STAT_DESC_1_TOEPLITZ_HASH_0_OFFSET                        0x00000004
248*5113495bSYour Name #define CE_STAT_DESC_1_TOEPLITZ_HASH_0_LSB                           0
249*5113495bSYour Name #define CE_STAT_DESC_1_TOEPLITZ_HASH_0_MASK                          0xffffffff
250*5113495bSYour Name 
251*5113495bSYour Name /* Description		CE_STAT_DESC_2_TOEPLITZ_HASH_1
252*5113495bSYour Name 
253*5113495bSYour Name 			32 MS bits of 64 bit Toeplitz LFSR hash result
254*5113495bSYour Name 
255*5113495bSYour Name 			<legal all>
256*5113495bSYour Name */
257*5113495bSYour Name #define CE_STAT_DESC_2_TOEPLITZ_HASH_1_OFFSET                        0x00000008
258*5113495bSYour Name #define CE_STAT_DESC_2_TOEPLITZ_HASH_1_LSB                           0
259*5113495bSYour Name #define CE_STAT_DESC_2_TOEPLITZ_HASH_1_MASK                          0xffffffff
260*5113495bSYour Name 
261*5113495bSYour Name /* Description		CE_STAT_DESC_3_FW_METADATA
262*5113495bSYour Name 
263*5113495bSYour Name 			Meta data used by FW
264*5113495bSYour Name 
265*5113495bSYour Name 			In case of gather field in first source ring entry of
266*5113495bSYour Name 			the gather copy cycle in taken into account.
267*5113495bSYour Name 
268*5113495bSYour Name 			<legal all>
269*5113495bSYour Name */
270*5113495bSYour Name #define CE_STAT_DESC_3_FW_METADATA_OFFSET                            0x0000000c
271*5113495bSYour Name #define CE_STAT_DESC_3_FW_METADATA_LSB                               0
272*5113495bSYour Name #define CE_STAT_DESC_3_FW_METADATA_MASK                              0x0000ffff
273*5113495bSYour Name 
274*5113495bSYour Name /* Description		CE_STAT_DESC_3_CE_RES_7
275*5113495bSYour Name 
276*5113495bSYour Name 			Reserved
277*5113495bSYour Name 
278*5113495bSYour Name 			<legal all>
279*5113495bSYour Name */
280*5113495bSYour Name #define CE_STAT_DESC_3_CE_RES_7_OFFSET                               0x0000000c
281*5113495bSYour Name #define CE_STAT_DESC_3_CE_RES_7_LSB                                  16
282*5113495bSYour Name #define CE_STAT_DESC_3_CE_RES_7_MASK                                 0x000f0000
283*5113495bSYour Name 
284*5113495bSYour Name /* Description		CE_STAT_DESC_3_RING_ID
285*5113495bSYour Name 
286*5113495bSYour Name 			The buffer pointer ring ID.
287*5113495bSYour Name 
288*5113495bSYour Name 			0 refers to the IDLE ring
289*5113495bSYour Name 
290*5113495bSYour Name 			1 - N refers to other rings
291*5113495bSYour Name 
292*5113495bSYour Name 
293*5113495bSYour Name 
294*5113495bSYour Name 			Helps with debugging when dumping ring contents.
295*5113495bSYour Name 
296*5113495bSYour Name 			<legal all>
297*5113495bSYour Name */
298*5113495bSYour Name #define CE_STAT_DESC_3_RING_ID_OFFSET                                0x0000000c
299*5113495bSYour Name #define CE_STAT_DESC_3_RING_ID_LSB                                   20
300*5113495bSYour Name #define CE_STAT_DESC_3_RING_ID_MASK                                  0x0ff00000
301*5113495bSYour Name 
302*5113495bSYour Name /* Description		CE_STAT_DESC_3_LOOPING_COUNT
303*5113495bSYour Name 
304*5113495bSYour Name 			A count value that indicates the number of times the
305*5113495bSYour Name 			producer of entries into the Ring has looped around the
306*5113495bSYour Name 			ring.
307*5113495bSYour Name 
308*5113495bSYour Name 			At initialization time, this value is set to 0. On the
309*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
310*5113495bSYour Name 			reached allowed by the number of bits for this field, the
311*5113495bSYour Name 			count value continues with 0 again.
312*5113495bSYour Name 
313*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
314*5113495bSYour Name 			use this field to figure out up to where the producer of
315*5113495bSYour Name 			entries has created new entries. This eliminates the need to
316*5113495bSYour Name 			check where the head pointer' of the ring is located once
317*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
318*5113495bSYour Name 			entries have been put into this ring...
319*5113495bSYour Name 
320*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
321*5113495bSYour Name 			LSB bit of this count value.
322*5113495bSYour Name 
323*5113495bSYour Name 			<legal all>
324*5113495bSYour Name */
325*5113495bSYour Name #define CE_STAT_DESC_3_LOOPING_COUNT_OFFSET                          0x0000000c
326*5113495bSYour Name #define CE_STAT_DESC_3_LOOPING_COUNT_LSB                             28
327*5113495bSYour Name #define CE_STAT_DESC_3_LOOPING_COUNT_MASK                            0xf0000000
328*5113495bSYour Name 
329*5113495bSYour Name 
330*5113495bSYour Name #endif // _CE_STAT_DESC_H_
331