SDL API Guide for J721E
sdl_pok.h File Reference

Introduction

This file contains the prototypes of the APIs present in the device abstraction layer file of POK. This also contains some related macros.

Go to the source code of this file.

Data Structures

struct  SDL_POK_staticRegs
 POK Static Registers structure. More...
 

Macros

#define SDL_WKUP_ESM0_CFG_BASE   (0x42080000U)
 
#define SDL_POK_MMR_BASE   (SDL_WKUP_CTRL_MMR0_CFG0_BASE)
 
#define WKUP_ESM_INSTANCE   (SDL_WKUP_ESM0_CFG_BASE)
 
#define WKUP_ESM_INTID   (SDLR_MCU_R5FSS0_CORE0_INTR_WKUP_ESM0_ESM_INT_HI_LVL_0)
 
#define WKUP_ESM_ERR_SIG_POKHV_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU_3POKS0_POK_PGOOD_OUT_N_TO_ESM_2)
 
#define WKUP_ESM_ERR_SIG_POKHV_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU_3POKS0_POK_PGOOD_OUT_N_TO_ESM_1)
 
#define WKUP_ESM_ERR_SIG_PORHV_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU_3POKS0_POK_PGOOD_OUT_N_TO_ESM_2)
 
#define WKUP_ESM_ERR_SIG_POKLV_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU_3POKS0_POK_PGOOD_OUT_N_TO_ESM_0)
 
#define WKUP_ESM_ERR_SIG_VDDA_IN   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU0_POK_PGOOD_OUT_N_TO_ESM_0)
 
#define WKUP_ESM_ERR_SIG_VDDSHV_WKUP_GEN_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU0_POK_PGOOD_OUT_N_TO_ESM_5)
 
#define WKUP_ESM_ERR_SIG_VDDR_MCU_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU0_POK_PGOOD_OUT_N_TO_ESM_4)
 
#define WKUP_ESM_ERR_SIG_VDD_MCU_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU0_POK_PGOOD_OUT_N_TO_ESM_1)
 
#define WKUP_ESM_ERR_SIG_VDDSHV_WKUP_GEN_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU0_POK_PGOOD_OUT_N_TO_ESM_2)
 
#define WKUP_ESM_ERR_SIG_VDDR_MCU_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU0_POK_PGOOD_OUT_N_TO_ESM_3)
 
#define WKUP_ESM_ERR_SIG_VDD_CORE_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_7)
 
#define WKUP_ESM_ERR_SIG_VDD_CPU_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_6)
 
#define WKUP_ESM_ERR_SIG_VMON_EXT_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_5)
 
#define WKUP_ESM_ERR_SIG_VDDR_CORE_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_4)
 
#define WKUP_ESM_ERR_SIG_VDD_CORE_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_3)
 
#define WKUP_ESM_ERR_SIG_VDD_CPU_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_2)
 
#define WKUP_ESM_ERR_SIG_VMON_EXT_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_1)
 
#define WKUP_ESM_ERR_SIG_VDDR_CORE_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_0)
 
#define ESM_INSTANCE   WKUP_ESM_INSTANCE
 
#define ESM_INTID   WKUP_ESM_INTID
 
#define ESM_ERR_SIG_POKHV_UV   WKUP_ESM_ERR_SIG_POKHV_UV
 
#define ESM_ERR_SIG_POKHV_OV   WKUP_ESM_ERR_SIG_POKHV_OV
 
#define ESM_ERR_SIG_POKLV_UV   WKUP_ESM_ERR_SIG_POKLV_UV
 
#define ESM_ERR_SIG_PORHV_UV   WKUP_ESM_ERR_SIG_PORHV_UV
 
#define ESM_ERR_SIG_VDDA_IN   WKUP_ESM_ERR_SIG_VDDA_IN
 
#define ESM_ERR_SIG_VDD_CORE_UV   WKUP_ESM_ERR_SIG_VDD_CORE_UV
 
#define ESM_ERR_SIG_VDDSHV_WKUP_GEN_UV   WKUP_ESM_ERR_SIG_VDDSHV_WKUP_GEN_UV
 
#define ESM_ERR_SIG_VDD_CPU_UV   WKUP_ESM_ERR_SIG_VDD_CPU_UV
 
#define ESM_ERR_SIG_VDDR_MCU_UV   WKUP_ESM_ERR_SIG_VDDR_MCU_UV
 
#define ESM_ERR_SIG_VMON_EXT_UV   WKUP_ESM_ERR_SIG_VMON_EXT_UV
 
#define ESM_ERR_SIG_VDD_MCU_OV   WKUP_ESM_ERR_SIG_VDD_MCU_OV
 
#define ESM_ERR_SIG_VDDR_CORE_UV   WKUP_ESM_ERR_SIG_VDDR_CORE_UV
 
#define ESM_ERR_SIG_VDDSHV_WKUP_GEN_OV   WKUP_ESM_ERR_SIG_VDDSHV_WKUP_GEN_OV
 
#define ESM_ERR_SIG_VDD_CORE_OV   WKUP_ESM_ERR_SIG_VDD_CORE_OV
 
#define ESM_ERR_SIG_VDDR_MCU_OV   WKUP_ESM_ERR_SIG_VDDR_MCU_OV
 
#define ESM_ERR_SIG_VDD_CPU_OV   WKUP_ESM_ERR_SIG_VDD_CPU_OV
 
#define ESM_ERR_SIG_VDDR_CORE_OV   WKUP_ESM_ERR_SIG_VDDR_CORE_OV
 
#define ESM_ERR_SIG_VMON_EXT_OV   WKUP_ESM_ERR_SIG_VMON_EXT_OV
 

Functions

int32_t SDL_POK_getStaticRegisters (SDL_POK_Inst Instance, SDL_POK_staticRegs *pStaticRegs)
 POK Function to get the Static Registers. This function reads the values of the static registers such as hysteresis control, voltage detect mode, trim, PORGP and module status. More...
 
int32_t SDL_POK_init (SDL_POK_Inst instance, SDL_POK_config *pConfig)
 POK module configuration API. More...
 
int32_t SDL_POK_verifyConfig (SDL_POK_Inst instance, SDL_POK_config *pConfig)
 POK Function to verify the written configuration. This function checks the provided config against the written config and returns the verification status. More...
 
int32_t SDL_POK_getStatus (SDL_POK_Inst instance, SDL_POK_thrStatus *pStatus)
 POK Function to get the threshold status of the POK instance. More...
 

Macro Definition Documentation

◆ SDL_WKUP_ESM0_CFG_BASE

#define SDL_WKUP_ESM0_CFG_BASE   (0x42080000U)

◆ SDL_POK_MMR_BASE

#define SDL_POK_MMR_BASE   (SDL_WKUP_CTRL_MMR0_CFG0_BASE)

◆ WKUP_ESM_INSTANCE

#define WKUP_ESM_INSTANCE   (SDL_WKUP_ESM0_CFG_BASE)

◆ WKUP_ESM_INTID

#define WKUP_ESM_INTID   (SDLR_MCU_R5FSS0_CORE0_INTR_WKUP_ESM0_ESM_INT_HI_LVL_0)

◆ WKUP_ESM_ERR_SIG_POKHV_UV

#define WKUP_ESM_ERR_SIG_POKHV_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU_3POKS0_POK_PGOOD_OUT_N_TO_ESM_2)

◆ WKUP_ESM_ERR_SIG_POKHV_OV

#define WKUP_ESM_ERR_SIG_POKHV_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU_3POKS0_POK_PGOOD_OUT_N_TO_ESM_1)

◆ WKUP_ESM_ERR_SIG_PORHV_UV

#define WKUP_ESM_ERR_SIG_PORHV_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU_3POKS0_POK_PGOOD_OUT_N_TO_ESM_2)

◆ WKUP_ESM_ERR_SIG_POKLV_UV

#define WKUP_ESM_ERR_SIG_POKLV_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU_3POKS0_POK_PGOOD_OUT_N_TO_ESM_0)

◆ WKUP_ESM_ERR_SIG_VDDA_IN

#define WKUP_ESM_ERR_SIG_VDDA_IN   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU0_POK_PGOOD_OUT_N_TO_ESM_0)

◆ WKUP_ESM_ERR_SIG_VDDSHV_WKUP_GEN_UV

#define WKUP_ESM_ERR_SIG_VDDSHV_WKUP_GEN_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU0_POK_PGOOD_OUT_N_TO_ESM_5)

◆ WKUP_ESM_ERR_SIG_VDDR_MCU_UV

#define WKUP_ESM_ERR_SIG_VDDR_MCU_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU0_POK_PGOOD_OUT_N_TO_ESM_4)

◆ WKUP_ESM_ERR_SIG_VDD_MCU_OV

#define WKUP_ESM_ERR_SIG_VDD_MCU_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU0_POK_PGOOD_OUT_N_TO_ESM_1)

◆ WKUP_ESM_ERR_SIG_VDDSHV_WKUP_GEN_OV

#define WKUP_ESM_ERR_SIG_VDDSHV_WKUP_GEN_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU0_POK_PGOOD_OUT_N_TO_ESM_2)

◆ WKUP_ESM_ERR_SIG_VDDR_MCU_OV

#define WKUP_ESM_ERR_SIG_VDDR_MCU_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG_MCU0_POK_PGOOD_OUT_N_TO_ESM_3)

◆ WKUP_ESM_ERR_SIG_VDD_CORE_UV

#define WKUP_ESM_ERR_SIG_VDD_CORE_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_7)

◆ WKUP_ESM_ERR_SIG_VDD_CPU_UV

#define WKUP_ESM_ERR_SIG_VDD_CPU_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_6)

◆ WKUP_ESM_ERR_SIG_VMON_EXT_UV

#define WKUP_ESM_ERR_SIG_VMON_EXT_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_5)

◆ WKUP_ESM_ERR_SIG_VDDR_CORE_UV

#define WKUP_ESM_ERR_SIG_VDDR_CORE_UV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_4)

◆ WKUP_ESM_ERR_SIG_VDD_CORE_OV

#define WKUP_ESM_ERR_SIG_VDD_CORE_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_3)

◆ WKUP_ESM_ERR_SIG_VDD_CPU_OV

#define WKUP_ESM_ERR_SIG_VDD_CPU_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_2)

◆ WKUP_ESM_ERR_SIG_VMON_EXT_OV

#define WKUP_ESM_ERR_SIG_VMON_EXT_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_1)

◆ WKUP_ESM_ERR_SIG_VDDR_CORE_OV

#define WKUP_ESM_ERR_SIG_VDDR_CORE_OV   (SDLR_WKUP_ESM0_ESM_PLS_EVENT0_WKUP_PRG0_POK_PGOOD_OUT_N_TO_ESM_0)

◆ ESM_INSTANCE

#define ESM_INSTANCE   WKUP_ESM_INSTANCE

◆ ESM_INTID

#define ESM_INTID   WKUP_ESM_INTID

◆ ESM_ERR_SIG_POKHV_UV

#define ESM_ERR_SIG_POKHV_UV   WKUP_ESM_ERR_SIG_POKHV_UV

◆ ESM_ERR_SIG_POKHV_OV

#define ESM_ERR_SIG_POKHV_OV   WKUP_ESM_ERR_SIG_POKHV_OV

◆ ESM_ERR_SIG_POKLV_UV

#define ESM_ERR_SIG_POKLV_UV   WKUP_ESM_ERR_SIG_POKLV_UV

◆ ESM_ERR_SIG_PORHV_UV

#define ESM_ERR_SIG_PORHV_UV   WKUP_ESM_ERR_SIG_PORHV_UV

◆ ESM_ERR_SIG_VDDA_IN

#define ESM_ERR_SIG_VDDA_IN   WKUP_ESM_ERR_SIG_VDDA_IN

◆ ESM_ERR_SIG_VDD_CORE_UV

#define ESM_ERR_SIG_VDD_CORE_UV   WKUP_ESM_ERR_SIG_VDD_CORE_UV

◆ ESM_ERR_SIG_VDDSHV_WKUP_GEN_UV

#define ESM_ERR_SIG_VDDSHV_WKUP_GEN_UV   WKUP_ESM_ERR_SIG_VDDSHV_WKUP_GEN_UV

◆ ESM_ERR_SIG_VDD_CPU_UV

#define ESM_ERR_SIG_VDD_CPU_UV   WKUP_ESM_ERR_SIG_VDD_CPU_UV

◆ ESM_ERR_SIG_VDDR_MCU_UV

#define ESM_ERR_SIG_VDDR_MCU_UV   WKUP_ESM_ERR_SIG_VDDR_MCU_UV

◆ ESM_ERR_SIG_VMON_EXT_UV

#define ESM_ERR_SIG_VMON_EXT_UV   WKUP_ESM_ERR_SIG_VMON_EXT_UV

◆ ESM_ERR_SIG_VDD_MCU_OV

#define ESM_ERR_SIG_VDD_MCU_OV   WKUP_ESM_ERR_SIG_VDD_MCU_OV

◆ ESM_ERR_SIG_VDDR_CORE_UV

#define ESM_ERR_SIG_VDDR_CORE_UV   WKUP_ESM_ERR_SIG_VDDR_CORE_UV

◆ ESM_ERR_SIG_VDDSHV_WKUP_GEN_OV

#define ESM_ERR_SIG_VDDSHV_WKUP_GEN_OV   WKUP_ESM_ERR_SIG_VDDSHV_WKUP_GEN_OV

◆ ESM_ERR_SIG_VDD_CORE_OV

#define ESM_ERR_SIG_VDD_CORE_OV   WKUP_ESM_ERR_SIG_VDD_CORE_OV

◆ ESM_ERR_SIG_VDDR_MCU_OV

#define ESM_ERR_SIG_VDDR_MCU_OV   WKUP_ESM_ERR_SIG_VDDR_MCU_OV

◆ ESM_ERR_SIG_VDD_CPU_OV

#define ESM_ERR_SIG_VDD_CPU_OV   WKUP_ESM_ERR_SIG_VDD_CPU_OV

◆ ESM_ERR_SIG_VDDR_CORE_OV

#define ESM_ERR_SIG_VDDR_CORE_OV   WKUP_ESM_ERR_SIG_VDDR_CORE_OV

◆ ESM_ERR_SIG_VMON_EXT_OV

#define ESM_ERR_SIG_VMON_EXT_OV   WKUP_ESM_ERR_SIG_VMON_EXT_OV