csl_udmap_tr.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2016-2019 Texas Instruments Incorporated.
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef CSL_UDMAP_TR_H_
#define CSL_UDMAP_TR_H_

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>

/* Windows Visual Studio build doesn't  __attribute__ indentifier, so forcing it be to dummy for getting build working */
#ifdef _MSC_VER
#ifndef __attribute__
#define __attribute__()
#endif
#endif

/*-----------------------------------------------------------------------------
 *  Transfer Request (TR) support
 *---------------------------------------------------------------------------*/

struct CSL_UdmapTR_t
{
    uint32_t flags;     
    uint16_t icnt0;     
    uint16_t icnt1;     
    uint64_t addr;      
    int32_t  dim1;      
    uint16_t icnt2;     
    uint16_t icnt3;     
    int32_t  dim2;      
    int32_t  dim3;      
    uint32_t fmtflags;  
    int32_t  ddim1;     
    uint64_t daddr;     
    int32_t  ddim2;     
    int32_t  ddim3;     
    uint16_t dicnt0;    
    uint16_t dicnt1;    
    uint16_t dicnt2;    
    uint16_t dicnt3;    
} __attribute__((__packed__));

typedef struct CSL_UdmapTR_t CSL_UdmapTR;

struct CSL_UdmapTR0_t
{
    uint32_t flags;     
    uint32_t icnt0;     
    uint64_t addr;      
} __attribute__((__packed__));

typedef struct CSL_UdmapTR0_t CSL_UdmapTR0;

struct CSL_UdmapTR1_t
{
    uint32_t flags;     
    uint16_t icnt0;     
    uint16_t icnt1;     
    uint64_t addr;      
    int32_t  dim1;      
} __attribute__((__packed__));

typedef struct CSL_UdmapTR1_t CSL_UdmapTR1;

struct CSL_UdmapTR2_t
{
    uint32_t flags;     
    uint16_t icnt0;     
    uint16_t icnt1;     
    uint64_t addr;      
    int32_t  dim1;      
    uint32_t icnt2;     
    int32_t  dim2;      
} __attribute__((__packed__));

typedef struct CSL_UdmapTR2_t CSL_UdmapTR2;

struct CSL_UdmapTR3_t
{
    uint32_t flags;     
    uint16_t icnt0;     
    uint16_t icnt1;     
    uint64_t addr;      
    int32_t  dim1;      
    uint16_t icnt2;     
    uint16_t icnt3;     
    int32_t  dim2;      
    int32_t  dim3;      
} __attribute__((__packed__));

typedef struct CSL_UdmapTR3_t CSL_UdmapTR3;

struct CSL_UdmapTR4_t
{
    uint32_t flags;     
    uint16_t icnt0;     
    uint16_t icnt1;     
    uint64_t addr;      
    int32_t  dim1;      
    uint16_t icnt2;     
    uint16_t icnt3;     
    int32_t  dim2;      
    int32_t  dim3;      
    uint32_t fmtflags;  
} __attribute__((__packed__));

typedef struct CSL_UdmapTR4_t CSL_UdmapTR4;

struct CSL_UdmapTR5_t
{
    uint32_t flags;     
    uint16_t icnt0;     
    uint16_t icnt1;     
    uint64_t addr;      
    int32_t  dim1;      
    uint16_t icnt2;     
    uint16_t icnt3;     
    int32_t  dim2;      
    int32_t  dim3;      
    uint32_t cacheflags;    
} __attribute__((__packed__));

typedef struct CSL_UdmapTR5_t CSL_UdmapTR5;

struct CSL_UdmapTR8_t
{
    uint32_t flags;     
    uint16_t icnt0;     
    uint16_t icnt1;     
    uint64_t addr;      
    int32_t  dim1;      
    uint16_t icnt2;     
    uint16_t icnt3;     
    int32_t  dim2;      
    int32_t  dim3;      
    uint32_t fmtflags;  
    int32_t  ddim1;     
    uint64_t daddr;     
    int32_t  ddim2;     
    int32_t  ddim3;     
} __attribute__((__packed__));

typedef struct CSL_UdmapTR8_t CSL_UdmapTR8;

struct CSL_UdmapTR9_t
{
    uint32_t flags;     
    uint16_t icnt0;     
    uint16_t icnt1;     
    uint64_t addr;      
    int32_t  dim1;      
    uint16_t icnt2;     
    uint16_t icnt3;     
    int32_t  dim2;      
    int32_t  dim3;      
    uint32_t fmtflags;  
    int32_t  ddim1;     
    uint64_t daddr;     
    int32_t  ddim2;     
    int32_t  ddim3;     
    uint16_t dicnt0;    
    uint16_t dicnt1;    
    uint16_t dicnt2;    
    uint16_t dicnt3;    
} __attribute__((__packed__));

typedef struct CSL_UdmapTR9_t CSL_UdmapTR9;

struct CSL_UdmapTR10_t
{
    uint32_t flags;     
    uint16_t icnt0;     
    uint16_t icnt1;     
    uint64_t addr;      
    int32_t  dim1;      
    uint32_t rsvd[3];   
    uint32_t fmtflags;  
    int32_t  ddim1;     
    uint64_t daddr;     
} __attribute__((__packed__));

typedef struct CSL_UdmapTR10_t CSL_UdmapTR10;

struct CSL_UdmapTR11_t
{
    uint32_t flags;     
    uint16_t icnt0;     
    uint16_t icnt1;     
    uint64_t addr;      
    int32_t  dim1;      
    uint32_t rsvd0[3];  
    uint32_t fmtflags;  
    int32_t  ddim1;     
    uint64_t daddr;     
    uint32_t rsvd1[2];  
    uint16_t dicnt0;    
    uint16_t dicnt1;    
} __attribute__((__packed__));

typedef struct CSL_UdmapTR11_t CSL_UdmapTR11;

struct CSL_UdmapTR15_t
{
    uint32_t flags;     
    uint16_t icnt0;     
    uint16_t icnt1;     
    uint64_t addr;      
    int32_t  dim1;      
    uint16_t icnt2;     
    uint16_t icnt3;     
    int32_t  dim2;      
    int32_t  dim3;      
    uint32_t fmtflags;  
    int32_t  ddim1;     
    uint64_t daddr;     
    int32_t  ddim2;     
    int32_t  ddim3;     
    uint16_t dicnt0;    
    uint16_t dicnt1;    
    uint16_t dicnt2;    
    uint16_t dicnt3;    
} __attribute__((__packed__));

typedef struct CSL_UdmapTR15_t CSL_UdmapTR15;

#define CSL_UDMAP_TR_FLAGS_TYPE_SHIFT                    ((uint32_t) 0U)
#define CSL_UDMAP_TR_FLAGS_TYPE_MASK                     (((uint32_t) 0xFU) << CSL_UDMAP_TR_FLAGS_TYPE_SHIFT)
#define CSL_UDMAP_TR_FLAGS_STATIC_SHIFT                  ((uint32_t) 4U)
#define CSL_UDMAP_TR_FLAGS_STATIC_MASK                   (((uint32_t) 1U) << CSL_UDMAP_TR_FLAGS_STATIC_SHIFT)
#define CSL_UDMAP_TR_FLAGS_WAIT_SHIFT                    ((uint32_t) 5U)
#define CSL_UDMAP_TR_FLAGS_WAIT_MASK                     (((uint32_t) 1U) << CSL_UDMAP_TR_FLAGS_WAIT_SHIFT)
#define CSL_UDMAP_TR_FLAGS_EVENT_SIZE_SHIFT              ((uint32_t) 6U)
#define CSL_UDMAP_TR_FLAGS_EVENT_SIZE_MASK               (((uint32_t) 3U) << CSL_UDMAP_TR_FLAGS_EVENT_SIZE_SHIFT)
#define CSL_UDMAP_TR_FLAGS_TRIGGER0_SHIFT                ((uint32_t) 8U)
#define CSL_UDMAP_TR_FLAGS_TRIGGER0_MASK                 (((uint32_t) 3U) << CSL_UDMAP_TR_FLAGS_TRIGGER0_SHIFT)
#define CSL_UDMAP_TR_FLAGS_TRIGGER0_TYPE_SHIFT           ((uint32_t) 10U)
#define CSL_UDMAP_TR_FLAGS_TRIGGER0_TYPE_MASK            (((uint32_t) 3U) << CSL_UDMAP_TR_FLAGS_TRIGGER0_TYPE_SHIFT)
#define CSL_UDMAP_TR_FLAGS_TRIGGER1_SHIFT                ((uint32_t) 12U)
#define CSL_UDMAP_TR_FLAGS_TRIGGER1_MASK                 (((uint32_t) 3U) << CSL_UDMAP_TR_FLAGS_TRIGGER1_SHIFT)
#define CSL_UDMAP_TR_FLAGS_TRIGGER1_TYPE_SHIFT           ((uint32_t) 14U)
#define CSL_UDMAP_TR_FLAGS_TRIGGER1_TYPE_MASK            (((uint32_t) 3U) << CSL_UDMAP_TR_FLAGS_TRIGGER1_TYPE_SHIFT)
#define CSL_UDMAP_TR_FLAGS_CMD_ID_SHIFT                  ((uint32_t) 16U)
#define CSL_UDMAP_TR_FLAGS_CMD_ID_MASK                   (((uint32_t) 0xFFU) << CSL_UDMAP_TR_FLAGS_CMD_ID_SHIFT)
#define CSL_UDMAP_TR_FLAGS_CFG_FLAGS_SHIFT               ((uint32_t) 24U)
#define CSL_UDMAP_TR_FLAGS_CFG_FLAGS_MASK                (((uint32_t) 0xFFU) << CSL_UDMAP_TR_FLAGS_CFG_FLAGS_SHIFT)
#define CSL_UDMAP_TR_FLAGS_SA_INDIRECT_SHIFT             ((uint32_t) 24U)
#define CSL_UDMAP_TR_FLAGS_SA_INDIRECT_MASK              (((uint32_t) 1U) << CSL_UDMAP_TR_FLAGS_SA_INDIRECT_SHIFT)
#define CSL_UDMAP_TR_FLAGS_DA_INDIRECT_SHIFT             ((uint32_t) 25U)
#define CSL_UDMAP_TR_FLAGS_DA_INDIRECT_MASK              (((uint32_t) 1U) << CSL_UDMAP_TR_FLAGS_DA_INDIRECT_SHIFT)
#define CSL_UDMAP_TR_FLAGS_SUPR_EVT_SHIFT                ((uint32_t) 26U)
#define CSL_UDMAP_TR_FLAGS_SUPR_EVT_MASK                 (((uint32_t) 1U) << CSL_UDMAP_TR_FLAGS_SUPR_EVT_SHIFT)
#define CSL_UDMAP_TR_FLAGS_EOL_SHIFT                     ((uint32_t) 28U)
#define CSL_UDMAP_TR_FLAGS_EOL_MASK                      (((uint32_t) 7U) << CSL_UDMAP_TR_FLAGS_EOL_SHIFT)
#define CSL_UDMAP_TR_FLAGS_EOP_SHIFT                     ((uint32_t) 31U)
#define CSL_UDMAP_TR_FLAGS_EOP_MASK                      (((uint32_t) 1U) << CSL_UDMAP_TR_FLAGS_EOP_SHIFT)
/* @} */

typedef uint32_t CSL_UdmapTrFlagsType;
#define CSL_UDMAP_TR_FLAGS_TYPE_1D_DATA_MOVE                        ((uint32_t) 0U)

#define CSL_UDMAP_TR_FLAGS_TYPE_2D_DATA_MOVE                        ((uint32_t) 1U)

#define CSL_UDMAP_TR_FLAGS_TYPE_3D_DATA_MOVE                        ((uint32_t) 2U)

#define CSL_UDMAP_TR_FLAGS_TYPE_4D_DATA_MOVE                        ((uint32_t) 3U)

#define CSL_UDMAP_TR_FLAGS_TYPE_4D_DATA_MOVE_FORMATTING             ((uint32_t) 4U)

#define CSL_UDMAP_TR_FLAGS_TYPE_4D_CACHE_WARM                       ((uint32_t) 5U)

#define CSL_UDMAP_TR_FLAGS_TYPE_4D_BLOCK_MOVE                       ((uint32_t) 8U)

#define CSL_UDMAP_TR_FLAGS_TYPE_4D_BLOCK_MOVE_REPACKING             ((uint32_t) 9U)

#define CSL_UDMAP_TR_FLAGS_TYPE_2D_BLOCK_MOVE                       ((uint32_t) 10U)

#define CSL_UDMAP_TR_FLAGS_TYPE_2D_BLOCK_MOVE_REPACKING             ((uint32_t) 11U)

#define CSL_UDMAP_TR_FLAGS_TYPE_4D_BLOCK_MOVE_REPACKING_INDIRECTION ((uint32_t) 15U)
/* @} */

typedef uint32_t CSL_UdmapTrFlagsEventSize;
#define CSL_UDMAP_TR_FLAGS_EVENT_SIZE_COMPLETION    ((uint32_t) 0U)

#define CSL_UDMAP_TR_FLAGS_EVENT_SIZE_ICNT1_DEC     ((uint32_t) 1U)

#define CSL_UDMAP_TR_FLAGS_EVENT_SIZE_ICNT2_DEC     ((uint32_t) 2U)

#define CSL_UDMAP_TR_FLAGS_EVENT_SIZE_ICNT3_DEC     ((uint32_t) 3U)
/* @} */

typedef uint32_t CSL_UdmapTrFlagsTrigger;
#define CSL_UDMAP_TR_FLAGS_TRIGGER_NONE             ((uint32_t) 0U)

#define CSL_UDMAP_TR_FLAGS_TRIGGER_GLOBAL0          ((uint32_t) 1U)

#define CSL_UDMAP_TR_FLAGS_TRIGGER_GLOBAL1          ((uint32_t) 2U)

#define CSL_UDMAP_TR_FLAGS_TRIGGER_LOCAL_EVENT      ((uint32_t) 3U)
/* @} */

typedef uint32_t CSL_UdmapTrFlagsTriggerType;
#define CSL_UDMAP_TR_FLAGS_TRIGGER_TYPE_ICNT1_DEC   ((uint32_t) 0U)

#define CSL_UDMAP_TR_FLAGS_TRIGGER_TYPE_ICNT2_DEC   ((uint32_t) 1U)

#define CSL_UDMAP_TR_FLAGS_TRIGGER_TYPE_ICNT3_DEC   ((uint32_t) 2U)

#define CSL_UDMAP_TR_FLAGS_TRIGGER_TYPE_ALL         ((uint32_t) 3U)
/* @} */

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SHIFT                ((uint32_t) 0U)
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_MASK                 (((uint32_t) 7U) << CSL_UDMAP_TR_FMTFLAGS_AMODE_SHIFT)
#define CSL_UDMAP_TR_FMTFLAGS_DIR_SHIFT                  ((uint32_t) 3U)
#define CSL_UDMAP_TR_FMTFLAGS_DIR_MASK                   (((uint32_t) 1U) << CSL_UDMAP_TR_FMTFLAGS_DIR_SHIFT)
#define CSL_UDMAP_TR_FMTFLAGS_ELYPE_SHIFT                ((uint32_t) 4U)
#define CSL_UDMAP_TR_FMTFLAGS_ELYPE_MASK                 (((uint32_t) 0xFU) << CSL_UDMAP_TR_FMTFLAGS_ELYPE_SHIFT)
#define CSL_UDMAP_TR_FMTFLAGS_DFMT_SHIFT                 ((uint32_t) 8U)
#define CSL_UDMAP_TR_FMTFLAGS_DFMT_MASK                  (((uint32_t) 0xFU) << CSL_UDMAP_TR_FMTFLAGS_DFMT_SHIFT)
#define CSL_UDMAP_TR_FMTFLAGS_SECTR_SHIFT                ((uint32_t) 12U)
#define CSL_UDMAP_TR_FMTFLAGS_SECTR_MASK                 (((uint32_t) 3U) << CSL_UDMAP_TR_FMTFLAGS_SECTR_SHIFT)
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK0_SHIFT  ((uint32_t) 16U)
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK0_MASK   (((uint32_t) 0xFU) << CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK0_SHIFT)
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK1_SHIFT  ((uint32_t) 20U)
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK1_MASK   (((uint32_t) 0xFU) << CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK1_SHIFT)
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AM0_SHIFT   ((uint32_t) 24U)
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AM0_MASK    (((uint32_t) 3U) << CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AM0_SHIFT)
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AM1_SHIFT   ((uint32_t) 26U)
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AM1_MASK    (((uint32_t) 3U) << CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AM1_SHIFT)
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AM2_SHIFT   ((uint32_t) 28U)
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AM2_MASK    (((uint32_t) 3U) << CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AM2_SHIFT)
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AM3_SHIFT   ((uint32_t) 30U)
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AM3_MASK    (((uint32_t) 3U) << CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AM3_SHIFT)
#define CSL_UDMAP_TR_CACHEFLAGS_CACHEID_SHIFT            ((uint32_t) 0U)
#define CSL_UDMAP_TR_CACHEFLAGS_CACHEID_MASK             (((uint32_t) 0xFFU) << CSL_UDMAP_TR_CACHEFLAGS_CACHEID_SHIFT)
#define CSL_UDMAP_TR_CACHEFLAGS_CACHEOP_SHIFT            ((uint32_t) 24U)
#define CSL_UDMAP_TR_CACHEFLAGS_CACHEOP_MASK             (((uint32_t) 0xFFU) << CSL_UDMAP_TR_CACHEFLAGS_CACHEOP_SHIFT)
/* @} */

typedef uint32_t CSL_UdmapTrFmtflagsAmode;
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_LINEAR          ((uint32_t) 0U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_CIRCULAR        ((uint32_t) 1U)
/* @} */

typedef uint32_t CSL_UdmapTrFmtflagsAmodeSpecificCbk;
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_512B   ((uint32_t) 0U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_1KB    ((uint32_t) 1U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_2KB    ((uint32_t) 2U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_4KB    ((uint32_t) 3U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_8KB    ((uint32_t) 4U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_16KB   ((uint32_t) 5U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_32KB   ((uint32_t) 6U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_64KB   ((uint32_t) 7U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_128KB  ((uint32_t) 8U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_256KB  ((uint32_t) 9U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_512KB  ((uint32_t) 10U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_1GB    ((uint32_t) 11U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_2GB    ((uint32_t) 12U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_4GB    ((uint32_t) 13U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_8GB    ((uint32_t) 14U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_CBK_16GB   ((uint32_t) 15U)
/* @} */

typedef uint32_t CSL_UdmapTrFmtflagsAmodeSpecificAmode;
#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AMODE_LINEAR   ((uint32_t) 0U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AMODE_CBK0     ((uint32_t) 1U)

#define CSL_UDMAP_TR_FMTFLAGS_AMODE_SPECIFIC_AMODE_CBK1     ((uint32_t) 2U)
/* @} */

typedef uint32_t CSL_UdmapTrFmtflagsDir;
#define CSL_UDMAP_TR_FMTFLAGS_DIR_SRC_USES_AMODE        ((uint32_t) 0U)

#define CSL_UDMAP_TR_FMTFLAGS_DIR_DST_USES_AMODE        ((uint32_t) 1U)
/* @} */

typedef uint32_t CSL_UdmapTrFmtflagsEltype;
#define CSL_UDMAP_TR_FMTFLAGS_ELYPE_1           ((uint32_t) 0U)

#define CSL_UDMAP_TR_FMTFLAGS_ELYPE_1p5         ((uint32_t) 1U)

#define CSL_UDMAP_TR_FMTFLAGS_ELYPE_2           ((uint32_t) 2U)

#define CSL_UDMAP_TR_FMTFLAGS_ELYPE_3           ((uint32_t) 3U)

#define CSL_UDMAP_TR_FMTFLAGS_ELYPE_4           ((uint32_t) 4U)

#define CSL_UDMAP_TR_FMTFLAGS_ELYPE_5           ((uint32_t) 5U)

#define CSL_UDMAP_TR_FMTFLAGS_ELYPE_16          ((uint32_t) 6U)

#define CSL_UDMAP_TR_FMTFLAGS_ELYPE_32          ((uint32_t) 7U)

#define CSL_UDMAP_TR_FMTFLAGS_ELYPE_1_2         ((uint32_t) 8U)

#define CSL_UDMAP_TR_FMTFLAGS_ELYPE_1p5_2       ((uint32_t) 9U)

#define CSL_UDMAP_TR_FMTFLAGS_ELYPE_2_1         ((uint32_t) 10U)

#define CSL_UDMAP_TR_FMTFLAGS_ELYPE_2_1p5       ((uint32_t) 11U)
/* @} */

typedef uint32_t CSL_UdmapTrFmtflagsDfmt;
#define CSL_UDMAP_TR_FMTFLAGS_DFMT_NO_CHANGE            ((uint32_t) 0U)

#define CSL_UDMAP_TR_FMTFLAGS_DFMT_CONSTANT_COPY        ((uint32_t) 1U)

#define CSL_UDMAP_TR_FMTFLAGS_DFMT_TRANSPOSE            ((uint32_t) 2U)

#define CSL_UDMAP_TR_FMTFLAGS_DFMT_REVERSE              ((uint32_t) 3U)

#define CSL_UDMAP_TR_FMTFLAGS_DFMT_REVERSE_TRANSPOSE    ((uint32_t) 4U)
/* @} */

typedef uint32_t CSL_UdmapTrCacheflagsOp;
#define CSL_UDMAP_TR_CACHEFLAGS_OP_PREWARM_CACHE        ((uint32_t) 0U)

#define CSL_UDMAP_TR_CACHEFLAGS_OP_PREWARM_MMU          ((uint32_t) 1U)
/* @} */

/*-----------------------------------------------------------------------------
 *  Secondary TR support
 *---------------------------------------------------------------------------*/
struct CSL_UdmapSecTR_t
{
    uint64_t addr;      
    uint32_t flags;     
    uint32_t data[13];  
} __attribute__((__packed__));

typedef struct CSL_UdmapSecTR_t CSL_UdmapSecTR;

#define CSL_UDMAP_SECTR_FLAGS_TYPE_SHIFT                 ((uint32_t) 0U)
#define CSL_UDMAP_SECTR_FLAGS_TYPE_MASK                  (((uint32_t) 0xFU) << CSL_UDMAP_SECTR_FLAGS_TYPE_SHIFT)
#define CSL_UDMAP_SECTR_FLAGS_TYPE_SPECIFIC_SHIFT        ((uint32_t) 4U)
#define CSL_UDMAP_SECTR_FLAGS_TYPE_SPECIFIC_MASK         (((uint32_t) 0xFFFFFFF0U) << CSL_UDMAP_SECTR_FLAGS_TYPE_SPECIFIC_SHIFT)
/* @} */

typedef uint32_t CSL_UdmapTrFmtflagsSectr;
#define CSL_UDMAP_TR_FMTFLAGS_SECTR_NONE        ((uint32_t) 0U)

#define CSL_UDMAP_TR_FMTFLAGS_SECTR_64          ((uint32_t) 1U)

#define CSL_UDMAP_TR_FMTFLAGS_SECTR_128         ((uint32_t) 2U)
/* @} */

/*-----------------------------------------------------------------------------
 *  TR response support
 *---------------------------------------------------------------------------*/
struct CSL_UdmapTrResponse_t
{
    uint32_t flags;     
} __attribute__((__packed__));

typedef struct CSL_UdmapTrResponse_t CSL_UdmapTrResponse;

#define CSL_UDMAP_TR_RESPONSE_STATUS_TYPE_SHIFT          ((uint32_t) 0U)
#define CSL_UDMAP_TR_RESPONSE_STATUS_TYPE_MASK           (((uint32_t) 0xFU) << CSL_UDMAP_TR_RESPONSE_STATUS_TYPE_SHIFT)
#define CSL_UDMAP_TR_RESPONSE_STATUS_INFO_SHIFT          ((uint32_t) 4U)
#define CSL_UDMAP_TR_RESPONSE_STATUS_INFO_MASK           (((uint32_t) 0xFU) << CSL_UDMAP_TR_RESPONSE_STATUS_INFO_SHIFT)
#define CSL_UDMAP_TR_RESPONSE_CMDID_SHIFT                ((uint32_t) 16U)
#define CSL_UDMAP_TR_RESPONSE_CMDID_MASK                 (((uint32_t) 0xFFU) << CSL_UDMAP_TR_RESPONSE_CMDID_SHIFT)
#define CSL_UDMAP_TR_RESPONSE_CFG_SPECIFIC_SHIFT         ((uint32_t) 24U)
#define CSL_UDMAP_TR_RESPONSE_CFG_SPECIFIC_MASK          (((uint32_t) 0xFFU) << CSL_UDMAP_TR_RESPONSE_CFG_SPECIFIC_SHIFT)
/* @} */

typedef uint32_t CSL_UdmapTrResponseStatus;
#define CSL_UDMAP_TR_RESPONSE_STATUS_COMPLETE           ((uint32_t) 0U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_TRANSFER_ERR       ((uint32_t) 1U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_ABORTED_ERR        ((uint32_t) 2U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_SUBMISSION_ERR     ((uint32_t) 3U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_UNSUPPORTED_ERR    ((uint32_t) 4U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_TRANSFER_EXCEP_ERR ((uint32_t) 5U)
/* @} */

typedef uint32_t CSL_UdmapTrResponseStatusSubmission;
#define CSL_UDMAP_TR_RESPONSE_STATUS_SUBMISSION_ICNT0       ((uint32_t) 0U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_SUBMISSION_FIFO_FULL   ((uint32_t) 1U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_SUBMISSION_OWN         ((uint32_t) 2U)
/* @} */

typedef uint32_t CSL_UdmapTrResponseStatusUnsupported;
#define CSL_UDMAP_TR_RESPONSE_STATUS_UNSUPPORTED_TR_TYPE        ((uint32_t) 0U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_UNSUPPORTED_STATIC         ((uint32_t) 1U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_UNSUPPORTED_EOL            ((uint32_t) 2U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_UNSUPPORTED_CFG_SPECIFIC   ((uint32_t) 3U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_UNSUPPORTED_AMODE          ((uint32_t) 4U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_UNSUPPORTED_ELTYPE         ((uint32_t) 5U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_UNSUPPORTED_DFMT           ((uint32_t) 6U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_UNSUPPORTED_SECTR          ((uint32_t) 7U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_UNSUPPORTED_AMODE_SPECIFIC ((uint32_t) 8U)
/* @} */


#define CSL_UDMAP_TR_RESPONSE_STATUS_TRANSFER_EXCEP_SHORT_PACKET ((uint32_t) 0U)

#define CSL_UDMAP_TR_RESPONSE_STATUS_TRANSFER_EXCEP_LONG_PACKET  ((uint32_t) 1U)
/* @} */

typedef uint32_t CSL_UdmapTrFlagsEol;
#define CSL_UDMAP_TR_FLAGS_EOL_MATCH_SOL_EOL                    ((uint32_t) 0U)

#define CSL_UDMAP_TR_FLAGS_EOL_ICNT0                            ((uint32_t) 1U)

#define CSL_UDMAP_TR_FLAGS_EOL_ICNT0_ICNT1                      ((uint32_t) 2U)

#define CSL_UDMAP_TR_FLAGS_EOL_ICNT0_ICNT1_ICNT2                ((uint32_t) 3U)

#define CSL_UDMAP_TR_FLAGS_EOL_ICNT0_ICNT1_ICNT2_ICNT3          ((uint32_t) 4U)

#define CSL_UDMAP_TR_FLAGS_EOL_RESERVED                         ((uint32_t) 5U)
/* @} */

static inline CSL_UdmapTrResponseStatus CSL_udmapTrResponseGetStatusType( const CSL_UdmapTrResponse *pTrResponse )
{
    return (CSL_UdmapTrResponseStatus)CSL_FEXT( pTrResponse->flags, UDMAP_TR_RESPONSE_STATUS_TYPE );
}

/*-----------------------------------------------------------------------------
 *  Teardown response support
 *---------------------------------------------------------------------------*/
struct CSL_UdmapTdResponse_t
{
    uint32_t tdIndicator;
    uint32_t chId;
    uint32_t forced;
} __attribute__((__packed__));

typedef struct CSL_UdmapTdResponse_t CSL_UdmapTdResponse;

#define CSL_UDMAP_TD_RESPONSE_TD_INDICATOR_SHIFT    ((uint32_t) 0U)
#define CSL_UDMAP_TD_RESPONSE_TD_INDICATOR_MASK     (((uint32_t) 0xFU) << CSL_UDMAP_TD_RESPONSE_TD_INDICATOR_SHIFT)
#define CSL_UDMAP_TD_RESPONSE_CHAN_ID_SHIFT         ((uint32_t) 4U)
#define CSL_UDMAP_TD_RESPONSE_CHAN_ID_MASK          (((uint32_t) 0x3FFU) << CSL_UDMAP_TD_RESPONSE_CHAN_ID_SHIFT)
#define CSL_UDMAP_TD_RESPONSE_FORCED_SHIFT          ((uint32_t) 31U)
#define CSL_UDMAP_TD_RESPONSE_FORCED_MASK           (((uint32_t) 0x1U) << CSL_UDMAP_TD_RESPONSE_FORCED_SHIFT)
/* @} */

static inline void CSL_udmapGetTdResponse(uint64_t tdResponseWord,
                                          CSL_UdmapTdResponse *pTdResponse);
static inline void CSL_udmapGetTdResponse(uint64_t tdResponseWord,
                                          CSL_UdmapTdResponse *pTdResponse)
{
    if(NULL != pTdResponse)
    {
        uint32_t tdResponseWordLow = (uint32_t)tdResponseWord;

        pTdResponse->tdIndicator = CSL_FEXT(tdResponseWordLow, UDMAP_TD_RESPONSE_TD_INDICATOR);
        pTdResponse->chId = CSL_FEXT(tdResponseWordLow, UDMAP_TD_RESPONSE_CHAN_ID);
        pTdResponse->forced = CSL_FEXT(tdResponseWordLow, UDMAP_TD_RESPONSE_FORCED);
    }
}

#ifdef __cplusplus
}
#endif

#endif  /* #ifndef CSL_UDMAP_TR_H_ */