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

UART I/O Control Functions
[Serial Communication Devices]

Collaboration diagram for UART I/O Control Functions:


Detailed Description

UART _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 UART driver.

The _ioctl() function expects three parameters:


Modules

 * UART Status
 UART device status flags,.
 XgUARTHS
 UART handshake modes.
 XgUARTClock
 UART device clock modes.

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_SETBLOCKREAD
 UART _ioctl() command code to set the block read mode.
#define UART_GETBLOCKREAD
 UART _ioctl() command code to query the receive buffer high watermark.
#define UART_SETRAWMODE
 UART _ioctl() command code to set physical device to the raw mode.
#define UART_GETRAWMODE
 UART _ioctl() command code to query the raw mode.


Define Documentation

#define HDLC_GETIFNET
 

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

The configuration parameter is set to the network interface mode.

#define HDLC_SETIFNET
 

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

The configuration parameter specifies the network interface mode.

#define UART_GETBLOCKREAD
 

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

The configuration parameter specifies the block read mode.

#define UART_GETBUFFERMODE
 

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

The configuration parameter is set to the buffering mode.

#define UART_GETCLOCKMODE
 

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

The configuration parameter is set to the clock mode.

#define UART_GETCOOKEDMODE
 

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

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

#define UART_GETDATABITS
 

UART _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.

#define UART_GETFLOWCONTROL
 

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

The configuration parameter is set to the flow control mode.

#define UART_GETLOCALECHO
 

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

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

#define UART_GETPARITY
 

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

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

#define UART_GETRAWMODE
 

UART _ioctl() command code to query the raw mode.

The configuration parameter specified the raw mode.

#define UART_GETREADTIMEOUT
 

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

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

#define UART_GETRXBUFHWMARK
 

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

The configuration parameter specifies the number of bytes.

#define UART_GETRXBUFLWMARK
 

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

The configuration parameter specifies the number of bytes.

#define UART_GETRXBUFSIZ
 

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

The configuration parameter specifies the number of bytes.

#define UART_GETSPEED
 

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

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

#define UART_GETSTATUS
 

UART _ioctl() command code to query the status.

The configuration parameter is set to the current status.

#define UART_GETSTOPBITS
 

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

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

#define UART_GETTXBUFHWMARK
 

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

The configuration parameter specifies the number of bytes.

#define UART_GETTXBUFLWMARK
 

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

The configuration parameter specifies the number of bytes.

#define UART_GETTXBUFSIZ
 

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

The configuration parameter specifies the number of bytes.

#define UART_GETWRITETIMEOUT
 

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

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

#define UART_SETBLOCKREAD
 

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

The configuration parameter specifies the block read mode.

#define UART_SETBUFFERMODE
 

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

The configuration parameter specifies the buffering mode.

#define UART_SETCLOCKMODE
 

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

The configuration parameter specifies the clock mode.

#define UART_SETCOOKEDMODE
 

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

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

#define UART_SETDATABITS
 

UART _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.

#define UART_SETFLOWCONTROL
 

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

The configuration parameter specifies the flow control mode.

#define UART_SETLOCALECHO
 

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

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

#define UART_SETPARITY
 

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

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

#define UART_SETRAWMODE
 

UART _ioctl() command code to set physical device to the raw mode.

The configuration parameter specifies the raw mode for device. In raw mode data encapsulation is not allowed to be done. This allows other processing to be done on physical device.

#define UART_SETREADTIMEOUT
 

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

The configuration parameter specifies the read timeout in milliseconds.

#define UART_SETRXBUFHWMARK
 

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

The configuration parameter specifies the number of bytes.

#define UART_SETRXBUFLWMARK
 

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

The configuration parameter specifies the number of bytes.

#define UART_SETRXBUFSIZ
 

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

The configuration parameter specifies the number of bytes.

#define UART_SETSPEED
 

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

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

Examples:
events/events.c, ftpd/ftpserv.c, httpd/httpserv.c, inetq/inetq.c, playmp3/playmp3.c, rs232d/rs232d.c, tcps/tcps.c, threads/threads.c, timers/timers.c, and uart/uart.c.

#define UART_SETSTATUS
 

UART _ioctl() command code to set the status.

The configuration parameter specifies the status to set.

#define UART_SETSTOPBITS
 

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

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

#define UART_SETTXBUFHWMARK
 

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

The configuration parameter specifies the number of bytes.

#define UART_SETTXBUFLWMARK
 

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

The configuration parameter specifies the number of bytes.

#define UART_SETTXBUFSIZ
 

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

The configuration parameter specifies the number of bytes.

#define UART_SETWRITETIMEOUT
 

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

The configuration parameter specifies the write timeout in milliseconds.


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