Introduction

PMIC common Driver contains Miscellaneous APIs supported by all supported PMIC Devices. Like, PMIC recovery count APIs, Read/Write Scratchpad registers APIs and PMIC nSLEEP Setup APIs.

Files
file	pmic_core.h
	PMIC Driver Common API/interface file.

file	pmic_types.h
	PMIC Driver Common data types file.

Data Structures
struct	Pmic_RecovCntCfg_t
	PMIC Recovery Counter Configuration 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_CommonCtrlCfg_t
	PMIC common control param configuration 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_MiscCtrlCfg_t
	PMIC Miscellaneous control param Configuration 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_BatteryCtrlCfg_t
	PMIC Backup Battery control param Configuration 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_CommonCtrlStat_t
	PMIC common control param status Note: validParams is input param for all Get APIs. other params except validParams is output param for Get APIs. More...

struct	Pmic_DeviceInfo_t
	PMIC Device Information. More...

struct	Pmic_DevSubSysInfo_t
	PMIC Subsystems. More...

struct	Pmic_CoreHandle_t
	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. More...

Functions
int32_t	Pmic_setRecoveryCntCfg (Pmic_CoreHandle_t *pPmicCoreHandle, const Pmic_RecovCntCfg_t recovCntCfg)
	API to Set Recovery Counter Configuration. More...

int32_t	Pmic_getRecoveryCntCfg (Pmic_CoreHandle_t pPmicCoreHandle, Pmic_RecovCntCfg_t pRecovCntCfg)
	API to Get Recovery Counter Configuration. More...

int32_t	Pmic_getRecoveryCnt (Pmic_CoreHandle_t pPmicCoreHandle, uint8_t pRecovCntVal)
	API to Read Recovery Count Value. More...

int32_t	Pmic_setScratchPadValue (Pmic_CoreHandle_t *pPmicCoreHandle, const uint8_t scratchPadRegNum, const uint8_t data)
	API to set/write value in/to scratchpad register. More...

int32_t	Pmic_getScratchPadValue (Pmic_CoreHandle_t pPmicCoreHandle, const uint8_t scratchPadRegNum, uint8_t pData)
	API to get/read data from scratchpad register. More...

int32_t	Pmic_setUserSpareValue (Pmic_CoreHandle_t *pPmicCoreHandle, const uint8_t userSpareRegNum, const uint8_t data)
	API to set/write value in/to User Spare register. More...

int32_t	Pmic_getUserSpareValue (Pmic_CoreHandle_t pPmicCoreHandle, const uint8_t userSpareRegNum, uint8_t pData)
	API to get/read data from User Spare register. More...

int32_t	Pmic_setCommonCtrlConfig (Pmic_CoreHandle_t *pPmicCoreHandle, const Pmic_CommonCtrlCfg_t commonCtrlCfg)
	API to set PMIC common control parameter configuration. More...

int32_t	Pmic_getCommonCtrlConfig (Pmic_CoreHandle_t pPmicCoreHandle, Pmic_CommonCtrlCfg_t pCommonCtrlCfg)
	API to get PMIC common control parameter configuration. More...

int32_t	Pmic_setMiscCtrlConfig (Pmic_CoreHandle_t *pPmicCoreHandle, const Pmic_MiscCtrlCfg_t miscCtrlCfg)
	API to set PMIC Miscellaneous control parameter configuration. More...

int32_t	Pmic_getMiscCtrlConfig (Pmic_CoreHandle_t pPmicCoreHandle, Pmic_MiscCtrlCfg_t pMiscCtrlCfg)
	API to get PMIC Miscellaneous control parameter configuration. More...

int32_t	Pmic_setBatteryCtrlConfig (Pmic_CoreHandle_t *pPmicCoreHandle, const Pmic_BatteryCtrlCfg_t batteryCtrlCfg)
	API to set PMIC Battery Backup control parameter configuration. More...

int32_t	Pmic_getBatteryCtrlConfig (Pmic_CoreHandle_t pPmicCoreHandle, Pmic_BatteryCtrlCfg_t pBatteryCtrlCfg)
	API to get PMIC Battery Backup control parameter configuration. 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...

int32_t	Pmic_getPinValue (Pmic_CoreHandle_t pPmicCoreHandle, const uint8_t pinType, uint8_t pPinValue)
	API to get PMIC GPIO NRSTOUT_SOC/ NRSTOUT/ EN_DRV Pin. More...

int32_t	Pmic_getCommonCtrlStat (Pmic_CoreHandle_t pPmicCoreHandle, Pmic_CommonCtrlStat_t pCommonCtrlStat)
	API to get PMIC common control parameter status. More...

int32_t	Pmic_getI2CSpeed (Pmic_CoreHandle_t pPmicCoreHandle, uint8_t pI2C1Speed, uint8_t *pI2C2Speed)
	API to get configured value for I2C1 or I2C2 Speed based on commMode. More...

int32_t	Pmic_enableCRC (Pmic_CoreHandle_t *pPmicCoreHandle)
	API to Enable CRC. More...

int32_t	Pmic_getCrcStatus (Pmic_CoreHandle_t pPmicCoreHandle, uint8_t pI2c1SpiCrcStatus, uint8_t *pI2c2CrcStatus)
	API to get CRC Status. More...

int32_t	Pmic_getDeviceInfo (Pmic_CoreHandle_t pPmicCoreHandle, Pmic_DeviceInfo_t pDeviceInfo)
	API to get PMIC Device Information. More...

int32_t	Pmic_setI2CSpeedCfg (Pmic_CoreHandle_t *pPmicCoreHandle)
	API to set I2C1 or I2C2 Speed based on commMode. More...

Macros
#define	DRV_INIT_SUCCESS (0xABCD0000U)
	PMIC driver Core Handle INIT status Magic Number. Used to validate Handle to avoid corrupted PmicHandle usage. on Success: (DRV_INIT_SUCCESS \| Pmic_InstType_t) More...

#define	PMIC_SILICON_REV_ID_PG_2_0 (0x08U)
	Silicon Revision Id - PG 2.0 for TPS6594x Leo and LP8764x Hera. More...

#define	PMIC_SILICON_REV_ID_PG_1_0 (0x0U)
	Silicon Revision Id - PG 1.0 for TPS6594x Leo and LP8764x Hera. More...

PMIC Recovery Counter Configuration Type

#define	PMIC_CFG_RECOV_CNT_THR_VAL_VALID (0U)
	validParams value used to set/get Recovery Counter Threshold Value More...

#define	PMIC_CFG_RECOV_CNT_CLR_CNT_VALID (1U)
	validParams value used to Clear/get Recovery Counter Value More...

PMIC Recovery Count Configuration Structure Param Bit shift values
Application can use below shifted values to set the validParams struct members defined in Pmic_RecovCntCfg_t structure
#define	PMIC_CFG_RECOV_CNT_THR_VAL_VALID_SHIFT (1U << PMIC_CFG_RECOV_CNT_THR_VAL_VALID)

#define	PMIC_CFG_RECOV_CNT_CLR_CNT_VALID_SHIFT (1U << PMIC_CFG_RECOV_CNT_CLR_CNT_VALID)

PMIC Scratchpad register selection

#define	PMIC_SCRATCH_PAD_REG_1 (0x0U)

#define	PMIC_SCRATCH_PAD_REG_2 (0x1U)

#define	PMIC_SCRATCH_PAD_REG_3 (0x2U)

#define	PMIC_SCRATCH_PAD_REG_4 (0x3U)

PMIC User Spare register selection

#define	PMIC_USER_SPARE_REG_1 (0x0U)

#define	PMIC_USER_SPARE_REG_2 (0x1U)

#define	PMIC_USER_SPARE_REG_3 (0x2U)

#define	PMIC_USER_SPARE_REG_4 (0x3U)

PMIC User Spare register Value

#define	PMIC_USER_SPARE_REG_VAL_0 (0x0U)

#define	PMIC_USER_SPARE_REG_VAL_1 (0x1U)

PMIC Common control param status Structure Param Bits
PMIC valid params configuration type for the structure member validParams of Pmic_CommonCtrlStat_t structure
#define	PMIC_CFG_BB_EOC_INDICATION_STAT_VALID (0U)
	validParams value used to get Backup Battery End of charge Indication Status More...

#define	PMIC_CFG_REGISTER_LOCK_STAT_VALID (1U)
	validParams value used to get Register lock status More...

#define	PMIC_CFG_EXT_CLK_VALIDITY_STAT_VALID (2U)
	validParams value used to get External clock validity status More...

#define	PMIC_CFG_STARTUP_PIN_STAT_VALID (3U)
	validParams value used to get Startup(nPWRON/Enable) pin status More...

#define	PMIC_CFG_EN_DRV_PIN_STAT_VALID (4U)
	validParams value used to get EN_DRV Pin status More...

#define	PMIC_CFG_NRSTOUTSOC_PIN_STAT_VALID (5U)
	validParams value used to get nRSTOUT_SOC Pin status More...

#define	PMIC_CFG_NRSTOUT_PIN_STAT_VALID (6U)
	validParams value used to get nRSTOUT Pin status More...

#define	PMIC_CFG_NINT_PIN_STAT_VALID (7U)
	validParams value used to get nINT Pin status More...

#define	PMIC_CFG_SPMI_LPM_STAT_VALID (8U)
	validParams value used to get SPMI Low Power Mode status More...

#define	PMIC_CFG_FORCE_ENABLE_DRV_LOW_STAT_VALID (9U)
	validParams value used to get status of ENABLE_DRV Configuration by I2C/SPI More...

PMIC Common Control param status valid param bit shift values
Application can use below shifted values to set the validParam member defined in Pmic_CommonCtrlStat_t structure
#define	PMIC_CFG_BB_EOC_INDICATION_STAT_VALID_SHIFT (1U << PMIC_CFG_BB_EOC_INDICATION_STAT_VALID)

#define	PMIC_CFG_REGISTER_LOCK_STAT_VALID_SHIFT (1U << PMIC_CFG_REGISTER_LOCK_STAT_VALID)

#define	PMIC_CFG_EXT_CLK_VALIDITY_STAT_VALID_SHIFT (1U << PMIC_CFG_EXT_CLK_VALIDITY_STAT_VALID)

#define	PMIC_CFG_STARTUP_PIN_STAT_VALID_SHIFT (1U << PMIC_CFG_STARTUP_PIN_STAT_VALID)

#define	PMIC_CFG_EN_DRV_PIN_STAT_VALID_SHIFT (1U << PMIC_CFG_EN_DRV_PIN_STAT_VALID)

#define	PMIC_CFG_NRSTOUTSOC_PIN_STAT_VALID_SHIFT (1U << PMIC_CFG_NRSTOUTSOC_PIN_STAT_VALID)

#define	PMIC_CFG_NRSTOUT_PIN_STAT_VALID_SHIFT (1U << PMIC_CFG_NRSTOUT_PIN_STAT_VALID)

#define	PMIC_CFG_NINT_PIN_STAT_VALID_SHIFT (1U << PMIC_CFG_NINT_PIN_STAT_VALID)

#define	PMIC_CFG_SPMI_LPM_STAT_VALID_SHIFT (1U << PMIC_CFG_SPMI_LPM_STAT_VALID)

#define	PMIC_CFG_FORCE_ENABLE_DRV_LOW_STAT_VALID_SHIFT (1U << PMIC_CFG_FORCE_ENABLE_DRV_LOW_STAT_VALID)

PMIC signal level of the STARTUP(NPWRON/ENABLE)/ NINT / NRSTOUT_SOC/
NRSTOUT/ EN_DRV Pin
#define	PMIC_PIN_SIGNAL_LEVEL_LOW (0U)

#define	PMIC_PIN_SIGNAL_LEVEL_HIGH (1U)

PMIC Pin Type Selection as NRSTOUT_SOC/ NRSTOUT/ EN_DRV

#define	PMIC_PIN_TYPE_EN_DRV (0U)

#define	PMIC_PIN_TYPE_NRSTOUT_SOC (1U)

#define	PMIC_PIN_TYPE_NRSTOUT (2U)

PMIC ENABLE_DRV I2C/SPI configuration status

#define	PMIC_ENABLE_DRV_I2C_SPI_CONFIG_ENABLE (0U)

#define	PMIC_ENABLE_DRV_I2C_SPI_CONFIG_DISABLE (1U)

PMIC Register Lock Configuration

#define	PMIC_REGISTER_UNLOCK (0x9BU)
	Unlock PMIC Registers. More...

#define	PMIC_REGISTER_LOCK (0x10U)
	Lock PMIC Registers - Write any value other than 0x9B. Here 0x10 is used. More...

PMIC Register Lock Status

#define	PMIC_REGISTER_STATUS_UNLOCK (0x0U)

#define	PMIC_REGISTER_STATUS_LOCK (0x1U)

PMIC Spread Spectrum Configuration

#define	PMIC_SPREAD_SPECTRUM_CFG_DISABLE 0U
	Disable Spread Spectrum Configuration. More...

#define	PMIC_SPREAD_SPECTRUM_CFG_ENABLE 1U
	Enable Spread Spectrum Configuration. More...

PMIC Spread Spectrum Modulation Depth Sel

#define	PMIC_SPREAD_SPECTRUM_MODULATION_DEPTH_NONE (0U)
	No Modulation. More...

#define	PMIC_SPREAD_SPECTRUM_MODULATION_DEPTH_6_3_PERCENT (1U)
	Modulation Depth as +/- 6.3%. More...

#define	PMIC_SPREAD_SPECTRUM_MODULATION_DEPTH_8_4_PERCENT (2U)
	Modulation Depth as +/- 8.4%. More...

PMIC SPMI LPM Mode Control Status

#define	PMIC_SPMI_LPM_MODE_CTRL_CFG_DISABLED (0U)
	SPMI LPM Mode Control Configuration is Disabled. More...

#define	PMIC_SPMI_LPM_MODE_CTRL_CFG_ENABLED (1U)
	SPMI LPM Mode Control Configuration is Enabled. More...

PMIC Internal Clock Monitoring Configuration

#define	PMIC_INTERNAL_CLK_MONITORING_CFG_DISABLE (0U)
	Disable Internal Clock Monitoring. More...

#define	PMIC_INTERNAL_CLK_MONITORING_CFG_ENABLE (1U)
	Enable Internal Clock Monitoring. More...

PMIC SYNCCLKOUT Frequency selection

#define	PMIC_SYNCCLKOUT_DISABLE (0U)
	DISABLE SYNCCLKOUT. More...

#define	PMIC_SYNCCLKOUT_1_1_MHZ (1U)
	SYNCCLKOUT Frequency as 1.1 MHz. More...

#define	PMIC_SYNCCLKOUT_2_2_MHZ (2U)
	SYNCCLKOUT Frequency as 2.2 MHz. More...

#define	PMIC_SYNCCLKOUT_4_4_MHZ (3U)
	SYNCCLKOUT Frequency as 4.4 MHz. More...

PMIC External Clock selection

#define	PMIC_INTERNAL_RC_OSC (0U)
	Forced to Internal RC Oscillator. More...

#define	PMIC_AUTOMATIC_EXT_CLK (1U)
	Selects External clock when Available. More...

PMIC External Clock Validity Status

#define	PMIC_EXT_CLK_STATUS_VALID (0U)

#define	PMIC_EXT_CLK_STATUS_INVALID (1U)

PMIC CRC Status for I2C1/I2C2/SPI

#define	PMIC_CRC_STATUS_DISABLED (0U)
	CRC is disabled. More...

#define	PMIC_CRC_STATUS_ENABLED (1U)
	CRC is enabled. More...

PMIC Common Control Configuration Structure Param Bits
PMIC valid params configuration type for the structure member validParams of Pmic_CommonCtrlCfg_t structure
#define	PMIC_CFG_SPREAD_SPECTRUM_EN_VALID (0U)
	validParams value used to set/get Spread Spectrum Enable/Disable More...

#define	PMIC_CFG_ENABLE_DRV_VALID (1U)
	validParams value used to set/get ENABLE_DRV pin configuration More...

#define	PMIC_CFG_REG_LOCK_VALID (2U)
	validParams value used to set/get Register Lock configuration More...

#define	PMIC_CFG_SPREAD_SPECTRUM_DEPTH_VALID (3U)
	validParams value used to set/get Spread Spectrum modulation Depth Value More...

#define	PMIC_CFG_EEPROM_DEFAULT_VALID (4U)
	validParams value used to set/get to Enable/Disable load from EEPROM defaults on RTC Domain(TPS6594X Leo)/ conf(LP8764x Hera) registers More...

#define	PMIC_CFG_SKIP_EEPROM_LOAD_VALID (5U)
	validParams value used to set/get to Enable/Disable to skip EEPROM defaults load on conf and Other registers Valid only for LP8764x Hera More...

PMIC Common Control Configuration valid param bit shift values
Application can use below shifted values to set the validParam member defined in Pmic_CommonCtrlCfg_t structure
#define	PMIC_CFG_SPREAD_SPECTRUM_EN_VALID_SHIFT (1U << PMIC_CFG_SPREAD_SPECTRUM_EN_VALID)

#define	PMIC_CFG_ENABLE_DRV_VALID_SHIFT (1U << PMIC_CFG_ENABLE_DRV_VALID)

#define	PMIC_CFG_REG_LOCK_VALID_SHIFT (1U << PMIC_CFG_REG_LOCK_VALID)

#define	PMIC_CFG_SPREAD_SPECTRUM_DEPTH_VALID_SHIFT (1U << PMIC_CFG_SPREAD_SPECTRUM_DEPTH_VALID)

#define	PMIC_CFG_EEPROM_DEFAULT_VALID_SHIFT (1U << PMIC_CFG_EEPROM_DEFAULT_VALID)

#define	PMIC_CFG_SKIP_EEPROM_LOAD_VALID_SHIFT (1U << PMIC_CFG_SKIP_EEPROM_LOAD_VALID)

PMIC Miscellaneous Control Configuration Structure Param Bits
PMIC valid params configuration type for the structure member validParams of Pmic_MiscCtrlCfg_t structure
#define	PMIC_CFG_AMUX_OUT_REF_OUT_EN_VALID (0U)
	validParams value used to set/get to Enable/Disable Band gap Voltage to AMUX OUT/REF OUT Pin More...

#define	PMIC_CFG_CLK_MON_EN_VALID (1U)
	validParams value used to set/get to Enable or Disable internal Clock Monitoring More...

#define	PMIC_CFG_SYNC_CLK_OUT_FREQ_SEL_VALID (2U)
	validParams value used to set/get to Select SYNCCLKOUT Frequency More...

#define	PMIC_CFG_EXT_CLK_SEL_VALID (3U)
	validParams value used to set/get External clock Selection More...

#define	PMIC_CFG_SYNC_CLK_IN_FREQ_VALID (4U)
	validParams value used to set/get to Select External clock Frequency More...

#define	PMIC_CFG_NRSTOUT_SOC_VALID (5U)
	validParams value used to set/get to NRSTOUT_SOC Signal More...

#define	PMIC_CFG_NRSTOUT_VALID (6U)
	validParams value used to set/get NRSTOUT Signal More...

PMIC Miscellaneous Control Configuration valid param bit shift
values Application can use below shifted values to set the validParam member defined in Pmic_MiscCtrlCfg_t structure
#define	PMIC_CFG_AMUX_OUT_REF_OUT_EN_VALID_SHIFT (1U << PMIC_CFG_AMUX_OUT_REF_OUT_EN_VALID)

#define	PMIC_CFG_CLK_MON_EN_VALID_SHIFT (1U << PMIC_CFG_CLK_MON_EN_VALID)

#define	PMIC_CFG_SYNC_CLK_OUT_FREQ_SEL_VALID_SHIFT (1U << PMIC_CFG_SYNC_CLK_OUT_FREQ_SEL_VALID)

#define	PMIC_CFG_EXT_CLK_SEL_VALID_SHIFT (1U << PMIC_CFG_EXT_CLK_SEL_VALID)

#define	PMIC_CFG_SYNC_CLK_IN_FREQ_VALID_SHIFT (1U << PMIC_CFG_SYNC_CLK_IN_FREQ_VALID)

#define	PMIC_CFG_NRSTOUT_SOC_VALID_SHIFT (1U << PMIC_CFG_NRSTOUT_SOC_VALID)

#define	PMIC_CFG_NRSTOUT_VALID_SHIFT (1U << PMIC_CFG_NRSTOUT_VALID)

PMIC Backup Battery Control Configuration Structure Param Bits
PMIC valid params configuration type for the structure member validParams of Pmic_BatteryCtrlCfg_t structure
#define	PMIC_CFG_CHARGING_EN_VALID (0U)
	validParams value used to set/get to Enable/Disable Backup Battery Charging More...

#define	PMIC_CFG_END_OF_CHARGE_VOLTAGE_VALID (1U)
	validParams value used to set/get to Backup Battery configuration for End of charge Voltage More...

#define	PMIC_CFG_CHARGE_CURRENT_VALID (2U)
	validParams value used to set/get to Backup Battery charging current value More...

PMIC Backup Battery Control Configuration valid param bit shift
values Application can use below shifted values to set the validParam member defined in Pmic_BatteryCtrlCfg_t structure
#define	PMIC_CFG_CHARGING_EN_VALID_SHIFT (1U << PMIC_CFG_CHARGING_EN_VALID)

#define	PMIC_CFG_END_OF_CHARGE_VOLTAGE_VALID_SHIFT (1U << PMIC_CFG_END_OF_CHARGE_VOLTAGE_VALID)

#define	PMIC_CFG_CHARGE_CURRENT_VALID_SHIFT (1U << PMIC_CFG_CHARGE_CURRENT_VALID)

PMIC CRC Enable/Disable Configuration

#define	PMIC_CRC_DISABLE (0U)

#define	PMIC_CRC_ENABLE (1U)

Macro Definition Documentation

◆ DRV_INIT_SUCCESS

#define DRV_INIT_SUCCESS (0xABCD0000U)

PMIC driver Core Handle INIT status Magic Number. Used to validate Handle to avoid corrupted PmicHandle usage. on Success: (DRV_INIT_SUCCESS | Pmic_InstType_t)

◆ PMIC_SILICON_REV_ID_PG_2_0

#define PMIC_SILICON_REV_ID_PG_2_0 (0x08U)

Silicon Revision Id - PG 2.0 for TPS6594x Leo and LP8764x Hera.

◆ PMIC_SILICON_REV_ID_PG_1_0

#define PMIC_SILICON_REV_ID_PG_1_0 (0x0U)

Silicon Revision Id - PG 1.0 for TPS6594x Leo and LP8764x Hera.

◆ PMIC_CFG_RECOV_CNT_THR_VAL_VALID

#define PMIC_CFG_RECOV_CNT_THR_VAL_VALID (0U)

validParams value used to set/get Recovery Counter Threshold Value

◆ PMIC_CFG_RECOV_CNT_CLR_CNT_VALID

#define PMIC_CFG_RECOV_CNT_CLR_CNT_VALID (1U)

validParams value used to Clear/get Recovery Counter Value

◆ PMIC_CFG_RECOV_CNT_THR_VAL_VALID_SHIFT

#define PMIC_CFG_RECOV_CNT_THR_VAL_VALID_SHIFT (1U << PMIC_CFG_RECOV_CNT_THR_VAL_VALID)

◆ PMIC_CFG_RECOV_CNT_CLR_CNT_VALID_SHIFT

#define PMIC_CFG_RECOV_CNT_CLR_CNT_VALID_SHIFT (1U << PMIC_CFG_RECOV_CNT_CLR_CNT_VALID)

◆ PMIC_SCRATCH_PAD_REG_1

#define PMIC_SCRATCH_PAD_REG_1 (0x0U)

◆ PMIC_SCRATCH_PAD_REG_2

#define PMIC_SCRATCH_PAD_REG_2 (0x1U)

◆ PMIC_SCRATCH_PAD_REG_3

#define PMIC_SCRATCH_PAD_REG_3 (0x2U)

◆ PMIC_SCRATCH_PAD_REG_4

#define PMIC_SCRATCH_PAD_REG_4 (0x3U)

◆ PMIC_USER_SPARE_REG_1

#define PMIC_USER_SPARE_REG_1 (0x0U)

◆ PMIC_USER_SPARE_REG_2

#define PMIC_USER_SPARE_REG_2 (0x1U)

◆ PMIC_USER_SPARE_REG_3

#define PMIC_USER_SPARE_REG_3 (0x2U)

◆ PMIC_USER_SPARE_REG_4

#define PMIC_USER_SPARE_REG_4 (0x3U)

◆ PMIC_USER_SPARE_REG_VAL_0

#define PMIC_USER_SPARE_REG_VAL_0 (0x0U)

◆ PMIC_USER_SPARE_REG_VAL_1

#define PMIC_USER_SPARE_REG_VAL_1 (0x1U)

◆ PMIC_CFG_BB_EOC_INDICATION_STAT_VALID

#define PMIC_CFG_BB_EOC_INDICATION_STAT_VALID (0U)

validParams value used to get Backup Battery End of charge Indication Status

◆ PMIC_CFG_REGISTER_LOCK_STAT_VALID

#define PMIC_CFG_REGISTER_LOCK_STAT_VALID (1U)

validParams value used to get Register lock status

◆ PMIC_CFG_EXT_CLK_VALIDITY_STAT_VALID

#define PMIC_CFG_EXT_CLK_VALIDITY_STAT_VALID (2U)

validParams value used to get External clock validity status

◆ PMIC_CFG_STARTUP_PIN_STAT_VALID

#define PMIC_CFG_STARTUP_PIN_STAT_VALID (3U)

validParams value used to get Startup(nPWRON/Enable) pin status

◆ PMIC_CFG_EN_DRV_PIN_STAT_VALID

#define PMIC_CFG_EN_DRV_PIN_STAT_VALID (4U)

validParams value used to get EN_DRV Pin status

◆ PMIC_CFG_NRSTOUTSOC_PIN_STAT_VALID

#define PMIC_CFG_NRSTOUTSOC_PIN_STAT_VALID (5U)

validParams value used to get nRSTOUT_SOC Pin status

◆ PMIC_CFG_NRSTOUT_PIN_STAT_VALID

#define PMIC_CFG_NRSTOUT_PIN_STAT_VALID (6U)

validParams value used to get nRSTOUT Pin status

◆ PMIC_CFG_NINT_PIN_STAT_VALID

#define PMIC_CFG_NINT_PIN_STAT_VALID (7U)

validParams value used to get nINT Pin status

◆ PMIC_CFG_SPMI_LPM_STAT_VALID

#define PMIC_CFG_SPMI_LPM_STAT_VALID (8U)

validParams value used to get SPMI Low Power Mode status

◆ PMIC_CFG_FORCE_ENABLE_DRV_LOW_STAT_VALID

#define PMIC_CFG_FORCE_ENABLE_DRV_LOW_STAT_VALID (9U)

validParams value used to get status of ENABLE_DRV Configuration by I2C/SPI

◆ PMIC_CFG_BB_EOC_INDICATION_STAT_VALID_SHIFT

#define PMIC_CFG_BB_EOC_INDICATION_STAT_VALID_SHIFT (1U << PMIC_CFG_BB_EOC_INDICATION_STAT_VALID)

◆ PMIC_CFG_REGISTER_LOCK_STAT_VALID_SHIFT

#define PMIC_CFG_REGISTER_LOCK_STAT_VALID_SHIFT (1U << PMIC_CFG_REGISTER_LOCK_STAT_VALID)

◆ PMIC_CFG_EXT_CLK_VALIDITY_STAT_VALID_SHIFT

#define PMIC_CFG_EXT_CLK_VALIDITY_STAT_VALID_SHIFT (1U << PMIC_CFG_EXT_CLK_VALIDITY_STAT_VALID)

◆ PMIC_CFG_STARTUP_PIN_STAT_VALID_SHIFT

#define PMIC_CFG_STARTUP_PIN_STAT_VALID_SHIFT (1U << PMIC_CFG_STARTUP_PIN_STAT_VALID)

◆ PMIC_CFG_EN_DRV_PIN_STAT_VALID_SHIFT

#define PMIC_CFG_EN_DRV_PIN_STAT_VALID_SHIFT (1U << PMIC_CFG_EN_DRV_PIN_STAT_VALID)

◆ PMIC_CFG_NRSTOUTSOC_PIN_STAT_VALID_SHIFT

#define PMIC_CFG_NRSTOUTSOC_PIN_STAT_VALID_SHIFT (1U << PMIC_CFG_NRSTOUTSOC_PIN_STAT_VALID)

◆ PMIC_CFG_NRSTOUT_PIN_STAT_VALID_SHIFT

#define PMIC_CFG_NRSTOUT_PIN_STAT_VALID_SHIFT (1U << PMIC_CFG_NRSTOUT_PIN_STAT_VALID)

◆ PMIC_CFG_NINT_PIN_STAT_VALID_SHIFT

#define PMIC_CFG_NINT_PIN_STAT_VALID_SHIFT (1U << PMIC_CFG_NINT_PIN_STAT_VALID)

◆ PMIC_CFG_SPMI_LPM_STAT_VALID_SHIFT

#define PMIC_CFG_SPMI_LPM_STAT_VALID_SHIFT (1U << PMIC_CFG_SPMI_LPM_STAT_VALID)

◆ PMIC_CFG_FORCE_ENABLE_DRV_LOW_STAT_VALID_SHIFT

#define PMIC_CFG_FORCE_ENABLE_DRV_LOW_STAT_VALID_SHIFT (1U << PMIC_CFG_FORCE_ENABLE_DRV_LOW_STAT_VALID)

◆ PMIC_PIN_SIGNAL_LEVEL_LOW

#define PMIC_PIN_SIGNAL_LEVEL_LOW (0U)

◆ PMIC_PIN_SIGNAL_LEVEL_HIGH

#define PMIC_PIN_SIGNAL_LEVEL_HIGH (1U)

◆ PMIC_PIN_TYPE_EN_DRV

#define PMIC_PIN_TYPE_EN_DRV (0U)

◆ PMIC_PIN_TYPE_NRSTOUT_SOC

#define PMIC_PIN_TYPE_NRSTOUT_SOC (1U)

◆ PMIC_PIN_TYPE_NRSTOUT

#define PMIC_PIN_TYPE_NRSTOUT (2U)

◆ PMIC_ENABLE_DRV_I2C_SPI_CONFIG_ENABLE

#define PMIC_ENABLE_DRV_I2C_SPI_CONFIG_ENABLE (0U)

◆ PMIC_ENABLE_DRV_I2C_SPI_CONFIG_DISABLE

#define PMIC_ENABLE_DRV_I2C_SPI_CONFIG_DISABLE (1U)

◆ PMIC_REGISTER_UNLOCK

#define PMIC_REGISTER_UNLOCK (0x9BU)

Unlock PMIC Registers.

◆ PMIC_REGISTER_LOCK

#define PMIC_REGISTER_LOCK (0x10U)

Lock PMIC Registers - Write any value other than 0x9B. Here 0x10 is used.

◆ PMIC_REGISTER_STATUS_UNLOCK

#define PMIC_REGISTER_STATUS_UNLOCK (0x0U)

◆ PMIC_REGISTER_STATUS_LOCK

#define PMIC_REGISTER_STATUS_LOCK (0x1U)

◆ PMIC_SPREAD_SPECTRUM_CFG_DISABLE

#define PMIC_SPREAD_SPECTRUM_CFG_DISABLE 0U

Disable Spread Spectrum Configuration.

◆ PMIC_SPREAD_SPECTRUM_CFG_ENABLE

#define PMIC_SPREAD_SPECTRUM_CFG_ENABLE 1U

Enable Spread Spectrum Configuration.

◆ PMIC_SPREAD_SPECTRUM_MODULATION_DEPTH_NONE

#define PMIC_SPREAD_SPECTRUM_MODULATION_DEPTH_NONE (0U)

No Modulation.

◆ PMIC_SPREAD_SPECTRUM_MODULATION_DEPTH_6_3_PERCENT

#define PMIC_SPREAD_SPECTRUM_MODULATION_DEPTH_6_3_PERCENT (1U)

Modulation Depth as +/- 6.3%.

◆ PMIC_SPREAD_SPECTRUM_MODULATION_DEPTH_8_4_PERCENT

#define PMIC_SPREAD_SPECTRUM_MODULATION_DEPTH_8_4_PERCENT (2U)

Modulation Depth as +/- 8.4%.

◆ PMIC_SPMI_LPM_MODE_CTRL_CFG_DISABLED

#define PMIC_SPMI_LPM_MODE_CTRL_CFG_DISABLED (0U)

SPMI LPM Mode Control Configuration is Disabled.

◆ PMIC_SPMI_LPM_MODE_CTRL_CFG_ENABLED

#define PMIC_SPMI_LPM_MODE_CTRL_CFG_ENABLED (1U)

SPMI LPM Mode Control Configuration is Enabled.

◆ PMIC_INTERNAL_CLK_MONITORING_CFG_DISABLE

#define PMIC_INTERNAL_CLK_MONITORING_CFG_DISABLE (0U)

Disable Internal Clock Monitoring.

◆ PMIC_INTERNAL_CLK_MONITORING_CFG_ENABLE

#define PMIC_INTERNAL_CLK_MONITORING_CFG_ENABLE (1U)

Enable Internal Clock Monitoring.

◆ PMIC_SYNCCLKOUT_DISABLE

#define PMIC_SYNCCLKOUT_DISABLE (0U)

DISABLE SYNCCLKOUT.

◆ PMIC_SYNCCLKOUT_1_1_MHZ

#define PMIC_SYNCCLKOUT_1_1_MHZ (1U)

SYNCCLKOUT Frequency as 1.1 MHz.

◆ PMIC_SYNCCLKOUT_2_2_MHZ

#define PMIC_SYNCCLKOUT_2_2_MHZ (2U)

SYNCCLKOUT Frequency as 2.2 MHz.

◆ PMIC_SYNCCLKOUT_4_4_MHZ

#define PMIC_SYNCCLKOUT_4_4_MHZ (3U)

SYNCCLKOUT Frequency as 4.4 MHz.

◆ PMIC_INTERNAL_RC_OSC

#define PMIC_INTERNAL_RC_OSC (0U)

Forced to Internal RC Oscillator.

◆ PMIC_AUTOMATIC_EXT_CLK

#define PMIC_AUTOMATIC_EXT_CLK (1U)

Selects External clock when Available.

◆ PMIC_EXT_CLK_STATUS_VALID

#define PMIC_EXT_CLK_STATUS_VALID (0U)

◆ PMIC_EXT_CLK_STATUS_INVALID

#define PMIC_EXT_CLK_STATUS_INVALID (1U)

◆ PMIC_CRC_STATUS_DISABLED

#define PMIC_CRC_STATUS_DISABLED (0U)

CRC is disabled.

◆ PMIC_CRC_STATUS_ENABLED

#define PMIC_CRC_STATUS_ENABLED (1U)

CRC is enabled.

◆ PMIC_CFG_SPREAD_SPECTRUM_EN_VALID

#define PMIC_CFG_SPREAD_SPECTRUM_EN_VALID (0U)

validParams value used to set/get Spread Spectrum Enable/Disable

◆ PMIC_CFG_ENABLE_DRV_VALID

#define PMIC_CFG_ENABLE_DRV_VALID (1U)

validParams value used to set/get ENABLE_DRV pin configuration

◆ PMIC_CFG_REG_LOCK_VALID

#define PMIC_CFG_REG_LOCK_VALID (2U)

validParams value used to set/get Register Lock configuration

◆ PMIC_CFG_SPREAD_SPECTRUM_DEPTH_VALID

#define PMIC_CFG_SPREAD_SPECTRUM_DEPTH_VALID (3U)

validParams value used to set/get Spread Spectrum modulation Depth Value

◆ PMIC_CFG_EEPROM_DEFAULT_VALID

#define PMIC_CFG_EEPROM_DEFAULT_VALID (4U)

validParams value used to set/get to Enable/Disable load from EEPROM defaults on RTC Domain(TPS6594X Leo)/ conf(LP8764x Hera) registers

◆ PMIC_CFG_SKIP_EEPROM_LOAD_VALID

#define PMIC_CFG_SKIP_EEPROM_LOAD_VALID (5U)

validParams value used to set/get to Enable/Disable to skip EEPROM defaults load on conf and Other registers Valid only for LP8764x Hera

◆ PMIC_CFG_SPREAD_SPECTRUM_EN_VALID_SHIFT

#define PMIC_CFG_SPREAD_SPECTRUM_EN_VALID_SHIFT (1U << PMIC_CFG_SPREAD_SPECTRUM_EN_VALID)

◆ PMIC_CFG_ENABLE_DRV_VALID_SHIFT

#define PMIC_CFG_ENABLE_DRV_VALID_SHIFT (1U << PMIC_CFG_ENABLE_DRV_VALID)

◆ PMIC_CFG_REG_LOCK_VALID_SHIFT

#define PMIC_CFG_REG_LOCK_VALID_SHIFT (1U << PMIC_CFG_REG_LOCK_VALID)

◆ PMIC_CFG_SPREAD_SPECTRUM_DEPTH_VALID_SHIFT

#define PMIC_CFG_SPREAD_SPECTRUM_DEPTH_VALID_SHIFT (1U << PMIC_CFG_SPREAD_SPECTRUM_DEPTH_VALID)

◆ PMIC_CFG_EEPROM_DEFAULT_VALID_SHIFT

#define PMIC_CFG_EEPROM_DEFAULT_VALID_SHIFT (1U << PMIC_CFG_EEPROM_DEFAULT_VALID)

◆ PMIC_CFG_SKIP_EEPROM_LOAD_VALID_SHIFT

#define PMIC_CFG_SKIP_EEPROM_LOAD_VALID_SHIFT (1U << PMIC_CFG_SKIP_EEPROM_LOAD_VALID)

◆ PMIC_CFG_AMUX_OUT_REF_OUT_EN_VALID

#define PMIC_CFG_AMUX_OUT_REF_OUT_EN_VALID (0U)

validParams value used to set/get to Enable/Disable Band gap Voltage to AMUX OUT/REF OUT Pin

◆ PMIC_CFG_CLK_MON_EN_VALID

#define PMIC_CFG_CLK_MON_EN_VALID (1U)

validParams value used to set/get to Enable or Disable internal Clock Monitoring

◆ PMIC_CFG_SYNC_CLK_OUT_FREQ_SEL_VALID

#define PMIC_CFG_SYNC_CLK_OUT_FREQ_SEL_VALID (2U)

validParams value used to set/get to Select SYNCCLKOUT Frequency

◆ PMIC_CFG_EXT_CLK_SEL_VALID

#define PMIC_CFG_EXT_CLK_SEL_VALID (3U)

validParams value used to set/get External clock Selection

◆ PMIC_CFG_SYNC_CLK_IN_FREQ_VALID

#define PMIC_CFG_SYNC_CLK_IN_FREQ_VALID (4U)

validParams value used to set/get to Select External clock Frequency

◆ PMIC_CFG_NRSTOUT_SOC_VALID

#define PMIC_CFG_NRSTOUT_SOC_VALID (5U)

validParams value used to set/get to NRSTOUT_SOC Signal

◆ PMIC_CFG_NRSTOUT_VALID

#define PMIC_CFG_NRSTOUT_VALID (6U)

validParams value used to set/get NRSTOUT Signal

◆ PMIC_CFG_AMUX_OUT_REF_OUT_EN_VALID_SHIFT

#define PMIC_CFG_AMUX_OUT_REF_OUT_EN_VALID_SHIFT (1U << PMIC_CFG_AMUX_OUT_REF_OUT_EN_VALID)

◆ PMIC_CFG_CLK_MON_EN_VALID_SHIFT

#define PMIC_CFG_CLK_MON_EN_VALID_SHIFT (1U << PMIC_CFG_CLK_MON_EN_VALID)

◆ PMIC_CFG_SYNC_CLK_OUT_FREQ_SEL_VALID_SHIFT

#define PMIC_CFG_SYNC_CLK_OUT_FREQ_SEL_VALID_SHIFT (1U << PMIC_CFG_SYNC_CLK_OUT_FREQ_SEL_VALID)

◆ PMIC_CFG_EXT_CLK_SEL_VALID_SHIFT

#define PMIC_CFG_EXT_CLK_SEL_VALID_SHIFT (1U << PMIC_CFG_EXT_CLK_SEL_VALID)

◆ PMIC_CFG_SYNC_CLK_IN_FREQ_VALID_SHIFT

#define PMIC_CFG_SYNC_CLK_IN_FREQ_VALID_SHIFT (1U << PMIC_CFG_SYNC_CLK_IN_FREQ_VALID)

◆ PMIC_CFG_NRSTOUT_SOC_VALID_SHIFT

#define PMIC_CFG_NRSTOUT_SOC_VALID_SHIFT (1U << PMIC_CFG_NRSTOUT_SOC_VALID)

◆ PMIC_CFG_NRSTOUT_VALID_SHIFT

#define PMIC_CFG_NRSTOUT_VALID_SHIFT (1U << PMIC_CFG_NRSTOUT_VALID)

◆ PMIC_CFG_CHARGING_EN_VALID

#define PMIC_CFG_CHARGING_EN_VALID (0U)

validParams value used to set/get to Enable/Disable Backup Battery Charging

◆ PMIC_CFG_END_OF_CHARGE_VOLTAGE_VALID

#define PMIC_CFG_END_OF_CHARGE_VOLTAGE_VALID (1U)

validParams value used to set/get to Backup Battery configuration for End of charge Voltage

◆ PMIC_CFG_CHARGE_CURRENT_VALID

#define PMIC_CFG_CHARGE_CURRENT_VALID (2U)

validParams value used to set/get to Backup Battery charging current value

◆ PMIC_CFG_CHARGING_EN_VALID_SHIFT

#define PMIC_CFG_CHARGING_EN_VALID_SHIFT (1U << PMIC_CFG_CHARGING_EN_VALID)

◆ PMIC_CFG_END_OF_CHARGE_VOLTAGE_VALID_SHIFT

#define PMIC_CFG_END_OF_CHARGE_VOLTAGE_VALID_SHIFT (1U << PMIC_CFG_END_OF_CHARGE_VOLTAGE_VALID)

◆ PMIC_CFG_CHARGE_CURRENT_VALID_SHIFT

#define PMIC_CFG_CHARGE_CURRENT_VALID_SHIFT (1U << PMIC_CFG_CHARGE_CURRENT_VALID)

◆ PMIC_CRC_DISABLE

#define PMIC_CRC_DISABLE (0U)

◆ PMIC_CRC_ENABLE

#define PMIC_CRC_ENABLE (1U)

Function Documentation

◆ Pmic_setRecoveryCntCfg()

int32_t Pmic_setRecoveryCntCfg	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		const Pmic_RecovCntCfg_t	recovCntCfg
	)

API to Set Recovery Counter Configuration.

Requirement: REQ_TAG(PDK-5809) Design: did_pmic_err_recov_cnt_cfg_readback Architecture: aid_pmic_core_misc_cfg

    This function configures PMIC Recovery Counter register, controlling
    recovery count Threshold and Clear, when corresponding validParam
    bit field is set in the Pmic_RecovCntCfg_t structure.
    For more information \ref Pmic_RecovCntCfg_t

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
recovCntCfg	[IN] Set configuration value for Recovery counter

Return values

PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_getRecoveryCntCfg()

int32_t Pmic_getRecoveryCntCfg	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		Pmic_RecovCntCfg_t *	pRecovCntCfg
	)

API to Get Recovery Counter Configuration.

Requirement: REQ_TAG(PDK-5809) Design: did_pmic_err_recov_cnt_cfg_readback Architecture: aid_pmic_core_misc_cfg

    This function gets PMIC Recovery Counter configuration values. Like,
    recovery count Threshold and Clear, when corresponding validParam
    bit field is set in the Pmic_RecovCntCfg_t structure.
    For more information \ref Pmic_RecovCntCfg_t

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
pRecovCntCfg	[IN/OUT] Pointer to store recovery counter configuration value

Return values

PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_getRecoveryCnt()

int32_t Pmic_getRecoveryCnt	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		uint8_t *	pRecovCntVal
	)

API to Read Recovery Count Value.

Requirement: REQ_TAG(PDK-5809) Design: did_pmic_err_recov_cnt_cfg_readback Architecture: aid_pmic_core_misc_cfg

    This function reads out the recovery count value.

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
pRecovCntVal	[OUT] Pointer to store recovery count value

Return values

PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_setScratchPadValue()

int32_t Pmic_setScratchPadValue	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		const uint8_t	scratchPadRegNum,
		const uint8_t	data
	)

API to set/write value in/to scratchpad register.

Requirement: REQ_TAG(PDK-5810), REQ_TAG(PDK-5843) Design: did_pmic_comm_single_i2c_cfg, did_pmic_comm_spi_cfg Architecture: aid_pmic_core_misc_cfg

     This function is used write data to scratchpad register of PMIC

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
scratchPadRegNum	[IN] ScratchPad register number Valid values Pmic_ScratchPad_Sel
data	[IN] Data/Value to be written to scratchpad.

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_getScratchPadValue()

int32_t Pmic_getScratchPadValue	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		const uint8_t	scratchPadRegNum,
		uint8_t *	pData
	)

API to get/read data from scratchpad register.

Requirement: REQ_TAG(PDK-5810), REQ_TAG(PDK-5843) Design: did_pmic_comm_single_i2c_cfg, did_pmic_comm_spi_cfg Architecture: aid_pmic_core_misc_cfg

     This function is used read data from scratchpad register of PMIC

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
scratchPadRegNum	[IN] ScratchPad register number Valid valuesPmic_ScratchPad_Sel
pData	[OUT] Parameter to hold the Data/Value read from scratchpad.

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_setUserSpareValue()

int32_t Pmic_setUserSpareValue	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		const uint8_t	userSpareRegNum,
		const uint8_t	data
	)

API to set/write value in/to User Spare register.

Requirement: REQ_TAG(PDK-9133) Design: did_pmic_user_spare_cfg_readback Architecture: aid_pmic_core_misc_cfg

     This function is used write data to User Spare register of PMIC

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
userSpareRegNum	[IN] UserSpare register number Valid values Pmic_UserSpareReg_Sel
data	[IN] Data/Value to be written to UserSpare register Valid values Pmic_UserSpareReg_Val

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_getUserSpareValue()

int32_t Pmic_getUserSpareValue	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		const uint8_t	userSpareRegNum,
		uint8_t *	pData
	)

API to get/read data from User Spare register.

Requirement: REQ_TAG(PDK-9133) Design: did_pmic_user_spare_cfg_readback Architecture: aid_pmic_core_misc_cfg

     This function is used read data from User Spare register of PMIC

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
userSpareRegNum	[IN] User Spare register number Valid values Pmic_UserSpareReg_Sel
pData	[OUT] Parameter to hold the Data/Value read from User Spare register.

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_setCommonCtrlConfig()

int32_t Pmic_setCommonCtrlConfig	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		const Pmic_CommonCtrlCfg_t	commonCtrlCfg
	)

API to set PMIC common control parameter configuration.

Requirement: REQ_TAG(PDK-9112), REQ_TAG(PDK-9114), REQ_TAG(PDK-9131), REQ_TAG(PDK-9143), REQ_TAG(PDK-9111) Design: did_pmic_common_ctrl_cfg_readback Architecture: aid_pmic_core_misc_cfg

     This function is used to set the required common control parameter
     configuration when corresponding validParam bit field is set in
     the Pmic_CommonCtrlCfg_t
     For more information \ref Pmic_CommonCtrlCfg_t

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
commonCtrlCfg	[IN] Set PMIC required common control parameter configuration.

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_getCommonCtrlConfig()

int32_t Pmic_getCommonCtrlConfig	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		Pmic_CommonCtrlCfg_t *	pCommonCtrlCfg
	)

API to get PMIC common control parameter configuration.

Requirement: REQ_TAG(PDK-9112), REQ_TAG(PDK-9114), REQ_TAG(PDK-9131), REQ_TAG(PDK-9143) Design: did_pmic_common_ctrl_cfg_readback Architecture: aid_pmic_core_misc_cfg

     This function is used to get the required common control parameter
     configuration when corresponding validParam bit field is set in
     the Pmic_CommonCtrlCfg_t
     For more information \ref Pmic_CommonCtrlCfg_t

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
pCommonCtrlCfg	[IN/OUT] Pointer to store PMIC required common control parameter configuration.

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_setMiscCtrlConfig()

int32_t Pmic_setMiscCtrlConfig	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		const Pmic_MiscCtrlCfg_t	miscCtrlCfg
	)

API to set PMIC Miscellaneous control parameter configuration.

Requirement: REQ_TAG(PDK-9132), REQ_TAG(PDK-9127), REQ_TAG(PDK-9111) Design: did_pmic_misc_ctrl_cfg_readback Architecture: aid_pmic_core_misc_cfg

     This function is used to set the required miscellaneous control
     parameter configuration when corresponding validParam bit field is
     set in the Pmic_MiscCtrlCfg_t
     For more information \ref Pmic_MiscCtrlCfg_t

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
miscCtrlCfg	[IN] Set PMIC required miscellaneous control parameter configuration.

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_getMiscCtrlConfig()

int32_t Pmic_getMiscCtrlConfig	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		Pmic_MiscCtrlCfg_t *	pMiscCtrlCfg
	)

API to get PMIC Miscellaneous control parameter configuration.

Requirement: REQ_TAG(PDK-9132), REQ_TAG(PDK-9127) Design: did_pmic_misc_ctrl_cfg_readback Architecture: aid_pmic_core_misc_cfg

     This function is used to get the required miscellaneous control
     parameter configuration when corresponding validParam bit field is
     set in the Pmic_MiscCtrlCfg_t
     For more information \ref Pmic_MiscCtrlCfg_t

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
pMiscCtrlCfg	[IN/OUT] Pointer to store PMIC required miscellaneous control parameter configuration.

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_setBatteryCtrlConfig()

int32_t Pmic_setBatteryCtrlConfig	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		const Pmic_BatteryCtrlCfg_t	batteryCtrlCfg
	)

API to set PMIC Battery Backup control parameter configuration.

Requirement: REQ_TAG(PDK-9130), REQ_TAG(PDK-9111) Design: did_pmic_battery_ctrl_cfg_readback Architecture: aid_pmic_core_misc_cfg

     This function is used to set the required Battery Backup control
     parameter configuration when corresponding validParam bit field is
     set in the Pmic_BatteryCtrlCfg_t
     For more information \ref Pmic_BatteryCtrlCfg_t

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
batteryCtrlCfg	[IN] Set PMIC required Battery Backup control parameter configuration.

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_getBatteryCtrlConfig()

int32_t Pmic_getBatteryCtrlConfig	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		Pmic_BatteryCtrlCfg_t *	pBatteryCtrlCfg
	)

API to get PMIC Battery Backup control parameter configuration. 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.

Requirement: REQ_TAG(PDK-9130) Design: did_pmic_battery_ctrl_cfg_readback Architecture: aid_pmic_core_misc_cfg

     This function is used to get the required Battery Backup control
     parameter configuration when corresponding validParam bit field is
     set in the Pmic_BatteryCtrlCfg_t
     For more information \ref Pmic_BatteryCtrlCfg_t

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
pBatteryCtrlCfg	[IN/OUT] Pointer to store PMIC required Battery Backup control parameter configuration

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_getPinValue()

int32_t Pmic_getPinValue	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		const uint8_t	pinType,
		uint8_t *	pPinValue
	)

API to get PMIC GPIO NRSTOUT_SOC/ NRSTOUT/ EN_DRV Pin.

Requirement: REQ_TAG(PDK-9137), REQ_TAG(PDK-9131) Design: did_pmic_pin_readback Architecture: aid_pmic_core_misc_cfg

     This function is used to read the signal level of the NRSTOUT_SOC/
     NRSTOUT/ EN_DRV Pin

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle
pinType	[IN] PMIC pin type. Valid values of pin type Pmic_PinType_Sel
pPinValue	[OUT] Pointer to store the status of pin type Valid values Pmic_SignalLvl

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_getCommonCtrlStat()

int32_t Pmic_getCommonCtrlStat	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		Pmic_CommonCtrlStat_t *	pCommonCtrlStat
	)

API to get PMIC common control parameter status.

Requirement: REQ_TAG(PDK-9126), REQ_TAG(PDK-9124), REQ_TAG(PDK-9130), REQ_TAG(PDK-9125), REQ_TAG(PDK-9139), REQ_TAG(PDK-9138), REQ_TAG(PDK-9112) Design: did_pmic_common_ctrl_status_readback Architecture: aid_pmic_core_misc_cfg

     This function is used to get the required common control parameter
     status when corresponding validParam bit field is set in
     the Pmic_CommonCtrlStat_t
     For more information \ref Pmic_CommonCtrlStat_t

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
pCommonCtrlStat	[IN/OUT] Pointer to store PMIC required common control parameter status.

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_getI2CSpeed()

int32_t Pmic_getI2CSpeed	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		uint8_t *	pI2C1Speed,
		uint8_t *	pI2C2Speed
	)

API to get configured value for I2C1 or I2C2 Speed based on commMode.

Requirement: REQ_TAG(PDK-9129) Design: did_pmic_i2c_speed_readback Architecture: aid_pmic_core_misc_cfg

     This function is used to get the configured value for I2C1 or
     I2C2 Speed based on commMode

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
pI2C1Speed	[OUT] Pointer to store I2C1 Speed for both PMIC_INTF_SINGLE_I2C and PMIC_INTF_DUAL_I2C interface Valid Vaues Pmic_I2CSpeedSel
pI2C2Speed	[OUT] Pointer to store I2C2 Speed for both PMIC_INTF_DUAL_I2C interface only Valid Vaues Pmic_I2CSpeedSel

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_enableCRC()

int32_t Pmic_enableCRC ( Pmic_CoreHandle_t * pPmicCoreHandle )

API to Enable CRC.

Requirement: REQ_TAG(PDK-9119) Design: did_pmic_crc_enable Architecture: aid_pmic_core_misc_cfg

     This function is used to enable CRC on Primary PMIC which enables
     CRC for I2C1, I2C2, SPI interface of both Primary and Secondary PMIC
     Note: Application shall not do reads and writes of the any
     PMIC registers for at least 2ms to allow the recalculation of the
     register CRC value due to the change
     Valid only for TPS6594x Leo PMIC PG2.0 and LP8764x Hera PMIC PG2.0

Parameters

pPmicCoreHandle [IN] PMIC Interface Handle.

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_getCrcStatus()

int32_t Pmic_getCrcStatus	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		uint8_t *	pI2c1SpiCrcStatus,
		uint8_t *	pI2c2CrcStatus
	)

API to get CRC Status.

Requirement: REQ_TAG(PDK-9329) Design: did_pmic_crc_status Architecture: aid_pmic_core_misc_cfg

     This function is used to get the CRC Status based on commMode

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
pI2c1SpiCrcStatus	[OUT] Pointer to store CRC Status for I2C1/ SPI interface Valid Vaues Pmic_CrcStatus
pI2c2CrcStatus	[OUT] Pointer to store CRC Status for I2C2 interface Valid Vaues Pmic_CrcStatus

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_getDeviceInfo()

int32_t Pmic_getDeviceInfo	(	Pmic_CoreHandle_t *	pPmicCoreHandle,
		Pmic_DeviceInfo_t *	pDeviceInfo
	)

API to get PMIC Device Information.

Requirement: REQ_TAG(PDK-9109), REQ_TAG(PDK-9110), REQ_TAG(PDK-9149), REQ_TAG(PDK-9159), REQ_TAG(PDK-9329) Design: did_pmic_dev_info_readback Architecture: aid_pmic_core_misc_cfg

     This function is used to get PMIC Device Information such as
     TI DeviceID, TI NVM ID, TI NVM Revision, TI Silicon Revision,
     Custom NVM ID
     Note: customNvmID is valid only for TPS6594x Leo PMIC PG2.0 and
     LP8764x Hera PMIC PG2.0

Parameters

pPmicCoreHandle	[IN] PMIC Interface Handle.
pDeviceInfo	[OUT] PMIC Device Information value

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

◆ Pmic_setI2CSpeedCfg()

int32_t Pmic_setI2CSpeedCfg ( Pmic_CoreHandle_t * pPmicCoreHandle )

API to set I2C1 or I2C2 Speed based on commMode.

Requirement: REQ_TAG(PDK-9129) Design: did_pmic_i2c_speed_readback Architecture: aid_pmic_core_misc_cfg

     This function is used to configure I2C1 speed for Single or Dual I2C
     Interface and I2C2 Speed for Dual I2C Interface based on commMode.

     Note: I2C Master before switching the I2C speed to HS/Standard Mode,
     I2C Master has to configure I2C1/I2C2 speed accordingly then only
     I2C Master can communicate with PMIC in HS/Standard Mode

Parameters

pPmicCoreHandle [IN] PMIC Interface Handle.

Returns: PMIC_ST_SUCCESS in case of success or appropriate error code For valid values Pmic_ErrorCodes

Introduction

Files

Data Structures

Functions

Macros

PMIC Recovery Counter Configuration Type

PMIC Recovery Count Configuration Structure Param Bit shift values

PMIC Scratchpad register selection

PMIC User Spare register selection

PMIC User Spare register Value

PMIC Common control param status Structure Param Bits

PMIC Common Control param status valid param bit shift values

PMIC signal level of the STARTUP(NPWRON/ENABLE)/ NINT / NRSTOUT_SOC/

PMIC Pin Type Selection as NRSTOUT_SOC/ NRSTOUT/ EN_DRV

PMIC ENABLE_DRV I2C/SPI configuration status

PMIC Register Lock Configuration

PMIC Register Lock Status

PMIC Spread Spectrum Configuration

PMIC Spread Spectrum Modulation Depth Sel

PMIC SPMI LPM Mode Control Status

PMIC Internal Clock Monitoring Configuration

PMIC SYNCCLKOUT Frequency selection

PMIC External Clock selection

PMIC External Clock Validity Status

PMIC CRC Status for I2C1/I2C2/SPI

PMIC Common Control Configuration Structure Param Bits

PMIC Common Control Configuration valid param bit shift values

PMIC Miscellaneous Control Configuration Structure Param Bits

PMIC Miscellaneous Control Configuration valid param bit shift

PMIC Backup Battery Control Configuration Structure Param Bits

PMIC Backup Battery Control Configuration valid param bit shift

PMIC CRC Enable/Disable Configuration

Macro Definition Documentation

◆ DRV_INIT_SUCCESS

◆ PMIC_SILICON_REV_ID_PG_2_0

◆ PMIC_SILICON_REV_ID_PG_1_0

◆ PMIC_CFG_RECOV_CNT_THR_VAL_VALID

◆ PMIC_CFG_RECOV_CNT_CLR_CNT_VALID

◆ PMIC_CFG_RECOV_CNT_THR_VAL_VALID_SHIFT

◆ PMIC_CFG_RECOV_CNT_CLR_CNT_VALID_SHIFT

◆ PMIC_SCRATCH_PAD_REG_1

◆ PMIC_SCRATCH_PAD_REG_2

◆ PMIC_SCRATCH_PAD_REG_3

◆ PMIC_SCRATCH_PAD_REG_4

◆ PMIC_USER_SPARE_REG_1

◆ PMIC_USER_SPARE_REG_2

◆ PMIC_USER_SPARE_REG_3

◆ PMIC_USER_SPARE_REG_4

◆ PMIC_USER_SPARE_REG_VAL_0

◆ PMIC_USER_SPARE_REG_VAL_1

◆ PMIC_CFG_BB_EOC_INDICATION_STAT_VALID

◆ PMIC_CFG_REGISTER_LOCK_STAT_VALID

◆ PMIC_CFG_EXT_CLK_VALIDITY_STAT_VALID

◆ PMIC_CFG_STARTUP_PIN_STAT_VALID

◆ PMIC_CFG_EN_DRV_PIN_STAT_VALID

◆ PMIC_CFG_NRSTOUTSOC_PIN_STAT_VALID

◆ PMIC_CFG_NRSTOUT_PIN_STAT_VALID

◆ PMIC_CFG_NINT_PIN_STAT_VALID

◆ PMIC_CFG_SPMI_LPM_STAT_VALID

◆ PMIC_CFG_FORCE_ENABLE_DRV_LOW_STAT_VALID

◆ PMIC_CFG_BB_EOC_INDICATION_STAT_VALID_SHIFT

◆ PMIC_CFG_REGISTER_LOCK_STAT_VALID_SHIFT

◆ PMIC_CFG_EXT_CLK_VALIDITY_STAT_VALID_SHIFT

◆ PMIC_CFG_STARTUP_PIN_STAT_VALID_SHIFT

◆ PMIC_CFG_EN_DRV_PIN_STAT_VALID_SHIFT

◆ PMIC_CFG_NRSTOUTSOC_PIN_STAT_VALID_SHIFT

◆ PMIC_CFG_NRSTOUT_PIN_STAT_VALID_SHIFT

◆ PMIC_CFG_NINT_PIN_STAT_VALID_SHIFT

◆ PMIC_CFG_SPMI_LPM_STAT_VALID_SHIFT

◆ PMIC_CFG_FORCE_ENABLE_DRV_LOW_STAT_VALID_SHIFT

◆ PMIC_PIN_SIGNAL_LEVEL_LOW

◆ PMIC_PIN_SIGNAL_LEVEL_HIGH

◆ PMIC_PIN_TYPE_EN_DRV

◆ PMIC_PIN_TYPE_NRSTOUT_SOC

◆ PMIC_PIN_TYPE_NRSTOUT

◆ PMIC_ENABLE_DRV_I2C_SPI_CONFIG_ENABLE

◆ PMIC_ENABLE_DRV_I2C_SPI_CONFIG_DISABLE

◆ PMIC_REGISTER_UNLOCK

◆ PMIC_REGISTER_LOCK

◆ PMIC_REGISTER_STATUS_UNLOCK