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