PDK API Guide for J721E
PMIC Common Driver API

Introduction

This is PMIC driver common parameters and API

Files

file  pmic_core.h
 PMIC Low Level Driver API/interface file for common API.
 

Data Structures

struct  Pmic_RecovCntCfg_t
 : PMIC Recovery Counter Configuration More...
 

Functions

int32_t Pmic_SetRecoveryCntCfg (Pmic_CoreHandle_t *pPmicCoreHandle, Pmic_RecovCntCfg_t *pRecovCnt)
 : Set Recovery Counter Configuration This function configures PMIC Recovery Counter register controlling recovery count Threshold and Clear More...
 
int32_t Pmic_getRecoveryCntCfg (Pmic_CoreHandle_t *pPmicCoreHandle, uint8_t *pRecovCntCfgVal)
 : Read Recovery Count Configuration This function reads the recovery count register value More...
 

Macros

#define DRV_INIT_SUCCESS   (0xABCD0000U)
 : Indicator of valid driver instance :DRVDEF and validation code to avoid corrupted PmicHandle data on Success: (DRV_INIT_SUCCESS | Pmic_InstType_t) More...
 

PMIC Recovery Counter Configuration Type

#define PMIC_RECOV_CNT_CFLAG_THR   (0x01U)
 
#define PMIC_RECOV_CNT_CFLAG_CLR   (0x02U)
 

Macro Definition Documentation

#define DRV_INIT_SUCCESS   (0xABCD0000U)

: Indicator of valid driver instance :DRVDEF and validation code to avoid corrupted PmicHandle data on Success: (DRV_INIT_SUCCESS | Pmic_InstType_t)

#define PMIC_RECOV_CNT_CFLAG_THR   (0x01U)
#define PMIC_RECOV_CNT_CFLAG_CLR   (0x02U)

Function Documentation

int32_t Pmic_SetRecoveryCntCfg ( Pmic_CoreHandle_t pPmicCoreHandle,
Pmic_RecovCntCfg_t pRecovCnt 
)

: Set Recovery Counter Configuration This function configures PMIC Recovery Counter register controlling recovery count Threshold and Clear

Parameters
pPmicCoreHandle[IN] PMIC Interface Handle.
pRecovCnt[IN] Pointer to set configuration value for Recovery counter
Return values
PMIC_ST_SUCCESSin case of success or appropriate error code For valid values Pmic_ErrorCodes
int32_t Pmic_getRecoveryCntCfg ( Pmic_CoreHandle_t pPmicCoreHandle,
uint8_t *  pRecovCntCfgVal 
)

: Read Recovery Count Configuration This function reads the recovery count register value

Parameters
pPmicCoreHandle[IN] PMIC Interface Handle.
pRecovCntCfgVal[OUT] Pointer to store recovery counter configuration value
Return values
PMIC_ST_SUCCESSin case of success or appropriate error code For valid values Pmic_ErrorCodes