Ras - Deprecated

oneAPI Level Zero Specification - Version 1.20.41

Ras - Deprecated Functions

zesRasGetConfig

Added in version 1.0

Deprecated since 1.16. Use zesRasGetConfigExp instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesRasGetConfig(zes_ras_handle_t hRas, zes_ras_config_t *pConfig)

Get RAS error thresholds that control when RAS events are generated

• The driver maintains counters for all RAS error sets and error categories. Events are generated when errors occur. The configuration enables setting thresholds to limit when events are sent.

• When a particular RAS correctable error counter exceeds the configured threshold, the event ZES_EVENT_TYPE_FLAG_RAS_CORRECTABLE_ERRORS will be triggered.

• When a particular RAS uncorrectable error counter exceeds the configured threshold, the event ZES_EVENT_TYPE_FLAG_RAS_UNCORRECTABLE_ERRORS will be triggered.

• The application may call this function from simultaneous threads.

• The implementation of this function should be lock-free.

Parameters:

• hRas – [in] Handle for the component.

• pConfig – [in,out] Will be populed with the current RAS configuration - thresholds used to trigger events

Returns:

• ZE_RESULT_SUCCESS

• ZE_RESULT_ERROR_UNINITIALIZED

• ZE_RESULT_ERROR_DEVICE_LOST

• ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY

• ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY

• ZE_RESULT_ERROR_INVALID_ARGUMENT

• ZE_RESULT_ERROR_UNSUPPORTED_FEATURE

• ZE_RESULT_ERROR_DEPENDENCY_UNAVAILABLE

• ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS

• ZE_RESULT_ERROR_NOT_AVAILABLE

• ZE_RESULT_ERROR_DEVICE_REQUIRES_RESET

• ZE_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE

• ZE_RESULT_ERROR_UNKNOWN

• ZE_RESULT_ERROR_INVALID_NULL_HANDLE

  • nullptr == hRas

• ZE_RESULT_ERROR_INVALID_NULL_POINTER

  • nullptr == pConfig

zesRasSetConfig

Added in version 1.0

Deprecated since 1.16. Use zesRasSetConfigExp instead.

ZE_APIEXPORT ze_result_t ZE_APICALL zesRasSetConfig(zes_ras_handle_t hRas, const zes_ras_config_t *pConfig)

Set RAS error thresholds that control when RAS events are generated

• The driver maintains counters for all RAS error sets and error categories. Events are generated when errors occur. The configuration enables setting thresholds to limit when events are sent.

• When a particular RAS correctable error counter exceeds the specified threshold, the event ZES_EVENT_TYPE_FLAG_RAS_CORRECTABLE_ERRORS will be generated.

• When a particular RAS uncorrectable error counter exceeds the specified threshold, the event ZES_EVENT_TYPE_FLAG_RAS_UNCORRECTABLE_ERRORS will be generated.

• Call zesRasGetState() and set the clear flag to true to restart event generation once counters have exceeded thresholds.

• The application may call this function from simultaneous threads.

• The implementation of this function should be lock-free.

Parameters:

• hRas – [in] Handle for the component.

• pConfig – [in] Change the RAS configuration - thresholds used to trigger events

Returns:

• ZE_RESULT_SUCCESS

• ZE_RESULT_ERROR_UNINITIALIZED

• ZE_RESULT_ERROR_DEVICE_LOST

• ZE_RESULT_ERROR_OUT_OF_HOST_MEMORY

• ZE_RESULT_ERROR_OUT_OF_DEVICE_MEMORY

• ZE_RESULT_ERROR_INVALID_ARGUMENT

• ZE_RESULT_ERROR_UNSUPPORTED_FEATURE

• ZE_RESULT_ERROR_DEPENDENCY_UNAVAILABLE

• ZE_RESULT_ERROR_DEVICE_REQUIRES_RESET

• ZE_RESULT_ERROR_DEVICE_IN_LOW_POWER_STATE

• ZE_RESULT_ERROR_UNKNOWN

• ZE_RESULT_ERROR_INVALID_NULL_HANDLE

  • nullptr == hRas

• ZE_RESULT_ERROR_INVALID_NULL_POINTER

  • nullptr == pConfig

• ZE_RESULT_ERROR_NOT_AVAILABLE

  • Another running process is controlling these settings.

• ZE_RESULT_ERROR_INSUFFICIENT_PERMISSIONS

  • Don’t have permissions to set thresholds.