xref: /wlan-driver/fw-api/hw/qca6290/11ax/v1/tcl_data_cmd.h (revision 5113495b16420b49004c444715d2daae2066e7dc) 
1*5113495bSYour Name /*
2*5113495bSYour Name  * Copyright (c) 2016-2017 The Linux Foundation. All rights reserved.
3*5113495bSYour Name  *
4*5113495bSYour Name  * Permission to use, copy, modify, and/or distribute this software for
5*5113495bSYour Name  * any purpose with or without fee is hereby granted, provided that the
6*5113495bSYour Name  * above copyright notice and this permission notice appear in all
7*5113495bSYour Name  * copies.
8*5113495bSYour Name  *
9*5113495bSYour Name  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
10*5113495bSYour Name  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
11*5113495bSYour Name  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
12*5113495bSYour Name  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
13*5113495bSYour Name  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
14*5113495bSYour Name  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
15*5113495bSYour Name  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
16*5113495bSYour Name  * PERFORMANCE OF THIS SOFTWARE.
17*5113495bSYour Name  */
18*5113495bSYour Name 
19*5113495bSYour Name #ifndef _TCL_DATA_CMD_H_
20*5113495bSYour Name #define _TCL_DATA_CMD_H_
21*5113495bSYour Name #if !defined(__ASSEMBLER__)
22*5113495bSYour Name #endif
23*5113495bSYour Name 
24*5113495bSYour Name #include "buffer_addr_info.h"
25*5113495bSYour Name 
26*5113495bSYour Name // ################ START SUMMARY #################
27*5113495bSYour Name //
28*5113495bSYour Name //	Dword	Fields
29*5113495bSYour Name //	0-1	struct buffer_addr_info buf_addr_info;
30*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_2a[11:10], search_type[13:12], addrx_en[14], addry_en[15], tcl_cmd_number[31:16]
31*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]
32*5113495bSYour Name //	4	buffer_timestamp[18:0], buffer_timestamp_valid[19], mesh_enable[20], hlos_tid_overwrite[21], hlos_tid[25:22], lmac_id[27:26], reserved_4[31:28]
33*5113495bSYour Name //	5	dscp_tid_table_num[5:0], search_index[25:6], cache_set_num[29:26], reserved_5[31:30]
34*5113495bSYour Name //	6	reserved_6a[19:0], ring_id[27:20], looping_count[31:28]
35*5113495bSYour Name //
36*5113495bSYour Name // ################ END SUMMARY #################
37*5113495bSYour Name 
38*5113495bSYour Name #define NUM_OF_DWORDS_TCL_DATA_CMD 7
39*5113495bSYour Name 
40*5113495bSYour Name struct tcl_data_cmd {
41*5113495bSYour Name     struct            buffer_addr_info                       buf_addr_info;
42*5113495bSYour Name              uint32_t buf_or_ext_desc_type            :  1, //[0]
43*5113495bSYour Name                       epd                             :  1, //[1]
44*5113495bSYour Name                       encap_type                      :  2, //[3:2]
45*5113495bSYour Name                       encrypt_type                    :  4, //[7:4]
46*5113495bSYour Name                       src_buffer_swap                 :  1, //[8]
47*5113495bSYour Name                       link_meta_swap                  :  1, //[9]
48*5113495bSYour Name                       reserved_2a                     :  2, //[11:10]
49*5113495bSYour Name                       search_type                     :  2, //[13:12]
50*5113495bSYour Name                       addrx_en                        :  1, //[14]
51*5113495bSYour Name                       addry_en                        :  1, //[15]
52*5113495bSYour Name                       tcl_cmd_number                  : 16; //[31:16]
53*5113495bSYour Name              uint32_t data_length                     : 16, //[15:0]
54*5113495bSYour Name                       ipv4_checksum_en                :  1, //[16]
55*5113495bSYour Name                       udp_over_ipv4_checksum_en       :  1, //[17]
56*5113495bSYour Name                       udp_over_ipv6_checksum_en       :  1, //[18]
57*5113495bSYour Name                       tcp_over_ipv4_checksum_en       :  1, //[19]
58*5113495bSYour Name                       tcp_over_ipv6_checksum_en       :  1, //[20]
59*5113495bSYour Name                       to_fw                           :  1, //[21]
60*5113495bSYour Name                       reserved_3a                     :  1, //[22]
61*5113495bSYour Name                       packet_offset                   :  9; //[31:23]
62*5113495bSYour Name              uint32_t buffer_timestamp                : 19, //[18:0]
63*5113495bSYour Name                       buffer_timestamp_valid          :  1, //[19]
64*5113495bSYour Name                       mesh_enable                     :  1, //[20]
65*5113495bSYour Name                       hlos_tid_overwrite              :  1, //[21]
66*5113495bSYour Name                       hlos_tid                        :  4, //[25:22]
67*5113495bSYour Name                       lmac_id                         :  2, //[27:26]
68*5113495bSYour Name                       reserved_4                      :  4; //[31:28]
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                       reserved_5                      :  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 reserved_2a
194*5113495bSYour Name 
195*5113495bSYour Name 			<legal 0>
196*5113495bSYour Name 
197*5113495bSYour Name search_type
198*5113495bSYour Name 
199*5113495bSYour Name 			Search type select
200*5113495bSYour Name 
201*5113495bSYour Name 
202*5113495bSYour Name 
203*5113495bSYour Name 			<enum 0 Normal_search> Address and flow search will use
204*5113495bSYour Name 			packet contents
205*5113495bSYour Name 
206*5113495bSYour Name 			<enum 1 Index_based_address_search> Address search will
207*5113495bSYour Name 
208*5113495bSYour Name 			<enum 2 Index_based_flow_search> Flow search will use
209*5113495bSYour Name 			'search_index', and address search will use packet contents
210*5113495bSYour Name 
211*5113495bSYour Name 			<legal 0-2>
212*5113495bSYour Name 
213*5113495bSYour Name addrx_en
214*5113495bSYour Name 
215*5113495bSYour Name 			Address X search enable in ASE
216*5113495bSYour Name 
217*5113495bSYour Name 			1'b0: Search disable
218*5113495bSYour Name 
219*5113495bSYour Name 			1'b1: Search Enable
220*5113495bSYour Name 
221*5113495bSYour Name 			<legal all>
222*5113495bSYour Name 
223*5113495bSYour Name addry_en
224*5113495bSYour Name 
225*5113495bSYour Name 			Address Y 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 tcl_cmd_number
234*5113495bSYour Name 
235*5113495bSYour Name 			This number can be used by SW to track, identify and
236*5113495bSYour Name 			link the created commands with the command statuses
237*5113495bSYour Name 
238*5113495bSYour Name 
239*5113495bSYour Name 
240*5113495bSYour Name 			Is set to the value 'TCL_CMD_Number' of the related
241*5113495bSYour Name 			TCL_DATA command
242*5113495bSYour Name 
243*5113495bSYour Name 			<legal all>
244*5113495bSYour Name 
245*5113495bSYour Name data_length
246*5113495bSYour Name 
247*5113495bSYour Name 			Valid Data length in bytes.
248*5113495bSYour Name 
249*5113495bSYour Name 
250*5113495bSYour Name 
251*5113495bSYour Name 			MSDU length in case of direct descriptor.
252*5113495bSYour Name 
253*5113495bSYour Name 			Length of link extension descriptor in case of Link
254*5113495bSYour Name 			extension descriptor. This is used to know the size of
255*5113495bSYour Name 			Metadata.
256*5113495bSYour Name 
257*5113495bSYour Name 			<legal all>
258*5113495bSYour Name 
259*5113495bSYour Name ipv4_checksum_en
260*5113495bSYour Name 
261*5113495bSYour Name 			OLE related control
262*5113495bSYour Name 
263*5113495bSYour Name 			Enable IPv4 checksum replacement
264*5113495bSYour Name 
265*5113495bSYour Name udp_over_ipv4_checksum_en
266*5113495bSYour Name 
267*5113495bSYour Name 			OLE related control
268*5113495bSYour Name 
269*5113495bSYour Name 			Enable UDP over IPv4 checksum replacement.  UDP checksum
270*5113495bSYour Name 			over IPv4 is optional for TCP/IP stacks.
271*5113495bSYour Name 
272*5113495bSYour Name udp_over_ipv6_checksum_en
273*5113495bSYour Name 
274*5113495bSYour Name 			OLE related control
275*5113495bSYour Name 
276*5113495bSYour Name 			Enable UDP over IPv6 checksum replacement.  UDP checksum
277*5113495bSYour Name 			over IPv6 is mandatory for TCP/IP stacks.
278*5113495bSYour Name 
279*5113495bSYour Name tcp_over_ipv4_checksum_en
280*5113495bSYour Name 
281*5113495bSYour Name 			OLE related control
282*5113495bSYour Name 
283*5113495bSYour Name 			Enable TCP checksum over IPv4 replacement
284*5113495bSYour Name 
285*5113495bSYour Name tcp_over_ipv6_checksum_en
286*5113495bSYour Name 
287*5113495bSYour Name 			OLE related control
288*5113495bSYour Name 
289*5113495bSYour Name 			Enable TCP checksum over IPv6 replacement
290*5113495bSYour Name 
291*5113495bSYour Name to_fw
292*5113495bSYour Name 
293*5113495bSYour Name 			Forward packet to FW along with classification result.
294*5113495bSYour Name 			The packet will not be forward to TQM when this bit is set
295*5113495bSYour Name 
296*5113495bSYour Name 
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 			<legal all>
304*5113495bSYour Name 
305*5113495bSYour Name reserved_3a
306*5113495bSYour Name 
307*5113495bSYour Name 			<legal 0>
308*5113495bSYour Name 
309*5113495bSYour Name packet_offset
310*5113495bSYour Name 
311*5113495bSYour Name 			Packet offset from Metadata in case of direct buffer
312*5113495bSYour Name 			descriptor. This field is valid when Buf_or_ext_desc_type is
313*5113495bSYour Name 			reset(= 0).
314*5113495bSYour Name 
315*5113495bSYour Name 			<legal all>
316*5113495bSYour Name 
317*5113495bSYour Name buffer_timestamp
318*5113495bSYour Name 
319*5113495bSYour Name 			Field only valid when 'Buffer_timestamp_valid ' is set.
320*5113495bSYour Name 
321*5113495bSYour Name 
322*5113495bSYour Name 
323*5113495bSYour Name 			Frame system entrance timestamp. The timestamp is
324*5113495bSYour Name 			related to the global system timer
325*5113495bSYour Name 
326*5113495bSYour Name 
327*5113495bSYour Name 
328*5113495bSYour Name 			Generally the first module (SW, TCL or TQM). that sees
329*5113495bSYour Name 			this frame and this timestamp field is not valid, shall fill
330*5113495bSYour Name 			in this field.
331*5113495bSYour Name 
332*5113495bSYour Name 
333*5113495bSYour Name 
334*5113495bSYour Name 			Timestamp in units of 1024 us
335*5113495bSYour Name 
336*5113495bSYour Name buffer_timestamp_valid
337*5113495bSYour Name 
338*5113495bSYour Name 			When set, the Buffer_timestamp field contains valid
339*5113495bSYour Name 			info.
340*5113495bSYour Name 
341*5113495bSYour Name mesh_enable
342*5113495bSYour Name 
343*5113495bSYour Name 			If set to 1:
344*5113495bSYour Name 
345*5113495bSYour Name 			* For raw WiFi frames, this indicates transmission to a
346*5113495bSYour Name 			mesh STA, enabling the interpretation of the 'Mesh Control
347*5113495bSYour Name 			Present' bit (bit 8) of QoS Control (otherwise this bit is
348*5113495bSYour Name 			ignored),
349*5113495bSYour Name 
350*5113495bSYour Name 			* For native WiFi frames, this indicates that a 'Mesh
351*5113495bSYour Name 			Control' field is present between the header and the LLC.
352*5113495bSYour Name 
353*5113495bSYour Name hlos_tid_overwrite
354*5113495bSYour Name 
355*5113495bSYour Name 			When set, TCL shall ignore the IP DSCP and VLAN PCP
356*5113495bSYour Name 			fields and use HLOS_TID as the final TID. Otherwise TCL
357*5113495bSYour Name 			shall consider the DSCP and PCP fields as well as HLOS_TID
358*5113495bSYour Name 			and choose a final TID based on the configured priority
359*5113495bSYour Name 
360*5113495bSYour Name 			<legal all>
361*5113495bSYour Name 
362*5113495bSYour Name hlos_tid
363*5113495bSYour Name 
364*5113495bSYour Name 			HLOS MSDU priority
365*5113495bSYour Name 
366*5113495bSYour Name 
367*5113495bSYour Name 
368*5113495bSYour Name 			Field is used when HLOS_TID_overwrite is set.
369*5113495bSYour Name 
370*5113495bSYour Name 
371*5113495bSYour Name 
372*5113495bSYour Name 			Field is also used when HLOS_TID_overwrite is not set
373*5113495bSYour Name 			and DSCP/PCP is not available in the packet
374*5113495bSYour Name 
375*5113495bSYour Name 			<legal all>
376*5113495bSYour Name 
377*5113495bSYour Name lmac_id
378*5113495bSYour Name 
379*5113495bSYour Name 			TCL uses this LMAC_ID in address search, i.e, while
380*5113495bSYour Name 			finding matching entry for the packet in AST corresponding
381*5113495bSYour Name 			to given LMAC_ID
382*5113495bSYour Name 
383*5113495bSYour Name 			If LMAC ID is all 1s (=> value 3), it indicates wildcard
384*5113495bSYour Name 			match for any MAC
385*5113495bSYour Name 
386*5113495bSYour Name 			<legal 0-3>
387*5113495bSYour Name 
388*5113495bSYour Name reserved_4
389*5113495bSYour Name 
390*5113495bSYour Name 			<legal 0>
391*5113495bSYour Name 
392*5113495bSYour Name dscp_tid_table_num
393*5113495bSYour Name 
394*5113495bSYour Name 			DSCP to TID mapping table number that need to be used
395*5113495bSYour Name 			for the MSDU, should be specified using this field
396*5113495bSYour Name 
397*5113495bSYour Name 			<legal all>
398*5113495bSYour Name 
399*5113495bSYour Name search_index
400*5113495bSYour Name 
401*5113495bSYour Name 			The index that will be used for index based address or
402*5113495bSYour Name 			flow search. The field is valid when 'search_type' is  1 or
403*5113495bSYour Name 			2.
404*5113495bSYour Name 
405*5113495bSYour Name 			<legal all>
406*5113495bSYour Name 
407*5113495bSYour Name cache_set_num
408*5113495bSYour Name 
409*5113495bSYour Name 			Cache set number that should be used to cache the index
410*5113495bSYour Name 			based search results, for address and flow search. This
411*5113495bSYour Name 			value should be equal to LSB four bits of the hash value of
412*5113495bSYour Name 			match data, in case of search index points to an entry which
413*5113495bSYour Name 			may be used in content based search also. The value can be
414*5113495bSYour Name 			anything when the entry pointed by search index will not be
415*5113495bSYour Name 			used for content based search.
416*5113495bSYour Name 
417*5113495bSYour Name 			<legal all>
418*5113495bSYour Name 
419*5113495bSYour Name reserved_5
420*5113495bSYour Name 
421*5113495bSYour Name 			<legal 0>
422*5113495bSYour Name 
423*5113495bSYour Name reserved_6a
424*5113495bSYour Name 
425*5113495bSYour Name 			<legal 0>
426*5113495bSYour Name 
427*5113495bSYour Name ring_id
428*5113495bSYour Name 
429*5113495bSYour Name 			The buffer pointer ring ID.
430*5113495bSYour Name 
431*5113495bSYour Name 			0 refers to the IDLE ring
432*5113495bSYour Name 
433*5113495bSYour Name 			1 - N refers to other rings
434*5113495bSYour Name 
435*5113495bSYour Name 
436*5113495bSYour Name 
437*5113495bSYour Name 			Helps with debugging when dumping ring contents.
438*5113495bSYour Name 
439*5113495bSYour Name 			<legal all>
440*5113495bSYour Name 
441*5113495bSYour Name looping_count
442*5113495bSYour Name 
443*5113495bSYour Name 			A count value that indicates the number of times the
444*5113495bSYour Name 			producer of entries into the Ring has looped around the
445*5113495bSYour Name 			ring.
446*5113495bSYour Name 
447*5113495bSYour Name 			At initialization time, this value is set to 0. On the
448*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
449*5113495bSYour Name 			reached allowed by the number of bits for this field, the
450*5113495bSYour Name 			count value continues with 0 again.
451*5113495bSYour Name 
452*5113495bSYour Name 
453*5113495bSYour Name 
454*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
455*5113495bSYour Name 			use this field to figure out up to where the producer of
456*5113495bSYour Name 			entries has created new entries. This eliminates the need to
457*5113495bSYour Name 			check where the head pointer' of the ring is located once
458*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
459*5113495bSYour Name 			entries have been put into this ring...
460*5113495bSYour Name 
461*5113495bSYour Name 
462*5113495bSYour Name 
463*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
464*5113495bSYour Name 			LSB bit of this count value.
465*5113495bSYour Name 
466*5113495bSYour Name 			<legal all>
467*5113495bSYour Name */
468*5113495bSYour Name 
469*5113495bSYour Name #define TCL_DATA_CMD_0_BUFFER_ADDR_INFO_BUF_ADDR_INFO_OFFSET         0x00000000
470*5113495bSYour Name #define TCL_DATA_CMD_0_BUFFER_ADDR_INFO_BUF_ADDR_INFO_LSB            28
471*5113495bSYour Name #define TCL_DATA_CMD_0_BUFFER_ADDR_INFO_BUF_ADDR_INFO_MASK           0xffffffff
472*5113495bSYour Name #define TCL_DATA_CMD_1_BUFFER_ADDR_INFO_BUF_ADDR_INFO_OFFSET         0x00000004
473*5113495bSYour Name #define TCL_DATA_CMD_1_BUFFER_ADDR_INFO_BUF_ADDR_INFO_LSB            28
474*5113495bSYour Name #define TCL_DATA_CMD_1_BUFFER_ADDR_INFO_BUF_ADDR_INFO_MASK           0xffffffff
475*5113495bSYour Name 
476*5113495bSYour Name /* Description		TCL_DATA_CMD_2_BUF_OR_EXT_DESC_TYPE
477*5113495bSYour Name 
478*5113495bSYour Name 			<enum 0 MSDU_buffer> The address points to an MSDU
479*5113495bSYour Name 			buffer.
480*5113495bSYour Name 
481*5113495bSYour Name 			<enum 1 extension_descriptor> The address points to an
482*5113495bSYour Name 			MSDU link extension descriptor
483*5113495bSYour Name 
484*5113495bSYour Name 			< legal all>
485*5113495bSYour Name */
486*5113495bSYour Name #define TCL_DATA_CMD_2_BUF_OR_EXT_DESC_TYPE_OFFSET                   0x00000008
487*5113495bSYour Name #define TCL_DATA_CMD_2_BUF_OR_EXT_DESC_TYPE_LSB                      0
488*5113495bSYour Name #define TCL_DATA_CMD_2_BUF_OR_EXT_DESC_TYPE_MASK                     0x00000001
489*5113495bSYour Name 
490*5113495bSYour Name /* Description		TCL_DATA_CMD_2_EPD
491*5113495bSYour Name 
492*5113495bSYour Name 			When this bit is set then input packet is an EPD type
493*5113495bSYour Name 
494*5113495bSYour Name 			<legal all>
495*5113495bSYour Name */
496*5113495bSYour Name #define TCL_DATA_CMD_2_EPD_OFFSET                                    0x00000008
497*5113495bSYour Name #define TCL_DATA_CMD_2_EPD_LSB                                       1
498*5113495bSYour Name #define TCL_DATA_CMD_2_EPD_MASK                                      0x00000002
499*5113495bSYour Name 
500*5113495bSYour Name /* Description		TCL_DATA_CMD_2_ENCAP_TYPE
501*5113495bSYour Name 
502*5113495bSYour Name 			Indicates the encapsulation that HW will perform:
503*5113495bSYour Name 
504*5113495bSYour Name 			<enum 0 RAW> No encapsulation
505*5113495bSYour Name 
506*5113495bSYour Name 			<enum 1 Native_WiFi>
507*5113495bSYour Name 
508*5113495bSYour Name 			<enum 2 Ethernet> Ethernet 2 (DIX)  or 802.3 (uses
509*5113495bSYour Name 			SNAP/LLC)
510*5113495bSYour Name 
511*5113495bSYour Name 			<enum 3 802_3> DO NOT USE. Indicate Ethernet
512*5113495bSYour Name 
513*5113495bSYour Name 
514*5113495bSYour Name 
515*5113495bSYour Name 			Used by the OLE during encapsulation.
516*5113495bSYour Name 
517*5113495bSYour Name 			<legal all>
518*5113495bSYour Name */
519*5113495bSYour Name #define TCL_DATA_CMD_2_ENCAP_TYPE_OFFSET                             0x00000008
520*5113495bSYour Name #define TCL_DATA_CMD_2_ENCAP_TYPE_LSB                                2
521*5113495bSYour Name #define TCL_DATA_CMD_2_ENCAP_TYPE_MASK                               0x0000000c
522*5113495bSYour Name 
523*5113495bSYour Name /* Description		TCL_DATA_CMD_2_ENCRYPT_TYPE
524*5113495bSYour Name 
525*5113495bSYour Name 			Field only valid for encap_type: RAW
526*5113495bSYour Name 
527*5113495bSYour Name 
528*5113495bSYour Name 
529*5113495bSYour Name 			Indicates type of decrypt cipher used (as defined in the
530*5113495bSYour Name 			peer entry)
531*5113495bSYour Name 
532*5113495bSYour Name 			<enum 0 wep_40> WEP 40-bit
533*5113495bSYour Name 
534*5113495bSYour Name 			<enum 1 wep_104> WEP 104-bit
535*5113495bSYour Name 
536*5113495bSYour Name 			<enum 2 tkip_no_mic> TKIP without MIC
537*5113495bSYour Name 
538*5113495bSYour Name 			<enum 3 wep_128> WEP 128-bit
539*5113495bSYour Name 
540*5113495bSYour Name 			<enum 4 tkip_with_mic> TKIP with MIC
541*5113495bSYour Name 
542*5113495bSYour Name 			<enum 5 wapi> WAPI
543*5113495bSYour Name 
544*5113495bSYour Name 			<enum 6 aes_ccmp_128> AES CCMP 128
545*5113495bSYour Name 
546*5113495bSYour Name 			<enum 7 no_cipher> No crypto
547*5113495bSYour Name 
548*5113495bSYour Name 			<enum 8 aes_ccmp_256> AES CCMP 256
549*5113495bSYour Name 
550*5113495bSYour Name 			<enum 9 aes_gcmp_128> AES CCMP 128
551*5113495bSYour Name 
552*5113495bSYour Name 			<enum 10 aes_gcmp_256> AES CCMP 256
553*5113495bSYour Name 
554*5113495bSYour Name 			<enum 11 wapi_gcm_sm4> WAPI GCM SM4
555*5113495bSYour Name 
556*5113495bSYour Name 
557*5113495bSYour Name 
558*5113495bSYour Name 			<enum 12 wep_varied_width> DO not use... Only for higher
559*5113495bSYour Name 			layer modules..
560*5113495bSYour Name 
561*5113495bSYour Name 			<legal 0-12>
562*5113495bSYour Name */
563*5113495bSYour Name #define TCL_DATA_CMD_2_ENCRYPT_TYPE_OFFSET                           0x00000008
564*5113495bSYour Name #define TCL_DATA_CMD_2_ENCRYPT_TYPE_LSB                              4
565*5113495bSYour Name #define TCL_DATA_CMD_2_ENCRYPT_TYPE_MASK                             0x000000f0
566*5113495bSYour Name 
567*5113495bSYour Name /* Description		TCL_DATA_CMD_2_SRC_BUFFER_SWAP
568*5113495bSYour Name 
569*5113495bSYour Name 			Treats source memory (packet buffer) organization as
570*5113495bSYour Name 			big-endian. The packets are read and byte swapped.
571*5113495bSYour Name 
572*5113495bSYour Name 			1'b0: Source memory is little endian
573*5113495bSYour Name 
574*5113495bSYour Name 			1'b1: Source memory is big endian
575*5113495bSYour Name 
576*5113495bSYour Name 			<legal all>
577*5113495bSYour Name */
578*5113495bSYour Name #define TCL_DATA_CMD_2_SRC_BUFFER_SWAP_OFFSET                        0x00000008
579*5113495bSYour Name #define TCL_DATA_CMD_2_SRC_BUFFER_SWAP_LSB                           8
580*5113495bSYour Name #define TCL_DATA_CMD_2_SRC_BUFFER_SWAP_MASK                          0x00000100
581*5113495bSYour Name 
582*5113495bSYour Name /* Description		TCL_DATA_CMD_2_LINK_META_SWAP
583*5113495bSYour Name 
584*5113495bSYour Name 			Treats link descriptor and Metadata as big-endian. The
585*5113495bSYour Name 			link descriptor/Metadata is read and byte swapped.
586*5113495bSYour Name 
587*5113495bSYour Name 			1'b0: Memory is little endian
588*5113495bSYour Name 
589*5113495bSYour Name 			1'b1: Memory is big endian
590*5113495bSYour Name 
591*5113495bSYour Name 			<legal all>
592*5113495bSYour Name */
593*5113495bSYour Name #define TCL_DATA_CMD_2_LINK_META_SWAP_OFFSET                         0x00000008
594*5113495bSYour Name #define TCL_DATA_CMD_2_LINK_META_SWAP_LSB                            9
595*5113495bSYour Name #define TCL_DATA_CMD_2_LINK_META_SWAP_MASK                           0x00000200
596*5113495bSYour Name 
597*5113495bSYour Name /* Description		TCL_DATA_CMD_2_RESERVED_2A
598*5113495bSYour Name 
599*5113495bSYour Name 			<legal 0>
600*5113495bSYour Name */
601*5113495bSYour Name #define TCL_DATA_CMD_2_RESERVED_2A_OFFSET                            0x00000008
602*5113495bSYour Name #define TCL_DATA_CMD_2_RESERVED_2A_LSB                               10
603*5113495bSYour Name #define TCL_DATA_CMD_2_RESERVED_2A_MASK                              0x00000c00
604*5113495bSYour Name 
605*5113495bSYour Name /* Description		TCL_DATA_CMD_2_SEARCH_TYPE
606*5113495bSYour Name 
607*5113495bSYour Name 			Search type select
608*5113495bSYour Name 
609*5113495bSYour Name 
610*5113495bSYour Name 
611*5113495bSYour Name 			<enum 0 Normal_search> Address and flow search will use
612*5113495bSYour Name 			packet contents
613*5113495bSYour Name 
614*5113495bSYour Name 			<enum 1 Index_based_address_search> Address search will
615*5113495bSYour Name 
616*5113495bSYour Name 			<enum 2 Index_based_flow_search> Flow search will use
617*5113495bSYour Name 			'search_index', and address search will use packet contents
618*5113495bSYour Name 
619*5113495bSYour Name 			<legal 0-2>
620*5113495bSYour Name */
621*5113495bSYour Name #define TCL_DATA_CMD_2_SEARCH_TYPE_OFFSET                            0x00000008
622*5113495bSYour Name #define TCL_DATA_CMD_2_SEARCH_TYPE_LSB                               12
623*5113495bSYour Name #define TCL_DATA_CMD_2_SEARCH_TYPE_MASK                              0x00003000
624*5113495bSYour Name 
625*5113495bSYour Name /* Description		TCL_DATA_CMD_2_ADDRX_EN
626*5113495bSYour Name 
627*5113495bSYour Name 			Address X search enable in ASE
628*5113495bSYour Name 
629*5113495bSYour Name 			1'b0: Search disable
630*5113495bSYour Name 
631*5113495bSYour Name 			1'b1: Search Enable
632*5113495bSYour Name 
633*5113495bSYour Name 			<legal all>
634*5113495bSYour Name */
635*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRX_EN_OFFSET                               0x00000008
636*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRX_EN_LSB                                  14
637*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRX_EN_MASK                                 0x00004000
638*5113495bSYour Name 
639*5113495bSYour Name /* Description		TCL_DATA_CMD_2_ADDRY_EN
640*5113495bSYour Name 
641*5113495bSYour Name 			Address Y search enable in ASE
642*5113495bSYour Name 
643*5113495bSYour Name 			1'b0: Search disable
644*5113495bSYour Name 
645*5113495bSYour Name 			1'b1: Search Enable
646*5113495bSYour Name 
647*5113495bSYour Name 			<legal all>
648*5113495bSYour Name */
649*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRY_EN_OFFSET                               0x00000008
650*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRY_EN_LSB                                  15
651*5113495bSYour Name #define TCL_DATA_CMD_2_ADDRY_EN_MASK                                 0x00008000
652*5113495bSYour Name 
653*5113495bSYour Name /* Description		TCL_DATA_CMD_2_TCL_CMD_NUMBER
654*5113495bSYour Name 
655*5113495bSYour Name 			This number can be used by SW to track, identify and
656*5113495bSYour Name 			link the created commands with the command statuses
657*5113495bSYour Name 
658*5113495bSYour Name 
659*5113495bSYour Name 
660*5113495bSYour Name 			Is set to the value 'TCL_CMD_Number' of the related
661*5113495bSYour Name 			TCL_DATA command
662*5113495bSYour Name 
663*5113495bSYour Name 			<legal all>
664*5113495bSYour Name */
665*5113495bSYour Name #define TCL_DATA_CMD_2_TCL_CMD_NUMBER_OFFSET                         0x00000008
666*5113495bSYour Name #define TCL_DATA_CMD_2_TCL_CMD_NUMBER_LSB                            16
667*5113495bSYour Name #define TCL_DATA_CMD_2_TCL_CMD_NUMBER_MASK                           0xffff0000
668*5113495bSYour Name 
669*5113495bSYour Name /* Description		TCL_DATA_CMD_3_DATA_LENGTH
670*5113495bSYour Name 
671*5113495bSYour Name 			Valid Data length in bytes.
672*5113495bSYour Name 
673*5113495bSYour Name 
674*5113495bSYour Name 
675*5113495bSYour Name 			MSDU length in case of direct descriptor.
676*5113495bSYour Name 
677*5113495bSYour Name 			Length of link extension descriptor in case of Link
678*5113495bSYour Name 			extension descriptor. This is used to know the size of
679*5113495bSYour Name 			Metadata.
680*5113495bSYour Name 
681*5113495bSYour Name 			<legal all>
682*5113495bSYour Name */
683*5113495bSYour Name #define TCL_DATA_CMD_3_DATA_LENGTH_OFFSET                            0x0000000c
684*5113495bSYour Name #define TCL_DATA_CMD_3_DATA_LENGTH_LSB                               0
685*5113495bSYour Name #define TCL_DATA_CMD_3_DATA_LENGTH_MASK                              0x0000ffff
686*5113495bSYour Name 
687*5113495bSYour Name /* Description		TCL_DATA_CMD_3_IPV4_CHECKSUM_EN
688*5113495bSYour Name 
689*5113495bSYour Name 			OLE related control
690*5113495bSYour Name 
691*5113495bSYour Name 			Enable IPv4 checksum replacement
692*5113495bSYour Name */
693*5113495bSYour Name #define TCL_DATA_CMD_3_IPV4_CHECKSUM_EN_OFFSET                       0x0000000c
694*5113495bSYour Name #define TCL_DATA_CMD_3_IPV4_CHECKSUM_EN_LSB                          16
695*5113495bSYour Name #define TCL_DATA_CMD_3_IPV4_CHECKSUM_EN_MASK                         0x00010000
696*5113495bSYour Name 
697*5113495bSYour Name /* Description		TCL_DATA_CMD_3_UDP_OVER_IPV4_CHECKSUM_EN
698*5113495bSYour Name 
699*5113495bSYour Name 			OLE related control
700*5113495bSYour Name 
701*5113495bSYour Name 			Enable UDP over IPv4 checksum replacement.  UDP checksum
702*5113495bSYour Name 			over IPv4 is optional for TCP/IP stacks.
703*5113495bSYour Name */
704*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV4_CHECKSUM_EN_OFFSET              0x0000000c
705*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV4_CHECKSUM_EN_LSB                 17
706*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV4_CHECKSUM_EN_MASK                0x00020000
707*5113495bSYour Name 
708*5113495bSYour Name /* Description		TCL_DATA_CMD_3_UDP_OVER_IPV6_CHECKSUM_EN
709*5113495bSYour Name 
710*5113495bSYour Name 			OLE related control
711*5113495bSYour Name 
712*5113495bSYour Name 			Enable UDP over IPv6 checksum replacement.  UDP checksum
713*5113495bSYour Name 			over IPv6 is mandatory for TCP/IP stacks.
714*5113495bSYour Name */
715*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV6_CHECKSUM_EN_OFFSET              0x0000000c
716*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV6_CHECKSUM_EN_LSB                 18
717*5113495bSYour Name #define TCL_DATA_CMD_3_UDP_OVER_IPV6_CHECKSUM_EN_MASK                0x00040000
718*5113495bSYour Name 
719*5113495bSYour Name /* Description		TCL_DATA_CMD_3_TCP_OVER_IPV4_CHECKSUM_EN
720*5113495bSYour Name 
721*5113495bSYour Name 			OLE related control
722*5113495bSYour Name 
723*5113495bSYour Name 			Enable TCP checksum over IPv4 replacement
724*5113495bSYour Name */
725*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV4_CHECKSUM_EN_OFFSET              0x0000000c
726*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV4_CHECKSUM_EN_LSB                 19
727*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV4_CHECKSUM_EN_MASK                0x00080000
728*5113495bSYour Name 
729*5113495bSYour Name /* Description		TCL_DATA_CMD_3_TCP_OVER_IPV6_CHECKSUM_EN
730*5113495bSYour Name 
731*5113495bSYour Name 			OLE related control
732*5113495bSYour Name 
733*5113495bSYour Name 			Enable TCP checksum over IPv6 replacement
734*5113495bSYour Name */
735*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV6_CHECKSUM_EN_OFFSET              0x0000000c
736*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV6_CHECKSUM_EN_LSB                 20
737*5113495bSYour Name #define TCL_DATA_CMD_3_TCP_OVER_IPV6_CHECKSUM_EN_MASK                0x00100000
738*5113495bSYour Name 
739*5113495bSYour Name /* Description		TCL_DATA_CMD_3_TO_FW
740*5113495bSYour Name 
741*5113495bSYour Name 			Forward packet to FW along with classification result.
742*5113495bSYour Name 			The packet will not be forward to TQM when this bit is set
743*5113495bSYour Name 
744*5113495bSYour Name 
745*5113495bSYour Name 
746*5113495bSYour Name 			1'b0: Use classification result to forward the packet.
747*5113495bSYour Name 
748*5113495bSYour Name 			1'b1: Override classification result and forward packet
749*5113495bSYour Name 			only to FW.
750*5113495bSYour Name 
751*5113495bSYour Name 			<legal all>
752*5113495bSYour Name */
753*5113495bSYour Name #define TCL_DATA_CMD_3_TO_FW_OFFSET                                  0x0000000c
754*5113495bSYour Name #define TCL_DATA_CMD_3_TO_FW_LSB                                     21
755*5113495bSYour Name #define TCL_DATA_CMD_3_TO_FW_MASK                                    0x00200000
756*5113495bSYour Name 
757*5113495bSYour Name /* Description		TCL_DATA_CMD_3_RESERVED_3A
758*5113495bSYour Name 
759*5113495bSYour Name 			<legal 0>
760*5113495bSYour Name */
761*5113495bSYour Name #define TCL_DATA_CMD_3_RESERVED_3A_OFFSET                            0x0000000c
762*5113495bSYour Name #define TCL_DATA_CMD_3_RESERVED_3A_LSB                               22
763*5113495bSYour Name #define TCL_DATA_CMD_3_RESERVED_3A_MASK                              0x00400000
764*5113495bSYour Name 
765*5113495bSYour Name /* Description		TCL_DATA_CMD_3_PACKET_OFFSET
766*5113495bSYour Name 
767*5113495bSYour Name 			Packet offset from Metadata in case of direct buffer
768*5113495bSYour Name 			descriptor. This field is valid when Buf_or_ext_desc_type is
769*5113495bSYour Name 			reset(= 0).
770*5113495bSYour Name 
771*5113495bSYour Name 			<legal all>
772*5113495bSYour Name */
773*5113495bSYour Name #define TCL_DATA_CMD_3_PACKET_OFFSET_OFFSET                          0x0000000c
774*5113495bSYour Name #define TCL_DATA_CMD_3_PACKET_OFFSET_LSB                             23
775*5113495bSYour Name #define TCL_DATA_CMD_3_PACKET_OFFSET_MASK                            0xff800000
776*5113495bSYour Name 
777*5113495bSYour Name /* Description		TCL_DATA_CMD_4_BUFFER_TIMESTAMP
778*5113495bSYour Name 
779*5113495bSYour Name 			Field only valid when 'Buffer_timestamp_valid ' is set.
780*5113495bSYour Name 
781*5113495bSYour Name 
782*5113495bSYour Name 
783*5113495bSYour Name 			Frame system entrance timestamp. The timestamp is
784*5113495bSYour Name 			related to the global system timer
785*5113495bSYour Name 
786*5113495bSYour Name 
787*5113495bSYour Name 
788*5113495bSYour Name 			Generally the first module (SW, TCL or TQM). that sees
789*5113495bSYour Name 			this frame and this timestamp field is not valid, shall fill
790*5113495bSYour Name 			in this field.
791*5113495bSYour Name 
792*5113495bSYour Name 
793*5113495bSYour Name 
794*5113495bSYour Name 			Timestamp in units of 1024 us
795*5113495bSYour Name */
796*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_OFFSET                       0x00000010
797*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_LSB                          0
798*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_MASK                         0x0007ffff
799*5113495bSYour Name 
800*5113495bSYour Name /* Description		TCL_DATA_CMD_4_BUFFER_TIMESTAMP_VALID
801*5113495bSYour Name 
802*5113495bSYour Name 			When set, the Buffer_timestamp field contains valid
803*5113495bSYour Name 			info.
804*5113495bSYour Name */
805*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_VALID_OFFSET                 0x00000010
806*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_VALID_LSB                    19
807*5113495bSYour Name #define TCL_DATA_CMD_4_BUFFER_TIMESTAMP_VALID_MASK                   0x00080000
808*5113495bSYour Name 
809*5113495bSYour Name /* Description		TCL_DATA_CMD_4_MESH_ENABLE
810*5113495bSYour Name 
811*5113495bSYour Name 			If set to 1:
812*5113495bSYour Name 
813*5113495bSYour Name 			* For raw WiFi frames, this indicates transmission to a
814*5113495bSYour Name 			mesh STA, enabling the interpretation of the 'Mesh Control
815*5113495bSYour Name 			Present' bit (bit 8) of QoS Control (otherwise this bit is
816*5113495bSYour Name 			ignored),
817*5113495bSYour Name 
818*5113495bSYour Name 			* For native WiFi frames, this indicates that a 'Mesh
819*5113495bSYour Name 			Control' field is present between the header and the LLC.
820*5113495bSYour Name */
821*5113495bSYour Name #define TCL_DATA_CMD_4_MESH_ENABLE_OFFSET                            0x00000010
822*5113495bSYour Name #define TCL_DATA_CMD_4_MESH_ENABLE_LSB                               20
823*5113495bSYour Name #define TCL_DATA_CMD_4_MESH_ENABLE_MASK                              0x00100000
824*5113495bSYour Name 
825*5113495bSYour Name /* Description		TCL_DATA_CMD_4_HLOS_TID_OVERWRITE
826*5113495bSYour Name 
827*5113495bSYour Name 			When set, TCL shall ignore the IP DSCP and VLAN PCP
828*5113495bSYour Name 			fields and use HLOS_TID as the final TID. Otherwise TCL
829*5113495bSYour Name 			shall consider the DSCP and PCP fields as well as HLOS_TID
830*5113495bSYour Name 			and choose a final TID based on the configured priority
831*5113495bSYour Name 
832*5113495bSYour Name 			<legal all>
833*5113495bSYour Name */
834*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_OVERWRITE_OFFSET                     0x00000010
835*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_OVERWRITE_LSB                        21
836*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_OVERWRITE_MASK                       0x00200000
837*5113495bSYour Name 
838*5113495bSYour Name /* Description		TCL_DATA_CMD_4_HLOS_TID
839*5113495bSYour Name 
840*5113495bSYour Name 			HLOS MSDU priority
841*5113495bSYour Name 
842*5113495bSYour Name 
843*5113495bSYour Name 
844*5113495bSYour Name 			Field is used when HLOS_TID_overwrite is set.
845*5113495bSYour Name 
846*5113495bSYour Name 
847*5113495bSYour Name 
848*5113495bSYour Name 			Field is also used when HLOS_TID_overwrite is not set
849*5113495bSYour Name 			and DSCP/PCP is not available in the packet
850*5113495bSYour Name 
851*5113495bSYour Name 			<legal all>
852*5113495bSYour Name */
853*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_OFFSET                               0x00000010
854*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_LSB                                  22
855*5113495bSYour Name #define TCL_DATA_CMD_4_HLOS_TID_MASK                                 0x03c00000
856*5113495bSYour Name 
857*5113495bSYour Name /* Description		TCL_DATA_CMD_4_LMAC_ID
858*5113495bSYour Name 
859*5113495bSYour Name 			TCL uses this LMAC_ID in address search, i.e, while
860*5113495bSYour Name 			finding matching entry for the packet in AST corresponding
861*5113495bSYour Name 			to given LMAC_ID
862*5113495bSYour Name 
863*5113495bSYour Name 			If LMAC ID is all 1s (=> value 3), it indicates wildcard
864*5113495bSYour Name 			match for any MAC
865*5113495bSYour Name 
866*5113495bSYour Name 			<legal 0-3>
867*5113495bSYour Name */
868*5113495bSYour Name #define TCL_DATA_CMD_4_LMAC_ID_OFFSET                                0x00000010
869*5113495bSYour Name #define TCL_DATA_CMD_4_LMAC_ID_LSB                                   26
870*5113495bSYour Name #define TCL_DATA_CMD_4_LMAC_ID_MASK                                  0x0c000000
871*5113495bSYour Name 
872*5113495bSYour Name /* Description		TCL_DATA_CMD_4_RESERVED_4
873*5113495bSYour Name 
874*5113495bSYour Name 			<legal 0>
875*5113495bSYour Name */
876*5113495bSYour Name #define TCL_DATA_CMD_4_RESERVED_4_OFFSET                             0x00000010
877*5113495bSYour Name #define TCL_DATA_CMD_4_RESERVED_4_LSB                                28
878*5113495bSYour Name #define TCL_DATA_CMD_4_RESERVED_4_MASK                               0xf0000000
879*5113495bSYour Name 
880*5113495bSYour Name /* Description		TCL_DATA_CMD_5_DSCP_TID_TABLE_NUM
881*5113495bSYour Name 
882*5113495bSYour Name 			DSCP to TID mapping table number that need to be used
883*5113495bSYour Name 			for the MSDU, should be specified using this field
884*5113495bSYour Name 
885*5113495bSYour Name 			<legal all>
886*5113495bSYour Name */
887*5113495bSYour Name #define TCL_DATA_CMD_5_DSCP_TID_TABLE_NUM_OFFSET                     0x00000014
888*5113495bSYour Name #define TCL_DATA_CMD_5_DSCP_TID_TABLE_NUM_LSB                        0
889*5113495bSYour Name #define TCL_DATA_CMD_5_DSCP_TID_TABLE_NUM_MASK                       0x0000003f
890*5113495bSYour Name 
891*5113495bSYour Name /* Description		TCL_DATA_CMD_5_SEARCH_INDEX
892*5113495bSYour Name 
893*5113495bSYour Name 			The index that will be used for index based address or
894*5113495bSYour Name 			flow search. The field is valid when 'search_type' is  1 or
895*5113495bSYour Name 			2.
896*5113495bSYour Name 
897*5113495bSYour Name 			<legal all>
898*5113495bSYour Name */
899*5113495bSYour Name #define TCL_DATA_CMD_5_SEARCH_INDEX_OFFSET                           0x00000014
900*5113495bSYour Name #define TCL_DATA_CMD_5_SEARCH_INDEX_LSB                              6
901*5113495bSYour Name #define TCL_DATA_CMD_5_SEARCH_INDEX_MASK                             0x03ffffc0
902*5113495bSYour Name 
903*5113495bSYour Name /* Description		TCL_DATA_CMD_5_CACHE_SET_NUM
904*5113495bSYour Name 
905*5113495bSYour Name 			Cache set number that should be used to cache the index
906*5113495bSYour Name 			based search results, for address and flow search. This
907*5113495bSYour Name 			value should be equal to LSB four bits of the hash value of
908*5113495bSYour Name 			match data, in case of search index points to an entry which
909*5113495bSYour Name 			may be used in content based search also. The value can be
910*5113495bSYour Name 			anything when the entry pointed by search index will not be
911*5113495bSYour Name 			used for content based search.
912*5113495bSYour Name 
913*5113495bSYour Name 			<legal all>
914*5113495bSYour Name */
915*5113495bSYour Name #define TCL_DATA_CMD_5_CACHE_SET_NUM_OFFSET                          0x00000014
916*5113495bSYour Name #define TCL_DATA_CMD_5_CACHE_SET_NUM_LSB                             26
917*5113495bSYour Name #define TCL_DATA_CMD_5_CACHE_SET_NUM_MASK                            0x3c000000
918*5113495bSYour Name 
919*5113495bSYour Name /* Description		TCL_DATA_CMD_5_RESERVED_5
920*5113495bSYour Name 
921*5113495bSYour Name 			<legal 0>
922*5113495bSYour Name */
923*5113495bSYour Name #define TCL_DATA_CMD_5_RESERVED_5_OFFSET                             0x00000014
924*5113495bSYour Name #define TCL_DATA_CMD_5_RESERVED_5_LSB                                30
925*5113495bSYour Name #define TCL_DATA_CMD_5_RESERVED_5_MASK                               0xc0000000
926*5113495bSYour Name 
927*5113495bSYour Name /* Description		TCL_DATA_CMD_6_RESERVED_6A
928*5113495bSYour Name 
929*5113495bSYour Name 			<legal 0>
930*5113495bSYour Name */
931*5113495bSYour Name #define TCL_DATA_CMD_6_RESERVED_6A_OFFSET                            0x00000018
932*5113495bSYour Name #define TCL_DATA_CMD_6_RESERVED_6A_LSB                               0
933*5113495bSYour Name #define TCL_DATA_CMD_6_RESERVED_6A_MASK                              0x000fffff
934*5113495bSYour Name 
935*5113495bSYour Name /* Description		TCL_DATA_CMD_6_RING_ID
936*5113495bSYour Name 
937*5113495bSYour Name 			The buffer pointer ring ID.
938*5113495bSYour Name 
939*5113495bSYour Name 			0 refers to the IDLE ring
940*5113495bSYour Name 
941*5113495bSYour Name 			1 - N refers to other rings
942*5113495bSYour Name 
943*5113495bSYour Name 
944*5113495bSYour Name 
945*5113495bSYour Name 			Helps with debugging when dumping ring contents.
946*5113495bSYour Name 
947*5113495bSYour Name 			<legal all>
948*5113495bSYour Name */
949*5113495bSYour Name #define TCL_DATA_CMD_6_RING_ID_OFFSET                                0x00000018
950*5113495bSYour Name #define TCL_DATA_CMD_6_RING_ID_LSB                                   20
951*5113495bSYour Name #define TCL_DATA_CMD_6_RING_ID_MASK                                  0x0ff00000
952*5113495bSYour Name 
953*5113495bSYour Name /* Description		TCL_DATA_CMD_6_LOOPING_COUNT
954*5113495bSYour Name 
955*5113495bSYour Name 			A count value that indicates the number of times the
956*5113495bSYour Name 			producer of entries into the Ring has looped around the
957*5113495bSYour Name 			ring.
958*5113495bSYour Name 
959*5113495bSYour Name 			At initialization time, this value is set to 0. On the
960*5113495bSYour Name 			first loop, this value is set to 1. After the max value is
961*5113495bSYour Name 			reached allowed by the number of bits for this field, the
962*5113495bSYour Name 			count value continues with 0 again.
963*5113495bSYour Name 
964*5113495bSYour Name 
965*5113495bSYour Name 
966*5113495bSYour Name 			In case SW is the consumer of the ring entries, it can
967*5113495bSYour Name 			use this field to figure out up to where the producer of
968*5113495bSYour Name 			entries has created new entries. This eliminates the need to
969*5113495bSYour Name 			check where the head pointer' of the ring is located once
970*5113495bSYour Name 			the SW starts processing an interrupt indicating that new
971*5113495bSYour Name 			entries have been put into this ring...
972*5113495bSYour Name 
973*5113495bSYour Name 
974*5113495bSYour Name 
975*5113495bSYour Name 			Also note that SW if it wants only needs to look at the
976*5113495bSYour Name 			LSB bit of this count value.
977*5113495bSYour Name 
978*5113495bSYour Name 			<legal all>
979*5113495bSYour Name */
980*5113495bSYour Name #define TCL_DATA_CMD_6_LOOPING_COUNT_OFFSET                          0x00000018
981*5113495bSYour Name #define TCL_DATA_CMD_6_LOOPING_COUNT_LSB                             28
982*5113495bSYour Name #define TCL_DATA_CMD_6_LOOPING_COUNT_MASK                            0xf0000000
983*5113495bSYour Name 
984*5113495bSYour Name 
985*5113495bSYour Name #endif // _TCL_DATA_CMD_H_
986