Nut/OS  4.10.3
API Reference
uart.h File Reference

UART I/O function prototypes. More...

#include <sys/device.h>
Include dependency graph for uart.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Defines

#define UART_SETSPEED   0x0101
 UART _ioctl() command code to set the line speed.
#define UART_GETSPEED   0x0102
 UART _ioctl() command code to query the line speed.
#define UART_SETDATABITS   0x0103
 UART _ioctl() command code to set the number of data bits.
#define UART_GETDATABITS   0x0104
 UART _ioctl() command code to query the number of data bits.
#define UART_SETPARITY   0x0105
 UART _ioctl() command code to set the parity mode.
#define UART_GETPARITY   0x0106
 UART _ioctl() command code to query the parity mode.
#define UART_SETSTOPBITS   0x0107
 UART _ioctl() command code to set the number of stop bits.
#define UART_GETSTOPBITS   0x0108
 UART _ioctl() command code to query the number of stop bits.
#define UART_SETSTATUS   0x0109
 UART _ioctl() command code to set the status.
#define UART_GETSTATUS   0x010a
 UART _ioctl() command code to query the status.
#define UART_SETREADTIMEOUT   0x010b
 UART _ioctl() command code to set the read timeout.
#define UART_GETREADTIMEOUT   0x010c
 UART _ioctl() command code to query the read timeout.
#define UART_SETWRITETIMEOUT   0x010d
 UART _ioctl() command code to set the write timeout.
#define UART_GETWRITETIMEOUT   0x010e
 UART _ioctl() command code to query the write timeout.
#define UART_SETLOCALECHO   0x010f
 UART _ioctl() command code to set the local echo mode.
#define UART_GETLOCALECHO   0x0110
 UART _ioctl() command code to query the local echo mode.
#define UART_SETFLOWCONTROL   0x0111
 UART _ioctl() command code to set the flow control mode.
#define UART_GETFLOWCONTROL   0x0112
 UART _ioctl() command code to query the flow control mode.
#define UART_SETCOOKEDMODE   0x0113
 UART _ioctl() command code to set the cooking mode.
#define UART_GETCOOKEDMODE   0x0114
 UART _ioctl() command code to query the cooking mode.
#define UART_SETBUFFERMODE   0x0115
 UART _ioctl() command code to set the buffering mode.
#define UART_GETBUFFERMODE   0x0116
 UART _ioctl() command code to query the buffering mode.
#define HDLC_SETIFNET   0x0117
 UART _ioctl() command code to set the network interface mode.
#define HDLC_GETIFNET   0x0118
 UART _ioctl() command code to query the network interface mode.
#define UART_SETCLOCKMODE   0x0119
 UART _ioctl() command code to set the clock mode.
#define UART_GETCLOCKMODE   0x011a
 UART _ioctl() command code to query the clock mode.
#define UART_SETTXBUFSIZ   0x011b
 UART _ioctl() command code to set the transmit buffer size.
#define UART_GETTXBUFSIZ   0x011c
 UART _ioctl() command code to query the transmit buffer size.
#define UART_SETRXBUFSIZ   0x011d
 UART _ioctl() command code to set the receive buffer size.
#define UART_GETRXBUFSIZ   0x011e
 UART _ioctl() command code to query the receive buffer size.
#define UART_SETTXBUFLWMARK   0x0120
 UART _ioctl() command code to set the transmit buffer low watermark.
#define UART_GETTXBUFLWMARK   0x0121
 UART _ioctl() command code to query the transmit buffer low watermark.
#define UART_SETTXBUFHWMARK   0x0122
 UART _ioctl() command code to set the transmit buffer high watermark.
#define UART_GETTXBUFHWMARK   0x0123
 UART _ioctl() command code to query the transmit buffer high watermark.
#define UART_SETRXBUFLWMARK   0x0124
 UART _ioctl() command code to set the receive buffer low watermark.
#define UART_GETRXBUFLWMARK   0x0125
 UART _ioctl() command code to query the receive buffer low watermark.
#define UART_SETRXBUFHWMARK   0x0126
 UART _ioctl() command code to set the receive buffer high watermark.
#define UART_GETRXBUFHWMARK   0x0127
 UART _ioctl() command code to query the receive buffer high watermark.
#define UART_SETBLOCKREAD   0x0128
 UART _ioctl() command code to set the block read mode.
#define UART_GETBLOCKREAD   0x0129
 UART _ioctl() command code to query the receive buffer high watermark.
#define UART_SETRAWMODE   0x012a
 UART _ioctl() command code to set physical device to the raw mode.
#define UART_GETRAWMODE   0x012b
 UART _ioctl() command code to query the raw mode.
#define HDLC_SETTXACCM   0x012c
 AHDLC _ioctl() command code to set the ACCM (Control Character Mask).
#define HDLC_GETTXACCM   0x012d
 AHDLC _ioctl() command code to get the ACCM (Control Character Mask).
#define UART_SETHDPXMODE   0x012c
 UART _ioctl() command code to set physical device to half duplex mode.
#define UART_GETHDPXMODE   0x012d
 UART _ioctl() command code to query the halfduplex mode.
#define UART_FRAMINGERROR   0x00000001UL
 Framing error.
#define UART_OVERRUNERROR   0x00000002UL
 Overrun error.
#define UART_PARITYERROR   0x00000004UL
 Parity error.
#define UART_ERRORS   (UART_FRAMINGERROR | UART_OVERRUNERROR | UART_PARITYERROR)
 UART errors.
#define UART_RXBUFFEREMPTY   0x00000040UL
 Receiver buffer empty.
#define UART_TXBUFFEREMPTY   0x00000080UL
 Transmitter buffer empty.
#define UART_RTSENABLED   0x00000100UL
 RTS handshake output enabled.
#define UART_RTSDISABLED   0x00000200UL
 RTS handshake output disabled.
#define UART_CTSENABLED   0x00000400UL
 CTS handshake input enabled.
#define UART_CTSDISABLED   0x00000800UL
 CTS handshake input disabled.
#define UART_DTRENABLED   0x00001000UL
 DTR handshake output enabled.
#define UART_DTRDISABLED   0x00002000UL
 DTR handshake output disabled.
#define UART_RXENABLED   0x00010000UL
 Receiver enabled.
#define UART_RXDISABLED   0x00020000UL
 Receiver enabled.
#define UART_TXENABLED   0x00040000UL
 Transmitter enabled.
#define UART_TXDISABLED   0x00080000UL
 Transmitter enabled.
#define UART_RXADDRFRAME   0x00100000UL
 Receive address frames only.
#define UART_RXNORMFRAME   0x00200000UL
 Receive all frames.
#define UART_TXADDRFRAME   0x00400000UL
 Transmit as address frame.
#define UART_TXNORMFRAME   0x00800000UL
 Transmit as normal frame.
#define UART_HS_RTSCTS   0x0003
 RTS / CTS hardware handshake.
#define UART_HS_MODEM   0x001F
 Full modem hardware handshake.
#define UART_HS_SOFT   0x0020
 XON / XOFF software handshake.
#define UART_HS_HALFDUPLEX   0x0400
 Half duplex mode.
#define UART_SYNC   0x01
#define UART_MASTER   0x02
#define UART_NCLOCK   0x04
#define UART_HIGHSPEED   0x20
#define UART_ASYNC   0x00
 Normal asynchronous mode.
#define UART_SYNCSLAVE   UART_SYNC
 Synchronous slave mode.
#define UART_SYNCMASTER   (UART_SYNC | UART_MASTER)
 Synchronous master mode.
#define UART_NSYNCSLAVE   (UART_SYNC | UART_NCLOCK)
 Synchronous slave mode, clock negated.
#define UART_NSYNCMASTER   (UART_SYNC | UART_NCLOCK | UART_MASTER)
 Synchronous master mode, clock negated.
#define UART_ASYNC_HS   UART_HIGHSPEED
 Asynchronous high speed mode.

Detailed Description

UART I/O function prototypes.

Definition in file uart.h.