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

include/dev/uart.h File Reference


Detailed Description

UART I/O function prototypes.


Defines

#define UART_SETSPEED
 UART _ioctl() command code to set the line speed.

#define UART_GETSPEED
 UART _ioctl() command code to query the line speed.

#define UART_SETDATABITS
 UART _ioctl() command code to set the number of data bits.

#define UART_GETDATABITS
 UART _ioctl() command code to query the number of data bits.

#define UART_SETPARITY
 UART _ioctl() command code to set the parity mode.

#define UART_GETPARITY
 UART _ioctl() command code to query the parity mode.

#define UART_SETSTOPBITS
 UART _ioctl() command code to set the number of stop bits.

#define UART_GETSTOPBITS
 UART _ioctl() command code to query the number of stop bits.

#define UART_SETSTATUS
 UART _ioctl() command code to set the status.

#define UART_GETSTATUS
 UART _ioctl() command code to query the status.

#define UART_SETREADTIMEOUT
 UART _ioctl() command code to set the read timeout.

#define UART_GETREADTIMEOUT
 UART _ioctl() command code to query the read timeout.

#define UART_SETWRITETIMEOUT
 UART _ioctl() command code to set the write timeout.

#define UART_GETWRITETIMEOUT
 UART _ioctl() command code to query the write timeout.

#define UART_SETLOCALECHO
 UART _ioctl() command code to set the local echo mode.

#define UART_GETLOCALECHO
 UART _ioctl() command code to query the local echo mode.

#define UART_SETFLOWCONTROL
 UART _ioctl() command code to set the flow control mode.

#define UART_GETFLOWCONTROL
 UART _ioctl() command code to query the flow control mode.

#define UART_SETCOOKEDMODE
 UART _ioctl() command code to set the cooking mode.

#define UART_GETCOOKEDMODE
 UART _ioctl() command code to query the cooking mode.

#define UART_SETBUFFERMODE
 UART _ioctl() command code to set the buffering mode.

#define UART_GETBUFFERMODE
 UART _ioctl() command code to query the buffering mode.

#define HDLC_SETIFNET
 UART _ioctl() command code to set the network interface mode.

#define HDLC_GETIFNET
 UART _ioctl() command code to query the network interface mode.

#define UART_SETCLOCKMODE
 UART _ioctl() command code to set the clock mode.

#define UART_GETCLOCKMODE
 UART _ioctl() command code to query the clock mode.

#define UART_SETTXBUFSIZ
 UART _ioctl() command code to set the transmit buffer size.

#define UART_GETTXBUFSIZ
 UART _ioctl() command code to query the transmit buffer size.

#define UART_SETRXBUFSIZ
 UART _ioctl() command code to set the receive buffer size.

#define UART_GETRXBUFSIZ
 UART _ioctl() command code to query the receive buffer size.

#define UART_SETTXBUFLWMARK
 UART _ioctl() command code to set the transmit buffer low watermark.

#define UART_GETTXBUFLWMARK
 UART _ioctl() command code to query the transmit buffer low watermark.

#define UART_SETTXBUFHWMARK
 UART _ioctl() command code to set the transmit buffer high watermark.

#define UART_GETTXBUFHWMARK
 UART _ioctl() command code to query the transmit buffer high watermark.

#define UART_SETRXBUFLWMARK
 UART _ioctl() command code to set the receive buffer low watermark.

#define UART_GETRXBUFLWMARK
 UART _ioctl() command code to query the receive buffer low watermark.

#define UART_SETRXBUFHWMARK
 UART _ioctl() command code to set the receive buffer high watermark.

#define UART_GETRXBUFHWMARK
 UART _ioctl() command code to query the receive buffer high watermark.

#define UART_FRAMINGERROR
 Framing error.

#define UART_OVERRUNERROR
 Overrun error.

#define UART_PARITYERROR
 Parity error.

#define UART_ERRORS
 UART errors.

#define UART_RXBUFFEREMPTY
 Receiver buffer empty.

#define UART_TXBUFFEREMPTY
 Transmitter buffer empty.

#define UART_RTSENABLED
 RTS handshake output enabled.

#define UART_RTSDISABLED
 RTS handshake output disabled.

#define UART_CTSENABLED
 CTS handshake input enabled.

#define UART_CTSDISABLED
 CTS handshake input disabled.

#define UART_DTRENABLED
 DTR handshake output enabled.

#define UART_DTRDISABLED
 DTR handshake output disabled.

#define UART_RXENABLED
 Receiver enabled.

#define UART_RXDISABLED
 Receiver enabled.

#define UART_TXENABLED
 Transmitter enabled.

#define UART_TXDISABLED
 Transmitter enabled.

#define UART_RXADDRFRAME
 Receive address frames only.

#define UART_RXNORMFRAME
 Receive all frames.

#define UART_TXADDRFRAME
 Transmit as address frame.

#define UART_TXNORMFRAME
 Transmit as normal frame.

#define UART_HS_RTSCTS
 RTS / CTS hardware handshake.

#define UART_HS_MODEM
 Full modem hardware handshake.

#define UART_HS_SOFT
 XON / XOFF software handshake.

#define UART_SYNC
#define UART_MASTER
#define UART_NCLOCK
#define UART_HIGHSPEED
#define UART_ASYNC
 Normal asynchronous mode.

#define UART_SYNCSLAVE
 Synchronous slave mode.

#define UART_SYNCMASTER
 Synchronous master mode.

#define UART_NSYNCSLAVE
 Synchronous slave mode, clock negated.

#define UART_NSYNCMASTER
 Synchronous master mode, clock negated.

#define UART_ASYNC_HS
 Asynchronous high speed mode.


Functions

int UartAvrInit (NUTDEVICE *dev)
 Initialize on chip uart device.

int UartAvrIOCtl (NUTDEVICE *dev, int req, void *conf)
 Perform on-chip UART control functions.

int UartAvrInput (NUTDEVICE *dev)
 Wait for input.

int UartAvrOutput (NUTDEVICE *dev)
 Initiate output.

int UartAvrFlush (NUTDEVICE *dev)
 Wait for output buffer empty.

int UartAvrGetRaw (u_char *cp)
int UartAvrPutRaw (u_char ch)
int UartAvrRead (NUTFILE *fp, void *buffer, int size)
 Read from device.

int UartAvrWrite (NUTFILE *fp, CONST void *buffer, int len)
NUTFILEUartAvrOpen (NUTDEVICE *dev, CONST char *name, int mode, int acc)
 Open a device or file.

long UartAvrSize (NUTFILE *fp)
 Request file size.

int UartAvrClose (NUTFILE *fp)
 Close a device or file.


© 2000-2003 by egnite Software GmbH - visit http://www.ethernut.de/