Yuji Hosogaya / Mbed 2 deprecated ModbusTCP_Modified

Modified version of ModbusTCP

Dependencies:   EthernetNetIf mbed

ModBus/mbfunccoils.cpp@3:d7d7c67f21fa, 2012-03-15 (annotated)

Committer:
paleskyjp
Date:
Thu Mar 15 15:28:14 2012 +0000
Revision:
3:d7d7c67f21fa
Parent:
0:62be54b8975d 
eMBRegCoilsCB was corrected.

(Implementation of writing single coil was wrong.)

Who changed what in which revision?

UserRevisionLine numberNew 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: mbfunccoils.c,v 1.8 2007/02/18 23:47:16 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 "mbframe.h"
paleskyjp 0:62be54b8975d 41 #include "mbproto.h"
paleskyjp 0:62be54b8975d 42 #include "mbconfig.h"
paleskyjp 0:62be54b8975d 43
paleskyjp 0:62be54b8975d 44 /* ----------------------- Defines ------------------------------------------*/
paleskyjp 0:62be54b8975d 45 #define MB_PDU_FUNC_READ_ADDR_OFF ( MB_PDU_DATA_OFF )
paleskyjp 0:62be54b8975d 46 #define MB_PDU_FUNC_READ_COILCNT_OFF ( MB_PDU_DATA_OFF + 2 )
paleskyjp 0:62be54b8975d 47 #define MB_PDU_FUNC_READ_SIZE ( 4 )
paleskyjp 0:62be54b8975d 48 #define MB_PDU_FUNC_READ_COILCNT_MAX ( 0x07D0 )
paleskyjp 0:62be54b8975d 49
paleskyjp 0:62be54b8975d 50 #define MB_PDU_FUNC_WRITE_ADDR_OFF ( MB_PDU_DATA_OFF )
paleskyjp 0:62be54b8975d 51 #define MB_PDU_FUNC_WRITE_VALUE_OFF ( MB_PDU_DATA_OFF + 2 )
paleskyjp 0:62be54b8975d 52 #define MB_PDU_FUNC_WRITE_SIZE ( 4 )
paleskyjp 0:62be54b8975d 53
paleskyjp 0:62be54b8975d 54 #define MB_PDU_FUNC_WRITE_MUL_ADDR_OFF ( MB_PDU_DATA_OFF )
paleskyjp 0:62be54b8975d 55 #define MB_PDU_FUNC_WRITE_MUL_COILCNT_OFF ( MB_PDU_DATA_OFF + 2 )
paleskyjp 0:62be54b8975d 56 #define MB_PDU_FUNC_WRITE_MUL_BYTECNT_OFF ( MB_PDU_DATA_OFF + 4 )
paleskyjp 0:62be54b8975d 57 #define MB_PDU_FUNC_WRITE_MUL_VALUES_OFF ( MB_PDU_DATA_OFF + 5 )
paleskyjp 0:62be54b8975d 58 #define MB_PDU_FUNC_WRITE_MUL_SIZE_MIN ( 5 )
paleskyjp 0:62be54b8975d 59 #define MB_PDU_FUNC_WRITE_MUL_COILCNT_MAX ( 0x07B0 )
paleskyjp 0:62be54b8975d 60
paleskyjp 0:62be54b8975d 61 /* ----------------------- Static functions ---------------------------------*/
paleskyjp 0:62be54b8975d 62 eMBException prveMBError2Exception( eMBErrorCode eErrorCode );
paleskyjp 0:62be54b8975d 63
paleskyjp 0:62be54b8975d 64 /* ----------------------- Start implementation -----------------------------*/
paleskyjp 0:62be54b8975d 65
paleskyjp 0:62be54b8975d 66 #if MB_FUNC_READ_COILS_ENABLED > 0
paleskyjp 0:62be54b8975d 67
paleskyjp 0:62be54b8975d 68 eMBException
paleskyjp 0:62be54b8975d 69 eMBFuncReadCoils( UCHAR * pucFrame, USHORT * usLen )
paleskyjp 0:62be54b8975d 70 {
paleskyjp 0:62be54b8975d 71 USHORT usRegAddress;
paleskyjp 0:62be54b8975d 72 USHORT usCoilCount;
paleskyjp 0:62be54b8975d 73 UCHAR ucNBytes;
paleskyjp 0:62be54b8975d 74 UCHAR *pucFrameCur;
paleskyjp 0:62be54b8975d 75
paleskyjp 0:62be54b8975d 76 eMBException eStatus = MB_EX_NONE;
paleskyjp 0:62be54b8975d 77 eMBErrorCode eRegStatus;
paleskyjp 0:62be54b8975d 78
paleskyjp 0:62be54b8975d 79 if( *usLen == ( MB_PDU_FUNC_READ_SIZE + MB_PDU_SIZE_MIN ) )
paleskyjp 0:62be54b8975d 80 {
paleskyjp 0:62be54b8975d 81 usRegAddress = ( USHORT )( pucFrame[MB_PDU_FUNC_READ_ADDR_OFF] << 8 );
paleskyjp 0:62be54b8975d 82 usRegAddress |= ( USHORT )( pucFrame[MB_PDU_FUNC_READ_ADDR_OFF + 1] );
paleskyjp 0:62be54b8975d 83 usRegAddress++;
paleskyjp 0:62be54b8975d 84
paleskyjp 0:62be54b8975d 85 usCoilCount = ( USHORT )( pucFrame[MB_PDU_FUNC_READ_COILCNT_OFF] << 8 );
paleskyjp 0:62be54b8975d 86 usCoilCount |= ( USHORT )( pucFrame[MB_PDU_FUNC_READ_COILCNT_OFF + 1] );
paleskyjp 0:62be54b8975d 87
paleskyjp 0:62be54b8975d 88 /* Check if the number of registers to read is valid. If not
paleskyjp 0:62be54b8975d 89 * return Modbus illegal data value exception.
paleskyjp 0:62be54b8975d 90 */
paleskyjp 0:62be54b8975d 91 if( ( usCoilCount >= 1 ) &&
paleskyjp 0:62be54b8975d 92 ( usCoilCount < MB_PDU_FUNC_READ_COILCNT_MAX ) )
paleskyjp 0:62be54b8975d 93 {
paleskyjp 0:62be54b8975d 94 /* Set the current PDU data pointer to the beginning. */
paleskyjp 0:62be54b8975d 95 pucFrameCur = &pucFrame[MB_PDU_FUNC_OFF];
paleskyjp 0:62be54b8975d 96 *usLen = MB_PDU_FUNC_OFF;
paleskyjp 0:62be54b8975d 97
paleskyjp 0:62be54b8975d 98 /* First byte contains the function code. */
paleskyjp 0:62be54b8975d 99 *pucFrameCur++ = MB_FUNC_READ_COILS;
paleskyjp 0:62be54b8975d 100 *usLen += 1;
paleskyjp 0:62be54b8975d 101
paleskyjp 0:62be54b8975d 102 /* Test if the quantity of coils is a multiple of 8. If not last
paleskyjp 0:62be54b8975d 103 * byte is only partially field with unused coils set to zero. */
paleskyjp 0:62be54b8975d 104 if( ( usCoilCount & 0x0007 ) != 0 )
paleskyjp 0:62be54b8975d 105 {
paleskyjp 0:62be54b8975d 106 ucNBytes = ( UCHAR )( usCoilCount / 8 + 1 );
paleskyjp 0:62be54b8975d 107 }
paleskyjp 0:62be54b8975d 108 else
paleskyjp 0:62be54b8975d 109 {
paleskyjp 0:62be54b8975d 110 ucNBytes = ( UCHAR )( usCoilCount / 8 );
paleskyjp 0:62be54b8975d 111 }
paleskyjp 0:62be54b8975d 112 *pucFrameCur++ = ucNBytes;
paleskyjp 0:62be54b8975d 113 *usLen += 1;
paleskyjp 0:62be54b8975d 114
paleskyjp 0:62be54b8975d 115 eRegStatus =
paleskyjp 0:62be54b8975d 116 eMBRegCoilsCB( pucFrameCur, usRegAddress, usCoilCount,
paleskyjp 0:62be54b8975d 117 MB_REG_READ );
paleskyjp 0:62be54b8975d 118
paleskyjp 0:62be54b8975d 119 /* If an error occured convert it into a Modbus exception. */
paleskyjp 0:62be54b8975d 120 if( eRegStatus != MB_ENOERR )
paleskyjp 0:62be54b8975d 121 {
paleskyjp 0:62be54b8975d 122 eStatus = prveMBError2Exception( eRegStatus );
paleskyjp 0:62be54b8975d 123 }
paleskyjp 0:62be54b8975d 124 else
paleskyjp 0:62be54b8975d 125 {
paleskyjp 0:62be54b8975d 126 /* The response contains the function code, the starting address
paleskyjp 0:62be54b8975d 127 * and the quantity of registers. We reuse the old values in the
paleskyjp 0:62be54b8975d 128 * buffer because they are still valid. */
paleskyjp 0:62be54b8975d 129 *usLen += ucNBytes;;
paleskyjp 0:62be54b8975d 130 }
paleskyjp 0:62be54b8975d 131 }
paleskyjp 0:62be54b8975d 132 else
paleskyjp 0:62be54b8975d 133 {
paleskyjp 0:62be54b8975d 134 eStatus = MB_EX_ILLEGAL_DATA_VALUE;
paleskyjp 0:62be54b8975d 135 }
paleskyjp 0:62be54b8975d 136 }
paleskyjp 0:62be54b8975d 137 else
paleskyjp 0:62be54b8975d 138 {
paleskyjp 0:62be54b8975d 139 /* Can't be a valid read coil register request because the length
paleskyjp 0:62be54b8975d 140 * is incorrect. */
paleskyjp 0:62be54b8975d 141 eStatus = MB_EX_ILLEGAL_DATA_VALUE;
paleskyjp 0:62be54b8975d 142 }
paleskyjp 0:62be54b8975d 143 return eStatus;
paleskyjp 0:62be54b8975d 144 }
paleskyjp 0:62be54b8975d 145
paleskyjp 0:62be54b8975d 146 #if MB_FUNC_WRITE_COIL_ENABLED > 0
paleskyjp 0:62be54b8975d 147 eMBException
paleskyjp 0:62be54b8975d 148 eMBFuncWriteCoil( UCHAR * pucFrame, USHORT * usLen )
paleskyjp 0:62be54b8975d 149 {
paleskyjp 0:62be54b8975d 150 USHORT usRegAddress;
paleskyjp 0:62be54b8975d 151 UCHAR ucBuf[2];
paleskyjp 0:62be54b8975d 152
paleskyjp 0:62be54b8975d 153 eMBException eStatus = MB_EX_NONE;
paleskyjp 0:62be54b8975d 154 eMBErrorCode eRegStatus;
paleskyjp 0:62be54b8975d 155
paleskyjp 0:62be54b8975d 156 if( *usLen == ( MB_PDU_FUNC_WRITE_SIZE + MB_PDU_SIZE_MIN ) )
paleskyjp 0:62be54b8975d 157 {
paleskyjp 0:62be54b8975d 158 usRegAddress = ( USHORT )( pucFrame[MB_PDU_FUNC_WRITE_ADDR_OFF] << 8 );
paleskyjp 0:62be54b8975d 159 usRegAddress |= ( USHORT )( pucFrame[MB_PDU_FUNC_WRITE_ADDR_OFF + 1] );
paleskyjp 0:62be54b8975d 160 usRegAddress++;
paleskyjp 0:62be54b8975d 161
paleskyjp 0:62be54b8975d 162 if( ( pucFrame[MB_PDU_FUNC_WRITE_VALUE_OFF + 1] == 0x00 ) &&
paleskyjp 0:62be54b8975d 163 ( ( pucFrame[MB_PDU_FUNC_WRITE_VALUE_OFF] == 0xFF ) ||
paleskyjp 0:62be54b8975d 164 ( pucFrame[MB_PDU_FUNC_WRITE_VALUE_OFF] == 0x00 ) ) )
paleskyjp 0:62be54b8975d 165 {
paleskyjp 0:62be54b8975d 166 ucBuf[1] = 0;
paleskyjp 0:62be54b8975d 167 if( pucFrame[MB_PDU_FUNC_WRITE_VALUE_OFF] == 0xFF )
paleskyjp 0:62be54b8975d 168 {
paleskyjp 0:62be54b8975d 169 ucBuf[0] = 1;
paleskyjp 0:62be54b8975d 170 }
paleskyjp 0:62be54b8975d 171 else
paleskyjp 0:62be54b8975d 172 {
paleskyjp 0:62be54b8975d 173 ucBuf[0] = 0;
paleskyjp 0:62be54b8975d 174 }
paleskyjp 0:62be54b8975d 175 eRegStatus =
paleskyjp 0:62be54b8975d 176 eMBRegCoilsCB( &ucBuf[0], usRegAddress, 1, MB_REG_WRITE );
paleskyjp 0:62be54b8975d 177
paleskyjp 0:62be54b8975d 178 /* If an error occured convert it into a Modbus exception. */
paleskyjp 0:62be54b8975d 179 if( eRegStatus != MB_ENOERR )
paleskyjp 0:62be54b8975d 180 {
paleskyjp 0:62be54b8975d 181 eStatus = prveMBError2Exception( eRegStatus );
paleskyjp 0:62be54b8975d 182 }
paleskyjp 0:62be54b8975d 183 }
paleskyjp 0:62be54b8975d 184 else
paleskyjp 0:62be54b8975d 185 {
paleskyjp 0:62be54b8975d 186 eStatus = MB_EX_ILLEGAL_DATA_VALUE;
paleskyjp 0:62be54b8975d 187 }
paleskyjp 0:62be54b8975d 188 }
paleskyjp 0:62be54b8975d 189 else
paleskyjp 0:62be54b8975d 190 {
paleskyjp 0:62be54b8975d 191 /* Can't be a valid write coil register request because the length
paleskyjp 0:62be54b8975d 192 * is incorrect. */
paleskyjp 0:62be54b8975d 193 eStatus = MB_EX_ILLEGAL_DATA_VALUE;
paleskyjp 0:62be54b8975d 194 }
paleskyjp 0:62be54b8975d 195 return eStatus;
paleskyjp 0:62be54b8975d 196 }
paleskyjp 0:62be54b8975d 197
paleskyjp 0:62be54b8975d 198 #endif
paleskyjp 0:62be54b8975d 199
paleskyjp 0:62be54b8975d 200 #if MB_FUNC_WRITE_MULTIPLE_COILS_ENABLED > 0
paleskyjp 0:62be54b8975d 201 eMBException
paleskyjp 0:62be54b8975d 202 eMBFuncWriteMultipleCoils( UCHAR * pucFrame, USHORT * usLen )
paleskyjp 0:62be54b8975d 203 {
paleskyjp 0:62be54b8975d 204 USHORT usRegAddress;
paleskyjp 0:62be54b8975d 205 USHORT usCoilCnt;
paleskyjp 0:62be54b8975d 206 UCHAR ucByteCount;
paleskyjp 0:62be54b8975d 207 UCHAR ucByteCountVerify;
paleskyjp 0:62be54b8975d 208
paleskyjp 0:62be54b8975d 209 eMBException eStatus = MB_EX_NONE;
paleskyjp 0:62be54b8975d 210 eMBErrorCode eRegStatus;
paleskyjp 0:62be54b8975d 211
paleskyjp 0:62be54b8975d 212 if( *usLen > ( MB_PDU_FUNC_WRITE_SIZE + MB_PDU_SIZE_MIN ) )
paleskyjp 0:62be54b8975d 213 {
paleskyjp 0:62be54b8975d 214 usRegAddress = ( USHORT )( pucFrame[MB_PDU_FUNC_WRITE_MUL_ADDR_OFF] << 8 );
paleskyjp 0:62be54b8975d 215 usRegAddress |= ( USHORT )( pucFrame[MB_PDU_FUNC_WRITE_MUL_ADDR_OFF + 1] );
paleskyjp 0:62be54b8975d 216 usRegAddress++;
paleskyjp 0:62be54b8975d 217
paleskyjp 0:62be54b8975d 218 usCoilCnt = ( USHORT )( pucFrame[MB_PDU_FUNC_WRITE_MUL_COILCNT_OFF] << 8 );
paleskyjp 0:62be54b8975d 219 usCoilCnt |= ( USHORT )( pucFrame[MB_PDU_FUNC_WRITE_MUL_COILCNT_OFF + 1] );
paleskyjp 0:62be54b8975d 220
paleskyjp 0:62be54b8975d 221 ucByteCount = pucFrame[MB_PDU_FUNC_WRITE_MUL_BYTECNT_OFF];
paleskyjp 0:62be54b8975d 222
paleskyjp 0:62be54b8975d 223 /* Compute the number of expected bytes in the request. */
paleskyjp 0:62be54b8975d 224 if( ( usCoilCnt & 0x0007 ) != 0 )
paleskyjp 0:62be54b8975d 225 {
paleskyjp 0:62be54b8975d 226 ucByteCountVerify = ( UCHAR )( usCoilCnt / 8 + 1 );
paleskyjp 0:62be54b8975d 227 }
paleskyjp 0:62be54b8975d 228 else
paleskyjp 0:62be54b8975d 229 {
paleskyjp 0:62be54b8975d 230 ucByteCountVerify = ( UCHAR )( usCoilCnt / 8 );
paleskyjp 0:62be54b8975d 231 }
paleskyjp 0:62be54b8975d 232
paleskyjp 0:62be54b8975d 233 if( ( usCoilCnt >= 1 ) &&
paleskyjp 0:62be54b8975d 234 ( usCoilCnt <= MB_PDU_FUNC_WRITE_MUL_COILCNT_MAX ) &&
paleskyjp 0:62be54b8975d 235 ( ucByteCountVerify == ucByteCount ) )
paleskyjp 0:62be54b8975d 236 {
paleskyjp 0:62be54b8975d 237 eRegStatus =
paleskyjp 0:62be54b8975d 238 eMBRegCoilsCB( &pucFrame[MB_PDU_FUNC_WRITE_MUL_VALUES_OFF],
paleskyjp 0:62be54b8975d 239 usRegAddress, usCoilCnt, MB_REG_WRITE );
paleskyjp 0:62be54b8975d 240
paleskyjp 0:62be54b8975d 241 /* If an error occured convert it into a Modbus exception. */
paleskyjp 0:62be54b8975d 242 if( eRegStatus != MB_ENOERR )
paleskyjp 0:62be54b8975d 243 {
paleskyjp 0:62be54b8975d 244 eStatus = prveMBError2Exception( eRegStatus );
paleskyjp 0:62be54b8975d 245 }
paleskyjp 0:62be54b8975d 246 else
paleskyjp 0:62be54b8975d 247 {
paleskyjp 0:62be54b8975d 248 /* The response contains the function code, the starting address
paleskyjp 0:62be54b8975d 249 * and the quantity of registers. We reuse the old values in the
paleskyjp 0:62be54b8975d 250 * buffer because they are still valid. */
paleskyjp 0:62be54b8975d 251 *usLen = MB_PDU_FUNC_WRITE_MUL_BYTECNT_OFF;
paleskyjp 0:62be54b8975d 252 }
paleskyjp 0:62be54b8975d 253 }
paleskyjp 0:62be54b8975d 254 else
paleskyjp 0:62be54b8975d 255 {
paleskyjp 0:62be54b8975d 256 eStatus = MB_EX_ILLEGAL_DATA_VALUE;
paleskyjp 0:62be54b8975d 257 }
paleskyjp 0:62be54b8975d 258 }
paleskyjp 0:62be54b8975d 259 else
paleskyjp 0:62be54b8975d 260 {
paleskyjp 0:62be54b8975d 261 /* Can't be a valid write coil register request because the length
paleskyjp 0:62be54b8975d 262 * is incorrect. */
paleskyjp 0:62be54b8975d 263 eStatus = MB_EX_ILLEGAL_DATA_VALUE;
paleskyjp 0:62be54b8975d 264 }
paleskyjp 0:62be54b8975d 265 return eStatus;
paleskyjp 0:62be54b8975d 266 }
paleskyjp 0:62be54b8975d 267
paleskyjp 0:62be54b8975d 268 #endif
paleskyjp 0:62be54b8975d 269
paleskyjp 0:62be54b8975d 270 #endif