Loading...
Searching...
No Matches
SLIP network device

SLIP network device over UART. More...

Detailed Description

SLIP network device over UART.

See also
RFC 1055

Modules

 SLIP Network driver compile configuration
 

Files

file  slipdev.h
 SLIP device definitions.
 
file  slipdev_internal.h
 
file  slipdev_params.h
 Default configuration for the SLIP device driver.
 

Data Structures

struct  slipdev_params_t
 Configuration parameters for a slipdev. More...
 
struct  slipdev_t
 Device descriptor for slipdev. More...
 

Functions

void slipdev_setup (slipdev_t *dev, const slipdev_params_t *params, uint8_t index)
 Setup a slipdev device state.
 

Device state definitions

enum  {
  SLIPDEV_STATE_NONE = 0 , SLIPDEV_STATE_NET , SLIPDEV_STATE_NET_ESC , SLIPDEV_STATE_STDIN ,
  SLIPDEV_STATE_STDIN_ESC , SLIPDEV_STATE_STANDBY , SLIPDEV_STATE_SLEEP
}
 

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
SLIPDEV_STATE_NONE 

Device is in no mode (currently did not receiving any data frame)

SLIPDEV_STATE_NET 

Device writes handles data as network device.

SLIPDEV_STATE_NET_ESC 

Device writes handles data as network device, next byte is escaped.

SLIPDEV_STATE_STDIN 

Device writes received data to stdin.

SLIPDEV_STATE_STDIN_ESC 

Device writes received data to stdin, next byte is escaped.

SLIPDEV_STATE_STANDBY 

Device is in standby, will wake up when sending data.

SLIPDEV_STATE_SLEEP 

Device is in sleep mode.

Definition at line 75 of file slipdev.h.

Function Documentation

◆ slipdev_setup()

void slipdev_setup ( slipdev_t dev,
const slipdev_params_t params,
uint8_t  index 
)

Setup a slipdev device state.

Parameters
[in]devdevice descriptor
[in]paramsparameters for device initialization
[in]indexindex of params in a global parameter struct array. If initialized manually, pass a unique identifier instead.