hal_sio.h File Reference

SIO Driver macros and structures. More...

#include "hal_sio_lld.h"

Go to the source code of this file.

Macros
#define	sioGetFlagsX(siop)   sio_lld_get_flags(siop)
	Returns the current set of flags and clears it. More...
#define	sioRXIsEmptyX(siop)   sio_lld_rx_is_empty(siop)
	Determines the state of the RX FIFO. More...
#define	sioTXIsFullX(siop)   sio_lld_tx_is_full(siop)
	Determines the state of the TX FIFO. More...
#define	sioRXGetX(siop)   sio_lld_rx_get(siop)
	Returns one frame from the RX FIFO. More...
#define	sioTXPutX(siop, data)   sio_lld_tx_put(siop, data)
	Pushes one frame into the TX FIFO. More...
#define	sioReadX(siop, buffer, size)   sio_lld_read(siop, buffer, size)
	Reads data from the RX FIFO. More...
#define	sioWriteX(siop, buffer, size)   sio_lld_write(siop, buffer, size)
	Writes data into the TX FIFO. More...
#define	sioControlX(siop, operation, arg)   sio_lld_control(siop, operation, arg)
	Control operation on a serial port. More...
SIO status flags
#define	SIO_NO_ERROR   0
	No pending conditions. More...
#define	SIO_PARITY_ERROR   4
	Parity error happened. More...
#define	SIO_FRAMING_ERROR   8
	Framing error happened. More...
#define	SIO_OVERRUN_ERROR   16
	Overflow happened. More...
#define	SIO_NOISE_ERROR   32
	Noise on the line. More...
#define	SIO_BREAK_DETECTED   64
	Break detected. More...

Typedefs
typedef struct hal_sio_driver	SIODriver
	Type of structure representing a SIO driver. More...
typedef struct hal_sio_config	SIOConfig
	Type of structure representing a SIO configuration. More...

Enumerations
enum	siostate_t { SIO_UNINIT = 0, SIO_STOP = 1, SIO_READY = 2 }
	Driver state machine possible states. More...

Functions
void	sioInit (void)
	SIO Driver initialization. More...
void	sioObjectInit (SIODriver *siop)
	Initializes the standard part of a SIODriver structure. More...
void	sioStart (SIODriver *siop, const SIOConfig *config)
	Configures and activates the SIO peripheral. More...
void	sioStop (SIODriver *siop)
	Deactivates the SIO peripheral. More...

Detailed Description

SIO Driver macros and structures.

Definition in file hal_sio.h.