sdl_pok_def.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2021 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 SDL_POK_DEF_H
#define SDL_POK_DEF_H

#ifdef __cplusplus
extern "C" {
#endif

#include <sdl_types.h>
#include <include/soc.h>

typedef struct SDL_pokShiftsAndMasks
{
    volatile    uint32_t    *pokAddr;
    volatile    uint32_t    *pokDetAddr;
    volatile    uint32_t    *pokEnSelAddr;
    uint32_t    hystMask;
    uint32_t    hystShift;
    uint32_t    vdDetMask;
    uint32_t    vdDetShift;
    uint32_t    detEnMask;
    uint32_t    detEnShift;
    uint32_t    pokEnSelMask;
    uint32_t    pokEnSelShift;
    uint32_t    trimMask;
    uint32_t    trimShift;
} SDL_pokShiftsAndMasks_t;

typedef  uint8_t                           SDL_pok_type;

#define SDL_TYPE_POK                          ((SDL_pok_type) 1U)

#define SDL_TYPE_POK_SA                       ((SDL_pok_type) 2U)

/* @} */

typedef  uint8_t                           SDL_pwrss_hysteresis;

#define SDL_PWRSS_SET_HYSTERESIS_DISABLE            ((SDL_pwrss_hysteresis) 0U)

#define SDL_PWRSS_SET_HYSTERESIS_ENABLE             ((SDL_pwrss_hysteresis) 1U)

#define SDL_PWRSS_GET_HYSTERESIS_VALUE              ((SDL_pwrss_hysteresis) 2U)

#define SDL_PWRSS_HYSTERESIS_NO_ACTION              ((SDL_pwrss_hysteresis) 3U)

/* @} */

typedef  uint8_t                          SDL_pwrss_trim;
#define SDL_PWRSS_MAX_TRIM_VALUE               ((SDL_pwrss_trim) 127U)

#define SDL_PWRSS_TRIM_NO_ACTION               ((SDL_pwrss_trim) 128U)

#define SDL_PWRSS_GET_TRIM_VALUE               ((SDL_pwrss_trim) 129U)

#define SDL_PWRSS_INVALID_TRIM_VALUE           ((SDL_pwrss_trim) 255U)


/* @} */

typedef  uint8_t                           SDL_pwrss_vd_mode;

#define SDL_PWRSS_SET_UNDER_VOLTAGE_DET_ENABLE           ((SDL_pwrss_vd_mode) 0U)

#define SDL_PWRSS_SET_OVER_VOLTAGE_DET_ENABLE            ((SDL_pwrss_vd_mode) 1U)

#define SDL_PWRSS_GET_VOLTAGE_DET_MODE                   ((SDL_pwrss_vd_mode) 2U)

#define SDL_PWRSS_VOLTAGE_DET_NO_ACTION                  ((SDL_pwrss_vd_mode) 3U)

/* @} */

typedef uint8_t                             SDL_POK_detection_status;
#define SDL_POK_DETECTION_DISABLED               ((SDL_POK_detection_status) 0U)

#define SDL_POK_DETECTION_ENABLED                ((SDL_POK_detection_status) 1U)

/* @} */

typedef uint8_t                             SDL_POK_detection;
#define SDL_POK_DETECTION_DISABLE               ((SDL_POK_detection) 0U)

#define SDL_POK_DETECTION_ENABLE                ((SDL_POK_detection) 1U)

#define SDL_POK_DETECTION_NO_ACTION             ((SDL_POK_detection) 2U)

#define SDL_POK_GET_DETECTION_VALUE             ((SDL_POK_detection) 3U)


/* @} */

typedef uint8_t                             SDL_POK_enSelSrc;
#define SDL_POK_ENSEL_HWTIEOFFS                  ((SDL_POK_enSelSrc) 0U)

#define SDL_POK_ENSEL_PRG_CTRL                   ((SDL_POK_enSelSrc) 1U)

#define SDL_POK_ENSEL_NO_ACTION                  ((SDL_POK_enSelSrc) 2U)

#define SDL_POK_GET_ENSEL_VALUE                  ((SDL_POK_enSelSrc) 3U)


/* @} */

typedef uint8_t                             SDL_POK_thrStatus;
/* POK Volage above threshold detected */
#define SDL_VOLTAGE_ABOVE_THRESHOLD              ((SDL_POK_thrStatus) 0U)
/* POK Volage below threshold detected */
#define SDL_VOLTAGE_BELOW_THRESHOLD              ((SDL_POK_thrStatus) 1U)
/* POK Voltage normal/good */
#define SDL_VOLTAGE_GOOD                         ((SDL_POK_thrStatus) 2U)

/* @} */

typedef uint8_t         SDL_por_trim_sel;

#define  SDL_POR_TRIM_SELECTION_FROM_HHV_DEFAULT      ((uint8_t) 0U)

#define  SDL_POR_TRIM_SELECTION_FROM_CTRL_REGS        ((uint8_t) 1U)

#define  SDL_POR_TRIM_SELECTION_NO_CHANGE             ((uint8_t) 2U)

#define  SDL_POR_TRIM_SELECTION_GET_VALUE             ((uint8_t) 3U)


/* @} */

typedef   uint8_t               SDL_por_override;

#define  SDL_POR_OVERRIDE_NOT_SET_DISABLE                   ((SDL_por_override) 0U)

#define  SDL_POR_OVERRIDE_NOT_SET_ENABLE                    ((SDL_por_override) 1U)

#define  SDL_POR_OVERRIDE_SET_DISABLE                       ((SDL_por_override) 2U)

#define  SDL_POR_OVERRIDE_SET_ENABLE                        ((SDL_por_override) 3U)

#define   SDL_POR_GET_OVERRIDE_VALUE                        ((SDL_por_override) 4U)

#define   SDL_POR_SET_OVERRIDE_NO_CHANGE                    ((SDL_por_override) 5U)

#define   SDL_OVERRIDE_SET_UNKNOWN                          ((SDL_por_override) 0xFFU)


/* @} */

#define  SDL_PORHV_OVERRIDE_INDEX                           (0U)

#define  SDL_BGAP_OVERRIDE_INDEX                            (1U)

#define  SDL_POKHV_OVERRIDE_INDEX                           (2U)

#define  SDL_POKLVA_OVERRIDE_INDEX                          (3U)

#define  SDL_POKLVB_OVERRIDE_INDEX                          (4U)

#define  SDL_MAX_OVERRIDE_INDEX                             (5U)

/* @} */


typedef   uint8_t               SDL_por_module_status ;

#define   SDL_POR_MODULE_STATUS_FUNCTIONAL_MODE             ((SDL_por_module_status) 0U)

#define   SDL_POR_MODULE_STATUS_RESET_MODE                  ((SDL_por_module_status) 1U)
/* @} */


typedef SDL_wkup_ctrl_mmr_cfg0Regs SDL_wkupCtrlRegsBase_t;

/* @} */

typedef int8_t  SDL_POK_Inst ;

#define SDL_FIRST_POK_ID                              (0)
/* PMIC POK ID */
#define SDL_POK_VDDA_PMIC_IN_ID                       (SDL_FIRST_POK_ID)
/* CORE Under Voltage POK ID */
#define SDL_POK_VDD_CORE_UV_ID                        (1)
/* Wakeup General POK Under Voltage ID */
#define SDL_POK_VDDSHV_WKUP_GEN_UV_ID                 (2)
/* CPU under voltage POK ID */
#define SDL_POK_VDD_CPU_UV_ID                         (3)
/* MCU under voltage VDD POK ID */
#define SDL_POK_VDDR_MCU_UV_ID                        (4)
/* VMON under voltage POK ID */
#define SDL_POK_VMON_EXT_UV_ID                        (5)
/* MCU overvoltage POK ID */
#define SDL_POK_VDD_MCU_OV_ID                         (6)
/* VDD CORE POK ID */
#define SDL_POK_VDDR_CORE_UV_ID                       (7)
/* Wakeup General POK Over voltage ID */
#define SDL_POK_VDDSHV_WKUP_GEN_OV_ID                 (8)
/* CORE VDD Over Voltage POK ID */
#define SDL_POK_VDD_CORE_OV_ID                        (9)
/* MCU  over Voltage POK ID */
#define SDL_POK_VDDR_MCU_OV_ID                        (10)
/* CPU  over Voltage POK ID */
#define SDL_POK_VDD_CPU_OV_ID                         (11)
/* CORE VDDR over Voltage POK ID */
#define SDL_POK_VDDR_CORE_OV_ID                       (12)
/* VMON POK Over Voltage ID */
#define SDL_POK_VMON_EXT_OV_ID                        (13)
/* POKHV Under Voltage POK ID */
#define SDL_POR_POKHV_UV_ID                           (14)
/* POKLV Under Voltage POK ID */
#define SDL_POR_POKLV_UV_ID                           (15)
/* POKHV Over Voltage POK ID */
#define SDL_POR_POKHV_OV_ID                           (16)
/* LAST POK ID */
#define SDL_LAST_POK_ID                               (SDL_POR_POKHV_OV_ID)


/* @} */
    
/* @} */

typedef struct SDL_pokCfg
{
    SDL_pwrss_hysteresis            hystCtrl;
    SDL_pwrss_vd_mode               voltDetMode;
    SDL_pwrss_trim                  trim;
    SDL_POK_detection               detectionCtrl;
    SDL_POK_enSelSrc                pokEnSelSrcCtrl;
    
} SDL_POK_config;

typedef struct SDL_pokVal
{
    SDL_pwrss_hysteresis            hystCtrl;
    SDL_pwrss_vd_mode               voltDetMode;
    SDL_pwrss_trim                  trim;
    SDL_POK_detection_status        detectionStatus;
    SDL_POK_enSelSrc                pokEnSelSrcCtrl;
    SDL_POK_thrStatus          voltageThrStatus;
} SDL_pokVal_t;


typedef struct SDL_pokPorCfg
{
    SDL_por_override              override[SDL_MAX_OVERRIDE_INDEX];
    bool                          maskHHVOutputEnable;
    SDL_por_trim_sel              trim_select;
} SDL_pokPorCfg_t;

typedef struct SDL_pokPorVal
{
    SDL_por_override              override[SDL_MAX_OVERRIDE_INDEX];
    bool                          maskHHVOutputEnable;
    SDL_por_trim_sel              trim_select;
} SDL_pokPorVal_t;


typedef struct SDL_pokPorStat
{
    SDL_POK_thrStatus           porModuleStatus;
    bool                            porBGapOK;
} SDL_pokPorStat_t;

/* @} */

#ifdef __cplusplus
}
#endif  /* extern "C" */

#endif  /* end of SDL_POK_DEF_H definition */