From b6f62bb651344680c40f0d71856496ecda2e4dbf Mon Sep 17 00:00:00 2001
From: Maisam Arif <maisarif@amd.com>
Date: Tue, 6 Feb 2024 17:40:10 -0600
Subject: [PATCH] Renamed amdsmi_get_metrics_table to
 amdsmi_get_cpu_metrics_table

	Renamed structs to be more conistent with what they are calling

Signed-off-by: Maisam Arif <maisarif@amd.com>
Change-Id: I6f2be2fcb76f004aa592f0dad8545565700ccd4b


[ROCm/amdsmi commit: f831cf49f76ad437fb5f05a595353ad61d2c4493]
---
 projects/amdsmi/amdsmi_cli/amdsmi_commands.py |  4 +--
 .../example/amdsmi_esmi_intg_example.cc       |  4 +--
 projects/amdsmi/include/amd_smi/amdsmi.h      | 20 ++++++-------
 projects/amdsmi/py-interface/README.md        | 20 ++++++-------
 projects/amdsmi/py-interface/__init__.py      |  4 +--
 .../amdsmi/py-interface/amdsmi_interface.py   | 10 +++----
 .../amdsmi/py-interface/amdsmi_wrapper.py     | 30 +++++++++----------
 projects/amdsmi/src/amd_smi/amd_smi.cc        | 10 +++----
 8 files changed, 51 insertions(+), 51 deletions(-)

diff --git a/projects/amdsmi/amdsmi_cli/amdsmi_commands.py b/projects/amdsmi/amdsmi_cli/amdsmi_commands.py
index ac774aae97..ad21167b45 100644
--- a/projects/amdsmi/amdsmi_cli/amdsmi_commands.py
+++ b/projects/amdsmi/amdsmi_cli/amdsmi_commands.py
@@ -1951,7 +1951,7 @@ class AMDSMICommands():
             if (args.cpu_metrics_ver):
                 static_dict["metric_version"] = {}
                 try:
-                    version = amdsmi_interface.amdsmi_get_metrics_table_version(args.cpu)
+                    version = amdsmi_interface.amdsmi_get_hsmp_metrics_table_version(args.cpu)
                     static_dict["metric_version"]["version"] = version
                 except amdsmi_exception.AmdSmiLibraryException as e:
                     static_dict["metric_version"]["version"] = "N/A"
@@ -1972,7 +1972,7 @@ class AMDSMICommands():
                     static_dict["metrics_table"]["cpu_model"] = "N/A"
                     logging.debug("Failed to get cpu model | %s", e.get_error_info())
                 try:
-                    metrics_table = amdsmi_interface.amdsmi_get_metrics_table(args.cpu)
+                    metrics_table = amdsmi_interface.amdsmi_get_hsmp_metrics_table(args.cpu)
                     static_dict["metrics_table"]["response"] = metrics_table
                 except amdsmi_exception.AmdSmiLibraryException as e:
                     static_dict["metrics_table"]["response"] = "N/A"
diff --git a/projects/amdsmi/example/amdsmi_esmi_intg_example.cc b/projects/amdsmi/example/amdsmi_esmi_intg_example.cc
index fc3af395c8..e3b3b67199 100644
--- a/projects/amdsmi/example/amdsmi_esmi_intg_example.cc
+++ b/projects/amdsmi/example/amdsmi_esmi_intg_example.cc
@@ -287,8 +287,8 @@ int main(int argc, char **argv) {
       double fraction_uq10 = fraction_q10;
       const char* err_str1;
 
-      amdsmi_hsmp_metric_table_t mtbl = {};
-      ret = amdsmi_get_metrics_table(plist[index], &mtbl);
+      amdsmi_hsmp_metrics_table_t mtbl = {};
+      ret = amdsmi_get_hsmp_metrics_table(plist[index], &mtbl);
 
       if (ret != AMDSMI_STATUS_SUCCESS) {
           cout<<"Failed to get Metrics Table for CPU["<<index<<"], Err["<<ret<<"]" << endl;
diff --git a/projects/amdsmi/include/amd_smi/amdsmi.h b/projects/amdsmi/include/amd_smi/amdsmi.h
index 58c7b818c8..bb6af21350 100644
--- a/projects/amdsmi/include/amd_smi/amdsmi.h
+++ b/projects/amdsmi/include/amd_smi/amdsmi.h
@@ -1527,7 +1527,7 @@ typedef struct {
 } amdsmi_dpm_level_t;
 
 /**
- * @brief Metrics table (supported only with hsmp proto version 6).
+ * @brief HSMP Metrics table (supported only with hsmp proto version 6).
  */
 typedef struct __attribute__((__packed__)){
     uint32_t accumulation_counter;
@@ -1606,7 +1606,7 @@ typedef struct __attribute__((__packed__)){
 
     /* New items at the end to maintain driver compatibility */
     uint32_t gfxclk_frequency[8];
-} amdsmi_hsmp_metric_table_t;
+} amdsmi_hsmp_metrics_table_t;
 
 #endif
 
@@ -5219,35 +5219,35 @@ amdsmi_status_t amdsmi_get_cpu_current_xgmi_bw(amdsmi_processor_handle processor
 /** @} */
 
 /*---------------------------------------------------------------------------*/
-/**  @defgroup MetQuer Metrics Table                                         */
+/**  @defgroup MetQuer HSMP Metrics Table                                         */
 /*---------------------------------------------------------------------------*/
 /** @{  */
 
 /**
- *  @brief Get metrics table version
+ *  @brief Get HSMP metrics table version
  *
  *  @platform{cpu_bm}
  *
  *  @param[in]      processor_handle Cpu socket which to query
- *  @param[in,out]  metrics_version input buffer to return the metrics table version.
+ *  @param[in,out]  metrics_version input buffer to return the HSMP metrics table version.
  *
  *  @return ::amdsmi_status_t | ::AMDSMI_STATUS_SUCCESS on success, non-zero on fail
  */
-amdsmi_status_t amdsmi_get_metrics_table_version(amdsmi_processor_handle processor_handle,
+amdsmi_status_t amdsmi_get_hsmp_metrics_table_version(amdsmi_processor_handle processor_handle,
                                                  uint32_t *metrics_version);
 
 /**
- *  @brief Get metrics table
+ *  @brief Get HSMP metrics table
  *
  *  @platform{cpu_bm}
  *
  *  @param[in]      processor_handle Cpu socket which to query
- *  @param[in,out]  metrics_table input buffer to return the metrics table.
+ *  @param[in,out]  metrics_table input buffer to return the HSMP metrics table.
  *
  *  @return ::amdsmi_status_t | ::AMDSMI_STATUS_SUCCESS on success, non-zero on fail
  */
-amdsmi_status_t amdsmi_get_metrics_table(amdsmi_processor_handle processor_handle,
-                                         amdsmi_hsmp_metric_table_t *metrics_table);
+amdsmi_status_t amdsmi_get_hsmp_metrics_table(amdsmi_processor_handle processor_handle,
+                                         amdsmi_hsmp_metrics_table_t *metrics_table);
 
 /** @} */
 
diff --git a/projects/amdsmi/py-interface/README.md b/projects/amdsmi/py-interface/README.md
index f16163fb29..3f9f4c4611 100644
--- a/projects/amdsmi/py-interface/README.md
+++ b/projects/amdsmi/py-interface/README.md
@@ -5958,13 +5958,13 @@ except AmdSmiException as e:
     print(e)
 ```
 
-### amdsmi_get_metrics_table_version
+### amdsmi_get_hsmp_metrics_table_version
 
-Description: Get metrics table version.
+Description: Get HSMP metrics table version.
 
-Output: amdsmi metrics table version
+Output: amdsmi HSMP metrics table version
 
-Exceptions that can be thrown by `amdsmi_get_metrics_table_version` function:
+Exceptions that can be thrown by `amdsmi_get_hsmp_metrics_table_version` function:
 
 * `AmdSmiLibraryException`
 
@@ -5977,19 +5977,19 @@ try:
         print("No CPU sockets on machine")
     else:
         for processor in processor_handles:
-            met_ver = amdsmi_get_metrics_table_version(processor)
+            met_ver = amdsmi_get_hsmp_metrics_table_version(processor)
             print(met_ver)
 except AmdSmiException as e:
     print(e)
 ```
 
-### amdsmi_get_metrics_table
+### amdsmi_get_hsmp_metrics_table
 
-Description: Get metrics table
+Description: Get HSMP metrics table
 
-Output: metric table data
+Output: HSMP metric table data
 
-Exceptions that can be thrown by `amdsmi_get_metrics_table` function:
+Exceptions that can be thrown by `amdsmi_get_hsmp_metrics_table` function:
 
 * `AmdSmiLibraryException`
 
@@ -6002,7 +6002,7 @@ try:
         print("No CPU sockets on machine")
     else:
         for processor in processor_handles:
-            mtbl = amdsmi_get_metrics_table(processor)
+            mtbl = amdsmi_get_hsmp_metrics_table(processor)
             print(mtbl['accumulation_counter'])
             print(mtbl['max_socket_temperature'])
             print(mtbl['max_vr_temperature'])
diff --git a/projects/amdsmi/py-interface/__init__.py b/projects/amdsmi/py-interface/__init__.py
index 5297f0ffb9..da749f43f2 100644
--- a/projects/amdsmi/py-interface/__init__.py
+++ b/projects/amdsmi/py-interface/__init__.py
@@ -69,8 +69,8 @@ try:
     from .amdsmi_interface import amdsmi_set_cpu_df_pstate_range
     from .amdsmi_interface import amdsmi_get_cpu_current_io_bandwidth
     from .amdsmi_interface import amdsmi_get_cpu_current_xgmi_bw
-    from .amdsmi_interface import amdsmi_get_metrics_table_version
-    from .amdsmi_interface import amdsmi_get_metrics_table
+    from .amdsmi_interface import amdsmi_get_hsmp_metrics_table_version
+    from .amdsmi_interface import amdsmi_get_hsmp_metrics_table
     from .amdsmi_interface import amdsmi_first_online_core_on_cpu_socket
     from .amdsmi_interface import amdsmi_get_cpu_family
     from .amdsmi_interface import amdsmi_get_cpu_model
diff --git a/projects/amdsmi/py-interface/amdsmi_interface.py b/projects/amdsmi/py-interface/amdsmi_interface.py
index 721685c0a8..0d7fff14e8 100644
--- a/projects/amdsmi/py-interface/amdsmi_interface.py
+++ b/projects/amdsmi/py-interface/amdsmi_interface.py
@@ -1349,7 +1349,7 @@ def amdsmi_get_cpu_current_xgmi_bw(
 
     return f"{xgmi_bw.value} Mbps"
 
-def amdsmi_get_metrics_table_version(
+def amdsmi_get_hsmp_metrics_table_version(
     processor_handle: amdsmi_wrapper.amdsmi_processor_handle
 ):
     if not isinstance(processor_handle, amdsmi_wrapper.amdsmi_processor_handle):
@@ -1360,7 +1360,7 @@ def amdsmi_get_metrics_table_version(
     metric_tbl_version = ctypes.c_uint32()
 
     _check_res(
-        amdsmi_wrapper.amdsmi_get_metrics_table_version(
+        amdsmi_wrapper.amdsmi_get_hsmp_metrics_table_version(
             processor_handle, ctypes.byref(metric_tbl_version))
     )
 
@@ -1393,7 +1393,7 @@ def check_msb_64(num):
     else:
         return num
 
-def amdsmi_get_metrics_table(
+def amdsmi_get_hsmp_metrics_table(
     processor_handle: amdsmi_wrapper.amdsmi_processor_handle
 ):
     if not isinstance(processor_handle, amdsmi_wrapper.amdsmi_processor_handle):
@@ -1401,7 +1401,7 @@ def amdsmi_get_metrics_table(
             processor_handle, amdsmi_wrapper.amdsmi_processor_handle
         )
 
-    mtbl = amdsmi_wrapper.amdsmi_hsmp_metric_table_t()
+    mtbl = amdsmi_wrapper.amdsmi_hsmp_metrics_table_t()
 
     '''Encodings for the metric table defined for hsmp'''
     fraction_q10 = 1 / math.pow(2, 10)
@@ -1409,7 +1409,7 @@ def amdsmi_get_metrics_table(
     fraction_uq16 = 1 / math.pow(2, 16)
 
     _check_res(
-            amdsmi_wrapper.amdsmi_get_metrics_table(
+            amdsmi_wrapper.amdsmi_get_hsmp_metrics_table(
                    processor_handle, mtbl
             )
     )
diff --git a/projects/amdsmi/py-interface/amdsmi_wrapper.py b/projects/amdsmi/py-interface/amdsmi_wrapper.py
index e73ef07af7..88d58e5303 100644
--- a/projects/amdsmi/py-interface/amdsmi_wrapper.py
+++ b/projects/amdsmi/py-interface/amdsmi_wrapper.py
@@ -1780,11 +1780,11 @@ struct_amdsmi_dpm_level_t._fields_ = [
 ]
 
 amdsmi_dpm_level_t = struct_amdsmi_dpm_level_t
-class struct_amdsmi_hsmp_metric_table_t(Structure):
+class struct_amdsmi_hsmp_metrics_table_t(Structure):
     pass
 
-struct_amdsmi_hsmp_metric_table_t._pack_ = 1 # source:True
-struct_amdsmi_hsmp_metric_table_t._fields_ = [
+struct_amdsmi_hsmp_metrics_table_t._pack_ = 1 # source:True
+struct_amdsmi_hsmp_metrics_table_t._fields_ = [
     ('accumulation_counter', ctypes.c_uint32),
     ('max_socket_temperature', ctypes.c_uint32),
     ('max_vr_temperature', ctypes.c_uint32),
@@ -1845,7 +1845,7 @@ struct_amdsmi_hsmp_metric_table_t._fields_ = [
     ('gfxclk_frequency', ctypes.c_uint32 * 8),
 ]
 
-amdsmi_hsmp_metric_table_t = struct_amdsmi_hsmp_metric_table_t
+amdsmi_hsmp_metrics_table_t = struct_amdsmi_hsmp_metrics_table_t
 uint64_t = ctypes.c_uint64
 amdsmi_init = _libraries['libamd_smi.so'].amdsmi_init
 amdsmi_init.restype = amdsmi_status_t
@@ -2285,12 +2285,12 @@ amdsmi_get_cpu_current_io_bandwidth.argtypes = [amdsmi_processor_handle, amdsmi_
 amdsmi_get_cpu_current_xgmi_bw = _libraries['libamd_smi.so'].amdsmi_get_cpu_current_xgmi_bw
 amdsmi_get_cpu_current_xgmi_bw.restype = amdsmi_status_t
 amdsmi_get_cpu_current_xgmi_bw.argtypes = [amdsmi_processor_handle, amdsmi_link_id_bw_type_t, ctypes.POINTER(ctypes.c_uint32)]
-amdsmi_get_metrics_table_version = _libraries['libamd_smi.so'].amdsmi_get_metrics_table_version
-amdsmi_get_metrics_table_version.restype = amdsmi_status_t
-amdsmi_get_metrics_table_version.argtypes = [amdsmi_processor_handle, ctypes.POINTER(ctypes.c_uint32)]
-amdsmi_get_metrics_table = _libraries['libamd_smi.so'].amdsmi_get_metrics_table
-amdsmi_get_metrics_table.restype = amdsmi_status_t
-amdsmi_get_metrics_table.argtypes = [amdsmi_processor_handle, ctypes.POINTER(struct_amdsmi_hsmp_metric_table_t)]
+amdsmi_get_hsmp_metrics_table_version = _libraries['libamd_smi.so'].amdsmi_get_hsmp_metrics_table_version
+amdsmi_get_hsmp_metrics_table_version.restype = amdsmi_status_t
+amdsmi_get_hsmp_metrics_table_version.argtypes = [amdsmi_processor_handle, ctypes.POINTER(ctypes.c_uint32)]
+amdsmi_get_hsmp_metrics_table = _libraries['libamd_smi.so'].amdsmi_get_hsmp_metrics_table
+amdsmi_get_hsmp_metrics_table.restype = amdsmi_status_t
+amdsmi_get_hsmp_metrics_table.argtypes = [amdsmi_processor_handle, ctypes.POINTER(struct_amdsmi_hsmp_metrics_table_t)]
 amdsmi_first_online_core_on_cpu_socket = _libraries['libamd_smi.so'].amdsmi_first_online_core_on_cpu_socket
 amdsmi_first_online_core_on_cpu_socket.restype = amdsmi_status_t
 amdsmi_first_online_core_on_cpu_socket.argtypes = [amdsmi_processor_handle, ctypes.POINTER(ctypes.c_uint32)]
@@ -2544,9 +2544,9 @@ __all__ = \
     'amdsmi_get_gpu_total_ecc_count', 'amdsmi_get_gpu_vbios_info',
     'amdsmi_get_gpu_vendor_name', 'amdsmi_get_gpu_volt_metric',
     'amdsmi_get_gpu_vram_info', 'amdsmi_get_gpu_vram_usage',
-    'amdsmi_get_gpu_vram_vendor', 'amdsmi_get_lib_version',
-    'amdsmi_get_link_metrics', 'amdsmi_get_metrics_table',
-    'amdsmi_get_metrics_table_version',
+    'amdsmi_get_gpu_vram_vendor', 'amdsmi_get_hsmp_metrics_table',
+    'amdsmi_get_hsmp_metrics_table_version', 'amdsmi_get_lib_version',
+    'amdsmi_get_link_metrics',
     'amdsmi_get_minmax_bandwidth_between_processors',
     'amdsmi_get_pcie_info', 'amdsmi_get_power_cap_info',
     'amdsmi_get_power_info',
@@ -2562,7 +2562,7 @@ __all__ = \
     'amdsmi_gpu_counter_group_supported', 'amdsmi_gpu_create_counter',
     'amdsmi_gpu_destroy_counter', 'amdsmi_gpu_metrics_t',
     'amdsmi_gpu_read_counter', 'amdsmi_gpu_xgmi_error_status',
-    'amdsmi_hsmp_metric_table_t', 'amdsmi_init',
+    'amdsmi_hsmp_metrics_table_t', 'amdsmi_init',
     'amdsmi_init_flags_t', 'amdsmi_init_gpu_event_notification',
     'amdsmi_io_bw_encoding_t', 'amdsmi_io_link_type_t',
     'amdsmi_is_P2P_accessible',
@@ -2623,7 +2623,7 @@ __all__ = \
     'struct_amdsmi_freq_volt_region_t', 'struct_amdsmi_frequencies_t',
     'struct_amdsmi_frequency_range_t', 'struct_amdsmi_fw_info_t',
     'struct_amdsmi_gpu_cache_info_t', 'struct_amdsmi_gpu_metrics_t',
-    'struct_amdsmi_hsmp_metric_table_t',
+    'struct_amdsmi_hsmp_metrics_table_t',
     'struct_amdsmi_link_id_bw_type_t', 'struct_amdsmi_link_metrics_t',
     'struct_amdsmi_name_value_t', 'struct_amdsmi_od_vddc_point_t',
     'struct_amdsmi_od_volt_curve_t',
diff --git a/projects/amdsmi/src/amd_smi/amd_smi.cc b/projects/amdsmi/src/amd_smi/amd_smi.cc
index 472d7ba325..52d069a04c 100644
--- a/projects/amdsmi/src/amd_smi/amd_smi.cc
+++ b/projects/amdsmi/src/amd_smi/amd_smi.cc
@@ -3004,7 +3004,7 @@ amdsmi_status_t amdsmi_get_cpu_current_xgmi_bw(amdsmi_processor_handle processor
     return AMDSMI_STATUS_SUCCESS;
 }
 
-amdsmi_status_t amdsmi_get_metrics_table_version(amdsmi_processor_handle processor_handle,
+amdsmi_status_t amdsmi_get_hsmp_metrics_table_version(amdsmi_processor_handle processor_handle,
                 uint32_t *metrics_version)
 {
     amdsmi_status_t status;
@@ -3024,8 +3024,8 @@ amdsmi_status_t amdsmi_get_metrics_table_version(amdsmi_processor_handle process
     return AMDSMI_STATUS_SUCCESS;
 }
 
-amdsmi_status_t amdsmi_get_metrics_table(amdsmi_processor_handle processor_handle,
-                amdsmi_hsmp_metric_table_t *metrics_table)
+amdsmi_status_t amdsmi_get_hsmp_metrics_table(amdsmi_processor_handle processor_handle,
+                amdsmi_hsmp_metrics_table_t *metrics_table)
 {
     amdsmi_status_t status;
     struct hsmp_metric_table metrics_tbl;
@@ -3036,7 +3036,7 @@ amdsmi_status_t amdsmi_get_metrics_table(amdsmi_processor_handle processor_handl
     if (processor_handle == nullptr)
         return AMDSMI_STATUS_INVAL;
 
-    if(sizeof(amdsmi_hsmp_metric_table_t) != sizeof(struct hsmp_metric_table))
+    if(sizeof(amdsmi_hsmp_metrics_table_t) != sizeof(struct hsmp_metric_table))
         return AMDSMI_STATUS_UNEXPECTED_SIZE;
 
     amdsmi_status_t r = amdsmi_get_processor_info(processor_handle, SIZE, proc_id);
@@ -3049,7 +3049,7 @@ amdsmi_status_t amdsmi_get_metrics_table(amdsmi_processor_handle processor_handl
     if (status != AMDSMI_STATUS_SUCCESS)
         return amdsmi_errno_to_esmi_status(status);
 
-    std::memcpy(metrics_table, &metrics_tbl, sizeof(amdsmi_hsmp_metric_table_t));
+    std::memcpy(metrics_table, &metrics_tbl, sizeof(amdsmi_hsmp_metrics_table_t));
 
     return AMDSMI_STATUS_SUCCESS;
 }