1*5113495bSYour Name /* 2*5113495bSYour Name * Copyright (c) 2019, The Linux Foundation. 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 _CE_SRC_DESC_H_ 18*5113495bSYour Name #define _CE_SRC_DESC_H_ 19*5113495bSYour Name #if !defined(__ASSEMBLER__) 20*5113495bSYour Name #endif 21*5113495bSYour Name 22*5113495bSYour Name 23*5113495bSYour Name // ################ START SUMMARY ################# 24*5113495bSYour Name // 25*5113495bSYour Name // Dword Fields 26*5113495bSYour Name // 0 src_buffer_low[31:0] 27*5113495bSYour Name // 1 src_buffer_high[7:0], toeplitz_en[8], src_swap[9], dest_swap[10], gather[11], ce_res_0[15:12], length[31:16] 28*5113495bSYour Name // 2 fw_metadata[15:0], ce_res_1[31:16] 29*5113495bSYour Name // 3 ce_res_2[19:0], ring_id[27:20], looping_count[31:28] 30*5113495bSYour Name // 31*5113495bSYour Name // ################ END SUMMARY ################# 32*5113495bSYour Name 33*5113495bSYour Name #define NUM_OF_DWORDS_CE_SRC_DESC 4 34*5113495bSYour Name 35*5113495bSYour Name struct ce_src_desc { 36*5113495bSYour Name uint32_t src_buffer_low : 32; //[31:0] 37*5113495bSYour Name uint32_t src_buffer_high : 8, //[7:0] 38*5113495bSYour Name toeplitz_en : 1, //[8] 39*5113495bSYour Name src_swap : 1, //[9] 40*5113495bSYour Name dest_swap : 1, //[10] 41*5113495bSYour Name gather : 1, //[11] 42*5113495bSYour Name ce_res_0 : 4, //[15:12] 43*5113495bSYour Name length : 16; //[31:16] 44*5113495bSYour Name uint32_t fw_metadata : 16, //[15:0] 45*5113495bSYour Name ce_res_1 : 16; //[31:16] 46*5113495bSYour Name uint32_t ce_res_2 : 20, //[19:0] 47*5113495bSYour Name ring_id : 8, //[27:20] 48*5113495bSYour Name looping_count : 4; //[31:28] 49*5113495bSYour Name }; 50*5113495bSYour Name 51*5113495bSYour Name /* 52*5113495bSYour Name 53*5113495bSYour Name src_buffer_low 54*5113495bSYour Name 55*5113495bSYour Name LSB 32 bits of the 40 Bit Pointer to the source buffer 56*5113495bSYour Name 57*5113495bSYour Name <legal all> 58*5113495bSYour Name 59*5113495bSYour Name src_buffer_high 60*5113495bSYour Name 61*5113495bSYour Name MSB 8 bits of the 40 Bit Pointer to the source buffer 62*5113495bSYour Name 63*5113495bSYour Name <legal all> 64*5113495bSYour Name 65*5113495bSYour Name toeplitz_en 66*5113495bSYour Name 67*5113495bSYour Name Enable generation of 32-bit Toeplitz-LFSR hash for the 68*5113495bSYour Name data transfer 69*5113495bSYour Name 70*5113495bSYour Name In case of gather field in first source ring entry of 71*5113495bSYour Name the gather copy cycle in taken into account. 72*5113495bSYour Name 73*5113495bSYour Name <legal all> 74*5113495bSYour Name 75*5113495bSYour Name src_swap 76*5113495bSYour Name 77*5113495bSYour Name Treats source memory organization as big-endian. For 78*5113495bSYour Name each dword read (4 bytes), the byte 0 is swapped with byte 3 79*5113495bSYour Name and byte 1 is swapped with byte 2. 80*5113495bSYour Name 81*5113495bSYour Name In case of gather field in first source ring entry of 82*5113495bSYour Name the gather copy cycle in taken into account. 83*5113495bSYour Name 84*5113495bSYour Name <legal all> 85*5113495bSYour Name 86*5113495bSYour Name dest_swap 87*5113495bSYour Name 88*5113495bSYour Name Treats destination memory organization as big-endian. 89*5113495bSYour Name For each dword write (4 bytes), the byte 0 is swapped with 90*5113495bSYour Name byte 3 and byte 1 is swapped with byte 2. 91*5113495bSYour Name 92*5113495bSYour Name In case of gather field in first source ring entry of 93*5113495bSYour Name the gather copy cycle in taken into account. 94*5113495bSYour Name 95*5113495bSYour Name <legal all> 96*5113495bSYour Name 97*5113495bSYour Name gather 98*5113495bSYour Name 99*5113495bSYour Name Enables gather of multiple copy engine source 100*5113495bSYour Name descriptors to one destination. 101*5113495bSYour Name 102*5113495bSYour Name <legal all> 103*5113495bSYour Name 104*5113495bSYour Name ce_res_0 105*5113495bSYour Name 106*5113495bSYour Name Reserved 107*5113495bSYour Name 108*5113495bSYour Name <legal all> 109*5113495bSYour Name 110*5113495bSYour Name length 111*5113495bSYour Name 112*5113495bSYour Name Length of the buffer in units of octets of the current 113*5113495bSYour Name descriptor 114*5113495bSYour Name 115*5113495bSYour Name <legal all> 116*5113495bSYour Name 117*5113495bSYour Name fw_metadata 118*5113495bSYour Name 119*5113495bSYour Name Meta data used by FW 120*5113495bSYour Name 121*5113495bSYour Name In case of gather field in first source ring entry of 122*5113495bSYour Name the gather copy cycle in taken into account. 123*5113495bSYour Name 124*5113495bSYour Name <legal all> 125*5113495bSYour Name 126*5113495bSYour Name ce_res_1 127*5113495bSYour Name 128*5113495bSYour Name Reserved 129*5113495bSYour Name 130*5113495bSYour Name <legal all> 131*5113495bSYour Name 132*5113495bSYour Name ce_res_2 133*5113495bSYour Name 134*5113495bSYour Name Reserved 135*5113495bSYour Name 136*5113495bSYour Name <legal all> 137*5113495bSYour Name 138*5113495bSYour Name ring_id 139*5113495bSYour Name 140*5113495bSYour Name The buffer pointer ring ID. 141*5113495bSYour Name 142*5113495bSYour Name 0 refers to the IDLE ring 143*5113495bSYour Name 144*5113495bSYour Name 1 - N refers to other rings 145*5113495bSYour Name 146*5113495bSYour Name 147*5113495bSYour Name 148*5113495bSYour Name Helps with debugging when dumping ring contents. 149*5113495bSYour Name 150*5113495bSYour Name <legal all> 151*5113495bSYour Name 152*5113495bSYour Name looping_count 153*5113495bSYour Name 154*5113495bSYour Name A count value that indicates the number of times the 155*5113495bSYour Name producer of entries into the Ring has looped around the 156*5113495bSYour Name ring. 157*5113495bSYour Name 158*5113495bSYour Name At initialization time, this value is set to 0. On the 159*5113495bSYour Name first loop, this value is set to 1. After the max value is 160*5113495bSYour Name reached allowed by the number of bits for this field, the 161*5113495bSYour Name count value continues with 0 again. 162*5113495bSYour Name 163*5113495bSYour Name In case SW is the consumer of the ring entries, it can 164*5113495bSYour Name use this field to figure out up to where the producer of 165*5113495bSYour Name entries has created new entries. This eliminates the need to 166*5113495bSYour Name check where the head pointer' of the ring is located once 167*5113495bSYour Name the SW starts processing an interrupt indicating that new 168*5113495bSYour Name entries have been put into this ring... 169*5113495bSYour Name 170*5113495bSYour Name Also note that SW if it wants only needs to look at the 171*5113495bSYour Name LSB bit of this count value. 172*5113495bSYour Name 173*5113495bSYour Name <legal all> 174*5113495bSYour Name */ 175*5113495bSYour Name 176*5113495bSYour Name 177*5113495bSYour Name /* Description CE_SRC_DESC_0_SRC_BUFFER_LOW 178*5113495bSYour Name 179*5113495bSYour Name LSB 32 bits of the 40 Bit Pointer to the source buffer 180*5113495bSYour Name 181*5113495bSYour Name <legal all> 182*5113495bSYour Name */ 183*5113495bSYour Name #define CE_SRC_DESC_0_SRC_BUFFER_LOW_OFFSET 0x00000000 184*5113495bSYour Name #define CE_SRC_DESC_0_SRC_BUFFER_LOW_LSB 0 185*5113495bSYour Name #define CE_SRC_DESC_0_SRC_BUFFER_LOW_MASK 0xffffffff 186*5113495bSYour Name 187*5113495bSYour Name /* Description CE_SRC_DESC_1_SRC_BUFFER_HIGH 188*5113495bSYour Name 189*5113495bSYour Name MSB 8 bits of the 40 Bit Pointer to the source buffer 190*5113495bSYour Name 191*5113495bSYour Name <legal all> 192*5113495bSYour Name */ 193*5113495bSYour Name #define CE_SRC_DESC_1_SRC_BUFFER_HIGH_OFFSET 0x00000004 194*5113495bSYour Name #define CE_SRC_DESC_1_SRC_BUFFER_HIGH_LSB 0 195*5113495bSYour Name #define CE_SRC_DESC_1_SRC_BUFFER_HIGH_MASK 0x000000ff 196*5113495bSYour Name 197*5113495bSYour Name /* Description CE_SRC_DESC_1_TOEPLITZ_EN 198*5113495bSYour Name 199*5113495bSYour Name Enable generation of 32-bit Toeplitz-LFSR hash for the 200*5113495bSYour Name data transfer 201*5113495bSYour Name 202*5113495bSYour Name In case of gather field in first source ring entry of 203*5113495bSYour Name the gather copy cycle in taken into account. 204*5113495bSYour Name 205*5113495bSYour Name <legal all> 206*5113495bSYour Name */ 207*5113495bSYour Name #define CE_SRC_DESC_1_TOEPLITZ_EN_OFFSET 0x00000004 208*5113495bSYour Name #define CE_SRC_DESC_1_TOEPLITZ_EN_LSB 8 209*5113495bSYour Name #define CE_SRC_DESC_1_TOEPLITZ_EN_MASK 0x00000100 210*5113495bSYour Name 211*5113495bSYour Name /* Description CE_SRC_DESC_1_SRC_SWAP 212*5113495bSYour Name 213*5113495bSYour Name Treats source memory organization as big-endian. For 214*5113495bSYour Name each dword read (4 bytes), the byte 0 is swapped with byte 3 215*5113495bSYour Name and byte 1 is swapped with byte 2. 216*5113495bSYour Name 217*5113495bSYour Name In case of gather field in first source ring entry of 218*5113495bSYour Name the gather copy cycle in taken into account. 219*5113495bSYour Name 220*5113495bSYour Name <legal all> 221*5113495bSYour Name */ 222*5113495bSYour Name #define CE_SRC_DESC_1_SRC_SWAP_OFFSET 0x00000004 223*5113495bSYour Name #define CE_SRC_DESC_1_SRC_SWAP_LSB 9 224*5113495bSYour Name #define CE_SRC_DESC_1_SRC_SWAP_MASK 0x00000200 225*5113495bSYour Name 226*5113495bSYour Name /* Description CE_SRC_DESC_1_DEST_SWAP 227*5113495bSYour Name 228*5113495bSYour Name Treats destination memory organization as big-endian. 229*5113495bSYour Name For each dword write (4 bytes), the byte 0 is swapped with 230*5113495bSYour Name byte 3 and byte 1 is swapped with byte 2. 231*5113495bSYour Name 232*5113495bSYour Name In case of gather field in first source ring entry of 233*5113495bSYour Name the gather copy cycle in taken into account. 234*5113495bSYour Name 235*5113495bSYour Name <legal all> 236*5113495bSYour Name */ 237*5113495bSYour Name #define CE_SRC_DESC_1_DEST_SWAP_OFFSET 0x00000004 238*5113495bSYour Name #define CE_SRC_DESC_1_DEST_SWAP_LSB 10 239*5113495bSYour Name #define CE_SRC_DESC_1_DEST_SWAP_MASK 0x00000400 240*5113495bSYour Name 241*5113495bSYour Name /* Description CE_SRC_DESC_1_GATHER 242*5113495bSYour Name 243*5113495bSYour Name Enables gather of multiple copy engine source 244*5113495bSYour Name descriptors to one destination. 245*5113495bSYour Name 246*5113495bSYour Name <legal all> 247*5113495bSYour Name */ 248*5113495bSYour Name #define CE_SRC_DESC_1_GATHER_OFFSET 0x00000004 249*5113495bSYour Name #define CE_SRC_DESC_1_GATHER_LSB 11 250*5113495bSYour Name #define CE_SRC_DESC_1_GATHER_MASK 0x00000800 251*5113495bSYour Name 252*5113495bSYour Name /* Description CE_SRC_DESC_1_CE_RES_0 253*5113495bSYour Name 254*5113495bSYour Name Reserved 255*5113495bSYour Name 256*5113495bSYour Name <legal all> 257*5113495bSYour Name */ 258*5113495bSYour Name #define CE_SRC_DESC_1_CE_RES_0_OFFSET 0x00000004 259*5113495bSYour Name #define CE_SRC_DESC_1_CE_RES_0_LSB 12 260*5113495bSYour Name #define CE_SRC_DESC_1_CE_RES_0_MASK 0x0000f000 261*5113495bSYour Name 262*5113495bSYour Name /* Description CE_SRC_DESC_1_LENGTH 263*5113495bSYour Name 264*5113495bSYour Name Length of the buffer in units of octets of the current 265*5113495bSYour Name descriptor 266*5113495bSYour Name 267*5113495bSYour Name <legal all> 268*5113495bSYour Name */ 269*5113495bSYour Name #define CE_SRC_DESC_1_LENGTH_OFFSET 0x00000004 270*5113495bSYour Name #define CE_SRC_DESC_1_LENGTH_LSB 16 271*5113495bSYour Name #define CE_SRC_DESC_1_LENGTH_MASK 0xffff0000 272*5113495bSYour Name 273*5113495bSYour Name /* Description CE_SRC_DESC_2_FW_METADATA 274*5113495bSYour Name 275*5113495bSYour Name Meta data used by FW 276*5113495bSYour Name 277*5113495bSYour Name In case of gather field in first source ring entry of 278*5113495bSYour Name the gather copy cycle in taken into account. 279*5113495bSYour Name 280*5113495bSYour Name <legal all> 281*5113495bSYour Name */ 282*5113495bSYour Name #define CE_SRC_DESC_2_FW_METADATA_OFFSET 0x00000008 283*5113495bSYour Name #define CE_SRC_DESC_2_FW_METADATA_LSB 0 284*5113495bSYour Name #define CE_SRC_DESC_2_FW_METADATA_MASK 0x0000ffff 285*5113495bSYour Name 286*5113495bSYour Name /* Description CE_SRC_DESC_2_CE_RES_1 287*5113495bSYour Name 288*5113495bSYour Name Reserved 289*5113495bSYour Name 290*5113495bSYour Name <legal all> 291*5113495bSYour Name */ 292*5113495bSYour Name #define CE_SRC_DESC_2_CE_RES_1_OFFSET 0x00000008 293*5113495bSYour Name #define CE_SRC_DESC_2_CE_RES_1_LSB 16 294*5113495bSYour Name #define CE_SRC_DESC_2_CE_RES_1_MASK 0xffff0000 295*5113495bSYour Name 296*5113495bSYour Name /* Description CE_SRC_DESC_3_CE_RES_2 297*5113495bSYour Name 298*5113495bSYour Name Reserved 299*5113495bSYour Name 300*5113495bSYour Name <legal all> 301*5113495bSYour Name */ 302*5113495bSYour Name #define CE_SRC_DESC_3_CE_RES_2_OFFSET 0x0000000c 303*5113495bSYour Name #define CE_SRC_DESC_3_CE_RES_2_LSB 0 304*5113495bSYour Name #define CE_SRC_DESC_3_CE_RES_2_MASK 0x000fffff 305*5113495bSYour Name 306*5113495bSYour Name /* Description CE_SRC_DESC_3_RING_ID 307*5113495bSYour Name 308*5113495bSYour Name The buffer pointer ring ID. 309*5113495bSYour Name 310*5113495bSYour Name 0 refers to the IDLE ring 311*5113495bSYour Name 312*5113495bSYour Name 1 - N refers to other rings 313*5113495bSYour Name 314*5113495bSYour Name 315*5113495bSYour Name 316*5113495bSYour Name Helps with debugging when dumping ring contents. 317*5113495bSYour Name 318*5113495bSYour Name <legal all> 319*5113495bSYour Name */ 320*5113495bSYour Name #define CE_SRC_DESC_3_RING_ID_OFFSET 0x0000000c 321*5113495bSYour Name #define CE_SRC_DESC_3_RING_ID_LSB 20 322*5113495bSYour Name #define CE_SRC_DESC_3_RING_ID_MASK 0x0ff00000 323*5113495bSYour Name 324*5113495bSYour Name /* Description CE_SRC_DESC_3_LOOPING_COUNT 325*5113495bSYour Name 326*5113495bSYour Name A count value that indicates the number of times the 327*5113495bSYour Name producer of entries into the Ring has looped around the 328*5113495bSYour Name ring. 329*5113495bSYour Name 330*5113495bSYour Name At initialization time, this value is set to 0. On the 331*5113495bSYour Name first loop, this value is set to 1. After the max value is 332*5113495bSYour Name reached allowed by the number of bits for this field, the 333*5113495bSYour Name count value continues with 0 again. 334*5113495bSYour Name 335*5113495bSYour Name In case SW is the consumer of the ring entries, it can 336*5113495bSYour Name use this field to figure out up to where the producer of 337*5113495bSYour Name entries has created new entries. This eliminates the need to 338*5113495bSYour Name check where the head pointer' of the ring is located once 339*5113495bSYour Name the SW starts processing an interrupt indicating that new 340*5113495bSYour Name entries have been put into this ring... 341*5113495bSYour Name 342*5113495bSYour Name Also note that SW if it wants only needs to look at the 343*5113495bSYour Name LSB bit of this count value. 344*5113495bSYour Name 345*5113495bSYour Name <legal all> 346*5113495bSYour Name */ 347*5113495bSYour Name #define CE_SRC_DESC_3_LOOPING_COUNT_OFFSET 0x0000000c 348*5113495bSYour Name #define CE_SRC_DESC_3_LOOPING_COUNT_LSB 28 349*5113495bSYour Name #define CE_SRC_DESC_3_LOOPING_COUNT_MASK 0xf0000000 350*5113495bSYour Name 351*5113495bSYour Name 352*5113495bSYour Name #endif // _CE_SRC_DESC_H_ 353