Contains two different component folders per each implementation (serial_master and serial_slave) with concrete ports. Added common public api for master and slave and common interface for master and slave implementation. Add support of cmake system (added cmake files). Added sdkconfig.defaults files for slave and master modbus examples. Updated make file and KConfig for freemodbus component Update according to review and fix doxygen warnings Fix Doxyfile to pass documentation build Update headers and change interface file names as per review comments Merge branch feature/freemodbus_move_rs485_mode_control Update after review: The stack modbus folder updated to support master and slave ports together and moved into freemodbus/modbus Stack and port files updated to remove duplicated simbols Make file, KConfig and CMakeLists.txt updated to compile master and slave stacks, common interface and concrete implementations of ports Stack callback functions execute callbacks using interface pointer from concrete port implementation User can instantiate any of concrete port using common API (only one concrete port at a time) and it does not require to select port by KConfig Port pins and mode configuration moved into example files from port files to allow user select pins and port mode (customer request) Changes tested using pymodbus, ModbusPoll and communication between two boards Updated DoxyFile according to public include path Fix maximum instance size for slave (merge from master of customer issue) Fix critical section issue TW#28622 (change spin lock based critical section to semaphore) Move serial port files into component port folder for master and slave accordingly Fix example issue showed in the log when IO slave is not configured correctly Fix conflicts while merging from origin/master Fix errors handling in modbus controller interface + some final corrections according to review Update maximum allowed number of slaves in the network segment Fix bug with incorrect coils read mask Closes https://github.com/espressif/esp-idf/issues/858
151 lines
6.7 KiB
C
151 lines
6.7 KiB
C
/*
|
|
* FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU.
|
|
* Copyright (c) 2006 Christian Walter <wolti@sil.at>
|
|
* All rights reserved.
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. The name of the author may not be used to endorse or promote products
|
|
* derived from this software without specific prior written permission.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
*
|
|
* File: $Id: mbconfig.h,v 1.15 2010/06/06 13:54:40 wolti Exp $
|
|
* $Id: mbconfig.h,v 1.60 2013/08/13 21:19:55 Armink Add Master Functions $
|
|
*/
|
|
|
|
#ifndef _MB_CONFIG_H
|
|
#define _MB_CONFIG_H
|
|
|
|
#include "sdkconfig.h" // for KConfig options
|
|
|
|
#ifdef __cplusplus
|
|
PR_BEGIN_EXTERN_C
|
|
#endif
|
|
/* ----------------------- Defines ------------------------------------------*/
|
|
/*! \defgroup modbus_cfg Modbus Configuration
|
|
*
|
|
* Most modules in the protocol stack are completly optional and can be
|
|
* excluded. This is specially important if target resources are very small
|
|
* and program memory space should be saved.<br>
|
|
*
|
|
* All of these settings are available in the file <code>mbconfig.h</code>
|
|
*/
|
|
/*! \addtogroup modbus_cfg
|
|
* @{
|
|
*/
|
|
/*! \brief If Modbus Master ASCII support is enabled. */
|
|
#define MB_MASTER_ASCII_ENABLED ( 0 )
|
|
/*! \brief If Modbus Master RTU support is enabled. */
|
|
#define MB_MASTER_RTU_ENABLED ( 1 )
|
|
/*! \brief If Modbus Master TCP support is enabled. */
|
|
#define MB_MASTER_TCP_ENABLED ( 0 )
|
|
/*! \brief If Modbus Slave ASCII support is enabled. */
|
|
#define MB_SLAVE_ASCII_ENABLED ( 1 )
|
|
/*! \brief If Modbus Slave RTU support is enabled. */
|
|
#define MB_SLAVE_RTU_ENABLED ( 1 )
|
|
/*! \brief If Modbus Slave TCP support is enabled. */
|
|
#define MB_TCP_ENABLED ( 1 )
|
|
/*! \brief The character timeout value for Modbus ASCII.
|
|
*
|
|
* The character timeout value is not fixed for Modbus ASCII and is therefore
|
|
* a configuration option. It should be set to the maximum expected delay
|
|
* time of the network.
|
|
*/
|
|
#define MB_ASCII_TIMEOUT_SEC ( 1 )
|
|
/*! \brief Timeout to wait in ASCII prior to enabling transmitter.
|
|
*
|
|
* If defined the function calls vMBPortSerialDelay with the argument
|
|
* MB_ASCII_TIMEOUT_WAIT_BEFORE_SEND_MS to allow for a delay before
|
|
* the serial transmitter is enabled. This is required because some
|
|
* targets are so fast that there is no time between receiving and
|
|
* transmitting the frame. If the master is to slow with enabling its
|
|
* receiver then he will not receive the response correctly.
|
|
*/
|
|
#ifndef MB_ASCII_TIMEOUT_WAIT_BEFORE_SEND_MS
|
|
#define MB_ASCII_TIMEOUT_WAIT_BEFORE_SEND_MS ( 0 )
|
|
#endif
|
|
|
|
/*! \brief Maximum number of Modbus functions codes the protocol stack
|
|
* should support.
|
|
*
|
|
* The maximum number of supported Modbus functions must be greater than
|
|
* the sum of all enabled functions in this file and custom function
|
|
* handlers. If set to small adding more functions will fail.
|
|
*/
|
|
#define MB_FUNC_HANDLERS_MAX ( 16 )
|
|
|
|
/*! \brief Number of bytes which should be allocated for the <em>Report Slave ID
|
|
* </em>command.
|
|
*
|
|
* This number limits the maximum size of the additional segment in the
|
|
* report slave id function. See eMBSetSlaveID( ) for more information on
|
|
* how to set this value. It is only used if MB_FUNC_OTHER_REP_SLAVEID_ENABLED
|
|
* is set to <code>1</code>.
|
|
*/
|
|
#define MB_FUNC_OTHER_REP_SLAVEID_BUF ( 32 )
|
|
|
|
/*! \brief If the <em>Report Slave ID</em> function should be enabled. */
|
|
#define MB_FUNC_OTHER_REP_SLAVEID_ENABLED ( CONFIG_MB_CONTROLLER_SLAVE_ID_SUPPORT )
|
|
|
|
/*! \brief If the <em>Read Input Registers</em> function should be enabled. */
|
|
#define MB_FUNC_READ_INPUT_ENABLED ( 1 )
|
|
|
|
/*! \brief If the <em>Read Holding Registers</em> function should be enabled. */
|
|
#define MB_FUNC_READ_HOLDING_ENABLED ( 1 )
|
|
|
|
/*! \brief If the <em>Write Single Register</em> function should be enabled. */
|
|
#define MB_FUNC_WRITE_HOLDING_ENABLED ( 1 )
|
|
|
|
/*! \brief If the <em>Write Multiple registers</em> function should be enabled. */
|
|
#define MB_FUNC_WRITE_MULTIPLE_HOLDING_ENABLED ( 1 )
|
|
|
|
/*! \brief If the <em>Read Coils</em> function should be enabled. */
|
|
#define MB_FUNC_READ_COILS_ENABLED ( 1 )
|
|
|
|
/*! \brief If the <em>Write Coils</em> function should be enabled. */
|
|
#define MB_FUNC_WRITE_COIL_ENABLED ( 1 )
|
|
|
|
/*! \brief If the <em>Write Multiple Coils</em> function should be enabled. */
|
|
#define MB_FUNC_WRITE_MULTIPLE_COILS_ENABLED ( 1 )
|
|
|
|
/*! \brief If the <em>Read Discrete Inputs</em> function should be enabled. */
|
|
#define MB_FUNC_READ_DISCRETE_INPUTS_ENABLED ( 1 )
|
|
|
|
/*! \brief If the <em>Read/Write Multiple Registers</em> function should be enabled. */
|
|
#define MB_FUNC_READWRITE_HOLDING_ENABLED ( 1 )
|
|
|
|
/*! @} */
|
|
#ifdef __cplusplus
|
|
PR_END_EXTERN_C
|
|
#endif
|
|
|
|
#if MB_MASTER_RTU_ENABLED || MB_MASTER_ASCII_ENABLED
|
|
/*! \brief If master send a broadcast frame, the master will wait time of convert to delay,
|
|
* then master can send other frame */
|
|
#define MB_MASTER_DELAY_MS_CONVERT ( CONFIG_MB_MASTER_DELAY_MS_CONVERT )
|
|
/*! \brief If master send a frame which is not broadcast,the master will wait sometime for slave.
|
|
* And if slave is not respond in this time,the master will process this timeout error.
|
|
* Then master can send other frame */
|
|
#define MB_MASTER_TIMEOUT_MS_RESPOND ( CONFIG_MB_MASTER_TIMEOUT_MS_RESPOND )
|
|
/*! \brief The total slaves in Modbus Master system.
|
|
* \note : The slave ID must be continuous from 1.*/
|
|
#define MB_MASTER_TOTAL_SLAVE_NUM ( 247 )
|
|
#endif
|
|
|
|
#endif
|