GPU ECC Interface

Data Structures
struct	NV_GPU_ECC_STATUS_INFO
struct	NV_GPU_ECC_ERROR_INFO
struct	NV_GPU_ECC_CONFIGURATION_INFO

Macros
#define	NV_GPU_ECC_STATUS_INFO_VER   MAKE_NVAPI_VERSION(NV_GPU_ECC_STATUS_INFO,1)
#define	NV_GPU_ECC_ERROR_INFO_VER   MAKE_NVAPI_VERSION(NV_GPU_ECC_ERROR_INFO,1)
#define	NV_GPU_ECC_CONFIGURATION_INFO_VER   MAKE_NVAPI_VERSION(NV_GPU_ECC_CONFIGURATION_INFO,1)

Functions
NVAPI_INTERFACE	NvAPI_GPU_GetECCStatusInfo (NvPhysicalGpuHandle hPhysicalGpu, NV_GPU_ECC_STATUS_INFO *pECCStatusInfo)
NVAPI_INTERFACE	NvAPI_GPU_ResetECCErrorInfo (NvPhysicalGpuHandle hPhysicalGpu, NvU8 bResetCurrent, NvU8 bResetAggregate)
NVAPI_INTERFACE	NvAPI_GPU_GetECCConfigurationInfo (NvPhysicalGpuHandle hPhysicalGpu, NV_GPU_ECC_CONFIGURATION_INFO *pECCConfigurationInfo)
NVAPI_INTERFACE	NvAPI_GPU_SetECCConfiguration (NvPhysicalGpuHandle hPhysicalGpu, NvU8 bEnable, NvU8 bEnableImmediately)
NVAPI_INTERFACE	NvAPI_GPU_GetECCErrorInfo (NvPhysicalGpuHandle hPhysicalGpu, NV_GPU_ECC_ERROR_INFO *pECCErrorInfo)

Detailed Description

The GPU ECC APIs are used to configure ECC-capable GPUs.

Used in NV_GPU_ECC_STATUS_INFO.

Macro Definition Documentation

#define NV_GPU_ECC_CONFIGURATION_INFO_VER   MAKE_NVAPI_VERSION(NV_GPU_ECC_CONFIGURATION_INFO,1)

Macro for consstructing the verion field of NV_GPU_ECC_CONFIGURATION_INFO

#define NV_GPU_ECC_ERROR_INFO_VER   MAKE_NVAPI_VERSION(NV_GPU_ECC_ERROR_INFO,1)

Macro for constructing the version field of NV_GPU_ECC_ERROR_INFO

#define NV_GPU_ECC_STATUS_INFO_VER   MAKE_NVAPI_VERSION(NV_GPU_ECC_STATUS_INFO,1)

Macro for constructing the version field of NV_GPU_ECC_STATUS_INFO

Function Documentation

NvAPI_GPU_GetECCConfigurationInfo	(	NvPhysicalGpuHandle	hPhysicalGpu,
		NV_GPU_ECC_CONFIGURATION_INFO *	pECCConfigurationInfo
	)

DESCRIPTION: This function returns ECC memory configuration information.

SUPPORTED OS: Windows XP and higher

TCC_SUPPORTED

Parameters

[in]	hPhysicalGpu	A handle identifying the physical GPU for which ECC configuration information is to be retrieved.
[out]	pECCConfigurationInfo	A pointer to an ECC configuration structure.

Return values

NVAPI_OK	The request was completed successfully.
NVAPI_ERROR	An unknown error occurred.
NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	The provided GPU handle is not a physical GPU handle.
NVAPI_INVALID_HANDLE	The provided GPU handle is invalid.
NVAPI_HANDLE_INVALIDATED	The provided GPU handle is no longer valid.
NVAPI_INVALID_POINTER	An invalid argument pointer was provided.
NVAPI_NOT_SUPPORTED	The request is not supported.
NVAPI_API_NOT_INTIALIZED	NvAPI was not yet initialized.

NvAPI_GPU_GetECCErrorInfo	(	NvPhysicalGpuHandle	hPhysicalGpu,
		NV_GPU_ECC_ERROR_INFO *	pECCErrorInfo
	)

DESCRIPTION: This function returns ECC memory error information.

SUPPORTED OS: Windows XP and higher

TCC_SUPPORTED

Parameters

[in]	hPhysicalGpu	A handle identifying the physical GPU for which ECC error information is to be retrieved.
[out]	pECCErrorInfo	A pointer to an ECC error structure.

Return values

NVAPI_OK	The request was completed successfully.
NVAPI_ERROR	An unknown error occurred.
NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	The provided GPU handle is not a physical GPU handle.
NVAPI_INVALID_ARGUMENT	incorrect param value
NVAPI_INVALID_POINTER	An invalid argument pointer was provided.
NVAPI_INCOMPATIBLE_STRUCT_VERSION	structure version is not supported, initialize to NV_GPU_ECC_ERROR_INFO_VER.
NVAPI_HANDLE_INVALIDATED	The provided GPU handle is no longer valid.
NVAPI_NOT_SUPPORTED	The request is not supported.
NVAPI_API_NOT_INTIALIZED	NvAPI was not yet initialized.

NvAPI_GPU_GetECCStatusInfo	(	NvPhysicalGpuHandle	hPhysicalGpu,
		NV_GPU_ECC_STATUS_INFO *	pECCStatusInfo
	)

DESCRIPTION: This function returns ECC memory status information.

SUPPORTED OS: Windows XP and higher

TCC_SUPPORTED

Parameters

[in]	hPhysicalGpu	A handle identifying the physical GPU for which ECC status information is to be retrieved.
[out]	pECCStatusInfo	A pointer to an ECC status structure.

Return values

NVAPI_OK	The request was completed successfully.
NVAPI_ERROR	An unknown error occurred.
NVAPI_EXPECTED_PHYSICAL_GPU_HANDLE	The provided GPU handle is not a physical GPU handle.
NVAPI_INVALID_HANDLE	The provided GPU handle is invalid.
NVAPI_HANDLE_INVALIDATED	The provided GPU handle is no longer valid.
NVAPI_INVALID_POINTER	An invalid argument pointer was provided.
NVAPI_NOT_SUPPORTED	The request is not supported.
NVAPI_API_NOT_INTIALIZED	NvAPI was not yet initialized.

NVAPI_INTERFACE NvAPI_GPU_ResetECCErrorInfo	(	NvPhysicalGpuHandle	hPhysicalGpu,
		NvU8	bResetCurrent,
		NvU8	bResetAggregate
	)

DESCRIPTION: This function resets ECC memory error counters.

SUPPORTED OS: Windows XP and higher

TCC_SUPPORTED

Parameters

[in]	hPhysicalGpu	A handle identifying the physical GPU for which ECC error information is to be cleared.
[in]	bResetCurrent	Reset the current ECC error counters.
[in]	bResetAggregate	Reset the aggregate ECC error counters.

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_INVALID_USER_PRIVILEGE

- The caller does not have administrative privileges

NVAPI_INTERFACE NvAPI_GPU_SetECCConfiguration	(	NvPhysicalGpuHandle	hPhysicalGpu,
		NvU8	bEnable,
		NvU8	bEnableImmediately
	)

DESCRIPTION: This function updates the ECC memory configuration setting.

SUPPORTED OS: Windows XP and higher

TCC_SUPPORTED

Parameters

[in]	hPhysicalGpu	A handle identifying the physical GPU for which to update the ECC configuration setting.
[in]	bEnable	The new ECC configuration setting.
[in]	bEnableImmediately	Request that the new setting take effect immediately.

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_INVALID_CONFIGURATION	- Possibly SLI is enabled. Disable SLI and retry.
NVAPI_INVALID_USER_PRIVILEGE	- The caller does not have administrative privileges