xref: /wlan-driver/fw-api/hw/qca6290/v2/ce_src_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_SRC_DESC_H_
25*5113495bSYour Name #define _CE_SRC_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	src_buffer_low[31:0]
34*5113495bSYour Name //	1	src_buffer_high[7:0], toeplitz_en[8], src_swap[9], dest_swap[10], gather[11], ce_res_0[15:12], length[31:16]
35*5113495bSYour Name //	2	fw_metadata[15:0], ce_res_1[31:16]
36*5113495bSYour Name //	3	ce_res_2[19:0], 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_SRC_DESC 4
41*5113495bSYour Name 
42*5113495bSYour Name struct ce_src_desc {
43*5113495bSYour Name              uint32_t src_buffer_low                  : 32; //[31:0]
44*5113495bSYour Name              uint32_t src_buffer_high                 :  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_0                        :  4, //[15:12]
50*5113495bSYour Name                       length                          : 16; //[31:16]
51*5113495bSYour Name              uint32_t fw_metadata                     : 16, //[15:0]
52*5113495bSYour Name                       ce_res_1                        : 16; //[31:16]
53*5113495bSYour Name              uint32_t ce_res_2                        : 20, //[19:0]
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 src_buffer_low
61*5113495bSYour Name 
62*5113495bSYour Name 			LSB 32 bits of the 40 Bit Pointer to the source buffer
63*5113495bSYour Name 
64*5113495bSYour Name 			<legal all>
65*5113495bSYour Name 
66*5113495bSYour Name src_buffer_high
67*5113495bSYour Name 
68*5113495bSYour Name 			MSB 8 bits of the 40 Bit Pointer to the source buffer
69*5113495bSYour Name 
70*5113495bSYour Name 			<legal all>
71*5113495bSYour Name 
72*5113495bSYour Name toeplitz_en
73*5113495bSYour Name 
74*5113495bSYour Name 			Enable generation of 32-bit Toeplitz-LFSR hash for the
75*5113495bSYour Name 			data transfer
76*5113495bSYour Name 
77*5113495bSYour Name 			In case of gather field in first source ring entry of
78*5113495bSYour Name 			the gather copy cycle in taken into account.
79*5113495bSYour Name 
80*5113495bSYour Name 			<legal all>
81*5113495bSYour Name 
82*5113495bSYour Name src_swap
83*5113495bSYour Name 
84*5113495bSYour Name 			Treats source memory organization as big-endian. For
85*5113495bSYour Name 			each dword read (4 bytes), the byte 0 is swapped with byte 3
86*5113495bSYour Name 			and byte 1 is swapped with byte 2.
87*5113495bSYour Name 
88*5113495bSYour Name 			In case of gather field in first source ring entry of
89*5113495bSYour Name 			the gather copy cycle in taken into account.
90*5113495bSYour Name 
91*5113495bSYour Name 			<legal all>
92*5113495bSYour Name 
93*5113495bSYour Name dest_swap
94*5113495bSYour Name 
95*5113495bSYour Name 			Treats destination memory organization as big-endian.
96*5113495bSYour Name 			For each dword write (4 bytes), the byte 0 is swapped with
97*5113495bSYour Name 			byte 3 and byte 1 is swapped with byte 2.
98*5113495bSYour Name 
99*5113495bSYour Name 			In case of gather field in first source ring entry of
100*5113495bSYour Name 			the gather copy cycle in taken into account.
101*5113495bSYour Name 
102*5113495bSYour Name 			<legal all>
103*5113495bSYour Name 
104*5113495bSYour Name gather
105*5113495bSYour Name 
106*5113495bSYour Name 			Enables gather of multiple copy engine source
107*5113495bSYour Name 			descriptors to one destination.
108*5113495bSYour Name 
109*5113495bSYour Name 			<legal all>
110*5113495bSYour Name 
111*5113495bSYour Name ce_res_0
112*5113495bSYour Name 
113*5113495bSYour Name 			Reserved
114*5113495bSYour Name 
115*5113495bSYour Name 			<legal all>
116*5113495bSYour Name 
117*5113495bSYour Name length
118*5113495bSYour Name 
119*5113495bSYour Name 			Length of the buffer in units of octets of the current
120*5113495bSYour Name 			descriptor
121*5113495bSYour Name 
122*5113495bSYour Name 			<legal all>
123*5113495bSYour Name 
124*5113495bSYour Name fw_metadata
125*5113495bSYour Name 
126*5113495bSYour Name 			Meta data used by FW
127*5113495bSYour Name 
128*5113495bSYour Name 			In case of gather field in first source ring entry of
129*5113495bSYour Name 			the gather copy cycle in taken into account.
130*5113495bSYour Name 
131*5113495bSYour Name 			<legal all>
132*5113495bSYour Name 
133*5113495bSYour Name ce_res_1
134*5113495bSYour Name 
135*5113495bSYour Name 			Reserved
136*5113495bSYour Name 
137*5113495bSYour Name 			<legal all>
138*5113495bSYour Name 
139*5113495bSYour Name ce_res_2
140*5113495bSYour Name 
141*5113495bSYour Name 			Reserved
142*5113495bSYour Name 
143*5113495bSYour Name 			<legal all>
144*5113495bSYour Name 
145*5113495bSYour Name ring_id
146*5113495bSYour Name 
147*5113495bSYour Name 			The buffer pointer ring ID.
148*5113495bSYour Name 
149*5113495bSYour Name 			0 refers to the IDLE ring
150*5113495bSYour Name 
151*5113495bSYour Name 			1 - N refers to other rings
152*5113495bSYour Name 
153*5113495bSYour Name 
154*5113495bSYour Name 
155*5113495bSYour Name 			Helps with debugging when dumping ring contents.
156*5113495bSYour Name 
157*5113495bSYour Name 			<legal all>
158*5113495bSYour Name 
159*5113495bSYour Name looping_count
160*5113495bSYour Name 
161*5113495bSYour Name 			A count value that indicates the number of times the
162*5113495bSYour Name 			producer of entries into the Ring has looped around the
163*5113495bSYour Name 			ring.
164*5113495bSYour Name 
165*5113495bSYour Name 			At initialization time, this value is set to 0. On the
166*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
167*5113495bSYour Name 			reached allowed by the number of bits for this field, the
168*5113495bSYour Name 			count value continues with 0 again.
169*5113495bSYour Name 
170*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
171*5113495bSYour Name 			use this field to figure out up to where the producer of
172*5113495bSYour Name 			entries has created new entries. This eliminates the need to
173*5113495bSYour Name 			check where the head pointer' of the ring is located once
174*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
175*5113495bSYour Name 			entries have been put into this ring...
176*5113495bSYour Name 
177*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
178*5113495bSYour Name 			LSB bit of this count value.
179*5113495bSYour Name 
180*5113495bSYour Name 			<legal all>
181*5113495bSYour Name */
182*5113495bSYour Name 
183*5113495bSYour Name 
184*5113495bSYour Name /* Description		CE_SRC_DESC_0_SRC_BUFFER_LOW
185*5113495bSYour Name 
186*5113495bSYour Name 			LSB 32 bits of the 40 Bit Pointer to the source buffer
187*5113495bSYour Name 
188*5113495bSYour Name 			<legal all>
189*5113495bSYour Name */
190*5113495bSYour Name #define CE_SRC_DESC_0_SRC_BUFFER_LOW_OFFSET                          0x00000000
191*5113495bSYour Name #define CE_SRC_DESC_0_SRC_BUFFER_LOW_LSB                             0
192*5113495bSYour Name #define CE_SRC_DESC_0_SRC_BUFFER_LOW_MASK                            0xffffffff
193*5113495bSYour Name 
194*5113495bSYour Name /* Description		CE_SRC_DESC_1_SRC_BUFFER_HIGH
195*5113495bSYour Name 
196*5113495bSYour Name 			MSB 8 bits of the 40 Bit Pointer to the source buffer
197*5113495bSYour Name 
198*5113495bSYour Name 			<legal all>
199*5113495bSYour Name */
200*5113495bSYour Name #define CE_SRC_DESC_1_SRC_BUFFER_HIGH_OFFSET                         0x00000004
201*5113495bSYour Name #define CE_SRC_DESC_1_SRC_BUFFER_HIGH_LSB                            0
202*5113495bSYour Name #define CE_SRC_DESC_1_SRC_BUFFER_HIGH_MASK                           0x000000ff
203*5113495bSYour Name 
204*5113495bSYour Name /* Description		CE_SRC_DESC_1_TOEPLITZ_EN
205*5113495bSYour Name 
206*5113495bSYour Name 			Enable generation of 32-bit Toeplitz-LFSR hash for the
207*5113495bSYour Name 			data transfer
208*5113495bSYour Name 
209*5113495bSYour Name 			In case of gather field in first source ring entry of
210*5113495bSYour Name 			the gather copy cycle in taken into account.
211*5113495bSYour Name 
212*5113495bSYour Name 			<legal all>
213*5113495bSYour Name */
214*5113495bSYour Name #define CE_SRC_DESC_1_TOEPLITZ_EN_OFFSET                             0x00000004
215*5113495bSYour Name #define CE_SRC_DESC_1_TOEPLITZ_EN_LSB                                8
216*5113495bSYour Name #define CE_SRC_DESC_1_TOEPLITZ_EN_MASK                               0x00000100
217*5113495bSYour Name 
218*5113495bSYour Name /* Description		CE_SRC_DESC_1_SRC_SWAP
219*5113495bSYour Name 
220*5113495bSYour Name 			Treats source memory organization as big-endian. For
221*5113495bSYour Name 			each dword read (4 bytes), the byte 0 is swapped with byte 3
222*5113495bSYour Name 			and byte 1 is swapped with byte 2.
223*5113495bSYour Name 
224*5113495bSYour Name 			In case of gather field in first source ring entry of
225*5113495bSYour Name 			the gather copy cycle in taken into account.
226*5113495bSYour Name 
227*5113495bSYour Name 			<legal all>
228*5113495bSYour Name */
229*5113495bSYour Name #define CE_SRC_DESC_1_SRC_SWAP_OFFSET                                0x00000004
230*5113495bSYour Name #define CE_SRC_DESC_1_SRC_SWAP_LSB                                   9
231*5113495bSYour Name #define CE_SRC_DESC_1_SRC_SWAP_MASK                                  0x00000200
232*5113495bSYour Name 
233*5113495bSYour Name /* Description		CE_SRC_DESC_1_DEST_SWAP
234*5113495bSYour Name 
235*5113495bSYour Name 			Treats destination memory organization as big-endian.
236*5113495bSYour Name 			For each dword write (4 bytes), the byte 0 is swapped with
237*5113495bSYour Name 			byte 3 and byte 1 is swapped with byte 2.
238*5113495bSYour Name 
239*5113495bSYour Name 			In case of gather field in first source ring entry of
240*5113495bSYour Name 			the gather copy cycle in taken into account.
241*5113495bSYour Name 
242*5113495bSYour Name 			<legal all>
243*5113495bSYour Name */
244*5113495bSYour Name #define CE_SRC_DESC_1_DEST_SWAP_OFFSET                               0x00000004
245*5113495bSYour Name #define CE_SRC_DESC_1_DEST_SWAP_LSB                                  10
246*5113495bSYour Name #define CE_SRC_DESC_1_DEST_SWAP_MASK                                 0x00000400
247*5113495bSYour Name 
248*5113495bSYour Name /* Description		CE_SRC_DESC_1_GATHER
249*5113495bSYour Name 
250*5113495bSYour Name 			Enables gather of multiple copy engine source
251*5113495bSYour Name 			descriptors to one destination.
252*5113495bSYour Name 
253*5113495bSYour Name 			<legal all>
254*5113495bSYour Name */
255*5113495bSYour Name #define CE_SRC_DESC_1_GATHER_OFFSET                                  0x00000004
256*5113495bSYour Name #define CE_SRC_DESC_1_GATHER_LSB                                     11
257*5113495bSYour Name #define CE_SRC_DESC_1_GATHER_MASK                                    0x00000800
258*5113495bSYour Name 
259*5113495bSYour Name /* Description		CE_SRC_DESC_1_CE_RES_0
260*5113495bSYour Name 
261*5113495bSYour Name 			Reserved
262*5113495bSYour Name 
263*5113495bSYour Name 			<legal all>
264*5113495bSYour Name */
265*5113495bSYour Name #define CE_SRC_DESC_1_CE_RES_0_OFFSET                                0x00000004
266*5113495bSYour Name #define CE_SRC_DESC_1_CE_RES_0_LSB                                   12
267*5113495bSYour Name #define CE_SRC_DESC_1_CE_RES_0_MASK                                  0x0000f000
268*5113495bSYour Name 
269*5113495bSYour Name /* Description		CE_SRC_DESC_1_LENGTH
270*5113495bSYour Name 
271*5113495bSYour Name 			Length of the buffer in units of octets of the current
272*5113495bSYour Name 			descriptor
273*5113495bSYour Name 
274*5113495bSYour Name 			<legal all>
275*5113495bSYour Name */
276*5113495bSYour Name #define CE_SRC_DESC_1_LENGTH_OFFSET                                  0x00000004
277*5113495bSYour Name #define CE_SRC_DESC_1_LENGTH_LSB                                     16
278*5113495bSYour Name #define CE_SRC_DESC_1_LENGTH_MASK                                    0xffff0000
279*5113495bSYour Name 
280*5113495bSYour Name /* Description		CE_SRC_DESC_2_FW_METADATA
281*5113495bSYour Name 
282*5113495bSYour Name 			Meta data used by FW
283*5113495bSYour Name 
284*5113495bSYour Name 			In case of gather field in first source ring entry of
285*5113495bSYour Name 			the gather copy cycle in taken into account.
286*5113495bSYour Name 
287*5113495bSYour Name 			<legal all>
288*5113495bSYour Name */
289*5113495bSYour Name #define CE_SRC_DESC_2_FW_METADATA_OFFSET                             0x00000008
290*5113495bSYour Name #define CE_SRC_DESC_2_FW_METADATA_LSB                                0
291*5113495bSYour Name #define CE_SRC_DESC_2_FW_METADATA_MASK                               0x0000ffff
292*5113495bSYour Name 
293*5113495bSYour Name /* Description		CE_SRC_DESC_2_CE_RES_1
294*5113495bSYour Name 
295*5113495bSYour Name 			Reserved
296*5113495bSYour Name 
297*5113495bSYour Name 			<legal all>
298*5113495bSYour Name */
299*5113495bSYour Name #define CE_SRC_DESC_2_CE_RES_1_OFFSET                                0x00000008
300*5113495bSYour Name #define CE_SRC_DESC_2_CE_RES_1_LSB                                   16
301*5113495bSYour Name #define CE_SRC_DESC_2_CE_RES_1_MASK                                  0xffff0000
302*5113495bSYour Name 
303*5113495bSYour Name /* Description		CE_SRC_DESC_3_CE_RES_2
304*5113495bSYour Name 
305*5113495bSYour Name 			Reserved
306*5113495bSYour Name 
307*5113495bSYour Name 			<legal all>
308*5113495bSYour Name */
309*5113495bSYour Name #define CE_SRC_DESC_3_CE_RES_2_OFFSET                                0x0000000c
310*5113495bSYour Name #define CE_SRC_DESC_3_CE_RES_2_LSB                                   0
311*5113495bSYour Name #define CE_SRC_DESC_3_CE_RES_2_MASK                                  0x000fffff
312*5113495bSYour Name 
313*5113495bSYour Name /* Description		CE_SRC_DESC_3_RING_ID
314*5113495bSYour Name 
315*5113495bSYour Name 			The buffer pointer ring ID.
316*5113495bSYour Name 
317*5113495bSYour Name 			0 refers to the IDLE ring
318*5113495bSYour Name 
319*5113495bSYour Name 			1 - N refers to other rings
320*5113495bSYour Name 
321*5113495bSYour Name 
322*5113495bSYour Name 
323*5113495bSYour Name 			Helps with debugging when dumping ring contents.
324*5113495bSYour Name 
325*5113495bSYour Name 			<legal all>
326*5113495bSYour Name */
327*5113495bSYour Name #define CE_SRC_DESC_3_RING_ID_OFFSET                                 0x0000000c
328*5113495bSYour Name #define CE_SRC_DESC_3_RING_ID_LSB                                    20
329*5113495bSYour Name #define CE_SRC_DESC_3_RING_ID_MASK                                   0x0ff00000
330*5113495bSYour Name 
331*5113495bSYour Name /* Description		CE_SRC_DESC_3_LOOPING_COUNT
332*5113495bSYour Name 
333*5113495bSYour Name 			A count value that indicates the number of times the
334*5113495bSYour Name 			producer of entries into the Ring has looped around the
335*5113495bSYour Name 			ring.
336*5113495bSYour Name 
337*5113495bSYour Name 			At initialization time, this value is set to 0. On the
338*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
339*5113495bSYour Name 			reached allowed by the number of bits for this field, the
340*5113495bSYour Name 			count value continues with 0 again.
341*5113495bSYour Name 
342*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
343*5113495bSYour Name 			use this field to figure out up to where the producer of
344*5113495bSYour Name 			entries has created new entries. This eliminates the need to
345*5113495bSYour Name 			check where the head pointer' of the ring is located once
346*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
347*5113495bSYour Name 			entries have been put into this ring...
348*5113495bSYour Name 
349*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
350*5113495bSYour Name 			LSB bit of this count value.
351*5113495bSYour Name 
352*5113495bSYour Name 			<legal all>
353*5113495bSYour Name */
354*5113495bSYour Name #define CE_SRC_DESC_3_LOOPING_COUNT_OFFSET                           0x0000000c
355*5113495bSYour Name #define CE_SRC_DESC_3_LOOPING_COUNT_LSB                              28
356*5113495bSYour Name #define CE_SRC_DESC_3_LOOPING_COUNT_MASK                             0xf0000000
357*5113495bSYour Name 
358*5113495bSYour Name 
359*5113495bSYour Name #endif // _CE_SRC_DESC_H_
360