Device health

Overview

These APIs are for health More…

// global functions

XPUM_API xpum_result_t xpumSetHealthConfig(
    xpum_device_id_t deviceId,
    xpum_health_config_type_t key,
    void* value
    );

XPUM_API xpum_result_t xpumGetHealthConfig(
    xpum_device_id_t deviceId,
    xpum_health_config_type_t key,
    void* value
    );

XPUM_API xpum_result_t xpumGetHealth(
    xpum_device_id_t deviceId,
    xpum_health_type_t type,
    xpum_health_data_t* data
    );

Detailed Documentation

These APIs are for health

Global Functions

XPUM_API xpum_result_t xpumSetHealthConfig(
    xpum_device_id_t deviceId,
    xpum_health_config_type_t key,
    void* value
    )

Set health configuration by device.

Support Platform: Linux

Parameters:

deviceId	IN: Device id
key	IN: Configuration key to set
value	IN: Pointer to configuration value to set, the type of value is decided by key type, which should be documented

Returns:

xpum_result_t

XPUM_API xpum_result_t xpumGetHealthConfig(
    xpum_device_id_t deviceId,
    xpum_health_config_type_t key,
    void* value
    )

Get health configuration by device.

Support Platform: Linux

Parameters:

deviceId	IN: Device id
key	IN: Configuration key to get
value	OUT: Pointer to configuration value to get the type of value is decided by key type, which should be documented

Returns:

xpum_result_t

XPUM_API xpum_result_t xpumGetHealth(
    xpum_device_id_t deviceId,
    xpum_health_type_t type,
    xpum_health_data_t* data
    )

Get health status by device for specific health type.

Support Platform: Linux

Parameters:

deviceId	IN: Device id
type	IN: Health type to get
data	OUT: Health status data

Returns:

xpum_result_t