AVED OutOfBand Telemetry Application¶

Overview¶

The Out-of-Band Telemetry application handles the events and communication between the Board Management Controller (BMC) and the ASDM data.

Application External APIs¶

Initialize the application¶

This function:

Creates a mutex
Binds into the BMC Proxy via iBMC_BindCallback and starts listening for incoming events.

iOUT_OF_BAND_TELEMETRY_Initialise

/**
 * @brief   Initialise the out of band telemetry application layer
 *          used to handle events and communication with RMI
 *
 * @return  OK          Success
 *          ERROR       Failure
 */
int iOUT_OF_BAND_TELEMETRY_Initialise( void );

Print Statistics¶

Debug function used to display the statistic counters and errors.

iOUT_OF_BAND_TELEMETRY_PrintStatistics

/**
 * @brief   Print all the stats gathered by the application
 *
 * @return  OK          Stats retrieved from the application successfully
 *          ERROR       Stats not retrieved successfully
 *
 */
int iOUT_OF_BAND_TELEMETRY_PrintStatistics( void );

Clear Statistics¶

Debug function used to clear the all statistics counters back to zero.

iOUT_OF_BAND_TELEMETRY_ClearStatistics

/**
 * @brief   Clear all the stats in the application
 *
 * @return  OK          Stats cleared successfully
 *          ERROR       Stats not cleared successfully
 *
 */
int iOUT_OF_BAND_TELEMETRY_ClearStatistics( void );

BMC Callback¶

On initialization, the application binds in the BMC callback and starts listening to incoming events.

When an event is received, the application will call back into the BMC Proxy to get additional data associated with the request, e.g. Sensor ID.

The request type (below) is then used to form up the response back from the BMC Proxy, and increment stats where required.

Event Type	Function
BMC_PROXY_DRIVER_E_GET_PDR	Stat incremented internally.
BMC_PROXY_DRIVER_E_GET_PDR_REPOSITORY_INFO	Stat incremented internally.
BMC_PROXY_DRIVER_E_GET_SENSOR_INFO	PLDM ID is decoded into AMC ID and sensor type. The application then calls into the ASC with those parameters to pull the latest sensor value. This is then returned to the BMC proxy as an int16_t. Stat incremented internally.
BMC_PROXY_DRIVER_E_ENABLE_SENSOR	PLDM ID is decoded into AMC ID and sensor type. The application then calls into the ASC with those parameters to set the sensor operational state to the value provided in the initial request. OK returned to BMC if sensor state was set successfully. Stat incremented internally.

Page Revision: v. 8