NVML API Reference Guide (PDF) - vR560 (older) - Last updated August 7, 2024 - Send Feedback

3. Change Log

This chapter list changes in API and bug fixes that were introduced to the library.

Changes between v555 and v560

The following new functionality is exposed on NVIDIA display drivers version 560 Production or later.

  • Added field values NVML_FI_DEV_PCIE_OUTBOUND_ATOMICS_MASK and NVML_FI_DEV_PCIE_INBOUND_ATOMICS_MASK for nvmlDeviceGetFieldValues.
  • Added field IDs NVML_FI_DEV_RESET_STATUS and NVML_FI_DEV_DRAIN_AND_RESET_STATUS which correspond to the nvidia-smi output.
  • Added NVML_DEVICE_ARCH_T23X architecture type.
  • Added nvmlVgpuTypeGetBAR1Info to query the BAR1 information of a vGPU type.
  • Added new event types, nvmlEventTypeSingleBitEccErrorStorm, nvmlEventTypeDramRetirementEvent, nvmlEventTypeDramRetirementFailure, nvmlEventTypeNonFatalPoisonError and nvmlEventTypeFatalPoisonError.
  • Added nvmlSystemGetDriverBranch to query the driver branch information.

Changes between v550 and v555

The following new functionality is exposed on NVIDIA display drivers version 555 Production or later.

Changes between v545 and v550

The following new functionality is exposed on NVIDIA display drivers version 550 Production or later.

Changes between v535 and v545

The following new functionality is exposed on NVIDIA display drivers version 545 Production or later.

  • Added a new error code NVML_ERROR_GPU_NOT_FOUND to be returned if no supported GPUS are found during initialization.
  • In nvmlGpuFabricInfo_v2_t, partitionId has been renamed to cliqueId.
  • Added new versioned structs nvmlGpuInstanceProfileInfo_v3_t and nvmlComputeInstanceProfileInfo_v3_t.
  • Added nvmlDeviceGetLastBBXFlushTime for retrieving the timestamp and duration of the latest flush of the BBX object to the inforom storage.
  • Added NVML_POWER_SCOPE_MEMORY to report out power usage for GPU Memory.
  • Added nvmlDeviceGetPciInfo_v3 which expands nvmlDeviceGetPciInfo to also report PCI base and sub classcodes.
  • Added new struct nvmlPciInfoExt_v1_t, which is used in nvmlDeviceGetPciInfoExt.
  • Added nvmlDeviceGetRunningProcessDetailList API to get information about Compute, Graphics or MPS-Compute processes running on a GPU with protected memory usage info.

Changes between v530 and v535

The following new functionality is exposed on NVIDIA display drivers version 535 Production or later.

Changes between v525 and v530

The following new functionality is exposed on NVIDIA display drivers version 530 Production or later.

Changes between v520 and v525

The following new functionality is exposed on NVIDIA display drivers version 525 Production or later.

  • Added nvmlDeviceGetPcieAtomicCaps to report PCIe atomic capabilities.
  • Added nvmlDeviceCcuGetStreamState API to report the counter collection unit stream state.
  • Added nvmlDeviceCcuSetStreamState API to set the counter collection unit stream state.
  • Removed support for NVML_FI_DEV_LINK_SPEED_MBPS_L{0..} field IDs in Hopper. Replaced with NVML_FI_DEV_NVLINK_GET_SPEED with scope as link ID.
  • Removed support for NVML_FI_DEV_NVLINK_CRC_FLIT_ERROR_COUNT{0..} field IDs in Hopper. Replaced with NVML_FI_DEV_NVLINK_ERROR_DL_CRC with scope as link ID.
  • Removed support for NVML_FI_DEV_NVLINK_REPLAY_ERROR_COUNT_L{0..} field IDs in Hopper. Replaced with NVML_FI_DEV_NVLINK_ERROR_DL_REPLAY with scope as link ID.
  • Removed support for NVML_FI_DEV_NVLINK_RECOVERY_ERROR_COUNT_{0..} field IDs in Hopper. Replaced with NVML_FI_DEV_NVLINK_ERROR_DL_RECOVERY with scope as link ID.
  • Added new field ID NVML_FI_DEV_NVLINK_GET_STATE to get nvlink state.
  • Added new field ID NVML_FI_DEV_NVLINK_GET_VERSION to get nvlink version.
  • Added new field ID NVML_FI_DEV_C2C_LINK_COUNT to get C2C link count.
  • Added new field ID NVML_FI_DEV_C2C_LINK_GET_STATUS to get C2C link status.
  • Added new field ID NVML_FI_DEV_C2C_LINK_GET_MAX_BW to get C2C link bandwidth.

Changes between v515 and v520

The following new functionality is exposed on NVIDIA display drivers version 520 Production or later.

Changes between v510 and v515

The following new functionality is exposed on NVIDIA display drivers version 515 Production or later.

Changes between v495 and v510

The following new functionality is exposed on NVIDIA display drivers version 510 Production or later.

Changes between v465 and v470

The following new functionality is exposed on NVIDIA display drivers version 470 Production or later.

  • Added new MIG GPU instance profile NVML_GPU_INSTANCE_PROFILE_1_SLICE_REV1.
  • Added nvmlDeviceGetGpuInstancePossiblePlacements_v2. The previous version of the API will not support the profiles with possible placements greater than its total capacity, such as NVML_GPU_INSTANCE_PROFILE_1_SLICE_REV1.

Changes between v460 and v465

The following new functionality is exposed on NVIDIA display drivers version 465 Production or later.

Changes between v450 and v460

The following new functionality is exposed on NVIDIA display drivers version 460 Production or later.

Changes between v445 and v450

The following new functionality is exposed on NVIDIA display drivers version 450 Production or later.

Changes between v418 and v445

The following new functionality is exposed on NVIDIA display drivers version 445 Production or later.

  • Added support for the NVIDIA Ampere architecture.
  • Added support for Multi Instance GPU management. Refer to the "Multi Instance GPU Management" section for details.

Changes between v361 and v418

The following new functionality is exposed on NVIDIA display drivers version 418 Production or later.

  • Added support for the Volta and Turing architectures, bug fixes, performance improvements, and new features.

Changes between v349 and v361

The following new functionality is exposed on NVIDIA display drivers version 361 Production or later.

Changes between v346 and v349

The following new functionality is exposed on NVIDIA display drivers version 349 Production or later.

Changes between v340 and v346

The following new functionality is exposed on NVIDIA display drivers version 346 Production or later.

Changes between NVML v331 and v340

The following new functionality is exposed on NVIDIA display drivers version 340 Production or later.

Changes between NVML v5.319 Update and v331

The following new functionality is exposed on NVIDIA display drivers version 331 or later.

Changes between NVML v5.319 RC and v5.319 Update

The following new functionality is exposed on NVIDIA display drivers version 319 Update or later.

Changes between NVML v4.304 Production and v5.319 RC

The following new functionality is exposed on NVIDIA display drivers version 319 RC or later.

Changes between NVML v4.304 RC and v4.304 Production

The following new functionality is exposed on NVIDIA display drivers version 304 Production or later.

Changes between NVML v3.295 and v4.304 RC

The following new functionality is exposed on NVIDIA display drivers version 304 RC or later.

Changes between NVML v2.285 and v3.295

The following new functionality is exposed on NVIDIA display drivers version 295 or later.

Changes between NVML v1.0 and v2.285

The following new functionality is exposed on NVIDIA display drivers version 285 or later.

  • Added possibility to query separately current and pending driver model with nvmlDeviceGetDriverModel.
  • Added API nvmlDeviceGetVbiosVersion function to report VBIOS version.
  • Added pciSubSystemId to nvmlPciInfo_t struct.
  • Added API nvmlErrorString function to convert error code to string.
  • Updated docs to indicate we support M2075 and C2075.
  • Added API nvmlSystemGetHicVersion function to report HIC firmware version.
  • Added NVML versioning support

    • Functions that changed API and/or size of structs have appended versioning suffix (e.g., nvmlDeviceGetPciInfo_v2). Appropriate C defines have been added that map old function names to the newer version of the function.
  • Added support for concurrent library usage by multiple libraries.
  • Added API nvmlDeviceGetMaxClockInfo function for reporting device's clock limits.
  • Added new error code NVML_ERROR_DRIVER_NOT_LOADED used by nvmlInit.
  • Extended nvmlPciInfo_t struct with new field: sub system id.
  • Added NVML support on Windows guest account.
  • Changed format of pciBusId string (to XXXX:XX:XX.X) of nvmlPciInfo_t.
  • Parsing of busId in nvmlDeviceGetHandleByPciBusId is less restrictive. You can pass 0:2:0.0 or 0000:02:00 and other variations.
  • Added API for events waiting for GPU events (Linux only) see docs of nvmlEvents.
  • Added API nvmlDeviceGetComputeRunningProcesses_v2 and nvmlSystemGetProcessName functions for looking up currently running compute applications.
  • Deprecated nvmlDeviceGetPowerState in favor of nvmlDeviceGetPerformanceState.

NVML API Reference Guide (PDF) - vR560 (older) - Last updated August 7, 2024 - Send Feedback