xref: /wlan-driver/fw-api/hw/qcn6122/tcl_data_cmd.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2020, 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_DATA_CMD_H_
18*5113495bSYour Name #define _TCL_DATA_CMD_H_
19*5113495bSYour Name #if !defined(__ASSEMBLER__)
20*5113495bSYour Name #endif
21*5113495bSYour Name 
22*5113495bSYour Name #include "buffer_addr_info.h"
23*5113495bSYour Name 
24*5113495bSYour Name // ################ START SUMMARY #################
25*5113495bSYour Name //
26*5113495bSYour Name //	Dword	Fields
27*5113495bSYour Name //	0-1	struct buffer_addr_info buf_addr_info;
28*5113495bSYour Name //	2	buf_or_ext_desc_type[0], epd[1], encap_type[3:2], encrypt_type[7:4], src_buffer_swap[8], link_meta_swap[9], tqm_no_drop[10], reserved_2a[11], search_type[13:12], addrx_en[14], addry_en[15], tcl_cmd_number[31:16]
29*5113495bSYour Name //	3	data_length[15:0], ipv4_checksum_en[16], udp_over_ipv4_checksum_en[17], udp_over_ipv6_checksum_en[18], tcp_over_ipv4_checksum_en[19], tcp_over_ipv6_checksum_en[20], to_fw[21], reserved_3a[22], packet_offset[31:23]
30*5113495bSYour Name //	4	buffer_timestamp[18:0], buffer_timestamp_valid[19], reserved_4a[20], hlos_tid_overwrite[21], hlos_tid[25:22], lmac_id[27:26], udp_flow_override[29:28], reserved_4b[31:30]
31*5113495bSYour Name //	5	dscp_tid_table_num[5:0], search_index[25:6], cache_set_num[29:26], mesh_enable[31:30]
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_DATA_CMD 7
37*5113495bSYour Name 
38*5113495bSYour Name struct tcl_data_cmd {
39*5113495bSYour Name     struct            buffer_addr_info                       buf_addr_info;
40*5113495bSYour Name              uint32_t buf_or_ext_desc_type            :  1, //[0]
41*5113495bSYour Name                       epd                             :  1, //[1]
42*5113495bSYour Name                       encap_type                      :  2, //[3:2]
43*5113495bSYour Name                       encrypt_type                    :  4, //[7:4]
44*5113495bSYour Name                       src_buffer_swap                 :  1, //[8]
45*5113495bSYour Name                       link_meta_swap                  :  1, //[9]
46*5113495bSYour Name                       tqm_no_drop                     :  1, //[10]
47*5113495bSYour Name                       reserved_2a                     :  1, //[11]
48*5113495bSYour Name                       search_type                     :  2, //[13:12]
49*5113495bSYour Name                       addrx_en                        :  1, //[14]
50*5113495bSYour Name                       addry_en                        :  1, //[15]
51*5113495bSYour Name                       tcl_cmd_number                  : 16; //[31:16]
52*5113495bSYour Name              uint32_t data_length                     : 16, //[15:0]
53*5113495bSYour Name                       ipv4_checksum_en                :  1, //[16]
54*5113495bSYour Name                       udp_over_ipv4_checksum_en       :  1, //[17]
55*5113495bSYour Name                       udp_over_ipv6_checksum_en       :  1, //[18]
56*5113495bSYour Name                       tcp_over_ipv4_checksum_en       :  1, //[19]
57*5113495bSYour Name                       tcp_over_ipv6_checksum_en       :  1, //[20]
58*5113495bSYour Name                       to_fw                           :  1, //[21]
59*5113495bSYour Name                       reserved_3a                     :  1, //[22]
60*5113495bSYour Name                       packet_offset                   :  9; //[31:23]
61*5113495bSYour Name              uint32_t buffer_timestamp                : 19, //[18:0]
62*5113495bSYour Name                       buffer_timestamp_valid          :  1, //[19]
63*5113495bSYour Name                       reserved_4a                     :  1, //[20]
64*5113495bSYour Name                       hlos_tid_overwrite              :  1, //[21]
65*5113495bSYour Name                       hlos_tid                        :  4, //[25:22]
66*5113495bSYour Name                       lmac_id                         :  2, //[27:26]
67*5113495bSYour Name                       udp_flow_override               :  2, //[29:28]
68*5113495bSYour Name                       reserved_4b                     :  2; //[31:30]
69*5113495bSYour Name              uint32_t dscp_tid_table_num              :  6, //[5:0]
70*5113495bSYour Name                       search_index                    : 20, //[25:6]
71*5113495bSYour Name                       cache_set_num                   :  4, //[29:26]
72*5113495bSYour Name                       mesh_enable                     :  2; //[31:30]
73*5113495bSYour Name              uint32_t reserved_6a                     : 20, //[19:0]
74*5113495bSYour Name                       ring_id                         :  8, //[27:20]
75*5113495bSYour Name                       looping_count                   :  4; //[31:28]
76*5113495bSYour Name };
77*5113495bSYour Name 
78*5113495bSYour Name /*
79*5113495bSYour Name 
80*5113495bSYour Name struct buffer_addr_info buf_addr_info
81*5113495bSYour Name 
82*5113495bSYour Name 			Details of the physical address for a single buffer
83*5113495bSYour Name 
84*5113495bSYour Name 			It also contains return ownership info as well as some
85*5113495bSYour Name 			meta data for SW related to this buffer.
86*5113495bSYour Name 
87*5113495bSYour Name 
88*5113495bSYour Name 
89*5113495bSYour Name 			In case of Buf_or_ext_desc_type indicating
90*5113495bSYour Name 			'MSDU_buffer', this address indicates the start of the meta
91*5113495bSYour Name 			data that is preceding the actual packet data.
92*5113495bSYour Name 
93*5113495bSYour Name 			The start of the actual packet data is provided by
94*5113495bSYour Name 			field: Packet_offset
95*5113495bSYour Name 
96*5113495bSYour Name buf_or_ext_desc_type
97*5113495bSYour Name 
98*5113495bSYour Name 			<enum 0 MSDU_buffer> The address points to an MSDU
99*5113495bSYour Name 			buffer.
100*5113495bSYour Name 
101*5113495bSYour Name 			<enum 1 extension_descriptor> The address points to an
102*5113495bSYour Name 			MSDU link extension descriptor
103*5113495bSYour Name 
104*5113495bSYour Name 			< legal all>
105*5113495bSYour Name 
106*5113495bSYour Name epd
107*5113495bSYour Name 
108*5113495bSYour Name 			When this bit is set then input packet is an EPD type
109*5113495bSYour Name 
110*5113495bSYour Name 			<legal all>
111*5113495bSYour Name 
112*5113495bSYour Name encap_type
113*5113495bSYour Name 
114*5113495bSYour Name 			Indicates the encapsulation that HW will perform:
115*5113495bSYour Name 
116*5113495bSYour Name 			<enum 0 RAW> No encapsulation
117*5113495bSYour Name 
118*5113495bSYour Name 			<enum 1 Native_WiFi>
119*5113495bSYour Name 
120*5113495bSYour Name 			<enum 2 Ethernet> Ethernet 2 (DIX)  or 802.3 (uses
121*5113495bSYour Name 			SNAP/LLC)
122*5113495bSYour Name 
123*5113495bSYour Name 			<enum 3 802_3> DO NOT USE. Indicate Ethernet
124*5113495bSYour Name 
125*5113495bSYour Name 
126*5113495bSYour Name 
127*5113495bSYour Name 			Used by the OLE during encapsulation.
128*5113495bSYour Name 
129*5113495bSYour Name 			<legal all>
130*5113495bSYour Name 
131*5113495bSYour Name encrypt_type
132*5113495bSYour Name 
133*5113495bSYour Name 			Field only valid for encap_type: RAW
134*5113495bSYour Name 
135*5113495bSYour Name 
136*5113495bSYour Name 
137*5113495bSYour Name 			Indicates type of decrypt cipher used (as defined in the
138*5113495bSYour Name 			peer entry)
139*5113495bSYour Name 
140*5113495bSYour Name 			<enum 0 wep_40> WEP 40-bit
141*5113495bSYour Name 
142*5113495bSYour Name 			<enum 1 wep_104> WEP 104-bit
143*5113495bSYour Name 
144*5113495bSYour Name 			<enum 2 tkip_no_mic> TKIP without MIC
145*5113495bSYour Name 
146*5113495bSYour Name 			<enum 3 wep_128> WEP 128-bit
147*5113495bSYour Name 
148*5113495bSYour Name 			<enum 4 tkip_with_mic> TKIP with MIC
149*5113495bSYour Name 
150*5113495bSYour Name 			<enum 5 wapi> WAPI
151*5113495bSYour Name 
152*5113495bSYour Name 			<enum 6 aes_ccmp_128> AES CCMP 128
153*5113495bSYour Name 
154*5113495bSYour Name 			<enum 7 no_cipher> No crypto
155*5113495bSYour Name 
156*5113495bSYour Name 			<enum 8 aes_ccmp_256> AES CCMP 256
157*5113495bSYour Name 
158*5113495bSYour Name 			<enum 9 aes_gcmp_128> AES CCMP 128
159*5113495bSYour Name 
160*5113495bSYour Name 			<enum 10 aes_gcmp_256> AES CCMP 256
161*5113495bSYour Name 
162*5113495bSYour Name 			<enum 11 wapi_gcm_sm4> WAPI GCM SM4
163*5113495bSYour Name 
164*5113495bSYour Name 
165*5113495bSYour Name 
166*5113495bSYour Name 			<enum 12 wep_varied_width> DO not use... Only for higher
167*5113495bSYour Name 			layer modules..
168*5113495bSYour Name 
169*5113495bSYour Name 			<legal 0-12>
170*5113495bSYour Name 
171*5113495bSYour Name src_buffer_swap
172*5113495bSYour Name 
173*5113495bSYour Name 			Treats source memory (packet buffer) organization as
174*5113495bSYour Name 			big-endian. The packets are read and byte swapped.
175*5113495bSYour Name 
176*5113495bSYour Name 			1'b0: Source memory is little endian
177*5113495bSYour Name 
178*5113495bSYour Name 			1'b1: Source memory is big endian
179*5113495bSYour Name 
180*5113495bSYour Name 			<legal all>
181*5113495bSYour Name 
182*5113495bSYour Name link_meta_swap
183*5113495bSYour Name 
184*5113495bSYour Name 			Treats link descriptor and Metadata as big-endian. The
185*5113495bSYour Name 			link descriptor/Metadata is read and byte swapped.
186*5113495bSYour Name 
187*5113495bSYour Name 			1'b0: Memory is little endian
188*5113495bSYour Name 
189*5113495bSYour Name 			1'b1: Memory is big endian
190*5113495bSYour Name 
191*5113495bSYour Name 			<legal all>
192*5113495bSYour Name 
193*5113495bSYour Name tqm_no_drop
194*5113495bSYour Name 
195*5113495bSYour Name 			This bit is used to stop TQM from dropping MSDUs while
196*5113495bSYour Name 			adding them to MSDU flows1'b1: Do not drop MSDU when any of
197*5113495bSYour Name 			the threshold value is met while adding MSDU in a flow1'b1:
198*5113495bSYour Name 			Drop MSDU when any of the threshold value is met while
199*5113495bSYour Name 			adding MSDU in a flow
200*5113495bSYour Name 
201*5113495bSYour Name 			<legal all>
202*5113495bSYour Name 
203*5113495bSYour Name reserved_2a
204*5113495bSYour Name 
205*5113495bSYour Name 			<legal 0>
206*5113495bSYour Name 
207*5113495bSYour Name search_type
208*5113495bSYour Name 
209*5113495bSYour Name 			Search type select
210*5113495bSYour Name 
211*5113495bSYour Name 
212*5113495bSYour Name 
213*5113495bSYour Name 			<enum 0 Normal_search> Address and flow search will use
214*5113495bSYour Name 			packet contents
215*5113495bSYour Name 
216*5113495bSYour Name 			<enum 1 Index_based_address_search> Address search will
217*5113495bSYour Name 
218*5113495bSYour Name 			<enum 2 Index_based_flow_search> Flow search will use
219*5113495bSYour Name 			'search_index', and address search will use packet contents
220*5113495bSYour Name 
221*5113495bSYour Name 			<legal 0-2>
222*5113495bSYour Name 
223*5113495bSYour Name addrx_en
224*5113495bSYour Name 
225*5113495bSYour Name 			Address X search enable in ASE
226*5113495bSYour Name 
227*5113495bSYour Name 			1'b0: Search disable
228*5113495bSYour Name 
229*5113495bSYour Name 			1'b1: Search Enable
230*5113495bSYour Name 
231*5113495bSYour Name 			<legal all>
232*5113495bSYour Name 
233*5113495bSYour Name addry_en
234*5113495bSYour Name 
235*5113495bSYour Name 			Address Y search enable in ASE
236*5113495bSYour Name 
237*5113495bSYour Name 			1'b0: Search disable
238*5113495bSYour Name 
239*5113495bSYour Name 			1'b1: Search Enable
240*5113495bSYour Name 
241*5113495bSYour Name 			<legal all>
242*5113495bSYour Name 
243*5113495bSYour Name tcl_cmd_number
244*5113495bSYour Name 
245*5113495bSYour Name 			This number can be used by SW to track, identify and
246*5113495bSYour Name 			link the created commands with the command statuses
247*5113495bSYour Name 
248*5113495bSYour Name 
249*5113495bSYour Name 
250*5113495bSYour Name 			Is set to the value 'TCL_CMD_Number' of the related
251*5113495bSYour Name 			TCL_DATA command
252*5113495bSYour Name 
253*5113495bSYour Name 			<legal all>
254*5113495bSYour Name 
255*5113495bSYour Name data_length
256*5113495bSYour Name 
257*5113495bSYour Name 			Valid Data length in bytes.
258*5113495bSYour Name 
259*5113495bSYour Name 
260*5113495bSYour Name 
261*5113495bSYour Name 			MSDU length in case of direct descriptor.
262*5113495bSYour Name 
263*5113495bSYour Name 			Length of link extension descriptor in case of Link
264*5113495bSYour Name 			extension descriptor. This is used to know the size of
265*5113495bSYour Name 			Metadata.
266*5113495bSYour Name 
267*5113495bSYour Name 			<legal all>
268*5113495bSYour Name 
269*5113495bSYour Name ipv4_checksum_en
270*5113495bSYour Name 
271*5113495bSYour Name 			OLE related control
272*5113495bSYour Name 
273*5113495bSYour Name 			Enable IPv4 checksum replacement
274*5113495bSYour Name 
275*5113495bSYour Name udp_over_ipv4_checksum_en
276*5113495bSYour Name 
277*5113495bSYour Name 			OLE related control
278*5113495bSYour Name 
279*5113495bSYour Name 			Enable UDP over IPv4 checksum replacement.  UDP checksum
280*5113495bSYour Name 			over IPv4 is optional for TCP/IP stacks.
281*5113495bSYour Name 
282*5113495bSYour Name udp_over_ipv6_checksum_en
283*5113495bSYour Name 
284*5113495bSYour Name 			OLE related control
285*5113495bSYour Name 
286*5113495bSYour Name 			Enable UDP over IPv6 checksum replacement.  UDP checksum
287*5113495bSYour Name 			over IPv6 is mandatory for TCP/IP stacks.
288*5113495bSYour Name 
289*5113495bSYour Name tcp_over_ipv4_checksum_en
290*5113495bSYour Name 
291*5113495bSYour Name 			OLE related control
292*5113495bSYour Name 
293*5113495bSYour Name 			Enable TCP checksum over IPv4 replacement
294*5113495bSYour Name 
295*5113495bSYour Name tcp_over_ipv6_checksum_en
296*5113495bSYour Name 
297*5113495bSYour Name 			OLE related control
298*5113495bSYour Name 
299*5113495bSYour Name 			Enable TCP checksum over IPv6 replacement
300*5113495bSYour Name 
301*5113495bSYour Name to_fw
302*5113495bSYour Name 
303*5113495bSYour Name 			Forward packet to FW along with classification result.
304*5113495bSYour Name 			The packet will not be forward to TQM when this bit is set
305*5113495bSYour Name 
306*5113495bSYour Name 
307*5113495bSYour Name 
308*5113495bSYour Name 			1'b0: Use classification result to forward the packet.
309*5113495bSYour Name 
310*5113495bSYour Name 			1'b1: Override classification result and forward packet
311*5113495bSYour Name 			only to FW.
312*5113495bSYour Name 
313*5113495bSYour Name 			<legal all>
314*5113495bSYour Name 
315*5113495bSYour Name reserved_3a
316*5113495bSYour Name 
317*5113495bSYour Name 			<legal 0>
318*5113495bSYour Name 
319*5113495bSYour Name packet_offset
320*5113495bSYour Name 
321*5113495bSYour Name 			Packet offset from Metadata in case of direct buffer
322*5113495bSYour Name 			descriptor. This field is valid when Buf_or_ext_desc_type is
323*5113495bSYour Name 			reset(= 0).
324*5113495bSYour Name 
325*5113495bSYour Name 			<legal all>
326*5113495bSYour Name 
327*5113495bSYour Name buffer_timestamp
328*5113495bSYour Name 
329*5113495bSYour Name 			Field only valid when 'Buffer_timestamp_valid ' is set.
330*5113495bSYour Name 
331*5113495bSYour Name 
332*5113495bSYour Name 
333*5113495bSYour Name 			Frame system entrance timestamp. The timestamp is
334*5113495bSYour Name 			related to the global system timer
335*5113495bSYour Name 
336*5113495bSYour Name 
337*5113495bSYour Name 
338*5113495bSYour Name 			Generally the first module (SW, TCL or TQM). that sees
339*5113495bSYour Name 			this frame and this timestamp field is not valid, shall fill
340*5113495bSYour Name 			in this field.
341*5113495bSYour Name 
342*5113495bSYour Name 
343*5113495bSYour Name 
344*5113495bSYour Name 			Timestamp in units of 1024 us
345*5113495bSYour Name 
346*5113495bSYour Name buffer_timestamp_valid
347*5113495bSYour Name 
348*5113495bSYour Name 			When set, the Buffer_timestamp field contains valid
349*5113495bSYour Name 			info.
350*5113495bSYour Name 
351*5113495bSYour Name reserved_4a
352*5113495bSYour Name 
353*5113495bSYour Name 			<legal 0>
354*5113495bSYour Name 
355*5113495bSYour Name hlos_tid_overwrite
356*5113495bSYour Name 
357*5113495bSYour Name 			When set, TCL shall ignore the IP DSCP and VLAN PCP
358*5113495bSYour Name 			fields and use HLOS_TID as the final TID. Otherwise TCL
359*5113495bSYour Name 			shall consider the DSCP and PCP fields as well as HLOS_TID
360*5113495bSYour Name 			and choose a final TID based on the configured priority
361*5113495bSYour Name 
362*5113495bSYour Name 			<legal all>
363*5113495bSYour Name 
364*5113495bSYour Name hlos_tid
365*5113495bSYour Name 
366*5113495bSYour Name 			HLOS MSDU priority
367*5113495bSYour Name 
368*5113495bSYour Name 
369*5113495bSYour Name 
370*5113495bSYour Name 			Field is used when HLOS_TID_overwrite is set.
371*5113495bSYour Name 
372*5113495bSYour Name 
373*5113495bSYour Name 
374*5113495bSYour Name 			Field is also used when HLOS_TID_overwrite is not set
375*5113495bSYour Name 			and DSCP/PCP is not available in the packet
376*5113495bSYour Name 
377*5113495bSYour Name 			<legal all>
378*5113495bSYour Name 
379*5113495bSYour Name lmac_id
380*5113495bSYour Name 
381*5113495bSYour Name 			TCL uses this LMAC_ID in address search, i.e, while
382*5113495bSYour Name 			finding matching entry for the packet in AST corresponding
383*5113495bSYour Name 			to given LMAC_ID
384*5113495bSYour Name 
385*5113495bSYour Name 			If LMAC ID is all 1s (=> value 3), it indicates wildcard
386*5113495bSYour Name 			match for any MAC
387*5113495bSYour Name 
388*5113495bSYour Name 			<legal 0-3>
389*5113495bSYour Name 
390*5113495bSYour Name udp_flow_override
391*5113495bSYour Name 
392*5113495bSYour Name 			TCL uses this to select the flow pointer from the peer
393*5113495bSYour Name 			table, which can be overridden by SW for pre-encrypted raw
394*5113495bSYour Name 			WiFi packets that cannot be parsed for UDP or for other
395*5113495bSYour Name 			enterprise use cases:
396*5113495bSYour Name 
397*5113495bSYour Name 			<enum 0 FP_PARSE_IP> Use the flow-pointer based on
398*5113495bSYour Name 			parsing the IPv4 or IPv6 header
399*5113495bSYour Name 
400*5113495bSYour Name 			<enum 1 FP_USE_NON_UDP> Use the non-UDP flow pointer
401*5113495bSYour Name 
402*5113495bSYour Name 			<enum 2 FP_USE_UDP> Use the UDP flow pointer
403*5113495bSYour Name 
404*5113495bSYour Name 
405*5113495bSYour Name 
406*5113495bSYour Name 			This is not supported in Moselle.
407*5113495bSYour Name 
408*5113495bSYour Name 			<legal 0-2>
409*5113495bSYour Name 
410*5113495bSYour Name reserved_4b
411*5113495bSYour Name 
412*5113495bSYour Name 			<legal 0>
413*5113495bSYour Name 
414*5113495bSYour Name dscp_tid_table_num
415*5113495bSYour Name 
416*5113495bSYour Name 			DSCP to TID mapping table number that need to be used
417*5113495bSYour Name 			for the MSDU, should be specified using this field
418*5113495bSYour Name 
419*5113495bSYour Name 			<legal all>
420*5113495bSYour Name 
421*5113495bSYour Name search_index
422*5113495bSYour Name 
423*5113495bSYour Name 			The index that will be used for index based address or
424*5113495bSYour Name 			flow search. The field is valid when 'search_type' is  1 or
425*5113495bSYour Name 			2.
426*5113495bSYour Name 
427*5113495bSYour Name 			<legal all>
428*5113495bSYour Name 
429*5113495bSYour Name cache_set_num
430*5113495bSYour Name 
431*5113495bSYour Name 			Cache set number that should be used to cache the index
432*5113495bSYour Name 			based search results, for address and flow search. This
433*5113495bSYour Name 			value should be equal to LSB four bits of the hash value of
434*5113495bSYour Name 			match data, in case of search index points to an entry which
435*5113495bSYour Name 			may be used in content based search also. The value can be
436*5113495bSYour Name 			anything when the entry pointed by search index will not be
437*5113495bSYour Name 			used for content based search.
438*5113495bSYour Name 
439*5113495bSYour Name 			<legal all>
440*5113495bSYour Name 
441*5113495bSYour Name mesh_enable
442*5113495bSYour Name 
443*5113495bSYour Name 			If set to a non-zero value:
444*5113495bSYour Name 
445*5113495bSYour Name 			* For raw WiFi frames, this indicates transmission to a
446*5113495bSYour Name 			mesh STA, enabling the interpretation of the 'Mesh Control
447*5113495bSYour Name 			Present' bit (bit 8) of QoS Control (otherwise this bit is
448*5113495bSYour Name 			ignored). The interpretation of the A-MSDU 'Length' field is
449*5113495bSYour Name 			decided by the e-numerations below.
450*5113495bSYour Name 
451*5113495bSYour Name 			* For native WiFi frames, this indicates that a 'Mesh
452*5113495bSYour Name 			Control' field is present between the header and the LLC.
453*5113495bSYour Name 			The three non-zero values are interchangeable.
454*5113495bSYour Name 
455*5113495bSYour Name 
456*5113495bSYour Name 
457*5113495bSYour Name 			<enum 0 MESH_DISABLE>
458*5113495bSYour Name 
459*5113495bSYour Name 			<enum 1 MESH_Q2Q> A-MSDU 'Length' is big endian and
460*5113495bSYour Name 			includes the length of Mesh Control.
461*5113495bSYour Name 
462*5113495bSYour Name 			<enum 2 MESH_11S_BE> A-MSDU 'Length' is big endian and
463*5113495bSYour Name 			excludes the length of Mesh Control.
464*5113495bSYour Name 
465*5113495bSYour Name 			<enum 3 MESH_11S_LE> A-MSDU 'Length' is little endian
466*5113495bSYour Name 			and excludes the length of Mesh Control. This is
467*5113495bSYour Name 			802.11s-compliant.
468*5113495bSYour Name 
469*5113495bSYour Name 			<legal 0-3>
470*5113495bSYour Name 
471*5113495bSYour Name reserved_6a
472*5113495bSYour Name 
473*5113495bSYour Name 			<legal 0>
474*5113495bSYour Name 
475*5113495bSYour Name ring_id
476*5113495bSYour Name 
477*5113495bSYour Name 			The buffer pointer ring ID.
478*5113495bSYour Name 
479*5113495bSYour Name 			0 refers to the IDLE ring
480*5113495bSYour Name 
481*5113495bSYour Name 			1 - N refers to other rings
482*5113495bSYour Name 
483*5113495bSYour Name 
484*5113495bSYour Name 
485*5113495bSYour Name 			Helps with debugging when dumping ring contents.
486*5113495bSYour Name 
487*5113495bSYour Name 			<legal all>
488*5113495bSYour Name 
489*5113495bSYour Name looping_count
490*5113495bSYour Name 
491*5113495bSYour Name 			A count value that indicates the number of times the
492*5113495bSYour Name 			producer of entries into the Ring has looped around the
493*5113495bSYour Name 			ring.
494*5113495bSYour Name 
495*5113495bSYour Name 			At initialization time, this value is set to 0. On the
496*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
497*5113495bSYour Name 			reached allowed by the number of bits for this field, the
498*5113495bSYour Name 			count value continues with 0 again.
499*5113495bSYour Name 
500*5113495bSYour Name 
501*5113495bSYour Name 
502*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
503*5113495bSYour Name 			use this field to figure out up to where the producer of
504*5113495bSYour Name 			entries has created new entries. This eliminates the need to
505*5113495bSYour Name 			check where the head pointer' of the ring is located once
506*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
507*5113495bSYour Name 			entries have been put into this ring...
508*5113495bSYour Name 
509*5113495bSYour Name 
510*5113495bSYour Name 
511*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
512*5113495bSYour Name 			LSB bit of this count value.
513*5113495bSYour Name 
514*5113495bSYour Name 			<legal all>
515*5113495bSYour Name */
516*5113495bSYour Name 
517*5113495bSYour Name 
518*5113495bSYour Name  /* EXTERNAL REFERENCE : struct buffer_addr_info buf_addr_info */
519*5113495bSYour Name 
520*5113495bSYour Name 
521*5113495bSYour Name /* Description		TCL_DATA_CMD_0_BUF_ADDR_INFO_BUFFER_ADDR_31_0
522*5113495bSYour Name 
523*5113495bSYour Name 			Address (lower 32 bits) of the MSDU buffer OR
524*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
525*5113495bSYour Name 
526*5113495bSYour Name 
527*5113495bSYour Name 
528*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
529*5113495bSYour Name 
530*5113495bSYour Name 			<legal all>
531*5113495bSYour Name */
532*5113495bSYour Name #define TCL_DATA_CMD_0_BUF_ADDR_INFO_BUFFER_ADDR_31_0_OFFSET         0x00000000
533*5113495bSYour Name #define TCL_DATA_CMD_0_BUF_ADDR_INFO_BUFFER_ADDR_31_0_LSB            0
534*5113495bSYour Name #define TCL_DATA_CMD_0_BUF_ADDR_INFO_BUFFER_ADDR_31_0_MASK           0xffffffff
535*5113495bSYour Name 
536*5113495bSYour Name /* Description		TCL_DATA_CMD_1_BUF_ADDR_INFO_BUFFER_ADDR_39_32
537*5113495bSYour Name 
538*5113495bSYour Name 			Address (upper 8 bits) of the MSDU buffer OR
539*5113495bSYour Name 			MSDU_EXTENSION descriptor OR Link Descriptor
540*5113495bSYour Name 
541*5113495bSYour Name 
542*5113495bSYour Name 
543*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
544*5113495bSYour Name 
545*5113495bSYour Name 			<legal all>
546*5113495bSYour Name */
547*5113495bSYour Name #define TCL_DATA_CMD_1_BUF_ADDR_INFO_BUFFER_ADDR_39_32_OFFSET        0x00000004
548*5113495bSYour Name #define TCL_DATA_CMD_1_BUF_ADDR_INFO_BUFFER_ADDR_39_32_LSB           0
549*5113495bSYour Name #define TCL_DATA_CMD_1_BUF_ADDR_INFO_BUFFER_ADDR_39_32_MASK          0x000000ff
550*5113495bSYour Name 
551*5113495bSYour Name /* Description		TCL_DATA_CMD_1_BUF_ADDR_INFO_RETURN_BUFFER_MANAGER
552*5113495bSYour Name 
553*5113495bSYour Name 			Consumer: WBM
554*5113495bSYour Name 
555*5113495bSYour Name 			Producer: SW/FW
556*5113495bSYour Name 
557*5113495bSYour Name 
558*5113495bSYour Name 
559*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
560*5113495bSYour Name 
561*5113495bSYour Name 
562*5113495bSYour Name 
563*5113495bSYour Name 			Indicates to which buffer manager the buffer OR
564*5113495bSYour Name 			MSDU_EXTENSION descriptor OR link descriptor that is being
565*5113495bSYour Name 			pointed to shall be returned after the frame has been
566*5113495bSYour Name 			processed. It is used by WBM for routing purposes.
567*5113495bSYour Name 
568*5113495bSYour Name 
569*5113495bSYour Name 
570*5113495bSYour Name 			<enum 0 WBM_IDLE_BUF_LIST> This buffer shall be returned
571*5113495bSYour Name 			to the WMB buffer idle list
572*5113495bSYour Name 
573*5113495bSYour Name 			<enum 1 WBM_IDLE_DESC_LIST> This buffer shall be
574*5113495bSYour Name 			returned to the WMB idle link descriptor idle list
575*5113495bSYour Name 
576*5113495bSYour Name 			<enum 2 FW_BM> This buffer shall be returned to the FW
577*5113495bSYour Name 
578*5113495bSYour Name 			<enum 3 SW0_BM> This buffer shall be returned to the SW,
579*5113495bSYour Name 			ring 0
580*5113495bSYour Name 
581*5113495bSYour Name 			<enum 4 SW1_BM> This buffer shall be returned to the SW,
582*5113495bSYour Name 			ring 1
583*5113495bSYour Name 
584*5113495bSYour Name 			<enum 5 SW2_BM> This buffer shall be returned to the SW,
585*5113495bSYour Name 			ring 2
586*5113495bSYour Name 
587*5113495bSYour Name 			<enum 6 SW3_BM> This buffer shall be returned to the SW,
588*5113495bSYour Name 			ring 3
589*5113495bSYour Name 
590*5113495bSYour Name 			<enum 7 SW4_BM> This buffer shall be returned to the SW,
591*5113495bSYour Name 			ring 4
592*5113495bSYour Name 
593*5113495bSYour Name 
594*5113495bSYour Name 
595*5113495bSYour Name 			<legal all>
596*5113495bSYour Name */
597*5113495bSYour Name #define TCL_DATA_CMD_1_BUF_ADDR_INFO_RETURN_BUFFER_MANAGER_OFFSET    0x00000004
598*5113495bSYour Name #define TCL_DATA_CMD_1_BUF_ADDR_INFO_RETURN_BUFFER_MANAGER_LSB       8
599*5113495bSYour Name #define TCL_DATA_CMD_1_BUF_ADDR_INFO_RETURN_BUFFER_MANAGER_MASK      0x00000700
600*5113495bSYour Name 
601*5113495bSYour Name /* Description		TCL_DATA_CMD_1_BUF_ADDR_INFO_SW_BUFFER_COOKIE
602*5113495bSYour Name 
603*5113495bSYour Name 			Cookie field exclusively used by SW.
604*5113495bSYour Name 
605*5113495bSYour Name 
606*5113495bSYour Name 
607*5113495bSYour Name 			In case of 'NULL' pointer, this field is set to 0
608*5113495bSYour Name 
609*5113495bSYour Name 
610*5113495bSYour Name 
611*5113495bSYour Name 			HW ignores the contents, accept that it passes the
612*5113495bSYour Name 			programmed value on to other descriptors together with the
613*5113495bSYour Name 			physical address
614*5113495bSYour Name 
615*5113495bSYour Name 
616*5113495bSYour Name 
617*5113495bSYour Name 			Field can be used by SW to for example associate the
618*5113495bSYour Name 			buffers physical address with the virtual address
619*5113495bSYour Name 
620*5113495bSYour Name 			The bit definitions as used by SW are within SW HLD
621*5113495bSYour Name 			specification
622*5113495bSYour Name 
623*5113495bSYour Name 
624*5113495bSYour Name 
625*5113495bSYour Name 			NOTE1:
626*5113495bSYour Name 
627*5113495bSYour Name 			The three most significant bits can have a special
628*5113495bSYour Name 			meaning in case this struct is embedded in a TX_MPDU_DETAILS
629*5113495bSYour Name 			STRUCT, and field transmit_bw_restriction is set
630*5113495bSYour Name 
631*5113495bSYour Name 
632*5113495bSYour Name 
633*5113495bSYour Name 			In case of NON punctured transmission:
634*5113495bSYour Name 
635*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b00: 20 MHz TX only
636*5113495bSYour Name 
637*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b01: 40 MHz TX only
638*5113495bSYour Name 
639*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b10: 80 MHz TX only
640*5113495bSYour Name 
641*5113495bSYour Name 			Sw_buffer_cookie[20:19] = 2'b11: 160 MHz TX only
642*5113495bSYour Name 
643*5113495bSYour Name 
644*5113495bSYour Name 
645*5113495bSYour Name 			In case of punctured transmission:
646*5113495bSYour Name 
647*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b000: pattern 0 only
648*5113495bSYour Name 
649*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b001: pattern 1 only
650*5113495bSYour Name 
651*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b010: pattern 2 only
652*5113495bSYour Name 
653*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b011: pattern 3 only
654*5113495bSYour Name 
655*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b100: pattern 4 only
656*5113495bSYour Name 
657*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b101: pattern 5 only
658*5113495bSYour Name 
659*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b110: pattern 6 only
660*5113495bSYour Name 
661*5113495bSYour Name 			Sw_buffer_cookie[20:18] = 3'b111: pattern 7 only
662*5113495bSYour Name 
663*5113495bSYour Name 
664*5113495bSYour Name 
665*5113495bSYour Name 			Note: a punctured transmission is indicated by the
666*5113495bSYour Name 			presence of TLV TX_PUNCTURE_SETUP embedded in the scheduler
667*5113495bSYour Name 			TLV
668*5113495bSYour Name 
669*5113495bSYour Name 
670*5113495bSYour Name 
671*5113495bSYour Name 			NOTE 2:The five most significant bits can have a special
672*5113495bSYour Name 			meaning in case this struct is embedded in an
673*5113495bSYour Name 			RX_MSDU_DETAILS STRUCT, and Maple/Spruce Rx DMA is
674*5113495bSYour Name 			configured for passing on the additional info
675*5113495bSYour Name 			from 'RX_MPDU_INFO' structure in 'RX_MPDU_START' TLV
676*5113495bSYour Name 			(FR56821). This is not supported in HastingsPrime, Pine or
677*5113495bSYour Name 			Moselle.
678*5113495bSYour Name 
679*5113495bSYour Name 
680*5113495bSYour Name 
681*5113495bSYour Name 			Sw_buffer_cookie[20:17]: Tid: The TID field in the QoS
682*5113495bSYour Name 			control field
683*5113495bSYour Name 
684*5113495bSYour Name 
685*5113495bSYour Name 
686*5113495bSYour Name 			Sw_buffer_cookie[16]: Mpdu_qos_control_valid: This field
687*5113495bSYour Name 			indicates MPDUs with a QoS control field.
688*5113495bSYour Name 
689*5113495bSYour Name 
690*5113495bSYour Name 
691*5113495bSYour Name 
692*5113495bSYour Name 
693*5113495bSYour Name 			<legal all>
694*5113495bSYour Name */
695*5113495bSYour Name #define TCL_DATA_CMD_1_BUF_ADDR_INFO_SW_BUFFER_COOKIE_OFFSET         0x00000004
696*5113495bSYour Name #define TCL_DATA_CMD_1_BUF_ADDR_INFO_SW_BUFFER_COOKIE_LSB            11
697*5113495bSYour Name #define TCL_DATA_CMD_1_BUF_ADDR_INFO_SW_BUFFER_COOKIE_MASK           0xfffff800
698*5113495bSYour Name 
699*5113495bSYour Name /* Description		TCL_DATA_CMD_2_BUF_OR_EXT_DESC_TYPE
700*5113495bSYour Name 
701*5113495bSYour Name 			<enum 0 MSDU_buffer> The address points to an MSDU
702*5113495bSYour Name 			buffer.
703*5113495bSYour Name 
704*5113495bSYour Name 			<enum 1 extension_descriptor> The address points to an
705*5113495bSYour Name 			MSDU link extension descriptor
706*5113495bSYour Name 
707*5113495bSYour Name 			< legal all>
708*5113495bSYour Name */
709*5113495bSYour Name #define TCL_DATA_CMD_2_BUF_OR_EXT_DESC_TYPE_OFFSET                   0x00000008
710*5113495bSYour Name #define TCL_DATA_CMD_2_BUF_OR_EXT_DESC_TYPE_LSB                      0
711*5113495bSYour Name #define TCL_DATA_CMD_2_BUF_OR_EXT_DESC_TYPE_MASK                     0x00000001
712*5113495bSYour Name 
713*5113495bSYour Name /* Description		TCL_DATA_CMD_2_EPD
714*5113495bSYour Name 
715*5113495bSYour Name 			When this bit is set then input packet is an EPD type
716*5113495bSYour Name 
717*5113495bSYour Name 			<legal all>
718*5113495bSYour Name */
719*5113495bSYour Name #define TCL_DATA_CMD_2_EPD_OFFSET                                    0x00000008
720*5113495bSYour Name #define TCL_DATA_CMD_2_EPD_LSB                                       1
721*5113495bSYour Name #define TCL_DATA_CMD_2_EPD_MASK                                      0x00000002
722*5113495bSYour Name 
723*5113495bSYour Name /* Description		TCL_DATA_CMD_2_ENCAP_TYPE
724*5113495bSYour Name 
725*5113495bSYour Name 			Indicates the encapsulation that HW will perform:
726*5113495bSYour Name 
727*5113495bSYour Name 			<enum 0 RAW> No encapsulation
728*5113495bSYour Name 
729*5113495bSYour Name 			<enum 1 Native_WiFi>
730*5113495bSYour Name 
731*5113495bSYour Name 			<enum 2 Ethernet> Ethernet 2 (DIX)  or 802.3 (uses
732*5113495bSYour Name 			SNAP/LLC)
733*5113495bSYour Name 
734*5113495bSYour Name 			<enum 3 802_3> DO NOT USE. Indicate Ethernet
735*5113495bSYour Name 
736*5113495bSYour Name 
737*5113495bSYour Name 
738*5113495bSYour Name 			Used by the OLE during encapsulation.
739*5113495bSYour Name 
740*5113495bSYour Name 			<legal all>
741*5113495bSYour Name */
742*5113495bSYour Name #define TCL_DATA_CMD_2_ENCAP_TYPE_OFFSET                             0x00000008
743*5113495bSYour Name #define TCL_DATA_CMD_2_ENCAP_TYPE_LSB                                2
744*5113495bSYour Name #define TCL_DATA_CMD_2_ENCAP_TYPE_MASK                               0x0000000c
745*5113495bSYour Name 
746*5113495bSYour Name /* Description		TCL_DATA_CMD_2_ENCRYPT_TYPE
747*5113495bSYour Name 
748*5113495bSYour Name 			Field only valid for encap_type: RAW
749*5113495bSYour Name 
750*5113495bSYour Name 
751*5113495bSYour Name 
752*5113495bSYour Name 			Indicates type of decrypt cipher used (as defined in the
753*5113495bSYour Name 			peer entry)
754*5113495bSYour Name 
755*5113495bSYour Name 			<enum 0 wep_40> WEP 40-bit
756*5113495bSYour Name 
757*5113495bSYour Name 			<enum 1 wep_104> WEP 104-bit
758*5113495bSYour Name 
759*5113495bSYour Name 			<enum 2 tkip_no_mic> TKIP without MIC
760*5113495bSYour Name 
761*5113495bSYour Name 			<enum 3 wep_128> WEP 128-bit
762*5113495bSYour Name 
763*5113495bSYour Name 			<enum 4 tkip_with_mic> TKIP with MIC
764*5113495bSYour Name 
765*5113495bSYour Name 			<enum 5 wapi> WAPI
766*5113495bSYour Name 
767*5113495bSYour Name 			<enum 6 aes_ccmp_128> AES CCMP 128
768*5113495bSYour Name 
769*5113495bSYour Name 			<enum 7 no_cipher> No crypto
770*5113495bSYour Name 
771*5113495bSYour Name 			<enum 8 aes_ccmp_256> AES CCMP 256
772*5113495bSYour Name 
773*5113495bSYour Name 			<enum 9 aes_gcmp_128> AES CCMP 128
774*5113495bSYour Name 
775*5113495bSYour Name 			<enum 10 aes_gcmp_256> AES CCMP 256
776*5113495bSYour Name 
777*5113495bSYour Name 			<enum 11 wapi_gcm_sm4> WAPI GCM SM4
778*5113495bSYour Name 
779*5113495bSYour Name 
780*5113495bSYour Name 
781*5113495bSYour Name 			<enum 12 wep_varied_width> DO not use... Only for higher
782*5113495bSYour Name 			layer modules..
783*5113495bSYour Name 
784*5113495bSYour Name 			<legal 0-12>
785*5113495bSYour Name */
786*5113495bSYour Name #define TCL_DATA_CMD_2_ENCRYPT_TYPE_OFFSET                           0x00000008
787*5113495bSYour Name #define TCL_DATA_CMD_2_ENCRYPT_TYPE_LSB                              4
788*5113495bSYour Name #define TCL_DATA_CMD_2_ENCRYPT_TYPE_MASK                             0x000000f0
789*5113495bSYour Name 
790*5113495bSYour Name /* Description		TCL_DATA_CMD_2_SRC_BUFFER_SWAP
791*5113495bSYour Name 
792*5113495bSYour Name 			Treats source memory (packet buffer) organization as
793*5113495bSYour Name 			big-endian. The packets are read and byte swapped.
794*5113495bSYour Name 
795*5113495bSYour Name 			1'b0: Source memory is little endian
796*5113495bSYour Name 
797*5113495bSYour Name 			1'b1: Source memory is big endian
798*5113495bSYour Name 
799*5113495bSYour Name 			<legal all>
800*5113495bSYour Name */
801*5113495bSYour Name #define TCL_DATA_CMD_2_SRC_BUFFER_SWAP_OFFSET                        0x00000008
802*5113495bSYour Name #define TCL_DATA_CMD_2_SRC_BUFFER_SWAP_LSB                           8
803*5113495bSYour Name #define TCL_DATA_CMD_2_SRC_BUFFER_SWAP_MASK                          0x00000100
804*5113495bSYour Name 
805*5113495bSYour Name /* Description		TCL_DATA_CMD_2_LINK_META_SWAP
806*5113495bSYour Name 
807*5113495bSYour Name 			Treats link descriptor and Metadata as big-endian. The
808*5113495bSYour Name 			link descriptor/Metadata is read and byte swapped.
809*5113495bSYour Name 
810*5113495bSYour Name 			1'b0: Memory is little endian
811*5113495bSYour Name 
812*5113495bSYour Name 			1'b1: Memory is big endian
813*5113495bSYour Name 
814*5113495bSYour Name 			<legal all>
815*5113495bSYour Name */
816*5113495bSYour Name #define TCL_DATA_CMD_2_LINK_META_SWAP_OFFSET                         0x00000008
817*5113495bSYour Name #define TCL_DATA_CMD_2_LINK_META_SWAP_LSB                            9
818*5113495bSYour Name #define TCL_DATA_CMD_2_LINK_META_SWAP_MASK                           0x00000200
819*5113495bSYour Name 
820*5113495bSYour Name /* Description		TCL_DATA_CMD_2_TQM_NO_DROP
821*5113495bSYour Name 
822*5113495bSYour Name 			This bit is used to stop TQM from dropping MSDUs while
823*5113495bSYour Name 			adding them to MSDU flows1'b1: Do not drop MSDU when any of
824*5113495bSYour Name 			the threshold value is met while adding MSDU in a flow1'b1:
825*5113495bSYour Name 			Drop MSDU when any of the threshold value is met while
826*5113495bSYour Name 			adding MSDU in a flow
827*5113495bSYour Name 
828*5113495bSYour Name 			<legal all>
829*5113495bSYour Name */
830*5113495bSYour Name #define TCL_DATA_CMD_2_TQM_NO_DROP_OFFSET                            0x00000008
831*5113495bSYour Name #define TCL_DATA_CMD_2_TQM_NO_DROP_LSB                               10
832*5113495bSYour Name #define TCL_DATA_CMD_2_TQM_NO_DROP_MASK                              0x00000400
833*5113495bSYour Name 
834*5113495bSYour Name /* Description		TCL_DATA_CMD_2_RESERVED_2A
835*5113495bSYour Name 
836*5113495bSYour Name 			<legal 0>
837*5113495bSYour Name */
838*5113495bSYour Name #define TCL_DATA_CMD_2_RESERVED_2A_OFFSET                            0x00000008
839*5113495bSYour Name #define TCL_DATA_CMD_2_RESERVED_2A_LSB                               11
840*5113495bSYour Name #define TCL_DATA_CMD_2_RESERVED_2A_MASK                              0x00000800
841*5113495bSYour Name 
842*5113495bSYour Name /* Description		TCL_DATA_CMD_2_SEARCH_TYPE
843*5113495bSYour Name 
844*5113495bSYour Name 			Search type select
845*5113495bSYour Name 
846*5113495bSYour Name 
847*5113495bSYour Name 
848*5113495bSYour Name 			<enum 0 Normal_search> Address and flow search will use
849*5113495bSYour Name 			packet contents
850*5113495bSYour Name 
851*5113495bSYour Name 			<enum 1 Index_based_address_search> Address search will
852*5113495bSYour Name 
853*5113495bSYour Name 			<enum 2 Index_based_flow_search> Flow search will use
854*5113495bSYour Name 			'search_index', and address search will use packet contents
855*5113495bSYour Name 
856*5113495bSYour Name 			<legal 0-2>
857*5113495bSYour Name */
858*5113495bSYour Name #define TCL_DATA_CMD_2_SEARCH_TYPE_OFFSET                            0x00000008
859*5113495bSYour Name #define TCL_DATA_CMD_2_SEARCH_TYPE_LSB                               12
860*5113495bSYour Name #define TCL_DATA_CMD_2_SEARCH_TYPE_MASK                              0x00003000
861*5113495bSYour Name 
862*5113495bSYour Name /* Description		TCL_DATA_CMD_2_ADDRX_EN
863*5113495bSYour Name 
864*5113495bSYour Name 			Address X search enable in ASE
865*5113495bSYour Name 
866*5113495bSYour Name 			1'b0: Search disable
867*5113495bSYour Name 
868*5113495bSYour Name 			1'b1: Search Enable
869*5113495bSYour Name 
870*5113495bSYour Name 			<legal all>
871*5113495bSYour Name */
872*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRX_EN_OFFSET                               0x00000008
873*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRX_EN_LSB                                  14
874*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRX_EN_MASK                                 0x00004000
875*5113495bSYour Name 
876*5113495bSYour Name /* Description		TCL_DATA_CMD_2_ADDRY_EN
877*5113495bSYour Name 
878*5113495bSYour Name 			Address Y search enable in ASE
879*5113495bSYour Name 
880*5113495bSYour Name 			1'b0: Search disable
881*5113495bSYour Name 
882*5113495bSYour Name 			1'b1: Search Enable
883*5113495bSYour Name 
884*5113495bSYour Name 			<legal all>
885*5113495bSYour Name */
886*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRY_EN_OFFSET                               0x00000008
887*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRY_EN_LSB                                  15
888*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRY_EN_MASK                                 0x00008000
889*5113495bSYour Name 
890*5113495bSYour Name /* Description		TCL_DATA_CMD_2_TCL_CMD_NUMBER
891*5113495bSYour Name 
892*5113495bSYour Name 			This number can be used by SW to track, identify and
893*5113495bSYour Name 			link the created commands with the command statuses
894*5113495bSYour Name 
895*5113495bSYour Name 
896*5113495bSYour Name 
897*5113495bSYour Name 			Is set to the value 'TCL_CMD_Number' of the related
898*5113495bSYour Name 			TCL_DATA command
899*5113495bSYour Name 
900*5113495bSYour Name 			<legal all>
901*5113495bSYour Name */
902*5113495bSYour Name #define TCL_DATA_CMD_2_TCL_CMD_NUMBER_OFFSET                         0x00000008
903*5113495bSYour Name #define TCL_DATA_CMD_2_TCL_CMD_NUMBER_LSB                            16
904*5113495bSYour Name #define TCL_DATA_CMD_2_TCL_CMD_NUMBER_MASK                           0xffff0000
905*5113495bSYour Name 
906*5113495bSYour Name /* Description		TCL_DATA_CMD_3_DATA_LENGTH
907*5113495bSYour Name 
908*5113495bSYour Name 			Valid Data length in bytes.
909*5113495bSYour Name 
910*5113495bSYour Name 
911*5113495bSYour Name 
912*5113495bSYour Name 			MSDU length in case of direct descriptor.
913*5113495bSYour Name 
914*5113495bSYour Name 			Length of link extension descriptor in case of Link
915*5113495bSYour Name 			extension descriptor. This is used to know the size of
916*5113495bSYour Name 			Metadata.
917*5113495bSYour Name 
918*5113495bSYour Name 			<legal all>
919*5113495bSYour Name */
920*5113495bSYour Name #define TCL_DATA_CMD_3_DATA_LENGTH_OFFSET                            0x0000000c
921*5113495bSYour Name #define TCL_DATA_CMD_3_DATA_LENGTH_LSB                               0
922*5113495bSYour Name #define TCL_DATA_CMD_3_DATA_LENGTH_MASK                              0x0000ffff
923*5113495bSYour Name 
924*5113495bSYour Name /* Description		TCL_DATA_CMD_3_IPV4_CHECKSUM_EN
925*5113495bSYour Name 
926*5113495bSYour Name 			OLE related control
927*5113495bSYour Name 
928*5113495bSYour Name 			Enable IPv4 checksum replacement
929*5113495bSYour Name */
930*5113495bSYour Name #define TCL_DATA_CMD_3_IPV4_CHECKSUM_EN_OFFSET                       0x0000000c
931*5113495bSYour Name #define TCL_DATA_CMD_3_IPV4_CHECKSUM_EN_LSB                          16
932*5113495bSYour Name #define TCL_DATA_CMD_3_IPV4_CHECKSUM_EN_MASK                         0x00010000
933*5113495bSYour Name 
934*5113495bSYour Name /* Description		TCL_DATA_CMD_3_UDP_OVER_IPV4_CHECKSUM_EN
935*5113495bSYour Name 
936*5113495bSYour Name 			OLE related control
937*5113495bSYour Name 
938*5113495bSYour Name 			Enable UDP over IPv4 checksum replacement.  UDP checksum
939*5113495bSYour Name 			over IPv4 is optional for TCP/IP stacks.
940*5113495bSYour Name */
941*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV4_CHECKSUM_EN_OFFSET              0x0000000c
942*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV4_CHECKSUM_EN_LSB                 17
943*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV4_CHECKSUM_EN_MASK                0x00020000
944*5113495bSYour Name 
945*5113495bSYour Name /* Description		TCL_DATA_CMD_3_UDP_OVER_IPV6_CHECKSUM_EN
946*5113495bSYour Name 
947*5113495bSYour Name 			OLE related control
948*5113495bSYour Name 
949*5113495bSYour Name 			Enable UDP over IPv6 checksum replacement.  UDP checksum
950*5113495bSYour Name 			over IPv6 is mandatory for TCP/IP stacks.
951*5113495bSYour Name */
952*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV6_CHECKSUM_EN_OFFSET              0x0000000c
953*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV6_CHECKSUM_EN_LSB                 18
954*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV6_CHECKSUM_EN_MASK                0x00040000
955*5113495bSYour Name 
956*5113495bSYour Name /* Description		TCL_DATA_CMD_3_TCP_OVER_IPV4_CHECKSUM_EN
957*5113495bSYour Name 
958*5113495bSYour Name 			OLE related control
959*5113495bSYour Name 
960*5113495bSYour Name 			Enable TCP checksum over IPv4 replacement
961*5113495bSYour Name */
962*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV4_CHECKSUM_EN_OFFSET              0x0000000c
963*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV4_CHECKSUM_EN_LSB                 19
964*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV4_CHECKSUM_EN_MASK                0x00080000
965*5113495bSYour Name 
966*5113495bSYour Name /* Description		TCL_DATA_CMD_3_TCP_OVER_IPV6_CHECKSUM_EN
967*5113495bSYour Name 
968*5113495bSYour Name 			OLE related control
969*5113495bSYour Name 
970*5113495bSYour Name 			Enable TCP checksum over IPv6 replacement
971*5113495bSYour Name */
972*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV6_CHECKSUM_EN_OFFSET              0x0000000c
973*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV6_CHECKSUM_EN_LSB                 20
974*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV6_CHECKSUM_EN_MASK                0x00100000
975*5113495bSYour Name 
976*5113495bSYour Name /* Description		TCL_DATA_CMD_3_TO_FW
977*5113495bSYour Name 
978*5113495bSYour Name 			Forward packet to FW along with classification result.
979*5113495bSYour Name 			The packet will not be forward to TQM when this bit is set
980*5113495bSYour Name 
981*5113495bSYour Name 
982*5113495bSYour Name 
983*5113495bSYour Name 			1'b0: Use classification result to forward the packet.
984*5113495bSYour Name 
985*5113495bSYour Name 			1'b1: Override classification result and forward packet
986*5113495bSYour Name 			only to FW.
987*5113495bSYour Name 
988*5113495bSYour Name 			<legal all>
989*5113495bSYour Name */
990*5113495bSYour Name #define TCL_DATA_CMD_3_TO_FW_OFFSET                                  0x0000000c
991*5113495bSYour Name #define TCL_DATA_CMD_3_TO_FW_LSB                                     21
992*5113495bSYour Name #define TCL_DATA_CMD_3_TO_FW_MASK                                    0x00200000
993*5113495bSYour Name 
994*5113495bSYour Name /* Description		TCL_DATA_CMD_3_RESERVED_3A
995*5113495bSYour Name 
996*5113495bSYour Name 			<legal 0>
997*5113495bSYour Name */
998*5113495bSYour Name #define TCL_DATA_CMD_3_RESERVED_3A_OFFSET                            0x0000000c
999*5113495bSYour Name #define TCL_DATA_CMD_3_RESERVED_3A_LSB                               22
1000*5113495bSYour Name #define TCL_DATA_CMD_3_RESERVED_3A_MASK                              0x00400000
1001*5113495bSYour Name 
1002*5113495bSYour Name /* Description		TCL_DATA_CMD_3_PACKET_OFFSET
1003*5113495bSYour Name 
1004*5113495bSYour Name 			Packet offset from Metadata in case of direct buffer
1005*5113495bSYour Name 			descriptor. This field is valid when Buf_or_ext_desc_type is
1006*5113495bSYour Name 			reset(= 0).
1007*5113495bSYour Name 
1008*5113495bSYour Name 			<legal all>
1009*5113495bSYour Name */
1010*5113495bSYour Name #define TCL_DATA_CMD_3_PACKET_OFFSET_OFFSET                          0x0000000c
1011*5113495bSYour Name #define TCL_DATA_CMD_3_PACKET_OFFSET_LSB                             23
1012*5113495bSYour Name #define TCL_DATA_CMD_3_PACKET_OFFSET_MASK                            0xff800000
1013*5113495bSYour Name 
1014*5113495bSYour Name /* Description		TCL_DATA_CMD_4_BUFFER_TIMESTAMP
1015*5113495bSYour Name 
1016*5113495bSYour Name 			Field only valid when 'Buffer_timestamp_valid ' is set.
1017*5113495bSYour Name 
1018*5113495bSYour Name 
1019*5113495bSYour Name 
1020*5113495bSYour Name 			Frame system entrance timestamp. The timestamp is
1021*5113495bSYour Name 			related to the global system timer
1022*5113495bSYour Name 
1023*5113495bSYour Name 
1024*5113495bSYour Name 
1025*5113495bSYour Name 			Generally the first module (SW, TCL or TQM). that sees
1026*5113495bSYour Name 			this frame and this timestamp field is not valid, shall fill
1027*5113495bSYour Name 			in this field.
1028*5113495bSYour Name 
1029*5113495bSYour Name 
1030*5113495bSYour Name 
1031*5113495bSYour Name 			Timestamp in units of 1024 us
1032*5113495bSYour Name */
1033*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_OFFSET                       0x00000010
1034*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_LSB                          0
1035*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_MASK                         0x0007ffff
1036*5113495bSYour Name 
1037*5113495bSYour Name /* Description		TCL_DATA_CMD_4_BUFFER_TIMESTAMP_VALID
1038*5113495bSYour Name 
1039*5113495bSYour Name 			When set, the Buffer_timestamp field contains valid
1040*5113495bSYour Name 			info.
1041*5113495bSYour Name */
1042*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_VALID_OFFSET                 0x00000010
1043*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_VALID_LSB                    19
1044*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_VALID_MASK                   0x00080000
1045*5113495bSYour Name 
1046*5113495bSYour Name /* Description		TCL_DATA_CMD_4_RESERVED_4A
1047*5113495bSYour Name 
1048*5113495bSYour Name 			<legal 0>
1049*5113495bSYour Name */
1050*5113495bSYour Name #define TCL_DATA_CMD_4_RESERVED_4A_OFFSET                            0x00000010
1051*5113495bSYour Name #define TCL_DATA_CMD_4_RESERVED_4A_LSB                               20
1052*5113495bSYour Name #define TCL_DATA_CMD_4_RESERVED_4A_MASK                              0x00100000
1053*5113495bSYour Name 
1054*5113495bSYour Name /* Description		TCL_DATA_CMD_4_HLOS_TID_OVERWRITE
1055*5113495bSYour Name 
1056*5113495bSYour Name 			When set, TCL shall ignore the IP DSCP and VLAN PCP
1057*5113495bSYour Name 			fields and use HLOS_TID as the final TID. Otherwise TCL
1058*5113495bSYour Name 			shall consider the DSCP and PCP fields as well as HLOS_TID
1059*5113495bSYour Name 			and choose a final TID based on the configured priority
1060*5113495bSYour Name 
1061*5113495bSYour Name 			<legal all>
1062*5113495bSYour Name */
1063*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_OVERWRITE_OFFSET                     0x00000010
1064*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_OVERWRITE_LSB                        21
1065*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_OVERWRITE_MASK                       0x00200000
1066*5113495bSYour Name 
1067*5113495bSYour Name /* Description		TCL_DATA_CMD_4_HLOS_TID
1068*5113495bSYour Name 
1069*5113495bSYour Name 			HLOS MSDU priority
1070*5113495bSYour Name 
1071*5113495bSYour Name 
1072*5113495bSYour Name 
1073*5113495bSYour Name 			Field is used when HLOS_TID_overwrite is set.
1074*5113495bSYour Name 
1075*5113495bSYour Name 
1076*5113495bSYour Name 
1077*5113495bSYour Name 			Field is also used when HLOS_TID_overwrite is not set
1078*5113495bSYour Name 			and DSCP/PCP is not available in the packet
1079*5113495bSYour Name 
1080*5113495bSYour Name 			<legal all>
1081*5113495bSYour Name */
1082*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_OFFSET                               0x00000010
1083*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_LSB                                  22
1084*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_MASK                                 0x03c00000
1085*5113495bSYour Name 
1086*5113495bSYour Name /* Description		TCL_DATA_CMD_4_LMAC_ID
1087*5113495bSYour Name 
1088*5113495bSYour Name 			TCL uses this LMAC_ID in address search, i.e, while
1089*5113495bSYour Name 			finding matching entry for the packet in AST corresponding
1090*5113495bSYour Name 			to given LMAC_ID
1091*5113495bSYour Name 
1092*5113495bSYour Name 			If LMAC ID is all 1s (=> value 3), it indicates wildcard
1093*5113495bSYour Name 			match for any MAC
1094*5113495bSYour Name 
1095*5113495bSYour Name 			<legal 0-3>
1096*5113495bSYour Name */
1097*5113495bSYour Name #define TCL_DATA_CMD_4_LMAC_ID_OFFSET                                0x00000010
1098*5113495bSYour Name #define TCL_DATA_CMD_4_LMAC_ID_LSB                                   26
1099*5113495bSYour Name #define TCL_DATA_CMD_4_LMAC_ID_MASK                                  0x0c000000
1100*5113495bSYour Name 
1101*5113495bSYour Name /* Description		TCL_DATA_CMD_4_UDP_FLOW_OVERRIDE
1102*5113495bSYour Name 
1103*5113495bSYour Name 			TCL uses this to select the flow pointer from the peer
1104*5113495bSYour Name 			table, which can be overridden by SW for pre-encrypted raw
1105*5113495bSYour Name 			WiFi packets that cannot be parsed for UDP or for other
1106*5113495bSYour Name 			enterprise use cases:
1107*5113495bSYour Name 
1108*5113495bSYour Name 			<enum 0 FP_PARSE_IP> Use the flow-pointer based on
1109*5113495bSYour Name 			parsing the IPv4 or IPv6 header
1110*5113495bSYour Name 
1111*5113495bSYour Name 			<enum 1 FP_USE_NON_UDP> Use the non-UDP flow pointer
1112*5113495bSYour Name 
1113*5113495bSYour Name 			<enum 2 FP_USE_UDP> Use the UDP flow pointer
1114*5113495bSYour Name 
1115*5113495bSYour Name 
1116*5113495bSYour Name 
1117*5113495bSYour Name 			This is not supported in Moselle.
1118*5113495bSYour Name 
1119*5113495bSYour Name 			<legal 0-2>
1120*5113495bSYour Name */
1121*5113495bSYour Name #define TCL_DATA_CMD_4_UDP_FLOW_OVERRIDE_OFFSET                      0x00000010
1122*5113495bSYour Name #define TCL_DATA_CMD_4_UDP_FLOW_OVERRIDE_LSB                         28
1123*5113495bSYour Name #define TCL_DATA_CMD_4_UDP_FLOW_OVERRIDE_MASK                        0x30000000
1124*5113495bSYour Name 
1125*5113495bSYour Name /* Description		TCL_DATA_CMD_4_RESERVED_4B
1126*5113495bSYour Name 
1127*5113495bSYour Name 			<legal 0>
1128*5113495bSYour Name */
1129*5113495bSYour Name #define TCL_DATA_CMD_4_RESERVED_4B_OFFSET                            0x00000010
1130*5113495bSYour Name #define TCL_DATA_CMD_4_RESERVED_4B_LSB                               30
1131*5113495bSYour Name #define TCL_DATA_CMD_4_RESERVED_4B_MASK                              0xc0000000
1132*5113495bSYour Name 
1133*5113495bSYour Name /* Description		TCL_DATA_CMD_5_DSCP_TID_TABLE_NUM
1134*5113495bSYour Name 
1135*5113495bSYour Name 			DSCP to TID mapping table number that need to be used
1136*5113495bSYour Name 			for the MSDU, should be specified using this field
1137*5113495bSYour Name 
1138*5113495bSYour Name 			<legal all>
1139*5113495bSYour Name */
1140*5113495bSYour Name #define TCL_DATA_CMD_5_DSCP_TID_TABLE_NUM_OFFSET                     0x00000014
1141*5113495bSYour Name #define TCL_DATA_CMD_5_DSCP_TID_TABLE_NUM_LSB                        0
1142*5113495bSYour Name #define TCL_DATA_CMD_5_DSCP_TID_TABLE_NUM_MASK                       0x0000003f
1143*5113495bSYour Name 
1144*5113495bSYour Name /* Description		TCL_DATA_CMD_5_SEARCH_INDEX
1145*5113495bSYour Name 
1146*5113495bSYour Name 			The index that will be used for index based address or
1147*5113495bSYour Name 			flow search. The field is valid when 'search_type' is  1 or
1148*5113495bSYour Name 			2.
1149*5113495bSYour Name 
1150*5113495bSYour Name 			<legal all>
1151*5113495bSYour Name */
1152*5113495bSYour Name #define TCL_DATA_CMD_5_SEARCH_INDEX_OFFSET                           0x00000014
1153*5113495bSYour Name #define TCL_DATA_CMD_5_SEARCH_INDEX_LSB                              6
1154*5113495bSYour Name #define TCL_DATA_CMD_5_SEARCH_INDEX_MASK                             0x03ffffc0
1155*5113495bSYour Name 
1156*5113495bSYour Name /* Description		TCL_DATA_CMD_5_CACHE_SET_NUM
1157*5113495bSYour Name 
1158*5113495bSYour Name 			Cache set number that should be used to cache the index
1159*5113495bSYour Name 			based search results, for address and flow search. This
1160*5113495bSYour Name 			value should be equal to LSB four bits of the hash value of
1161*5113495bSYour Name 			match data, in case of search index points to an entry which
1162*5113495bSYour Name 			may be used in content based search also. The value can be
1163*5113495bSYour Name 			anything when the entry pointed by search index will not be
1164*5113495bSYour Name 			used for content based search.
1165*5113495bSYour Name 
1166*5113495bSYour Name 			<legal all>
1167*5113495bSYour Name */
1168*5113495bSYour Name #define TCL_DATA_CMD_5_CACHE_SET_NUM_OFFSET                          0x00000014
1169*5113495bSYour Name #define TCL_DATA_CMD_5_CACHE_SET_NUM_LSB                             26
1170*5113495bSYour Name #define TCL_DATA_CMD_5_CACHE_SET_NUM_MASK                            0x3c000000
1171*5113495bSYour Name 
1172*5113495bSYour Name /* Description		TCL_DATA_CMD_5_MESH_ENABLE
1173*5113495bSYour Name 
1174*5113495bSYour Name 			If set to a non-zero value:
1175*5113495bSYour Name 
1176*5113495bSYour Name 			* For raw WiFi frames, this indicates transmission to a
1177*5113495bSYour Name 			mesh STA, enabling the interpretation of the 'Mesh Control
1178*5113495bSYour Name 			Present' bit (bit 8) of QoS Control (otherwise this bit is
1179*5113495bSYour Name 			ignored). The interpretation of the A-MSDU 'Length' field is
1180*5113495bSYour Name 			decided by the e-numerations below.
1181*5113495bSYour Name 
1182*5113495bSYour Name 			* For native WiFi frames, this indicates that a 'Mesh
1183*5113495bSYour Name 			Control' field is present between the header and the LLC.
1184*5113495bSYour Name 			The three non-zero values are interchangeable.
1185*5113495bSYour Name 
1186*5113495bSYour Name 
1187*5113495bSYour Name 
1188*5113495bSYour Name 			<enum 0 MESH_DISABLE>
1189*5113495bSYour Name 
1190*5113495bSYour Name 			<enum 1 MESH_Q2Q> A-MSDU 'Length' is big endian and
1191*5113495bSYour Name 			includes the length of Mesh Control.
1192*5113495bSYour Name 
1193*5113495bSYour Name 			<enum 2 MESH_11S_BE> A-MSDU 'Length' is big endian and
1194*5113495bSYour Name 			excludes the length of Mesh Control.
1195*5113495bSYour Name 
1196*5113495bSYour Name 			<enum 3 MESH_11S_LE> A-MSDU 'Length' is little endian
1197*5113495bSYour Name 			and excludes the length of Mesh Control. This is
1198*5113495bSYour Name 			802.11s-compliant.
1199*5113495bSYour Name 
1200*5113495bSYour Name 			<legal 0-3>
1201*5113495bSYour Name */
1202*5113495bSYour Name #define TCL_DATA_CMD_5_MESH_ENABLE_OFFSET                            0x00000014
1203*5113495bSYour Name #define TCL_DATA_CMD_5_MESH_ENABLE_LSB                               30
1204*5113495bSYour Name #define TCL_DATA_CMD_5_MESH_ENABLE_MASK                              0xc0000000
1205*5113495bSYour Name 
1206*5113495bSYour Name /* Description		TCL_DATA_CMD_6_RESERVED_6A
1207*5113495bSYour Name 
1208*5113495bSYour Name 			<legal 0>
1209*5113495bSYour Name */
1210*5113495bSYour Name #define TCL_DATA_CMD_6_RESERVED_6A_OFFSET                            0x00000018
1211*5113495bSYour Name #define TCL_DATA_CMD_6_RESERVED_6A_LSB                               0
1212*5113495bSYour Name #define TCL_DATA_CMD_6_RESERVED_6A_MASK                              0x000fffff
1213*5113495bSYour Name 
1214*5113495bSYour Name /* Description		TCL_DATA_CMD_6_RING_ID
1215*5113495bSYour Name 
1216*5113495bSYour Name 			The buffer pointer ring ID.
1217*5113495bSYour Name 
1218*5113495bSYour Name 			0 refers to the IDLE ring
1219*5113495bSYour Name 
1220*5113495bSYour Name 			1 - N refers to other rings
1221*5113495bSYour Name 
1222*5113495bSYour Name 
1223*5113495bSYour Name 
1224*5113495bSYour Name 			Helps with debugging when dumping ring contents.
1225*5113495bSYour Name 
1226*5113495bSYour Name 			<legal all>
1227*5113495bSYour Name */
1228*5113495bSYour Name #define TCL_DATA_CMD_6_RING_ID_OFFSET                                0x00000018
1229*5113495bSYour Name #define TCL_DATA_CMD_6_RING_ID_LSB                                   20
1230*5113495bSYour Name #define TCL_DATA_CMD_6_RING_ID_MASK                                  0x0ff00000
1231*5113495bSYour Name 
1232*5113495bSYour Name /* Description		TCL_DATA_CMD_6_LOOPING_COUNT
1233*5113495bSYour Name 
1234*5113495bSYour Name 			A count value that indicates the number of times the
1235*5113495bSYour Name 			producer of entries into the Ring has looped around the
1236*5113495bSYour Name 			ring.
1237*5113495bSYour Name 
1238*5113495bSYour Name 			At initialization time, this value is set to 0. On the
1239*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
1240*5113495bSYour Name 			reached allowed by the number of bits for this field, the
1241*5113495bSYour Name 			count value continues with 0 again.
1242*5113495bSYour Name 
1243*5113495bSYour Name 
1244*5113495bSYour Name 
1245*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
1246*5113495bSYour Name 			use this field to figure out up to where the producer of
1247*5113495bSYour Name 			entries has created new entries. This eliminates the need to
1248*5113495bSYour Name 			check where the head pointer' of the ring is located once
1249*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
1250*5113495bSYour Name 			entries have been put into this ring...
1251*5113495bSYour Name 
1252*5113495bSYour Name 
1253*5113495bSYour Name 
1254*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
1255*5113495bSYour Name 			LSB bit of this count value.
1256*5113495bSYour Name 
1257*5113495bSYour Name 			<legal all>
1258*5113495bSYour Name */
1259*5113495bSYour Name #define TCL_DATA_CMD_6_LOOPING_COUNT_OFFSET                          0x00000018
1260*5113495bSYour Name #define TCL_DATA_CMD_6_LOOPING_COUNT_LSB                             28
1261*5113495bSYour Name #define TCL_DATA_CMD_6_LOOPING_COUNT_MASK                            0xf0000000
1262*5113495bSYour Name 
1263*5113495bSYour Name 
1264*5113495bSYour Name #endif // _TCL_DATA_CMD_H_
1265