nvsciipc.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 NVSCIIPC_H
#define NVSCIIPC_H

#ifdef __cplusplus
extern "C" {
#endif

#include <stdint.h>
#include <stddef.h>
#include <nvscierror.h>
/*******************************************************************/
/************************ OS SPECIFIC ******************************/
/*******************************************************************/
#ifdef QNX
#include <sys/neutrino.h>

/* This default code can be used by Application in NvSciIpcSetQnxPulseParam() */
#define NV_SCI_IPC_NOTIFY_CODE (_PULSE_CODE_MINAVAIL + 1)
#endif // QNX

/*******************************************************************/
/************************ DATA TYPES *******************************/
/*******************************************************************/
typedef uint64_t NvSciIpcEndpoint;

/* NvSciIpcEventNotifier type is for Drive OS internal use only */
typedef int32_t NvSciIpcEventNotifier;

struct NvSciIpcEndpointInfo {
    uint32_t nframes;
    uint32_t frame_size;
};

/* NvSciIPC Event type */
#define NV_SCI_IPC_EVENT_READ       1U

#define NV_SCI_IPC_EVENT_WRITE      2U

#define NV_SCI_IPC_EVENT_CONN_EST   4U

#define NV_SCI_IPC_EVENT_CONN_RESET 8U

/********************* FUNCTION TYPES *******************************/
/*******************************************************************/

NvSciError NvSciIpcInit(void);

void NvSciIpcDeinit(void);

NvSciError NvSciIpcOpenEndpoint(const char *endpoint, NvSciIpcEndpoint *handle);

void NvSciIpcCloseEndpoint(NvSciIpcEndpoint handle);

void NvSciIpcResetEndpoint(NvSciIpcEndpoint handle);

NvSciError NvSciIpcRead(NvSciIpcEndpoint handle, void *buf, size_t size,
    int32_t *bytes);

NvSciError NvSciIpcReadGetNextFrame(NvSciIpcEndpoint handle, void **buf);

NvSciError NvSciIpcReadAdvance(NvSciIpcEndpoint handle);

NvSciError NvSciIpcWrite(NvSciIpcEndpoint handle, const void *buf, size_t size,
    int32_t *bytes);

NvSciError NvSciIpcWriteGetNextFrame(NvSciIpcEndpoint handle, void **buf);

NvSciError NvSciIpcWriteAdvance(NvSciIpcEndpoint handle);

NvSciError NvSciIpcGetEndpointInfo(NvSciIpcEndpoint handle,
                struct NvSciIpcEndpointInfo *info);

/* For internal use only. */
NvSciError NvSciIpcGetEventNotifier(NvSciIpcEndpoint handle,
               NvSciIpcEventNotifier *eventNotifier);

NvSciError NvSciIpcGetLinuxEventFd(NvSciIpcEndpoint handle, int32_t *fd);

NvSciError NvSciIpcGetEvent(NvSciIpcEndpoint handle, uint32_t *event);

/* For internal use only. */
NvSciError NvSciIpcSetEventNotifierPulseParam(NvSciIpcEndpoint handle,
    int32_t chid, int16_t pulsePriority, int16_t pulseCode,
    int32_t pulseValue);

NvSciError NvSciIpcSetQnxPulseParam(NvSciIpcEndpoint handle,
    int32_t coid, int16_t pulsePriority, int16_t pulseCode,
    void *pulseValue);

/* For internal use only. */
NvSciError NvSciIpcErrnoToNvSciErr(int32_t err);

/* For internal use only. */
int32_t NvSciIpcNvSciErrToErrno(NvSciError nvSciErr);

#ifdef __cplusplus
}
#endif
#endif /* NVSCIIPC_H */