xref: /wlan-driver/fw-api/hw/qca6290/v2/tcl_gse_cmd.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 _TCL_GSE_CMD_H_
25*5113495bSYour Name #define _TCL_GSE_CMD_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	control_buffer_addr_31_0[31:0]
34*5113495bSYour Name //	1	control_buffer_addr_39_32[7:0], gse_ctrl[11:8], gse_sel[12], status_destination_ring_id[13], swap[14], reserved_1a[31:15]
35*5113495bSYour Name //	2	cmd_meta_data_31_0[31:0]
36*5113495bSYour Name //	3	cmd_meta_data_63_32[31:0]
37*5113495bSYour Name //	4	reserved_4a[31:0]
38*5113495bSYour Name //	5	reserved_5a[31:0]
39*5113495bSYour Name //	6	reserved_6a[19:0], ring_id[27:20], looping_count[31:28]
40*5113495bSYour Name //
41*5113495bSYour Name // ################ END SUMMARY #################
42*5113495bSYour Name 
43*5113495bSYour Name #define NUM_OF_DWORDS_TCL_GSE_CMD 7
44*5113495bSYour Name 
45*5113495bSYour Name struct tcl_gse_cmd {
46*5113495bSYour Name              uint32_t control_buffer_addr_31_0        : 32; //[31:0]
47*5113495bSYour Name              uint32_t control_buffer_addr_39_32       :  8, //[7:0]
48*5113495bSYour Name                       gse_ctrl                        :  4, //[11:8]
49*5113495bSYour Name                       gse_sel                         :  1, //[12]
50*5113495bSYour Name                       status_destination_ring_id      :  1, //[13]
51*5113495bSYour Name                       swap                            :  1, //[14]
52*5113495bSYour Name                       reserved_1a                     : 17; //[31:15]
53*5113495bSYour Name              uint32_t cmd_meta_data_31_0              : 32; //[31:0]
54*5113495bSYour Name              uint32_t cmd_meta_data_63_32             : 32; //[31:0]
55*5113495bSYour Name              uint32_t reserved_4a                     : 32; //[31:0]
56*5113495bSYour Name              uint32_t reserved_5a                     : 32; //[31:0]
57*5113495bSYour Name              uint32_t reserved_6a                     : 20, //[19:0]
58*5113495bSYour Name                       ring_id                         :  8, //[27:20]
59*5113495bSYour Name                       looping_count                   :  4; //[31:28]
60*5113495bSYour Name };
61*5113495bSYour Name 
62*5113495bSYour Name /*
63*5113495bSYour Name 
64*5113495bSYour Name control_buffer_addr_31_0
65*5113495bSYour Name 
66*5113495bSYour Name 			Address (lower 32 bits) of a control buffer containing
67*5113495bSYour Name 			additional info needed for this command execution.
68*5113495bSYour Name 
69*5113495bSYour Name 			<legal all>
70*5113495bSYour Name 
71*5113495bSYour Name control_buffer_addr_39_32
72*5113495bSYour Name 
73*5113495bSYour Name 			Address (upper 8 bits) of a control buffer containing
74*5113495bSYour Name 			additional info needed for this command execution.
75*5113495bSYour Name 
76*5113495bSYour Name 			<legal all>
77*5113495bSYour Name 
78*5113495bSYour Name gse_ctrl
79*5113495bSYour Name 
80*5113495bSYour Name 			GSE control operations. This includes cache operations
81*5113495bSYour Name 			and table entry statistics read/clear operation.
82*5113495bSYour Name 
83*5113495bSYour Name 			<enum 0 rd_stat> Report or Read statistics
84*5113495bSYour Name 
85*5113495bSYour Name 			<enum 1 srch_dis> Search disable. Report only Hash
86*5113495bSYour Name 
87*5113495bSYour Name 			<enum 2 Wr_bk_single> Write Back single entry
88*5113495bSYour Name 
89*5113495bSYour Name 			<enum 3 wr_bk_all> Write Back entire cache entry
90*5113495bSYour Name 
91*5113495bSYour Name 			<enum 4 inval_single> Invalidate single cache entry
92*5113495bSYour Name 
93*5113495bSYour Name 			<enum 5 inval_all> Invalidate entire cache
94*5113495bSYour Name 
95*5113495bSYour Name 			<enum 6 wr_bk_inval_single> Write back and Invalidate
96*5113495bSYour Name 			single entry in cache
97*5113495bSYour Name 
98*5113495bSYour Name 			<enum 7 wr_bk_inval_all> write back and invalidate
99*5113495bSYour Name 			entire cache
100*5113495bSYour Name 
101*5113495bSYour Name 			<enum 8 clr_stat_single> Clear statistics for single
102*5113495bSYour Name 			entry
103*5113495bSYour Name 
104*5113495bSYour Name 			<legal 0-8>
105*5113495bSYour Name 
106*5113495bSYour Name 			Rest of the values reserved.
107*5113495bSYour Name 
108*5113495bSYour Name 			For all single entry control operations (write back,
109*5113495bSYour Name 			Invalidate or both)Statistics will be reported
110*5113495bSYour Name 
111*5113495bSYour Name gse_sel
112*5113495bSYour Name 
113*5113495bSYour Name 			Bit to select the ASE or FSE to do the operation mention
114*5113495bSYour Name 			by GSE_ctrl bit
115*5113495bSYour Name 
116*5113495bSYour Name 			0: FSE select
117*5113495bSYour Name 
118*5113495bSYour Name 			1: ASE select
119*5113495bSYour Name 
120*5113495bSYour Name status_destination_ring_id
121*5113495bSYour Name 
122*5113495bSYour Name 			The TCL status ring to which the GSE status needs to be
123*5113495bSYour Name 			send.
124*5113495bSYour Name 
125*5113495bSYour Name 
126*5113495bSYour Name 
127*5113495bSYour Name 			<enum 0 tcl_status_0_ring>
128*5113495bSYour Name 
129*5113495bSYour Name 			<enum 1 tcl_status_1_ring>
130*5113495bSYour Name 
131*5113495bSYour Name 
132*5113495bSYour Name 
133*5113495bSYour Name 			<legal all>
134*5113495bSYour Name 
135*5113495bSYour Name swap
136*5113495bSYour Name 
137*5113495bSYour Name 			Bit to enable byte swapping of contents of buffer
138*5113495bSYour Name 
139*5113495bSYour Name 			<enum 0 Byte_swap_disable >
140*5113495bSYour Name 
141*5113495bSYour Name 			<enum 1 byte_swap_enable >
142*5113495bSYour Name 
143*5113495bSYour Name 			<legal all>
144*5113495bSYour Name 
145*5113495bSYour Name reserved_1a
146*5113495bSYour Name 
147*5113495bSYour Name 			<legal 0>
148*5113495bSYour Name 
149*5113495bSYour Name cmd_meta_data_31_0
150*5113495bSYour Name 
151*5113495bSYour Name 			Meta data to be returned in the status descriptor
152*5113495bSYour Name 
153*5113495bSYour Name 			<legal all>
154*5113495bSYour Name 
155*5113495bSYour Name cmd_meta_data_63_32
156*5113495bSYour Name 
157*5113495bSYour Name 			Meta data to be returned in the status descriptor
158*5113495bSYour Name 
159*5113495bSYour Name 			<legal all>
160*5113495bSYour Name 
161*5113495bSYour Name reserved_4a
162*5113495bSYour Name 
163*5113495bSYour Name 			<legal 0>
164*5113495bSYour Name 
165*5113495bSYour Name reserved_5a
166*5113495bSYour Name 
167*5113495bSYour Name 			<legal 0>
168*5113495bSYour Name 
169*5113495bSYour Name reserved_6a
170*5113495bSYour Name 
171*5113495bSYour Name 			<legal 0>
172*5113495bSYour Name 
173*5113495bSYour Name ring_id
174*5113495bSYour Name 
175*5113495bSYour Name 			Helps with debugging when dumping ring contents.
176*5113495bSYour Name 
177*5113495bSYour Name 			<legal all>
178*5113495bSYour Name 
179*5113495bSYour Name looping_count
180*5113495bSYour Name 
181*5113495bSYour Name 			A count value that indicates the number of times the
182*5113495bSYour Name 			producer of entries into the Ring has looped around the
183*5113495bSYour Name 			ring.
184*5113495bSYour Name 
185*5113495bSYour Name 			At initialization time, this value is set to 0. On the
186*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
187*5113495bSYour Name 			reached allowed by the number of bits for this field, the
188*5113495bSYour Name 			count value continues with 0 again.
189*5113495bSYour Name 
190*5113495bSYour Name 
191*5113495bSYour Name 
192*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
193*5113495bSYour Name 			use this field to figure out up to where the producer of
194*5113495bSYour Name 			entries has created new entries. This eliminates the need to
195*5113495bSYour Name 			check where the head pointer' of the ring is located once
196*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
197*5113495bSYour Name 			entries have been put into this ring...
198*5113495bSYour Name 
199*5113495bSYour Name 
200*5113495bSYour Name 
201*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
202*5113495bSYour Name 			LSB bit of this count value.
203*5113495bSYour Name 
204*5113495bSYour Name 			<legal all>
205*5113495bSYour Name */
206*5113495bSYour Name 
207*5113495bSYour Name 
208*5113495bSYour Name /* Description		TCL_GSE_CMD_0_CONTROL_BUFFER_ADDR_31_0
209*5113495bSYour Name 
210*5113495bSYour Name 			Address (lower 32 bits) of a control buffer containing
211*5113495bSYour Name 			additional info needed for this command execution.
212*5113495bSYour Name 
213*5113495bSYour Name 			<legal all>
214*5113495bSYour Name */
215*5113495bSYour Name #define TCL_GSE_CMD_0_CONTROL_BUFFER_ADDR_31_0_OFFSET                0x00000000
216*5113495bSYour Name #define TCL_GSE_CMD_0_CONTROL_BUFFER_ADDR_31_0_LSB                   0
217*5113495bSYour Name #define TCL_GSE_CMD_0_CONTROL_BUFFER_ADDR_31_0_MASK                  0xffffffff
218*5113495bSYour Name 
219*5113495bSYour Name /* Description		TCL_GSE_CMD_1_CONTROL_BUFFER_ADDR_39_32
220*5113495bSYour Name 
221*5113495bSYour Name 			Address (upper 8 bits) of a control buffer containing
222*5113495bSYour Name 			additional info needed for this command execution.
223*5113495bSYour Name 
224*5113495bSYour Name 			<legal all>
225*5113495bSYour Name */
226*5113495bSYour Name #define TCL_GSE_CMD_1_CONTROL_BUFFER_ADDR_39_32_OFFSET               0x00000004
227*5113495bSYour Name #define TCL_GSE_CMD_1_CONTROL_BUFFER_ADDR_39_32_LSB                  0
228*5113495bSYour Name #define TCL_GSE_CMD_1_CONTROL_BUFFER_ADDR_39_32_MASK                 0x000000ff
229*5113495bSYour Name 
230*5113495bSYour Name /* Description		TCL_GSE_CMD_1_GSE_CTRL
231*5113495bSYour Name 
232*5113495bSYour Name 			GSE control operations. This includes cache operations
233*5113495bSYour Name 			and table entry statistics read/clear operation.
234*5113495bSYour Name 
235*5113495bSYour Name 			<enum 0 rd_stat> Report or Read statistics
236*5113495bSYour Name 
237*5113495bSYour Name 			<enum 1 srch_dis> Search disable. Report only Hash
238*5113495bSYour Name 
239*5113495bSYour Name 			<enum 2 Wr_bk_single> Write Back single entry
240*5113495bSYour Name 
241*5113495bSYour Name 			<enum 3 wr_bk_all> Write Back entire cache entry
242*5113495bSYour Name 
243*5113495bSYour Name 			<enum 4 inval_single> Invalidate single cache entry
244*5113495bSYour Name 
245*5113495bSYour Name 			<enum 5 inval_all> Invalidate entire cache
246*5113495bSYour Name 
247*5113495bSYour Name 			<enum 6 wr_bk_inval_single> Write back and Invalidate
248*5113495bSYour Name 			single entry in cache
249*5113495bSYour Name 
250*5113495bSYour Name 			<enum 7 wr_bk_inval_all> write back and invalidate
251*5113495bSYour Name 			entire cache
252*5113495bSYour Name 
253*5113495bSYour Name 			<enum 8 clr_stat_single> Clear statistics for single
254*5113495bSYour Name 			entry
255*5113495bSYour Name 
256*5113495bSYour Name 			<legal 0-8>
257*5113495bSYour Name 
258*5113495bSYour Name 			Rest of the values reserved.
259*5113495bSYour Name 
260*5113495bSYour Name 			For all single entry control operations (write back,
261*5113495bSYour Name 			Invalidate or both)Statistics will be reported
262*5113495bSYour Name */
263*5113495bSYour Name #define TCL_GSE_CMD_1_GSE_CTRL_OFFSET                                0x00000004
264*5113495bSYour Name #define TCL_GSE_CMD_1_GSE_CTRL_LSB                                   8
265*5113495bSYour Name #define TCL_GSE_CMD_1_GSE_CTRL_MASK                                  0x00000f00
266*5113495bSYour Name 
267*5113495bSYour Name /* Description		TCL_GSE_CMD_1_GSE_SEL
268*5113495bSYour Name 
269*5113495bSYour Name 			Bit to select the ASE or FSE to do the operation mention
270*5113495bSYour Name 			by GSE_ctrl bit
271*5113495bSYour Name 
272*5113495bSYour Name 			0: FSE select
273*5113495bSYour Name 
274*5113495bSYour Name 			1: ASE select
275*5113495bSYour Name */
276*5113495bSYour Name #define TCL_GSE_CMD_1_GSE_SEL_OFFSET                                 0x00000004
277*5113495bSYour Name #define TCL_GSE_CMD_1_GSE_SEL_LSB                                    12
278*5113495bSYour Name #define TCL_GSE_CMD_1_GSE_SEL_MASK                                   0x00001000
279*5113495bSYour Name 
280*5113495bSYour Name /* Description		TCL_GSE_CMD_1_STATUS_DESTINATION_RING_ID
281*5113495bSYour Name 
282*5113495bSYour Name 			The TCL status ring to which the GSE status needs to be
283*5113495bSYour Name 			send.
284*5113495bSYour Name 
285*5113495bSYour Name 
286*5113495bSYour Name 
287*5113495bSYour Name 			<enum 0 tcl_status_0_ring>
288*5113495bSYour Name 
289*5113495bSYour Name 			<enum 1 tcl_status_1_ring>
290*5113495bSYour Name 
291*5113495bSYour Name 
292*5113495bSYour Name 
293*5113495bSYour Name 			<legal all>
294*5113495bSYour Name */
295*5113495bSYour Name #define TCL_GSE_CMD_1_STATUS_DESTINATION_RING_ID_OFFSET              0x00000004
296*5113495bSYour Name #define TCL_GSE_CMD_1_STATUS_DESTINATION_RING_ID_LSB                 13
297*5113495bSYour Name #define TCL_GSE_CMD_1_STATUS_DESTINATION_RING_ID_MASK                0x00002000
298*5113495bSYour Name 
299*5113495bSYour Name /* Description		TCL_GSE_CMD_1_SWAP
300*5113495bSYour Name 
301*5113495bSYour Name 			Bit to enable byte swapping of contents of buffer
302*5113495bSYour Name 
303*5113495bSYour Name 			<enum 0 Byte_swap_disable >
304*5113495bSYour Name 
305*5113495bSYour Name 			<enum 1 byte_swap_enable >
306*5113495bSYour Name 
307*5113495bSYour Name 			<legal all>
308*5113495bSYour Name */
309*5113495bSYour Name #define TCL_GSE_CMD_1_SWAP_OFFSET                                    0x00000004
310*5113495bSYour Name #define TCL_GSE_CMD_1_SWAP_LSB                                       14
311*5113495bSYour Name #define TCL_GSE_CMD_1_SWAP_MASK                                      0x00004000
312*5113495bSYour Name 
313*5113495bSYour Name /* Description		TCL_GSE_CMD_1_RESERVED_1A
314*5113495bSYour Name 
315*5113495bSYour Name 			<legal 0>
316*5113495bSYour Name */
317*5113495bSYour Name #define TCL_GSE_CMD_1_RESERVED_1A_OFFSET                             0x00000004
318*5113495bSYour Name #define TCL_GSE_CMD_1_RESERVED_1A_LSB                                15
319*5113495bSYour Name #define TCL_GSE_CMD_1_RESERVED_1A_MASK                               0xffff8000
320*5113495bSYour Name 
321*5113495bSYour Name /* Description		TCL_GSE_CMD_2_CMD_META_DATA_31_0
322*5113495bSYour Name 
323*5113495bSYour Name 			Meta data to be returned in the status descriptor
324*5113495bSYour Name 
325*5113495bSYour Name 			<legal all>
326*5113495bSYour Name */
327*5113495bSYour Name #define TCL_GSE_CMD_2_CMD_META_DATA_31_0_OFFSET                      0x00000008
328*5113495bSYour Name #define TCL_GSE_CMD_2_CMD_META_DATA_31_0_LSB                         0
329*5113495bSYour Name #define TCL_GSE_CMD_2_CMD_META_DATA_31_0_MASK                        0xffffffff
330*5113495bSYour Name 
331*5113495bSYour Name /* Description		TCL_GSE_CMD_3_CMD_META_DATA_63_32
332*5113495bSYour Name 
333*5113495bSYour Name 			Meta data to be returned in the status descriptor
334*5113495bSYour Name 
335*5113495bSYour Name 			<legal all>
336*5113495bSYour Name */
337*5113495bSYour Name #define TCL_GSE_CMD_3_CMD_META_DATA_63_32_OFFSET                     0x0000000c
338*5113495bSYour Name #define TCL_GSE_CMD_3_CMD_META_DATA_63_32_LSB                        0
339*5113495bSYour Name #define TCL_GSE_CMD_3_CMD_META_DATA_63_32_MASK                       0xffffffff
340*5113495bSYour Name 
341*5113495bSYour Name /* Description		TCL_GSE_CMD_4_RESERVED_4A
342*5113495bSYour Name 
343*5113495bSYour Name 			<legal 0>
344*5113495bSYour Name */
345*5113495bSYour Name #define TCL_GSE_CMD_4_RESERVED_4A_OFFSET                             0x00000010
346*5113495bSYour Name #define TCL_GSE_CMD_4_RESERVED_4A_LSB                                0
347*5113495bSYour Name #define TCL_GSE_CMD_4_RESERVED_4A_MASK                               0xffffffff
348*5113495bSYour Name 
349*5113495bSYour Name /* Description		TCL_GSE_CMD_5_RESERVED_5A
350*5113495bSYour Name 
351*5113495bSYour Name 			<legal 0>
352*5113495bSYour Name */
353*5113495bSYour Name #define TCL_GSE_CMD_5_RESERVED_5A_OFFSET                             0x00000014
354*5113495bSYour Name #define TCL_GSE_CMD_5_RESERVED_5A_LSB                                0
355*5113495bSYour Name #define TCL_GSE_CMD_5_RESERVED_5A_MASK                               0xffffffff
356*5113495bSYour Name 
357*5113495bSYour Name /* Description		TCL_GSE_CMD_6_RESERVED_6A
358*5113495bSYour Name 
359*5113495bSYour Name 			<legal 0>
360*5113495bSYour Name */
361*5113495bSYour Name #define TCL_GSE_CMD_6_RESERVED_6A_OFFSET                             0x00000018
362*5113495bSYour Name #define TCL_GSE_CMD_6_RESERVED_6A_LSB                                0
363*5113495bSYour Name #define TCL_GSE_CMD_6_RESERVED_6A_MASK                               0x000fffff
364*5113495bSYour Name 
365*5113495bSYour Name /* Description		TCL_GSE_CMD_6_RING_ID
366*5113495bSYour Name 
367*5113495bSYour Name 			Helps with debugging when dumping ring contents.
368*5113495bSYour Name 
369*5113495bSYour Name 			<legal all>
370*5113495bSYour Name */
371*5113495bSYour Name #define TCL_GSE_CMD_6_RING_ID_OFFSET                                 0x00000018
372*5113495bSYour Name #define TCL_GSE_CMD_6_RING_ID_LSB                                    20
373*5113495bSYour Name #define TCL_GSE_CMD_6_RING_ID_MASK                                   0x0ff00000
374*5113495bSYour Name 
375*5113495bSYour Name /* Description		TCL_GSE_CMD_6_LOOPING_COUNT
376*5113495bSYour Name 
377*5113495bSYour Name 			A count value that indicates the number of times the
378*5113495bSYour Name 			producer of entries into the Ring has looped around the
379*5113495bSYour Name 			ring.
380*5113495bSYour Name 
381*5113495bSYour Name 			At initialization time, this value is set to 0. On the
382*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
383*5113495bSYour Name 			reached allowed by the number of bits for this field, the
384*5113495bSYour Name 			count value continues with 0 again.
385*5113495bSYour Name 
386*5113495bSYour Name 
387*5113495bSYour Name 
388*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
389*5113495bSYour Name 			use this field to figure out up to where the producer of
390*5113495bSYour Name 			entries has created new entries. This eliminates the need to
391*5113495bSYour Name 			check where the head pointer' of the ring is located once
392*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
393*5113495bSYour Name 			entries have been put into this ring...
394*5113495bSYour Name 
395*5113495bSYour Name 
396*5113495bSYour Name 
397*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
398*5113495bSYour Name 			LSB bit of this count value.
399*5113495bSYour Name 
400*5113495bSYour Name 			<legal all>
401*5113495bSYour Name */
402*5113495bSYour Name #define TCL_GSE_CMD_6_LOOPING_COUNT_OFFSET                           0x00000018
403*5113495bSYour Name #define TCL_GSE_CMD_6_LOOPING_COUNT_LSB                              28
404*5113495bSYour Name #define TCL_GSE_CMD_6_LOOPING_COUNT_MASK                             0xf0000000
405*5113495bSYour Name 
406*5113495bSYour Name 
407*5113495bSYour Name #endif // _TCL_GSE_CMD_H_
408