bug #26397: Added SLIP polling support (uses sio_tryread)

CHANGELOG

@@ -19,6 +19,9 @@ HISTORY
 
   ++ New features:
 
+  2009-08-26 Simon Goldschmidt/Simon Kallweit
+  * slipif.c/.h: bug #26397: SLIP polling support
+
   2009-08-25 Simon Goldschmidt
   * opt.h, etharp.h/.c: task #9033: Support IEEE 802.1q tagged frame (VLAN),
     New configuration options ETHARP_SUPPORT_VLAN and ETHARP_VLAN_CHECK.

src/include/netif/slipif.h

@@ -41,6 +41,7 @@ extern "C" {
 #endif
 
 err_t slipif_init(struct netif * netif);
+void slipif_poll(struct netif *netif);
 
 #ifdef __cplusplus
 }

src/netif/slipif.c

@@ -54,12 +54,28 @@
 #include "lwip/snmp.h"
 #include "lwip/sio.h"
 
+#define SLIP_BLOCK     1
+#define SLIP_DONTBLOCK 0
+
 #define SLIP_END     0300 /* 0xC0 */
 #define SLIP_ESC     0333 /* 0xDB */
 #define SLIP_ESC_END 0334 /* 0xDC */
 #define SLIP_ESC_ESC 0335 /* 0xDD */
 
-#define MAX_SIZE     1500
+#define SLIP_MAX_SIZE 1500
+
+enum slipif_recv_state {
+    SLIP_RECV_NORMAL,
+    SLIP_RECV_ESCAPE,
+};
+
+struct slipif_priv {
+  sio_fd_t sd;
+  /* q is the whole pbuf chain for a packet, p is the current pbuf in the chain */
+  struct pbuf *p, *q;
+  enum slipif_recv_state state;
+  u16_t i, recved;
+};
 
 /**
  * Send a pbuf doing the necessary SLIP encapsulation
@@ -74,6 +90,7 @@
 err_t
 slipif_output(struct netif *netif, struct pbuf *p, struct ip_addr *ipaddr)
 {
+  struct slipif_priv *priv;
   struct pbuf *q;
   u16_t i;
   u8_t c;
@@ -84,73 +101,101 @@ slipif_output(struct netif *netif, struct pbuf *p, struct ip_addr *ipaddr)
 
   LWIP_UNUSED_ARG(ipaddr);
 
+  priv = netif->state;
+
   /* Send pbuf out on the serial I/O device. */
-  sio_send(SLIP_END, netif->state);
+  sio_send(SLIP_END, priv->sd);
 
   for (q = p; q != NULL; q = q->next) {
     for (i = 0; i < q->len; i++) {
       c = ((u8_t *)q->payload)[i];
       switch (c) {
       case SLIP_END:
-        sio_send(SLIP_ESC, netif->state);
+        sio_send(SLIP_ESC, priv->sd);
-        sio_send(SLIP_ESC_END, netif->state);
+        sio_send(SLIP_ESC_END, priv->sd);
         break;
       case SLIP_ESC:
-        sio_send(SLIP_ESC, netif->state);
+        sio_send(SLIP_ESC, priv->sd);
-        sio_send(SLIP_ESC_ESC, netif->state);
+        sio_send(SLIP_ESC_ESC, priv->sd);
         break;
       default:
-        sio_send(c, netif->state);
+        sio_send(c, priv->sd);
         break;
       }
     }
   }
-  sio_send(SLIP_END, netif->state);
+  sio_send(SLIP_END, priv->sd);
   return ERR_OK;
 }
 
+/**
+ * Static function for easy use of blockig or non-blocking
+ * sio_read
+ *
+ * @param fd serial device handle
+ * @param data pointer to data buffer for receiving
+ * @param len maximum length (in bytes) of data to receive
+ * @param block if 1, call sio_read; if 0, call sio_tryread
+ * @return return value of sio_read of sio_tryread
+ */
+static u32_t
+slip_sio_read(sio_fd_t fd, u8_t* data, u32_t len, u8_t block)
+{
+  if (block) {
+    return sio_read(fd, data, len);
+  } else {
+    return sio_tryread(fd, data, len);
+  }
+}
+
 /**
  * Handle the incoming SLIP stream character by character
  *
  * Poll the serial layer by calling sio_recv()
  *
  * @param netif the lwip network interface structure for this slipif
- * @return The IP packet when SLIP_END is received 
+ * @param block if 1, block until data is received; if 0, return when all data
+ *        from the buffer is received (multiple calls to this function will
+ *        return a complete packet, NULL is returned before - used for polling)
+ * @return The IP packet when SLIP_END is received
  */
 static struct pbuf *
-slipif_input(struct netif *netif)
+slipif_input(struct netif *netif, u8_t block)
 {
+  struct slipif_priv *priv;
   u8_t c;
-  /* q is the whole pbuf chain for a packet, p is the current pbuf in the chain */
+  struct pbuf *t;
-  struct pbuf *p, *q;
-  u16_t recved;
-  u16_t i;
 
   LWIP_ASSERT("netif != NULL", (netif != NULL));
   LWIP_ASSERT("netif->state != NULL", (netif->state != NULL));
 
-  q = p = NULL;
+  priv = netif->state;
-  recved = i = 0;
-  c = 0;
 
-  while (1) {
+  while (slip_sio_read(priv->sd, &c, 1, block) > 0) {
-    c = sio_recv(netif->state);
+    switch (priv->state) {
-    switch (c) {
+    case SLIP_RECV_NORMAL:
-    case SLIP_END:
+      switch (c) {
-      if (recved > 0) {
+      case SLIP_END:
-        /* Received whole packet. */
+        if (priv->recved > 0) {
-        /* Trim the pbuf to the size of the received packet. */
+          /* Received whole packet. */
-        pbuf_realloc(q, recved);
+          /* Trim the pbuf to the size of the received packet. */
-        
+          pbuf_realloc(priv->q, priv->recved);
-        LINK_STATS_INC(link.recv);
+
-        
+          LINK_STATS_INC(link.recv);
-        LWIP_DEBUGF(SLIP_DEBUG, ("slipif: Got packet\n"));
+
-        return q;
+          LWIP_DEBUGF(SLIP_DEBUG, ("slipif: Got packet\n"));
+          t = priv->q;
+          priv->p = priv->q = NULL;
+          priv->i = priv->recved = 0;
+          return t;
+        }
+        continue;
+      case SLIP_ESC:
+        priv->state = SLIP_RECV_ESCAPE;
+        continue;
       }
       break;
-
+    case SLIP_RECV_ESCAPE:
-    case SLIP_ESC:
-      c = sio_recv(netif->state);
       switch (c) {
       case SLIP_ESC_END:
         c = SLIP_END;
@@ -159,52 +204,52 @@ slipif_input(struct netif *netif)
         c = SLIP_ESC;
         break;
       }
+      priv->state = SLIP_RECV_NORMAL;
       /* FALLTHROUGH */
+    }
 
-    default:
+    /* byte received, packet not yet completely received */
-      /* byte received, packet not yet completely received */
+    if (priv->p == NULL) {
-      if (p == NULL) {
+      /* allocate a new pbuf */
-        /* allocate a new pbuf */
+      LWIP_DEBUGF(SLIP_DEBUG, ("slipif_input: alloc\n"));
-        LWIP_DEBUGF(SLIP_DEBUG, ("slipif_input: alloc\n"));
+      priv->p = pbuf_alloc(PBUF_LINK, (PBUF_POOL_BUFSIZE - PBUF_LINK_HLEN), PBUF_POOL);
-        p = pbuf_alloc(PBUF_LINK, PBUF_POOL_BUFSIZE, PBUF_POOL);
 
-        if (p == NULL) {
+      if (priv->p == NULL) {
-          LINK_STATS_INC(link.drop);
+        LINK_STATS_INC(link.drop);
-          LWIP_DEBUGF(SLIP_DEBUG, ("slipif_input: no new pbuf! (DROP)\n"));
+        LWIP_DEBUGF(SLIP_DEBUG, ("slipif_input: no new pbuf! (DROP)\n"));
-          /* don't process any further since we got no pbuf to receive to */
+        /* don't process any further since we got no pbuf to receive to */
-          break;
+        break;
-        }
+      }
 
-        if (q != NULL) {
+      if (priv->q != NULL) {
-          /* 'chain' the pbuf to the existing chain */
+        /* 'chain' the pbuf to the existing chain */
-          pbuf_cat(q, p);
+        pbuf_cat(priv->q, priv->p);
+      } else {
+        /* p is the first pbuf in the chain */
+        priv->q = priv->p;
+      }
+    }
+
+    /* this automatically drops bytes if > SLIP_MAX_SIZE */
+    if ((priv->p != NULL) && (priv->recved <= SLIP_MAX_SIZE)) {
+      ((u8_t *)priv->p->payload)[priv->i] = c;
+      priv->recved++;
+      priv->i++;
+      if (priv->i >= priv->p->len) {
+        /* on to the next pbuf */
+        priv->i = 0;
+        if (priv->p->next != NULL && priv->p->next->len > 0) {
+          /* p is a chain, on to the next in the chain */
+            priv->p = priv->p->next;
         } else {
-          /* p is the first pbuf in the chain */
+          /* p is a single pbuf, set it to NULL so next time a new
-          q = p;
+           * pbuf is allocated */
+            priv->p = NULL;
         }
       }
-
-      /* this automatically drops bytes if > MAX_SIZE */
-      if ((p != NULL) && (recved <= MAX_SIZE)) {
-        ((u8_t *)p->payload)[i] = c;
-        recved++;
-        i++;
-        if (i >= p->len) {
-          /* on to the next pbuf */
-          i = 0;
-          if (p->next != NULL && p->next->len > 0) {
-            /* p is a chain, on to the next in the chain */
-            p = p->next;
-          } else {
-            /* p is a single pbuf, set it to NULL so next time a new
-             * pbuf is allocated */
-            p = NULL;
-          }
-        }
-      }
-      break;
     }
   }
+
   return NULL;
 }
 
@@ -217,13 +262,13 @@ slipif_input(struct netif *netif)
  * @param nf the lwip network interface structure for this slipif
  */
 static void
-slipif_loop(void *nf)
+slipif_loop_thread(void *nf)
 {
   struct pbuf *p;
   struct netif *netif = (struct netif *)nf;
 
   while (1) {
-    p = slipif_input(netif);
+    p = slipif_input(netif, SLIP_BLOCK);
     if (p != NULL) {
       if (netif->input(p, netif) != ERR_OK) {
         pbuf_free(p);
@@ -242,6 +287,7 @@ slipif_loop(void *nf)
  *
  * @param netif the lwip network interface structure for this slipif
  * @return ERR_OK if serial line could be opened,
+ *         ERR_MEM if no memory could be allocated,
  *         ERR_IF is serial line couldn't be opened
  *
  * @note netif->num must contain the number of the serial port to open
@@ -250,22 +296,39 @@ slipif_loop(void *nf)
 err_t
 slipif_init(struct netif *netif)
 {
+  struct slipif_priv *priv;
 
   LWIP_DEBUGF(SLIP_DEBUG, ("slipif_init: netif->num=%"U16_F"\n", (u16_t)netif->num));
 
+  /* Allocate private data */
+  priv = mem_malloc(sizeof(struct slipif_priv));
+  if (!priv) {
+    return ERR_MEM;
+  }
+
   netif->name[0] = 's';
   netif->name[1] = 'l';
   netif->output = slipif_output;
-  netif->mtu = MAX_SIZE;
+  netif->mtu = SLIP_MAX_SIZE;
-  netif->flags = NETIF_FLAG_POINTTOPOINT;
+  netif->flags |= NETIF_FLAG_POINTTOPOINT;
 
   /* Try to open the serial port (netif->num contains the port number). */
-  netif->state = sio_open(netif->num);
+  priv->sd = sio_open(netif->num);
-  if (!netif->state) {
+  if (!priv->sd) {
     /* Opening the serial port failed. */
+    mem_free(priv);
     return ERR_IF;
   }
 
+  /* Initialize private data */
+  priv->p = NULL;
+  priv->q = NULL;
+  priv->state = SLIP_RECV_NORMAL;
+  priv->i = 0;
+  priv->recved = 0;
+
+  netif->state = priv;
+
   /* initialize the snmp variables and counters inside the struct netif
    * ifSpeed: no assumption can be made without knowing more about the
    * serial line!
@@ -273,7 +336,32 @@ slipif_init(struct netif *netif)
   NETIF_INIT_SNMP(netif, snmp_ifType_slip, 0);
 
   /* Create a thread to poll the serial line. */
-  sys_thread_new(SLIPIF_THREAD_NAME, slipif_loop, netif, SLIPIF_THREAD_STACKSIZE, SLIPIF_THREAD_PRIO);
+  sys_thread_new(SLIPIF_THREAD_NAME, slipif_loop_thread, netif,
+    SLIPIF_THREAD_STACKSIZE, SLIPIF_THREAD_PRIO);
   return ERR_OK;
 }
+
+/**
+ * Polls the serial device and feeds the IP layer with incoming packets.
+ *
+ * @param netif The lwip network interface structure for this slipif
+ */
+void
+slipif_poll(struct netif *netif)
+{
+  struct pbuf *p;
+  struct slipif_priv *priv;
+
+  LWIP_ASSERT("netif != NULL", (netif != NULL));
+  LWIP_ASSERT("netif->state != NULL", (netif->state != NULL));
+
+  priv = netif->state;
+
+  while ((p = slipif_input(netif, SLIP_DONTBLOCK)) != NULL) {
+    if (netif->input(p, netif) != ERR_OK) {
+      pbuf_free(p);
+    }
+  }
+}
+
 #endif /* LWIP_HAVE_SLIPIF */