1 /* 2 * FreeModbus Libary: A portable Modbus implementation for Modbus ASCII/RTU. 3 * Copyright (c) 2006 Christian Walter <wolti@sil.at> 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 3. The name of the author may not be used to endorse or promote products 15 * derived from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 27 * 28 * File: $Id: mbconfig.h,v 1.15 2010/06/06 13:54:40 wolti Exp $ 29 * $Id: mbconfig.h,v 1.60 2013/08/13 21:19:55 Armink Add Master Functions $ 30 */ 31 32 #ifndef _MB_CONFIG_H 33 #define _MB_CONFIG_H 34 35 #include "sdkconfig.h" // for KConfig options 36 37 #ifdef __cplusplus 38 PR_BEGIN_EXTERN_C 39 #endif 40 /* ----------------------- Defines ------------------------------------------*/ 41 /*! \defgroup modbus_cfg Modbus Configuration 42 * 43 * Most modules in the protocol stack are completly optional and can be 44 * excluded. This is specially important if target resources are very small 45 * and program memory space should be saved.<br> 46 * 47 * All of these settings are available in the file <code>mbconfig.h</code> 48 */ 49 /*! \addtogroup modbus_cfg 50 * @{ 51 */ 52 /*! \brief If Modbus Master ASCII support is enabled. */ 53 #define MB_MASTER_ASCII_ENABLED ( CONFIG_FMB_COMM_MODE_ASCII_EN ) 54 /*! \brief If Modbus Master RTU support is enabled. */ 55 #define MB_MASTER_RTU_ENABLED ( CONFIG_FMB_COMM_MODE_RTU_EN ) 56 /*! \brief If Modbus Master TCP support is enabled. */ 57 #define MB_MASTER_TCP_ENABLED ( CONFIG_FMB_COMM_MODE_TCP_EN ) 58 /*! \brief If Modbus Slave ASCII support is enabled. */ 59 #define MB_SLAVE_ASCII_ENABLED ( CONFIG_FMB_COMM_MODE_ASCII_EN ) 60 /*! \brief If Modbus Slave RTU support is enabled. */ 61 #define MB_SLAVE_RTU_ENABLED ( CONFIG_FMB_COMM_MODE_RTU_EN ) 62 /*! \brief If Modbus Slave TCP support is enabled. */ 63 #define MB_TCP_ENABLED ( CONFIG_FMB_COMM_MODE_TCP_EN ) 64 65 #if !CONFIG_FMB_COMM_MODE_ASCII_EN && !CONFIG_FMB_COMM_MODE_RTU_EN && !MB_MASTER_TCP_ENABLED && !MB_TCP_ENABLED 66 #error "None of Modbus communication mode is enabled. Please enable one of (ASCII, RTU, TCP) mode in Kconfig." 67 #endif 68 69 /*! \brief This option defines the number of data bits per ASCII character. 70 * 71 * A parity bit is added before the stop bit which keeps the actual byte size at 10 bits. 72 */ 73 #ifdef CONFIG_FMB_SERIAL_ASCII_BITS_PER_SYMB 74 #define MB_ASCII_BITS_PER_SYMB ( CONFIG_FMB_SERIAL_ASCII_BITS_PER_SYMB ) 75 #endif 76 77 /*! \brief The character timeout value for Modbus ASCII. 78 * 79 * The character timeout value is not fixed for Modbus ASCII and is therefore 80 * a configuration option. It should be set to the maximum expected delay 81 * time of the network. 82 */ 83 #ifdef CONFIG_FMB_SERIAL_ASCII_TIMEOUT_RESPOND_MS 84 #define MB_ASCII_TIMEOUT_MS ( CONFIG_FMB_SERIAL_ASCII_TIMEOUT_RESPOND_MS ) 85 #endif 86 87 /*! \brief Timeout to wait in ASCII prior to enabling transmitter. 88 * 89 * If defined the function calls vMBPortSerialDelay with the argument 90 * MB_ASCII_TIMEOUT_WAIT_BEFORE_SEND_MS to allow for a delay before 91 * the serial transmitter is enabled. This is required because some 92 * targets are so fast that there is no time between receiving and 93 * transmitting the frame. If the master is to slow with enabling its 94 * receiver then he will not receive the response correctly. 95 */ 96 #ifndef MB_ASCII_TIMEOUT_WAIT_BEFORE_SEND_MS 97 #define MB_ASCII_TIMEOUT_WAIT_BEFORE_SEND_MS ( 0 ) 98 #endif 99 100 /*! \brief Maximum number of Modbus functions codes the protocol stack 101 * should support. 102 * 103 * The maximum number of supported Modbus functions must be greater than 104 * the sum of all enabled functions in this file and custom function 105 * handlers. If set to small adding more functions will fail. 106 */ 107 #define MB_FUNC_HANDLERS_MAX ( 16 ) 108 109 /*! \brief Number of bytes which should be allocated for the <em>Report Slave ID 110 * </em>command. 111 * 112 * This number limits the maximum size of the additional segment in the 113 * report slave id function. See eMBSetSlaveID( ) for more information on 114 * how to set this value. It is only used if MB_FUNC_OTHER_REP_SLAVEID_ENABLED 115 * is set to <code>1</code>. 116 */ 117 #define MB_FUNC_OTHER_REP_SLAVEID_BUF ( 32 ) 118 119 /*! \brief If the <em>Report Slave ID</em> function should be enabled. */ 120 #define MB_FUNC_OTHER_REP_SLAVEID_ENABLED ( CONFIG_FMB_CONTROLLER_SLAVE_ID_SUPPORT ) 121 122 /*! \brief If the <em>Read Input Registers</em> function should be enabled. */ 123 #define MB_FUNC_READ_INPUT_ENABLED ( 1 ) 124 125 /*! \brief If the <em>Read Holding Registers</em> function should be enabled. */ 126 #define MB_FUNC_READ_HOLDING_ENABLED ( 1 ) 127 128 /*! \brief If the <em>Write Single Register</em> function should be enabled. */ 129 #define MB_FUNC_WRITE_HOLDING_ENABLED ( 1 ) 130 131 /*! \brief If the <em>Write Multiple registers</em> function should be enabled. */ 132 #define MB_FUNC_WRITE_MULTIPLE_HOLDING_ENABLED ( 1 ) 133 134 /*! \brief If the <em>Read Coils</em> function should be enabled. */ 135 #define MB_FUNC_READ_COILS_ENABLED ( 1 ) 136 137 /*! \brief If the <em>Write Coils</em> function should be enabled. */ 138 #define MB_FUNC_WRITE_COIL_ENABLED ( 1 ) 139 140 /*! \brief If the <em>Write Multiple Coils</em> function should be enabled. */ 141 #define MB_FUNC_WRITE_MULTIPLE_COILS_ENABLED ( 1 ) 142 143 /*! \brief If the <em>Read Discrete Inputs</em> function should be enabled. */ 144 #define MB_FUNC_READ_DISCRETE_INPUTS_ENABLED ( 1 ) 145 146 /*! \brief If the <em>Read/Write Multiple Registers</em> function should be enabled. */ 147 #define MB_FUNC_READWRITE_HOLDING_ENABLED ( 1 ) 148 149 /*! \brief Check the option to place timer handler into IRAM */ 150 #define MB_PORT_TIMER_ISR_IN_IRAM ( CONFIG_FMB_TIMER_ISR_IN_IRAM ) 151 152 /*! @} */ 153 #ifdef __cplusplus 154 PR_END_EXTERN_C 155 #endif 156 157 #if MB_MASTER_RTU_ENABLED || MB_MASTER_ASCII_ENABLED || MB_MASTER_TCP_ENABLED 158 /*! \brief If master send a broadcast frame, the master will wait time of convert to delay, 159 * then master can send other frame */ 160 #define MB_MASTER_DELAY_MS_CONVERT ( CONFIG_FMB_MASTER_DELAY_MS_CONVERT ) 161 /*! \brief If master send a frame which is not broadcast,the master will wait sometime for slave. 162 * And if slave is not respond in this time,the master will process this timeout error. 163 * Then master can send other frame */ 164 #define MB_MASTER_TIMEOUT_MS_RESPOND ( CONFIG_FMB_MASTER_TIMEOUT_MS_RESPOND ) 165 /*! \brief The total slaves in Modbus Master system. 166 * \note : The slave ID must be continuous from 1.*/ 167 #define MB_MASTER_TOTAL_SLAVE_NUM ( 247 ) 168 #endif 169 170 #endif 171
