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.

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: mbfuncinput.c,v 1.10 2007/09/12 10:15:56 wolti Exp $
cam 0:0453a0a7e500 29 */
cam 0:0453a0a7e500 30
cam 0:0453a0a7e500 31 /* ----------------------- System includes ----------------------------------*/
cam 0:0453a0a7e500 32 #include "stdlib.h"
cam 0:0453a0a7e500 33 #include "string.h"
cam 0:0453a0a7e500 34
cam 0:0453a0a7e500 35 /* ----------------------- Platform includes --------------------------------*/
cam 0:0453a0a7e500 36 #include "port.h"
cam 0:0453a0a7e500 37
cam 0:0453a0a7e500 38 /* ----------------------- Modbus includes ----------------------------------*/
cam 0:0453a0a7e500 39 #include "mb.h"
cam 0:0453a0a7e500 40 #include "mbframe.h"
cam 0:0453a0a7e500 41 #include "mbproto.h"
cam 0:0453a0a7e500 42 #include "mbconfig.h"
cam 0:0453a0a7e500 43
cam 0:0453a0a7e500 44 /* ----------------------- Defines ------------------------------------------*/
cam 0:0453a0a7e500 45 #define MB_PDU_FUNC_READ_ADDR_OFF ( MB_PDU_DATA_OFF )
cam 0:0453a0a7e500 46 #define MB_PDU_FUNC_READ_REGCNT_OFF ( MB_PDU_DATA_OFF + 2 )
cam 0:0453a0a7e500 47 #define MB_PDU_FUNC_READ_SIZE ( 4 )
cam 0:0453a0a7e500 48 #define MB_PDU_FUNC_READ_REGCNT_MAX ( 0x007D )
cam 0:0453a0a7e500 49
cam 0:0453a0a7e500 50 #define MB_PDU_FUNC_READ_RSP_BYTECNT_OFF ( MB_PDU_DATA_OFF )
cam 0:0453a0a7e500 51
cam 0:0453a0a7e500 52 /* ----------------------- Static functions ---------------------------------*/
cam 0:0453a0a7e500 53 eMBException prveMBError2Exception( eMBErrorCode eErrorCode );
cam 0:0453a0a7e500 54
cam 0:0453a0a7e500 55 /* ----------------------- Start implementation -----------------------------*/
cam 0:0453a0a7e500 56 #if MB_FUNC_READ_INPUT_ENABLED > 0
cam 0:0453a0a7e500 57
cam 0:0453a0a7e500 58 eMBException
cam 0:0453a0a7e500 59 eMBFuncReadInputRegister( UCHAR * pucFrame, USHORT * usLen )
cam 0:0453a0a7e500 60 {
cam 0:0453a0a7e500 61 USHORT usRegAddress;
cam 0:0453a0a7e500 62 USHORT usRegCount;
cam 0:0453a0a7e500 63 UCHAR *pucFrameCur;
cam 0:0453a0a7e500 64
cam 0:0453a0a7e500 65 eMBException eStatus = MB_EX_NONE;
cam 0:0453a0a7e500 66 eMBErrorCode eRegStatus;
cam 0:0453a0a7e500 67
cam 0:0453a0a7e500 68 if( *usLen == ( MB_PDU_FUNC_READ_SIZE + MB_PDU_SIZE_MIN ) )
cam 0:0453a0a7e500 69 {
cam 0:0453a0a7e500 70 usRegAddress = ( USHORT )( pucFrame[MB_PDU_FUNC_READ_ADDR_OFF] << 8 );
cam 0:0453a0a7e500 71 usRegAddress |= ( USHORT )( pucFrame[MB_PDU_FUNC_READ_ADDR_OFF + 1] );
cam 0:0453a0a7e500 72 usRegAddress++;
cam 0:0453a0a7e500 73
cam 0:0453a0a7e500 74 usRegCount = ( USHORT )( pucFrame[MB_PDU_FUNC_READ_REGCNT_OFF] << 8 );
cam 0:0453a0a7e500 75 usRegCount |= ( USHORT )( pucFrame[MB_PDU_FUNC_READ_REGCNT_OFF + 1] );
cam 0:0453a0a7e500 76
cam 0:0453a0a7e500 77 /* Check if the number of registers to read is valid. If not
cam 0:0453a0a7e500 78 * return Modbus illegal data value exception.
cam 0:0453a0a7e500 79 */
cam 0:0453a0a7e500 80 if( ( usRegCount >= 1 )
cam 0:0453a0a7e500 81 && ( usRegCount < MB_PDU_FUNC_READ_REGCNT_MAX ) )
cam 0:0453a0a7e500 82 {
cam 0:0453a0a7e500 83 /* Set the current PDU data pointer to the beginning. */
cam 0:0453a0a7e500 84 pucFrameCur = &pucFrame[MB_PDU_FUNC_OFF];
cam 0:0453a0a7e500 85 *usLen = MB_PDU_FUNC_OFF;
cam 0:0453a0a7e500 86
cam 0:0453a0a7e500 87 /* First byte contains the function code. */
cam 0:0453a0a7e500 88 *pucFrameCur++ = MB_FUNC_READ_INPUT_REGISTER;
cam 0:0453a0a7e500 89 *usLen += 1;
cam 0:0453a0a7e500 90
cam 0:0453a0a7e500 91 /* Second byte in the response contain the number of bytes. */
cam 0:0453a0a7e500 92 *pucFrameCur++ = ( UCHAR )( usRegCount * 2 );
cam 0:0453a0a7e500 93 *usLen += 1;
cam 0:0453a0a7e500 94
cam 0:0453a0a7e500 95 eRegStatus = eMBRegInputCB( pucFrameCur, usRegAddress, usRegCount );
cam 0:0453a0a7e500 96
cam 0:0453a0a7e500 97 /* If an error occured convert it into a Modbus exception. */
cam 0:0453a0a7e500 98 if( eRegStatus != MB_ENOERR )
cam 0:0453a0a7e500 99 {
cam 0:0453a0a7e500 100 eStatus = prveMBError2Exception( eRegStatus );
cam 0:0453a0a7e500 101 }
cam 0:0453a0a7e500 102 else
cam 0:0453a0a7e500 103 {
cam 0:0453a0a7e500 104 *usLen += usRegCount * 2;
cam 0:0453a0a7e500 105 }
cam 0:0453a0a7e500 106 }
cam 0:0453a0a7e500 107 else
cam 0:0453a0a7e500 108 {
cam 0:0453a0a7e500 109 eStatus = MB_EX_ILLEGAL_DATA_VALUE;
cam 0:0453a0a7e500 110 }
cam 0:0453a0a7e500 111 }
cam 0:0453a0a7e500 112 else
cam 0:0453a0a7e500 113 {
cam 0:0453a0a7e500 114 /* Can't be a valid read input register request because the length
cam 0:0453a0a7e500 115 * is incorrect. */
cam 0:0453a0a7e500 116 eStatus = MB_EX_ILLEGAL_DATA_VALUE;
cam 0:0453a0a7e500 117 }
cam 0:0453a0a7e500 118 return eStatus;
cam 0:0453a0a7e500 119 }
cam 0:0453a0a7e500 120
cam 0:0453a0a7e500 121 #endif