Detailed Description

Manages GPU resources.

For related information, see Discrete GPU in the Development Guide.

General usage notes:

This library uses object-oriented design. In general, objects are referred by handles.
When destroying an object, the child objects are not destroyed by default. Additionally, it is an error to destroy a parent before its child.
In object creation, the attribute pointer (where applicable) can always be NULL, which indicates defaults.
In object creation, the first parameter specifies the parent. Some objects may be created for parents of different types.
Whenever a function that returns a new handle is invoked, the handle is guaranteed to be unique as well as the object it points to. There will be 1-to-1 mapping between handles and objects.
It is a fatal error to provide unexpected handle type. That will produce either an assert (debug builds) or undefined behavior (release builds)
In general, the const pointers returned by functions are valid as long as the related object is valid, unless otherwise stated. And in particular, they shall not be free'd by the caller. For example, the device list returned by NvRmGpuLibListDevices() is valid until the lib handle is closed, and the device info struct returned by NvRmGpuDeviceGetInfo() is valid until the device is closed.
This library is thread-safe with the following rule: an object can be closed only if there are no concurrent operations on-going on it. Attempting to close an object during an on-going operation is a fatal error.

Data Structures
struct	NvRmGpuLibOpenAttrRec

struct	NvRmGpuLibDeviceListEntryRec

struct	NvRmGpuDeviceOpenAttrRec

struct	NvRmGpuClockGetEntryRec

struct	NvRmGpuClockSetEntryRec

struct	NvRmGpuClockRangeRec

struct	NvRmGpuClockPointRec

struct	NvRmGpuClockDomainInfoRec

struct	NvRmGpuDeviceEventSessionOpenAttrRec
	Holds the events for which to listen. More...

struct	NvRmGpuDeviceEventInfoRec

Macros
#define	NVRM_GPU_DEFINE_LIB_OPEN_ATTR(x) NvRmGpuLibOpenAttr x = { 0 }

#define	NVRM_GPU_DEVICE_INDEX_DEFAULT (-1)

#define	NVRM_GPU_DEFINE_DEVICE_OPEN_ATTR(x) NvRmGpuDeviceOpenAttr x = { NvRmGpuSyncType_Default, false }

#define	NVRM_GPU_CLOCK_ASYNC_REQ_HANDLE_PRIFMT "p"
	NvRmGpuDevice subinterface for application-driven GPU clock frequency management. More...

#define	NVRM_GPU_DEFINE_DEVICE_EVENT_SESSION_ATTR(x) NvRmGpuDeviceEventSessionOpenAttr x = { NULL, 0 }

Typedefs
typedef struct NvRmGpuLibRec	NvRmGpuLib
	Library handle type. More...

typedef struct NvRmGpuDeviceRec	NvRmGpuDevice
	Device handle type. More...

typedef struct NvRmGpuLibOpenAttrRec	NvRmGpuLibOpenAttr

typedef struct NvRmGpuLibDeviceListEntryRec	NvRmGpuLibDeviceListEntry

typedef struct NvRmGpuDeviceOpenAttrRec	NvRmGpuDeviceOpenAttr

typedef struct NvRmGpuClockAsyncNotImplemented *	NvRmGpuClockAsyncReqHandle

typedef enum NvRmGpuClockDomain	NvRmGpuClockDomain
	Clock domains. More...

typedef enum NvRmGpuClockType	NvRmGpuClockType

typedef struct NvRmGpuClockGetEntryRec	NvRmGpuClockGetEntry

typedef struct NvRmGpuClockSetEntryRec	NvRmGpuClockSetEntry

typedef struct NvRmGpuClockRangeRec	NvRmGpuClockRange

typedef struct NvRmGpuClockPointRec	NvRmGpuClockPoint

typedef struct NvRmGpuClockDomainInfoRec	NvRmGpuClockDomainInfo

typedef struct NvRmGpuDeviceEventSessionRec	NvRmGpuDeviceEventSession

typedef struct NvRmGpuDeviceEventSessionOpenAttrRec	NvRmGpuDeviceEventSessionOpenAttr
	Holds the events for which to listen. More...

typedef struct NvRmGpuDeviceEventInfoRec	NvRmGpuDeviceEventInfo

Enumerations
enum	NvRmGpuDeviceState { NvRmGpuLibDeviceState_Detached, NvRmGpuLibDeviceState_Attached }

enum	NvRmGpuSyncType { NvRmGpuSyncType_Default, NvRmGpuSyncType_SyncFd, NvRmGpuSyncType_Syncpoint }

enum	NvRmGpuClockDomain { NvRmGpuClockDomain_MCLK = 0, NvRmGpuClockDomain_GPCCLK, NvRmGpuClockDomain_Count }
	Clock domains. More...

enum	NvRmGpuClockType { NvRmGpuClockType_Target = 1, NvRmGpuClockType_Actual, NvRmGpuClockType_Effective }

enum	NvRmGpuDeviceVoltage { NvRmGpuDeviceVoltage_Core = 1, NvRmGpuDeviceVoltage_SRAM, NvRmGpuDeviceVoltage_Bus }

enum	NvRmGpuDeviceCurrent { NvRmGpuDeviceCurrent_Bus = 1 }

enum	NvRmGpuDevicePower { NvRmGpuDevicePower_Bus = 1 }

enum	NvRmGpuDeviceTemperature { NvRmGpuDeviceTemperature_InternalSensor = 1 }

enum	NvRmGpuDeviceEventId { NvRmGpuDeviceEventId_VfUpdate = 0, NvRmGpuDeviceEventId_AlarmTargetVfNotPossible, NvRmGpuDeviceEventId_AlarmLocalTargetVfNotPossible, NvRmGpuDeviceEventId_AlarmClockArbiterFailed, NvRmGpuDeviceEventId_AlarmVfTableUpdateFailed, NvRmGpuDeviceEventId_AlarmThermalAboveThreshold, NvRmGpuDeviceEventId_AlarmPowerAboveThreshold, NvRmGpuDeviceEventId_AlarmGpuLost, NvRmGpuDeviceEventId_Count }
	Holds information about the GPU device event. More...

Functions
NvRmGpuLib *	NvRmGpuLibOpen (const NvRmGpuLibOpenAttr *attr)
	Opens a new instance of the library. More...

NvError	NvRmGpuLibClose (NvRmGpuLib *hlib)
	Closes the library and releases all resources. More...

const NvRmGpuLibDeviceListEntry *	NvRmGpuLibListDevices (NvRmGpuLib hlib, size_t pnumDevices)
	Returns a pointer to the device array. More...

NvError	NvRmGpuLibAttachDevice (NvRmGpuLib *const hlib, const int deviceIndex)
	Power up and attach a GPU. More...

NvError	NvRmGpuLibDetachDevice (NvRmGpuLib *const hlib, const int deviceIndex)
	Detach and power down a GPU. More...

NvError	NvRmGpuDeviceOpen (NvRmGpuLib hLib, int deviceIndex, const NvRmGpuDeviceOpenAttr attr, NvRmGpuDevice **phDevice)
	Opens the GPU device. More...

NvError	NvRmGpuDeviceClose (NvRmGpuDevice *hDevice)
	Closes the GPU device. More...

NvError	NvRmGpuClockGetDomains (NvRmGpuDevice hDevice, const NvRmGpuClockDomainInfo infos, size_t pNumDomains)
	Gets configurable clock domains. More...

NvError	NvRmGpuClockGetPoints (NvRmGpuDevice hDevice, NvRmGpuClockDomain domain, NvRmGpuClockPoint pClkPoints, size_t *pNumPoints)
	Gets VF points for a given clock domain. More...

NvError	NvRmGpuClockSet (NvRmGpuDevice hDevice, const NvRmGpuClockSetEntry pClkSetEntries, size_t numEntries, NvRmGpuClockAsyncReqHandle *phReq)
	Sets a clock request. More...

NvError	NvRmGpuClockWaitAsyncReq (NvRmGpuDevice hDevice, const NvRmGpuClockAsyncReqHandle phReqs, size_t numEntries, uint32_t timeoutMs)
	Waits for completion of one or more asynchronous requests. More...

NvError	NvRmGpuClockCloseAsyncReq (NvRmGpuDevice *hDevice, NvRmGpuClockAsyncReqHandle hReq)
	Closes an asynchronous request handle. More...

NvError	NvRmGpuClockWaitAnyEvent (NvRmGpuDevice *hDevice, uint32_t timeoutMs)
	Waits on any clock update event. More...

NvError	NvRmGpuClockGet (NvRmGpuDevice hDevice, NvRmGpuClockGetEntry pClkGetEntries, size_t numEntries)
	Gets clock state(s). More...

NvError	NvRmGpuDeviceGetLoad (NvRmGpuDevice hDevice, uint32_t pLoadPerMille)
	Gets gpu load. More...

NvError	NvRmGpuDeviceListVoltageSensors (NvRmGpuDevice hDevice, const NvRmGpuDeviceVoltage pSensors, size_t numSensors)
	Gets a list of the available voltage sensors. More...

NvError	NvRmGpuDeviceGetVoltage (NvRmGpuDevice hDevice, NvRmGpuDeviceVoltage which, uint64_t pVoltageMicroVolt)
	Gets the current voltage. More...

NvError	NvRmGpuDeviceListCurrentSensors (NvRmGpuDevice hDevice, const NvRmGpuDeviceCurrent pSensors, size_t numSensors)
	Gets a list of the available current sensors. More...

NvError	NvRmGpuDeviceGetCurrent (NvRmGpuDevice hDevice, NvRmGpuDeviceCurrent which, uint64_t pCurrentMicroAmpere)
	Gets the current drawn by the GPU. More...

NvError	NvRmGpuDeviceListPowerSensors (NvRmGpuDevice hDevice, const NvRmGpuDevicePower pSensors, size_t numSensors)
	Gets a list of the available power sensors. More...

NvError	NvRmGpuDeviceGetPower (NvRmGpuDevice hDevice, NvRmGpuDevicePower which, uint64_t pPowerMicroWatt)
	Gets the power consumed by the GPU. More...

NvError	NvRmGpuDeviceListTemperatureSensors (NvRmGpuDevice hDevice, const NvRmGpuDeviceTemperature pSensors, size_t numSensors)
	Gets the list of available temperature sensors. More...

NvError	NvRmGpuDeviceGetTemperature (NvRmGpuDevice hDevice, NvRmGpuDeviceTemperature which, int32_t pTemperatureMilliCelsius)
	Gets the temperature. More...

NvError	NvRmGpuDeviceThermalAlertSetLimit (NvRmGpuDevice *hDevice, int32_t temperature_mC)
	Sets the thermal alert limit. More...

static void	NvRmGpuDeviceEventSessionOpenAttrSetAllEvents (NvRmGpuDeviceEventSessionOpenAttr *attr)

NvError	NvRmGpuDeviceEventSessionOpen (NvRmGpuDevice hDevice, const NvRmGpuDeviceEventSessionOpenAttr attr, NvRmGpuDeviceEventSession **phSession)
	Opens the session to monitor device events. More...

NvError	NvRmGpuDeviceEventSessionRead (NvRmGpuDeviceEventSession hSession, NvRmGpuDeviceEventInfo pEventInfo, uint32_t timeoutMs)
	Reads detailed event information from the event session. More...

NvError	NvRmGpuDeviceEventSessionClose (NvRmGpuDeviceEventSession *hSession)
	Closes the event session. More...

Macro Definition Documentation

#define NVRM_GPU_CLOCK_ASYNC_REQ_HANDLE_PRIFMT "p"

NvRmGpuDevice subinterface for application-driven GPU clock frequency management.

The lifespan of GPU clock requests is tied to the NvRmGpuDevice instance. All requests are canceled when the NvRmGpuDevice handle is closed.
The clock requests of all NvRmGpuDevice instances are coalesced. Generally, given that thermal and power limits are not exceeded, the actual clock frequency will be at least the greatest requested. The exact selection algorithm depends on the global clock management driver policy. The selection algorithm is run by the "clock arbiter".
Each clock domain has VF points, defined as frequencies for which voltage is optimal. The clock arbiter will try to program frequencies which correspond to VF points.
A single clock request can set target frequencies for multiple clock domains
Clock requests can be either synchronous or asynchronous. In asynchronous mode a request handle is allocated and can be used to wait for request completion. This request handle must be freed by application.
It is possible to wait for any clock change event, in order to detect clock changes that originated from other applications or thermal conditions.

Definition at line 245 of file nvrm_gpu.h.

#define NVRM_GPU_DEFINE_DEVICE_EVENT_SESSION_ATTR ( x ) NvRmGpuDeviceEventSessionOpenAttr x = { NULL, 0 }

Definition at line 624 of file nvrm_gpu.h.

#define NVRM_GPU_DEFINE_DEVICE_OPEN_ATTR ( x ) NvRmGpuDeviceOpenAttr x = { NvRmGpuSyncType_Default, false }

Definition at line 190 of file nvrm_gpu.h.

#define NVRM_GPU_DEFINE_LIB_OPEN_ATTR ( x ) NvRmGpuLibOpenAttr x = { 0 }

Definition at line 94 of file nvrm_gpu.h.

#define NVRM_GPU_DEVICE_INDEX_DEFAULT (-1)

Definition at line 161 of file nvrm_gpu.h.

Typedef Documentation

typedef struct NvRmGpuClockAsyncNotImplemented* NvRmGpuClockAsyncReqHandle

Definition at line 246 of file nvrm_gpu.h.

typedef enum NvRmGpuClockDomain NvRmGpuClockDomain

Clock domains.

typedef struct NvRmGpuClockDomainInfoRec NvRmGpuClockDomainInfo

typedef struct NvRmGpuClockGetEntryRec NvRmGpuClockGetEntry

typedef struct NvRmGpuClockPointRec NvRmGpuClockPoint

typedef struct NvRmGpuClockRangeRec NvRmGpuClockRange

typedef struct NvRmGpuClockSetEntryRec NvRmGpuClockSetEntry

typedef enum NvRmGpuClockType NvRmGpuClockType

typedef struct NvRmGpuDeviceRec NvRmGpuDevice

Device handle type.

Definition at line 83 of file nvrm_gpu.h.

typedef struct NvRmGpuDeviceEventInfoRec NvRmGpuDeviceEventInfo

typedef struct NvRmGpuDeviceEventSessionRec NvRmGpuDeviceEventSession

Definition at line 613 of file nvrm_gpu.h.

typedef struct NvRmGpuDeviceEventSessionOpenAttrRec NvRmGpuDeviceEventSessionOpenAttr

Holds the events for which to listen.

typedef struct NvRmGpuDeviceOpenAttrRec NvRmGpuDeviceOpenAttr

typedef struct NvRmGpuLibRec NvRmGpuLib

Library handle type.

Definition at line 81 of file nvrm_gpu.h.

typedef struct NvRmGpuLibDeviceListEntryRec NvRmGpuLibDeviceListEntry

typedef struct NvRmGpuLibOpenAttrRec NvRmGpuLibOpenAttr

Enumeration Type Documentation

enum NvRmGpuClockDomain

Clock domains.

Enumerator
NvRmGpuClockDomain_MCLK	Memory clock.
NvRmGpuClockDomain_GPCCLK	Main graphics core clock.
NvRmGpuClockDomain_Count

Definition at line 252 of file nvrm_gpu.h.

enum NvRmGpuClockType

Enumerator
NvRmGpuClockType_Target	Target clock frequency requested by application.
NvRmGpuClockType_Actual	Actual clock frequency programmed (including PLL constraints).
NvRmGpuClockType_Effective	Effective clock, measured from hardware.

Definition at line 259 of file nvrm_gpu.h.

enum NvRmGpuDeviceCurrent

Enumerator
NvRmGpuDeviceCurrent_Bus

Definition at line 481 of file nvrm_gpu.h.

enum NvRmGpuDeviceEventId

Holds information about the GPU device event.

Enumerator
NvRmGpuDeviceEventId_VfUpdate	VF update occurred for a clock domain, either because one session changed target frequency or because of thermal or power conditions.
NvRmGpuDeviceEventId_AlarmTargetVfNotPossible	One clock domain frequency is below target.
NvRmGpuDeviceEventId_AlarmLocalTargetVfNotPossible	One clock domain frequency is below local target frequency requested by one session.
NvRmGpuDeviceEventId_AlarmClockArbiterFailed	Clock Arbiter failed.
NvRmGpuDeviceEventId_AlarmVfTableUpdateFailed	Vf table update failed.
NvRmGpuDeviceEventId_AlarmThermalAboveThreshold	Temperature above threshold.
NvRmGpuDeviceEventId_AlarmPowerAboveThreshold	Power above threshold.
NvRmGpuDeviceEventId_AlarmGpuLost	GPU lost (non-recoverable).
NvRmGpuDeviceEventId_Count	Number of events.

Definition at line 590 of file nvrm_gpu.h.

enum NvRmGpuDevicePower

Enumerator
NvRmGpuDevicePower_Bus

Definition at line 513 of file nvrm_gpu.h.

enum NvRmGpuDeviceState

Enumerator
NvRmGpuLibDeviceState_Detached
NvRmGpuLibDeviceState_Attached

Definition at line 111 of file nvrm_gpu.h.

enum NvRmGpuDeviceTemperature

Enumerator
NvRmGpuDeviceTemperature_InternalSensor

Definition at line 546 of file nvrm_gpu.h.

enum NvRmGpuDeviceVoltage

Enumerator
NvRmGpuDeviceVoltage_Core
NvRmGpuDeviceVoltage_SRAM
NvRmGpuDeviceVoltage_Bus

Definition at line 448 of file nvrm_gpu.h.

enum NvRmGpuSyncType

Enumerator
NvRmGpuSyncType_Default
NvRmGpuSyncType_SyncFd
NvRmGpuSyncType_Syncpoint

Definition at line 163 of file nvrm_gpu.h.

Function Documentation

NvError NvRmGpuClockCloseAsyncReq	(	NvRmGpuDevice *	hDevice,
		NvRmGpuClockAsyncReqHandle	hReq
	)

Closes an asynchronous request handle.

Frees all resources related to an asynchronous request. It is not mandatory to wait for request completion, before closing the handle.

Parameters

hDevice	GPU device handle.
hReq	Request handle obtained from NvRmGpuClockSet.

Returns: NvSuccess indicates that handle was closed.

NvError NvRmGpuClockGet	(	NvRmGpuDevice *	hDevice,
		NvRmGpuClockGetEntry *	pClkGetEntries,
		size_t	numEntries
	)

Gets clock state(s).

Parameters

[in]	hDevice	GPU device handle
[out]	pClkGetEntries	Array of clock entries. For each entry, the clock domain and clock types MUST be set, and the associated frequency will be returned on a successful call. It is allowed to mix several clocks domains and clock types in the same request.
[out]	numEntries	Number of entries to query

Returns: NvSuccess indicates that request was successful.

NvError NvRmGpuClockGetDomains	(	NvRmGpuDevice *	hDevice,
		const NvRmGpuClockDomainInfo **	infos,
		size_t *	pNumDomains
	)

Gets configurable clock domains.

Parameters

[in]	hDevice	GPU device handle.
[out]	infos	Array of configurable clock domains. This list is valid only during the life-time of the hDevice handle.
[out]	pNumDomains	Number of domains in array.

Returns: NvSuccess indicates that request was successful.

NvError NvRmGpuClockGetPoints	(	NvRmGpuDevice *	hDevice,
		NvRmGpuClockDomain	domain,
		NvRmGpuClockPoint *	pClkPoints,
		size_t *	pNumPoints
	)

Gets VF points for a given clock domain.

For information about VF points, see NvRmGpuClockAsyncReqHandle.

Parameters

[in]	hDevice	GPU device handle.
[in]	domain	Clock domain to query.
[in,out]	pClkPoints	Array of optimal Voltage/Frequency points. The allocated array must contain space for at least NvRmGpuClockDomainInfo::maxVfPoints (as retrieved by NvRmGpuClockGetDomains())
[out]	pNumPoints	Number of VF points. May vary depending on thermal conditions, and be lower than maxPoints.

Returns: NvSuccess indicates that request was successful.

NvError NvRmGpuClockSet	(	NvRmGpuDevice *	hDevice,
		const NvRmGpuClockSetEntry *	pClkSetEntries,
		size_t	numEntries,
		NvRmGpuClockAsyncReqHandle *	phReq
	)

Sets a clock request.

Parameters

[in]	hDevice	GPU device handle.
[in]	pClkSetEntries	Array of entries. Each entry specifies target frequency for one clock domain. If a clock domain appears multiple times, then only last entry will be taken into account.
[in]	numEntries	Number of entries in the pClkSetEntries array.
[in,out]	phReq	A pointer to request handle. (in) If NULL, the request is synchronous and function waits until all clocks are programmed. Otherwise, the request is asynchronous and is assigned a request handle. The application may wait for asynchronous request completion using NvRmGpuClockWaitAsync(). The request handle MUST be freed by the application using NvRmGpuClockCloseAsyncReq(). (out) The request handle that was assigned to this asynchronous request.

Returns: NvSuccess indicates that the request has completed in the synchronous case, and that the request was successfully submitted in the asynchronous case. NvError_Busy indicates that an asynchronous request could not be submitted, and application should try again.

Note

A subsequent clock request to a domain supersedes the previous request
Actual frequency might differ depending on global policies, requests from other NvRmGpuDevice instances, or thermal conditions.
If specified target frequency is not a VF point, clock arbiter will try to program the clocks with first VF point that is greater than or equal to specified target frequency (assuming a single application)
All clock requests will be cancelled when hDevice is closed.

NvError NvRmGpuClockWaitAnyEvent	(	NvRmGpuDevice *	hDevice,
		uint32_t	timeoutMs
	)

Waits on any clock update event.

Parameters

hDevice	GPU device handle
timeoutMs	Timeout value in milliseconds. `NV_WAIT_INFINITE` for no timeout.

Returns: NvSuccess indicates that we received a clock change event. NvError_Timeout indicates that timeout was reached.

Note: If several clock changes occurred between two calls to this function, then a single event will be reported.

NvError NvRmGpuClockWaitAsyncReq	(	NvRmGpuDevice *	hDevice,
		const NvRmGpuClockAsyncReqHandle *	phReqs,
		size_t	numEntries,
		uint32_t	timeoutMs
	)

Waits for completion of one or more asynchronous requests.

Parameters

hDevice	GPU device handle.
phReqs	Array of request handles.
numEntries	Number of entries in array.
timeoutMs	Timeout value in milliseconds. Set this value as follows: `timeoutMs = <positive integer>` for time-limited polling, where the function returns when the request completes or when the timeout expires, whichever comes first. `timeoutMs = 0` specifies open-ended polling, where the function returns only when the request has completed.

Returns: NvSuccess indicates that requests have completed. NvError_Timeout indicates that timeout was reached.

NvError NvRmGpuDeviceClose ( NvRmGpuDevice * hDevice )

Closes the GPU device.

Returns: NvSuccess if closing the device object was successful. Regardless of possible errors in deinitialization, the device object will be closed.

NvError NvRmGpuDeviceEventSessionClose ( NvRmGpuDeviceEventSession * hSession )

Closes the event session.

Parameters

hSession Event session handle

Returns: NvSuccess if closing the object was successful. Regardless of possible errors in deinitialization, the object will be closed.

NvError NvRmGpuDeviceEventSessionOpen	(	NvRmGpuDevice *	hDevice,
		const NvRmGpuDeviceEventSessionOpenAttr *	attr,
		NvRmGpuDeviceEventSession **	phSession
	)

Opens the session to monitor device events.

Parameters

[in]	hDevice	GPU device handle.
[in]	attr	Event session attributes, including event filter.
[out]	phSession	A pointer to the event session handle.

Returns: NvSuccess if event session could be created.

static void NvRmGpuDeviceEventSessionOpenAttrSetAllEvents ( NvRmGpuDeviceEventSessionOpenAttr * attr )

inlinestatic

Definition at line 627 of file nvrm_gpu.h.

References NvRmGpuDeviceEventSessionOpenAttrRec::filterList, NvRmGpuDeviceEventSessionOpenAttrRec::filterListSize, NvRmGpuDeviceEventId_AlarmClockArbiterFailed, NvRmGpuDeviceEventId_AlarmGpuLost, NvRmGpuDeviceEventId_AlarmLocalTargetVfNotPossible, NvRmGpuDeviceEventId_AlarmPowerAboveThreshold, NvRmGpuDeviceEventId_AlarmTargetVfNotPossible, NvRmGpuDeviceEventId_AlarmThermalAboveThreshold, NvRmGpuDeviceEventId_AlarmVfTableUpdateFailed, and NvRmGpuDeviceEventId_VfUpdate.

NvError NvRmGpuDeviceEventSessionRead	(	NvRmGpuDeviceEventSession *	hSession,
		NvRmGpuDeviceEventInfo *	pEventInfo,
		uint32_t	timeoutMs
	)

Reads detailed event information from the event session.

Parameters

[in]	hSession	Event session handle
[out]	pEventInfo	Detailed event information
[in]	timeoutMs	Timeout value in milliseconds. NVRM_GPU_CLK_WAIT_INFINITE to wait infinitely.

Returns: NvSuccess indicates that one event occurred, and detailed information has been updated in pEventInfo. NvError_Timeout indicates that timeout was reached.

Note: If several identical events occur between two calls to this function, then a single event will be reported. After this call, related event information is cleared.

NvError NvRmGpuDeviceGetCurrent	(	NvRmGpuDevice *	hDevice,
		NvRmGpuDeviceCurrent	which,
		uint64_t *	pCurrentMicroAmpere
	)

Gets the current drawn by the GPU.

Parameters

[in]	hDevice	GPU device handle.
[in]	which	The current to query.
[out]	pCurrentMicroAmpere	Current in microamperes.

Returns: : NvSuccess or NvError_NotSupported

NvError NvRmGpuDeviceGetLoad	(	NvRmGpuDevice *	hDevice,
		uint32_t *	pLoadPerMille
	)

Gets gpu load.

Parameters

[in]	hDevice	GPU device handle
[out]	pLoadPerMille	GPU load in permille

Returns: NvSuccess indicates that request was successful.

NvError NvRmGpuDeviceGetPower	(	NvRmGpuDevice *	hDevice,
		NvRmGpuDevicePower	which,
		uint64_t *	pPowerMicroWatt
	)

Gets the power consumed by the GPU.

Parameters

[in]	hDevice	GPU device handle.
[in]	which	The Power to query.
[out]	pPowerMicroWatt	Power in microwatts.

Returns: : NvSuccess or NvError_NotSupported.

NvError NvRmGpuDeviceGetTemperature	(	NvRmGpuDevice *	hDevice,
		NvRmGpuDeviceTemperature	which,
		int32_t *	pTemperatureMilliCelsius
	)

Gets the temperature.

Parameters

[in]	hDevice	GPU device handle.
[in]	which	Temperature sensor to query.
[out]	pTemperatureMilliCelsius	Temperature in millidegrees Celsius.

Returns: : NvSuccess or NvError_NotSupported

NvError NvRmGpuDeviceGetVoltage	(	NvRmGpuDevice *	hDevice,
		NvRmGpuDeviceVoltage	which,
		uint64_t *	pVoltageMicroVolt
	)

Gets the current voltage.

Parameters

[in]	hDevice	GPU device handle
[in]	which	The voltage to query
[out]	pVoltageMicroVolt	Voltage in microvolts.

Returns: : NvSuccess or NvError_NotSupported

NvError NvRmGpuDeviceListCurrentSensors	(	NvRmGpuDevice *	hDevice,
		const NvRmGpuDeviceCurrent **	pSensors,
		size_t *	numSensors
	)

Gets a list of the available current sensors.

Parameters

[in]	hDevice	GPU device handle.
[out]	pSensors	List of available sensors (may be NULL if no sensor is available).
[out]	numSensors	Number of sensors available.

Returns: : NvSuccess on successful operation.

NvError NvRmGpuDeviceListPowerSensors	(	NvRmGpuDevice *	hDevice,
		const NvRmGpuDevicePower **	pSensors,
		size_t *	numSensors
	)

Gets a list of the available power sensors.

Parameters

[in]	hDevice	GPU device handle.
[out]	pSensors	List of available sensors (may be NULL if no sensor is available).
[out]	numSensors	Number of sensors available.

Returns: : NvSuccess on successful operation.

NvError NvRmGpuDeviceListTemperatureSensors	(	NvRmGpuDevice *	hDevice,
		const NvRmGpuDeviceTemperature **	pSensors,
		size_t *	numSensors
	)

Gets the list of available temperature sensors.

Parameters

[in]	hDevice	GPU device handle
[out]	pSensors	List of available sensors (may be NULL if no sensor is available).
[out]	numSensors	Number of sensors available.

Returns: : NvSuccess on successful operation.

NvError NvRmGpuDeviceListVoltageSensors	(	NvRmGpuDevice *	hDevice,
		const NvRmGpuDeviceVoltage **	pSensors,
		size_t *	numSensors
	)

Gets a list of the available voltage sensors.

Parameters

[in]	hDevice	GPU device handle
[out]	pSensors	List of available sensors (may be NULL if no sensor is available)
[out]	numSensors	Number of sensors available

Returns: : NvSuccess on successful operation.

NvError NvRmGpuDeviceOpen	(	NvRmGpuLib *	hLib,
		int	deviceIndex,
		const NvRmGpuDeviceOpenAttr *	attr,
		NvRmGpuDevice **	phDevice
	)

Opens the GPU device.

Note: Do not assume that the device indexes are sequential and start from zero. Use the NVRM_GPU_DEVICE_INDEX_DEFAULT for the primary GPU when the system has more than one GPU.; Only attached GPUs can be opened. A detached GPU can be attached with help of NvRmGpuLibAttachDevice(deviceIndex).

NvError NvRmGpuDeviceThermalAlertSetLimit	(	NvRmGpuDevice *	hDevice,
		int32_t	temperature_mC
	)

Sets the thermal alert limit.

Parameters

hDevice	GPU device handle.
temperature_mC	Thermal temperature alert limit value in millidegrees Celsius.

Returns: NvSuccess indicates that request was successful.

NvError NvRmGpuLibAttachDevice	(	NvRmGpuLib *const	hlib,
		const int	deviceIndex
	)

Power up and attach a GPU.

hlib: handle to nvrm gpu lib. deviceIndex: GPU device index.

Returns NvSuccess on a succesful GPU attach. Returns NvError otherwise.

NvError NvRmGpuLibClose ( NvRmGpuLib * hlib )

Closes the library and releases all resources.

Returns: NvSuccess if closing the library was successful. Regardless of possible errors in deinitialization, the library object will be closed.

NvError NvRmGpuLibDetachDevice	(	NvRmGpuLib *const	hlib,
		const int	deviceIndex
	)

Detach and power down a GPU.

hlib: handle to nvrm gpu lib. deviceIndex: GPU device index.

Returns NvSuccess on a succesful GPU power-off. Returns NvError otherwise.

const NvRmGpuLibDeviceListEntry* NvRmGpuLibListDevices	(	NvRmGpuLib *	hlib,
		size_t *	pnumDevices
	)

Returns a pointer to the device array.

The size of the array is returned in pnumDevices. pnumDevices must be non-NULL.

The returned pointer is valid until the library is closed. The caller must not attempt to free the pointer.

Remarks:

The first device listed will always be considered the primary GPU.
The device index numbers returned will be non-negative, unique and in ascending order. Numbering may be discontiguous, and specifically, the index numbers will likely not start at 0.
Negative index numbers are reserved for pseudo indexes used by NvRmGpuDeviceOpen().

NvRmGpuLib* NvRmGpuLibOpen ( const NvRmGpuLibOpenAttr * attr )

Opens a new instance of the library.

There can be multiple concurrent instances.

NVIDIA DRIVE OS Linux SDK API Reference

5.1.6.0 Release

Detailed Description

Data Structures

Macros

Typedefs

Enumerations

Functions

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation