NVIDIA DRIVE OS Linux SDK API Reference

5.2.3 Release
For Test and Development only
nvscistream_types.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2020 NVIDIA Corporation. All rights reserved.
3  *
4  * NVIDIA Corporation and its licensors retain all intellectual property and
5  * proprietary rights in and to this software, related documentation and any
6  * modifications thereto. Any use, reproduction, disclosure or distribution
7  * of this software and related documentation without an express license
8  * agreement from NVIDIA Corporation is strictly prohibited.
9  */
19 #ifndef NVSCISTREAM_TYPES_H
20 #define NVSCISTREAM_TYPES_H
21 
22 #ifdef __cplusplus
23 #include <cstdint>
24 #else
25 #include <stdint.h>
26 #endif
27 
28 #include "nvscierror.h"
29 #include "nvscibuf.h"
30 #include "nvscisync.h"
31 #include "nvsciipc.h"
32 
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36 
47 typedef uintptr_t NvSciStreamBlock;
48 
50 typedef uintptr_t NvSciStreamPacket;
51 
55 typedef uintptr_t NvSciStreamCookie;
56 
63 
70 
138 typedef enum {
146 
151 typedef enum {
162 
167 typedef enum {
168 
179 
195 
217 
230 
244 
257 
270 
285 
312 
342 
367 
380 
398 
411 
426 
441 
458 
475 
484 
495 
497 
502 typedef struct {
505 
517 
531 
543 
555 
563 
578 
590  uint32_t count;
591 
604  uint32_t index;
605 
618 
630  uint32_t userData;
631 
642 
655 
657 
658 
665 typedef struct {
666  uint32_t index;
667  uint32_t type;
671 
672 typedef struct {
673  uint32_t index;
677 
678 typedef struct {
682 
683 typedef struct {
684  uint32_t index;
687 
688 typedef struct {
692 
693 #ifdef __cplusplus
694 }
695 #endif
696 
697 #endif /* NVSCISTREAM_TYPES_H */
NvSciStreamEvent::bufAttrList
NvSciBufAttrList bufAttrList
Used with events that specify packet element information: NvSciStreamEventType_PacketAttr,...
Definition: nvscistream_types.h:530
NvSciError
NvSciError
Return/error codes for all NvSci functions.
Definition: nvscierror.h:45
NvSciStreamElementAttr::type
uint32_t type
Definition: nvscistream_types.h:667
NvSciStreamEventType_Error
@ NvSciStreamEventType_Error
Indicates a failure not directly triggered by user action.
Definition: nvscistream_types.h:494
NvSciStreamEventType_ElementStatusConsumer
@ NvSciStreamEventType_ElementStatusConsumer
Specifies the consumer(s)' acceptance status of packet element.
Definition: nvscistream_types.h:474
NvSciStreamBlock
uintptr_t NvSciStreamBlock
Handle to a block.
Definition: nvscistream_types.h:47
NvSciStreamSyncDesc::sync
NvSciSyncObj sync
Definition: nvscistream_types.h:685
NvSciStreamEventType_PacketElementCountProducer
@ NvSciStreamEventType_PacketElementCountProducer
Specifies supported packet element count from producer.
Definition: nvscistream_types.h:256
NvSciStreamEventType_PacketAttr
@ NvSciStreamEventType_PacketAttr
Specifies the finalized packet element information from pool.
Definition: nvscistream_types.h:366
NvSciStreamCookie_Invalid
static const NvSciStreamCookie NvSciStreamCookie_Invalid
Constant variable denoting an invalid NvSciStreamCookie.
Definition: nvscistream_types.h:69
NvSciStreamElementMode_Asynchronous
@ NvSciStreamElementMode_Asynchronous
Written asynchronously, typically by hardware engine.
Definition: nvscistream_types.h:156
NvSciStreamEventType_Connected
@ NvSciStreamEventType_Connected
Indicates block has complete connection to producer and consumer endpoints.
Definition: nvscistream_types.h:178
NvSciStreamEventType_SyncDesc
@ NvSciStreamEventType_SyncDesc
Specifies a NvSciSyncObj sent from the opposite endpoint.
Definition: nvscistream_types.h:243
NvSciStreamEvent::packetCookie
NvSciStreamCookie packetCookie
Used with events that indicate a packet operation: NvSciStreamEventType_PacketDelete,...
Definition: nvscistream_types.h:577
NvSciStreamPayload::cookie
NvSciStreamCookie cookie
Definition: nvscistream_types.h:689
NvSciStreamSyncAttr
Definition: nvscistream_types.h:678
NvSciStreamEvent::syncObj
NvSciSyncObj syncObj
Used with events that provide a NvSciSyncObj: NvSciStreamEventType_SyncDesc.
Definition: nvscistream_types.h:542
NvSciStreamEventType_PacketAttrProducer
@ NvSciStreamEventType_PacketAttrProducer
Specifies the packet element information from producer.
Definition: nvscistream_types.h:311
NvSciStreamQueryableAttrib_MaxSyncObj
@ NvSciStreamQueryableAttrib_MaxSyncObj
Maximum number of NvSciSyncObjs allowed.
Definition: nvscistream_types.h:142
NvSciStreamElementDesc::buffer
NvSciBufObj buffer
Definition: nvscistream_types.h:675
NvSciStreamEvent::type
NvSciStreamEventType type
Holds the type of event.
Definition: nvscistream_types.h:504
NvSciStreamEvent::error
NvSciError error
Used with events that return an error: NvSciStreamEventType_PacketStatusProducer, NvSciStreamEventTyp...
Definition: nvscistream_types.h:617
NvSciSyncAttrList
struct NvSciSyncAttrListRec * NvSciSyncAttrList
A container constituting an NvSciSyncAttrList which contains:
Definition: nvscisync.h:308
NvSciBufObj
struct NvSciBufObjRefRec * NvSciBufObj
A memory object is a container holding the reconciled NvSciBufAttrList defining constraints of the bu...
Definition: nvscibuf.h:1325
NvSciStreamEventType_Disconnected
@ NvSciStreamEventType_Disconnected
Indicates portions of the stream have disconnected such that no more useful work can be done with the...
Definition: nvscistream_types.h:194
NvSciStreamEventType_PacketReady
@ NvSciStreamEventType_PacketReady
Specifies a packet is available for reuse or acquire.
Definition: nvscistream_types.h:483
nvscisync.h
NVIDIA Software Communications Interface (SCI) : NvSciSync
NvSciStreamEvent::packetHandle
NvSciStreamPacket packetHandle
Used with events that return a NvSciStreamPacket: NvSciStreamEventType_PacketCreate.
Definition: nvscistream_types.h:562
NvSciStreamElementDesc
Definition: nvscistream_types.h:672
NvSciStreamEventType_SyncAttr
@ NvSciStreamEventType_SyncAttr
Specifies NvSciSyncObj waiter requirements.
Definition: nvscistream_types.h:216
NvSciStreamQueryableAttrib
NvSciStreamQueryableAttrib
Defines NvSciStream attributes that are queryable.
Definition: nvscistream_types.h:138
NvSciStreamElementAttr::bufAttr
NvSciBufAttrList bufAttr
Definition: nvscistream_types.h:669
NvSciStreamEventType_PacketDelete
@ NvSciStreamEventType_PacketDelete
Specifies the deleted packet.
Definition: nvscistream_types.h:410
NvSciStreamSyncAttr::synchronousOnly
bool synchronousOnly
Definition: nvscistream_types.h:679
NvSciStreamEvent::bufObj
NvSciBufObj bufObj
Used with events that provide a NvSciBufObj: NvSciStreamEventType_PacketElement.
Definition: nvscistream_types.h:554
NvSciStreamEventType_ElementStatusProducer
@ NvSciStreamEventType_ElementStatusProducer
Specifies the producer's acceptance status of packet element.
Definition: nvscistream_types.h:457
NvSciStreamEvent::syncMode
NvSciStreamElementMode syncMode
Used with events that specify a NvSciStreamElementMode: NvSciStreamEventType_PacketAttr,...
Definition: nvscistream_types.h:654
NvSciStreamEvent::userData
uint32_t userData
Used with events that require a user-defined data field: NvSciStreamEventType_PacketAttr,...
Definition: nvscistream_types.h:630
NvSciStreamElementAttr::mode
NvSciStreamElementMode mode
Definition: nvscistream_types.h:668
nvsciipc.h
NVIDIA Software Communications Interface (SCI) : NvSci Inter-Process Communication
NvSciStreamQueryableAttrib_MaxElements
@ NvSciStreamQueryableAttrib_MaxElements
Maximum number of elements allowed per packet.
Definition: nvscistream_types.h:140
NvSciStreamPayload::prefences
NvSciSyncFence * prefences
Definition: nvscistream_types.h:690
NvSciStreamCookie
uintptr_t NvSciStreamCookie
Application assigned cookie for a NvSciStreamPacket.
Definition: nvscistream_types.h:55
NvSciStreamPacket_Invalid
static const NvSciStreamPacket NvSciStreamPacket_Invalid
Constant variable denoting an invalid NvSciStreamPacket.
Definition: nvscistream_types.h:62
NvSciStreamElementAttr::index
uint32_t index
Definition: nvscistream_types.h:666
NvSciStreamPayload
Definition: nvscistream_types.h:688
NvSciStreamPacket
uintptr_t NvSciStreamPacket
NvSciStream assigned handle for a packet.
Definition: nvscistream_types.h:50
NvSciStreamEvent::index
uint32_t index
Used with events that require an index: NvSciStreamEventType_SyncDesc, NvSciStreamEventType_PacketAtt...
Definition: nvscistream_types.h:604
NvSciBufAttrList
struct NvSciBufAttrListRec * NvSciBufAttrList
A container constituting an attribute list which contains.
Definition: nvscibuf.h:1343
NvSciStreamEventType_SyncCount
@ NvSciStreamEventType_SyncCount
Specifies the number of NvSciSyncObj(s) sent from the opposite endpoint.
Definition: nvscistream_types.h:229
NvSciStreamSyncDesc
Definition: nvscistream_types.h:683
NvSciStreamEventType_PacketElementCountConsumer
@ NvSciStreamEventType_PacketElementCountConsumer
Specifies supported packet element count from consumer.
Definition: nvscistream_types.h:269
NvSciSyncFence
Defines the opaque NvSciSyncFence.
Definition: nvscisync.h:234
NvSciStreamEventType_PacketElementCount
@ NvSciStreamEventType_PacketElementCount
Specifies the packet element count determined by pool.
Definition: nvscistream_types.h:284
nvscibuf.h
NVIDIA Software Communications Interface (SCI) : NvSciBuf
NvSciStreamElementAttr
The following data structures are no longer used by any interfaces and are deprecated.
Definition: nvscistream_types.h:665
NvSciStreamEventType_PacketStatusConsumer
@ NvSciStreamEventType_PacketStatusConsumer
Specifies the consumer(s)' acceptance status of packet.
Definition: nvscistream_types.h:440
NvSciStreamEvent::syncAttrList
NvSciSyncAttrList syncAttrList
Used with events that specify NvSciSyncObj waiter requirements: NvSciStreamEventType_SyncAttr.
Definition: nvscistream_types.h:516
NvSciStreamEventType
NvSciStreamEventType
Defines event types for the blocks.
Definition: nvscistream_types.h:167
NvSciStreamElementMode_Immediate
@ NvSciStreamElementMode_Immediate
Written synchronously, typically by CPU.
Definition: nvscistream_types.h:160
NvSciStreamElementMode
NvSciStreamElementMode
Defines access modes for the elements of a packet.
Definition: nvscistream_types.h:151
NvSciStreamElementDesc::index
uint32_t index
Definition: nvscistream_types.h:673
NvSciStreamSyncAttr::waiterSyncAttr
NvSciSyncAttrList waiterSyncAttr
Definition: nvscistream_types.h:680
NvSciStreamElementDesc::handle
NvSciStreamPacket handle
Definition: nvscistream_types.h:674
nvscierror.h
NvSciStreamEvent
Describes an event triggered by the blocks.
Definition: nvscistream_types.h:502
NvSciStreamEventType_PacketAttrConsumer
@ NvSciStreamEventType_PacketAttrConsumer
Specifies the packet element information from consumer.
Definition: nvscistream_types.h:341
NvSciStreamEvent::count
uint32_t count
Used with events that require a count: NvSciStreamEventType_SyncCount, NvSciStreamEventType_PacketEle...
Definition: nvscistream_types.h:590
NvSciSyncObj
struct NvSciSyncObjRec * NvSciSyncObj
A Synchronization Object is a container holding the reconciled NvSciSyncAttrList defining constraints...
Definition: nvscisync.h:289
NvSciStreamSyncDesc::index
uint32_t index
Definition: nvscistream_types.h:684
NvSciStreamQueryableAttrib_MaxMulticastOutputs
@ NvSciStreamQueryableAttrib_MaxMulticastOutputs
Maximum number of multicast outputs allowed.
Definition: nvscistream_types.h:144
NvSciStreamEventType_PacketElement
@ NvSciStreamEventType_PacketElement
Specifies new packet element.
Definition: nvscistream_types.h:397
NvSciStreamEventType_PacketStatusProducer
@ NvSciStreamEventType_PacketStatusProducer
Specifies the producer's acceptance status of packet.
Definition: nvscistream_types.h:425
NvSciStreamEventType_PacketCreate
@ NvSciStreamEventType_PacketCreate
Specifies the new packet created by pool.
Definition: nvscistream_types.h:379
NvSciStreamEvent::synchronousOnly
bool synchronousOnly
Used with events that specify NvSciSynObj waiter requirements: NvSciStreamEventType_SyncAttr.
Definition: nvscistream_types.h:641