Rajit Singh / Mbed OS Modbus

Port of the FreeModbus Libary for mbed, copied from https://developer.mbed.org/users/cam/code/Modbus/ and upgraded to mbed 5

Dependents:   NUCLEO-F401-printf

mbutils.cpp@0:9db3bed8fffd, 2017-08-16 (annotated)

Committer:
Rajit Singh
Date:
Wed Aug 16 17:12:19 2017 +0100
Revision:
0:9db3bed8fffd
First commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Rajit Singh 0:9db3bed8fffd 1 /*
Rajit Singh 0:9db3bed8fffd 2 * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU.
Rajit Singh 0:9db3bed8fffd 3 * Copyright (c) 2006 Christian Walter <wolti@sil.at>
Rajit Singh 0:9db3bed8fffd 4 * All rights reserved.
Rajit Singh 0:9db3bed8fffd 5 *
Rajit Singh 0:9db3bed8fffd 6 * Redistribution and use in source and binary forms, with or without
Rajit Singh 0:9db3bed8fffd 7 * modification, are permitted provided that the following conditions
Rajit Singh 0:9db3bed8fffd 8 * are met:
Rajit Singh 0:9db3bed8fffd 9 * 1. Redistributions of source code must retain the above copyright
Rajit Singh 0:9db3bed8fffd 10 * notice, this list of conditions and the following disclaimer.
Rajit Singh 0:9db3bed8fffd 11 * 2. Redistributions in binary form must reproduce the above copyright
Rajit Singh 0:9db3bed8fffd 12 * notice, this list of conditions and the following disclaimer in the
Rajit Singh 0:9db3bed8fffd 13 * documentation and/or other materials provided with the distribution.
Rajit Singh 0:9db3bed8fffd 14 * 3. The name of the author may not be used to endorse or promote products
Rajit Singh 0:9db3bed8fffd 15 * derived from this software without specific prior written permission.
Rajit Singh 0:9db3bed8fffd 16 *
Rajit Singh 0:9db3bed8fffd 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
Rajit Singh 0:9db3bed8fffd 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
Rajit Singh 0:9db3bed8fffd 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
Rajit Singh 0:9db3bed8fffd 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
Rajit Singh 0:9db3bed8fffd 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
Rajit Singh 0:9db3bed8fffd 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
Rajit Singh 0:9db3bed8fffd 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
Rajit Singh 0:9db3bed8fffd 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
Rajit Singh 0:9db3bed8fffd 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
Rajit Singh 0:9db3bed8fffd 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Rajit Singh 0:9db3bed8fffd 27 *
Rajit Singh 0:9db3bed8fffd 28 * File: $Id: mbutils.c,v 1.6 2007/02/18 23:49:07 wolti Exp $
Rajit Singh 0:9db3bed8fffd 29 */
Rajit Singh 0:9db3bed8fffd 30
Rajit Singh 0:9db3bed8fffd 31 /* ----------------------- System includes ----------------------------------*/
Rajit Singh 0:9db3bed8fffd 32 #include "stdlib.h"
Rajit Singh 0:9db3bed8fffd 33 #include "string.h"
Rajit Singh 0:9db3bed8fffd 34
Rajit Singh 0:9db3bed8fffd 35 /* ----------------------- Platform includes --------------------------------*/
Rajit Singh 0:9db3bed8fffd 36 #include "port.h"
Rajit Singh 0:9db3bed8fffd 37
Rajit Singh 0:9db3bed8fffd 38 /* ----------------------- Modbus includes ----------------------------------*/
Rajit Singh 0:9db3bed8fffd 39 #include "mb.h"
Rajit Singh 0:9db3bed8fffd 40 #include "mbproto.h"
Rajit Singh 0:9db3bed8fffd 41
Rajit Singh 0:9db3bed8fffd 42 /* ----------------------- Defines ------------------------------------------*/
Rajit Singh 0:9db3bed8fffd 43 #define BITS_UCHAR 8U
Rajit Singh 0:9db3bed8fffd 44
Rajit Singh 0:9db3bed8fffd 45 /* ----------------------- Start implementation -----------------------------*/
Rajit Singh 0:9db3bed8fffd 46 void
Rajit Singh 0:9db3bed8fffd 47 xMBUtilSetBits( UCHAR * ucByteBuf, USHORT usBitOffset, UCHAR ucNBits,
Rajit Singh 0:9db3bed8fffd 48 UCHAR ucValue )
Rajit Singh 0:9db3bed8fffd 49 {
Rajit Singh 0:9db3bed8fffd 50 USHORT usWordBuf;
Rajit Singh 0:9db3bed8fffd 51 USHORT usMask;
Rajit Singh 0:9db3bed8fffd 52 USHORT usByteOffset;
Rajit Singh 0:9db3bed8fffd 53 USHORT usNPreBits;
Rajit Singh 0:9db3bed8fffd 54 USHORT usValue = ucValue;
Rajit Singh 0:9db3bed8fffd 55
Rajit Singh 0:9db3bed8fffd 56 assert( ucNBits <= 8 );
Rajit Singh 0:9db3bed8fffd 57 assert( ( size_t )BITS_UCHAR == sizeof( UCHAR ) * 8 );
Rajit Singh 0:9db3bed8fffd 58
Rajit Singh 0:9db3bed8fffd 59 /* Calculate byte offset for first byte containing the bit values starting
Rajit Singh 0:9db3bed8fffd 60 * at usBitOffset. */
Rajit Singh 0:9db3bed8fffd 61 usByteOffset = ( USHORT )( ( usBitOffset ) / BITS_UCHAR );
Rajit Singh 0:9db3bed8fffd 62
Rajit Singh 0:9db3bed8fffd 63 /* How many bits precede our bits to set. */
Rajit Singh 0:9db3bed8fffd 64 usNPreBits = ( USHORT )( usBitOffset - usByteOffset * BITS_UCHAR );
Rajit Singh 0:9db3bed8fffd 65
Rajit Singh 0:9db3bed8fffd 66 /* Move bit field into position over bits to set */
Rajit Singh 0:9db3bed8fffd 67 usValue <<= usNPreBits;
Rajit Singh 0:9db3bed8fffd 68
Rajit Singh 0:9db3bed8fffd 69 /* Prepare a mask for setting the new bits. */
Rajit Singh 0:9db3bed8fffd 70 usMask = ( USHORT )( ( 1 << ( USHORT ) ucNBits ) - 1 );
Rajit Singh 0:9db3bed8fffd 71 usMask <<= usBitOffset - usByteOffset * BITS_UCHAR;
Rajit Singh 0:9db3bed8fffd 72
Rajit Singh 0:9db3bed8fffd 73 /* copy bits into temporary storage. */
Rajit Singh 0:9db3bed8fffd 74 usWordBuf = ucByteBuf[usByteOffset];
Rajit Singh 0:9db3bed8fffd 75 usWordBuf |= ucByteBuf[usByteOffset + 1] << BITS_UCHAR;
Rajit Singh 0:9db3bed8fffd 76
Rajit Singh 0:9db3bed8fffd 77 /* Zero out bit field bits and then or value bits into them. */
Rajit Singh 0:9db3bed8fffd 78 usWordBuf = ( USHORT )( ( usWordBuf & ( ~usMask ) ) | usValue );
Rajit Singh 0:9db3bed8fffd 79
Rajit Singh 0:9db3bed8fffd 80 /* move bits back into storage */
Rajit Singh 0:9db3bed8fffd 81 ucByteBuf[usByteOffset] = ( UCHAR )( usWordBuf & 0xFF );
Rajit Singh 0:9db3bed8fffd 82 ucByteBuf[usByteOffset + 1] = ( UCHAR )( usWordBuf >> BITS_UCHAR );
Rajit Singh 0:9db3bed8fffd 83 }
Rajit Singh 0:9db3bed8fffd 84
Rajit Singh 0:9db3bed8fffd 85 UCHAR
Rajit Singh 0:9db3bed8fffd 86 xMBUtilGetBits( UCHAR * ucByteBuf, USHORT usBitOffset, UCHAR ucNBits )
Rajit Singh 0:9db3bed8fffd 87 {
Rajit Singh 0:9db3bed8fffd 88 USHORT usWordBuf;
Rajit Singh 0:9db3bed8fffd 89 USHORT usMask;
Rajit Singh 0:9db3bed8fffd 90 USHORT usByteOffset;
Rajit Singh 0:9db3bed8fffd 91 USHORT usNPreBits;
Rajit Singh 0:9db3bed8fffd 92
Rajit Singh 0:9db3bed8fffd 93 /* Calculate byte offset for first byte containing the bit values starting
Rajit Singh 0:9db3bed8fffd 94 * at usBitOffset. */
Rajit Singh 0:9db3bed8fffd 95 usByteOffset = ( USHORT )( ( usBitOffset ) / BITS_UCHAR );
Rajit Singh 0:9db3bed8fffd 96
Rajit Singh 0:9db3bed8fffd 97 /* How many bits precede our bits to set. */
Rajit Singh 0:9db3bed8fffd 98 usNPreBits = ( USHORT )( usBitOffset - usByteOffset * BITS_UCHAR );
Rajit Singh 0:9db3bed8fffd 99
Rajit Singh 0:9db3bed8fffd 100 /* Prepare a mask for setting the new bits. */
Rajit Singh 0:9db3bed8fffd 101 usMask = ( USHORT )( ( 1 << ( USHORT ) ucNBits ) - 1 );
Rajit Singh 0:9db3bed8fffd 102
Rajit Singh 0:9db3bed8fffd 103 /* copy bits into temporary storage. */
Rajit Singh 0:9db3bed8fffd 104 usWordBuf = ucByteBuf[usByteOffset];
Rajit Singh 0:9db3bed8fffd 105 usWordBuf |= ucByteBuf[usByteOffset + 1] << BITS_UCHAR;
Rajit Singh 0:9db3bed8fffd 106
Rajit Singh 0:9db3bed8fffd 107 /* throw away unneeded bits. */
Rajit Singh 0:9db3bed8fffd 108 usWordBuf >>= usNPreBits;
Rajit Singh 0:9db3bed8fffd 109
Rajit Singh 0:9db3bed8fffd 110 /* mask away bits above the requested bitfield. */
Rajit Singh 0:9db3bed8fffd 111 usWordBuf &= usMask;
Rajit Singh 0:9db3bed8fffd 112
Rajit Singh 0:9db3bed8fffd 113 return ( UCHAR ) usWordBuf;
Rajit Singh 0:9db3bed8fffd 114 }
Rajit Singh 0:9db3bed8fffd 115
Rajit Singh 0:9db3bed8fffd 116 eMBException
Rajit Singh 0:9db3bed8fffd 117 prveMBError2Exception( eMBErrorCode eErrorCode )
Rajit Singh 0:9db3bed8fffd 118 {
Rajit Singh 0:9db3bed8fffd 119 eMBException eStatus;
Rajit Singh 0:9db3bed8fffd 120
Rajit Singh 0:9db3bed8fffd 121 switch ( eErrorCode )
Rajit Singh 0:9db3bed8fffd 122 {
Rajit Singh 0:9db3bed8fffd 123 case MB_ENOERR:
Rajit Singh 0:9db3bed8fffd 124 eStatus = MB_EX_NONE;
Rajit Singh 0:9db3bed8fffd 125 break;
Rajit Singh 0:9db3bed8fffd 126
Rajit Singh 0:9db3bed8fffd 127 case MB_ENOREG:
Rajit Singh 0:9db3bed8fffd 128 eStatus = MB_EX_ILLEGAL_DATA_ADDRESS;
Rajit Singh 0:9db3bed8fffd 129 break;
Rajit Singh 0:9db3bed8fffd 130
Rajit Singh 0:9db3bed8fffd 131 case MB_ETIMEDOUT:
Rajit Singh 0:9db3bed8fffd 132 eStatus = MB_EX_SLAVE_BUSY;
Rajit Singh 0:9db3bed8fffd 133 break;
Rajit Singh 0:9db3bed8fffd 134
Rajit Singh 0:9db3bed8fffd 135 default:
Rajit Singh 0:9db3bed8fffd 136 eStatus = MB_EX_SLAVE_DEVICE_FAILURE;
Rajit Singh 0:9db3bed8fffd 137 break;
Rajit Singh 0:9db3bed8fffd 138 }
Rajit Singh 0:9db3bed8fffd 139
Rajit Singh 0:9db3bed8fffd 140 return eStatus;
Rajit Singh 0:9db3bed8fffd 141 }