Rtos API example

Embed: (wiki syntax)

« Back to documentation index

slipif.h File Reference

slipif.h File Reference

SLIP netif API. More...

Go to the source code of this file.

Functions

err_t slipif_init (struct netif *netif)
 SLIP netif initialization.
void slipif_poll (struct netif *netif)
 Polls the serial device and feeds the IP layer with incoming packets.
void slipif_process_rxqueue (struct netif *netif)
 Feeds the IP layer with incoming packets that were receive.
void slipif_received_byte (struct netif *netif, u8_t data)
 Process a received byte, completed packets are put on a queue that is fed into IP through slipif_process_rxqueue().
void slipif_received_bytes (struct netif *netif, u8_t *data, u8_t len)
 Process multiple received byte, completed packets are put on a queue that is fed into IP through slipif_process_rxqueue().

Detailed Description

SLIP netif API.

Definition in file slipif.h.


Function Documentation

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:
netifthe 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.

Definition at line 361 of file lwip_slipif.c.

void slipif_poll ( struct netif netif )

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

Parameters:
netifThe lwip network interface structure for this slipif

Definition at line 427 of file lwip_slipif.c.

void slipif_process_rxqueue ( struct netif netif )

Feeds the IP layer with incoming packets that were receive.

Parameters:
netifThe lwip network interface structure for this slipif

Definition at line 449 of file lwip_slipif.c.

void slipif_received_byte ( struct netif netif,
u8_t  data 
)

Process a received byte, completed packets are put on a queue that is fed into IP through slipif_process_rxqueue().

This function can be called from ISR if SYS_LIGHTWEIGHT_PROT is enabled.

Parameters:
netifThe lwip network interface structure for this slipif
datareceived character

Definition at line 526 of file lwip_slipif.c.

void slipif_received_bytes ( struct netif netif,
u8_t *  data,
u8_t  len 
)

Process multiple received byte, completed packets are put on a queue that is fed into IP through slipif_process_rxqueue().

This function can be called from ISR if SYS_LIGHTWEIGHT_PROT is enabled.

Parameters:
netifThe lwip network interface structure for this slipif
datareceived character
lenNumber of received characters

Definition at line 544 of file lwip_slipif.c.