Wayne Lin / Modbus

modified for nuc472

Dependents:   modbus-over-rs485-sample NTOUEE-mbed-modbus-RTU NuMaker_NuWicam_Lite

Fork of Modbus by Matthew Waddilove

mbutils.h@7:be466464a18c, 2017-10-06 (annotated)

Committer:
wclin
Date:
Fri Oct 06 02:54:27 2017 +0000
Revision:
7:be466464a18c
Parent:
0:274eb57e1df3 
Support M487 board.

Who changed what in which revision?

UserRevisionLine numberNew 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: mbutils.h,v 1.5 2006/12/07 22:10:34 wolti Exp $
giryan 0:274eb57e1df3 29 */
giryan 0:274eb57e1df3 30
giryan 0:274eb57e1df3 31 #ifndef _MB_UTILS_H
giryan 0:274eb57e1df3 32 #define _MB_UTILS_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 /*! \defgroup modbus_utils Utilities
giryan 0:274eb57e1df3 38 *
giryan 0:274eb57e1df3 39 * This module contains some utility functions which can be used by
giryan 0:274eb57e1df3 40 * the application. It includes some special functions for working with
giryan 0:274eb57e1df3 41 * bitfields backed by a character array buffer.
giryan 0:274eb57e1df3 42 *
giryan 0:274eb57e1df3 43 */
giryan 0:274eb57e1df3 44 /*! \addtogroup modbus_utils
giryan 0:274eb57e1df3 45 * @{
giryan 0:274eb57e1df3 46 */
giryan 0:274eb57e1df3 47 /*! \brief Function to set bits in a byte buffer.
giryan 0:274eb57e1df3 48 *
giryan 0:274eb57e1df3 49 * This function allows the efficient use of an array to implement bitfields.
giryan 0:274eb57e1df3 50 * The array used for storing the bits must always be a multiple of two
giryan 0:274eb57e1df3 51 * bytes. Up to eight bits can be set or cleared in one operation.
giryan 0:274eb57e1df3 52 *
giryan 0:274eb57e1df3 53 * \param ucByteBuf A buffer where the bit values are stored. Must be a
giryan 0:274eb57e1df3 54 * multiple of 2 bytes. No length checking is performed and if
giryan 0:274eb57e1df3 55 * usBitOffset / 8 is greater than the size of the buffer memory contents
giryan 0:274eb57e1df3 56 * is overwritten.
giryan 0:274eb57e1df3 57 * \param usBitOffset The starting address of the bits to set. The first
giryan 0:274eb57e1df3 58 * bit has the offset 0.
giryan 0:274eb57e1df3 59 * \param ucNBits Number of bits to modify. The value must always be smaller
giryan 0:274eb57e1df3 60 * than 8.
giryan 0:274eb57e1df3 61 * \param ucValues Thew new values for the bits. The value for the first bit
giryan 0:274eb57e1df3 62 * starting at <code>usBitOffset</code> is the LSB of the value
giryan 0:274eb57e1df3 63 * <code>ucValues</code>
giryan 0:274eb57e1df3 64 *
giryan 0:274eb57e1df3 65 * \code
giryan 0:274eb57e1df3 66 * ucBits[2] = {0, 0};
giryan 0:274eb57e1df3 67 *
giryan 0:274eb57e1df3 68 * // Set bit 4 to 1 (read: set 1 bit starting at bit offset 4 to value 1)
giryan 0:274eb57e1df3 69 * xMBUtilSetBits( ucBits, 4, 1, 1 );
giryan 0:274eb57e1df3 70 *
giryan 0:274eb57e1df3 71 * // Set bit 7 to 1 and bit 8 to 0.
giryan 0:274eb57e1df3 72 * xMBUtilSetBits( ucBits, 7, 2, 0x01 );
giryan 0:274eb57e1df3 73 *
giryan 0:274eb57e1df3 74 * // Set bits 8 - 11 to 0x05 and bits 12 - 15 to 0x0A;
giryan 0:274eb57e1df3 75 * xMBUtilSetBits( ucBits, 8, 8, 0x5A);
giryan 0:274eb57e1df3 76 * \endcode
giryan 0:274eb57e1df3 77 */
giryan 0:274eb57e1df3 78 void xMBUtilSetBits( UCHAR * ucByteBuf, USHORT usBitOffset,
giryan 0:274eb57e1df3 79 UCHAR ucNBits, UCHAR ucValues );
giryan 0:274eb57e1df3 80
giryan 0:274eb57e1df3 81 /*! \brief Function to read bits in a byte buffer.
giryan 0:274eb57e1df3 82 *
giryan 0:274eb57e1df3 83 * This function is used to extract up bit values from an array. Up to eight
giryan 0:274eb57e1df3 84 * bit values can be extracted in one step.
giryan 0:274eb57e1df3 85 *
giryan 0:274eb57e1df3 86 * \param ucByteBuf A buffer where the bit values are stored.
giryan 0:274eb57e1df3 87 * \param usBitOffset The starting address of the bits to set. The first
giryan 0:274eb57e1df3 88 * bit has the offset 0.
giryan 0:274eb57e1df3 89 * \param ucNBits Number of bits to modify. The value must always be smaller
giryan 0:274eb57e1df3 90 * than 8.
giryan 0:274eb57e1df3 91 *
giryan 0:274eb57e1df3 92 * \code
giryan 0:274eb57e1df3 93 * UCHAR ucBits[2] = {0, 0};
giryan 0:274eb57e1df3 94 * UCHAR ucResult;
giryan 0:274eb57e1df3 95 *
giryan 0:274eb57e1df3 96 * // Extract the bits 3 - 10.
giryan 0:274eb57e1df3 97 * ucResult = xMBUtilGetBits( ucBits, 3, 8 );
giryan 0:274eb57e1df3 98 * \endcode
giryan 0:274eb57e1df3 99 */
giryan 0:274eb57e1df3 100 UCHAR xMBUtilGetBits( UCHAR * ucByteBuf, USHORT usBitOffset,
giryan 0:274eb57e1df3 101 UCHAR ucNBits );
giryan 0:274eb57e1df3 102
giryan 0:274eb57e1df3 103 /*! @} */
giryan 0:274eb57e1df3 104
giryan 0:274eb57e1df3 105 #ifdef __cplusplus
giryan 0:274eb57e1df3 106 PR_END_EXTERN_C
giryan 0:274eb57e1df3 107 #endif
giryan 0:274eb57e1df3 108 #endif