xref: /nrf52832-nimble/rt-thread/components/net/freemodbus/modbus/rtu/mbrtu.h (revision 104654410c56c573564690304ae786df310c91fc)
1*10465441SEvalZero /*
2*10465441SEvalZero  * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU.
3*10465441SEvalZero  * Copyright (c) 2006 Christian Walter <[email protected]>
4*10465441SEvalZero  * All rights reserved.
5*10465441SEvalZero  *
6*10465441SEvalZero  * Redistribution and use in source and binary forms, with or without
7*10465441SEvalZero  * modification, are permitted provided that the following conditions
8*10465441SEvalZero  * are met:
9*10465441SEvalZero  * 1. Redistributions of source code must retain the above copyright
10*10465441SEvalZero  *    notice, this list of conditions and the following disclaimer.
11*10465441SEvalZero  * 2. Redistributions in binary form must reproduce the above copyright
12*10465441SEvalZero  *    notice, this list of conditions and the following disclaimer in the
13*10465441SEvalZero  *    documentation and/or other materials provided with the distribution.
14*10465441SEvalZero  * 3. The name of the author may not be used to endorse or promote products
15*10465441SEvalZero  *    derived from this software without specific prior written permission.
16*10465441SEvalZero  *
17*10465441SEvalZero  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18*10465441SEvalZero  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19*10465441SEvalZero  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20*10465441SEvalZero  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21*10465441SEvalZero  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22*10465441SEvalZero  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23*10465441SEvalZero  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24*10465441SEvalZero  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25*10465441SEvalZero  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26*10465441SEvalZero  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27*10465441SEvalZero  *
28*10465441SEvalZero  * File: $Id: mbrtu.h,v 1.9  2006/12/07 22:10:34 wolti Exp $
29*10465441SEvalZero  * File: $Id: mbrtu.h,v 1.60 2013/08/17 13:11:42 Armink Add Master Functions $
30*10465441SEvalZero  */
31*10465441SEvalZero #include "mbconfig.h"
32*10465441SEvalZero 
33*10465441SEvalZero #ifndef _MB_RTU_H
34*10465441SEvalZero #define _MB_RTU_H
35*10465441SEvalZero 
36*10465441SEvalZero #ifdef __cplusplus
37*10465441SEvalZero PR_BEGIN_EXTERN_C
38*10465441SEvalZero #endif
39*10465441SEvalZero eMBErrorCode    eMBRTUInit( UCHAR slaveAddress, UCHAR ucPort, ULONG ulBaudRate,
40*10465441SEvalZero 						    eMBParity eParity );
41*10465441SEvalZero void            eMBRTUStart( void );
42*10465441SEvalZero void            eMBRTUStop( void );
43*10465441SEvalZero eMBErrorCode    eMBRTUReceive( UCHAR * pucRcvAddress, UCHAR ** pucFrame, USHORT * pusLength );
44*10465441SEvalZero eMBErrorCode    eMBRTUSend( UCHAR slaveAddress, const UCHAR * pucFrame, USHORT usLength );
45*10465441SEvalZero BOOL            xMBRTUReceiveFSM( void );
46*10465441SEvalZero BOOL            xMBRTUTransmitFSM( void );
47*10465441SEvalZero BOOL            xMBRTUTimerT15Expired( void );
48*10465441SEvalZero BOOL            xMBRTUTimerT35Expired( void );
49*10465441SEvalZero 
50*10465441SEvalZero #if MB_MASTER_RTU_ENABLED > 0
51*10465441SEvalZero eMBErrorCode    eMBMasterRTUInit( UCHAR ucPort, ULONG ulBaudRate,eMBParity eParity );
52*10465441SEvalZero void            eMBMasterRTUStart( void );
53*10465441SEvalZero void            eMBMasterRTUStop( void );
54*10465441SEvalZero eMBErrorCode    eMBMasterRTUReceive( UCHAR * pucRcvAddress, UCHAR ** pucFrame, USHORT * pusLength );
55*10465441SEvalZero eMBErrorCode    eMBMasterRTUSend( UCHAR slaveAddress, const UCHAR * pucFrame, USHORT usLength );
56*10465441SEvalZero BOOL            xMBMasterRTUReceiveFSM( void );
57*10465441SEvalZero BOOL            xMBMasterRTUTransmitFSM( void );
58*10465441SEvalZero BOOL            xMBMasterRTUTimerExpired( void );
59*10465441SEvalZero #endif
60*10465441SEvalZero 
61*10465441SEvalZero #ifdef __cplusplus
62*10465441SEvalZero PR_END_EXTERN_C
63*10465441SEvalZero #endif
64*10465441SEvalZero #endif
65