Device Enums


Defines

#define nvmlFlagDefault   0x00
 Generic flags used for changing default behavior of some functions.
#define nvmlFlagForce   0x01
 Force some behavior.

Enumerations

enum  nvmlEnableState_t {
  NVML_FEATURE_DISABLED = 0,
  NVML_FEATURE_ENABLED = 1
}
 Generic enable/disable enum. More...
enum  nvmlTemperatureSensors_t { NVML_TEMPERATURE_GPU = 0 }
 Temperature sensors. More...
enum  nvmlComputeMode_t {
  NVML_COMPUTEMODE_DEFAULT = 0,
  NVML_COMPUTEMODE_EXCLUSIVE_THREAD = 1,
  NVML_COMPUTEMODE_PROHIBITED = 2,
  NVML_COMPUTEMODE_EXCLUSIVE_PROCESS = 3
}
 Compute mode. More...
enum  nvmlEccBitType_t {
  NVML_SINGLE_BIT_ECC = 0,
  NVML_DOUBLE_BIT_ECC = 1
}
 ECC bit types. More...
enum  nvmlEccCounterType_t {
  NVML_VOLATILE_ECC = 0,
  NVML_AGGREGATE_ECC = 1
}
 ECC counter types. More...
enum  nvmlClockType_t {
  NVML_CLOCK_GRAPHICS = 0,
  NVML_CLOCK_SM = 1,
  NVML_CLOCK_MEM = 2
}
 Clock types. More...
enum  nvmlDriverModel_t {
  NVML_DRIVER_WDDM = 0,
  NVML_DRIVER_WDM = 1
}
 Driver models. More...
enum  nvmlPstates_t {
  NVML_PSTATE_0 = 0,
  NVML_PSTATE_1 = 1,
  NVML_PSTATE_2 = 2,
  NVML_PSTATE_3 = 3,
  NVML_PSTATE_4 = 4,
  NVML_PSTATE_5 = 5,
  NVML_PSTATE_6 = 6,
  NVML_PSTATE_7 = 7,
  NVML_PSTATE_8 = 8,
  NVML_PSTATE_9 = 9,
  NVML_PSTATE_10 = 10,
  NVML_PSTATE_11 = 11,
  NVML_PSTATE_12 = 12,
  NVML_PSTATE_13 = 13,
  NVML_PSTATE_14 = 14,
  NVML_PSTATE_15 = 15,
  NVML_PSTATE_UNKNOWN = 32
}
 Allowed PStates. More...
enum  nvmlInforomObject_t {
  NVML_INFOROM_OEM = 0,
  NVML_INFOROM_ECC = 1,
  NVML_INFOROM_POWER = 2
}
 Available inforom objects. More...
enum  nvmlReturn_t {
  NVML_SUCCESS = 0,
  NVML_ERROR_UNINITIALIZED = 1,
  NVML_ERROR_INVALID_ARGUMENT = 2,
  NVML_ERROR_NOT_SUPPORTED = 3,
  NVML_ERROR_NO_PERMISSION = 4,
  NVML_ERROR_ALREADY_INITIALIZED = 5,
  NVML_ERROR_NOT_FOUND = 6,
  NVML_ERROR_INSUFFICIENT_SIZE = 7,
  NVML_ERROR_INSUFFICIENT_POWER = 8,
  NVML_ERROR_UNKNOWN = 999
}
 Return values for nvml api calls. More...

Define Documentation

#define nvmlFlagDefault   0x00

Generic flags used for changing default behavior of some functions.

See description particular of function for details.

Flags can be combined with bitwise or operator | Default behavior


Enumeration Type Documentation

Clock types.

All speeds are in Mhz.

Enumerator:
NVML_CLOCK_GRAPHICS  Graphics clock domain.
NVML_CLOCK_SM  SM clock domain.
NVML_CLOCK_MEM  Memory clock domain.

Compute mode.

NVML_COMPUTEMODE_EXCLUSIVE_PROCESS was added in CUDA 4.0. Earlier CUDA versions supported a single exclusive mode, which is equivalent to NVML_COMPUTEMODE_EXCLUSIVE_THREAD in CUDA 4.0 and beyond.

Enumerator:
NVML_COMPUTEMODE_DEFAULT  Default compute mode -- multiple contexts per device.
NVML_COMPUTEMODE_EXCLUSIVE_THREAD  Compute-exclusive-thread mode -- only one context per device, usable from one thread at a time.
NVML_COMPUTEMODE_PROHIBITED  Compute-prohibited mode -- no contexts per device.
NVML_COMPUTEMODE_EXCLUSIVE_PROCESS  Compute-exclusive-process mode -- only one context per device, usable from multiple threads at a time.

Driver models.

windows only.

Enumerator:
NVML_DRIVER_WDDM  WDDM driver model -- GPU treated as a display device.
NVML_DRIVER_WDM  WDM (TCC) model -- GPU treated as a generic device.

ECC bit types.

Enumerator:
NVML_SINGLE_BIT_ECC  Single bit ECC errors.
NVML_DOUBLE_BIT_ECC  Double bit ECC errors.

ECC counter types.

Enumerator:
NVML_VOLATILE_ECC  Volatile counts are reset after each boot.
NVML_AGGREGATE_ECC  Aggregate counts persist across reboots (i.e. for the lifetime of the device).

Generic enable/disable enum.

Enumerator:
NVML_FEATURE_DISABLED  Feature disabled.
NVML_FEATURE_ENABLED  Feature enabled.

Available inforom objects.

Enumerator:
NVML_INFOROM_OEM  The OEM object.
NVML_INFOROM_ECC  The ECC object.
NVML_INFOROM_POWER  The power management object.

Allowed PStates.

Enumerator:
NVML_PSTATE_0  Power state 0 -- Maximum Performance.
NVML_PSTATE_1  Power state 1.
NVML_PSTATE_2  Power state 2.
NVML_PSTATE_3  Power state 3.
NVML_PSTATE_4  Power state 4.
NVML_PSTATE_5  Power state 5.
NVML_PSTATE_6  Power state 6.
NVML_PSTATE_7  Power state 7.
NVML_PSTATE_8  Power state 8.
NVML_PSTATE_9  Power state 9.
NVML_PSTATE_10  Power state 10.
NVML_PSTATE_11  Power state 11.
NVML_PSTATE_12  Power state 12.
NVML_PSTATE_13  Power state 13.
NVML_PSTATE_14  Power state 14.
NVML_PSTATE_15  Power state 15 -- Minimum Power.
NVML_PSTATE_UNKNOWN  Unknown power state.

Return values for nvml api calls.

Enumerator:
NVML_SUCCESS  The operation was successful.
NVML_ERROR_UNINITIALIZED  NVML was not first initialized with nvmlInit().
NVML_ERROR_INVALID_ARGUMENT  A supplied argument is invalid.
NVML_ERROR_NOT_SUPPORTED  The requested operation is not available on target device.
NVML_ERROR_NO_PERMISSION  The currrent user does not have permission for operation.
NVML_ERROR_ALREADY_INITIALIZED  NVML has already been initialized.
NVML_ERROR_NOT_FOUND  A query to find an object was unccessful.
NVML_ERROR_INSUFFICIENT_SIZE  An input argument is not large enough.
NVML_ERROR_INSUFFICIENT_POWER  A device's external power cables are not properly attached.
NVML_ERROR_UNKNOWN  An internal driver error occurred.

Temperature sensors.

Enumerator:
NVML_TEMPERATURE_GPU  Temperature sensor for the GPU die.


Generated on Tue Mar 15 21:18:02 2011