/****************************************************************************
* **File:** csp/csp_types.h
*
* **Description:** Basic types
****************************************************************************/
#pragma once
#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
#include "csp/autoconfig.h" // -> CSP_X defines (compile configuration)
#include <csp/csp_error.h>
#include <csp/arch/csp_queue.h>
#ifdef __cplusplus
extern "C" {
#endif
typedef struct {
uint32_t tv_sec;
uint32_t tv_nsec;
} csp_timestamp_t;
[docs]/**
* Reserved ports for CSP services.
*/
typedef enum {
CSP_CMP = 0, /*< CSP management, e.g. memory, routes, stats */
CSP_PING = 1, /*< Ping - return ping */
CSP_PS = 2, /*< Current process list */
CSP_MEMFREE = 3, /*< Free memory */
CSP_REBOOT = 4, /*< Reboot, see #CSP_REBOOT_MAGIC and #CSP_REBOOT_SHUTDOWN_MAGIC */
CSP_BUF_FREE = 5, /*< Free CSP buffers */
CSP_UPTIME = 6, /*< Uptime */
} csp_service_port_t;
[docs]/** Listen on all ports, primarily used with csp_bind() */
#define CSP_ANY 255
[docs]/**
Message priority.
*/
typedef enum {
[docs] CSP_PRIO_CRITICAL = 0, //!< Critical
[docs] CSP_PRIO_HIGH = 1, //!< High
[docs] CSP_PRIO_NORM = 2, //!< Normal (default)
[docs] CSP_PRIO_LOW = 3, //!< Low
} csp_prio_t;
[docs][docs]/**
CSP identifier/header.
*/
typedef struct __packed {
} csp_id_t ; [docs]/**
@defgroup CSP_HEADER_FLAGS CSP header flags.
@{
*/
#define CSP_FRES1 0x80 /*< Reserved for future use */
#define CSP_FRES2 0x40 /*< Reserved for future use */
#define CSP_FRES3 0x20 /*< Reserved for future use */
#define CSP_FFRAG 0x10 /*< Use fragmentation */
#define CSP_FHMAC 0x08 /*< Use HMAC verification */
#define CSP_FRDP 0x02 /*< Use RDP protocol */
#define CSP_FCRC32 0x01 /*< Use CRC32 checksum */
/**@}*/
[docs]/**
@defgroup CSP_SOCKET_OPTIONS CSP Socket options.
@{
*/
#define CSP_SO_NONE 0x0000 /*< No socket options */
#define CSP_SO_RDPREQ 0x0001 /*< Require RDP */
#define CSP_SO_RDPPROHIB 0x0002 /*< Prohibit RDP */
#define CSP_SO_HMACREQ 0x0004 /*< Require HMAC */
#define CSP_SO_HMACPROHIB 0x0008 /*< Prohibit HMAC */
#define CSP_SO_CRC32REQ 0x0040 /*< Require CRC32 */
#define CSP_SO_CRC32PROHIB 0x0080 /*< Prohibit CRC32 */
#define CSP_SO_CONN_LESS 0x0100 /*< Enable Connection Less mode */
#define CSP_SO_SAME 0x8000 /*< Copy opts from incoming packet only apllies to csp_sendto_reply() */
/**@}*/
[docs]/** CSP Connect options */
#define CSP_O_NONE CSP_SO_NONE /*< No connection options */
#define CSP_O_RDP CSP_SO_RDPREQ /*< Enable RDP */
#define CSP_O_NORDP CSP_SO_RDPPROHIB /*< Disable RDP */
#define CSP_O_HMAC CSP_SO_HMACREQ /*< Enable HMAC */
#define CSP_O_NOHMAC CSP_SO_HMACPROHIB /*< Disable HMAC */
#define CSP_O_CRC32 CSP_SO_CRC32REQ /*< Enable CRC32 */
#define CSP_O_NOCRC32 CSP_SO_CRC32PROHIB /*< Disable CRC32 */
#define CSP_O_SAME CSP_SO_SAME
#ifndef CSP_PACKET_PADDING_BYTES
#define CSP_PACKET_PADDING_BYTES 8
#endif
/* This struct is referenced in documentation. Update doc when you change this. */
[docs][docs]/**
* CSP Packet.
*
* This structure is constructed to fit with all interface and protocols to prevent the
* need to copy data (zero copy).
*
* .. note:: In most cases a CSP packet cannot be reused in case of send failure, because the
* lower layers may add additional data causing increased length (e.g. CRC32), convert
* the CSP id to different endian (e.g. I2C), etc.
*
*/
typedef struct csp_packet_s {
union {
/* Only used on layer 3 (RDP) */
struct {
uint32_t timestamp_tx; /*< Time the message was sent */
struct csp_conn_s * conn; /*< Associated connection (this is used in RDP queue) */
};
/* Only used on interface RX/TX (layer 2) */
struct {
uint16_t rx_count; /*< Received bytes */
uint16_t remain; /*< Remaining packets */
uint32_t cfpid; /*< Connection CFP identification number */
uint32_t last_used; /*< Timestamp in ms for last use of buffer */
uint8_t * frame_begin;
uint16_t frame_length;
};
};
[docs][docs] csp_id_t id; /*< CSP id (unpacked version CPU readable) */ [docs][docs] struct csp_packet_s * next; /*< Used for lists / queues of packets */ [docs]/** Forward declaration of CSP interface, see #csp_iface_s for details. */
typedef struct csp_iface_s csp_iface_t;
typedef void (*csp_callback_t)(csp_packet_t * packet);
[docs]/** @brief Connection struct */
struct csp_socket_s {
[docs] csp_queue_handle_t rx_queue; /*< Queue for RX packets */
[docs] csp_static_queue_t rx_queue_static; /*< Static storage for rx queue */
[docs] char rx_queue_static_data[sizeof(csp_packet_t *) * CSP_CONN_RXQUEUE_LEN];
[docs] uint32_t opts; /*< Connection or socket options */
};
[docs]/** Forward declaration of socket structure */
typedef struct csp_socket_s csp_socket_t;
[docs]/** Forward declaration of connection structure */
typedef struct csp_conn_s csp_conn_t;
[docs]/** Max length of host name - including zero termination */
#define CSP_HOSTNAME_LEN 20
[docs]/** Max length of model name - including zero termination */
#define CSP_MODEL_LEN 30
[docs]/** Magic number for reboot request, for service-code #CSP_REBOOT */
#define CSP_REBOOT_MAGIC 0x80078007
[docs]/** Magic number for shutdown request, for service-code #CSP_REBOOT */
#define CSP_REBOOT_SHUTDOWN_MAGIC 0xD1E5529A
#ifdef __AVR__
typedef uint32_t csp_memptr_t;
typedef const uint32_t csp_const_memptr_t;
#else
[docs]/** Memory pointer */
typedef void * csp_memptr_t;
[docs]/** Const memory pointer */
typedef const void * csp_const_memptr_t;
#endif
[docs]/**
* Platform specific memory copy function.
*/
typedef csp_memptr_t (*csp_memcpy_fnc_t)(csp_memptr_t, csp_const_memptr_t, size_t);
[docs]/**
* Compile check/asserts.
*/
#define CSP_STATIC_ASSERT(condition, name) typedef char name[(condition) ? 1 : -1]
#ifdef __cplusplus
}
#endif