 |
PDK API Guide for J721E
|
|
PDK API Guide for J721E
|
This module explains about PMIC Power Resources driver parameters and API usage. PMIC Power Module covers all power resources feature APIs, which includes set/get BUCK and LDO regulator output voltage configurations, set/get volatge monitor, current monitor, power good monitor and short circuit protection configuration for external power sources, set/get thermal monitoring/shutdown of the PMIC module, APIs to configure regulator and VMON interrupts to notify the application when PMIC power related errors are found on the power Rails
Supported PMIC devices for Power Module:
Files | |
| file | pmic_power.h |
| PMIC Power Resources Driver Interface file. | |
| file | pmic_power_tps6594x.h |
| PMIC TPS6594x Leo PMIC Power Resources Driver API/interface file. | |
| file | pmic_power_lp8764x.h |
| PMIC LP8764x Leo PMIC Power Resources Driver API/interface file. | |
Data Structures | |
| struct | Pmic_PowerResourceCfg_t |
| Pmic Power resources control and 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_PowerCommonCfg_t |
| Power configuration The power control and config 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_PowerResourceStat_t |
| PMIC power status. The PMIC power and thermal status structure. Note: validParams is input param for all Get APIs. other params except validParams is output param for Get APIs. More... | |
| struct | Pmic_PowerThermalCfg_t |
| PMIC Power Thermal 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_PowerThermalStat_t |
| PMIC Power Thermal status structure Note: validParams is input param for all Get APIs. other params except validParams is output param for Get APIs. More... | |
Functions | |
| int32_t | Pmic_powerSetPwrResourceCfg (Pmic_CoreHandle_t *pPmicCoreHandle, const uint16_t pwrResource, const Pmic_PowerResourceCfg_t pwrResourceCfg) |
| API to set power resources configurations. More... | |
| int32_t | Pmic_powerGetPwrResourceCfg (Pmic_CoreHandle_t *pPmicCoreHandle, const uint16_t pwrResource, Pmic_PowerResourceCfg_t *pPwrResourceCfg) |
| API to get power resources configurations. More... | |
| int32_t | Pmic_powerSetCommonConfig (Pmic_CoreHandle_t *pPmicCoreHandle, const Pmic_PowerCommonCfg_t powerCommonCfg) |
| API to Set Power configuration. More... | |
| int32_t | Pmic_powerGetCommonConfig (Pmic_CoreHandle_t *pPmicCoreHandle, Pmic_PowerCommonCfg_t *pPowerCommonCfg) |
| API to Get Power configuration. More... | |
| int32_t | Pmic_powerSetConfigPowerGood (Pmic_CoreHandle_t *pPmicCoreHandle, const uint16_t pgoodSrcSel, const uint8_t pgoodSelType) |
| API to Set Power good configuration. More... | |
| int32_t | Pmic_powerGetConfigPowerGood (Pmic_CoreHandle_t *pPmicCoreHandle, const uint16_t pgoodSrcSel, uint8_t *pPgoodSelType) |
| Get Power good configuration. More... | |
| int32_t | Pmic_powerGetPwrRsrcStat (Pmic_CoreHandle_t *pPmicCoreHandle, const uint16_t pwrResource, Pmic_PowerResourceStat_t *pPwrRsrcStatCfg) |
| API to get power resources status. More... | |
| int32_t | Pmic_powerGetPwrThermalStat (Pmic_CoreHandle_t *pPmicCoreHandle, Pmic_PowerThermalStat_t *pPwrThermalStatCfg) |
| API to get PMIC die temperature thermal status. More... | |
| int32_t | Pmic_powerSetThermalConfig (Pmic_CoreHandle_t *pPmicCoreHandle, const Pmic_PowerThermalCfg_t thermalThreshold) |
| API to configure the thermal temperature threshold level for PMIC. More... | |
| int32_t | Pmic_powerGetThermalConfig (Pmic_CoreHandle_t *pPmicCoreHandle, Pmic_PowerThermalCfg_t *pThermalThreshold) |
| Get the PMIC thermal threshold value function. More... | |
| int32_t | Pmic_powerSetPwrRsrcIntr (Pmic_CoreHandle_t *pPmicCoreHandle, const uint16_t pwrResource, const uint8_t intrType, const bool intrEnable) |
| API to enable/disable Power interrupt. More... | |
| int32_t | Pmic_powerSetIntr (Pmic_CoreHandle_t *pPmicCoreHandle, const uint8_t intrType, const bool intrEnable) |
| API to enable/disable Power interrupt. More... | |
| int32_t | Pmic_powerSetLdoRtc (Pmic_CoreHandle_t *pPmicCoreHandle, bool ldortcEnable) |
| API to enable/disable LDORTC regulator. More... | |
| int32_t | Pmic_powerGetLdoRtc (Pmic_CoreHandle_t *pPmicCoreHandle, bool *pLdortcEnable) |
| API to get enable/disable status for LDORTC regulator. More... | |
PMIC Power Resources Config Structure Param Bits | |
|
PMIC Power Resources valid params configuration type for the structure member validParams of Pmic_PowerResourceCfg_t structure | |
| #define | PMIC_CFG_REGULATOR_VMON_RV_SEL_VALID (0U) |
| validParams value used to set/get to Enable/Disable residual voltage checking for regulator/VMON pin Valid only for VMON1/VMON2/BUCK/LDO More... | |
| #define | PMIC_CFG_REGULATOR_BUCK_PLDN_EN_VALID (1U) |
| validParams value used to set/get to Enable/Disable output pull-down resistor when BUCK is disabled. Valid only for BUCK regulator More... | |
| #define | PMIC_CFG_VMON_EN_VALID (2U) |
| validParams value used to set/get to Enable /Disable the Voltage monitor feature Valid only for VMON1/VMON2/VMON of BUCK/VMON of LDO/VMON of VCCA Power Resources More... | |
| #define | PMIC_CFG_REGULATOR_BUCK_VOUT_SEL_VALID (3U) |
| validParams value used to set/get to Select output voltage register for BUCK Valid only for BUCK regulator More... | |
| #define | PMIC_CFG_REGULATOR_BUCK_FPWM_VALID (4U) |
| validParams value used to set/get to Select PWM or Auto Mode for BUCK Valid only for BUCK regulator More... | |
| #define | PMIC_CFG_REGULATOR_BUCK_PWM_MP_VALID (5U) |
| validParams value used to set/get to Select between Multi phase with PWM OR AUTO mode with Automatic phase adding and shedding for BUCK Valid only for BUCK regulator More... | |
| #define | PMIC_CFG_REGULATOR_EN_VALID (6U) |
| validParams value used to set/get to Enable/Disable the power regulators Valid only for BUCK/LDO regulator More... | |
| #define | PMIC_CFG_REGULATOR_LDO_SLOW_RAMP_EN_VALID (7U) |
| validParams value used to set/get to Enable/Disable Slow Ramp for LDO Valid only for LDO regulator Valid only for TPS6594x Leo PMIC PG2.0 More... | |
| #define | PMIC_CFG_REGULATOR_LDO_BYPASS_MODE_EN_VALID (8U) |
| validParams value used to set/get to Select Bypass/Linear Regulator LDO mode Valid only for LDO regulator More... | |
| #define | PMIC_CFG_VCCA_PWR_GOOD_LVL_VALID (9U) |
| validParams value used to set/get Powergood level for VCCA pin Valid only for VCCA More... | |
| #define | PMIC_CFG_VMON_RANGE_VALID (10U) |
| validParams value used to set/get to Select OV/UV voltage monitoring range for VMON Valid only for VMON1/VMON2 More... | |
| #define | PMIC_CFG_REGULATOR_BUCK_ILIM_VALID (12U) |
| validParams value used to set/get Switch peak current limit for BUCK regulator Valid only for BUCK regulator More... | |
| #define | PMIC_CFG_REGULATOR_BUCK_VMON_SLEW_RATE_VALID (13U) |
| validParams value used to set/get Output voltage slew rate for BUCK/VMON Valid only for VMON1/VMON2/BUCK More... | |
| #define | PMIC_CFG_REGULATOR_LDO_PLDN_SEL_VALID (14U) |
| validParams value used to set/get to Selects the resistor value for output pull-down resistor for LDO regulator Valid only for LDO regulator More... | |
| #define | PMIC_CFG_REGULATOR_LDO_RV_TIMEOUT_SEL_VALID (15U) |
| validParams value used to set/get LDO residual voltage check timeout select Valid only for LDO regulator More... | |
| #define | PMIC_CFG_PWR_RESOURCE_PG_UV_THRESHOLD_LVL_VALID (16U) |
| validParams value used to set/get Power good low threshold level for the power resources Valid for all power resources More... | |
| #define | PMIC_CFG_PWR_RESOURCE_PG_OV_THRESHOLD_LVL_VALID (17U) |
| validParams value used to set/get Power good high threshold level for the power resources Valid for all power resources More... | |
| #define | PMIC_CFG_PWR_RESOURCE_RAIL_GRP_SEL_VALID (18U) |
| validParams value used to set/get Rail group selection for the power resources Valid for all power resources More... | |
| #define | PMIC_CFG_REGULATOR_VMON_VOLTAGE_SET_VALID (19U) |
| validParams value used to set/get Voltage level (For LDO/BUCK)/ Powergood voltage level(For VMON1/VMON2) in mv Valid only for VMON1/VMMON2/BUCK/LDO More... | |
PMIC Power Resources valid param bit shift values | |
|
Application can use below shifted values to set the validParam member defined in Pmic_PowerResourceCfg_t structure | |
| #define | PMIC_CFG_REGULATOR_VMON_RV_SEL_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_VMON_RV_SEL_VALID) |
| #define | PMIC_CFG_REGULATOR_BUCK_PLDN_EN_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_BUCK_PLDN_EN_VALID) |
| #define | PMIC_CFG_VMON_EN_VALID_SHIFT (1U << PMIC_CFG_VMON_EN_VALID) |
| #define | PMIC_CFG_REGULATOR_BUCK_VOUT_SEL_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_BUCK_VOUT_SEL_VALID) |
| #define | PMIC_CFG_REGULATOR_BUCK_FPWM_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_BUCK_FPWM_VALID) |
| #define | PMIC_CFG_REGULATOR_BUCK_PWM_MP_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_BUCK_PWM_MP_VALID) |
| #define | PMIC_CFG_REGULATOR_EN_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_EN_VALID) |
| #define | PMIC_CFG_REGULATOR_LDO_SLOW_RAMP_EN_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_LDO_SLOW_RAMP_EN_VALID) |
| #define | PMIC_CFG_REGULATOR_LDO_BYPASS_MODE_EN_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_LDO_BYPASS_MODE_EN_VALID) |
| #define | PMIC_CFG_VCCA_PWR_GOOD_LVL_VALID_SHIFT (1U << PMIC_CFG_VCCA_PWR_GOOD_LVL_VALID) |
| #define | PMIC_CFG_VMON_RANGE_VALID_SHIFT (1U << PMIC_CFG_VMON_RANGE_VALID) |
| #define | PMIC_CFG_REGULATOR_BUCK_ILIM_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_BUCK_ILIM_VALID) |
| #define | PMIC_CFG_REGULATOR_BUCK_VMON_SLEW_RATE_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_BUCK_VMON_SLEW_RATE_VALID) |
| #define | PMIC_CFG_REGULATOR_LDO_PLDN_SEL_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_LDO_PLDN_SEL_VALID) |
| #define | PMIC_CFG_REGULATOR_LDO_RV_TIMEOUT_SEL_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_LDO_RV_TIMEOUT_SEL_VALID) |
| #define | PMIC_CFG_PWR_RESOURCE_PG_UV_THRESHOLD_LVL_VALID_SHIFT (1U << PMIC_CFG_PWR_RESOURCE_PG_UV_THRESHOLD_LVL_VALID) |
| #define | PMIC_CFG_PWR_RESOURCE_PG_OV_THRESHOLD_LVL_VALID_SHIFT (1U << PMIC_CFG_PWR_RESOURCE_PG_OV_THRESHOLD_LVL_VALID) |
| #define | PMIC_CFG_PWR_RESOURCE_RAIL_GRP_SEL_VALID_SHIFT (1U << PMIC_CFG_PWR_RESOURCE_RAIL_GRP_SEL_VALID) |
| #define | PMIC_CFG_REGULATOR_VMON_VOLTAGE_SET_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_VMON_VOLTAGE_SET_VALID) |
| #define | PMIC_POWER_REGULATOR_ILIM_STAT_VALID_SHIFT (1U << PMIC_POWER_REGULATOR_ILIM_STAT_VALID) |
| #define | PMIC_POWER_RESOURCE_UV_STAT_VALID_SHIFT (1U << PMIC_POWER_RESOURCE_UV_STAT_VALID) |
| #define | PMIC_POWER_RESOURCE_OV_STAT_VALID_SHIFT (1U << PMIC_POWER_RESOURCE_OV_STAT_VALID) |
| #define | PMIC_POWER_VCCA_OV_LVL_STAT_VALID_SHIFT (1U << PMIC_POWER_VCCA_OV_LVL_STAT_VALID) |
PMIC Pmic_PowerCommonCfg_s member configuration type. | |
| #define | PMIC_POWER_PGOOD_WINDOW_VALID (0U) |
| validParams value used to set/get to Select the type of voltage monitoring for PGOOD signal More... | |
| #define | PMIC_POWER_PGOOD_POL_VALID (1U) |
| validParams value used to set/get to Select the PGOOD signal polarity More... | |
| #define | PMIC_CFG_DEGLITCH_TIME_SEL_VALID (2U) |
| validParams value used to set/get Deglitch time select for all power resources Valid only for VMON1/VMON2/VCCA/VMON of LDO/VMON of BUCK power resources Valid only for TPS6594x Leo PMIC PG2.0 and LP8764x Hera PMIC PG1.0 and PG2.0 More... | |
| #define | PMIC_SEVERE_ERR_TRIG_VALID (3U) |
| validParams value used to set/get to Select the trigger selection for severe Error More... | |
| #define | PMIC_OTHER_RAIL_TRIG_VALID (4U) |
| validParams value used to set/get to Select the trigger selection for other rail group More... | |
| #define | PMIC_SOC_RAIL_TRIG_VALID (5U) |
| validParams value used to set/get to Select the trigger selection for soc rail group More... | |
| #define | PMIC_MCU_RAIL_TRIG_VALID (6U) |
| validParams value used to set/get to Select the trigger selection for mcu rail group More... | |
| #define | PMIC_MODERATE_ERR_TRIG_VALID (7U) |
| validParams value used to set/get Select the trigger selection for Moderate Error More... | |
PMIC valid params bit shift values | |
|
Application can use below shifted values to set the validParam member defined in Pmic_PowerCommonCfg_t structure | |
| #define | PMIC_POWER_PGOOD_WINDOW_VALID_SHIFT (1U << PMIC_POWER_PGOOD_WINDOW_VALID) |
| #define | PMIC_POWER_PGOOD_POL_VALID_SHIFT (1U << PMIC_POWER_PGOOD_POL_VALID) |
| #define | PMIC_CFG_DEGLITCH_TIME_SEL_VALID_SHIFT (1U << PMIC_CFG_DEGLITCH_TIME_SEL_VALID) |
| #define | PMIC_SEVERE_ERR_TRIG_VALID_SHIFT (1U << PMIC_SEVERE_ERR_TRIG_VALID) |
| #define | PMIC_OTHER_RAIL_TRIG_VALID_SHIFT (1U << PMIC_OTHER_RAIL_TRIG_VALID) |
| #define | PMIC_SOC_RAIL_TRIG_VALID_SHIFT (1U << PMIC_SOC_RAIL_TRIG_VALID) |
| #define | PMIC_MCU_RAIL_TRIG_VALID_SHIFT (1U << PMIC_MCU_RAIL_TRIG_VALID) |
| #define | PMIC_MODERATE_ERR_TRIG_VALID_SHIFT (1U << PMIC_MODERATE_ERR_TRIG_VALID) |
PMIC Power Status Config Structure Param Bits | |
|
PMIC Power Status valid params configuration type for the structure member validParams of Pmic_PowerResourceStat_t structure. | |
| #define | PMIC_POWER_REGULATOR_ILIM_STAT_VALID (0U) |
| validParams value used to get output current limit status for LDO and buck regulators More... | |
| #define | PMIC_POWER_RESOURCE_UV_STAT_VALID (1U) |
| validParams value used to get output under voltage status for LDO/ BUCK and input under voltage status for VCCA/VMON Valid for all power resources More... | |
| #define | PMIC_POWER_RESOURCE_OV_STAT_VALID (2U) |
| validParams value used to get output over voltage status for LDO/BUCK and input over voltage status for VCCA/VMON Valid for all power resources More... | |
| #define | PMIC_POWER_VCCA_OV_LVL_STAT_VALID (3U) |
| validParams value used to get voltage level status for VCCA Valid only for VCCA More... | |
PMIC Power Thermal threshold type | |
| #define | PMIC_THERMAL_WARN_VALID (1U) |
| validParams value used to set/get thermal Warning Threshold temperature value More... | |
| #define | PMIC_THERMAL_SHTDWN_VALID (2U) |
| validParams value used to set/get Thermal Shutdown Threshold temperature value valid only for TPS6594x Leo PMIC PG2.0 and LP8764x Hera PMIC PG1.0 and PG2.0 More... | |
PMIC Power Thermal threshold type structure Param Bits shift values | |
|
Application can use below shifted values to set the validParam member defined in Pmic_PowerThermalCfg_t structure | |
| #define | PMIC_THERMAL_WARN_VALID_SHIFT (1U << PMIC_THERMAL_WARN_VALID) |
| #define | PMIC_THERMAL_SHTDWN_VALID_SHIFT (1U << PMIC_THERMAL_SHTDWN_VALID) |
PMIC Power Thermal status type | |
| #define | PMIC_THERMAL_STAT_WARN_VALID (1U) |
| validParams value used to get Thermal warning status More... | |
| #define | PMIC_THERMAL_STAT_ORD_SHTDWN_VALID (2U) |
| validParams value used to get Orderly Shutdown status More... | |
| #define | PMIC_THERMAL_STAT_IMM_SHTDWN_VALID (3U) |
| validParams value used to get Immediate Shutdown status More... | |
PMIC Power Thermal status type structure Param Bits shift values | |
|
Application can use below shifted values to set the validParam member defined in Pmic_PowerThermalStat_t structure | |
| #define | PMIC_THERMAL_STAT_WARN_VALID_SHIFT (1U << PMIC_THERMAL_STAT_WARN_VALID) |
| #define | PMIC_THERMAL_STAT_ORD_SHTDWN_VALID_SHIFT (1U << PMIC_THERMAL_STAT_ORD_SHTDWN_VALID) |
| #define | PMIC_THERMAL_STAT_IMM_SHTDWN_VALID_SHIFT (1U << PMIC_THERMAL_STAT_IMM_SHTDWN_VALID) |
PMIC Power Interrupt selection | |
| #define | PMIC_POWER_INTERRUPT_ENABLE (0U) |
| #define | PMIC_POWER_INTERRUPT_DISABLE (1U) |
Type of voltage monitoring for PGOOD signal: | |
| #define | PMIC_POWER_GOOD_UV_MONITOR_ENABLE (0x0U) |
| Only undervoltage is monitored. More... | |
| #define | PMIC_POWER_GOOD_UV_OV_MONITOR_ENABLE (0x1U) |
| Both undervoltage and overvoltage are monitored. More... | |
PGOOD signal polarity | |
| #define | PMIC_POWER_PGOOD_POL_HIGH (0x0U) |
| PGOOD signal is high when monitored inputs are valid. More... | |
| #define | PMIC_POWER_PGOOD_POL_LOW (0x1U) |
| PGOOD signal is low when monitored inputs are valid. More... | |
PMIC Power Trigger selection | |
| #define | PMIC_POWER_TRIG_IMM_SHUTDOWN (0U) |
| #define | PMIC_POWER_TRIG_ODERLY_SHUTDOWN (1U) |
| #define | PMIC_POWER_TRIG_MCU_PWR_ERR (2U) |
| #define | PMIC_POWER_TRIG_SOC_PWR_ERR (3U) |
PMIC Power Resource Type for LEO TPS6594x | |
| #define | PMIC_TPS6594X_POWER_RESOURCE_TYPE_VCCA (0U) |
| #define | PMIC_TPS6594X_POWER_RESOURCE_TYPE_BUCK (1U) |
| #define | PMIC_TPS6594X_POWER_RESOURCE_TYPE_LDO (2U) |
PMIC Residual voltage check Enable/Disable | |
|
Valid only for BUCK and LDO regulators | |
| #define | PMIC_TPS6594X_REGULATOR_RV_SEL_ENABLE (0x1U) |
| Used to enable the residual voltage check. More... | |
| #define | PMIC_TPS6594X_REGULATOR_RV_SEL_DISABLE (0x0U) |
| Used to disable the residual voltage check. More... | |
PMIC Pull-down resistor Enable/Disable for BUCK Regulator. | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_PLDN_ENABLE (0x1U) |
| Used to enable the pull down resistor for BUCK regulator. More... | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_PLDN_DISABLE (0x0U) |
| Used to disable the pull down resistor for BUCK regulator. More... | |
PMIC Voltage monitor Enable/Disable for BUCK/LDO/VCCA. Enable/Disable OV and UV comparators for LDO/VCCA. Enable/Disable OV, UV, SC and ILIM for BUCK | |
| #define | PMIC_TPS6594X_VMON_DISABLE (0x0U) |
| Used to disable the voltage monitor. More... | |
| #define | PMIC_TPS6594X_VMON_ENABLE (0x1U) |
| Used to enable the voltage monitor. More... | |
PMIC Select output voltage register for BUCK. | |
|
Valid only for BUCK Regulator | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_VOUT_SEL_VOUT2 (bool)true |
| Used to select VOUT2 register for voltage selection. More... | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_VOUT_SEL_VOUT1 (bool)false |
| Used to select VOUT1 register for voltage selection. More... | |
PMIC Select between Automatic transitions between PFM and PWM modes OR Forced to PWM operation. | |
|
Valid only for BUCK regulators. | |
| #define | PMIC_TPS6594X_REGULATOR_PWM_MODE (0x1U) |
| Used to select PWM mode. More... | |
| #define | PMIC_TPS6594X_REGULATOR_AUTO_PWM_PFM_MODE (0x0U) |
| Used to select Automatic transition between PFM and PWM modes. More... | |
PMIC Select between multi-phase operation OR AUTO mode with Automatic phase adding and shedding. | |
|
Valid only for BUCK regulators. | |
| #define | PMIC_TPS6594X_REGULATOR_PWM_MP_MODE (0x1U) |
| Used to select multi-phase operation. More... | |
| #define | PMIC_TPS6594X_REGULATOR_AUTO_PHASE_MODE (0x0U) |
| Used to select Automatic phase adding and shedding mode. More... | |
PMIC Enable/Disable BUCK/LDO Regulators. | |
| #define | PMIC_TPS6594X_REGULATOR_ENABLE (0x1U) |
| Used to enable the BUCK or LDO regulator. More... | |
| #define | PMIC_TPS6594X_REGULATOR_DISABLE (0x0U) |
| Used to disable the BUCK or LDO regulator. More... | |
PMIC Enable/Disable Slow Ramp for LDO regulator | |
|
Valid only for LDO regulators. | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_SLOW_RAMP_ENABLE (0x1U) |
| Used to enable slow ramp for LDO. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_SLOW_RAMP_DISABLE (0x0U) |
| Used to disable slow ramp for LDO. More... | |
PMIC Selects the LDO Bypass or Linear Regulator mode | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_BYPASS_MODDE (0x1U) |
| Used to set to bypass mode. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_LINEAR_REGULATOR_MODE (0x0U) |
| Used to set to linear regulator mode. More... | |
PMIC Deglitch time select for BUCKx_VMON/LDOx_VMON/VCCA_VMON | |
| #define | PMIC_TPS6594X_POWER_RESOURCE_DEGLITCH_SEL_4US (0x0U) |
| Used to select the degitch time as 4 usec. More... | |
| #define | PMIC_TPS6594X_POWER_RESOURCE_DEGLITCH_SEL_20US (0x1U) |
| Used to select the degitch time as 20 usec. More... | |
PMIC Powergood level for VCCA | |
| #define | PMIC_TPS6594X_VCCA_PG_3V3_LEVEL (0x0U) |
| Used to select the powergood level for VCCA to be 3.3v. More... | |
| #define | PMIC_TPS6594X_VCCA_PG_5V_LEVEL (0x1U) |
| Used to select the powergood level for VCCA to be 5v. More... | |
PMIC Switch Peak Current limit for BUCK Regulator | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_CURRENT_LIMIT_2A5 (0x2U) |
| Used to configure BUCK current limit as 2.5 Ampere. More... | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_CURRENT_LIMIT_3A5 (0x3U) |
| Used to configure BUCK current limit as 3.5 Ampere. More... | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_CURRENT_LIMIT_4A5 (0x4U) |
| Used to configure BUCK current limit as 4.5 Ampere. More... | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_CURRENT_LIMIT_5A5 (0x5U) |
| Used to configure BUCK current limit as 5.5 Ampere. More... | |
PMIC Output voltage slew rate for BUCK Regulator | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_33MV (0x0U) |
| Used to configure BUCK current limit as 30mv. More... | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_20MV (0x1U) |
| Used to configure BUCK current limit as 20mv. More... | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_10MV (0x2U) |
| Used to configure BUCK current limit as 10mv. More... | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_05MV (0x3U) |
| Used to configure BUCK current limit as 5mv. More... | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_2MV5 (0x4U) |
| Used to configure BUCK current limit as 2.5mv. More... | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_1MV3 (0x5U) |
| Used to configure BUCK current limit as 1.3mv. More... | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_0MV63 (0x6U) |
| Used to configure BUCK current limit as 0.63mv. More... | |
| #define | PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_0MV31 (0x7U) |
| Used to configure BUCK current limit as 0.31mv. More... | |
PMIC Output pull-down resistor value for LDO Regulator. | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_PLDN_VAL_50KOHM (0x0U) |
| Used to select the pull down resistor value as 50KOhm. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_PLDN_VAL_125OHM (0x1U) |
| Used to select the pull down resistor value as 125Ohm. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_PLDN_VAL_250OHM (0x2U) |
| Used to select the pull down resistor value as 250Ohm. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_PLDN_VAL_500OHM (0x3U) |
| Used to select the pull down resistor value as 500Ohm. More... | |
PMIC Selects the LDO Residual voltage check Timeout value. | |
|
Valid only for LDO regulators (LDO1, 2 and 3 only). | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_0MS5 (0U) |
| Used to set timeout to 0.5ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_1MS (1U) |
| Used to set timeout to 1ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_1MS5 (2U) |
| Used to set timeout to 1.5ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_2MS (3U) |
| Used to set timeout to 2ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_2MS5 (4U) |
| Used to set timeout to 2.5ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_3MS (5U) |
| Used to set timeout to 3ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_3MS5 (6U) |
| Used to set timeout to 3.5ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_4MS (7U) |
| Used to set timeout to 4ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_2MS0 (8U) |
| Used to set timeout to 2ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_4MS0 (9U) |
| Used to set timeout to 4ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_6MS (10U) |
| Used to set timeout to 6ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_8MS (11U) |
| Used to set timeout to 8ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_10MS (12U) |
| Used to set timeout to 10ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_12MS (13U) |
| Used to set timeout to 12ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_14MS (14U) |
| Used to set timeout to 14ms. More... | |
| #define | PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_16MS (15U) |
| Used to set timeout to 16ms. More... | |
PMIC Power Good Over/Under voltage threshold level for BUCK/LDO/VCCA | |
|
For LDO/BUCK - Over/Under Volatge thershold level are +x1 mv/ +x2 % or -x1 mv/ -x2 % respectively. For VCCA - Over/Under Volatge thershold level are +x2 % or -x2 % respectively. | |
| #define | PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_30_OR_3 (0U) |
| #define | PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_35_OR_3P5 (1U) |
| Used to select over/under voltage threshold level as +/-35mv or +/-3.5%. More... | |
| #define | PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_40_OR_4 (2U) |
| Used to select over/under voltage threshold level as +/-40mv or +/-4%. More... | |
| #define | PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_50_OR_5 (3U) |
| Used to select over/under voltage threshold level as +/-50mv or +/-5%. More... | |
| #define | PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_60_OR_6 (4U) |
| Used to select over/under voltage threshold level as +/-60mv or +/-6%. More... | |
| #define | PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_70_OR_7 (5U) |
| Used to select over/under voltage threshold level as +/-70mv or +/-7%. More... | |
| #define | PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_80_OR_8 (6U) |
| Used to select over/under voltage threshold level as +/-80mv or +/-8%. More... | |
| #define | PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_100_OR_10 (7U) |
| Used to select over/under voltage threshold level as +/-100mv or +/-10%. More... | |
PMIC Rail group selection for all power resources. | |
| #define | PMIC_TPS6594X_POWER_RAIL_SEL_NONE (0x0U) |
| Used to select rail group as no group Note: Software can prevent the SoC/MCU Power Error Handling, which normally shuts down the SOC/MCU power rails, by setting the relevent regulators to PMIC_TPS6594X_POWER_RAIL_SEL_NONE. More... | |
| #define | PMIC_TPS6594X_POWER_RAIL_SEL_MCU (0x1U) |
| Used to select rail group as MCU rail group. More... | |
| #define | PMIC_TPS6594X_POWER_RAIL_SEL_SOC (0x2U) |
| Used to select rail group as SOC rail group. More... | |
| #define | PMIC_TPS6594X_POWER_RAIL_SEL_OTHER (0x3U) |
| Used to select rail group as other rail group. More... | |
PMIC Power-Good source Type for LEO TPS6594x | |
| #define | PMIC_TPS6594X_PGOOD_SOURCE_TYPE_VCCA (0U) |
| #define | PMIC_TPS6594X_PGOOD_SOURCE_TYPE_BUCK (1U) |
| #define | PMIC_TPS6594X_PGOOD_SOURCE_TYPE_NRSTOUT (2U) |
| #define | PMIC_TPS6594X_PGOOD_SOURCE_TYPE_NRSTOUT_SOC (3U) |
| #define | PMIC_TPS6594X_PGOOD_SOURCE_TYPE_TDIE (4U) |
| #define | PMIC_TPS6594X_PGOOD_SOURCE_TYPE_LDO (5U) |
Type of voltage monitoring for PGOOD signal: | |
| #define | PMIC_TPS6594X_POWER_GOOD_UV_MONITOR_ENABLE (0x0U) |
| Only undervoltage is monitored. More... | |
| #define | PMIC_TPS6594X_POWER_GOOD_UV_OV_MONITOR_ENABLE (0x1U) |
| Both undervoltage and overvoltage are monitored. More... | |
PGOOD signal polarity | |
| #define | PMIC_TPS6594X_POWER_PGOOD_POL_HIGH (0x0U) |
| PGOOD signal is high when monitored inputs are valid. More... | |
| #define | PMIC_TPS6594X_POWER_PGOOD_POL_LOW (0x1U) |
| PGOOD signal is low when monitored inputs are valid. More... | |
PGOOD signal source control from nRSTOUT_SOC pin | |
| #define | PMIC_TPS6594X_POWER_PGOOD_SEL_NRSTOUT_SOC_MASKED (0x0U) |
| Signal is Masked. More... | |
| #define | PMIC_TPS6594X_POWER_PGOOD_SEL_NRSTOUT_SOC (0x1U) |
| nRSTOUT_SOC pin low state forces PGOOD signal to low More... | |
PGOOD signal source control from nRSTOUT pin | |
| #define | PMIC_TPS6594X_POWER_PGOOD_SEL_NRSTOUT_MASKED (0x0U) |
| Signal is Masked. More... | |
| #define | PMIC_TPS6594X_POWER_PGOOD_SEL_NRSTOUT (0x1U) |
| nRSTOUT pin low state forces PGOOD signal to low More... | |
PGOOD signal source control from thermal warning | |
| #define | PMIC_TPS6594X_POWER_PGOOD_SEL_TDIE_WARN_MASKED (0x0U) |
| Signal is Masked. More... | |
| #define | PMIC_TPS6594X_POWER_PGOOD_SEL_TDIE_WARN (0x1U) |
| Thermal warning affecting to PGOOD signal. More... | |
PGOOD signal source control from VCCA monitoring | |
| #define | PMIC_TPS6594X_POWER_PGOOD_SEL_VCCA_DISABLE (0x0U) |
| Signal is Masked. More... | |
| #define | PMIC_TPS6594X_POWER_PGOOD_SEL_VCCA_ENABLE (0x1U) |
| VCCA OV/UV threshold affecting PGOOD signal. More... | |
PGOOD signal source control for BUCK and LDO monitoring | |
| #define | PMIC_TPS6594X_POWER_PGOOD_SEL_SRC_MASKED (0x0U) |
| Signal is Masked. More... | |
| #define | PMIC_TPS6594X_POWER_PGOOD_SEL_SRC_VOLTAGE (0x1U) |
| Powergood threshold voltage. More... | |
| #define | PMIC_TPS6594X_POWER_PGOOD_SEL_SRC_VOLTAGE_CURRENT (0x2U) |
| Powergood threshold voltage AND current limit. More... | |
Status whether the output current is above/below current limit level | |
| #define | PMIC_TPS6594X_POWER_CURRENT_LIMIT_STATUS_ABOVE_LIMIT (0x0U) |
| Status indicating that output current is above current limit level. More... | |
| #define | PMIC_TPS6594X_POWER_CURRENT_LIMIT_STATUS_BELOW_LIMIT (0x1U) |
| Status indicating that output current is below current limit level. More... | |
Status whether the output voltage is above/below voltage threshold for LDO and BUCK | |
| #define | PMIC_TPS6594X_REGULATOR_OUTPUT_UNDER_VOLTAGE_STATUS_ABOVE_UV (0x0U) |
| Status indicating that output voltage is above under-voltage threshold. More... | |
| #define | PMIC_TPS6594X_REGULATOR_OUTPUT_UNDER_VOLTAGE_STATUS_BELOW_UV (0x1U) |
| Status indicating that output voltage is below under-voltage threshold. More... | |
| #define | PMIC_TPS6594X_REGULATOR_OUTPUT_OVER_VOLTAGE_STATUS_ABOVE_OV (0x0U) |
| Status indicating that output voltage is above over-voltage threshold. More... | |
| #define | PMIC_TPS6594X_REGULATOR_OUTPUT_OVER_VOLTAGE_STATUS_BELOW_OV (0x1U) |
| Status indicating that output voltage is below over-voltage threshold. More... | |
Status whether the input voltage is above/below under-voltage level for VCCA/VMON | |
| #define | PMIC_TPS6594X_VCCA_INPUT_UNDER_VOLTAGE_STATUS_ABOVE_UV (0x0U) |
| Status indicating that input voltage is above under-voltage level. More... | |
| #define | PMIC_TPS6594X_VCCA_INPUT_UNDER_VOLTAGE_STATUS_BELOW_UV (0x1U) |
| Status indicating that input voltage is below under-voltage level. More... | |
Status whether the input voltage is above/below over-voltage level for VCCA/VMON | |
| #define | PMIC_TPS6594X_VCCA_INPUT_OVER_VOLTAGE_STATUS_ABOVE_OV (0x0U) |
| Status indicating that input voltage is above over-voltage level. More... | |
| #define | PMIC_TPS6594X_VCCA_INPUT_OVER_VOLTAGE_STATUS_BELOW_OV (0x1U) |
| Status indicating that input voltage is below over-voltage level. More... | |
Status whether the voltage is above/below over-voltage protection level for VCCA | |
| #define | PMIC_TPS6594X_VCCA_OVER_VOLTAGE_LVL_STATUS_ABOVE_OV (0x0U) |
| Status indicating that voltage is above over-voltage protection level. More... | |
| #define | PMIC_TPS6594X_VCCA_OVER_VOLTAGE_LVL_STATUS_BELOW_OV (0x1U) |
| Status indicating that voltage is below over-voltage protection level. More... | |
PMIC Thermal shutdown threshold level. | |
| #define | PMIC_TPS6594X_THERMAL_TEMP_TSD_ORD_140C (0U) |
| Used to set the Thermal shutdown threshold level to 140 Celsius. More... | |
| #define | PMIC_TPS6594X_THERMAL_TEMP_TSD_ORD_145C (1U) |
| Used to set the Thermal shutdown threshold level to 145 Celsius. More... | |
PMIC Thermal warning threshold level for TPS6594x Leo PMIC PG2.0 | |
| #define | PMIC_TPS6594X_PG_2_0_THERMAL_TEMP_WARN_140C (1U) |
| Used to set the Thermal warning threshold level to 140 Celsius. More... | |
| #define | PMIC_TPS6594X_PG_2_0_THERMAL_TEMP_WARN_130C (0U) |
| Used to set the Thermal warning threshold level to 130 Celsius. More... | |
PMIC Thermal warning threshold level for TPS6594x Leo PMIC PG1.0 | |
| #define | PMIC_TPS6594X_THERMAL_TEMP_WARN_130C (1U) |
| Used to set the Thermal warning threshold level to 140 Celsius. More... | |
| #define | PMIC_TPS6594X_THERMAL_TEMP_WARN_120C (0U) |
| Used to set the Thermal warning threshold level to 130 Celsius. More... | |
PMIC Power Interrupt selection | |
| #define | PMIC_TPS6594X_POWER_OV_INT (0U) |
| #define | PMIC_TPS6594X_POWER_UV_INT (1U) |
| #define | PMIC_TPS6594X_POWER_ILIM_INT (3U) |
| #define | PMIC_TPS6594X_POWER_INTERRUPT_TWARN (0U) |
| #define | PMIC_TPS6594X_POWER_INTERRUPT_NRSTOUT_READBACK (1U) |
| #define | PMIC_TPS6594X_POWER_INTERRUPT_SOC_PWR_ERR (2U) |
| #define | PMIC_TPS6594X_POWER_INTERRUPT_MCU_PWR_ERR (3U) |
| #define | PMIC_TPS6594X_POWER_INTERRUPT_ORD_SHUTDOWN (4U) |
| #define | PMIC_TPS6594X_POWER_INTERRUPT_IMM_SHUTDOWN (5U) |
| #define | PMIC_TPS6594X_POWER_INTERRUPT_NRSTOUT_SOC_READBACK (6U) |
| #define | PMIC_TPS6594X_POWER_INTERRUPT_EN_DRV_READBACK (7U) |
PMIC Power LDORTC enable/disable | |
| #define | PMIC_TPS6594X_REGULATOR_LDORTC_ENABLE (0U) |
| #define | PMIC_TPS6594X_REGULATOR_LDORTC_DISABLE (1U) |
PMIC Power Resource Type for LEO TPS6594x | |
| #define | PMIC_LP8764X_POWER_RESOURCE_TYPE_VCCA (0U) |
| #define | PMIC_LP8764X_POWER_RESOURCE_TYPE_BUCK (1U) |
| #define | PMIC_LP8764X_POWER_RESOURCE_TYPE_LDO (2U) |
| #define | PMIC_LP8764X_POWER_RESOURCE_TYPE_VMON (3U) |
PMIC Power Resources for HERA lp8764x | |
| #define | PMIC_LP8764X_POWER_SOURCE_VCCA ((((uint16_t)PMIC_LP8764X_POWER_RESOURCE_TYPE_VCCA << 8U) | 0x0U)) |
| #define | PMIC_LP8764X_REGULATOR_BUCK1 ((((uint16_t)PMIC_LP8764X_POWER_RESOURCE_TYPE_BUCK << 8U) | 0x1U)) |
| #define | PMIC_LP8764X_REGULATOR_BUCK2 ((((uint16_t)PMIC_LP8764X_POWER_RESOURCE_TYPE_BUCK << 8U) | 0x2U)) |
| #define | PMIC_LP8764X_REGULATOR_BUCK3 ((((uint16_t)PMIC_LP8764X_POWER_RESOURCE_TYPE_BUCK << 8U) | 0x3U)) |
| #define | PMIC_LP8764X_REGULATOR_BUCK4 ((((uint16_t)PMIC_LP8764X_POWER_RESOURCE_TYPE_BUCK << 8U) | 0x4U)) |
| #define | PMIC_LP8764X_POWER_SOURCE_VMON1 ((((uint16_t)PMIC_LP8764X_POWER_RESOURCE_TYPE_VMON << 8U) | 0x5U)) |
| #define | PMIC_LP8764X_POWER_SOURCE_VMON2 ((((uint16_t)PMIC_LP8764X_POWER_RESOURCE_TYPE_VMON << 8U) | 0x6U)) |
PMIC Residual voltage check Enable/Disable | |
|
Valid only for VMON1, VMON2, LDO, BUCK | |
| #define | PMIC_LP8764X_REGULATOR_VMON_RV_SEL_ENABLE (0x1U) |
| Used to enable the residual voltage check. More... | |
| #define | PMIC_LP8764X_REGULATOR_VMON_RV_SEL_DISABLE (0x0U) |
| Used to disable the residual voltage check. More... | |
PMIC Pull-down resistor Enable/Disable for BUCK Regulator. | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_PLDN_ENABLE (0x1U) |
| Used to enable the pull down resistor for BUCK regulator. More... | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_PLDN_DISABLE (0x0U) |
| Used to disable the pull down resistor for BUCK regulator. More... | |
PMIC Voltage monitor Enable/Disable for BUCK/VMON1/VMON2/VCCA. Enable/Disable OV and UV comparators for VMON1/VMON2/VCCA. Enable/Disable OV, UV, SC and ILIM for BUCK | |
| #define | PMIC_LP8764X_VMON_DISABLE (0x0U) |
| Used to disable the voltage monitor. More... | |
| #define | PMIC_LP8764X_VMON_ENABLE (0x1U) |
| Used to enable the voltage monitor. More... | |
PMIC Select output voltage register for BUCK. | |
|
Valid only for BUCK Regulator | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_VOUT_SEL_VOUT2 (bool)true |
| Used to select VOUT2 register for voltage selection. More... | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_VOUT_SEL_VOUT1 (bool)false |
| Used to select VOUT1 register for voltage selection. More... | |
PMIC Select between Automatic transitions between PFM and PWM modes OR Forced to PWM operation | |
|
Valid only for BUCK regulators. | |
| #define | PMIC_LP8764X_REGULATOR_PWM_MODE (0x1U) |
| Used to select PWM mode. More... | |
| #define | PMIC_LP8764X_REGULATOR_AUTO_PWM_PFM_MODE (0x0U) |
| Used to select Automatic transition between PFM and PWM modes. More... | |
PMIC Select btetween multi-phase operation OR AUTO mode with Automatic phase adding and shedding. | |
|
Valid only for BUCK regulators. | |
| #define | PMIC_LP8764X_REGULATOR_PWM_MP_MODE (0x1U) |
| Used to select multi-phase operation. More... | |
| #define | PMIC_LP8764X_REGULATOR_AUTO_PHASE_MODE (0x0U) |
| Used to select Automatic phase adding and shedding mode. More... | |
PMIC Enable/Disable BUCK Regulator. | |
| #define | PMIC_LP8764X_BUCK_REGULATOR_ENABLE (0x1U) |
| Used to enable the BUCK regulator. More... | |
| #define | PMIC_LP8764X_BUCK_REGULATOR_DISABLE (0x0U) |
| Used to disable the BUCK regulator. More... | |
PMIC Deglitch time select for BUCKx_VMON/VCCA_VMON/VMONx | |
| #define | PMIC_LP8764X_POWER_RESOURCE_DEGLITCH_SEL_4US (0x0U) |
| Used to select the degitch time as 4 usec. More... | |
| #define | PMIC_LP8764X_POWER_RESOURCE_DEGLITCH_SEL_20US (0x1U) |
| Used to select the degitch time as 20 usec. More... | |
PMIC Powergood level for VCCA | |
| #define | PMIC_LP8764X_VCCA_PG_3V3_LEVEL (0x0U) |
| Used to select the powergood level for VCCA to be 3.3v. More... | |
| #define | PMIC_LP8764X_VCCA_PG_5V_LEVEL (0x1U) |
| Used to select the powergood level for VCCA to be 5v. More... | |
OV/UV voltage monitoring range selection for VMON1/VMON2 | |
| #define | PMIC_LP8764X_VMON_RANGE_0V3_3V34 (bool)false |
| Used to select range 0.3 -3.34V. More... | |
| #define | PMIC_LP8764X_VMON_RANGE_3V35_5V (bool)true |
| Used to select range 3.5 -5V. More... | |
PMIC Switch Peak Current limit for BUCK Regulator | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_CURRENT_LIMIT_2A5 (0x2U) |
| Used to configure BUCK current limit as 2.5 Ampere. More... | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_CURRENT_LIMIT_3A5 (0x3U) |
| Used to configure BUCK current limit as 3.5 Ampere. More... | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_CURRENT_LIMIT_4A5 (0x4U) |
| Used to configure BUCK current limit as 4.5 Ampere. More... | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_CURRENT_LIMIT_5A5 (0x5U) |
| Used to configure BUCK current limit as 5.5 Ampere. More... | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_CURRENT_LIMIT_6A5 (0x6U) |
| Used to configure BUCK current limit as 6.5 Ampere. More... | |
PMIC Output voltage slew rate for BUCKx/VMONx | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_33MV (0x0U) |
| Used to configure BUCK current limit as 30mv. More... | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_20MV (0x1U) |
| Used to configure BUCK current limit as 20mv. More... | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_10MV (0x2U) |
| Used to configure BUCK current limit as 10mv. More... | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_05MV (0x3U) |
| Used to configure BUCK current limit as 5mv. More... | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_2MV5 (0x4U) |
| Used to configure BUCK current limit as 2.5mv. More... | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_1MV3 (0x5U) |
| Used to configure BUCK current limit as 1.3mv. More... | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_0MV63 (0x6U) |
| Used to configure BUCK current limit as 0.63mv. More... | |
| #define | PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_0MV31 (0x7U) |
| Used to configure BUCK current limit as 0.31mv. More... | |
PMIC Power Good Over/Under voltage threshold level for BUCK/LDO/VCCA | |
|
For LDO/BUCK - Over/Under Volatge thershold level are +x1 mv/ +x2 % or -x1 mv/ -x2 % respectively. For VCCA only perc For VCCA - Over/Under Volatge thershold level are +x2 % or -x2 % respectively. | |
| #define | PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_30_OR_3 (0U) |
| #define | PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_35_OR_3P5 (1U) |
| Used to select over/under voltage threshold level as +/-35mv or +/-3.5%. More... | |
| #define | PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_40_OR_4 (2U) |
| Used to select over/under voltage threshold level as +/-40mv or +/-4%. More... | |
| #define | PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_50_OR_5 (3U) |
| Used to select over/under voltage threshold level as +/-50mv or +/-5%. More... | |
| #define | PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_60_OR_6 (4U) |
| Used to select over/under voltage threshold level as +/-60mv or +/-6%. More... | |
| #define | PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_70_OR_7 (5U) |
| Used to select over/under voltage threshold level as +/-70mv or +/-7%. More... | |
| #define | PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_80_OR_8 (6U) |
| Used to select over/under voltage threshold level as +/-80mv or +/-8%. More... | |
| #define | PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_100_OR_10 (7U) |
| Used to select over/under voltage threshold level as +/-100mv or +/-10%. More... | |
PMIC Rail group selection for all power resources. | |
| #define | PMIC_LP8764X_POWER_RAIL_SEL_NONE (0x0U) |
| Used to select rail group as no group Note: Software can prevent the SoC/MCU Power Error Handling, which normally shuts down the SOC/MCU power rails, by setting the relevent regulators to PMIC_LP8764X_POWER_RAIL_SEL_NONE. More... | |
| #define | PMIC_LP8764X_POWER_RAIL_SEL_MCU (0x1U) |
| Used to select rail group as MCU rail group. More... | |
| #define | PMIC_LP8764X_POWER_RAIL_SEL_SOC (0x2U) |
| Used to select rail group as SOC rail group. More... | |
| #define | PMIC_LP8764X_POWER_RAIL_SEL_OTHER (0x3U) |
| Used to select rail group as other rail group. More... | |
PMIC Power-Good source Type for HERA LP8764x | |
| #define | PMIC_LP8764X_PGOOD_SOURCE_TYPE_VCCA (0U) |
| #define | PMIC_LP8764X_PGOOD_SOURCE_TYPE_BUCK (1U) |
| #define | PMIC_LP8764X_PGOOD_SOURCE_TYPE_NRSTOUT (2U) |
| #define | PMIC_LP8764X_PGOOD_SOURCE_TYPE_NRSTOUT_SOC (3U) |
| #define | PMIC_LP8764X_PGOOD_SOURCE_TYPE_TDIE (4U) |
| #define | PMIC_LP8764X_PGOOD_SOURCE_TYPE_VMON (6U) |
Type of voltage monitoring for PGOOD signal: | |
| #define | PMIC_LP8764X_POWER_GOOD_UV_MONITOR_ENABLE (0x0U) |
| Only undervoltage is monitored. More... | |
| #define | PMIC_LP8764X_POWER_GOOD_UV_OV_MONITOR_ENABLE (0x1U) |
| Both undervoltage and overvoltage are monitored. More... | |
PGOOD signal polarity | |
| #define | PMIC_LP8764X_POWER_PGOOD_POL_HIGH (0x0U) |
| PGOOD signal is high when monitored inputs are valid. More... | |
| #define | PMIC_LP8764X_POWER_PGOOD_POL_LOW (0x1U) |
| PGOOD signal is low when monitored inputs are valid. More... | |
PGOOD signal source control from nRSTOUT_SOC pin | |
| #define | PMIC_LP8764X_POWER_PGOOD_SEL_NRSTOUT_SOC_MASKED (0x0U) |
| Signal is Masked. More... | |
| #define | PMIC_LP8764X_POWER_PGOOD_SEL_NRSTOUT_SOC (0x1U) |
| nRSTOUT_SOC pin low state forces PGOOD signal to low More... | |
PGOOD signal source control from nRSTOUT pin | |
| #define | PMIC_LP8764X_POWER_PGOOD_SEL_NRSTOUT_MASKED (0x0U) |
| Signal is Masked. More... | |
| #define | PMIC_LP8764X_POWER_PGOOD_SEL_NRSTOUT (0x1U) |
| nRSTOUT pin low state forces PGOOD signal to low More... | |
PGOOD signal source control from thermal warning | |
| #define | PMIC_LP8764X_POWER_PGOOD_SEL_TDIE_WARN_MASKED (0x0U) |
| Signal is Masked. More... | |
| #define | PMIC_LP8764X_POWER_PGOOD_SEL_TDIE_WARN (0x1U) |
| Thermal warning affecting to PGOOD signal. More... | |
PGOOD signal source control from VCCA monitoring | |
| #define | PMIC_LP8764X_POWER_PGOOD_SEL_VCCA_VMON_DISABLE (0x0U) |
| Signal is Masked. More... | |
| #define | PMIC_LP8764X_POWER_PGOOD_SEL_VCCA_VMON_ENABLE (0x1U) |
| VCCA/VMON OV/UV threshold affecting PGOOD signal. More... | |
PGOOD signal source control for BUCK and LDO monitoring | |
| #define | PMIC_LP8764X_POWER_PGOOD_SEL_SRC_MASKED (0x0U) |
| Signal is Masked. More... | |
| #define | PMIC_LP8764X_POWER_PGOOD_SEL_SRC_VOLTAGE (0x1U) |
| Powergood threshold voltage. More... | |
| #define | PMIC_LP8764X_POWER_PGOOD_SEL_SRC_VOLTAGE_CURRENT (0x2U) |
| Powergood threshold voltage AND current limit. More... | |
Status whether the output current is above/below current limit level | |
| #define | PMIC_LP8764X_POWER_CURRENT_LIMIT_STATUS_ABOVE_LIMIT (0x0U) |
| Status indicating that output current is above current limit level. More... | |
| #define | PMIC_LP8764X_POWER_CURRENT_LIMIT_STATUS_BELOW_LIMIT (0x1U) |
| Status indicating that output current is below current limit level. More... | |
Status whether the output voltage is above/below voltage threshold for LDO and BUCK | |
| #define | PMIC_LP8764X_REGULATOR_OUTPUT_UNDER_VOLTAGE_STATUS_ABOVE_UV (0x0U) |
| Status indicating that output voltage is above under-voltage threshold. More... | |
| #define | PMIC_LP8764X_REGULATOR_OUTPUT_UNDER_VOLTAGE_STATUS_BELOW_UV (0x1U) |
| Status indicating that output voltage is below under-voltage threshold. More... | |
| #define | PMIC_LP8764X_REGULATOR_OUTPUT_OVER_VOLTAGE_STATUS_ABOVE_OV (0x0U) |
| Status indicating that output voltage is above over-voltage threshold. More... | |
| #define | PMIC_LP8764X_REGULATOR_OUTPUT_OVER_VOLTAGE_STATUS_BELOW_OV (0x1U) |
| Status indicating that output voltage is below over-voltage threshold. More... | |
Status whether the input voltage is above/below under-voltage level for VCCA/VMON | |
| #define | PMIC_LP8764X_VCCA_VMON_INPUT_UNDER_VOLTAGE_STATUS_ABOVE_UV (0x0U) |
| Status indicating that input voltage is above under-voltage level. More... | |
| #define | PMIC_LP8764X_VCCA_VMON_INPUT_UNDER_VOLTAGE_STATUS_BELOW_UV (0x1U) |
| Status indicating that input voltage is below under-voltage level. More... | |
Status whether the input voltage is above/below over-voltage level for VCCA/VMON | |
| #define | PMIC_LP8764X_VCCA_VMON_INPUT_OVER_VOLTAGE_STATUS_ABOVE_OV (0x0U) |
| Status indicating that input voltage is above over-voltage level. More... | |
| #define | PMIC_LP8764X_VCCA_VMON_INPUT_OVER_VOLTAGE_STATUS_BELOW_OV (0x1U) |
| Status indicating that input voltage is below over-voltage level. More... | |
Status whether the voltage is above/below over-voltage protection level for VCCA | |
| #define | PMIC_LP8764X_VCCA_OVER_VOLTAGE_LVL_STATUS_ABOVE_OV (0x0U) |
| Status indicating that voltage is above over-voltage protection level. More... | |
| #define | PMIC_LP8764X_VCCA_OVER_VOLTAGE_LVL_STATUS_BELOW_OV (0x1U) |
| Status indicating that voltage is below over-voltage protection level. More... | |
PMIC Thermal shutdown threshold level. | |
| #define | PMIC_LP8764X_THERMAL_TEMP_TSD_ORD_140C (0U) |
| Used to set the Thermal shutdown threshold level to 140 Celsius. More... | |
| #define | PMIC_LP8764X_THERMAL_TEMP_TSD_ORD_145C (1U) |
| Used to set the Thermal shutdown threshold level to 145 Celsius. More... | |
PMIC Thermal warning threshold level. | |
| #define | PMIC_LP8764X_THERMAL_TEMP_WARN_120C (0U) |
| Used to set the Thermal warning threshold level to 120 Celsius. More... | |
| #define | PMIC_LP8764X_THERMAL_TEMP_WARN_130C (1U) |
| Used to set the Thermal warning threshold level to 130 Celsius. More... | |
PMIC Power Interrupt selection | |
| #define | PMIC_LP8764X_POWER_OV_INT (0U) |
| #define | PMIC_LP8764X_POWER_UV_INT (1U) |
| #define | PMIC_LP8764X_POWER_ILIM_INT (3U) |
| #define | PMIC_LP8764X_POWER_INTERRUPT_TWARN (0U) |
| #define | PMIC_LP8764X_POWER_INTERRUPT_NRSTOUT_READBACK (1U) |
| #define | PMIC_LP8764X_POWER_INTERRUPT_SOC_PWR_ERR (2U) |
| #define | PMIC_LP8764X_POWER_INTERRUPT_MCU_PWR_ERR (3U) |
| #define | PMIC_LP8764X_POWER_INTERRUPT_ORD_SHUTDOWN (4U) |
| #define | PMIC_LP8764X_POWER_INTERRUPT_IMM_SHUTDOWN (5U) |
| #define | PMIC_LP8764X_POWER_INTERRUPT_NRSTOUT_SOC_READBACK (6U) |
| #define | PMIC_LP8764X_POWER_INTERRUPT_EN_DRV_READBACK (7U) |
| #define PMIC_CFG_REGULATOR_VMON_RV_SEL_VALID (0U) |
validParams value used to set/get to Enable/Disable residual voltage checking for regulator/VMON pin Valid only for VMON1/VMON2/BUCK/LDO
| #define PMIC_CFG_REGULATOR_BUCK_PLDN_EN_VALID (1U) |
validParams value used to set/get to Enable/Disable output pull-down resistor when BUCK is disabled. Valid only for BUCK regulator
| #define PMIC_CFG_VMON_EN_VALID (2U) |
validParams value used to set/get to Enable /Disable the Voltage monitor feature Valid only for VMON1/VMON2/VMON of BUCK/VMON of LDO/VMON of VCCA Power Resources
| #define PMIC_CFG_REGULATOR_BUCK_VOUT_SEL_VALID (3U) |
validParams value used to set/get to Select output voltage register for BUCK Valid only for BUCK regulator
| #define PMIC_CFG_REGULATOR_BUCK_FPWM_VALID (4U) |
validParams value used to set/get to Select PWM or Auto Mode for BUCK Valid only for BUCK regulator
| #define PMIC_CFG_REGULATOR_BUCK_PWM_MP_VALID (5U) |
validParams value used to set/get to Select between Multi phase with PWM OR AUTO mode with Automatic phase adding and shedding for BUCK Valid only for BUCK regulator
| #define PMIC_CFG_REGULATOR_EN_VALID (6U) |
validParams value used to set/get to Enable/Disable the power regulators Valid only for BUCK/LDO regulator
| #define PMIC_CFG_REGULATOR_LDO_SLOW_RAMP_EN_VALID (7U) |
validParams value used to set/get to Enable/Disable Slow Ramp for LDO Valid only for LDO regulator Valid only for TPS6594x Leo PMIC PG2.0
| #define PMIC_CFG_REGULATOR_LDO_BYPASS_MODE_EN_VALID (8U) |
validParams value used to set/get to Select Bypass/Linear Regulator LDO mode Valid only for LDO regulator
| #define PMIC_CFG_VCCA_PWR_GOOD_LVL_VALID (9U) |
validParams value used to set/get Powergood level for VCCA pin Valid only for VCCA
| #define PMIC_CFG_VMON_RANGE_VALID (10U) |
validParams value used to set/get to Select OV/UV voltage monitoring range for VMON Valid only for VMON1/VMON2
| #define PMIC_CFG_REGULATOR_BUCK_ILIM_VALID (12U) |
validParams value used to set/get Switch peak current limit for BUCK regulator Valid only for BUCK regulator
| #define PMIC_CFG_REGULATOR_BUCK_VMON_SLEW_RATE_VALID (13U) |
validParams value used to set/get Output voltage slew rate for BUCK/VMON Valid only for VMON1/VMON2/BUCK
| #define PMIC_CFG_REGULATOR_LDO_PLDN_SEL_VALID (14U) |
validParams value used to set/get to Selects the resistor value for output pull-down resistor for LDO regulator Valid only for LDO regulator
| #define PMIC_CFG_REGULATOR_LDO_RV_TIMEOUT_SEL_VALID (15U) |
validParams value used to set/get LDO residual voltage check timeout select Valid only for LDO regulator
| #define PMIC_CFG_PWR_RESOURCE_PG_UV_THRESHOLD_LVL_VALID (16U) |
validParams value used to set/get Power good low threshold level for the power resources Valid for all power resources
| #define PMIC_CFG_PWR_RESOURCE_PG_OV_THRESHOLD_LVL_VALID (17U) |
validParams value used to set/get Power good high threshold level for the power resources Valid for all power resources
| #define PMIC_CFG_PWR_RESOURCE_RAIL_GRP_SEL_VALID (18U) |
validParams value used to set/get Rail group selection for the power resources Valid for all power resources
| #define PMIC_CFG_REGULATOR_VMON_VOLTAGE_SET_VALID (19U) |
validParams value used to set/get Voltage level (For LDO/BUCK)/ Powergood voltage level(For VMON1/VMON2) in mv Valid only for VMON1/VMMON2/BUCK/LDO
| #define PMIC_CFG_REGULATOR_VMON_RV_SEL_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_VMON_RV_SEL_VALID) |
| #define PMIC_CFG_REGULATOR_BUCK_PLDN_EN_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_BUCK_PLDN_EN_VALID) |
| #define PMIC_CFG_VMON_EN_VALID_SHIFT (1U << PMIC_CFG_VMON_EN_VALID) |
| #define PMIC_CFG_REGULATOR_BUCK_VOUT_SEL_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_BUCK_VOUT_SEL_VALID) |
| #define PMIC_CFG_REGULATOR_BUCK_FPWM_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_BUCK_FPWM_VALID) |
| #define PMIC_CFG_REGULATOR_BUCK_PWM_MP_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_BUCK_PWM_MP_VALID) |
| #define PMIC_CFG_REGULATOR_EN_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_EN_VALID) |
| #define PMIC_CFG_REGULATOR_LDO_SLOW_RAMP_EN_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_LDO_SLOW_RAMP_EN_VALID) |
| #define PMIC_CFG_REGULATOR_LDO_BYPASS_MODE_EN_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_LDO_BYPASS_MODE_EN_VALID) |
| #define PMIC_CFG_VCCA_PWR_GOOD_LVL_VALID_SHIFT (1U << PMIC_CFG_VCCA_PWR_GOOD_LVL_VALID) |
| #define PMIC_CFG_VMON_RANGE_VALID_SHIFT (1U << PMIC_CFG_VMON_RANGE_VALID) |
| #define PMIC_CFG_REGULATOR_BUCK_ILIM_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_BUCK_ILIM_VALID) |
| #define PMIC_CFG_REGULATOR_BUCK_VMON_SLEW_RATE_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_BUCK_VMON_SLEW_RATE_VALID) |
| #define PMIC_CFG_REGULATOR_LDO_PLDN_SEL_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_LDO_PLDN_SEL_VALID) |
| #define PMIC_CFG_REGULATOR_LDO_RV_TIMEOUT_SEL_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_LDO_RV_TIMEOUT_SEL_VALID) |
| #define PMIC_CFG_PWR_RESOURCE_PG_UV_THRESHOLD_LVL_VALID_SHIFT (1U << PMIC_CFG_PWR_RESOURCE_PG_UV_THRESHOLD_LVL_VALID) |
| #define PMIC_CFG_PWR_RESOURCE_PG_OV_THRESHOLD_LVL_VALID_SHIFT (1U << PMIC_CFG_PWR_RESOURCE_PG_OV_THRESHOLD_LVL_VALID) |
| #define PMIC_CFG_PWR_RESOURCE_RAIL_GRP_SEL_VALID_SHIFT (1U << PMIC_CFG_PWR_RESOURCE_RAIL_GRP_SEL_VALID) |
| #define PMIC_CFG_REGULATOR_VMON_VOLTAGE_SET_VALID_SHIFT (1U << PMIC_CFG_REGULATOR_VMON_VOLTAGE_SET_VALID) |
| #define PMIC_POWER_PGOOD_WINDOW_VALID (0U) |
validParams value used to set/get to Select the type of voltage monitoring for PGOOD signal
| #define PMIC_POWER_PGOOD_POL_VALID (1U) |
validParams value used to set/get to Select the PGOOD signal polarity
| #define PMIC_CFG_DEGLITCH_TIME_SEL_VALID (2U) |
validParams value used to set/get Deglitch time select for all power resources Valid only for VMON1/VMON2/VCCA/VMON of LDO/VMON of BUCK power resources Valid only for TPS6594x Leo PMIC PG2.0 and LP8764x Hera PMIC PG1.0 and PG2.0
| #define PMIC_SEVERE_ERR_TRIG_VALID (3U) |
validParams value used to set/get to Select the trigger selection for severe Error
| #define PMIC_OTHER_RAIL_TRIG_VALID (4U) |
validParams value used to set/get to Select the trigger selection for other rail group
| #define PMIC_SOC_RAIL_TRIG_VALID (5U) |
validParams value used to set/get to Select the trigger selection for soc rail group
| #define PMIC_MCU_RAIL_TRIG_VALID (6U) |
validParams value used to set/get to Select the trigger selection for mcu rail group
| #define PMIC_MODERATE_ERR_TRIG_VALID (7U) |
validParams value used to set/get Select the trigger selection for Moderate Error
| #define PMIC_POWER_PGOOD_WINDOW_VALID_SHIFT (1U << PMIC_POWER_PGOOD_WINDOW_VALID) |
| #define PMIC_POWER_PGOOD_POL_VALID_SHIFT (1U << PMIC_POWER_PGOOD_POL_VALID) |
| #define PMIC_CFG_DEGLITCH_TIME_SEL_VALID_SHIFT (1U << PMIC_CFG_DEGLITCH_TIME_SEL_VALID) |
| #define PMIC_SEVERE_ERR_TRIG_VALID_SHIFT (1U << PMIC_SEVERE_ERR_TRIG_VALID) |
| #define PMIC_OTHER_RAIL_TRIG_VALID_SHIFT (1U << PMIC_OTHER_RAIL_TRIG_VALID) |
| #define PMIC_SOC_RAIL_TRIG_VALID_SHIFT (1U << PMIC_SOC_RAIL_TRIG_VALID) |
| #define PMIC_MCU_RAIL_TRIG_VALID_SHIFT (1U << PMIC_MCU_RAIL_TRIG_VALID) |
| #define PMIC_MODERATE_ERR_TRIG_VALID_SHIFT (1U << PMIC_MODERATE_ERR_TRIG_VALID) |
| #define PMIC_POWER_REGULATOR_ILIM_STAT_VALID (0U) |
validParams value used to get output current limit status for LDO and buck regulators
| #define PMIC_POWER_RESOURCE_UV_STAT_VALID (1U) |
validParams value used to get output under voltage status for LDO/ BUCK and input under voltage status for VCCA/VMON Valid for all power resources
| #define PMIC_POWER_RESOURCE_OV_STAT_VALID (2U) |
validParams value used to get output over voltage status for LDO/BUCK and input over voltage status for VCCA/VMON Valid for all power resources
| #define PMIC_POWER_VCCA_OV_LVL_STAT_VALID (3U) |
validParams value used to get voltage level status for VCCA Valid only for VCCA
| #define PMIC_POWER_REGULATOR_ILIM_STAT_VALID_SHIFT (1U << PMIC_POWER_REGULATOR_ILIM_STAT_VALID) |
| #define PMIC_POWER_RESOURCE_UV_STAT_VALID_SHIFT (1U << PMIC_POWER_RESOURCE_UV_STAT_VALID) |
| #define PMIC_POWER_RESOURCE_OV_STAT_VALID_SHIFT (1U << PMIC_POWER_RESOURCE_OV_STAT_VALID) |
| #define PMIC_POWER_VCCA_OV_LVL_STAT_VALID_SHIFT (1U << PMIC_POWER_VCCA_OV_LVL_STAT_VALID) |
| #define PMIC_THERMAL_WARN_VALID (1U) |
validParams value used to set/get thermal Warning Threshold temperature value
| #define PMIC_THERMAL_SHTDWN_VALID (2U) |
validParams value used to set/get Thermal Shutdown Threshold temperature value valid only for TPS6594x Leo PMIC PG2.0 and LP8764x Hera PMIC PG1.0 and PG2.0
| #define PMIC_THERMAL_WARN_VALID_SHIFT (1U << PMIC_THERMAL_WARN_VALID) |
| #define PMIC_THERMAL_SHTDWN_VALID_SHIFT (1U << PMIC_THERMAL_SHTDWN_VALID) |
| #define PMIC_THERMAL_STAT_WARN_VALID (1U) |
validParams value used to get Thermal warning status
| #define PMIC_THERMAL_STAT_ORD_SHTDWN_VALID (2U) |
validParams value used to get Orderly Shutdown status
| #define PMIC_THERMAL_STAT_IMM_SHTDWN_VALID (3U) |
validParams value used to get Immediate Shutdown status
| #define PMIC_THERMAL_STAT_WARN_VALID_SHIFT (1U << PMIC_THERMAL_STAT_WARN_VALID) |
| #define PMIC_THERMAL_STAT_ORD_SHTDWN_VALID_SHIFT (1U << PMIC_THERMAL_STAT_ORD_SHTDWN_VALID) |
| #define PMIC_THERMAL_STAT_IMM_SHTDWN_VALID_SHIFT (1U << PMIC_THERMAL_STAT_IMM_SHTDWN_VALID) |
| #define PMIC_POWER_INTERRUPT_ENABLE (0U) |
| #define PMIC_POWER_INTERRUPT_DISABLE (1U) |
| #define PMIC_POWER_GOOD_UV_MONITOR_ENABLE (0x0U) |
Only undervoltage is monitored.
| #define PMIC_POWER_GOOD_UV_OV_MONITOR_ENABLE (0x1U) |
Both undervoltage and overvoltage are monitored.
| #define PMIC_POWER_PGOOD_POL_HIGH (0x0U) |
PGOOD signal is high when monitored inputs are valid.
| #define PMIC_POWER_PGOOD_POL_LOW (0x1U) |
PGOOD signal is low when monitored inputs are valid.
| #define PMIC_POWER_TRIG_IMM_SHUTDOWN (0U) |
| #define PMIC_POWER_TRIG_ODERLY_SHUTDOWN (1U) |
| #define PMIC_POWER_TRIG_MCU_PWR_ERR (2U) |
| #define PMIC_POWER_TRIG_SOC_PWR_ERR (3U) |
| #define PMIC_TPS6594X_POWER_RESOURCE_TYPE_VCCA (0U) |
| #define PMIC_TPS6594X_POWER_RESOURCE_TYPE_BUCK (1U) |
| #define PMIC_TPS6594X_POWER_RESOURCE_TYPE_LDO (2U) |
| #define PMIC_TPS6594X_POWER_SOURCE_VCCA ((((uint16_t)PMIC_TPS6594X_POWER_RESOURCE_TYPE_VCCA << 8U) | 0x0U)) |
| #define PMIC_TPS6594X_REGULATOR_BUCK1 ((((uint16_t)PMIC_TPS6594X_POWER_RESOURCE_TYPE_BUCK << 8U) | 0x1U)) |
| #define PMIC_TPS6594X_REGULATOR_BUCK2 ((((uint16_t)PMIC_TPS6594X_POWER_RESOURCE_TYPE_BUCK << 8U) | 0x2U)) |
| #define PMIC_TPS6594X_REGULATOR_BUCK3 ((((uint16_t)PMIC_TPS6594X_POWER_RESOURCE_TYPE_BUCK << 8U) | 0x3U)) |
| #define PMIC_TPS6594X_REGULATOR_BUCK4 ((((uint16_t)PMIC_TPS6594X_POWER_RESOURCE_TYPE_BUCK << 8U) | 0x4U)) |
| #define PMIC_TPS6594X_REGULATOR_BUCK5 ((((uint16_t)PMIC_TPS6594X_POWER_RESOURCE_TYPE_BUCK << 8U) | 0x5U)) |
| #define PMIC_TPS6594X_REGULATOR_LDO1 ((((uint16_t)PMIC_TPS6594X_POWER_RESOURCE_TYPE_LDO << 8U) | 0x6U)) |
| #define PMIC_TPS6594X_REGULATOR_LDO2 ((((uint16_t)PMIC_TPS6594X_POWER_RESOURCE_TYPE_LDO << 8U) | 0x7U)) |
| #define PMIC_TPS6594X_REGULATOR_LDO3 ((((uint16_t)PMIC_TPS6594X_POWER_RESOURCE_TYPE_LDO << 8U) | 0x8U)) |
| #define PMIC_TPS6594X_REGULATOR_LDO4 ((((uint16_t)PMIC_TPS6594X_POWER_RESOURCE_TYPE_LDO << 8U) | 0x9U)) |
| #define PMIC_TPS6594X_REGULATOR_RV_SEL_ENABLE (0x1U) |
Used to enable the residual voltage check.
| #define PMIC_TPS6594X_REGULATOR_RV_SEL_DISABLE (0x0U) |
Used to disable the residual voltage check.
| #define PMIC_TPS6594X_REGULATOR_BUCK_PLDN_ENABLE (0x1U) |
Used to enable the pull down resistor for BUCK regulator.
| #define PMIC_TPS6594X_REGULATOR_BUCK_PLDN_DISABLE (0x0U) |
Used to disable the pull down resistor for BUCK regulator.
| #define PMIC_TPS6594X_VMON_DISABLE (0x0U) |
Used to disable the voltage monitor.
| #define PMIC_TPS6594X_VMON_ENABLE (0x1U) |
Used to enable the voltage monitor.
| #define PMIC_TPS6594X_REGULATOR_BUCK_VOUT_SEL_VOUT2 (bool)true |
Used to select VOUT2 register for voltage selection.
| #define PMIC_TPS6594X_REGULATOR_BUCK_VOUT_SEL_VOUT1 (bool)false |
Used to select VOUT1 register for voltage selection.
| #define PMIC_TPS6594X_REGULATOR_PWM_MODE (0x1U) |
Used to select PWM mode.
| #define PMIC_TPS6594X_REGULATOR_AUTO_PWM_PFM_MODE (0x0U) |
Used to select Automatic transition between PFM and PWM modes.
| #define PMIC_TPS6594X_REGULATOR_PWM_MP_MODE (0x1U) |
Used to select multi-phase operation.
| #define PMIC_TPS6594X_REGULATOR_AUTO_PHASE_MODE (0x0U) |
Used to select Automatic phase adding and shedding mode.
| #define PMIC_TPS6594X_REGULATOR_ENABLE (0x1U) |
Used to enable the BUCK or LDO regulator.
| #define PMIC_TPS6594X_REGULATOR_DISABLE (0x0U) |
Used to disable the BUCK or LDO regulator.
| #define PMIC_TPS6594X_REGULATOR_LDO_SLOW_RAMP_ENABLE (0x1U) |
Used to enable slow ramp for LDO.
| #define PMIC_TPS6594X_REGULATOR_LDO_SLOW_RAMP_DISABLE (0x0U) |
Used to disable slow ramp for LDO.
| #define PMIC_TPS6594X_REGULATOR_LDO_BYPASS_MODDE (0x1U) |
Used to set to bypass mode.
| #define PMIC_TPS6594X_REGULATOR_LDO_LINEAR_REGULATOR_MODE (0x0U) |
Used to set to linear regulator mode.
| #define PMIC_TPS6594X_POWER_RESOURCE_DEGLITCH_SEL_4US (0x0U) |
Used to select the degitch time as 4 usec.
| #define PMIC_TPS6594X_POWER_RESOURCE_DEGLITCH_SEL_20US (0x1U) |
Used to select the degitch time as 20 usec.
| #define PMIC_TPS6594X_VCCA_PG_3V3_LEVEL (0x0U) |
Used to select the powergood level for VCCA to be 3.3v.
| #define PMIC_TPS6594X_VCCA_PG_5V_LEVEL (0x1U) |
Used to select the powergood level for VCCA to be 5v.
| #define PMIC_TPS6594X_REGULATOR_BUCK_CURRENT_LIMIT_2A5 (0x2U) |
Used to configure BUCK current limit as 2.5 Ampere.
| #define PMIC_TPS6594X_REGULATOR_BUCK_CURRENT_LIMIT_3A5 (0x3U) |
Used to configure BUCK current limit as 3.5 Ampere.
| #define PMIC_TPS6594X_REGULATOR_BUCK_CURRENT_LIMIT_4A5 (0x4U) |
Used to configure BUCK current limit as 4.5 Ampere.
| #define PMIC_TPS6594X_REGULATOR_BUCK_CURRENT_LIMIT_5A5 (0x5U) |
Used to configure BUCK current limit as 5.5 Ampere.
| #define PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_33MV (0x0U) |
Used to configure BUCK current limit as 30mv.
| #define PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_20MV (0x1U) |
Used to configure BUCK current limit as 20mv.
| #define PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_10MV (0x2U) |
Used to configure BUCK current limit as 10mv.
| #define PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_05MV (0x3U) |
Used to configure BUCK current limit as 5mv.
| #define PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_2MV5 (0x4U) |
Used to configure BUCK current limit as 2.5mv.
| #define PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_1MV3 (0x5U) |
Used to configure BUCK current limit as 1.3mv.
| #define PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_0MV63 (0x6U) |
Used to configure BUCK current limit as 0.63mv.
| #define PMIC_TPS6594X_REGULATOR_BUCK_SLEW_RATE_0MV31 (0x7U) |
Used to configure BUCK current limit as 0.31mv.
| #define PMIC_TPS6594X_REGULATOR_LDO_PLDN_VAL_50KOHM (0x0U) |
Used to select the pull down resistor value as 50KOhm.
| #define PMIC_TPS6594X_REGULATOR_LDO_PLDN_VAL_125OHM (0x1U) |
Used to select the pull down resistor value as 125Ohm.
| #define PMIC_TPS6594X_REGULATOR_LDO_PLDN_VAL_250OHM (0x2U) |
Used to select the pull down resistor value as 250Ohm.
| #define PMIC_TPS6594X_REGULATOR_LDO_PLDN_VAL_500OHM (0x3U) |
Used to select the pull down resistor value as 500Ohm.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_0MS5 (0U) |
Used to set timeout to 0.5ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_1MS (1U) |
Used to set timeout to 1ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_1MS5 (2U) |
Used to set timeout to 1.5ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_2MS (3U) |
Used to set timeout to 2ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_2MS5 (4U) |
Used to set timeout to 2.5ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_3MS (5U) |
Used to set timeout to 3ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_3MS5 (6U) |
Used to set timeout to 3.5ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_4MS (7U) |
Used to set timeout to 4ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_2MS0 (8U) |
Used to set timeout to 2ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_4MS0 (9U) |
Used to set timeout to 4ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_6MS (10U) |
Used to set timeout to 6ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_8MS (11U) |
Used to set timeout to 8ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_10MS (12U) |
Used to set timeout to 10ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_12MS (13U) |
Used to set timeout to 12ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_14MS (14U) |
Used to set timeout to 14ms.
| #define PMIC_TPS6594X_REGULATOR_LDO_RV_TIMEOUT_16MS (15U) |
Used to set timeout to 16ms.
| #define PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_30_OR_3 (0U) |
| #define PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_35_OR_3P5 (1U) |
Used to select over/under voltage threshold level as +/-35mv or +/-3.5%.
| #define PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_40_OR_4 (2U) |
Used to select over/under voltage threshold level as +/-40mv or +/-4%.
| #define PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_50_OR_5 (3U) |
Used to select over/under voltage threshold level as +/-50mv or +/-5%.
| #define PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_60_OR_6 (4U) |
Used to select over/under voltage threshold level as +/-60mv or +/-6%.
| #define PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_70_OR_7 (5U) |
Used to select over/under voltage threshold level as +/-70mv or +/-7%.
| #define PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_80_OR_8 (6U) |
Used to select over/under voltage threshold level as +/-80mv or +/-8%.
| #define PMIC_TPS6594X_PG_OV_UV_THRESHOLD_LVL_100_OR_10 (7U) |
Used to select over/under voltage threshold level as +/-100mv or +/-10%.
| #define PMIC_TPS6594X_POWER_RAIL_SEL_NONE (0x0U) |
Used to select rail group as no group Note: Software can prevent the SoC/MCU Power Error Handling, which normally shuts down the SOC/MCU power rails, by setting the relevent regulators to PMIC_TPS6594X_POWER_RAIL_SEL_NONE.
| #define PMIC_TPS6594X_POWER_RAIL_SEL_MCU (0x1U) |
Used to select rail group as MCU rail group.
| #define PMIC_TPS6594X_POWER_RAIL_SEL_SOC (0x2U) |
Used to select rail group as SOC rail group.
| #define PMIC_TPS6594X_POWER_RAIL_SEL_OTHER (0x3U) |
Used to select rail group as other rail group.
| #define PMIC_TPS6594X_PGOOD_SOURCE_TYPE_VCCA (0U) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_TYPE_BUCK (1U) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_TYPE_NRSTOUT (2U) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_TYPE_NRSTOUT_SOC (3U) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_TYPE_TDIE (4U) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_TYPE_LDO (5U) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_VCCA ((((uint16_t)PMIC_TPS6594X_PGOOD_SOURCE_TYPE_VCCA << 8U) | 0U)) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_BUCK1 ((((uint16_t)PMIC_TPS6594X_PGOOD_SOURCE_TYPE_BUCK << 8U) | 1U)) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_BUCK2 ((((uint16_t)PMIC_TPS6594X_PGOOD_SOURCE_TYPE_BUCK << 8U) | 2U)) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_BUCK3 ((((uint16_t)PMIC_TPS6594X_PGOOD_SOURCE_TYPE_BUCK << 8U) | 3U)) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_BUCK4 ((((uint16_t)PMIC_TPS6594X_PGOOD_SOURCE_TYPE_BUCK << 8U) | 4U)) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_BUCK5 ((((uint16_t)PMIC_TPS6594X_PGOOD_SOURCE_TYPE_BUCK << 8U) | 5U)) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_NRSTOUT ((((uint16_t)PMIC_TPS6594X_PGOOD_SOURCE_TYPE_NRSTOUT << 8U) | 6U)) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_NRSTOUT_SOC ((((uint16_t)PMIC_TPS6594X_PGOOD_SOURCE_TYPE_NRSTOUT_SOC << 8U) | 7U)) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_TDIE ((((uint16_t)PMIC_TPS6594X_PGOOD_SOURCE_TYPE_TDIE << 8U) | 8U)) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_LDO1 ((((uint16_t)PMIC_TPS6594X_PGOOD_SOURCE_TYPE_LDO << 8U) | 9U)) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_LDO2 ((((uint16_t)PMIC_TPS6594X_PGOOD_SOURCE_TYPE_LDO << 8U) | 10U)) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_LDO3 ((((uint16_t)PMIC_TPS6594X_PGOOD_SOURCE_TYPE_LDO << 8U) | 11U)) |
| #define PMIC_TPS6594X_PGOOD_SOURCE_LDO4 ((((uint16_t)PMIC_TPS6594X_PGOOD_SOURCE_TYPE_LDO << 8U) | 12U)) |
| #define PMIC_TPS6594X_POWER_GOOD_UV_MONITOR_ENABLE (0x0U) |
Only undervoltage is monitored.
| #define PMIC_TPS6594X_POWER_GOOD_UV_OV_MONITOR_ENABLE (0x1U) |
Both undervoltage and overvoltage are monitored.
| #define PMIC_TPS6594X_POWER_PGOOD_POL_HIGH (0x0U) |
PGOOD signal is high when monitored inputs are valid.
| #define PMIC_TPS6594X_POWER_PGOOD_POL_LOW (0x1U) |
PGOOD signal is low when monitored inputs are valid.
| #define PMIC_TPS6594X_POWER_PGOOD_SEL_NRSTOUT_SOC_MASKED (0x0U) |
Signal is Masked.
| #define PMIC_TPS6594X_POWER_PGOOD_SEL_NRSTOUT_SOC (0x1U) |
nRSTOUT_SOC pin low state forces PGOOD signal to low
| #define PMIC_TPS6594X_POWER_PGOOD_SEL_NRSTOUT_MASKED (0x0U) |
Signal is Masked.
| #define PMIC_TPS6594X_POWER_PGOOD_SEL_NRSTOUT (0x1U) |
nRSTOUT pin low state forces PGOOD signal to low
| #define PMIC_TPS6594X_POWER_PGOOD_SEL_TDIE_WARN_MASKED (0x0U) |
Signal is Masked.
| #define PMIC_TPS6594X_POWER_PGOOD_SEL_TDIE_WARN (0x1U) |
Thermal warning affecting to PGOOD signal.
| #define PMIC_TPS6594X_POWER_PGOOD_SEL_VCCA_DISABLE (0x0U) |
Signal is Masked.
| #define PMIC_TPS6594X_POWER_PGOOD_SEL_VCCA_ENABLE (0x1U) |
VCCA OV/UV threshold affecting PGOOD signal.
| #define PMIC_TPS6594X_POWER_PGOOD_SEL_SRC_MASKED (0x0U) |
Signal is Masked.
| #define PMIC_TPS6594X_POWER_PGOOD_SEL_SRC_VOLTAGE (0x1U) |
Powergood threshold voltage.
| #define PMIC_TPS6594X_POWER_PGOOD_SEL_SRC_VOLTAGE_CURRENT (0x2U) |
Powergood threshold voltage AND current limit.
| #define PMIC_TPS6594X_POWER_CURRENT_LIMIT_STATUS_ABOVE_LIMIT (0x0U) |
Status indicating that output current is above current limit level.
| #define PMIC_TPS6594X_POWER_CURRENT_LIMIT_STATUS_BELOW_LIMIT (0x1U) |
Status indicating that output current is below current limit level.
| #define PMIC_TPS6594X_REGULATOR_OUTPUT_UNDER_VOLTAGE_STATUS_ABOVE_UV (0x0U) |
Status indicating that output voltage is above under-voltage threshold.
| #define PMIC_TPS6594X_REGULATOR_OUTPUT_UNDER_VOLTAGE_STATUS_BELOW_UV (0x1U) |
Status indicating that output voltage is below under-voltage threshold.
| #define PMIC_TPS6594X_VCCA_INPUT_UNDER_VOLTAGE_STATUS_ABOVE_UV (0x0U) |
Status indicating that input voltage is above under-voltage level.
| #define PMIC_TPS6594X_VCCA_INPUT_UNDER_VOLTAGE_STATUS_BELOW_UV (0x1U) |
Status indicating that input voltage is below under-voltage level.
| #define PMIC_TPS6594X_REGULATOR_OUTPUT_OVER_VOLTAGE_STATUS_ABOVE_OV (0x0U) |
Status indicating that output voltage is above over-voltage threshold.
| #define PMIC_TPS6594X_REGULATOR_OUTPUT_OVER_VOLTAGE_STATUS_BELOW_OV (0x1U) |
Status indicating that output voltage is below over-voltage threshold.
| #define PMIC_TPS6594X_VCCA_INPUT_OVER_VOLTAGE_STATUS_ABOVE_OV (0x0U) |
Status indicating that input voltage is above over-voltage level.
| #define PMIC_TPS6594X_VCCA_INPUT_OVER_VOLTAGE_STATUS_BELOW_OV (0x1U) |
Status indicating that input voltage is below over-voltage level.
| #define PMIC_TPS6594X_VCCA_OVER_VOLTAGE_LVL_STATUS_ABOVE_OV (0x0U) |
Status indicating that voltage is above over-voltage protection level.
| #define PMIC_TPS6594X_VCCA_OVER_VOLTAGE_LVL_STATUS_BELOW_OV (0x1U) |
Status indicating that voltage is below over-voltage protection level.
| #define PMIC_TPS6594X_THERMAL_TEMP_TSD_ORD_140C (0U) |
Used to set the Thermal shutdown threshold level to 140 Celsius.
| #define PMIC_TPS6594X_THERMAL_TEMP_TSD_ORD_145C (1U) |
Used to set the Thermal shutdown threshold level to 145 Celsius.
| #define PMIC_TPS6594X_PG_2_0_THERMAL_TEMP_WARN_140C (1U) |
Used to set the Thermal warning threshold level to 140 Celsius.
| #define PMIC_TPS6594X_PG_2_0_THERMAL_TEMP_WARN_130C (0U) |
Used to set the Thermal warning threshold level to 130 Celsius.
| #define PMIC_TPS6594X_THERMAL_TEMP_WARN_130C (1U) |
Used to set the Thermal warning threshold level to 140 Celsius.
| #define PMIC_TPS6594X_THERMAL_TEMP_WARN_120C (0U) |
Used to set the Thermal warning threshold level to 130 Celsius.
| #define PMIC_TPS6594X_POWER_OV_INT (0U) |
| #define PMIC_TPS6594X_POWER_UV_INT (1U) |
| #define PMIC_TPS6594X_POWER_ILIM_INT (3U) |
| #define PMIC_TPS6594X_POWER_INTERRUPT_TWARN (0U) |
| #define PMIC_TPS6594X_POWER_INTERRUPT_NRSTOUT_READBACK (1U) |
| #define PMIC_TPS6594X_POWER_INTERRUPT_SOC_PWR_ERR (2U) |
| #define PMIC_TPS6594X_POWER_INTERRUPT_MCU_PWR_ERR (3U) |
| #define PMIC_TPS6594X_POWER_INTERRUPT_ORD_SHUTDOWN (4U) |
| #define PMIC_TPS6594X_POWER_INTERRUPT_IMM_SHUTDOWN (5U) |
| #define PMIC_TPS6594X_POWER_INTERRUPT_NRSTOUT_SOC_READBACK (6U) |
| #define PMIC_TPS6594X_POWER_INTERRUPT_EN_DRV_READBACK (7U) |
| #define PMIC_TPS6594X_REGULATOR_LDORTC_ENABLE (0U) |
| #define PMIC_TPS6594X_REGULATOR_LDORTC_DISABLE (1U) |
| #define PMIC_LP8764X_POWER_RESOURCE_TYPE_VCCA (0U) |
| #define PMIC_LP8764X_POWER_RESOURCE_TYPE_BUCK (1U) |
| #define PMIC_LP8764X_POWER_RESOURCE_TYPE_LDO (2U) |
| #define PMIC_LP8764X_POWER_RESOURCE_TYPE_VMON (3U) |
| #define PMIC_LP8764X_POWER_SOURCE_VCCA ((((uint16_t)PMIC_LP8764X_POWER_RESOURCE_TYPE_VCCA << 8U) | 0x0U)) |
| #define PMIC_LP8764X_REGULATOR_BUCK1 ((((uint16_t)PMIC_LP8764X_POWER_RESOURCE_TYPE_BUCK << 8U) | 0x1U)) |
| #define PMIC_LP8764X_REGULATOR_BUCK2 ((((uint16_t)PMIC_LP8764X_POWER_RESOURCE_TYPE_BUCK << 8U) | 0x2U)) |
| #define PMIC_LP8764X_REGULATOR_BUCK3 ((((uint16_t)PMIC_LP8764X_POWER_RESOURCE_TYPE_BUCK << 8U) | 0x3U)) |
| #define PMIC_LP8764X_REGULATOR_BUCK4 ((((uint16_t)PMIC_LP8764X_POWER_RESOURCE_TYPE_BUCK << 8U) | 0x4U)) |
| #define PMIC_LP8764X_POWER_SOURCE_VMON1 ((((uint16_t)PMIC_LP8764X_POWER_RESOURCE_TYPE_VMON << 8U) | 0x5U)) |
| #define PMIC_LP8764X_POWER_SOURCE_VMON2 ((((uint16_t)PMIC_LP8764X_POWER_RESOURCE_TYPE_VMON << 8U) | 0x6U)) |
| #define PMIC_LP8764X_REGULATOR_VMON_RV_SEL_ENABLE (0x1U) |
Used to enable the residual voltage check.
| #define PMIC_LP8764X_REGULATOR_VMON_RV_SEL_DISABLE (0x0U) |
Used to disable the residual voltage check.
| #define PMIC_LP8764X_REGULATOR_BUCK_PLDN_ENABLE (0x1U) |
Used to enable the pull down resistor for BUCK regulator.
| #define PMIC_LP8764X_REGULATOR_BUCK_PLDN_DISABLE (0x0U) |
Used to disable the pull down resistor for BUCK regulator.
| #define PMIC_LP8764X_VMON_DISABLE (0x0U) |
Used to disable the voltage monitor.
| #define PMIC_LP8764X_VMON_ENABLE (0x1U) |
Used to enable the voltage monitor.
| #define PMIC_LP8764X_REGULATOR_BUCK_VOUT_SEL_VOUT2 (bool)true |
Used to select VOUT2 register for voltage selection.
| #define PMIC_LP8764X_REGULATOR_BUCK_VOUT_SEL_VOUT1 (bool)false |
Used to select VOUT1 register for voltage selection.
| #define PMIC_LP8764X_REGULATOR_PWM_MODE (0x1U) |
Used to select PWM mode.
| #define PMIC_LP8764X_REGULATOR_AUTO_PWM_PFM_MODE (0x0U) |
Used to select Automatic transition between PFM and PWM modes.
| #define PMIC_LP8764X_REGULATOR_PWM_MP_MODE (0x1U) |
Used to select multi-phase operation.
| #define PMIC_LP8764X_REGULATOR_AUTO_PHASE_MODE (0x0U) |
Used to select Automatic phase adding and shedding mode.
| #define PMIC_LP8764X_BUCK_REGULATOR_ENABLE (0x1U) |
Used to enable the BUCK regulator.
| #define PMIC_LP8764X_BUCK_REGULATOR_DISABLE (0x0U) |
Used to disable the BUCK regulator.
| #define PMIC_LP8764X_POWER_RESOURCE_DEGLITCH_SEL_4US (0x0U) |
Used to select the degitch time as 4 usec.
| #define PMIC_LP8764X_POWER_RESOURCE_DEGLITCH_SEL_20US (0x1U) |
Used to select the degitch time as 20 usec.
| #define PMIC_LP8764X_VCCA_PG_3V3_LEVEL (0x0U) |
Used to select the powergood level for VCCA to be 3.3v.
| #define PMIC_LP8764X_VCCA_PG_5V_LEVEL (0x1U) |
Used to select the powergood level for VCCA to be 5v.
| #define PMIC_LP8764X_VMON_RANGE_0V3_3V34 (bool)false |
Used to select range 0.3 -3.34V.
| #define PMIC_LP8764X_VMON_RANGE_3V35_5V (bool)true |
Used to select range 3.5 -5V.
| #define PMIC_LP8764X_REGULATOR_BUCK_CURRENT_LIMIT_2A5 (0x2U) |
Used to configure BUCK current limit as 2.5 Ampere.
| #define PMIC_LP8764X_REGULATOR_BUCK_CURRENT_LIMIT_3A5 (0x3U) |
Used to configure BUCK current limit as 3.5 Ampere.
| #define PMIC_LP8764X_REGULATOR_BUCK_CURRENT_LIMIT_4A5 (0x4U) |
Used to configure BUCK current limit as 4.5 Ampere.
| #define PMIC_LP8764X_REGULATOR_BUCK_CURRENT_LIMIT_5A5 (0x5U) |
Used to configure BUCK current limit as 5.5 Ampere.
| #define PMIC_LP8764X_REGULATOR_BUCK_CURRENT_LIMIT_6A5 (0x6U) |
Used to configure BUCK current limit as 6.5 Ampere.
| #define PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_33MV (0x0U) |
Used to configure BUCK current limit as 30mv.
| #define PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_20MV (0x1U) |
Used to configure BUCK current limit as 20mv.
| #define PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_10MV (0x2U) |
Used to configure BUCK current limit as 10mv.
| #define PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_05MV (0x3U) |
Used to configure BUCK current limit as 5mv.
| #define PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_2MV5 (0x4U) |
Used to configure BUCK current limit as 2.5mv.
| #define PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_1MV3 (0x5U) |
Used to configure BUCK current limit as 1.3mv.
| #define PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_0MV63 (0x6U) |
Used to configure BUCK current limit as 0.63mv.
| #define PMIC_LP8764X_REGULATOR_BUCK_VMON_SLEW_RATE_0MV31 (0x7U) |
Used to configure BUCK current limit as 0.31mv.
| #define PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_30_OR_3 (0U) |
| #define PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_35_OR_3P5 (1U) |
Used to select over/under voltage threshold level as +/-35mv or +/-3.5%.
| #define PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_40_OR_4 (2U) |
Used to select over/under voltage threshold level as +/-40mv or +/-4%.
| #define PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_50_OR_5 (3U) |
Used to select over/under voltage threshold level as +/-50mv or +/-5%.
| #define PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_60_OR_6 (4U) |
Used to select over/under voltage threshold level as +/-60mv or +/-6%.
| #define PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_70_OR_7 (5U) |
Used to select over/under voltage threshold level as +/-70mv or +/-7%.
| #define PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_80_OR_8 (6U) |
Used to select over/under voltage threshold level as +/-80mv or +/-8%.
| #define PMIC_LP8764X_PG_OV_UV_THRESHOLD_LVL_100_OR_10 (7U) |
Used to select over/under voltage threshold level as +/-100mv or +/-10%.
| #define PMIC_LP8764X_POWER_RAIL_SEL_NONE (0x0U) |
Used to select rail group as no group Note: Software can prevent the SoC/MCU Power Error Handling, which normally shuts down the SOC/MCU power rails, by setting the relevent regulators to PMIC_LP8764X_POWER_RAIL_SEL_NONE.
| #define PMIC_LP8764X_POWER_RAIL_SEL_MCU (0x1U) |
Used to select rail group as MCU rail group.
| #define PMIC_LP8764X_POWER_RAIL_SEL_SOC (0x2U) |
Used to select rail group as SOC rail group.
| #define PMIC_LP8764X_POWER_RAIL_SEL_OTHER (0x3U) |
Used to select rail group as other rail group.
| #define PMIC_LP8764X_PGOOD_SOURCE_TYPE_VCCA (0U) |
| #define PMIC_LP8764X_PGOOD_SOURCE_TYPE_BUCK (1U) |
| #define PMIC_LP8764X_PGOOD_SOURCE_TYPE_NRSTOUT (2U) |
| #define PMIC_LP8764X_PGOOD_SOURCE_TYPE_NRSTOUT_SOC (3U) |
| #define PMIC_LP8764X_PGOOD_SOURCE_TYPE_TDIE (4U) |
| #define PMIC_LP8764X_PGOOD_SOURCE_TYPE_VMON (6U) |
| #define PMIC_LP8764X_PGOOD_SOURCE_VCCA ((((uint16_t)PMIC_LP8764X_PGOOD_SOURCE_TYPE_VCCA << 8U) | 0U)) |
| #define PMIC_LP8764X_PGOOD_SOURCE_BUCK1 ((((uint16_t)PMIC_LP8764X_PGOOD_SOURCE_TYPE_BUCK << 8U) | 1U)) |
| #define PMIC_LP8764X_PGOOD_SOURCE_BUCK2 ((((uint16_t)PMIC_LP8764X_PGOOD_SOURCE_TYPE_BUCK << 8U) | 2U)) |
| #define PMIC_LP8764X_PGOOD_SOURCE_BUCK3 ((((uint16_t)PMIC_LP8764X_PGOOD_SOURCE_TYPE_BUCK << 8U) | 3U)) |
| #define PMIC_LP8764X_PGOOD_SOURCE_BUCK4 ((((uint16_t)PMIC_LP8764X_PGOOD_SOURCE_TYPE_BUCK << 8U) | 4U)) |
| #define PMIC_LP8764X_PGOOD_SOURCE_NRSTOUT ((((uint16_t)PMIC_LP8764X_PGOOD_SOURCE_TYPE_NRSTOUT << 8U) | 5U)) |
| #define PMIC_LP8764X_PGOOD_SOURCE_NRSTOUT_SOC ((((uint16_t)PMIC_LP8764X_PGOOD_SOURCE_TYPE_NRSTOUT_SOC << 8U) | 6U)) |
| #define PMIC_LP8764X_PGOOD_SOURCE_TDIE ((((uint16_t)PMIC_LP8764X_PGOOD_SOURCE_TYPE_TDIE << 8U) | 7U)) |
| #define PMIC_LP8764X_PGOOD_SOURCE_VMON1 ((((uint16_t)PMIC_LP8764X_PGOOD_SOURCE_TYPE_VMON << 8U) | 8U)) |
| #define PMIC_LP8764X_PGOOD_SOURCE_VMON2 ((((uint16_t)PMIC_LP8764X_PGOOD_SOURCE_TYPE_VMON << 8U) | 9U)) |
| #define PMIC_LP8764X_POWER_GOOD_UV_MONITOR_ENABLE (0x0U) |
Only undervoltage is monitored.
| #define PMIC_LP8764X_POWER_GOOD_UV_OV_MONITOR_ENABLE (0x1U) |
Both undervoltage and overvoltage are monitored.
| #define PMIC_LP8764X_POWER_PGOOD_POL_HIGH (0x0U) |
PGOOD signal is high when monitored inputs are valid.
| #define PMIC_LP8764X_POWER_PGOOD_POL_LOW (0x1U) |
PGOOD signal is low when monitored inputs are valid.
| #define PMIC_LP8764X_POWER_PGOOD_SEL_NRSTOUT_SOC_MASKED (0x0U) |
Signal is Masked.
| #define PMIC_LP8764X_POWER_PGOOD_SEL_NRSTOUT_SOC (0x1U) |
nRSTOUT_SOC pin low state forces PGOOD signal to low
| #define PMIC_LP8764X_POWER_PGOOD_SEL_NRSTOUT_MASKED (0x0U) |
Signal is Masked.
| #define PMIC_LP8764X_POWER_PGOOD_SEL_NRSTOUT (0x1U) |
nRSTOUT pin low state forces PGOOD signal to low
| #define PMIC_LP8764X_POWER_PGOOD_SEL_TDIE_WARN_MASKED (0x0U) |
Signal is Masked.
| #define PMIC_LP8764X_POWER_PGOOD_SEL_TDIE_WARN (0x1U) |
Thermal warning affecting to PGOOD signal.
| #define PMIC_LP8764X_POWER_PGOOD_SEL_VCCA_VMON_DISABLE (0x0U) |
Signal is Masked.
| #define PMIC_LP8764X_POWER_PGOOD_SEL_VCCA_VMON_ENABLE (0x1U) |
VCCA/VMON OV/UV threshold affecting PGOOD signal.
| #define PMIC_LP8764X_POWER_PGOOD_SEL_SRC_MASKED (0x0U) |
Signal is Masked.
| #define PMIC_LP8764X_POWER_PGOOD_SEL_SRC_VOLTAGE (0x1U) |
Powergood threshold voltage.
| #define PMIC_LP8764X_POWER_PGOOD_SEL_SRC_VOLTAGE_CURRENT (0x2U) |
Powergood threshold voltage AND current limit.
| #define PMIC_LP8764X_POWER_CURRENT_LIMIT_STATUS_ABOVE_LIMIT (0x0U) |
Status indicating that output current is above current limit level.
| #define PMIC_LP8764X_POWER_CURRENT_LIMIT_STATUS_BELOW_LIMIT (0x1U) |
Status indicating that output current is below current limit level.
| #define PMIC_LP8764X_REGULATOR_OUTPUT_UNDER_VOLTAGE_STATUS_ABOVE_UV (0x0U) |
Status indicating that output voltage is above under-voltage threshold.
| #define PMIC_LP8764X_REGULATOR_OUTPUT_UNDER_VOLTAGE_STATUS_BELOW_UV (0x1U) |
Status indicating that output voltage is below under-voltage threshold.
| #define PMIC_LP8764X_VCCA_VMON_INPUT_UNDER_VOLTAGE_STATUS_ABOVE_UV (0x0U) |
Status indicating that input voltage is above under-voltage level.
| #define PMIC_LP8764X_VCCA_VMON_INPUT_UNDER_VOLTAGE_STATUS_BELOW_UV (0x1U) |
Status indicating that input voltage is below under-voltage level.
| #define PMIC_LP8764X_REGULATOR_OUTPUT_OVER_VOLTAGE_STATUS_ABOVE_OV (0x0U) |
Status indicating that output voltage is above over-voltage threshold.
| #define PMIC_LP8764X_REGULATOR_OUTPUT_OVER_VOLTAGE_STATUS_BELOW_OV (0x1U) |
Status indicating that output voltage is below over-voltage threshold.
| #define PMIC_LP8764X_VCCA_VMON_INPUT_OVER_VOLTAGE_STATUS_ABOVE_OV (0x0U) |
Status indicating that input voltage is above over-voltage level.
| #define PMIC_LP8764X_VCCA_VMON_INPUT_OVER_VOLTAGE_STATUS_BELOW_OV (0x1U) |
Status indicating that input voltage is below over-voltage level.
| #define PMIC_LP8764X_VCCA_OVER_VOLTAGE_LVL_STATUS_ABOVE_OV (0x0U) |
Status indicating that voltage is above over-voltage protection level.
| #define PMIC_LP8764X_VCCA_OVER_VOLTAGE_LVL_STATUS_BELOW_OV (0x1U) |
Status indicating that voltage is below over-voltage protection level.
| #define PMIC_LP8764X_THERMAL_TEMP_TSD_ORD_140C (0U) |
Used to set the Thermal shutdown threshold level to 140 Celsius.
| #define PMIC_LP8764X_THERMAL_TEMP_TSD_ORD_145C (1U) |
Used to set the Thermal shutdown threshold level to 145 Celsius.
| #define PMIC_LP8764X_THERMAL_TEMP_WARN_120C (0U) |
Used to set the Thermal warning threshold level to 120 Celsius.
| #define PMIC_LP8764X_THERMAL_TEMP_WARN_130C (1U) |
Used to set the Thermal warning threshold level to 130 Celsius.
| #define PMIC_LP8764X_POWER_OV_INT (0U) |
| #define PMIC_LP8764X_POWER_UV_INT (1U) |
| #define PMIC_LP8764X_POWER_ILIM_INT (3U) |
| #define PMIC_LP8764X_POWER_INTERRUPT_TWARN (0U) |
| #define PMIC_LP8764X_POWER_INTERRUPT_NRSTOUT_READBACK (1U) |
| #define PMIC_LP8764X_POWER_INTERRUPT_SOC_PWR_ERR (2U) |
| #define PMIC_LP8764X_POWER_INTERRUPT_MCU_PWR_ERR (3U) |
| #define PMIC_LP8764X_POWER_INTERRUPT_ORD_SHUTDOWN (4U) |
| #define PMIC_LP8764X_POWER_INTERRUPT_IMM_SHUTDOWN (5U) |
| #define PMIC_LP8764X_POWER_INTERRUPT_NRSTOUT_SOC_READBACK (6U) |
| #define PMIC_LP8764X_POWER_INTERRUPT_EN_DRV_READBACK (7U) |
| int32_t Pmic_powerSetPwrResourceCfg | ( | Pmic_CoreHandle_t * | pPmicCoreHandle, |
| const uint16_t | pwrResource, | ||
| const Pmic_PowerResourceCfg_t | pwrResourceCfg | ||
| ) |
API to set power resources configurations.
Requirement: REQ_TAG(PDK-5829), REQ_TAG(PDK-5841), REQ_TAG(PDK-5848), REQ_TAG(PDK-9111), REQ_TAG(PDK-9163), REQ_TAG(PDK-9149), REQ_TAG(PDK-9159), REQ_TAG(PDK-9329) Design: did_pmic_power_cfg_readback
This function can be used to configure the various control and
configuration parameters for BUCK/LDO/VCCA/VMON power resources and
also used to set the various control and configuration of
voltage monitor parameters for BUCK/LDO/VCCA/VMON power resources
when corresponding validParam bit field is set in the
Pmic_PowerResourceCfg_t structure.
For more information \ref Pmic_PowerResourceCfg_t
To set control and configuration params for BUCK, the application
has to configure the below defined structure members of
Pmic_PowerResourceCfg_t:
rvCheckEn, buckPullDownEn, vmonEn, buckVoutRegSel, buckFpwmMode,
buckFpwmMpMode, regulatorEn, buckCurrentLimit,
buckVmonSlewRate, voltage_mV, pgUvThresholdLvl,
pgOvThresholdLvl, railGrpSel
To set control and configuration params for LDO, the application
has to configure the below defined structure members of
Pmic_PowerResourceCfg_t:
rvCheckEn, vmonEn, regulatorEn, ldoPullDownSel, ldoSlowRampEn,
ldoBypassModeEn, ldoRvTimeoutSel, voltage_mV,
pgUvThresholdLvl, pgOvThresholdLvl, railGrpSel
To set control and configuration params for VCCA, the application
has to configure the below defined structure members of
Pmic_PowerResourceCfg_t:
vmonEn, vccaPwrGudLvl, pgUvThresholdLvl,
pgOvThresholdLvl, railGrpSel
To set control and configuration params for VMON, the application
has to configure the below defined structure members of
Pmic_PowerResourceCfg_t:
rvCheckEn, vmonEn, vccaPwrGudLvl, vmonRange,
pgUvThresholdLvl, pgOvThresholdLvl, railGrpSel, voltage_mV
Valid only for LP8764x HERA Device
| pPmicCoreHandle | [IN] PMIC Interface Handle. |
| pwrResource | [IN] PMIC Power resource Valid values for TPS6594x Leo Device Pmic_Tps6594xLeo_Power_Resource. Valid values for LP8764x HERA Device Pmic_Lp8764xHera_Power_Resource. |
| pwrResourceCfg | [IN] Power Resource configuration for BUCK/LDO/VMON/VCCA |
| PMIC_ST_SUCCESS | in case of success or appropriate error code. For valid values Pmic_ErrorCodes |
| int32_t Pmic_powerGetPwrResourceCfg | ( | Pmic_CoreHandle_t * | pPmicCoreHandle, |
| const uint16_t | pwrResource, | ||
| Pmic_PowerResourceCfg_t * | pPwrResourceCfg | ||
| ) |
API to get power resources configurations.
Requirement: REQ_TAG(PDK-5829), REQ_TAG(PDK-5848), REQ_TAG(PDK-5850), REQ_TAG(PDK-9163) Design: did_pmic_power_cfg_readback
This function can be used to get the various control and
configuration parameters for BUCK/LDO/VCCA/VMON power resources and
also used to get the various control and configuration of
voltage monitor parameters for BUCK/LDO/VCCA/VMON power resources
when corresponding validParam bit field is set in the
Pmic_PowerResourceCfg_t structure.
For more information \ref Pmic_PowerResourceCfg_t
Application can get these control and configuration params for BUCK,
which is stored in the below defined structure members of
Pmic_PowerResourceCfg_t:
rvCheckEn, buckPullDownEn, vmonEn, buckVoutRegSel, buckFpwmMode,
buckFpwmMpMode, regulatorEn, buckCurrentLimit,
buckVmonSlewRate, voltage_mV, pgUvThresholdLvl,
pgOvThresholdLvl, railGrpSel
Application can get these control and configuration params for LDO,
which is stored in the below defined structure members of
Pmic_PowerResourceCfg_t:
rvCheckEn, vmonEn, regulatorEn, ldoPullDownSel, ldoSlowRampEn,
ldoBypassModeEn, ldoRvTimeoutSel, voltage_mV,
pgUvThresholdLvl, pgOvThresholdLvl, railGrpSel
Application can get these control and configuration params for VCCA,
which is stored in the below defined structure members of
Pmic_PowerResourceCfg_t:
vmonEn, vccaPwrGudLvl, pgUvThresholdLvl,
pgOvThresholdLvl, railGrpSel
Application can get these control and configuration params for VMON,
which is stored in the below defined structure members of
Pmic_PowerResourceCfg_t:
rvCheckEn, vmonEn, vccaPwrGudLvl, vmonRange,
pgUvThresholdLvl, pgOvThresholdLvl, railGrpSel, voltage_mV
Valid only for LP8764x HERA Device
| pPmicCoreHandle | [IN] PMIC Interface Handle. |
| pwrResource | [IN] PMIC Power resource Valid values for TPS6594x Leo Device Pmic_Tps6594xLeo_Power_Resource. Valid values for LP8764x HERA Device Pmic_Lp8764xHera_Power_Resource. |
| pPwrResourceCfg | [IN/OUT] Pointer to store Power Resource configuration for BUCK/LDO/VMON/VCCA |
| PMIC_ST_SUCCESS | in case of success or appropriate error code. For valid values Pmic_ErrorCodes |
| int32_t Pmic_powerSetCommonConfig | ( | Pmic_CoreHandle_t * | pPmicCoreHandle, |
| const Pmic_PowerCommonCfg_t | powerCommonCfg | ||
| ) |
API to Set Power configuration.
Requirement: REQ_TAG(PDK-5829), REQ_TAG(PDK-5848), REQ_TAG(PDK-5847), REQ_TAG(PDK-9111), REQ_TAG(PDK-9149), REQ_TAG(PDK-9159), REQ_TAG(PDK-9329) Design: did_pmic_power_cfg_readback, did_pmic_power_pgood_cfg_readback
This function is used to set the power configuration
parameters such as selection of type of voltage monitoring, and
polarity of the power-good signal, deglitch time select for all
power resources when corresponding validParam bit field is set in
the Pmic_PowerCommonCfg_t structure.
For more information \ref Pmic_PowerCommonCfg_t
Application can set the voltage monitoring for PGOOD
by configuring the following structure members of
Pmic_PowerCommonCfg_t:
pgoodWindow
Application can set the PGOOD signal polarity
by configuring the following structure members of
Pmic_PowerCommonCfg_t:
pgoodPolarity
Application can set the Deglitch time select for all power resources
by configuring the following structure members of
Pmic_PowerCommonCfg_t:
deglitchTimeSel
Application can set/select trigger selection for :
severe Error, other rail group, soc rail group, mcu rail group and
Moderate Error
by configuring the following structure members of
Pmic_PowerCommonCfg_t:
severeErrorTrig, otherRailTrig, socRailTrig, mcuRailTrig
moderateRailTrig
| pPmicCoreHandle | [IN] PMIC Interface Handle. |
| powerCommonCfg | [IN] Power configuration. |
| PMIC_ST_SUCCESS | in case of success or appropriate error code. For valid values Pmic_ErrorCodes |
| int32_t Pmic_powerGetCommonConfig | ( | Pmic_CoreHandle_t * | pPmicCoreHandle, |
| Pmic_PowerCommonCfg_t * | pPowerCommonCfg | ||
| ) |
API to Get Power configuration.
Requirement: REQ_TAG(PDK-5829), REQ_TAG(PDK-5848), REQ_TAG(PDK_5847) Design: did_pmic_power_cfg_readback, did_pmic_power_pgood_cfg_readback
This function is used to get the power configuration
parameters such as selection of type of voltage monitoring, and
polarity of the power-good signal, deglitch time select for all
power resources when corresponding validParam bit field is set in
the Pmic_PowerCommonCfg_t structure.
For more information \ref Pmic_PowerCommonCfg_t
Application can get the voltage monitoring for PGOOD
which is stored in the below defined structure members of
Pmic_PowerCommonCfg_t:
pgoodWindow
Application can get the PGOOD signal polarity
which is stored in the below defined structure members of
Pmic_PowerCommonCfg_t:
pgoodPolarity
Application can get the Deglitch time select for all power resources
which is stored in the below defined structure members of
Pmic_PowerCommonCfg_t:
deglitchTimeSel
Application can get trigger selection for :
severe Error, other rail group, soc rail group, mcu rail group and
Moderate Error
which is stored in the below defined structure members of
Pmic_PowerCommonCfg_t:
severeErrorTrig, otherRailTrig, socRailTrig, mcuRailTrig
moderateRailTrig
| pPmicCoreHandle | [IN] PMIC Interface Handle. |
| pPowerCommonCfg | [IN/OUT] Pointer to hold Power configuration. |
| PMIC_ST_SUCCESS | in case of success or appropriate error code. For valid values Pmic_ErrorCodes |
| int32_t Pmic_powerSetConfigPowerGood | ( | Pmic_CoreHandle_t * | pPmicCoreHandle, |
| const uint16_t | pgoodSrcSel, | ||
| const uint8_t | pgoodSelType | ||
| ) |
API to Set Power good configuration.
Requirement: REQ_TAG(PDK-5847), REQ_TAG(PDK-9111) Design: did_pmic_power_pgood_cfg_readback
This function is used to control and configure the power good
source control. For the
following, power good signal control can be selected:
All supported Bucks and Ldo by the PMIC, VCCA , thermal warning,
nRSTOUT pin and nRSTOUT_SOC pin.
| pPmicCoreHandle | [IN] PMIC Interface Handle. |
| pgoodSrcSel | [IN] Power Good Source. Valid values for TPS6594x Leo Device Pmic_Tps6594xLeo_Pgood_SourceType. Valid values for LP8764x HERA Device Pmic_Lp8764xHera_Pgood_SourceType. |
| pgoodSelType | [IN] Power Good configuration. Valid values for TPS6594x Leo Device: For LDO/BUCK: Pmic_TPS6594x_Power_Good_Regulator_Signal For VCCA: Pmic_TPS6594x_Power_Good_Vcca For Thermal Warning Pmic_TPS6594x_Power_Good_Thermal_Warn For nRSTOUT: Pmic_TPS6594x_Power_Good_Nrstout For nRSTOUT_SOC: Pmic_TPS6594x_Power_Good_Nrstout_Soc Valid values for LP8764x HERA Device For BUCK: Pmic_LP8764x_Power_Good_Buck_Signal For VCCA/VMON: Pmic_LP8764x_Power_Good_Vcca_Vmon For Thermal Warning: Pmic_LP8764x_Power_Good_Thermal_Warn For nRSTOUT Pmic_LP8764x_Power_Good_Nrstout For nRSTOUT_SOC: Pmic_LP8764x_Power_Good_Nrstout_Soc |
| PMIC_ST_SUCCESS | in case of success or appropriate error code. For valid values Pmic_ErrorCodes |
| int32_t Pmic_powerGetConfigPowerGood | ( | Pmic_CoreHandle_t * | pPmicCoreHandle, |
| const uint16_t | pgoodSrcSel, | ||
| uint8_t * | pPgoodSelType | ||
| ) |
Get Power good configuration.
Requirement: REQ_TAG(PDK-5847) Design: did_pmic_power_pgood_cfg_readback
This function is used to get various power good conifg.
This function also provides the pgood source control for
different power resources and pins.
| pPmicCoreHandle | [IN] PMIC Interface Handle. |
| pgoodSrcSel | [IN] Power Good Source. Valid values for TPS6594x Leo Device Pmic_Tps6594xLeo_Pgood_SourceType. Valid values for LP8764x HERA Device Pmic_Lp8764xHera_Pgood_SourceType. |
| pPgoodSelType | [OUT] Power Good configuration. |
| PMIC_ST_SUCCESS | in case of success or appropriate error code. For valid values Pmic_ErrorCodes |
| int32_t Pmic_powerGetPwrRsrcStat | ( | Pmic_CoreHandle_t * | pPmicCoreHandle, |
| const uint16_t | pwrResource, | ||
| Pmic_PowerResourceStat_t * | pPwrRsrcStatCfg | ||
| ) |
API to get power resources status.
Requirement: REQ_TAG(PDK-5829), REQ_TAG(PDK-5848), REQ_TAG(PDK-5850) Design: did_pmic_power_cfg_readback
This function can be used to get the status related to current limit
, voltage over and under limit for BUCK/LDO/VCCA/VMON power
resources when corresponding validParam bit field is set in
the Pmic_PowerResourceStat_t
For more information \ref Pmic_PowerResourceStat_t
Application can get the current limit status that if the output
current is above current limit level for BUCK which is stored in the
below defined structure members of
Pmic_PowerResourceStat_t:
currentLimitLvlStat
Application can get the output voltage status that if the
output voltage is below undervoltage threshold for BUCK/LDO which is
stored in the below defined structure members of
Pmic_PowerResourceStat_t :
underVoltageTholdStat
For VMON/VCCA the same member is used to get the input voltage
status that if input voltage is below undervoltage level.
Application can get the output voltage status that if the
output voltage is above overvoltage threshold for BUCK/LDO which is
stored in the below defined structure members of
Pmic_PowerResourceStat_t :
overVoltageTholdStat
For VMON/VCCA the same member is used to get the input voltage
status that if input voltage is above overvoltage level.
Application can get the VCCA voltage status that if the VCCA
voltage is above overvoltage protection level which is stored in
the below defined structure members of
Pmic_PowerResourceStat_t :
overVoltageProtectionLvlStat
| pPmicCoreHandle | [IN] PMIC Interface Handle. |
| pwrResource | [IN] PMIC Power resource Valid values for TPS6594x Leo Device Pmic_Tps6594xLeo_Power_Resource. Valid values for LP8764x HERA Device Pmic_Lp8764xHera_Power_Resource. |
| pPwrRsrcStatCfg | [IN/OUT] Pointer to store Power Resource Status for BUCK/LDO/VMON/VCCA |
| PMIC_ST_SUCCESS | in case of success or appropriate error code. For valid values Pmic_ErrorCodes |
| int32_t Pmic_powerGetPwrThermalStat | ( | Pmic_CoreHandle_t * | pPmicCoreHandle, |
| Pmic_PowerThermalStat_t * | pPwrThermalStatCfg | ||
| ) |
API to get PMIC die temperature thermal status.
Requirement: REQ_TAG(PDK-5840) Design: did_pmic_power_thermal_cfg_readback
This function is used to get the thermal status of the PMIC
(die temperature) when corresponding validParam bit field is set in
the Pmic_PowerThermalStat_t
For more information \ref Pmic_PowerThermalStat_t
Application can get the thermal status that if the die junction
above the thermal warning level which is stored in
the below defined structure members of
Pmic_PowerThermalStat_t:
thermalStateWarning
Application can get the thermal status that if the die junction
above the thermal level causing a sequenced shutdown which is
stored in the below defined structure members of
Pmic_PowerThermalStat_t:
thermalStateOderlyShtDwn
Application can get the thermal status that if the die junction
above the thermal level causing an immediate shutdown which is
stored in the below defined structure members of
Pmic_PowerThermalStat_t:
thermalStateImmShtDwn
| pPmicCoreHandle | [IN] PMIC Interface Handle. |
| pPwrThermalStatCfg | [IN/OUT] Pointer to store Thermal configuration for PMIC |
| PMIC_ST_SUCCESS | in case of success or appropriate error code. For valid values Pmic_ErrorCodes |
| int32_t Pmic_powerSetThermalConfig | ( | Pmic_CoreHandle_t * | pPmicCoreHandle, |
| const Pmic_PowerThermalCfg_t | thermalThreshold | ||
| ) |
API to configure the thermal temperature threshold level for PMIC.
Requirement: REQ_TAG(PDK-5840), REQ_TAG(PDK-9111), REQ_TAG(PDK-9117) Design: did_pmic_power_thermal_cfg_readback
This function is used to set the thermal threshold level for PMIC
(die temperature) when corresponding validParam bit field is set in
the Pmic_PowerThermalCfg_t
For more information \ref Pmic_PowerThermalCfg_t
To configure the the thermal warning threshold temperature level,
the application has to configure the below defined structure
member of the Pmic_PowerThermalCfg_t:
thermalWarnThold
To configure the the thermal shutdown threshold temperature level,
the application has to configure the below defined structure member
of the Pmic_PowerThermalCfg_t:
thermalShutdownThold
| pPmicCoreHandle | [IN] PMIC Interface Handle. |
| thermalThreshold | [IN] Thermal Configuration. |
| PMIC_ST_SUCCESS | in case of success or appropriate error code. For valid values Pmic_ErrorCodes |
| int32_t Pmic_powerGetThermalConfig | ( | Pmic_CoreHandle_t * | pPmicCoreHandle, |
| Pmic_PowerThermalCfg_t * | pThermalThreshold | ||
| ) |
Get the PMIC thermal threshold value function.
Requirement: REQ_TAG(PDK-5840), REQ_TAG(PDK-9117) Design: did_pmic_power_thermal_cfg_readback
This function is used to get the thermal temperature threshold
value for the PMIC when corresponding validParam bit field is set in
the Pmic_PowerThermalCfg_t
For more information \ref Pmic_PowerThermalCfg_t
Application can get the the thermal wrarning threshold temperature
level which is stored in the below defined structure member of
member of the Pmic_PowerThermalCfg_t:
thermalWarnThold
Application can get the the thermal shutdown threshold temperature
level which is stored in the below defined structure member
of the Pmic_PowerThermalCfg_t:
thermalShutdownThold
| pPmicCoreHandle | [IN] PMIC Interface Handle. |
| pThermalThreshold | [IN/OUT] Pointer to hold Thermal Cfg |
| PMIC_ST_SUCCESS | in case of success or appropriate error code. For valid values Pmic_ErrorCodes |
| int32_t Pmic_powerSetPwrRsrcIntr | ( | Pmic_CoreHandle_t * | pPmicCoreHandle, |
| const uint16_t | pwrResource, | ||
| const uint8_t | intrType, | ||
| const bool | intrEnable | ||
| ) |
API to enable/disable Power interrupt.
Requirement: REQ_TAG(PDK-5829), REQ_TAG(PDK-5848) Design: did_pmic_power_cfg_readback
This function is used to enable/disable Power Resource Interrupts
| pPmicCoreHandle | [IN] PMIC Interface Handle. |
| pwrResource | [IN] PMIC Power resource Valid values for TPS6594x Leo Device Pmic_Tps6594xLeo_Power_Resource. Valid values for LP8764x HERA Device Pmic_Lp8764xHera_Power_Resource |
| intrType | [IN] Interrupt type Valid values for TPS6594x Leo Device Pmic_Tps6594x_PowerInterruptType Valid values for LP8764x HERA Device Pmic_LP8764x_PowerInterruptType |
| intrEnable | [IN] Enable/Disable the interrupt. For Vaild values: Pmic_PowerInterruptCfg |
| int32_t Pmic_powerSetIntr | ( | Pmic_CoreHandle_t * | pPmicCoreHandle, |
| const uint8_t | intrType, | ||
| const bool | intrEnable | ||
| ) |
API to enable/disable Power interrupt.
Requirement: REQ_TAG(PDK-5841), REQ_TAG(PDK-5840) Design: did_pmic_power_cfg_readback, did_pmic_power_thermal_cfg_readback
This function is used to enable/disable power Interrupts
| pPmicCoreHandle | [IN] PMIC Interface Handle. |
| intrType | [IN] Interrupt type Valid values for TPS6594x Leo Device Pmic_Tps6594x_PowerInterruptCommonType Valid values for LP8764x HERA Device Pmic_LP8764x_PowerInterruptCommonType |
| intrEnable | [IN] Enable/Disable the interrupt. For Vaild values: Pmic_PowerInterruptCfg |
| int32_t Pmic_powerSetLdoRtc | ( | Pmic_CoreHandle_t * | pPmicCoreHandle, |
| bool | ldortcEnable | ||
| ) |
API to enable/disable LDORTC regulator.
Requirement: REQ_TAG(PDK-5841) Design: did_pmic_power_cfg_readback
This function is used to enable/disable LDORTC regulator.
| pPmicCoreHandle | [IN] PMIC Interface Handle. |
| ldortcEnable | [IN] Enable/Disable the LDORTC. Valid values: Pmic_Tps6594x_PowerLdoRtcCfg |
| int32_t Pmic_powerGetLdoRtc | ( | Pmic_CoreHandle_t * | pPmicCoreHandle, |
| bool * | pLdortcEnable | ||
| ) |
API to get enable/disable status for LDORTC regulator.
Requirement: REQ_TAG(PDK-5841) Design: did_pmic_power_cfg_readback
This function is used to get enable/disable status for LDORTC
regulator.
| pPmicCoreHandle | [IN] PMIC Interface Handle. |
| pLdortcEnable | [IN] Pointer to hold Enable/Disable status. Valid values: Pmic_Tps6594x_PowerLdoRtcCfg |
1.8.15