1*5113495bSYour Name /* 2*5113495bSYour Name * Copyright (c) 2023 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 #ifndef _TCL_STATUS_RING_H_ 18*5113495bSYour Name #define _TCL_STATUS_RING_H_ 19*5113495bSYour Name #if !defined(__ASSEMBLER__) 20*5113495bSYour Name #endif 21*5113495bSYour Name 22*5113495bSYour Name #define NUM_OF_DWORDS_TCL_STATUS_RING 8 23*5113495bSYour Name 24*5113495bSYour Name 25*5113495bSYour Name struct tcl_status_ring { 26*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN 27*5113495bSYour Name uint32_t gse_ctrl : 4, // [3:0] 28*5113495bSYour Name ase_fse_sel : 1, // [4:4] 29*5113495bSYour Name cache_op_res : 2, // [6:5] 30*5113495bSYour Name index_search_en : 1, // [7:7] 31*5113495bSYour Name msdu_cnt_n : 24; // [31:8] 32*5113495bSYour Name uint32_t msdu_byte_cnt_n : 32; // [31:0] 33*5113495bSYour Name uint32_t msdu_timestmp_n : 32; // [31:0] 34*5113495bSYour Name uint32_t cmd_meta_data_31_0 : 32; // [31:0] 35*5113495bSYour Name uint32_t cmd_meta_data_63_32 : 32; // [31:0] 36*5113495bSYour Name uint32_t hash_indx_val : 20, // [19:0] 37*5113495bSYour Name cache_set_num : 4, // [23:20] 38*5113495bSYour Name reserved_5a : 8; // [31:24] 39*5113495bSYour Name uint32_t reserved_6a : 32; // [31:0] 40*5113495bSYour Name uint32_t reserved_7a : 20, // [19:0] 41*5113495bSYour Name ring_id : 8, // [27:20] 42*5113495bSYour Name looping_count : 4; // [31:28] 43*5113495bSYour Name #else 44*5113495bSYour Name uint32_t msdu_cnt_n : 24, // [31:8] 45*5113495bSYour Name index_search_en : 1, // [7:7] 46*5113495bSYour Name cache_op_res : 2, // [6:5] 47*5113495bSYour Name ase_fse_sel : 1, // [4:4] 48*5113495bSYour Name gse_ctrl : 4; // [3:0] 49*5113495bSYour Name uint32_t msdu_byte_cnt_n : 32; // [31:0] 50*5113495bSYour Name uint32_t msdu_timestmp_n : 32; // [31:0] 51*5113495bSYour Name uint32_t cmd_meta_data_31_0 : 32; // [31:0] 52*5113495bSYour Name uint32_t cmd_meta_data_63_32 : 32; // [31:0] 53*5113495bSYour Name uint32_t reserved_5a : 8, // [31:24] 54*5113495bSYour Name cache_set_num : 4, // [23:20] 55*5113495bSYour Name hash_indx_val : 20; // [19:0] 56*5113495bSYour Name uint32_t reserved_6a : 32; // [31:0] 57*5113495bSYour Name uint32_t looping_count : 4, // [31:28] 58*5113495bSYour Name ring_id : 8, // [27:20] 59*5113495bSYour Name reserved_7a : 20; // [19:0] 60*5113495bSYour Name #endif 61*5113495bSYour Name }; 62*5113495bSYour Name 63*5113495bSYour Name 64*5113495bSYour Name /* Description GSE_CTRL 65*5113495bSYour Name 66*5113495bSYour Name GSE control operations. This includes cache operations and 67*5113495bSYour Name table entry statistics read/clear operation. 68*5113495bSYour Name <enum 0 rd_stat> Report or Read statistics 69*5113495bSYour Name <enum 1 srch_dis> Search disable. Report only Hash 70*5113495bSYour Name <enum 2 Wr_bk_single> Write Back single entry 71*5113495bSYour Name <enum 3 wr_bk_all> Write Back entire cache entry 72*5113495bSYour Name <enum 4 inval_single> Invalidate single cache entry 73*5113495bSYour Name <enum 5 inval_all> Invalidate entire cache 74*5113495bSYour Name <enum 6 wr_bk_inval_single> Write back and Invalidate single 75*5113495bSYour Name entry in cache 76*5113495bSYour Name <enum 7 wr_bk_inval_all> write back and invalidate entire 77*5113495bSYour Name cache 78*5113495bSYour Name <enum 8 clr_stat_single> Clear statistics for single entry 79*5113495bSYour Name 80*5113495bSYour Name <legal 0-8> 81*5113495bSYour Name Rest of the values reserved. 82*5113495bSYour Name For all single entry control operations (write back, Invalidate 83*5113495bSYour Name or both)Statistics will be reported 84*5113495bSYour Name */ 85*5113495bSYour Name 86*5113495bSYour Name #define TCL_STATUS_RING_GSE_CTRL_OFFSET 0x00000000 87*5113495bSYour Name #define TCL_STATUS_RING_GSE_CTRL_LSB 0 88*5113495bSYour Name #define TCL_STATUS_RING_GSE_CTRL_MSB 3 89*5113495bSYour Name #define TCL_STATUS_RING_GSE_CTRL_MASK 0x0000000f 90*5113495bSYour Name 91*5113495bSYour Name 92*5113495bSYour Name /* Description ASE_FSE_SEL 93*5113495bSYour Name 94*5113495bSYour Name Search Engine for which operation is done. 95*5113495bSYour Name 1'b0: Address Search Engine Result 96*5113495bSYour Name 1'b1: Flow Search Engine result 97*5113495bSYour Name */ 98*5113495bSYour Name 99*5113495bSYour Name #define TCL_STATUS_RING_ASE_FSE_SEL_OFFSET 0x00000000 100*5113495bSYour Name #define TCL_STATUS_RING_ASE_FSE_SEL_LSB 4 101*5113495bSYour Name #define TCL_STATUS_RING_ASE_FSE_SEL_MSB 4 102*5113495bSYour Name #define TCL_STATUS_RING_ASE_FSE_SEL_MASK 0x00000010 103*5113495bSYour Name 104*5113495bSYour Name 105*5113495bSYour Name /* Description CACHE_OP_RES 106*5113495bSYour Name 107*5113495bSYour Name Cache operation result. Following are results of cache operation. 108*5113495bSYour Name 109*5113495bSYour Name <enum 0 op_done> Operation successful 110*5113495bSYour Name <enum 1 not_fnd> Entry not found in Table 111*5113495bSYour Name <enum 2 timeout_er> Timeout Error 112*5113495bSYour Name <legal 0-2> 113*5113495bSYour Name */ 114*5113495bSYour Name 115*5113495bSYour Name #define TCL_STATUS_RING_CACHE_OP_RES_OFFSET 0x00000000 116*5113495bSYour Name #define TCL_STATUS_RING_CACHE_OP_RES_LSB 5 117*5113495bSYour Name #define TCL_STATUS_RING_CACHE_OP_RES_MSB 6 118*5113495bSYour Name #define TCL_STATUS_RING_CACHE_OP_RES_MASK 0x00000060 119*5113495bSYour Name 120*5113495bSYour Name 121*5113495bSYour Name /* Description INDEX_SEARCH_EN 122*5113495bSYour Name 123*5113495bSYour Name When this bit is set to 1 control_buffer_addr[19:0] will 124*5113495bSYour Name be considered as index of the AST or Flow table and GSE 125*5113495bSYour Name commands will be executed accordingly on the entry pointed 126*5113495bSYour Name by the index. 127*5113495bSYour Name This feature is disabled by setting this bit to 0. 128*5113495bSYour Name <enum 0 index_based_cmd_disable> 129*5113495bSYour Name <enum 1 index_based_cmd_enable> 130*5113495bSYour Name 131*5113495bSYour Name <legal all> 132*5113495bSYour Name */ 133*5113495bSYour Name 134*5113495bSYour Name #define TCL_STATUS_RING_INDEX_SEARCH_EN_OFFSET 0x00000000 135*5113495bSYour Name #define TCL_STATUS_RING_INDEX_SEARCH_EN_LSB 7 136*5113495bSYour Name #define TCL_STATUS_RING_INDEX_SEARCH_EN_MSB 7 137*5113495bSYour Name #define TCL_STATUS_RING_INDEX_SEARCH_EN_MASK 0x00000080 138*5113495bSYour Name 139*5113495bSYour Name 140*5113495bSYour Name /* Description MSDU_CNT_N 141*5113495bSYour Name 142*5113495bSYour Name MSDU count of Entry. Valid when GSE_CTRL is 4'b0111 and 143*5113495bSYour Name 4'b1000 144*5113495bSYour Name */ 145*5113495bSYour Name 146*5113495bSYour Name #define TCL_STATUS_RING_MSDU_CNT_N_OFFSET 0x00000000 147*5113495bSYour Name #define TCL_STATUS_RING_MSDU_CNT_N_LSB 8 148*5113495bSYour Name #define TCL_STATUS_RING_MSDU_CNT_N_MSB 31 149*5113495bSYour Name #define TCL_STATUS_RING_MSDU_CNT_N_MASK 0xffffff00 150*5113495bSYour Name 151*5113495bSYour Name 152*5113495bSYour Name /* Description MSDU_BYTE_CNT_N 153*5113495bSYour Name 154*5113495bSYour Name MSDU byte count for entry 1. Valid when GSE_CTRL is 4'b0111 155*5113495bSYour Name and 4'b1000 156*5113495bSYour Name */ 157*5113495bSYour Name 158*5113495bSYour Name #define TCL_STATUS_RING_MSDU_BYTE_CNT_N_OFFSET 0x00000004 159*5113495bSYour Name #define TCL_STATUS_RING_MSDU_BYTE_CNT_N_LSB 0 160*5113495bSYour Name #define TCL_STATUS_RING_MSDU_BYTE_CNT_N_MSB 31 161*5113495bSYour Name #define TCL_STATUS_RING_MSDU_BYTE_CNT_N_MASK 0xffffffff 162*5113495bSYour Name 163*5113495bSYour Name 164*5113495bSYour Name /* Description MSDU_TIMESTMP_N 165*5113495bSYour Name 166*5113495bSYour Name MSDU timestamp for entry 1. Valid when GSE_CTRL is 4'b0111 167*5113495bSYour Name and 4'b1000 168*5113495bSYour Name */ 169*5113495bSYour Name 170*5113495bSYour Name #define TCL_STATUS_RING_MSDU_TIMESTMP_N_OFFSET 0x00000008 171*5113495bSYour Name #define TCL_STATUS_RING_MSDU_TIMESTMP_N_LSB 0 172*5113495bSYour Name #define TCL_STATUS_RING_MSDU_TIMESTMP_N_MSB 31 173*5113495bSYour Name #define TCL_STATUS_RING_MSDU_TIMESTMP_N_MASK 0xffffffff 174*5113495bSYour Name 175*5113495bSYour Name 176*5113495bSYour Name /* Description CMD_META_DATA_31_0 177*5113495bSYour Name 178*5113495bSYour Name Meta data from input ring 179*5113495bSYour Name <legal all> 180*5113495bSYour Name */ 181*5113495bSYour Name 182*5113495bSYour Name #define TCL_STATUS_RING_CMD_META_DATA_31_0_OFFSET 0x0000000c 183*5113495bSYour Name #define TCL_STATUS_RING_CMD_META_DATA_31_0_LSB 0 184*5113495bSYour Name #define TCL_STATUS_RING_CMD_META_DATA_31_0_MSB 31 185*5113495bSYour Name #define TCL_STATUS_RING_CMD_META_DATA_31_0_MASK 0xffffffff 186*5113495bSYour Name 187*5113495bSYour Name 188*5113495bSYour Name /* Description CMD_META_DATA_63_32 189*5113495bSYour Name 190*5113495bSYour Name Meta data from input ring 191*5113495bSYour Name <legal all> 192*5113495bSYour Name */ 193*5113495bSYour Name 194*5113495bSYour Name #define TCL_STATUS_RING_CMD_META_DATA_63_32_OFFSET 0x00000010 195*5113495bSYour Name #define TCL_STATUS_RING_CMD_META_DATA_63_32_LSB 0 196*5113495bSYour Name #define TCL_STATUS_RING_CMD_META_DATA_63_32_MSB 31 197*5113495bSYour Name #define TCL_STATUS_RING_CMD_META_DATA_63_32_MASK 0xffffffff 198*5113495bSYour Name 199*5113495bSYour Name 200*5113495bSYour Name /* Description HASH_INDX_VAL 201*5113495bSYour Name 202*5113495bSYour Name Index of entry in the table in case of search pass (or) 203*5113495bSYour Name 204*5113495bSYour Name Hash value of the entry in table in case of search failed 205*5113495bSYour Name or search disable. 206*5113495bSYour Name <legal all> 207*5113495bSYour Name */ 208*5113495bSYour Name 209*5113495bSYour Name #define TCL_STATUS_RING_HASH_INDX_VAL_OFFSET 0x00000014 210*5113495bSYour Name #define TCL_STATUS_RING_HASH_INDX_VAL_LSB 0 211*5113495bSYour Name #define TCL_STATUS_RING_HASH_INDX_VAL_MSB 19 212*5113495bSYour Name #define TCL_STATUS_RING_HASH_INDX_VAL_MASK 0x000fffff 213*5113495bSYour Name 214*5113495bSYour Name 215*5113495bSYour Name /* Description CACHE_SET_NUM 216*5113495bSYour Name 217*5113495bSYour Name Cache set number copied from TCL_GSE_CMD 218*5113495bSYour Name */ 219*5113495bSYour Name 220*5113495bSYour Name #define TCL_STATUS_RING_CACHE_SET_NUM_OFFSET 0x00000014 221*5113495bSYour Name #define TCL_STATUS_RING_CACHE_SET_NUM_LSB 20 222*5113495bSYour Name #define TCL_STATUS_RING_CACHE_SET_NUM_MSB 23 223*5113495bSYour Name #define TCL_STATUS_RING_CACHE_SET_NUM_MASK 0x00f00000 224*5113495bSYour Name 225*5113495bSYour Name 226*5113495bSYour Name /* Description RESERVED_5A 227*5113495bSYour Name 228*5113495bSYour Name <legal 0> 229*5113495bSYour Name */ 230*5113495bSYour Name 231*5113495bSYour Name #define TCL_STATUS_RING_RESERVED_5A_OFFSET 0x00000014 232*5113495bSYour Name #define TCL_STATUS_RING_RESERVED_5A_LSB 24 233*5113495bSYour Name #define TCL_STATUS_RING_RESERVED_5A_MSB 31 234*5113495bSYour Name #define TCL_STATUS_RING_RESERVED_5A_MASK 0xff000000 235*5113495bSYour Name 236*5113495bSYour Name 237*5113495bSYour Name /* Description RESERVED_6A 238*5113495bSYour Name 239*5113495bSYour Name <legal 0> 240*5113495bSYour Name */ 241*5113495bSYour Name 242*5113495bSYour Name #define TCL_STATUS_RING_RESERVED_6A_OFFSET 0x00000018 243*5113495bSYour Name #define TCL_STATUS_RING_RESERVED_6A_LSB 0 244*5113495bSYour Name #define TCL_STATUS_RING_RESERVED_6A_MSB 31 245*5113495bSYour Name #define TCL_STATUS_RING_RESERVED_6A_MASK 0xffffffff 246*5113495bSYour Name 247*5113495bSYour Name 248*5113495bSYour Name /* Description RESERVED_7A 249*5113495bSYour Name 250*5113495bSYour Name <legal 0> 251*5113495bSYour Name */ 252*5113495bSYour Name 253*5113495bSYour Name #define TCL_STATUS_RING_RESERVED_7A_OFFSET 0x0000001c 254*5113495bSYour Name #define TCL_STATUS_RING_RESERVED_7A_LSB 0 255*5113495bSYour Name #define TCL_STATUS_RING_RESERVED_7A_MSB 19 256*5113495bSYour Name #define TCL_STATUS_RING_RESERVED_7A_MASK 0x000fffff 257*5113495bSYour Name 258*5113495bSYour Name 259*5113495bSYour Name /* Description RING_ID 260*5113495bSYour Name 261*5113495bSYour Name The buffer pointer ring ID. 262*5113495bSYour Name 263*5113495bSYour Name Helps with debugging when dumping ring contents. 264*5113495bSYour Name <legal all> 265*5113495bSYour Name */ 266*5113495bSYour Name 267*5113495bSYour Name #define TCL_STATUS_RING_RING_ID_OFFSET 0x0000001c 268*5113495bSYour Name #define TCL_STATUS_RING_RING_ID_LSB 20 269*5113495bSYour Name #define TCL_STATUS_RING_RING_ID_MSB 27 270*5113495bSYour Name #define TCL_STATUS_RING_RING_ID_MASK 0x0ff00000 271*5113495bSYour Name 272*5113495bSYour Name 273*5113495bSYour Name /* Description LOOPING_COUNT 274*5113495bSYour Name 275*5113495bSYour Name A count value that indicates the number of times the producer 276*5113495bSYour Name of entries into the Ring has looped around the ring. 277*5113495bSYour Name At initialization time, this value is set to 0. On the first 278*5113495bSYour Name loop, this value is set to 1. After the max value is reached 279*5113495bSYour Name allowed by the number of bits for this field, the count 280*5113495bSYour Name value continues with 0 again. 281*5113495bSYour Name 282*5113495bSYour Name In case SW is the consumer of the ring entries, it can use 283*5113495bSYour Name this field to figure out up to where the producer of entries 284*5113495bSYour Name has created new entries. This eliminates the need to check 285*5113495bSYour Name where the "head pointer' of the ring is located once the 286*5113495bSYour Name SW starts processing an interrupt indicating that new entries 287*5113495bSYour Name have been put into this ring... 288*5113495bSYour Name 289*5113495bSYour Name Also note that SW if it wants only needs to look at the 290*5113495bSYour Name LSB bit of this count value. 291*5113495bSYour Name <legal all> 292*5113495bSYour Name */ 293*5113495bSYour Name 294*5113495bSYour Name #define TCL_STATUS_RING_LOOPING_COUNT_OFFSET 0x0000001c 295*5113495bSYour Name #define TCL_STATUS_RING_LOOPING_COUNT_LSB 28 296*5113495bSYour Name #define TCL_STATUS_RING_LOOPING_COUNT_MSB 31 297*5113495bSYour Name #define TCL_STATUS_RING_LOOPING_COUNT_MASK 0xf0000000 298*5113495bSYour Name 299*5113495bSYour Name 300*5113495bSYour Name 301*5113495bSYour Name #endif // TCL_STATUS_RING 302