[Link layer] GNRC PPP

drivers/include/net/netdev2.h

@@ -62,7 +62,8 @@ enum {
     NETDEV2_TYPE_ETHERNET,
     NETDEV2_TYPE_IEEE802154,
     NETDEV2_TYPE_CC110X,
-    NETDEV2_TYPE_NRFMIN
+    NETDEV2_TYPE_NRFMIN,
+    NETDEV2_TYPE_PPP
 };
 
 /**

drivers/include/net/netdev2/ppp.h

@@ -0,0 +1,111 @@
+/*
+ * Copyright (C) 2016 Fundación Inria Chile
+ *
+ * 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 drivers_netdev_netdev2
+ * @brief
+ * @{
+ *
+ * @file
+ * @brief   Definitions for netdev2 common Point to Point Protocol code
+ *
+ * @author  José Ignacio Alamos
+ */
+#ifndef NETDEV2_PPP_H
+#define NETDEV2_PPP_H
+
+#include "net/gnrc/ppp/prot.h"
+#include "net/gnrc/ppp/prot.h"
+#include "net/gnrc/ppp/lcp.h"
+#include "net/gnrc/ppp/pap.h"
+#include "net/gnrc/ppp/ipcp.h"
+#include "net/gnrc/nettype.h"
+#include "net/netopt.h"
+#include "net/netdev2.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+#if defined(MODULE_GNRC_PPP) || doxygen
+/**
+ * @brief class of custom driver control protocol
+ * @extends ppp_protocol_t
+ *
+ * @details the DCP is in charge of monitoring the link and exchanging messages with the ppp device
+ */
+typedef struct gnrc_ppp_dcp {
+    gnrc_ppp_protocol_t prot;    /**< base ppp_protocol_t object */
+    msg_t timer_msg;        /**< msg struct for handling timeouts messages */
+    xtimer_t xtimer;        /**< xtimer struct for sending timeout messages */
+    uint8_t dead_counter;   /**< when reaches zero, the link is assumed to be dead */
+} gnrc_ppp_dcp_t;
+#endif
+
+
+/**
+ * @brief Extended structure to hold PPP driver state
+ *
+ * @extends netdev2_t
+ *
+ * Supposed to be extended by driver implementations.
+ * The extended structure should contain all variable driver state.
+ */
+typedef struct {
+    netdev2_t netdev;                       /**< @ref netdev2_t base class */
+#if defined(MODULE_GNRC_PPP) || doxygen
+    /**
+     * @brief PPP specific fields
+     * @{
+     */
+    gnrc_ppp_dcp_t dcp;                             /**< Control protocol for driver */
+    gnrc_ppp_lcp_t lcp;                             /**< Link Control Protocol */
+    gnrc_ppp_pap_t pap;                             /**< Password Authentication Protocol */
+    gnrc_ppp_ipcp_t ipcp;                  /**< IPv4 Network Control Protocol */
+    gnrc_ppp_ipv4_t ipv4;                  /**< Handler for IPv4 packets */
+#endif
+} netdev2_ppp_t;
+
+
+/**
+ * @brief   Fallback function for netdev2 PPP devices' _get function
+ *
+ * Supposed to be used by netdev2 drivers as default case.
+ *
+ * @param[in]   dev     network device descriptor
+ * @param[in]   opt     option type
+ * @param[out]  value   pointer to store the option's value in
+ * @param[in]   max_len maximal amount of byte that fit into @p value
+ *
+ * @return              number of bytes written to @p value
+ * @return              <0 on error
+ */
+int netdev2_ppp_get(netdev2_ppp_t *dev, netopt_t opt, void *value,
+                    size_t max_len);
+
+/**
+ * @brief   Fallback function for netdev2 PPP devices' _set function
+ *
+ *
+ * @param[in] dev       network device descriptor
+ * @param[in] opt       option type
+ * @param[in] value     value to set
+ * @param[in] value_len the length of @p value
+ *
+ * @return              number of bytes used from @p value
+ * @return              <0 on error
+ */
+int netdev2_ppp_set(netdev2_ppp_t *dev, netopt_t opt, void *value,
+                    size_t value_len);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* NETDEV2_PPP_H */
+/** @} */

drivers/netdev2_ppp/Makefile

@@ -0,0 +1 @@
+include $(RIOTBASE)/Makefile.base

drivers/netdev2_ppp/netdev2_ppp.c

@@ -0,0 +1,88 @@
+/*
+ * Copyright (C) Fundación Inria Chile 2017
+ *
+ * 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     driver_netdev2_ppp
+ * @{
+ *
+ * @file
+ * @brief       Common code for netdev2 ppp drivers
+ *
+ * @author      José Ignacio Alamos <jose.alamos@inria.cl>
+ *
+ * @}
+ */
+
+#include <assert.h>
+#include <errno.h>
+
+#include "net/netdev2.h"
+#include "net/netdev2/ppp.h"
+
+#define ENABLE_DEBUG (0)
+#include "debug.h"
+
+int netdev2_ppp_get(netdev2_ppp_t *dev, netopt_t opt, void *value, size_t max_len)
+{
+    int res;
+    switch (opt) {
+        case NETOPT_PPP_LCP_STATE:
+            *((uint8_t *) value) = ((gnrc_ppp_protocol_t*) &dev->lcp)->state;
+            res = 0;
+            break;
+        case NETOPT_PPP_AUTH_STATE:
+            *((uint8_t *) value) = ((gnrc_ppp_protocol_t*) &dev->pap)->state;
+            res = 0;
+            break;
+        case NETOPT_PPP_IPCP_STATE:
+            *((uint8_t *) value) = ((gnrc_ppp_protocol_t*) &dev->ipcp)->state;
+            res = 0;
+            break;
+        case NETOPT_PPP_IS_IPV6_READY:
+            res = ((gnrc_ppp_protocol_t*) &dev->ipv4)->state == PROTOCOL_UP;
+            *((uint8_t *) value) = res;
+            break;
+        case NETOPT_DEVICE_TYPE:
+            *((uint16_t*) value) = NETDEV2_TYPE_PPP;
+            res = 2;
+            break;
+        default:
+            return -ENOTSUP;
+            break;
+    }
+    return res;
+}
+
+int netdev2_ppp_set(netdev2_ppp_t *dev, netopt_t opt, void *value, size_t value_len)
+{
+    int res;
+    switch (opt) {
+        case NETOPT_TUNNEL_IPV4_ADDRESS:
+            dev->ipv4.tunnel_addr = *((ipv4_addr_t *) value);
+            res = 0;
+            break;
+        case NETOPT_TUNNEL_UDP_PORT:
+            dev->ipv4.tunnel_port = *((uint16_t *) value);
+            res = 0;
+            break;
+        case NETOPT_APN_USER:
+            memcpy(dev->pap.username, value, value_len);
+            dev->pap.user_size = value_len;
+            res = 0;
+            break;
+        case NETOPT_APN_PASS:
+            memcpy(dev->pap.password, value, value_len);
+            dev->pap.pass_size = value_len;
+            res = 0;
+            break;
+        default:
+            return -ENOTSUP;
+            break;
+    }
+    return res;
+}

sys/Makefile

@@ -58,6 +58,9 @@ endif
 ifneq (,$(filter gnrc_netdev2,$(USEMODULE)))
     DIRS += net/gnrc/link_layer/netdev2
 endif
+ifneq (,$(filter gnrc_ppp,$(USEMODULE)))
+    DIRS += net/gnrc/link_layer/ppp
+endif
 ifneq (,$(filter fib,$(USEMODULE)))
     DIRS += net/network_layer/fib
 endif

sys/include/net/gnrc/netdev2.h

@@ -80,6 +80,28 @@ typedef struct gnrc_netdev2 {
      */
     int (*send)(struct gnrc_netdev2 *dev, gnrc_pktsnip_t *snip);
 
+
+    /**
+     * @brief Handle custom messages
+     *
+     * This function handles messages that are not present in gnrc_netdev2 loop.
+     */
+    int (*msg_handler)(struct gnrc_netdev2 *dev, msg_t *msg);
+#if defined(MODULE_GNRC_PPP) || doxygen
+    /**
+     * @brief Handle link up event from this device
+     *
+     * This function handles link up events from device. 
+     */
+    int (*link_up)(struct gnrc_netdev2 *dev);
+
+    /**
+     * @brief Handle link down event from this device
+     *
+     * This function handles link down events from device. 
+     */
+    int (*link_down)(struct gnrc_netdev2 *dev);
+#endif
     /**
      * @brief Receive a pktsnip from this device
      *

sys/include/net/gnrc/netdev2/ppp.h

@@ -0,0 +1,43 @@
+/*
+ * Copyright (C) Fundación Inria Chile 2017
+ *
+ * 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.
+ */
+
+/**
+ * @addtogroup  net_gnrc
+ * @{
+ *
+ * @file
+ * @brief       GNRC to PPP netdev2 glue code interface
+ *
+ * @author      José Ignacio Alamos <jose.alamos@inria.cl>
+ */
+
+#ifndef GNRC_NETDEV2_PPP_H_
+#define GNRC_NETDEV2_PPP_H_
+
+#include "net/netdev2/ppp.h"
+#include "net/gnrc/netdev2.h"
+
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**
+ * @brief   Initialize GNRC handler for netdev2 PPP devices
+ *
+ * @param[out] gnrc_netdev2     gnrc_netdev2 struct to initialize
+ * @param[in]  dev              PPP device to handle
+ */
+void gnrc_netdev2_ppp_init(gnrc_netdev2_t *gnrc_netdev2, netdev2_ppp_t *dev);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* GNRC_NETDEV2_PPP_H_ */
+/** @} */

sys/include/net/gnrc/nettype.h

@@ -29,6 +29,7 @@
 
 #include "net/ethertype.h"
 #include "net/protnum.h"
+#include "net/ppptype.h"
 
 #ifdef __cplusplus
 extern "C" {
@@ -104,6 +105,21 @@ typedef enum {
      * @}
      */
 
+    /**
+     * @{
+     * @name Link layer
+     */
+#ifdef MODULE_GNRC_PPP
+    GNRC_NETTYPE_LCP,   /**< Protocol is PPP LCP */
+    GNRC_NETTYPE_IPCP,  /**< Protocol is PPP IPCP */
+    GNRC_NETTYPE_HDLC,  /**< Protocol is HDLC */
+    GNRC_NETTYPE_IPV4,  /**< Protocol is IPV4 encapsulated in HDLC frame */
+    GNRC_NETTYPE_PAP,   /**< Protocol is PAP auth */
+#endif
+    /**
+     * @}
+     */
+
     GNRC_NETTYPE_NUMOF,         /**< maximum number of available protocols */
 } gnrc_nettype_t;
 
@@ -134,6 +150,7 @@ static inline gnrc_nettype_t gnrc_nettype_from_ethertype(uint16_t type)
     }
 }
 
+
 /**
  * @brief   Translates @ref net_gnrc_nettype to an Ether Type number
  * @see     <a href="http://www.iana.org/assignments/ieee-802-numbers/ieee-802-numbers.xhtml#ieee-802-numbers-1">
@@ -241,6 +258,49 @@ static inline uint8_t gnrc_nettype_to_protnum(gnrc_nettype_t type)
     }
 }
 
+static inline gnrc_nettype_t gnrc_nettype_from_ppp_protnum(uint16_t protnum)
+{
+    switch (protnum) {
+#ifdef MODULE_GNRC_PPP
+        case PPPTYPE_LCP:
+            return GNRC_NETTYPE_LCP;
+        case PPPTYPE_NCP_IPV4:
+            return GNRC_NETTYPE_IPCP;
+        case PPPTYPE_IPV4:
+            return GNRC_NETTYPE_IPV4;
+        case PPPTYPE_PAP:
+            return GNRC_NETTYPE_PAP;
+#   ifdef MODULE_GNRC_IPV6
+        case PPPTYPE_IPV6:
+            return GNRC_NETTYPE_IPV6;
+#   endif
+#endif
+        default:
+            return GNRC_NETTYPE_UNDEF;
+    }
+}
+static inline uint16_t gnrc_nettype_to_ppp_protnum(gnrc_nettype_t type)
+{
+    switch (type) {
+#ifdef MODULE_GNRC_PPP
+        case GNRC_NETTYPE_LCP:
+            return PPPTYPE_LCP;
+        case GNRC_NETTYPE_IPCP:
+            return PPPTYPE_NCP_IPV4;
+#   ifdef MODULE_GNRC_IPV6
+        case GNRC_NETTYPE_IPV6:
+            return PPPTYPE_IPV6;
+#   endif
+        case GNRC_NETTYPE_IPV4:
+            return PPPTYPE_IPV4;
+        case GNRC_NETTYPE_PAP:
+            return PPPTYPE_PAP;
+#endif
+        default:
+            return PPPTYPE_UNKNOWN;
+    }
+}
+
 #ifdef __cplusplus
 }
 #endif