SDL API Guide for J721E
Functions
VTM Functions
SDL API » Voltage and Thermal Monitor(VTM)

Introduction

Functions

int32_t SDL_VTM_initVd (SDL_VTM_InstVd instance, const SDL_VTM_configVd *pConfig)
 VTM Voltage Domain initialization. More...
 
int32_t SDL_VTM_initTs (SDL_VTM_InstTs instance, const SDL_VTM_configTs *pConfig)
 VTM Temperature sensor initialization. More...
 
int32_t SDL_VTM_getTemp (SDL_VTM_InstTs instance, uint32_t *pTempVal)
 Read VTM Temperature sensor values in degree celcius. More...
 
int32_t SDL_VTM_getSensorStatus (SDL_VTM_InstTs instance, const SDL_VTM_Stat_read_ctrl *pCtrl, SDL_VTM_Stat_val *pStat_val)
 Read VTM Temperature sensor status. More...
 
int32_t SDL_VTM_intrCntrl (SDL_VTM_InstVd instance, SDL_VTM_intrCtrl intrCtrl)
 Set maximum Threshold values of VTM Temperature sensor. More...
 
int32_t SDL_VTM_verifyConfigVd (SDL_VTM_InstVd instance, const SDL_VTM_configVd *pConfig)
 VTM Voltage Domain configures verification. More...
 
int32_t SDL_VTM_verifyConfigTs (SDL_VTM_InstTs instance, const SDL_VTM_configTs *pConfig)
 VTM Temperature sensor configures verification. More...
 
int32_t SDL_VTM_getStaticRegistersVd (SDL_VTM_InstVd instance, SDL_VTM_staticRegsVd *pStaticRegs)
 VTM Voltage Domain readback Static configuration registers. More...
 
int32_t SDL_VTM_getStaticRegistersTs (SDL_VTM_InstTs instance, SDL_VTM_staticRegsTs *pStaticRegs)
 VTM Temperature sensor readback Static configuration registers. More...
 

Function Documentation

◆ SDL_VTM_initVd()

int32_t SDL_VTM_initVd ( SDL_VTM_InstVd  instance,
const SDL_VTM_configVd *  pConfig 
)

VTM Voltage Domain initialization.

This function executes a VTM Voltage Domain initialization of the specified type for a specific VTM VD instance. VTM is a feature that is used to set OPP VID, event selection, global configuration

Parameters
instance[IN] VTM Voltage Domain instance
pConfig[IN] Pointer to VTM VD configuration (optional)
Returns
The SDL error code for the API. If pConfig is NULL: SDL_EBADARGS If instance is invalid: SDL_EBADARGS Success: SDL_PASS

◆ SDL_VTM_initTs()

int32_t SDL_VTM_initTs ( SDL_VTM_InstTs  instance,
const SDL_VTM_configTs *  pConfig 
)

VTM Temperature sensor initialization.

This function executes a VTM Temperature sensor initialization of the specified type for a specific VTM TS instance. VTM is a feature that is used to set control register, thermal shutdown range, Threshold values and interrupts

Parameters
instance[IN] VTM Temperature sensor instance
pConfig[IN] Pointer to VTM TS configuration (optional)
Returns
The SDL error code for the API. If pConfig is NULL: SDL_EBADARGS If instance is invalid: SDL_EBADARGS Success: SDL_PASS

◆ SDL_VTM_getTemp()

int32_t SDL_VTM_getTemp ( SDL_VTM_InstTs  instance,
uint32_t *  pTempVal 
)

Read VTM Temperature sensor values in degree celcius.

Parameters
instance[IN] VTM Temperature sensor instance
pTempVal[OUT] Pointer to Temperature sensor values
Returns
The SDL error code for the API. If pTempVal is NULL: SDL_EBADARGS If instance is invalid: SDL_EBADARGS Success: SDL_PASS

◆ SDL_VTM_getSensorStatus()

int32_t SDL_VTM_getSensorStatus ( SDL_VTM_InstTs  instance,
const SDL_VTM_Stat_read_ctrl *  pCtrl,
SDL_VTM_Stat_val *  pStat_val 
)

Read VTM Temperature sensor status.

Parameters
instance[IN] VTM Temperature sensor instance
pCtrl[IN] Pointer to VTM interrupt control
pStat_val[OUT] Pointer to Temperature sensor status
Returns
The SDL error code for the API. If pCtrl and pStat_val are NULL: SDL_EBADARGS If instance is invalid: SDL_EBADARGS Success: SDL_PASS

◆ SDL_VTM_intrCntrl()

int32_t SDL_VTM_intrCntrl ( SDL_VTM_InstVd  instance,
SDL_VTM_intrCtrl  intrCtrl 
)

Set maximum Threshold values of VTM Temperature sensor.

Parameters
instance[IN] VTM Temperature sensor instance
intrCtrl[IN] VTM interrupt control
Returns
The SDL error code for the API. If intrCtrl and instance are invalid: SDL_EBADARGS Success: SDL_PASS

◆ SDL_VTM_verifyConfigVd()

int32_t SDL_VTM_verifyConfigVd ( SDL_VTM_InstVd  instance,
const SDL_VTM_configVd *  pConfig 
)

VTM Voltage Domain configures verification.

Parameters
instance[IN] VTM Voltage Domain instance
pConfig[IN] Pointer to VTM VD configuration (optional)
Returns
The SDL error code for the API. If pConfig is NULL: SDL_EBADARGS If instance is invalid: SDL_EBADARGS Success: SDL_PASS

◆ SDL_VTM_verifyConfigTs()

int32_t SDL_VTM_verifyConfigTs ( SDL_VTM_InstTs  instance,
const SDL_VTM_configTs *  pConfig 
)

VTM Temperature sensor configures verification.

Parameters
instance[IN] VTM Temperature sensor instance
pConfig[IN] Pointer to VTM VD configuration (optional)
Returns
The SDL error code for the API. If pConfig is NULL: SDL_EBADARGS If instance is invalid: SDL_EBADARGS Success: SDL_PASS

◆ SDL_VTM_getStaticRegistersVd()

int32_t SDL_VTM_getStaticRegistersVd ( SDL_VTM_InstVd  instance,
SDL_VTM_staticRegsVd *  pStaticRegs 
)

VTM Voltage Domain readback Static configuration registers.

Parameters
instance[IN] VTM Voltage Domain instance
pStaticRegs[OUT] Pointer to VTM VD static register
Returns
The SDL error code for the API. If pStaticRegs is NULL: SDL_EBADARGS If instance is invalid: SDL_EBADARGS Success: SDL_PASS

◆ SDL_VTM_getStaticRegistersTs()

int32_t SDL_VTM_getStaticRegistersTs ( SDL_VTM_InstTs  instance,
SDL_VTM_staticRegsTs *  pStaticRegs 
)

VTM Temperature sensor readback Static configuration registers.

Parameters
instance[IN] VTM Temperature sensor instance
pStaticRegs[OUT] Pointer to VTM TS static register
Returns
The SDL error code for the API. If pStaticRegs is NULL: SDL_EBADARGS If instance is invalid: SDL_EBADARGS Success: SDL_PASS