Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages | Examples

include/dev/usart.h File Reference

Detailed Description

Synchronous/asynchronous serial device definitions.


Ring Buffer

#define USART_RXBUFSIZ   256
 Initial receive buffer size.
#define USART_RXHIWMARK   240
 Receiver's initial high water mark.
#define USART_RXLOWMARK   208
 Receiver's initial low water mark.
#define USART_TXBUFSIZ   64
 Initial transmit buffer size.
#define USART_TXHIWMARK   56
 Transmitter's initial high water mark.
#define USART_TXLOWMARK   40
 Transmitter's initial low water mark.
typedef _RINGBUF RINGBUF
 Character device ring buffer type.

Initial UART Configuration

#define USART_INITSPEED   115200
 Initial bit rate.

Function Prototypes

int UsartInit (NUTDEVICE *dev)
 Initialize the USART device.
int UsartIOCtl (NUTDEVICE *dev, int req, void *conf)
 Perform USART control functions.
int UsartRead (NUTFILE *fp, void *buffer, int size)
 Read from device.
int UsartWrite (NUTFILE *fp, CONST void *buffer, int len)
 Write a device or file.
NUTFILE * UsartOpen (NUTDEVICE *dev, CONST char *name, int mode, int acc)
 Open an USART device.
int UsartClose (NUTFILE *fp)
 Close an USART device.
long UsartSize (NUTFILE *fp)
 Retrieves the number of characters in input buffer.

Defines

#define USART_MF_RTSCONTROL
#define USART_MF_CTSSENSE
#define USART_MF_DTRCONTROL
#define USART_MF_DSRSENSE
#define USART_MF_DCDSENSE
#define USART_MF_SENSEMASK
#define USART_MF_CONTROLMASK
#define USART_MF_XONXOFF
 Software handshake.
#define USART_MF_LOCALECHO
#define USART_MF_COOKEDMODE
#define USART_MF_NOBUFFER
#define USART_MF_LINEBUFFER
#define USART_MF_BUFFERMASK
#define USART_MF_HALFDUPLEX
#define USART_MF_BLOCKREAD
#define USART_SF_RTSOFF
#define USART_SF_CTSOFF
#define USART_SF_DTROFF
#define USART_SF_DSROFF
#define USART_SF_DCDOFF
#define USART_SF_TXDISABLED
#define USART_SF_RXDISABLED

Typedefs

typedef _USARTDCB USARTDCB