Struct amdgpu_sysfs::gpu_handle::GpuHandle

pub struct GpuHandle {
    pub hw_monitors: Vec<HwMon>,
    /* private fields */
}

A GpuHandle represents a handle over a single GPU device, as exposed in the Linux SysFS.

Fields

hw_monitors: Vec<HwMon>

A collection of all HwMons bound to this GPU. They are used to expose real-time data.

Implementations

impl GpuHandle

pub fn new_from_path(sysfs_path: PathBuf) -> Result<Self, Error>

Initializes a new GpuHandle from a given SysFS device path.

Normally, the path should look akin to /sys/class/drm/card0/device, and it needs to at least contain a uevent file.

pub fn get_driver(&self) -> &str

Gets the kernel driver used.

pub fn get_pci_id(&self) -> Option<(&str, &str)>

Gets the GPU’s PCI vendor and ID. This is the ID of your GPU chip, e.g. AMD Radeon RX 580.

pub fn get_pci_subsys_id(&self) -> Option<(&str, &str)>

Gets the Card’s PCI vendor and ID. This is the ID of your card model, e.g. Sapphire RX 580 Pulse.

pub fn get_pci_slot_name(&self) -> Option<&str>

Gets the pci slot name of the card.

pub fn get_current_link_speed(&self) -> Result<String, Error>

Gets the current PCIe link speed.

pub fn get_current_link_width(&self) -> Result<String, Error>

Gets the current PCIe link width.

pub fn get_max_link_speed(&self) -> Result<String, Error>

Gets the maximum possible PCIe link speed.

pub fn get_max_link_width(&self) -> Result<String, Error>

Gets the maximum possible PCIe link width.

pub fn get_total_vram(&self) -> Result<u64, Error>

Gets total VRAM size in bytes. May not be reported on some devices, such as integrated GPUs.

pub fn get_used_vram(&self) -> Result<u64, Error>

Gets how much VRAM is currently used, in bytes. May not be reported on some devices, such as integrated GPUs.

pub fn get_busy_percent(&self) -> Result<u8, Error>

Returns the GPU busy percentage.

pub fn get_vbios_version(&self) -> Result<String, Error>

Returns the GPU VBIOS version.

pub fn get_power_force_performance_level( &self ) -> Result<PerformanceLevel, Error>

Returns the currently forced performance level.

pub fn set_power_force_performance_level( &self, level: PerformanceLevel ) -> Result<(), Error>

Forces a given performance level.

pub fn get_clock_levels<T>( &self, kind: PowerLevelKind ) -> Result<PowerLevels<T>, Error>

where T: FromStr, <T as FromStr>::Err: Display,

Retuns the list of power levels and index of the currently active level for a given kind of power state. T is the type that values should be deserialized into.

pub fn get_core_clock_levels(&self) -> Result<PowerLevels<u64>, Error>

Gets clocks levels.

pub fn get_memory_clock_levels(&self) -> Result<PowerLevels<u64>, Error>

Gets clocks levels.

pub fn get_pcie_clock_levels(&self) -> Result<PowerLevels<String>, Error>

Gets clocks levels.

pub fn set_enabled_power_levels( &self, kind: PowerLevelKind, levels: &[u8] ) -> Result<(), Error>

Sets the enabled power levels for a power state kind to a given list of levels. This means that only the given power levels will be allowed.

Can only be used if power_force_performance_level is set to manual.

pub fn get_clocks_table(&self) -> Result<ClocksTableGen, Error>

Reads the clocks table from pp_od_clk_voltage.

pub fn set_clocks_table(&self, table: &ClocksTableGen) -> Result<(), Error>

Writes and commits the given clocks table to pp_od_clk_voltage.

pub fn reset_clocks_table(&self) -> Result<(), Error>

Resets the clocks table to the default configuration.

pub fn get_power_profile_modes(&self) -> Result<PowerProfileModesTable, Error>

Reads the list of predefined power profiles and the relevant heuristics settings for them from pp_power_profile_mode

https://kernel.org/doc/html/latest/gpu/amdgpu/thermal.html#pp-power-profile-mode

pub fn set_active_power_profile_mode(&self, i: u16) -> Result<(), Error>

Sets the current power profile mode. You can get the available modes with [get_power_profile_modes]. Requires the performance level to be set to “manual” first using [set_power_force_performance_level]

Trait Implementations

impl Clone for GpuHandle

fn clone(&self) -> GpuHandle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GpuHandle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl SysFS for GpuHandle

fn get_path(&self) -> &Path

Gets the path of the current SysFS.

fn read_file(&self, file: &str) -> Result<String, Error>

Reads the content of a file in the SysFS.

fn read_file_parsed<T: FromStr<Err = E>, E: ToString>( &self, file: &str ) -> Result<T, Error>

Reads the content of a file and then parses it

fn write_file<C: AsRef<[u8]> + Send>( &self, file: &str, contents: C ) -> Result<(), Error>

Write to a file in the SysFS.