Modified version of ModbusTCP
Dependencies: EthernetNetIf mbed
ModBus/mbtcp.cpp@0:62be54b8975d, 2012-03-13 (annotated)
- Committer:
- paleskyjp
- Date:
- Tue Mar 13 09:11:49 2012 +0000
- Revision:
- 0:62be54b8975d
The first modification of ModbusTCP
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
paleskyjp | 0:62be54b8975d | 1 | /* |
paleskyjp | 0:62be54b8975d | 2 | * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU. |
paleskyjp | 0:62be54b8975d | 3 | * Copyright (c) 2006 Christian Walter <wolti@sil.at> |
paleskyjp | 0:62be54b8975d | 4 | * All rights reserved. |
paleskyjp | 0:62be54b8975d | 5 | * |
paleskyjp | 0:62be54b8975d | 6 | * Redistribution and use in source and binary forms, with or without |
paleskyjp | 0:62be54b8975d | 7 | * modification, are permitted provided that the following conditions |
paleskyjp | 0:62be54b8975d | 8 | * are met: |
paleskyjp | 0:62be54b8975d | 9 | * 1. Redistributions of source code must retain the above copyright |
paleskyjp | 0:62be54b8975d | 10 | * notice, this list of conditions and the following disclaimer. |
paleskyjp | 0:62be54b8975d | 11 | * 2. Redistributions in binary form must reproduce the above copyright |
paleskyjp | 0:62be54b8975d | 12 | * notice, this list of conditions and the following disclaimer in the |
paleskyjp | 0:62be54b8975d | 13 | * documentation and/or other materials provided with the distribution. |
paleskyjp | 0:62be54b8975d | 14 | * 3. The name of the author may not be used to endorse or promote products |
paleskyjp | 0:62be54b8975d | 15 | * derived from this software without specific prior written permission. |
paleskyjp | 0:62be54b8975d | 16 | * |
paleskyjp | 0:62be54b8975d | 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
paleskyjp | 0:62be54b8975d | 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
paleskyjp | 0:62be54b8975d | 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. |
paleskyjp | 0:62be54b8975d | 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, |
paleskyjp | 0:62be54b8975d | 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT |
paleskyjp | 0:62be54b8975d | 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
paleskyjp | 0:62be54b8975d | 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
paleskyjp | 0:62be54b8975d | 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
paleskyjp | 0:62be54b8975d | 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF |
paleskyjp | 0:62be54b8975d | 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
paleskyjp | 0:62be54b8975d | 27 | * |
paleskyjp | 0:62be54b8975d | 28 | * File: $Id: mbtcp.c,v 1.3 2006/12/07 22:10:34 wolti Exp $ |
paleskyjp | 0:62be54b8975d | 29 | */ |
paleskyjp | 0:62be54b8975d | 30 | |
paleskyjp | 0:62be54b8975d | 31 | /* ----------------------- System includes ----------------------------------*/ |
paleskyjp | 0:62be54b8975d | 32 | #include "stdlib.h" |
paleskyjp | 0:62be54b8975d | 33 | #include "string.h" |
paleskyjp | 0:62be54b8975d | 34 | |
paleskyjp | 0:62be54b8975d | 35 | /* ----------------------- Platform includes --------------------------------*/ |
paleskyjp | 0:62be54b8975d | 36 | #include "port.h" |
paleskyjp | 0:62be54b8975d | 37 | |
paleskyjp | 0:62be54b8975d | 38 | /* ----------------------- Modbus includes ----------------------------------*/ |
paleskyjp | 0:62be54b8975d | 39 | #include "mb.h" |
paleskyjp | 0:62be54b8975d | 40 | #include "mbconfig.h" |
paleskyjp | 0:62be54b8975d | 41 | #include "mbtcp.h" |
paleskyjp | 0:62be54b8975d | 42 | #include "mbframe.h" |
paleskyjp | 0:62be54b8975d | 43 | #include "mbport.h" |
paleskyjp | 0:62be54b8975d | 44 | |
paleskyjp | 0:62be54b8975d | 45 | #if MB_TCP_ENABLED > 0 |
paleskyjp | 0:62be54b8975d | 46 | |
paleskyjp | 0:62be54b8975d | 47 | /* ----------------------- Defines ------------------------------------------*/ |
paleskyjp | 0:62be54b8975d | 48 | |
paleskyjp | 0:62be54b8975d | 49 | /* ----------------------- MBAP Header --------------------------------------*/ |
paleskyjp | 0:62be54b8975d | 50 | /* |
paleskyjp | 0:62be54b8975d | 51 | * |
paleskyjp | 0:62be54b8975d | 52 | * <------------------------ MODBUS TCP/IP ADU(1) -------------------------> |
paleskyjp | 0:62be54b8975d | 53 | * <----------- MODBUS PDU (1') ----------------> |
paleskyjp | 0:62be54b8975d | 54 | * +-----------+---------------+------------------------------------------+ |
paleskyjp | 0:62be54b8975d | 55 | * | TID | PID | Length | UID |Code | Data | |
paleskyjp | 0:62be54b8975d | 56 | * +-----------+---------------+------------------------------------------+ |
paleskyjp | 0:62be54b8975d | 57 | * | | | | | |
paleskyjp | 0:62be54b8975d | 58 | * (2) (3) (4) (5) (6) |
paleskyjp | 0:62be54b8975d | 59 | * |
paleskyjp | 0:62be54b8975d | 60 | * (2) ... MB_TCP_TID = 0 (Transaction Identifier - 2 Byte) |
paleskyjp | 0:62be54b8975d | 61 | * (3) ... MB_TCP_PID = 2 (Protocol Identifier - 2 Byte) |
paleskyjp | 0:62be54b8975d | 62 | * (4) ... MB_TCP_LEN = 4 (Number of bytes - 2 Byte) |
paleskyjp | 0:62be54b8975d | 63 | * (5) ... MB_TCP_UID = 6 (Unit Identifier - 1 Byte) |
paleskyjp | 0:62be54b8975d | 64 | * (6) ... MB_TCP_FUNC = 7 (Modbus Function Code) |
paleskyjp | 0:62be54b8975d | 65 | * |
paleskyjp | 0:62be54b8975d | 66 | * (1) ... Modbus TCP/IP Application Data Unit |
paleskyjp | 0:62be54b8975d | 67 | * (1') ... Modbus Protocol Data Unit |
paleskyjp | 0:62be54b8975d | 68 | */ |
paleskyjp | 0:62be54b8975d | 69 | |
paleskyjp | 0:62be54b8975d | 70 | #define MB_TCP_TID 0 |
paleskyjp | 0:62be54b8975d | 71 | #define MB_TCP_PID 2 |
paleskyjp | 0:62be54b8975d | 72 | #define MB_TCP_LEN 4 |
paleskyjp | 0:62be54b8975d | 73 | #define MB_TCP_UID 6 |
paleskyjp | 0:62be54b8975d | 74 | #define MB_TCP_FUNC 7 |
paleskyjp | 0:62be54b8975d | 75 | |
paleskyjp | 0:62be54b8975d | 76 | #define MB_TCP_PROTOCOL_ID 0 /* 0 = Modbus Protocol */ |
paleskyjp | 0:62be54b8975d | 77 | |
paleskyjp | 0:62be54b8975d | 78 | |
paleskyjp | 0:62be54b8975d | 79 | /* ----------------------- Start implementation -----------------------------*/ |
paleskyjp | 0:62be54b8975d | 80 | eMBErrorCode |
paleskyjp | 0:62be54b8975d | 81 | eMBTCPDoInit( USHORT ucTCPPort ) |
paleskyjp | 0:62be54b8975d | 82 | { |
paleskyjp | 0:62be54b8975d | 83 | eMBErrorCode eStatus = MB_ENOERR; |
paleskyjp | 0:62be54b8975d | 84 | |
paleskyjp | 0:62be54b8975d | 85 | if( xMBTCPPortInit( ucTCPPort ) == FALSE ) |
paleskyjp | 0:62be54b8975d | 86 | { |
paleskyjp | 0:62be54b8975d | 87 | eStatus = MB_EPORTERR; |
paleskyjp | 0:62be54b8975d | 88 | } |
paleskyjp | 0:62be54b8975d | 89 | return eStatus; |
paleskyjp | 0:62be54b8975d | 90 | } |
paleskyjp | 0:62be54b8975d | 91 | |
paleskyjp | 0:62be54b8975d | 92 | void |
paleskyjp | 0:62be54b8975d | 93 | eMBTCPStart( void ) |
paleskyjp | 0:62be54b8975d | 94 | { |
paleskyjp | 0:62be54b8975d | 95 | } |
paleskyjp | 0:62be54b8975d | 96 | |
paleskyjp | 0:62be54b8975d | 97 | void |
paleskyjp | 0:62be54b8975d | 98 | eMBTCPStop( void ) |
paleskyjp | 0:62be54b8975d | 99 | { |
paleskyjp | 0:62be54b8975d | 100 | /* Make sure that no more clients are connected. */ |
paleskyjp | 0:62be54b8975d | 101 | vMBTCPPortDisable( ); |
paleskyjp | 0:62be54b8975d | 102 | } |
paleskyjp | 0:62be54b8975d | 103 | |
paleskyjp | 0:62be54b8975d | 104 | eMBErrorCode |
paleskyjp | 0:62be54b8975d | 105 | eMBTCPReceive( UCHAR * pucRcvAddress, UCHAR ** ppucFrame, USHORT * pusLength ) |
paleskyjp | 0:62be54b8975d | 106 | { |
paleskyjp | 0:62be54b8975d | 107 | eMBErrorCode eStatus = MB_EIO; |
paleskyjp | 0:62be54b8975d | 108 | UCHAR *pucMBTCPFrame; |
paleskyjp | 0:62be54b8975d | 109 | USHORT usLength; |
paleskyjp | 0:62be54b8975d | 110 | USHORT usPID; |
paleskyjp | 0:62be54b8975d | 111 | |
paleskyjp | 0:62be54b8975d | 112 | if( xMBTCPPortGetRequest( &pucMBTCPFrame, &usLength ) != FALSE ) |
paleskyjp | 0:62be54b8975d | 113 | { |
paleskyjp | 0:62be54b8975d | 114 | usPID = pucMBTCPFrame[MB_TCP_PID] << 8U; |
paleskyjp | 0:62be54b8975d | 115 | usPID |= pucMBTCPFrame[MB_TCP_PID + 1]; |
paleskyjp | 0:62be54b8975d | 116 | |
paleskyjp | 0:62be54b8975d | 117 | if( usPID == MB_TCP_PROTOCOL_ID ) |
paleskyjp | 0:62be54b8975d | 118 | { |
paleskyjp | 0:62be54b8975d | 119 | *ppucFrame = &pucMBTCPFrame[MB_TCP_FUNC]; |
paleskyjp | 0:62be54b8975d | 120 | *pusLength = usLength - MB_TCP_FUNC; |
paleskyjp | 0:62be54b8975d | 121 | eStatus = MB_ENOERR; |
paleskyjp | 0:62be54b8975d | 122 | |
paleskyjp | 0:62be54b8975d | 123 | /* Modbus TCP does not use any addresses. Fake the source address such |
paleskyjp | 0:62be54b8975d | 124 | * that the processing part deals with this frame. |
paleskyjp | 0:62be54b8975d | 125 | */ |
paleskyjp | 0:62be54b8975d | 126 | *pucRcvAddress = MB_TCP_PSEUDO_ADDRESS; |
paleskyjp | 0:62be54b8975d | 127 | } |
paleskyjp | 0:62be54b8975d | 128 | } |
paleskyjp | 0:62be54b8975d | 129 | else |
paleskyjp | 0:62be54b8975d | 130 | { |
paleskyjp | 0:62be54b8975d | 131 | eStatus = MB_EIO; |
paleskyjp | 0:62be54b8975d | 132 | } |
paleskyjp | 0:62be54b8975d | 133 | return eStatus; |
paleskyjp | 0:62be54b8975d | 134 | } |
paleskyjp | 0:62be54b8975d | 135 | |
paleskyjp | 0:62be54b8975d | 136 | eMBErrorCode |
paleskyjp | 0:62be54b8975d | 137 | eMBTCPSend( UCHAR _unused, const UCHAR * pucFrame, USHORT usLength ) |
paleskyjp | 0:62be54b8975d | 138 | { |
paleskyjp | 0:62be54b8975d | 139 | eMBErrorCode eStatus = MB_ENOERR; |
paleskyjp | 0:62be54b8975d | 140 | UCHAR *pucMBTCPFrame = ( UCHAR * ) pucFrame - MB_TCP_FUNC; |
paleskyjp | 0:62be54b8975d | 141 | USHORT usTCPLength = usLength + MB_TCP_FUNC; |
paleskyjp | 0:62be54b8975d | 142 | |
paleskyjp | 0:62be54b8975d | 143 | /* The MBAP header is already initialized because the caller calls this |
paleskyjp | 0:62be54b8975d | 144 | * function with the buffer returned by the previous call. Therefore we |
paleskyjp | 0:62be54b8975d | 145 | * only have to update the length in the header. Note that the length |
paleskyjp | 0:62be54b8975d | 146 | * header includes the size of the Modbus PDU and the UID Byte. Therefore |
paleskyjp | 0:62be54b8975d | 147 | * the length is usLength plus one. |
paleskyjp | 0:62be54b8975d | 148 | */ |
paleskyjp | 0:62be54b8975d | 149 | pucMBTCPFrame[MB_TCP_LEN] = ( usLength + 1 ) >> 8U; |
paleskyjp | 0:62be54b8975d | 150 | pucMBTCPFrame[MB_TCP_LEN + 1] = ( usLength + 1 ) & 0xFF; |
paleskyjp | 0:62be54b8975d | 151 | if( xMBTCPPortSendResponse( pucMBTCPFrame, usTCPLength ) == FALSE ) |
paleskyjp | 0:62be54b8975d | 152 | { |
paleskyjp | 0:62be54b8975d | 153 | eStatus = MB_EIO; |
paleskyjp | 0:62be54b8975d | 154 | } |
paleskyjp | 0:62be54b8975d | 155 | return eStatus; |
paleskyjp | 0:62be54b8975d | 156 | } |
paleskyjp | 0:62be54b8975d | 157 | |
paleskyjp | 0:62be54b8975d | 158 | #endif |