hsu han-lin / Modbus_For_F446RE

1.original from Cam Marshall 2.use for F446RE Test 3.use the interrupt method of uart 4.not change to RTOS yet

Dependents:   RoboticArm Modbus_Gripper_Test

include/mbutils.h@0:aefcdfe9ca2f, 2017-03-31 (annotated)

Committer:
stanley1228
Date:
Fri Mar 31 01:47:35 2017 +0000
Revision:
0:aefcdfe9ca2f
1.change the file in "port" folder to F446RE use

Who changed what in which revision?

UserRevisionLine numberNew contents of line
stanley1228 0:aefcdfe9ca2f 1 /*
stanley1228 0:aefcdfe9ca2f 2 * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU.
stanley1228 0:aefcdfe9ca2f 3 * Copyright (c) 2006 Christian Walter <wolti@sil.at>
stanley1228 0:aefcdfe9ca2f 4 * All rights reserved.
stanley1228 0:aefcdfe9ca2f 5 *
stanley1228 0:aefcdfe9ca2f 6 * Redistribution and use in source and binary forms, with or without
stanley1228 0:aefcdfe9ca2f 7 * modification, are permitted provided that the following conditions
stanley1228 0:aefcdfe9ca2f 8 * are met:
stanley1228 0:aefcdfe9ca2f 9 * 1. Redistributions of source code must retain the above copyright
stanley1228 0:aefcdfe9ca2f 10 * notice, this list of conditions and the following disclaimer.
stanley1228 0:aefcdfe9ca2f 11 * 2. Redistributions in binary form must reproduce the above copyright
stanley1228 0:aefcdfe9ca2f 12 * notice, this list of conditions and the following disclaimer in the
stanley1228 0:aefcdfe9ca2f 13 * documentation and/or other materials provided with the distribution.
stanley1228 0:aefcdfe9ca2f 14 * 3. The name of the author may not be used to endorse or promote products
stanley1228 0:aefcdfe9ca2f 15 * derived from this software without specific prior written permission.
stanley1228 0:aefcdfe9ca2f 16 *
stanley1228 0:aefcdfe9ca2f 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
stanley1228 0:aefcdfe9ca2f 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
stanley1228 0:aefcdfe9ca2f 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
stanley1228 0:aefcdfe9ca2f 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
stanley1228 0:aefcdfe9ca2f 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
stanley1228 0:aefcdfe9ca2f 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
stanley1228 0:aefcdfe9ca2f 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
stanley1228 0:aefcdfe9ca2f 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
stanley1228 0:aefcdfe9ca2f 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
stanley1228 0:aefcdfe9ca2f 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
stanley1228 0:aefcdfe9ca2f 27 *
stanley1228 0:aefcdfe9ca2f 28 * File: $Id: mbutils.h,v 1.5 2006/12/07 22:10:34 wolti Exp $
stanley1228 0:aefcdfe9ca2f 29 */
stanley1228 0:aefcdfe9ca2f 30
stanley1228 0:aefcdfe9ca2f 31 #ifndef _MB_UTILS_H
stanley1228 0:aefcdfe9ca2f 32 #define _MB_UTILS_H
stanley1228 0:aefcdfe9ca2f 33
stanley1228 0:aefcdfe9ca2f 34 #ifdef __cplusplus
stanley1228 0:aefcdfe9ca2f 35 PR_BEGIN_EXTERN_C
stanley1228 0:aefcdfe9ca2f 36 #endif
stanley1228 0:aefcdfe9ca2f 37 /*! \defgroup modbus_utils Utilities
stanley1228 0:aefcdfe9ca2f 38 *
stanley1228 0:aefcdfe9ca2f 39 * This module contains some utility functions which can be used by
stanley1228 0:aefcdfe9ca2f 40 * the application. It includes some special functions for working with
stanley1228 0:aefcdfe9ca2f 41 * bitfields backed by a character array buffer.
stanley1228 0:aefcdfe9ca2f 42 *
stanley1228 0:aefcdfe9ca2f 43 */
stanley1228 0:aefcdfe9ca2f 44 /*! \addtogroup modbus_utils
stanley1228 0:aefcdfe9ca2f 45 * @{
stanley1228 0:aefcdfe9ca2f 46 */
stanley1228 0:aefcdfe9ca2f 47 /*! \brief Function to set bits in a byte buffer.
stanley1228 0:aefcdfe9ca2f 48 *
stanley1228 0:aefcdfe9ca2f 49 * This function allows the efficient use of an array to implement bitfields.
stanley1228 0:aefcdfe9ca2f 50 * The array used for storing the bits must always be a multiple of two
stanley1228 0:aefcdfe9ca2f 51 * bytes. Up to eight bits can be set or cleared in one operation.
stanley1228 0:aefcdfe9ca2f 52 *
stanley1228 0:aefcdfe9ca2f 53 * \param ucByteBuf A buffer where the bit values are stored. Must be a
stanley1228 0:aefcdfe9ca2f 54 * multiple of 2 bytes. No length checking is performed and if
stanley1228 0:aefcdfe9ca2f 55 * usBitOffset / 8 is greater than the size of the buffer memory contents
stanley1228 0:aefcdfe9ca2f 56 * is overwritten.
stanley1228 0:aefcdfe9ca2f 57 * \param usBitOffset The starting address of the bits to set. The first
stanley1228 0:aefcdfe9ca2f 58 * bit has the offset 0.
stanley1228 0:aefcdfe9ca2f 59 * \param ucNBits Number of bits to modify. The value must always be smaller
stanley1228 0:aefcdfe9ca2f 60 * than 8.
stanley1228 0:aefcdfe9ca2f 61 * \param ucValues Thew new values for the bits. The value for the first bit
stanley1228 0:aefcdfe9ca2f 62 * starting at <code>usBitOffset</code> is the LSB of the value
stanley1228 0:aefcdfe9ca2f 63 * <code>ucValues</code>
stanley1228 0:aefcdfe9ca2f 64 *
stanley1228 0:aefcdfe9ca2f 65 * \code
stanley1228 0:aefcdfe9ca2f 66 * ucBits[2] = {0, 0};
stanley1228 0:aefcdfe9ca2f 67 *
stanley1228 0:aefcdfe9ca2f 68 * // Set bit 4 to 1 (read: set 1 bit starting at bit offset 4 to value 1)
stanley1228 0:aefcdfe9ca2f 69 * xMBUtilSetBits( ucBits, 4, 1, 1 );
stanley1228 0:aefcdfe9ca2f 70 *
stanley1228 0:aefcdfe9ca2f 71 * // Set bit 7 to 1 and bit 8 to 0.
stanley1228 0:aefcdfe9ca2f 72 * xMBUtilSetBits( ucBits, 7, 2, 0x01 );
stanley1228 0:aefcdfe9ca2f 73 *
stanley1228 0:aefcdfe9ca2f 74 * // Set bits 8 - 11 to 0x05 and bits 12 - 15 to 0x0A;
stanley1228 0:aefcdfe9ca2f 75 * xMBUtilSetBits( ucBits, 8, 8, 0x5A);
stanley1228 0:aefcdfe9ca2f 76 * \endcode
stanley1228 0:aefcdfe9ca2f 77 */
stanley1228 0:aefcdfe9ca2f 78 void xMBUtilSetBits( UCHAR * ucByteBuf, USHORT usBitOffset,
stanley1228 0:aefcdfe9ca2f 79 UCHAR ucNBits, UCHAR ucValues );
stanley1228 0:aefcdfe9ca2f 80
stanley1228 0:aefcdfe9ca2f 81 /*! \brief Function to read bits in a byte buffer.
stanley1228 0:aefcdfe9ca2f 82 *
stanley1228 0:aefcdfe9ca2f 83 * This function is used to extract up bit values from an array. Up to eight
stanley1228 0:aefcdfe9ca2f 84 * bit values can be extracted in one step.
stanley1228 0:aefcdfe9ca2f 85 *
stanley1228 0:aefcdfe9ca2f 86 * \param ucByteBuf A buffer where the bit values are stored.
stanley1228 0:aefcdfe9ca2f 87 * \param usBitOffset The starting address of the bits to set. The first
stanley1228 0:aefcdfe9ca2f 88 * bit has the offset 0.
stanley1228 0:aefcdfe9ca2f 89 * \param ucNBits Number of bits to modify. The value must always be smaller
stanley1228 0:aefcdfe9ca2f 90 * than 8.
stanley1228 0:aefcdfe9ca2f 91 *
stanley1228 0:aefcdfe9ca2f 92 * \code
stanley1228 0:aefcdfe9ca2f 93 * UCHAR ucBits[2] = {0, 0};
stanley1228 0:aefcdfe9ca2f 94 * UCHAR ucResult;
stanley1228 0:aefcdfe9ca2f 95 *
stanley1228 0:aefcdfe9ca2f 96 * // Extract the bits 3 - 10.
stanley1228 0:aefcdfe9ca2f 97 * ucResult = xMBUtilGetBits( ucBits, 3, 8 );
stanley1228 0:aefcdfe9ca2f 98 * \endcode
stanley1228 0:aefcdfe9ca2f 99 */
stanley1228 0:aefcdfe9ca2f 100 UCHAR xMBUtilGetBits( UCHAR * ucByteBuf, USHORT usBitOffset,
stanley1228 0:aefcdfe9ca2f 101 UCHAR ucNBits );
stanley1228 0:aefcdfe9ca2f 102
stanley1228 0:aefcdfe9ca2f 103 /*! @} */
stanley1228 0:aefcdfe9ca2f 104
stanley1228 0:aefcdfe9ca2f 105 #ifdef __cplusplus
stanley1228 0:aefcdfe9ca2f 106 PR_END_EXTERN_C
stanley1228 0:aefcdfe9ca2f 107 #endif
stanley1228 0:aefcdfe9ca2f 108 #endif