PDK API Guide for J721E
Board Standard APIs

Introduction

Functions

Board_STATUS Board_getIDInfo (Board_IDInfo *info)
 Get board information. More...
 
Board_STATUS Board_getIDInfo_v2 (Board_IDInfo_v2 *info, uint8_t slaveAddress)
 Get board information - v2. More...
 
Board_STATUS Board_writeIDInfo_v2 (Board_IDInfo_v2 *info, uint8_t slaveAddress)
 Set board information - v2. More...
 
Board_STATUS Board_getSoCInfo (Board_SoCInfo *socInfo)
 Get SoC information. More...
 
Board_STATUS Board_init (Board_initCfg cfg)
 Initialization functions for a specific board. More...
 
Board_STATUS Board_deinit (Board_initCfg cfg)
 Board library deinitialization function. More...
 
Board_STATUS Board_DDRTempMonitoringInit (Board_thermalMgmtCallbackFunction_t callbackFunction)
 Initialize Board DDR Temperature monitoring. More...
 

Function Documentation

Board_STATUS Board_getIDInfo ( Board_IDInfo info)

Get board information.

Parameters
[out]infoThis structure will have board information on return
Returns
Board_STATUS Returns status on API call
Board_STATUS Board_getIDInfo_v2 ( Board_IDInfo_v2 *  info,
uint8_t  slaveAddress 
)

Get board information - v2.

Parameters
[out]infoThis structure will have board information on return
[in]slaveAddressI2C slave address of EEPROM to be read
Returns
Board_STATUS Returns status on API call
Board_STATUS Board_writeIDInfo_v2 ( Board_IDInfo_v2 *  info,
uint8_t  slaveAddress 
)

Set board information - v2.

Parameters
[in]infoThis structure will have board information
[in]slaveAddressI2C slave address of EEPROM to be write
Returns
Board_STATUS Returns status on API call
Board_STATUS Board_getSoCInfo ( Board_SoCInfo socInfo)

Get SoC information.

Parameters
[out]socInfoThis structure will have SoC information on return
Returns
Board_STATUS Returns status on API call
Board_STATUS Board_init ( Board_initCfg  cfg)

Initialization functions for a specific board.

Parameters
[in]cfgParam to indicate what to initialize when calling Board_init()
Returns
Board_STATUS Returns status on API call
Board_STATUS Board_deinit ( Board_initCfg  cfg)

Board library deinitialization function.

BOARD_DEINIT_UART_STDIO - Deinitializes the UART module.

Parameters
cfg[IN] Board configuration flags
Returns
BOARD_SOK in case of success or appropriate error code
Board_STATUS Board_DDRTempMonitoringInit ( Board_thermalMgmtCallbackFunction_t  callbackFunction)

Initialize Board DDR Temperature monitoring.

Parameters
[in]callbackFunctionCallback function to be called with thermal events
Returns
Board_STATUS Returns status on API call