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-2025, 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 // NOTICE: ROCm-SMI is fully deprecated as of ROCm 10.1; only critical bug
48 // fixes will be applied. Please switch to AMD-SMI
49 // (https://github.com/ROCm/amdsmi) for continued support.
50 #pragma message( \
51  " ROCm-SMI is fully deprecated as of ROCm 10.1 (https://rocm.blogs.amd.com/ecosystems-and-partners/rocm-10.1-blog/README.html). Please switch to AMD-SMI (https://github.com/ROCm/amdsmi).")
52 
53 #ifdef __cplusplus
54 extern "C" {
55 #include <cstdint>
56 #else
57 #include <stdint.h>
58 #endif // __cplusplus
59 
60 #include <stdbool.h>
61 #include <stddef.h>
62 
63 #include "rocm_smi/kfd_ioctl.h"
64 
80 #define RSMI_MAX_NUM_FREQUENCIES 33
81 
84 #define RSMI_MAX_FAN_SPEED 255
85 
87 #define RSMI_NUM_VOLTAGE_CURVE_POINTS 3
88 
92 typedef enum {
114  RSMI_INITIALIZATION_ERROR = RSMI_STATUS_INIT_ERROR,
143 
145 } rsmi_status_t;
146 
153 typedef enum {
160  RSMI_INIT_FLAG_THRAD_ONLY_MUTEX = 0x400000000000000,
161  RSMI_INIT_FLAG_RESRV_TEST1 = 0x800000000000000,
163 
167 typedef enum {
169  RSMI_DEV_PERF_LEVEL_FIRST = RSMI_DEV_PERF_LEVEL_AUTO,
170 
185 
186  RSMI_DEV_PERF_LEVEL_LAST = RSMI_DEV_PERF_LEVEL_DETERMINISM,
187 
191 typedef rsmi_dev_perf_level_t rsmi_dev_perf_level;
193 
200 typedef enum {
201  RSMI_SW_COMP_FIRST = 0x0,
202 
203  RSMI_SW_COMP_DRIVER = RSMI_SW_COMP_FIRST,
204 
205  RSMI_SW_COMP_LAST = RSMI_SW_COMP_DRIVER
207 
215 typedef uintptr_t rsmi_event_handle_t;
216 
223 typedef enum {
226  RSMI_EVNT_GRP_INVALID = 0xFFFFFFFF
228 
235 typedef enum {
236  RSMI_EVNT_FIRST = RSMI_EVNT_GRP_XGMI,
237 
238  RSMI_EVNT_XGMI_FIRST = RSMI_EVNT_GRP_XGMI,
239  RSMI_EVNT_XGMI_0_NOP_TX = RSMI_EVNT_XGMI_FIRST,
244 
257  // ie, Throughput = BEATS/time_running 10^9 bytes/sec
267 
268  RSMI_EVNT_XGMI_LAST = RSMI_EVNT_XGMI_1_BEATS_TX, // 5
269 
270  RSMI_EVNT_XGMI_DATA_OUT_FIRST = RSMI_EVNT_GRP_XGMI_DATA_OUT, // 10
271 
272  /*
273  * @brief Events in the RSMI_EVNT_GRP_XGMI_DATA_OUT group measure
274  * the number of beats sent on an XGMI link. Each beat represents
275  * 32 bytes. RSMI_EVNT_XGMI_DATA_OUT_n represents the number of
276  * outbound beats (each representing 32 bytes) on link n.<br><br>
277  *
278  * XGMI throughput can be calculated by multiplying a event
279  * such as ::RSMI_EVNT_XGMI_DATA_OUT_n by 32 and dividing by
280  * the time for which event collection occurred,
281  * ::rsmi_counter_value_t.time_running (which is in nanoseconds). To get
282  * bytes per second, multiply this value by 10<sup>9</sup>.<br>
283  * <br>
284  * Throughput = BEATS/time_running * 10<sup>9</sup> (bytes/second)<br>
285  */
286  // ie, Throughput = BEATS/time_running 10^9 bytes/sec
287  RSMI_EVNT_XGMI_DATA_OUT_0 = RSMI_EVNT_XGMI_DATA_OUT_FIRST,
293  RSMI_EVNT_XGMI_DATA_OUT_LAST = RSMI_EVNT_XGMI_DATA_OUT_5,
294 
295  RSMI_EVNT_LAST = RSMI_EVNT_XGMI_DATA_OUT_LAST,
297 
301 typedef enum {
306 
310 typedef struct {
311  uint64_t value;
312  uint64_t time_enabled;
314  uint64_t time_running;
317 
321 typedef enum {
322  RSMI_EVT_NOTIF_NONE = KFD_SMI_EVENT_NONE,
323  RSMI_EVT_NOTIF_VMFAULT = KFD_SMI_EVENT_VMFAULT,
324  RSMI_EVT_NOTIF_FIRST = RSMI_EVT_NOTIF_VMFAULT,
325  RSMI_EVT_NOTIF_THERMAL_THROTTLE = KFD_SMI_EVENT_THERMAL_THROTTLE,
326  RSMI_EVT_NOTIF_GPU_PRE_RESET = KFD_SMI_EVENT_GPU_PRE_RESET,
327  RSMI_EVT_NOTIF_GPU_POST_RESET = KFD_SMI_EVENT_GPU_POST_RESET,
328  RSMI_EVT_NOTIF_EVENT_MIGRATE_START = KFD_SMI_EVENT_MIGRATE_START,
329  RSMI_EVT_NOTIF_EVENT_MIGRATE_END = KFD_SMI_EVENT_MIGRATE_END,
330  RSMI_EVT_NOTIF_EVENT_PAGE_FAULT_START = KFD_SMI_EVENT_PAGE_FAULT_START,
331  RSMI_EVT_NOTIF_EVENT_PAGE_FAULT_END = KFD_SMI_EVENT_PAGE_FAULT_END,
332  RSMI_EVT_NOTIF_EVENT_QUEUE_EVICTION = KFD_SMI_EVENT_QUEUE_EVICTION,
333  RSMI_EVT_NOTIF_EVENT_QUEUE_RESTORE = KFD_SMI_EVENT_QUEUE_RESTORE,
334  RSMI_EVT_NOTIF_EVENT_UNMAP_FROM_GPU = KFD_SMI_EVENT_UNMAP_FROM_GPU,
335  RSMI_EVT_NOTIF_EVENT_ALL_PROCESS = KFD_SMI_EVENT_ALL_PROCESS,
336  RSMI_EVT_NOTIF_LAST = KFD_SMI_EVENT_ALL_PROCESS
338 
342 #define RSMI_EVENT_MASK_FROM_INDEX(i) (1ULL << ((i) - 1))
343 
345 // matches kfd message max size
346 #define MAX_EVENT_NOTIFICATION_MSG_SIZE 96
347 
351 typedef struct {
352  uint32_t dv_ind;
356 
360 typedef enum {
362  RSMI_CLK_TYPE_FIRST = RSMI_CLK_TYPE_SYS,
369 
370  // Add new clocks to the end (not in the middle) and update
371  // RSMI_CLK_TYPE_LAST
372  RSMI_CLK_TYPE_LAST = RSMI_CLK_TYPE_MEM,
373  RSMI_CLK_INVALID = 0xFFFFFFFF
376 typedef rsmi_clk_type_t rsmi_clk_type;
378 
383 typedef enum {
384  RSMI_COMPUTE_PARTITION_INVALID = 0,
397 typedef rsmi_compute_partition_type_t rsmi_compute_partition_type;
399 
404 typedef enum {
405  RSMI_MEMORY_PARTITION_UNKNOWN = 0,
421 typedef rsmi_memory_partition_type_t rsmi_memory_partition_type;
423 
429 typedef enum {
431  RSMI_TEMP_FIRST = RSMI_TEMP_CURRENT,
432 
463 
464  RSMI_TEMP_LAST = RSMI_TEMP_HIGHEST
467 typedef rsmi_temperature_metric_t rsmi_temperature_metric;
469 
474 typedef enum {
475  RSMI_TEMP_TYPE_FIRST = 0,
476 
477  RSMI_TEMP_TYPE_EDGE = RSMI_TEMP_TYPE_FIRST,
485  RSMI_TEMP_TYPE_LAST = RSMI_TEMP_TYPE_HBM_3,
486  RSMI_TEMP_TYPE_INVALID = 0xFFFFFFFF
488 
494 typedef enum {
495  /* Utilization */
496  RSMI_ACTIVITY_GFX = (0x1 << 0),
497  RSMI_ACTIVITY_UMC = (0x1 << 1),
498  RSMI_ACTIVITY_MM = (0x1 << 2)
500 
506 typedef enum {
508 
509  RSMI_VOLT_FIRST = RSMI_VOLT_CURRENT,
517 
518  RSMI_VOLT_LAST = RSMI_VOLT_HIGHEST
520 
525 typedef enum {
526  RSMI_VOLT_TYPE_FIRST = 0,
527 
528  RSMI_VOLT_TYPE_VDDGFX = RSMI_VOLT_TYPE_FIRST,
530 
531  RSMI_VOLT_TYPE_LAST = RSMI_VOLT_TYPE_VDDBOARD,
532  RSMI_VOLT_TYPE_INVALID = 0xFFFFFFFF
534 
541 typedef enum {
547 
549  RSMI_PWR_PROF_PRST_3D_FULL_SCR_MASK = 0x20,
552 
554  RSMI_PWR_PROF_PRST_INVALID = 0xFFFFFFFFFFFFFFFF
557 typedef rsmi_power_profile_preset_masks_t rsmi_power_profile_preset_masks;
559 
563 typedef enum {
564  RSMI_GPU_BLOCK_INVALID = 0x0000000000000000,
566  RSMI_GPU_BLOCK_FIRST = 0x0000000000000001,
567 
568  RSMI_GPU_BLOCK_UMC = RSMI_GPU_BLOCK_FIRST,
569  RSMI_GPU_BLOCK_SDMA = 0x0000000000000002,
570  RSMI_GPU_BLOCK_GFX = 0x0000000000000004,
571  RSMI_GPU_BLOCK_MMHUB = 0x0000000000000008,
572  RSMI_GPU_BLOCK_ATHUB = 0x0000000000000010,
573  RSMI_GPU_BLOCK_PCIE_BIF = 0x0000000000000020,
574  RSMI_GPU_BLOCK_HDP = 0x0000000000000040,
575  RSMI_GPU_BLOCK_XGMI_WAFL = 0x0000000000000080,
576  RSMI_GPU_BLOCK_DF = 0x0000000000000100,
577  RSMI_GPU_BLOCK_SMN = 0x0000000000000200,
578  RSMI_GPU_BLOCK_SEM = 0x0000000000000400,
579  RSMI_GPU_BLOCK_MP0 = 0x0000000000000800,
580  RSMI_GPU_BLOCK_MP1 = 0x0000000000001000,
581  RSMI_GPU_BLOCK_FUSE = 0x0000000000002000,
582 
585  RSMI_GPU_BLOCK_RESERVED = 0x8000000000000000
588 typedef rsmi_gpu_block_t rsmi_gpu_block;
590 
594 typedef enum {
603 
604  RSMI_RAS_ERR_STATE_LAST = RSMI_RAS_ERR_STATE_ENABLED,
605  RSMI_RAS_ERR_STATE_INVALID = 0xFFFFFFFF
607 
611 typedef enum {
612  RSMI_MEM_TYPE_FIRST = 0,
613 
614  RSMI_MEM_TYPE_VRAM = RSMI_MEM_TYPE_FIRST,
617 
618  RSMI_MEM_TYPE_LAST = RSMI_MEM_TYPE_GTT
620 
624 typedef enum {
627  RSMI_FREQ_IND_INVALID = 0xFFFFFFFF
630 typedef rsmi_freq_ind_t rsmi_freq_ind;
632 
637 typedef enum {
638  RSMI_FW_BLOCK_FIRST = 0,
639 
640  RSMI_FW_BLOCK_ASD = RSMI_FW_BLOCK_FIRST,
641  RSMI_FW_BLOCK_CE,
642  RSMI_FW_BLOCK_DMCU,
643  RSMI_FW_BLOCK_MC,
644  RSMI_FW_BLOCK_ME,
645  RSMI_FW_BLOCK_MEC,
646  RSMI_FW_BLOCK_MEC2,
647  RSMI_FW_BLOCK_MES,
648  RSMI_FW_BLOCK_MES_KIQ,
649  RSMI_FW_BLOCK_PFP,
650  RSMI_FW_BLOCK_RLC,
651  RSMI_FW_BLOCK_RLC_SRLC,
652  RSMI_FW_BLOCK_RLC_SRLG,
653  RSMI_FW_BLOCK_RLC_SRLS,
654  RSMI_FW_BLOCK_SDMA,
655  RSMI_FW_BLOCK_SDMA2,
656  RSMI_FW_BLOCK_SMC,
657  RSMI_FW_BLOCK_SOS,
658  RSMI_FW_BLOCK_TA_RAS,
659  RSMI_FW_BLOCK_TA_XGMI,
660  RSMI_FW_BLOCK_UVD,
661  RSMI_FW_BLOCK_VCE,
662  RSMI_FW_BLOCK_VCN,
663 
664  RSMI_FW_BLOCK_LAST = RSMI_FW_BLOCK_VCN
666 
670 typedef enum {
671  RSMI_XGMI_STATUS_NO_ERRORS = 0,
672  RSMI_XGMI_STATUS_ERROR,
673  RSMI_XGMI_STATUS_MULTIPLE_ERRORS,
675 
679 typedef uint64_t rsmi_bit_field_t;
681 typedef rsmi_bit_field_t rsmi_bit_field;
683 
687 typedef enum {
695 
699 typedef enum _RSMI_IO_LINK_TYPE {
704  RSMI_IOLINK_TYPE_SIZE = 0xFFFFFFFF
706 
709 #define CPU_NODE_INDEX 0xFFFFFFFF
710 
714 typedef enum {
717  RSMI_COARSE_GRAIN_GFX_ACTIVITY = RSMI_UTILIZATION_COUNTER_FIRST,
719  RSMI_UTILIZATION_COUNTER_LAST = RSMI_COARSE_GRAIN_MEM_ACTIVITY
721 
725 typedef enum {
728  RSMI_INVALID_POWER = 0xFFFFFFFF
730 
734 typedef struct {
736  uint64_t value;
738 
742 typedef struct {
743  uint64_t page_address;
744  uint64_t page_size;
747 
751 #define RSMI_MAX_NUM_POWER_PROFILES (sizeof(rsmi_bit_field_t) * 8)
752 
758 typedef struct {
763 
768 
772  uint32_t num_profiles;
775 typedef rsmi_power_profile_status_t rsmi_power_profile_status;
777 
781 typedef struct {
786 
790  uint32_t num_supported;
791 
795  uint32_t current;
796 
801  uint64_t frequency[RSMI_MAX_NUM_FREQUENCIES];
804 typedef rsmi_frequencies_t rsmi_frequencies;
806 
812 typedef struct {
817 
822  uint32_t lanes[RSMI_MAX_NUM_FREQUENCIES];
824 
826 typedef rsmi_pcie_bandwidth_t rsmi_pcie_bandwidth;
828 
833 typedef struct {
834  /* Utilization */
839 
843 typedef struct {
844  uint32_t major;
845  uint32_t minor;
846  uint32_t patch;
847  const char* build;
850 typedef rsmi_version_t rsmi_version;
852 
855 typedef struct {
856  uint64_t lower_bound;
857  uint64_t upper_bound;
858 } rsmi_range_t;
860 typedef rsmi_range_t rsmi_range;
862 
866 typedef struct {
867  uint64_t frequency;
868  uint64_t voltage;
871 typedef rsmi_od_vddc_point_t rsmi_od_vddc_point;
873 
879 typedef struct {
884 typedef rsmi_freq_volt_region_t rsmi_freq_volt_region;
886 
890 typedef struct {
898 typedef rsmi_od_volt_curve_t rsmi_od_volt_curve;
900 
904 typedef struct {
910 
915  uint32_t num_regions;
918 typedef rsmi_od_volt_freq_data_t rsmi_od_volt_freq_data;
920 
929  // TODO(amd) Doxygen documents
930  // Note: This should match: AMDGpuMetricsHeader_v1_t
932  uint16_t structure_size;
933  uint8_t format_revision;
934  uint8_t content_revision;
936 };
940 
944 #define CENTRIGRADE_TO_MILLI_CENTIGRADE 1000
945 
949 #define RSMI_NUM_HBM_INSTANCES 4
950 
954 #define RSMI_MAX_NUM_VCNS 4
955 
959 #define RSMI_MAX_NUM_JPEG_ENGS 32
960 
964 #define RSMI_MAX_NUM_JPEG_ENG_V1 40
965 
969 #define RSMI_MAX_NUM_CLKS 4
970 
974 #define RSMI_MAX_NUM_XGMI_LINKS 8
975 
979 #define RSMI_MAX_NUM_GFX_CLKS 8
980 
990 #define RSMI_MAX_NUM_XCC 8
991 
1002 #define RSMI_MAX_NUM_XCP 8
1003 
1008  /*
1009  * v1.6 additions
1010  */
1011  /* Utilization Instantaneous (%) */
1012  uint32_t gfx_busy_inst[RSMI_MAX_NUM_XCC];
1013  uint16_t jpeg_busy[RSMI_MAX_NUM_JPEG_ENG_V1];
1014  uint16_t vcn_busy[RSMI_MAX_NUM_VCNS];
1015 
1016  /* Utilization Accumulated (%) */
1017  uint64_t gfx_busy_acc[RSMI_MAX_NUM_XCC];
1018 
1019  /*
1020  * v1.7 additions
1021  */
1022  /* Total App Clock Counter Accumulated */
1023  uint64_t gfx_below_host_limit_acc[RSMI_MAX_NUM_XCC];
1024 
1029  uint64_t gfx_below_host_limit_thm_acc[RSMI_MAX_NUM_XCC];
1030  uint64_t gfx_low_utilization_acc[RSMI_MAX_NUM_XCC];
1031  uint64_t gfx_below_host_limit_total_acc[RSMI_MAX_NUM_XCC];
1032 };
1033 
1034 typedef struct {
1035  // TODO(amd) Doxygen documents
1036  // Note: This structure is extended to fit the needs of different GPU metric
1037  // versions when exposing data through the structure.
1038  // Depending on the version, some data members will hold data, and
1039  // some will not. A good example is the set of 'current clocks':
1040  // - current_gfxclk, current_socclk, current_vclk0, current_dclk0
1041  // These are single-valued data members, up to version 1.3.
1042  // For version 1.4 and up these are multi-valued data members (arrays)
1043  // and their counterparts;
1044  // - current_gfxclks[], current_socclks[], current_vclk0s[],
1045  // current_dclk0s[]
1046  // will hold the data
1048 
1049  /*
1050  * v1.0 Base
1051  */
1052  struct metrics_table_header_t common_header;
1053 
1054  // Temperature (C)
1055  uint16_t temperature_edge;
1056  uint16_t temperature_hotspot;
1057  uint16_t temperature_mem;
1058  uint16_t temperature_vrgfx;
1059  uint16_t temperature_vrsoc;
1060  uint16_t temperature_vrmem;
1061 
1062  // Utilization (%)
1063  uint16_t average_gfx_activity;
1064  uint16_t average_umc_activity; // memory controller
1065  uint16_t average_mm_activity; // UVD or VCN
1066 
1067  // Power (W) /Energy (15.259uJ per 1ns)
1068  uint16_t average_socket_power;
1069  uint64_t energy_accumulator; // v1 mod. (32->64)
1070 
1071  // Driver attached timestamp (in ns)
1072  uint64_t system_clock_counter; // v1 mod. (moved from top of struct)
1073 
1074  // Average clocks (MHz)
1075  uint16_t average_gfxclk_frequency;
1076  uint16_t average_socclk_frequency;
1077  uint16_t average_uclk_frequency;
1078  uint16_t average_vclk0_frequency;
1079  uint16_t average_dclk0_frequency;
1080  uint16_t average_vclk1_frequency;
1081  uint16_t average_dclk1_frequency;
1082 
1083  // Current clocks (MHz)
1084  uint16_t current_gfxclk;
1085  uint16_t current_socclk;
1086  uint16_t current_uclk;
1087  uint16_t current_vclk0;
1088  uint16_t current_dclk0;
1089  uint16_t current_vclk1;
1090  uint16_t current_dclk1;
1091 
1092  // Throttle status
1093  uint32_t throttle_status;
1094 
1095  // Fans (RPM)
1096  uint16_t current_fan_speed;
1097 
1098  // Link width (number of lanes) /speed (0.1 GT/s)
1099  uint16_t pcie_link_width; // v1 mod.(8->16)
1100  uint16_t pcie_link_speed; // in 0.1 GT/s; v1 mod. (8->16)
1101 
1102  /*
1103  * v1.1 additions
1104  */
1105  uint32_t gfx_activity_acc; // new in v1
1106  uint32_t mem_activity_acc; // new in v1
1107  uint16_t temperature_hbm[RSMI_NUM_HBM_INSTANCES]; // new in v1
1108 
1109  /*
1110  * v1.2 additions
1111  */
1112  // PMFW attached timestamp (10ns resolution)
1113  uint64_t firmware_timestamp;
1114 
1115  /*
1116  * v1.3 additions
1117  */
1118  // Voltage (mV)
1119  uint16_t voltage_soc;
1120  uint16_t voltage_gfx;
1121  uint16_t voltage_mem;
1122 
1123  // Throttle status
1124  uint64_t indep_throttle_status;
1125 
1126  /*
1127  * v1.4 additions
1128  */
1129  // Power (Watts)
1130  uint16_t current_socket_power;
1131 
1132  // Utilization (%)
1133  uint16_t vcn_activity[RSMI_MAX_NUM_VCNS]; // VCN instances activity percent (encode/decode)
1134 
1135  // Clock Lock Status. Each bit corresponds to clock instance
1136  uint32_t gfxclk_lock_status;
1137 
1138  // XGMI bus width and bitrate (in GB/s)
1139  uint16_t xgmi_link_width;
1140  uint16_t xgmi_link_speed;
1141 
1142  // PCIE accumulated bandwidth (GB/sec)
1143  uint64_t pcie_bandwidth_acc;
1144 
1145  // PCIE instantaneous bandwidth (GB/sec)
1146  uint64_t pcie_bandwidth_inst;
1147 
1148  // PCIE L0 to recovery state transition accumulated count
1149  uint64_t pcie_l0_to_recov_count_acc;
1150 
1151  // PCIE replay accumulated count
1152  uint64_t pcie_replay_count_acc;
1153 
1154  // PCIE replay rollover accumulated count
1155  uint64_t pcie_replay_rover_count_acc;
1156 
1157  // XGMI accumulated data transfer size(KiloBytes)
1158  uint64_t xgmi_read_data_acc[RSMI_MAX_NUM_XGMI_LINKS];
1159  uint64_t xgmi_write_data_acc[RSMI_MAX_NUM_XGMI_LINKS];
1160 
1161  // XGMI accumulated data transfer size(KiloBytes)
1162  uint16_t current_gfxclks[RSMI_MAX_NUM_GFX_CLKS];
1163  uint16_t current_socclks[RSMI_MAX_NUM_CLKS];
1164  uint16_t current_vclk0s[RSMI_MAX_NUM_CLKS];
1165  uint16_t current_dclk0s[RSMI_MAX_NUM_CLKS];
1166 
1167  /*
1168  * v1.5 additions
1169  */
1170  // JPEG activity percent (encode/decode)
1171  uint16_t jpeg_activity[RSMI_MAX_NUM_JPEG_ENGS];
1172 
1173  // PCIE NAK sent accumulated count
1174  uint32_t pcie_nak_sent_count_acc;
1175 
1176  // PCIE NAK received accumulated count
1177  uint32_t pcie_nak_rcvd_count_acc;
1178 
1179  /*
1180  * v1.6 additions
1181  */
1182  /* Accumulation cycle counter */
1183  uint64_t accumulation_counter;
1184 
1188  uint64_t prochot_residency_acc;
1204  uint64_t ppt_residency_acc;
1220  uint64_t socket_thm_residency_acc;
1221  uint64_t vr_thm_residency_acc;
1222  uint64_t hbm_thm_residency_acc;
1223 
1224  /* Number of current partition */
1225  uint16_t num_partition;
1226 
1227  /* XCP (Graphic Cluster Partitions) metrics stats */
1228  struct amdgpu_xcp_metrics_t xcp_stats[RSMI_MAX_NUM_XCP];
1229 
1230  /* PCIE other end recovery counter */
1231  uint32_t pcie_lc_perf_other_end_recovery;
1232 
1233  /*
1234  * v1.7 additions
1235  */
1236  /* VRAM max bandwidth at max memory clock */
1237  uint64_t vram_max_bandwidth;
1238 
1239  /* XGMI link status(up/down) */
1240  uint16_t xgmi_link_status[RSMI_MAX_NUM_XGMI_LINKS];
1241 
1244 
1248 typedef struct {
1249  uint64_t correctable_err;
1252 
1256 typedef struct {
1257  uint32_t process_id;
1258  uint32_t pasid;
1259  uint64_t vram_usage;
1260  uint64_t sdma_usage;
1261  uint32_t cu_occupancy;
1263 
1265 #define CU_OCCUPANCY_INVALID 0xFFFFFFFF
1266 
1270 typedef struct rsmi_func_id_iter_handle* rsmi_func_id_iter_handle_t;
1271 
1274 #define RSMI_DEFAULT_VARIANT 0xFFFFFFFFFFFFFFFF
1275 
1281 typedef union id {
1282  uint64_t id;
1283  const char* name;
1284  union {
1299  };
1301 
1310 typedef struct {
1312  uint32_t card_index;
1315 
1317  uint64_t bdfid;
1318 
1320  uint64_t kfd_gpu_id;
1321 
1323  uint32_t partition_id;
1324 
1326  uint32_t smi_device_id;
1327 
1328  uint32_t reserved[10];
1330 
1331 /*****************************************************************************/
1349 rsmi_status_t rsmi_init(uint64_t init_flags);
1350 
1357  // end of InitShut
1359 
1360 /*****************************************************************************/
1378 
1406 rsmi_status_t rsmi_dev_id_get(uint32_t dv_ind, uint16_t* id);
1407 
1422 rsmi_status_t rsmi_dev_revision_get(uint32_t dv_ind, uint16_t* revision);
1423 
1448 rsmi_status_t rsmi_dev_sku_get(uint32_t dv_ind, uint16_t* sku);
1449 
1473 rsmi_status_t rsmi_dev_vendor_id_get(uint32_t dv_ind, uint16_t* id);
1474 
1509 rsmi_status_t rsmi_dev_name_get(uint32_t dv_ind, char* name, size_t len);
1510 
1543 rsmi_status_t rsmi_dev_brand_get(uint32_t dv_ind, char* brand, uint32_t len);
1544 
1579 rsmi_status_t rsmi_dev_vendor_name_get(uint32_t dv_ind, char* name, size_t len);
1580 
1606 rsmi_status_t rsmi_dev_market_name_get(uint32_t dv_ind, char* market_name, uint32_t len);
1607 
1630 rsmi_status_t rsmi_dev_vram_vendor_get(uint32_t dv_ind, char* brand, uint32_t len);
1631 
1660 rsmi_status_t rsmi_dev_serial_number_get(uint32_t dv_ind, char* serial_num, uint32_t len);
1684 rsmi_status_t rsmi_dev_subsystem_id_get(uint32_t dv_ind, uint16_t* id);
1685 
1720 rsmi_status_t rsmi_dev_subsystem_name_get(uint32_t dv_ind, char* name, size_t len);
1721 
1739 rsmi_status_t rsmi_dev_drm_render_minor_get(uint32_t dv_ind, uint32_t* minor);
1740 
1763 rsmi_status_t rsmi_dev_subsystem_vendor_id_get(uint32_t dv_ind, uint16_t* id);
1764 
1786 rsmi_status_t rsmi_dev_unique_id_get(uint32_t dv_ind, uint64_t* id);
1787 
1802 rsmi_status_t rsmi_dev_xgmi_physical_id_get(uint32_t dv_ind, uint16_t* id);
1803 
1826 rsmi_status_t rsmi_dev_guid_get(uint32_t dv_ind, uint64_t* guid);
1827 
1850 rsmi_status_t rsmi_dev_node_id_get(uint32_t dv_ind, uint32_t* node_id);
1851 
1880  rsmi_device_identifiers_t* identifiers);
1881  // end of IDQuer
1883 
1884 /*****************************************************************************/
1909 
1957 rsmi_status_t rsmi_dev_pci_id_get(uint32_t dv_ind, uint64_t* bdfid);
1958 
1981 rsmi_status_t rsmi_topo_numa_affinity_get(uint32_t dv_ind, int32_t* numa_node);
1982 
2007 rsmi_status_t rsmi_dev_pci_throughput_get(uint32_t dv_ind, uint64_t* sent, uint64_t* received,
2008  uint64_t* max_pkt_sz);
2009 
2032 rsmi_status_t rsmi_dev_pci_replay_counter_get(uint32_t dv_ind, uint64_t* counter);
2033  // end of PCIeQuer
2035 /*****************************************************************************/
2070 rsmi_status_t rsmi_dev_pci_bandwidth_set(uint32_t dv_ind, uint64_t bw_bitmask);
2071  // end of PCIeCont
2073 
2074 /*****************************************************************************/
2109 rsmi_status_t rsmi_dev_power_ave_get(uint32_t dv_ind, uint32_t sensor_ind, uint64_t* power);
2110 
2132 rsmi_status_t rsmi_dev_current_socket_power_get(uint32_t dv_ind, uint64_t* socket_power);
2133 
2168 rsmi_status_t rsmi_dev_power_get(uint32_t dv_ind, uint64_t* power, RSMI_POWER_TYPE* type);
2169 
2200 rsmi_status_t rsmi_dev_energy_count_get(uint32_t dv_ind, uint64_t* power, float* counter_resolution,
2201  uint64_t* timestamp);
2202 
2228 rsmi_status_t rsmi_dev_power_cap_get(uint32_t dv_ind, uint32_t sensor_ind, uint64_t* cap);
2229 
2251 rsmi_status_t rsmi_dev_power_cap_default_get(uint32_t dv_ind, uint64_t* default_cap);
2252 
2284 rsmi_status_t rsmi_dev_power_cap_range_get(uint32_t dv_ind, uint32_t sensor_ind, uint64_t* max,
2285  uint64_t* min);
2286  // end of PowerQuer
2288 
2289 /*****************************************************************************/
2314 rsmi_status_t rsmi_dev_power_cap_set(uint32_t dv_ind, uint32_t sensor_ind, uint64_t cap);
2315 
2335 rsmi_status_t rsmi_dev_power_profile_set(uint32_t dv_ind, uint32_t reserved,
2336  rsmi_power_profile_preset_masks_t profile); // end of PowerCont
2338 /*****************************************************************************/
2339 
2340 /*****************************************************************************/
2372  uint64_t* total);
2373 
2401  uint64_t* used);
2402 
2425 rsmi_status_t rsmi_dev_memory_busy_percent_get(uint32_t dv_ind, uint32_t* busy_percent);
2426 
2462 rsmi_status_t rsmi_dev_memory_reserved_pages_get(uint32_t dv_ind, uint32_t* num_pages,
2463  rsmi_retired_page_record_t* records); // end of MemQuer
2465 
2497 rsmi_status_t rsmi_dev_fan_rpms_get(uint32_t dv_ind, uint32_t sensor_ind, int64_t* speed);
2498 
2526 rsmi_status_t rsmi_dev_fan_speed_get(uint32_t dv_ind, uint32_t sensor_ind, int64_t* speed);
2527 
2553 rsmi_status_t rsmi_dev_fan_speed_max_get(uint32_t dv_ind, uint32_t sensor_ind, uint64_t* max_speed);
2554 
2585 rsmi_status_t rsmi_dev_temp_metric_get(uint32_t dv_ind, uint32_t sensor_type,
2586  rsmi_temperature_metric_t metric, int64_t* temperature);
2587 
2619  rsmi_voltage_metric_t metric, int64_t* voltage); // end of PhysQuer
2621 
2622 /*****************************************************************************/
2642 rsmi_status_t rsmi_dev_fan_reset(uint32_t dv_ind, uint32_t sensor_ind);
2643 
2666 rsmi_status_t rsmi_dev_fan_speed_set(uint32_t dv_ind, uint32_t sensor_ind, uint64_t speed);
2667  // end of PhysCont
2669 /*****************************************************************************/
2699 rsmi_status_t rsmi_dev_busy_percent_get(uint32_t dv_ind, uint32_t* busy_percent);
2700 
2731  rsmi_utilization_counter_t utilization_counters[],
2732  uint32_t count, uint64_t* timestamp);
2733 
2759  rsmi_activity_metric_t activity_metric_type,
2760  rsmi_activity_metric_counter_t* activity_metric_counter);
2761 
2782 rsmi_status_t rsmi_dev_activity_avg_mm_get(uint32_t dv_ind, uint16_t* avg_activity);
2783 
2808 
2830 rsmi_status_t rsmi_perf_determinism_mode_set(uint32_t dv_ind, uint64_t clkvalue);
2831 
2855 rsmi_status_t rsmi_dev_overdrive_level_get(uint32_t dv_ind, uint32_t* od);
2856 
2880 rsmi_status_t rsmi_dev_mem_overdrive_level_get(uint32_t dv_ind, uint32_t* od);
2881 
2915  rsmi_frequencies_t* f);
2916 
2931 
2955 
2977 
3000 rsmi_status_t rsmi_dev_clk_range_set(uint32_t dv_ind, uint64_t minclkvalue, uint64_t maxclkvalue,
3001  rsmi_clk_type_t clkType);
3002 
3024 rsmi_status_t rsmi_dev_clk_extremum_set(uint32_t dv_ind, rsmi_freq_ind_t level, uint64_t clkvalue,
3025  rsmi_clk_type_t clkType);
3026 
3049 rsmi_status_t rsmi_dev_od_clk_info_set(uint32_t dv_ind, rsmi_freq_ind_t level, uint64_t clkvalue,
3050  rsmi_clk_type_t clkType);
3051 
3073 rsmi_status_t rsmi_dev_od_volt_info_set(uint32_t dv_ind, uint32_t vpoint, uint64_t clkvalue,
3074  uint64_t voltvalue);
3075 
3114 rsmi_status_t rsmi_dev_od_volt_curve_regions_get(uint32_t dv_ind, uint32_t* num_regions,
3115  rsmi_freq_volt_region_t* buffer);
3116 
3152 rsmi_status_t rsmi_dev_power_profile_presets_get(uint32_t dv_ind, uint32_t sensor_ind,
3153  rsmi_power_profile_status_t* status);
3154  // end of PerfQuer
3156 /*****************************************************************************/
3157 
3185 
3205 
3249 rsmi_status_t rsmi_dev_overdrive_level_set(uint32_t dv_ind, uint32_t od);
3250 
3290 rsmi_status_t rsmi_dev_overdrive_level_set_v1(uint32_t dv_ind, uint32_t od);
3291 
3327  uint64_t freq_bitmask);
3328  // end of PerfCont
3330 
3331 /*****************************************************************************/
3351 
3377 rsmi_status_t rsmi_version_str_get(rsmi_sw_component_t component, char* ver_str, uint32_t len);
3378 
3405 rsmi_status_t rsmi_dev_vbios_version_get(uint32_t dv_ind, char* vbios, uint32_t len);
3406 
3432  uint64_t* fw_version);
3433 
3454 rsmi_status_t rsmi_dev_target_graphics_version_get(uint32_t dv_ind, uint64_t* gfx_version);
3455  // end of VersQuer
3457 
3458 /*****************************************************************************/
3491  rsmi_error_count_t* ec);
3492 
3520 rsmi_status_t rsmi_dev_ecc_enabled_get(uint32_t dv_ind, uint64_t* enabled_blocks);
3521 
3548  rsmi_ras_err_state_t* state);
3563 rsmi_status_t rsmi_status_string(rsmi_status_t status, const char** status_string);
3564  // end of ErrQuer
3566 
3567 /*****************************************************************************/
3689 
3719  rsmi_event_handle_t* evnt_handle);
3720 
3735 
3754  void* cmd_args);
3755 
3774 
3795  uint32_t* available); // end of PerfCntr
3797 
3798 /*****************************************************************************/
3839 
3862 
3897 rsmi_status_t rsmi_compute_process_gpus_get(uint32_t pid, uint32_t* dv_indices,
3898  uint32_t* num_devices);
3899 
3920  rsmi_process_info_t* proc);
3921  // end of SysInfo
3923 
3924 /*****************************************************************************/
3954 
3968 
3987 rsmi_status_t rsmi_dev_xgmi_hive_id_get(uint32_t dv_ind, uint64_t* hive_id);
3988  // end of SysInfo
3990 
3991 /*****************************************************************************/
4014 rsmi_status_t rsmi_topo_get_numa_node_number(uint32_t dv_ind, uint32_t* numa_node);
4015 
4036 rsmi_status_t rsmi_topo_get_link_weight(uint32_t dv_ind_src, uint32_t dv_ind_dst, uint64_t* weight);
4037 
4060 rsmi_status_t rsmi_minmax_bandwidth_get(uint32_t dv_ind_src, uint32_t dv_ind_dst,
4061  uint64_t* min_bandwidth, uint64_t* max_bandwidth);
4062 
4095 rsmi_status_t rsmi_topo_get_link_type(uint32_t dv_ind_src, uint32_t dv_ind_dst, uint64_t* hops,
4096  RSMI_IO_LINK_TYPE* type);
4097 
4118 rsmi_status_t rsmi_is_P2P_accessible(uint32_t dv_ind_src, uint32_t dv_ind_dst, bool* accessible);
4119  // end of HWTopo
4121 
4122 /*****************************************************************************/
4157 rsmi_status_t rsmi_dev_compute_partition_get(uint32_t dv_ind, char* compute_partition,
4158  uint32_t len);
4159 
4185  rsmi_compute_partition_type_t compute_partition);
4186 
4209 rsmi_status_t rsmi_dev_partition_id_get(uint32_t dv_ind, uint32_t* partition_id);
4210  // end of ComputePartition
4212 
4213 /*****************************************************************************/
4248 rsmi_status_t rsmi_dev_memory_partition_get(uint32_t dv_ind, char* memory_partition, uint32_t len);
4249 
4281  char* memory_partition_caps, uint32_t len);
4282 
4307  rsmi_memory_partition_type_t memory_partition);
4308  // end of memory_partition
4310 
4311 /*****************************************************************************/
4444  rsmi_func_id_iter_handle_t* handle);
4445 
4471  rsmi_func_id_iter_handle_t* var_iter);
4472 
4492 
4505 
4525  rsmi_func_id_value_t* value);
4526  // end of APISupport
4528 
4529 /*****************************************************************************/
4550 
4577 rsmi_status_t rsmi_event_notification_mask_set(uint32_t dv_ind, uint64_t mask);
4578 
4619 rsmi_status_t rsmi_event_notification_get(int timeout_ms, uint32_t* num_elem,
4621 
4641  // end of EvntNotif
4643 
4644 /*****************************************************************************/
4668  metrics_table_header_t* header_value);
4669 
4686 rsmi_status_t rsmi_dev_metrics_xcd_counter_get(uint32_t dv_ind, uint16_t* xcd_counter_value);
4687 
4700  // end of DevMetricsHeaderInfoGet
4702 
4703 #ifdef __cplusplus
4704 }
4705 #endif // __cplusplus
4706 #endif // ROCM_SMI_ROCM_SMI_H_
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_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_status_t rsmi_func_iter_next(rsmi_func_id_iter_handle_t handle)
Advance a function identifier iterator.
rsmi_status_t rsmi_dev_supported_func_iterator_close(rsmi_func_id_iter_handle_t *handle)
Close a variant iterator handle.
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_status_t rsmi_dev_partition_id_get(uint32_t dv_ind, uint32_t *partition_id)
Retrieves the partition_id for a desired device.
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_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_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_status_t rsmi_dev_ecc_enabled_get(uint32_t dv_ind, uint64_t *enabled_blocks)
Retrieve the enabled ECC bit-mask.
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_t rsmi_status_string(rsmi_status_t status, const char **status_string)
Get a description of a provided RSMI error status.
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_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_status_t rsmi_event_notification_init(uint32_t dv_ind)
Prepare to collect event notifications for a GPU.
rsmi_status_t rsmi_event_notification_mask_set(uint32_t dv_ind, uint64_t mask)
Specify which events to collect for a device.
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_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_status_t rsmi_dev_metrics_log_get(uint32_t dv_ind)
Get the log from the GPU metrics associated with the device.
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_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_status_t rsmi_minmax_bandwidth_get(uint32_t dv_ind_src, uint32_t dv_ind_dst, uint64_t *min_bandwidth, uint64_t *max_bandwidth)
Retrieve minimal and maximal io link bandwidth between 2 GPUs.
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_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_status_t rsmi_dev_name_get(uint32_t dv_ind, char *name, size_t len)
Get the name string of a gpu device.
rsmi_status_t rsmi_dev_device_identifiers_get(uint32_t dv_ind, rsmi_device_identifiers_t *identifiers)
Retrieves the device identifiers for a specific GPU device.
rsmi_status_t rsmi_dev_unique_id_get(uint32_t dv_ind, uint64_t *id)
Get Unique ID.
rsmi_status_t rsmi_num_monitor_devices(uint32_t *num_devices)
Get the number of devices that have monitor information.
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_status_t rsmi_dev_market_name_get(uint32_t dv_ind, char *market_name, uint32_t len)
Get the device's market name.
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_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_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_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_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_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_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_status_t rsmi_dev_brand_get(uint32_t dv_ind, char *brand, uint32_t len)
Get the brand string of a gpu device.
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_status_t rsmi_dev_subsystem_name_get(uint32_t dv_ind, char *name, size_t len)
Get the name string for the device subsystem.
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_status_t rsmi_dev_revision_get(uint32_t dv_ind, uint16_t *revision)
Get the device revision associated with the device.
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_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_status_t rsmi_init(uint64_t init_flags)
Initialize ROCm SMI.
rsmi_status_t rsmi_shut_down(void)
Shutdown ROCm SMI.
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_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_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_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_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_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_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_status_t rsmi_topo_numa_affinity_get(uint32_t dv_ind, int32_t *numa_node)
Get the NUMA node associated with a device.
rsmi_status_t rsmi_dev_pci_replay_counter_get(uint32_t dv_ind, uint64_t *counter)
Get PCIe replay counter.
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_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_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_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_status_t rsmi_dev_counter_destroy(rsmi_event_handle_t evnt_handle)
Deallocate a performance counter object.
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_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_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_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_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_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_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_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_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_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_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_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_status_t rsmi_dev_gpu_reset(uint32_t dv_ind)
Reset the gpu associated with the device with provided device index.
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_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_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_status_t rsmi_perf_determinism_mode_set(uint32_t dv_ind, uint64_t clkvalue)
Enter performance determinism mode with provided device index.
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_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_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_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_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_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_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_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_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_status_t rsmi_dev_fan_reset(uint32_t dv_ind, uint32_t sensor_ind)
Reset the fan to automatic driver control.
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_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_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_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_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_status_t rsmi_dev_power_cap_set(uint32_t dv_ind, uint32_t sensor_ind, uint64_t cap)
Set the power cap value.
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_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_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_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_status_t rsmi_dev_power_get(uint32_t dv_ind, uint64_t *power, RSMI_POWER_TYPE *type)
A generic get which attempts to retrieve current socket power (also known as instant power) of the de...
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_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_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_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_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_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_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_status_t rsmi_version_get(rsmi_version_t *version)
Get the build version information for the currently running build of RSMI.
rsmi_status_t rsmi_dev_vbios_version_get(uint32_t dv_ind, char *vbios, uint32_t len)
Get the VBIOS identifier string.
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_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_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_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_status_t rsmi_dev_xgmi_error_reset(uint32_t dv_ind)
Reset the XGMI error status for a device.
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_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_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_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
Activity (Utilization) Metrics. This enum is used to identify various activity metrics.
Definition: rocm_smi.h:494
@ RSMI_ACTIVITY_UMC
memory controller
Definition: rocm_smi.h:497
@ RSMI_ACTIVITY_MM
UVD or VCN.
Definition: rocm_smi.h:498
struct rsmi_func_id_iter_handle * rsmi_func_id_iter_handle_t
Opaque handle to function-support object.
Definition: rocm_smi.h:1270
rsmi_memory_page_status_t
Reserved Memory Page States.
Definition: rocm_smi.h:687
@ RSMI_MEM_PAGE_STATUS_UNRESERVABLE
Unable to reserve this page.
Definition: rocm_smi.h:693
@ RSMI_MEM_PAGE_STATUS_PENDING
Definition: rocm_smi.h:690
@ RSMI_MEM_PAGE_STATUS_RESERVED
Definition: rocm_smi.h:688
rsmi_status_t
Error codes returned by rocm_smi_lib functions.
Definition: rocm_smi.h:92
@ RSMI_STATUS_UNEXPECTED_DATA
Definition: rocm_smi.h:129
@ RSMI_STATUS_REFCOUNT_OVERFLOW
Definition: rocm_smi.h:134
@ RSMI_STATUS_NOT_FOUND
Definition: rocm_smi.h:119
@ RSMI_STATUS_UNKNOWN_ERROR
An unknown error occurred.
Definition: rocm_smi.h:144
@ RSMI_STATUS_INIT_ERROR
Definition: rocm_smi.h:111
@ RSMI_STATUS_DRM_ERROR
Error when call libdrm.
Definition: rocm_smi.h:140
@ RSMI_STATUS_SETTING_UNAVAILABLE
Definition: rocm_smi.h:136
@ RSMI_STATUS_INSUFFICIENT_SIZE
Definition: rocm_smi.h:121
@ RSMI_STATUS_INVALID_ARGS
Passed in arguments are not valid.
Definition: rocm_smi.h:94
@ RSMI_STATUS_NOT_SUPPORTED
Definition: rocm_smi.h:95
@ RSMI_STATUS_FAIL_LOAD_SYMBOL
Fail to load symbol.
Definition: rocm_smi.h:142
@ RSMI_STATUS_NO_DATA
Definition: rocm_smi.h:127
@ RSMI_STATUS_UNEXPECTED_SIZE
Definition: rocm_smi.h:125
@ RSMI_STATUS_AMDGPU_RESTART_ERR
Definition: rocm_smi.h:138
@ RSMI_STATUS_FILE_ERROR
Definition: rocm_smi.h:98
@ RSMI_STATUS_BUSY
Definition: rocm_smi.h:131
@ RSMI_STATUS_FAIL_LOAD_MODULE
Fail to load lib.
Definition: rocm_smi.h:141
@ RSMI_STATUS_NOT_YET_IMPLEMENTED
Definition: rocm_smi.h:115
@ RSMI_STATUS_OUT_OF_RESOURCES
Definition: rocm_smi.h:106
@ RSMI_STATUS_INTERRUPT
Definition: rocm_smi.h:123
@ RSMI_STATUS_INTERNAL_EXCEPTION
An internal exception was caught.
Definition: rocm_smi.h:108
@ RSMI_STATUS_SUCCESS
Operation was successful.
Definition: rocm_smi.h:93
@ RSMI_STATUS_INPUT_OUT_OF_BOUNDS
Definition: rocm_smi.h:109
@ RSMI_STATUS_PERMISSION
Definition: rocm_smi.h:103
RSMI_UTILIZATION_COUNTER_TYPE
The utilization counter type.
Definition: rocm_smi.h:714
@ RSMI_COARSE_GRAIN_MEM_ACTIVITY
Memory Activity.
Definition: rocm_smi.h:718
@ RSMI_UTILIZATION_COUNTER_FIRST
GFX Activity.
Definition: rocm_smi.h:715
_RSMI_IO_LINK_TYPE
Types for IO Link.
Definition: rocm_smi.h:699
@ RSMI_IOLINK_TYPE_XGMI
XGMI.
Definition: rocm_smi.h:702
@ RSMI_IOLINK_TYPE_UNDEFINED
unknown type.
Definition: rocm_smi.h:700
@ RSMI_IOLINK_TYPE_PCIEXPRESS
PCI Express.
Definition: rocm_smi.h:701
@ RSMI_IOLINK_TYPE_SIZE
Max of IO Link types.
Definition: rocm_smi.h:704
@ RSMI_IOLINK_TYPE_NUMIOLINKTYPES
Number of IO Link types.
Definition: rocm_smi.h:703
rsmi_sw_component_t
Available clock types.
Definition: rocm_smi.h:200
@ RSMI_SW_COMP_DRIVER
Driver.
Definition: rocm_smi.h:203
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:223
@ RSMI_EVNT_GRP_XGMI
Data Fabric (XGMI) related events.
Definition: rocm_smi.h:224
@ RSMI_EVNT_GRP_XGMI_DATA_OUT
XGMI Outbound data.
Definition: rocm_smi.h:225
#define MAX_EVENT_NOTIFICATION_MSG_SIZE
Maximum number of characters an event notification message will be.
Definition: rocm_smi.h:346
#define RSMI_MAX_NUM_CLKS
This should match kRSMI_MAX_NUM_CLKS.
Definition: rocm_smi.h:969
#define RSMI_MAX_NUM_JPEG_ENGS
This should match kRSMI_MAX_JPEG_ENGINES.
Definition: rocm_smi.h:959
rsmi_dev_perf_level_t
PowerPlay performance levels.
Definition: rocm_smi.h:167
@ RSMI_DEV_PERF_LEVEL_LOW
Definition: rocm_smi.h:171
@ RSMI_DEV_PERF_LEVEL_MANUAL
Definition: rocm_smi.h:175
@ RSMI_DEV_PERF_LEVEL_STABLE_MIN_MCLK
Definition: rocm_smi.h:180
@ RSMI_DEV_PERF_LEVEL_UNKNOWN
Unknown performance level.
Definition: rocm_smi.h:188
@ RSMI_DEV_PERF_LEVEL_DETERMINISM
Performance determinism state.
Definition: rocm_smi.h:184
@ RSMI_DEV_PERF_LEVEL_HIGH
Definition: rocm_smi.h:173
@ RSMI_DEV_PERF_LEVEL_STABLE_STD
Definition: rocm_smi.h:177
@ RSMI_DEV_PERF_LEVEL_STABLE_PEAK
Stable power state with peak clocks.
Definition: rocm_smi.h:179
@ RSMI_DEV_PERF_LEVEL_STABLE_MIN_SCLK
Definition: rocm_smi.h:182
@ RSMI_DEV_PERF_LEVEL_AUTO
Performance level is "auto".
Definition: rocm_smi.h:168
rsmi_voltage_metric_t
Voltage Metrics. This enum is used to identify various Voltage metrics. Corresponding values will be ...
Definition: rocm_smi.h:506
@ RSMI_VOLT_LOWEST
Historical minimum voltage.
Definition: rocm_smi.h:515
@ RSMI_VOLT_MIN_CRIT
Voltage critical min value.
Definition: rocm_smi.h:511
@ RSMI_VOLT_MAX_CRIT
Voltage critical max value.
Definition: rocm_smi.h:513
@ RSMI_VOLT_CURRENT
Voltage current value.
Definition: rocm_smi.h:507
@ RSMI_VOLT_MIN
Voltage min value.
Definition: rocm_smi.h:512
@ RSMI_VOLT_AVERAGE
Average voltage.
Definition: rocm_smi.h:514
@ RSMI_VOLT_MAX
Voltage max value.
Definition: rocm_smi.h:510
@ RSMI_VOLT_HIGHEST
Historical maximum voltage.
Definition: rocm_smi.h:516
rsmi_evt_notification_type_t
Definition: rocm_smi.h:321
@ RSMI_EVT_NOTIF_VMFAULT
VM page fault.
Definition: rocm_smi.h:323
@ RSMI_EVT_NOTIF_NONE
Unused.
Definition: rocm_smi.h:322
#define RSMI_NUM_VOLTAGE_CURVE_POINTS
The number of points that make up a voltage-frequency curve definition.
Definition: rocm_smi.h:87
#define RSMI_MAX_NUM_GFX_CLKS
This should match kRSMI_MAX_NUM_GFX_CLKS.
Definition: rocm_smi.h:979
rsmi_xgmi_status_t
XGMI Status.
Definition: rocm_smi.h:670
rsmi_compute_partition_type_t
Compute Partition. This enum is used to identify various compute partitioning settings.
Definition: rocm_smi.h:383
@ RSMI_COMPUTE_PARTITION_SPX
Definition: rocm_smi.h:385
@ RSMI_COMPUTE_PARTITION_DPX
Definition: rocm_smi.h:387
@ RSMI_COMPUTE_PARTITION_QPX
Definition: rocm_smi.h:391
@ RSMI_COMPUTE_PARTITION_TPX
Definition: rocm_smi.h:389
@ RSMI_COMPUTE_PARTITION_CPX
Definition: rocm_smi.h:393
rsmi_voltage_type_t
This ennumeration is used to indicate which type of voltage reading should be obtained.
Definition: rocm_smi.h:525
@ RSMI_VOLT_TYPE_VDDGFX
Vddgfx GPU voltage.
Definition: rocm_smi.h:528
@ RSMI_VOLT_TYPE_INVALID
Invalid type.
Definition: rocm_smi.h:532
@ RSMI_VOLT_TYPE_VDDBOARD
Voltage for VDDBOARD.
Definition: rocm_smi.h:529
rsmi_temperature_metric_t
Temperature Metrics. This enum is used to identify various temperature metrics. Corresponding values ...
Definition: rocm_smi.h:429
@ RSMI_TEMP_CURRENT
Temperature current value.
Definition: rocm_smi.h:430
@ RSMI_TEMP_LOWEST
Historical minimum temperature.
Definition: rocm_smi.h:461
@ RSMI_TEMP_CRIT_MIN
Definition: rocm_smi.h:453
@ RSMI_TEMP_CRIT_MIN_HYST
Definition: rocm_smi.h:456
@ RSMI_TEMP_MIN
Temperature min value.
Definition: rocm_smi.h:434
@ RSMI_TEMP_MAX
Temperature max value.
Definition: rocm_smi.h:433
@ RSMI_TEMP_EMERGENCY
Definition: rocm_smi.h:446
@ RSMI_TEMP_MAX_HYST
Definition: rocm_smi.h:435
@ RSMI_TEMP_MIN_HYST
Definition: rocm_smi.h:438
@ RSMI_TEMP_CRITICAL_HYST
Definition: rocm_smi.h:443
@ RSMI_TEMP_EMERGENCY_HYST
Definition: rocm_smi.h:450
@ RSMI_TEMP_HIGHEST
Historical maximum temperature.
Definition: rocm_smi.h:462
@ RSMI_TEMP_CRITICAL
Definition: rocm_smi.h:441
@ RSMI_TEMP_OFFSET
Definition: rocm_smi.h:459
rsmi_ras_err_state_t
The current ECC state.
Definition: rocm_smi.h:594
@ RSMI_RAS_ERR_STATE_MULT_UC
Multiple uncorrectable errors.
Definition: rocm_smi.h:599
@ RSMI_RAS_ERR_STATE_POISON
Definition: rocm_smi.h:600
@ RSMI_RAS_ERR_STATE_DISABLED
ECC is disabled.
Definition: rocm_smi.h:596
@ RSMI_RAS_ERR_STATE_PARITY
ECC errors present, but type unknown.
Definition: rocm_smi.h:597
@ RSMI_RAS_ERR_STATE_SING_C
Single correctable error.
Definition: rocm_smi.h:598
@ RSMI_RAS_ERR_STATE_ENABLED
ECC is enabled.
Definition: rocm_smi.h:602
@ RSMI_RAS_ERR_STATE_NONE
No current errors.
Definition: rocm_smi.h:595
#define RSMI_NUM_HBM_INSTANCES
This should match kRSMI_MAX_NUM_HBM_INSTANCES.
Definition: rocm_smi.h:949
#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:990
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:235
@ RSMI_EVNT_XGMI_1_RESPONSE_TX
Definition: rocm_smi.h:262
@ RSMI_EVNT_XGMI_DATA_OUT_5
Outbound beats to neighbor 5.
Definition: rocm_smi.h:292
@ RSMI_EVNT_XGMI_1_BEATS_TX
Definition: rocm_smi.h:264
@ RSMI_EVNT_XGMI_1_NOP_TX
NOPs sent to neighbor 1.
Definition: rocm_smi.h:259
@ RSMI_EVNT_XGMI_0_NOP_TX
NOPs sent to neighbor 0.
Definition: rocm_smi.h:239
@ RSMI_EVNT_XGMI_1_REQUEST_TX
Definition: rocm_smi.h:260
@ RSMI_EVNT_XGMI_DATA_OUT_3
Outbound beats to neighbor 3.
Definition: rocm_smi.h:290
@ RSMI_EVNT_XGMI_DATA_OUT_4
Outbound beats to neighbor 4.
Definition: rocm_smi.h:291
@ RSMI_EVNT_XGMI_DATA_OUT_2
Outbound beats to neighbor 2.
Definition: rocm_smi.h:289
@ RSMI_EVNT_XGMI_0_RESPONSE_TX
Definition: rocm_smi.h:242
@ RSMI_EVNT_XGMI_DATA_OUT_1
Outbound beats to neighbor 1.
Definition: rocm_smi.h:288
@ RSMI_EVNT_XGMI_0_BEATS_TX
Data beats sent to neighbor 0; Each beat represents 32 bytes.
Definition: rocm_smi.h:258
@ RSMI_EVNT_XGMI_0_REQUEST_TX
Definition: rocm_smi.h:240
rsmi_freq_ind_t
The values of this enum are used as frequency identifiers.
Definition: rocm_smi.h:624
@ RSMI_FREQ_IND_MAX
Index used for the maximum frequency value.
Definition: rocm_smi.h:626
@ RSMI_FREQ_IND_MIN
Index used for the minimum frequency value.
Definition: rocm_smi.h:625
@ RSMI_FREQ_IND_INVALID
An invalid frequency index.
Definition: rocm_smi.h:627
rsmi_memory_type_t
Types of memory.
Definition: rocm_smi.h:611
@ RSMI_MEM_TYPE_VRAM
VRAM memory.
Definition: rocm_smi.h:614
@ RSMI_MEM_TYPE_GTT
GTT memory.
Definition: rocm_smi.h:616
@ RSMI_MEM_TYPE_VIS_VRAM
VRAM memory that is visible.
Definition: rocm_smi.h:615
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:541
@ RSMI_PWR_PROF_PRST_LAST
Invalid power profile.
Definition: rocm_smi.h:551
@ RSMI_PWR_PROF_PRST_VIDEO_MASK
Video Power Profile.
Definition: rocm_smi.h:543
@ RSMI_PWR_PROF_PRST_VR_MASK
VR Power Profile.
Definition: rocm_smi.h:546
@ RSMI_PWR_PROF_PRST_CUSTOM_MASK
Custom Power Profile.
Definition: rocm_smi.h:542
@ RSMI_PWR_PROF_PRST_POWER_SAVING_MASK
Power Saving Profile.
Definition: rocm_smi.h:544
@ RSMI_PWR_PROF_PRST_COMPUTE_MASK
Compute Saving Profile.
Definition: rocm_smi.h:545
@ RSMI_PWR_PROF_PRST_BOOTUP_DEFAULT
Default Boot Up Profile.
Definition: rocm_smi.h:550
rsmi_gpu_block_t
This enum is used to identify different GPU blocks.
Definition: rocm_smi.h:563
@ RSMI_GPU_BLOCK_SMN
SMN block.
Definition: rocm_smi.h:577
@ RSMI_GPU_BLOCK_ATHUB
ATHUB block.
Definition: rocm_smi.h:572
@ RSMI_GPU_BLOCK_GFX
GFX block.
Definition: rocm_smi.h:570
@ RSMI_GPU_BLOCK_MMHUB
MMHUB block.
Definition: rocm_smi.h:571
@ RSMI_GPU_BLOCK_FUSE
Fuse block.
Definition: rocm_smi.h:581
@ RSMI_GPU_BLOCK_HDP
HDP block.
Definition: rocm_smi.h:574
@ RSMI_GPU_BLOCK_DF
DF block.
Definition: rocm_smi.h:576
@ RSMI_GPU_BLOCK_SEM
SEM block.
Definition: rocm_smi.h:578
@ RSMI_GPU_BLOCK_INVALID
Definition: rocm_smi.h:564
@ RSMI_GPU_BLOCK_MP1
MP1 block.
Definition: rocm_smi.h:580
@ RSMI_GPU_BLOCK_XGMI_WAFL
XGMI block.
Definition: rocm_smi.h:575
@ RSMI_GPU_BLOCK_UMC
UMC block.
Definition: rocm_smi.h:568
@ RSMI_GPU_BLOCK_LAST
Definition: rocm_smi.h:583
@ RSMI_GPU_BLOCK_PCIE_BIF
PCIE_BIF block.
Definition: rocm_smi.h:573
@ RSMI_GPU_BLOCK_MP0
MP0 block.
Definition: rocm_smi.h:579
@ RSMI_GPU_BLOCK_SDMA
SDMA block.
Definition: rocm_smi.h:569
#define RSMI_MAX_NUM_VCNS
This should match kRSMI_MAX_NUM_VCNS.
Definition: rocm_smi.h:954
#define RSMI_MAX_NUM_JPEG_ENG_V1
This should match kRSMI_MAX_NUM_JPEG_ENG_V1.
Definition: rocm_smi.h:964
rsmi_fw_block_t
The values of this enum are used to identify the various firmware blocks.
Definition: rocm_smi.h:637
rsmi_init_flags_t
Initialization flags.
Definition: rocm_smi.h:153
@ RSMI_INIT_FLAG_RESRV_TEST1
Reserved for test.
Definition: rocm_smi.h:161
@ RSMI_INIT_FLAG_THRAD_ONLY_MUTEX
The mutex limit to thread.
Definition: rocm_smi.h:160
@ RSMI_INIT_FLAG_ALL_GPUS
Definition: rocm_smi.h:154
enum _RSMI_IO_LINK_TYPE RSMI_IO_LINK_TYPE
Types for IO Link.
#define RSMI_MAX_NUM_FREQUENCIES
Definition: rocm_smi.h:80
#define RSMI_MAX_NUM_XGMI_LINKS
This should match kRSMI_MAX_NUM_XGMI_LINKS.
Definition: rocm_smi.h:974
uintptr_t rsmi_event_handle_t
Handle to performance event counter.
Definition: rocm_smi.h:215
rsmi_counter_command_t
Definition: rocm_smi.h:301
@ RSMI_CNTR_CMD_START
Start the counter.
Definition: rocm_smi.h:302
@ RSMI_CNTR_CMD_STOP
Definition: rocm_smi.h:303
uint64_t rsmi_bit_field_t
Bitfield used in various RSMI calls.
Definition: rocm_smi.h:679
#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:1002
rsmi_clk_type_t
Definition: rocm_smi.h:360
@ RSMI_CLK_TYPE_MEM
Memory clock.
Definition: rocm_smi.h:367
@ RSMI_CLK_TYPE_DCEF
Display Controller Engine clock.
Definition: rocm_smi.h:365
@ RSMI_CLK_TYPE_PCIE
PCIE clock.
Definition: rocm_smi.h:368
@ RSMI_CLK_TYPE_SOC
SOC clock.
Definition: rocm_smi.h:366
@ RSMI_CLK_TYPE_DF
Definition: rocm_smi.h:363
@ RSMI_CLK_TYPE_SYS
System clock.
Definition: rocm_smi.h:361
rsmi_memory_partition_type_t
Memory Partitions. This enum is used to identify various memory partition types.
Definition: rocm_smi.h:404
@ RSMI_MEMORY_PARTITION_NPS8
Definition: rocm_smi.h:414
@ RSMI_MEMORY_PARTITION_NPS4
Definition: rocm_smi.h:411
@ RSMI_MEMORY_PARTITION_NPS2
Definition: rocm_smi.h:408
@ RSMI_MEMORY_PARTITION_NPS1
Definition: rocm_smi.h:406
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
Power types.
Definition: rocm_smi.h:725
@ RSMI_AVERAGE_POWER
Average Power.
Definition: rocm_smi.h:726
@ RSMI_INVALID_POWER
Invalid / Undetected Power.
Definition: rocm_smi.h:728
@ RSMI_CURRENT_POWER
Current / Instant Power.
Definition: rocm_smi.h:727
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:474
@ RSMI_TEMP_TYPE_HBM_2
HBM temperature instance 2.
Definition: rocm_smi.h:483
@ RSMI_TEMP_TYPE_HBM_0
HBM temperature instance 0.
Definition: rocm_smi.h:481
@ RSMI_TEMP_TYPE_HBM_1
HBM temperature instance 1.
Definition: rocm_smi.h:482
@ RSMI_TEMP_TYPE_MEMORY
VRAM temperature.
Definition: rocm_smi.h:480
@ RSMI_TEMP_TYPE_INVALID
Invalid type.
Definition: rocm_smi.h:486
@ RSMI_TEMP_TYPE_EDGE
Edge GPU temperature.
Definition: rocm_smi.h:477
@ RSMI_TEMP_TYPE_JUNCTION
Definition: rocm_smi.h:478
@ RSMI_TEMP_TYPE_HBM_3
HBM temperature instance 3.
Definition: rocm_smi.h:484
The following structures hold the gpu statistics for a device.
Definition: rocm_smi.h:1007
uint64_t gfx_below_host_limit_ppt_acc[RSMI_MAX_NUM_XCC]
Definition: rocm_smi.h:1028
The following structures hold the gpu metrics values for a device.
Definition: rocm_smi.h:928
This structure holds information about the possible activity averages. Specifically,...
Definition: rocm_smi.h:833
uint16_t average_mm_activity
UVD or VCN.
Definition: rocm_smi.h:837
uint16_t average_gfx_activity
Average graphics activity.
Definition: rocm_smi.h:835
uint16_t average_umc_activity
memory controller
Definition: rocm_smi.h:836
Definition: rocm_smi.h:310
uint64_t value
Counter value.
Definition: rocm_smi.h:311
uint64_t time_enabled
Definition: rocm_smi.h:312
uint64_t time_running
Definition: rocm_smi.h:314
Structure to hold various identifiers for a GPU device.
Definition: rocm_smi.h:1310
uint32_t drm_render_minor
The PCI Bus/Device/Function identifier (BDFID) of the device.
Definition: rocm_smi.h:1314
uint32_t card_index
< The card index of the device.
Definition: rocm_smi.h:1312
uint64_t bdfid
The KFD (Kernel Fusion Driver) GPU ID of the device.
Definition: rocm_smi.h:1317
uint32_t partition_id
The SMI (System Management Interface) device ID.
Definition: rocm_smi.h:1323
uint64_t kfd_gpu_id
The partition ID of the device.
Definition: rocm_smi.h:1320
This structure holds error counts.
Definition: rocm_smi.h:1248
uint64_t correctable_err
Accumulated correctable errors.
Definition: rocm_smi.h:1249
uint64_t uncorrectable_err
Accumulated uncorrectable errors.
Definition: rocm_smi.h:1250
Definition: rocm_smi.h:351
rsmi_evt_notification_type_t event
Event type.
Definition: rocm_smi.h:353
uint32_t dv_ind
Index of device that corresponds to the event.
Definition: rocm_smi.h:352
This structure holds 2 rsmi_range_t's, one for frequency and one for voltage. These 2 ranges indicate...
Definition: rocm_smi.h:879
rsmi_range_t volt_range
The voltage range for this VDDC Curve point.
Definition: rocm_smi.h:881
rsmi_range_t freq_range
The frequency range for this VDDC Curve point.
Definition: rocm_smi.h:880
This structure holds information about clock frequencies.
Definition: rocm_smi.h:781
uint32_t current
Definition: rocm_smi.h:795
uint32_t num_supported
Definition: rocm_smi.h:790
bool has_deep_sleep
Definition: rocm_smi.h:785
Definition: rocm_smi.h:1034
This structure represents a point on the frequency-voltage plane.
Definition: rocm_smi.h:866
uint64_t frequency
Frequency coordinate (in Hz)
Definition: rocm_smi.h:867
uint64_t voltage
Voltage coordinate (in mV)
Definition: rocm_smi.h:868
Definition: rocm_smi.h:890
This structure holds the frequency-voltage values for a device.
Definition: rocm_smi.h:904
rsmi_range_t mclk_freq_limits
The range possible of MCLK values.
Definition: rocm_smi.h:909
uint32_t num_regions
The number of voltage curve regions.
Definition: rocm_smi.h:915
rsmi_range_t curr_mclk_range
Definition: rocm_smi.h:906
rsmi_range_t sclk_freq_limits
The range possible of SCLK values.
Definition: rocm_smi.h:908
rsmi_range_t curr_sclk_range
The current SCLK frequency range.
Definition: rocm_smi.h:905
rsmi_od_volt_curve_t curve
The current voltage curve.
Definition: rocm_smi.h:914
This structure holds information about the possible PCIe bandwidths. Specifically,...
Definition: rocm_smi.h:812
rsmi_frequencies_t transfer_rate
Definition: rocm_smi.h:816
This structure contains information about which power profiles are supported by the system for a give...
Definition: rocm_smi.h:758
uint32_t num_profiles
Definition: rocm_smi.h:772
rsmi_bit_field_t available_profiles
Definition: rocm_smi.h:762
rsmi_power_profile_preset_masks_t current
Definition: rocm_smi.h:767
This structure contains information specific to a process.
Definition: rocm_smi.h:1256
uint32_t cu_occupancy
Compute Unit usage in percent.
Definition: rocm_smi.h:1261
uint32_t pasid
PASID.
Definition: rocm_smi.h:1258
uint32_t process_id
Process ID.
Definition: rocm_smi.h:1257
uint64_t sdma_usage
SDMA usage in microseconds.
Definition: rocm_smi.h:1260
uint64_t vram_usage
VRAM usage.
Definition: rocm_smi.h:1259
This structure represents a range (e.g., frequencies or voltages).
Definition: rocm_smi.h:855
uint64_t upper_bound
Upper bound of range.
Definition: rocm_smi.h:857
uint64_t lower_bound
Lower bound of range.
Definition: rocm_smi.h:856
Reserved Memory Page Record.
Definition: rocm_smi.h:742
uint64_t page_size
Page size.
Definition: rocm_smi.h:744
rsmi_memory_page_status_t status
Page "reserved" status.
Definition: rocm_smi.h:745
uint64_t page_address
Start address of page.
Definition: rocm_smi.h:743
The utilization counter data.
Definition: rocm_smi.h:734
RSMI_UTILIZATION_COUNTER_TYPE type
Utilization counter type.
Definition: rocm_smi.h:735
uint64_t value
Utilization counter value.
Definition: rocm_smi.h:736
This structure holds version information.
Definition: rocm_smi.h:843
uint32_t patch
Patch, build or stepping version.
Definition: rocm_smi.h:846
const char * build
Build string.
Definition: rocm_smi.h:847
uint32_t minor
Minor version.
Definition: rocm_smi.h:845
uint32_t major
Major version.
Definition: rocm_smi.h:844
This union holds the value of an rsmi_func_id_iter_handle_t. The value may be a function name,...
Definition: rocm_smi.h:1281
rsmi_temperature_metric_t temp_metric
Definition: rocm_smi.h:1288
rsmi_memory_type_t memory_type
Definition: rocm_smi.h:1286
rsmi_event_group_t evnt_group
Definition: rocm_smi.h:1292
rsmi_clk_type_t clk_type
Definition: rocm_smi.h:1294
uint64_t id
uint64_t representation of value
Definition: rocm_smi.h:1282
rsmi_event_type_t evnt_type
Definition: rocm_smi.h:1290
rsmi_gpu_block_t gpu_block_type
Definition: rocm_smi.h:1298
rsmi_fw_block_t fw_block
Definition: rocm_smi.h:1296
const char * name
name string (applicable to functions only)
Definition: rocm_smi.h:1283