PDK API Guide for J721E
Pmic_CoreHandle_t Struct Reference

Detailed Description

: PMIC Interface Handle. Contains various PMIC driver instance specific info - the PMIC device type, PMIC interface mode, Slave address, various application defined API function pointers for LLD and Critical sections Note - Driver will configure the Pmic Handle info. User should Ensure that Application shall not update/configure the PMIC Handle info.

Parameters
pPmic_SubSysInfoPMIC driver subsystem information
drvInitStatusPMIC Driver initialization status Valid driver status: Main instance: DRV_INIT_STATUS | PMIC_MAIN_INST QA instance: DRV_INIT_STATUS | PMIC_QA_INST
pmicDeviceTypePMIC device type
commModeInterface mode - Single I2C, Dual I2C or SPI
slaveAddrMain Interface Slave Address
qaSlaveAddrWDOG QA Interface Slave Address
crcEnableParameter to enable/disable CRC
pFnPmicCommIoReadPointer to I2C/SPI Comm LLD Read Function
pFnPmicCommIoWritePointer to I2C/SPI Comm LLD Write Function
pCommHandlePointer to Handle for I2C1/SPI Main Interface
pQACommHandlePointer to Handle for I2C2-QA Interface
pFnPmicCritSecStartPointer to Pmic Critical-Section Start Function
pFnPmicCritSecStopPointer to Pmic Critical-Section Stop Function

Data Fields

Pmic_DevSubSysInfo_tpPmic_SubSysInfo
 
uint32_t drvInitStatus
 
uint8_t pmicDeviceType
 
uint8_t commMode
 
uint8_t slaveAddr
 
uint8_t qaSlaveAddr
 
bool crcEnable
 
void * pCommHandle
 
void * pQACommHandle
 
int32_t(* pFnPmicCommIoRead )(struct Pmic_CoreHandle_s *pmicCorehandle, uint8_t instType, uint16_t regAddr, uint8_t *pRxBuf, uint8_t bufLen)
 
int32_t(* pFnPmicCommIoWrite )(struct Pmic_CoreHandle_s *pmicCorehandle, uint8_t instType, uint16_t regAddr, uint8_t *pTxBuf, uint8_t bufLen)
 
void(* pFnPmicCritSecStart )(void)
 
void(* pFnPmicCritSecStop )(void)
 

Field Documentation

Pmic_DevSubSysInfo_t* Pmic_CoreHandle_t::pPmic_SubSysInfo
uint32_t Pmic_CoreHandle_t::drvInitStatus
uint8_t Pmic_CoreHandle_t::pmicDeviceType
uint8_t Pmic_CoreHandle_t::commMode
uint8_t Pmic_CoreHandle_t::slaveAddr
uint8_t Pmic_CoreHandle_t::qaSlaveAddr
bool Pmic_CoreHandle_t::crcEnable
void* Pmic_CoreHandle_t::pCommHandle
void* Pmic_CoreHandle_t::pQACommHandle
int32_t(* Pmic_CoreHandle_t::pFnPmicCommIoRead) (struct Pmic_CoreHandle_s *pmicCorehandle, uint8_t instType, uint16_t regAddr, uint8_t *pRxBuf, uint8_t bufLen)
int32_t(* Pmic_CoreHandle_t::pFnPmicCommIoWrite) (struct Pmic_CoreHandle_s *pmicCorehandle, uint8_t instType, uint16_t regAddr, uint8_t *pTxBuf, uint8_t bufLen)
void(* Pmic_CoreHandle_t::pFnPmicCritSecStart) (void)
void(* Pmic_CoreHandle_t::pFnPmicCritSecStop) (void)