Daniel McKinnell / Modbus-Slave

Forking https://os.mbed.com/users/cam/code/Modbus/ to work for NUCLEO 64 boards

Fork of Cam's original FreeModbus port (https://os.mbed.com/users/cam/code/Modbus/)

Change: - Serial implementation to work for NUCLEO 64 boards and receive interrupts instead of timer. (see `portserial.cpp`)

Added: - Custom RTU mode. Allows for external implementation of packet receiving and sending. Sends and receives packets as whole frames (address + PDU) (i.e. this was added for a custom LoRa implementation). implement `xMBRTUCustGetPDU` and `xMBRTUCustSendResponse` (see `mbport.h`) and call `eMBRTUCustomInit( address )`. implementations need to be fully initialised as `eMBRTUCustomInit` only sets the address and nothing else.

mbutils.h@4:7621103c5a40, 2020-08-04 (annotated)

Committer:
danielmckinnell
Date:
Tue Aug 04 04:42:52 2020 +0000
Revision:
4:7621103c5a40
Parent:
0:0453a0a7e500 
RTU Serial updates

Who changed what in which revision?

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