6.0.8 Release
NVIDIA DRIVE OS Linux SDK API Reference Documentation

Welcome to the NVIDIA DRIVE® OS Linux SDK API Reference.

Documentation is preliminary and subject to change. Please see your customer engineer for additional information and to request documentation updates.

Release Notes

For release-specific information, including software version numbers, what's new, and known issues, read the Release Notes. These notes are available on NVONLINE.

API Documentation

This product implements NVIDIA APIs and certain Graphics and Media APIs.

This API Documentation describes the NVIDIA APIs that you can use to customize aspects of your device's behavior. To provide unified API documentation, the API content of this volume was generated from code comments.

The API content represents the set of APIs you can use directly. Some APIs are not documented and we advise you do not use them directly. Using undocumented APIs can lead to incompatibility when upgrading to later releases.

This API Documentation also includes 3rd-party specifications and other documents that are referenced here and in the Developer Guide. The 3rd-party documents are provided as a convenience to readers. NVIDIA takes no responsibility for the accuracy of their contents.

The APIs included in this documentation are logically grouped into a hierarchy of modules. Header files that contribute to the same capability are grouped into a single, high-level module. Each high-level module may be further broken down into functional subcategories. To view the modules in this documentation, click the API Modules tab.

API Usage Considerations

The API Usage Considerations section lists additional properties or attributes for a function. The supported properties and descriptions are:

  • Thread-safe: An API is thread safe if its documented behavior does not change when processing more than one thread of execution at a time. In some cases, an API is not "thread-safe" without imposing some restrictions on the callers using it. In those cases, the restrictions are documented with the API.
  • Interrupt handler: An interrupt-safe function behaves as documented even if used in an interrupt handler.
  • Signal handler: A signal-safe function behaves as documented even if called from a signal handler and even if the signal interrupts a signal-unsafe function.
  • Re-entrant: A procedure is re-entrant if multiple invocations of it can run safely and concurrently on a single processor system. A re-entrant procedure can be interrupted in the middle of its execution and then safely be called again before its previous invocations complete execution.
  • Async/Sync: This indicates whether the API performs its function synchronously or asynchronously. The results of a synchronous API will be available immediately when the API returns. The results of an asynchronous API are available to the caller by an event or other mechanisms later.
  • Required privileges: A list of privileges required to execute the function.
  • API group: The supported mode for calling the function. This attribute is used in safety development. The API group definitions in the NVIDIA DRIVE® OS 6.0 Safety Manual supersede the definitions in this API Reference.
The validation of the specified properties on each API is based on code inspection but not comprehensive validation tests; therefore, full compliance with the properties is not guaranteed.


The Precondition section describes any required preconditions that must be satisfied before calling this API. This is typically other APIs (such as initialization APIs) that must be called first.

For example, NvThermmonOpen() API must be called and return a success response before calling another NvThermmon API.

Searching for APIs

Full-text search is now available for the complete documentation included in this document set. Read this section for details.

You can search for APIs using both full-text search (from the Developer Guide) and keyword search (from this API document).

  • Full-text search supports searching for any word or phrase.
  • Keyword search only supports searching for the keyword itself.
Benefits of Full-Text Search

Using full-text search from within the Developer Guide has these benefits:

  • Ability to use the * wildcard
  • Ability to search for phrases by wrapping them in quotation marks
  • Search results for both the Developer Guide and this API document
  • Search results for content of PDFs that are included within the HTML documents

For full-text search, click this link to open the Developer Guide and enter the search phrase in the Search field at the upper-right of the window. For more information about searching, see the "About this Documentation" appendix in the Development Guide.

Keyword Search

For keyword search in this document, enter the API name in the Search field at the upper-right of this window. Typing the beginning letters of an API results in populating a drop-down results list containing all APIs starting with the same letters. You can select the API of interest from the results list, or by floating your cursor over the magnifying glass icon you can narrow down the results list to:

  • a type of API (like enumerations)
  • a file
  • a group
  • a page

This search is case-insensitive. Dismiss the search results by clicking the X at the right of the Search field.