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.
|
Modules |
| XgACEStatus |
| ACE device status flags,.
|
| XgACEHS |
| ACE handshake modes.
|
Data Structures |
struct | _ACEDCB |
| ACE device control block structure. More...
|
struct | _ACEDCB |
| ACE device control block structure. More...
|
Defines |
#define | ACE_SETSPEED |
| ACE _ioctl() command code to set the line speed.
|
#define | ACE_GETSPEED |
| ACE _ioctl() command code to query the line speed.
|
#define | ACE_SETDATABITS |
| ACE _ioctl() command code to set the number of data bits.
|
#define | ACE_GETDATABITS |
| ACE _ioctl() command code to query the number of data bits.
|
#define | ACE_SETPARITY |
| ACE _ioctl() command code to set the parity mode.
|
#define | ACE_GETPARITY |
| ACE _ioctl() command code to query the parity mode.
|
#define | ACE_SETSTOPBITS |
| ACE _ioctl() command code to set the number of stop bits.
|
#define | ACE_GETSTOPBITS |
| ACE _ioctl() command code to query the number of stop bits.
|
#define | ACE_SETSTATUS |
| ACE _ioctl() command code to set the status.
|
#define | ACE_GETSTATUS |
| ACE _ioctl() command code to query the status.
|
#define | ACE_SETREADTIMEOUT |
| ACE _ioctl() command code to set the read timeout.
|
#define | ACE_GETREADTIMEOUT |
| ACE _ioctl() command code to query the read timeout.
|
#define | ACE_SETWRITETIMEOUT |
| ACE _ioctl() command code to set the write timeout.
|
#define | ACE_GETWRITETIMEOUT |
| ACE _ioctl() command code to query the write timeout.
|
#define | ACE_SETLOCALECHO |
| ACE _ioctl() command code to set the local echo mode.
|
#define | ACE_GETLOCALECHO |
| ACE _ioctl() command code to query the local echo mode.
|
#define | ACE_SETFLOWCONTROL |
| ACE _ioctl() command code to set the flow control mode.
|
#define | ACE_GETFLOWCONTROL |
| ACE _ioctl() command code to query the flow control mode.
|
#define | ACE_SETCOOKEDMODE |
| ACE _ioctl() command code to set the cooking mode.
|
#define | ACE_GETCOOKEDMODE |
| ACE _ioctl() command code to query the cooking mode.
|
#define | ACE_SETBUFFERMODE |
| ACE _ioctl() command code to set the buffering mode.
|
#define | ACE_GETBUFFERMODE |
| ACE _ioctl() command code to query the buffering mode.
|
#define | ACE_SETTXBUFSIZ |
| ACE _ioctl() command code to set the transmit buffer size.
|
#define | ACE_GETTXBUFSIZ |
| ACE _ioctl() command code to query the transmit buffer size.
|
#define | ACE_SETRXBUFSIZ |
| ACE _ioctl() command code to set the receive buffer size.
|
#define | ACE_GETRXBUFSIZ |
| ACE _ioctl() command code to query the receive buffer size.
|
#define | ACE_SETTXBUFLWMARK |
| ACE _ioctl() command code to set the transmit buffer low watermark.
|
#define | ACE_GETTXBUFLWMARK |
| ACE _ioctl() command code to query the transmit buffer low watermark.
|
#define | ACE_SETTXBUFHWMARK |
| ACE _ioctl() command code to set the transmit buffer high watermark.
|
#define | ACE_GETTXBUFHWMARK |
| ACE _ioctl() command code to query the transmit buffer high watermark.
|
#define | ACE_SETRXBUFLWMARK |
| ACE _ioctl() command code to set the receive buffer low watermark.
|
#define | ACE_GETRXBUFLWMARK |
| ACE _ioctl() command code to query the receive buffer low watermark.
|
#define | ACE_SETRXBUFHWMARK |
| ACE _ioctl() command code to set the receive buffer high watermark.
|
#define | ACE_GETRXBUFHWMARK |
| ACE _ioctl() command code to query the receive buffer high watermark.
|
#define | ACE_SETBLOCKREAD |
| ACE _ioctl() command code to set the block read mode.
|
#define | ACE_GETBLOCKREAD |
| ACE _ioctl() command code to query the receive buffer high watermark.
|
#define | ACE_SETFIFO |
| ACE _ioctl() command code to set the fifo mode and receive fifo trigger level.
|
#define | ACE_GETFIFO |
| ACE _ioctl() command code to query the fifo mode and receive fifo trigger level.
|
#define | ACE_MF_RTSSENSE |
#define | ACE_MF_CTSCONTROL |
#define | ACE_MF_DTRSENSE |
#define | ACE_MF_DSRCONTROL |
#define | ACE_MF_DCDCONTROL |
#define | ACE_MF_RTSCONTROL |
#define | ACE_MF_CTSSENSE |
#define | ACE_MF_DTRCONTROL |
#define | ACE_MF_DSRSENSE |
#define | ACE_MF_DCDSENSE |
#define | ACE_MF_SENSEMASK |
#define | ACE_MF_CONTROLMASK |
#define | ACE_MF_XONXOFF |
#define | ACE_MF_LOCALECHO |
#define | ACE_MF_COOKEDMODE |
#define | ACE_MF_NOBUFFER |
#define | ACE_MF_LINEBUFFER |
#define | ACE_MF_BUFFERMASK |
#define | ACE_SF_RTSOFF |
#define | ACE_SF_CTSOFF |
#define | ACE_SF_DTROFF |
#define | ACE_SF_DSROFF |
#define | ACE_SF_DCDOFF |
#define | ACE_SF_TXDISABLED |
#define | ACE_SF_RXDISABLED |
#define | ACE_HS_DCERTSCTS |
#define | ACE_HS_DCEFULL |
#define | ACE_HS_DTERTSCTS |
#define | ACE_HS_DTEFULL |
#define | ACE_HS_XONXOFF |
#define | ACE_CLOCK |
Typedefs |
typedef _ACEDCB | ACEDCB |
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) |
NUTFILE * | AceOpen (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.
|
|
Perform ACE control functions.
- Parameters:
-
| dev | Identifies the device that receives the device-control function. |
| req | Requested control function. May be set to one of the following constants:
- ACE_SETSPEED, conf points to an u_long value containing the baudrate.
- ACE_GETSPEED, conf points to an u_long value receiving the current baudrate.
- ACE_SETDATABITS, conf points to an u_long value containing the number of data bits, 5, 6, 7 or 8.
- ACE_GETDATABITS, conf points to an u_long value receiving the number of data bits, 5, 6, 7 or 8.
- ACE_SETPARITY, conf points to an u_long value containing the parity, 0 (no), 1 (odd) or 2 (even).
- ACE_GETPARITY, conf points to an u_long value receiving the parity, 0 (no), 1 (odd) or 2 (even).
- ACE_SETSTOPBITS, conf points to an u_long value containing the number of stop bits 1 or 2.
- ACE_GETSTOPBITS, conf points to an u_long value receiving the number of stop bits 1 or 2.
- ACE_SETSTATUS
- ACE_GETSTATUS
- ACE_SETREADTIMEOUT, conf points to an u_long value containing the read timeout.
- ACE_GETREADTIMEOUT, conf points to an u_long value receiving the read timeout.
- ACE_SETWRITETIMEOUT, conf points to an u_long value containing the write timeout.
- ACE_GETWRITETIMEOUT, conf points to an u_long value receiving the write timeout.
- ACE_SETLOCALECHO, conf points to an u_long value containing 0 (off) or 1 (on).
- ACE_GETLOCALECHO, conf points to an u_long value receiving 0 (off) or 1 (on).
- ACE_SETFLOWCONTROL, conf points to an u_long value containing combined ACE_FCTL_ values.
- ACE_GETFLOWCONTROL, conf points to an u_long value containing receiving ACE_FCTL_ values.
- ACE_SETCOOKEDMODE, conf points to an u_long value containing 0 (off) or 1 (on).
- ACE_GETCOOKEDMODE, conf points to an u_long value receiving 0 (off) or 1 (on).
|
| conf | Points to a buffer that contains any data required for the given control function or receives data from that function. |
- Returns:
- 0 on success, -1 otherwise.
- Warning:
- Timeout values are given in milliseconds and are limited to the granularity of the system timer. To disable timeout, set the parameter to NUT_WAIT_INFINITE.
|