Ubuntu Manpages

Device Enums


enum nvmlEnableState_t { NVML_FEATURE_DISABLED = 0, NVML_FEATURE_ENABLED = 1 }
enum nvmlBrandType_t
enum nvmlTemperatureThresholds_t
enum nvmlTemperatureSensors_t { NVML_TEMPERATURE_GPU = 0 }
enum nvmlComputeMode_t { NVML_COMPUTEMODE_DEFAULT = 0, NVML_COMPUTEMODE_EXCLUSIVE_THREAD = 1, NVML_COMPUTEMODE_PROHIBITED = 2, NVML_COMPUTEMODE_EXCLUSIVE_PROCESS = 3 }
enum nvmlMemoryErrorType_t { NVML_MEMORY_ERROR_TYPE_CORRECTED = 0, NVML_MEMORY_ERROR_TYPE_UNCORRECTED = 1, NVML_MEMORY_ERROR_TYPE_COUNT }
enum nvmlEccCounterType_t { NVML_VOLATILE_ECC = 0, NVML_AGGREGATE_ECC = 1, NVML_ECC_COUNTER_TYPE_COUNT }
enum nvmlClockType_t { NVML_CLOCK_GRAPHICS = 0, NVML_CLOCK_SM = 1, NVML_CLOCK_MEM = 2, NVML_CLOCK_VIDEO = 3, NVML_CLOCK_COUNT }
enum nvmlClockId_t { NVML_CLOCK_ID_CURRENT = 0, NVML_CLOCK_ID_APP_CLOCK_TARGET = 1, NVML_CLOCK_ID_APP_CLOCK_DEFAULT = 2, NVML_CLOCK_ID_CUSTOMER_BOOST_MAX = 3, NVML_CLOCK_ID_COUNT }
enum nvmlDriverModel_t { NVML_DRIVER_WDDM = 0, NVML_DRIVER_WDM = 1 }
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 }
enum nvmlGpuOperationMode_t { NVML_GOM_ALL_ON = 0, NVML_GOM_COMPUTE = 1, NVML_GOM_LOW_DP = 2 }
enum nvmlInforomObject_t { NVML_INFOROM_OEM = 0, NVML_INFOROM_ECC = 1, NVML_INFOROM_POWER = 2, NVML_INFOROM_COUNT }
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_DRIVER_NOT_LOADED = 9, NVML_ERROR_TIMEOUT = 10, NVML_ERROR_IRQ_ISSUE = 11, NVML_ERROR_LIBRARY_NOT_FOUND = 12, NVML_ERROR_FUNCTION_NOT_FOUND = 13, NVML_ERROR_CORRUPTED_INFOROM = 14, NVML_ERROR_GPU_IS_LOST = 15, NVML_ERROR_RESET_REQUIRED = 16, NVML_ERROR_OPERATING_SYSTEM = 17, NVML_ERROR_LIB_RM_VERSION_MISMATCH = 18, NVML_ERROR_IN_USE = 19, NVML_ERROR_MEMORY = 20, NVML_ERROR_NO_DATA = 21, NVML_ERROR_VGPU_ECC_NOT_SUPPORTED = 22, NVML_ERROR_UNKNOWN = 999 }
enum nvmlMemoryLocation_t { NVML_MEMORY_LOCATION_L1_CACHE = 0, NVML_MEMORY_LOCATION_L2_CACHE = 1, NVML_MEMORY_LOCATION_DRAM = 2, NVML_MEMORY_LOCATION_DEVICE_MEMORY = 2, NVML_MEMORY_LOCATION_REGISTER_FILE = 3, NVML_MEMORY_LOCATION_TEXTURE_MEMORY = 4, NVML_MEMORY_LOCATION_TEXTURE_SHM = 5, NVML_MEMORY_LOCATION_CBU = 6, NVML_MEMORY_LOCATION_SRAM = 7, NVML_MEMORY_LOCATION_COUNT }
enum nvmlPageRetirementCause_t { NVML_PAGE_RETIREMENT_CAUSE_MULTIPLE_SINGLE_BIT_ECC_ERRORS = 0, NVML_PAGE_RETIREMENT_CAUSE_DOUBLE_BIT_ECC_ERROR = 1 }
enum nvmlRestrictedAPI_t { NVML_RESTRICTED_API_SET_APPLICATION_CLOCKS = 0, NVML_RESTRICTED_API_SET_AUTO_BOOSTED_CLOCKS = 1 }

Double bit ECC errors

Deprecated

Mapped to NVML_MEMORY_ERROR_TYPE_UNCORRECTED

Single bit ECC errors

Deprecated

Mapped to NVML_MEMORY_ERROR_TYPE_CORRECTED

ECC bit types.

Deprecated

See nvmlMemoryErrorType_t for a more flexible type

enum nvmlBrandType_t

* The Brand of the GPU

enum nvmlClockId_t

Clock Ids. These are used in combination with nvmlClockType_t to specify a single clock value.

Enumerator:

Current actual clock value.
Target application clock.
Default application clock target.
OEM-defined maximum clock rate.
Count of Clock Ids.

enum nvmlClockType_t

Clock types.

All speeds are in Mhz.

Enumerator:

Graphics clock domain.
SM clock domain.
Memory clock domain.
Video encoder/decoder clock domain.
Count of clock types.

enum nvmlComputeMode_t

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:

Default compute mode -- multiple contexts per device.
Support Removed.
Compute-prohibited mode -- no contexts per device.
Compute-exclusive-process mode -- only one context per device, usable from multiple threads at a time.

enum nvmlDriverModel_t

Driver models.

Windows only.

Enumerator:

WDDM driver model -- GPU treated as a display device.
WDM (TCC) model (recommended) -- GPU treated as a generic device.

enum nvmlEccCounterType_t

ECC counter types.

Note: Volatile counts are reset each time the driver loads. On Windows this is once per boot. On Linux this can be more frequent. On Linux the driver unloads when no active clients exist. If persistence mode is enabled or there is always a driver client active (e.g. X11), then Linux also sees per-boot behavior. If not, volatile counts are reset each time a compute app is run.

Enumerator:

Volatile counts are reset each time the driver loads.
Aggregate counts persist across reboots (i.e. for the lifetime of the device).
Count of memory counter types.

enum nvmlEnableState_t

Generic enable/disable enum.

Enumerator:

Feature disabled.
Feature enabled.

enum nvmlGpuOperationMode_t

GPU Operation Mode

GOM allows one to reduce power usage and optimize GPU throughput by disabling GPU features.

Each GOM is designed to meet specific user needs.

Enumerator:

Everything is enabled and running at full speed.
Designed for running only compute tasks. Graphics operations < are not allowed.
Designed for running graphics applications that don't require < high bandwidth double precision.

enum nvmlInforomObject_t

Available infoROM objects.

Enumerator:

An object defined by OEM.
The ECC object determining the level of ECC support.
The power management object.
This counts the number of infoROM objects the driver knows about.

enum nvmlMemoryErrorType_t

Memory error types

Enumerator:

A memory error that was corrected

For ECC errors, these are single bit errors For Texture memory, these are errors fixed by resend

A memory error that was not corrected

For ECC errors, these are double bit errors For Texture memory, these are errors where the resend fails

Count of memory error types.

enum nvmlMemoryLocation_t

See nvmlDeviceGetMemoryErrorCounter

Enumerator:

GPU L1 Cache.
GPU L2 Cache.
Turing+ DRAM.
GPU Device Memory.
GPU Register File.
GPU Texture Memory.
Shared memory.
CBU.
Turing+ SRAM.
This counts the number of memory locations the driver knows about.

enum nvmlPageRetirementCause_t

Causes for page retirement

Enumerator:

Page was retired due to multiple single bit ECC error.
Page was retired due to double bit ECC error.

enum nvmlPstates_t

Allowed PStates.

Enumerator:

Performance state 0 -- Maximum Performance.
Performance state 1.
Performance state 2.
Performance state 3.
Performance state 4.
Performance state 5.
Performance state 6.
Performance state 7.
Performance state 8.
Performance state 9.
Performance state 10.
Performance state 11.
Performance state 12.
Performance state 13.
Performance state 14.
Performance state 15 -- Minimum Performance.
Unknown performance state.

enum nvmlRestrictedAPI_t

API types that allow changes to default permission restrictions

Enumerator:

APIs that change application clocks, see nvmlDeviceSetApplicationsClocks < and see nvmlDeviceResetApplicationsClocks.
APIs that enable/disable Auto Boosted clocks < see nvmlDeviceSetAutoBoostedClocksEnabled.

enum nvmlReturn_t

Return values for NVML API calls.

Enumerator:

The operation was successful.
NVML was not first initialized with nvmlInit().
A supplied argument is invalid.
The requested operation is not available on target device.
The current user does not have permission for operation.
Deprecated: Multiple initializations are now allowed through ref counting.
A query to find an object was unsuccessful.
An input argument is not large enough.
A device's external power cables are not properly attached.
NVIDIA driver is not loaded.
User provided timeout passed.
NVIDIA Kernel detected an interrupt issue with a GPU.
NVML Shared Library couldn't be found or loaded.
Local version of NVML doesn't implement this function.
infoROM is corrupted
The GPU has fallen off the bus or has otherwise become inaccessible.
The GPU requires a reset before it can be used again.
The GPU control device has been blocked by the operating system/cgroups.
RM detects a driver/library version mismatch.
An operation cannot be performed because the GPU is currently in use.
Insufficient memory.
No data.
The requested vgpu operation is not available on target device, because ECC is enabled.
An internal driver error occurred.

enum nvmlTemperatureSensors_t

Temperature sensors.

Enumerator:

Temperature sensor for the GPU die.

enum nvmlTemperatureThresholds_t

Temperature thresholds.

Generated automatically by Doxygen for NVML from the source code.