NvmlClocksThrottleReasons(3)

NAME
NvmlClocksThrottleReasons -

  Defines

#define nvmlClocksThrottleReasonGpuIdle 0x0000000000000001LL
#define nvmlClocksThrottleReasonApplicationsClocksSetting 0x0000000000000002LL
#define nvmlClocksThrottleReasonUserDefinedClocks nvmlClocksThrottleReasonApplicationsClocksSetting
#define nvmlClocksThrottleReasonSwPowerCap 0x0000000000000004LL
#define nvmlClocksThrottleReasonHwSlowdown 0x0000000000000008LL
#define nvmlClocksThrottleReasonUnknown 0x8000000000000000LL
#define nvmlClocksThrottleReasonNone 0x0000000000000000LL
#define nvmlClocksThrottleReasonAll

Define Documentation

  #define nvmlClocksThrottleReasonAll

Value:

(nvmlClocksThrottleReasonNone       | nvmlClocksThrottleReasonGpuIdle                                 | nvmlClocksThrottleReasonApplicationsClocksSetting               | nvmlClocksThrottleReasonSwPowerCap                              | nvmlClocksThrottleReasonHwSlowdown                              | nvmlClocksThrottleReasonUnknown                                   )
Bit mask representing all supported clocks throttling reasons New reasons might be added to this list in the future

  #define nvmlClocksThrottleReasonApplicationsClocksSetting 0x0000000000000002LL

GPU clocks are limited by current setting of applications clocks

See also:
    nvmlDeviceSetApplicationsClocks

    nvmlDeviceGetApplicationsClock

  #define nvmlClocksThrottleReasonGpuIdle 0x0000000000000001LL

Nothing is running on the GPU and the clocks are dropping to Idle state

Note:
    This limiter may be removed in a later release

  #define nvmlClocksThrottleReasonHwSlowdown 0x0000000000000008LL

HW Slowdown (reducing the core clocks by a factor of 2 or more) is engaged

This is an indicator of:

•   temperature being too high

•   External Power Brake Assertion is triggered (e.g. by the system power supply)

•   Power draw is too high and Fast Trigger protection is reducing the clocks

•   May be also reported during PState or clock change

•   This behavior may be removed in a later release.

See also:
    nvmlDeviceGetTemperature

    nvmlDeviceGetPowerUsage

  #define nvmlClocksThrottleReasonNone 0x0000000000000000LL

Bit mask representing no clocks throttling

Clocks are as high as possible.

  #define nvmlClocksThrottleReasonSwPowerCap 0x0000000000000004LL

SW Power Scaling algorithm is reducing the clocks below requested clocks

See also:
    nvmlDeviceGetPowerUsage

    nvmlDeviceSetPowerManagementLimit

    nvmlDeviceGetPowerManagementLimit

  #define nvmlClocksThrottleReasonUnknown 0x8000000000000000LL

Some other unspecified factor is reducing the clocks

  #define nvmlClocksThrottleReasonUserDefinedClocks nvmlClocksThrottleReasonApplicationsClocksSetting

Deprecated
    Renamed to nvmlClocksThrottleReasonApplicationsClocksSetting as the name describes the situation more accurately.

Author

Generated automatically by Doxygen for NVML from the source code.