xref: /nrf52832-nimble/rt-thread/components/net/freemodbus/modbus/rtu/mbrtu.h (revision 042d53a763ad75cb1465103098bb88c245d95138)
1 /*
2  * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU.
3  * Copyright (c) 2006 Christian Walter <[email protected]>
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  * File: $Id: mbrtu.h,v 1.60 2013/08/17 13:11:42 Armink Add Master Functions $
30  */
31 #include "mbconfig.h"
32 
33 #ifndef _MB_RTU_H
34 #define _MB_RTU_H
35 
36 #ifdef __cplusplus
37 PR_BEGIN_EXTERN_C
38 #endif
39 eMBErrorCode    eMBRTUInit( UCHAR slaveAddress, UCHAR ucPort, ULONG ulBaudRate,
40 						    eMBParity eParity );
41 void            eMBRTUStart( void );
42 void            eMBRTUStop( void );
43 eMBErrorCode    eMBRTUReceive( UCHAR * pucRcvAddress, UCHAR ** pucFrame, USHORT * pusLength );
44 eMBErrorCode    eMBRTUSend( UCHAR slaveAddress, const UCHAR * pucFrame, USHORT usLength );
45 BOOL            xMBRTUReceiveFSM( void );
46 BOOL            xMBRTUTransmitFSM( void );
47 BOOL            xMBRTUTimerT15Expired( void );
48 BOOL            xMBRTUTimerT35Expired( void );
49 
50 #if MB_MASTER_RTU_ENABLED > 0
51 eMBErrorCode    eMBMasterRTUInit( UCHAR ucPort, ULONG ulBaudRate,eMBParity eParity );
52 void            eMBMasterRTUStart( void );
53 void            eMBMasterRTUStop( void );
54 eMBErrorCode    eMBMasterRTUReceive( UCHAR * pucRcvAddress, UCHAR ** pucFrame, USHORT * pusLength );
55 eMBErrorCode    eMBMasterRTUSend( UCHAR slaveAddress, const UCHAR * pucFrame, USHORT usLength );
56 BOOL            xMBMasterRTUReceiveFSM( void );
57 BOOL            xMBMasterRTUTransmitFSM( void );
58 BOOL            xMBMasterRTUTimerExpired( void );
59 #endif
60 
61 #ifdef __cplusplus
62 PR_END_EXTERN_C
63 #endif
64 #endif
65