mbed-os/EthernetInterface.cpp

/* LWIP implementation of NetworkInterfaceAPI
 * Copyright (c) 2015 ARM Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#include "EthernetInterface.h"
#include "mbed.h"
#include "SingletonPtr.h"

#include "eth_arch.h"
#include "lwip/opt.h"
#include "lwip/api.h"
#include "lwip/inet.h"
#include "lwip/netif.h"
#include "lwip/dhcp.h"
#include "lwip/tcpip.h"
#include "lwip/tcp.h"


/* Predeclared LWIPStack class */
class LWIPStack : public NetworkStack
{
    virtual const char *get_ip_address();
    virtual int socket_open(nsapi_socket_t *handle, nsapi_protocol_t proto);
    virtual int socket_close(nsapi_socket_t handle);
    virtual int socket_bind(nsapi_socket_t handle, const SocketAddress &address);
    virtual int socket_listen(nsapi_socket_t handle, int backlog);
    virtual int socket_connect(nsapi_socket_t handle, const SocketAddress &address);
    virtual int socket_accept(nsapi_socket_t *handle, nsapi_socket_t server);
    virtual int socket_send(nsapi_socket_t handle, const void *data, unsigned size);
    virtual int socket_recv(nsapi_socket_t handle, void *data, unsigned size);
    virtual int socket_sendto(nsapi_socket_t handle, const SocketAddress &address, const void *data, unsigned size);
    virtual int socket_recvfrom(nsapi_socket_t handle, SocketAddress *address, void *buffer, unsigned size);
    virtual int setsockopt(nsapi_socket_t handle, int level, int optname, const void *optval, unsigned optlen);
    virtual void socket_attach(nsapi_socket_t handle, void (*callback)(void *), void *data);
};

static SingletonPtr<LWIPStack> lwip_stack;


/* Static arena of sockets */
static struct lwip_socket {
    bool in_use;

    struct netconn *conn;
    struct netbuf *buf;
    u16_t offset;

    void (*cb)(void *);
    void *data;
} lwip_arena[MEMP_NUM_NETCONN];

static void lwip_arena_init()
{
    memset(lwip_arena, 0, sizeof lwip_arena);
}

static struct lwip_socket *lwip_arena_alloc()
{
    sys_prot_t prot = sys_arch_protect();

    for (int i = 0; i < MEMP_NUM_NETCONN; i++) {
        if (!lwip_arena[i].in_use) {
            struct lwip_socket *s = &lwip_arena[i];
            memset(s, 0, sizeof *s);
            s->in_use = true;
            sys_arch_unprotect(prot);
            return s;
        }
    }

    sys_arch_unprotect(prot);
    return 0;
}

static void lwip_arena_dealloc(struct lwip_socket *s)
{
    s->in_use = false;
}

static void lwip_socket_callback(struct netconn *nc, enum netconn_evt, u16_t len) {
    sys_prot_t prot = sys_arch_protect();

    for (int i = 0; i < MEMP_NUM_NETCONN; i++) {
        if (lwip_arena[i].in_use
            && lwip_arena[i].conn == nc
            && lwip_arena[i].cb) {
            lwip_arena[i].cb(lwip_arena[i].data);
        }
    }

    sys_arch_unprotect(prot);
}


/* TCP/IP and Network Interface Initialisation */
static struct netif lwip_netif;

static char lwip_ip_addr[NSAPI_IP_SIZE] = "\0";
static char lwip_mac_addr[NSAPI_MAC_SIZE] = "\0";

static SingletonPtr<Semaphore> lwip_tcpip_inited;
static void lwip_tcpip_init_irq(void *)
{
    lwip_tcpip_inited->release();
}

static SingletonPtr<Semaphore> lwip_netif_linked;
static void lwip_netif_link_irq(struct netif *lwip_netif)
{
    if (netif_is_link_up(lwip_netif)) {
        lwip_netif_linked->release();
    }
}

static SingletonPtr<Semaphore> lwip_netif_up;
static void lwip_netif_status_irq(struct netif *lwip_netif)
{
    if (netif_is_up(lwip_netif)) {
        strcpy(lwip_ip_addr, inet_ntoa(lwip_netif->ip_addr));
        lwip_netif_up->release();
    }
}

static void lwip_set_mac_address()
{
#if (MBED_MAC_ADDRESS_SUM != MBED_MAC_ADDR_INTERFACE)
    snprintf(lwip_mac_addr, 19, "%02x:%02x:%02x:%02x:%02x:%02x",
            MBED_MAC_ADDR_0, MBED_MAC_ADDR_1, MBED_MAC_ADDR_2,
            MBED_MAC_ADDR_3, MBED_MAC_ADDR_4, MBED_MAC_ADDR_5);
#else
    char mac[6];
    mbed_mac_address(mac);
    snprintf(lwip_mac_addr, 19, "%02x:%02x:%02x:%02x:%02x:%02x",
            mac[0], mac[1], mac[2], mac[3], mac[4], mac[5]);
#endif
}

static const char *lwip_get_mac_address()
{
    return lwip_mac_addr[0] ? lwip_mac_addr : 0;
}

static const char *lwip_get_ip_address()
{
    return lwip_ip_addr[0] ? lwip_ip_addr : 0;
}

static int lwip_init()
{
    // Check if we've already connected
    if (lwip_get_mac_address()) {
        return 0;
    }

    // Set up network
    lwip_set_mac_address();

    tcpip_init(lwip_tcpip_init_irq, NULL);
    lwip_tcpip_inited->wait();

    memset(&lwip_netif, 0, sizeof lwip_netif);
    netif_add(&lwip_netif, 0, 0, 0, NULL, eth_arch_enetif_init, tcpip_input);
    netif_set_default(&lwip_netif);

    netif_set_link_callback  (&lwip_netif, lwip_netif_link_irq);
    netif_set_status_callback(&lwip_netif, lwip_netif_status_irq);

    // Connect to network
    eth_arch_enable_interrupts();
    dhcp_start(&lwip_netif);

    // Zero out socket set
    lwip_arena_init();

    // Wait for an IP Address
    // -1: error, 0: timeout
    if (lwip_netif_up->wait(15000) <= 0) {
        return NSAPI_ERROR_DHCP_FAILURE;
    }

    return 0;
}

static void lwip_deinit()
{
    dhcp_release(&lwip_netif);
    dhcp_stop(&lwip_netif);

    eth_arch_disable_interrupts();
    lwip_ip_addr[0] = '\0';
    lwip_mac_addr[0] = '\0';
}

static int lwip_err_remap(err_t err) {
    switch (err) {
        case ERR_OK:
            return 0;
        case ERR_MEM:
            return NSAPI_ERROR_NO_MEMORY;
        case ERR_CONN:
        case ERR_CLSD:
            return NSAPI_ERROR_NO_CONNECTION;
        case ERR_TIMEOUT:
        case ERR_RTE:
        case ERR_INPROGRESS:
        case ERR_WOULDBLOCK:
            return NSAPI_ERROR_WOULD_BLOCK;
        case ERR_VAL:
        case ERR_USE:
        case ERR_ISCONN:
        case ERR_ARG:
            return NSAPI_ERROR_PARAMETER;
        default:
            return NSAPI_ERROR_DEVICE_ERROR;
    }
}

/* LWIP stack implementation */
const char *LWIPStack::get_ip_address() {
    return lwip_get_ip_address();
}

int LWIPStack::socket_open(nsapi_socket_t *handle, nsapi_protocol_t proto)
{
    struct lwip_socket *s = lwip_arena_alloc();
    if (!s) {
        return NSAPI_ERROR_NO_SOCKET;
    }

    s->conn = netconn_new_with_callback(
            proto == NSAPI_TCP ? NETCONN_TCP : NETCONN_UDP,
            lwip_socket_callback);

    if (!s->conn) {
        lwip_arena_dealloc(s);
        return NSAPI_ERROR_NO_SOCKET;
    }

    netconn_set_recvtimeout(s->conn, 1);
    *reinterpret_cast<struct lwip_socket**>(handle) = s;
    return 0;
}

int LWIPStack::socket_close(nsapi_socket_t handle)
{
    struct lwip_socket *s = static_cast<struct lwip_socket*>(handle);

    err_t err = netconn_delete(s->conn);
    lwip_arena_dealloc(s);
    return lwip_err_remap(err);
}


int LWIPStack::socket_bind(nsapi_socket_t handle, const SocketAddress &addr)
{
    struct lwip_socket *s = static_cast<struct lwip_socket*>(handle);

    ip_addr_t ip_addr;
    inet_aton(addr.get_ip_address(), &ip_addr);

    err_t err = netconn_bind(s->conn, &ip_addr, addr.get_port());
    return lwip_err_remap(err);
}

int LWIPStack::socket_listen(nsapi_socket_t handle, int backlog)
{
    struct lwip_socket *s = static_cast<struct lwip_socket*>(handle);

    err_t err = netconn_listen_with_backlog(s->conn, backlog);
    return lwip_err_remap(err);
}

int LWIPStack::socket_connect(nsapi_socket_t handle, const SocketAddress &addr)
{
    struct lwip_socket *s = static_cast<struct lwip_socket*>(handle);

    ip_addr_t ip_addr;
    inet_aton(addr.get_ip_address(), &ip_addr);

    netconn_set_nonblocking(s->conn, false);
    err_t err = netconn_connect(s->conn, &ip_addr, addr.get_port());
    netconn_set_nonblocking(s->conn, true);

    return lwip_err_remap(err);
}

int LWIPStack::socket_accept(nsapi_socket_t *handle, nsapi_socket_t server)
{
    struct lwip_socket *s = static_cast<struct lwip_socket*>(server);
    struct lwip_socket *ns = lwip_arena_alloc();

    err_t err = netconn_accept(s->conn, &ns->conn);
    if (err != ERR_OK) {
        lwip_arena_dealloc(ns);
        return lwip_err_remap(err);
    }

    *reinterpret_cast<struct lwip_socket**>(handle) = ns;
    return 0;
}

int LWIPStack::socket_send(nsapi_socket_t handle, const void *data, unsigned size)
{
    struct lwip_socket *s = static_cast<struct lwip_socket*>(handle);

    err_t err = netconn_write(s->conn, data, size, NETCONN_COPY);
    if (err != ERR_OK) {
        return lwip_err_remap(err);
    }

    return size;
}

int LWIPStack::socket_recv(nsapi_socket_t handle, void *data, unsigned size)
{
    struct lwip_socket *s = static_cast<struct lwip_socket*>(handle);

    if (!s->buf) {
        err_t err = netconn_recv(s->conn, &s->buf);
        s->offset = 0;

        if (err != ERR_OK) {
            return (err == ERR_CLSD) ? 0 : lwip_err_remap(err);
        }
    }

    u16_t recv = netbuf_copy_partial(s->buf, data,
            static_cast<u16_t>(size), s->offset);
    s->offset += recv;

    if (s->offset >= netbuf_len(s->buf)) {
        netbuf_delete(s->buf);
        s->buf = 0;
    }

    return recv;
}

int LWIPStack::socket_sendto(nsapi_socket_t handle, const SocketAddress &addr, const void *data, unsigned size)
{
    struct lwip_socket *s = static_cast<struct lwip_socket*>(handle);

    struct netbuf *buf = netbuf_new();
    err_t err = netbuf_ref(buf, data, static_cast<u16_t>(size));
    if (err != ERR_OK) {
        netbuf_free(buf);
        return lwip_err_remap(err);;
    }

    ip_addr_t ip_addr;
    inet_aton(addr.get_ip_address(), &ip_addr);

    err = netconn_sendto(s->conn, buf, &ip_addr, addr.get_port());
    netbuf_delete(buf);
    if (err != ERR_OK) {
        return lwip_err_remap(err);
    }

    return size;
}

int LWIPStack::socket_recvfrom(nsapi_socket_t handle, SocketAddress *addr, void *data, unsigned size)
{
    struct lwip_socket *s = static_cast<struct lwip_socket*>(handle);

    struct netbuf *buf;
    err_t err = netconn_recv(s->conn, &buf);
    if (err != ERR_OK) {
        return lwip_err_remap(err);
    }

    if (addr) {
        ip_addr_t *ip_addr = netbuf_fromaddr(buf);
        addr->set_ip_address(inet_ntoa(*ip_addr));
        addr->set_port(netbuf_fromport(buf));
    }

    u16_t recv = netbuf_copy(buf, data, static_cast<u16_t>(size));
    netbuf_delete(buf);

    return recv;
}

int LWIPStack::setsockopt(nsapi_socket_t handle, int level, int optname, const void *optval, unsigned optlen) {
    struct lwip_socket *s = static_cast<struct lwip_socket*>(handle);

    switch (optname) {
        case NSAPI_KEEPALIVE:
            if (optlen != sizeof(int) || s->conn->type != NETCONN_TCP) {
                return NSAPI_ERROR_UNSUPPORTED;
            }

            s->conn->pcb.tcp->so_options |= SOF_KEEPALIVE;
            return 0;

        case NSAPI_KEEPIDLE:
            if (optlen != sizeof(int) || s->conn->type != NETCONN_TCP) {
                return NSAPI_ERROR_UNSUPPORTED;
            }

            s->conn->pcb.tcp->keep_idle = *(int*)optval;
            return 0;

        case NSAPI_KEEPINTVL:
            if (optlen != sizeof(int) || s->conn->type != NETCONN_TCP) {
                return NSAPI_ERROR_UNSUPPORTED;
            }

            s->conn->pcb.tcp->keep_intvl = *(int*)optval;
            return 0;

        default:
            return NSAPI_ERROR_UNSUPPORTED;
    }
}

void LWIPStack::socket_attach(nsapi_socket_t handle, void (*callback)(void *), void *data)
{
    struct lwip_socket *s = static_cast<struct lwip_socket*>(handle);

    s->cb = callback;
    s->data = data;
}


/* Interface implementation */
int EthernetInterface::connect()
{
    return lwip_init();
}

int EthernetInterface::disconnect()
{
    lwip_deinit();
    return 0;
}

const char *EthernetInterface::get_ip_address()
{
    return lwip_get_ip_address();
}

const char *EthernetInterface::get_mac_address()
{
    return lwip_get_mac_address();
}

NetworkStack *EthernetInterface::get_stack()
{
    return lwip_stack.get();
}