Deep Learning Accelerator Synchronization

Detailed Description

The NvMedia DLA NvSciSync API encompasses all NvMediaDla NvSciSync handling functions.

Macros
#define	NVMEDIA_DLA_NVSCISYNC_VERSION_MAJOR   1
	Major version number. More...
#define	NVMEDIA_DLA_NVSCISYNC_VERSION_MINOR   6
	Minor version number. More...
#define	NVMEDIA_DLA_NVSCISYNC_VERSION_PATCH   0
	Patch version number. More...
#define	NVMEDIA_DLA_MAX_PRENVSCISYNCFENCES   (8U)
	NvMediaDlaInsertPreNvSciSyncFence API can be called at most NVMEDIA_DLA_MAX_PRENVSCISYNCFENCES times before each Dla submit call. More...

Functions
NvMediaStatus	NvMediaDlaNvSciSyncGetVersion (NvMediaVersion *version)
	Returns the version information for the NvMedia DLA NvSciSync library. More...
NvMediaStatus	NvMediaDlaFillNvSciSyncAttrList (const NvMediaDla *dla, NvSciSyncAttrList attrlist, NvMediaNvSciSyncClientType clienttype)
	Fills the NvMediaDla specific NvSciSync attributes. More...
NvMediaStatus	NvMediaDlaFillNvSciSyncDeterministicAttrList (const NvMediaDla *dla, NvSciSyncAttrList attrlist, NvMediaNvSciSyncClientType clienttype)
	Fills the NvMediaDla specific NvSciSync deterministic attributes. More...
NvMediaStatus	NvMediaDlaRegisterNvSciSyncObj (NvMediaDla *dla, NvMediaNvSciSyncObjType syncobjtype, NvSciSyncObj nvscisync)
	Registers an NvSciSyncObj with NvMediaDla. More...
NvMediaStatus	NvMediaDlaUnregisterNvSciSyncObj (NvMediaDla *dla, NvSciSyncObj scisyncobj)
	Unregisters an NvSciSyncObj with NvMediaDla. More...
NvMediaStatus	NvMediaDlaSetNvSciSyncObjforSOF (NvMediaDla *dla, NvSciSyncObj nvscisyncSOF)
	Sets the NvSciSyncObj to be used for a Start of Frame (SOF) NvSciSyncFence. More...
NvMediaStatus	NvMediaDlaSetNvSciSyncObjforEOF (NvMediaDla *dla, NvSciSyncObj nvscisyncEOF)
	Sets an NvSciSyncObj to be used for a End of Frame (EOF) NvSciSyncFence. More...
NvMediaStatus	NvMediaDlaInsertPreNvSciSyncFence (NvMediaDla *dla, const NvSciSyncFence *prenvscisyncfence)
	Sets an NvSciSyncFence as a prefence for a DLA submit operation. More...
NvMediaStatus	NvMediaDlaGetSOFNvSciSyncFence (const NvMediaDla *dla, NvSciSyncObj sofnvscisyncobj, NvSciSyncFence *sofnvscisyncfence)
	Gets an SOF NvSciSyncFence for a DLA submit operation. More...
NvMediaStatus	NvMediaDlaGetEOFNvSciSyncFence (const NvMediaDla *dla, NvSciSyncObj eofnvscisyncobj, NvSciSyncFence *eofnvscisyncfence)
	Gets an EOF NvSciSyncFence for a DLA submit operation. More...
NvMediaStatus	NvMediaDlaInsertSOFNvSciSyncObj (NvMediaDla *dla, NvSciSyncObj syncObj)
	Sets NvSciSyncObj as a SOF for a DLA submit operation. More...
NvMediaStatus	NvMediaDlaInsertEOFNvSciSyncObj (NvMediaDla *dla, NvSciSyncObj syncObj)
	Sets NvSciSyncObj as a EOF for a DLA submit operation. More...

Macro Definition Documentation

NVMEDIA_DLA_MAX_PRENVSCISYNCFENCES

#define NVMEDIA_DLA_MAX_PRENVSCISYNCFENCES   (8U)

NvMediaDlaInsertPreNvSciSyncFence API can be called at most NVMEDIA_DLA_MAX_PRENVSCISYNCFENCES times before each Dla submit call.

Definition at line 54 of file nvmedia_dla_nvscisync.h.

NVMEDIA_DLA_NVSCISYNC_VERSION_MAJOR

#define NVMEDIA_DLA_NVSCISYNC_VERSION_MAJOR   1

Major version number.

Definition at line 44 of file nvmedia_dla_nvscisync.h.

NVMEDIA_DLA_NVSCISYNC_VERSION_MINOR

#define NVMEDIA_DLA_NVSCISYNC_VERSION_MINOR   6

Minor version number.

Definition at line 46 of file nvmedia_dla_nvscisync.h.

NVMEDIA_DLA_NVSCISYNC_VERSION_PATCH

#define NVMEDIA_DLA_NVSCISYNC_VERSION_PATCH   0

Patch version number.

Definition at line 48 of file nvmedia_dla_nvscisync.h.

Function Documentation

NvMediaDlaFillNvSciSyncAttrList()

NvMediaStatus NvMediaDlaFillNvSciSyncAttrList	(	const NvMediaDla *	dla,
		NvSciSyncAttrList	attrlist,
		NvMediaNvSciSyncClientType	clienttype
	)

Fills the NvMediaDla specific NvSciSync attributes.

This function updates the input NvSciSyncAttrList with values equivalent to the following public attribute key-values: NvSciSyncAttrKey_RequiredPerm set to

• NvSciSyncAccessPerm_WaitOnly for clienttype NVMEDIA_WAITER
• NvSciSyncAccessPerm_SignalOnly for clienttype NVMEDIA_SIGNALER
• NvSciSyncAccessPerm_WaitSignal for clienttype NVMEDIA_SIGNALER_WAITER NvSciSyncAttrKey_PrimitiveInfo set to
• NvSciSyncAttrValPrimitiveType_Syncpoint

The application must not set these attributes in the NvSciSyncAttrList passed as an input to this function.

Parameters

[in]	dla	An NvMedia DLA device handle. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in,out]	attrlist	A pointer to an NvSciSyncAttrList structure where NvMedia places NvSciSync attributes. Input range: A non-null pointer created by NvSciSyncAttrListCreate(). Output range: A non-null pointer to an NvSciSyncAttrList.
[in]	clienttype	Indicates whether the attrlist is requested for an NvMediaDla signaler or an NvMediaDla waiter or an NvMediaDla signaler-waiter. Input range: Any enum value defined by NvMediaNvSciSyncClientType.

Returns

NvMediaStatus, the completion status of the operation:

• NVMEDIA_STATUS_OK if the call is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if attrlist is NULL, or any of the above listed public attributes are already set, or if client type is invalid.
• 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

• attrlist must be a valid NvSciSyncAttrList.
• This function must be called before allocating the NvSciSyncObj

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

NvMediaDlaFillNvSciSyncDeterministicAttrList()

NvMediaStatus NvMediaDlaFillNvSciSyncDeterministicAttrList	(	const NvMediaDla *	dla,
		NvSciSyncAttrList	attrlist,
		NvMediaNvSciSyncClientType	clienttype
	)

Fills the NvMediaDla specific NvSciSync deterministic attributes.

This function updates the input NvSciSyncAttrList with values equivalent to the following public attribute key-values: NvSciSyncAttrKey_RequiredPerm set to

• NvSciSyncAccessPerm_WaitOnly for clienttype NVMEDIA_WAITER
• NvSciSyncAccessPerm_SignalOnly for clienttype NVMEDIA_SIGNALER
• NvSciSyncAccessPerm_WaitSignal for clienttype NVMEDIA_SIGNALER_WAITER NvSciSyncAttrKey_PrimitiveInfo set to
• NvSciSyncAttrValPrimitiveType_SysmemSemaphore NvSciSyncAttrKey_RequireDeterministicFences set to
• TRUE

The application must not set these attributes in the NvSciSyncAttrList passed as an input to this function.

Parameters

[in]	dla	An NvMedia DLA device handle. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in,out]	attrlist	A pointer to an NvSciSyncAttrList structure where NvMedia places NvSciSync attributes. Input range: A non-null pointer created by NvSciSyncAttrListCreate(). Output range: A non-null pointer to an NvSciSyncAttrList.
[in]	clienttype	Indicates whether the attrlist is requested for an NvMediaDla signaler or an NvMediaDla waiter. Input range: Any enum value defined by NvMediaNvSciSyncClientType.

Returns

NvMediaStatus, the completion status of the operation:

• NVMEDIA_STATUS_OK if the call is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if attrlist is NULL, or any of the above listed public attributes are already set, or if client type is invalid.
• 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

• attrlist must be a valid NvSciSyncAttrList.
• This function must be called before allocating the NvSciSyncObj

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

NvMediaDlaGetEOFNvSciSyncFence()

NvMediaStatus NvMediaDlaGetEOFNvSciSyncFence	(	const NvMediaDla *	dla,
		NvSciSyncObj	eofnvscisyncobj,
		NvSciSyncFence *	eofnvscisyncfence
	)

Gets an EOF NvSciSyncFence for a DLA submit operation.

Note

This API is not applicable for NvSciSyncObj backed by deterministic primitive.

An EOF NvSciSyncFence is associated with a DLA submit operation and its expiry indicates that the corresponding DLA submit operation has finished. NvMediaDlaGetEOFNvSciSyncFence returns the EOF NvSciSyncFence associated with the last DLA submit call.

If you use NvMediaDlaGetEOFNvSciSyncFence(), you must call it after calling a DLA submit function.

Parameters

[in]	dla	An NvMedia DLA device handle. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	eofnvscisyncobj	An EOF NvSciSyncObj associated with the NvSciSyncFence being requested. This structure will be modified by this function. Input range: A non-null pointer created by NvSciSyncObjAlloc().
[in,out]	eofnvscisyncfence	A pointer to the EOF NvSciSyncFence. Input range: A non-null pointer to NvSciSyncFence. Output range: A non-null pointer to NvSciSyncFence.

Returns

NvMediaStatus, the completion status of the operation:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if any of the following occurs:
  • dla is not a valid NvMediaDla handle, or
  • eofnvscisyncfence is NULL, or
  • eofnvscisyncobj is not registered with dla as type NVMEDIA_EOFSYNCOBJ or type NVMEDIA_EOF_PRESYNCOBJ.
• NVMEDIA_STATUS_NOT_SUPPORTED if eofnvscisyncobj is backed by deterministic primitive.
• 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 the function is called before setting the loadable as current or if there is a failure while updating the eofnvscisyncfence with the fence from the eofnvscisyncobj

Precondition

• eofnvscisyncobj must have been created and registered with the input NvMediaDLA handle using NvMediaDlaRegisterNvSciSyncObj().
• eofnvscisyncobj must have been set as the active EOF NvSciSyncObj.
• A task must have been submitted to the DLA engine using NvMediaDlaSubmit().

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: Yes
  • De-Init: No

NvMediaDlaGetSOFNvSciSyncFence()

NvMediaStatus NvMediaDlaGetSOFNvSciSyncFence	(	const NvMediaDla *	dla,
		NvSciSyncObj	sofnvscisyncobj,
		NvSciSyncFence *	sofnvscisyncfence
	)

Gets an SOF NvSciSyncFence for a DLA submit operation.

Note

This API is not applicable for NvSciSyncObj backed by deterministic primitive.

An SOF NvSciSyncFence is associated with a DLA submit operation, and its expiry indicates that the corresponding DLA submit operation has started. NvMediaDlaGetSOFNvSciSyncFence() returns the SOF NvSciSyncFence associated with the last DLA submit call.

If you use NvMediaDlaGetSOFNvSciSyncFence(), you must call it after calling the DLA submit function.

Parameters

[in]	dla	An NvMedia DLA device handle. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	sofnvscisyncobj	The SOF NvSciSyncObj associated with the NvSciSyncFence being requested. This structure will be modified by this function. Input range: A non-null pointer created by NvSciSyncObjAlloc().
[in,out]	sofnvscisyncfence	A pointer to the SOF NvSciSyncFence. Input range: A non-null pointer to NvSciSyncFence. Output range: A non-null pointer to SOF NvSciSyncFence.

Returns

NvMediaStatus, the completion status of the operation:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if any of the following occurs:
  • dla is not a valid NvMediaDla handle, or
  • sofnvscisyncfence is NULL, or
  • sofnvscisyncobj is not registered with dla as type NVMEDIA_SOFSYNCOBJ or type NVMEDIA_SOF_PRESYNCOBJ.
• NVMEDIA_STATUS_NOT_SUPPORTED if sofnvscisyncobj is backed by deterministic primitive.
• 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 the function is called before setting the loadable as current or if there is a failure while updating the sofnvscisyncfence with the fence from the sofnvscisyncobj

Precondition

• sofnvscisyncobj must have been created and registered with the input NvMediaDLA handle using NvMediaDlaRegisterNvSciSyncObj()
• sofnvscisyncobj must have been set as the active SOF NvSciSyncObj.
• A task must have been submitted to the DLA engine using NvMediaDlaSubmit().

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: Yes
  • De-Init: No

NvMediaDlaInsertEOFNvSciSyncObj()

NvMediaStatus NvMediaDlaInsertEOFNvSciSyncObj	(	NvMediaDla *	dla,
		NvSciSyncObj	syncObj
	)

Sets NvSciSyncObj as a EOF for a DLA submit operation.

If you use NvMediaDlaInsertEOFNvSciSyncObj(), the application must call it before calling a DLA submit API and before NvSciSyncObj gets signaled by DLA immediately after task execution completion.

You can set a maximum of <TODO> prefences by calling NvMediaDlaInsertEOFNvSciSyncObj() before calling a DLA submit function.

After a call to the DLA submit function, all NvSciSyncFences previously inserted by %NvMediaDlaInsertEOFNvSciSyncObj() are cleared, and they are not reused for subsequent DLA submit calls.

Parameters

[in]	dla	An NvMedia DLA device handle. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	syncObj	NvSciSyncObj that needs to be used as EOF for current submission. Input range: A non-null NvSciSyncObj that is already registered as NVMEDIA_EOFSYNCOBJ or NVMEDIA_EOF_PRESYNCOBJ.

Returns

NvMediaStatus, the completion status of the operation:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if any of the following occurs:
  • dla is not a valid NvMediaDla handle.
• 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 any of the following occurs:
  • current loadable is not set.
  • if syncObj is not registered with NvMediaDla for EOF operation.
  • if function fails to set syncObj as active EOF event for the current submission.

Precondition

• syncObj must have been created and registered with the input NvMediaDLA handle using NvMediaDlaRegisterNvSciSyncObj().

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: No
  • Runtime: Yes
  • De-Init: No

NvMediaDlaInsertPreNvSciSyncFence()

NvMediaStatus NvMediaDlaInsertPreNvSciSyncFence	(	NvMediaDla *	dla,
		const NvSciSyncFence *	prenvscisyncfence
	)

Sets an NvSciSyncFence as a prefence for a DLA submit operation.

If you use NvMediaDlaInsertPreNvSciSyncFence(), the application must call it before calling a DLA submit API. The following DLA submit operation is started only after the expiry of the prenvscisyncfence.

You can set a maximum of NVMEDIA_DLA_MAX_PRENVSCISYNCFENCES prefences by calling NvMediaDlaInsertPreNvSciSyncFence() before calling a DLA submit function.

After a call to the DLA submit function, all NvSciSyncFences previously inserted by NvMediaDlaInsertPreNvSciSyncFence() are cleared, and they are not reused for subsequent DLA submit calls.

Parameters

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

Returns

NvMediaStatus, the completion status of the operation:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if any of the following occurs:
  • dla is not a valid NvMediaDla handle, or
  • prenvscisyncfence is NULL, or
  • prenvscisyncfence is not generated with an NvSciSyncObj that was registered with dla as either type NVMEDIA_PRESYNCOBJ or type NVMEDIA_EOF_PRESYNCOBJ.
• NVMEDIA_STATUS_NOT_SUPPORTED if NvMediaDlaInsertPreNvSciSyncFence is already called at least NVMEDIA_DLA_MAX_PRENVSCISYNCFENCES times with the same dla NvMediaDla handle before a DLA submit call.
• 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 NvSciSyncObj associated with prenvscisyncfence must have been registered with the input NvMediaDLA handle using NvMediaDlaRegisterNvSciSyncObj().

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: Yes
  • De-Init: No

NvMediaDlaInsertSOFNvSciSyncObj()

NvMediaStatus NvMediaDlaInsertSOFNvSciSyncObj	(	NvMediaDla *	dla,
		NvSciSyncObj	syncObj
	)

Sets NvSciSyncObj as a SOF for a DLA submit operation.

If you use NvMediaDlaInsertSOFNvSciSyncObj(), the application must call it before calling a DLA submit API & before NvSciSyncObj gets signaled by DLA prior to the start of execution.

You can set a maximum of <TODO> prefences by calling NvMediaDlaInsertSOFNvSciSyncObj() before calling a DLA submit function.

After a call to the DLA submit function, all NvSciSyncFences previously inserted by %NvMediaDlaInsertSOFNvSciSyncObj() are cleared, and they are not reused for subsequent DLA submit calls.

Parameters

[in]	dla	An NvMedia DLA device handle. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	syncObj	NvSciSyncObj that needs to be used as SOF for current submission. Input range: A non-null NvSciSyncObj that is already registered as NVMEDIA_SOFSYNCOBJ or NVMEDIA_SOF_PRESYNCOBJ.

Returns

NvMediaStatus, the completion status of the operation:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if any of the following occurs:
  • dla is not a valid NvMediaDla handle.
• 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 any of the following occurs:
  • current loadable is not set.
  • if syncObj is not registered with NvMediaDla for SOF operation.
  • if function fails to set syncObj as active SOF event for the current submission.

Precondition

• syncObj must have been created and registered with the input NvMediaDLA handle using NvMediaDlaRegisterNvSciSyncObj().

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: No
  • Runtime: Yes
  • De-Init: No

NvMediaDlaNvSciSyncGetVersion()

NvMediaStatus NvMediaDlaNvSciSyncGetVersion

(

NvMediaVersion *

version

)

Returns the version information for the NvMedia DLA NvSciSync library.

Parameters

[in,out]

version

A pointer to an NvMediaVersion structure filled by the DLA NvSciSync library. Input range: A non-null pointer to an NvMediaVersion. Output range: A non-null pointer to an NvMediaVersion 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

NvMediaDlaRegisterNvSciSyncObj()

NvMediaStatus NvMediaDlaRegisterNvSciSyncObj	(	NvMediaDla *	dla,
		NvMediaNvSciSyncObjType	syncobjtype,
		NvSciSyncObj	nvscisync
	)

Registers an NvSciSyncObj with NvMediaDla.

Every NvSciSyncObj(even duplicate objects) used by NvMediaDla must be registered by a call to this function before it is used. Only the exact same registered NvSciSyncObj can be passed to the run time APIs.

For a given NvMediaDla handle, one NvSciSyncObj can be registered as one NvMediaNvSciSyncObjType only. For each NvMediaNvSciSyncObjType, a maximum of 16 NvSciSyncObj objects can be registered.

Parameters

[in]	dla	An NvMedia DLA device handle. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	syncobjtype	Determines how nvscisync is used by dla. Input range: Any enum value defined by NvMediaNvSciSyncObjType.
[in]	nvscisync	The NvSciSyncObj to be registered with dla. Input range: A non-null pointer created by NvSciSyncObjAlloc().

Returns

NvMediaStatus, the completion status of the operation:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if dla is NULL or syncobjtype is not a valid NvMediaNvSciSyncObjType.
• NVMEDIA_STATUS_NOT_SUPPORTED if nvscisync is not a compatible NvSciSyncObj which NvMediaDla can support.
• 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 the maximum number of NvSciScynObj objects are already registered for the given syncobjtype, OR if nvscisync is already registered with the same dla handle for a different syncobjtype.

Precondition

• nvscisync to be registered must have been created with the NvSciSyncAttrList returned by NvMedia-DLA.

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

NvMediaDlaSetNvSciSyncObjforEOF()

NvMediaStatus NvMediaDlaSetNvSciSyncObjforEOF	(	NvMediaDla *	dla,
		NvSciSyncObj	nvscisyncEOF
	)

Sets an NvSciSyncObj to be used for a End of Frame (EOF) NvSciSyncFence.

Note

This API is not applicable for NvSciSyncObj backed by deterministic primitive.

To use NvMediaDlaGetEOFNvSciSyncFence(), the application must call this function before the calling the first DLA submit API. NvMedia DLA currently accepts only one EOF NvSciSyncObj.

Parameters

[in]	dla	An NvMedia DLA device handle. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	nvscisyncEOF	A registered NvSciSyncObj which is to be associated with EOF NvSciSyncFence. Input range: A non-null pointer created by NvSciSyncObjAlloc().

Returns

NvMediaStatus, the completion status of the operation:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if dla is NULL, OR if nvscisyncEOF is not registered with dla as either type NVMEDIA_EOFSYNCOBJ or type NVMEDIA_EOF_PRESYNCOBJ.
• NVMEDIA_STATUS_NOT_SUPPORTED if nvscisyncEOF is backed by deterministic primitive.
• 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

• nvscisyncEOF must have been created and registered with the input NvMediaDLA handle NvMediaDlaRegisterNvSciSyncObj().

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

NvMediaDlaSetNvSciSyncObjforSOF()

NvMediaStatus NvMediaDlaSetNvSciSyncObjforSOF	(	NvMediaDla *	dla,
		NvSciSyncObj	nvscisyncSOF
	)

Sets the NvSciSyncObj to be used for a Start of Frame (SOF) NvSciSyncFence.

Note

This API is not applicable for NvSciSyncObj backed by deterministic primitive.

To use NvMediaDlaGetSOFNvSciSyncFence(), the application must call this function before the first DLA submit API. NvMedia DlA currently accepts only one SOF NvSciSyncObj.

Parameters

[in]	dla	An NvMedia DLA device handle. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	nvscisyncSOF	A registered NvSciSyncObj to be associated with SOF NvSciSyncFence. Input range: A non-null pointer created by NvSciSyncObjAlloc().

Returns

NvMediaStatus, the completion status of the operation:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if dla is NULL, or if nvscisyncSOF is not registered with dla as either type NVMEDIA_SOFSYNCOBJ or type NVMEDIA_SOF_PRESYNCOBJ.
• NVMEDIA_STATUS_NOT_SUPPORTED if nvscisyncSOF is backed by deterministic primitive.
• 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

• nvscisyncSOF must have been created and registered with the input NvMediaDLA handle using NvMediaDlaRegisterNvSciSyncObj().

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

NvMediaDlaUnregisterNvSciSyncObj()

NvMediaStatus NvMediaDlaUnregisterNvSciSyncObj	(	NvMediaDla *	dla,
		NvSciSyncObj	scisyncobj
	)

Unregisters an NvSciSyncObj with NvMediaDla.

During teardown, every NvSciSyncObj registered with NvMediaDla must be unregistered before calling NvMediaDlaDestroy().

Before the application calls this function, it must ensure that the application is in teardown mode, and any NvMediaDla operation using this scisyncobj has completed. If the function is called while scisyncobj is still in use by any NvMediaDla operations, the behavior is undefined.

Parameters

[in]	dla	An NvMedia DLA device handle. Input range: A non-null pointer to an NvMediaDla created with NvMediaDlaCreate().
[in]	scisyncobj	An NvSciSyncObj to be unregistered with dla. Input range: A non-null pointer created by NvSciSyncObjAlloc().

Returns

NvMediaStatus, the completion status of the operation:

• NVMEDIA_STATUS_OK if the function is successful.
• NVMEDIA_STATUS_BAD_PARAMETER if dla is NULL, or nvscisync is not registered with dla.
• 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 dla is destroyed before this function is called.

Precondition

• scisyncobj have been created and registered with the input 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