4.31. Power Smoothing Information
Typedefs
- typedef nvmlPowerSmoothingProfile_v1_t nvmlPowerSmoothingProfile_t
- Current version for the power smoothing profile structure.
- typedef nvmlPowerSmoothingState_v1_t nvmlPowerSmoothingState_t
- Current version for the power smoothing state structure.
Functions
- nvmlReturn_t nvmlDevicePowerSmoothingActivatePresetProfile ( nvmlDevice_t device, nvmlPowerSmoothingProfile_t* profile )
- nvmlReturn_t nvmlDevicePowerSmoothingSetState ( nvmlDevice_t device, nvmlPowerSmoothingState_t* state )
- nvmlReturn_t nvmlDevicePowerSmoothingUpdatePresetProfileParam ( nvmlDevice_t device, nvmlPowerSmoothingProfile_t* profile )
Typedefs
Functions
- nvmlReturn_t nvmlDevicePowerSmoothingActivatePresetProfile ( nvmlDevice_t device, nvmlPowerSmoothingProfile_t* profile )
-
Parameters
- device
- The identifier of the target device
- profile
- Reference to nvmlPowerSmoothingProfile_t. Note that only profile->profileId is used and the rest of the structure is ignored.
Returns
- NVML_SUCCESS if the Desired Profile was successfully set
- NVML_ERROR_INVALID_ARGUMENT if device is invalid or structure was NULL
- NVML_ERROR_NO_PERMISSION if user does not have permission to change the profile number
- NVML_ERROR_NOT_SUPPORTED if this feature is not supported by the device
Description
Activiate a specific preset profile for datacenter power smoothing The API only sets the active preset profile based on the input profileId, and ignores the other parameters of the structure.
- nvmlReturn_t nvmlDevicePowerSmoothingSetState ( nvmlDevice_t device, nvmlPowerSmoothingState_t* state )
-
Parameters
- device
- The identifier of the target device
- state
- Reference to nvmlPowerSmoothingState_t
Returns
- NVML_SUCCESS if the feature state was successfully set
- NVML_ERROR_INVALID_ARGUMENT if device is invalid or state is NULL
- NVML_ERROR_NO_PERMISSION if user does not have permission to change feature state
- NVML_ERROR_NOT_SUPPORTED if this feature is not supported by the device
Description
Enable or disable the Power Smoothing Feature See nvmlEnableState_t for details on allowed states
- nvmlReturn_t nvmlDevicePowerSmoothingUpdatePresetProfileParam ( nvmlDevice_t device, nvmlPowerSmoothingProfile_t* profile )
-
Parameters
- device
- The identifier of the target device
- profile
- Reference to nvmlPowerSmoothingProfile_t struct
Returns
- NVML_SUCCESS if the Active Profile was successfully set
- NVML_ERROR_INVALID_ARGUMENT if device is invalid or profile parameter/value was invalid
- NVML_ERROR_NO_PERMISSION if user does not have permission to change any profile parameters
- NVML_ERROR_ARGUMENT_VERSION_MISMATCH if the structure version is not supported
Description
Update the value of a specific profile parameter contained within nvmlPowerSmoothingProfile_t
NVML_POWER_SMOOTHING_PROFILE_PARAM_PERCENT_TMP_FLOOR expects a value as a percentage from 00.00-100.00% NVML_POWER_SMOOTHING_PROFILE_PARAM_RAMP_UP_RATE expects a value in W/s NVML_POWER_SMOOTHING_PROFILE_PARAM_RAMP_DOWN_RATE expects a value in W/s NVML_POWER_SMOOTHING_PROFILE_PARAM_RAMP_DOWN_HYSTERESIS expects a value in ms