[SWDEV-513210] Add references to AMDGPU RAS Support info in API docs (#144)

Add reference to AMDGPU RAS Support info in API docs

[ROCm/amdsmi commit: 0b4a6ff149]
This commit is contained in:
Park, Peter
2025-03-04 10:32:23 -05:00
committato da GitHub
parent c0809e05cb
commit 43b5d10e26
2 ha cambiato i file con 32 aggiunte e 0 eliminazioni
@@ -1045,6 +1045,10 @@ except AmdSmiException as e:
Description: Returns the ECC error count for the given GPU.
It is not supported on virtual machine guest
See [RAS Error Count sysfs Interface (AMDGPU RAS Support - Linux Kernel
documentation)](https://docs.kernel.org/gpu/amdgpu/ras.html#ras-error-count-sysfs-interface)
to learn how these error counts are accessed.
Input parameters:
* `processor_handle` device which to query
@@ -3106,6 +3110,10 @@ except AmdSmiException as e:
Description: Retrieve the error counts for a GPU block. It is not supported
on virtual machine guest
See [RAS Error Count sysfs Interface (AMDGPU RAS Support - Linux Kernel
documentation)](https://docs.kernel.org/gpu/amdgpu/ras.html#ras-error-count-sysfs-interface)
to learn how these error counts are accessed.
Input parameters:
* `processor_handle` handle for the given device
@@ -3145,6 +3153,10 @@ except AmdSmiException as e:
Description: Retrieve the enabled ECC bit-mask. It is not supported on virtual
machine guest
See [RAS Error Count sysfs Interface (AMDGPU RAS Support - Linux Kernel
documentation)](https://docs.kernel.org/gpu/amdgpu/ras.html#ras-error-count-sysfs-interface)
to learn how these error counts are accessed.
Input parameters:
* `processor_handle` handle for the given device
@@ -3177,6 +3189,10 @@ except AmdSmiException as e:
Description: Retrieve the ECC status for a GPU block. It is not supported
on virtual machine guest
See [RAS Error Count sysfs Interface (AMDGPU RAS Support - Linux Kernel
documentation)](https://docs.kernel.org/gpu/amdgpu/ras.html#ras-error-count-sysfs-interface)
to learn how these error counts are accessed.
Input parameters:
* `processor_handle` handle for the given device
@@ -4467,6 +4467,10 @@ amdsmi_status_t amdsmi_get_lib_version(amdsmi_version_t *version);
* @brief Retrieve the error counts for a GPU block. It is not supported on virtual
* machine guest
*
* See [RAS Error Count sysfs Interface (AMDGPU RAS Support - Linux Kernel
* documentation)](https://docs.kernel.org/gpu/amdgpu/ras.html#ras-error-count-sysfs-interface)
* to learn how these error counts are accessed.
*
* @ingroup tagECCInfo
*
* @platform{gpu_bm_linux} @platform{host}
@@ -4495,6 +4499,10 @@ amdsmi_status_t amdsmi_get_gpu_ecc_count(amdsmi_processor_handle processor_handl
/**
* @brief Retrieve the enabled ECC bit-mask. It is not supported on virtual machine guest
*
* See [RAS Error Count sysfs Interface (AMDGPU RAS Support - Linux Kernel
* documentation)](https://docs.kernel.org/gpu/amdgpu/ras.html#ras-error-count-sysfs-interface)
* to learn how these error counts are accessed.
*
* @ingroup tagECCInfo
*
* @platform{gpu_bm_linux} @platform{host}
@@ -4528,6 +4536,10 @@ amdsmi_status_t amdsmi_get_gpu_ecc_enabled(amdsmi_processor_handle processor_han
* uncorrectable and deferred) in the given GPU. It is not supported on
* virtual machine guest
*
* See [RAS Error Count sysfs Interface (AMDGPU RAS Support - Linux Kernel
* documentation)](https://docs.kernel.org/gpu/amdgpu/ras.html#ras-error-count-sysfs-interface)
* to learn how these error counts are accessed.
*
* @ingroup tagECCInfo
*
* @platform{gpu_bm_linux} @platform{host} @platform{guest_windows}
@@ -4555,6 +4567,10 @@ amdsmi_get_gpu_total_ecc_count(amdsmi_processor_handle processor_handle, amdsmi_
* @brief Retrieve the ECC status for a GPU block. It is not supported on virtual machine
* guest
*
* See [RAS Error Count sysfs Interface (AMDGPU RAS Support - Linux Kernel
* documentation)](https://docs.kernel.org/gpu/amdgpu/ras.html#ras-error-count-sysfs-interface)
* to learn how these error counts are accessed.
*
* @ingroup tagErrorQuery
*
* @platform{gpu_bm_linux}