NVIDIA DRIVE OS Linux SDK API Reference

5.2.0 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 
52 typedef uintptr_t NvSciStreamBlock;
53 
58 typedef uintptr_t NvSciStreamPacket;
59 
64 typedef uintptr_t NvSciStreamCookie;
65 
71 
77 
82 typedef enum {
90 
95 typedef enum {
107 
112 typedef enum {
113 
124 
142 
166 
179 
192 
204 
216 
229 
255 
283 
307 
320 
337 
349 
364 
379 
396 
413 
423 
434 
436 
441 typedef struct {
444 
456 
470 
482 
494 
502 
517 
529  uint32_t count;
530 
543  uint32_t index;
544 
555 
567  uint32_t userData;
568 
579 
592 
594 
595 
602 typedef struct {
603  uint32_t index;
604  uint32_t type;
608 
609 typedef struct {
610  uint32_t index;
614 
615 typedef struct {
619 
620 typedef struct {
621  uint32_t index;
624 
625 typedef struct {
629 
630 #ifdef __cplusplus
631 }
632 #endif
633 
634 #endif /* NVSCISTREAM_TYPES_H */
NvSciStreamEvent::bufAttrList
NvSciBufAttrList bufAttrList
Used with events that specify buffer object attributes: PacketAttr PacketAttrProducer PacketAttrConsu...
Definition: nvscistream_types.h:469
NvSciError
NvSciError
Return/error codes for all NvSci functions.
Definition: nvscierror.h:45
NvSciStreamElementAttr::type
uint32_t type
Definition: nvscistream_types.h:604
NvSciStreamEventType_Error
@ NvSciStreamEventType_Error
Indicates a failure not directly triggered by user action.
Definition: nvscistream_types.h:433
NvSciStreamEventType_ElementStatusConsumer
@ NvSciStreamEventType_ElementStatusConsumer
Specifies the consumer-side status of packet element.
Definition: nvscistream_types.h:412
NvSciStreamBlock
uintptr_t NvSciStreamBlock
Handle to a stream component.
Definition: nvscistream_types.h:52
NvSciStreamSyncDesc::sync
NvSciSyncObj sync
Definition: nvscistream_types.h:622
NvSciStreamEventType_PacketElementCountProducer
@ NvSciStreamEventType_PacketElementCountProducer
Specifies number of packets elements request from producer.
Definition: nvscistream_types.h:203
NvSciStreamEventType_PacketAttr
@ NvSciStreamEventType_PacketAttr
Specifies the packet final settings from pool.
Definition: nvscistream_types.h:306
NvSciStreamCookie_Invalid
static const NvSciStreamCookie NvSciStreamCookie_Invalid
Constant variable denoting invalid cookie.
Definition: nvscistream_types.h:76
NvSciStreamElementMode_Asynchronous
@ NvSciStreamElementMode_Asynchronous
Written asynchronously, typically by hardware engine.
Definition: nvscistream_types.h:100
NvSciStreamEventType_Connected
@ NvSciStreamEventType_Connected
Indicates block has complete connection to producer and consumer endpoints.
Definition: nvscistream_types.h:123
NvSciStreamEventType_SyncDesc
@ NvSciStreamEventType_SyncDesc
Specifies a sync object sent from the opposite endpoint.
Definition: nvscistream_types.h:191
NvSciStreamEvent::packetCookie
NvSciStreamCookie packetCookie
Used with events that indicate a packet operation: PacketDelete PacketElement PacketStatusProducer Pa...
Definition: nvscistream_types.h:516
NvSciStreamPayload::cookie
NvSciStreamCookie cookie
Definition: nvscistream_types.h:626
NvSciStreamSyncAttr
Definition: nvscistream_types.h:615
NvSciStreamEvent::syncObj
NvSciSyncObj syncObj
Used with events that provide a sync object: SyncDesc.
Definition: nvscistream_types.h:481
NvSciStreamEventType_PacketAttrProducer
@ NvSciStreamEventType_PacketAttrProducer
Specifies the packet capabilities from producer.
Definition: nvscistream_types.h:254
NvSciStreamQueryableAttrib_MaxSyncObj
@ NvSciStreamQueryableAttrib_MaxSyncObj
Maximum number of NvSciSync objects allowed.
Definition: nvscistream_types.h:86
NvSciStreamElementDesc::buffer
NvSciBufObj buffer
Definition: nvscistream_types.h:612
NvSciStreamEvent::type
NvSciStreamEventType type
Holds the type of event.
Definition: nvscistream_types.h:443
NvSciStreamEvent::error
NvSciError error
Used with events that return an error: PacketStatus ElementStatus.
Definition: nvscistream_types.h:554
NvSciSyncAttrList
struct NvSciSyncAttrListRec * NvSciSyncAttrList
A container constituting an NvSciSyncAttrList which contains:
Definition: nvscisync.h:307
NvSciBufObj
struct NvSciBufObjRefRec * NvSciBufObj
A memory object is a container holding the reconciled NvSciBufAttrList defining constraints of the bu...
Definition: nvscibuf.h:1278
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:141
NvSciStreamEventType_PacketReady
@ NvSciStreamEventType_PacketReady
Specifies a packet is available for reuse or acquire.
Definition: nvscistream_types.h:422
nvscisync.h
NVIDIA Software Communications Interface (SCI) : NvSciSync
NvSciStreamEvent::packetHandle
NvSciStreamPacket packetHandle
Used with events that return a packet handle: PacketCreate.
Definition: nvscistream_types.h:501
NvSciStreamElementDesc
Definition: nvscistream_types.h:609
NvSciStreamEventType_SyncAttr
@ NvSciStreamEventType_SyncAttr
Specifies sync object requirements.
Definition: nvscistream_types.h:165
NvSciStreamQueryableAttrib
NvSciStreamQueryableAttrib
Defines NvSciStream attributes that are queryable.
Definition: nvscistream_types.h:82
NvSciStreamElementAttr::bufAttr
NvSciBufAttrList bufAttr
Definition: nvscistream_types.h:606
NvSciStreamEventType_PacketDelete
@ NvSciStreamEventType_PacketDelete
Specifies the discontinued packet object.
Definition: nvscistream_types.h:348
NvSciStreamSyncAttr::synchronousOnly
bool synchronousOnly
Definition: nvscistream_types.h:616
NvSciStreamEvent::bufObj
NvSciBufObj bufObj
Used with events that provide a buffer object: PacketElement.
Definition: nvscistream_types.h:493
NvSciStreamEventType_ElementStatusProducer
@ NvSciStreamEventType_ElementStatusProducer
Specifies the producer-side status of packet element.
Definition: nvscistream_types.h:395
NvSciStreamEvent::syncMode
NvSciStreamElementMode syncMode
Used with events that specify a synchronization mode: PacketAttr PacketAttrProducer PacketAttrConsume...
Definition: nvscistream_types.h:591
NvSciStreamEvent::userData
uint32_t userData
Used with events that require a user-defined data field: PacketAttr PacketAttrProducer PacketAttrCons...
Definition: nvscistream_types.h:567
NvSciStreamElementAttr::mode
NvSciStreamElementMode mode
Definition: nvscistream_types.h:605
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:84
NvSciStreamPayload::prefences
NvSciSyncFence * prefences
Definition: nvscistream_types.h:627
NvSciStreamCookie
uintptr_t NvSciStreamCookie
Component-assigned cookie for a packet.
Definition: nvscistream_types.h:64
NvSciStreamPacket_Invalid
static const NvSciStreamPacket NvSciStreamPacket_Invalid
Constant variable denoting invalid packet.
Definition: nvscistream_types.h:70
NvSciStreamElementAttr::index
uint32_t index
Definition: nvscistream_types.h:603
NvSciStreamPayload
Definition: nvscistream_types.h:625
NvSciStreamPacket
uintptr_t NvSciStreamPacket
NvSciStream-assigned handle for a packet.
Definition: nvscistream_types.h:58
NvSciStreamEvent::index
uint32_t index
Used with events that require an index: SyncDesc PacketAttr PacketElement ElementStatusProducer Eleme...
Definition: nvscistream_types.h:543
NvSciBufAttrList
struct NvSciBufAttrListRec * NvSciBufAttrList
A container constituting an attribute list which contains.
Definition: nvscibuf.h:1291
NvSciStreamEventType_SyncCount
@ NvSciStreamEventType_SyncCount
Specifies the number of sync objects sent from the opposite endpoint.
Definition: nvscistream_types.h:178
NvSciStreamSyncDesc
Definition: nvscistream_types.h:620
NvSciStreamEventType_PacketElementCountConsumer
@ NvSciStreamEventType_PacketElementCountConsumer
Specifies number of packets elements request from consumer.
Definition: nvscistream_types.h:215
NvSciSyncFence
Defines the opaque NvSciSyncFence.
Definition: nvscisync.h:234
NvSciStreamEventType_PacketElementCount
@ NvSciStreamEventType_PacketElementCount
Specifies the number of packet elements determined by pool.
Definition: nvscistream_types.h:228
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:602
NvSciStreamEventType_PacketStatusConsumer
@ NvSciStreamEventType_PacketStatusConsumer
Specifies the consumer-side status of packet.
Definition: nvscistream_types.h:378
NvSciStreamEvent::syncAttrList
NvSciSyncAttrList syncAttrList
Used with events that specify sync object attributes: SyncAttr.
Definition: nvscistream_types.h:455
NvSciStreamEventType
NvSciStreamEventType
Defines component event types.
Definition: nvscistream_types.h:112
NvSciStreamElementMode_Immediate
@ NvSciStreamElementMode_Immediate
Written synchronously, typically by CPU.
Definition: nvscistream_types.h:105
NvSciStreamElementMode
NvSciStreamElementMode
Defines packet element access modes.
Definition: nvscistream_types.h:95
NvSciStreamElementDesc::index
uint32_t index
Definition: nvscistream_types.h:610
NvSciStreamSyncAttr::waiterSyncAttr
NvSciSyncAttrList waiterSyncAttr
Definition: nvscistream_types.h:617
NvSciStreamElementDesc::handle
NvSciStreamPacket handle
Definition: nvscistream_types.h:611
nvscierror.h
NvSciStreamEvent
Describes a component event.
Definition: nvscistream_types.h:441
NvSciStreamEventType_PacketAttrConsumer
@ NvSciStreamEventType_PacketAttrConsumer
Specifies the packet requests from consumer.
Definition: nvscistream_types.h:282
NvSciStreamEvent::count
uint32_t count
Used with events that require a count: SyncCount PacketElementCount PacketElementCountProducer Packet...
Definition: nvscistream_types.h:529
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:621
NvSciStreamQueryableAttrib_MaxMulticastOutputs
@ NvSciStreamQueryableAttrib_MaxMulticastOutputs
Maximum number of multicast outputs allowed.
Definition: nvscistream_types.h:88
NvSciStreamEventType_PacketElement
@ NvSciStreamEventType_PacketElement
Specifies new packet element.
Definition: nvscistream_types.h:336
NvSciStreamEventType_PacketStatusProducer
@ NvSciStreamEventType_PacketStatusProducer
Specifies the producer-side status of packet.
Definition: nvscistream_types.h:363
NvSciStreamEventType_PacketCreate
@ NvSciStreamEventType_PacketCreate
Indicates new packet object has been introduced by pool.
Definition: nvscistream_types.h:319
NvSciStreamEvent::synchronousOnly
bool synchronousOnly
Used with events that specify sync object attributes: SyncAttr.
Definition: nvscistream_types.h:578