Atmel Software Framework

lwip-1.4.0/src/include/lwip/sio.h File Reference
#include "lwip/arch.h"

Typedefs

typedef void * sio_fd_t
 

Functions

sio_fd_t sio_open (u8_t devnum)
 Opens a serial device for communication. More...
 
u32_t sio_read (sio_fd_t fd, u8_t *data, u32_t len)
 Reads from the serial device. More...
 
void sio_read_abort (sio_fd_t fd)
 Aborts a blocking sio_read() call. More...
 
u8_t sio_recv (sio_fd_t fd)
 Receives a single character from the serial device. More...
 
void sio_send (u8_t c, sio_fd_t fd)
 Sends a single character to the serial device. More...
 
u32_t sio_tryread (sio_fd_t fd, u8_t *data, u32_t len)
 Tries to read from the serial device. More...
 
u32_t sio_write (sio_fd_t fd, u8_t *data, u32_t len)
 Writes to the serial device. More...
 

typedef void* sio_fd_t

sio_fd_t sio_open ( u8_t  devnum)

Opens a serial device for communication.

Parameters
devnumdevice number
Returns
handle to serial device if successful, NULL otherwise
u32_t sio_read ( sio_fd_t  fd,
u8_t data,
u32_t  len 
)

Reads from the serial device.

Parameters
fdserial device handle
datapointer to data buffer for receiving
lenmaximum length (in bytes) of data to receive
Returns
number of bytes actually received - may be 0 if aborted by sio_read_abort
Note
This function will block until data can be received. The blocking can be cancelled by calling sio_read_abort().
void sio_read_abort ( sio_fd_t  fd)

Aborts a blocking sio_read() call.

Parameters
fdserial device handle
u8_t sio_recv ( sio_fd_t  fd)

Receives a single character from the serial device.

Parameters
fdserial device handle
Note
This function will block until a character is received.
void sio_send ( u8_t  c,
sio_fd_t  fd 
)

Sends a single character to the serial device.

Parameters
ccharacter to send
fdserial device handle
Note
This function will block until the character can be sent.
u32_t sio_tryread ( sio_fd_t  fd,
u8_t data,
u32_t  len 
)

Tries to read from the serial device.

Same as sio_read but returns immediately if no data is available and never blocks.

Parameters
fdserial device handle
datapointer to data buffer for receiving
lenmaximum length (in bytes) of data to receive
Returns
number of bytes actually received
u32_t sio_write ( sio_fd_t  fd,
u8_t data,
u32_t  len 
)

Writes to the serial device.

Parameters
fdserial device handle
datapointer to data to send
lenlength (in bytes) of data to send
Returns
number of bytes actually sent
Note
This function will block until all data can be sent.