Pmic_CoreHandle_t Struct Reference

Detailed Description

PMIC Interface Handle. Contains various PMIC driver instance specific information. like, the PMIC device type, PMIC interface mode, Slave addresses, various application defined API function pointers for LLD and Critical sections.

Note: Pmic_init() configures the Pmic Handle information and provide pmic core handle to user application. User should ensure that application shall not modify the PMIC Handle information.

Parameters

pPmic_SubSysInfo	PMIC driver subsystem information
drvInitStatus	PMIC Driver initialization status. Valid driver status: For Main instance: DRV_INIT_STATUS | PMIC_MAIN_INST. For QA instance: DRV_INIT_STATUS | PMIC_QA_INST.
pmicDeviceType	PMIC device type
pmicDevRev	PMIC device revision ID
pmicDevSiliconRev	PMIC device silicon revision ID
commMode	Interface mode - Single I2C, Dual I2C or SPI.
slaveAddr	Main Interface Slave Address
qaSlaveAddr	WDOG QA Interface Slave Address
nvmSlaveAddr	NVM Slave Address which provides only read access to CRC status of Page-1 Application shall use this slave address to read only CRC status. Application shall not do any write operations using this slave address
i2c1Speed	I2C1 Speed when commMode is Single or Dual I2C
i2c2Speed	I2C2 Speed when commMode is Dual I2C
crcEnable	Parameter to enable/disable CRC For Valid Values: Pmic_CrcEnableCfg
pFnPmicCommIoRead	Pointer to I2C/SPI Comm LLD Read Function
pFnPmicCommIoWrite	Pointer to I2C/SPI Comm LLD Write Function
pCommHandle	Pointer to Handle for I2C1/SPI Main Interface
pQACommHandle	Pointer to Handle for I2C2-QA Interface
pFnPmicCritSecStart	Pointer to Pmic Critical-Section Start Function
pFnPmicCritSecStop	Pointer to Pmic Critical-Section Stop Function

Data Fields
const Pmic_DevSubSysInfo_t *	pPmic_SubSysInfo
uint32_t	drvInitStatus
uint8_t	pmicDeviceType
uint8_t	pmicDevRev
uint8_t	pmicDevSiliconRev
uint8_t	commMode
uint8_t	slaveAddr
uint8_t	qaSlaveAddr
uint8_t	nvmSlaveAddr
uint8_t	i2c1Speed
uint8_t	i2c2Speed
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

pPmic_SubSysInfo

const Pmic_DevSubSysInfo_t* Pmic_CoreHandle_t::pPmic_SubSysInfo

drvInitStatus

uint32_t Pmic_CoreHandle_t::drvInitStatus

pmicDeviceType

uint8_t Pmic_CoreHandle_t::pmicDeviceType

pmicDevRev

uint8_t Pmic_CoreHandle_t::pmicDevRev

pmicDevSiliconRev

uint8_t Pmic_CoreHandle_t::pmicDevSiliconRev

commMode

uint8_t Pmic_CoreHandle_t::commMode

slaveAddr

uint8_t Pmic_CoreHandle_t::slaveAddr

qaSlaveAddr

uint8_t Pmic_CoreHandle_t::qaSlaveAddr

nvmSlaveAddr

uint8_t Pmic_CoreHandle_t::nvmSlaveAddr

i2c1Speed

uint8_t Pmic_CoreHandle_t::i2c1Speed

i2c2Speed

uint8_t Pmic_CoreHandle_t::i2c2Speed

crcEnable

bool Pmic_CoreHandle_t::crcEnable

pCommHandle

void* Pmic_CoreHandle_t::pCommHandle

pQACommHandle

void* Pmic_CoreHandle_t::pQACommHandle

pFnPmicCommIoRead

int32_t(* Pmic_CoreHandle_t::pFnPmicCommIoRead) (struct Pmic_CoreHandle_s *pmicCorehandle, uint8_t instType, uint16_t regAddr, uint8_t *pRxBuf, uint8_t bufLen)

pFnPmicCommIoWrite

int32_t(* Pmic_CoreHandle_t::pFnPmicCommIoWrite) (struct Pmic_CoreHandle_s *pmicCorehandle, uint8_t instType, uint16_t regAddr, uint8_t *pTxBuf, uint8_t bufLen)

pFnPmicCritSecStart

void(* Pmic_CoreHandle_t::pFnPmicCritSecStart) (void)

pFnPmicCritSecStop

void(* Pmic_CoreHandle_t::pFnPmicCritSecStop) (void)