1 /* 2 * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU. 3 * Copyright (c) 2006 Christian Walter <wolti@sil.at> 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * 28 * File: $Id: mbascii.h,v 1.8 2006/12/07 22:10:34 wolti Exp $ 29 */ 30 31 #ifndef _MB_ASCII_H 32 #define _MB_ASCII_H 33 34 #ifdef __cplusplus 35 PR_BEGIN_EXTERN_C 36 #endif 37 38 /* ----------------------- Defines ------------------------------------------*/ 39 #define MB_ASCII_DEFAULT_CR '\r' /*!< Default CR character for Modbus ASCII. */ 40 #define MB_ASCII_DEFAULT_LF '\n' /*!< Default LF character for Modbus ASCII. */ 41 #define MB_ASCII_SER_PDU_SIZE_MIN 3 /*!< Minimum size of a Modbus ASCII frame. */ 42 43 /* ----------------------- Function declaration -----------------------------*/ 44 45 #if MB_SLAVE_ASCII_ENABLED > 0 46 eMBErrorCode eMBASCIIInit( UCHAR slaveAddress, UCHAR ucPort, 47 ULONG ulBaudRate, eMBParity eParity ); 48 void eMBASCIIStart( void ); 49 void eMBASCIIStop( void ); 50 51 eMBErrorCode eMBASCIIReceive( UCHAR * pucRcvAddress, UCHAR ** pucFrame, 52 USHORT * pusLength ); 53 eMBErrorCode eMBASCIISend( UCHAR slaveAddress, const UCHAR * pucFrame, 54 USHORT usLength ); 55 BOOL xMBASCIIReceiveFSM( void ); 56 BOOL xMBASCIITransmitFSM( void ); 57 BOOL xMBASCIITimerT1SExpired( void ); 58 #endif 59 60 #if MB_MASTER_ASCII_ENABLED > 0 61 eMBErrorCode eMBMasterASCIIInit( UCHAR ucPort, 62 ULONG ulBaudRate, eMBParity eParity ); 63 void eMBMasterASCIIStart( void ); 64 void eMBMasterASCIIStop( void ); 65 66 eMBErrorCode eMBMasterASCIIReceive( UCHAR * pucRcvAddress, UCHAR ** pucFrame, 67 USHORT * pusLength ); 68 eMBErrorCode eMBMasterASCIISend( UCHAR slaveAddress, const UCHAR * pucFrame, 69 USHORT usLength ); 70 BOOL xMBMasterASCIIReceiveFSM( void ); 71 BOOL xMBMasterASCIITransmitFSM( void ); 72 BOOL xMBMasterASCIITimerT1SExpired( void ); 73 #endif 74 75 #ifdef __cplusplus 76 PR_END_EXTERN_C 77 #endif 78 #endif 79
