mirror of
https://github.com/RIOT-OS/RIOT.git
synced 2024-12-29 04:50:03 +01:00
f3ab285362
`tsrb` changed to that type, so there is no reason for us, to keep the internally used buffer as a `char` (especially since the rest of the driver already uses `uint8_t`)
83 lines
2.0 KiB
C
83 lines
2.0 KiB
C
/*
|
|
* 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.
|
|
*/
|
|
|
|
/**
|
|
* @defgroup drivers_slipdev SLIP network device
|
|
* @ingroup drivers_netdev
|
|
* @brief SLIP network device over @ref drivers_periph_uart
|
|
* @see [RFC 1055](https://github.com/RIOT-OS/RIOT/pull/6487)
|
|
* @{
|
|
*
|
|
* @file
|
|
* @brief SLIP device definitions
|
|
*
|
|
* @author Martine Lenders <m.lenders@fu-berlin.de>
|
|
*/
|
|
#ifndef SLIPDEV_H
|
|
#define SLIPDEV_H
|
|
|
|
#include <stdint.h>
|
|
|
|
#include "cib.h"
|
|
#include "net/netdev.h"
|
|
#include "periph/uart.h"
|
|
#include "tsrb.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @brief UART buffer size used for TX and RX buffers
|
|
*
|
|
* Reduce this value if your expected traffic does not include full IPv6 MTU
|
|
* sized packets.
|
|
*
|
|
* @pre Needs to be power of two and `<= INT_MAX`
|
|
*/
|
|
#ifndef SLIPDEV_BUFSIZE
|
|
#define SLIPDEV_BUFSIZE (2048U)
|
|
#endif
|
|
|
|
/**
|
|
* @brief Configuration parameters for a slipdev
|
|
*/
|
|
typedef struct {
|
|
uart_t uart; /**< UART interface the device is connected to */
|
|
uint32_t baudrate; /**< baudrate to use with slipdev_params_t::uart */
|
|
} slipdev_params_t;
|
|
|
|
/**
|
|
* @brief Device descriptor for slipdev
|
|
*
|
|
* @extends netdev_t
|
|
*/
|
|
typedef struct {
|
|
netdev_t netdev; /**< parent class */
|
|
slipdev_params_t config; /**< configuration parameters */
|
|
tsrb_t inbuf; /**< RX buffer */
|
|
uint8_t rxmem[SLIPDEV_BUFSIZE]; /**< memory used by RX buffer */
|
|
uint16_t inesc; /**< device previously received an escape
|
|
* byte */
|
|
} slipdev_t;
|
|
|
|
/**
|
|
* @brief Setup a slipdev device state
|
|
*
|
|
* @param[in] dev device descriptor
|
|
* @param[in] params parameters for device initialization
|
|
*/
|
|
void slipdev_setup(slipdev_t *dev, const slipdev_params_t *params);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* SLIPDEV_H */
|
|
/** @} */
|