.TH "NvmlClocksThrottleReasons" 3 "24 Apr 2019" "Version 1.1" "NVML" \" -*- nroff -*-
.ad l
.nh
.SH NAME
NvmlClocksThrottleReasons \- 
.SS "Defines"

.in +1c
.ti -1c
.RI "#define \fBnvmlClocksThrottleReasonGpuIdle\fP   0x0000000000000001LL"
.br
.ti -1c
.RI "#define \fBnvmlClocksThrottleReasonApplicationsClocksSetting\fP   0x0000000000000002LL"
.br
.ti -1c
.RI "#define \fBnvmlClocksThrottleReasonUserDefinedClocks\fP   nvmlClocksThrottleReasonApplicationsClocksSetting"
.br
.ti -1c
.RI "#define \fBnvmlClocksThrottleReasonSwPowerCap\fP   0x0000000000000004LL"
.br
.ti -1c
.RI "#define \fBnvmlClocksThrottleReasonHwSlowdown\fP   0x0000000000000008LL"
.br
.ti -1c
.RI "#define \fBnvmlClocksThrottleReasonSyncBoost\fP   0x0000000000000010LL"
.br
.ti -1c
.RI "#define \fBnvmlClocksThrottleReasonSwThermalSlowdown\fP   0x0000000000000020LL"
.br
.ti -1c
.RI "#define \fBnvmlClocksThrottleReasonHwThermalSlowdown\fP   0x0000000000000040LL"
.br
.ti -1c
.RI "#define \fBnvmlClocksThrottleReasonHwPowerBrakeSlowdown\fP   0x0000000000000080LL"
.br
.ti -1c
.RI "#define \fBnvmlClocksThrottleReasonDisplayClockSetting\fP   0x0000000000000100LL"
.br
.ti -1c
.RI "#define \fBnvmlClocksThrottleReasonNone\fP   0x0000000000000000LL"
.br
.ti -1c
.RI "#define \fBnvmlClocksThrottleReasonAll\fP"
.br
.in -1c
.SH "Define Documentation"
.PP 
.SS "#define nvmlClocksThrottleReasonAll"
.PP
\fBValue:\fP
.PP
.nf
(nvmlClocksThrottleReasonNone \
      | nvmlClocksThrottleReasonGpuIdle                           \
      | nvmlClocksThrottleReasonApplicationsClocksSetting         \
      | nvmlClocksThrottleReasonSwPowerCap                        \
      | nvmlClocksThrottleReasonHwSlowdown                        \
      | nvmlClocksThrottleReasonSyncBoost                         \
      | nvmlClocksThrottleReasonSwThermalSlowdown                 \
      | nvmlClocksThrottleReasonHwThermalSlowdown                 \
      | nvmlClocksThrottleReasonHwPowerBrakeSlowdown              \
      | nvmlClocksThrottleReasonDisplayClockSetting               \
)
.fi
Bit mask representing all supported clocks throttling reasons New reasons might be added to this list in the future 
.SS "#define nvmlClocksThrottleReasonApplicationsClocksSetting   0x0000000000000002LL"
.PP
GPU clocks are limited by current setting of applications clocks
.PP
\fBSee also:\fP
.RS 4
\fBnvmlDeviceSetApplicationsClocks\fP 
.PP
\fBnvmlDeviceGetApplicationsClock\fP 
.RE
.PP

.SS "#define nvmlClocksThrottleReasonDisplayClockSetting   0x0000000000000100LL"
.PP
GPU clocks are limited by current setting of Display clocks
.PP
\fBSee also:\fP
.RS 4
bug 1997531 
.RE
.PP

.SS "#define nvmlClocksThrottleReasonGpuIdle   0x0000000000000001LL"
.PP
Nothing is running on the GPU and the clocks are dropping to Idle state 
.PP
\fBNote:\fP
.RS 4
This limiter may be removed in a later release 
.RE
.PP

.SS "#define nvmlClocksThrottleReasonHwPowerBrakeSlowdown   0x0000000000000080LL"
.PP
HW Power Brake Slowdown (reducing the core clocks by a factor of 2 or more) is engaged
.PP
This is an indicator of:
.IP "\(bu" 2
External Power Brake Assertion being triggered (e.g. by the system power supply)
.PP
.PP
\fBSee also:\fP
.RS 4
\fBnvmlDeviceGetTemperature\fP 
.PP
\fBnvmlDeviceGetTemperatureThreshold\fP 
.PP
\fBnvmlDeviceGetPowerUsage\fP 
.RE
.PP

.SS "#define nvmlClocksThrottleReasonHwSlowdown   0x0000000000000008LL"
.PP
HW Slowdown (reducing the core clocks by a factor of 2 or more) is engaged
.PP
This is an indicator of:
.IP "\(bu" 2
temperature being too high
.IP "\(bu" 2
External Power Brake Assertion is triggered (e.g. by the system power supply)
.IP "\(bu" 2
Power draw is too high and Fast Trigger protection is reducing the clocks
.IP "\(bu" 2
May be also reported during PState or clock change
.IP "  \(bu" 4
This behavior may be removed in a later release.
.PP

.PP
.PP
\fBSee also:\fP
.RS 4
\fBnvmlDeviceGetTemperature\fP 
.PP
\fBnvmlDeviceGetTemperatureThreshold\fP 
.PP
\fBnvmlDeviceGetPowerUsage\fP 
.RE
.PP

.SS "#define nvmlClocksThrottleReasonHwThermalSlowdown   0x0000000000000040LL"
.PP
HW Thermal Slowdown (reducing the core clocks by a factor of 2 or more) is engaged
.PP
This is an indicator of:
.IP "\(bu" 2
temperature being too high
.PP
.PP
\fBSee also:\fP
.RS 4
\fBnvmlDeviceGetTemperature\fP 
.PP
\fBnvmlDeviceGetTemperatureThreshold\fP 
.PP
\fBnvmlDeviceGetPowerUsage\fP 
.RE
.PP

.SS "#define nvmlClocksThrottleReasonNone   0x0000000000000000LL"
.PP
Bit mask representing no clocks throttling
.PP
Clocks are as high as possible. 
.SS "#define nvmlClocksThrottleReasonSwPowerCap   0x0000000000000004LL"
.PP
SW Power Scaling algorithm is reducing the clocks below requested clocks
.PP
\fBSee also:\fP
.RS 4
\fBnvmlDeviceGetPowerUsage\fP 
.PP
\fBnvmlDeviceSetPowerManagementLimit\fP 
.PP
\fBnvmlDeviceGetPowerManagementLimit\fP 
.RE
.PP

.SS "#define nvmlClocksThrottleReasonSwThermalSlowdown   0x0000000000000020LL"
.PP
SW Thermal Slowdown
.PP
This is an indicator of one or more of the following:
.IP "\(bu" 2
Current GPU temperature above the GPU Max Operating Temperature
.IP "\(bu" 2
Current memory temperature above the Memory Max Operating Temperature 
.PP

.SS "#define nvmlClocksThrottleReasonSyncBoost   0x0000000000000010LL"
.PP
Sync Boost
.PP
This GPU has been added to a Sync boost group with nvidia-smi or DCGM in order to maximize performance per watt. All GPUs in the sync boost group will boost to the minimum possible clocks across the entire group. Look at the throttle reasons for other GPUs in the system to see why those GPUs are holding this one at lower clocks. 
.SS "#define nvmlClocksThrottleReasonUserDefinedClocks   nvmlClocksThrottleReasonApplicationsClocksSetting"
.PP
\fBDeprecated\fP
.RS 4
Renamed to \fBnvmlClocksThrottleReasonApplicationsClocksSetting\fP as the name describes the situation more accurately. 
.RE
.PP

.SH "Author"
.PP 
Generated automatically by Doxygen for NVML from the source code.