Merge pull request #7898 from miri64/gnrc_netif2/feat/xbee

xbee: port to gnrc_netif2

drivers/xbee/gnrc_xbee.c

@@ -0,0 +1,189 @@
+/*
+ * Copyright (C) 2016-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.
+ */
+
+/**
+ * @ingroup     net_gnrc_netif2
+ * @{
+ *
+ * @file
+ *
+ * @author      Hauke Petersen <hauke.petersen@fu-berlin.de>
+ * @author      Martine Lenders <m.lenders@fu-berlin.de>
+ *
+ * @}
+ */
+
+#include "assert.h"
+#include "xbee.h"
+#include "net/gnrc.h"
+#include "gnrc_netif2_xbee.h"
+
+#define ENABLE_DEBUG    (0)
+#include "debug.h"
+
+#define BCAST   (GNRC_NETIF_HDR_FLAGS_BROADCAST | GNRC_NETIF_HDR_FLAGS_MULTICAST)
+
+static gnrc_pktsnip_t *xbee_adpt_recv(gnrc_netif2_t *netif)
+{
+    netdev_t *dev = netif->dev;
+    int pktlen;
+    int xhdr_len;
+    gnrc_pktsnip_t *payload;
+    gnrc_pktsnip_t *netif_snip;
+    gnrc_pktsnip_t *xhdr_snip;
+    gnrc_netif_hdr_t *netif_hdr;
+    xbee_l2hdr_t l2hdr;
+
+    assert(dev);
+
+    /* see how much data there is to process */
+    pktlen = dev->driver->recv(dev, NULL, 0, NULL);
+    if (pktlen <= 0) {
+        DEBUG("[xbee-gnrc] recv: no data available to process\n");
+        return NULL;
+    }
+
+    /* allocate space for the packet in the pktbuf */
+    payload = gnrc_pktbuf_add(NULL, NULL, pktlen, XBEE_DEFAULT_PROTOCOL);
+    if (payload == NULL) {
+        DEBUG("[xbee-gnrc] recv: unable to allocate space in the pktbuf\n");
+        /* tell the driver to drop the packet */
+        dev->driver->recv(dev, NULL, 1, NULL);
+        return NULL;
+    }
+
+    /* copy the complete including the XBee header into the packet buffer */
+    dev->driver->recv(dev, payload->data, pktlen, NULL);
+
+    /* try to parse the L2 header data from the XBee header */
+    xhdr_len = xbee_parse_hdr((xbee_t *)dev, (uint8_t *)payload->data, &l2hdr);
+    if (xhdr_len < 0) {
+        DEBUG("[xbee-gnrc] recv: unable to parse XBee header\n");
+        gnrc_pktbuf_release(payload);
+        return NULL;
+    }
+
+    /* crop the XBee header from the payload */
+    xhdr_snip = gnrc_pktbuf_mark(payload, xhdr_len, GNRC_NETTYPE_UNDEF);
+    if (xhdr_snip == NULL) {
+        DEBUG("[xbee-gnrc] recv: unable to mark XBee header snip\n");
+        gnrc_pktbuf_release(payload);
+        return NULL;
+    }
+    gnrc_pktbuf_remove_snip(payload, xhdr_snip);
+
+    /* create a netif hdr from the obtained data */
+    netif_snip = gnrc_netif_hdr_build(l2hdr.src_addr, l2hdr.addr_len,
+                                      l2hdr.dst_addr, l2hdr.addr_len);
+    if (netif_snip == NULL) {
+        DEBUG("[xbee-gnrc] recv: unable to allocate netif header\n");
+        gnrc_pktbuf_release(payload);
+        return NULL;
+    }
+    netif_hdr = (gnrc_netif_hdr_t *)netif_snip->data;
+    netif_hdr->if_pid = netif->pid;
+    netif_hdr->rssi = l2hdr.rssi;
+    if (l2hdr.bcast) {
+        netif_hdr->flags = GNRC_NETIF_HDR_FLAGS_BROADCAST;
+    }
+
+    DEBUG("[xbee-gnrc] recv: successfully parsed packet\n");
+
+    /* and append the netif header */
+    LL_APPEND(payload, netif_snip);
+
+    return payload;
+}
+
+static int xbee_adpt_send(gnrc_netif2_t *netif, gnrc_pktsnip_t *pkt)
+{
+    int res;
+    size_t size;
+    size_t count;
+    gnrc_pktsnip_t *vec;
+    gnrc_netif_hdr_t *hdr;
+    uint8_t xhdr[XBEE_MAX_TXHDR_LENGTH];
+
+    /* check device descriptor and packet */
+    assert(netif && pkt);
+
+    /* get the payload size and the dst address details */
+    size = gnrc_pkt_len(pkt->next);
+    DEBUG("[xbee-gnrc] send: payload of packet is %i\n", (int)size);
+    hdr = (gnrc_netif_hdr_t *)pkt->data;
+    if (hdr->flags & BCAST) {
+        uint16_t addr = 0xffff;
+        res = xbee_build_hdr((xbee_t *)netif, xhdr, size, &addr, 2);
+        DEBUG("[xbee-gnrc] send: preparing to send broadcast\n");
+    }
+    else {
+        uint8_t *addr = gnrc_netif_hdr_get_dst_addr(hdr);
+        res = xbee_build_hdr((xbee_t *)netif, xhdr, size, addr,
+                             hdr->dst_l2addr_len);
+        if (res < 0) {
+            if (res == -EOVERFLOW) {
+                DEBUG("[xbee-gnrc] send: payload length exceeds max limit\n");
+            }
+            else if (res == -ENOMSG) {
+                DEBUG("[xbee-gnrc] send: invalid destination l2 address\n");
+            }
+            return res;
+        }
+        if (hdr->dst_l2addr_len == IEEE802154_SHORT_ADDRESS_LEN) {
+            DEBUG("[xbee-gnrc] send: preparing to send unicast to %02x:%02x\n",
+                  (int)addr[0], (int)addr[1]);
+        }
+        else {
+            DEBUG("[xbee-gnrc] send: preparing to send unicast to "
+                  "%02x:%02x:%02x:%02x:%02x:%02x:%02x:%02x\n",
+                  (int)addr[0], (int)addr[1], (int)addr[2], (int)addr[3],
+                  (int)addr[4], (int)addr[5], (int)addr[6], (int)addr[7]);
+        }
+    }
+
+    /* now let's extract the iovector and send out the stuff */
+    vec = gnrc_pktbuf_get_iovec(pkt, &count);
+    if (vec != NULL) {
+        pkt = vec;
+        struct iovec *vector = (struct iovec *)pkt->data;
+        vector[0].iov_base = xhdr;
+        vector[0].iov_len = res;
+#ifdef MODULE_NETSTATS_L2
+        if (hdr->flags & BCAST) {
+            netif->dev->stats.tx_mcast_count++;
+        }
+        else {
+            netif->dev->stats.tx_unicast_count++;
+        }
+#endif
+        DEBUG("[xbee-gnrc] send: triggering the drivers send function\n");
+        res = netif->dev->driver->send(netif->dev, vector, count);
+    }
+    else {
+        DEBUG("[xbee-gnrc] send: unable to create iovec\n");
+    }
+
+    gnrc_pktbuf_release(pkt);
+
+    return res;
+}
+
+static const gnrc_netif2_ops_t _xbee_ops = {
+    .send = xbee_adpt_send,
+    .recv = xbee_adpt_recv,
+    .get = gnrc_netif2_get_from_netdev,
+    .set = gnrc_netif2_set_from_netdev,
+};
+
+gnrc_netif2_t *gnrc_netif2_xbee_create(char *stack, int stacksize,
+                                       char priority, char *name,
+                                       netdev_t *dev)
+{
+    return gnrc_netif2_create(stack, stacksize, priority, name,
+                              dev, &_xbee_ops);
+}

drivers/xbee/include/gnrc_netif2_xbee.h

@@ -0,0 +1,36 @@
+/*
+ * 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.
+ */
+
+/**
+ * @ingroup net_gnrc_netif2
+ * @{
+ *
+ * @file
+ * @brief   XBee adaption for @ref net_gnrc_netif2
+ *
+ * @author  Martine Lenders <m.lenders@fu-berlin.de>
+ */
+#ifndef GNRC_NETIF2_XBEE_H
+#define GNRC_NETIF2_XBEE_H
+
+#include "net/gnrc/netif2.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+gnrc_netif2_t *gnrc_netif2_xbee_create(char *stack, int stacksize,
+                                       char priority, char *name,
+                                       netdev_t *dev);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* GNRC_NETIF2_XBEE_H */
+/** @} */

drivers/xbee/xbee.c

@@ -749,6 +749,10 @@ static int xbee_get(netdev_t *ndev, netopt_t opt, void *value, size_t max_len)
                 *((uint16_t *)value) = IEEE802154_SHORT_ADDRESS_LEN;
             }
             return sizeof(uint16_t);
+        case NETOPT_DEVICE_TYPE:
+            assert(max_len == sizeof(uint16_t));
+            *((uint16_t *)value) = NETDEV_TYPE_IEEE802154;
+            return sizeof(uint16_t);
         case NETOPT_IPV6_IID:
             if (max_len < sizeof(eui64_t)) {
                 return -EOVERFLOW;

sys/auto_init/netif/auto_init_xbee.c

@@ -23,7 +23,8 @@
 
 #include "log.h"
 #include "board.h"
-#include "net/gnrc/netdev/xbee_adpt.h"
+#include "gnrc_netif2_xbee.h"
+#include "xbee.h"
 #include "xbee_params.h"
 
 /**
@@ -36,14 +37,13 @@
  */
 #define XBEE_MAC_STACKSIZE           (THREAD_STACKSIZE_DEFAULT)
 #ifndef XBEE_MAC_PRIO
-#define XBEE_MAC_PRIO                (GNRC_NETDEV_MAC_PRIO)
+#define XBEE_MAC_PRIO                (GNRC_NETIF2_PRIO)
 #endif
 
 /**
  * @brief   Allocate memory for device descriptors, stacks, and GNRC adaption
  */
 static xbee_t xbee_devs[XBEE_NUM];
-static gnrc_netdev_t gnrc_adpt[XBEE_NUM];
 static char stacks[XBEE_NUM][XBEE_MAC_STACKSIZE];
 
 void auto_init_xbee(void)
@@ -52,9 +52,8 @@ void auto_init_xbee(void)
         LOG_DEBUG("[auto_init_netif] initializing xbee #%u\n", i);
 
         xbee_setup(&xbee_devs[i], &xbee_params[i]);
-        gnrc_netdev_xbee_init(&gnrc_adpt[i], &xbee_devs[i]);
+        gnrc_netif2_xbee_create(stacks[i], XBEE_MAC_STACKSIZE, XBEE_MAC_PRIO,
-        gnrc_netdev_init(stacks[i], XBEE_MAC_STACKSIZE, XBEE_MAC_PRIO,
+                                "xbee", (netdev_t *)&xbee_devs[i]);
-                              "xbee", &gnrc_adpt[i]);
     }
 }
 

tests/driver_xbee/Makefile

@@ -9,7 +9,6 @@ BOARD_INSUFFICIENT_MEMORY := nucleo32-f031 nucleo32-f042 nucleo-f030 nucleo-f334
 USEMODULE += xbee
 USEMODULE += gnrc_netif
 USEMODULE += gnrc_txtsnd
-USEMODULE += gnrc_netdev
 USEMODULE += auto_init_gnrc_netif
 USEMODULE += gnrc_pktdump
 USEMODULE += shell