GPU Metric Functions

GPU Metric Functions#

AMD SMI: GPU Metric Functions
Typedefs | Functions
GPU Metric Functions

Typedefs

typedef uint16_t gpu_metric_temp_hbm_t[AMDSMI_NUM_HBM_INSTANCES]
 
typedef uint16_t gpu_metric_vcn_activity_t[AMDSMI_MAX_NUM_VCN]
 
typedef uint64_t gpu_metric_xgmi_read_data_acc_t[AMDSMI_MAX_NUM_XGMI_LINKS]
 
typedef uint64_t gpu_metric_xgmi_write_data_acc_t[AMDSMI_MAX_NUM_XGMI_LINKS]
 
typedef uint16_t gpu_metric_curr_gfxclk_t[AMDSMI_MAX_NUM_GFX_CLKS]
 
typedef uint16_t gpu_metric_curr_socclk_t[AMDSMI_MAX_NUM_CLKS]
 
typedef uint16_t gpu_metric_curr_vclk0_t[AMDSMI_MAX_NUM_CLKS]
 
typedef uint16_t gpu_metric_curr_dclk0_t[AMDSMI_MAX_NUM_CLKS]
 

Functions

amdsmi_status_t amdsmi_get_gpu_metrics_temp_hotspot (amdsmi_processor_handle processor_handle, uint16_t *hotspot_value)
 Get the 'temp_hotspot' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_temp_mem (amdsmi_processor_handle processor_handle, uint16_t *mem_value)
 Get the 'temp_mem' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_temp_vrsoc (amdsmi_processor_handle processor_handle, uint16_t *vrsoc_value)
 Get the 'temp_vrsoc' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_curr_socket_power (amdsmi_processor_handle processor_handle, uint16_t *socket_power_value)
 Get the 'curr_socket_power' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_avg_gfx_activity (amdsmi_processor_handle processor_handle, uint16_t *gfx_activity_value)
 Get the 'avg_gfx_activity' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_avg_umc_activity (amdsmi_processor_handle processor_handle, uint16_t *umc_activity_value)
 Get the 'avg_umc_activity' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_energy_acc (amdsmi_processor_handle processor_handle, uint64_t *energy_acc_value)
 Get the 'energy_acc' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_system_clock_counter (amdsmi_processor_handle processor_handle, uint64_t *system_clock_counter_value)
 Get the 'system_clock_counter' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_firmware_timestamp (amdsmi_processor_handle processor_handle, uint64_t *firmware_timestamp_value)
 Get the 'firmware_timestamp' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_throttle_status (amdsmi_processor_handle processor_handle, uint32_t *throttle_status_value)
 Get the 'throttle_status' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_pcie_link_width (amdsmi_processor_handle processor_handle, uint16_t *pcie_link_width_value)
 Get the 'pcie_link_width' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_pcie_link_speed (amdsmi_processor_handle processor_handle, uint16_t *pcie_link_speed_value)
 Get the 'pcie_link_speed' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_xgmi_link_width (amdsmi_processor_handle processor_handle, uint16_t *xgmi_link_width_value)
 Get the 'xgmi_link_width' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_xgmi_link_speed (amdsmi_processor_handle processor_handle, uint16_t *xgmi_link_speed_value)
 Get the 'xgmi_link_speed' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_gfxclk_lock_status (amdsmi_processor_handle processor_handle, uint32_t *gfxclk_lock_status_value)
 Get the 'gfxclk_lock_status' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_gfx_activity_acc (amdsmi_processor_handle processor_handle, uint32_t *gfx_activity_acc_value)
 Get the 'gfx_activity_acc' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_mem_activity_acc (amdsmi_processor_handle processor_handle, uint32_t *mem_activity_acc_value)
 Get the 'mem_activity_acc' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_pcie_bandwidth_acc (amdsmi_processor_handle processor_handle, uint64_t *pcie_bandwidth_acc_value)
 Get the 'pcie_bandwidth_acc' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_pcie_bandwidth_inst (amdsmi_processor_handle processor_handle, uint64_t *pcie_bandwidth_inst_value)
 Get the 'pcie_bandwidth_inst' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_pcie_l0_recov_count_acc (amdsmi_processor_handle processor_handle, uint64_t *pcie_count_acc_value)
 Get the 'pcie_l0_recov_count_acc' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_pcie_replay_count_acc (amdsmi_processor_handle processor_handle, uint64_t *pcie_count_acc_value)
 Get the 'pcie_replay_count_acc' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_pcie_replay_rover_count_acc (amdsmi_processor_handle processor_handle, uint64_t *pcie_count_acc_value)
 Get the 'pcie_replay_rover_count_acc' (Rollover count) from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_curr_uclk (amdsmi_processor_handle processor_handle, uint16_t *uclk_value)
 Get the 'curr_uclk' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_temp_hbm (amdsmi_processor_handle processor_handle, gpu_metric_temp_hbm_t *temp_hbm_value)
 Get the 'temp_hbm' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_vcn_activity (amdsmi_processor_handle processor_handle, gpu_metric_vcn_activity_t *vcn_activity_value)
 Get the 'vcn_activity' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_xgmi_read_data (amdsmi_processor_handle processor_handle, gpu_metric_xgmi_read_data_acc_t *xgmi_read_data_acc_value)
 Get the 'xgmi_read_data' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_xgmi_write_data (amdsmi_processor_handle processor_handle, gpu_metric_xgmi_write_data_acc_t *xgmi_write_data_acc_value)
 Get the 'xgmi_write_data' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_curr_gfxclk (amdsmi_processor_handle processor_handle, gpu_metric_curr_gfxclk_t *current_gfxclk_value)
 Get the 'curr_gfxclk' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_curr_socclk (amdsmi_processor_handle processor_handle, gpu_metric_curr_socclk_t *current_socclk_value)
 Get the 'curr_socclk' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_curr_vclk0 (amdsmi_processor_handle processor_handle, gpu_metric_curr_vclk0_t *current_vclk_value)
 Get the 'curr_vclk0' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_curr_dclk0 (amdsmi_processor_handle processor_handle, gpu_metric_curr_dclk0_t *current_dclk_value)
 Get the 'curr_dclk0' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_temp_edge (amdsmi_processor_handle processor_handle, uint16_t *edge_value)
 Get the 'temp_edge' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_temp_vrgfx (amdsmi_processor_handle processor_handle, uint16_t *vrgfx_value)
 Get the 'temp_vrgfx' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_temp_vrmem (amdsmi_processor_handle processor_handle, uint16_t *vrmem_value)
 Get the 'temp_vrmem' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_avg_mm_activity (amdsmi_processor_handle processor_handle, uint16_t *mm_activity_value)
 Get the 'avg_mm_activity' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_curr_vclk1 (amdsmi_processor_handle processor_handle, uint16_t *current_vclk_value)
 Get the 'curr_vclk1' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_curr_dclk1 (amdsmi_processor_handle processor_handle, uint16_t *current_dclk_value)
 Get the 'curr_dclk1' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_indep_throttle_status (amdsmi_processor_handle processor_handle, uint64_t *throttle_status_value)
 Get the 'indep_throttle_status' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_avg_socket_power (amdsmi_processor_handle processor_handle, uint16_t *socket_power_value)
 Get the 'avg_socket_power' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_curr_fan_speed (amdsmi_processor_handle processor_handle, uint16_t *fan_speed_value)
 Get the 'curr_fan_speed' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_avg_gfx_clock_frequency (amdsmi_processor_handle processor_handle, uint16_t *clock_frequency_value)
 Get the 'avg_gfx_clock_frequency' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_avg_soc_clock_frequency (amdsmi_processor_handle processor_handle, uint16_t *clock_frequency_value)
 Get the 'avg_soc_clock_frequency' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_avg_uclock_frequency (amdsmi_processor_handle processor_handle, uint16_t *clock_frequency_value)
 Get the 'avg_uclock_frequency' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_avg_vclock0_frequency (amdsmi_processor_handle processor_handle, uint16_t *clock_frequency_value)
 Get the 'avg_vclock0_frequency' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_avg_dclock0_frequency (amdsmi_processor_handle processor_handle, uint16_t *clock_frequency_value)
 Get the 'avg_dclock0_frequency' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_avg_vclock1_frequency (amdsmi_processor_handle processor_handle, uint16_t *clock_frequency_value)
 Get the 'avg_vclock1_frequency' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_avg_dclock1_frequency (amdsmi_processor_handle processor_handle, uint16_t *clock_frequency_value)
 Get the 'avg_dclock1_frequency' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_volt_soc (amdsmi_processor_handle processor_handle, uint16_t *voltage_value)
 Get the 'volt_soc' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_volt_gfx (amdsmi_processor_handle processor_handle, uint16_t *voltage_value)
 Get the 'volt_gfx' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_volt_mem (amdsmi_processor_handle processor_handle, uint16_t *voltage_value)
 Get the 'volt_mem' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_header_info (amdsmi_processor_handle processor_handle, amd_metrics_table_header_t *header_value)
 Get the 'metrics_header_info' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_xcd_counter (amdsmi_processor_handle processor_handle, uint16_t *xcd_counter_value)
 Get the 'xcd_counter' from the GPU metrics associated with the device. More...
 
amdsmi_status_t amdsmi_get_gpu_metrics_log (amdsmi_processor_handle processor_handle)
 Get the log from the GPU metrics associated with the device. More...
 

Detailed Description

These functions are used to get granular information about all counters available in GPU Metrics.

Typedef Documentation

◆ gpu_metric_temp_hbm_t

typedef uint16_t gpu_metric_temp_hbm_t[AMDSMI_NUM_HBM_INSTANCES]

Metric multi-valued counter types

Function Documentation

◆ amdsmi_get_gpu_metrics_temp_hotspot()

amdsmi_status_t amdsmi_get_gpu_metrics_temp_hotspot ( amdsmi_processor_handle  processor_handle,
uint16_t *  hotspot_value 
)

Get the 'temp_hotspot' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'temp_hotspot' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]hotspot_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_temp_mem()

amdsmi_status_t amdsmi_get_gpu_metrics_temp_mem ( amdsmi_processor_handle  processor_handle,
uint16_t *  mem_value 
)

Get the 'temp_mem' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'temp_mem' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]mem_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_temp_vrsoc()

amdsmi_status_t amdsmi_get_gpu_metrics_temp_vrsoc ( amdsmi_processor_handle  processor_handle,
uint16_t *  vrsoc_value 
)

Get the 'temp_vrsoc' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'temp_vrsoc' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]vrsoc_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_curr_socket_power()

amdsmi_status_t amdsmi_get_gpu_metrics_curr_socket_power ( amdsmi_processor_handle  processor_handle,
uint16_t *  socket_power_value 
)

Get the 'curr_socket_power' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'socket_power' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]socket_power_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_avg_gfx_activity()

amdsmi_status_t amdsmi_get_gpu_metrics_avg_gfx_activity ( amdsmi_processor_handle  processor_handle,
uint16_t *  gfx_activity_value 
)

Get the 'avg_gfx_activity' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'gfx_activity' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]gfx_activity_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_avg_umc_activity()

amdsmi_status_t amdsmi_get_gpu_metrics_avg_umc_activity ( amdsmi_processor_handle  processor_handle,
uint16_t *  umc_activity_value 
)

Get the 'avg_umc_activity' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'umc_activity' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]umc_activity_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_energy_acc()

amdsmi_status_t amdsmi_get_gpu_metrics_energy_acc ( amdsmi_processor_handle  processor_handle,
uint64_t *  energy_acc_value 
)

Get the 'energy_acc' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint64_t in which the 'energy_acc' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]energy_acc_valuea pointer to uint64_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_system_clock_counter()

amdsmi_status_t amdsmi_get_gpu_metrics_system_clock_counter ( amdsmi_processor_handle  processor_handle,
uint64_t *  system_clock_counter_value 
)

Get the 'system_clock_counter' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint64_t in which the 'system_clock_counter' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]system_clock_counter_valuea pointer to uint64_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_firmware_timestamp()

amdsmi_status_t amdsmi_get_gpu_metrics_firmware_timestamp ( amdsmi_processor_handle  processor_handle,
uint64_t *  firmware_timestamp_value 
)

Get the 'firmware_timestamp' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint64_t in which the 'firmware_timestamp' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]firmware_timestamp_valuea pointer to uint64_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_throttle_status()

amdsmi_status_t amdsmi_get_gpu_metrics_throttle_status ( amdsmi_processor_handle  processor_handle,
uint32_t *  throttle_status_value 
)

Get the 'throttle_status' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint32_t in which the 'throttle_status' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]throttle_status_valuea pointer to uint32_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_pcie_link_width()

amdsmi_status_t amdsmi_get_gpu_metrics_pcie_link_width ( amdsmi_processor_handle  processor_handle,
uint16_t *  pcie_link_width_value 
)

Get the 'pcie_link_width' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'pcie_link_width' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]pcie_link_width_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_pcie_link_speed()

amdsmi_status_t amdsmi_get_gpu_metrics_pcie_link_speed ( amdsmi_processor_handle  processor_handle,
uint16_t *  pcie_link_speed_value 
)

Get the 'pcie_link_speed' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'pcie_link_speed' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]pcie_link_speed_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_xgmi_link_width()

amdsmi_status_t amdsmi_get_gpu_metrics_xgmi_link_width ( amdsmi_processor_handle  processor_handle,
uint16_t *  xgmi_link_width_value 
)

Get the 'xgmi_link_width' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'xgmi_link_width' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]xgmi_link_width_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_xgmi_link_speed()

amdsmi_status_t amdsmi_get_gpu_metrics_xgmi_link_speed ( amdsmi_processor_handle  processor_handle,
uint16_t *  xgmi_link_speed_value 
)

Get the 'xgmi_link_speed' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'xgmi_link_speed' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]xgmi_link_speed_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_gfxclk_lock_status()

amdsmi_status_t amdsmi_get_gpu_metrics_gfxclk_lock_status ( amdsmi_processor_handle  processor_handle,
uint32_t *  gfxclk_lock_status_value 
)

Get the 'gfxclk_lock_status' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint32_t in which the 'gfxclk_lock_status' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]gfxclk_lock_status_valuea pointer to uint32_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_gfx_activity_acc()

amdsmi_status_t amdsmi_get_gpu_metrics_gfx_activity_acc ( amdsmi_processor_handle  processor_handle,
uint32_t *  gfx_activity_acc_value 
)

Get the 'gfx_activity_acc' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint32_t in which the 'gfx_activity_acc' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]gfx_activity_acc_valuea pointer to uint32_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_mem_activity_acc()

amdsmi_status_t amdsmi_get_gpu_metrics_mem_activity_acc ( amdsmi_processor_handle  processor_handle,
uint32_t *  mem_activity_acc_value 
)

Get the 'mem_activity_acc' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint32_t in which the 'mem_activity_acc' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]mem_activity_acc_valuea pointer to uint32_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_pcie_bandwidth_acc()

amdsmi_status_t amdsmi_get_gpu_metrics_pcie_bandwidth_acc ( amdsmi_processor_handle  processor_handle,
uint64_t *  pcie_bandwidth_acc_value 
)

Get the 'pcie_bandwidth_acc' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint64_t in which the 'pcie_bandwidth_acc' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]pcie_bandwidth_acc_valuea pointer to uint64_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_pcie_bandwidth_inst()

amdsmi_status_t amdsmi_get_gpu_metrics_pcie_bandwidth_inst ( amdsmi_processor_handle  processor_handle,
uint64_t *  pcie_bandwidth_inst_value 
)

Get the 'pcie_bandwidth_inst' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint64_t in which the 'pcie_bandwidth_inst' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]pcie_bandwidth_inst_valuea pointer to uint64_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_pcie_l0_recov_count_acc()

amdsmi_status_t amdsmi_get_gpu_metrics_pcie_l0_recov_count_acc ( amdsmi_processor_handle  processor_handle,
uint64_t *  pcie_count_acc_value 
)

Get the 'pcie_l0_recov_count_acc' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint64_t in which the 'pcie_l0_recov_count_acc' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]pcie_count_acc_valuea pointer to uint64_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_pcie_replay_count_acc()

amdsmi_status_t amdsmi_get_gpu_metrics_pcie_replay_count_acc ( amdsmi_processor_handle  processor_handle,
uint64_t *  pcie_count_acc_value 
)

Get the 'pcie_replay_count_acc' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint64_t in which the 'pcie_replay_count_acc' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]pcie_count_acc_valuea pointer to uint64_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_pcie_replay_rover_count_acc()

amdsmi_status_t amdsmi_get_gpu_metrics_pcie_replay_rover_count_acc ( amdsmi_processor_handle  processor_handle,
uint64_t *  pcie_count_acc_value 
)

Get the 'pcie_replay_rover_count_acc' (Rollover count) from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint64_t in which the 'pcie_replay_rover_count_acc' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]pcie_count_acc_valuea pointer to uint64_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_curr_uclk()

amdsmi_status_t amdsmi_get_gpu_metrics_curr_uclk ( amdsmi_processor_handle  processor_handle,
uint16_t *  uclk_value 
)

Get the 'curr_uclk' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'curr_uclk' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]uclk_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_temp_hbm()

amdsmi_status_t amdsmi_get_gpu_metrics_temp_hbm ( amdsmi_processor_handle  processor_handle,
gpu_metric_temp_hbm_t *  temp_hbm_value 
)

Get the 'temp_hbm' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'temp_hbm' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]temp_hbm_valuea pointer to uint16_t to which the device gpu metric unit will be stored
  • This is a multi-valued counter holding a 4 (AMDSMI_NUM_HBM_INSTANCES) element array (gpu_metric_temp_hbm_t)
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_vcn_activity()

amdsmi_status_t amdsmi_get_gpu_metrics_vcn_activity ( amdsmi_processor_handle  processor_handle,
gpu_metric_vcn_activity_t *  vcn_activity_value 
)

Get the 'vcn_activity' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'vcn_activity' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]vcn_activity_valuea pointer to uint16_t to which the device gpu metric unit will be stored
  • This is a multi-valued counter holding a 4 (AMDSMI_MAX_NUM_VCN) element array (gpu_metric_vcn_activity_t)
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_xgmi_read_data()

amdsmi_status_t amdsmi_get_gpu_metrics_xgmi_read_data ( amdsmi_processor_handle  processor_handle,
gpu_metric_xgmi_read_data_acc_t *  xgmi_read_data_acc_value 
)

Get the 'xgmi_read_data' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint64_t in which the 'xgmi_read_data' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]xgmi_read_data_acc_valuea pointer to uint64_t to which the device gpu metric unit will be stored
  • This is a multi-valued counter holding an 8 (AMDSMI_MAX_NUM_XGMI_LINKS) element array (gpu_metric_xgmi_read_data_acc_t)
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_xgmi_write_data()

amdsmi_status_t amdsmi_get_gpu_metrics_xgmi_write_data ( amdsmi_processor_handle  processor_handle,
gpu_metric_xgmi_write_data_acc_t *  xgmi_write_data_acc_value 
)

Get the 'xgmi_write_data' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint64_t in which the 'xgmi_write_data' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]xgmi_write_data_acc_valuea pointer to uint64_t to which the device gpu metric unit will be stored
  • This is a multi-valued counter holding an 8 (AMDSMI_MAX_NUM_XGMI_LINKS) element array (gpu_metric_xgmi_write_data_acc_t)
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_curr_gfxclk()

amdsmi_status_t amdsmi_get_gpu_metrics_curr_gfxclk ( amdsmi_processor_handle  processor_handle,
gpu_metric_curr_gfxclk_t *  current_gfxclk_value 
)

Get the 'curr_gfxclk' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint64_t in which the 'curr_gfxclk' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]current_gfxclk_valuea pointer to uint16_t to which the device gpu metric unit will be stored
  • This is a multi-valued counter holding an 8 (AMDSMI_MAX_NUM_GFX_CLKS) element array (gpu_metric_curr_gfxclk_t)
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_curr_socclk()

amdsmi_status_t amdsmi_get_gpu_metrics_curr_socclk ( amdsmi_processor_handle  processor_handle,
gpu_metric_curr_socclk_t *  current_socclk_value 
)

Get the 'curr_socclk' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'curr_socclk' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]current_socclk_valuea pointer to uint16_t to which the device gpu metric unit will be stored
  • This is a multi-valued counter holding a 4 (AMDSMI_MAX_NUM_CLKS) element array (gpu_metric_curr_socclk_t)
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_curr_vclk0()

amdsmi_status_t amdsmi_get_gpu_metrics_curr_vclk0 ( amdsmi_processor_handle  processor_handle,
gpu_metric_curr_vclk0_t *  current_vclk_value 
)

Get the 'curr_vclk0' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'curr_vclk0' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]current_vclk_valuea pointer to uint16_t to which the device gpu metric unit will be stored
  • This is a multi-valued counter holding a 4 (AMDSMI_MAX_NUM_CLKS) element array (gpu_metric_curr_vclk0_t)
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_curr_dclk0()

amdsmi_status_t amdsmi_get_gpu_metrics_curr_dclk0 ( amdsmi_processor_handle  processor_handle,
gpu_metric_curr_dclk0_t *  current_dclk_value 
)

Get the 'curr_dclk0' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'curr_dclk0' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]current_dclk_valuea pointer to uint16_t to which the device gpu metric unit will be stored
  • This is a multi-valued counter holding a 4 (AMDSMI_MAX_NUM_CLKS) element array (gpu_metric_curr_dclk0_t)
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_temp_edge()

amdsmi_status_t amdsmi_get_gpu_metrics_temp_edge ( amdsmi_processor_handle  processor_handle,
uint16_t *  edge_value 
)

Get the 'temp_edge' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'temp_edge' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]edge_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_temp_vrgfx()

amdsmi_status_t amdsmi_get_gpu_metrics_temp_vrgfx ( amdsmi_processor_handle  processor_handle,
uint16_t *  vrgfx_value 
)

Get the 'temp_vrgfx' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'temp_vrgfx' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]vrgfx_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_temp_vrmem()

amdsmi_status_t amdsmi_get_gpu_metrics_temp_vrmem ( amdsmi_processor_handle  processor_handle,
uint16_t *  vrmem_value 
)

Get the 'temp_vrmem' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'temp_vrmem' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]vrmem_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_avg_mm_activity()

amdsmi_status_t amdsmi_get_gpu_metrics_avg_mm_activity ( amdsmi_processor_handle  processor_handle,
uint16_t *  mm_activity_value 
)

Get the 'avg_mm_activity' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'avg_mm_activity' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]mm_activity_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_curr_vclk1()

amdsmi_status_t amdsmi_get_gpu_metrics_curr_vclk1 ( amdsmi_processor_handle  processor_handle,
uint16_t *  current_vclk_value 
)

Get the 'curr_vclk1' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'curr_vclk1' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]current_vclk_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_curr_dclk1()

amdsmi_status_t amdsmi_get_gpu_metrics_curr_dclk1 ( amdsmi_processor_handle  processor_handle,
uint16_t *  current_dclk_value 
)

Get the 'curr_dclk1' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'curr_dclk1' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]current_dclk_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_indep_throttle_status()

amdsmi_status_t amdsmi_get_gpu_metrics_indep_throttle_status ( amdsmi_processor_handle  processor_handle,
uint64_t *  throttle_status_value 
)

Get the 'indep_throttle_status' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint64_t in which the 'indep_throttle_status' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]throttle_status_valuea pointer to uint64_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_avg_socket_power()

amdsmi_status_t amdsmi_get_gpu_metrics_avg_socket_power ( amdsmi_processor_handle  processor_handle,
uint16_t *  socket_power_value 
)

Get the 'avg_socket_power' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'avg_socket_power' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]socket_power_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_curr_fan_speed()

amdsmi_status_t amdsmi_get_gpu_metrics_curr_fan_speed ( amdsmi_processor_handle  processor_handle,
uint16_t *  fan_speed_value 
)

Get the 'curr_fan_speed' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'curr_fan_speed' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]fan_speed_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_avg_gfx_clock_frequency()

amdsmi_status_t amdsmi_get_gpu_metrics_avg_gfx_clock_frequency ( amdsmi_processor_handle  processor_handle,
uint16_t *  clock_frequency_value 
)

Get the 'avg_gfx_clock_frequency' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'avg_gfx_clock_frequency' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]clock_frequency_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_avg_soc_clock_frequency()

amdsmi_status_t amdsmi_get_gpu_metrics_avg_soc_clock_frequency ( amdsmi_processor_handle  processor_handle,
uint16_t *  clock_frequency_value 
)

Get the 'avg_soc_clock_frequency' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'avg_soc_clock_frequency' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]clock_frequency_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_avg_uclock_frequency()

amdsmi_status_t amdsmi_get_gpu_metrics_avg_uclock_frequency ( amdsmi_processor_handle  processor_handle,
uint16_t *  clock_frequency_value 
)

Get the 'avg_uclock_frequency' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'avg_uclock_frequency' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]clock_frequency_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_avg_vclock0_frequency()

amdsmi_status_t amdsmi_get_gpu_metrics_avg_vclock0_frequency ( amdsmi_processor_handle  processor_handle,
uint16_t *  clock_frequency_value 
)

Get the 'avg_vclock0_frequency' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'avg_vclock0_frequency' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]clock_frequency_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_avg_dclock0_frequency()

amdsmi_status_t amdsmi_get_gpu_metrics_avg_dclock0_frequency ( amdsmi_processor_handle  processor_handle,
uint16_t *  clock_frequency_value 
)

Get the 'avg_dclock0_frequency' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'avg_dclock0_frequency' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]clock_frequency_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_avg_vclock1_frequency()

amdsmi_status_t amdsmi_get_gpu_metrics_avg_vclock1_frequency ( amdsmi_processor_handle  processor_handle,
uint16_t *  clock_frequency_value 
)

Get the 'avg_vclock1_frequency' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'avg_vclock1_frequency' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]clock_frequency_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_avg_dclock1_frequency()

amdsmi_status_t amdsmi_get_gpu_metrics_avg_dclock1_frequency ( amdsmi_processor_handle  processor_handle,
uint16_t *  clock_frequency_value 
)

Get the 'avg_dclock1_frequency' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'avg_dclock1_frequency' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]clock_frequency_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_volt_soc()

amdsmi_status_t amdsmi_get_gpu_metrics_volt_soc ( amdsmi_processor_handle  processor_handle,
uint16_t *  voltage_value 
)

Get the 'volt_soc' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'volt_soc' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]voltage_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_volt_gfx()

amdsmi_status_t amdsmi_get_gpu_metrics_volt_gfx ( amdsmi_processor_handle  processor_handle,
uint16_t *  voltage_value 
)

Get the 'volt_gfx' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'volt_gfx' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]voltage_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_volt_mem()

amdsmi_status_t amdsmi_get_gpu_metrics_volt_mem ( amdsmi_processor_handle  processor_handle,
uint16_t *  voltage_value 
)

Get the 'volt_mem' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'volt_mem' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]voltage_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_header_info()

amdsmi_status_t amdsmi_get_gpu_metrics_header_info ( amdsmi_processor_handle  processor_handle,
amd_metrics_table_header_t *  header_value 
)

Get the 'metrics_header_info' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a amd_metrics_table_header_t in which the 'metrics_header_info' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]header_valuea pointer to amd_metrics_table_header_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_xcd_counter()

amdsmi_status_t amdsmi_get_gpu_metrics_xcd_counter ( amdsmi_processor_handle  processor_handle,
uint16_t *  xcd_counter_value 
)

Get the 'xcd_counter' from the GPU metrics associated with the device.

Given a processor handle processor_handle and a pointer to a uint16_t in which the 'xcd_counter' will stored

Parameters
[in]processor_handleDevice which to query
[in,out]xcd_counter_valuea pointer to uint16_t to which the device gpu metric unit will be stored
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call. AMDSMI_STATUS_NOT_SUPPORTED is returned in case the metric unit does not exist for the given device

◆ amdsmi_get_gpu_metrics_log()

amdsmi_status_t amdsmi_get_gpu_metrics_log ( amdsmi_processor_handle  processor_handle)

Get the log from the GPU metrics associated with the device.

Given a processor handle processor_handle it will log all the gpu metric info related to the device. The 'logging' feature must be on.

Parameters
[in]processor_handleDevice which to query
Return values
AMDSMI_STATUS_SUCCESSis returned upon successful call.