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