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.

mbframe.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: mbframe.h,v 1.9 2006/12/07 22:10:34 wolti Exp $
cam 0:0453a0a7e500 29 */
cam 0:0453a0a7e500 30
cam 0:0453a0a7e500 31 #ifndef _MB_FRAME_H
cam 0:0453a0a7e500 32 #define _MB_FRAME_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
cam 0:0453a0a7e500 38 /*!
cam 0:0453a0a7e500 39 * Constants which defines the format of a modbus frame. The example is
cam 0:0453a0a7e500 40 * shown for a Modbus RTU/ASCII frame. Note that the Modbus PDU is not
cam 0:0453a0a7e500 41 * dependent on the underlying transport.
cam 0:0453a0a7e500 42 *
cam 0:0453a0a7e500 43 * <code>
cam 0:0453a0a7e500 44 * <------------------------ MODBUS SERIAL LINE PDU (1) ------------------->
cam 0:0453a0a7e500 45 * <----------- MODBUS PDU (1') ---------------->
cam 0:0453a0a7e500 46 * +-----------+---------------+----------------------------+-------------+
cam 0:0453a0a7e500 47 * | Address | Function Code | Data | CRC/LRC |
cam 0:0453a0a7e500 48 * +-----------+---------------+----------------------------+-------------+
cam 0:0453a0a7e500 49 * | | | |
cam 0:0453a0a7e500 50 * (2) (3/2') (3') (4)
cam 0:0453a0a7e500 51 *
cam 0:0453a0a7e500 52 * (1) ... MB_SER_PDU_SIZE_MAX = 256
cam 0:0453a0a7e500 53 * (2) ... MB_SER_PDU_ADDR_OFF = 0
cam 0:0453a0a7e500 54 * (3) ... MB_SER_PDU_PDU_OFF = 1
cam 0:0453a0a7e500 55 * (4) ... MB_SER_PDU_SIZE_CRC = 2
cam 0:0453a0a7e500 56 *
cam 0:0453a0a7e500 57 * (1') ... MB_PDU_SIZE_MAX = 253
cam 0:0453a0a7e500 58 * (2') ... MB_PDU_FUNC_OFF = 0
cam 0:0453a0a7e500 59 * (3') ... MB_PDU_DATA_OFF = 1
cam 0:0453a0a7e500 60 * </code>
cam 0:0453a0a7e500 61 */
cam 0:0453a0a7e500 62
cam 0:0453a0a7e500 63 /* ----------------------- Defines ------------------------------------------*/
cam 0:0453a0a7e500 64 #define MB_PDU_SIZE_MAX 253 /*!< Maximum size of a PDU. */
cam 0:0453a0a7e500 65 #define MB_PDU_SIZE_MIN 1 /*!< Function Code */
cam 0:0453a0a7e500 66 #define MB_PDU_FUNC_OFF 0 /*!< Offset of function code in PDU. */
cam 0:0453a0a7e500 67 #define MB_PDU_DATA_OFF 1 /*!< Offset for response data in PDU. */
cam 0:0453a0a7e500 68
cam 0:0453a0a7e500 69 /* ----------------------- Prototypes 0-------------------------------------*/
cam 0:0453a0a7e500 70 typedef void ( *pvMBFrameStart ) ( void );
cam 0:0453a0a7e500 71
cam 0:0453a0a7e500 72 typedef void ( *pvMBFrameStop ) ( void );
cam 0:0453a0a7e500 73
cam 0:0453a0a7e500 74 typedef eMBErrorCode( *peMBFrameReceive ) ( UCHAR * pucRcvAddress,
cam 0:0453a0a7e500 75 UCHAR ** pucFrame,
cam 0:0453a0a7e500 76 USHORT * pusLength );
cam 0:0453a0a7e500 77
cam 0:0453a0a7e500 78 typedef eMBErrorCode( *peMBFrameSend ) ( UCHAR slaveAddress,
cam 0:0453a0a7e500 79 const UCHAR * pucFrame,
cam 0:0453a0a7e500 80 USHORT usLength );
cam 0:0453a0a7e500 81
cam 0:0453a0a7e500 82 typedef void( *pvMBFrameClose ) ( void );
cam 0:0453a0a7e500 83
cam 0:0453a0a7e500 84 #ifdef __cplusplus
cam 0:0453a0a7e500 85 PR_END_EXTERN_C
cam 0:0453a0a7e500 86 #endif
cam 0:0453a0a7e500 87 #endif