Types API

group Types

Defines

bool
false
true
CSP_PRIORITIES
CSP_RX_QUEUE_LENGTH
CSP_ROUTE_FIFOS
CSP_RX_QUEUES
CSP_ID_PRIO_SIZE

Size of bit-fields in CSP header.

CSP_ID_HOST_SIZE
CSP_ID_PORT_SIZE
CSP_ID_FLAGS_SIZE
CSP_HEADER_BITS
CSP_HEADER_LENGTH
CSP_ID_PRIO_MAX

Highest number to be entered in field.

CSP_ID_HOST_MAX
CSP_ID_PORT_MAX
CSP_ID_FLAGS_MAX
CSP_ID_PRIO_MASK

Identifier field masks.

CSP_ID_SRC_MASK
CSP_ID_DST_MASK
CSP_ID_DPORT_MASK
CSP_ID_SPORT_MASK
CSP_ID_FLAGS_MASK
CSP_ID_CONN_MASK
CSP_BROADCAST_ADDR

Broadcast address.

CSP_DEFAULT_ROUTE

Default routing address.

CSP_FRES1

CSP Flags.

CSP_FRES2
CSP_FRES3
CSP_FFRAG
CSP_FHMAC
CSP_FXTEA
CSP_FRDP
CSP_FCRC32
CSP_SO_NONE

CSP Socket options.

CSP_SO_RDPREQ
CSP_SO_RDPPROHIB
CSP_SO_HMACREQ
CSP_SO_HMACPROHIB
CSP_SO_XTEAREQ
CSP_SO_XTEAPROHIB
CSP_SO_CRC32REQ
CSP_SO_CRC32PROHIB
CSP_SO_CONN_LESS
CSP_O_NONE

CSP Connect options.

CSP_O_RDP
CSP_O_NORDP
CSP_O_HMAC
CSP_O_NOHMAC
CSP_O_XTEA
CSP_O_NOXTEA
CSP_O_CRC32
CSP_O_NOCRC32
CSP_BUFFER_PACKET_OVERHEAD

This define must be equal to the size of the packet overhead in csp_packet_t.

It is used in csp_buffer_get() to check the allocated buffer size against the required buffer size.

CSP_HOSTNAME_LEN
CSP_MODEL_LEN
CSP_REBOOT_MAGIC
CSP_REBOOT_SHUTDOWN_MAGIC

Typedefs

typedef int (*nexthop_t)(struct csp_iface_s *interface, csp_packet_t *packet, uint32_t timeout)
typedef struct csp_iface_s csp_iface_t

Interface struct.

typedef struct csp_conn_s csp_socket_t

Forward declaration of socket and connection structures.

typedef struct csp_conn_s csp_conn_t

Enums

enum csp_reserved_ports_e

RESERVED PORTS (SERVICES)

Values:

CSP_CMP = 0
CSP_PING = 1
CSP_PS = 2
CSP_MEMFREE = 3
CSP_REBOOT = 4
CSP_BUF_FREE = 5
CSP_UPTIME = 6
CSP_ANY = (CSP_MAX_BIND_PORT + 1)
CSP_PROMISC = (CSP_MAX_BIND_PORT + 2)
enum csp_prio_t

Values:

CSP_PRIO_CRITICAL = 0
CSP_PRIO_HIGH = 1
CSP_PRIO_NORM = 2
CSP_PRIO_LOW = 3
union csp_id_t
#include <csp_types.h>

This union defines a CSP identifier and allows access to the individual fields or the entire identifier.

Public Members

uint32_t ext
struct csp_packet_t
#include <csp_types.h>

CSP PACKET STRUCTURE Note: This structure is constructed to fit with all interface frame types in order to have buffer reuse.

struct csp_iface_s
#include <csp_types.h>

Interface struct.