pmic_esm.h File Reference

Introduction

PMIC Low Level Driver API/interface file for ESM API.

Go to the source code of this file.

Data Structures
struct	Pmic_EsmCfg_t
	PMIC ESM Configuration structure Note: validParams is input param for all Set and Get APIs. other params except validParams is input param for Set APIs and output param for Get APIs. More...
struct	Pmic_EsmIntrCfg_t
	PMIC ESM Interrupt Configuration Structure. More...

Macros
PMIC ESM types
#define	PMIC_ESM_MODE_MCU   (bool)false
#define	PMIC_ESM_MODE_SOC   (bool)true
PMIC ESM Start/Stop state
#define	PMIC_ESM_STOP   (bool)false
#define	PMIC_ESM_START   (bool)true
PMIC ESM Enable/Disable
#define	PMIC_ESM_DISABLE   (bool)false
#define	PMIC_ESM_ENABLE   (bool)true
PMIC ESM Modes
#define	PMIC_ESM_LEVEL_MODE   (bool)false
#define	PMIC_ESM_PWM_MODE   (bool)true
PMIC ESM EN DRV Clear CFG
#define	PMIC_ESM_ERR_EN_DRV_CLEAR_DISABLE   (bool)false
#define	PMIC_ESM_ERR_EN_DRV_CLEAR_ENABLE   (bool)true
PMIC ESM Interrupt enable/disable
#define	PMIC_ESM_INTERRUPT_DISABLE   (bool)false
#define	PMIC_ESM_INTERRUPT_ENABLE   (bool)true
PMIC Pmic_EsmCfg_s member configuration type
#define	PMIC_ESM_CFG_DELAY1_VALID   (0x00U)
	validParams value used to set/get ESM delay-1 time interval More...
#define	PMIC_ESM_CFG_DELAY2_VALID   (0x01U)
	validParams value used to set/get ESM delay-2 time interval More...
#define	PMIC_ESM_CFG_ERR_CNT_THR_VALID   (0x02U)
	validParams value used to set/get ESM Error count Threshold value More...
#define	PMIC_ESM_CFG_HMAX_VALID   (0x03U)
	validParams value used to set/get ESM Maximum high-pulse time-threshold value More...
#define	PMIC_ESM_CFG_HMIN_VALID   (0x04U)
	validParams value used to set/get ESM Minimum high-pulse time-threshold value More...
#define	PMIC_ESM_CFG_LMAX_VALID   (0x05U)
	validParams value used to set/get ESM Maximum low-pulse time-threshold value More...
#define	PMIC_ESM_CFG_LMIN_VALID   (0x06U)
	validParams value used to set/get ESM Minimum low-pulse time-threshold value More...
#define	PMIC_ESM_CFG_EN_DRV_VALID   (0x07U)
	validParams value used to set/get ESM ENABLE_DRV clear configuration More...
#define	PMIC_ESM_CFG_MODE_VALID   (0x08U)
	validParams value used to set/get ESM mode More...
PMIC ESM Configuration Structure Param Bit shift values
Application can use the below shifted values to set the validParams struct member defined in Pmic_EsmCfg_t structure.
#define	PMIC_ESM_CFG_DELAY1_VALID_SHIFT   (0x01U << PMIC_ESM_CFG_DELAY1_VALID)
#define	PMIC_ESM_CFG_DELAY2_VALID_SHIFT   (0x01U << PMIC_ESM_CFG_DELAY2_VALID)
#define	PMIC_ESM_CFG_ERR_CNT_THR_VALID_SHIFT   (0x01U << PMIC_ESM_CFG_ERR_CNT_THR_VALID)
#define	PMIC_ESM_CFG_HMAX_VALID_SHIFT   (0x01U << PMIC_ESM_CFG_HMAX_VALID)
#define	PMIC_ESM_CFG_HMIN_VALID_SHIFT   (0x01U << PMIC_ESM_CFG_HMIN_VALID)
#define	PMIC_ESM_CFG_LMAX_VALID_SHIFT   (0x01U << PMIC_ESM_CFG_LMAX_VALID)
#define	PMIC_ESM_CFG_LMIN_VALID_SHIFT   (0x01U << PMIC_ESM_CFG_LMIN_VALID)
#define	PMIC_ESM_CFG_EN_DRV_VALID_SHIFT   (0x01U << PMIC_ESM_CFG_EN_DRV_VALID)
#define	PMIC_ESM_CFG_MODE_VALID_SHIFT   (0x01U << PMIC_ESM_CFG_MODE_VALID)

Functions
int32_t	Pmic_esmStart (Pmic_CoreHandle_t *pPmicCoreHandle, const bool esmType, const bool esmState)
	API to start PMIC ESM. More...
int32_t	Pmic_esmGetStatus (Pmic_CoreHandle_t *pPmicCoreHandle, const bool esmType, bool *pEsmState)
	API to read status of PMIC ESM is started or not. More...
int32_t	Pmic_esmEnable (Pmic_CoreHandle_t *pPmicCoreHandle, const bool esmType, const bool esmToggle)
	API to Enable/Disable PMIC ESM. More...
int32_t	Pmic_esmGetEnableState (Pmic_CoreHandle_t *pPmicCoreHandle, const bool esmType, bool *pEsmState)
	API to Read PMIC ESM Enable/Disable state. More...
int32_t	Pmic_esmSetConfiguration (Pmic_CoreHandle_t *pPmicCoreHandle, const bool esmType, const Pmic_EsmCfg_t esmCfg)
	API to Set PMIC ESM Configuration. More...
int32_t	Pmic_esmGetConfiguration (Pmic_CoreHandle_t *pPmicCoreHandle, const bool esmType, Pmic_EsmCfg_t *pEsmCfg)
	API to Get the PMIC ESM Configuration. More...
int32_t	Pmic_esmSetInterrupt (Pmic_CoreHandle_t *pPmicCoreHandle, const bool esmType, const Pmic_EsmIntrCfg_t esmIntrCfg)
	API to Set PMIC ESM Interrupts. More...
int32_t	Pmic_esmGetErrCnt (Pmic_CoreHandle_t *pPmicCoreHandle, const bool esmType, uint8_t *pEsmErrCnt)
	API to Get the current ESM Error Count. More...