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: mbframe.h,v 1.9 2006/12/07 22:10:34 wolti Exp $ 29 */ 30 31 #ifndef _MB_FRAME_H 32 #define _MB_FRAME_H 33 34 #include "port.h" 35 36 #ifdef __cplusplus 37 PR_BEGIN_EXTERN_C 38 #endif 39 40 /*! 41 * Constants which defines the format of a modbus frame. The example is 42 * shown for a Modbus RTU/ASCII frame. Note that the Modbus PDU is not 43 * dependent on the underlying transport. 44 * 45 * <code> 46 * <------------------------ MODBUS SERIAL LINE PDU (1) -------------------> 47 * <----------- MODBUS PDU (1') ----------------> 48 * +-----------+---------------+----------------------------+-------------+ 49 * | Address | Function Code | Data | CRC/LRC | 50 * +-----------+---------------+----------------------------+-------------+ 51 * | | | | 52 * (2) (3/2') (3') (4) 53 * 54 * (1) ... MB_SER_PDU_SIZE_MAX = 256 55 * (2) ... MB_SER_PDU_ADDR_OFF = 0 56 * (3) ... MB_SER_PDU_PDU_OFF = 1 57 * (4) ... MB_SER_PDU_SIZE_CRC = 2 58 * 59 * (1') ... MB_PDU_SIZE_MAX = 253 60 * (2') ... MB_PDU_FUNC_OFF = 0 61 * (3') ... MB_PDU_DATA_OFF = 1 62 * </code> 63 */ 64 65 /* ----------------------- Defines ------------------------------------------*/ 66 #define MB_PDU_SIZE_MAX 253 /*!< Maximum size of a PDU. */ 67 #define MB_PDU_SIZE_MIN 1 /*!< Function Code */ 68 #define MB_PDU_FUNC_OFF 0 /*!< Offset of function code in PDU. */ 69 #define MB_PDU_DATA_OFF 1 /*!< Offset for response data in PDU. */ 70 71 #define MB_SER_PDU_SIZE_MAX MB_SERIAL_BUF_SIZE /*!< Maximum size of a Modbus frame. */ 72 #define MB_SER_PDU_SIZE_LRC 1 /*!< Size of LRC field in PDU. */ 73 #define MB_SER_PDU_ADDR_OFF 0 /*!< Offset of slave address in Ser-PDU. */ 74 #define MB_SER_PDU_PDU_OFF 1 /*!< Offset of Modbus-PDU in Ser-PDU. */ 75 #define MB_SER_PDU_SIZE_CRC 2 /*!< Size of CRC field in PDU. */ 76 77 #define MB_TCP_TID 0 78 #define MB_TCP_PID 2 79 #define MB_TCP_LEN 4 80 #define MB_TCP_UID 6 81 #define MB_TCP_FUNC 7 82 83 #define MB_TCP_PSEUDO_ADDRESS 255 84 85 /* ----------------------- Prototypes 0-------------------------------------*/ 86 typedef void ( *pvMBFrameStart ) ( void ); 87 88 typedef void ( *pvMBFrameStop ) ( void ); 89 90 typedef eMBErrorCode( *peMBFrameReceive ) ( UCHAR * pucRcvAddress, 91 UCHAR ** pucFrame, 92 USHORT * pusLength ); 93 94 typedef eMBErrorCode( *peMBFrameSend ) ( UCHAR slaveAddress, 95 const UCHAR * pucFrame, 96 USHORT usLength ); 97 98 typedef void( *pvMBFrameClose ) ( void ); 99 100 #ifdef __cplusplus 101 PR_END_EXTERN_C 102 #endif 103 #endif 104
