NVAPI Reference Documentation
NVIDIA
Release 470: June 28
2021

Data Structures | Macros | Typedefs | Enumerations | Functions
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)
 

Typedefs

typedef enum _NV_ECC_CONFIGURATION NV_ECC_CONFIGURATION
 

Enumerations

enum  _NV_ECC_CONFIGURATION { NV_ECC_CONFIGURATION_NOT_SUPPORTED = 0, NV_ECC_CONFIGURATION_DEFERRED, NV_ECC_CONFIGURATION_IMMEDIATE }
 

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.

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

Typedef Documentation

Enumeration Type Documentation

Used in NV_GPU_ECC_STATUS_INFO.

Enumerator
NV_ECC_CONFIGURATION_NOT_SUPPORTED 
NV_ECC_CONFIGURATION_DEFERRED 

Changes require a POST to take effect.

NV_ECC_CONFIGURATION_IMMEDIATE 

Changes can optionally be made to take effect immediately.

Function Documentation

NvAPI_GPU_GetECCConfigurationInfo ( NvPhysicalGpuHandle  hPhysicalGpu,
NV_GPU_ECC_CONFIGURATION_INFO pECCConfigurationInfo 
)

DESCRIPTION: This function returns ECC memory configuration information.

SUPPORTED OS: Windows 7 and higher

TCC_SUPPORTED

Parameters
[in]hPhysicalGpuA handle identifying the physical GPU for which ECC configuration information is to be retrieved.
[out]pECCConfigurationInfoA pointer to an ECC configuration structure.
Return values
NVAPI_OKThe request was completed successfully.
NVAPI_ERRORAn unknown error occurred.
NVAPI_EXPECTED_PHYSICAL_GPU_HANDLEThe provided GPU handle is not a physical GPU handle.
NVAPI_INVALID_HANDLEThe provided GPU handle is invalid.
NVAPI_HANDLE_INVALIDATEDThe provided GPU handle is no longer valid.
NVAPI_INVALID_POINTERAn invalid argument pointer was provided.
NVAPI_NOT_SUPPORTEDThe request is not supported.
NVAPI_API_NOT_INTIALIZEDNvAPI 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 7 and higher

TCC_SUPPORTED

Parameters
[in]hPhysicalGpuA handle identifying the physical GPU for which ECC error information is to be retrieved.
[out]pECCErrorInfoA pointer to an ECC error structure.
Return values
NVAPI_OKThe request was completed successfully.
NVAPI_ERRORAn unknown error occurred.
NVAPI_EXPECTED_PHYSICAL_GPU_HANDLEThe provided GPU handle is not a physical GPU handle.
NVAPI_INVALID_ARGUMENTincorrect param value
NVAPI_INVALID_POINTERAn invalid argument pointer was provided.
NVAPI_INCOMPATIBLE_STRUCT_VERSIONstructure version is not supported, initialize to NV_GPU_ECC_ERROR_INFO_VER.
NVAPI_HANDLE_INVALIDATEDThe provided GPU handle is no longer valid.
NVAPI_NOT_SUPPORTEDThe request is not supported.
NVAPI_API_NOT_INTIALIZEDNvAPI 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 7 and higher

TCC_SUPPORTED

Parameters
[in]hPhysicalGpuA handle identifying the physical GPU for which ECC status information is to be retrieved.
[out]pECCStatusInfoA pointer to an ECC status structure.
Return values
NVAPI_OKThe request was completed successfully.
NVAPI_ERRORAn unknown error occurred.
NVAPI_EXPECTED_PHYSICAL_GPU_HANDLEThe provided GPU handle is not a physical GPU handle.
NVAPI_INVALID_HANDLEThe provided GPU handle is invalid.
NVAPI_HANDLE_INVALIDATEDThe provided GPU handle is no longer valid.
NVAPI_INVALID_POINTERAn invalid argument pointer was provided.
NVAPI_NOT_SUPPORTEDThe request is not supported.
NVAPI_API_NOT_INTIALIZEDNvAPI 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 7 and higher

TCC_SUPPORTED

Administrator privileges since release 430.39

Parameters
[in]hPhysicalGpuA handle identifying the physical GPU for which ECC error information is to be cleared.
[in]bResetCurrentReset the current ECC error counters.
[in]bResetAggregateReset 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 application will require Administrator privileges to access this API. The application can be elevated to a higher permission level by selecting "Run as Administrator".
NVAPI_INTERFACE NvAPI_GPU_SetECCConfiguration ( NvPhysicalGpuHandle  hPhysicalGpu,
NvU8  bEnable,
NvU8  bEnableImmediately 
)

DESCRIPTION: This function updates the ECC memory configuration setting.

SUPPORTED OS: Windows 7 and higher

TCC_SUPPORTED

Administrator privileges since release 430.39

Parameters
[in]hPhysicalGpuA handle identifying the physical GPU for which to update the ECC configuration setting.
[in]bEnableThe new ECC configuration setting.
[in]bEnableImmediatelyRequest 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 application will require Administrator privileges to access this API. The application can be elevated to a higher permission level by selecting "Run as Administrator".


Copyright (c) 2007-2021 NVIDIA Corporation. All rights reserved.

NVIDIA