System - General Interface <br>

Data Structures
struct	NV_CHIPSET_INFO_v4
struct	NV_CHIPSET_INFO_v3
struct	NV_CHIPSET_INFO_v2
struct	NV_CHIPSET_INFO_v1
struct	NV_LID_DOCK_PARAMS

Macros
#define	NV_CHIPSET_INFO_VER_1   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v1,1)
#define	NV_CHIPSET_INFO_VER_2   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v2,2)
#define	NV_CHIPSET_INFO_VER_3   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v3,3)
#define	NV_CHIPSET_INFO_VER_4   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v4,4)
#define	NV_CHIPSET_INFO   NV_CHIPSET_INFO_v4
#define	NV_CHIPSET_INFO_VER   NV_CHIPSET_INFO_VER_4

Enumerations
enum	NV_CHIPSET_INFO_FLAGS { NV_CHIPSET_INFO_HYBRID = 0x00000001 }

Functions
NVAPI_INTERFACE	NvAPI_SYS_GetChipSetInfo (NV_CHIPSET_INFO *pChipSetInfo)
NVAPI_INTERFACE	NvAPI_SYS_GetLidAndDockInfo (NV_LID_DOCK_PARAMS *pLidAndDock)
NVAPI_INTERFACE	NvAPI_SYS_GetDisplayIdFromGpuAndOutputId (NvPhysicalGpuHandle hPhysicalGpu, NvU32 outputId, NvU32 *displayId)
NVAPI_INTERFACE	NvAPI_SYS_GetGpuAndOutputIdFromDisplayId (NvU32 displayId, NvPhysicalGpuHandle *hPhysicalGpu, NvU32 *outputId)
NVAPI_INTERFACE	NvAPI_SYS_GetPhysicalGpuFromDisplayId (NvU32 displayId, NvPhysicalGpuHandle *hPhysicalGpu)
NVAPI_INTERFACE	NvAPI_SYS_GetPhysicalGPUs (__inout NV_PHYSICAL_GPUS *pPhysicalGPUs)
NVAPI_INTERFACE	NvAPI_SYS_GetLogicalGPUs (__inout NV_LOGICAL_GPUS *pLogicalGPUs)

Detailed Description

The System APIs retrieve chipset information such as vendor/device name and IDs, and CPU information such as processor type, speed, embedded CPU name, etc.

Macro Definition Documentation

NV_CHIPSET_INFO

#define NV_CHIPSET_INFO   NV_CHIPSET_INFO_v4

NV_CHIPSET_INFO_VER

#define NV_CHIPSET_INFO_VER   NV_CHIPSET_INFO_VER_4

NV_CHIPSET_INFO_VER_1

#define NV_CHIPSET_INFO_VER_1   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v1,1)

NV_CHIPSET_INFO_VER_2

#define NV_CHIPSET_INFO_VER_2   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v2,2)

NV_CHIPSET_INFO_VER_3

#define NV_CHIPSET_INFO_VER_3   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v3,3)

NV_CHIPSET_INFO_VER_4

#define NV_CHIPSET_INFO_VER_4   MAKE_NVAPI_VERSION(NV_CHIPSET_INFO_v4,4)

Enumeration Type Documentation

NV_CHIPSET_INFO_FLAGS

enum NV_CHIPSET_INFO_FLAGS

Enumerator
NV_CHIPSET_INFO_HYBRID

Function Documentation

NvAPI_SYS_GetChipSetInfo()

NVAPI_INTERFACE NvAPI_SYS_GetChipSetInfo

(

NV_CHIPSET_INFO *

pChipSetInfo

)

This function returns information about the system's chipset.

SUPPORTED OS: Windows 7 and higher

Since

Release: 95

Return values

NVAPI_INVALID_ARGUMENT	pChipSetInfo is NULL.
NVAPI_OK	*pChipSetInfo is now set.
NVAPI_INCOMPATIBLE_STRUCT_VERSION	NV_CHIPSET_INFO version not compatible with driver.

NvAPI_SYS_GetDisplayIdFromGpuAndOutputId()

NVAPI_INTERFACE NvAPI_SYS_GetDisplayIdFromGpuAndOutputId	(	NvPhysicalGpuHandle	hPhysicalGpu,
		NvU32	outputId,
		NvU32 *	displayId
	)

DESCRIPTION: This API converts a Physical GPU handle and output ID to a display ID.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	hPhysicalGpu	Handle to the physical GPU
[in]	outputId	Connected display output ID on the target GPU - must only have one bit set
[out]	displayId	Pointer to an NvU32 which contains the display ID

Return values

NVAPI_OK	- completed request
NVAPI_API_NOT_INTIALIZED	- NVAPI not initialized
NVAPI_ERROR	- miscellaneous error occurred
NVAPI_INVALID_ARGUMENT	- Invalid input parameter.

NvAPI_SYS_GetGpuAndOutputIdFromDisplayId()

NVAPI_INTERFACE NvAPI_SYS_GetGpuAndOutputIdFromDisplayId	(	NvU32	displayId,
		NvPhysicalGpuHandle *	hPhysicalGpu,
		NvU32 *	outputId
	)

DESCRIPTION: This API converts a display ID to a Physical GPU handle and output ID.

SUPPORTED OS: Windows 7 and higher

Parameters

[in]	displayId	Display ID of display to retrieve GPU and outputId for
[out]	hPhysicalGpu	Handle to the physical GPU
[out]	outputId	) Connected display output ID on the target GPU will only have one bit set.

Return values

NVAPI_OK
NVAPI_API_NOT_INTIALIZED
NVAPI_ID_OUT_OF_RANGE	The DisplayId corresponds to a display which is not within the normal outputId range.
NVAPI_ERROR
NVAPI_INVALID_ARGUMENT

NvAPI_SYS_GetLidAndDockInfo()

NVAPI_INTERFACE NvAPI_SYS_GetLidAndDockInfo

(

NV_LID_DOCK_PARAMS *

pLidAndDock

)

DESCRIPTION: This function returns the current lid and dock information.

SUPPORTED OS: Windows 7 and higher

Since

Release: 177

Return values

NVAPI_OK
NVAPI_ERROR
NVAPI_NOT_SUPPORTED
NVAPI_HANDLE_INVALIDATED
NVAPI_API_NOT_INTIALIZED

NvAPI_SYS_GetLogicalGPUs()

NVAPI_INTERFACE NvAPI_SYS_GetLogicalGPUs

(

__inout NV_LOGICAL_GPUS *

pLogicalGPUs

)

DESCRIPTION: This API will return the GPU handles for all the logical GPUs in the system. Additional metadata is also returned with each handle.

SUPPORTED OS: Windows 10 and higher

MCDM_SUPPORTED

Since

Release: 530

Parameters

[in,out]

pLogicalGPUs

- Pointer to the structure holding the logical GPU handle related information.

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

Return values

NVAPI_NVIDIA_DEVICE_NOT_FOUND

No GPU handles are enumerated.

NvAPI_SYS_GetPhysicalGpuFromDisplayId()

NVAPI_INTERFACE NvAPI_SYS_GetPhysicalGpuFromDisplayId	(	NvU32	displayId,
		NvPhysicalGpuHandle *	hPhysicalGpu
	)

DESCRIPTION:     This API retrieves the Physical GPU handle of the connected display
 
\since Release: 313
 
SUPPORTED OS:  Windows 7 and higher
 
 
PARAMETERS:      displayId(IN)     - Display ID of display to retrieve 
                                     GPU handle
                 hPhysicalGpu(OUT) - Handle to the physical GPU
 
RETURN STATUS:
                 NVAPI_OK - completed request
                 NVAPI_API_NOT_INTIALIZED - NVAPI not initialized
                 NVAPI_ERROR - miscellaneous error occurred
                 NVAPI_INVALID_ARGUMENT - Invalid input parameter.

NvAPI_SYS_GetPhysicalGPUs()

NVAPI_INTERFACE NvAPI_SYS_GetPhysicalGPUs

(

__inout NV_PHYSICAL_GPUS *

pPhysicalGPUs

)

DESCRIPTION: This API will return the GPU handles for all the physical GPUs in the system. Additional metadata is also returned with each handle.

SUPPORTED OS: Windows 10 and higher

TCC_SUPPORTED

MCDM_SUPPORTED

Since

Release: 530

Parameters

[in,out]

pPhysicalGPUs

- Pointer to the structure holding the physical GPU handle related information.

Returns

This API can return any of the error codes enumerated in NvAPI_Status. If there are return error codes with specific meaning for this API, they are listed below.

Return values

NVAPI_NVIDIA_DEVICE_NOT_FOUND

No GPU handles are enumerated.