nvmedia_dla_nvscisync.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2019-2023 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
 * property and proprietary rights in and to this material, related
 * documentation and any modifications thereto. Any use, reproduction,
 * disclosure or distribution of this material and related documentation
 * without an express license agreement from NVIDIA CORPORATION or
 * its affiliates is strictly prohibited.
 */
 
#ifndef NVMEDIA_DLA_NVSCISYNC_H
#define NVMEDIA_DLA_NVSCISYNC_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "nvmedia_core.h"
#include "nvscisync.h"
#include "nvmedia_dla.h"
 
#define NVMEDIA_DLA_NVSCISYNC_VERSION_MAJOR   1
 
#define NVMEDIA_DLA_NVSCISYNC_VERSION_MINOR   6
 
#define NVMEDIA_DLA_NVSCISYNC_VERSION_PATCH   0
 
#define NVMEDIA_DLA_MAX_PRENVSCISYNCFENCES  (8U)
 
NvMediaStatus
NvMediaDlaNvSciSyncGetVersion(
    NvMediaVersion *version
);
 
NvMediaStatus
NvMediaDlaFillNvSciSyncAttrList(
    const NvMediaDla                *dla,
    NvSciSyncAttrList          attrlist,
    NvMediaNvSciSyncClientType clienttype
);
 
NvMediaStatus
NvMediaDlaFillNvSciSyncDeterministicAttrList(
    const NvMediaDla* dla,
    NvSciSyncAttrList attrlist,
    NvMediaNvSciSyncClientType clienttype
);
 
NvMediaStatus
NvMediaDlaRegisterNvSciSyncObj(
    NvMediaDla                *dla,
    NvMediaNvSciSyncObjType    syncobjtype,
    NvSciSyncObj               nvscisync
);
 
NvMediaStatus
NvMediaDlaUnregisterNvSciSyncObj(
    NvMediaDla                *dla,
    NvSciSyncObj               scisyncobj
);
 
NvMediaStatus
NvMediaDlaSetNvSciSyncObjforSOF(
    NvMediaDla                *dla,
    NvSciSyncObj               nvscisyncSOF
);
 
NvMediaStatus
NvMediaDlaSetNvSciSyncObjforEOF(
    NvMediaDla                *dla,
    NvSciSyncObj               nvscisyncEOF
);
 
NvMediaStatus
NvMediaDlaInsertPreNvSciSyncFence(
    NvMediaDla                *dla,
    const NvSciSyncFence      *prenvscisyncfence
);
 
NvMediaStatus
NvMediaDlaGetSOFNvSciSyncFence(
    const NvMediaDla                *dla,
    NvSciSyncObj               sofnvscisyncobj,
    NvSciSyncFence            *sofnvscisyncfence
);
 
NvMediaStatus
NvMediaDlaGetEOFNvSciSyncFence(
    const NvMediaDla                *dla,
    NvSciSyncObj               eofnvscisyncobj,
    NvSciSyncFence            *eofnvscisyncfence
);
 
NvMediaStatus
NvMediaDlaInsertSOFNvSciSyncObj(
    NvMediaDla* dla,
    NvSciSyncObj syncObj
);
 
NvMediaStatus
NvMediaDlaInsertEOFNvSciSyncObj(
    NvMediaDla* dla,
    NvSciSyncObj syncObj
);
 
/*
 * \defgroup history_nvmedia_dla_nvscisync History
 * Provides change history for the NvMedia Dla NvSciSync API
 *
 * \section history_nvmedia_dla_nvscisync Version History
 *
 * <b> Version 1.0 </b> March 14, 2019
 * - Initial release
 *
 * <b> Version 1.1 </b> April 11, 2019
 * - Add new API NvMediaDlaSetNvSciSyncObjforSOF and NvMediaDlaGetEOFNvSciSyncFence
 * - Rename NvMediaDlaUnRegisterNvSciSyncObj to NvMediaDlaUnregisterNvSciSyncObj
 *
 * <b> Version 1.2 </b> Jan 22, 2020
 * - Disable NvMediaDlaSetNvSciSyncObjforSOF and NvMediaDlaGetSOFNvSciSyncFence in
 *   safety build as they are currently unsupported.
 *
 * <b> Version 1.3 </b> Jul 20, 2020
 * - Added support for NvSciSyncObj backed by deterministic primitive.
 * - Currently timestamp feature is disabled with NvSciSyncObj backed by
 *  deterministic primitive.
 * - Added new APIs: NvMediaDlaInsertEOFNvSciSyncObj,
 *      NvMediaDlaInsertSOFNvSciSyncObj (disabled in safety),
 *      NvMediaDlaFillNvSciSyncDeterministicAttrList
 *
 * <b> Version 1.4 </b> July 26, 2021
 * - Update comments for NvMediaDlaGetEOFNvSciSyncFence and NvMediaDlaGetSOFNvSciSyncFence
 *
 * <b> Version 1.5 </b> August 20, 2021
 * - Update doxygen comments for All APIs to have Thread safety information and API Group information
 *
 * <b> Version 1.6 </b> October 25, 2021
 * - Enable SOF feature in safety builds.
 * - Enable timestamp support for all primitives.
 *
 * <b> Version 1.6.0 </b> May 10, 2022
 * - Added patch version number macro: NVMEDIA_DLA_NVSCISYNC_VERSION_PATCH.
 *
 */
 
#ifdef __cplusplus
}     /* extern "C" */
#endif
 
#endif /* NVMEDIA_DLA_NVSCISYNC_H */