chat.h

Go to the documentation of this file.
00001 #ifndef _DEV_CHAT_H_
00002 #define _DEV_CHAT_H_
00003 
00004 /*
00005  * Copyright (C) 2001-2004 by egnite Software GmbH. All rights reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  * 2. Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in the
00015  *    documentation and/or other materials provided with the distribution.
00016  * 3. Neither the name of the copyright holders nor the names of
00017  *    contributors may be used to endorse or promote products derived
00018  *    from this software without specific prior written permission.
00019  *
00020  * THIS SOFTWARE IS PROVIDED BY EGNITE SOFTWARE GMBH AND CONTRIBUTORS
00021  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
00022  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
00023  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL EGNITE
00024  * SOFTWARE GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
00025  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
00026  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
00027  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
00028  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00029  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
00030  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00031  * SUCH DAMAGE.
00032  *
00033  * For additional information see http://www.ethernut.de/
00034  */
00035 
00036 /*
00037  * $Log: chat.h,v $
00038  * Revision 1.9  2006/03/16 15:25:32  haraldkipp
00039  * Changed human readable strings from u_char to char to stop GCC 4 from
00040  * nagging about signedness.
00041  *
00042  * Revision 1.8  2005/04/30 16:42:41  chaac
00043  * Fixed bug in handling of NUTDEBUG. Added include for cfg/os.h. If NUTDEBUG
00044  * is defined in NutConf, it will make effect where it is used.
00045  *
00046  * Revision 1.7  2004/11/24 15:25:15  haraldkipp
00047  * Made options cnfigurable
00048  *
00049  * Revision 1.6  2004/03/17 11:29:20  haraldkipp
00050  * Bugfix for ICCAVR
00051  *
00052  * Revision 1.5  2004/03/16 16:48:28  haraldkipp
00053  * Added Jan Dubiec's H8/300 port.
00054  *
00055  * Revision 1.4  2004/03/08 11:18:54  haraldkipp
00056  * Debug output added.
00057  *
00058  * Revision 1.3  2004/01/06 18:12:36  drsung
00059  * Bugfix multiple define: '_chat_report' under ICCAVR
00060  *
00061  * Revision 1.2  2003/10/13 10:15:54  haraldkipp
00062  * Added Jelle's report function
00063  *
00064  * Revision 1.1.1.1  2003/05/09 14:41:05  haraldkipp
00065  * Initial using 3.2.1
00066  *
00067  * Revision 1.1  2003/03/31 14:53:23  harald
00068  * Prepare release 3.1
00069  *
00070  */
00071 
00072 #include <cfg/os.h>
00073 #include <cfg/chat.h>
00074 
00075 #define CHAT_ARG_SEND           0
00076 #define CHAT_ARG_ABORT          1
00077 #define CHAT_ARG_TIMEOUT        2
00078 #define CHAT_ARG_REPORT         3
00079 
00083 #ifndef CHAT_MAX_ABORTS
00084 #define CHAT_MAX_ABORTS         10
00085 #endif
00086 
00090 #ifndef CHAT_MAX_REPORT_SIZE
00091 #define CHAT_MAX_REPORT_SIZE    32
00092 #endif
00093 
00097 #ifndef CHAT_DEFAULT_TIMEOUT
00098 #define CHAT_DEFAULT_TIMEOUT    45
00099 #endif
00100 
00101 typedef struct {
00102     int chat_fd;
00103     u_char chat_arg;
00104     u_char chat_aborts;
00105     char *chat_abort[CHAT_MAX_ABORTS];
00106     u_char chat_abomat[CHAT_MAX_ABORTS];
00107     char *chat_report_search;
00108     u_char chat_repmat;
00109     char chat_report_state;
00110 } NUTCHAT;
00111 
00112 extern u_char *chat_report;
00113 
00114 #ifdef NUTDEBUG
00115 #include <stdio.h>
00116 #endif
00117 
00118 __BEGIN_DECLS
00119 
00120 #ifdef NUTDEBUG
00121 void NutTraceChat(FILE * stream, u_char flags);
00122 #endif
00123 
00124 int NutChatExpectString(NUTCHAT *ci, char *str);
00125 int NutChatExpect(NUTCHAT *ci, char *str);
00126 int NutChatSend(NUTCHAT *ci, char *str);
00127 NUTCHAT *NutChatCreate(int fd);
00128 void NutChatDestroy(NUTCHAT *ci);
00129 int NutChat(int fd, CONST char *script);
00130 #ifdef __HARVARD_ARCH__
00131 int NutChat_P(int fd, PGM_P script);
00132 #endif
00133 
00134 __END_DECLS
00135 
00136 #endif

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