nvscistream_api.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020-2025 NVIDIA Corporation. All rights reserved.
 *
 * NVIDIA Corporation and its licensors retain all intellectual property and
 * proprietary rights in and to this software, related documentation and any
 * modifications thereto. Any use, reproduction, disclosure or distribution
 * of this software and related documentation without an express license
 * agreement from NVIDIA Corporation is strictly prohibited.
 */
#ifndef NVSCISTREAM_API_H
#define NVSCISTREAM_API_H
 
#ifdef __cplusplus
#include <cstdint>
#else
#include <stdint.h>
#endif
#if defined(NV_QNX)
#include "nvdvms_client.h"
#include "nvdvms_types.h"
#endif
#include "nvscierror.h"
#include "nvscibuf.h"
#include "nvscisync.h"
#include "nvsciipc.h"
#include "nvscievent.h"
#include "nvscistream_types.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
#if (defined(NV_QNX))
/*
 *       - API is called in runtime state
 */
#endif
/*
 *       - @a upstream argument represents a multicast block which is not ready
 *         for late consumer connections.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamBlockConnect(
    NvSciStreamBlock const upstream,
    NvSciStreamBlock const downstream
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_BadParameter If any of the following occurs:
 *       - the output parameter @a producer is a null pointer
 *       - the @a pool parameter does not reference a pool block
 *  - ::NvSciError_StreamBadBlock If block referenced by @a pool is invalid.
 *  - ::NvSciError_InsufficientResource If the pool block is already
 *      associated with another producer.
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - the producer block cannot be initialized properly
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamProducerCreate(
    NvSciStreamBlock const pool,
    NvSciStreamBlock *const producer
);
 
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_BadParameter If any of the following occurs:
 *       - the output parameter @a producer is a null pointer
 *       - the @a pool parameter does not reference a pool block
 *  - ::NvSciError_StreamBadBlock If block referenced by @a pool is invalid
 *  - ::NvSciError_InsufficientResource If the pool block is already
 *      associated with another producer.
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - the producer block cannot be initialized properly
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamProducerCreate2(
    NvSciStreamBlock const pool,
    bool const crcValidate,
    NvSciStreamBlock *const producer
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_BadParameter If any of the following occurs:
 *       - the output parameter @a consumer is a null pointer
 *       - the @a queue parameter does not reference a queue block
 *  - ::NvSciError_StreamBadBlock If block referenced by @a queue is invalid.
 *  - ::NvSciError_InsufficientResource If the queue block is already bound to
 *      another consumer.
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - the consumer block cannot be initialized properly
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamConsumerCreate(
    NvSciStreamBlock const queue,
    NvSciStreamBlock *const consumer
);
 
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_BadParameter If any of the following occurs:
 *       - the output parameter @a consumer is a null pointer
 *       - the @a queue parameter does not reference a queue block
 *  - ::NvSciError_StreamBadBlock If the block referenced by @a queue is
 *      invalid.
 *  - ::NvSciError_InsufficientResource If the queue block is already bound to
 *      another consumer.
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - the consumer block cannot be initialized properly
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamConsumerCreate2(
    NvSciStreamBlock const queue,
    bool const crcValidate,
    NvSciStreamBlock *const consumer
);
 
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_BadParameter The output parameter @a pool is a null pointer.
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - the pool block cannot be initialized properly
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamStaticPoolCreate(
    uint32_t const numPackets,
    NvSciStreamBlock *const pool
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_BadParameter The output parameter @a queue is a null pointer.
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - the mailbox queue block cannot be initialized properly
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamMailboxQueueCreate(
    NvSciStreamBlock *const queue
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_BadParameter The output parameter @a queue is a null pointer.
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - the FIFO queue block cannot be initialized properly.
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamFifoQueueCreate(
    NvSciStreamBlock *const queue
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_BadParameter If any of the following occurs:
 *       - the output parameter @a multicast is a null pointer
 *       - @a outputCount is larger than the number allowed
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - the multicast block cannot be initialized properly
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamMulticastCreate(
    uint32_t const outputCount,
    NvSciStreamBlock *const multicast
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 *  - ::NvSciError_NotSupported for interVM endpoint backend type in QNX.
 */
#endif
/*
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - connection establishment through @a ipcEndpoint fails
 *       - IpcSrc block cannot be initialized properly
 *  - ::NvSciError_BadParameter The output parameter @a ipc is a null pointer.
 *  - ::NvSciError_NotInitialized @a ipcEndpoint is uninitialized.
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamIpcSrcCreate(
    NvSciIpcEndpoint const ipcEndpoint,
    NvSciSyncModule const syncModule,
    NvSciBufModule const bufModule,
    NvSciStreamBlock *const ipc
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 *  - ::NvSciError_NotSupported Inter-VM endpoint not supported in QNX.
 */
#endif
/*
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - connection establishment through @a ipcEndpoint fails
 *       - IpcSrc or C2CSrc block cannot be initialized properly
 *       - default FIFO queue cannot be initialized properly when queue is not
 *         provided by user if the @a ipcEndpoint is a C2C endpoint.
 *  - ::NvSciError_BadParameter If any of the following occurs:
 *       - the output parameter @a ipc is a null pointer
 *       - the input parameter @a queue does not reference a queue block when
 *         the @a ipcEndpoint is a C2C backend type
 *       - the input parameter @a queue is valid when the @a ipcEndpoint is
 *         a non-C2C backend type
 *  - ::NvSciError_StreamBadBlock If the input parameter @a queue is provided
 *      but invalid when the @a ipcEndpoint is a C2C backend type
 *  - ::NvSciError_InsufficientResource If the queue block is already
 *      associated with any other consumer or C2CSrc block.
 *  - ::NvSciError_NotInitialized @a ipcEndpoint is uninitialized.
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamIpcSrcCreate2(
    NvSciIpcEndpoint const ipcEndpoint,
    NvSciSyncModule const syncModule,
    NvSciBufModule const bufModule,
    NvSciStreamBlock const queue,
    NvSciStreamBlock *const ipc
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 *  - ::NvSciError_NotSupported for interVM endpoint backend type in QNX.
 */
#endif
/*
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - connection establishment through @a ipcEndpoint fails
 *       - IpcDst block can't be initialized properly
 *  - ::NvSciError_BadParameter The output parameter @a ipc is a null pointer.
 *  - ::NvSciError_NotInitialized @a ipcEndpoint is uninitialized.
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamIpcDstCreate(
    NvSciIpcEndpoint const ipcEndpoint,
    NvSciSyncModule const syncModule,
    NvSciBufModule const bufModule,
    NvSciStreamBlock *const ipc
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 *  - ::NvSciError_NotSupported Inter-VM backend endpoint not supported in QNX
 */
#endif
/*
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - connection establishment through @a ipcEndpoint fails
 *       - IpcDst or C2CDst block cannot be initialized properly
 *  - ::NvSciError_BadParameter If any of the following occurs:
 *       - the output parameter @a ipc is a null pointer
 *       - the input parameter @a pool does not reference a pool block when the
 *         @a ipcEndpoint is a C2C backend type
 *       - the input parameter @a pool is valid when the @a ipcEndpoint
 *         is a non-C2C backend type
 *  - ::NvSciError_StreamBadBlock If the input parameter @a pool is provided
 *      but invalid when the @a ipcEndpoint is a C2C backend type
 *  - ::NvSciError_InsufficientResource If the pool block is already
 *      associated with any other producer or C2CDst block.
 *  - ::NvSciError_NotInitialized @a ipcEndpoint is uninitialized
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamIpcDstCreate2(
    NvSciIpcEndpoint const ipcEndpoint,
    NvSciSyncModule const syncModule,
    NvSciBufModule const bufModule,
    NvSciStreamBlock const pool,
    NvSciStreamBlock *const ipc
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_BadParameter The output parameter @a limiter is a null
 *      pointer.
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - the Limiter block can't be initialized properly
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamLimiterCreate(
    uint32_t const maxPackets,
    NvSciStreamBlock *const limiter
);
 
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_BadParameter The output parameter @a returnSync is a null
 *      pointer.
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - the ReturnSync block can't be initialized properly
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamReturnSyncCreate(
    NvSciSyncModule const syncModule,
    NvSciStreamBlock *const returnSync
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_BadParameter The output parameter @a presentSync is a null
 *      pointer.
 *  - ::NvSciError_StreamInternalError If any of the following occurs:
 *       - block registration fails
 *       - the PresentSync block can't be initialized properly
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamPresentSyncCreate(
    NvSciSyncModule const syncModule,
    NvSciStreamBlock *const presentSync
);
 
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamBlockEventQuery(
    NvSciStreamBlock const block,
    int64_t const timeoutUsec,
    NvSciStreamEventType *const event
);
 
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockErrorGet(
    NvSciStreamBlock const block,
    NvSciError* const status
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_BadAddress @a numConsumers is NULL.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not posted on the block or
 *      NvSciStreamEventType_Disconnect is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockConsumerCountGet(
    NvSciStreamBlock const block,
    uint32_t* const numConsumers
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer, consumer, pool and multicast
 *      block.
 *  - ::NvSciError_NotYetAvailable Prerequisites for marking the group
 *      identified by @a setupType as complete have not been met.
 *  - ::NvSciError_InsufficientData Not all data associated with the group
 *      identified by @a setupType has been provided.
 *  - ::NvSciError_AlreadyDone The group identified by @a setupType has
 *      already been marked complete.
 *  - ::NvSciError_BadParameter @a completed is not true.
 *  - ::NvSciError_Busy An NvSciStream interface in another thread is
 *      currently interacting with the group identified by @a setupType on
 *      this @a block. The call can be tried again, but this typically
 *      indicates a flaw in application design.
 *  - ::NvSciError_InsufficientMemory Failed to allocate memory needed to
 *      process the data.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected when it is
 *      called on producer, consumer or pool block, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or
 *      NvSciStreamEventType_Disconnect is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockSetupStatusSet(
    NvSciStreamBlock const block,
    NvSciStreamSetup const setupType,
    bool const completed
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer, consumer and pool block.
 *  - ::NvSciError_NotYetAvailable The prerequisite event has not yet arrived.
 *  - ::NvSciError_NoLongerAvailable The element export phase was completed.
 *  - ::NvSciError_Busy An NvSciStream interface in another thread is
 *      currently interacting with the block's exported element information.
 *      The call can be retried, but this typically indicates a flaw in
 *      application design.
 *  - ::NvSciError_Overflow The number of elements in the list has reached
 *      the maximum allowed value.
 *  - ::NvSciError_AlreadyInUse An element with the specified @a userType
 *      already exists in the list.
 *  - ::NvSciError_InsufficientMemory Unable to allocate storage for the new
 *      element.
 *  - ::NvSciError_BadParameter If @a bufAttrList is NULL.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - Any error that NvSciBufAttrListClone() can generate.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockElementAttrSet(
    NvSciStreamBlock const block,
    uint32_t const userType,
    NvSciBufAttrList const bufAttrList
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer, consumer and pool block.
 *  - ::NvSciError_BadAddress @a numElements is NULL.
 *  - ::NvSciError_BadParameter The @a queryBlockType is not valid for
 *      the @a block.
 *  - ::NvSciError_NotYetAvailable The requested element information has
 *      not yet arrived.
 *  - ::NvSciError_NoLongerAvailable The element import phase was completed.
 *  - ::NvSciError_Busy An NvSciStream interface in another thread is
 *      currently interacting with the block's imported element information.
 *      The call can be retried.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockElementCountGet(
    NvSciStreamBlock const block,
    NvSciStreamBlockType const queryBlockType,
    uint32_t* const numElements
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer, consumer and pool block.
 *  - ::NvSciError_BadAddress @a userType and @a bufAttrList are both NULL.
 *  - ::NvSciError_BadParameter The @a queryBlockType is not valid for
 *      the @a block or the @a elemIndex is out of range.
 *  - ::NvSciError_NotYetAvailable The requested element information has
 *      not yet arrived.
 *  - ::NvSciError_NoLongerAvailable The element import phase was completed.
 *  - ::NvSciError_Busy An NvSciStream interface in another thread is
 *      currently interacting with the block's imported element information.
 *      The call can be retried.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - ::NvSciError_IndexOutOfRange @a elemIndex out of range.
 *  - Any error that NvSciBufAttrListClone() can generate.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockElementAttrGet(
    NvSciStreamBlock const block,
    NvSciStreamBlockType const queryBlockType,
    uint32_t const elemIndex,
    uint32_t* const userType,
    NvSciBufAttrList* const bufAttrList
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on pool block.
 *  - ::NvSciError_NotYetAvailable The requested element information has
 *      not yet arrived.
 *  - ::NvSciError_NoLongerAvailable The element export phase was completed.
 *  - ::NvSciError_BadParameter The @a consumerIndex is out of range or
 *      entry with @a userType not found in the allocated element list.
 *  - ::NvSciError_StreamInternalError Inconsistency in internal data structures.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - ::NvSciError_Busy An NvSciStream interface in another thread is
 *      currently interacting with the block's imported element information.
 *      The call can be retried.
 *  - ::NvSciError_IndexOutOfRange @a consumerIndex out of range.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockElementNotVisible(
    NvSciStreamBlock const pool,
    uint32_t const userType,
    uint32_t const consumerIndex
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on consumer block.
 *  - ::NvSciError_NotYetAvailable The requested element information has
 *      not yet arrived.
 *  - ::NvSciError_NoLongerAvailable The element import phase was completed.
 *  - ::NvSciError_BadParameter The @a elemIndex is out of range.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockElementUsageSet(
    NvSciStreamBlock const block,
    uint32_t const elemIndex,
    bool const used
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a pool is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a pool. Only supported on pool block.
 *  - ::NvSciError_BadAddress @a handle is NULL.
 *  - ::NvSciError_NotYetAvailable Completion of element export has not
 *      yet been signaled on the pool.
 *  - ::NvSciError_StreamBadCookie @a cookie is invalid.
 *  - ::NvSciError_AlreadyInUse @a cookie is already assigned to a packet.
 *  - ::NvSciError_Overflow Pool already has maximum number of packets.
 *  - ::NvSciError_InsufficientMemory Unable to allocate memory for the new
 *      packet.
 *  - ::NvSciError_StreamInternalError Inconsistency in internal data structures.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamPoolPacketCreate(
    NvSciStreamBlock const pool,
    NvSciStreamCookie const cookie,
    NvSciStreamPacket *const handle
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a pool is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a pool. Only supported on pool block.
 *  - ::NvSciError_StreamBadPacket Packet referenced by @a handle is invalid.
 *  - ::NvSciError_BadParameter @a bufObj is NULL.
 *  - ::NvSciError_IndexOutOfRange @a index is out of range.
 *  - ::NvSciError_NoLongerAvailable The packet has been marked complete.
 *  - ::NvSciError_InconsistentData The element at @a index is unused by
 *      the consumer.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - Any error or panic behavior returned by NvSciBufObjRef().
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamPoolPacketInsertBuffer(
    NvSciStreamBlock const pool,
    NvSciStreamPacket const handle,
    uint32_t const index,
    NvSciBufObj const bufObj
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a pool is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a pool. Only supported on pool block.
 *  - ::NvSciError_StreamBadPacket Packet referenced by @a handle is invalid.
 *  - ::NvSciError_AlreadyDone The packet has already been marked complete.
 *  - ::NvSciError_InsufficientData Buffers were not provided for all of the
 *      packet's elements.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamPoolPacketComplete(
    NvSciStreamBlock const pool,
    NvSciStreamPacket const handle
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a pool is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a pool. Only supported on pool block.
 *  - ::NvSciError_StreamBadPacket Packet referenced by @a handle is invalid.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamPoolPacketDelete(
    NvSciStreamBlock const pool,
    NvSciStreamPacket const handle
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer and consumer block.
 *  - ::NvSciError_BadAddress @a handle is NULL.
 *  - ::NvSciError_NotYetAvailable The block has not yet indicated it is
 *      done importing element information.
 *  - ::NvSciError_NoLongerAvailable The block has completed importing packets.
 *  - ::NvSciError_NoStreamPacket There is no pending new packet handle.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockPacketNewHandleGet(
    NvSciStreamBlock const block,
    NvSciStreamPacket* const handle
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer and consumer block.
 *  - ::NvSciError_StreamBadPacket Packet referenced by @a handle is invalid.
 *  - ::NvSciError_BadAddress @a bufObj is NULL.
 *  - ::NvSciError_NotYetAvailable The block has not yet indicated it is
 *      done importing element information.
 *  - ::NvSciError_NoLongerAvailable The block has completed importing packets.
 *  - ::NvSciError_IndexOutOfRange @a elemIndex is out of range.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - Any error or panic behavior returned by NvSciBufObjDup(), NvSciBufObjRef().
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockPacketBufferGet(
    NvSciStreamBlock const block,
    NvSciStreamPacket const handle,
    uint32_t const elemIndex,
    NvSciBufObj* const bufObj
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer and consumer block.
 *  - ::NvSciError_BadAddress @a cookie is NULL.
 *  - ::NvSciError_NotYetAvailable The block has not yet indicated it is
 *      done importing element information.
 *  - ::NvSciError_NoStreamPacket There is no pending deleted packet cookie.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockPacketOldCookieGet(
    NvSciStreamBlock const block,
    NvSciStreamCookie* const cookie
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer and consumer block.
 *  - ::NvSciError_StreamBadPacket Packet referenced by @a handle is invalid.
 *  - ::NvSciError_BadParameter @a status is invalid.
 *  - ::NvSciError_StreamBadCookie The packet was accepted but @a cookie is
 *      invalid.
 *  - ::NvSciError_AlreadyInUse The packet was accepted but @a cookie was
 *      already assigned to another packet.
 *  - ::NvSciError_AlreadyDone The packet's status was already set.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockPacketStatusSet(
    NvSciStreamBlock const block,
    NvSciStreamPacket const handle,
    NvSciStreamCookie const cookie,
    NvSciError const status
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a pool is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a pool. Only supported on pool block.
 *  - ::NvSciError_StreamBadPacket Packet referenced by @a handle is invalid.
 *  - ::NvSciError_BadAddress @a accepted is NULL.
 *  - ::NvSciError_NotYetAvailable Packet status has not yet arrived.
 *  - ::NvSciError_NoLongerAvailable Packet export phase has completed.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamPoolPacketStatusAcceptGet(
    NvSciStreamBlock const pool,
    NvSciStreamPacket const handle,
    bool* const accepted
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a pool is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a pool. Only supported on pool block.
 *  - ::NvSciError_StreamBadPacket Packet referenced by @a handle is invalid.
 *  - ::NvSciError_BadAddress @a status is NULL.
 *  - ::NvSciError_NotYetAvailable Packet status has not yet arrived.
 *  - ::NvSciError_NoLongerAvailable Packet export phase has completed.
 *  - ::NvSciError_IndexOutOfRange @a queryBlockIndex is out of range.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - ::NvSciError_BadParameter: @a queryBlockType does not indicate
 *      producer or consumer endpoint.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamPoolPacketStatusValueGet(
    NvSciStreamBlock const pool,
    NvSciStreamPacket const handle,
    NvSciStreamBlockType const queryBlockType,
    uint32_t const queryBlockIndex,
    NvSciError* const status
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer and consumer block.
 *  - ::NvSciError_NotYetAvailable Element information has not yet arrived.
 *  - ::NvSciError_NoLongerAvailable The waiter info export phase was
 *     completed.
 *  - ::NvSciError_IndexOutOfRange The @a elemIndex is out of range.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - Any error or panic behavior that NvSciSyncAttrListClone() can generate.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockElementWaiterAttrSet(
    NvSciStreamBlock const block,
    uint32_t const elemIndex,
    NvSciSyncAttrList const waitSyncAttrList
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer and consumer block.
 *  - ::NvSciError_BadAddress @a waitSyncAttrList is NULL.
 *  - ::NvSciError_NotYetAvailable Waiter information has not yet arrived.
 *  - ::NvSciError_NoLongerAvailable The waiter info import phase was
 *      completed.
 *  - ::NvSciError_IndexOutOfRange The @a elemIndex is out of range.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - Any error or panic behavior that NvSciSyncAttrListClone() can generate.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockElementWaiterAttrGet(
    NvSciStreamBlock const block,
    uint32_t const elemIndex,
    NvSciSyncAttrList* const waitSyncAttrList
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer and consumer block.
 *  - ::NvSciError_NotYetAvailable Waiter requirements have not yet arrived.
 *  - ::NvSciError_NoLongerAvailable The signal info export phase was
 *      completed.
 *  - ::NvSciError_IndexOutOfRange The @a elemIndex is out of range.
 *  - ::NvSciError_InconsistentData The element at @a elemIndex is unused by
 *      @a block.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - Any error or panic behavior that NvSciSyncObjGetAttrList(),
 *      NvSciSyncAttrListValidateReconciled() or NvSciSyncObjRef() can generate.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockElementSignalObjSet(
    NvSciStreamBlock const block,
    uint32_t const elemIndex,
    NvSciSyncObj const signalSyncObj
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer and consumer block.
 *  - ::NvSciError_BadAddress @a signalSyncObj is NULL.
 *  - ::NvSciError_NotYetAvailable Signal information has not yet arrived.
 *  - ::NvSciError_NoLongerAvailable The signal info import phase was
 *      completed.
 *  - ::NvSciError_IndexOutOfRange The @a queryBlockIndex or @a elemIndex
 *      is out of range.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - Any error or panic behavior that NvSciSyncObjRef(), NvSciSyncObjDup()
 *     can generate.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockElementSignalObjGet(
    NvSciStreamBlock const block,
    uint32_t const queryBlockIndex,
    uint32_t const elemIndex,
    NvSciSyncObj* const signalSyncObj
);
 
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamProducerPacketGet(
    NvSciStreamBlock const producer,
    NvSciStreamCookie *const cookie
);
 
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamProducerPacketPresent(
    NvSciStreamBlock const producer,
    NvSciStreamPacket const handle
);
 
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamConsumerPacketAcquire(
    NvSciStreamBlock const consumer,
    NvSciStreamCookie *const cookie
);
 
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamConsumerPacketRelease(
    NvSciStreamBlock const consumer,
    NvSciStreamPacket const handle
);
 
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockPacketFenceSet(
    NvSciStreamBlock const block,
    NvSciStreamPacket const handle,
    uint32_t const elemIndex,
    NvSciSyncFence const *const postfence
);
 
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockPacketFenceGet(
    NvSciStreamBlock const block,
    NvSciStreamPacket const handle,
    uint32_t const queryBlockIndex,
    uint32_t const elemIndex,
    NvSciSyncFence* const prefence
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a producer is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a producer. Only supported on producer block.
 *  - ::NvSciError_BadAddress @a newConnected is NULL.
 *  - ::NvSciError_IndexOutOfRange @a queryConnIndex is not valid
 *  - ::NvSciError_NotYetAvailable If NvSciStreamEventType_Connected is not
 *      yet received for the newly connected consumers.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamNewConsumerGet(
    NvSciStreamBlock const producer,
    uint32_t const consumerIndex,
    bool* const newConnected );
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamBlockDelete(
    NvSciStreamBlock const block
);
 
 
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamBlockDisconnect(
    NvSciStreamBlock const block
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_BadParameter @a attr is invalid or @a value is null.
 *
 * @pre
 *   None
 *
 * @post
 *   None
 *
 * @usage
 * - 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
 */
NvSciError NvSciStreamAttributeQuery(
    NvSciStreamQueryableAttrib const attr,
    int32_t *const value
);
 
#if (defined(NV_QNX))
/*
 *       - API is called in runtime state.
 */
#endif
/*
 *       - An NvSciStream API has already been called on the block referenced
 *         by @a block.
 *  - ::NvSciError_BadParameter If @a eventService or @a eventNotifier is null
 *  - ::NvSciError_StreamBadBlock If block referenced by @a block is invalid.
 *  - Any error or panic behavior that NvSciEventService::CreateLocalEvent()
 *     can generate when @a eventService and @a eventNotifier arguments
 *     are passed to it.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError NvSciStreamBlockEventServiceSetup(
    NvSciStreamBlock const block,
    NvSciEventService  *const eventService,
    NvSciEventNotifier **const eventNotifier
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on ipcsrc and ipcdst block.
 *  - ::NvSciError_AlreadyDone Internal event service setup done.
 *  - ::NvSciError_BadParameter If any of the following occurs:
 *       - @a eventService, @a notifierCount or @a eventNotifierArray is null
 *         or invalid
 *  - ::NvSciError_StreamBadBlock If block referenced by @a block is invalid.
 *  - ::NvSciError_InsufficientMemory Size of the input array @a notifierCount
 *      not large enough.
 *  - Any error or panic behavior that following APIs can generate:
 *    NvSciIpcBindEventService(), NvSciIpcGetEventNotifier(),
 *    NvSciEventNotifier::SetHandler(), NvSciEventService::CreateLocalEvent().
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockInternalEventServiceSetup(
    NvSciStreamBlock const block,
    NvSciEventService* const eventService,
    uint32_t* const notifierCount,
    NvSciEventNotifier** const eventNotifierArray
);
 
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockHandleInternalEvents(
    NvSciStreamBlock const block
);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer and consumer block.
 *  - ::NvSciError_BadParameter @a data is a NULL pointer.
 *  - ::NvSciError_AlreadyInUse An endpoint information with the specified
 *      @a userType already exists in the list.
 *  - ::NvSciError_InsufficientMemory Unable to allocate storage for the new
 *      endpoint information.
 *  - ::NvSciError_NoLongerAvailable The configuration of the block instance
 *      is already done.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockUserInfoSet(
    NvSciStreamBlock const block,
    uint32_t const userType,
    uint32_t const dataSize,
    void const* const data);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_BadAddress If any of the following occurs:
 *       - @a dataSize is NULL
 *       - @a data is NULL when @a dataSize is non-zero
 *  - ::NvSciError_NoLongerAvailable Setup of the stream is completed.
 *  - ::NvSciError_BadParameter The @a queryBlockType is not valid.
 *  - ::NvSciError_IndexOutOfRange The @a queryBlockIndex is invalid for the
 *      @a queryBlockType.
 *  - ::NvSciError_StreamInfoNotProvided The queried endpoint info not exist.
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockUserInfoGet(
    NvSciStreamBlock const block,
    NvSciStreamBlockType const queryBlockType,
    uint32_t const queryBlockIndex,
    uint32_t const userType,
    uint32_t* const dataSize,
    void* const data);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer and consumer block.
 *  - ::NvSciError_AlreadyInUse An endpoint information with the specified
 *      @a userType already exists in the list.
 *  - ::NvSciError_InsufficientMemory Unable to allocate storage for the new
 *      endpoint information.
 *  - ::NvSciError_NoLongerAvailable The configuration of the block instance
 *      is already done.
 *  - ::NvSciError_BadAddress @a crc or @a data is NULL.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockUserInfoSetWithCrc(
    NvSciStreamBlock const block,
    uint32_t const userType,
    uint32_t const dataSize,
    void const* const data,
    uint32_t* const crc);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_BadAddress If any of the following occurs:
 *       - @a dataSize is NULL
 *       - @a data is NULL when @a dataSize is non-zero
 *       - @a crc pointer is NULL.
 *  - ::NvSciError_NoLongerAvailable Setup of the stream is completed.
 *  - ::NvSciError_BadParameter The @a queryBlockType is not valid.
 *  - ::NvSciError_IndexOutOfRange The @a queryBlockIndex is invalid for the
 *      @a queryBlockType.
 *  - ::NvSciError_StreamInfoNotProvided The queried endpoint info not exist.
 *  - ::NvSciError_InsufficientMemory Memory allocation fails.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockUserInfoGetWithCrc(
    NvSciStreamBlock const block,
    NvSciStreamBlockType const queryBlockType,
    uint32_t const queryBlockIndex,
    uint32_t const userType,
    uint32_t* const dataSize,
    void* const data,
    uint32_t* const crc);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer, consumer and primary pool block.
 *  - ::NvSciError_NotYetAvailable The prerequisite event has not yet arrived.
 *  - ::NvSciError_NoLongerAvailable The element export phase was completed.
 *  - ::NvSciError_Busy An NvSciStream interface in another thread is
 *      currently interacting with the block's exported element information.
 *      The call can be retried, but this typically indicates a flaw in
 *      application design.
 *  - ::NvSciError_Overflow The number of elements in the list has reached
 *      the maximum allowed value.
 *  - ::NvSciError_AlreadyInUse An element with the specified @a userType
 *      already exists in the list.
 *  - ::NvSciError_InsufficientMemory Unable to allocate storage for the new
 *      element.
 *  - ::NvSciError_BadParameter If @a bufAttrList is NULL.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - ::NvSciError_BadAddress @a crc pointer is NULL.
 *  - Any error that NvSciBufAttrListClone() can generate.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockElementAttrSetWithCrc(
    NvSciStreamBlock const block,
    uint32_t const userType,
    NvSciBufAttrList const bufAttrList,
    uint32_t* const crc);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer, consumer and pool block.
 *  - ::NvSciError_BadAddress @a userType and @a bufAttrList are both NULL.
 *  - ::NvSciError_BadParameter The @a queryBlockType is not valid for
 *      the @a block or the @a elemIndex is out of range.
 *  - ::NvSciError_NotYetAvailable The requested element information has
 *      not yet arrived.
 *  - ::NvSciError_NoLongerAvailable The element import phase was completed.
 *  - ::NvSciError_Busy An NvSciStream interface in another thread is
 *      currently interacting with the block's imported element information.
 *      The call can be retried.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - ::NvSciError_BadAddress @a crc pointer is NULL.
 *  - ::NvSciError_IndexOutOfRange @a elemIndex out of range.
 *  - Any error that NvSciBufAttrListClone() can generate.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockElementAttrGetWithCrc(
    NvSciStreamBlock const block,
    NvSciStreamBlockType const queryBlockType,
    uint32_t const elemIndex,
    uint32_t* const userType,
    NvSciBufAttrList* const bufAttrList,
    uint32_t* const crc);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a pool is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a pool. Only supported on pool block.
 *  - ::NvSciError_StreamBadPacket Packet referenced by @a handle is invalid.
 *  - ::NvSciError_BadParameter @a bufObj is NULL.
 *  - ::NvSciError_IndexOutOfRange @a index is out of range.
 *  - ::NvSciError_NoLongerAvailable The packet has been marked complete.
 *  - ::NvSciError_InconsistentData The element at @a index is unused by
 *     the consumer.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - ::NvSciError_BadAddress @a crc pointer is NULL.
 *  - Any error or panic behavior returned by NvSciBufObjGetId()
 *    or NvSciBufObjRef().
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamPoolPacketInsertBufferWithCrc(
    NvSciStreamBlock const pool,
    NvSciStreamPacket const handle,
    uint32_t const index,
    NvSciBufObj const bufObj,
    uint32_t* const crc);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer and consumer block.
 *  - ::NvSciError_StreamBadPacket Packet referenced by @a handle is invalid.
 *  - ::NvSciError_BadAddress @a bufObj is NULL.
 *  - ::NvSciError_NotYetAvailable The block has not yet indicated it is
 *      done importing element information.
 *  - ::NvSciError_NoLongerAvailable The block has completed importing packets.
 *  - ::NvSciError_IndexOutOfRange @a elemIndex is out of range.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - ::NvSciError_BadAddress @a crc pointer is NULL.
 *  - Any error or panic behavior returned by NvSciBufObjGetId(), NvSciBufObjDup(),
 *    NvSciBufObjRef().
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockPacketBufferGetWithCrc(
    NvSciStreamBlock const block,
    NvSciStreamPacket const handle,
    uint32_t const elemIndex,
    NvSciBufObj* const bufObj,
    size_t const crcCount,
    uint32_t* const crc);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer and consumer block.
 *  - ::NvSciError_NotYetAvailable Waiter requirements have not yet arrived.
 *  - ::NvSciError_NoLongerAvailable The signal info export phase was
 *      completed.
 *  - ::NvSciError_IndexOutOfRange The @a elemIndex is out of range.
 *  - ::NvSciError_InconsistentData The element at @a elemIndex is unused by
 *      @a block.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - ::NvSciError_BadAddress @a crc pointer is NULL.
 *  - Any error or panic behavior that NvSciSyncObjIdGet(), NvSciSyncObjGetAttrList()
 *    NvSciSyncAttrListValidateReconciled() or NvSciSyncObjRef() can generate.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockElementSignalObjSetWithCrc(
    NvSciStreamBlock const block,
    uint32_t const elemIndex,
    NvSciSyncObj const signalSyncObj,
    uint32_t* const crc);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on producer and consumer block.
 *  - ::NvSciError_BadAddress @a signalSyncObj is NULL.
 *  - ::NvSciError_NotYetAvailable Signal information has not yet arrived.
 *  - ::NvSciError_NoLongerAvailable The signal info import phase was
 *      completed.
 *  - ::NvSciError_IndexOutOfRange The @a queryBlockIndex or @a elemIndex
 *      is out of range.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 *  - ::NvSciError_BadAddress @a crc pointer is NULL.
 *  - Any error or panic behavior that NvSciSyncObjIdGet(), NvSciSyncObjRef(),
 *    NvSciSyncObjDup() can generate.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockElementSignalObjGetWithCrc(
    NvSciStreamBlock const block,
    uint32_t const queryBlockIndex,
    uint32_t const elemIndex,
    NvSciSyncObj* const signalSyncObj,
    uint32_t* const crc);
 
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockPacketFenceSetWithCrc(
    NvSciStreamBlock const block,
    NvSciStreamPacket const handle,
    uint32_t const elemIndex,
    NvSciSyncFence const *const postfence,
    uint32_t* const crc);
 
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamBlockPacketFenceGetWithCrc(
    NvSciStreamBlock const block,
    NvSciStreamPacket const handle,
    uint32_t const queryBlockIndex,
    uint32_t const elemIndex,
    NvSciSyncFence* const prefence,
    uint32_t* const crc);
 
#if (defined(NV_QNX))
/*
 *  - ::NvSciError_InvalidState API is called in runtime state.
 */
#endif
/*
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a consumer. Only supported on consumer block.
 *  - ::NvSciError_BadAddress @a index is NULL.
 *  - ::NvSciError_StreamNotConnected Stream is not fully connected, which means
 *      NvSciStreamEventType_Connected is not yet queried by the application
 *      by calling NvSciStreamBlockEventQuery() or NvSciStreamEventType_Disconnect
 *      is posted.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamConsumerIndexGet(
    NvSciStreamBlock const consumer,
    uint32_t* const index);
 
#if (defined(NV_QNX))
/*
 *       - API is called in runtime state
 */
#endif
/*
 *       - An NvSciStream API has already been called on the block referenced
 *         by @a block.
 *  - ::NvSciError_StreamBadBlock Block referenced by @a block is invalid.
 *  - ::NvSciError_NotSupported Operation not supported on the block referenced
 *      by @a block. Only supported on ipcsrc and ipcdst block.
 */
#if (NV_IS_SAFETY == 1)
 
#endif
 
NvSciError
NvSciStreamPacketSendSync(
    NvSciStreamBlock const block);
 
#ifdef __cplusplus
}
#endif
 
#endif /* NVSCISTREAM_API_H */