From 16ffa7714cc0f07844df8b0ef0062d563db06859 Mon Sep 17 00:00:00 2001 From: Maisam Arif Date: Tue, 29 Oct 2024 11:24:41 -0500 Subject: [PATCH] Updated amdsmi_get_energy_count() C API documentation Signed-off-by: Maisam Arif Change-Id: Iac75a0dcd583f39eb97aada769c736c3305cc8a2 [ROCm/amdsmi commit: 6e843436f559aae98a9ed119650f5838684440c1] --- projects/amdsmi/include/amd_smi/amdsmi.h | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/projects/amdsmi/include/amd_smi/amdsmi.h b/projects/amdsmi/include/amd_smi/amdsmi.h index fb4875632f..93e37bff0e 100644 --- a/projects/amdsmi/include/amd_smi/amdsmi.h +++ b/projects/amdsmi/include/amd_smi/amdsmi.h @@ -2573,14 +2573,12 @@ amdsmi_status_t amdsmi_set_gpu_pci_bandwidth(amdsmi_processor_handle processor_h * @platform{gpu_bm_linux} * * @details Given a processor handle @p processor_handle, a pointer to a uint64_t - * @p power, and a pointer to a uint64_t @p timestamp, this function will write - * amount of energy consumed to the uint64_t pointed to by @p power, - * and the timestamp to the uint64_t pointed to by @p timestamp. + * @p energy_accumulator, and a pointer to a uint64_t @p timestamp, this function + * will write amount of energy consumed to the uint64_t pointed to by + * @p energy_accumulator, and the timestamp to the uint64_t pointed to by @p timestamp. * This function accumulates all energy consumed. * * @param[in] processor_handle a processor handle - * @param[in,out] counter_resolution resolution of the counter @p power in - * micro Joules * * @param[in,out] energy_accumulator a pointer to uint64_t to which the energy * counter will be written @@ -2589,6 +2587,9 @@ amdsmi_status_t amdsmi_set_gpu_pci_bandwidth(amdsmi_processor_handle processor_h * and ::AMDSMI_STATUS_NOT_SUPPORTED if it is not supported with the * provided arguments. * + * @param[in,out] counter_resolution resolution of the counter @p energy_accumulator in + * micro Joules + * * @param[in,out] timestamp a pointer to uint64_t to which the timestamp * will be written. Resolution: 1 ns. *