Nut/OS  4.10.3
API Reference
UART Status

UART device status flags,. More...

Collaboration diagram for UART Status:

Defines

#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.

Detailed Description

UART device status flags,.

A combination of these status flags is used by the _ioctl() commands UART_SETSTATUS and UART_GETSTATUS.


Define Documentation

#define UART_FRAMINGERROR   0x00000001UL

Framing error.

UART_SETSTATUS will clear this error.

Definition at line 411 of file uart.h.

#define UART_OVERRUNERROR   0x00000002UL

Overrun error.

UART_SETSTATUS will clear this error.

Definition at line 417 of file uart.h.

#define UART_PARITYERROR   0x00000004UL

Parity error.

UART_SETSTATUS will clear this error.

Definition at line 423 of file uart.h.

#define UART_ERRORS   (UART_FRAMINGERROR | UART_OVERRUNERROR | UART_PARITYERROR)

UART errors.

UART_SETSTATUS will clear all errors.

Definition at line 429 of file uart.h.

#define UART_RXBUFFEREMPTY   0x00000040UL

Receiver buffer empty.

Definition at line 433 of file uart.h.

Referenced by UsartIOCtl().

#define UART_TXBUFFEREMPTY   0x00000080UL

Transmitter buffer empty.

UART_SETSTATUS will immediately clear the buffer. It will not wait until the remaining characters have been transmitted.

Definition at line 440 of file uart.h.

Referenced by UsartIOCtl().

#define UART_RTSENABLED   0x00000100UL

RTS handshake output enabled.

Definition at line 444 of file uart.h.

#define UART_RTSDISABLED   0x00000200UL

RTS handshake output disabled.

Definition at line 448 of file uart.h.

Referenced by UsartClose().

#define UART_CTSENABLED   0x00000400UL

CTS handshake input enabled.

Definition at line 452 of file uart.h.

#define UART_CTSDISABLED   0x00000800UL

CTS handshake input disabled.

Definition at line 456 of file uart.h.

#define UART_DTRENABLED   0x00001000UL

DTR handshake output enabled.

Definition at line 460 of file uart.h.

#define UART_DTRDISABLED   0x00002000UL

DTR handshake output disabled.

Definition at line 464 of file uart.h.

#define UART_RXENABLED   0x00010000UL

Receiver enabled.

Definition at line 468 of file uart.h.

#define UART_RXDISABLED   0x00020000UL

Receiver enabled.

Definition at line 472 of file uart.h.

#define UART_TXENABLED   0x00040000UL

Transmitter enabled.

Definition at line 476 of file uart.h.

#define UART_TXDISABLED   0x00080000UL

Transmitter enabled.

Definition at line 480 of file uart.h.

#define UART_RXADDRFRAME   0x00100000UL

Receive address frames only.

Used in multidrop communication. May only work if 9 databits have been configured.

Definition at line 487 of file uart.h.

#define UART_RXNORMFRAME   0x00200000UL

Receive all frames.

Used in multidrop communication.

Definition at line 493 of file uart.h.

#define UART_TXADDRFRAME   0x00400000UL

Transmit as address frame.

Used in multidrop communication. May only work if 9 databits have been configured.

Definition at line 500 of file uart.h.

#define UART_TXNORMFRAME   0x00800000UL

Transmit as normal frame.

Used in multidrop communication.

Definition at line 506 of file uart.h.