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: mbrtu.h,v 1.9 2006/12/07 22:10:34 wolti Exp $
29  */
30 #include "mbconfig.h"
31 
32 #ifndef _MB_RTU_H
33 #define _MB_RTU_H
34 
35 #ifdef __cplusplus
36 PR_BEGIN_EXTERN_C
37 #endif
38 
39 /* ----------------------- Defines ------------------------------------------*/
40 #define MB_SER_PDU_SIZE_MIN     4       /*!< Minimum size of a Modbus RTU frame. */
41 
42 #if MB_SLAVE_RTU_ENABLED
43 eMBErrorCode eMBRTUInit( UCHAR slaveAddress, UCHAR ucPort, ULONG ulBaudRate,
44                              eMBParity eParity );
45 void            eMBRTUStart( void );
46 void            eMBRTUStop( void );
47 eMBErrorCode    eMBRTUReceive( UCHAR * pucRcvAddress, UCHAR ** pucFrame, USHORT * pusLength );
48 eMBErrorCode    eMBRTUSend( UCHAR slaveAddress, const UCHAR * pucFrame, USHORT usLength );
49 BOOL            xMBRTUReceiveFSM( void );
50 BOOL            xMBRTUTransmitFSM( void );
51 BOOL            xMBRTUTimerT15Expired( void );
52 BOOL            xMBRTUTimerT35Expired( void );
53 #endif
54 
55 #if MB_MASTER_RTU_ENABLED
56 eMBErrorCode    eMBMasterRTUInit( UCHAR ucPort, ULONG ulBaudRate,eMBParity eParity );
57 void            eMBMasterRTUStart( void );
58 void            eMBMasterRTUStop( void );
59 eMBErrorCode    eMBMasterRTUReceive( UCHAR * pucRcvAddress, UCHAR ** pucFrame, USHORT * pusLength );
60 eMBErrorCode    eMBMasterRTUSend( UCHAR slaveAddress, const UCHAR * pucFrame, USHORT usLength );
61 BOOL            xMBMasterRTUReceiveFSM( void );
62 BOOL            xMBMasterRTUTransmitFSM( void );
63 BOOL            xMBMasterRTUTimerExpired( void );
64 #endif
65 
66 #ifdef __cplusplus
67 PR_END_EXTERN_C
68 #endif
69 #endif
70