slipdev.h

Go to the documentation of this file.

/*
 * Copyright (C) 2015-17 Freie Universität Berlin
 *
 * This file is subject to the terms and conditions of the GNU Lesser
 * General Public License v2.1. See the file LICENSE in the top level
 * directory for more details.
 */
 
#pragma once



 
#include <stdint.h>
 
#include "cib.h"
#include "net/netdev.h"
#include "periph/uart.h"
#include "chunked_ringbuffer.h"
#include "sched.h"
 
#ifdef __cplusplus
extern "C" {
#endif

#ifdef CONFIG_SLIPDEV_BUFSIZE_EXP
#define CONFIG_SLIPDEV_BUFSIZE (1 << CONFIG_SLIPDEV_BUFSIZE_EXP)
#endif
 
#ifndef CONFIG_SLIPDEV_BUFSIZE
#define CONFIG_SLIPDEV_BUFSIZE (2048U)
#endif

typedef enum {
    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,
} slipdev_state_t;

typedef struct {
    uart_t uart;        
    uint32_t baudrate;  
} slipdev_params_t;

typedef struct {
    netdev_t netdev;                        
    slipdev_params_t config;                
    chunk_ringbuf_t rb;                     
                                            /* Written to from interrupts (with irq_disable */
                                            /* to prevent any simultaneous writes),         */
                                            /* consumed exclusively in the network stack's  */
                                            /* loop at _isr.                                */
 
    uint8_t rxmem[CONFIG_SLIPDEV_BUFSIZE];  
 
#if IS_USED(MODULE_SLIPDEV_CONFIG)
    chunk_ringbuf_t rb_config;                      
    uint8_t rxmem_config[CONFIG_SLIPDEV_BUFSIZE];   
    kernel_pid_t coap_server_pid;                   
#endif
    slipdev_state_t state;
} slipdev_t;

void slipdev_setup(slipdev_t *dev, const slipdev_params_t *params, uint8_t index);
 
#ifdef __cplusplus
}
#endif