ngcbIFC.hpp File Reference

#include <ngc/core/ngcb.h>
#include <ngc/core/ngcbAddr.h>
#include <ngc/core/ngcbSIM.hpp>
#include <ngc/core/ngcbI2C.hpp>
#include <ngc/core/ngcbAFE.hpp>
#include <ngc/core/ngcbLIST.hpp>
#include <ngc/core/ngcbSERVICE.hpp>
#include <cmdsrv-client/client_connection.hpp>

Go to the source code of this file.

Classes
struct	ngcb_route_t
class	ngcb_reg_t
class	ngcb_rtms_cfg_t
struct	ngcb_chan_ip_t
struct	ngcb_chan_mudpi_t
struct	ngcb_chan_rtms_t
struct	ngcb_rtms_chan
struct	ngcb_rtms_net
struct	ngcb_rtms_if
struct	ngcb_tsu_t
struct	ngcb_sctl_t
struct	ngcb_evt_t
struct	ngcb_evt_st_t
class	ngcbEVT
class	ngcbIFC
class	ngcbI2C_IO
class	ngcbAFE_IO
struct	ngcb_ifc_err

Macros
#define	ngcbIFC_TIMEOUT_DEFAULT   5
#define	ngcbIFC_CLASS_VERSION   0x00000001
#define	ngcbIFC_OP_WR   0x0
#define	ngcbIFC_OP_RD   0x1
#define	ngcbIFC_OP_EVT   0x2
#define	ngcbEVT_PENDING   -1
#define	ngcbEVT_SUCCESS   0
#define	ngcbEVT_TIMEOUT   1
#define	ngcbEVT_FAILURE   2
#define	ngcbEVT_INVALID   3
#define	ngcbEVT_COND_FAIL   0x00010000
#define	RPC_STATE_INVALID   0x00000000
#define	RPC_STATE_SEND   0x00000001
#define	RPC_STATE_RECEIVED   0x00000002
#define	RPC_STATE_WAITING   0x00000003
#define	RPC_STATE_DONE   0x000000FF
#define	RPC_STATE_BUSY   0x40000000
#define	RPC_STATE_ERROR   0x80000000
#define	RPC_STATE_ERROR_UNKNOWN_CMD   (RPC_STATE_ERROR | 1)
#define	RPC_STATE_ERROR_BUSY   (RPC_STATE_ERROR | 2)
#define	RPC_STATE_ERROR_OUT_OF_MEMORY   (RPC_STATE_ERROR | 3)
#define	RPC_STATE_ERROR_TOO_LONG   (RPC_STATE_ERROR | 4)
#define	RPC_STATE_ERROR_UNKNOWN_DEVICE   (RPC_STATE_ERROR | 5)
#define	RPC_STATE_ERROR_BUFFER_TOO_SMALL   (RPC_STATE_ERROR | 6)
#define	RPC_STATE_ERROR_UNKNOWN_CHANNEL   (RPC_STATE_ERROR | 7)
#define	RPC_STATE_ERROR_TRANSFER_FAILED   (RPC_STATE_ERROR | 8)
#define	ngcbIFC_HDR_SIZE   (3 + ngcbMAX_MOD + 1)

Detailed Description

Copyright

SPDX-FileCopyrightText: 2026 European Southern Observatory (ESO) SPDX-License-Identifier: LGPL-3.0-only

Macro Definition Documentation

ngcbEVT_COND_FAIL

#define ngcbEVT_COND_FAIL   0x00010000

ngcbEVT_FAILURE

#define ngcbEVT_FAILURE   2

ngcbEVT_INVALID

#define ngcbEVT_INVALID   3

ngcbEVT_PENDING

#define ngcbEVT_PENDING   -1

ngcbEVT_SUCCESS

#define ngcbEVT_SUCCESS   0

ngcbEVT_TIMEOUT

#define ngcbEVT_TIMEOUT   1

ngcbIFC_CLASS_VERSION

#define ngcbIFC_CLASS_VERSION   0x00000001

ngcbIFC_HDR_SIZE

#define ngcbIFC_HDR_SIZE   (3 + ngcbMAX_MOD + 1)

Internal header size in words

ngcbIFC_OP_EVT

#define ngcbIFC_OP_EVT   0x2

ngcbIFC_OP_RD

#define ngcbIFC_OP_RD   0x1

ngcbIFC_OP_WR

#define ngcbIFC_OP_WR   0x0

ngcbIFC_TIMEOUT_DEFAULT

#define ngcbIFC_TIMEOUT_DEFAULT   5

A reasonable default timeout

RPC_STATE_BUSY

#define RPC_STATE_BUSY   0x40000000

RPC_STATE_DONE

#define RPC_STATE_DONE   0x000000FF

RPC_STATE_ERROR

#define RPC_STATE_ERROR   0x80000000

RPC_STATE_ERROR_BUFFER_TOO_SMALL

#define RPC_STATE_ERROR_BUFFER_TOO_SMALL   (RPC_STATE_ERROR | 6)

RPC_STATE_ERROR_BUSY

#define RPC_STATE_ERROR_BUSY   (RPC_STATE_ERROR | 2)

RPC_STATE_ERROR_OUT_OF_MEMORY

#define RPC_STATE_ERROR_OUT_OF_MEMORY   (RPC_STATE_ERROR | 3)

RPC_STATE_ERROR_TOO_LONG

#define RPC_STATE_ERROR_TOO_LONG   (RPC_STATE_ERROR | 4)

RPC_STATE_ERROR_TRANSFER_FAILED

#define RPC_STATE_ERROR_TRANSFER_FAILED   (RPC_STATE_ERROR | 8)

RPC_STATE_ERROR_UNKNOWN_CHANNEL

#define RPC_STATE_ERROR_UNKNOWN_CHANNEL   (RPC_STATE_ERROR | 7)

RPC_STATE_ERROR_UNKNOWN_CMD

#define RPC_STATE_ERROR_UNKNOWN_CMD   (RPC_STATE_ERROR | 1)

RPC_STATE_ERROR_UNKNOWN_DEVICE

#define RPC_STATE_ERROR_UNKNOWN_DEVICE   (RPC_STATE_ERROR | 5)

RPC_STATE_INVALID

#define RPC_STATE_INVALID   0x00000000

RPC_STATE_RECEIVED

#define RPC_STATE_RECEIVED   0x00000002

RPC_STATE_SEND

#define RPC_STATE_SEND   0x00000001

RPC_STATE_WAITING

#define RPC_STATE_WAITING   0x00000003