mbutils.h
上传用户:kongshuqi
上传日期:2013-10-09
资源大小:59k
文件大小:3k
源码类别:

通讯编程

开发平台:

Visual C++

  1.  /*
  2.   * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU.
  3.   * Copyright (C) 2006 Christian Walter <wolti@sil.at>
  4.   *
  5.   * This library is free software; you can redistribute it and/or
  6.   * modify it under the terms of the GNU Lesser General Public
  7.   * License as published by the Free Software Foundation; either
  8.   * version 2.1 of the License, or (at your option) any later version.
  9.   *
  10.   * This library is distributed in the hope that it will be useful,
  11.   * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12.   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13.   * Lesser General Public License for more details.
  14.   *
  15.   * You should have received a copy of the GNU Lesser General Public
  16.   * License along with this library; if not, write to the Free Software
  17.   * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18.   */
  19. #ifndef _MB_UTILS_H
  20. #define _MB_UTILS_H
  21. #ifdef __cplusplus
  22. PR_BEGIN_EXTERN_C
  23. #endif
  24. /*! defgroup modbus_utils Utilities
  25.  *
  26.  * This module contains some utility functions which can be used by
  27.  * the application. It includes some special functions for working with
  28.  * bitfields backed by a character array buffer.
  29.  *
  30.  */
  31. /*! addtogroup modbus_utils
  32.  *  @{
  33.  */
  34. /*! brief Function to set bits in a byte buffer.
  35.  *
  36.  * This function allows the efficient use of an array to implement bitfields.
  37.  * The array used for storing the bits must always be a multiple of two
  38.  * bytes. Up to eight bits can be set or cleared in one operation.
  39.  *
  40.  * param ucByteBuf A buffer where the bit values are stored. Must be a
  41.  *   multiple of 2 bytes. No length checking is performed and if
  42.  *   usBitOffset / 8 is greater than the size of the buffer memory contents
  43.  *   is overwritten.
  44.  * param usBitOffset The starting address of the bits to set. The first
  45.  *   bit has the offset 0.
  46.  * param ucNBits Number of bits to modify. The value must always be smaller
  47.  *   than 8.
  48.  * param ucValues Thew new values for the bits. The value for the first bit
  49.  *   starting at <code>usBitOffset</code> is the LSB of the value
  50.  *   <code>ucValues</code>
  51.  *
  52.  * code
  53.  * ucBits[2] = {0, 0};
  54.  *
  55.  * // Set bit 4 to 1 (read: set 1 bit starting at bit offset 4 to value 1)
  56.  * xMBUtilSetBits( ucBits, 4, 1, 1 );
  57.  *
  58.  * // Set bit 7 to 1 and bit 8 to 0.
  59.  * xMBUtilSetBits( ucBits, 7, 2, 0x01 );
  60.  *
  61.  * // Set bits 8 - 11 to 0x05 and bits 12 - 15 to 0x0A;
  62.  * xMBUtilSetBits( ucBits, 8, 8, 0x5A);
  63.  * endcode
  64.  */
  65. void            xMBUtilSetBits( UCHAR * ucByteBuf, USHORT usBitOffset,
  66.                                 UCHAR ucNBits, UCHAR ucValues );
  67. /*! brief Function to read bits in a byte buffer.
  68.  *
  69.  * This function is used to extract up bit values from an array. Up to eight
  70.  * bit values can be extracted in one step.
  71.  *
  72.  * param ucByteBuf A buffer where the bit values are stored.
  73.  * param usBitOffset The starting address of the bits to set. The first
  74.  *   bit has the offset 0.
  75.  * param ucNBits Number of bits to modify. The value must always be smaller
  76.  *   than 8.
  77.  *
  78.  * code
  79.  * UCHAR ucBits[2] = {0, 0};
  80.  * UCHAR ucResult;
  81.  *
  82.  * // Extract the bits 3 - 10.
  83.  * ucResult = xMBUtilGetBits( ucBits, 3, 8 );
  84.  * endcode
  85.  */
  86. UCHAR           xMBUtilGetBits( UCHAR * ucByteBuf, USHORT usBitOffset,
  87.                                 UCHAR ucNBits );
  88. /*! @} */
  89. #ifdef __cplusplus
  90. PR_END_EXTERN_C
  91. #endif
  92. #endif