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