nvscistream.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2020 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_H
#define NVSCISTREAM_H

#ifdef __cplusplus
#include <cstdint>
#else
#include <stdint.h>
#endif

#include "nvscierror.h"
#include "nvscibuf.h"
#include "nvscisync.h"
#include "nvsciipc.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef uintptr_t NvSciStreamBlock;

typedef uintptr_t NvSciStreamPacket;

typedef uintptr_t NvSciStreamCookie;

static const NvSciStreamPacket NvSciStreamPacket_Invalid = 0U;

static const NvSciStreamCookie NvSciStreamCookie_Invalid = 0U;

typedef enum {
    NvSciStreamQueryableAttrib_MaxElements          = 0x000000,
    NvSciStreamQueryableAttrib_MaxSyncObj           = 0x000001,
    NvSciStreamQueryableAttrib_MaxMulticastOutputs  = 0x000002
} NvSciStreamQueryableAttrib;

typedef enum {
    NvSciStreamElementMode_Asynchronous     = 0x000000,
    NvSciStreamElementMode_Immediate        = 0x000001
} NvSciStreamElementMode;

typedef enum {

    NvSciStreamEventType_Connected                  = 0x004004,

    NvSciStreamEventType_Disconnected               = 0x004005,

    NvSciStreamEventType_SyncAttr                   = 0x004010,

    NvSciStreamEventType_SyncCount                  = 0x004011,

    NvSciStreamEventType_SyncDesc                   = 0x004012,

    NvSciStreamEventType_PacketElementCountProducer = 0x004020,

    NvSciStreamEventType_PacketElementCountConsumer = 0x004021,

    NvSciStreamEventType_PacketElementCount         = 0x004022,

    NvSciStreamEventType_PacketAttrProducer         = 0x004023,

    NvSciStreamEventType_PacketAttrConsumer         = 0x004024,

    NvSciStreamEventType_PacketAttr                 = 0x004025,

    NvSciStreamEventType_PacketCreate               = 0x004030,

    NvSciStreamEventType_PacketElement              = 0x004031,

    NvSciStreamEventType_PacketDelete               = 0x004032,

    NvSciStreamEventType_PacketStatusProducer       = 0x004033,

    NvSciStreamEventType_PacketStatusConsumer       = 0x004034,

    NvSciStreamEventType_ElementStatusProducer      = 0x004035,

    NvSciStreamEventType_ElementStatusConsumer      = 0x004036,

    NvSciStreamEventType_PacketReady                = 0x004040,

    NvSciStreamEventType_Error                      = 0x0040FF

} NvSciStreamEventType;

typedef struct {
    NvSciStreamEventType type;

    NvSciSyncAttrList syncAttrList;

    NvSciBufAttrList bufAttrList;

    NvSciSyncObj syncObj;

    NvSciBufObj bufObj;

    NvSciStreamPacket packetHandle;

    NvSciStreamCookie packetCookie;

    uint32_t count;

    uint32_t index;

    NvSciError error;

    uint32_t userData;

    bool synchronousOnly;

    NvSciStreamElementMode syncMode;

} NvSciStreamEvent;

NvSciError NvSciStreamBlockConnect(
    NvSciStreamBlock const upstream,
    NvSciStreamBlock const downstream
);

NvSciError NvSciStreamProducerCreate(
    NvSciStreamBlock const pool,
    NvSciStreamBlock *const producer
);

NvSciError NvSciStreamConsumerCreate(
    NvSciStreamBlock const queue,
    NvSciStreamBlock *const consumer
);

NvSciError NvSciStreamStaticPoolCreate(
    uint32_t const numPackets,
    NvSciStreamBlock *const pool
);

NvSciError NvSciStreamMailboxQueueCreate(
    NvSciStreamBlock *const queue
);

NvSciError NvSciStreamFifoQueueCreate(
    NvSciStreamBlock *const queue
);

NvSciError NvSciStreamMulticastCreate(
    uint32_t const outputCount,
    NvSciStreamBlock *const multicast
);

NvSciError NvSciStreamIpcSrcCreate(
    NvSciIpcEndpoint const ipcEndpoint,
    NvSciSyncModule const syncModule,
    NvSciBufModule const bufModule,
    NvSciStreamBlock *const ipc
);

NvSciError NvSciStreamIpcDstCreate(
    NvSciIpcEndpoint const ipcEndpoint,
    NvSciSyncModule const syncModule,
    NvSciBufModule const bufModule,
    NvSciStreamBlock *const ipc
);

NvSciError NvSciStreamBlockEventQuery(
    NvSciStreamBlock const block,
    int64_t const timeoutUsec,
    NvSciStreamEvent *const event
);

NvSciError NvSciStreamBlockSyncRequirements(
    NvSciStreamBlock const block,
    bool const synchronousOnly,
    NvSciSyncAttrList const waitSyncAttrList
);

NvSciError NvSciStreamBlockSyncObjCount(
    NvSciStreamBlock const block,
    uint32_t const count
);

NvSciError NvSciStreamBlockSyncObject(
    NvSciStreamBlock const block,
    uint32_t const index,
    NvSciSyncObj const syncObj
);

NvSciError NvSciStreamBlockPacketElementCount(
    NvSciStreamBlock const block,
    uint32_t const count
);

NvSciError NvSciStreamBlockPacketAttr(
    NvSciStreamBlock const block,
    uint32_t const index,
    uint32_t const type,
    NvSciStreamElementMode const syncMode,
    NvSciBufAttrList const bufAttrList
);

NvSciError NvSciStreamPoolPacketCreate(
    NvSciStreamBlock const pool,
    NvSciStreamCookie const cookie,
    NvSciStreamPacket *const handle
);

NvSciError NvSciStreamPoolPacketInsertBuffer(
    NvSciStreamBlock const pool,
    NvSciStreamPacket const handle,
    uint32_t const index,
    NvSciBufObj const bufObj
);

NvSciError NvSciStreamPoolPacketDelete(
    NvSciStreamBlock const pool,
    NvSciStreamPacket const handle
);

NvSciError NvSciStreamBlockPacketAccept(
    NvSciStreamBlock const block,
    NvSciStreamPacket const handle,
    NvSciStreamCookie const cookie,
    NvSciError const err
);

NvSciError NvSciStreamBlockElementAccept(
    NvSciStreamBlock const block,
    NvSciStreamPacket const handle,
    uint32_t const index,
    NvSciError const err
);

NvSciError NvSciStreamProducerPacketGet(
    NvSciStreamBlock const producer,
    NvSciStreamCookie *const cookie,
    NvSciSyncFence *const prefences
);

NvSciError NvSciStreamProducerPacketPresent(
    NvSciStreamBlock const producer,
    NvSciStreamPacket const handle,
    NvSciSyncFence const *const postfences
);

NvSciError NvSciStreamConsumerPacketAcquire(
    NvSciStreamBlock const consumer,
    NvSciStreamCookie *const cookie,
    NvSciSyncFence *const prefences
);

NvSciError NvSciStreamConsumerPacketRelease(
    NvSciStreamBlock const consumer,
    NvSciStreamPacket const handle,
    NvSciSyncFence const *const postfences
);

NvSciError NvSciStreamBlockDelete(
    NvSciStreamBlock const block
);

NvSciError NvSciStreamAttributeQuery(
    NvSciStreamQueryableAttrib const attr,
    int32_t *const value
);

typedef struct {
    uint32_t index;
    uint32_t type;
    NvSciStreamElementMode mode;
    NvSciBufAttrList bufAttr;
} NvSciStreamElementAttr;

typedef struct {
    uint32_t index;
    NvSciStreamPacket handle;
    NvSciBufObj buffer;
} NvSciStreamElementDesc;

typedef struct {
    bool synchronousOnly;
    NvSciSyncAttrList waiterSyncAttr;
} NvSciStreamSyncAttr;

typedef struct {
    uint32_t index;
    NvSciSyncObj sync;
} NvSciStreamSyncDesc;

typedef struct {
    NvSciStreamCookie cookie;
    NvSciSyncFence *prefences;
} NvSciStreamPayload;

#ifdef __cplusplus
}
#endif

#endif /* NVSCISTREAM_H */