Device Commands

This page describes NVML operations that change the state of the device. More...


Functions

nvmlReturn_t DECLDIR nvmlDeviceSetPersistenceMode (nvmlDevice_t device, nvmlEnableState_t mode)
 Set the persistence mode for the device.
nvmlReturn_t DECLDIR nvmlDeviceSetComputeMode (nvmlDevice_t device, nvmlComputeMode_t mode)
 Set the compute mode for the device.
nvmlReturn_t DECLDIR nvmlDeviceSetEccMode (nvmlDevice_t device, nvmlEnableState_t ecc)
 Set the ECC mode for the device.
nvmlReturn_t DECLDIR nvmlDeviceClearEccErrorCounts (nvmlDevice_t device, nvmlEccCounterType_t counterType)
 Clear the ECC error counts for the device.
nvmlReturn_t DECLDIR nvmlDeviceSetDriverModel (nvmlDevice_t device, nvmlDriverModel_t driverModel)
 Set the driver model for the device.


Detailed Description

This page describes NVML operations that change the state of the device.

Each of these requires root/admin access. Non-admin users will see an NVML_ERROR_NO_PERMISSION error code when invoking any of these methods.


Function Documentation

nvmlReturn_t DECLDIR nvmlDeviceClearEccErrorCounts ( nvmlDevice_t  device,
nvmlEccCounterType_t  counterType 
)

Clear the ECC error counts for the device.

For Fermi-class products only.

Sets all of the specified ECC counters to 0, including both detailed and total counts.

This operation takes effect immediately.

See nvmlEccCounterType_t for details on available counter types.

Parameters:
device The identifer of the target device
counterType Flag that indicates which type of errors should be cleared.
Returns:
See also:

nvmlReturn_t DECLDIR nvmlDeviceSetComputeMode ( nvmlDevice_t  device,
nvmlComputeMode_t  mode 
)

Set the compute mode for the device.

The compute mode determines whether a GPU can be used for compute operations and whether it can be shared across contexts.

This operation takes effect immediately. Under Linux it is not persistent across reboots and always resets to "Default". Under windows it is persistent.

See nvmlComputeMode_t for details on available compute modes.

Parameters:
device The identifer of the target device
mode The target compute mode
Returns:
See also:
nvmlDeviceGetComputeMode()

nvmlReturn_t DECLDIR nvmlDeviceSetDriverModel ( nvmlDevice_t  device,
nvmlDriverModel_t  driverModel 
)

Set the driver model for the device.

Windows-only.

On Windows platforms the device driver can run in either WDDM or WDM (TCC) mode. If a display is attached to the device it must run in WDDM mode.

This operation takes effect after the next reboot.

See nvmlDriverModel_t for details on available driver models.

Parameters:
device The identifer of the target device
driverModel The target driver model
Returns:
See also:
nvmlDeviceGetDriverModel()

nvmlReturn_t DECLDIR nvmlDeviceSetEccMode ( nvmlDevice_t  device,
nvmlEnableState_t  ecc 
)

Set the ECC mode for the device.

For Fermi-class products only.

The ECC mode determines whether the GPU enables its ECC support.

This operation takes effect after the next reboot.

See nvmlEnableState_t for details on available modes.

Parameters:
device The identifer of the target device
ecc The target ECC mode
Returns:
See also:
nvmlDeviceGetEccMode()

nvmlReturn_t DECLDIR nvmlDeviceSetPersistenceMode ( nvmlDevice_t  device,
nvmlEnableState_t  mode 
)

Set the persistence mode for the device.

Linux Only.

The persistence mode determines whether the GPU driver software is torn down after the last client exits.

This operation takes effect immediately. It is not persistent across reboots. After each reboot the persistence mode is set to "disabled".

See nvmlEnableState_t for available modes.

Parameters:
device The identifer of the target device
mode The target persistence mode
Returns:
See also:
nvmlDeviceGetPersistenceMode()


Generated on Tue Feb 8 09:10:21 2011