mbascii.h

00001 /* 
00002  * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU.
00003  * Copyright (c) 2006 Christian Walter <wolti@sil.at>
00004  * All rights reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without
00007  * modification, are permitted provided that the following conditions
00008  * are met:
00009  * 1. Redistributions of source code must retain the above copyright
00010  *    notice, this list of conditions and the following disclaimer.
00011  * 2. Redistributions in binary form must reproduce the above copyright
00012  *    notice, this list of conditions and the following disclaimer in the
00013  *    documentation and/or other materials provided with the distribution.
00014  * 3. The name of the author may not be used to endorse or promote products
00015  *    derived from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
00018  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00019  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
00020  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
00021  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
00022  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
00023  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
00024  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
00025  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
00026  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00027  *
00028  * File: $Id: mbascii.h,v 1.8 2006/12/07 22:10:34 wolti Exp $
00029  */
00030 
00031 #ifndef _MB_ASCII_H
00032 #define _MB_ASCII_H
00033 
00034 #ifdef __cplusplus
00035 PR_BEGIN_EXTERN_C
00036 #endif
00037 
00038 #if MB_ASCII_ENABLED > 0
00039 eMBErrorCode    eMBASCIIInit( UCHAR slaveAddress, UCHAR ucPort,
00040                               ULONG ulBaudRate, eMBParity eParity );
00041 void            eMBASCIIStart( void );
00042 void            eMBASCIIStop( void );
00043 
00044 eMBErrorCode    eMBASCIIReceive( UCHAR * pucRcvAddress, UCHAR ** pucFrame,
00045                                  USHORT * pusLength );
00046 eMBErrorCode    eMBASCIISend( UCHAR slaveAddress, const UCHAR * pucFrame,
00047                               USHORT usLength );
00048 BOOL            xMBASCIIReceiveFSM( void );
00049 BOOL            xMBASCIITransmitFSM( void );
00050 BOOL            xMBASCIITimerT1SExpired( void );
00051 #endif
00052 
00053 #ifdef __cplusplus
00054 PR_END_EXTERN_C
00055 #endif
00056 #endif