nvscistream.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2019 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;

typedef enum {
    NvSciStreamQueryableAttrib_MaxElements,
    NvSciStreamQueryableAttrib_MaxSyncObj
} NvSciStreamQueryableAttrib;

typedef enum {
    NvSciStreamElementMode_Asynchronous,
    NvSciStreamElementMode_Immediate,
} NvSciStreamElementMode;

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 {
    NvSciStreamCookie cookie;
    NvSciSyncFence *prefences;
} NvSciStreamPayload;

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

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

typedef enum {
    NvSciStreamEventType_ConnectDownstream,

    NvSciStreamEventType_ConnectUpstream,

    NvSciStreamEventType_SyncAttr,

    NvSciStreamEventType_SyncCount,

    NvSciStreamEventType_SyncDesc,

    NvSciStreamEventType_PacketElementCountProducer,

    NvSciStreamEventType_PacketElementCountConsumer,

    NvSciStreamEventType_PacketElementCount,

    NvSciStreamEventType_PacketAttrProducer,

    NvSciStreamEventType_PacketAttrConsumer,

    NvSciStreamEventType_PacketAttr,

    NvSciStreamEventType_PacketCreate,

    NvSciStreamEventType_PacketElement,

    NvSciStreamEventType_PacketDelete,

    NvSciStreamEventType_PacketStatusProducer,

    NvSciStreamEventType_PacketStatusConsumer,

    NvSciStreamEventType_ElementStatusProducer,

    NvSciStreamEventType_ElementStatusConsumer,

    NvSciStreamEventType_PacketReady,

    NvSciStreamEventType_DisconnectDownstream,

    NvSciStreamEventType_DisconnectUpstream,
} NvSciStreamEventType;

typedef struct {
    NvSciStreamEventType type;

    NvSciStreamSyncAttr syncAttr;

    NvSciStreamSyncDesc syncDesc;

    NvSciStreamElementAttr packetAttr;

    NvSciStreamPacket packetCreate;

    NvSciStreamElementDesc packetElement;

    NvSciStreamCookie packetCookie;

    NvSciError error;

    uint32_t index;

    uint32_t count;
} NvSciStreamEvent;

NvSciError NvSciStreamBlockConnect(
    NvSciStreamBlock upstream,
    NvSciStreamBlock downstream
);

NvSciError NvSciStreamProducerCreate(
    NvSciStreamBlock pool,
    NvSciStreamBlock *producer
);

NvSciError NvSciStreamConsumerCreate(
    NvSciStreamBlock queue,
    NvSciStreamBlock *consumer
);

NvSciError NvSciStreamStaticPoolCreate(
    uint32_t numPackets,
    NvSciStreamBlock *pool
);

NvSciError NvSciStreamMailboxQueueCreate(
    NvSciStreamBlock *queue
);

NvSciError NvSciStreamFifoQueueCreate(
    NvSciStreamBlock *queue
);

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

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

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

NvSciError NvSciStreamBlockSyncRequirements(
    NvSciStreamBlock block,
    const NvSciStreamSyncAttr *attr
);

NvSciError NvSciStreamBlockSyncObjCount(
    NvSciStreamBlock block,
    uint32_t count
);

NvSciError NvSciStreamBlockSyncObject(
    NvSciStreamBlock block,
    const NvSciStreamSyncDesc *sync
);

NvSciError NvSciStreamBlockPacketElementCount(
    NvSciStreamBlock block,
    uint32_t count
);

NvSciError NvSciStreamBlockPacketAttr(
    NvSciStreamBlock block,
    const NvSciStreamElementAttr *attr
);

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

NvSciError NvSciStreamPoolPacketInsertBuffer(
    NvSciStreamBlock pool,
    const NvSciStreamElementDesc *desc
);

NvSciError NvSciStreamPoolPacketDelete(
    NvSciStreamBlock pool,
    NvSciStreamPacket handle
);

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

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

NvSciError NvSciStreamProducerPacketGet(
    NvSciStreamBlock producer,
    NvSciStreamPayload *payload
);

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

NvSciError NvSciStreamConsumerPacketAcquire(
    NvSciStreamBlock consumer,
    NvSciStreamPayload  *payload
);

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

NvSciError NvSciStreamBlockDelete(
    NvSciStreamBlock block
);

NvSciError NvSciStreamAttributeQuery(
    NvSciStreamQueryableAttrib attr,
    int32_t *value
);

#ifdef __cplusplus
}
#endif

#endif /* NVSCISTREAM_H */