PDK API Guide for J721E
Pmic_PowerResourceCfg_t Struct Reference

Detailed Description

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.

Parameters
validParamsSelection of structure parameters to be set, from the combination of Pmic_PowerResourcesValidParamCfg and the corresponding member value must be updated.
rvCheckEnEnable/Disable residual voltage checking for regulator/VMON pin. Valid values for TPS6594x Leo Device Pmic_TPS6594x_Regulator_RV_Check. Valid values for LP8764x HERA Device Pmic_LP8764x_Regulator_Vmon_RV_Check. Valid only when PMIC_CFG_REGULATOR_VMON_RV_SEL_VALID bit is set.
buckPullDownEnEnable/Disable output pull-down resistor when BUCK is disabled. Valid values for TPS6594x Leo Device Pmic_TPS6594x_Buck_Pull_Down_Resistor. Valid values for LP8764x HERA Device Pmic_LP8764x_Buck_Pull_Down_Resistor. Valid only when PMIC_CFG_REGULATOR_BUCK_PLDN_EN_VALID bit is set.
vmonEnEnable /Disable the Voltage monitor feature. For LDO, VCCA, VMON1 and VMON2: Enable/Disable OV and UV comparators. For BUCK: Enable/Disable OV, UV, SC and ILIM comparators. Note: For VMON1 and VMON2, Need to configure respective GPIO pin functionality before enabling VMON feature Valid values for TPS6594x Leo Device Pmic_TPS6594x_Vmon_Enable. Valid values for LP8764x HERA Device Pmic_LP8764x_Vmon_Enable. Valid only when PMIC_CFG_VMON_EN_VALID bit is set.
buckVoutSelSelect output voltage register for BUCK. Valid values for TPS6594x Leo Device Pmic_TPS6594x_Regulator_Buck_Vout_Sel. Valid values for LP8764x HERA Device Pmic_LP8764x_Regulator_Buck_Vout_Sel. Valid only when PMIC_CFG_REGULATOR_BUCK_VOUT_SEL_VALID bit is set.
buckFpwmModeSelect PWM or Auto Mode for BUCK. Valid values for TPS6594x Leo Device Pmic_TPS6594x_Regulator_Pwm_Pfm_Mode. Valid values for LP8764x HERA Device Pmic_LP8764x_Regulator_Pwm_Pfm_Mode. Valid only when PMIC_CFG_REGULATOR_BUCK_FPWM_VALID bit is set.
buckFpwmMpModeSelect between Multi phase with PWM OR AUTO mode with Automatic phase adding and shedding for BUCK. Valid values for TPS6594x Leo Device Pmic_TPS6594x_Regulator_Pwm_Mp_Mode. Valid values for LP8764x HERA Device PMIC_LP8764X_Regulator_Pwm_Mp_Mode. Valid only when PMIC_CFG_REGULATOR_BUCK_PWM_MP_VALID bit is set.
regulatorEnEnable/Disable the power regulators. Valid values for TPS6594x Leo Device Pmic_TPS6594x_Power_Regulator_enable. Valid values for LP8764x HERA Device Pmic_LP8764x_Buck_Regulator_enable. Valid only when PMIC_CFG_REGULATOR_EN_VALID bit is set.
ldoSlowRampEnEnable/Disable Slow Ramp for LDO Valid only for TPS6594X Leo. For Valid Values Pmic_TPS6594x_Regulator_Ldo_Slow_Ramp. Valid only when PMIC_CFG_REGULATOR_LDO_SLOW_RAMP_EN_VALID bit is set. Valid only for TPS6594x Leo PMIC PG2.0
ldoBypassModeEnSelects Bypass/Linear Regulator LDO mode. Valid only for TPS6594X Leo. For Valid Values Pmic_TPS6594x_Regulator_Ldo_Mode. Valid only when PMIC_CFG_REGULATOR_LDO_BYPASS_MODE_EN_VALID bit is set.
vccaPwrGudLvlPowergood level for VCCA pin. Valid values for TPS6594x Leo Device Pmic_TPS6594x_VccaPowerGoodLimit. Valid values for LP8764x HERA Device Pmic_LP8764x_VccaPowerGoodLimit. Valid only when PMIC_CFG_VCCA_PWR_GOOD_LVL_VALID bit is set.
vmonRangeSelect OV/UV voltage monitoring range for VMON Valid only for LP8764X Hera. For Valid Values Pmic_LP8764x_Power_Vmon_Range. Valid only when PMIC_CFG_VMON_RANGE_VALID bit is set
buckCurrentLimitSwitch peak current limit for BUCK regulator. Valid values for TPS6594x Leo Device Pmic_TPS6594x_Buck_Current_Limit. Valid values for LP8764x HERA Device Pmic_LP8764x_Buck_Current_Limit. Valid only when PMIC_CFG_REGULATOR_BUCK_ILIM_VALID bit is set.
buckVmonSlewRateOutput voltage slew rate for BUCK/VMON Valid values for TPS6594x Leo Device Pmic_TPS6594x_Buck_Slew_Rate. Valid values for LP8764x HERA Device Pmic_LP8764x_Buck_Vmon_Slew_Rate. Valid only when PMIC_CFG_REGULATOR_BUCK_VMON_SLEW_RATE_VALID bit is set
ldoPullDownSelSelects the resistor value for output pull-down resistor for LDO regulator Valid only for TPS6594X Leo. For Valid Values Pmic_TPS6594x_Ldo_Pldn_Resistor_Val. Valid only when PMIC_CFG_REGULATOR_LDO_PLDN_SEL_VALID bit is set.
ldoRvTimeoutSelLDO residual voltage check timeout select. Valid only for TPS6594X Leo. For Valid Values Pmic_TPS6594x_Ldo_RV_Timeout. Valid only when PMIC_CFG_REGULATOR_LDO_RV_TIMEOUT_SEL_VALID bit is set.
pgUvThresholdLvlPower good low threshold level for the power resources. Valid values for TPS6594x Leo Device Pmic_TPS6594x_Pg_Ov_Uv_Threshold_lvl. Valid values for LP8764x HERA Device Pmic_LP8764x_Pg_Ov_Uv_Threshold_lvl. Valid only when PMIC_CFG_PWR_RESOURCE_PG_UV_THRESHOLD_LVL_VALID bit is set.
pgOvThresholdLvlPower good high threshold level for the power resources. Valid values for TPS6594x Leo Device Pmic_TPS6594x_Pg_Ov_Uv_Threshold_lvl. Valid values for LP8764x HERA Device Pmic_LP8764x_Pg_Ov_Uv_Threshold_lvl. PMIC_CFG_PWR_RESOURCE_PG_OV_THRESHOLD_LVL_VALID bit is set.
railGrpSelRail group selection for the power resources Valid values for TPS6594x Leo Device Pmic_TPS6594x_Power_Rail_Sel. Valid values for LP8764x HERA Device Pmic_LP8764x_Power_Rail_Sel. Valid only when PMIC_CFG_PWR_RESOURCE_RAIL_GRP_SEL_VALID bit is set
voltage_mVFor LDO/BUCK: Voltage level in mv. For VMON1/VMON2: Powergood voltage level in mv Valid only when PMIC_CFG_REGULATOR_VMON_VOLTAGE_SET_VALID bit is set

Data Fields

uint32_t validParams
 
bool rvCheckEn
 
bool buckPullDownEn
 
bool vmonEn
 
bool buckVoutSel
 
bool buckFpwmMode
 
bool buckFpwmMpMode
 
bool regulatorEn
 
bool ldoSlowRampEn
 
bool ldoBypassModeEn
 
bool vccaPwrGudLvl
 
bool vmonRange
 
uint8_t buckCurrentLimit
 
uint8_t buckVmonSlewRate
 
uint8_t ldoPullDownSel
 
uint8_t ldoRvTimeoutSel
 
uint8_t pgUvThresholdLvl
 
uint8_t pgOvThresholdLvl
 
uint8_t railGrpSel
 
uint16_t voltage_mV
 

Field Documentation

◆ validParams

uint32_t Pmic_PowerResourceCfg_t::validParams

◆ rvCheckEn

bool Pmic_PowerResourceCfg_t::rvCheckEn

◆ buckPullDownEn

bool Pmic_PowerResourceCfg_t::buckPullDownEn

◆ vmonEn

bool Pmic_PowerResourceCfg_t::vmonEn

◆ buckVoutSel

bool Pmic_PowerResourceCfg_t::buckVoutSel

◆ buckFpwmMode

bool Pmic_PowerResourceCfg_t::buckFpwmMode

◆ buckFpwmMpMode

bool Pmic_PowerResourceCfg_t::buckFpwmMpMode

◆ regulatorEn

bool Pmic_PowerResourceCfg_t::regulatorEn

◆ ldoSlowRampEn

bool Pmic_PowerResourceCfg_t::ldoSlowRampEn

◆ ldoBypassModeEn

bool Pmic_PowerResourceCfg_t::ldoBypassModeEn

◆ vccaPwrGudLvl

bool Pmic_PowerResourceCfg_t::vccaPwrGudLvl

◆ vmonRange

bool Pmic_PowerResourceCfg_t::vmonRange

◆ buckCurrentLimit

uint8_t Pmic_PowerResourceCfg_t::buckCurrentLimit

◆ buckVmonSlewRate

uint8_t Pmic_PowerResourceCfg_t::buckVmonSlewRate

◆ ldoPullDownSel

uint8_t Pmic_PowerResourceCfg_t::ldoPullDownSel

◆ ldoRvTimeoutSel

uint8_t Pmic_PowerResourceCfg_t::ldoRvTimeoutSel

◆ pgUvThresholdLvl

uint8_t Pmic_PowerResourceCfg_t::pgUvThresholdLvl

◆ pgOvThresholdLvl

uint8_t Pmic_PowerResourceCfg_t::pgOvThresholdLvl

◆ railGrpSel

uint8_t Pmic_PowerResourceCfg_t::railGrpSel

◆ voltage_mV

uint16_t Pmic_PowerResourceCfg_t::voltage_mV