Nut/OS  4.10.3
API Reference
TLC16C550

TLC16C550 UART driver. More...

Collaboration diagram for TLC16C550:

Data Structures

struct  _ACEDCB
 ACE device control block structure. More...

Modules

 XgACEStatus
 

ACE device status flags,.


 XgACEHS
 

ACE handshake modes.


Defines

#define ACE_SETSPEED   0x0101
 ACE _ioctl() command code to set the line speed.
#define ACE_GETSPEED   0x0102
 ACE _ioctl() command code to query the line speed.
#define ACE_SETDATABITS   0x0103
 ACE _ioctl() command code to set the number of data bits.
#define ACE_GETDATABITS   0x0104
 ACE _ioctl() command code to query the number of data bits.
#define ACE_SETPARITY   0x0105
 ACE _ioctl() command code to set the parity mode.
#define ACE_GETPARITY   0x0106
 ACE _ioctl() command code to query the parity mode.
#define ACE_SETSTOPBITS   0x0107
 ACE _ioctl() command code to set the number of stop bits.
#define ACE_GETSTOPBITS   0x0108
 ACE _ioctl() command code to query the number of stop bits.
#define ACE_SETSTATUS   0x0109
 ACE _ioctl() command code to set the status.
#define ACE_GETSTATUS   0x010a
 ACE _ioctl() command code to query the status.
#define ACE_SETREADTIMEOUT   0x010b
 ACE _ioctl() command code to set the read timeout.
#define ACE_GETREADTIMEOUT   0x010c
 ACE _ioctl() command code to query the read timeout.
#define ACE_SETWRITETIMEOUT   0x010d
 ACE _ioctl() command code to set the write timeout.
#define ACE_GETWRITETIMEOUT   0x010e
 ACE _ioctl() command code to query the write timeout.
#define ACE_SETLOCALECHO   0x010f
 ACE _ioctl() command code to set the local echo mode.
#define ACE_GETLOCALECHO   0x0110
 ACE _ioctl() command code to query the local echo mode.
#define ACE_SETFLOWCONTROL   0x0111
 ACE _ioctl() command code to set the flow control mode.
#define ACE_GETFLOWCONTROL   0x0112
 ACE _ioctl() command code to query the flow control mode.
#define ACE_SETCOOKEDMODE   0x0113
 ACE _ioctl() command code to set the cooking mode.
#define ACE_GETCOOKEDMODE   0x0114
 ACE _ioctl() command code to query the cooking mode.
#define ACE_SETBUFFERMODE   0x0115
 ACE _ioctl() command code to set the buffering mode.
#define ACE_GETBUFFERMODE   0x0116
 ACE _ioctl() command code to query the buffering mode.
#define ACE_SETTXBUFSIZ   0x011b
 ACE _ioctl() command code to set the transmit buffer size.
#define ACE_GETTXBUFSIZ   0x011c
 ACE _ioctl() command code to query the transmit buffer size.
#define ACE_SETRXBUFSIZ   0x011d
 ACE _ioctl() command code to set the receive buffer size.
#define ACE_GETRXBUFSIZ   0x011e
 ACE _ioctl() command code to query the receive buffer size.
#define ACE_SETTXBUFLWMARK   0x0120
 ACE _ioctl() command code to set the transmit buffer low watermark.
#define ACE_GETTXBUFLWMARK   0x0121
 ACE _ioctl() command code to query the transmit buffer low watermark.
#define ACE_SETTXBUFHWMARK   0x0122
 ACE _ioctl() command code to set the transmit buffer high watermark.
#define ACE_GETTXBUFHWMARK   0x0123
 ACE _ioctl() command code to query the transmit buffer high watermark.
#define ACE_SETRXBUFLWMARK   0x0124
 ACE _ioctl() command code to set the receive buffer low watermark.
#define ACE_GETRXBUFLWMARK   0x0125
 ACE _ioctl() command code to query the receive buffer low watermark.
#define ACE_SETRXBUFHWMARK   0x0126
 ACE _ioctl() command code to set the receive buffer high watermark.
#define ACE_GETRXBUFHWMARK   0x0127
 ACE _ioctl() command code to query the receive buffer high watermark.
#define ACE_SETBLOCKREAD   0x0128
 ACE _ioctl() command code to set the block read mode.
#define ACE_GETBLOCKREAD   0x0129
 ACE _ioctl() command code to query the receive buffer high watermark.
#define ACE_SETFIFO   0x012a
 ACE _ioctl() command code to set the fifo mode and receive fifo trigger level.
#define ACE_GETFIFO   0x012b
 ACE _ioctl() command code to query the fifo mode and receive fifo trigger level.
#define ACE_MF_RTSSENSE   0x00000001UL
#define ACE_MF_CTSCONTROL   0x00000002UL
#define ACE_MF_DTRSENSE   0x00000004UL
#define ACE_MF_DSRCONTROL   0x00000008UL
#define ACE_MF_DCDCONTROL   0x00000010UL
#define ACE_MF_RTSCONTROL   0x00000020UL
#define ACE_MF_CTSSENSE   0x00000040UL
#define ACE_MF_DTRCONTROL   0x00000080UL
#define ACE_MF_DSRSENSE   0x00000100UL
#define ACE_MF_DCDSENSE   0x00000200UL
#define ACE_MF_SENSEMASK   0x0345
#define ACE_MF_CONTROLMASK   0x00BC
#define ACE_MF_XONXOFF   0x00000400UL
#define ACE_MF_HALFDUPLEX   0x00000800UL
#define ACE_MF_LOCALECHO   0x00010000UL
#define ACE_MF_COOKEDMODE   0x00020000UL
#define ACE_MF_NOBUFFER   0x00100000UL
#define ACE_MF_LINEBUFFER   0x00200000UL
#define ACE_MF_BUFFERMASK   0x00300000UL
#define ACE_SF_RTSOFF   0x00000001UL
#define ACE_SF_CTSOFF   0x00000002UL
#define ACE_SF_DTROFF   0x00000004UL
#define ACE_SF_DSROFF   0x00000008UL
#define ACE_SF_DCDOFF   0x00000010UL
#define ACE_SF_TXDISABLED   0x00000040UL
#define ACE_SF_RXDISABLED   0x00000080UL
#define ACE_HS_DCERTSCTS   0x00000003UL
#define ACE_HS_DCEFULL   0x0000001FUL
#define ACE_HS_DTERTSCTS   0x00000060UL
#define ACE_HS_DTEFULL   0x000003E0UL
#define ACE_HS_XONXOFF   0x00000400UL
#define ACE_CLOCK   14745600UL
#define ACE_FIFO_SIZE   16

Typedefs

typedef struct _ACEDCB ACEDCB

Detailed Description

TLC16C550 UART driver.

ACE _ioctl() commands.

These commands are used to control and retrieve hardware specific configurations. The definitions are kept independent from the underlying hardware, but not all commands may be fully implemented in each ACE driver.

The _ioctl() function expects three parameters:


Define Documentation

#define ACE_SETSPEED   0x0101

ACE _ioctl() command code to set the line speed.

The configuration parameter specifies the input and output bit rate per second.

Definition at line 83 of file ace.h.

Referenced by AceInit(), and AceIOCtl().

#define ACE_GETSPEED   0x0102

ACE _ioctl() command code to query the line speed.

The configuration parameter is set to the input and output bit rate per second.

Definition at line 90 of file ace.h.

Referenced by AceIOCtl().

#define ACE_SETDATABITS   0x0103

ACE _ioctl() command code to set the number of data bits.

The configuration parameter specifies the number of data bits, 5, 6, 7, 8 or 9.

Definition at line 97 of file ace.h.

Referenced by AceInit(), and AceIOCtl().

#define ACE_GETDATABITS   0x0104

ACE _ioctl() command code to query the number of data bits.

The configuration parameter is set to the number of data bits, 5, 6, 7, 8 or 9.

Definition at line 104 of file ace.h.

Referenced by AceIOCtl().

#define ACE_SETPARITY   0x0105

ACE _ioctl() command code to set the parity mode.

The configuration parameter specifies the type of the parity bit, 0 (none), 1 (odd), 2 (even), 3 (mark) or 4 (space).

Definition at line 111 of file ace.h.

Referenced by AceInit(), and AceIOCtl().

#define ACE_GETPARITY   0x0106

ACE _ioctl() command code to query the parity mode.

The configuration parameter is set to the type of the parity bit, 0 (none), 1 (odd), 2 (even), 3 (mark) or 4 (space).

Definition at line 118 of file ace.h.

Referenced by AceIOCtl().

#define ACE_SETSTOPBITS   0x0107

ACE _ioctl() command code to set the number of stop bits.

The configuration parameter specifies the number of stop bits, 1 or 2.

Definition at line 124 of file ace.h.

Referenced by AceInit(), and AceIOCtl().

#define ACE_GETSTOPBITS   0x0108

ACE _ioctl() command code to query the number of stop bits.

The configuration parameter is set to the number of stop bits, 1 or 2.

Definition at line 130 of file ace.h.

Referenced by AceIOCtl().

#define ACE_SETSTATUS   0x0109

ACE _ioctl() command code to set the status.

The configuration parameter specifies the status to set.

Definition at line 136 of file ace.h.

Referenced by AceIOCtl().

#define ACE_GETSTATUS   0x010a

ACE _ioctl() command code to query the status.

The configuration parameter is set to the current status.

Definition at line 142 of file ace.h.

Referenced by AceIOCtl().

#define ACE_SETREADTIMEOUT   0x010b

ACE _ioctl() command code to set the read timeout.

The configuration parameter specifies the read timeout in milliseconds.

Definition at line 149 of file ace.h.

Referenced by AceIOCtl().

#define ACE_GETREADTIMEOUT   0x010c

ACE _ioctl() command code to query the read timeout.

The configuration parameter is set to the read timeout in milliseconds.

Definition at line 156 of file ace.h.

Referenced by AceIOCtl().

#define ACE_SETWRITETIMEOUT   0x010d

ACE _ioctl() command code to set the write timeout.

The configuration parameter specifies the write timeout in milliseconds.

Definition at line 163 of file ace.h.

Referenced by AceIOCtl().

#define ACE_GETWRITETIMEOUT   0x010e

ACE _ioctl() command code to query the write timeout.

The configuration parameter is set to the write timeout in milliseconds.

Definition at line 170 of file ace.h.

Referenced by AceIOCtl().

#define ACE_SETLOCALECHO   0x010f

ACE _ioctl() command code to set the local echo mode.

The configuration parameter specifies the local echo mode, 0 (off) or 1 (on).

Definition at line 177 of file ace.h.

Referenced by AceIOCtl().

#define ACE_GETLOCALECHO   0x0110

ACE _ioctl() command code to query the local echo mode.

The configuration parameter is set to the local echo mode, 0 (off) or 1 (on).

Definition at line 184 of file ace.h.

Referenced by AceIOCtl().

#define ACE_SETFLOWCONTROL   0x0111

ACE _ioctl() command code to set the flow control mode.

The configuration parameter specifies the flow control mode.

Definition at line 190 of file ace.h.

Referenced by AceInit(), and AceIOCtl().

#define ACE_GETFLOWCONTROL   0x0112

ACE _ioctl() command code to query the flow control mode.

The configuration parameter is set to the flow control mode.

Definition at line 196 of file ace.h.

Referenced by AceIOCtl().

#define ACE_SETCOOKEDMODE   0x0113

ACE _ioctl() command code to set the cooking mode.

The configuration parameter specifies the character cooking mode, 0 (raw) or 1 (EOL translation).

Definition at line 203 of file ace.h.

Referenced by AceIOCtl().

#define ACE_GETCOOKEDMODE   0x0114

ACE _ioctl() command code to query the cooking mode.

The configuration parameter is set to the character cooking mode, 0 (raw) or 1 (EOL translation).

Definition at line 210 of file ace.h.

Referenced by AceIOCtl().

#define ACE_SETBUFFERMODE   0x0115

ACE _ioctl() command code to set the buffering mode.

The configuration parameter specifies the buffering mode.

Definition at line 216 of file ace.h.

#define ACE_GETBUFFERMODE   0x0116

ACE _ioctl() command code to query the buffering mode.

The configuration parameter is set to the buffering mode.

Definition at line 222 of file ace.h.

#define ACE_SETTXBUFSIZ   0x011b

ACE _ioctl() command code to set the transmit buffer size.

The configuration parameter specifies the number of bytes.

Definition at line 228 of file ace.h.

#define ACE_GETTXBUFSIZ   0x011c

ACE _ioctl() command code to query the transmit buffer size.

The configuration parameter specifies the number of bytes.

Definition at line 234 of file ace.h.

#define ACE_SETRXBUFSIZ   0x011d

ACE _ioctl() command code to set the receive buffer size.

The configuration parameter specifies the number of bytes.

Definition at line 240 of file ace.h.

#define ACE_GETRXBUFSIZ   0x011e

ACE _ioctl() command code to query the receive buffer size.

The configuration parameter specifies the number of bytes.

Definition at line 246 of file ace.h.

#define ACE_SETTXBUFLWMARK   0x0120

ACE _ioctl() command code to set the transmit buffer low watermark.

The configuration parameter specifies the number of bytes.

Definition at line 252 of file ace.h.

#define ACE_GETTXBUFLWMARK   0x0121

ACE _ioctl() command code to query the transmit buffer low watermark.

The configuration parameter specifies the number of bytes.

Definition at line 258 of file ace.h.

#define ACE_SETTXBUFHWMARK   0x0122

ACE _ioctl() command code to set the transmit buffer high watermark.

The configuration parameter specifies the number of bytes.

Definition at line 264 of file ace.h.

#define ACE_GETTXBUFHWMARK   0x0123

ACE _ioctl() command code to query the transmit buffer high watermark.

The configuration parameter specifies the number of bytes.

Definition at line 270 of file ace.h.

#define ACE_SETRXBUFLWMARK   0x0124

ACE _ioctl() command code to set the receive buffer low watermark.

The configuration parameter specifies the number of bytes.

Definition at line 276 of file ace.h.

#define ACE_GETRXBUFLWMARK   0x0125

ACE _ioctl() command code to query the receive buffer low watermark.

The configuration parameter specifies the number of bytes.

Definition at line 282 of file ace.h.

#define ACE_SETRXBUFHWMARK   0x0126

ACE _ioctl() command code to set the receive buffer high watermark.

The configuration parameter specifies the number of bytes.

Definition at line 288 of file ace.h.

#define ACE_GETRXBUFHWMARK   0x0127

ACE _ioctl() command code to query the receive buffer high watermark.

The configuration parameter specifies the number of bytes.

Definition at line 294 of file ace.h.

#define ACE_SETBLOCKREAD   0x0128

ACE _ioctl() command code to set the block read mode.

The configuration parameter specifies the block read mode

Definition at line 300 of file ace.h.

#define ACE_GETBLOCKREAD   0x0129

ACE _ioctl() command code to query the receive buffer high watermark.

The configuration parameter specifies the block read mode

Definition at line 306 of file ace.h.

#define ACE_SETFIFO   0x012a

ACE _ioctl() command code to set the fifo mode and receive fifo trigger level.

The configuration parameter specifies the receive fifo trigger level (x,1,4,8,14), x - disables fifo

Definition at line 312 of file ace.h.

Referenced by AceIOCtl().

#define ACE_GETFIFO   0x012b

ACE _ioctl() command code to query the fifo mode and receive fifo trigger level.

The configuration parameter specifies the receive fifo trigger level (x,1,4,8,14), x - fifo is disabled

Definition at line 318 of file ace.h.

Referenced by AceIOCtl().

#define ACE_MF_RTSSENSE   0x00000001UL

DCE input, low on port bit is +12V, which means ON.

Definition at line 82 of file tlc16c550.h.

#define ACE_MF_CTSCONTROL   0x00000002UL

DCE output.

Definition at line 83 of file tlc16c550.h.

#define ACE_MF_DTRSENSE   0x00000004UL

DCE input.

Definition at line 84 of file tlc16c550.h.

#define ACE_MF_DSRCONTROL   0x00000008UL

DCE output.

Definition at line 85 of file tlc16c550.h.

#define ACE_MF_DCDCONTROL   0x00000010UL

DCE output.

Definition at line 86 of file tlc16c550.h.

#define ACE_MF_RTSCONTROL   0x00000020UL

DTE output.

Definition at line 88 of file tlc16c550.h.

#define ACE_MF_CTSSENSE   0x00000040UL

DTE input.

Definition at line 89 of file tlc16c550.h.

#define ACE_MF_DTRCONTROL   0x00000080UL

DTE output.

Definition at line 90 of file tlc16c550.h.

#define ACE_MF_DSRSENSE   0x00000100UL

DTE input.

Definition at line 91 of file tlc16c550.h.

#define ACE_MF_DCDSENSE   0x00000200UL

DTE input.

Definition at line 92 of file tlc16c550.h.

#define ACE_MF_SENSEMASK   0x0345

Handshake sense mask.

Definition at line 94 of file tlc16c550.h.

#define ACE_MF_CONTROLMASK   0x00BC

Handshake control mask.

Definition at line 95 of file tlc16c550.h.

#define ACE_MF_XONXOFF   0x00000400UL

Software handshake.

Definition at line 97 of file tlc16c550.h.

#define ACE_MF_HALFDUPLEX   0x00000800UL

Half duplex bit control

Definition at line 99 of file tlc16c550.h.

Referenced by AceIOCtl(), and AceOutput().

#define ACE_MF_LOCALECHO   0x00010000UL

Should be used in stream, not device.

Definition at line 101 of file tlc16c550.h.

Referenced by AceIOCtl().

#define ACE_MF_COOKEDMODE   0x00020000UL

Should be used in stream, not device.

Definition at line 102 of file tlc16c550.h.

Referenced by AceIOCtl(), AceOpen(), AcePut(), and AceRead().

#define ACE_MF_NOBUFFER   0x00100000UL

No buffering.

Definition at line 104 of file tlc16c550.h.

Referenced by AceInit(), and AcePut().

#define ACE_MF_LINEBUFFER   0x00200000UL

Line buffered.

Definition at line 105 of file tlc16c550.h.

Referenced by AcePut().

#define ACE_MF_BUFFERMASK   0x00300000UL

Masks buffering mode flags.

Definition at line 106 of file tlc16c550.h.

#define ACE_SF_RTSOFF   0x00000001UL

Set RTS line is off.

Definition at line 109 of file tlc16c550.h.

#define ACE_SF_CTSOFF   0x00000002UL

Set CTS line is off.

Definition at line 110 of file tlc16c550.h.

#define ACE_SF_DTROFF   0x00000004UL

Set DTR line is off.

Definition at line 111 of file tlc16c550.h.

#define ACE_SF_DSROFF   0x00000008UL

Set DSR line is off.

Definition at line 112 of file tlc16c550.h.

#define ACE_SF_DCDOFF   0x00000010UL

Set DCD line is off.

Definition at line 113 of file tlc16c550.h.

#define ACE_SF_TXDISABLED   0x00000040UL

Transmitter disabled.

Definition at line 115 of file tlc16c550.h.

#define ACE_SF_RXDISABLED   0x00000080UL

Receiver disabled.

Definition at line 116 of file tlc16c550.h.

#define ACE_HS_DCERTSCTS   0x00000003UL

RTS/CTS DCE handshake.

Definition at line 118 of file tlc16c550.h.

#define ACE_HS_DCEFULL   0x0000001FUL

Full DCE handshake.

Definition at line 119 of file tlc16c550.h.

#define ACE_HS_DTERTSCTS   0x00000060UL

RTS/CTS DTE handshake.

Definition at line 121 of file tlc16c550.h.

#define ACE_HS_DTEFULL   0x000003E0UL

Full DTE handshake.

Definition at line 122 of file tlc16c550.h.

#define ACE_HS_XONXOFF   0x00000400UL

Software handshake.

Definition at line 124 of file tlc16c550.h.

#define ACE_CLOCK   14745600UL

Definition at line 127 of file tlc16c550.h.

Referenced by AceIOCtl().

#define ACE_FIFO_SIZE   16

Definition at line 130 of file tlc16c550.h.

Referenced by AceIOCtl().


Typedef Documentation

typedef struct _ACEDCB ACEDCB

ACE device control block type.

Definition at line 157 of file tlc16c550.h.