GPU access API: Library

Detailed Description

Modules
	GPU access API: Library (safety subset)

Functions
NvError	NvRmGpuLibAttachDevice (NvRmGpuLib *hLib, int deviceIndex)
	Attaches and powers up a GPU. More...
NvError	NvRmGpuLibDetachDevice (NvRmGpuLib *hLib, int deviceIndex)
	Powers down and detaches a GPU. More...

Function Documentation

NvRmGpuLibAttachDevice()

NvError NvRmGpuLibAttachDevice	(	NvRmGpuLib *	hLib,
		int	deviceIndex
	)

Attaches and powers up a GPU.

Parameters

[in]	hLib	Library handle
[in]	deviceIndex	GPU device index. See NvRmGpuLibListDevices().

Returns

The usual error code

Return values

NvSuccess	Device attached successfully
NvError_BadValue	Bad deviceIndex
NvError_NotSupported	This device does not support attach/detach functionality
NvError_AccessDenied	Insufficient user privileges
NvError_ResourceError	Device attachment failed. Likely, the device failed to boot.
NvError_*	Unspecified error. Error code returned for diagnostics.

Remarks

This is privileged functionality for system management purposes. Regular applications should not invoke this function.

Generally, only dGPUs can be attached and detached. The typical use case is zero-power idling (ZPI) for power saving when the dGPU is not required.

See also

NvRmGpuLibDetachDevice()

NvRmGpuLibDetachDevice()

NvError NvRmGpuLibDetachDevice	(	NvRmGpuLib *	hLib,
		int	deviceIndex
	)

Powers down and detaches a GPU.

Parameters

[in]	hLib	Library handle
[in]	deviceIndex	GPU device index. See NvRmGpuLibListDevices().

Returns

The usual error code

Return values

NvSuccess	Device detached successfully
NvError_BadValue	Bad deviceIndex
NvError_NotSupported	This device does not support attach/detach functionality
NvError_AccessDenied	Insufficient use privileges
NvError_ResourceError	Device attachment failed. Likely, the device failed to boot.
NvError_*	Unspecified error. Error code returned for diagnostics.

Remarks

This is privileged functionality for system management purposes. Regular applications should not invoke this function.

Generally, only dGPUs can be attached and detached. The typical use case is zero-power idling (ZPI) for power saving when the dGPU is not required.

See also

NvRmGpuLibAttachDevice()