xref: /wlan-driver/fw-api/hw/qca8074/v1/tcl_data_cmd.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2016 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 // $ATH_LICENSE_HW_HDR_C$
20*5113495bSYour Name //
21*5113495bSYour Name // DO NOT EDIT!  This file is automatically generated
22*5113495bSYour Name //               These definitions are tied to a particular hardware layout
23*5113495bSYour Name 
24*5113495bSYour Name 
25*5113495bSYour Name #ifndef _TCL_DATA_CMD_H_
26*5113495bSYour Name #define _TCL_DATA_CMD_H_
27*5113495bSYour Name #if !defined(__ASSEMBLER__)
28*5113495bSYour Name #endif
29*5113495bSYour Name 
30*5113495bSYour Name #include "buffer_addr_info.h"
31*5113495bSYour Name 
32*5113495bSYour Name // ################ START SUMMARY #################
33*5113495bSYour Name //
34*5113495bSYour Name //	Dword	Fields
35*5113495bSYour Name //	0-1	struct buffer_addr_info buf_addr_info;
36*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], reserved[13:10], addrx_en[14], addry_en[15], tcl_cmd_number[31:16]
37*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], dscp_to_tid_priority_table_id[22], packet_offset[31:23]
38*5113495bSYour Name //	4	buffer_timestamp[18:0], buffer_timestamp_valid[19], mesh_enable[20], hlos_tid_overwrite[21], hlos_tid[25:22], reserved_4[31:26]
39*5113495bSYour Name //	5	reserved_5[31:0]
40*5113495bSYour Name //	6	reserved_6a[19:0], ring_id[27:20], looping_count[31:28]
41*5113495bSYour Name //
42*5113495bSYour Name // ################ END SUMMARY #################
43*5113495bSYour Name 
44*5113495bSYour Name #define NUM_OF_DWORDS_TCL_DATA_CMD 7
45*5113495bSYour Name 
46*5113495bSYour Name struct tcl_data_cmd {
47*5113495bSYour Name     struct            buffer_addr_info                       buf_addr_info;
48*5113495bSYour Name              uint32_t buf_or_ext_desc_type            :  1, //[0]
49*5113495bSYour Name                       epd                             :  1, //[1]
50*5113495bSYour Name                       encap_type                      :  2, //[3:2]
51*5113495bSYour Name                       encrypt_type                    :  4, //[7:4]
52*5113495bSYour Name                       src_buffer_swap                 :  1, //[8]
53*5113495bSYour Name                       link_meta_swap                  :  1, //[9]
54*5113495bSYour Name                       reserved                        :  4, //[13:10]
55*5113495bSYour Name                       addrx_en                        :  1, //[14]
56*5113495bSYour Name                       addry_en                        :  1, //[15]
57*5113495bSYour Name                       tcl_cmd_number                  : 16; //[31:16]
58*5113495bSYour Name              uint32_t data_length                     : 16, //[15:0]
59*5113495bSYour Name                       ipv4_checksum_en                :  1, //[16]
60*5113495bSYour Name                       udp_over_ipv4_checksum_en       :  1, //[17]
61*5113495bSYour Name                       udp_over_ipv6_checksum_en       :  1, //[18]
62*5113495bSYour Name                       tcp_over_ipv4_checksum_en       :  1, //[19]
63*5113495bSYour Name                       tcp_over_ipv6_checksum_en       :  1, //[20]
64*5113495bSYour Name                       to_fw                           :  1, //[21]
65*5113495bSYour Name                       dscp_to_tid_priority_table_id   :  1, //[22]
66*5113495bSYour Name                       packet_offset                   :  9; //[31:23]
67*5113495bSYour Name              uint32_t buffer_timestamp                : 19, //[18:0]
68*5113495bSYour Name                       buffer_timestamp_valid          :  1, //[19]
69*5113495bSYour Name                       mesh_enable                     :  1, //[20]
70*5113495bSYour Name                       hlos_tid_overwrite              :  1, //[21]
71*5113495bSYour Name                       hlos_tid                        :  4, //[25:22]
72*5113495bSYour Name                       reserved_4                      :  6; //[31:26]
73*5113495bSYour Name              uint32_t reserved_5                      : 32; //[31:0]
74*5113495bSYour Name              uint32_t reserved_6a                     : 20, //[19:0]
75*5113495bSYour Name                       ring_id                         :  8, //[27:20]
76*5113495bSYour Name                       looping_count                   :  4; //[31:28]
77*5113495bSYour Name };
78*5113495bSYour Name 
79*5113495bSYour Name /*
80*5113495bSYour Name 
81*5113495bSYour Name struct buffer_addr_info buf_addr_info
82*5113495bSYour Name 
83*5113495bSYour Name 			Details of the physical address for a single buffer
84*5113495bSYour Name 
85*5113495bSYour Name 			It also contains return ownership info as well as some
86*5113495bSYour Name 			meta data for SW related to this buffer.
87*5113495bSYour Name 
88*5113495bSYour Name 
89*5113495bSYour Name 
90*5113495bSYour Name 			In case of Buf_or_ext_desc_type indicating
91*5113495bSYour Name 			'MSDU_buffer', this address indicates the start of the meta
92*5113495bSYour Name 			data that is preceding the actual packet data.
93*5113495bSYour Name 
94*5113495bSYour Name 			The start of the actual packet data is provided by
95*5113495bSYour Name 			field: Packet_offset
96*5113495bSYour Name 
97*5113495bSYour Name buf_or_ext_desc_type
98*5113495bSYour Name 
99*5113495bSYour Name 			<enum 0 MSDU_buffer> The address points to an MSDU
100*5113495bSYour Name 			buffer.
101*5113495bSYour Name 
102*5113495bSYour Name 			<enum 1 extension_descriptor> The address points to an
103*5113495bSYour Name 			MSDU link extension descriptor
104*5113495bSYour Name 
105*5113495bSYour Name 			< legal all>
106*5113495bSYour Name 
107*5113495bSYour Name epd
108*5113495bSYour Name 
109*5113495bSYour Name 			When this bit is set then input packet is an EPD type
110*5113495bSYour Name 
111*5113495bSYour Name 			<legal all>
112*5113495bSYour Name 
113*5113495bSYour Name encap_type
114*5113495bSYour Name 
115*5113495bSYour Name 			Indicates the encapsulation that HW will perform:
116*5113495bSYour Name 
117*5113495bSYour Name 			<enum 0 RAW> No encapsulation
118*5113495bSYour Name 
119*5113495bSYour Name 			<enum 1 Native_WiFi>
120*5113495bSYour Name 
121*5113495bSYour Name 			<enum 2 Ethernet> Ethernet 2 (DIX)
122*5113495bSYour Name 
123*5113495bSYour Name 			<enum 3 802_3> 802.3 (uses SNAP/LLC)
124*5113495bSYour Name 
125*5113495bSYour Name 			Used by the OLE during encapsulation.
126*5113495bSYour Name 
127*5113495bSYour Name 			<legal all>
128*5113495bSYour Name 
129*5113495bSYour Name encrypt_type
130*5113495bSYour Name 
131*5113495bSYour Name 			Field only valid for encap_type: RAW
132*5113495bSYour Name 
133*5113495bSYour Name 
134*5113495bSYour Name 
135*5113495bSYour Name 			Indicates type of decrypt cipher used (as defined in the
136*5113495bSYour Name 			peer entry)
137*5113495bSYour Name 
138*5113495bSYour Name 			<enum 0 wep_40> WEP 40-bit
139*5113495bSYour Name 
140*5113495bSYour Name 			<enum 1 wep_104> WEP 104-bit
141*5113495bSYour Name 
142*5113495bSYour Name 			<enum 2 tkip_no_mic> TKIP without MIC
143*5113495bSYour Name 
144*5113495bSYour Name 			<enum 3 wep_128> WEP 128-bit
145*5113495bSYour Name 
146*5113495bSYour Name 			<enum 4 tkip_with_mic> TKIP with MIC
147*5113495bSYour Name 
148*5113495bSYour Name 			<enum 5 wapi> WAPI
149*5113495bSYour Name 
150*5113495bSYour Name 			<enum 6 aes_ccmp_128> AES CCMP 128
151*5113495bSYour Name 
152*5113495bSYour Name 			<enum 7 no_cipher> No crypto
153*5113495bSYour Name 
154*5113495bSYour Name 			<enum 8 aes_ccmp_256> AES CCMP 256
155*5113495bSYour Name 
156*5113495bSYour Name 			<enum 9 aes_gcmp_128> AES CCMP 128
157*5113495bSYour Name 
158*5113495bSYour Name 			<enum 10 aes_gcmp_256> AES CCMP 256
159*5113495bSYour Name 
160*5113495bSYour Name 			<enum 11 wapi_gcm_sm4> WAPI GCM SM4
161*5113495bSYour Name 
162*5113495bSYour Name 			<legal 0-11>
163*5113495bSYour Name 
164*5113495bSYour Name src_buffer_swap
165*5113495bSYour Name 
166*5113495bSYour Name 			Treats source memory (packet buffer) organization as
167*5113495bSYour Name 			big-endian. The packets are read and byte swapped.
168*5113495bSYour Name 
169*5113495bSYour Name 			1'b0: Source memory is little endian
170*5113495bSYour Name 
171*5113495bSYour Name 			1'b1: Source memory is big endian
172*5113495bSYour Name 
173*5113495bSYour Name 			<legal all>
174*5113495bSYour Name 
175*5113495bSYour Name link_meta_swap
176*5113495bSYour Name 
177*5113495bSYour Name 			Treats link descriptor and Metadata as big-endian. The
178*5113495bSYour Name 			link descriptor/Metadata is read and byte swapped.
179*5113495bSYour Name 
180*5113495bSYour Name 			1'b0: Memory is little endian
181*5113495bSYour Name 
182*5113495bSYour Name 			1'b1: Memory is big endian
183*5113495bSYour Name 
184*5113495bSYour Name 			<legal all>
185*5113495bSYour Name 
186*5113495bSYour Name reserved
187*5113495bSYour Name 
188*5113495bSYour Name 			<legal 0>
189*5113495bSYour Name 
190*5113495bSYour Name addrx_en
191*5113495bSYour Name 
192*5113495bSYour Name 			Address X search enable in ASE
193*5113495bSYour Name 
194*5113495bSYour Name 			1'b0: Search disable
195*5113495bSYour Name 
196*5113495bSYour Name 			1'b1: Search Enable
197*5113495bSYour Name 
198*5113495bSYour Name 			<legal all>
199*5113495bSYour Name 
200*5113495bSYour Name addry_en
201*5113495bSYour Name 
202*5113495bSYour Name 			Address Y search enable in ASE
203*5113495bSYour Name 
204*5113495bSYour Name 			1'b0: Search disable
205*5113495bSYour Name 
206*5113495bSYour Name 			1'b1: Search Enable
207*5113495bSYour Name 
208*5113495bSYour Name 			<legal all>
209*5113495bSYour Name 
210*5113495bSYour Name tcl_cmd_number
211*5113495bSYour Name 
212*5113495bSYour Name 			This number can be used by SW to track, identify and
213*5113495bSYour Name 			link the created commands with the command statuses
214*5113495bSYour Name 
215*5113495bSYour Name 
216*5113495bSYour Name 
217*5113495bSYour Name 			Is set to the value 'TCL_CMD_Number' of the related
218*5113495bSYour Name 			TCL_DATA command
219*5113495bSYour Name 
220*5113495bSYour Name 			<legal all>
221*5113495bSYour Name 
222*5113495bSYour Name data_length
223*5113495bSYour Name 
224*5113495bSYour Name 			Valid Data length in bytes.
225*5113495bSYour Name 
226*5113495bSYour Name 
227*5113495bSYour Name 
228*5113495bSYour Name 			MSDU length in case of direct descriptor.
229*5113495bSYour Name 
230*5113495bSYour Name 			Length of link extension descriptor in case of Link
231*5113495bSYour Name 			extension descriptor. This is used to know the size of
232*5113495bSYour Name 			Metadata.
233*5113495bSYour Name 
234*5113495bSYour Name 			<legal all>
235*5113495bSYour Name 
236*5113495bSYour Name ipv4_checksum_en
237*5113495bSYour Name 
238*5113495bSYour Name 			Field only valid when msdu_buffer_type is set to
239*5113495bSYour Name 			MSDU_buffer.
240*5113495bSYour Name 
241*5113495bSYour Name 
242*5113495bSYour Name 
243*5113495bSYour Name 			OLE related control
244*5113495bSYour Name 
245*5113495bSYour Name 			Enable IPv4 checksum replacement
246*5113495bSYour Name 
247*5113495bSYour Name udp_over_ipv4_checksum_en
248*5113495bSYour Name 
249*5113495bSYour Name 			Field only valid when msdu_buffer_type is set to
250*5113495bSYour Name 			MSDU_buffer.
251*5113495bSYour Name 
252*5113495bSYour Name 
253*5113495bSYour Name 
254*5113495bSYour Name 			OLE related control
255*5113495bSYour Name 
256*5113495bSYour Name 			Enable UDP over IPv4 checksum replacement.  UDP checksum
257*5113495bSYour Name 			over IPv4 is optional for TCP/IP stacks.
258*5113495bSYour Name 
259*5113495bSYour Name udp_over_ipv6_checksum_en
260*5113495bSYour Name 
261*5113495bSYour Name 			Field only valid when msdu_buffer_type is set to
262*5113495bSYour Name 			MSDU_buffer.
263*5113495bSYour Name 
264*5113495bSYour Name 
265*5113495bSYour Name 
266*5113495bSYour Name 			OLE related control
267*5113495bSYour Name 
268*5113495bSYour Name 			Enable UDP over IPv6 checksum replacement.  UDP checksum
269*5113495bSYour Name 			over IPv6 is mandatory for TCP/IP stacks.
270*5113495bSYour Name 
271*5113495bSYour Name tcp_over_ipv4_checksum_en
272*5113495bSYour Name 
273*5113495bSYour Name 			Field only valid when msdu_buffer_type is set to
274*5113495bSYour Name 			MSDU_buffer.
275*5113495bSYour Name 
276*5113495bSYour Name 
277*5113495bSYour Name 
278*5113495bSYour Name 			OLE related control
279*5113495bSYour Name 
280*5113495bSYour Name 			Enable TCP checksum over IPv4 replacement
281*5113495bSYour Name 
282*5113495bSYour Name tcp_over_ipv6_checksum_en
283*5113495bSYour Name 
284*5113495bSYour Name 			Field only valid when msdu_buffer_type is set to
285*5113495bSYour Name 			MSDU_buffer.
286*5113495bSYour Name 
287*5113495bSYour Name 
288*5113495bSYour Name 
289*5113495bSYour Name 			OLE related control
290*5113495bSYour Name 
291*5113495bSYour Name 			Enable TCP checksum over IPv6 replacement
292*5113495bSYour Name 
293*5113495bSYour Name to_fw
294*5113495bSYour Name 
295*5113495bSYour Name 			Forward packet to FW along with classification result.
296*5113495bSYour Name 			The packet will not be forward to TQM when this bit is set
297*5113495bSYour Name 
298*5113495bSYour Name 			1'b0: Use classification result to forward the packet.
299*5113495bSYour Name 
300*5113495bSYour Name 			1'b1: Override classification result and forward packet
301*5113495bSYour Name 			only to FW.
302*5113495bSYour Name 
303*5113495bSYour Name dscp_to_tid_priority_table_id
304*5113495bSYour Name 
305*5113495bSYour Name 			The DSCP to tid conversion table to be used for this
306*5113495bSYour Name 			frame
307*5113495bSYour Name 
308*5113495bSYour Name 			<legal all>
309*5113495bSYour Name 
310*5113495bSYour Name packet_offset
311*5113495bSYour Name 
312*5113495bSYour Name 			Packet offset from Metadata in case of direct buffer
313*5113495bSYour Name 			descriptor. This field is valid when Buf_or_ext_desc_type is
314*5113495bSYour Name 			reset(= 0).
315*5113495bSYour Name 
316*5113495bSYour Name 			<legal all>
317*5113495bSYour Name 
318*5113495bSYour Name buffer_timestamp
319*5113495bSYour Name 
320*5113495bSYour Name 			Field only valid when 'Buffer_timestamp_valid ' is set.
321*5113495bSYour Name 
322*5113495bSYour Name 
323*5113495bSYour Name 
324*5113495bSYour Name 			Frame system entrance timestamp. The timestamp is
325*5113495bSYour Name 			related to the global system timer
326*5113495bSYour Name 
327*5113495bSYour Name 
328*5113495bSYour Name 
329*5113495bSYour Name 			Generally the first module (SW, TCL or TQM). that sees
330*5113495bSYour Name 			this frame and this timestamp field is not valid, shall fill
331*5113495bSYour Name 			in this field.
332*5113495bSYour Name 
333*5113495bSYour Name 
334*5113495bSYour Name 
335*5113495bSYour Name 			Timestamp in units of 1024 us
336*5113495bSYour Name 
337*5113495bSYour Name buffer_timestamp_valid
338*5113495bSYour Name 
339*5113495bSYour Name 			When set, the Buffer_timestamp field contains valid
340*5113495bSYour Name 			info.
341*5113495bSYour Name 
342*5113495bSYour Name mesh_enable
343*5113495bSYour Name 
344*5113495bSYour Name 			If set to 1:
345*5113495bSYour Name 
346*5113495bSYour Name 			* For raw WiFi frames, this indicates transmission to a
347*5113495bSYour Name 			mesh STA, enabling the interpretation of the 'Mesh Control
348*5113495bSYour Name 			Present' bit (bit 8) of QoS Control (otherwise this bit is
349*5113495bSYour Name 			ignored),
350*5113495bSYour Name 
351*5113495bSYour Name 			* For native WiFi frames, this indicates that a 'Mesh
352*5113495bSYour Name 			Control' field is present between the header and the LLC.
353*5113495bSYour Name 
354*5113495bSYour Name hlos_tid_overwrite
355*5113495bSYour Name 
356*5113495bSYour Name 			When set, TCL shall ignore the IP DSCP and VLAN PCP
357*5113495bSYour Name 			fields and use HLOS_TID as the final TID. Otherwise TCL
358*5113495bSYour Name 			shall consider the DSCP and PCP fields as well as HLOS_TID
359*5113495bSYour Name 			and choose a final TID based on the configured priority
360*5113495bSYour Name 
361*5113495bSYour Name 			<legal all>
362*5113495bSYour Name 
363*5113495bSYour Name hlos_tid
364*5113495bSYour Name 
365*5113495bSYour Name 			HLOS MSDU priority
366*5113495bSYour Name 
367*5113495bSYour Name 
368*5113495bSYour Name 
369*5113495bSYour Name 			Field is used when HLOS_TID_overwrite is set.
370*5113495bSYour Name 
371*5113495bSYour Name 
372*5113495bSYour Name 
373*5113495bSYour Name 			Field is also used when HLOS_TID_overwrite is not set
374*5113495bSYour Name 			and DSCP/PCP is not available in the packet
375*5113495bSYour Name 
376*5113495bSYour Name 			<legal all>
377*5113495bSYour Name 
378*5113495bSYour Name reserved_4
379*5113495bSYour Name 
380*5113495bSYour Name 			<legal 0>
381*5113495bSYour Name 
382*5113495bSYour Name reserved_5
383*5113495bSYour Name 
384*5113495bSYour Name 			<legal 0>
385*5113495bSYour Name 
386*5113495bSYour Name reserved_6a
387*5113495bSYour Name 
388*5113495bSYour Name 			<legal 0>
389*5113495bSYour Name 
390*5113495bSYour Name ring_id
391*5113495bSYour Name 
392*5113495bSYour Name 			The buffer pointer ring ID.
393*5113495bSYour Name 
394*5113495bSYour Name 			0 refers to the IDLE ring
395*5113495bSYour Name 
396*5113495bSYour Name 			1 - N refers to other rings
397*5113495bSYour Name 
398*5113495bSYour Name 
399*5113495bSYour Name 
400*5113495bSYour Name 			Helps with debugging when dumping ring contents.
401*5113495bSYour Name 
402*5113495bSYour Name 			<legal all>
403*5113495bSYour Name 
404*5113495bSYour Name looping_count
405*5113495bSYour Name 
406*5113495bSYour Name 			A count value that indicates the number of times the
407*5113495bSYour Name 			producer of entries into the Ring has looped around the
408*5113495bSYour Name 			ring.
409*5113495bSYour Name 
410*5113495bSYour Name 			At initialization time, this value is set to 0. On the
411*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
412*5113495bSYour Name 			reached allowed by the number of bits for this field, the
413*5113495bSYour Name 			count value continues with 0 again.
414*5113495bSYour Name 
415*5113495bSYour Name 
416*5113495bSYour Name 
417*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
418*5113495bSYour Name 			use this field to figure out up to where the producer of
419*5113495bSYour Name 			entries has created new entries. This eliminates the need to
420*5113495bSYour Name 			check where the head pointer' of the ring is located once
421*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
422*5113495bSYour Name 			entries have been put into this ring...
423*5113495bSYour Name 
424*5113495bSYour Name 
425*5113495bSYour Name 
426*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
427*5113495bSYour Name 			LSB bit of this count value.
428*5113495bSYour Name 
429*5113495bSYour Name 			<legal all>
430*5113495bSYour Name */
431*5113495bSYour Name 
432*5113495bSYour Name #define TCL_DATA_CMD_0_BUFFER_ADDR_INFO_BUF_ADDR_INFO_OFFSET         0x00000000
433*5113495bSYour Name #define TCL_DATA_CMD_0_BUFFER_ADDR_INFO_BUF_ADDR_INFO_LSB            28
434*5113495bSYour Name #define TCL_DATA_CMD_0_BUFFER_ADDR_INFO_BUF_ADDR_INFO_MASK           0xffffffff
435*5113495bSYour Name #define TCL_DATA_CMD_1_BUFFER_ADDR_INFO_BUF_ADDR_INFO_OFFSET         0x00000004
436*5113495bSYour Name #define TCL_DATA_CMD_1_BUFFER_ADDR_INFO_BUF_ADDR_INFO_LSB            28
437*5113495bSYour Name #define TCL_DATA_CMD_1_BUFFER_ADDR_INFO_BUF_ADDR_INFO_MASK           0xffffffff
438*5113495bSYour Name 
439*5113495bSYour Name /* Description		TCL_DATA_CMD_2_BUF_OR_EXT_DESC_TYPE
440*5113495bSYour Name 
441*5113495bSYour Name 			<enum 0 MSDU_buffer> The address points to an MSDU
442*5113495bSYour Name 			buffer.
443*5113495bSYour Name 
444*5113495bSYour Name 			<enum 1 extension_descriptor> The address points to an
445*5113495bSYour Name 			MSDU link extension descriptor
446*5113495bSYour Name 
447*5113495bSYour Name 			< legal all>
448*5113495bSYour Name */
449*5113495bSYour Name #define TCL_DATA_CMD_2_BUF_OR_EXT_DESC_TYPE_OFFSET                   0x00000008
450*5113495bSYour Name #define TCL_DATA_CMD_2_BUF_OR_EXT_DESC_TYPE_LSB                      0
451*5113495bSYour Name #define TCL_DATA_CMD_2_BUF_OR_EXT_DESC_TYPE_MASK                     0x00000001
452*5113495bSYour Name 
453*5113495bSYour Name /* Description		TCL_DATA_CMD_2_EPD
454*5113495bSYour Name 
455*5113495bSYour Name 			When this bit is set then input packet is an EPD type
456*5113495bSYour Name 
457*5113495bSYour Name 			<legal all>
458*5113495bSYour Name */
459*5113495bSYour Name #define TCL_DATA_CMD_2_EPD_OFFSET                                    0x00000008
460*5113495bSYour Name #define TCL_DATA_CMD_2_EPD_LSB                                       1
461*5113495bSYour Name #define TCL_DATA_CMD_2_EPD_MASK                                      0x00000002
462*5113495bSYour Name 
463*5113495bSYour Name /* Description		TCL_DATA_CMD_2_ENCAP_TYPE
464*5113495bSYour Name 
465*5113495bSYour Name 			Indicates the encapsulation that HW will perform:
466*5113495bSYour Name 
467*5113495bSYour Name 			<enum 0 RAW> No encapsulation
468*5113495bSYour Name 
469*5113495bSYour Name 			<enum 1 Native_WiFi>
470*5113495bSYour Name 
471*5113495bSYour Name 			<enum 2 Ethernet> Ethernet 2 (DIX)
472*5113495bSYour Name 
473*5113495bSYour Name 			<enum 3 802_3> 802.3 (uses SNAP/LLC)
474*5113495bSYour Name 
475*5113495bSYour Name 			Used by the OLE during encapsulation.
476*5113495bSYour Name 
477*5113495bSYour Name 			<legal all>
478*5113495bSYour Name */
479*5113495bSYour Name #define TCL_DATA_CMD_2_ENCAP_TYPE_OFFSET                             0x00000008
480*5113495bSYour Name #define TCL_DATA_CMD_2_ENCAP_TYPE_LSB                                2
481*5113495bSYour Name #define TCL_DATA_CMD_2_ENCAP_TYPE_MASK                               0x0000000c
482*5113495bSYour Name 
483*5113495bSYour Name /* Description		TCL_DATA_CMD_2_ENCRYPT_TYPE
484*5113495bSYour Name 
485*5113495bSYour Name 			Field only valid for encap_type: RAW
486*5113495bSYour Name 
487*5113495bSYour Name 
488*5113495bSYour Name 
489*5113495bSYour Name 			Indicates type of decrypt cipher used (as defined in the
490*5113495bSYour Name 			peer entry)
491*5113495bSYour Name 
492*5113495bSYour Name 			<enum 0 wep_40> WEP 40-bit
493*5113495bSYour Name 
494*5113495bSYour Name 			<enum 1 wep_104> WEP 104-bit
495*5113495bSYour Name 
496*5113495bSYour Name 			<enum 2 tkip_no_mic> TKIP without MIC
497*5113495bSYour Name 
498*5113495bSYour Name 			<enum 3 wep_128> WEP 128-bit
499*5113495bSYour Name 
500*5113495bSYour Name 			<enum 4 tkip_with_mic> TKIP with MIC
501*5113495bSYour Name 
502*5113495bSYour Name 			<enum 5 wapi> WAPI
503*5113495bSYour Name 
504*5113495bSYour Name 			<enum 6 aes_ccmp_128> AES CCMP 128
505*5113495bSYour Name 
506*5113495bSYour Name 			<enum 7 no_cipher> No crypto
507*5113495bSYour Name 
508*5113495bSYour Name 			<enum 8 aes_ccmp_256> AES CCMP 256
509*5113495bSYour Name 
510*5113495bSYour Name 			<enum 9 aes_gcmp_128> AES CCMP 128
511*5113495bSYour Name 
512*5113495bSYour Name 			<enum 10 aes_gcmp_256> AES CCMP 256
513*5113495bSYour Name 
514*5113495bSYour Name 			<enum 11 wapi_gcm_sm4> WAPI GCM SM4
515*5113495bSYour Name 
516*5113495bSYour Name 			<legal 0-11>
517*5113495bSYour Name */
518*5113495bSYour Name #define TCL_DATA_CMD_2_ENCRYPT_TYPE_OFFSET                           0x00000008
519*5113495bSYour Name #define TCL_DATA_CMD_2_ENCRYPT_TYPE_LSB                              4
520*5113495bSYour Name #define TCL_DATA_CMD_2_ENCRYPT_TYPE_MASK                             0x000000f0
521*5113495bSYour Name 
522*5113495bSYour Name /* Description		TCL_DATA_CMD_2_SRC_BUFFER_SWAP
523*5113495bSYour Name 
524*5113495bSYour Name 			Treats source memory (packet buffer) organization as
525*5113495bSYour Name 			big-endian. The packets are read and byte swapped.
526*5113495bSYour Name 
527*5113495bSYour Name 			1'b0: Source memory is little endian
528*5113495bSYour Name 
529*5113495bSYour Name 			1'b1: Source memory is big endian
530*5113495bSYour Name 
531*5113495bSYour Name 			<legal all>
532*5113495bSYour Name */
533*5113495bSYour Name #define TCL_DATA_CMD_2_SRC_BUFFER_SWAP_OFFSET                        0x00000008
534*5113495bSYour Name #define TCL_DATA_CMD_2_SRC_BUFFER_SWAP_LSB                           8
535*5113495bSYour Name #define TCL_DATA_CMD_2_SRC_BUFFER_SWAP_MASK                          0x00000100
536*5113495bSYour Name 
537*5113495bSYour Name /* Description		TCL_DATA_CMD_2_LINK_META_SWAP
538*5113495bSYour Name 
539*5113495bSYour Name 			Treats link descriptor and Metadata as big-endian. The
540*5113495bSYour Name 			link descriptor/Metadata is read and byte swapped.
541*5113495bSYour Name 
542*5113495bSYour Name 			1'b0: Memory is little endian
543*5113495bSYour Name 
544*5113495bSYour Name 			1'b1: Memory is big endian
545*5113495bSYour Name 
546*5113495bSYour Name 			<legal all>
547*5113495bSYour Name */
548*5113495bSYour Name #define TCL_DATA_CMD_2_LINK_META_SWAP_OFFSET                         0x00000008
549*5113495bSYour Name #define TCL_DATA_CMD_2_LINK_META_SWAP_LSB                            9
550*5113495bSYour Name #define TCL_DATA_CMD_2_LINK_META_SWAP_MASK                           0x00000200
551*5113495bSYour Name 
552*5113495bSYour Name /* Description		TCL_DATA_CMD_2_RESERVED
553*5113495bSYour Name 
554*5113495bSYour Name 			<legal 0>
555*5113495bSYour Name */
556*5113495bSYour Name #define TCL_DATA_CMD_2_RESERVED_OFFSET                               0x00000008
557*5113495bSYour Name #define TCL_DATA_CMD_2_RESERVED_LSB                                  10
558*5113495bSYour Name #define TCL_DATA_CMD_2_RESERVED_MASK                                 0x00003c00
559*5113495bSYour Name 
560*5113495bSYour Name /* Description		TCL_DATA_CMD_2_ADDRX_EN
561*5113495bSYour Name 
562*5113495bSYour Name 			Address X search enable in ASE
563*5113495bSYour Name 
564*5113495bSYour Name 			1'b0: Search disable
565*5113495bSYour Name 
566*5113495bSYour Name 			1'b1: Search Enable
567*5113495bSYour Name 
568*5113495bSYour Name 			<legal all>
569*5113495bSYour Name */
570*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRX_EN_OFFSET                               0x00000008
571*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRX_EN_LSB                                  14
572*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRX_EN_MASK                                 0x00004000
573*5113495bSYour Name 
574*5113495bSYour Name /* Description		TCL_DATA_CMD_2_ADDRY_EN
575*5113495bSYour Name 
576*5113495bSYour Name 			Address Y search enable in ASE
577*5113495bSYour Name 
578*5113495bSYour Name 			1'b0: Search disable
579*5113495bSYour Name 
580*5113495bSYour Name 			1'b1: Search Enable
581*5113495bSYour Name 
582*5113495bSYour Name 			<legal all>
583*5113495bSYour Name */
584*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRY_EN_OFFSET                               0x00000008
585*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRY_EN_LSB                                  15
586*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRY_EN_MASK                                 0x00008000
587*5113495bSYour Name 
588*5113495bSYour Name /* Description		TCL_DATA_CMD_2_TCL_CMD_NUMBER
589*5113495bSYour Name 
590*5113495bSYour Name 			This number can be used by SW to track, identify and
591*5113495bSYour Name 			link the created commands with the command statuses
592*5113495bSYour Name 
593*5113495bSYour Name 
594*5113495bSYour Name 
595*5113495bSYour Name 			Is set to the value 'TCL_CMD_Number' of the related
596*5113495bSYour Name 			TCL_DATA command
597*5113495bSYour Name 
598*5113495bSYour Name 			<legal all>
599*5113495bSYour Name */
600*5113495bSYour Name #define TCL_DATA_CMD_2_TCL_CMD_NUMBER_OFFSET                         0x00000008
601*5113495bSYour Name #define TCL_DATA_CMD_2_TCL_CMD_NUMBER_LSB                            16
602*5113495bSYour Name #define TCL_DATA_CMD_2_TCL_CMD_NUMBER_MASK                           0xffff0000
603*5113495bSYour Name 
604*5113495bSYour Name /* Description		TCL_DATA_CMD_3_DATA_LENGTH
605*5113495bSYour Name 
606*5113495bSYour Name 			Valid Data length in bytes.
607*5113495bSYour Name 
608*5113495bSYour Name 
609*5113495bSYour Name 
610*5113495bSYour Name 			MSDU length in case of direct descriptor.
611*5113495bSYour Name 
612*5113495bSYour Name 			Length of link extension descriptor in case of Link
613*5113495bSYour Name 			extension descriptor. This is used to know the size of
614*5113495bSYour Name 			Metadata.
615*5113495bSYour Name 
616*5113495bSYour Name 			<legal all>
617*5113495bSYour Name */
618*5113495bSYour Name #define TCL_DATA_CMD_3_DATA_LENGTH_OFFSET                            0x0000000c
619*5113495bSYour Name #define TCL_DATA_CMD_3_DATA_LENGTH_LSB                               0
620*5113495bSYour Name #define TCL_DATA_CMD_3_DATA_LENGTH_MASK                              0x0000ffff
621*5113495bSYour Name 
622*5113495bSYour Name /* Description		TCL_DATA_CMD_3_IPV4_CHECKSUM_EN
623*5113495bSYour Name 
624*5113495bSYour Name 			Field only valid when msdu_buffer_type is set to
625*5113495bSYour Name 			MSDU_buffer.
626*5113495bSYour Name 
627*5113495bSYour Name 
628*5113495bSYour Name 
629*5113495bSYour Name 			OLE related control
630*5113495bSYour Name 
631*5113495bSYour Name 			Enable IPv4 checksum replacement
632*5113495bSYour Name */
633*5113495bSYour Name #define TCL_DATA_CMD_3_IPV4_CHECKSUM_EN_OFFSET                       0x0000000c
634*5113495bSYour Name #define TCL_DATA_CMD_3_IPV4_CHECKSUM_EN_LSB                          16
635*5113495bSYour Name #define TCL_DATA_CMD_3_IPV4_CHECKSUM_EN_MASK                         0x00010000
636*5113495bSYour Name 
637*5113495bSYour Name /* Description		TCL_DATA_CMD_3_UDP_OVER_IPV4_CHECKSUM_EN
638*5113495bSYour Name 
639*5113495bSYour Name 			Field only valid when msdu_buffer_type is set to
640*5113495bSYour Name 			MSDU_buffer.
641*5113495bSYour Name 
642*5113495bSYour Name 
643*5113495bSYour Name 
644*5113495bSYour Name 			OLE related control
645*5113495bSYour Name 
646*5113495bSYour Name 			Enable UDP over IPv4 checksum replacement.  UDP checksum
647*5113495bSYour Name 			over IPv4 is optional for TCP/IP stacks.
648*5113495bSYour Name */
649*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV4_CHECKSUM_EN_OFFSET              0x0000000c
650*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV4_CHECKSUM_EN_LSB                 17
651*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV4_CHECKSUM_EN_MASK                0x00020000
652*5113495bSYour Name 
653*5113495bSYour Name /* Description		TCL_DATA_CMD_3_UDP_OVER_IPV6_CHECKSUM_EN
654*5113495bSYour Name 
655*5113495bSYour Name 			Field only valid when msdu_buffer_type is set to
656*5113495bSYour Name 			MSDU_buffer.
657*5113495bSYour Name 
658*5113495bSYour Name 
659*5113495bSYour Name 
660*5113495bSYour Name 			OLE related control
661*5113495bSYour Name 
662*5113495bSYour Name 			Enable UDP over IPv6 checksum replacement.  UDP checksum
663*5113495bSYour Name 			over IPv6 is mandatory for TCP/IP stacks.
664*5113495bSYour Name */
665*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV6_CHECKSUM_EN_OFFSET              0x0000000c
666*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV6_CHECKSUM_EN_LSB                 18
667*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV6_CHECKSUM_EN_MASK                0x00040000
668*5113495bSYour Name 
669*5113495bSYour Name /* Description		TCL_DATA_CMD_3_TCP_OVER_IPV4_CHECKSUM_EN
670*5113495bSYour Name 
671*5113495bSYour Name 			Field only valid when msdu_buffer_type is set to
672*5113495bSYour Name 			MSDU_buffer.
673*5113495bSYour Name 
674*5113495bSYour Name 
675*5113495bSYour Name 
676*5113495bSYour Name 			OLE related control
677*5113495bSYour Name 
678*5113495bSYour Name 			Enable TCP checksum over IPv4 replacement
679*5113495bSYour Name */
680*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV4_CHECKSUM_EN_OFFSET              0x0000000c
681*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV4_CHECKSUM_EN_LSB                 19
682*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV4_CHECKSUM_EN_MASK                0x00080000
683*5113495bSYour Name 
684*5113495bSYour Name /* Description		TCL_DATA_CMD_3_TCP_OVER_IPV6_CHECKSUM_EN
685*5113495bSYour Name 
686*5113495bSYour Name 			Field only valid when msdu_buffer_type is set to
687*5113495bSYour Name 			MSDU_buffer.
688*5113495bSYour Name 
689*5113495bSYour Name 
690*5113495bSYour Name 
691*5113495bSYour Name 			OLE related control
692*5113495bSYour Name 
693*5113495bSYour Name 			Enable TCP checksum over IPv6 replacement
694*5113495bSYour Name */
695*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV6_CHECKSUM_EN_OFFSET              0x0000000c
696*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV6_CHECKSUM_EN_LSB                 20
697*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV6_CHECKSUM_EN_MASK                0x00100000
698*5113495bSYour Name 
699*5113495bSYour Name /* Description		TCL_DATA_CMD_3_TO_FW
700*5113495bSYour Name 
701*5113495bSYour Name 			Forward packet to FW along with classification result.
702*5113495bSYour Name 			The packet will not be forward to TQM when this bit is set
703*5113495bSYour Name 
704*5113495bSYour Name 			1'b0: Use classification result to forward the packet.
705*5113495bSYour Name 
706*5113495bSYour Name 			1'b1: Override classification result and forward packet
707*5113495bSYour Name 			only to FW.
708*5113495bSYour Name */
709*5113495bSYour Name #define TCL_DATA_CMD_3_TO_FW_OFFSET                                  0x0000000c
710*5113495bSYour Name #define TCL_DATA_CMD_3_TO_FW_LSB                                     21
711*5113495bSYour Name #define TCL_DATA_CMD_3_TO_FW_MASK                                    0x00200000
712*5113495bSYour Name 
713*5113495bSYour Name /* Description		TCL_DATA_CMD_3_DSCP_TO_TID_PRIORITY_TABLE_ID
714*5113495bSYour Name 
715*5113495bSYour Name 			The DSCP to tid conversion table to be used for this
716*5113495bSYour Name 			frame
717*5113495bSYour Name 
718*5113495bSYour Name 			<legal all>
719*5113495bSYour Name */
720*5113495bSYour Name #define TCL_DATA_CMD_3_DSCP_TO_TID_PRIORITY_TABLE_ID_OFFSET          0x0000000c
721*5113495bSYour Name #define TCL_DATA_CMD_3_DSCP_TO_TID_PRIORITY_TABLE_ID_LSB             22
722*5113495bSYour Name #define TCL_DATA_CMD_3_DSCP_TO_TID_PRIORITY_TABLE_ID_MASK            0x00400000
723*5113495bSYour Name 
724*5113495bSYour Name /* Description		TCL_DATA_CMD_3_PACKET_OFFSET
725*5113495bSYour Name 
726*5113495bSYour Name 			Packet offset from Metadata in case of direct buffer
727*5113495bSYour Name 			descriptor. This field is valid when Buf_or_ext_desc_type is
728*5113495bSYour Name 			reset(= 0).
729*5113495bSYour Name 
730*5113495bSYour Name 			<legal all>
731*5113495bSYour Name */
732*5113495bSYour Name #define TCL_DATA_CMD_3_PACKET_OFFSET_OFFSET                          0x0000000c
733*5113495bSYour Name #define TCL_DATA_CMD_3_PACKET_OFFSET_LSB                             23
734*5113495bSYour Name #define TCL_DATA_CMD_3_PACKET_OFFSET_MASK                            0xff800000
735*5113495bSYour Name 
736*5113495bSYour Name /* Description		TCL_DATA_CMD_4_BUFFER_TIMESTAMP
737*5113495bSYour Name 
738*5113495bSYour Name 			Field only valid when 'Buffer_timestamp_valid ' is set.
739*5113495bSYour Name 
740*5113495bSYour Name 
741*5113495bSYour Name 
742*5113495bSYour Name 			Frame system entrance timestamp. The timestamp is
743*5113495bSYour Name 			related to the global system timer
744*5113495bSYour Name 
745*5113495bSYour Name 
746*5113495bSYour Name 
747*5113495bSYour Name 			Generally the first module (SW, TCL or TQM). that sees
748*5113495bSYour Name 			this frame and this timestamp field is not valid, shall fill
749*5113495bSYour Name 			in this field.
750*5113495bSYour Name 
751*5113495bSYour Name 
752*5113495bSYour Name 
753*5113495bSYour Name 			Timestamp in units of 1024 us
754*5113495bSYour Name */
755*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_OFFSET                       0x00000010
756*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_LSB                          0
757*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_MASK                         0x0007ffff
758*5113495bSYour Name 
759*5113495bSYour Name /* Description		TCL_DATA_CMD_4_BUFFER_TIMESTAMP_VALID
760*5113495bSYour Name 
761*5113495bSYour Name 			When set, the Buffer_timestamp field contains valid
762*5113495bSYour Name 			info.
763*5113495bSYour Name */
764*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_VALID_OFFSET                 0x00000010
765*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_VALID_LSB                    19
766*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_VALID_MASK                   0x00080000
767*5113495bSYour Name 
768*5113495bSYour Name /* Description		TCL_DATA_CMD_4_MESH_ENABLE
769*5113495bSYour Name 
770*5113495bSYour Name 			If set to 1:
771*5113495bSYour Name 
772*5113495bSYour Name 			* For raw WiFi frames, this indicates transmission to a
773*5113495bSYour Name 			mesh STA, enabling the interpretation of the 'Mesh Control
774*5113495bSYour Name 			Present' bit (bit 8) of QoS Control (otherwise this bit is
775*5113495bSYour Name 			ignored),
776*5113495bSYour Name 
777*5113495bSYour Name 			* For native WiFi frames, this indicates that a 'Mesh
778*5113495bSYour Name 			Control' field is present between the header and the LLC.
779*5113495bSYour Name */
780*5113495bSYour Name #define TCL_DATA_CMD_4_MESH_ENABLE_OFFSET                            0x00000010
781*5113495bSYour Name #define TCL_DATA_CMD_4_MESH_ENABLE_LSB                               20
782*5113495bSYour Name #define TCL_DATA_CMD_4_MESH_ENABLE_MASK                              0x00100000
783*5113495bSYour Name 
784*5113495bSYour Name /* Description		TCL_DATA_CMD_4_HLOS_TID_OVERWRITE
785*5113495bSYour Name 
786*5113495bSYour Name 			When set, TCL shall ignore the IP DSCP and VLAN PCP
787*5113495bSYour Name 			fields and use HLOS_TID as the final TID. Otherwise TCL
788*5113495bSYour Name 			shall consider the DSCP and PCP fields as well as HLOS_TID
789*5113495bSYour Name 			and choose a final TID based on the configured priority
790*5113495bSYour Name 
791*5113495bSYour Name 			<legal all>
792*5113495bSYour Name */
793*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_OVERWRITE_OFFSET                     0x00000010
794*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_OVERWRITE_LSB                        21
795*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_OVERWRITE_MASK                       0x00200000
796*5113495bSYour Name 
797*5113495bSYour Name /* Description		TCL_DATA_CMD_4_HLOS_TID
798*5113495bSYour Name 
799*5113495bSYour Name 			HLOS MSDU priority
800*5113495bSYour Name 
801*5113495bSYour Name 
802*5113495bSYour Name 
803*5113495bSYour Name 			Field is used when HLOS_TID_overwrite is set.
804*5113495bSYour Name 
805*5113495bSYour Name 
806*5113495bSYour Name 
807*5113495bSYour Name 			Field is also used when HLOS_TID_overwrite is not set
808*5113495bSYour Name 			and DSCP/PCP is not available in the packet
809*5113495bSYour Name 
810*5113495bSYour Name 			<legal all>
811*5113495bSYour Name */
812*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_OFFSET                               0x00000010
813*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_LSB                                  22
814*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_MASK                                 0x03c00000
815*5113495bSYour Name 
816*5113495bSYour Name /* Description		TCL_DATA_CMD_4_RESERVED_4
817*5113495bSYour Name 
818*5113495bSYour Name 			<legal 0>
819*5113495bSYour Name */
820*5113495bSYour Name #define TCL_DATA_CMD_4_RESERVED_4_OFFSET                             0x00000010
821*5113495bSYour Name #define TCL_DATA_CMD_4_RESERVED_4_LSB                                26
822*5113495bSYour Name #define TCL_DATA_CMD_4_RESERVED_4_MASK                               0xfc000000
823*5113495bSYour Name 
824*5113495bSYour Name /* Description		TCL_DATA_CMD_5_RESERVED_5
825*5113495bSYour Name 
826*5113495bSYour Name 			<legal 0>
827*5113495bSYour Name */
828*5113495bSYour Name #define TCL_DATA_CMD_5_RESERVED_5_OFFSET                             0x00000014
829*5113495bSYour Name #define TCL_DATA_CMD_5_RESERVED_5_LSB                                0
830*5113495bSYour Name #define TCL_DATA_CMD_5_RESERVED_5_MASK                               0xffffffff
831*5113495bSYour Name 
832*5113495bSYour Name /* Description		TCL_DATA_CMD_6_RESERVED_6A
833*5113495bSYour Name 
834*5113495bSYour Name 			<legal 0>
835*5113495bSYour Name */
836*5113495bSYour Name #define TCL_DATA_CMD_6_RESERVED_6A_OFFSET                            0x00000018
837*5113495bSYour Name #define TCL_DATA_CMD_6_RESERVED_6A_LSB                               0
838*5113495bSYour Name #define TCL_DATA_CMD_6_RESERVED_6A_MASK                              0x000fffff
839*5113495bSYour Name 
840*5113495bSYour Name /* Description		TCL_DATA_CMD_6_RING_ID
841*5113495bSYour Name 
842*5113495bSYour Name 			The buffer pointer ring ID.
843*5113495bSYour Name 
844*5113495bSYour Name 			0 refers to the IDLE ring
845*5113495bSYour Name 
846*5113495bSYour Name 			1 - N refers to other rings
847*5113495bSYour Name 
848*5113495bSYour Name 
849*5113495bSYour Name 
850*5113495bSYour Name 			Helps with debugging when dumping ring contents.
851*5113495bSYour Name 
852*5113495bSYour Name 			<legal all>
853*5113495bSYour Name */
854*5113495bSYour Name #define TCL_DATA_CMD_6_RING_ID_OFFSET                                0x00000018
855*5113495bSYour Name #define TCL_DATA_CMD_6_RING_ID_LSB                                   20
856*5113495bSYour Name #define TCL_DATA_CMD_6_RING_ID_MASK                                  0x0ff00000
857*5113495bSYour Name 
858*5113495bSYour Name /* Description		TCL_DATA_CMD_6_LOOPING_COUNT
859*5113495bSYour Name 
860*5113495bSYour Name 			A count value that indicates the number of times the
861*5113495bSYour Name 			producer of entries into the Ring has looped around the
862*5113495bSYour Name 			ring.
863*5113495bSYour Name 
864*5113495bSYour Name 			At initialization time, this value is set to 0. On the
865*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
866*5113495bSYour Name 			reached allowed by the number of bits for this field, the
867*5113495bSYour Name 			count value continues with 0 again.
868*5113495bSYour Name 
869*5113495bSYour Name 
870*5113495bSYour Name 
871*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
872*5113495bSYour Name 			use this field to figure out up to where the producer of
873*5113495bSYour Name 			entries has created new entries. This eliminates the need to
874*5113495bSYour Name 			check where the head pointer' of the ring is located once
875*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
876*5113495bSYour Name 			entries have been put into this ring...
877*5113495bSYour Name 
878*5113495bSYour Name 
879*5113495bSYour Name 
880*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
881*5113495bSYour Name 			LSB bit of this count value.
882*5113495bSYour Name 
883*5113495bSYour Name 			<legal all>
884*5113495bSYour Name */
885*5113495bSYour Name #define TCL_DATA_CMD_6_LOOPING_COUNT_OFFSET                          0x00000018
886*5113495bSYour Name #define TCL_DATA_CMD_6_LOOPING_COUNT_LSB                             28
887*5113495bSYour Name #define TCL_DATA_CMD_6_LOOPING_COUNT_MASK                            0xf0000000
888*5113495bSYour Name 
889*5113495bSYour Name 
890*5113495bSYour Name #endif // _TCL_DATA_CMD_H_
891