nvsciipc.h File Reference

Detailed Description

NVIDIA Software Communications Interface (SCI) : NvSci Inter-Process Communication

Version

1.4

Definition in file nvsciipc.h.

Go to the source code of this file.

Data Structures
struct	NvSciIpcEndpointInfo
	Defines information about the NvSciIpc endpoint. More...

Macros
#define	NVSCIIPC_MAX_ENDPOINT_NAME   64U
	Specifies maximum Endpoint name length including null terminator. More...
#define	NV_SCI_IPC_EVENT_READ   0x01U
	Specifies the IPC read event. More...
#define	NV_SCI_IPC_EVENT_WRITE   0x02U
	Specifies the IPC write event. More...
#define	NV_SCI_IPC_EVENT_CONN_EST   0x04U
	Specifies the IPC connection established event. More...
#define	NV_SCI_IPC_EVENT_CONN_RESET   0x08U
	Specifies the IPC connection reset event. More...
#define	NV_SCI_IPC_EVENT_WRITE_EMPTY   0x10U
	Specifies the IPC write fifo empty event. More...
#define	NV_SCI_IPC_EVENT_ASYNC_ERROR   0x20U
	Specifies the IPC asynchronous error event. More...
#define	NV_SCI_IPC_EVENT_CONN_EST_ALL
	Specifies single event mask to check IPC connection establishment. More...
#define	NVSCIIPC_INFINITE_WAIT   -1LL
	infinite timeout for NvSciIpcWaitEventQnx() More...
#define	NV_SCI_ASYNC_PCIE_EDMA_XFER_ERROR   0x1U
	Indicates there is eDMA error during PCIE operation. More...
#define	NV_SCI_ASYNC_PCIE_AER_UNCORRECTABLE_FATAL   0x2U
	Indicates there is uncorrectable fatal error during PCIE operation. More...
#define	NV_SCI_ASYNC_PCIE_AER_UNCORRECTABLE_NONFATAL   0x4U
	Indicates there is uncorrectable non fatal error during PCIE operation. More...
#define	NV_SCI_ASYNC_PCIE_VALIDATION_ERROR   0x8U
	Indicates there is validation error. More...

Typedefs
typedef uint64_t	NvSciIpcEndpoint
	Handle to the NvSciIpc endpoint. More...
typedef struct NvSciIpcEndpointInfo	NvSciIpcEndpointInfo

Functions
NvSciError	NvSciIpcInit (void)
	Initializes the NvSciIpc library. More...
void	NvSciIpcDeinit (void)
	De-initializes the NvSciIpc library. More...
NvSciError	NvSciIpcOpenEndpoint (const char *endpoint, NvSciIpcEndpoint *handle)
	Opens an endpoint with the given name. More...
NvSciError	NvSciIpcOpenEndpointWithEventService (const char *endpoint, NvSciIpcEndpoint *handle, NvSciEventService *eventService)
	Opens an endpoint with the given name and event service. More...
NvSciError	NvSciIpcGetEventNotifier (NvSciIpcEndpoint handle, NvSciEventNotifier **eventNotifier)
	Get NvSciIpc event notifier. More...
void	NvSciIpcCloseEndpoint (NvSciIpcEndpoint handle)
	Closes an endpoint with the given handle. More...
NvSciError	NvSciIpcCloseEndpointSafe (NvSciIpcEndpoint handle, bool clear)
	Closes an endpoint with the given handle (safety version) More...
void	NvSciIpcResetEndpoint (NvSciIpcEndpoint handle)
	Resets an endpoint. More...
NvSciError	NvSciIpcResetEndpointSafe (NvSciIpcEndpoint handle)
	Resets an endpoint. More...
NvSciError	NvSciIpcRead (NvSciIpcEndpoint handle, void *buf, size_t size, int32_t *bytes)
	Reads a frame from the endpoint. More...
NvSciError	NvSciIpcReadSafe (NvSciIpcEndpoint handle, void *buf, uint32_t size, uint32_t *bytes)
	Reads a frame from the endpoint (safety version) More...
NvSciError	NvSciIpcReadGetNextFrame (NvSciIpcEndpoint handle, const volatile void **buf)
	Get a pointer to the read frame from the endpoint. More...
NvSciError	NvSciIpcReadAdvance (NvSciIpcEndpoint handle)
	Advance to the next read frame of the endpoint. More...
NvSciError	NvSciIpcWrite (NvSciIpcEndpoint handle, const void *buf, size_t size, int32_t *bytes)
	Writes a frame to the endpoint. More...
NvSciError	NvSciIpcWriteSafe (NvSciIpcEndpoint handle, const void *buf, uint32_t size, uint32_t *bytes)
	Writes a frame to the endpoint. More...
NvSciError	NvSciIpcWriteGetNextFrame (NvSciIpcEndpoint handle, volatile void **buf)
	Get a pointer to the write frame from the endpoint. More...
NvSciError	NvSciIpcWriteAdvance (NvSciIpcEndpoint handle)
	Advance to the next write frame of the endpoint. More...
NvSciError	NvSciIpcGetEndpointInfo (NvSciIpcEndpoint handle, NvSciIpcEndpointInfo *info)
	Returns endpoint information. More...
NvSciError	NvSciIpcGetLinuxEventFd (NvSciIpcEndpoint handle, int32_t *fd)
	Returns the NvSciIpc file descriptor for a given endpoint. More...
NvSciError	NvSciIpcGetEvent (NvSciIpcEndpoint handle, uint32_t *events)
	Get Events. More...
NvSciError	NvSciIpcGetEventSafe (NvSciIpcEndpoint handle, uint32_t *events)
	Get Events (safety version) More...
NvSciError	NvSciIpcGetAsyncErrors (NvSciIpcEndpoint handle, uint32_t *errors)
	Get asynchronouse errors. More...
NvSciError	NvSciIpcEnableNotification (NvSciIpcEndpoint handle, bool flag)
	Enable event notification (or polling) More...
NvSciError	NvSciIpcCheckVersionCompatibility (uint32_t majorVer, uint32_t minorVer, bool *isCompatible)
	Check NvSciIpc library version compatibility. More...

Variables
static const uint32_t	NvSciIpcMajorVersion = 1U
	NvSciIpc API Major version number. More...
static const uint32_t	NvSciIpcMinorVersion = 4U
	NvSciIpc API Minor version number. More...

Variable Documentation

NvSciIpcMajorVersion

const uint32_t NvSciIpcMajorVersion = 1U

static

NvSciIpc API Major version number.

Definition at line 71 of file nvsciipc.h.

NvSciIpcMinorVersion

const uint32_t NvSciIpcMinorVersion = 4U

static

NvSciIpc API Minor version number.

Definition at line 74 of file nvsciipc.h.