sdl_ip_rat.h

Go to the documentation of this file.

#ifndef SDL_IP_RAT_H_
#define SDL_IP_RAT_H_


#include <sdl_types.h>
#include <tistdtypes.h>
#include <stdint.h>
#include <stdbool.h>
#include <src/sdl/hw_types.h>
#include <src/sdl/sdlr.h>


#ifdef __cplusplus
extern "C"
{
#endif

/**************************************************************************
* RAT static Registers Structure
**************************************************************************/

typedef struct {
    volatile uint32_t RAT_CTRL_k;                      /* Region Control Register */
    volatile uint32_t RAT_BASE_k;                      /* Region Base Register */
    volatile uint32_t RAT_TRANS_L_k;                   /* Region Translated Lower Address */
    volatile uint32_t RAT_TRANS_U_k;                   /* Region Translated Upper Address */
    volatile uint32_t RAT_EXCEPTION_LOGGING_CONTROL;   /* RAT Error Log control register */
    volatile uint32_t RAT_EXCEPTION_ENABLE_SET;        /* RAT Exception Logging Interrupt Enable Set Register */
} SDL_ratStaticRegs;

/**************************************************************************
* Register Overlay Structure
**************************************************************************/

typedef struct {
    volatile uint32_t CTRL;                      /* Region Control Register */
    volatile uint32_t BASE;                      /* Region Base Register */
    volatile uint32_t TRANS_L;                   /* Region Translated Lower Address */
    volatile uint32_t TRANS_U;                   /* Region Translated Upper Address */
} SDL_ratRegs_region;

typedef struct
{
    uint32_t    baseAddress;
    uint64_t    sizeInBytes;
    uint64_t    translatedAddress;
} SDL_ratTranslationCfgInfo;


typedef struct {
    volatile uint32_t PID;                       /* Revision Register */
    volatile uint32_t CONFIG;                    /* Config Register */
    volatile uint8_t  Resv_32[24];
    SDL_ratRegs_region REGION[16];
    volatile uint8_t  Resv_2052[1764];
    volatile uint32_t DESTINATION_ID;            /* Destination ID Register */
    volatile uint8_t  Resv_2080[24];
    volatile uint32_t EXCEPTION_LOGGING_CONTROL;   /* Exception Logging Control Register */
    volatile uint32_t EXCEPTION_LOGGING_HEADER0;   /* Exception Logging Header 0 Register */
    volatile uint32_t EXCEPTION_LOGGING_HEADER1;   /* Exception Logging Header 1 Register */
    volatile uint32_t EXCEPTION_LOGGING_DATA0;   /* Exception Logging Data 0 Register */
    volatile uint32_t EXCEPTION_LOGGING_DATA1;   /* Exception Logging Data 1 Register */
    volatile uint32_t EXCEPTION_LOGGING_DATA2;   /* Exception Logging Data 2 Register */
    volatile uint32_t EXCEPTION_LOGGING_DATA3;   /* Exception Logging Data 3 Register */
    volatile uint8_t  Resv_2112[4];
    volatile uint32_t EXCEPTION_PEND_SET;        /* Exception Logging Interrupt Pending Set Register */
    volatile uint32_t EXCEPTION_PEND_CLEAR;      /* Exception Logging Interrupt Pending Clear Register */
    volatile uint32_t EXCEPTION_ENABLE_SET;      /* Exception Logging Interrupt Enable Set Register */
    volatile uint32_t EXCEPTION_ENABLE_CLEAR;    /* Exception Logging Interrupt Enable Clear Register */
    volatile uint32_t EOI_REG;                   /* EOI Register */
} SDL_ratRegs;


/**************************************************************************
* Register Macros
**************************************************************************/

#define SDL_RAT_PID                                                            (0x00000000U)
#define SDL_RAT_CONFIG                                                         (0x00000004U)
#define SDL_RAT_REGION_CTRL(REGION)                                            (0x00000020U+((REGION)*0x10U))
#define SDL_RAT_REGION_BASE(REGION)                                            (0x00000024U+((REGION)*0x10U))
#define SDL_RAT_REGION_TRANS_L(REGION)                                         (0x00000028U+((REGION)*0x10U))
#define SDL_RAT_REGION_TRANS_U(REGION)                                         (0x0000002CU+((REGION)*0x10U))
#define SDL_RAT_DESTINATION_ID                                                 (0x00000804U)
#define SDL_RAT_EXCEPTION_LOGGING_CONTROL                                      (0x00000820U)
#define SDL_RAT_EXCEPTION_LOGGING_HEADER0                                      (0x00000824U)
#define SDL_RAT_EXCEPTION_LOGGING_HEADER1                                      (0x00000828U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA0                                        (0x0000082CU)
#define SDL_RAT_EXCEPTION_LOGGING_DATA1                                        (0x00000830U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2                                        (0x00000834U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA3                                        (0x00000838U)
#define SDL_RAT_EXCEPTION_PEND_SET                                             (0x00000840U)
#define SDL_RAT_EXCEPTION_PEND_CLEAR                                           (0x00000844U)
#define SDL_RAT_EXCEPTION_ENABLE_SET                                           (0x00000848U)
#define SDL_RAT_EXCEPTION_ENABLE_CLEAR                                         (0x0000084CU)
#define SDL_RAT_EOI_REG                                                        (0x00000850U)

/**************************************************************************
* Field Definition Macros
**************************************************************************/


/* CTRL */

#define SDL_RAT_REGION_CTRL_EN_MASK                                            (0x80000000U)
#define SDL_RAT_REGION_CTRL_EN_SHIFT                                           (0x0000001FU)
#define SDL_RAT_REGION_CTRL_EN_MAX                                             (0x00000001U)

#define SDL_RAT_REGION_CTRL_SIZE_MASK                                          (0x0000003FU)
#define SDL_RAT_REGION_CTRL_SIZE_SHIFT                                         (0x00000000U)
#define SDL_RAT_REGION_CTRL_SIZE_MAX                                           (0x0000003FU)

/* BASE */

#define SDL_RAT_REGION_BASE_BASE_MASK                                          (0xFFFFFFFFU)
#define SDL_RAT_REGION_BASE_BASE_SHIFT                                         (0x00000000U)
#define SDL_RAT_REGION_BASE_BASE_MAX                                           (0xFFFFFFFFU)

/* TRANS_L */

#define SDL_RAT_REGION_TRANS_L_LOWER_MASK                                      (0xFFFFFFFFU)
#define SDL_RAT_REGION_TRANS_L_LOWER_SHIFT                                     (0x00000000U)
#define SDL_RAT_REGION_TRANS_L_LOWER_MAX                                       (0xFFFFFFFFU)

/* TRANS_U */

#define SDL_RAT_REGION_TRANS_U_UPPER_MASK                                      (0x0000FFFFU)
#define SDL_RAT_REGION_TRANS_U_UPPER_SHIFT                                     (0x00000000U)
#define SDL_RAT_REGION_TRANS_U_UPPER_MAX                                       (0x0000FFFFU)

/* PID */

#define SDL_RAT_PID_MINOR_MASK                                                 (0x0000003FU)
#define SDL_RAT_PID_MINOR_SHIFT                                                (0x00000000U)
#define SDL_RAT_PID_MINOR_MAX                                                  (0x0000003FU)

#define SDL_RAT_PID_CUSTOM_MASK                                                (0x000000C0U)
#define SDL_RAT_PID_CUSTOM_SHIFT                                               (0x00000006U)
#define SDL_RAT_PID_CUSTOM_MAX                                                 (0x00000003U)

#define SDL_RAT_PID_MAJOR_MASK                                                 (0x00000700U)
#define SDL_RAT_PID_MAJOR_SHIFT                                                (0x00000008U)
#define SDL_RAT_PID_MAJOR_MAX                                                  (0x00000007U)

#define SDL_RAT_PID_RTL_MASK                                                   (0x0000F800U)
#define SDL_RAT_PID_RTL_SHIFT                                                  (0x0000000BU)
#define SDL_RAT_PID_RTL_MAX                                                    (0x0000001FU)

#define SDL_RAT_PID_FUNC_MASK                                                  (0x0FFF0000U)
#define SDL_RAT_PID_FUNC_SHIFT                                                 (0x00000010U)
#define SDL_RAT_PID_FUNC_MAX                                                   (0x00000FFFU)

#define SDL_RAT_PID_BU_MASK                                                    (0x30000000U)
#define SDL_RAT_PID_BU_SHIFT                                                   (0x0000001CU)
#define SDL_RAT_PID_BU_MAX                                                     (0x00000003U)

#define SDL_RAT_PID_SCHEME_MASK                                                (0xC0000000U)
#define SDL_RAT_PID_SCHEME_SHIFT                                               (0x0000001EU)
#define SDL_RAT_PID_SCHEME_MAX                                                 (0x00000003U)

/* CONFIG */

#define SDL_RAT_CONFIG_REGIONS_MASK                                            (0x000000FFU)
#define SDL_RAT_CONFIG_REGIONS_SHIFT                                           (0x00000000U)
#define SDL_RAT_CONFIG_REGIONS_MAX                                             (0x000000FFU)

#define SDL_RAT_CONFIG_ADDRS_MASK                                              (0x0000FF00U)
#define SDL_RAT_CONFIG_ADDRS_SHIFT                                             (0x00000008U)
#define SDL_RAT_CONFIG_ADDRS_MAX                                               (0x000000FFU)

#define SDL_RAT_CONFIG_ADDR_WIDTH_MASK                                         (0x00FF0000U)
#define SDL_RAT_CONFIG_ADDR_WIDTH_SHIFT                                        (0x00000010U)
#define SDL_RAT_CONFIG_ADDR_WIDTH_MAX                                          (0x000000FFU)

/* DESTINATION_ID */

#define SDL_RAT_DESTINATION_ID_DEST_ID_MASK                                    (0x000000FFU)
#define SDL_RAT_DESTINATION_ID_DEST_ID_SHIFT                                   (0x00000000U)
#define SDL_RAT_DESTINATION_ID_DEST_ID_MAX                                     (0x000000FFU)

/* EXCEPTION_LOGGING_CONTROL */

#define SDL_RAT_EXCEPTION_LOGGING_CONTROL_DISABLE_F_MASK                       (0x00000001U)
#define SDL_RAT_EXCEPTION_LOGGING_CONTROL_DISABLE_F_SHIFT                      (0x00000000U)
#define SDL_RAT_EXCEPTION_LOGGING_CONTROL_DISABLE_F_MAX                        (0x00000001U)

#define SDL_RAT_EXCEPTION_LOGGING_CONTROL_DISABLE_INTR_MASK                    (0x00000002U)
#define SDL_RAT_EXCEPTION_LOGGING_CONTROL_DISABLE_INTR_SHIFT                   (0x00000001U)
#define SDL_RAT_EXCEPTION_LOGGING_CONTROL_DISABLE_INTR_MAX                     (0x00000001U)

/* EXCEPTION_LOGGING_HEADER0 */

#define SDL_RAT_EXCEPTION_LOGGING_HEADER0_DEST_ID_MASK                         (0x000000FFU)
#define SDL_RAT_EXCEPTION_LOGGING_HEADER0_DEST_ID_SHIFT                        (0x00000000U)
#define SDL_RAT_EXCEPTION_LOGGING_HEADER0_DEST_ID_MAX                          (0x000000FFU)

#define SDL_RAT_EXCEPTION_LOGGING_HEADER0_SRC_ID_MASK                          (0x00FFFF00U)
#define SDL_RAT_EXCEPTION_LOGGING_HEADER0_SRC_ID_SHIFT                         (0x00000008U)
#define SDL_RAT_EXCEPTION_LOGGING_HEADER0_SRC_ID_MAX                           (0x0000FFFFU)

#define SDL_RAT_EXCEPTION_LOGGING_HEADER0_TYPE_F_MASK                          (0xFF000000U)
#define SDL_RAT_EXCEPTION_LOGGING_HEADER0_TYPE_F_SHIFT                         (0x00000018U)
#define SDL_RAT_EXCEPTION_LOGGING_HEADER0_TYPE_F_MAX                           (0x000000FFU)

/* EXCEPTION_LOGGING_HEADER1 */

#define SDL_RAT_EXCEPTION_LOGGING_HEADER1_CODE_MASK                            (0x00FF0000U)
#define SDL_RAT_EXCEPTION_LOGGING_HEADER1_CODE_SHIFT                           (0x00000010U)
#define SDL_RAT_EXCEPTION_LOGGING_HEADER1_CODE_MAX                             (0x000000FFU)

#define SDL_RAT_EXCEPTION_LOGGING_HEADER1_GROUP_MASK                           (0xFF000000U)
#define SDL_RAT_EXCEPTION_LOGGING_HEADER1_GROUP_SHIFT                          (0x00000018U)
#define SDL_RAT_EXCEPTION_LOGGING_HEADER1_GROUP_MAX                            (0x000000FFU)

/* EXCEPTION_LOGGING_DATA0 */

#define SDL_RAT_EXCEPTION_LOGGING_DATA0_ADDR_L_MASK                            (0xFFFFFFFFU)
#define SDL_RAT_EXCEPTION_LOGGING_DATA0_ADDR_L_SHIFT                           (0x00000000U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA0_ADDR_L_MAX                             (0xFFFFFFFFU)

/* EXCEPTION_LOGGING_DATA1 */

#define SDL_RAT_EXCEPTION_LOGGING_DATA1_ADDR_H_MASK                            (0x0000FFFFU)
#define SDL_RAT_EXCEPTION_LOGGING_DATA1_ADDR_H_SHIFT                           (0x00000000U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA1_ADDR_H_MAX                             (0x0000FFFFU)

/* EXCEPTION_LOGGING_DATA2 */

#define SDL_RAT_EXCEPTION_LOGGING_DATA2_PRIV_ID_MASK                           (0x000000FFU)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_PRIV_ID_SHIFT                          (0x00000000U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_PRIV_ID_MAX                            (0x000000FFU)

#define SDL_RAT_EXCEPTION_LOGGING_DATA2_SECURE_MASK                            (0x00000100U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_SECURE_SHIFT                           (0x00000008U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_SECURE_MAX                             (0x00000001U)

#define SDL_RAT_EXCEPTION_LOGGING_DATA2_PRIV_MASK                              (0x00000200U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_PRIV_SHIFT                             (0x00000009U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_PRIV_MAX                               (0x00000001U)

#define SDL_RAT_EXCEPTION_LOGGING_DATA2_CACHEABLE_MASK                         (0x00000400U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_CACHEABLE_SHIFT                        (0x0000000AU)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_CACHEABLE_MAX                          (0x00000001U)

#define SDL_RAT_EXCEPTION_LOGGING_DATA2_DEBUG_MASK                             (0x00000800U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_DEBUG_SHIFT                            (0x0000000BU)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_DEBUG_MAX                              (0x00000001U)

#define SDL_RAT_EXCEPTION_LOGGING_DATA2_READ_MASK                              (0x00001000U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_READ_SHIFT                             (0x0000000CU)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_READ_MAX                               (0x00000001U)

#define SDL_RAT_EXCEPTION_LOGGING_DATA2_WRITE_MASK                             (0x00002000U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_WRITE_SHIFT                            (0x0000000DU)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_WRITE_MAX                              (0x00000001U)

#define SDL_RAT_EXCEPTION_LOGGING_DATA2_ROUTEID_MASK                           (0x0FFF0000U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_ROUTEID_SHIFT                          (0x00000010U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA2_ROUTEID_MAX                            (0x00000FFFU)

/* EXCEPTION_LOGGING_DATA3 */

#define SDL_RAT_EXCEPTION_LOGGING_DATA3_BYTECNT_MASK                           (0x000003FFU)
#define SDL_RAT_EXCEPTION_LOGGING_DATA3_BYTECNT_SHIFT                          (0x00000000U)
#define SDL_RAT_EXCEPTION_LOGGING_DATA3_BYTECNT_MAX                            (0x000003FFU)

/* EXCEPTION_PEND_SET */

#define SDL_RAT_EXCEPTION_PEND_SET_PEND_SET_MASK                               (0x00000001U)
#define SDL_RAT_EXCEPTION_PEND_SET_PEND_SET_SHIFT                              (0x00000000U)
#define SDL_RAT_EXCEPTION_PEND_SET_PEND_SET_MAX                                (0x00000001U)

/* EXCEPTION_PEND_CLEAR */

#define SDL_RAT_EXCEPTION_PEND_CLEAR_PEND_CLR_MASK                             (0x00000001U)
#define SDL_RAT_EXCEPTION_PEND_CLEAR_PEND_CLR_SHIFT                            (0x00000000U)
#define SDL_RAT_EXCEPTION_PEND_CLEAR_PEND_CLR_MAX                              (0x00000001U)

/* EXCEPTION_ENABLE_SET */

#define SDL_RAT_EXCEPTION_ENABLE_SET_ENABLE_SET_MASK                           (0x00000001U)
#define SDL_RAT_EXCEPTION_ENABLE_SET_ENABLE_SET_SHIFT                          (0x00000000U)
#define SDL_RAT_EXCEPTION_ENABLE_SET_ENABLE_SET_MAX                            (0x00000001U)

/* EXCEPTION_ENABLE_CLEAR */

#define SDL_RAT_EXCEPTION_ENABLE_CLEAR_ENABLE_CLR_MASK                         (0x00000001U)
#define SDL_RAT_EXCEPTION_ENABLE_CLEAR_ENABLE_CLR_SHIFT                        (0x00000000U)
#define SDL_RAT_EXCEPTION_ENABLE_CLEAR_ENABLE_CLR_MAX                          (0x00000001U)

/* EOI_REG */

#define SDL_RAT_EOI_REG_EOI_WR_MASK                                            (0x0000FFFFU)
#define SDL_RAT_EOI_REG_EOI_WR_SHIFT                                           (0x00000000U)
#define SDL_RAT_EOI_REG_EOI_WR_MAX                                             (0x0000FFFFU)

typedef uint32_t SDL_RAT_intrSrcTypes;
#define SDL_RAT_INTR_SRC_EXCEPTION  ((uint32_t) 0U)

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

typedef struct
{
    uint32_t    type;
    uint64_t    address;
    uint32_t    group;
    uint32_t    code;
    uint32_t    srcId;
    uint32_t    destId;
    uint32_t    routeId;
    uint32_t    privId;
    uint32_t    byteCnt;
    bool        bWrite;
    bool        bRead;
    bool        bDebug;
    bool        bCacheable;
    bool        bPriv;
    bool        bSecure;
} SDL_ratExceptionInfo;

/**************************************************************************
* @brief Below are low level function declarations for rat module
**************************************************************************/

int32_t  SDL_RAT_getRegionTranslationConfig(const SDL_ratRegs *pRatRegs, uint32_t regionIndex,
                                            SDL_ratTranslationCfgInfo *pTranslationCfg);
uint32_t SDL_RAT_lmo(uint64_t v);
int32_t  SDL_RAT_setRegionTranslationEnable(SDL_ratRegs *pRatRegs, uint32_t regionIndex, bool bEnable);
void     SDL_RAT_setIntEnable(SDL_ratRegs *pRatRegs, SDL_RAT_intrSrcTypes intrSrc, bool bEnable);
void     SDL_RAT_setExceptionLoggingEnable(SDL_ratRegs *pRatRegs, bool bEnable);
void     SDL_RAT_setExceptionLoggingIntEnable(SDL_ratRegs *pRatRegs, bool bEnable);
int32_t  SDL_RAT_isPowerOf2(uint64_t v);
int32_t  SDL_RAT_isRegionOverlap(const SDL_ratRegs *pRatRegs, uint32_t thisRegionIndex,
                                 const SDL_ratTranslationCfgInfo *pTranslationCfg);
int32_t  SDL_RAT_validateTranslationConfig(const SDL_ratRegs *pRatRegs, uint32_t regionIndex,
                                           SDL_ratTranslationCfgInfo *pTranslationCfg);
int32_t  SDL_RAT_isRegionTranslationEnabled(const SDL_ratRegs *pRatRegs, uint32_t regionIndex);

uint32_t SDL_RAT_getMaxRegions(const SDL_ratRegs *pRatRegs);

#endif