xref: /wlan-driver/fw-api/hw/qca6290/11ax/v2/tcl_status_ring.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_STATUS_RING_H_
20*5113495bSYour Name #define _TCL_STATUS_RING_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	gse_ctrl[3:0], ase_fse_sel[4], cache_op_res[6:5], index_search_en[7], msdu_cnt_n[31:8]
29*5113495bSYour Name //	1	msdu_byte_cnt_n[31:0]
30*5113495bSYour Name //	2	msdu_timestmp_n[31:0]
31*5113495bSYour Name //	3	cmd_meta_data_31_0[31:0]
32*5113495bSYour Name //	4	cmd_meta_data_63_32[31:0]
33*5113495bSYour Name //	5	hash_indx_val[19:0], cache_set_num[23:20], reserved_5a[31:24]
34*5113495bSYour Name //	6	reserved_6a[31:0]
35*5113495bSYour Name //	7	reserved_7a[19:0], ring_id[27:20], looping_count[31:28]
36*5113495bSYour Name //
37*5113495bSYour Name // ################ END SUMMARY #################
38*5113495bSYour Name 
39*5113495bSYour Name #define NUM_OF_DWORDS_TCL_STATUS_RING 8
40*5113495bSYour Name 
41*5113495bSYour Name struct tcl_status_ring {
42*5113495bSYour Name              uint32_t gse_ctrl                        :  4, //[3:0]
43*5113495bSYour Name                       ase_fse_sel                     :  1, //[4]
44*5113495bSYour Name                       cache_op_res                    :  2, //[6:5]
45*5113495bSYour Name                       index_search_en                 :  1, //[7]
46*5113495bSYour Name                       msdu_cnt_n                      : 24; //[31:8]
47*5113495bSYour Name              uint32_t msdu_byte_cnt_n                 : 32; //[31:0]
48*5113495bSYour Name              uint32_t msdu_timestmp_n                 : 32; //[31:0]
49*5113495bSYour Name              uint32_t cmd_meta_data_31_0              : 32; //[31:0]
50*5113495bSYour Name              uint32_t cmd_meta_data_63_32             : 32; //[31:0]
51*5113495bSYour Name              uint32_t hash_indx_val                   : 20, //[19:0]
52*5113495bSYour Name                       cache_set_num                   :  4, //[23:20]
53*5113495bSYour Name                       reserved_5a                     :  8; //[31:24]
54*5113495bSYour Name              uint32_t reserved_6a                     : 32; //[31:0]
55*5113495bSYour Name              uint32_t reserved_7a                     : 20, //[19:0]
56*5113495bSYour Name                       ring_id                         :  8, //[27:20]
57*5113495bSYour Name                       looping_count                   :  4; //[31:28]
58*5113495bSYour Name };
59*5113495bSYour Name 
60*5113495bSYour Name /*
61*5113495bSYour Name 
62*5113495bSYour Name gse_ctrl
63*5113495bSYour Name 
64*5113495bSYour Name 			GSE control operations. This includes cache operations
65*5113495bSYour Name 			and table entry statistics read/clear operation.
66*5113495bSYour Name 
67*5113495bSYour Name 			<enum 0 rd_stat> Report or Read statistics
68*5113495bSYour Name 
69*5113495bSYour Name 			<enum 1 srch_dis> Search disable. Report only Hash
70*5113495bSYour Name 
71*5113495bSYour Name 			<enum 2 Wr_bk_single> Write Back single entry
72*5113495bSYour Name 
73*5113495bSYour Name 			<enum 3 wr_bk_all> Write Back entire cache entry
74*5113495bSYour Name 
75*5113495bSYour Name 			<enum 4 inval_single> Invalidate single cache entry
76*5113495bSYour Name 
77*5113495bSYour Name 			<enum 5 inval_all> Invalidate entire cache
78*5113495bSYour Name 
79*5113495bSYour Name 			<enum 6 wr_bk_inval_single> Write back and Invalidate
80*5113495bSYour Name 			single entry in cache
81*5113495bSYour Name 
82*5113495bSYour Name 			<enum 7 wr_bk_inval_all> write back and invalidate
83*5113495bSYour Name 			entire cache
84*5113495bSYour Name 
85*5113495bSYour Name 			<enum 8 clr_stat_single> Clear statistics for single
86*5113495bSYour Name 			entry
87*5113495bSYour Name 
88*5113495bSYour Name 			<legal 0-8>
89*5113495bSYour Name 
90*5113495bSYour Name 			Rest of the values reserved.
91*5113495bSYour Name 
92*5113495bSYour Name 			For all single entry control operations (write back,
93*5113495bSYour Name 			Invalidate or both)Statistics will be reported
94*5113495bSYour Name 
95*5113495bSYour Name ase_fse_sel
96*5113495bSYour Name 
97*5113495bSYour Name 			Search Engine for which operation is done.
98*5113495bSYour Name 
99*5113495bSYour Name 			1'b0: Address Search Engine Result
100*5113495bSYour Name 
101*5113495bSYour Name 			1'b1: Flow Search Engine result
102*5113495bSYour Name 
103*5113495bSYour Name cache_op_res
104*5113495bSYour Name 
105*5113495bSYour Name 			Cache operation result. Following are results of cache
106*5113495bSYour Name 			operation.
107*5113495bSYour Name 
108*5113495bSYour Name 			<enum 0 op_done>  Operation successful
109*5113495bSYour Name 
110*5113495bSYour Name 			<enum 1 not_fnd> Entry not found in Table
111*5113495bSYour Name 
112*5113495bSYour Name 			<enum 2 timeout_er>  Timeout Error
113*5113495bSYour Name 
114*5113495bSYour Name 			<legal 0-2>
115*5113495bSYour Name 
116*5113495bSYour Name index_search_en
117*5113495bSYour Name 
118*5113495bSYour Name 			When this bit is set to 1 control_buffer_addr[19:0] will
119*5113495bSYour Name 			be considered as index of the AST or Flow table and GSE
120*5113495bSYour Name 			commands will be executed accordingly on the entry pointed
121*5113495bSYour Name 			by the index.
122*5113495bSYour Name 
123*5113495bSYour Name 			This feature is disabled by setting this bit to 0.
124*5113495bSYour Name 
125*5113495bSYour Name 			<enum 0 index_based_cmd_disable>
126*5113495bSYour Name 
127*5113495bSYour Name 			<enum 1 index_based_cmd_enable>
128*5113495bSYour Name 
129*5113495bSYour Name 
130*5113495bSYour Name 
131*5113495bSYour Name 			<legal all>
132*5113495bSYour Name 
133*5113495bSYour Name msdu_cnt_n
134*5113495bSYour Name 
135*5113495bSYour Name 			MSDU count of Entry. Valid when GSE_CTRL is 4'b0111 and
136*5113495bSYour Name 			4'b1000
137*5113495bSYour Name 
138*5113495bSYour Name msdu_byte_cnt_n
139*5113495bSYour Name 
140*5113495bSYour Name 			MSDU byte count for entry 1. Valid when GSE_CTRL is
141*5113495bSYour Name 			4'b0111 and 4'b1000
142*5113495bSYour Name 
143*5113495bSYour Name msdu_timestmp_n
144*5113495bSYour Name 
145*5113495bSYour Name 			MSDU timestamp for entry 1. Valid when GSE_CTRL is
146*5113495bSYour Name 			4'b0111 and 4'b1000
147*5113495bSYour Name 
148*5113495bSYour Name cmd_meta_data_31_0
149*5113495bSYour Name 
150*5113495bSYour Name 			Meta data from input ring
151*5113495bSYour Name 
152*5113495bSYour Name 			<legal all>
153*5113495bSYour Name 
154*5113495bSYour Name cmd_meta_data_63_32
155*5113495bSYour Name 
156*5113495bSYour Name 			Meta data from input ring
157*5113495bSYour Name 
158*5113495bSYour Name 			<legal all>
159*5113495bSYour Name 
160*5113495bSYour Name hash_indx_val
161*5113495bSYour Name 
162*5113495bSYour Name 
163*5113495bSYour Name 			Hash value of the entry in table in case of search
164*5113495bSYour Name 			failed or search disable.
165*5113495bSYour Name 
166*5113495bSYour Name 			<legal all>
167*5113495bSYour Name 
168*5113495bSYour Name cache_set_num
169*5113495bSYour Name 
170*5113495bSYour Name 			Cache set number copied from TCL_GSE_CMD
171*5113495bSYour Name 
172*5113495bSYour Name reserved_5a
173*5113495bSYour Name 
174*5113495bSYour Name 			<legal 0>
175*5113495bSYour Name 
176*5113495bSYour Name reserved_6a
177*5113495bSYour Name 
178*5113495bSYour Name 			<legal 0>
179*5113495bSYour Name 
180*5113495bSYour Name reserved_7a
181*5113495bSYour Name 
182*5113495bSYour Name 			<legal 0>
183*5113495bSYour Name 
184*5113495bSYour Name ring_id
185*5113495bSYour Name 
186*5113495bSYour Name 			The buffer pointer ring ID.
187*5113495bSYour Name 
188*5113495bSYour Name 
189*5113495bSYour Name 
190*5113495bSYour Name 			Helps with debugging when dumping ring contents.
191*5113495bSYour Name 
192*5113495bSYour Name 			<legal all>
193*5113495bSYour Name 
194*5113495bSYour Name looping_count
195*5113495bSYour Name 
196*5113495bSYour Name 			A count value that indicates the number of times the
197*5113495bSYour Name 			producer of entries into the Ring has looped around the
198*5113495bSYour Name 			ring.
199*5113495bSYour Name 
200*5113495bSYour Name 			At initialization time, this value is set to 0. On the
201*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
202*5113495bSYour Name 			reached allowed by the number of bits for this field, the
203*5113495bSYour Name 			count value continues with 0 again.
204*5113495bSYour Name 
205*5113495bSYour Name 
206*5113495bSYour Name 
207*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
208*5113495bSYour Name 			use this field to figure out up to where the producer of
209*5113495bSYour Name 			entries has created new entries. This eliminates the need to
210*5113495bSYour Name 			check where the head pointer' of the ring is located once
211*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
212*5113495bSYour Name 			entries have been put into this ring...
213*5113495bSYour Name 
214*5113495bSYour Name 
215*5113495bSYour Name 
216*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
217*5113495bSYour Name 			LSB bit of this count value.
218*5113495bSYour Name 
219*5113495bSYour Name 			<legal all>
220*5113495bSYour Name */
221*5113495bSYour Name 
222*5113495bSYour Name 
223*5113495bSYour Name /* Description		TCL_STATUS_RING_0_GSE_CTRL
224*5113495bSYour Name 
225*5113495bSYour Name 			GSE control operations. This includes cache operations
226*5113495bSYour Name 			and table entry statistics read/clear operation.
227*5113495bSYour Name 
228*5113495bSYour Name 			<enum 0 rd_stat> Report or Read statistics
229*5113495bSYour Name 
230*5113495bSYour Name 			<enum 1 srch_dis> Search disable. Report only Hash
231*5113495bSYour Name 
232*5113495bSYour Name 			<enum 2 Wr_bk_single> Write Back single entry
233*5113495bSYour Name 
234*5113495bSYour Name 			<enum 3 wr_bk_all> Write Back entire cache entry
235*5113495bSYour Name 
236*5113495bSYour Name 			<enum 4 inval_single> Invalidate single cache entry
237*5113495bSYour Name 
238*5113495bSYour Name 			<enum 5 inval_all> Invalidate entire cache
239*5113495bSYour Name 
240*5113495bSYour Name 			<enum 6 wr_bk_inval_single> Write back and Invalidate
241*5113495bSYour Name 			single entry in cache
242*5113495bSYour Name 
243*5113495bSYour Name 			<enum 7 wr_bk_inval_all> write back and invalidate
244*5113495bSYour Name 			entire cache
245*5113495bSYour Name 
246*5113495bSYour Name 			<enum 8 clr_stat_single> Clear statistics for single
247*5113495bSYour Name 			entry
248*5113495bSYour Name 
249*5113495bSYour Name 			<legal 0-8>
250*5113495bSYour Name 
251*5113495bSYour Name 			Rest of the values reserved.
252*5113495bSYour Name 
253*5113495bSYour Name 			For all single entry control operations (write back,
254*5113495bSYour Name 			Invalidate or both)Statistics will be reported
255*5113495bSYour Name */
256*5113495bSYour Name #define TCL_STATUS_RING_0_GSE_CTRL_OFFSET                            0x00000000
257*5113495bSYour Name #define TCL_STATUS_RING_0_GSE_CTRL_LSB                               0
258*5113495bSYour Name #define TCL_STATUS_RING_0_GSE_CTRL_MASK                              0x0000000f
259*5113495bSYour Name 
260*5113495bSYour Name /* Description		TCL_STATUS_RING_0_ASE_FSE_SEL
261*5113495bSYour Name 
262*5113495bSYour Name 			Search Engine for which operation is done.
263*5113495bSYour Name 
264*5113495bSYour Name 			1'b0: Address Search Engine Result
265*5113495bSYour Name 
266*5113495bSYour Name 			1'b1: Flow Search Engine result
267*5113495bSYour Name */
268*5113495bSYour Name #define TCL_STATUS_RING_0_ASE_FSE_SEL_OFFSET                         0x00000000
269*5113495bSYour Name #define TCL_STATUS_RING_0_ASE_FSE_SEL_LSB                            4
270*5113495bSYour Name #define TCL_STATUS_RING_0_ASE_FSE_SEL_MASK                           0x00000010
271*5113495bSYour Name 
272*5113495bSYour Name /* Description		TCL_STATUS_RING_0_CACHE_OP_RES
273*5113495bSYour Name 
274*5113495bSYour Name 			Cache operation result. Following are results of cache
275*5113495bSYour Name 			operation.
276*5113495bSYour Name 
277*5113495bSYour Name 			<enum 0 op_done>  Operation successful
278*5113495bSYour Name 
279*5113495bSYour Name 			<enum 1 not_fnd> Entry not found in Table
280*5113495bSYour Name 
281*5113495bSYour Name 			<enum 2 timeout_er>  Timeout Error
282*5113495bSYour Name 
283*5113495bSYour Name 			<legal 0-2>
284*5113495bSYour Name */
285*5113495bSYour Name #define TCL_STATUS_RING_0_CACHE_OP_RES_OFFSET                        0x00000000
286*5113495bSYour Name #define TCL_STATUS_RING_0_CACHE_OP_RES_LSB                           5
287*5113495bSYour Name #define TCL_STATUS_RING_0_CACHE_OP_RES_MASK                          0x00000060
288*5113495bSYour Name 
289*5113495bSYour Name /* Description		TCL_STATUS_RING_0_INDEX_SEARCH_EN
290*5113495bSYour Name 
291*5113495bSYour Name 			When this bit is set to 1 control_buffer_addr[19:0] will
292*5113495bSYour Name 			be considered as index of the AST or Flow table and GSE
293*5113495bSYour Name 			commands will be executed accordingly on the entry pointed
294*5113495bSYour Name 			by the index.
295*5113495bSYour Name 
296*5113495bSYour Name 			This feature is disabled by setting this bit to 0.
297*5113495bSYour Name 
298*5113495bSYour Name 			<enum 0 index_based_cmd_disable>
299*5113495bSYour Name 
300*5113495bSYour Name 			<enum 1 index_based_cmd_enable>
301*5113495bSYour Name 
302*5113495bSYour Name 
303*5113495bSYour Name 
304*5113495bSYour Name 			<legal all>
305*5113495bSYour Name */
306*5113495bSYour Name #define TCL_STATUS_RING_0_INDEX_SEARCH_EN_OFFSET                     0x00000000
307*5113495bSYour Name #define TCL_STATUS_RING_0_INDEX_SEARCH_EN_LSB                        7
308*5113495bSYour Name #define TCL_STATUS_RING_0_INDEX_SEARCH_EN_MASK                       0x00000080
309*5113495bSYour Name 
310*5113495bSYour Name /* Description		TCL_STATUS_RING_0_MSDU_CNT_N
311*5113495bSYour Name 
312*5113495bSYour Name 			MSDU count of Entry. Valid when GSE_CTRL is 4'b0111 and
313*5113495bSYour Name 			4'b1000
314*5113495bSYour Name */
315*5113495bSYour Name #define TCL_STATUS_RING_0_MSDU_CNT_N_OFFSET                          0x00000000
316*5113495bSYour Name #define TCL_STATUS_RING_0_MSDU_CNT_N_LSB                             8
317*5113495bSYour Name #define TCL_STATUS_RING_0_MSDU_CNT_N_MASK                            0xffffff00
318*5113495bSYour Name 
319*5113495bSYour Name /* Description		TCL_STATUS_RING_1_MSDU_BYTE_CNT_N
320*5113495bSYour Name 
321*5113495bSYour Name 			MSDU byte count for entry 1. Valid when GSE_CTRL is
322*5113495bSYour Name 			4'b0111 and 4'b1000
323*5113495bSYour Name */
324*5113495bSYour Name #define TCL_STATUS_RING_1_MSDU_BYTE_CNT_N_OFFSET                     0x00000004
325*5113495bSYour Name #define TCL_STATUS_RING_1_MSDU_BYTE_CNT_N_LSB                        0
326*5113495bSYour Name #define TCL_STATUS_RING_1_MSDU_BYTE_CNT_N_MASK                       0xffffffff
327*5113495bSYour Name 
328*5113495bSYour Name /* Description		TCL_STATUS_RING_2_MSDU_TIMESTMP_N
329*5113495bSYour Name 
330*5113495bSYour Name 			MSDU timestamp for entry 1. Valid when GSE_CTRL is
331*5113495bSYour Name 			4'b0111 and 4'b1000
332*5113495bSYour Name */
333*5113495bSYour Name #define TCL_STATUS_RING_2_MSDU_TIMESTMP_N_OFFSET                     0x00000008
334*5113495bSYour Name #define TCL_STATUS_RING_2_MSDU_TIMESTMP_N_LSB                        0
335*5113495bSYour Name #define TCL_STATUS_RING_2_MSDU_TIMESTMP_N_MASK                       0xffffffff
336*5113495bSYour Name 
337*5113495bSYour Name /* Description		TCL_STATUS_RING_3_CMD_META_DATA_31_0
338*5113495bSYour Name 
339*5113495bSYour Name 			Meta data from input ring
340*5113495bSYour Name 
341*5113495bSYour Name 			<legal all>
342*5113495bSYour Name */
343*5113495bSYour Name #define TCL_STATUS_RING_3_CMD_META_DATA_31_0_OFFSET                  0x0000000c
344*5113495bSYour Name #define TCL_STATUS_RING_3_CMD_META_DATA_31_0_LSB                     0
345*5113495bSYour Name #define TCL_STATUS_RING_3_CMD_META_DATA_31_0_MASK                    0xffffffff
346*5113495bSYour Name 
347*5113495bSYour Name /* Description		TCL_STATUS_RING_4_CMD_META_DATA_63_32
348*5113495bSYour Name 
349*5113495bSYour Name 			Meta data from input ring
350*5113495bSYour Name 
351*5113495bSYour Name 			<legal all>
352*5113495bSYour Name */
353*5113495bSYour Name #define TCL_STATUS_RING_4_CMD_META_DATA_63_32_OFFSET                 0x00000010
354*5113495bSYour Name #define TCL_STATUS_RING_4_CMD_META_DATA_63_32_LSB                    0
355*5113495bSYour Name #define TCL_STATUS_RING_4_CMD_META_DATA_63_32_MASK                   0xffffffff
356*5113495bSYour Name 
357*5113495bSYour Name /* Description		TCL_STATUS_RING_5_HASH_INDX_VAL
358*5113495bSYour Name 
359*5113495bSYour Name 
360*5113495bSYour Name 			Hash value of the entry in table in case of search
361*5113495bSYour Name 			failed or search disable.
362*5113495bSYour Name 
363*5113495bSYour Name 			<legal all>
364*5113495bSYour Name */
365*5113495bSYour Name #define TCL_STATUS_RING_5_HASH_INDX_VAL_OFFSET                       0x00000014
366*5113495bSYour Name #define TCL_STATUS_RING_5_HASH_INDX_VAL_LSB                          0
367*5113495bSYour Name #define TCL_STATUS_RING_5_HASH_INDX_VAL_MASK                         0x000fffff
368*5113495bSYour Name 
369*5113495bSYour Name /* Description		TCL_STATUS_RING_5_CACHE_SET_NUM
370*5113495bSYour Name 
371*5113495bSYour Name 			Cache set number copied from TCL_GSE_CMD
372*5113495bSYour Name */
373*5113495bSYour Name #define TCL_STATUS_RING_5_CACHE_SET_NUM_OFFSET                       0x00000014
374*5113495bSYour Name #define TCL_STATUS_RING_5_CACHE_SET_NUM_LSB                          20
375*5113495bSYour Name #define TCL_STATUS_RING_5_CACHE_SET_NUM_MASK                         0x00f00000
376*5113495bSYour Name 
377*5113495bSYour Name /* Description		TCL_STATUS_RING_5_RESERVED_5A
378*5113495bSYour Name 
379*5113495bSYour Name 			<legal 0>
380*5113495bSYour Name */
381*5113495bSYour Name #define TCL_STATUS_RING_5_RESERVED_5A_OFFSET                         0x00000014
382*5113495bSYour Name #define TCL_STATUS_RING_5_RESERVED_5A_LSB                            24
383*5113495bSYour Name #define TCL_STATUS_RING_5_RESERVED_5A_MASK                           0xff000000
384*5113495bSYour Name 
385*5113495bSYour Name /* Description		TCL_STATUS_RING_6_RESERVED_6A
386*5113495bSYour Name 
387*5113495bSYour Name 			<legal 0>
388*5113495bSYour Name */
389*5113495bSYour Name #define TCL_STATUS_RING_6_RESERVED_6A_OFFSET                         0x00000018
390*5113495bSYour Name #define TCL_STATUS_RING_6_RESERVED_6A_LSB                            0
391*5113495bSYour Name #define TCL_STATUS_RING_6_RESERVED_6A_MASK                           0xffffffff
392*5113495bSYour Name 
393*5113495bSYour Name /* Description		TCL_STATUS_RING_7_RESERVED_7A
394*5113495bSYour Name 
395*5113495bSYour Name 			<legal 0>
396*5113495bSYour Name */
397*5113495bSYour Name #define TCL_STATUS_RING_7_RESERVED_7A_OFFSET                         0x0000001c
398*5113495bSYour Name #define TCL_STATUS_RING_7_RESERVED_7A_LSB                            0
399*5113495bSYour Name #define TCL_STATUS_RING_7_RESERVED_7A_MASK                           0x000fffff
400*5113495bSYour Name 
401*5113495bSYour Name /* Description		TCL_STATUS_RING_7_RING_ID
402*5113495bSYour Name 
403*5113495bSYour Name 			The buffer pointer ring ID.
404*5113495bSYour Name 
405*5113495bSYour Name 
406*5113495bSYour Name 
407*5113495bSYour Name 			Helps with debugging when dumping ring contents.
408*5113495bSYour Name 
409*5113495bSYour Name 			<legal all>
410*5113495bSYour Name */
411*5113495bSYour Name #define TCL_STATUS_RING_7_RING_ID_OFFSET                             0x0000001c
412*5113495bSYour Name #define TCL_STATUS_RING_7_RING_ID_LSB                                20
413*5113495bSYour Name #define TCL_STATUS_RING_7_RING_ID_MASK                               0x0ff00000
414*5113495bSYour Name 
415*5113495bSYour Name /* Description		TCL_STATUS_RING_7_LOOPING_COUNT
416*5113495bSYour Name 
417*5113495bSYour Name 			A count value that indicates the number of times the
418*5113495bSYour Name 			producer of entries into the Ring has looped around the
419*5113495bSYour Name 			ring.
420*5113495bSYour Name 
421*5113495bSYour Name 			At initialization time, this value is set to 0. On the
422*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
423*5113495bSYour Name 			reached allowed by the number of bits for this field, the
424*5113495bSYour Name 			count value continues with 0 again.
425*5113495bSYour Name 
426*5113495bSYour Name 
427*5113495bSYour Name 
428*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
429*5113495bSYour Name 			use this field to figure out up to where the producer of
430*5113495bSYour Name 			entries has created new entries. This eliminates the need to
431*5113495bSYour Name 			check where the head pointer' of the ring is located once
432*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
433*5113495bSYour Name 			entries have been put into this ring...
434*5113495bSYour Name 
435*5113495bSYour Name 
436*5113495bSYour Name 
437*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
438*5113495bSYour Name 			LSB bit of this count value.
439*5113495bSYour Name 
440*5113495bSYour Name 			<legal all>
441*5113495bSYour Name */
442*5113495bSYour Name #define TCL_STATUS_RING_7_LOOPING_COUNT_OFFSET                       0x0000001c
443*5113495bSYour Name #define TCL_STATUS_RING_7_LOOPING_COUNT_LSB                          28
444*5113495bSYour Name #define TCL_STATUS_RING_7_LOOPING_COUNT_MASK                         0xf0000000
445*5113495bSYour Name 
446*5113495bSYour Name 
447*5113495bSYour Name #endif // _TCL_STATUS_RING_H_
448