sdlr_esm.h

Go to the documentation of this file.

/*
 * Copyright (C) 2024 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 SDLR_ESM_H_
#define SDLR_ESM_H_
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include <stdint.h>
 
/**************************************************************************
* Module Base Offset Values
**************************************************************************/
 
#define SDL_ESM_REGS_BASE                                                      (0x00000000U)
 
 
/**************************************************************************
* Hardware Region  : ESM Registers
**************************************************************************/
 
 
/**************************************************************************
* Register Overlay Structure
**************************************************************************/
 
typedef struct {
    volatile uint32_t RAW;                       /* Config Error Raw Status/Set Register */
    volatile uint32_t STS;                       /* Level Error Interrupt Enable Status/Clear Register */
    volatile uint32_t INTR_EN_SET;               /* Level Error Interrutp Enable Set Register */
    volatile uint32_t INTR_EN_CLR;               /* Level Error Interrupt Enabled Clear Register */
    volatile uint32_t INT_PRIO;                  /* Level Error Interrupt Priority Register */
    volatile uint32_t PIN_EN_SET;                /* Level Error Interrupt Pin Influence Set Register */
    volatile uint32_t PIN_EN_CLR;                /* Level Error Interrupt Pin Influence Clear Register */
    volatile uint8_t  Resv_32[4];                /* 0x1C is reserved */
} SDL_esmRegs_ERR_GRP;
 
typedef struct {
    volatile uint32_t CRI_EN_SET;               /* Level Critical Priority Interrupt Enabled Clear Register */
    volatile uint32_t CRI_EN_CLR;               /* Level Critical Priority Interrupt Enabled Clear Register */
    volatile uint8_t  Resv_32[24];
} SDL_esmRegs_ERR_EXT_GRP;
 
 
typedef struct {
    volatile uint32_t PID;                       /* Revision Register */
    volatile uint32_t INFO;                      /* Info Register */
    volatile uint32_t EN;                        /* Global Enable Register */
    volatile uint32_t SFT_RST;                   /* Global Soft Reset Register */
    volatile uint32_t ERR_RAW;                   /* Config Error Raw Status/Set Register */
    volatile uint32_t ERR_STS;                   /* Config Error Interrupt Enable Status/Clear Register */
    volatile uint32_t ERR_EN_SET;                /* Config Error Interrutp Enable Set Register */
    volatile uint32_t ERR_EN_CLR;                /* Config Error Interrupt Enabled Clear Register */
    volatile uint32_t LOW_PRI;                   /* Low Priority Prioritized Register */
    volatile uint32_t HI_PRI;                    /* High Priority Prioritized Register */
    volatile uint32_t LOW;                       /* Low Priority Interrupt Status Register */
    volatile uint32_t HI;                        /* High Priority Interrupt Status Register */
    volatile uint32_t EOI;                       /* EOI Interrupt Register */
    volatile uint8_t  Resv_64[12];
    volatile uint32_t PIN_CTRL;                  /* Error Pin Control Register */
    volatile uint32_t PIN_STS;                   /* Error Pin Status Register */
    volatile uint32_t PIN_CNTR;                  /* Error Counter Value Register */
    volatile uint32_t PIN_CNTR_PRE;              /* Error Counter Value Pre-Load Register */
    volatile uint32_t PWMH_PIN_CNTR;             /* Error PWM High Counter Value Register */
    volatile uint32_t PWMH_PIN_CNTR_PRE;         /* Error PWM High Counter Value Pre-Load Register */
    volatile uint32_t PWML_PIN_CNTR;             /* Error PWM Low Counter Value Register */
    volatile uint32_t PWML_PIN_CNTR_PRE;         /* Error PWM Low Counter Value Pre-Load Register */
    volatile uint8_t  Resv_1024[928];
    SDL_esmRegs_ERR_GRP ERR_GRP[32];
    SDL_esmRegs_ERR_EXT_GRP ERR_EXT_GRP[32];
} SDL_esmRegs;
 
 
/**************************************************************************
* Register Macros
**************************************************************************/
 
#define SDL_ESM_PID                                                            (0x00000000U)
#define SDL_ESM_INFO                                                           (0x00000004U)
#define SDL_ESM_EN                                                             (0x00000008U)
#define SDL_ESM_SFT_RST                                                        (0x0000000CU)
#define SDL_ESM_ERR_RAW                                                        (0x00000010U)
#define SDL_ESM_ERR_STS                                                        (0x00000014U)
#define SDL_ESM_ERR_EN_SET                                                     (0x00000018U)
#define SDL_ESM_ERR_EN_CLR                                                     (0x0000001CU)
#define SDL_ESM_LOW_PRI                                                        (0x00000020U)
#define SDL_ESM_HI_PRI                                                         (0x00000024U)
#define SDL_ESM_LOW                                                            (0x00000028U)
#define SDL_ESM_HI                                                             (0x0000002CU)
#define SDL_ESM_EOI                                                            (0x00000030U)
#define SDL_ESM_PIN_CTRL                                                       (0x00000040U)
#define SDL_ESM_PIN_STS                                                        (0x00000044U)
#define SDL_ESM_PIN_CNTR                                                       (0x00000048U)
#define SDL_ESM_PIN_CNTR_PRE                                                   (0x0000004CU)
#define SDL_ESM_PWMH_PIN_CNTR                                                  (0x00000050U)
#define SDL_ESM_PWMH_PIN_CNTR_PRE                                              (0x00000054U)
#define SDL_ESM_PWML_PIN_CNTR                                                  (0x00000058U)
#define SDL_ESM_PWML_PIN_CNTR_PRE                                              (0x0000005CU)
#define SDL_ESM_CRITICAL_PRI_INT_DELAY_CNTR                                    (0x00000060U)
#define SDL_ESM_CRITICAL_PRI_INT_DELAY_CNTR_PRE                                (0x00000064U)
#define SDL_ESM_ERR_GRP_RAW(ERR_GRP)                                           (0x00000400U+((ERR_GRP)*0x20U))
#define SDL_ESM_ERR_GRP_STS(ERR_GRP)                                           (0x00000404U+((ERR_GRP)*0x20U))
#define SDL_ESM_ERR_GRP_INTR_EN_SET(ERR_GRP)                                   (0x00000408U+((ERR_GRP)*0x20U))
#define SDL_ESM_ERR_GRP_INTR_EN_CLR(ERR_GRP)                                   (0x0000040CU+((ERR_GRP)*0x20U))
#define SDL_ESM_ERR_GRP_INT_PRIO(ERR_GRP)                                      (0x00000410U+((ERR_GRP)*0x20U))
#define SDL_ESM_ERR_GRP_PIN_EN_SET(ERR_GRP)                                    (0x00000414U+((ERR_GRP)*0x20U))
#define SDL_ESM_ERR_GRP_PIN_EN_CLR(ERR_GRP)                                    (0x00000418U+((ERR_GRP)*0x20U))
#define SDL_ESM_ERR_GRP_CRITICAL_PRI_EN_SET(ERR_GRP)                           (0x00000800U+((ERR_GRP)*0x20U))
#define SDL_ESM_ERR_GRP_CRITICAL_PRI_EN_CLR(ERR_GRP)                           (0x00000804U+((ERR_GRP)*0x20U))
 
/**************************************************************************
* Field Definition Macros
**************************************************************************/
 
 
/* RAW */
 
#define SDL_ESM_ERR_GRP_RAW_STS_MASK                                           (0xFFFFFFFFU)
#define SDL_ESM_ERR_GRP_RAW_STS_SHIFT                                          (0x00000000U)
#define SDL_ESM_ERR_GRP_RAW_STS_MAX                                            (0xFFFFFFFFU)
 
/* STS */
 
#define SDL_ESM_ERR_GRP_STS_MSK_MASK                                           (0xFFFFFFFFU)
#define SDL_ESM_ERR_GRP_STS_MSK_SHIFT                                          (0x00000000U)
#define SDL_ESM_ERR_GRP_STS_MSK_MAX                                            (0xFFFFFFFFU)
 
/* INTR_EN_SET */
 
#define SDL_ESM_ERR_GRP_INTR_EN_SET_MSK_MASK                                   (0xFFFFFFFFU)
#define SDL_ESM_ERR_GRP_INTR_EN_SET_MSK_SHIFT                                  (0x00000000U)
#define SDL_ESM_ERR_GRP_INTR_EN_SET_MSK_MAX                                    (0xFFFFFFFFU)
 
/* INTR_EN_CLR */
 
#define SDL_ESM_ERR_GRP_INTR_EN_CLR_MSK_MASK                                   (0xFFFFFFFFU)
#define SDL_ESM_ERR_GRP_INTR_EN_CLR_MSK_SHIFT                                  (0x00000000U)
#define SDL_ESM_ERR_GRP_INTR_EN_CLR_MSK_MAX                                    (0xFFFFFFFFU)
 
/* INT_PRIO */
 
#define SDL_ESM_ERR_GRP_INT_PRIO_MSK_MASK                                      (0xFFFFFFFFU)
#define SDL_ESM_ERR_GRP_INT_PRIO_MSK_SHIFT                                     (0x00000000U)
#define SDL_ESM_ERR_GRP_INT_PRIO_MSK_MAX                                       (0xFFFFFFFFU)
 
/* PIN_EN_SET */
 
#define SDL_ESM_ERR_GRP_PIN_EN_SET_MSK_MASK                                    (0xFFFFFFFFU)
#define SDL_ESM_ERR_GRP_PIN_EN_SET_MSK_SHIFT                                   (0x00000000U)
#define SDL_ESM_ERR_GRP_PIN_EN_SET_MSK_MAX                                     (0xFFFFFFFFU)
 
/* PIN_EN_CLR */
 
#define SDL_ESM_ERR_GRP_PIN_EN_CLR_MSK_MASK                                    (0xFFFFFFFFU)
#define SDL_ESM_ERR_GRP_PIN_EN_CLR_MSK_SHIFT                                   (0x00000000U)
#define SDL_ESM_ERR_GRP_PIN_EN_CLR_MSK_MAX                                     (0xFFFFFFFFU)
 
/* PID */
 
#define SDL_ESM_PID_MINOR_MASK                                                 (0x0000003FU)
#define SDL_ESM_PID_MINOR_SHIFT                                                (0x00000000U)
#define SDL_ESM_PID_MINOR_MAX                                                  (0x0000003FU)
 
#define SDL_ESM_PID_CUSTOM_MASK                                                (0x000000C0U)
#define SDL_ESM_PID_CUSTOM_SHIFT                                               (0x00000006U)
#define SDL_ESM_PID_CUSTOM_MAX                                                 (0x00000003U)
 
#define SDL_ESM_PID_MAJOR_MASK                                                 (0x00000700U)
#define SDL_ESM_PID_MAJOR_SHIFT                                                (0x00000008U)
#define SDL_ESM_PID_MAJOR_MAX                                                  (0x00000007U)
 
#define SDL_ESM_PID_RTL_MASK                                                   (0x0000F800U)
#define SDL_ESM_PID_RTL_SHIFT                                                  (0x0000000BU)
#define SDL_ESM_PID_RTL_MAX                                                    (0x0000001FU)
 
#define SDL_ESM_PID_FUNC_MASK                                                  (0x0FFF0000U)
#define SDL_ESM_PID_FUNC_SHIFT                                                 (0x00000010U)
#define SDL_ESM_PID_FUNC_MAX                                                   (0x00000FFFU)
 
#define SDL_ESM_PID_BU_MASK                                                    (0x30000000U)
#define SDL_ESM_PID_BU_SHIFT                                                   (0x0000001CU)
#define SDL_ESM_PID_BU_MAX                                                     (0x00000003U)
 
#define SDL_ESM_PID_SCHEME_MASK                                                (0xC0000000U)
#define SDL_ESM_PID_SCHEME_SHIFT                                               (0x0000001EU)
#define SDL_ESM_PID_SCHEME_MAX                                                 (0x00000003U)
 
/* INFO */
 
#define SDL_ESM_INFO_GROUPS_MASK                                               (0x000000FFU)
#define SDL_ESM_INFO_GROUPS_SHIFT                                              (0x00000000U)
#define SDL_ESM_INFO_GROUPS_MAX                                                (0x000000FFU)
 
#define SDL_ESM_INFO_PULSE_GROUPS_MASK                                         (0x0000FF00U)
#define SDL_ESM_INFO_PULSE_GROUPS_SHIFT                                        (0x00000008U)
#define SDL_ESM_INFO_PULSE_GROUPS_MAX                                          (0x000000FFU)
 
#define SDL_ESM_INFO_LAST_RESET_MASK                                           (0x80000000U)
#define SDL_ESM_INFO_LAST_RESET_SHIFT                                          (0x0000001FU)
#define SDL_ESM_INFO_LAST_RESET_MAX                                            (0x00000001U)
 
/* EN */
 
#define SDL_ESM_EN_KEY_MASK                                                    (0x0000000FU)
#define SDL_ESM_EN_KEY_SHIFT                                                   (0x00000000U)
#define SDL_ESM_EN_KEY_MAX                                                     (0x0000000FU)
 
/* SFT_RST */
 
#define SDL_ESM_SFT_RST_KEY_MASK                                               (0x0000000FU)
#define SDL_ESM_SFT_RST_KEY_SHIFT                                              (0x00000000U)
#define SDL_ESM_SFT_RST_KEY_MAX                                                (0x0000000FU)
 
/* ERR_RAW */
 
#define SDL_ESM_ERR_RAW_STS_MASK                                               (0xFFFFFFFFU)
#define SDL_ESM_ERR_RAW_STS_SHIFT                                              (0x00000000U)
#define SDL_ESM_ERR_RAW_STS_MAX                                                (0xFFFFFFFFU)
 
/* ERR_STS */
 
#define SDL_ESM_ERR_STS_MSK_MASK                                               (0xFFFFFFFFU)
#define SDL_ESM_ERR_STS_MSK_SHIFT                                              (0x00000000U)
#define SDL_ESM_ERR_STS_MSK_MAX                                                (0xFFFFFFFFU)
 
/* ERR_EN_SET */
 
#define SDL_ESM_ERR_EN_SET_MSK_MASK                                            (0xFFFFFFFFU)
#define SDL_ESM_ERR_EN_SET_MSK_SHIFT                                           (0x00000000U)
#define SDL_ESM_ERR_EN_SET_MSK_MAX                                             (0xFFFFFFFFU)
 
/* ERR_EN_CLR */
 
#define SDL_ESM_ERR_EN_CLR_MSK_MASK                                            (0xFFFFFFFFU)
#define SDL_ESM_ERR_EN_CLR_MSK_SHIFT                                           (0x00000000U)
#define SDL_ESM_ERR_EN_CLR_MSK_MAX                                             (0xFFFFFFFFU)
 
/* LOW_PRI */
 
#define SDL_ESM_LOW_PRI_PLS_MASK                                               (0xFFFF0000U)
#define SDL_ESM_LOW_PRI_PLS_SHIFT                                              (0x00000010U)
#define SDL_ESM_LOW_PRI_PLS_MAX                                                (0x0000FFFFU)
 
#define SDL_ESM_LOW_PRI_LVL_MASK                                               (0x0000FFFFU)
#define SDL_ESM_LOW_PRI_LVL_SHIFT                                              (0x00000000U)
#define SDL_ESM_LOW_PRI_LVL_MAX                                                (0x0000FFFFU)
 
/* HI_PRI */
 
#define SDL_ESM_HI_PRI_PLS_MASK                                                (0xFFFF0000U)
#define SDL_ESM_HI_PRI_PLS_SHIFT                                               (0x00000010U)
#define SDL_ESM_HI_PRI_PLS_MAX                                                 (0x0000FFFFU)
 
#define SDL_ESM_HI_PRI_LVL_MASK                                                (0x0000FFFFU)
#define SDL_ESM_HI_PRI_LVL_SHIFT                                               (0x00000000U)
#define SDL_ESM_HI_PRI_LVL_MAX                                                 (0x0000FFFFU)
 
/* LOW */
 
#define SDL_ESM_LOW_STS_MASK                                                   (0xFFFFFFFFU)
#define SDL_ESM_LOW_STS_SHIFT                                                  (0x00000000U)
#define SDL_ESM_LOW_STS_MAX                                                    (0xFFFFFFFFU)
 
/* HI */
 
#define SDL_ESM_HI_STS_MASK                                                    (0xFFFFFFFFU)
#define SDL_ESM_HI_STS_SHIFT                                                   (0x00000000U)
#define SDL_ESM_HI_STS_MAX                                                     (0xFFFFFFFFU)
 
/* EOI */
 
#define SDL_ESM_EOI_KEY_MASK                                                   (0x000007FFU)
#define SDL_ESM_EOI_KEY_SHIFT                                                  (0x00000000U)
#define SDL_ESM_EOI_KEY_MAX                                                    (0x000007FFU)
 
/* PIN_CTRL */
 
#define SDL_ESM_PIN_CTRL_KEY_MASK                                              (0x0000000FU)
#define SDL_ESM_PIN_CTRL_KEY_SHIFT                                             (0x00000000U)
#define SDL_ESM_PIN_CTRL_KEY_MAX                                               (0x0000000FU)
 
#define SDL_ESM_PIN_CTRL_PWM_EN_MASK                                           (0x000000F0U)
#define SDL_ESM_PIN_CTRL_PWM_EN_SHIFT                                          (0x00000004U)
#define SDL_ESM_PIN_CTRL_PWM_EN_MAX                                            (0x0000000FU)
 
/* PIN_STS */
 
#define SDL_ESM_PIN_STS_VAL_MASK                                               (0x00000001U)
#define SDL_ESM_PIN_STS_VAL_SHIFT                                              (0x00000000U)
#define SDL_ESM_PIN_STS_VAL_MAX                                                (0x00000001U)
 
/* PIN_CNTR */
 
#define SDL_ESM_PIN_CNTR_COUNT_MASK                                            (0x00FFFFFFU)
#define SDL_ESM_PIN_CNTR_COUNT_SHIFT                                           (0x00000000U)
#define SDL_ESM_PIN_CNTR_COUNT_MAX                                             (0x00FFFFFFU)
 
/* PIN_CNTR_PRE */
 
#define SDL_ESM_PIN_CNTR_PRE_COUNT_MASK                                        (0x00FFFFFFU)
#define SDL_ESM_PIN_CNTR_PRE_COUNT_SHIFT                                       (0x00000000U)
#define SDL_ESM_PIN_CNTR_PRE_COUNT_MAX                                         (0x00FFFFFFU)
 
#ifdef __cplusplus
}
#endif
#endif /* SDLR_ESM_ */