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

ace.h File Reference


Detailed Description

ACE I/O function prototypes.


Defines

#define ACE_HS_RTSCTS   0x0003
 RTS / CTS hardware handshake.
#define ACE_HS_MODEM   0x001F
 Full modem hardware handshake.
#define ACE_HS_SOFT   0x0020
 XON / XOFF software handshake.

Functions

int AceInit (NUTDEVICE *dev)
 Initialize on chip ACE device.
int AceIOCtl (NUTDEVICE *dev, int req, void *conf)
 Perform ACE control functions.
int AceInput (NUTDEVICE *dev)
 Wait for input.
int AceOutput (NUTDEVICE *dev)
 Initiate output.
int AceFlush (NUTDEVICE *dev)
 Wait for output buffer empty.
int AceGetRaw (u_char *cp)
int AcePutRaw (u_char ch)
int AceRead (NUTFILE *fp, void *buffer, int size)
 Read from device.
int AceWrite (NUTFILE *fp, CONST void *buffer, int len)
int AceWrite_P (NUTFILE *fp, PGM_P buffer, int len)
NUTFILEAceOpen (NUTDEVICE *dev, CONST char *name, int mode, int acc)
 Open a device or file.
long AceSize (NUTFILE *fp)
 Request file size.
int AceClose (NUTFILE *fp)
 Close a device or file.


Define Documentation

#define ACE_SETSPEED   0x0101
 

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

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

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

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

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

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

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

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

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

#define ACE_SETSTATUS   0x0109
 

ACE _ioctl() command code to set the status.

The configuration parameter specifies the status to set.

#define ACE_GETSTATUS   0x010a
 

ACE _ioctl() command code to query the status.

The configuration parameter is set to the current status.

#define ACE_SETREADTIMEOUT   0x010b
 

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

The configuration parameter specifies the read timeout in milliseconds.

#define ACE_GETREADTIMEOUT   0x010c
 

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

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

#define ACE_SETWRITETIMEOUT   0x010d
 

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

The configuration parameter specifies the write timeout in milliseconds.

#define ACE_GETWRITETIMEOUT   0x010e
 

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

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

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

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

#define ACE_SETFLOWCONTROL   0x0111
 

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

The configuration parameter specifies the flow control mode.

#define ACE_GETFLOWCONTROL   0x0112
 

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

The configuration parameter is set to the flow control mode.

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

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

#define ACE_SETBUFFERMODE   0x0115
 

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

The configuration parameter specifies the buffering mode.

#define ACE_GETBUFFERMODE   0x0116
 

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

The configuration parameter is set to the buffering mode.

#define ACE_SETTXBUFSIZ   0x011b
 

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

The configuration parameter specifies the number of bytes.

#define ACE_GETTXBUFSIZ   0x011c
 

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

The configuration parameter specifies the number of bytes.

#define ACE_SETRXBUFSIZ   0x011d
 

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

The configuration parameter specifies the number of bytes.

#define ACE_GETRXBUFSIZ   0x011e
 

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

The configuration parameter specifies the number of bytes.

#define ACE_SETTXBUFLWMARK   0x0120
 

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

The configuration parameter specifies the number of bytes.

#define ACE_GETTXBUFLWMARK   0x0121
 

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

The configuration parameter specifies the number of bytes.

#define ACE_SETTXBUFHWMARK   0x0122
 

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

The configuration parameter specifies the number of bytes.

#define ACE_GETTXBUFHWMARK   0x0123
 

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

The configuration parameter specifies the number of bytes.

#define ACE_SETRXBUFLWMARK   0x0124
 

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

The configuration parameter specifies the number of bytes.

#define ACE_GETRXBUFLWMARK   0x0125
 

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

The configuration parameter specifies the number of bytes.

#define ACE_SETRXBUFHWMARK   0x0126
 

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

The configuration parameter specifies the number of bytes.

#define ACE_GETRXBUFHWMARK   0x0127
 

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

The configuration parameter specifies the number of bytes.

#define ACE_SETBLOCKREAD   0x0128
 

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

The configuration parameter specifies the block read mode

#define ACE_GETBLOCKREAD   0x0129
 

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

The configuration parameter specifies the block read mode

#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

#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


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