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 _CE_STAT_DESC_H_ 27*5113495bSYour Name #define _CE_STAT_DESC_H_ 28*5113495bSYour Name #if !defined(__ASSEMBLER__) 29*5113495bSYour Name #endif 30*5113495bSYour Name 31*5113495bSYour Name #define NUM_OF_DWORDS_CE_STAT_DESC 4 32*5113495bSYour Name 33*5113495bSYour Name 34*5113495bSYour Name struct ce_stat_desc { 35*5113495bSYour Name #ifndef WIFI_BIT_ORDER_BIG_ENDIAN 36*5113495bSYour Name uint32_t ce_res_5 : 8, // [7:0] 37*5113495bSYour Name toeplitz_en : 1, // [8:8] 38*5113495bSYour Name src_swap : 1, // [9:9] 39*5113495bSYour Name dest_swap : 1, // [10:10] 40*5113495bSYour Name gather : 1, // [11:11] 41*5113495bSYour Name barrier_read : 1, // [12:12] 42*5113495bSYour Name ce_res_6 : 3, // [15:13] 43*5113495bSYour Name length : 16; // [31:16] 44*5113495bSYour Name uint32_t toeplitz_hash_0 : 32; // [31:0] 45*5113495bSYour Name uint32_t toeplitz_hash_1 : 32; // [31:0] 46*5113495bSYour Name uint32_t fw_metadata : 16, // [15:0] 47*5113495bSYour Name ce_res_7 : 4, // [19:16] 48*5113495bSYour Name ring_id : 8, // [27:20] 49*5113495bSYour Name looping_count : 4; // [31:28] 50*5113495bSYour Name #else 51*5113495bSYour Name uint32_t length : 16, // [31:16] 52*5113495bSYour Name ce_res_6 : 3, // [15:13] 53*5113495bSYour Name barrier_read : 1, // [12:12] 54*5113495bSYour Name gather : 1, // [11:11] 55*5113495bSYour Name dest_swap : 1, // [10:10] 56*5113495bSYour Name src_swap : 1, // [9:9] 57*5113495bSYour Name toeplitz_en : 1, // [8:8] 58*5113495bSYour Name ce_res_5 : 8; // [7:0] 59*5113495bSYour Name uint32_t toeplitz_hash_0 : 32; // [31:0] 60*5113495bSYour Name uint32_t toeplitz_hash_1 : 32; // [31:0] 61*5113495bSYour Name uint32_t looping_count : 4, // [31:28] 62*5113495bSYour Name ring_id : 8, // [27:20] 63*5113495bSYour Name ce_res_7 : 4, // [19:16] 64*5113495bSYour Name fw_metadata : 16; // [15:0] 65*5113495bSYour Name #endif 66*5113495bSYour Name }; 67*5113495bSYour Name 68*5113495bSYour Name 69*5113495bSYour Name /* Description CE_RES_5 70*5113495bSYour Name 71*5113495bSYour Name Reserved 72*5113495bSYour Name <legal all> 73*5113495bSYour Name */ 74*5113495bSYour Name 75*5113495bSYour Name #define CE_STAT_DESC_CE_RES_5_OFFSET 0x00000000 76*5113495bSYour Name #define CE_STAT_DESC_CE_RES_5_LSB 0 77*5113495bSYour Name #define CE_STAT_DESC_CE_RES_5_MSB 7 78*5113495bSYour Name #define CE_STAT_DESC_CE_RES_5_MASK 0x000000ff 79*5113495bSYour Name 80*5113495bSYour Name 81*5113495bSYour Name /* Description TOEPLITZ_EN 82*5113495bSYour Name 83*5113495bSYour Name 32-bit Toeplitz-LFSR hash for the data transfer, Enabled 84*5113495bSYour Name 85*5113495bSYour Name <legal all> 86*5113495bSYour Name */ 87*5113495bSYour Name 88*5113495bSYour Name #define CE_STAT_DESC_TOEPLITZ_EN_OFFSET 0x00000000 89*5113495bSYour Name #define CE_STAT_DESC_TOEPLITZ_EN_LSB 8 90*5113495bSYour Name #define CE_STAT_DESC_TOEPLITZ_EN_MSB 8 91*5113495bSYour Name #define CE_STAT_DESC_TOEPLITZ_EN_MASK 0x00000100 92*5113495bSYour Name 93*5113495bSYour Name 94*5113495bSYour Name /* Description SRC_SWAP 95*5113495bSYour Name 96*5113495bSYour Name Source memory buffer swapped 97*5113495bSYour Name <legal all> 98*5113495bSYour Name */ 99*5113495bSYour Name 100*5113495bSYour Name #define CE_STAT_DESC_SRC_SWAP_OFFSET 0x00000000 101*5113495bSYour Name #define CE_STAT_DESC_SRC_SWAP_LSB 9 102*5113495bSYour Name #define CE_STAT_DESC_SRC_SWAP_MSB 9 103*5113495bSYour Name #define CE_STAT_DESC_SRC_SWAP_MASK 0x00000200 104*5113495bSYour Name 105*5113495bSYour Name 106*5113495bSYour Name /* Description DEST_SWAP 107*5113495bSYour Name 108*5113495bSYour Name Destination memory buffer swapped 109*5113495bSYour Name <legal all> 110*5113495bSYour Name */ 111*5113495bSYour Name 112*5113495bSYour Name #define CE_STAT_DESC_DEST_SWAP_OFFSET 0x00000000 113*5113495bSYour Name #define CE_STAT_DESC_DEST_SWAP_LSB 10 114*5113495bSYour Name #define CE_STAT_DESC_DEST_SWAP_MSB 10 115*5113495bSYour Name #define CE_STAT_DESC_DEST_SWAP_MASK 0x00000400 116*5113495bSYour Name 117*5113495bSYour Name 118*5113495bSYour Name /* Description GATHER 119*5113495bSYour Name 120*5113495bSYour Name Gather of multiple copy engine source descriptors to one 121*5113495bSYour Name destination enabled 122*5113495bSYour Name <legal all> 123*5113495bSYour Name */ 124*5113495bSYour Name 125*5113495bSYour Name #define CE_STAT_DESC_GATHER_OFFSET 0x00000000 126*5113495bSYour Name #define CE_STAT_DESC_GATHER_LSB 11 127*5113495bSYour Name #define CE_STAT_DESC_GATHER_MSB 11 128*5113495bSYour Name #define CE_STAT_DESC_GATHER_MASK 0x00000800 129*5113495bSYour Name 130*5113495bSYour Name 131*5113495bSYour Name /* Description BARRIER_READ 132*5113495bSYour Name 133*5113495bSYour Name Barrier read enabled 134*5113495bSYour Name <legal all> 135*5113495bSYour Name */ 136*5113495bSYour Name 137*5113495bSYour Name #define CE_STAT_DESC_BARRIER_READ_OFFSET 0x00000000 138*5113495bSYour Name #define CE_STAT_DESC_BARRIER_READ_LSB 12 139*5113495bSYour Name #define CE_STAT_DESC_BARRIER_READ_MSB 12 140*5113495bSYour Name #define CE_STAT_DESC_BARRIER_READ_MASK 0x00001000 141*5113495bSYour Name 142*5113495bSYour Name 143*5113495bSYour Name /* Description CE_RES_6 144*5113495bSYour Name 145*5113495bSYour Name Reserved 146*5113495bSYour Name <legal all> 147*5113495bSYour Name */ 148*5113495bSYour Name 149*5113495bSYour Name #define CE_STAT_DESC_CE_RES_6_OFFSET 0x00000000 150*5113495bSYour Name #define CE_STAT_DESC_CE_RES_6_LSB 13 151*5113495bSYour Name #define CE_STAT_DESC_CE_RES_6_MSB 15 152*5113495bSYour Name #define CE_STAT_DESC_CE_RES_6_MASK 0x0000e000 153*5113495bSYour Name 154*5113495bSYour Name 155*5113495bSYour Name /* Description LENGTH 156*5113495bSYour Name 157*5113495bSYour Name Sum of all the Lengths of the source descriptor in the gather 158*5113495bSYour Name chain 159*5113495bSYour Name <legal all> 160*5113495bSYour Name */ 161*5113495bSYour Name 162*5113495bSYour Name #define CE_STAT_DESC_LENGTH_OFFSET 0x00000000 163*5113495bSYour Name #define CE_STAT_DESC_LENGTH_LSB 16 164*5113495bSYour Name #define CE_STAT_DESC_LENGTH_MSB 31 165*5113495bSYour Name #define CE_STAT_DESC_LENGTH_MASK 0xffff0000 166*5113495bSYour Name 167*5113495bSYour Name 168*5113495bSYour Name /* Description TOEPLITZ_HASH_0 169*5113495bSYour Name 170*5113495bSYour Name 32 LS bits of 64 bit Toeplitz LFSR hash result 171*5113495bSYour Name <legal all> 172*5113495bSYour Name */ 173*5113495bSYour Name 174*5113495bSYour Name #define CE_STAT_DESC_TOEPLITZ_HASH_0_OFFSET 0x00000004 175*5113495bSYour Name #define CE_STAT_DESC_TOEPLITZ_HASH_0_LSB 0 176*5113495bSYour Name #define CE_STAT_DESC_TOEPLITZ_HASH_0_MSB 31 177*5113495bSYour Name #define CE_STAT_DESC_TOEPLITZ_HASH_0_MASK 0xffffffff 178*5113495bSYour Name 179*5113495bSYour Name 180*5113495bSYour Name /* Description TOEPLITZ_HASH_1 181*5113495bSYour Name 182*5113495bSYour Name 32 MS bits of 64 bit Toeplitz LFSR hash result 183*5113495bSYour Name <legal all> 184*5113495bSYour Name */ 185*5113495bSYour Name 186*5113495bSYour Name #define CE_STAT_DESC_TOEPLITZ_HASH_1_OFFSET 0x00000008 187*5113495bSYour Name #define CE_STAT_DESC_TOEPLITZ_HASH_1_LSB 0 188*5113495bSYour Name #define CE_STAT_DESC_TOEPLITZ_HASH_1_MSB 31 189*5113495bSYour Name #define CE_STAT_DESC_TOEPLITZ_HASH_1_MASK 0xffffffff 190*5113495bSYour Name 191*5113495bSYour Name 192*5113495bSYour Name /* Description FW_METADATA 193*5113495bSYour Name 194*5113495bSYour Name Meta data used by FW 195*5113495bSYour Name In case of gather field in first source ring entry of the 196*5113495bSYour Name gather copy cycle in taken into account. 197*5113495bSYour Name <legal all> 198*5113495bSYour Name */ 199*5113495bSYour Name 200*5113495bSYour Name #define CE_STAT_DESC_FW_METADATA_OFFSET 0x0000000c 201*5113495bSYour Name #define CE_STAT_DESC_FW_METADATA_LSB 0 202*5113495bSYour Name #define CE_STAT_DESC_FW_METADATA_MSB 15 203*5113495bSYour Name #define CE_STAT_DESC_FW_METADATA_MASK 0x0000ffff 204*5113495bSYour Name 205*5113495bSYour Name 206*5113495bSYour Name /* Description CE_RES_7 207*5113495bSYour Name 208*5113495bSYour Name Reserved 209*5113495bSYour Name <legal all> 210*5113495bSYour Name */ 211*5113495bSYour Name 212*5113495bSYour Name #define CE_STAT_DESC_CE_RES_7_OFFSET 0x0000000c 213*5113495bSYour Name #define CE_STAT_DESC_CE_RES_7_LSB 16 214*5113495bSYour Name #define CE_STAT_DESC_CE_RES_7_MSB 19 215*5113495bSYour Name #define CE_STAT_DESC_CE_RES_7_MASK 0x000f0000 216*5113495bSYour Name 217*5113495bSYour Name 218*5113495bSYour Name /* Description RING_ID 219*5113495bSYour Name 220*5113495bSYour Name The buffer pointer ring ID. 221*5113495bSYour Name 0 refers to the IDLE ring 222*5113495bSYour Name 1 - N refers to other rings 223*5113495bSYour Name 224*5113495bSYour Name Helps with debugging when dumping ring contents. 225*5113495bSYour Name <legal all> 226*5113495bSYour Name */ 227*5113495bSYour Name 228*5113495bSYour Name #define CE_STAT_DESC_RING_ID_OFFSET 0x0000000c 229*5113495bSYour Name #define CE_STAT_DESC_RING_ID_LSB 20 230*5113495bSYour Name #define CE_STAT_DESC_RING_ID_MSB 27 231*5113495bSYour Name #define CE_STAT_DESC_RING_ID_MASK 0x0ff00000 232*5113495bSYour Name 233*5113495bSYour Name 234*5113495bSYour Name /* Description LOOPING_COUNT 235*5113495bSYour Name 236*5113495bSYour Name A count value that indicates the number of times the producer 237*5113495bSYour Name of entries into the Ring has looped around the ring. 238*5113495bSYour Name At initialization time, this value is set to 0. On the first 239*5113495bSYour Name loop, this value is set to 1. After the max value is reached 240*5113495bSYour Name allowed by the number of bits for this field, the count 241*5113495bSYour Name value continues with 0 again. 242*5113495bSYour Name In case SW is the consumer of the ring entries, it can use 243*5113495bSYour Name this field to figure out up to where the producer of entries 244*5113495bSYour Name has created new entries. This eliminates the need to check 245*5113495bSYour Name where the "head pointer' of the ring is located once the 246*5113495bSYour Name SW starts processing an interrupt indicating that new entries 247*5113495bSYour Name have been put into this ring... 248*5113495bSYour Name Also note that SW if it wants only needs to look at the 249*5113495bSYour Name LSB bit of this count value. 250*5113495bSYour Name <legal all> 251*5113495bSYour Name */ 252*5113495bSYour Name 253*5113495bSYour Name #define CE_STAT_DESC_LOOPING_COUNT_OFFSET 0x0000000c 254*5113495bSYour Name #define CE_STAT_DESC_LOOPING_COUNT_LSB 28 255*5113495bSYour Name #define CE_STAT_DESC_LOOPING_COUNT_MSB 31 256*5113495bSYour Name #define CE_STAT_DESC_LOOPING_COUNT_MASK 0xf0000000 257*5113495bSYour Name 258*5113495bSYour Name 259*5113495bSYour Name 260*5113495bSYour Name #endif // CE_STAT_DESC 261