rocm_smi.h Source File

rocm_smi.h Source File#

ROCmSMI: rocm_smi.h Source File
rocm_smi.h
Go to the documentation of this file.
1 /*
2  * =============================================================================
3  * The University of Illinois/NCSA
4  * Open Source License (NCSA)
5  *
6  * Copyright (c) 2017-2023, Advanced Micro Devices, Inc.
7  * All rights reserved.
8  *
9  * Developed by:
10  *
11  * AMD Research and AMD ROC Software Development
12  *
13  * Advanced Micro Devices, Inc.
14  *
15  * www.amd.com
16  *
17  * Permission is hereby granted, free of charge, to any person obtaining a copy
18  * of this software and associated documentation files (the "Software"), to
19  * deal with the Software without restriction, including without limitation
20  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
21  * and/or sell copies of the Software, and to permit persons to whom the
22  * Software is furnished to do so, subject to the following conditions:
23  *
24  * - Redistributions of source code must retain the above copyright notice,
25  * this list of conditions and the following disclaimers.
26  * - Redistributions in binary form must reproduce the above copyright
27  * notice, this list of conditions and the following disclaimers in
28  * the documentation and/or other materials provided with the distribution.
29  * - Neither the names of <Name of Development Group, Name of Institution>,
30  * nor the names of its contributors may be used to endorse or promote
31  * products derived from this Software without specific prior written
32  * permission.
33  *
34  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
35  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
36  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
37  * THE CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
38  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
39  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
40  * DEALINGS WITH THE SOFTWARE.
41  *
42  */
43 
44 #ifndef ROCM_SMI_ROCM_SMI_H_
45 #define ROCM_SMI_ROCM_SMI_H_
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #include <cstdint>
50 #else
51 #include <stdint.h>
52 #endif // __cplusplus
53 
54 #include <stddef.h>
55 #include <stdbool.h>
56 
57 #include "rocm_smi/kfd_ioctl.h"
58 
75 #define RSMI_MAX_NUM_FREQUENCIES 33
76 
79 #define RSMI_MAX_FAN_SPEED 255
80 
82 #define RSMI_NUM_VOLTAGE_CURVE_POINTS 3
83 
84 
88 typedef enum {
89  RSMI_STATUS_SUCCESS = 0x0,
90  RSMI_STATUS_INVALID_ARGS,
91  RSMI_STATUS_NOT_SUPPORTED,
94  RSMI_STATUS_FILE_ERROR,
99  RSMI_STATUS_PERMISSION,
102  RSMI_STATUS_OUT_OF_RESOURCES,
104  RSMI_STATUS_INTERNAL_EXCEPTION,
105  RSMI_STATUS_INPUT_OUT_OF_BOUNDS,
107  RSMI_STATUS_INIT_ERROR,
110  RSMI_INITIALIZATION_ERROR = RSMI_STATUS_INIT_ERROR,
111  RSMI_STATUS_NOT_YET_IMPLEMENTED,
115  RSMI_STATUS_NOT_FOUND,
117  RSMI_STATUS_INSUFFICIENT_SIZE,
119  RSMI_STATUS_INTERRUPT,
121  RSMI_STATUS_UNEXPECTED_SIZE,
123  RSMI_STATUS_NO_DATA,
125  RSMI_STATUS_UNEXPECTED_DATA,
127  RSMI_STATUS_BUSY,
130  RSMI_STATUS_REFCOUNT_OVERFLOW,
132  RSMI_STATUS_SETTING_UNAVAILABLE,
134  RSMI_STATUS_AMDGPU_RESTART_ERR,
136  RSMI_STATUS_DRM_ERROR,
137 
138  RSMI_STATUS_UNKNOWN_ERROR = 0xFFFFFFFF,
139 } rsmi_status_t;
140 
147 typedef enum {
148  RSMI_INIT_FLAG_ALL_GPUS = 0x1,
154  RSMI_INIT_FLAG_THRAD_ONLY_MUTEX = 0x400000000000000,
155  RSMI_INIT_FLAG_RESRV_TEST1 = 0x800000000000000,
156 } rsmi_init_flags_t;
157 
161 typedef enum {
162  RSMI_DEV_PERF_LEVEL_AUTO = 0,
163  RSMI_DEV_PERF_LEVEL_FIRST = RSMI_DEV_PERF_LEVEL_AUTO,
164 
165  RSMI_DEV_PERF_LEVEL_LOW,
167  RSMI_DEV_PERF_LEVEL_HIGH,
169  RSMI_DEV_PERF_LEVEL_MANUAL,
171  RSMI_DEV_PERF_LEVEL_STABLE_STD,
173  RSMI_DEV_PERF_LEVEL_STABLE_PEAK,
174  RSMI_DEV_PERF_LEVEL_STABLE_MIN_MCLK,
176  RSMI_DEV_PERF_LEVEL_STABLE_MIN_SCLK,
178  RSMI_DEV_PERF_LEVEL_DETERMINISM,
179 
180  RSMI_DEV_PERF_LEVEL_LAST = RSMI_DEV_PERF_LEVEL_DETERMINISM,
181 
182  RSMI_DEV_PERF_LEVEL_UNKNOWN = 0x100
183 } rsmi_dev_perf_level_t;
185 typedef rsmi_dev_perf_level_t rsmi_dev_perf_level;
187 
194 typedef enum {
195  RSMI_SW_COMP_FIRST = 0x0,
196 
197  RSMI_SW_COMP_DRIVER = RSMI_SW_COMP_FIRST,
198 
199  RSMI_SW_COMP_LAST = RSMI_SW_COMP_DRIVER
200 } rsmi_sw_component_t;
201 
209 typedef uintptr_t rsmi_event_handle_t;
210 
217 typedef enum {
218  RSMI_EVNT_GRP_XGMI = 0,
219  RSMI_EVNT_GRP_XGMI_DATA_OUT = 10,
220  RSMI_EVNT_GRP_INVALID = 0xFFFFFFFF
221 } rsmi_event_group_t;
222 
229 typedef enum {
230  RSMI_EVNT_FIRST = RSMI_EVNT_GRP_XGMI,
231 
232  RSMI_EVNT_XGMI_FIRST = RSMI_EVNT_GRP_XGMI,
233  RSMI_EVNT_XGMI_0_NOP_TX = RSMI_EVNT_XGMI_FIRST,
234  RSMI_EVNT_XGMI_0_REQUEST_TX,
236  RSMI_EVNT_XGMI_0_RESPONSE_TX,
238 
251  // ie, Throughput = BEATS/time_running 10^9 bytes/sec
252  RSMI_EVNT_XGMI_0_BEATS_TX,
253  RSMI_EVNT_XGMI_1_NOP_TX,
254  RSMI_EVNT_XGMI_1_REQUEST_TX,
256  RSMI_EVNT_XGMI_1_RESPONSE_TX,
258  RSMI_EVNT_XGMI_1_BEATS_TX,
261 
262  RSMI_EVNT_XGMI_LAST = RSMI_EVNT_XGMI_1_BEATS_TX, // 5
263 
264  RSMI_EVNT_XGMI_DATA_OUT_FIRST = RSMI_EVNT_GRP_XGMI_DATA_OUT, // 10
265 
266  /*
267  * @brief Events in the RSMI_EVNT_GRP_XGMI_DATA_OUT group measure
268  * the number of beats sent on an XGMI link. Each beat represents
269  * 32 bytes. RSMI_EVNT_XGMI_DATA_OUT_n represents the number of
270  * outbound beats (each representing 32 bytes) on link n.<br><br>
271  *
272  * XGMI throughput can be calculated by multiplying a event
273  * such as ::RSMI_EVNT_XGMI_DATA_OUT_n by 32 and dividing by
274  * the time for which event collection occurred,
275  * ::rsmi_counter_value_t.time_running (which is in nanoseconds). To get
276  * bytes per second, multiply this value by 10<sup>9</sup>.<br>
277  * <br>
278  * Throughput = BEATS/time_running * 10<sup>9</sup> (bytes/second)<br>
279  */
280  // ie, Throughput = BEATS/time_running 10^9 bytes/sec
281  RSMI_EVNT_XGMI_DATA_OUT_0 = RSMI_EVNT_XGMI_DATA_OUT_FIRST,
282  RSMI_EVNT_XGMI_DATA_OUT_1,
283  RSMI_EVNT_XGMI_DATA_OUT_2,
284  RSMI_EVNT_XGMI_DATA_OUT_3,
285  RSMI_EVNT_XGMI_DATA_OUT_4,
286  RSMI_EVNT_XGMI_DATA_OUT_5,
287  RSMI_EVNT_XGMI_DATA_OUT_LAST = RSMI_EVNT_XGMI_DATA_OUT_5,
288 
289  RSMI_EVNT_LAST = RSMI_EVNT_XGMI_DATA_OUT_LAST,
290 } rsmi_event_type_t;
291 
295 typedef enum {
296  RSMI_CNTR_CMD_START = 0,
297  RSMI_CNTR_CMD_STOP,
299 } rsmi_counter_command_t;
300 
304 typedef struct {
305  uint64_t value;
306  uint64_t time_enabled;
308  uint64_t time_running;
310 } rsmi_counter_value_t;
311 
315 typedef enum {
316  RSMI_EVT_NOTIF_NONE = KFD_SMI_EVENT_NONE,
317  RSMI_EVT_NOTIF_VMFAULT = KFD_SMI_EVENT_VMFAULT,
318  RSMI_EVT_NOTIF_FIRST = RSMI_EVT_NOTIF_VMFAULT,
319  RSMI_EVT_NOTIF_THERMAL_THROTTLE = KFD_SMI_EVENT_THERMAL_THROTTLE,
320  RSMI_EVT_NOTIF_GPU_PRE_RESET = KFD_SMI_EVENT_GPU_PRE_RESET,
321  RSMI_EVT_NOTIF_GPU_POST_RESET = KFD_SMI_EVENT_GPU_POST_RESET,
322  RSMI_EVT_NOTIF_EVENT_MIGRATE_START = KFD_SMI_EVENT_MIGRATE_START,
323  RSMI_EVT_NOTIF_EVENT_MIGRATE_END = KFD_SMI_EVENT_MIGRATE_END,
324  RSMI_EVT_NOTIF_EVENT_PAGE_FAULT_START = KFD_SMI_EVENT_PAGE_FAULT_START,
325  RSMI_EVT_NOTIF_EVENT_PAGE_FAULT_END = KFD_SMI_EVENT_PAGE_FAULT_END,
326  RSMI_EVT_NOTIF_EVENT_QUEUE_EVICTION = KFD_SMI_EVENT_QUEUE_EVICTION,
327  RSMI_EVT_NOTIF_EVENT_QUEUE_RESTORE = KFD_SMI_EVENT_QUEUE_RESTORE,
328  RSMI_EVT_NOTIF_EVENT_UNMAP_FROM_GPU = KFD_SMI_EVENT_UNMAP_FROM_GPU,
329  RSMI_EVT_NOTIF_EVENT_ALL_PROCESS = KFD_SMI_EVENT_ALL_PROCESS,
330  RSMI_EVT_NOTIF_LAST = KFD_SMI_EVENT_ALL_PROCESS
331 } rsmi_evt_notification_type_t;
332 
336 #define RSMI_EVENT_MASK_FROM_INDEX(i) (1ULL << ((i) - 1))
337 
339 // matches kfd message max size
340 #define MAX_EVENT_NOTIFICATION_MSG_SIZE 96
341 
345 typedef struct {
346  uint32_t dv_ind;
347  rsmi_evt_notification_type_t event;
348  char message[MAX_EVENT_NOTIFICATION_MSG_SIZE];
349 } rsmi_evt_notification_data_t;
350 
354 typedef enum {
355  RSMI_CLK_TYPE_SYS = 0x0,
356  RSMI_CLK_TYPE_FIRST = RSMI_CLK_TYPE_SYS,
357  RSMI_CLK_TYPE_DF,
359  RSMI_CLK_TYPE_DCEF,
360  RSMI_CLK_TYPE_SOC,
361  RSMI_CLK_TYPE_MEM,
362  RSMI_CLK_TYPE_PCIE,
363 
364  // Add new clocks to the end (not in the middle) and update
365  // RSMI_CLK_TYPE_LAST
366  RSMI_CLK_TYPE_LAST = RSMI_CLK_TYPE_MEM,
367  RSMI_CLK_INVALID = 0xFFFFFFFF
368 } rsmi_clk_type_t;
370 typedef rsmi_clk_type_t rsmi_clk_type;
372 
377 typedef enum {
378  RSMI_COMPUTE_PARTITION_INVALID = 0,
379  RSMI_COMPUTE_PARTITION_SPX,
381  RSMI_COMPUTE_PARTITION_DPX,
383  RSMI_COMPUTE_PARTITION_TPX,
385  RSMI_COMPUTE_PARTITION_QPX,
387  RSMI_COMPUTE_PARTITION_CPX
389 } rsmi_compute_partition_type_t;
391 typedef rsmi_compute_partition_type_t rsmi_compute_partition_type;
393 
398 typedef enum {
399  RSMI_MEMORY_PARTITION_UNKNOWN = 0,
400  RSMI_MEMORY_PARTITION_NPS1,
402  RSMI_MEMORY_PARTITION_NPS2,
405  RSMI_MEMORY_PARTITION_NPS4,
408  RSMI_MEMORY_PARTITION_NPS8,
413 } rsmi_memory_partition_type_t;
415 typedef rsmi_memory_partition_type_t rsmi_memory_partition_type;
417 
423 typedef enum {
424  RSMI_TEMP_CURRENT = 0x0,
425  RSMI_TEMP_FIRST = RSMI_TEMP_CURRENT,
426 
427  RSMI_TEMP_MAX,
428  RSMI_TEMP_MIN,
429  RSMI_TEMP_MAX_HYST,
432  RSMI_TEMP_MIN_HYST,
435  RSMI_TEMP_CRITICAL,
437  RSMI_TEMP_CRITICAL_HYST,
440  RSMI_TEMP_EMERGENCY,
444  RSMI_TEMP_EMERGENCY_HYST,
447  RSMI_TEMP_CRIT_MIN,
450  RSMI_TEMP_CRIT_MIN_HYST,
453  RSMI_TEMP_OFFSET,
455  RSMI_TEMP_LOWEST,
456  RSMI_TEMP_HIGHEST,
457 
458  RSMI_TEMP_LAST = RSMI_TEMP_HIGHEST
459 } rsmi_temperature_metric_t;
461 typedef rsmi_temperature_metric_t rsmi_temperature_metric;
463 
468 typedef enum {
469  RSMI_TEMP_TYPE_FIRST = 0,
470 
471  RSMI_TEMP_TYPE_EDGE = RSMI_TEMP_TYPE_FIRST,
472  RSMI_TEMP_TYPE_JUNCTION,
474  RSMI_TEMP_TYPE_MEMORY,
475  RSMI_TEMP_TYPE_HBM_0,
476  RSMI_TEMP_TYPE_HBM_1,
477  RSMI_TEMP_TYPE_HBM_2,
478  RSMI_TEMP_TYPE_HBM_3,
479  RSMI_TEMP_TYPE_LAST = RSMI_TEMP_TYPE_HBM_3,
480  RSMI_TEMP_TYPE_INVALID = 0xFFFFFFFF
481 } rsmi_temperature_type_t;
482 
488 typedef enum {
489  /* Utilization */
490  RSMI_ACTIVITY_GFX = (0x1 << 0),
491  RSMI_ACTIVITY_UMC = (0x1 << 1),
492  RSMI_ACTIVITY_MM = (0x1 << 2)
493 } rsmi_activity_metric_t;
494 
495 
501 typedef enum {
502  RSMI_VOLT_CURRENT = 0x0,
503 
504  RSMI_VOLT_FIRST = RSMI_VOLT_CURRENT,
505  RSMI_VOLT_MAX,
506  RSMI_VOLT_MIN_CRIT,
507  RSMI_VOLT_MIN,
508  RSMI_VOLT_MAX_CRIT,
509  RSMI_VOLT_AVERAGE,
510  RSMI_VOLT_LOWEST,
511  RSMI_VOLT_HIGHEST,
512 
513  RSMI_VOLT_LAST = RSMI_VOLT_HIGHEST
514 } rsmi_voltage_metric_t;
515 
520 typedef enum {
521  RSMI_VOLT_TYPE_FIRST = 0,
522 
523  RSMI_VOLT_TYPE_VDDGFX = RSMI_VOLT_TYPE_FIRST,
525  RSMI_VOLT_TYPE_LAST = RSMI_VOLT_TYPE_VDDGFX,
526  RSMI_VOLT_TYPE_INVALID = 0xFFFFFFFF
527 } rsmi_voltage_type_t;
528 
535 typedef enum {
536  RSMI_PWR_PROF_PRST_CUSTOM_MASK = 0x1,
537  RSMI_PWR_PROF_PRST_VIDEO_MASK = 0x2,
538  RSMI_PWR_PROF_PRST_POWER_SAVING_MASK = 0x4,
539  RSMI_PWR_PROF_PRST_COMPUTE_MASK = 0x8,
540  RSMI_PWR_PROF_PRST_VR_MASK = 0x10,
541 
543  RSMI_PWR_PROF_PRST_3D_FULL_SCR_MASK = 0x20,
544  RSMI_PWR_PROF_PRST_BOOTUP_DEFAULT = 0x40,
545  RSMI_PWR_PROF_PRST_LAST = RSMI_PWR_PROF_PRST_BOOTUP_DEFAULT,
546 
548  RSMI_PWR_PROF_PRST_INVALID = 0xFFFFFFFFFFFFFFFF
549 } rsmi_power_profile_preset_masks_t;
551 typedef rsmi_power_profile_preset_masks_t rsmi_power_profile_preset_masks;
553 
557 typedef enum {
558  RSMI_GPU_BLOCK_INVALID = 0x0000000000000000,
560  RSMI_GPU_BLOCK_FIRST = 0x0000000000000001,
561 
562  RSMI_GPU_BLOCK_UMC = RSMI_GPU_BLOCK_FIRST,
563  RSMI_GPU_BLOCK_SDMA = 0x0000000000000002,
564  RSMI_GPU_BLOCK_GFX = 0x0000000000000004,
565  RSMI_GPU_BLOCK_MMHUB = 0x0000000000000008,
566  RSMI_GPU_BLOCK_ATHUB = 0x0000000000000010,
567  RSMI_GPU_BLOCK_PCIE_BIF = 0x0000000000000020,
568  RSMI_GPU_BLOCK_HDP = 0x0000000000000040,
569  RSMI_GPU_BLOCK_XGMI_WAFL = 0x0000000000000080,
570  RSMI_GPU_BLOCK_DF = 0x0000000000000100,
571  RSMI_GPU_BLOCK_SMN = 0x0000000000000200,
572  RSMI_GPU_BLOCK_SEM = 0x0000000000000400,
573  RSMI_GPU_BLOCK_MP0 = 0x0000000000000800,
574  RSMI_GPU_BLOCK_MP1 = 0x0000000000001000,
575  RSMI_GPU_BLOCK_FUSE = 0x0000000000002000,
576 
577  RSMI_GPU_BLOCK_LAST = RSMI_GPU_BLOCK_FUSE,
579  RSMI_GPU_BLOCK_RESERVED = 0x8000000000000000
580 } rsmi_gpu_block_t;
582 typedef rsmi_gpu_block_t rsmi_gpu_block;
584 
588 typedef enum {
589  RSMI_RAS_ERR_STATE_NONE = 0,
590  RSMI_RAS_ERR_STATE_DISABLED,
591  RSMI_RAS_ERR_STATE_PARITY,
592  RSMI_RAS_ERR_STATE_SING_C,
593  RSMI_RAS_ERR_STATE_MULT_UC,
594  RSMI_RAS_ERR_STATE_POISON,
596  RSMI_RAS_ERR_STATE_ENABLED,
597 
598  RSMI_RAS_ERR_STATE_LAST = RSMI_RAS_ERR_STATE_ENABLED,
599  RSMI_RAS_ERR_STATE_INVALID = 0xFFFFFFFF
600 } rsmi_ras_err_state_t;
601 
605 typedef enum {
606  RSMI_MEM_TYPE_FIRST = 0,
607 
608  RSMI_MEM_TYPE_VRAM = RSMI_MEM_TYPE_FIRST,
609  RSMI_MEM_TYPE_VIS_VRAM,
610  RSMI_MEM_TYPE_GTT,
611 
612  RSMI_MEM_TYPE_LAST = RSMI_MEM_TYPE_GTT
613 } rsmi_memory_type_t;
614 
618 typedef enum {
619  RSMI_FREQ_IND_MIN = 0,
620  RSMI_FREQ_IND_MAX = 1,
621  RSMI_FREQ_IND_INVALID = 0xFFFFFFFF
622 } rsmi_freq_ind_t;
624 typedef rsmi_freq_ind_t rsmi_freq_ind;
626 
627 
632 typedef enum {
633  RSMI_FW_BLOCK_FIRST = 0,
634 
635  RSMI_FW_BLOCK_ASD = RSMI_FW_BLOCK_FIRST,
636  RSMI_FW_BLOCK_CE,
637  RSMI_FW_BLOCK_DMCU,
638  RSMI_FW_BLOCK_MC,
639  RSMI_FW_BLOCK_ME,
640  RSMI_FW_BLOCK_MEC,
641  RSMI_FW_BLOCK_MEC2,
642  RSMI_FW_BLOCK_MES,
643  RSMI_FW_BLOCK_MES_KIQ,
644  RSMI_FW_BLOCK_PFP,
645  RSMI_FW_BLOCK_RLC,
646  RSMI_FW_BLOCK_RLC_SRLC,
647  RSMI_FW_BLOCK_RLC_SRLG,
648  RSMI_FW_BLOCK_RLC_SRLS,
649  RSMI_FW_BLOCK_SDMA,
650  RSMI_FW_BLOCK_SDMA2,
651  RSMI_FW_BLOCK_SMC,
652  RSMI_FW_BLOCK_SOS,
653  RSMI_FW_BLOCK_TA_RAS,
654  RSMI_FW_BLOCK_TA_XGMI,
655  RSMI_FW_BLOCK_UVD,
656  RSMI_FW_BLOCK_VCE,
657  RSMI_FW_BLOCK_VCN,
658 
659  RSMI_FW_BLOCK_LAST = RSMI_FW_BLOCK_VCN
660 } rsmi_fw_block_t;
661 
665 typedef enum {
666  RSMI_XGMI_STATUS_NO_ERRORS = 0,
667  RSMI_XGMI_STATUS_ERROR,
668  RSMI_XGMI_STATUS_MULTIPLE_ERRORS,
669 } rsmi_xgmi_status_t;
670 
674 typedef uint64_t rsmi_bit_field_t;
676 typedef rsmi_bit_field_t rsmi_bit_field;
678 
682 typedef enum {
683  RSMI_MEM_PAGE_STATUS_RESERVED = 0,
685  RSMI_MEM_PAGE_STATUS_PENDING,
688  RSMI_MEM_PAGE_STATUS_UNRESERVABLE
689 } rsmi_memory_page_status_t;
690 
694 typedef enum _RSMI_IO_LINK_TYPE {
695  RSMI_IOLINK_TYPE_UNDEFINED = 0,
696  RSMI_IOLINK_TYPE_PCIEXPRESS,
697  RSMI_IOLINK_TYPE_XGMI,
698  RSMI_IOLINK_TYPE_NUMIOLINKTYPES,
699  RSMI_IOLINK_TYPE_SIZE = 0xFFFFFFFF
700 } RSMI_IO_LINK_TYPE;
701 
704 #define CPU_NODE_INDEX 0xFFFFFFFF
705 
709 typedef enum {
710  RSMI_UTILIZATION_COUNTER_FIRST = 0,
712  RSMI_COARSE_GRAIN_GFX_ACTIVITY = RSMI_UTILIZATION_COUNTER_FIRST,
713  RSMI_COARSE_GRAIN_MEM_ACTIVITY,
714  RSMI_UTILIZATION_COUNTER_LAST = RSMI_COARSE_GRAIN_MEM_ACTIVITY
715 } RSMI_UTILIZATION_COUNTER_TYPE;
716 
720 typedef enum {
721  RSMI_AVERAGE_POWER = 0,
722  RSMI_CURRENT_POWER,
723  RSMI_INVALID_POWER = 0xFFFFFFFF
724 } RSMI_POWER_TYPE;
725 
729 typedef struct {
730  RSMI_UTILIZATION_COUNTER_TYPE type;
731  uint64_t value;
732 } rsmi_utilization_counter_t;
733 
737 typedef struct {
738  uint64_t page_address;
739  uint64_t page_size;
740  rsmi_memory_page_status_t status;
741 } rsmi_retired_page_record_t;
742 
746 #define RSMI_MAX_NUM_POWER_PROFILES (sizeof(rsmi_bit_field_t) * 8)
747 
753 typedef struct {
757  rsmi_bit_field_t available_profiles;
758 
762  rsmi_power_profile_preset_masks_t current;
763 
767  uint32_t num_profiles;
768 } rsmi_power_profile_status_t;
770 typedef rsmi_power_profile_status_t rsmi_power_profile_status;
772 
776 typedef struct {
780  bool has_deep_sleep;
781 
785  uint32_t num_supported;
786 
790  uint32_t current;
791 
796  uint64_t frequency[RSMI_MAX_NUM_FREQUENCIES];
797 } rsmi_frequencies_t;
799 typedef rsmi_frequencies_t rsmi_frequencies;
801 
807 typedef struct {
811  rsmi_frequencies_t transfer_rate;
812 
817  uint32_t lanes[RSMI_MAX_NUM_FREQUENCIES];
818 } rsmi_pcie_bandwidth_t;
819 
821 typedef rsmi_pcie_bandwidth_t rsmi_pcie_bandwidth;
823 
828 typedef struct {
829  /* Utilization */
830  uint16_t average_gfx_activity;
831  uint16_t average_umc_activity;
832  uint16_t average_mm_activity;
833 } rsmi_activity_metric_counter_t;
834 
838 typedef struct {
839  uint32_t major;
840  uint32_t minor;
841  uint32_t patch;
842  const char *build;
843 } rsmi_version_t;
845 typedef rsmi_version_t rsmi_version;
847 
850 typedef struct {
851  uint64_t lower_bound;
852  uint64_t upper_bound;
853 } rsmi_range_t;
855 typedef rsmi_range_t rsmi_range;
857 
861 typedef struct {
862  uint64_t frequency;
863  uint64_t voltage;
864 } rsmi_od_vddc_point_t;
866 typedef rsmi_od_vddc_point_t rsmi_od_vddc_point;
868 
874 typedef struct {
875  rsmi_range_t freq_range;
876  rsmi_range_t volt_range;
877 } rsmi_freq_volt_region_t;
879 typedef rsmi_freq_volt_region_t rsmi_freq_volt_region;
881 
885 typedef struct {
890  rsmi_od_vddc_point_t vc_points[RSMI_NUM_VOLTAGE_CURVE_POINTS];
891 } rsmi_od_volt_curve_t;
893 typedef rsmi_od_volt_curve_t rsmi_od_volt_curve;
895 
899 typedef struct {
900  rsmi_range_t curr_sclk_range;
901  rsmi_range_t curr_mclk_range;
903  rsmi_range_t sclk_freq_limits;
904  rsmi_range_t mclk_freq_limits;
905 
909  rsmi_od_volt_curve_t curve;
910  uint32_t num_regions;
911 } rsmi_od_volt_freq_data_t;
913 typedef rsmi_od_volt_freq_data_t rsmi_od_volt_freq_data;
915 
916 
924 struct metrics_table_header_t {
925  // TODO(amd) Doxygen documents
926  // Note: This should match: AMDGpuMetricsHeader_v1_t
928  uint16_t structure_size;
929  uint8_t format_revision;
930  uint8_t content_revision;
932 };
934 typedef struct metrics_table_header_t metrics_table_header_t;
936 
940 #define CENTRIGRADE_TO_MILLI_CENTIGRADE 1000
941 
945 #define RSMI_NUM_HBM_INSTANCES 4
946 
950 #define RSMI_MAX_NUM_VCNS 4
951 
955 #define RSMI_MAX_NUM_JPEG_ENGS 32
956 
960 #define RSMI_MAX_NUM_CLKS 4
961 
965 #define RSMI_MAX_NUM_XGMI_LINKS 8
966 
970 #define RSMI_MAX_NUM_GFX_CLKS 8
971 
981 #define RSMI_MAX_NUM_XCC 8
982 
993 #define RSMI_MAX_NUM_XCP 8
994 
998 struct amdgpu_xcp_metrics_t {
999  /*
1000  * v1.6 additions
1001  */
1002  /* Utilization Instantaneous (%) */
1003  uint32_t gfx_busy_inst[RSMI_MAX_NUM_XCC];
1004  uint16_t jpeg_busy[RSMI_MAX_NUM_JPEG_ENGS];
1005  uint16_t vcn_busy[RSMI_MAX_NUM_VCNS];
1006 
1007  /* Utilization Accumulated (%) */
1008  uint64_t gfx_busy_acc[RSMI_MAX_NUM_XCC];
1009 
1010  /*
1011  * v1.7 additions
1012  */
1013  /* Total App Clock Counter Accumulated */
1014  uint64_t gfx_below_host_limit_acc[RSMI_MAX_NUM_XCC];
1015 };
1016 
1017 typedef struct {
1018  // TODO(amd) Doxygen documents
1019  // Note: This structure is extended to fit the needs of different GPU metric
1020  // versions when exposing data through the structure.
1021  // Depending on the version, some data members will hold data, and
1022  // some will not. A good example is the set of 'current clocks':
1023  // - current_gfxclk, current_socclk, current_vclk0, current_dclk0
1024  // These are single-valued data members, up to version 1.3.
1025  // For version 1.4 and up these are multi-valued data members (arrays)
1026  // and their counterparts;
1027  // - current_gfxclks[], current_socclks[], current_vclk0s[],
1028  // current_dclk0s[]
1029  // will hold the data
1031 
1032  /*
1033  * v1.0 Base
1034  */
1035  struct metrics_table_header_t common_header;
1036 
1037  // Temperature (C)
1038  uint16_t temperature_edge;
1039  uint16_t temperature_hotspot;
1040  uint16_t temperature_mem;
1041  uint16_t temperature_vrgfx;
1042  uint16_t temperature_vrsoc;
1043  uint16_t temperature_vrmem;
1044 
1045  // Utilization (%)
1046  uint16_t average_gfx_activity;
1047  uint16_t average_umc_activity; // memory controller
1048  uint16_t average_mm_activity; // UVD or VCN
1049 
1050  // Power (W) /Energy (15.259uJ per 1ns)
1051  uint16_t average_socket_power;
1052  uint64_t energy_accumulator; // v1 mod. (32->64)
1053 
1054  // Driver attached timestamp (in ns)
1055  uint64_t system_clock_counter; // v1 mod. (moved from top of struct)
1056 
1057  // Average clocks (MHz)
1058  uint16_t average_gfxclk_frequency;
1059  uint16_t average_socclk_frequency;
1060  uint16_t average_uclk_frequency;
1061  uint16_t average_vclk0_frequency;
1062  uint16_t average_dclk0_frequency;
1063  uint16_t average_vclk1_frequency;
1064  uint16_t average_dclk1_frequency;
1065 
1066  // Current clocks (MHz)
1067  uint16_t current_gfxclk;
1068  uint16_t current_socclk;
1069  uint16_t current_uclk;
1070  uint16_t current_vclk0;
1071  uint16_t current_dclk0;
1072  uint16_t current_vclk1;
1073  uint16_t current_dclk1;
1074 
1075  // Throttle status
1076  uint32_t throttle_status;
1077 
1078  // Fans (RPM)
1079  uint16_t current_fan_speed;
1080 
1081  // Link width (number of lanes) /speed (0.1 GT/s)
1082  uint16_t pcie_link_width; // v1 mod.(8->16)
1083  uint16_t pcie_link_speed; // in 0.1 GT/s; v1 mod. (8->16)
1084 
1085 
1086  /*
1087  * v1.1 additions
1088  */
1089  uint32_t gfx_activity_acc; // new in v1
1090  uint32_t mem_activity_acc; // new in v1
1091  uint16_t temperature_hbm[RSMI_NUM_HBM_INSTANCES]; // new in v1
1092 
1093 
1094  /*
1095  * v1.2 additions
1096  */
1097  // PMFW attached timestamp (10ns resolution)
1098  uint64_t firmware_timestamp;
1099 
1100 
1101  /*
1102  * v1.3 additions
1103  */
1104  // Voltage (mV)
1105  uint16_t voltage_soc;
1106  uint16_t voltage_gfx;
1107  uint16_t voltage_mem;
1108 
1109  // Throttle status
1110  uint64_t indep_throttle_status;
1111 
1112 
1113  /*
1114  * v1.4 additions
1115  */
1116  // Power (Watts)
1117  uint16_t current_socket_power;
1118 
1119  // Utilization (%)
1120  uint16_t vcn_activity[RSMI_MAX_NUM_VCNS]; // VCN instances activity percent (encode/decode)
1121 
1122  // Clock Lock Status. Each bit corresponds to clock instance
1123  uint32_t gfxclk_lock_status;
1124 
1125  // XGMI bus width and bitrate (in GB/s)
1126  uint16_t xgmi_link_width;
1127  uint16_t xgmi_link_speed;
1128 
1129  // PCIE accumulated bandwidth (GB/sec)
1130  uint64_t pcie_bandwidth_acc;
1131 
1132  // PCIE instantaneous bandwidth (GB/sec)
1133  uint64_t pcie_bandwidth_inst;
1134 
1135  // PCIE L0 to recovery state transition accumulated count
1136  uint64_t pcie_l0_to_recov_count_acc;
1137 
1138  // PCIE replay accumulated count
1139  uint64_t pcie_replay_count_acc;
1140 
1141  // PCIE replay rollover accumulated count
1142  uint64_t pcie_replay_rover_count_acc;
1143 
1144  // XGMI accumulated data transfer size(KiloBytes)
1145  uint64_t xgmi_read_data_acc[RSMI_MAX_NUM_XGMI_LINKS];
1146  uint64_t xgmi_write_data_acc[RSMI_MAX_NUM_XGMI_LINKS];
1147 
1148  // XGMI accumulated data transfer size(KiloBytes)
1149  uint16_t current_gfxclks[RSMI_MAX_NUM_GFX_CLKS];
1150  uint16_t current_socclks[RSMI_MAX_NUM_CLKS];
1151  uint16_t current_vclk0s[RSMI_MAX_NUM_CLKS];
1152  uint16_t current_dclk0s[RSMI_MAX_NUM_CLKS];
1153 
1154  /*
1155  * v1.5 additions
1156  */
1157  // JPEG activity percent (encode/decode)
1158  uint16_t jpeg_activity[RSMI_MAX_NUM_JPEG_ENGS];
1159 
1160  // PCIE NAK sent accumulated count
1161  uint32_t pcie_nak_sent_count_acc;
1162 
1163  // PCIE NAK received accumulated count
1164  uint32_t pcie_nak_rcvd_count_acc;
1165 
1166  /*
1167  * v1.6 additions
1168  */
1169  /* Accumulation cycle counter */
1170  uint64_t accumulation_counter;
1171 
1175  uint64_t prochot_residency_acc;
1190  uint64_t ppt_residency_acc;
1205  uint64_t socket_thm_residency_acc;
1206  uint64_t vr_thm_residency_acc;
1207  uint64_t hbm_thm_residency_acc;
1208 
1209  /* Number of current partition */
1210  uint16_t num_partition;
1211 
1212  /* XCP (Graphic Cluster Partitions) metrics stats */
1213  struct amdgpu_xcp_metrics_t xcp_stats[RSMI_MAX_NUM_XCP];
1214 
1215  /* PCIE other end recovery counter */
1216  uint32_t pcie_lc_perf_other_end_recovery;
1217 
1218  /*
1219  * v1.7 additions
1220  */
1221  /* VRAM max bandwidth at max memory clock (GB/s) */
1222  uint64_t vram_max_bandwidth;
1223 
1224  /* XGMI link status(up/down) */
1225  uint16_t xgmi_link_status[RSMI_MAX_NUM_XGMI_LINKS];
1226 
1228 } rsmi_gpu_metrics_t;
1229 
1233 typedef struct {
1234  uint64_t correctable_err;
1235  uint64_t uncorrectable_err;
1236 } rsmi_error_count_t;
1237 
1241 typedef struct {
1242  uint32_t process_id;
1243  uint32_t pasid;
1244  uint64_t vram_usage;
1245  uint64_t sdma_usage;
1246  uint32_t cu_occupancy;
1247 } rsmi_process_info_t;
1248 
1250 #define CU_OCCUPANCY_INVALID 0xFFFFFFFF
1251 
1255 typedef struct rsmi_func_id_iter_handle * rsmi_func_id_iter_handle_t;
1256 
1259 #define RSMI_DEFAULT_VARIANT 0xFFFFFFFFFFFFFFFF
1260 
1266 typedef union id {
1267  uint64_t id;
1268  const char *name;
1269  union {
1271  rsmi_memory_type_t memory_type;
1273  rsmi_temperature_metric_t temp_metric;
1275  rsmi_event_type_t evnt_type;
1277  rsmi_event_group_t evnt_group;
1279  rsmi_clk_type_t clk_type;
1281  rsmi_fw_block_t fw_block;
1283  rsmi_gpu_block_t gpu_block_type;
1284  };
1285 } rsmi_func_id_value_t;
1286 
1287 
1288 /*****************************************************************************/
1306 rsmi_status_t rsmi_init(uint64_t init_flags);
1307 
1313 rsmi_status_t rsmi_shut_down(void);
1314  // end of InitShut
1316 
1317 /*****************************************************************************/
1334 rsmi_status_t rsmi_num_monitor_devices(uint32_t *num_devices);
1335 
1363 rsmi_status_t rsmi_dev_id_get(uint32_t dv_ind, uint16_t *id);
1364 
1379 rsmi_status_t rsmi_dev_revision_get(uint32_t dv_ind, uint16_t *revision);
1380 
1405 rsmi_status_t rsmi_dev_sku_get(uint32_t dv_ind, uint16_t *sku);
1406 
1430 rsmi_status_t rsmi_dev_vendor_id_get(uint32_t dv_ind, uint16_t *id);
1431 
1466 rsmi_status_t rsmi_dev_name_get(uint32_t dv_ind, char *name, size_t len);
1467 
1500 rsmi_status_t rsmi_dev_brand_get(uint32_t dv_ind, char *brand, uint32_t len);
1501 
1536 rsmi_status_t rsmi_dev_vendor_name_get(uint32_t dv_ind, char *name, size_t len);
1537 
1538 
1564 rsmi_status_t rsmi_dev_market_name_get(uint32_t dv_ind, char *market_name, uint32_t len);
1565 
1588 rsmi_status_t rsmi_dev_vram_vendor_get(uint32_t dv_ind, char *brand,
1589  uint32_t len);
1590 
1619 rsmi_status_t rsmi_dev_serial_number_get(uint32_t dv_ind,
1620  char *serial_num, uint32_t len);
1644 rsmi_status_t rsmi_dev_subsystem_id_get(uint32_t dv_ind, uint16_t *id);
1645 
1680 rsmi_status_t
1681 rsmi_dev_subsystem_name_get(uint32_t dv_ind, char *name, size_t len);
1682 
1700 rsmi_status_t
1701 rsmi_dev_drm_render_minor_get(uint32_t dv_ind, uint32_t *minor);
1702 
1725 rsmi_status_t rsmi_dev_subsystem_vendor_id_get(uint32_t dv_ind, uint16_t *id);
1726 
1748 rsmi_status_t rsmi_dev_unique_id_get(uint32_t dv_ind, uint64_t *id);
1749 
1764 rsmi_status_t rsmi_dev_xgmi_physical_id_get(uint32_t dv_ind, uint16_t *id);
1765 
1788 rsmi_status_t rsmi_dev_guid_get(uint32_t dv_ind, uint64_t *guid);
1789 
1812 rsmi_status_t rsmi_dev_node_id_get(uint32_t dv_ind, uint32_t *node_id);
1813 
1814  // end of IDQuer
1816 
1817 /*****************************************************************************/
1841 rsmi_status_t
1842 rsmi_dev_pci_bandwidth_get(uint32_t dv_ind, rsmi_pcie_bandwidth_t *bandwidth);
1843 
1891 rsmi_status_t rsmi_dev_pci_id_get(uint32_t dv_ind, uint64_t *bdfid);
1892 
1915 rsmi_status_t rsmi_topo_numa_affinity_get(uint32_t dv_ind, int32_t *numa_node);
1916 
1941 rsmi_status_t rsmi_dev_pci_throughput_get(uint32_t dv_ind, uint64_t *sent,
1942  uint64_t *received, uint64_t *max_pkt_sz);
1943 
1966 rsmi_status_t rsmi_dev_pci_replay_counter_get(uint32_t dv_ind,
1967  uint64_t *counter);
1968  // end of PCIeQuer
1970 /*****************************************************************************/
2005 rsmi_status_t rsmi_dev_pci_bandwidth_set(uint32_t dv_ind, uint64_t bw_bitmask);
2006  // end of PCIeCont
2008 
2009 /*****************************************************************************/
2044 rsmi_status_t
2045 rsmi_dev_power_ave_get(uint32_t dv_ind, uint32_t sensor_ind, uint64_t *power);
2046 
2068 rsmi_status_t
2069 rsmi_dev_current_socket_power_get(uint32_t dv_ind, uint64_t *socket_power);
2070 
2105 rsmi_status_t rsmi_dev_power_get(uint32_t dv_ind, uint64_t *power,
2106  RSMI_POWER_TYPE *type);
2107 
2138 rsmi_status_t
2139 rsmi_dev_energy_count_get(uint32_t dv_ind, uint64_t *power,
2140  float *counter_resolution, uint64_t *timestamp);
2141 
2167 rsmi_status_t
2168 rsmi_dev_power_cap_get(uint32_t dv_ind, uint32_t sensor_ind, uint64_t *cap);
2169 
2191 rsmi_status_t
2192 rsmi_dev_power_cap_default_get(uint32_t dv_ind, uint64_t *default_cap);
2193 
2225 rsmi_status_t
2226 rsmi_dev_power_cap_range_get(uint32_t dv_ind, uint32_t sensor_ind,
2227  uint64_t *max, uint64_t *min);
2228  // end of PowerQuer
2230 
2231 /*****************************************************************************/
2256 rsmi_status_t
2257 rsmi_dev_power_cap_set(uint32_t dv_ind, uint32_t sensor_ind, uint64_t cap);
2258 
2278 rsmi_status_t
2279 rsmi_dev_power_profile_set(uint32_t dv_ind, uint32_t reserved,
2280  rsmi_power_profile_preset_masks_t profile); // end of PowerCont
2282 /*****************************************************************************/
2283 
2284 
2285 
2286 /*****************************************************************************/
2317 rsmi_status_t
2318 rsmi_dev_memory_total_get(uint32_t dv_ind, rsmi_memory_type_t mem_type,
2319  uint64_t *total);
2320 
2347 rsmi_status_t
2348 rsmi_dev_memory_usage_get(uint32_t dv_ind, rsmi_memory_type_t mem_type,
2349  uint64_t *used);
2350 
2373 rsmi_status_t
2374 rsmi_dev_memory_busy_percent_get(uint32_t dv_ind, uint32_t *busy_percent);
2375 
2411 rsmi_status_t
2412 rsmi_dev_memory_reserved_pages_get(uint32_t dv_ind, uint32_t *num_pages,
2413  rsmi_retired_page_record_t *records); // end of MemQuer
2415 
2447 rsmi_status_t rsmi_dev_fan_rpms_get(uint32_t dv_ind, uint32_t sensor_ind,
2448  int64_t *speed);
2449 
2477 rsmi_status_t rsmi_dev_fan_speed_get(uint32_t dv_ind,
2478  uint32_t sensor_ind, int64_t *speed);
2479 
2505 rsmi_status_t rsmi_dev_fan_speed_max_get(uint32_t dv_ind,
2506  uint32_t sensor_ind, uint64_t *max_speed);
2507 
2538 rsmi_status_t rsmi_dev_temp_metric_get(uint32_t dv_ind, uint32_t sensor_type,
2539  rsmi_temperature_metric_t metric, int64_t *temperature);
2540 
2571 rsmi_status_t rsmi_dev_volt_metric_get(uint32_t dv_ind,
2572  rsmi_voltage_type_t sensor_type,
2573  rsmi_voltage_metric_t metric, int64_t *voltage); // end of PhysQuer
2575 
2576 /*****************************************************************************/
2596 rsmi_status_t rsmi_dev_fan_reset(uint32_t dv_ind, uint32_t sensor_ind);
2597 
2620 rsmi_status_t rsmi_dev_fan_speed_set(uint32_t dv_ind, uint32_t sensor_ind,
2621  uint64_t speed);
2622  // end of PhysCont
2624 /*****************************************************************************/
2654 rsmi_status_t
2655 rsmi_dev_busy_percent_get(uint32_t dv_ind, uint32_t *busy_percent);
2656 
2686 rsmi_status_t
2687 rsmi_utilization_count_get(uint32_t dv_ind,
2688  rsmi_utilization_counter_t utilization_counters[],
2689  uint32_t count,
2690  uint64_t *timestamp);
2691 
2715 rsmi_status_t
2716 rsmi_dev_activity_metric_get(uint32_t dv_ind,
2717  rsmi_activity_metric_t activity_metric_type,
2718  rsmi_activity_metric_counter_t* activity_metric_counter);
2719 
2740 rsmi_status_t
2741 rsmi_dev_activity_avg_mm_get(uint32_t dv_ind, uint16_t* avg_activity);
2742 
2766 rsmi_status_t rsmi_dev_perf_level_get(uint32_t dv_ind,
2767  rsmi_dev_perf_level_t *perf);
2768 
2790 rsmi_status_t rsmi_perf_determinism_mode_set(uint32_t dv_ind,
2791  uint64_t clkvalue);
2792 
2816 rsmi_status_t rsmi_dev_overdrive_level_get(uint32_t dv_ind, uint32_t *od);
2817 
2841 rsmi_status_t rsmi_dev_mem_overdrive_level_get(uint32_t dv_ind, uint32_t *od);
2842 
2875 rsmi_status_t rsmi_dev_gpu_clk_freq_get(uint32_t dv_ind,
2876  rsmi_clk_type_t clk_type, rsmi_frequencies_t *f);
2877 
2891 rsmi_status_t rsmi_dev_gpu_reset(uint32_t dv_ind);
2892 
2913 rsmi_status_t rsmi_dev_od_volt_info_get(uint32_t dv_ind,
2914  rsmi_od_volt_freq_data_t *odv);
2915 
2936 rsmi_status_t rsmi_dev_gpu_metrics_info_get(uint32_t dv_ind,
2937  rsmi_gpu_metrics_t *pgpu_metrics);
2938 
2961 rsmi_status_t rsmi_dev_clk_range_set(uint32_t dv_ind, uint64_t minclkvalue,
2962  uint64_t maxclkvalue,
2963  rsmi_clk_type_t clkType);
2964 
2986 rsmi_status_t rsmi_dev_clk_extremum_set(uint32_t dv_ind, rsmi_freq_ind_t level,
2987  uint64_t clkvalue,
2988  rsmi_clk_type_t clkType);
2989 
3012 rsmi_status_t rsmi_dev_od_clk_info_set(uint32_t dv_ind, rsmi_freq_ind_t level,
3013  uint64_t clkvalue,
3014  rsmi_clk_type_t clkType);
3015 
3037 rsmi_status_t rsmi_dev_od_volt_info_set(uint32_t dv_ind, uint32_t vpoint,
3038  uint64_t clkvalue, uint64_t voltvalue);
3039 
3078 rsmi_status_t rsmi_dev_od_volt_curve_regions_get(uint32_t dv_ind,
3079  uint32_t *num_regions, rsmi_freq_volt_region_t *buffer);
3080 
3116 rsmi_status_t
3117 rsmi_dev_power_profile_presets_get(uint32_t dv_ind, uint32_t sensor_ind,
3118  rsmi_power_profile_status_t *status);
3119  // end of PerfQuer
3121 /*****************************************************************************/
3122 
3149 rsmi_status_t
3150 rsmi_dev_perf_level_set(uint32_t dv_ind, rsmi_dev_perf_level_t perf_lvl);
3151 
3170 rsmi_status_t
3171 rsmi_dev_perf_level_set_v1(uint32_t dv_ind, rsmi_dev_perf_level_t perf_lvl);
3172 
3216 rsmi_status_t rsmi_dev_overdrive_level_set(uint32_t dv_ind, uint32_t od);
3217 
3257 rsmi_status_t rsmi_dev_overdrive_level_set_v1(uint32_t dv_ind, uint32_t od);
3258 
3293 rsmi_status_t rsmi_dev_gpu_clk_freq_set(uint32_t dv_ind,
3294  rsmi_clk_type_t clk_type, uint64_t freq_bitmask);
3295  // end of PerfCont
3297 
3298 /*****************************************************************************/
3317 rsmi_status_t
3318 rsmi_version_get(rsmi_version_t *version);
3319 
3345 rsmi_status_t
3346 rsmi_version_str_get(rsmi_sw_component_t component, char *ver_str,
3347  uint32_t len);
3348 
3375 rsmi_status_t
3376 rsmi_dev_vbios_version_get(uint32_t dv_ind, char *vbios, uint32_t len);
3377 
3402 rsmi_status_t
3403 rsmi_dev_firmware_version_get(uint32_t dv_ind, rsmi_fw_block_t block,
3404  uint64_t *fw_version);
3405 
3426 rsmi_status_t rsmi_dev_target_graphics_version_get(uint32_t dv_ind,
3427  uint64_t *gfx_version);
3428  // end of VersQuer
3430 
3431 /*****************************************************************************/
3463 rsmi_status_t rsmi_dev_ecc_count_get(uint32_t dv_ind,
3464  rsmi_gpu_block_t block, rsmi_error_count_t *ec);
3465 
3493 rsmi_status_t rsmi_dev_ecc_enabled_get(uint32_t dv_ind,
3494  uint64_t *enabled_blocks);
3495 
3521 rsmi_status_t rsmi_dev_ecc_status_get(uint32_t dv_ind, rsmi_gpu_block_t block,
3522  rsmi_ras_err_state_t *state);
3537 rsmi_status_t
3538 rsmi_status_string(rsmi_status_t status, const char **status_string);
3539  // end of ErrQuer
3541 
3542 /*****************************************************************************/
3663 rsmi_status_t
3664 rsmi_dev_counter_group_supported(uint32_t dv_ind, rsmi_event_group_t group);
3665 
3694 rsmi_status_t
3695 rsmi_dev_counter_create(uint32_t dv_ind, rsmi_event_type_t type,
3696  rsmi_event_handle_t *evnt_handle);
3697 
3711 rsmi_status_t
3712 rsmi_dev_counter_destroy(rsmi_event_handle_t evnt_handle);
3713 
3731 rsmi_status_t
3732 rsmi_counter_control(rsmi_event_handle_t evt_handle,
3733  rsmi_counter_command_t cmd, void *cmd_args);
3734 
3752 rsmi_status_t
3753 rsmi_counter_read(rsmi_event_handle_t evt_handle,
3754  rsmi_counter_value_t *value);
3755 
3775 rsmi_status_t
3776 rsmi_counter_available_counters_get(uint32_t dv_ind,
3777  rsmi_event_group_t grp, uint32_t *available); // end of PerfCntr
3779 
3780 /*****************************************************************************/
3820 rsmi_status_t
3821 rsmi_compute_process_info_get(rsmi_process_info_t *procs, uint32_t *num_items);
3822 
3844 rsmi_status_t
3845 rsmi_compute_process_info_by_pid_get(uint32_t pid, rsmi_process_info_t *proc);
3846 
3881 rsmi_status_t
3882 rsmi_compute_process_gpus_get(uint32_t pid, uint32_t *dv_indices,
3883  uint32_t *num_devices);
3884 
3904 rsmi_status_t
3905 rsmi_compute_process_info_by_device_get(uint32_t pid, uint32_t dv_ind,
3906  rsmi_process_info_t *proc);
3907  // end of SysInfo
3909 
3910 /*****************************************************************************/
3939 rsmi_status_t
3940 rsmi_dev_xgmi_error_status(uint32_t dv_ind, rsmi_xgmi_status_t *status);
3941 
3954 rsmi_status_t
3955 rsmi_dev_xgmi_error_reset(uint32_t dv_ind);
3956 
3975 rsmi_status_t
3976 rsmi_dev_xgmi_hive_id_get(uint32_t dv_ind, uint64_t *hive_id);
3977  // end of SysInfo
3979 
3980 /*****************************************************************************/
4003 rsmi_status_t
4004 rsmi_topo_get_numa_node_number(uint32_t dv_ind, uint32_t *numa_node);
4005 
4026 rsmi_status_t
4027 rsmi_topo_get_link_weight(uint32_t dv_ind_src, uint32_t dv_ind_dst,
4028  uint64_t *weight);
4029 
4052 rsmi_status_t
4053 rsmi_minmax_bandwidth_get(uint32_t dv_ind_src, uint32_t dv_ind_dst,
4054  uint64_t *min_bandwidth, uint64_t *max_bandwidth);
4055 
4088 rsmi_status_t
4089 rsmi_topo_get_link_type(uint32_t dv_ind_src, uint32_t dv_ind_dst,
4090  uint64_t *hops, RSMI_IO_LINK_TYPE *type);
4091 
4112 rsmi_status_t
4113 rsmi_is_P2P_accessible(uint32_t dv_ind_src, uint32_t dv_ind_dst,
4114  bool *accessible);
4115  // end of HWTopo
4117 
4118 /*****************************************************************************/
4153 rsmi_status_t
4154 rsmi_dev_compute_partition_get(uint32_t dv_ind, char *compute_partition,
4155  uint32_t len);
4156 
4181 rsmi_status_t
4182 rsmi_dev_compute_partition_set(uint32_t dv_ind,
4183  rsmi_compute_partition_type_t compute_partition);
4184 
4207 rsmi_status_t rsmi_dev_partition_id_get(uint32_t dv_ind, uint32_t *partition_id);
4208  // end of ComputePartition
4210 
4211 /*****************************************************************************/
4246 rsmi_status_t
4247 rsmi_dev_memory_partition_get(uint32_t dv_ind, char *memory_partition,
4248  uint32_t len);
4249 
4280 rsmi_status_t rsmi_dev_memory_partition_capabilities_get(
4281  uint32_t dv_ind, char *memory_partition_caps, uint32_t len);
4282 
4306 rsmi_status_t
4307 rsmi_dev_memory_partition_set(uint32_t dv_ind,
4308  rsmi_memory_partition_type_t memory_partition);
4309  // end of memory_partition
4311 
4312 /*****************************************************************************/
4445 rsmi_status_t
4446 rsmi_dev_supported_func_iterator_open(uint32_t dv_ind,
4447  rsmi_func_id_iter_handle_t *handle);
4448 
4473 rsmi_status_t
4474 rsmi_dev_supported_variant_iterator_open(rsmi_func_id_iter_handle_t obj_h,
4475  rsmi_func_id_iter_handle_t *var_iter);
4476 
4495 rsmi_status_t
4496 rsmi_func_iter_next(rsmi_func_id_iter_handle_t handle);
4497 
4509 rsmi_status_t
4510 rsmi_dev_supported_func_iterator_close(rsmi_func_id_iter_handle_t *handle);
4511 
4530 rsmi_status_t
4531 rsmi_func_iter_value_get(rsmi_func_id_iter_handle_t handle,
4532  rsmi_func_id_value_t *value);
4533  // end of APISupport
4535 
4536 /*****************************************************************************/
4556 rsmi_status_t
4557 rsmi_event_notification_init(uint32_t dv_ind);
4558 
4585 rsmi_status_t
4586 rsmi_event_notification_mask_set(uint32_t dv_ind, uint64_t mask);
4587 
4628 rsmi_status_t
4629 rsmi_event_notification_get(int timeout_ms,
4630  uint32_t *num_elem, rsmi_evt_notification_data_t *data);
4631 
4650 rsmi_status_t rsmi_event_notification_stop(uint32_t dv_ind);
4651  // end of EvntNotif
4653 
4654 
4655 /*****************************************************************************/
4678 rsmi_status_t
4679 rsmi_dev_metrics_header_info_get(uint32_t dv_ind, metrics_table_header_t* header_value);
4680 
4697 rsmi_status_t
4698 rsmi_dev_metrics_xcd_counter_get(uint32_t dv_ind, uint16_t* xcd_counter_value);
4699 
4711 rsmi_status_t
4712 rsmi_dev_metrics_log_get(uint32_t dv_ind);
4713  // end of DevMetricsHeaderInfoGet
4715 
4716 #ifdef __cplusplus
4717 }
4718 #endif // __cplusplus
4719 #endif // ROCM_SMI_ROCM_SMI_H_
rsmi_func_iter_value_get
rsmi_status_t rsmi_func_iter_value_get(rsmi_func_id_iter_handle_t handle, rsmi_func_id_value_t *value)
Get the value associated with a function/variant iterator.
rsmi_dev_supported_variant_iterator_open
rsmi_status_t rsmi_dev_supported_variant_iterator_open(rsmi_func_id_iter_handle_t obj_h, rsmi_func_id_iter_handle_t *var_iter)
Get a variant iterator for a given handle.
rsmi_func_iter_next
rsmi_status_t rsmi_func_iter_next(rsmi_func_id_iter_handle_t handle)
Advance a function identifer iterator.
rsmi_dev_supported_func_iterator_close
rsmi_status_t rsmi_dev_supported_func_iterator_close(rsmi_func_id_iter_handle_t *handle)
Close a variant iterator handle.
rsmi_dev_supported_func_iterator_open
rsmi_status_t rsmi_dev_supported_func_iterator_open(uint32_t dv_ind, rsmi_func_id_iter_handle_t *handle)
Get a function name iterator of supported RSMI functions for a device.
rsmi_dev_partition_id_get
rsmi_status_t rsmi_dev_partition_id_get(uint32_t dv_ind, uint32_t *partition_id)
Retrieves the partition_id for a desired device.
rsmi_dev_compute_partition_set
rsmi_status_t rsmi_dev_compute_partition_set(uint32_t dv_ind, rsmi_compute_partition_type_t compute_partition)
Modifies a selected device's compute partition setting.
rsmi_dev_compute_partition_get
rsmi_status_t rsmi_dev_compute_partition_get(uint32_t dv_ind, char *compute_partition, uint32_t len)
Retrieves the current compute partitioning for a desired device.
rsmi_dev_ecc_status_get
rsmi_status_t rsmi_dev_ecc_status_get(uint32_t dv_ind, rsmi_gpu_block_t block, rsmi_ras_err_state_t *state)
Retrieve the ECC status for a GPU block.
rsmi_dev_ecc_enabled_get
rsmi_status_t rsmi_dev_ecc_enabled_get(uint32_t dv_ind, uint64_t *enabled_blocks)
Retrieve the enabled ECC bit-mask.
rsmi_dev_ecc_count_get
rsmi_status_t rsmi_dev_ecc_count_get(uint32_t dv_ind, rsmi_gpu_block_t block, rsmi_error_count_t *ec)
Retrieve the error counts for a GPU block.
rsmi_status_string
rsmi_status_t rsmi_status_string(rsmi_status_t status, const char **status_string)
Get a description of a provided RSMI error status.
rsmi_event_notification_stop
rsmi_status_t rsmi_event_notification_stop(uint32_t dv_ind)
Close any file handles and free any resources used by event notification for a GPU.
rsmi_event_notification_get
rsmi_status_t rsmi_event_notification_get(int timeout_ms, uint32_t *num_elem, rsmi_evt_notification_data_t *data)
Collect event notifications, waiting a specified amount of time.
rsmi_event_notification_init
rsmi_status_t rsmi_event_notification_init(uint32_t dv_ind)
Prepare to collect event notifications for a GPU.
rsmi_event_notification_mask_set
rsmi_status_t rsmi_event_notification_mask_set(uint32_t dv_ind, uint64_t mask)
Specify which events to collect for a device.
rsmi_dev_metrics_xcd_counter_get
rsmi_status_t rsmi_dev_metrics_xcd_counter_get(uint32_t dv_ind, uint16_t *xcd_counter_value)
Get the 'xcd_counter' from the GPU metrics associated with the device.
rsmi_dev_metrics_header_info_get
rsmi_status_t rsmi_dev_metrics_header_info_get(uint32_t dv_ind, metrics_table_header_t *header_value)
Get the 'metrics_header_info' from the GPU metrics associated with the device.
rsmi_dev_metrics_log_get
rsmi_status_t rsmi_dev_metrics_log_get(uint32_t dv_ind)
Get the log from the GPU metrics associated with the device.
rsmi_topo_get_link_type
rsmi_status_t rsmi_topo_get_link_type(uint32_t dv_ind_src, uint32_t dv_ind_dst, uint64_t *hops, RSMI_IO_LINK_TYPE *type)
Retrieve the hops and the connection type between GPU to GPU/CPU.
rsmi_topo_get_link_weight
rsmi_status_t rsmi_topo_get_link_weight(uint32_t dv_ind_src, uint32_t dv_ind_dst, uint64_t *weight)
Retrieve the weight for a connection between 2 GPUs.
rsmi_minmax_bandwidth_get
rsmi_status_t rsmi_minmax_bandwidth_get(uint32_t dv_ind_src, uint32_t dv_ind_dst, uint64_t *min_bandwidth, uint64_t *max_bandwidth)
Retreive minimal and maximal io link bandwidth between 2 GPUs.
rsmi_is_P2P_accessible
rsmi_status_t rsmi_is_P2P_accessible(uint32_t dv_ind_src, uint32_t dv_ind_dst, bool *accessible)
Return P2P availability status between 2 GPUs.
rsmi_topo_get_numa_node_number
rsmi_status_t rsmi_topo_get_numa_node_number(uint32_t dv_ind, uint32_t *numa_node)
Retrieve the NUMA CPU node number for a device.
rsmi_dev_name_get
rsmi_status_t rsmi_dev_name_get(uint32_t dv_ind, char *name, size_t len)
Get the name string of a gpu device.
rsmi_dev_unique_id_get
rsmi_status_t rsmi_dev_unique_id_get(uint32_t dv_ind, uint64_t *id)
Get Unique ID.
rsmi_num_monitor_devices
rsmi_status_t rsmi_num_monitor_devices(uint32_t *num_devices)
Get the number of devices that have monitor information.
rsmi_dev_guid_get
rsmi_status_t rsmi_dev_guid_get(uint32_t dv_ind, uint64_t *guid)
Get the GUID, also known as the GPU device id, associated with the provided device index indicated by...
rsmi_dev_market_name_get
rsmi_status_t rsmi_dev_market_name_get(uint32_t dv_ind, char *market_name, uint32_t len)
Get the device's market name.
rsmi_dev_vram_vendor_get
rsmi_status_t rsmi_dev_vram_vendor_get(uint32_t dv_ind, char *brand, uint32_t len)
Get the vram vendor string of a gpu device.
rsmi_dev_sku_get
rsmi_status_t rsmi_dev_sku_get(uint32_t dv_ind, uint16_t *sku)
Get the SKU for a desired device associated with the device with provided device index.
rsmi_dev_drm_render_minor_get
rsmi_status_t rsmi_dev_drm_render_minor_get(uint32_t dv_ind, uint32_t *minor)
Get the drm minor number associated with this device.
rsmi_dev_subsystem_id_get
rsmi_status_t rsmi_dev_subsystem_id_get(uint32_t dv_ind, uint16_t *id)
Get the subsystem device id associated with the device with provided device index.
rsmi_dev_xgmi_physical_id_get
rsmi_status_t rsmi_dev_xgmi_physical_id_get(uint32_t dv_ind, uint16_t *id)
Get the XGMI physical id associated with the device.
rsmi_dev_serial_number_get
rsmi_status_t rsmi_dev_serial_number_get(uint32_t dv_ind, char *serial_num, uint32_t len)
Get the serial number string for a device.
rsmi_dev_vendor_name_get
rsmi_status_t rsmi_dev_vendor_name_get(uint32_t dv_ind, char *name, size_t len)
Get the name string for a give vendor ID.
rsmi_dev_brand_get
rsmi_status_t rsmi_dev_brand_get(uint32_t dv_ind, char *brand, uint32_t len)
Get the brand string of a gpu device.
rsmi_dev_id_get
rsmi_status_t rsmi_dev_id_get(uint32_t dv_ind, uint16_t *id)
Get the device id associated with the device with provided device index.
rsmi_dev_subsystem_name_get
rsmi_status_t rsmi_dev_subsystem_name_get(uint32_t dv_ind, char *name, size_t len)
Get the name string for the device subsytem.
rsmi_dev_node_id_get
rsmi_status_t rsmi_dev_node_id_get(uint32_t dv_ind, uint32_t *node_id)
Get the node id associated with the provided device index indicated by KFD.
rsmi_dev_revision_get
rsmi_status_t rsmi_dev_revision_get(uint32_t dv_ind, uint16_t *revision)
Get the device revision associated with the device.
rsmi_dev_subsystem_vendor_id_get
rsmi_status_t rsmi_dev_subsystem_vendor_id_get(uint32_t dv_ind, uint16_t *id)
Get the device subsystem vendor id associated with the device with provided device index.
rsmi_dev_vendor_id_get
rsmi_status_t rsmi_dev_vendor_id_get(uint32_t dv_ind, uint16_t *id)
Get the device vendor id associated with the device with provided device index.
rsmi_init
rsmi_status_t rsmi_init(uint64_t init_flags)
Initialize ROCm SMI.
rsmi_shut_down
rsmi_status_t rsmi_shut_down(void)
Shutdown ROCm SMI.
rsmi_dev_memory_total_get
rsmi_status_t rsmi_dev_memory_total_get(uint32_t dv_ind, rsmi_memory_type_t mem_type, uint64_t *total)
Get the total amount of memory that exists.
rsmi_dev_memory_usage_get
rsmi_status_t rsmi_dev_memory_usage_get(uint32_t dv_ind, rsmi_memory_type_t mem_type, uint64_t *used)
Get the current memory usage.
rsmi_dev_memory_reserved_pages_get
rsmi_status_t rsmi_dev_memory_reserved_pages_get(uint32_t dv_ind, uint32_t *num_pages, rsmi_retired_page_record_t *records)
Get information about reserved ("retired") memory pages.
rsmi_dev_memory_busy_percent_get
rsmi_status_t rsmi_dev_memory_busy_percent_get(uint32_t dv_ind, uint32_t *busy_percent)
Get percentage of time any device memory is being used.
rsmi_dev_pci_bandwidth_set
rsmi_status_t rsmi_dev_pci_bandwidth_set(uint32_t dv_ind, uint64_t bw_bitmask)
Control the set of allowed PCIe bandwidths that can be used.
rsmi_dev_pci_throughput_get
rsmi_status_t rsmi_dev_pci_throughput_get(uint32_t dv_ind, uint64_t *sent, uint64_t *received, uint64_t *max_pkt_sz)
Get PCIe traffic information.
rsmi_dev_pci_bandwidth_get
rsmi_status_t rsmi_dev_pci_bandwidth_get(uint32_t dv_ind, rsmi_pcie_bandwidth_t *bandwidth)
Get the list of possible PCIe bandwidths that are available.
rsmi_topo_numa_affinity_get
rsmi_status_t rsmi_topo_numa_affinity_get(uint32_t dv_ind, int32_t *numa_node)
Get the NUMA node associated with a device.
rsmi_dev_pci_replay_counter_get
rsmi_status_t rsmi_dev_pci_replay_counter_get(uint32_t dv_ind, uint64_t *counter)
Get PCIe replay counter.
rsmi_dev_pci_id_get
rsmi_status_t rsmi_dev_pci_id_get(uint32_t dv_ind, uint64_t *bdfid)
Get the unique PCI device identifier associated for a device.
rsmi_counter_control
rsmi_status_t rsmi_counter_control(rsmi_event_handle_t evt_handle, rsmi_counter_command_t cmd, void *cmd_args)
Issue performance counter control commands.
rsmi_counter_read
rsmi_status_t rsmi_counter_read(rsmi_event_handle_t evt_handle, rsmi_counter_value_t *value)
Read the current value of a performance counter.
rsmi_counter_available_counters_get
rsmi_status_t rsmi_counter_available_counters_get(uint32_t dv_ind, rsmi_event_group_t grp, uint32_t *available)
Get the number of currently available counters.
rsmi_dev_counter_destroy
rsmi_status_t rsmi_dev_counter_destroy(rsmi_event_handle_t evnt_handle)
Deallocate a performance counter object.
rsmi_dev_counter_create
rsmi_status_t rsmi_dev_counter_create(uint32_t dv_ind, rsmi_event_type_t type, rsmi_event_handle_t *evnt_handle)
Create a performance counter object.
rsmi_dev_counter_group_supported
rsmi_status_t rsmi_dev_counter_group_supported(uint32_t dv_ind, rsmi_event_group_t group)
Tell if an event group is supported by a given device.
rsmi_dev_overdrive_level_set_v1
rsmi_status_t rsmi_dev_overdrive_level_set_v1(uint32_t dv_ind, uint32_t od)
Set the overdrive percent associated with the device with provided device index with the provided val...
rsmi_dev_perf_level_set
rsmi_status_t rsmi_dev_perf_level_set(uint32_t dv_ind, rsmi_dev_perf_level_t perf_lvl)
Set the PowerPlay performance level associated with the device with provided device index with the pr...
rsmi_dev_overdrive_level_set
rsmi_status_t rsmi_dev_overdrive_level_set(uint32_t dv_ind, uint32_t od)
Set the overdrive percent associated with the device with provided device index with the provided val...
rsmi_dev_gpu_clk_freq_set
rsmi_status_t rsmi_dev_gpu_clk_freq_set(uint32_t dv_ind, rsmi_clk_type_t clk_type, uint64_t freq_bitmask)
Control the set of allowed frequencies that can be used for the specified clock.
rsmi_dev_perf_level_set_v1
rsmi_status_t rsmi_dev_perf_level_set_v1(uint32_t dv_ind, rsmi_dev_perf_level_t perf_lvl)
Set the PowerPlay performance level associated with the device with provided device index with the pr...
rsmi_dev_clk_range_set
rsmi_status_t rsmi_dev_clk_range_set(uint32_t dv_ind, uint64_t minclkvalue, uint64_t maxclkvalue, rsmi_clk_type_t clkType)
This function sets the clock range information.
rsmi_dev_od_volt_curve_regions_get
rsmi_status_t rsmi_dev_od_volt_curve_regions_get(uint32_t dv_ind, uint32_t *num_regions, rsmi_freq_volt_region_t *buffer)
This function will retrieve the current valid regions in the frequency/voltage space.
rsmi_dev_power_profile_presets_get
rsmi_status_t rsmi_dev_power_profile_presets_get(uint32_t dv_ind, uint32_t sensor_ind, rsmi_power_profile_status_t *status)
Get the list of available preset power profiles and an indication of which profile is currently activ...
rsmi_dev_od_clk_info_set
rsmi_status_t rsmi_dev_od_clk_info_set(uint32_t dv_ind, rsmi_freq_ind_t level, uint64_t clkvalue, rsmi_clk_type_t clkType)
This function sets the clock frequency information.
rsmi_dev_perf_level_get
rsmi_status_t rsmi_dev_perf_level_get(uint32_t dv_ind, rsmi_dev_perf_level_t *perf)
Get the performance level of the device with provided device index.
rsmi_dev_gpu_reset
rsmi_status_t rsmi_dev_gpu_reset(uint32_t dv_ind)
Reset the gpu associated with the device with provided device index.
rsmi_dev_activity_metric_get
rsmi_status_t rsmi_dev_activity_metric_get(uint32_t dv_ind, rsmi_activity_metric_t activity_metric_type, rsmi_activity_metric_counter_t *activity_metric_counter)
Get activity metric average utilization counter of the specified device.
rsmi_dev_od_volt_info_get
rsmi_status_t rsmi_dev_od_volt_info_get(uint32_t dv_ind, rsmi_od_volt_freq_data_t *odv)
This function retrieves the voltage/frequency curve information.
rsmi_dev_gpu_metrics_info_get
rsmi_status_t rsmi_dev_gpu_metrics_info_get(uint32_t dv_ind, rsmi_gpu_metrics_t *pgpu_metrics)
This function retrieves the gpu metrics information.
rsmi_perf_determinism_mode_set
rsmi_status_t rsmi_perf_determinism_mode_set(uint32_t dv_ind, uint64_t clkvalue)
Enter performance determinism mode with provided device index.
rsmi_utilization_count_get
rsmi_status_t rsmi_utilization_count_get(uint32_t dv_ind, rsmi_utilization_counter_t utilization_counters[], uint32_t count, uint64_t *timestamp)
Get coarse grain utilization counter of the specified device.
rsmi_dev_clk_extremum_set
rsmi_status_t rsmi_dev_clk_extremum_set(uint32_t dv_ind, rsmi_freq_ind_t level, uint64_t clkvalue, rsmi_clk_type_t clkType)
This function sets the clock min/max level.
rsmi_dev_od_volt_info_set
rsmi_status_t rsmi_dev_od_volt_info_set(uint32_t dv_ind, uint32_t vpoint, uint64_t clkvalue, uint64_t voltvalue)
This function sets 1 of the 3 voltage curve points.
rsmi_dev_overdrive_level_get
rsmi_status_t rsmi_dev_overdrive_level_get(uint32_t dv_ind, uint32_t *od)
Get the overdrive percent associated with the device with provided device index.
rsmi_dev_gpu_clk_freq_get
rsmi_status_t rsmi_dev_gpu_clk_freq_get(uint32_t dv_ind, rsmi_clk_type_t clk_type, rsmi_frequencies_t *f)
Get the list of possible system clock speeds of device for a specified clock type.
rsmi_dev_activity_avg_mm_get
rsmi_status_t rsmi_dev_activity_avg_mm_get(uint32_t dv_ind, uint16_t *avg_activity)
Get activity metric bandwidth average utilization counter of the specified device.
rsmi_dev_mem_overdrive_level_get
rsmi_status_t rsmi_dev_mem_overdrive_level_get(uint32_t dv_ind, uint32_t *od)
Get the memory clock overdrive percent associated with the device with provided device index.
rsmi_dev_busy_percent_get
rsmi_status_t rsmi_dev_busy_percent_get(uint32_t dv_ind, uint32_t *busy_percent)
Get percentage of time device is busy doing any processing.
rsmi_dev_fan_speed_set
rsmi_status_t rsmi_dev_fan_speed_set(uint32_t dv_ind, uint32_t sensor_ind, uint64_t speed)
Set the fan speed for the specified device with the provided speed, in RPMs.
rsmi_dev_fan_reset
rsmi_status_t rsmi_dev_fan_reset(uint32_t dv_ind, uint32_t sensor_ind)
Reset the fan to automatic driver control.
rsmi_dev_volt_metric_get
rsmi_status_t rsmi_dev_volt_metric_get(uint32_t dv_ind, rsmi_voltage_type_t sensor_type, rsmi_voltage_metric_t metric, int64_t *voltage)
Get the voltage metric value for the specified metric, from the specified voltage sensor on the speci...
rsmi_dev_temp_metric_get
rsmi_status_t rsmi_dev_temp_metric_get(uint32_t dv_ind, uint32_t sensor_type, rsmi_temperature_metric_t metric, int64_t *temperature)
Get the temperature metric value for the specified metric, from the specified temperature sensor on t...
rsmi_dev_fan_speed_max_get
rsmi_status_t rsmi_dev_fan_speed_max_get(uint32_t dv_ind, uint32_t sensor_ind, uint64_t *max_speed)
Get the max. fan speed of the device with provided device index.
rsmi_dev_fan_rpms_get
rsmi_status_t rsmi_dev_fan_rpms_get(uint32_t dv_ind, uint32_t sensor_ind, int64_t *speed)
Get the fan speed in RPMs of the device with the specified device index and 0-based sensor index.
rsmi_dev_fan_speed_get
rsmi_status_t rsmi_dev_fan_speed_get(uint32_t dv_ind, uint32_t sensor_ind, int64_t *speed)
Get the fan speed for the specified device as a value relative to RSMI_MAX_FAN_SPEED.
rsmi_dev_power_cap_set
rsmi_status_t rsmi_dev_power_cap_set(uint32_t dv_ind, uint32_t sensor_ind, uint64_t cap)
Set the power cap value.
rsmi_dev_power_profile_set
rsmi_status_t rsmi_dev_power_profile_set(uint32_t dv_ind, uint32_t reserved, rsmi_power_profile_preset_masks_t profile)
Set the power profile.
rsmi_dev_energy_count_get
rsmi_status_t rsmi_dev_energy_count_get(uint32_t dv_ind, uint64_t *power, float *counter_resolution, uint64_t *timestamp)
Get the energy accumulator counter of the device with provided device index.
rsmi_dev_power_cap_default_get
rsmi_status_t rsmi_dev_power_cap_default_get(uint32_t dv_ind, uint64_t *default_cap)
Get the default power cap for the device specified by dv_ind.
rsmi_dev_power_ave_get
rsmi_status_t rsmi_dev_power_ave_get(uint32_t dv_ind, uint32_t sensor_ind, uint64_t *power)
Get the average power consumption of the device with provided device index.
rsmi_dev_power_get
rsmi_status_t rsmi_dev_power_get(uint32_t dv_ind, uint64_t *power, RSMI_POWER_TYPE *type)
A generic get which attempts to retieve current socket power (also known as instant power) of the dev...
rsmi_dev_power_cap_get
rsmi_status_t rsmi_dev_power_cap_get(uint32_t dv_ind, uint32_t sensor_ind, uint64_t *cap)
Get the cap on power which, when reached, causes the system to take action to reduce power.
rsmi_dev_power_cap_range_get
rsmi_status_t rsmi_dev_power_cap_range_get(uint32_t dv_ind, uint32_t sensor_ind, uint64_t *max, uint64_t *min)
Get the range of valid values for the power cap.
rsmi_dev_current_socket_power_get
rsmi_status_t rsmi_dev_current_socket_power_get(uint32_t dv_ind, uint64_t *socket_power)
Get the current socket power (also known as instant power) of the device index provided.
rsmi_compute_process_info_by_device_get
rsmi_status_t rsmi_compute_process_info_by_device_get(uint32_t pid, uint32_t dv_ind, rsmi_process_info_t *proc)
Get the info of a process on a specific device.
rsmi_compute_process_gpus_get
rsmi_status_t rsmi_compute_process_gpus_get(uint32_t pid, uint32_t *dv_indices, uint32_t *num_devices)
Get the device indices currently being used by a process.
rsmi_compute_process_info_by_pid_get
rsmi_status_t rsmi_compute_process_info_by_pid_get(uint32_t pid, rsmi_process_info_t *proc)
Get process information about a specific process.
rsmi_compute_process_info_get
rsmi_status_t rsmi_compute_process_info_get(rsmi_process_info_t *procs, uint32_t *num_items)
Get process information about processes currently using GPU.
rsmi_version_get
rsmi_status_t rsmi_version_get(rsmi_version_t *version)
Get the build version information for the currently running build of RSMI.
rsmi_dev_vbios_version_get
rsmi_status_t rsmi_dev_vbios_version_get(uint32_t dv_ind, char *vbios, uint32_t len)
Get the VBIOS identifer string.
rsmi_dev_firmware_version_get
rsmi_status_t rsmi_dev_firmware_version_get(uint32_t dv_ind, rsmi_fw_block_t block, uint64_t *fw_version)
Get the firmware versions for a device.
rsmi_version_str_get
rsmi_status_t rsmi_version_str_get(rsmi_sw_component_t component, char *ver_str, uint32_t len)
Get the driver version string for the current system.
rsmi_dev_target_graphics_version_get
rsmi_status_t rsmi_dev_target_graphics_version_get(uint32_t dv_ind, uint64_t *gfx_version)
Get the target graphics version for a GPU device.
rsmi_dev_xgmi_error_status
rsmi_status_t rsmi_dev_xgmi_error_status(uint32_t dv_ind, rsmi_xgmi_status_t *status)
Retrieve the XGMI error status for a device.
rsmi_dev_xgmi_error_reset
rsmi_status_t rsmi_dev_xgmi_error_reset(uint32_t dv_ind)
Reset the XGMI error status for a device.
rsmi_dev_xgmi_hive_id_get
rsmi_status_t rsmi_dev_xgmi_hive_id_get(uint32_t dv_ind, uint64_t *hive_id)
Retrieve the XGMI hive id for a device.
rsmi_dev_memory_partition_get
rsmi_status_t rsmi_dev_memory_partition_get(uint32_t dv_ind, char *memory_partition, uint32_t len)
Retrieves the current memory partition for a desired device.
rsmi_dev_memory_partition_set
rsmi_status_t rsmi_dev_memory_partition_set(uint32_t dv_ind, rsmi_memory_partition_type_t memory_partition)
Modifies a selected device's current memory partition setting.
rsmi_dev_memory_partition_capabilities_get
rsmi_status_t rsmi_dev_memory_partition_capabilities_get(uint32_t dv_ind, char *memory_partition_caps, uint32_t len)
Retrieves the available memory partition capabilities for a desired device.
rsmi_activity_metric_t
rsmi_activity_metric_t
Activity (Utilization) Metrics. This enum is used to identify various activity metrics.
Definition: rocm_smi.h:488
RSMI_ACTIVITY_UMC
@ RSMI_ACTIVITY_UMC
memory controller
Definition: rocm_smi.h:491
RSMI_ACTIVITY_MM
@ RSMI_ACTIVITY_MM
UVD or VCN.
Definition: rocm_smi.h:492
rsmi_func_id_iter_handle_t
struct rsmi_func_id_iter_handle * rsmi_func_id_iter_handle_t
Opaque handle to function-support object.
Definition: rocm_smi.h:1255
rsmi_memory_page_status_t
rsmi_memory_page_status_t
Reserved Memory Page States.
Definition: rocm_smi.h:682
RSMI_MEM_PAGE_STATUS_UNRESERVABLE
@ RSMI_MEM_PAGE_STATUS_UNRESERVABLE
Unable to reserve this page.
Definition: rocm_smi.h:688
RSMI_MEM_PAGE_STATUS_PENDING
@ RSMI_MEM_PAGE_STATUS_PENDING
Definition: rocm_smi.h:685
RSMI_MEM_PAGE_STATUS_RESERVED
@ RSMI_MEM_PAGE_STATUS_RESERVED
Definition: rocm_smi.h:683
rsmi_status_t
rsmi_status_t
Error codes retured by rocm_smi_lib functions.
Definition: rocm_smi.h:88
RSMI_STATUS_UNEXPECTED_DATA
@ RSMI_STATUS_UNEXPECTED_DATA
Definition: rocm_smi.h:125
RSMI_STATUS_REFCOUNT_OVERFLOW
@ RSMI_STATUS_REFCOUNT_OVERFLOW
Definition: rocm_smi.h:130
RSMI_STATUS_NOT_FOUND
@ RSMI_STATUS_NOT_FOUND
Definition: rocm_smi.h:115
RSMI_STATUS_UNKNOWN_ERROR
@ RSMI_STATUS_UNKNOWN_ERROR
An unknown error occurred.
Definition: rocm_smi.h:138
RSMI_STATUS_INIT_ERROR
@ RSMI_STATUS_INIT_ERROR
Definition: rocm_smi.h:107
RSMI_STATUS_DRM_ERROR
@ RSMI_STATUS_DRM_ERROR
Error when call libdrm.
Definition: rocm_smi.h:136
RSMI_STATUS_SETTING_UNAVAILABLE
@ RSMI_STATUS_SETTING_UNAVAILABLE
Definition: rocm_smi.h:132
RSMI_STATUS_INSUFFICIENT_SIZE
@ RSMI_STATUS_INSUFFICIENT_SIZE
Definition: rocm_smi.h:117
RSMI_STATUS_INVALID_ARGS
@ RSMI_STATUS_INVALID_ARGS
Passed in arguments are not valid.
Definition: rocm_smi.h:90
RSMI_STATUS_NOT_SUPPORTED
@ RSMI_STATUS_NOT_SUPPORTED
Definition: rocm_smi.h:91
RSMI_STATUS_NO_DATA
@ RSMI_STATUS_NO_DATA
Definition: rocm_smi.h:123
RSMI_STATUS_UNEXPECTED_SIZE
@ RSMI_STATUS_UNEXPECTED_SIZE
Definition: rocm_smi.h:121
RSMI_STATUS_AMDGPU_RESTART_ERR
@ RSMI_STATUS_AMDGPU_RESTART_ERR
Definition: rocm_smi.h:134
RSMI_STATUS_FILE_ERROR
@ RSMI_STATUS_FILE_ERROR
Definition: rocm_smi.h:94
RSMI_STATUS_BUSY
@ RSMI_STATUS_BUSY
Definition: rocm_smi.h:127
RSMI_STATUS_NOT_YET_IMPLEMENTED
@ RSMI_STATUS_NOT_YET_IMPLEMENTED
Definition: rocm_smi.h:111
RSMI_STATUS_OUT_OF_RESOURCES
@ RSMI_STATUS_OUT_OF_RESOURCES
Definition: rocm_smi.h:102
RSMI_STATUS_INTERRUPT
@ RSMI_STATUS_INTERRUPT
Definition: rocm_smi.h:119
RSMI_STATUS_INTERNAL_EXCEPTION
@ RSMI_STATUS_INTERNAL_EXCEPTION
An internal exception was caught.
Definition: rocm_smi.h:104
RSMI_STATUS_SUCCESS
@ RSMI_STATUS_SUCCESS
Operation was successful.
Definition: rocm_smi.h:89
RSMI_STATUS_INPUT_OUT_OF_BOUNDS
@ RSMI_STATUS_INPUT_OUT_OF_BOUNDS
Definition: rocm_smi.h:105
RSMI_STATUS_PERMISSION
@ RSMI_STATUS_PERMISSION
Definition: rocm_smi.h:99
RSMI_UTILIZATION_COUNTER_TYPE
RSMI_UTILIZATION_COUNTER_TYPE
The utilization counter type.
Definition: rocm_smi.h:709
RSMI_COARSE_GRAIN_MEM_ACTIVITY
@ RSMI_COARSE_GRAIN_MEM_ACTIVITY
Memory Activity.
Definition: rocm_smi.h:713
RSMI_UTILIZATION_COUNTER_FIRST
@ RSMI_UTILIZATION_COUNTER_FIRST
GFX Activity.
Definition: rocm_smi.h:710
_RSMI_IO_LINK_TYPE
_RSMI_IO_LINK_TYPE
Types for IO Link.
Definition: rocm_smi.h:694
RSMI_IOLINK_TYPE_XGMI
@ RSMI_IOLINK_TYPE_XGMI
XGMI.
Definition: rocm_smi.h:697
RSMI_IOLINK_TYPE_UNDEFINED
@ RSMI_IOLINK_TYPE_UNDEFINED
unknown type.
Definition: rocm_smi.h:695
RSMI_IOLINK_TYPE_PCIEXPRESS
@ RSMI_IOLINK_TYPE_PCIEXPRESS
PCI Express.
Definition: rocm_smi.h:696
RSMI_IOLINK_TYPE_SIZE
@ RSMI_IOLINK_TYPE_SIZE
Max of IO Link types.
Definition: rocm_smi.h:699
RSMI_IOLINK_TYPE_NUMIOLINKTYPES
@ RSMI_IOLINK_TYPE_NUMIOLINKTYPES
Number of IO Link types.
Definition: rocm_smi.h:698
rsmi_sw_component_t
rsmi_sw_component_t
Available clock types.
Definition: rocm_smi.h:194
RSMI_SW_COMP_DRIVER
@ RSMI_SW_COMP_DRIVER
Driver.
Definition: rocm_smi.h:197
rsmi_event_group_t
rsmi_event_group_t
Enum denoting an event group. The value of the enum is the base value for all the event enums in the ...
Definition: rocm_smi.h:217
RSMI_EVNT_GRP_XGMI
@ RSMI_EVNT_GRP_XGMI
Data Fabric (XGMI) related events.
Definition: rocm_smi.h:218
RSMI_EVNT_GRP_XGMI_DATA_OUT
@ RSMI_EVNT_GRP_XGMI_DATA_OUT
XGMI Outbound data.
Definition: rocm_smi.h:219
MAX_EVENT_NOTIFICATION_MSG_SIZE
#define MAX_EVENT_NOTIFICATION_MSG_SIZE
Maximum number of characters an event notification message will be.
Definition: rocm_smi.h:340
RSMI_MAX_NUM_CLKS
#define RSMI_MAX_NUM_CLKS
This should match kRSMI_MAX_NUM_CLKS.
Definition: rocm_smi.h:960
RSMI_MAX_NUM_JPEG_ENGS
#define RSMI_MAX_NUM_JPEG_ENGS
This should match kRSMI_MAX_JPEG_ENGINES.
Definition: rocm_smi.h:955
rsmi_dev_perf_level_t
rsmi_dev_perf_level_t
PowerPlay performance levels.
Definition: rocm_smi.h:161
RSMI_DEV_PERF_LEVEL_LOW
@ RSMI_DEV_PERF_LEVEL_LOW
Definition: rocm_smi.h:165
RSMI_DEV_PERF_LEVEL_MANUAL
@ RSMI_DEV_PERF_LEVEL_MANUAL
Definition: rocm_smi.h:169
RSMI_DEV_PERF_LEVEL_STABLE_MIN_MCLK
@ RSMI_DEV_PERF_LEVEL_STABLE_MIN_MCLK
Definition: rocm_smi.h:174
RSMI_DEV_PERF_LEVEL_UNKNOWN
@ RSMI_DEV_PERF_LEVEL_UNKNOWN
Unknown performance level.
Definition: rocm_smi.h:182
RSMI_DEV_PERF_LEVEL_DETERMINISM
@ RSMI_DEV_PERF_LEVEL_DETERMINISM
Performance determinism state.
Definition: rocm_smi.h:178
RSMI_DEV_PERF_LEVEL_HIGH
@ RSMI_DEV_PERF_LEVEL_HIGH
Definition: rocm_smi.h:167
RSMI_DEV_PERF_LEVEL_STABLE_STD
@ RSMI_DEV_PERF_LEVEL_STABLE_STD
Definition: rocm_smi.h:171
RSMI_DEV_PERF_LEVEL_STABLE_PEAK
@ RSMI_DEV_PERF_LEVEL_STABLE_PEAK
Stable power state with peak clocks.
Definition: rocm_smi.h:173
RSMI_DEV_PERF_LEVEL_STABLE_MIN_SCLK
@ RSMI_DEV_PERF_LEVEL_STABLE_MIN_SCLK
Definition: rocm_smi.h:176
RSMI_DEV_PERF_LEVEL_AUTO
@ RSMI_DEV_PERF_LEVEL_AUTO
Performance level is "auto".
Definition: rocm_smi.h:162
rsmi_voltage_metric_t
rsmi_voltage_metric_t
Voltage Metrics. This enum is used to identify various Volatge metrics. Corresponding values will be ...
Definition: rocm_smi.h:501
RSMI_VOLT_LOWEST
@ RSMI_VOLT_LOWEST
Historical minimum voltage.
Definition: rocm_smi.h:510
RSMI_VOLT_MIN_CRIT
@ RSMI_VOLT_MIN_CRIT
Voltage critical min value.
Definition: rocm_smi.h:506
RSMI_VOLT_MAX_CRIT
@ RSMI_VOLT_MAX_CRIT
Voltage critical max value.
Definition: rocm_smi.h:508
RSMI_VOLT_CURRENT
@ RSMI_VOLT_CURRENT
Voltage current value.
Definition: rocm_smi.h:502
RSMI_VOLT_MIN
@ RSMI_VOLT_MIN
Voltage min value.
Definition: rocm_smi.h:507
RSMI_VOLT_AVERAGE
@ RSMI_VOLT_AVERAGE
Average voltage.
Definition: rocm_smi.h:509
RSMI_VOLT_MAX
@ RSMI_VOLT_MAX
Voltage max value.
Definition: rocm_smi.h:505
RSMI_VOLT_HIGHEST
@ RSMI_VOLT_HIGHEST
Historical maximum voltage.
Definition: rocm_smi.h:511
rsmi_evt_notification_type_t
rsmi_evt_notification_type_t
Definition: rocm_smi.h:315
RSMI_EVT_NOTIF_VMFAULT
@ RSMI_EVT_NOTIF_VMFAULT
VM page fault.
Definition: rocm_smi.h:317
RSMI_EVT_NOTIF_NONE
@ RSMI_EVT_NOTIF_NONE
Unused.
Definition: rocm_smi.h:316
RSMI_NUM_VOLTAGE_CURVE_POINTS
#define RSMI_NUM_VOLTAGE_CURVE_POINTS
The number of points that make up a voltage-frequency curve definition.
Definition: rocm_smi.h:82
RSMI_MAX_NUM_GFX_CLKS
#define RSMI_MAX_NUM_GFX_CLKS
This should match kRSMI_MAX_NUM_GFX_CLKS.
Definition: rocm_smi.h:970
rsmi_xgmi_status_t
rsmi_xgmi_status_t
XGMI Status.
Definition: rocm_smi.h:665
rsmi_compute_partition_type_t
rsmi_compute_partition_type_t
Compute Partition. This enum is used to identify various compute partitioning settings.
Definition: rocm_smi.h:377
RSMI_COMPUTE_PARTITION_SPX
@ RSMI_COMPUTE_PARTITION_SPX
Definition: rocm_smi.h:379
RSMI_COMPUTE_PARTITION_DPX
@ RSMI_COMPUTE_PARTITION_DPX
Definition: rocm_smi.h:381
RSMI_COMPUTE_PARTITION_QPX
@ RSMI_COMPUTE_PARTITION_QPX
Definition: rocm_smi.h:385
RSMI_COMPUTE_PARTITION_TPX
@ RSMI_COMPUTE_PARTITION_TPX
Definition: rocm_smi.h:383
RSMI_COMPUTE_PARTITION_CPX
@ RSMI_COMPUTE_PARTITION_CPX
Definition: rocm_smi.h:387
rsmi_voltage_type_t
rsmi_voltage_type_t
This ennumeration is used to indicate which type of voltage reading should be obtained.
Definition: rocm_smi.h:520
RSMI_VOLT_TYPE_VDDGFX
@ RSMI_VOLT_TYPE_VDDGFX
Definition: rocm_smi.h:523
RSMI_VOLT_TYPE_INVALID
@ RSMI_VOLT_TYPE_INVALID
Invalid type.
Definition: rocm_smi.h:526
rsmi_temperature_metric_t
rsmi_temperature_metric_t
Temperature Metrics. This enum is used to identify various temperature metrics. Corresponding values ...
Definition: rocm_smi.h:423
RSMI_TEMP_CURRENT
@ RSMI_TEMP_CURRENT
Temperature current value.
Definition: rocm_smi.h:424
RSMI_TEMP_LOWEST
@ RSMI_TEMP_LOWEST
Historical minimum temperature.
Definition: rocm_smi.h:455
RSMI_TEMP_CRIT_MIN
@ RSMI_TEMP_CRIT_MIN
Definition: rocm_smi.h:447
RSMI_TEMP_CRIT_MIN_HYST
@ RSMI_TEMP_CRIT_MIN_HYST
Definition: rocm_smi.h:450
RSMI_TEMP_MIN
@ RSMI_TEMP_MIN
Temperature min value.
Definition: rocm_smi.h:428
RSMI_TEMP_MAX
@ RSMI_TEMP_MAX
Temperature max value.
Definition: rocm_smi.h:427
RSMI_TEMP_EMERGENCY
@ RSMI_TEMP_EMERGENCY
Definition: rocm_smi.h:440
RSMI_TEMP_MAX_HYST
@ RSMI_TEMP_MAX_HYST
Definition: rocm_smi.h:429
RSMI_TEMP_MIN_HYST
@ RSMI_TEMP_MIN_HYST
Definition: rocm_smi.h:432
RSMI_TEMP_CRITICAL_HYST
@ RSMI_TEMP_CRITICAL_HYST
Definition: rocm_smi.h:437
RSMI_TEMP_EMERGENCY_HYST
@ RSMI_TEMP_EMERGENCY_HYST
Definition: rocm_smi.h:444
RSMI_TEMP_HIGHEST
@ RSMI_TEMP_HIGHEST
Historical maximum temperature.
Definition: rocm_smi.h:456
RSMI_TEMP_CRITICAL
@ RSMI_TEMP_CRITICAL
Definition: rocm_smi.h:435
RSMI_TEMP_OFFSET
@ RSMI_TEMP_OFFSET
Definition: rocm_smi.h:453
rsmi_ras_err_state_t
rsmi_ras_err_state_t
The current ECC state.
Definition: rocm_smi.h:588
RSMI_RAS_ERR_STATE_MULT_UC
@ RSMI_RAS_ERR_STATE_MULT_UC
Multiple uncorrectable errors.
Definition: rocm_smi.h:593
RSMI_RAS_ERR_STATE_POISON
@ RSMI_RAS_ERR_STATE_POISON
Definition: rocm_smi.h:594
RSMI_RAS_ERR_STATE_DISABLED
@ RSMI_RAS_ERR_STATE_DISABLED
ECC is disabled.
Definition: rocm_smi.h:590
RSMI_RAS_ERR_STATE_PARITY
@ RSMI_RAS_ERR_STATE_PARITY
ECC errors present, but type unknown.
Definition: rocm_smi.h:591
RSMI_RAS_ERR_STATE_SING_C
@ RSMI_RAS_ERR_STATE_SING_C
Single correctable error.
Definition: rocm_smi.h:592
RSMI_RAS_ERR_STATE_ENABLED
@ RSMI_RAS_ERR_STATE_ENABLED
ECC is enabled.
Definition: rocm_smi.h:596
RSMI_RAS_ERR_STATE_NONE
@ RSMI_RAS_ERR_STATE_NONE
No current errors.
Definition: rocm_smi.h:589
RSMI_NUM_HBM_INSTANCES
#define RSMI_NUM_HBM_INSTANCES
This should match kRSMI_MAX_NUM_HBM_INSTANCES.
Definition: rocm_smi.h:945
RSMI_MAX_NUM_XCC
#define RSMI_MAX_NUM_XCC
This should match kRSMI_MAX_NUM_XCC; XCC - Accelerated Compute Core, the collection of compute units,...
Definition: rocm_smi.h:981
rsmi_event_type_t
rsmi_event_type_t
Event type enum. Events belonging to a particular event group rsmi_event_group_t should begin enumera...
Definition: rocm_smi.h:229
RSMI_EVNT_XGMI_1_RESPONSE_TX
@ RSMI_EVNT_XGMI_1_RESPONSE_TX
Definition: rocm_smi.h:256
RSMI_EVNT_XGMI_DATA_OUT_5
@ RSMI_EVNT_XGMI_DATA_OUT_5
Outbound beats to neighbor 5.
Definition: rocm_smi.h:286
RSMI_EVNT_XGMI_1_BEATS_TX
@ RSMI_EVNT_XGMI_1_BEATS_TX
Definition: rocm_smi.h:258
RSMI_EVNT_XGMI_1_NOP_TX
@ RSMI_EVNT_XGMI_1_NOP_TX
NOPs sent to neighbor 1.
Definition: rocm_smi.h:253
RSMI_EVNT_XGMI_0_NOP_TX
@ RSMI_EVNT_XGMI_0_NOP_TX
NOPs sent to neighbor 0.
Definition: rocm_smi.h:233
RSMI_EVNT_XGMI_1_REQUEST_TX
@ RSMI_EVNT_XGMI_1_REQUEST_TX
neighbor 1
Definition: rocm_smi.h:254
RSMI_EVNT_XGMI_DATA_OUT_3
@ RSMI_EVNT_XGMI_DATA_OUT_3
Outbound beats to neighbor 3.
Definition: rocm_smi.h:284
RSMI_EVNT_XGMI_DATA_OUT_4
@ RSMI_EVNT_XGMI_DATA_OUT_4
Outbound beats to neighbor 4.
Definition: rocm_smi.h:285
RSMI_EVNT_XGMI_DATA_OUT_2
@ RSMI_EVNT_XGMI_DATA_OUT_2
Outbound beats to neighbor 2.
Definition: rocm_smi.h:283
RSMI_EVNT_XGMI_0_RESPONSE_TX
@ RSMI_EVNT_XGMI_0_RESPONSE_TX
Definition: rocm_smi.h:236
RSMI_EVNT_XGMI_DATA_OUT_1
@ RSMI_EVNT_XGMI_DATA_OUT_1
Outbound beats to neighbor 1.
Definition: rocm_smi.h:282
RSMI_EVNT_XGMI_0_BEATS_TX
@ RSMI_EVNT_XGMI_0_BEATS_TX
Data beats sent to neighbor 0; Each beat represents 32 bytes.
Definition: rocm_smi.h:252
RSMI_EVNT_XGMI_0_REQUEST_TX
@ RSMI_EVNT_XGMI_0_REQUEST_TX
Definition: rocm_smi.h:234
rsmi_freq_ind_t
rsmi_freq_ind_t
The values of this enum are used as frequency identifiers.
Definition: rocm_smi.h:618
RSMI_FREQ_IND_MAX
@ RSMI_FREQ_IND_MAX
Index used for the maximum frequency value.
Definition: rocm_smi.h:620
RSMI_FREQ_IND_MIN
@ RSMI_FREQ_IND_MIN
Index used for the minimum frequency value.
Definition: rocm_smi.h:619
RSMI_FREQ_IND_INVALID
@ RSMI_FREQ_IND_INVALID
An invalid frequency index.
Definition: rocm_smi.h:621
rsmi_memory_type_t
rsmi_memory_type_t
Types of memory.
Definition: rocm_smi.h:605
RSMI_MEM_TYPE_VRAM
@ RSMI_MEM_TYPE_VRAM
VRAM memory.
Definition: rocm_smi.h:608
RSMI_MEM_TYPE_GTT
@ RSMI_MEM_TYPE_GTT
GTT memory.
Definition: rocm_smi.h:610
RSMI_MEM_TYPE_VIS_VRAM
@ RSMI_MEM_TYPE_VIS_VRAM
VRAM memory that is visible.
Definition: rocm_smi.h:609
rsmi_power_profile_preset_masks_t
rsmi_power_profile_preset_masks_t
Pre-set Profile Selections. These bitmasks can be AND'd with the rsmi_power_profile_status_t....
Definition: rocm_smi.h:535
RSMI_PWR_PROF_PRST_LAST
@ RSMI_PWR_PROF_PRST_LAST
Invalid power profile.
Definition: rocm_smi.h:545
RSMI_PWR_PROF_PRST_VIDEO_MASK
@ RSMI_PWR_PROF_PRST_VIDEO_MASK
Video Power Profile.
Definition: rocm_smi.h:537
RSMI_PWR_PROF_PRST_VR_MASK
@ RSMI_PWR_PROF_PRST_VR_MASK
VR Power Profile.
Definition: rocm_smi.h:540
RSMI_PWR_PROF_PRST_CUSTOM_MASK
@ RSMI_PWR_PROF_PRST_CUSTOM_MASK
Custom Power Profile.
Definition: rocm_smi.h:536
RSMI_PWR_PROF_PRST_POWER_SAVING_MASK
@ RSMI_PWR_PROF_PRST_POWER_SAVING_MASK
Power Saving Profile.
Definition: rocm_smi.h:538
RSMI_PWR_PROF_PRST_COMPUTE_MASK
@ RSMI_PWR_PROF_PRST_COMPUTE_MASK
Compute Saving Profile.
Definition: rocm_smi.h:539
RSMI_PWR_PROF_PRST_BOOTUP_DEFAULT
@ RSMI_PWR_PROF_PRST_BOOTUP_DEFAULT
Default Boot Up Profile.
Definition: rocm_smi.h:544
rsmi_gpu_block_t
rsmi_gpu_block_t
This enum is used to identify different GPU blocks.
Definition: rocm_smi.h:557
RSMI_GPU_BLOCK_SMN
@ RSMI_GPU_BLOCK_SMN
SMN block.
Definition: rocm_smi.h:571
RSMI_GPU_BLOCK_ATHUB
@ RSMI_GPU_BLOCK_ATHUB
ATHUB block.
Definition: rocm_smi.h:566
RSMI_GPU_BLOCK_GFX
@ RSMI_GPU_BLOCK_GFX
GFX block.
Definition: rocm_smi.h:564
RSMI_GPU_BLOCK_MMHUB
@ RSMI_GPU_BLOCK_MMHUB
MMHUB block.
Definition: rocm_smi.h:565
RSMI_GPU_BLOCK_FUSE
@ RSMI_GPU_BLOCK_FUSE
Fuse block.
Definition: rocm_smi.h:575
RSMI_GPU_BLOCK_HDP
@ RSMI_GPU_BLOCK_HDP
HDP block.
Definition: rocm_smi.h:568
RSMI_GPU_BLOCK_DF
@ RSMI_GPU_BLOCK_DF
DF block.
Definition: rocm_smi.h:570
RSMI_GPU_BLOCK_SEM
@ RSMI_GPU_BLOCK_SEM
SEM block.
Definition: rocm_smi.h:572
RSMI_GPU_BLOCK_INVALID
@ RSMI_GPU_BLOCK_INVALID
Definition: rocm_smi.h:558
RSMI_GPU_BLOCK_MP1
@ RSMI_GPU_BLOCK_MP1
MP1 block.
Definition: rocm_smi.h:574
RSMI_GPU_BLOCK_XGMI_WAFL
@ RSMI_GPU_BLOCK_XGMI_WAFL
XGMI block.
Definition: rocm_smi.h:569
RSMI_GPU_BLOCK_UMC
@ RSMI_GPU_BLOCK_UMC
UMC block.
Definition: rocm_smi.h:562
RSMI_GPU_BLOCK_LAST
@ RSMI_GPU_BLOCK_LAST
for supported blocks
Definition: rocm_smi.h:577
RSMI_GPU_BLOCK_PCIE_BIF
@ RSMI_GPU_BLOCK_PCIE_BIF
PCIE_BIF block.
Definition: rocm_smi.h:567
RSMI_GPU_BLOCK_MP0
@ RSMI_GPU_BLOCK_MP0
MP0 block.
Definition: rocm_smi.h:573
RSMI_GPU_BLOCK_SDMA
@ RSMI_GPU_BLOCK_SDMA
SDMA block.
Definition: rocm_smi.h:563
RSMI_MAX_NUM_VCNS
#define RSMI_MAX_NUM_VCNS
This should match kRSMI_MAX_NUM_VCNS.
Definition: rocm_smi.h:950
rsmi_fw_block_t
rsmi_fw_block_t
The values of this enum are used to identify the various firmware blocks.
Definition: rocm_smi.h:632
rsmi_init_flags_t
rsmi_init_flags_t
Initialization flags.
Definition: rocm_smi.h:147
RSMI_INIT_FLAG_RESRV_TEST1
@ RSMI_INIT_FLAG_RESRV_TEST1
Reserved for test.
Definition: rocm_smi.h:155
RSMI_INIT_FLAG_THRAD_ONLY_MUTEX
@ RSMI_INIT_FLAG_THRAD_ONLY_MUTEX
The mutex limit to thread.
Definition: rocm_smi.h:154
RSMI_INIT_FLAG_ALL_GPUS
@ RSMI_INIT_FLAG_ALL_GPUS
Definition: rocm_smi.h:148
RSMI_IO_LINK_TYPE
enum _RSMI_IO_LINK_TYPE RSMI_IO_LINK_TYPE
Types for IO Link.
RSMI_MAX_NUM_FREQUENCIES
#define RSMI_MAX_NUM_FREQUENCIES
Definition: rocm_smi.h:75
RSMI_MAX_NUM_XGMI_LINKS
#define RSMI_MAX_NUM_XGMI_LINKS
This should match kRSMI_MAX_NUM_XGMI_LINKS.
Definition: rocm_smi.h:965
rsmi_event_handle_t
uintptr_t rsmi_event_handle_t
Handle to performance event counter.
Definition: rocm_smi.h:209
rsmi_counter_command_t
rsmi_counter_command_t
Definition: rocm_smi.h:295
RSMI_CNTR_CMD_START
@ RSMI_CNTR_CMD_START
Start the counter.
Definition: rocm_smi.h:296
RSMI_CNTR_CMD_STOP
@ RSMI_CNTR_CMD_STOP
Definition: rocm_smi.h:297
rsmi_bit_field_t
uint64_t rsmi_bit_field_t
Bitfield used in various RSMI calls.
Definition: rocm_smi.h:674
RSMI_MAX_NUM_XCP
#define RSMI_MAX_NUM_XCP
This should match kRSMI_MAX_NUM_XCP; XCP - Accelerated Compute Processor, also referred to as the Gra...
Definition: rocm_smi.h:993
rsmi_clk_type_t
rsmi_clk_type_t
Definition: rocm_smi.h:354
RSMI_CLK_TYPE_MEM
@ RSMI_CLK_TYPE_MEM
Memory clock.
Definition: rocm_smi.h:361
RSMI_CLK_TYPE_DCEF
@ RSMI_CLK_TYPE_DCEF
Display Controller Engine clock.
Definition: rocm_smi.h:359
RSMI_CLK_TYPE_PCIE
@ RSMI_CLK_TYPE_PCIE
PCIE clock.
Definition: rocm_smi.h:362
RSMI_CLK_TYPE_SOC
@ RSMI_CLK_TYPE_SOC
SOC clock.
Definition: rocm_smi.h:360
RSMI_CLK_TYPE_DF
@ RSMI_CLK_TYPE_DF
Definition: rocm_smi.h:357
RSMI_CLK_TYPE_SYS
@ RSMI_CLK_TYPE_SYS
System clock.
Definition: rocm_smi.h:355
rsmi_memory_partition_type_t
rsmi_memory_partition_type_t
Memory Partitions. This enum is used to identify various memory partition types.
Definition: rocm_smi.h:398
RSMI_MEMORY_PARTITION_NPS8
@ RSMI_MEMORY_PARTITION_NPS8
Definition: rocm_smi.h:408
RSMI_MEMORY_PARTITION_NPS4
@ RSMI_MEMORY_PARTITION_NPS4
Definition: rocm_smi.h:405
RSMI_MEMORY_PARTITION_NPS2
@ RSMI_MEMORY_PARTITION_NPS2
Definition: rocm_smi.h:402
RSMI_MEMORY_PARTITION_NPS1
@ RSMI_MEMORY_PARTITION_NPS1
Definition: rocm_smi.h:400
rsmi_func_id_value_t
union id rsmi_func_id_value_t
This union holds the value of an rsmi_func_id_iter_handle_t. The value may be a function name,...
RSMI_POWER_TYPE
RSMI_POWER_TYPE
Power types.
Definition: rocm_smi.h:720
RSMI_AVERAGE_POWER
@ RSMI_AVERAGE_POWER
Average Power.
Definition: rocm_smi.h:721
RSMI_INVALID_POWER
@ RSMI_INVALID_POWER
Invalid / Undetected Power.
Definition: rocm_smi.h:723
RSMI_CURRENT_POWER
@ RSMI_CURRENT_POWER
Current / Instant Power.
Definition: rocm_smi.h:722
rsmi_temperature_type_t
rsmi_temperature_type_t
This enumeration is used to indicate from which part of the device a temperature reading should be ob...
Definition: rocm_smi.h:468
RSMI_TEMP_TYPE_HBM_2
@ RSMI_TEMP_TYPE_HBM_2
HBM temperature instance 2.
Definition: rocm_smi.h:477
RSMI_TEMP_TYPE_HBM_0
@ RSMI_TEMP_TYPE_HBM_0
HBM temperature instance 0.
Definition: rocm_smi.h:475
RSMI_TEMP_TYPE_HBM_1
@ RSMI_TEMP_TYPE_HBM_1
HBM temperature instance 1.
Definition: rocm_smi.h:476
RSMI_TEMP_TYPE_MEMORY
@ RSMI_TEMP_TYPE_MEMORY
VRAM temperature.
Definition: rocm_smi.h:474
RSMI_TEMP_TYPE_INVALID
@ RSMI_TEMP_TYPE_INVALID
Invalid type.
Definition: rocm_smi.h:480
RSMI_TEMP_TYPE_EDGE
@ RSMI_TEMP_TYPE_EDGE
Edge GPU temperature.
Definition: rocm_smi.h:471
RSMI_TEMP_TYPE_JUNCTION
@ RSMI_TEMP_TYPE_JUNCTION
Definition: rocm_smi.h:472
RSMI_TEMP_TYPE_HBM_3
@ RSMI_TEMP_TYPE_HBM_3
HBM temperature instance 3.
Definition: rocm_smi.h:478
amdgpu_xcp_metrics_t
The following structures hold the gpu statistics for a device.
Definition: rocm_smi.h:998
metrics_table_header_t
The following structures hold the gpu metrics values for a device.
Definition: rocm_smi.h:924
rsmi_activity_metric_counter_t
This structure holds information about the possible activity averages. Specifically,...
Definition: rocm_smi.h:828
rsmi_activity_metric_counter_t::average_mm_activity
uint16_t average_mm_activity
UVD or VCN.
Definition: rocm_smi.h:832
rsmi_activity_metric_counter_t::average_gfx_activity
uint16_t average_gfx_activity
Average graphics activity.
Definition: rocm_smi.h:830
rsmi_activity_metric_counter_t::average_umc_activity
uint16_t average_umc_activity
memory controller
Definition: rocm_smi.h:831
rsmi_counter_value_t
Definition: rocm_smi.h:304
rsmi_counter_value_t::value
uint64_t value
Counter value.
Definition: rocm_smi.h:305
rsmi_counter_value_t::time_enabled
uint64_t time_enabled
Definition: rocm_smi.h:306
rsmi_counter_value_t::time_running
uint64_t time_running
Definition: rocm_smi.h:308
rsmi_error_count_t
This structure holds error counts.
Definition: rocm_smi.h:1233
rsmi_error_count_t::correctable_err
uint64_t correctable_err
Accumulated correctable errors.
Definition: rocm_smi.h:1234
rsmi_error_count_t::uncorrectable_err
uint64_t uncorrectable_err
Accumulated uncorrectable errors.
Definition: rocm_smi.h:1235
rsmi_evt_notification_data_t
Definition: rocm_smi.h:345
rsmi_evt_notification_data_t::event
rsmi_evt_notification_type_t event
Event type.
Definition: rocm_smi.h:347
rsmi_evt_notification_data_t::dv_ind
uint32_t dv_ind
Index of device that corresponds to the event.
Definition: rocm_smi.h:346
rsmi_freq_volt_region_t
This structure holds 2 rsmi_range_t's, one for frequency and one for voltage. These 2 ranges indicate...
Definition: rocm_smi.h:874
rsmi_freq_volt_region_t::volt_range
rsmi_range_t volt_range
The voltage range for this VDDC Curve point.
Definition: rocm_smi.h:876
rsmi_freq_volt_region_t::freq_range
rsmi_range_t freq_range
The frequency range for this VDDC Curve point.
Definition: rocm_smi.h:875
rsmi_frequencies_t
This structure holds information about clock frequencies.
Definition: rocm_smi.h:776
rsmi_frequencies_t::current
uint32_t current
Definition: rocm_smi.h:790
rsmi_frequencies_t::num_supported
uint32_t num_supported
Definition: rocm_smi.h:785
rsmi_frequencies_t::has_deep_sleep
bool has_deep_sleep
Definition: rocm_smi.h:780
rsmi_gpu_metrics_t
Definition: rocm_smi.h:1017
rsmi_od_vddc_point_t
This structure represents a point on the frequency-voltage plane.
Definition: rocm_smi.h:861
rsmi_od_vddc_point_t::frequency
uint64_t frequency
Frequency coordinate (in Hz)
Definition: rocm_smi.h:862
rsmi_od_vddc_point_t::voltage
uint64_t voltage
Voltage coordinate (in mV)
Definition: rocm_smi.h:863
rsmi_od_volt_curve_t
Definition: rocm_smi.h:885
rsmi_od_volt_freq_data_t
This structure holds the frequency-voltage values for a device.
Definition: rocm_smi.h:899
rsmi_od_volt_freq_data_t::mclk_freq_limits
rsmi_range_t mclk_freq_limits
The range possible of MCLK values.
Definition: rocm_smi.h:904
rsmi_od_volt_freq_data_t::num_regions
uint32_t num_regions
The number of voltage curve regions.
Definition: rocm_smi.h:910
rsmi_od_volt_freq_data_t::curr_mclk_range
rsmi_range_t curr_mclk_range
Definition: rocm_smi.h:901
rsmi_od_volt_freq_data_t::sclk_freq_limits
rsmi_range_t sclk_freq_limits
The range possible of SCLK values.
Definition: rocm_smi.h:903
rsmi_od_volt_freq_data_t::curr_sclk_range
rsmi_range_t curr_sclk_range
The current SCLK frequency range.
Definition: rocm_smi.h:900
rsmi_od_volt_freq_data_t::curve
rsmi_od_volt_curve_t curve
The current voltage curve.
Definition: rocm_smi.h:909
rsmi_pcie_bandwidth_t
This structure holds information about the possible PCIe bandwidths. Specifically,...
Definition: rocm_smi.h:807
rsmi_pcie_bandwidth_t::transfer_rate
rsmi_frequencies_t transfer_rate
Definition: rocm_smi.h:811
rsmi_power_profile_status_t
This structure contains information about which power profiles are supported by the system for a give...
Definition: rocm_smi.h:753
rsmi_power_profile_status_t::num_profiles
uint32_t num_profiles
Definition: rocm_smi.h:767
rsmi_power_profile_status_t::available_profiles
rsmi_bit_field_t available_profiles
Definition: rocm_smi.h:757
rsmi_power_profile_status_t::current
rsmi_power_profile_preset_masks_t current
Definition: rocm_smi.h:762
rsmi_process_info_t
This structure contains information specific to a process.
Definition: rocm_smi.h:1241
rsmi_process_info_t::cu_occupancy
uint32_t cu_occupancy
Compute Unit usage in percent.
Definition: rocm_smi.h:1246
rsmi_process_info_t::pasid
uint32_t pasid
PASID.
Definition: rocm_smi.h:1243
rsmi_process_info_t::process_id
uint32_t process_id
Process ID.
Definition: rocm_smi.h:1242
rsmi_process_info_t::sdma_usage
uint64_t sdma_usage
SDMA usage in microseconds.
Definition: rocm_smi.h:1245
rsmi_process_info_t::vram_usage
uint64_t vram_usage
VRAM usage.
Definition: rocm_smi.h:1244
rsmi_range_t
This structure represents a range (e.g., frequencies or voltages).
Definition: rocm_smi.h:850
rsmi_range_t::upper_bound
uint64_t upper_bound
Upper bound of range.
Definition: rocm_smi.h:852
rsmi_range_t::lower_bound
uint64_t lower_bound
Lower bound of range.
Definition: rocm_smi.h:851
rsmi_retired_page_record_t
Reserved Memory Page Record.
Definition: rocm_smi.h:737
rsmi_retired_page_record_t::page_size
uint64_t page_size
Page size.
Definition: rocm_smi.h:739
rsmi_retired_page_record_t::status
rsmi_memory_page_status_t status
Page "reserved" status.
Definition: rocm_smi.h:740
rsmi_retired_page_record_t::page_address
uint64_t page_address
Start address of page.
Definition: rocm_smi.h:738
rsmi_utilization_counter_t
The utilization counter data.
Definition: rocm_smi.h:729
rsmi_utilization_counter_t::type
RSMI_UTILIZATION_COUNTER_TYPE type
Utilization counter type.
Definition: rocm_smi.h:730
rsmi_utilization_counter_t::value
uint64_t value
Utilization counter value.
Definition: rocm_smi.h:731
rsmi_version_t
This structure holds version information.
Definition: rocm_smi.h:838
rsmi_version_t::patch
uint32_t patch
Patch, build or stepping version.
Definition: rocm_smi.h:841
rsmi_version_t::build
const char * build
Build string.
Definition: rocm_smi.h:842
rsmi_version_t::minor
uint32_t minor
Minor version.
Definition: rocm_smi.h:840
rsmi_version_t::major
uint32_t major
Major version.
Definition: rocm_smi.h:839
id
This union holds the value of an rsmi_func_id_iter_handle_t. The value may be a function name,...
Definition: rocm_smi.h:1266
id::temp_metric
rsmi_temperature_metric_t temp_metric
Definition: rocm_smi.h:1273
id::memory_type
rsmi_memory_type_t memory_type
Definition: rocm_smi.h:1271
id::evnt_group
rsmi_event_group_t evnt_group
Definition: rocm_smi.h:1277
id::clk_type
rsmi_clk_type_t clk_type
Definition: rocm_smi.h:1279
id::id
uint64_t id
uint64_t representation of value
Definition: rocm_smi.h:1267
id::evnt_type
rsmi_event_type_t evnt_type
Definition: rocm_smi.h:1275
id::gpu_block_type
rsmi_gpu_block_t gpu_block_type
Definition: rocm_smi.h:1283
id::fw_block
rsmi_fw_block_t fw_block
Definition: rocm_smi.h:1281
id::name
const char * name
name string (applicable to functions only)
Definition: rocm_smi.h:1268