Detailed Description

NvMedia DLA runtime APIs for accessing the DLA hardware engine for deep learning operations.

Modules
	DLA Specific Types
	Defines specific types for DLA.

Macros
#define	NVMEDIA_DLA_VERSION_MAJOR 4
	Major version number. More...

#define	NVMEDIA_DLA_VERSION_MINOR 0
	Minor version number. More...

#define	NVMEDIA_DLA_VERSION_PATCH 0
	Patch version number. More...

Functions
NvMediaStatus	NvMediaDlaGetVersion (NvMediaVersion *version)
	Returns the version information for the NvMediaDla library. More...

NvMediaStatus	NvMediaDlaPingById (const uint32_t dlaId)
	Checks the status of the DLA engine. More...

NvMediaDla *	NvMediaDlaCreate (void)
	Creates a default context for NvMediaDla. More...

NvMediaStatus	NvMediaDlaDestroy (NvMediaDla *dla)
	Destroys a DLA engine instance created by NvMediaDlaCreate(). More...

NvMediaStatus	NvMediaDlaGetUMDVersion (const NvMediaDla dla, NvMediaDlaUMDVersion version)
	Returns the version information for the NvMedia DLA UMD library. More...

NvMediaStatus	NvMediaDlaGetNumEngines (const NvMediaDla dla, uint16_t numEngines)
	Returns the number of DLA hardware engines available. More...

NvMediaStatus	NvMediaDlaGetMaxOutstandingTasks (const NvMediaDla dla, uint32_t maxOutstandingTasks)
	Returns the maximum number of tasks that can be queued to an instance of an engine. More...

NvMediaStatus	NvMediaDlaInit (NvMediaDla *dla, uint32_t dlaId, uint32_t numTasks)
	Configures the context for a particular DLA engine. More...

NvMediaStatus	NvMediaDlaGetInstanceId (const NvMediaDla dla, uint32_t dlaId)
	Returns the instance id of the NvMediaDla. More...

NvMediaStatus	NvMediaDlaGetNumTasks (const NvMediaDla dla, uint32_t numTasks)
	Returns the number of outstanding tasks of NvMediaDla. More...

NvMediaStatus	NvMediaDlaLoadableCreate (NvMediaDla dla, NvMediaDlaLoadable *loadable)
	Creates a loadable handle. More...

NvMediaStatus	NvMediaDlaLoadableDestroy (const NvMediaDla dla, NvMediaDlaLoadable loadable)
	Destroys a loadable handle. More...

NvMediaStatus	NvMediaDlaAppendLoadable (const NvMediaDla dla, const NvMediaDlaBinaryLoadable binaryLoadable, NvMediaDlaLoadable loadable)
	Appends a loadable to the NvMediaDla context. More...

NvMediaStatus	NvMediaDlaAppendDiagnosticLoadable (const NvMediaDla dla, NvMediaDlaLoadable loadable)
	Appends diagnostic loadable to the NvMediaDla context. More...

NvMediaStatus	NvMediaDlaSetCurrentLoadable (NvMediaDla dla, const NvMediaDlaLoadable loadable)
	Sets the current loadable for the NvMediaDla. More...

NvMediaStatus	NvMediaDlaGetNumOfInputTensors (const NvMediaDla dla, int32_t numOfInputTensors)
	Gets the number of input tensors for the current loadable in the NvMediaDla context. More...

NvMediaStatus	NvMediaDlaGetInputTensorDescriptor (const NvMediaDla dla, const uint32_t idx, NvMediaDlaTensorDescriptor descriptor)
	Gets the input tensor descriptor for the current loadable in the NvMediaDla context. More...

NvMediaStatus	NvMediaDlaGetNumOfOutputTensors (const NvMediaDla dla, int32_t numOfOutputTensors)
	Gets the number of output tensors for the current loadable in the NvMediaDla context. More...

NvMediaStatus	NvMediaDlaGetOutputTensorDescriptor (const NvMediaDla dla, const uint32_t idx, NvMediaDlaTensorDescriptor descriptor)
	Gets the output tensor descriptor for the current loadable in the NvMediaDla context. More...

NvMediaStatus	NvMediaDlaDataRegister (const NvMediaDla dla, const NvMediaDlaData dlaData, uint32_t flags)
	Registers an NvMediaDlaData for use with an NvMediaDla handle. More...

NvMediaStatus	NvMediaDlaDataUnregister (const NvMediaDla dla, const NvMediaDlaData dlaData)
	Unregisters an NvMediaDlaData after use. More...

NvMediaStatus	NvMediaDlaLoadLoadable (NvMediaDla *dla)
	Loads the current loadable to the provided NvMediaDla context. More...

NvMediaStatus	NvMediaDlaRemoveLoadable (NvMediaDla *dla)
	Removes the current loadable from the provided NvMediaDla context. More...

NvMediaStatus	NvMediaDlaSubmit (NvMediaDla dla, const NvMediaDlaArgs inputArgs, const NvMediaDlaArgs scratchpadArgs, const NvMediaDlaArgs outputArgs, uint32_t taskTimeout)
	Submits a job to the DLA to run the network on a set of input NvMediaDla arguments and a timeout value. More...

NvMediaStatus	NvMediaDlaSubmitBypass (NvMediaDla dla, const NvMediaDlaArgs inputArgs, const NvMediaDlaArgs scratchpadArgs, const NvMediaDlaArgs outputArgs)
	Submits a job to the DLA but its execution is skipped. More...

Macro Definition Documentation

◆ NVMEDIA_DLA_VERSION_MAJOR

#define NVMEDIA_DLA_VERSION_MAJOR 4

Major version number.

Definition at line 51 of file nvmedia_dla.h.

◆ NVMEDIA_DLA_VERSION_MINOR

#define NVMEDIA_DLA_VERSION_MINOR 0

Minor version number.

Definition at line 53 of file nvmedia_dla.h.

◆ NVMEDIA_DLA_VERSION_PATCH

#define NVMEDIA_DLA_VERSION_PATCH 0

Patch version number.

Definition at line 55 of file nvmedia_dla.h.

Function Documentation

◆ NvMediaDlaAppendDiagnosticLoadable()

NvMediaStatus NvMediaDlaAppendDiagnosticLoadable	(	const NvMediaDla *	dla,
		NvMediaDlaLoadable *	loadable
	)

Appends diagnostic loadable to the NvMediaDla context.

NvMediaDlaAppendDiagnosticLoadable() appends the value in loadable and returns to the calling function. Currently, only one loadable can be appended.

The application may call this function or NvMediaDlaAppendLoadable only once per NvMediaDla context.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created using NvMediaDlaCreate().
[in,out]	loadable	A pointer to an NvMediaDlaLoadable filled by NvMediaDla. Input range: A non-null pointer to an NvMediaDlaLoadable created using NvMediaDlaLoadableCreate() Output range: A non-null pointer to a valid loadable if successful.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition: None

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaAppendLoadable()

NvMediaStatus NvMediaDlaAppendLoadable	(	const NvMediaDla *	dla,
		const NvMediaDlaBinaryLoadable	binaryLoadable,
		NvMediaDlaLoadable *	loadable
	)

Appends a loadable to the NvMediaDla context.

NvMediaDlaAppendLoadable() appends the value in loadable and returns to the calling function. Currently, only one loadable can be appended.

The application may call this function or NvMediaDlaAppendDiagnosticLoadable only once per NvMediaDla context.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	binaryLoadable	Holds a non-null pointer to NvMediaDlaBinaryLoadable. Input range: The `loadableSize` must be greater than 0.
[in,out]	loadable	A pointer to an NvMediaDlaLoadable filled by NvMediaDla. Input range: A non-null pointer to an NvMediaDlaLoadable created using NvMediaDlaLoadableCreate() Output range: A non-null pointer to a valid loadable if successful.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition

binaryLoadable must be a valid handle to a loadable created using TensorRT APIs.
The user must provide a valid NvMediaDlaLoadable handle and the corresponding NvMediaDla handle

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaCreate()

NvMediaDla* NvMediaDlaCreate ( void )

Creates a default context for NvMediaDla.

Use the function NvMediaDlaInit() to initialize the newly-created context for use as an engine instance.

Returns: NvMediaDla A handle to the context.
Output range: A non-null pointer to an NvMediaDla if successful, or NULL otherwise.

Precondition: None

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaDataRegister()

NvMediaStatus NvMediaDlaDataRegister	(	const NvMediaDla *	dla,
		const NvMediaDlaData *	dlaData,
		uint32_t	flags
	)

Registers an NvMediaDlaData for use with an NvMediaDla handle.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	dlaData	A pointer to NvMediaDlaData to register. Input range: A non-null pointer to an NvMediaDlaData.
[in]	flags	Reserved for future use. Should be set to zero.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition

The NvMediaDlaLoadable associated with dla, the input NvMediaDla handle, must have been set as current using NvMediaDlaSetCurrentLoadable().

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaDataUnregister()

NvMediaStatus NvMediaDlaDataUnregister	(	const NvMediaDla *	dla,
		const NvMediaDlaData *	dlaData
	)

Unregisters an NvMediaDlaData after use.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	dlaData	A pointer to a registered NvMediaDlaData. Input range: A non-null pointer to an NvMediaDlaData registered with NvMediaDlaDataRegister().

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition

The NvMediaDlaLoadable associated with dla, the input NvMediaDla handle, must have been set as current using NvMediaDlaSetCurrentLoadable()
dlaData must have been registered

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: Yes

◆ NvMediaDlaDestroy()

NvMediaStatus NvMediaDlaDestroy ( NvMediaDla * dla )

Destroys a DLA engine instance created by NvMediaDlaCreate().

Parameters

[in] dla A handle to the instance to destroy.
Input range: A non-null pointer to an NvMediaDla instance created with NvMediaDlaCreate().

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if dla is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition: None

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Sync
Required privileges: None
API group
- Init: No
- Runtime: No
- De-Init: Yes

◆ NvMediaDlaGetInputTensorDescriptor()

NvMediaStatus NvMediaDlaGetInputTensorDescriptor	(	const NvMediaDla *	dla,
		const uint32_t	idx,
		NvMediaDlaTensorDescriptor *	descriptor
	)

Gets the input tensor descriptor for the current loadable in the NvMediaDla context.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	idx	A tensor index. Input range: A value between 0 (zero) and the result of NvMediaDlaGetNumOfInputTensors() - 1.
[in,out]	descriptor	Descriptor for the tensor. Input range: A non-null pointer to an NvMediaDlaTensorDescriptor. Output range: A non-null pointer to an NvMediaDlaTensorDescriptor if successful.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL or if Tensor Index overflow occurs.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition

The NvMediaDlaLoadable associated with dla, the input NvMediaDla handle, must have been set as current using NvMediaDlaSetCurrentLoadable().

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaGetInstanceId()

NvMediaStatus NvMediaDlaGetInstanceId	(	const NvMediaDla *	dla,
		uint32_t *	dlaId
	)

Returns the instance id of the NvMediaDla.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in,out]	dlaId	A pointer to the NvMediaDla instance id. Input range: A non-null pointer to an `uint32_t`. Output range: A non-null pointer to an `uint32_t` between 0 (zero) and the result of NvMediaDlaGetNumEngines() - 1 if successful.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_NOT_INITIALIZED if NvMediaDla handle has not been initialzied.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR if dlaId of the NvMediaDla has not been set.

Precondition

dla must have been initialized using NvMediaDlaInit()

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaGetMaxOutstandingTasks()

NvMediaStatus NvMediaDlaGetMaxOutstandingTasks	(	const NvMediaDla *	dla,
		uint32_t *	maxOutstandingTasks
	)

Returns the maximum number of tasks that can be queued to an instance of an engine.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in,out]	maxOutstandingTasks	A pointer to the maximum number of tasks that can be queued. Input range: A non-null pointer to an `uint32_t`. Output range: A non-null pointer to an `uint32_t` if successful, otherwise the value pointed to by numEngines remains unchanged.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.

Precondition: None

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaGetNumEngines()

NvMediaStatus NvMediaDlaGetNumEngines	(	const NvMediaDla *	dla,
		uint16_t *	numEngines
	)

Returns the number of DLA hardware engines available.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer an NvMediaDla instance created with NvMediaDlaCreate().
[in,out]	numEngines	A pointer to the number of DLA hardware engines. Input range: A non-null pointer to an `uint16_t`. Output range: A non-null pointer to an `uint16_t` if successful, otherwise the value pointed to by numEngines remains unchanged.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.

Precondition: None

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaGetNumOfInputTensors()

NvMediaStatus NvMediaDlaGetNumOfInputTensors	(	const NvMediaDla *	dla,
		int32_t *	numOfInputTensors
	)

Gets the number of input tensors for the current loadable in the NvMediaDla context.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in,out]	numOfInputTensors	The number of input tensors. Input range: A non-null pointer to an `int32_t` value. Output range: A non-null pointer to an `int32_t` if successful.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition

NvMediaDlaLoadable associated with dla, the input NvMediaDla handle, must have been set as current using NvMediaDlaSetCurrentLoadable().

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaGetNumOfOutputTensors()

NvMediaStatus NvMediaDlaGetNumOfOutputTensors	(	const NvMediaDla *	dla,
		int32_t *	numOfOutputTensors
	)

Gets the number of output tensors for the current loadable in the NvMediaDla context.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in,out]	numOfOutputTensors	The number of output tensors. Input range: A non-null pointer to an `int32_t` value. Output range: A non-null pointer to an `int32_t` value if successful.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition

The NvMediaDlaLoadable associated with dla, the input NvMediaDla handle, must have been set as current using NvMediaDlaSetCurrentLoadable().

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaGetNumTasks()

NvMediaStatus NvMediaDlaGetNumTasks	(	const NvMediaDla *	dla,
		uint32_t *	numTasks
	)

Returns the number of outstanding tasks of NvMediaDla.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in,out]	numTasks	A pointer to the number of outstanding tasks. Input range: A non-null pointer to an `uint32_t`. Output range: A non-null pointer to an `uint32_t` between 0 (zero) and the result of NvMediaDlaGetMaxOutstandingTasks() if successful.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_NOT_INITIALIZED if NvMediaDla handle has not been initialzied.
NVMEDIA_STATUS_ERROR if numTasks of the NvMediaDla has not been set.

Precondition

dla must have been initialized using NvMediaDlaInit()

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaGetOutputTensorDescriptor()

NvMediaStatus NvMediaDlaGetOutputTensorDescriptor	(	const NvMediaDla *	dla,
		const uint32_t	idx,
		NvMediaDlaTensorDescriptor *	descriptor
	)

Gets the output tensor descriptor for the current loadable in the NvMediaDla context.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	idx	The tensor index. Input range: A value between 0 (zero) and the result of NvMediaDlaGetNumOfOutputTensors() - 1.
[in,out]	descriptor	A descriptor for the tensor. Input range: A non-null pointer to an NvMediaDlaTensorDescriptor. Output range: A non-null pointer to an NvMediaDlaTensorDescriptor if successful.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL or if Tensor Index overflow occurs.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition

The NvMediaDlaLoadable associated with dla, the input NvMediaDla handle, must have been set as current using NvMediaDlaSetCurrentLoadable().

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaGetUMDVersion()

NvMediaStatus NvMediaDlaGetUMDVersion	(	const NvMediaDla *	dla,
		NvMediaDlaUMDVersion *	version
	)

Returns the version information for the NvMedia DLA UMD library.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla instance created with NvMediaDlaCreate().
[in,out]	version	A pointer to an NvMediaDlaUMDVersion structure filled by the NvMediaDla library. Input range: A non-null pointer to an NvMediaDlaUMDVersion. Output range: A non-null pointer to an NvMediaDlaUMDVersion if successful, otherwise the value pointed to by `version` remains unchanged.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if dla is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.

Precondition: None

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaGetVersion()

NvMediaStatus NvMediaDlaGetVersion ( NvMediaVersion * version )

Returns the version information for the NvMediaDla library.

Parameters

[in,out] version A pointer to an NvMediaVersion structure filled by the NvMediaDla library.
Input range: A non-null pointer to an NvMediaVersion structure.
Output range: A non-null pointer to an NvMediaVersion structure if successful, otherwise the value pointed to by version remains unchanged.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if version is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.

Precondition: None

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaInit()

NvMediaStatus NvMediaDlaInit	(	NvMediaDla *	dla,
		uint32_t	dlaId,
		uint32_t	numTasks
	)

Configures the context for a particular DLA engine.

Note: Once the dlaId and numTasks have been assigned, their values cannot be modified.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	dlaId	The DLA engine ID. Input range: An `uint32_t` value between 0 (zero) and the result of NvMediaDlaGetNumEngines() - 1.
[in]	numTasks	The number of simultaneous tasks that can be submitted to a DLA instance at a time. Input range: An `uint32_t` value between 1 and the result of NvMediaDlaGetMaxOutstandingTasks().

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition: None

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaLoadableCreate()

NvMediaStatus NvMediaDlaLoadableCreate	(	NvMediaDla *	dla,
		NvMediaDlaLoadable **	loadable
	)

Creates a loadable handle.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in,out]	loadable	A pointer to an NvMediaDlaLoadable. Input range: A non-null pointer to an NvMediaDlaLoadable. Output range: A non-null pointer to a valid loadable if successful.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition: None

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaLoadableDestroy()

NvMediaStatus NvMediaDlaLoadableDestroy	(	const NvMediaDla *	dla,
		NvMediaDlaLoadable *	loadable
	)

Destroys a loadable handle.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	loadable	A pointer to an NvMediaDlaLoadable. Input range: A non-null pointer to an NvMediaDlaLoadable created with NvMediaDlaLoadableCreate().

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition: None

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: Yes

◆ NvMediaDlaLoadLoadable()

NvMediaStatus NvMediaDlaLoadLoadable ( NvMediaDla * dla )

Loads the current loadable to the provided NvMediaDla context.

Parameters

[in] dla A handle to the DLA device.
Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if dla is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition

The NvMediaDlaLoadable associated with dla, the input NvMediaDla handle, must have been set as current using NvMediaDlaSetCurrentLoadable()

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaPingById()

NvMediaStatus NvMediaDlaPingById ( const uint32_t dlaId )

Checks the status of the DLA engine.

This function sends a ping to the DLA engine identified by dlaId to fetch its status.

Parameters

[in] dlaId Id of the DLA engine to ping.
Input range: An uint32_t value between 0 (zero) and the result of NvMediaDlaGetNumEngines() - 1.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if dlaId is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition: None

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: Yes
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: No

◆ NvMediaDlaRemoveLoadable()

NvMediaStatus NvMediaDlaRemoveLoadable ( NvMediaDla * dla )

Removes the current loadable from the provided NvMediaDla context.

Parameters

[in] dla A handle to the DLA context.
Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if dla is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition

The NvMediaDlaLoadable associated with dla, the input NvMediaDla handle, must have been set as current using NvMediaDlaSetCurrentLoadable().
The NvMediaDlaLoadable associated with dla, must have been loaded using NvMediaDlaLoadLoadable().
The user must provide a valid NvMediaDlaLoadable handle and the corresponding NvMediaDla handle

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: No
- De-Init: Yes

◆ NvMediaDlaSetCurrentLoadable()

NvMediaStatus NvMediaDlaSetCurrentLoadable	(	NvMediaDla *	dla,
		const NvMediaDlaLoadable *	loadable
	)

Sets the current loadable for the NvMediaDla.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	loadable	A pointer to an NvMediaDlaLoadable. Input range: A non-null pointer to an NvMediaDlaLoadable created with NvMediaDlaLoadableCreate().

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if any argument is NULL.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Precondition

A binary loadable must have been appended to loadable using NvMediaDlaAppendLoadable().
The user must provide a valid NvMediaDlaLoadable handle and the corresponding NvMediaDla handle

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Sync
Required privileges: None
API group
- Init: Yes
- Runtime: Yes
- De-Init: Yes

◆ NvMediaDlaSubmit()

NvMediaStatus NvMediaDlaSubmit	(	NvMediaDla *	dla,
		const NvMediaDlaArgs *	inputArgs,
		const NvMediaDlaArgs *	scratchpadArgs,
		const NvMediaDlaArgs *	outputArgs,
		uint32_t	taskTimeout
	)

Submits a job to the DLA to run the network on a set of input NvMediaDla arguments and a timeout value.

Note: The scratchpadArgs parameter is currently not supported. The application must pass a NULL in this argument.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	inputArgs	A pointer to input NvMediaDlaArgs. Input range: A non-null pointer to a valid NvMediaDlaArgs.
[in]	scratchpadArgs	A pointer to scratchpad arguments for NvMediaDla. Input range: A NULL value. This parameter is currently not supported. The application must pass NULL in this argument.
[in]	outputArgs	Holds output NvMediaDlaArgs. Input range: A non-null pointer to a valid NvMediaDlaArgs.
[in]	taskTimeout	The maximum time allocated for completing the task (in milliseconds). Input range: The valid range is from 1 millisecond to 1000000 milliseconds. The value 0 (zero) is mapped to 1000000 milliseconds.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if invalid parameters or if overflows occur.
NVMEDIA_STATUS_NOT_SUPPORTED if input/output parameters are not valid or dont match.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Notes:

A valid NvMediaDlaArgs should meet the following restrictions:

[1] NvMediaDlaArgs should hold a non-NULL NvMediaDlaData.

[2] NvMediaDlaDataType of NvMediaDlaData shall be equal to NVMEDIA_DLA_DATA_TYPE_TENSOR.

[3] NvMediaDlaDataPointer of NvMediaDlaData shall be non-NULL.

[4] NvMediaTensor of NvMediaDlaDataPointer shall match the tensor descriptor that is queried by NvMediaDlaGetInputTensorDescriptor or NvMediaDlaGetOutputTensorDescriptor.

[5] numArgs of NvMediaDlaArgs shall be equal to the number of tensors queried by NvMediaDlaGetNumOfInputTensors or NvMediaDlaGetNumOfOutputTensors.

The task will error out if it does not finish within the time set in taskTimeout. Error details can be obtained: [1] using NvMediaTensorGetStatus() for output tensors or [2] using NvSciSyncFenceGetTaskStatus from the fence associated with EOF NvSciSyncObj

Precondition

Client must have created a NvMediaDla handle.
The binary loadable corresponding to the network must have been loaded.
The input and output tensors that are part of inputArgs and outputArgs respectively, must have been registered with the NvMediaDla handle.
If any prefences are available, they must have associated using NvMediaDlaInsertPreNvSciSyncFence().
If any EOF/SOF NvSciSyncObjs are registered, they must have been set as current.

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Async
Required privileges: None
API group
- Init: No
- Runtime: Yes
- De-Init: No

◆ NvMediaDlaSubmitBypass()

NvMediaStatus NvMediaDlaSubmitBypass	(	NvMediaDla *	dla,
		const NvMediaDlaArgs *	inputArgs,
		const NvMediaDlaArgs *	scratchpadArgs,
		const NvMediaDlaArgs *	outputArgs
	)

Submits a job to the DLA but its execution is skipped.

Note: The scratchpadArgs parameter is currently not supported. The application must pass a NULL in this argument.

Parameters

[in]	dla	A handle to the DLA context. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	inputArgs	A pointer to input NvMediaDlaArgs. Input range: A non-null pointer to a valid NvMediaDlaArgs.
[in]	scratchpadArgs	A pointer to scratchpad arguments for NvMediaDla. Input range: A NULL value. This parameter is currently not supported. The application must pass NULL in this argument.
[in]	outputArgs	Holds output NvMediaDlaArgs. Input range: A non-null pointer to a valid NvMediaDlaArgs.

Returns

NvMediaStatus, the completion status of the operation:

NVMEDIA_STATUS_OK if the function is successful.
NVMEDIA_STATUS_BAD_PARAMETER if invalid parameters or if overflows occur.
NVMEDIA_STATUS_NOT_SUPPORTED if input/output parameters are not valid or dont match.
NVMEDIA_STATUS_INVALID_STATE if the API is triggered in the DRIVEOS state that is not allowed as per the API Group.
NVMEDIA_STATUS_ERROR for any other error.

Notes:

A valid NvMediaDlaArgs should meet the following restrictions:

[1] NvMediaDlaArgs should hold a non-NULL NvMediaDlaData.

[2] NvMediaDlaDataType of NvMediaDlaData shall be equal to NVMEDIA_DLA_DATA_TYPE_TENSOR.

[3] NvMediaDlaDataPointer of NvMediaDlaData shall be non-NULL.

[4] NvMediaTensor of NvMediaDlaDataPointer shall match the tensor descriptor that is queried by NvMediaDlaGetInputTensorDescriptor or NvMediaDlaGetOutputTensorDescriptor.

[5] numArgs of NvMediaDlaArgs shall be equal to the number of tensors queried by NvMediaDlaGetNumOfInputTensors or NvMediaDlaGetNumOfOutputTensors.

Error details can be obtained: [1] using NvMediaTensorGetStatus() for output tensors or [2] using NvSciSyncFenceGetTaskStatus from the fence associated with EOF NvSciSyncObj

Precondition

Client must have created a NvMediaDla handle.
The binary loadable corresponding to the network must have been loaded.
The input and output tensors that are part of inputArgs and outputArgs respectively, must have been registered with the NvMediaDla handle.
If any prefences are available, they must have associated using NvMediaDlaInsertPreNvSciSyncFence().
If any EOF/SOF NvSciSyncObjs are registered, they must have been set as current.

Usage considerations

Allowed context for the API call
- Interrupt handler: No
- Signal handler: No
- Thread-safe: Yes
- Re-entrant: No
- Async/Sync: Async
Required privileges: None
API group
- Init: No
- Runtime: Yes
- De-Init: No

NVIDIA DRIVE OS Linux SDK API Reference

6.0.9 Release

Detailed Description

Modules

Macros

Functions

Macro Definition Documentation

◆ NVMEDIA_DLA_VERSION_MAJOR

◆ NVMEDIA_DLA_VERSION_MINOR

◆ NVMEDIA_DLA_VERSION_PATCH

Function Documentation

◆ NvMediaDlaAppendDiagnosticLoadable()

◆ NvMediaDlaAppendLoadable()

◆ NvMediaDlaCreate()

◆ NvMediaDlaDataRegister()

◆ NvMediaDlaDataUnregister()

◆ NvMediaDlaDestroy()

◆ NvMediaDlaGetInputTensorDescriptor()

◆ NvMediaDlaGetInstanceId()

◆ NvMediaDlaGetMaxOutstandingTasks()

◆ NvMediaDlaGetNumEngines()

◆ NvMediaDlaGetNumOfInputTensors()

◆ NvMediaDlaGetNumOfOutputTensors()

◆ NvMediaDlaGetNumTasks()

◆ NvMediaDlaGetOutputTensorDescriptor()

◆ NvMediaDlaGetUMDVersion()

◆ NvMediaDlaGetVersion()

◆ NvMediaDlaInit()

◆ NvMediaDlaLoadableCreate()

◆ NvMediaDlaLoadableDestroy()

◆ NvMediaDlaLoadLoadable()

◆ NvMediaDlaPingById()

◆ NvMediaDlaRemoveLoadable()

◆ NvMediaDlaSetCurrentLoadable()

◆ NvMediaDlaSubmit()

◆ NvMediaDlaSubmitBypass()