slipdev.h File Reference

SLIP device definitions. More...

Detailed Description

SLIP device definitions.

Author

Martine Lenders m.len.nosp@m.ders.nosp@m.@fu-b.nosp@m.erli.nosp@m.n.de

Definition in file slipdev.h.

#include <stdint.h>
#include "cib.h"
#include "event.h"
#include "net/netdev.h"
#include "periph/uart.h"
#include "chunked_ringbuffer.h"
#include "sched.h"

Include dependency graph for slipdev.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	slipdev_params_t
	Configuration parameters for a slipdev. More...
struct	slipdev_t
	Device descriptor for slipdev. More...

Macros
#define	CONFIG_SLIPDEV_BUFSIZE   (2048U)
	UART buffer size used for TX and RX buffers.

Enumerations
enum	slipdev_state_t {   SLIPDEV_STATE_NONE = 0 , SLIPDEV_STATE_UNKNOWN , SLIPDEV_STATE_NET , SLIPDEV_STATE_NET_ESC ,   SLIPDEV_STATE_STDIN , SLIPDEV_STATE_STDIN_ESC , SLIPDEV_STATE_CONFIG , SLIPDEV_STATE_CONFIG_ESC ,   SLIPDEV_STATE_STANDBY , SLIPDEV_STATE_SLEEP }
	States for the slipdev and its parser. More...

Functions
void	slipdev_setup (slipdev_t *dev, const slipdev_params_t *params, uint8_t index)
	Setup a slipdev device state.
void	slipdev_coap_set_event_queue (event_queue_t *q)
	Setup the event queue that will be notified when a config frame arrives.
void	slipdev_coap_unset_event_queue (void)
	Teardown the event queue.
void	unicoap_slipdev_recv_handler (event_t *event)
	Callback to inform unicoap that a new configuration frame is available.
int	slipdev_coap_recv (uint8_t *buf, size_t buf_size, slipdev_t *dev)
	Receive a CoAP packet into the given buffer.
void	slipdev_coap_send (const iolist_t *iolist, const slipdev_t *dev)
	Send a CoAP message as a configuration frame.