sw k
/
Modbus
a
Fork of Modbus by
mbport.h@0:274eb57e1df3, 2010-08-22 (annotated)
- Committer:
- giryan
- Date:
- Sun Aug 22 16:34:20 2010 +0000
- Revision:
- 0:274eb57e1df3
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
giryan | 0:274eb57e1df3 | 1 | /* |
giryan | 0:274eb57e1df3 | 2 | * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU. |
giryan | 0:274eb57e1df3 | 3 | * Copyright (c) 2006 Christian Walter <wolti@sil.at> |
giryan | 0:274eb57e1df3 | 4 | * All rights reserved. |
giryan | 0:274eb57e1df3 | 5 | * |
giryan | 0:274eb57e1df3 | 6 | * Redistribution and use in source and binary forms, with or without |
giryan | 0:274eb57e1df3 | 7 | * modification, are permitted provided that the following conditions |
giryan | 0:274eb57e1df3 | 8 | * are met: |
giryan | 0:274eb57e1df3 | 9 | * 1. Redistributions of source code must retain the above copyright |
giryan | 0:274eb57e1df3 | 10 | * notice, this list of conditions and the following disclaimer. |
giryan | 0:274eb57e1df3 | 11 | * 2. Redistributions in binary form must reproduce the above copyright |
giryan | 0:274eb57e1df3 | 12 | * notice, this list of conditions and the following disclaimer in the |
giryan | 0:274eb57e1df3 | 13 | * documentation and/or other materials provided with the distribution. |
giryan | 0:274eb57e1df3 | 14 | * 3. The name of the author may not be used to endorse or promote products |
giryan | 0:274eb57e1df3 | 15 | * derived from this software without specific prior written permission. |
giryan | 0:274eb57e1df3 | 16 | * |
giryan | 0:274eb57e1df3 | 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
giryan | 0:274eb57e1df3 | 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
giryan | 0:274eb57e1df3 | 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
giryan | 0:274eb57e1df3 | 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
giryan | 0:274eb57e1df3 | 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
giryan | 0:274eb57e1df3 | 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
giryan | 0:274eb57e1df3 | 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
giryan | 0:274eb57e1df3 | 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
giryan | 0:274eb57e1df3 | 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
giryan | 0:274eb57e1df3 | 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
giryan | 0:274eb57e1df3 | 27 | * |
giryan | 0:274eb57e1df3 | 28 | * File: $Id: mbport.h,v 1.17 2006/12/07 22:10:34 wolti Exp $ |
giryan | 0:274eb57e1df3 | 29 | */ |
giryan | 0:274eb57e1df3 | 30 | |
giryan | 0:274eb57e1df3 | 31 | #ifndef _MB_PORT_H |
giryan | 0:274eb57e1df3 | 32 | #define _MB_PORT_H |
giryan | 0:274eb57e1df3 | 33 | |
giryan | 0:274eb57e1df3 | 34 | #ifdef __cplusplus |
giryan | 0:274eb57e1df3 | 35 | PR_BEGIN_EXTERN_C |
giryan | 0:274eb57e1df3 | 36 | #endif |
giryan | 0:274eb57e1df3 | 37 | |
giryan | 0:274eb57e1df3 | 38 | /* ----------------------- Type definitions ---------------------------------*/ |
giryan | 0:274eb57e1df3 | 39 | |
giryan | 0:274eb57e1df3 | 40 | typedef enum |
giryan | 0:274eb57e1df3 | 41 | { |
giryan | 0:274eb57e1df3 | 42 | EV_READY, /*!< Startup finished. */ |
giryan | 0:274eb57e1df3 | 43 | EV_FRAME_RECEIVED, /*!< Frame received. */ |
giryan | 0:274eb57e1df3 | 44 | EV_EXECUTE, /*!< Execute function. */ |
giryan | 0:274eb57e1df3 | 45 | EV_FRAME_SENT /*!< Frame sent. */ |
giryan | 0:274eb57e1df3 | 46 | } eMBEventType; |
giryan | 0:274eb57e1df3 | 47 | |
giryan | 0:274eb57e1df3 | 48 | /*! \ingroup modbus |
giryan | 0:274eb57e1df3 | 49 | * \brief Parity used for characters in serial mode. |
giryan | 0:274eb57e1df3 | 50 | * |
giryan | 0:274eb57e1df3 | 51 | * The parity which should be applied to the characters sent over the serial |
giryan | 0:274eb57e1df3 | 52 | * link. Please note that this values are actually passed to the porting |
giryan | 0:274eb57e1df3 | 53 | * layer and therefore not all parity modes might be available. |
giryan | 0:274eb57e1df3 | 54 | */ |
giryan | 0:274eb57e1df3 | 55 | typedef enum |
giryan | 0:274eb57e1df3 | 56 | { |
giryan | 0:274eb57e1df3 | 57 | MB_PAR_NONE, /*!< No parity. */ |
giryan | 0:274eb57e1df3 | 58 | MB_PAR_ODD, /*!< Odd parity. */ |
giryan | 0:274eb57e1df3 | 59 | MB_PAR_EVEN /*!< Even parity. */ |
giryan | 0:274eb57e1df3 | 60 | } eMBParity; |
giryan | 0:274eb57e1df3 | 61 | |
giryan | 0:274eb57e1df3 | 62 | /* ----------------------- Supporting functions -----------------------------*/ |
giryan | 0:274eb57e1df3 | 63 | BOOL xMBPortEventInit( void ); |
giryan | 0:274eb57e1df3 | 64 | |
giryan | 0:274eb57e1df3 | 65 | BOOL xMBPortEventPost( eMBEventType eEvent ); |
giryan | 0:274eb57e1df3 | 66 | |
giryan | 0:274eb57e1df3 | 67 | BOOL xMBPortEventGet( /*@out@ */ eMBEventType * eEvent ); |
giryan | 0:274eb57e1df3 | 68 | |
giryan | 0:274eb57e1df3 | 69 | /* ----------------------- Serial port functions ----------------------------*/ |
giryan | 0:274eb57e1df3 | 70 | |
giryan | 0:274eb57e1df3 | 71 | BOOL xMBPortSerialInit( UCHAR ucPort, ULONG ulBaudRate, |
giryan | 0:274eb57e1df3 | 72 | UCHAR ucDataBits, eMBParity eParity ); |
giryan | 0:274eb57e1df3 | 73 | |
giryan | 0:274eb57e1df3 | 74 | void vMBPortClose( void ); |
giryan | 0:274eb57e1df3 | 75 | |
giryan | 0:274eb57e1df3 | 76 | void xMBPortSerialClose( void ); |
giryan | 0:274eb57e1df3 | 77 | |
giryan | 0:274eb57e1df3 | 78 | void vMBPortSerialEnable( BOOL xRxEnable, BOOL xTxEnable ); |
giryan | 0:274eb57e1df3 | 79 | |
giryan | 0:274eb57e1df3 | 80 | INLINE BOOL xMBPortSerialGetByte( CHAR * pucByte ); |
giryan | 0:274eb57e1df3 | 81 | |
giryan | 0:274eb57e1df3 | 82 | INLINE BOOL xMBPortSerialPutByte( CHAR ucByte ); |
giryan | 0:274eb57e1df3 | 83 | |
giryan | 0:274eb57e1df3 | 84 | /* ----------------------- Timers functions ---------------------------------*/ |
giryan | 0:274eb57e1df3 | 85 | BOOL xMBPortTimersInit( USHORT usTimeOut50us ); |
giryan | 0:274eb57e1df3 | 86 | |
giryan | 0:274eb57e1df3 | 87 | void xMBPortTimersClose( void ); |
giryan | 0:274eb57e1df3 | 88 | |
giryan | 0:274eb57e1df3 | 89 | INLINE void vMBPortTimersEnable( void ); |
giryan | 0:274eb57e1df3 | 90 | |
giryan | 0:274eb57e1df3 | 91 | INLINE void vMBPortTimersDisable( void ); |
giryan | 0:274eb57e1df3 | 92 | |
giryan | 0:274eb57e1df3 | 93 | /* ----------------------- Callback for the protocol stack ------------------*/ |
giryan | 0:274eb57e1df3 | 94 | |
giryan | 0:274eb57e1df3 | 95 | /*! |
giryan | 0:274eb57e1df3 | 96 | * \brief Callback function for the porting layer when a new byte is |
giryan | 0:274eb57e1df3 | 97 | * available. |
giryan | 0:274eb57e1df3 | 98 | * |
giryan | 0:274eb57e1df3 | 99 | * Depending upon the mode this callback function is used by the RTU or |
giryan | 0:274eb57e1df3 | 100 | * ASCII transmission layers. In any case a call to xMBPortSerialGetByte() |
giryan | 0:274eb57e1df3 | 101 | * must immediately return a new character. |
giryan | 0:274eb57e1df3 | 102 | * |
giryan | 0:274eb57e1df3 | 103 | * \return <code>TRUE</code> if a event was posted to the queue because |
giryan | 0:274eb57e1df3 | 104 | * a new byte was received. The port implementation should wake up the |
giryan | 0:274eb57e1df3 | 105 | * tasks which are currently blocked on the eventqueue. |
giryan | 0:274eb57e1df3 | 106 | */ |
giryan | 0:274eb57e1df3 | 107 | extern BOOL( *pxMBFrameCBByteReceived ) ( void ); |
giryan | 0:274eb57e1df3 | 108 | |
giryan | 0:274eb57e1df3 | 109 | extern BOOL( *pxMBFrameCBTransmitterEmpty ) ( void ); |
giryan | 0:274eb57e1df3 | 110 | |
giryan | 0:274eb57e1df3 | 111 | extern BOOL( *pxMBPortCBTimerExpired ) ( void ); |
giryan | 0:274eb57e1df3 | 112 | |
giryan | 0:274eb57e1df3 | 113 | /* ----------------------- TCP port functions -------------------------------*/ |
giryan | 0:274eb57e1df3 | 114 | BOOL xMBTCPPortInit( USHORT usTCPPort ); |
giryan | 0:274eb57e1df3 | 115 | |
giryan | 0:274eb57e1df3 | 116 | void vMBTCPPortClose( void ); |
giryan | 0:274eb57e1df3 | 117 | |
giryan | 0:274eb57e1df3 | 118 | void vMBTCPPortDisable( void ); |
giryan | 0:274eb57e1df3 | 119 | |
giryan | 0:274eb57e1df3 | 120 | BOOL xMBTCPPortGetRequest( UCHAR **ppucMBTCPFrame, USHORT * usTCPLength ); |
giryan | 0:274eb57e1df3 | 121 | |
giryan | 0:274eb57e1df3 | 122 | BOOL xMBTCPPortSendResponse( const UCHAR *pucMBTCPFrame, USHORT usTCPLength ); |
giryan | 0:274eb57e1df3 | 123 | |
giryan | 0:274eb57e1df3 | 124 | #ifdef __cplusplus |
giryan | 0:274eb57e1df3 | 125 | PR_END_EXTERN_C |
giryan | 0:274eb57e1df3 | 126 | #endif |
giryan | 0:274eb57e1df3 | 127 | #endif |