slipif.h File Reference

#include "lwip/opt.h"
#include "lwip/netif.h"

Go to the source code of this file.

Macros
#define	SLIP_USE_RX_THREAD   !NO_SYS
#define	SLIP_RX_FROM_ISR   0
#define	SLIP_RX_QUEUE   SLIP_RX_FROM_ISR

Functions
err_t	slipif_init (struct netif *netif)
void	slipif_poll (struct netif *netif)

Detailed Description

SLIP netif API

Macro Definition Documentation

SLIP_USE_RX_THREAD

#define SLIP_USE_RX_THREAD   !NO_SYS

Set this to 1 to start a thread that blocks reading on the serial line (using sio_read()).

SLIP_RX_FROM_ISR

#define SLIP_RX_FROM_ISR   0

Set this to 1 to enable functions to pass in RX bytes from ISR context. If enabled, slipif_received_byte[s]() process incoming bytes and put assembled packets on a queue, which is fed into lwIP from slipif_poll(). If disabled, slipif_poll() polls the serial line (using sio_tryread()).

SLIP_RX_QUEUE

#define SLIP_RX_QUEUE   SLIP_RX_FROM_ISR

Set this to 1 (default for SLIP_RX_FROM_ISR) to queue incoming packets received by slipif_received_byte[s]() as long as PBUF_POOL pbufs are available. If disabled, packets will be dropped if more than one packet is received.

Function Documentation

slipif_init()

err_t slipif_init

(

struct netif *

netif

)

SLIP netif initialization

Call the arch specific sio_open and remember the opened device in the state field of the netif.

Parameters

netif

the lwip network interface structure for this slipif

Returns

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 (0 by default). If netif->state is != NULL, it is interpreted as an u8_t pointer pointing to the serial port number instead of netif->num.

{
  struct slipif_priv *priv;
  u8_t sio_num;
 
  LWIP_DEBUGF(SLIP_DEBUG, ("slipif_init: netif->num=%"U16_F"\n", (u16_t)netif->num));
 
  /* Allocate private data */
  priv = (struct slipif_priv *)mem_malloc(sizeof(struct slipif_priv));
  if (!priv) {
    return ERR_MEM;
  }
 
  netif->name[0] = 's';
  netif->name[1] = 'l';
#if LWIP_IPV4
  netif->output = slipif_output_v4;
#endif /* LWIP_IPV4 */
#if LWIP_IPV6
  netif->output_ip6 = slipif_output_v6;
#endif /* LWIP_IPV6 */
  netif->mtu = SLIP_MAX_SIZE;
 
  /* netif->state or netif->num contain the port number */
  if (netif->state != NULL) {
    sio_num = *(u8_t*)netif->state;
  } else {
    sio_num = netif->num;
  }
  /* Try to open the serial port. */
  priv->sd = sio_open(sio_num);
  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;
#if SLIP_RX_FROM_ISR
  priv->rxpackets = NULL;
#endif
 
  netif->state = priv;
 
  /* initialize the snmp variables and counters inside the struct netif */
  MIB2_INIT_NETIF(netif, snmp_ifType_slip, SLIP_SIO_SPEED(priv->sd));
 
#if SLIP_USE_RX_THREAD
  /* Create a thread to poll the serial line. */
  sys_thread_new(SLIPIF_THREAD_NAME, slipif_loop_thread, netif,
    SLIPIF_THREAD_STACKSIZE, SLIPIF_THREAD_PRIO);
#endif /* SLIP_USE_RX_THREAD */
  return ERR_OK;
}

Here is the call graph for this function:

slipif_poll()

void slipif_poll

(

struct netif *

netif

)

Polls the serial device and feeds the IP layer with incoming packets.

Parameters

netif

The lwip network interface structure for this slipif

{
  u8_t c;
  struct slipif_priv *priv;
 
  LWIP_ASSERT("netif != NULL", (netif != NULL));
  LWIP_ASSERT("netif->state != NULL", (netif->state != NULL));
 
  priv = (struct slipif_priv *)netif->state;
 
  while (sio_tryread(priv->sd, &c, 1) > 0) {
    slipif_rxbyte_input(netif, c);
  }
}

Here is the call graph for this function: