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