1*5113495bSYour Name 2*5113495bSYour Name /* Copyright (c) 2022, Qualcomm Innovation Center, Inc. All rights reserved. 3*5113495bSYour Name * 4*5113495bSYour Name * Permission to use, copy, modify, and/or distribute this software for any 5*5113495bSYour Name * purpose with or without fee is hereby granted, provided that the above 6*5113495bSYour Name * copyright notice and this permission notice appear in all copies. 7*5113495bSYour Name * 8*5113495bSYour Name * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 9*5113495bSYour Name * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 10*5113495bSYour Name * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 11*5113495bSYour Name * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 12*5113495bSYour Name * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 13*5113495bSYour Name * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 14*5113495bSYour Name * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 15*5113495bSYour Name */ 16*5113495bSYour Name 17*5113495bSYour Name 18*5113495bSYour Name 19*5113495bSYour Name 20*5113495bSYour Name 21*5113495bSYour Name 22*5113495bSYour Name 23*5113495bSYour Name 24*5113495bSYour Name 25*5113495bSYour Name 26*5113495bSYour Name #ifndef _TCL_GSE_CMD_H_ 27*5113495bSYour Name #define _TCL_GSE_CMD_H_ 28*5113495bSYour Name #if !defined(__ASSEMBLER__) 29*5113495bSYour Name #endif 30*5113495bSYour Name 31*5113495bSYour Name #define NUM_OF_DWORDS_TCL_GSE_CMD 8 32*5113495bSYour Name 33*5113495bSYour Name 34*5113495bSYour Name struct tcl_gse_cmd { 35*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN 36*5113495bSYour Name uint32_t control_buffer_addr_31_0 : 32; // [31:0] 37*5113495bSYour Name uint32_t control_buffer_addr_39_32 : 8, // [7:0] 38*5113495bSYour Name gse_ctrl : 4, // [11:8] 39*5113495bSYour Name gse_sel : 1, // [12:12] 40*5113495bSYour Name status_destination_ring_id : 1, // [13:13] 41*5113495bSYour Name swap : 1, // [14:14] 42*5113495bSYour Name index_search_en : 1, // [15:15] 43*5113495bSYour Name cache_set_num : 4, // [19:16] 44*5113495bSYour Name reserved_1a : 12; // [31:20] 45*5113495bSYour Name uint32_t tcl_cmd_type : 1, // [0:0] 46*5113495bSYour Name reserved_2a : 31; // [31:1] 47*5113495bSYour Name uint32_t cmd_meta_data_31_0 : 32; // [31:0] 48*5113495bSYour Name uint32_t cmd_meta_data_63_32 : 32; // [31:0] 49*5113495bSYour Name uint32_t reserved_5a : 32; // [31:0] 50*5113495bSYour Name uint32_t reserved_6a : 32; // [31:0] 51*5113495bSYour Name uint32_t reserved_7a : 20, // [19:0] 52*5113495bSYour Name ring_id : 8, // [27:20] 53*5113495bSYour Name looping_count : 4; // [31:28] 54*5113495bSYour Name #else 55*5113495bSYour Name uint32_t control_buffer_addr_31_0 : 32; // [31:0] 56*5113495bSYour Name uint32_t reserved_1a : 12, // [31:20] 57*5113495bSYour Name cache_set_num : 4, // [19:16] 58*5113495bSYour Name index_search_en : 1, // [15:15] 59*5113495bSYour Name swap : 1, // [14:14] 60*5113495bSYour Name status_destination_ring_id : 1, // [13:13] 61*5113495bSYour Name gse_sel : 1, // [12:12] 62*5113495bSYour Name gse_ctrl : 4, // [11:8] 63*5113495bSYour Name control_buffer_addr_39_32 : 8; // [7:0] 64*5113495bSYour Name uint32_t reserved_2a : 31, // [31:1] 65*5113495bSYour Name tcl_cmd_type : 1; // [0:0] 66*5113495bSYour Name uint32_t cmd_meta_data_31_0 : 32; // [31:0] 67*5113495bSYour Name uint32_t cmd_meta_data_63_32 : 32; // [31:0] 68*5113495bSYour Name uint32_t reserved_5a : 32; // [31:0] 69*5113495bSYour Name uint32_t reserved_6a : 32; // [31:0] 70*5113495bSYour Name uint32_t looping_count : 4, // [31:28] 71*5113495bSYour Name ring_id : 8, // [27:20] 72*5113495bSYour Name reserved_7a : 20; // [19:0] 73*5113495bSYour Name #endif 74*5113495bSYour Name }; 75*5113495bSYour Name 76*5113495bSYour Name 77*5113495bSYour Name /* Description CONTROL_BUFFER_ADDR_31_0 78*5113495bSYour Name 79*5113495bSYour Name Address (lower 32 bits) of a control buffer containing additional 80*5113495bSYour Name info needed for this command execution. 81*5113495bSYour Name <legal all> 82*5113495bSYour Name */ 83*5113495bSYour Name 84*5113495bSYour Name #define TCL_GSE_CMD_CONTROL_BUFFER_ADDR_31_0_OFFSET 0x00000000 85*5113495bSYour Name #define TCL_GSE_CMD_CONTROL_BUFFER_ADDR_31_0_LSB 0 86*5113495bSYour Name #define TCL_GSE_CMD_CONTROL_BUFFER_ADDR_31_0_MSB 31 87*5113495bSYour Name #define TCL_GSE_CMD_CONTROL_BUFFER_ADDR_31_0_MASK 0xffffffff 88*5113495bSYour Name 89*5113495bSYour Name 90*5113495bSYour Name /* Description CONTROL_BUFFER_ADDR_39_32 91*5113495bSYour Name 92*5113495bSYour Name Address (upper 8 bits) of a control buffer containing additional 93*5113495bSYour Name info needed for this command execution. 94*5113495bSYour Name <legal all> 95*5113495bSYour Name */ 96*5113495bSYour Name 97*5113495bSYour Name #define TCL_GSE_CMD_CONTROL_BUFFER_ADDR_39_32_OFFSET 0x00000004 98*5113495bSYour Name #define TCL_GSE_CMD_CONTROL_BUFFER_ADDR_39_32_LSB 0 99*5113495bSYour Name #define TCL_GSE_CMD_CONTROL_BUFFER_ADDR_39_32_MSB 7 100*5113495bSYour Name #define TCL_GSE_CMD_CONTROL_BUFFER_ADDR_39_32_MASK 0x000000ff 101*5113495bSYour Name 102*5113495bSYour Name 103*5113495bSYour Name /* Description GSE_CTRL 104*5113495bSYour Name 105*5113495bSYour Name GSE control operations. This includes cache operations and 106*5113495bSYour Name table entry statistics read/clear operation. 107*5113495bSYour Name <enum 0 rd_stat> Report or Read statistics 108*5113495bSYour Name <enum 1 srch_dis> Search disable. Report only Hash 109*5113495bSYour Name <enum 2 Wr_bk_single> Write Back single entry 110*5113495bSYour Name <enum 3 wr_bk_all> Write Back entire cache entry 111*5113495bSYour Name <enum 4 inval_single> Invalidate single cache entry 112*5113495bSYour Name <enum 5 inval_all> Invalidate entire cache 113*5113495bSYour Name <enum 6 wr_bk_inval_single> Write back and Invalidate single 114*5113495bSYour Name entry in cache 115*5113495bSYour Name <enum 7 wr_bk_inval_all> write back and invalidate entire 116*5113495bSYour Name cache 117*5113495bSYour Name <enum 8 clr_stat_single> Clear statistics for single entry 118*5113495bSYour Name 119*5113495bSYour Name <legal 0-8> 120*5113495bSYour Name Rest of the values reserved. 121*5113495bSYour Name For all single entry control operations (write back, Invalidate 122*5113495bSYour Name or both)Statistics will be reported 123*5113495bSYour Name */ 124*5113495bSYour Name 125*5113495bSYour Name #define TCL_GSE_CMD_GSE_CTRL_OFFSET 0x00000004 126*5113495bSYour Name #define TCL_GSE_CMD_GSE_CTRL_LSB 8 127*5113495bSYour Name #define TCL_GSE_CMD_GSE_CTRL_MSB 11 128*5113495bSYour Name #define TCL_GSE_CMD_GSE_CTRL_MASK 0x00000f00 129*5113495bSYour Name 130*5113495bSYour Name 131*5113495bSYour Name /* Description GSE_SEL 132*5113495bSYour Name 133*5113495bSYour Name Bit to select the ASE or FSE to do the operation mention 134*5113495bSYour Name by GSE_ctrl bit 135*5113495bSYour Name 0: FSE select 136*5113495bSYour Name 1: ASE select 137*5113495bSYour Name */ 138*5113495bSYour Name 139*5113495bSYour Name #define TCL_GSE_CMD_GSE_SEL_OFFSET 0x00000004 140*5113495bSYour Name #define TCL_GSE_CMD_GSE_SEL_LSB 12 141*5113495bSYour Name #define TCL_GSE_CMD_GSE_SEL_MSB 12 142*5113495bSYour Name #define TCL_GSE_CMD_GSE_SEL_MASK 0x00001000 143*5113495bSYour Name 144*5113495bSYour Name 145*5113495bSYour Name /* Description STATUS_DESTINATION_RING_ID 146*5113495bSYour Name 147*5113495bSYour Name The TCL status ring to which the GSE status needs to be 148*5113495bSYour Name send. 149*5113495bSYour Name 150*5113495bSYour Name <enum 0 tcl_status_0_ring> 151*5113495bSYour Name <enum 1 tcl_status_1_ring> 152*5113495bSYour Name 153*5113495bSYour Name <legal all> 154*5113495bSYour Name */ 155*5113495bSYour Name 156*5113495bSYour Name #define TCL_GSE_CMD_STATUS_DESTINATION_RING_ID_OFFSET 0x00000004 157*5113495bSYour Name #define TCL_GSE_CMD_STATUS_DESTINATION_RING_ID_LSB 13 158*5113495bSYour Name #define TCL_GSE_CMD_STATUS_DESTINATION_RING_ID_MSB 13 159*5113495bSYour Name #define TCL_GSE_CMD_STATUS_DESTINATION_RING_ID_MASK 0x00002000 160*5113495bSYour Name 161*5113495bSYour Name 162*5113495bSYour Name /* Description SWAP 163*5113495bSYour Name 164*5113495bSYour Name Bit to enable byte swapping of contents of buffer 165*5113495bSYour Name <enum 0 Byte_swap_disable > 166*5113495bSYour Name <enum 1 byte_swap_enable > 167*5113495bSYour Name <legal all> 168*5113495bSYour Name */ 169*5113495bSYour Name 170*5113495bSYour Name #define TCL_GSE_CMD_SWAP_OFFSET 0x00000004 171*5113495bSYour Name #define TCL_GSE_CMD_SWAP_LSB 14 172*5113495bSYour Name #define TCL_GSE_CMD_SWAP_MSB 14 173*5113495bSYour Name #define TCL_GSE_CMD_SWAP_MASK 0x00004000 174*5113495bSYour Name 175*5113495bSYour Name 176*5113495bSYour Name /* Description INDEX_SEARCH_EN 177*5113495bSYour Name 178*5113495bSYour Name When this bit is set to 1 control_buffer_addr[19:0] will 179*5113495bSYour Name be considered as index of the AST or Flow table and GSE 180*5113495bSYour Name commands will be executed accordingly on the entry pointed 181*5113495bSYour Name by the index. 182*5113495bSYour Name This feature is disabled by setting this bit to 0. 183*5113495bSYour Name <enum 0 index_based_cmd_disable> 184*5113495bSYour Name <enum 1 index_based_cmd_enable> 185*5113495bSYour Name 186*5113495bSYour Name <legal all> 187*5113495bSYour Name */ 188*5113495bSYour Name 189*5113495bSYour Name #define TCL_GSE_CMD_INDEX_SEARCH_EN_OFFSET 0x00000004 190*5113495bSYour Name #define TCL_GSE_CMD_INDEX_SEARCH_EN_LSB 15 191*5113495bSYour Name #define TCL_GSE_CMD_INDEX_SEARCH_EN_MSB 15 192*5113495bSYour Name #define TCL_GSE_CMD_INDEX_SEARCH_EN_MASK 0x00008000 193*5113495bSYour Name 194*5113495bSYour Name 195*5113495bSYour Name /* Description CACHE_SET_NUM 196*5113495bSYour Name 197*5113495bSYour Name Cache set number that should be used to cache the index 198*5113495bSYour Name based search results, for address and flow search. This 199*5113495bSYour Name value should be equal to value of cache_set_num for the 200*5113495bSYour Name index that is issued in TCL_DATA_CMD during search index 201*5113495bSYour Name based ASE or FSE. This field is valid for index based GSE 202*5113495bSYour Name commands 203*5113495bSYour Name <legal all> 204*5113495bSYour Name */ 205*5113495bSYour Name 206*5113495bSYour Name #define TCL_GSE_CMD_CACHE_SET_NUM_OFFSET 0x00000004 207*5113495bSYour Name #define TCL_GSE_CMD_CACHE_SET_NUM_LSB 16 208*5113495bSYour Name #define TCL_GSE_CMD_CACHE_SET_NUM_MSB 19 209*5113495bSYour Name #define TCL_GSE_CMD_CACHE_SET_NUM_MASK 0x000f0000 210*5113495bSYour Name 211*5113495bSYour Name 212*5113495bSYour Name /* Description RESERVED_1A 213*5113495bSYour Name 214*5113495bSYour Name <legal 0> 215*5113495bSYour Name */ 216*5113495bSYour Name 217*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_1A_OFFSET 0x00000004 218*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_1A_LSB 20 219*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_1A_MSB 31 220*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_1A_MASK 0xfff00000 221*5113495bSYour Name 222*5113495bSYour Name 223*5113495bSYour Name /* Description TCL_CMD_TYPE 224*5113495bSYour Name 225*5113495bSYour Name This field is used to select the type of TCL Command decriptor 226*5113495bSYour Name that is queued by SW/FW. For 'TCL_GSE_CMD' this has to 227*5113495bSYour Name be 1. 228*5113495bSYour Name <legal 1> 229*5113495bSYour Name */ 230*5113495bSYour Name 231*5113495bSYour Name #define TCL_GSE_CMD_TCL_CMD_TYPE_OFFSET 0x00000008 232*5113495bSYour Name #define TCL_GSE_CMD_TCL_CMD_TYPE_LSB 0 233*5113495bSYour Name #define TCL_GSE_CMD_TCL_CMD_TYPE_MSB 0 234*5113495bSYour Name #define TCL_GSE_CMD_TCL_CMD_TYPE_MASK 0x00000001 235*5113495bSYour Name 236*5113495bSYour Name 237*5113495bSYour Name /* Description RESERVED_2A 238*5113495bSYour Name 239*5113495bSYour Name <legal 0> 240*5113495bSYour Name */ 241*5113495bSYour Name 242*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_2A_OFFSET 0x00000008 243*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_2A_LSB 1 244*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_2A_MSB 31 245*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_2A_MASK 0xfffffffe 246*5113495bSYour Name 247*5113495bSYour Name 248*5113495bSYour Name /* Description CMD_META_DATA_31_0 249*5113495bSYour Name 250*5113495bSYour Name Meta data to be returned in the status descriptor 251*5113495bSYour Name <legal all> 252*5113495bSYour Name */ 253*5113495bSYour Name 254*5113495bSYour Name #define TCL_GSE_CMD_CMD_META_DATA_31_0_OFFSET 0x0000000c 255*5113495bSYour Name #define TCL_GSE_CMD_CMD_META_DATA_31_0_LSB 0 256*5113495bSYour Name #define TCL_GSE_CMD_CMD_META_DATA_31_0_MSB 31 257*5113495bSYour Name #define TCL_GSE_CMD_CMD_META_DATA_31_0_MASK 0xffffffff 258*5113495bSYour Name 259*5113495bSYour Name 260*5113495bSYour Name /* Description CMD_META_DATA_63_32 261*5113495bSYour Name 262*5113495bSYour Name Meta data to be returned in the status descriptor 263*5113495bSYour Name <legal all> 264*5113495bSYour Name */ 265*5113495bSYour Name 266*5113495bSYour Name #define TCL_GSE_CMD_CMD_META_DATA_63_32_OFFSET 0x00000010 267*5113495bSYour Name #define TCL_GSE_CMD_CMD_META_DATA_63_32_LSB 0 268*5113495bSYour Name #define TCL_GSE_CMD_CMD_META_DATA_63_32_MSB 31 269*5113495bSYour Name #define TCL_GSE_CMD_CMD_META_DATA_63_32_MASK 0xffffffff 270*5113495bSYour Name 271*5113495bSYour Name 272*5113495bSYour Name /* Description RESERVED_5A 273*5113495bSYour Name 274*5113495bSYour Name <legal 0> 275*5113495bSYour Name */ 276*5113495bSYour Name 277*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_5A_OFFSET 0x00000014 278*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_5A_LSB 0 279*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_5A_MSB 31 280*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_5A_MASK 0xffffffff 281*5113495bSYour Name 282*5113495bSYour Name 283*5113495bSYour Name /* Description RESERVED_6A 284*5113495bSYour Name 285*5113495bSYour Name <legal 0> 286*5113495bSYour Name */ 287*5113495bSYour Name 288*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_6A_OFFSET 0x00000018 289*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_6A_LSB 0 290*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_6A_MSB 31 291*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_6A_MASK 0xffffffff 292*5113495bSYour Name 293*5113495bSYour Name 294*5113495bSYour Name /* Description RESERVED_7A 295*5113495bSYour Name 296*5113495bSYour Name <legal 0> 297*5113495bSYour Name */ 298*5113495bSYour Name 299*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_7A_OFFSET 0x0000001c 300*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_7A_LSB 0 301*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_7A_MSB 19 302*5113495bSYour Name #define TCL_GSE_CMD_RESERVED_7A_MASK 0x000fffff 303*5113495bSYour Name 304*5113495bSYour Name 305*5113495bSYour Name /* Description RING_ID 306*5113495bSYour Name 307*5113495bSYour Name Helps with debugging when dumping ring contents. 308*5113495bSYour Name <legal all> 309*5113495bSYour Name */ 310*5113495bSYour Name 311*5113495bSYour Name #define TCL_GSE_CMD_RING_ID_OFFSET 0x0000001c 312*5113495bSYour Name #define TCL_GSE_CMD_RING_ID_LSB 20 313*5113495bSYour Name #define TCL_GSE_CMD_RING_ID_MSB 27 314*5113495bSYour Name #define TCL_GSE_CMD_RING_ID_MASK 0x0ff00000 315*5113495bSYour Name 316*5113495bSYour Name 317*5113495bSYour Name /* Description LOOPING_COUNT 318*5113495bSYour Name 319*5113495bSYour Name A count value that indicates the number of times the producer 320*5113495bSYour Name of entries into the Ring has looped around the ring. 321*5113495bSYour Name At initialization time, this value is set to 0. On the first 322*5113495bSYour Name loop, this value is set to 1. After the max value is reached 323*5113495bSYour Name allowed by the number of bits for this field, the count 324*5113495bSYour Name value continues with 0 again. 325*5113495bSYour Name 326*5113495bSYour Name In case SW is the consumer of the ring entries, it can use 327*5113495bSYour Name this field to figure out up to where the producer of entries 328*5113495bSYour Name has created new entries. This eliminates the need to check 329*5113495bSYour Name where the "head pointer' of the ring is located once the 330*5113495bSYour Name SW starts processing an interrupt indicating that new entries 331*5113495bSYour Name have been put into this ring... 332*5113495bSYour Name 333*5113495bSYour Name Also note that SW if it wants only needs to look at the 334*5113495bSYour Name LSB bit of this count value. 335*5113495bSYour Name <legal all> 336*5113495bSYour Name */ 337*5113495bSYour Name 338*5113495bSYour Name #define TCL_GSE_CMD_LOOPING_COUNT_OFFSET 0x0000001c 339*5113495bSYour Name #define TCL_GSE_CMD_LOOPING_COUNT_LSB 28 340*5113495bSYour Name #define TCL_GSE_CMD_LOOPING_COUNT_MSB 31 341*5113495bSYour Name #define TCL_GSE_CMD_LOOPING_COUNT_MASK 0xf0000000 342*5113495bSYour Name 343*5113495bSYour Name 344*5113495bSYour Name 345*5113495bSYour Name #endif // TCL_GSE_CMD 346