Physical State Control

Physical State Control#

ROCmSMI: Physical State Control
Physical State Control

Functions

rsmi_status_t rsmi_dev_fan_reset (uint32_t dv_ind, uint32_t sensor_ind)
 Reset the fan to automatic driver control. More...
 
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. More...
 

Detailed Description

These functions provide control over the physical state of a device.

Function Documentation

◆ 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.

This function returns control of the fan to the system

Parameters
[in]dv_inda device index
[in]sensor_inda 0-based sensor index. Normally, this will be 0. If a device has more than one sensor, it could be greater than 0.
Return values
RSMI_STATUS_SUCCESSis returned upon successful call.
RSMI_STATUS_NOT_SUPPORTEDinstalled software or hardware does not support this function with the given arguments

◆ 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.

Given a device index dv_ind and a integer value indicating speed speed, this function will attempt to set the fan speed to speed. An error will be returned if the specified speed is outside the allowable range for the device. The maximum value is 255 and the minimum is 0.

Parameters
[in]dv_inda device index
[in]sensor_inda 0-based sensor index. Normally, this will be 0. If a device has more than one sensor, it could be greater than 0.
[in]speedthe speed to which the function will attempt to set the fan
Return values
RSMI_STATUS_SUCCESSis returned upon successful call.
RSMI_STATUS_NOT_SUPPORTEDinstalled software or hardware does not support this function with the given arguments
RSMI_STATUS_PERMISSIONfunction requires root access