RIOT/drivers/slipdev/slipdev.c

/*
 * Copyright (C) 2017 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.
 */

/**
 * @{
 *
 * @file
 * @author  Martine Lenders <mlenders@inf.fu-berlin.de>
 */

#include <assert.h>
#include <errno.h>
#include <stdbool.h>
#include <string.h>

#include "log.h"
#include "slipdev.h"
#include "slipdev_internal.h"
#include "net/eui_provider.h"

/* XXX: BE CAREFUL ABOUT USING OUTPUT WITH MODULE_SLIPDEV_STDIO IN SENDING
 * FUNCTIONALITY! MIGHT CAUSE DEADLOCK!!!1!! */
#define ENABLE_DEBUG 0
#include "debug.h"

#include "isrpipe.h"
#include "mutex.h"
#include "stdio_uart.h"

static int _check_state(slipdev_t *dev);

static inline void slipdev_lock(void)
{
    if (IS_USED(MODULE_SLIPDEV_STDIO)) {
        mutex_lock(&slipdev_mutex);
    }
}

static inline void slipdev_unlock(void)
{
    if (IS_USED(MODULE_SLIPDEV_STDIO)) {
        mutex_unlock(&slipdev_mutex);
    }
}

static void _slip_rx_cb(void *arg, uint8_t byte)
{
    slipdev_t *dev = arg;

    if (IS_USED(MODULE_SLIPDEV_STDIO)) {
        if (dev->state == SLIPDEV_STATE_STDIN) {
            isrpipe_write_one(&slipdev_stdio_isrpipe, byte);
            goto check_end;
        }
        else if ((byte == SLIPDEV_STDIO_START) &&
            (dev->config.uart == STDIO_UART_DEV) &&
            (dev->state == SLIPDEV_STATE_NONE)) {
            dev->state = SLIPDEV_STATE_STDIN;
            return;
        }
    }
    dev->state = SLIPDEV_STATE_NET;
    tsrb_add_one(&dev->inbuf, byte);
check_end:
    if (byte == SLIPDEV_END) {
        if (dev->state == SLIPDEV_STATE_NET) {
            dev->rx_queued++;
            netdev_trigger_event_isr(&dev->netdev);
        }
        dev->state = SLIPDEV_STATE_NONE;
    }
}

static void _poweron(slipdev_t *dev)
{
    if ((dev->state != SLIPDEV_STATE_STANDBY) &&
            (dev->state != SLIPDEV_STATE_SLEEP)) {
        return;
    }

    dev->state = 0;
    uart_init(dev->config.uart, dev->config.baudrate, _slip_rx_cb, dev);
}

static inline void _poweroff(slipdev_t *dev, uint8_t state)
{
    uart_poweroff(dev->config.uart);
    dev->state = state;
}

static int _init(netdev_t *netdev)
{
    slipdev_t *dev = (slipdev_t *)netdev;

    DEBUG("slipdev: initializing device %p on UART %i with baudrate %" PRIu32 "\n",
          (void *)dev, dev->config.uart, dev->config.baudrate);
    /* initialize buffers */
    tsrb_init(&dev->inbuf, dev->rxmem, sizeof(dev->rxmem));
    if (uart_init(dev->config.uart, dev->config.baudrate, _slip_rx_cb,
                  dev) != UART_OK) {
        LOG_ERROR("slipdev: error initializing UART %i with baudrate %" PRIu32 "\n",
                  dev->config.uart, dev->config.baudrate);
        return -ENODEV;
    }

    /* signal link UP */
    netdev->event_callback(netdev, NETDEV_EVENT_LINK_UP);

    return 0;
}

void slipdev_write_bytes(uart_t uart, const uint8_t *data, size_t len)
{
    for (unsigned j = 0; j < len; j++, data++) {
        switch (*data) {
            case SLIPDEV_END:
                /* escaping END byte*/
                slipdev_write_byte(uart, SLIPDEV_ESC);
                slipdev_write_byte(uart, SLIPDEV_END_ESC);
                break;
            case SLIPDEV_ESC:
                /* escaping ESC byte*/
                slipdev_write_byte(uart, SLIPDEV_ESC);
                slipdev_write_byte(uart, SLIPDEV_ESC_ESC);
                break;
            default:
                slipdev_write_byte(uart, *data);
        }
    }
}

static unsigned _copy_byte(uint8_t *buf, uint8_t byte, bool *escaped)
{
    *buf = byte;
    *escaped = false;
    return 1U;
}

unsigned slipdev_unstuff_readbyte(uint8_t *buf, uint8_t byte, bool *escaped)
{
    unsigned res = 0U;

    switch (byte) {
        case SLIPDEV_ESC:
            *escaped = true;
            /* Intentionally falls through */
        case SLIPDEV_END:
            break;
        case SLIPDEV_END_ESC:
            if (*escaped) {
                return _copy_byte(buf, SLIPDEV_END, escaped);
            }
            /* Intentionally falls through */
            /* to default when !(*escaped) */
        case SLIPDEV_ESC_ESC:
            if (*escaped) {
                return _copy_byte(buf, SLIPDEV_ESC, escaped);
            }
            /* Intentionally falls through */
            /* to default when !(*escaped) */
        default:
            return _copy_byte(buf, byte, escaped);
    }
    return res;
}

static int _check_state(slipdev_t *dev)
{
    /* power states not supported when multiplexing stdio */
    if (IS_USED(MODULE_SLIPDEV_STDIO)) {
        return 0;
    }

    /* discard data when interface is in SLEEP mode */
    if (dev->state == SLIPDEV_STATE_SLEEP) {
        return -ENETDOWN;
    }

    /* sending data wakes the interface from STANDBY */
    if (dev->state == SLIPDEV_STATE_STANDBY) {
        _poweron(dev);
    }

    return 0;
}

static int _send(netdev_t *netdev, const iolist_t *iolist)
{
    slipdev_t *dev = (slipdev_t *)netdev;
    int bytes = _check_state(dev);
    if (bytes) {
        return bytes;
    }

    DEBUG("slipdev: sending iolist\n");
    slipdev_lock();
    for (const iolist_t *iol = iolist; iol; iol = iol->iol_next) {
        uint8_t *data = iol->iol_base;
        slipdev_write_bytes(dev->config.uart, data, iol->iol_len);
        bytes += iol->iol_len;
    }
    slipdev_write_byte(dev->config.uart, SLIPDEV_END);
    slipdev_unlock();
    return bytes;
}

static int _recv(netdev_t *netdev, void *buf, size_t len, void *info)
{
    slipdev_t *dev = (slipdev_t *)netdev;
    int res = 0;

    (void)info;
    if (buf == NULL) {
        if (len > 0) {
            /* remove data */
            for (; len > 0; len--) {
                int byte = tsrb_get_one(&dev->inbuf);
                if ((byte == (int)SLIPDEV_END) || (byte < 0)) {
                    /* end early if end of packet or ringbuffer is reached;
                     * len might be larger than the actual packet */
                    break;
                }
            }
        } else {
            /* the user was warned not to use a buffer size > `INT_MAX` ;-) */
            res = (int)tsrb_avail(&dev->inbuf);
        }
    }
    else {
        int byte;
        bool escaped = false;
        uint8_t *ptr = buf;

        do {
            int tmp;

            if ((byte = tsrb_get_one(&dev->inbuf)) < 0) {
                /* something went wrong, return error */
                return -EIO;
            }

            /* frame is larger than expected - lost end marker */
            if ((unsigned)res >= len) {
                while (byte != SLIPDEV_END) {
                    /* clear out unreceived packet */
                    byte = tsrb_get_one(&dev->inbuf);
                }
                return -ENOBUFS;
            }

            tmp = slipdev_unstuff_readbyte(ptr, byte, &escaped);
            ptr += tmp;
            res += tmp;
        } while (byte != SLIPDEV_END);

        if (++dev->rx_done != dev->rx_queued) {
            DEBUG("slipdev: pkt still in queue");
            netdev_trigger_event_isr(&dev->netdev);
        }
    }
    return res;
}

static void _isr(netdev_t *netdev)
{
    DEBUG("slipdev: handling ISR event\n");
    if (netdev->event_callback != NULL) {
        DEBUG("slipdev: event handler set, issuing RX_COMPLETE event\n");
        netdev->event_callback(netdev, NETDEV_EVENT_RX_COMPLETE);
    }
}

#if !IS_USED(MODULE_SLIPDEV_STDIO)
static int _set_state(slipdev_t *dev, netopt_state_t state)
{
    if (IS_USED(MODULE_SLIPDEV_STDIO)) {
        return -ENOTSUP;
    }

    switch (state) {
    case NETOPT_STATE_STANDBY:
        _poweroff(dev, SLIPDEV_STATE_STANDBY);
        break;
    case NETOPT_STATE_SLEEP:
        _poweroff(dev, SLIPDEV_STATE_SLEEP);
        break;
    case NETOPT_STATE_IDLE:
        _poweron(dev);
        break;
    default:
        return -ENOTSUP;
    }

    return sizeof(netopt_state_t);
}

static int _set(netdev_t *netdev, netopt_t opt, const void *value, size_t max_len)
{
    (void)max_len;

    slipdev_t *dev = (slipdev_t *)netdev;
    switch (opt) {
    case NETOPT_STATE:
        assert(max_len <= sizeof(netopt_state_t));
        return _set_state(dev, *((const netopt_state_t *)value));
    default:
        return -ENOTSUP;
    }
}
#endif /* !MODULE_SLIPDEV_STDIO */

static int _get(netdev_t *netdev, netopt_t opt, void *value, size_t max_len)
{
    (void)netdev;
    (void)value;
    (void)max_len;
    switch (opt) {
        case NETOPT_IS_WIRED:
            return 1;
        case NETOPT_DEVICE_TYPE:
            assert(max_len == sizeof(uint16_t));
            *((uint16_t *)value) = NETDEV_TYPE_SLIP;
            return sizeof(uint16_t);
#if IS_USED(MODULE_SLIPDEV_L2ADDR)
        case NETOPT_ADDRESS_LONG:
            assert(max_len == sizeof(eui64_t));
            netdev_eui64_get(netdev, value);
            return sizeof(eui64_t);
#endif
        default:
            return -ENOTSUP;
    }
}

static const netdev_driver_t slip_driver = {
    .send = _send,
    .recv = _recv,
    .init = _init,
    .isr = _isr,
    .get = _get,
#if IS_USED(MODULE_SLIPDEV_STDIO)
    .set = netdev_set_notsup,
#else
    .set = _set,
#endif
};

void slipdev_setup(slipdev_t *dev, const slipdev_params_t *params, uint8_t index)
{
    /* set device descriptor fields */
    dev->config = *params;
    dev->state = 0;
    dev->netdev.driver = &slip_driver;

    netdev_register(&dev->netdev, NETDEV_SLIPDEV, index);
}

/** @} */