PDK API Guide for J721E
|
Application interfaces provided by TPS65941 PMIC device library.
Data Structures | |
struct | Board_Tps65941GpioRegCfg |
TPS65941 gpio details object structure. More... | |
struct | Board_Tps65941PwrResourceRegCfg |
TPS65941 power resource details object structure. More... | |
struct | Board_Tps65941IntrRegMap |
TPS65941 power resource details object structure. More... | |
struct | Board_Tps65941VoltMonitorCfg |
TPS65941 voltage monitoring details object structure. More... | |
struct | Board_Tps65941RtcTime |
TPS65941 RTC time object structure. More... | |
struct | Board_Tps65941RtcDate |
TPS65941 RTC Date object structure. More... | |
struct | Board_Tps65941WdtCfg |
TPS65941 WDT configuration parameters object structure. More... | |
struct | Board_Tps65941EsmCfg |
TPS65941 ESM configuration parameters object structure. More... | |
Functions | |
Board_STATUS | Board_tps65941GpioRead (void *handle, uint8_t slaveAddr, uint8_t pinNum, uint8_t *pinValue) |
TPS65941 GPIO read function. More... | |
Board_STATUS | Board_tps65941GpioWrite (void *handle, uint8_t slaveAddr, uint8_t pinNum, uint8_t pinValue) |
TPS65941 GPIO write function. More... | |
Board_STATUS | Board_tps65941SetVoltage (void *handle, uint8_t slaveAddr, uint8_t powerResource, uint16_t millivolt) |
TPS65941 set voltage function. More... | |
Board_STATUS | Board_tps65941GetVoltage (void *handle, uint8_t slaveAddr, uint8_t powerResource, uint16_t *millivolt) |
TPS65941 read voltage function. More... | |
Board_STATUS | Board_tps65941ConvertVolt (uint8_t voutCode, uint8_t powerResource, uint16_t *millivolt) |
Conversion of VOUT code to millivolt. More... | |
Board_STATUS | Board_tps65941ConvertVoutCode (uint16_t millivolt, uint8_t powerResource, uint8_t *voutCode) |
Conversion of millivolt to VOUT code. More... | |
Board_STATUS | Board_tps65941ConfigIntr (void *handle, uint8_t slaveAddr, uint32_t intrID, uint8_t intrEnable) |
TPS65941 enable/disable interrupt function. More... | |
Board_STATUS | Board_tps65941GetIntrStatus (void *handle, uint8_t slaveAddr, uint32_t intrID, uint8_t *intrStatus) |
Get the TPS65941 interrupt function. More... | |
Board_STATUS | Board_tps65941ClearIntr (void *handle, uint8_t slaveAddr, uint32_t intrID) |
Clears the TPS65941 interrupt function. More... | |
Board_STATUS | Board_tps65941SetThermalThresVal (void *handle, uint8_t slaveAddr, uint32_t thermalThresholdVal) |
Set the TPS65941 thermal threshold value function. More... | |
Board_STATUS | Board_tps65941GetThermalStatus (void *handle, uint8_t slaveAddr, uint32_t *thermalStatus) |
Get the TPS65941 thermal status function. More... | |
Board_STATUS | Board_tps65941SetThermalMonitor (void *handle, uint8_t slaveAddr) |
Set the thermal monitoring function. More... | |
Board_STATUS | Board_tps65941SetVoltageMonitor (void *handle, uint8_t slaveAddr, uint8_t powerResource, Board_Tps65941VoltMonitorCfg *voltMonCfg) |
Set the voltage monitoring function. More... | |
Board_STATUS | Board_tps65941SetVccaMonitor (void *handle, uint8_t slaveAddr, uint8_t vccaPgLevel, Board_Tps65941VoltMonitorCfg *voltMonitorCfg) |
Set the Vcca voltage monitoring function. More... | |
Board_STATUS | Board_tps65941SetRtc (void *handle, uint8_t slaveAddr, Board_Tps65941RtcTime *timeCfg, Board_Tps65941RtcDate *dateCfg) |
Set the TPS65941 RTC date and time function. More... | |
Board_STATUS | Board_tps65941GetRtc (void *handle, uint8_t slaveAddr, Board_Tps65941RtcTime *timeCfg, Board_Tps65941RtcDate *dateCfg) |
Get the TPS65941 RTC date and time function. More... | |
Board_STATUS | Board_tps65941SetAlarmIntr (void *handle, uint8_t slaveAddr, Board_Tps65941RtcTime *timeCfg, Board_Tps65941RtcDate *dateCfg) |
Set the alarm interrupt in TPS65941 RTC function. More... | |
Board_STATUS | Board_tps65941SetTimerIntr (void *handle, uint8_t slaveAddr, uint8_t timerPeriod) |
Set the timer interrupt in TPS65941 RTC function. More... | |
Board_STATUS | Board_tps65941WdtDisable (void *handle, uint8_t slaveAddr, uint8_t wdtDisable) |
Enable/Disable the TPS65941 Watchdog function. More... | |
Board_STATUS | Board_tps65941WdtConfig (void *handle, uint8_t slaveAddr, uint8_t wdtCfgMode, Board_Tps65941WdtCfg *wdtCfg) |
TPS65941 watchdog configuration function. More... | |
Board_STATUS | Board_tps65941GetWdtStat (void *handle, uint8_t slaveAddr, uint8_t wdtErrType, uint8_t *wdtErrStat) |
TPS65941 watchdog error status function. More... | |
Board_STATUS | Board_tps65941StartEsm (void *handle, uint8_t slaveAddr, uint8_t esmCfg, uint8_t esmMode) |
Start TPS65941 ESM function. More... | |
Board_STATUS | Board_tps65941StopEsm (void *handle, uint8_t slaveAddr, uint8_t esmCfg) |
Stop TPS65941 ESM function. More... | |
Board_STATUS | Board_tps65941ConfigEsm (void *handle, uint8_t slaveAddr, uint8_t esmCfgType, Board_Tps65941EsmCfg *esmCfg) |
TPS65941 ESM configuration function. More... | |
Board_STATUS | Board_tps65941GetEsmCount (void *handle, uint8_t slaveAddr, uint8_t esmCfg, uint8_t *esmErrCnt) |
Get the ESM error count function. More... | |
Board_STATUS Board_tps65941GpioRead | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint8_t | pinNum, | ||
uint8_t * | pinValue | ||
) |
TPS65941 GPIO read function.
This function is used to read the gpio signal level of the TPS65941 device.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
pinNum | [IN] TPS65941 GPIO number |
pinValue | [OUT] TPS65941 GPIO signal level High/Low |
Board_STATUS Board_tps65941GpioWrite | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint8_t | pinNum, | ||
uint8_t | pinValue | ||
) |
TPS65941 GPIO write function.
This function is used to write the gpio signal level to the TPS65941 device.
handle | [IN] Low level driver |
slaveAddr | [IN] TPS65941 slave address |
pinNum | [IN] TPS65941 GPIO number |
pinValue | [IN] TPS65941 GPIO signal level High/Low Valid values: BOARD_TPS65941_GPIO_HIGH BOARD_TPS65941_GPIO_LOW |
Board_STATUS Board_tps65941SetVoltage | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint8_t | powerResource, | ||
uint16_t | millivolt | ||
) |
TPS65941 set voltage function.
This function is used to set the voltage to the power resource of the TPS65941.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
powerResource | [IN] TPS65941 Power resource Valid values: BOARD_TPS65941_BUCK1_RESOURCE BOARD_TPS65941_BUCK2_RESOURCE BOARD_TPS65941_BUCK3_RESOURCE BOARD_TPS65941_BUCK4_RESOURCE BOARD_TPS65941_BUCK5_RESOURCE BOARD_TPS65941_LDO1_RESOURCE BOARD_TPS65941_LDO2_RESOURCE BOARD_TPS65941_LDO3_RESOURCE BOARD_TPS65941_LDO4_RESOURCE |
millivolt | [IN] Voltage in millivolt |
Board_STATUS Board_tps65941GetVoltage | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint8_t | powerResource, | ||
uint16_t * | millivolt | ||
) |
TPS65941 read voltage function.
This function is used to read the voltage to the power resource of the TPS65941.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
powerResource | [IN] TPS65941 Power resource Valid values: BOARD_TPS65941_BUCK1_RESOURCE BOARD_TPS65941_BUCK2_RESOURCE BOARD_TPS65941_BUCK3_RESOURCE BOARD_TPS65941_BUCK4_RESOURCE BOARD_TPS65941_BUCK5_RESOURCE BOARD_TPS65941_LDO1_RESOURCE BOARD_TPS65941_LDO2_RESOURCE BOARD_TPS65941_LDO3_RESOURCE BOARD_TPS65941_LDO4_RESOURCE |
millivolt | [OUT] Voltage in millivolt |
Board_STATUS Board_tps65941ConvertVolt | ( | uint8_t | voutCode, |
uint8_t | powerResource, | ||
uint16_t * | millivolt | ||
) |
Conversion of VOUT code to millivolt.
This function is used to convert the VOUT code read from the PMIC registers to millivolt.
voutCode | [IN] VOUT code in hexadecimal |
powerResource | [IN] PMIC Power resource Valid values: BOARD_TPS65941_BUCK1_RESOURCE BOARD_TPS65941_BUCK2_RESOURCE BOARD_TPS65941_BUCK3_RESOURCE BOARD_TPS65941_BUCK4_RESOURCE BOARD_TPS65941_BUCK5_RESOURCE BOARD_TPS65941_LDO1_RESOURCE BOARD_TPS65941_LDO2_RESOURCE BOARD_TPS65941_LDO3_RESOURCE BOARD_TPS65941_LDO4_RESOURCE |
millivolt | [OUT] Voltage in millivolt |
Board_STATUS Board_tps65941ConvertVoutCode | ( | uint16_t | millivolt, |
uint8_t | powerResource, | ||
uint8_t * | voutCode | ||
) |
Conversion of millivolt to VOUT code.
This function is used to convert the millivolt value to VOUT code to write into the TPS65941 registers.
millivolt | [IN] Voltage in millivolt |
powerResource | [IN] TPS65941 Power resource Valid values: BOARD_TPS65941_BUCK1_RESOURCE BOARD_TPS65941_BUCK2_RESOURCE BOARD_TPS65941_BUCK3_RESOURCE BOARD_TPS65941_BUCK4_RESOURCE BOARD_TPS65941_BUCK5_RESOURCE BOARD_TPS65941_LDO1_RESOURCE BOARD_TPS65941_LDO2_RESOURCE BOARD_TPS65941_LDO3_RESOURCE BOARD_TPS65941_LDO4_RESOURCE |
voutCode | [OUT] VOUT code in hexadecimal |
Board_STATUS Board_tps65941ConfigIntr | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint32_t | intrID, | ||
uint8_t | intrEnable | ||
) |
TPS65941 enable/disable interrupt function.
This function is used to enable/disable the interrupt of the TPS65941.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
intrID | [IN] TPS65941 Interrupt ID Use the macros BOARD_TPS65941_INTR_ID_XXX |
intrEnable | [IN] Enable/Disable the interrupt Valid values: BOARD_TPS65941_INTR_ENABLE BOARD_TPS65941_INTR_DISABLE |
Board_STATUS Board_tps65941GetIntrStatus | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint32_t | intrID, | ||
uint8_t * | intrStatus | ||
) |
Get the TPS65941 interrupt function.
This function is used to get the interrupt status of the TPS65941.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
intrID | [IN] TPS65941 Interrupt ID Use the macros BOARD_TPS65941_INTR_ID_XXX |
intrStatus | [OUT] Interrupt status Valid value: BOARD_TPS65941_INTR_SET BOARD_TPS65941_INTR_UNSET |
Board_STATUS Board_tps65941ClearIntr | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint32_t | intrID | ||
) |
Clears the TPS65941 interrupt function.
This function is used to clear the interrupt of the TPS65941.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
intrID | [IN] TPS65941 Interrupt ID Use the macros BOARD_TPS65941_INTR_ID_XXX |
Board_STATUS Board_tps65941SetThermalThresVal | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint32_t | thermalThresholdVal | ||
) |
Set the TPS65941 thermal threshold value function.
This function is used to set the thermal temperature threshold value for the TPS65941.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
thermalThresholdVal | [IN] Thermal temperature threshold value Valid Values: BOARD_TPS65941_THERMAL_TEMP_120C BOARD_TPS65941_THERMAL_TEMP_130C |
Board_STATUS Board_tps65941GetThermalStatus | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint32_t * | thermalStatus | ||
) |
Get the TPS65941 thermal status function.
This function is used to read the thermal status of the TPS65941.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
thermalStatus | [OUT] TPS65941 Thermal status Valid Value: BOARD_TPS65941_TDIE_NO_WARN BOARD_TPS65941_TDIE_WARN BOARD_TPS65941_TDIE_WARN_ORD_SD BOARD_TPS65941_TDIE_WARN_IMM_SD |
Board_STATUS Board_tps65941SetThermalMonitor | ( | void * | handle, |
uint8_t | slaveAddr | ||
) |
Set the thermal monitoring function.
This function is used to set the thermal temperature monitoring function with PGOOD signal.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
Board_STATUS Board_tps65941SetVoltageMonitor | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint8_t | powerResource, | ||
Board_Tps65941VoltMonitorCfg * | voltMonCfg | ||
) |
Set the voltage monitoring function.
This function is used to set the voltage monitoring function to the BUCK and LDO power resources with PGOOD signal.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
powerResource | [IN] TPS65941 Power resource Valid values: BOARD_TPS65941_BUCK1_RESOURCE BOARD_TPS65941_BUCK2_RESOURCE BOARD_TPS65941_BUCK3_RESOURCE BOARD_TPS65941_BUCK4_RESOURCE BOARD_TPS65941_BUCK5_RESOURCE BOARD_TPS65941_LDO1_RESOURCE BOARD_TPS65941_LDO2_RESOURCE BOARD_TPS65941_LDO3_RESOURCE BOARD_TPS65941_LDO4_RESOURCE |
voltMonCfg | [IN] TPS65941 voltage monitor details |
Board_STATUS Board_tps65941SetVccaMonitor | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint8_t | vccaPgLevel, | ||
Board_Tps65941VoltMonitorCfg * | voltMonitorCfg | ||
) |
Set the Vcca voltage monitoring function.
This function is used to set the voltage monitoring function to the Vcca with PGOOD signal.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
vccaPgLevel | [IN] TPS65941 Vcca Power good level Valid values: BOARD_TPS65941_PG_3V3_LEVEL BOARD_TPS65941_PG_5V_LEVEL |
voltMonitorCfg | [IN] TPS65941 voltage monitor details |
Board_STATUS Board_tps65941SetRtc | ( | void * | handle, |
uint8_t | slaveAddr, | ||
Board_Tps65941RtcTime * | timeCfg, | ||
Board_Tps65941RtcDate * | dateCfg | ||
) |
Set the TPS65941 RTC date and time function.
This function is used to set the date and time parameters in RTC present in the TPS65941.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
timeCfg | [IN] TPS65941 RTC time configuration |
dateCfg | [IN] TPS65941 RTC date configuration |
Board_STATUS Board_tps65941GetRtc | ( | void * | handle, |
uint8_t | slaveAddr, | ||
Board_Tps65941RtcTime * | timeCfg, | ||
Board_Tps65941RtcDate * | dateCfg | ||
) |
Get the TPS65941 RTC date and time function.
This function is used to get the current date and time parameters in RTC present in the TPS65941.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
timeCfg | [OUT] TPS65941 RTC time configuration |
dateCfg | [OUT] TPS65941 RTC date configuration |
Board_STATUS Board_tps65941SetAlarmIntr | ( | void * | handle, |
uint8_t | slaveAddr, | ||
Board_Tps65941RtcTime * | timeCfg, | ||
Board_Tps65941RtcDate * | dateCfg | ||
) |
Set the alarm interrupt in TPS65941 RTC function.
This function is used to set the alarm date and time interrupt in RTC present in the TPS65941.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
timeCfg | [IN] TPS65941 RTC time configuration |
dateCfg | [IN] TPS65941 RTC date configuration |
Board_STATUS Board_tps65941SetTimerIntr | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint8_t | timerPeriod | ||
) |
Set the timer interrupt in TPS65941 RTC function.
This function is used to set the timer interrupt in RTC present in the TPS65941.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
timerPeriod | [IN] Timer interrupt periods Valid values: BOARD_TPS65941_SECOND_INTR_PERIOD BOARD_TPS65941_MINUTE_INTR_PERIOD BOARD_TPS65941_HOUR_INTR_PERIOD BOARD_TPS65941_DAY_INTR_PERIOD |
Board_STATUS Board_tps65941WdtDisable | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint8_t | wdtDisable | ||
) |
Enable/Disable the TPS65941 Watchdog function.
This function is used to enable/disable the watchdog function in the TPS65941.
handle | [IN] Low level driver |
slaveAddr | [IN] TPS65941 slave address |
wdtDisable | [IN] Enable/Disable the watchdog Valid values: BOARD_TPS65941_WDT_DISABLE BOARD_TPS65941_WDT_ENABLE |
Board_STATUS Board_tps65941WdtConfig | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint8_t | wdtCfgMode, | ||
Board_Tps65941WdtCfg * | wdtCfg | ||
) |
TPS65941 watchdog configuration function.
This function is used to configure the watchdog function parameters in the TPS65941 in either trigger mode or Q&A (question and answer) mode.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
wdtCfgMode | [IN] Watchdog configuration mode Valid values: BOARD_TPS65941_WDT_QA_MODE BOARD_TPS65941_WDT_TRIGGER_MODE |
wdtCfg | [IN] TPS65941 watchdog configuration |
Board_STATUS Board_tps65941GetWdtStat | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint8_t | wdtErrType, | ||
uint8_t * | wdtErrStat | ||
) |
TPS65941 watchdog error status function.
This function is used to get the error status from the TPS65941 watchdog.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
wdtErrType | [IN] TPS65941 Watchdog error type Valid Values: BOARD_TPS65941_WDT_RST_INT BOARD_TPS65941_WDT_FAIL_INT BOARD_TPS65941_WDT_ANSW_ERR BOARD_TPS65941_WDT_SEQ_ERR BOARD_TPS65941_WDT_ANSW_ERLY_ERR BOARD_TPS65941_WDT_TRIG_ERLY_ERR BOARD_TPS65941_WDT_TIMEOUT_ERR BOARD_TPS65941_WDT_LNGWIN_TIMEOUT_ERR |
wdtErrStat | [OUT] TPS65941 Watchdog error status Valid Values: BOARD_TPS65941_WDT_ERR_LATCHED BOARD_TPS65941_WDT_NO_ERR |
Board_STATUS Board_tps65941StartEsm | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint8_t | esmCfg, | ||
uint8_t | esmMode | ||
) |
Start TPS65941 ESM function.
This function is used the start the TPS65941 ESM for SoC or MCU in either level or PWM mode.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
esmCfg | [IN] ESM configuration Valid values: BOARD_TPS65941_ESM_SOC BOARD_TPS65941_ESM_MCU |
esmMode | [IN] ESM configuration mode Valid values: BOARD_TPS65941_ESM_LEVEL_MODE BOARD_TPS65941_ESM_PWM_MODE |
Board_STATUS Board_tps65941StopEsm | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint8_t | esmCfg | ||
) |
Stop TPS65941 ESM function.
This function is used the stop the TPS65941 ESM for SoC or MCU.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
esmCfg | [IN] ESM configuration Valid values: BOARD_TPS65941_ESM_SOC BOARD_TPS65941_ESM_MCU |
Board_STATUS Board_tps65941ConfigEsm | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint8_t | esmCfgType, | ||
Board_Tps65941EsmCfg * | esmCfg | ||
) |
TPS65941 ESM configuration function.
This function is used to configure the TPS65941 ESM parameters.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
esmCfgType | [IN] ESM configuration type Valid values: BOARD_TPS65941_ESM_SOC BOARD_TPS65941_ESM_MCU |
esmCfg | [IN] TPS65941 ESM configuration |
Board_STATUS Board_tps65941GetEsmCount | ( | void * | handle, |
uint8_t | slaveAddr, | ||
uint8_t | esmCfg, | ||
uint8_t * | esmErrCnt | ||
) |
Get the ESM error count function.
This function is used to get the number error count events for the TPS65941 ESM for SoC or MCU.
handle | [IN] Low level driver handle |
slaveAddr | [IN] TPS65941 slave address |
esmCfg | [IN] ESM configuration Valid values: BOARD_TPS65941_ESM_SOC BOARD_TPS65941_ESM_MCU |
esmErrCnt | [OUT] TPS65941 ESM error count |