ace.h

Go to the documentation of this file.

#ifndef _DEV_ACE_H
#define _DEV_ACE_H

/*
 * Copyright (C) 2001-2003 by Cyber Integration, LLC. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the copyright holders nor the names of
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY CYBER INTEGRATION, LLC AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL CYBER
 * INTEGRATION, LLC OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *
 */

/*
 * $Log$
 * Revision 1.4  2008/08/11 06:59:59  haraldkipp
 * BSD types replaced by stdint types (feature request #1282721).
 *
 * Revision 1.3  2007/08/29 07:43:53  haraldkipp
 * Documentation updated and corrected.
 *
 * Revision 1.2  2006/05/25 09:09:57  haraldkipp
 * API documentation updated and corrected.
 *
 * Revision 1.1  2005/11/24 11:24:06  haraldkipp
 * Initial check-in.
 * Many thanks to William Basser for this code and also to Przemyslaw Rudy
 * for several enhancements.
 *
 */

#include <sys/device.h>


#define ACE_SETSPEED           0x0101

#define ACE_GETSPEED           0x0102

#define ACE_SETDATABITS        0x0103

#define ACE_GETDATABITS        0x0104

#define ACE_SETPARITY          0x0105

#define ACE_GETPARITY          0x0106

#define ACE_SETSTOPBITS        0x0107

#define ACE_GETSTOPBITS        0x0108

#define ACE_SETSTATUS          0x0109

#define ACE_GETSTATUS          0x010a

#define ACE_SETREADTIMEOUT     0x010b

#define ACE_GETREADTIMEOUT     0x010c

#define ACE_SETWRITETIMEOUT    0x010d

#define ACE_GETWRITETIMEOUT    0x010e

#define ACE_SETLOCALECHO       0x010f

#define ACE_GETLOCALECHO       0x0110

#define ACE_SETFLOWCONTROL     0x0111

#define ACE_GETFLOWCONTROL     0x0112

#define ACE_SETCOOKEDMODE      0x0113

#define ACE_GETCOOKEDMODE      0x0114

#define ACE_SETBUFFERMODE      0x0115

#define ACE_GETBUFFERMODE      0x0116

#define ACE_SETTXBUFSIZ        0x011b

#define ACE_GETTXBUFSIZ        0x011c

#define ACE_SETRXBUFSIZ        0x011d

#define ACE_GETRXBUFSIZ        0x011e

#define ACE_SETTXBUFLWMARK     0x0120

#define ACE_GETTXBUFLWMARK     0x0121

#define ACE_SETTXBUFHWMARK     0x0122

#define ACE_GETTXBUFHWMARK     0x0123

#define ACE_SETRXBUFLWMARK     0x0124

#define ACE_GETRXBUFLWMARK     0x0125

#define ACE_SETRXBUFHWMARK     0x0126

#define ACE_GETRXBUFHWMARK     0x0127

#define ACE_SETBLOCKREAD                0x0128

#define ACE_GETBLOCKREAD                0x0129

#define ACE_SETFIFO             0x012a

#define ACE_GETFIFO             0x012b


#define ACE_FRAMINGERROR   0x00000001UL

#define ACE_OVERRUNERROR   0x00000002UL

#define ACE_PARITYERROR    0x00000004UL

#define ACE_ERRORS         (ACE_FRAMINGERROR | ACE_OVERRUNERROR | ACE_PARITYERROR)

#define ACE_RXBUFFEREMPTY  0x00000040UL

#define ACE_TXBUFFEREMPTY  0x00000080UL

#define ACE_RTSENABLED     0x00000100UL

#define ACE_RTSDISABLED    0x00000200UL

#define ACE_CTSENABLED     0x00000400UL

#define ACE_CTSDISABLED    0x00000800UL

#define ACE_DTRENABLED     0x00001000UL

#define ACE_DTRDISABLED    0x00002000UL

#define ACE_RXENABLED      0x00010000UL

#define ACE_RXDISABLED     0x00020000UL

#define ACE_TXENABLED      0x00040000UL

#define ACE_TXDISABLED     0x00080000UL


#define ACE_HS_RTSCTS      0x0003

#define ACE_HS_MODEM       0x001F

#define ACE_HS_SOFT        0x0020


__BEGIN_DECLS
/* */
extern int AceInit(NUTDEVICE * dev);
extern int AceIOCtl(NUTDEVICE * dev, int req, void *conf);
extern int AceInput(NUTDEVICE * dev);
extern int AceOutput(NUTDEVICE * dev);
extern int AceFlush(NUTDEVICE * dev);

extern int AceGetRaw(uint8_t * cp);
extern int AcePutRaw(uint8_t ch);

extern int AceRead(NUTFILE * fp, void *buffer, int size);
extern int AceWrite(NUTFILE * fp, CONST void *buffer, int len);
extern int AceWrite_P(NUTFILE * fp, PGM_P buffer, int len);
extern NUTFILE *AceOpen(NUTDEVICE * dev, CONST char *name, int mode, int acc);
extern long AceSize(NUTFILE * fp);
extern int AceClose(NUTFILE * fp);

__END_DECLS
#endif