Introduction

Header file containing various enumerations, structure definitions and function declarations for the Power System modules such as POK/POR IP.

POK types
This enumerator defines the possible POK module types
#define	SDL_TYPE_POK ((SDL_pok_type) 1U)

#define	SDL_TYPE_POK_SA ((SDL_pok_type) 2U)

typedef uint8_t	SDL_pok_type

POK/POR hysteresIs types
This enumerator defines the possible hysteresis control values for the Power Subsystem modules
#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_hysteresis

POK/POR TRIM values
This enumerator defines the possible trim value for POK/POR modules Any value between 0 through 127 is valid TRIM value * * POK \| Under Voltage \| Over Voltage \| * \| Detection \| Detection \| Step Resolution * ----------- \| --------------- \| ---------------- \| ---------------- * CORE_POK \| 475mV - 1.35V \| 725mV - 1.65V \| 0.0125V * POK1.8 \| 1.432V - 2.168V \| 1.432V - 2.168V \| 0.02V * POK3.3 \| 2.625V - 3.975V \| 2.625V - 3.975V \| 0.0375V * *
#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_trim

POK/POR Voltage detection modes
This enumerator defines the possible values of Voltage Detection modes
#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_pwrss_vd_mode

POK detection status
This enumerator defines the POK Detection status values
#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_status

POK detection values
This enumerator defines the POK Detection values
#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_detection

POK Enable Selection source Values
This enumerator defines the POK Enable selection source Selection source values
#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_enSelSrc

POK voltage threshold status
This enumerator defines the Voltage threshold status
#define	SDL_VOLTAGE_ABOVE_THRESHOLD ((SDL_POK_thrStatus) 0U)

#define	SDL_VOLTAGE_BELOW_THRESHOLD ((SDL_POK_thrStatus) 1U)

#define	SDL_VOLTAGE_GOOD ((SDL_POK_thrStatus) 2U)

typedef uint8_t	SDL_POK_thrStatus

POK trim selection values from HHV default or CTRL registers
This enumerator defines the trim selection values
#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_trim_sel

POR POR Override enable and set
This enumerator defines the override enable/set values /set
#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)

typedef uint8_t	SDL_por_override

POR Module state values
This enumerator defines the POR Module State
#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 uint8_t	SDL_por_module_status

POK POK ID values
This enumerator defines the possible POK module ID values on J721E
#define	SDL_FIRST_POK_ID (0)

#define	SDL_POK_VDDA_PMIC_IN_ID (SDL_FIRST_POK_ID)

#define	SDL_POK_VDD_CORE_UV_ID (1)

#define	SDL_POK_VDDSHV_WKUP_GEN_UV_ID (2)

#define	SDL_POK_VDD_CPU_UV_ID (3)

#define	SDL_POK_VDDR_MCU_UV_ID (4)

#define	SDL_POK_VMON_EXT_UV_ID (5)

#define	SDL_POK_VDD_MCU_OV_ID (6)

#define	SDL_POK_VDDR_CORE_UV_ID (7)

#define	SDL_POK_VDDSHV_WKUP_GEN_OV_ID (8)

#define	SDL_POK_VDD_CORE_OV_ID (9)

#define	SDL_POK_VDDR_MCU_OV_ID (10)

#define	SDL_POK_VDD_CPU_OV_ID (11)

#define	SDL_POK_VDDR_CORE_OV_ID (12)

#define	SDL_POK_VMON_EXT_OV_ID (13)

#define	SDL_POR_POKHV_UV_ID (14)

#define	SDL_POR_POKLV_UV_ID (15)

#define	SDL_POR_POKHV_OV_ID (16)

#define	SDL_LAST_POK_ID (SDL_POR_POKHV_OV_ID)

typedef SDL_wkup_ctrl_mmr_cfg0Regs	SDL_wkupCtrlRegsBase_t

typedef int8_t	SDL_POK_Inst

Data Structures
struct	SDL_pokShiftsAndMasks_t

struct	SDL_POK_config
	POK Configuration structure. More...

struct	SDL_pokVal_t
	POK Configuration structure read value. More...

struct	SDL_pokPorCfg_t
	POK functionality of POR Configuration structure. More...

struct	SDL_pokPorVal_t
	POK functionality of POR Value structure. More...

struct	SDL_pokPorStat_t
	POK functionality of POR Configuration structure. More...

Macros
POR POR Override index
This enumerator defines the override index values
#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)

POK types