2021-10-22 17:23:03 +00:00
|
|
|
/*
|
|
|
|
* SPDX-FileCopyrightText: 2010 Christian Walter
|
2018-06-28 15:45:41 +00:00
|
|
|
*
|
2021-10-22 17:23:03 +00:00
|
|
|
* SPDX-License-Identifier: BSD-3-Clause
|
2018-06-28 15:45:41 +00:00
|
|
|
*
|
2021-10-22 17:23:03 +00:00
|
|
|
* SPDX-FileContributor: 2016-2021 Espressif Systems (Shanghai) CO LTD
|
|
|
|
*/
|
|
|
|
/*
|
2021-11-25 11:45:44 +00:00
|
|
|
* FreeModbus Libary: ESP32 Port
|
2021-10-22 17:23:03 +00:00
|
|
|
* Copyright (C) 2010 Christian Walter <cwalter@embedded-solutions.at>
|
|
|
|
*
|
|
|
|
* 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
|
|
|
|
* IF 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.
|
2018-06-28 15:45:41 +00:00
|
|
|
*
|
2021-11-25 11:45:44 +00:00
|
|
|
* File: $Id: port.h,v 1.1 2010/06/06 13:07:20 wolti Exp $
|
2018-06-28 15:45:41 +00:00
|
|
|
*/
|
2018-10-19 13:51:27 +00:00
|
|
|
|
|
|
|
#ifndef PORT_COMMON_H_
|
|
|
|
#define PORT_COMMON_H_
|
|
|
|
|
2018-06-28 15:45:41 +00:00
|
|
|
#include "freertos/FreeRTOS.h"
|
2018-10-19 13:51:27 +00:00
|
|
|
#include "esp_log.h" // for ESP_LOGE macro
|
2021-10-12 15:06:13 +00:00
|
|
|
#include "esp_timer.h"
|
2020-07-21 16:34:04 +00:00
|
|
|
#include "mbconfig.h"
|
2018-06-28 15:45:41 +00:00
|
|
|
|
2018-10-19 13:51:27 +00:00
|
|
|
#define INLINE inline
|
|
|
|
#define PR_BEGIN_EXTERN_C extern "C" {
|
|
|
|
#define PR_END_EXTERN_C }
|
2018-06-28 15:45:41 +00:00
|
|
|
|
2020-07-21 16:34:04 +00:00
|
|
|
#define MB_PORT_TAG "MB_PORT_COMMON"
|
2018-06-28 15:45:41 +00:00
|
|
|
|
2020-07-21 16:34:04 +00:00
|
|
|
#define MB_BAUD_RATE_DEFAULT (115200)
|
|
|
|
#define MB_QUEUE_LENGTH (CONFIG_FMB_QUEUE_LENGTH)
|
2020-03-30 14:05:48 +00:00
|
|
|
|
2020-07-21 16:34:04 +00:00
|
|
|
#define MB_SERIAL_TASK_PRIO (CONFIG_FMB_PORT_TASK_PRIO)
|
|
|
|
#define MB_SERIAL_TASK_STACK_SIZE (CONFIG_FMB_PORT_TASK_STACK_SIZE)
|
|
|
|
#define MB_SERIAL_TOUT (3) // 3.5*8 = 28 ticks, TOUT=3 -> ~24..33 ticks
|
2020-03-30 14:05:48 +00:00
|
|
|
|
|
|
|
// Set buffer size for transmission
|
2020-07-21 16:34:04 +00:00
|
|
|
#define MB_SERIAL_BUF_SIZE (CONFIG_FMB_SERIAL_BUF_SIZE)
|
2020-03-30 14:05:48 +00:00
|
|
|
|
2019-11-26 05:16:25 +00:00
|
|
|
// common definitions for serial port implementations
|
2021-07-21 02:07:44 +00:00
|
|
|
#define MB_SERIAL_TX_TOUT_MS (2200) // maximum time for transmission of longest allowed frame buffer
|
2020-07-21 16:34:04 +00:00
|
|
|
#define MB_SERIAL_TX_TOUT_TICKS (pdMS_TO_TICKS(MB_SERIAL_TX_TOUT_MS)) // timeout for transmission
|
|
|
|
#define MB_SERIAL_RX_TOUT_MS (1)
|
|
|
|
#define MB_SERIAL_RX_TOUT_TICKS (pdMS_TO_TICKS(MB_SERIAL_RX_TOUT_MS)) // timeout for receive
|
2020-03-30 14:05:48 +00:00
|
|
|
|
2020-07-21 16:34:04 +00:00
|
|
|
#define MB_SERIAL_RESP_LEN_MIN (4)
|
|
|
|
|
|
|
|
// Common definitions for TCP port
|
|
|
|
#define MB_TCP_BUF_SIZE (256 + 7) // Must hold a complete Modbus TCP frame.
|
|
|
|
#define MB_TCP_DEFAULT_PORT (CONFIG_FMB_TCP_PORT_DEFAULT)
|
|
|
|
#define MB_TCP_STACK_SIZE (CONFIG_FMB_PORT_TASK_STACK_SIZE)
|
|
|
|
#define MB_TCP_TASK_PRIO (CONFIG_FMB_PORT_TASK_PRIO)
|
|
|
|
|
2021-03-16 11:06:22 +00:00
|
|
|
// The task affinity for Modbus stack tasks
|
|
|
|
#define MB_PORT_TASK_AFFINITY (CONFIG_FMB_PORT_TASK_AFFINITY)
|
|
|
|
|
2020-07-21 16:34:04 +00:00
|
|
|
#define MB_TCP_READ_TIMEOUT_MS (100) // read timeout in mS
|
|
|
|
#define MB_TCP_READ_TIMEOUT (pdMS_TO_TICKS(MB_TCP_READ_TIMEOUT_MS))
|
|
|
|
#define MB_TCP_SEND_TIMEOUT_MS (500) // send event timeout in mS
|
|
|
|
#define MB_TCP_SEND_TIMEOUT (pdMS_TO_TICKS(MB_TCP_SEND_TIMEOUT_MS))
|
|
|
|
#define MB_TCP_PORT_MAX_CONN (CONFIG_FMB_TCP_PORT_MAX_CONN)
|
|
|
|
|
|
|
|
#define MB_TCP_FRAME_LOG_BUFSIZE (256)
|
|
|
|
|
2021-08-13 14:46:09 +00:00
|
|
|
#define MB_PORT_HAS_CLOSE (1) // Define to explicitly close port on destroy
|
|
|
|
|
2020-07-21 16:34:04 +00:00
|
|
|
// Define number of timer reloads per 1 mS
|
|
|
|
#define MB_TIMER_TICS_PER_MS (20UL)
|
2021-10-12 15:06:13 +00:00
|
|
|
#define MB_TIMER_TICK_TIME_US (1000 / MB_TIMER_TICS_PER_MS) // 50uS = one discreet for timer
|
2020-07-21 16:34:04 +00:00
|
|
|
|
|
|
|
#define MB_TCP_DEBUG (LOG_LOCAL_LEVEL >= ESP_LOG_DEBUG) // Enable legacy debug output in TCP module.
|
|
|
|
|
|
|
|
#define MB_TCP_GET_FIELD(buffer, field) ((USHORT)((buffer[field] << 8U) | buffer[field + 1]))
|
2019-11-26 05:16:25 +00:00
|
|
|
|
2018-06-28 15:45:41 +00:00
|
|
|
#define MB_PORT_CHECK(a, ret_val, str, ...) \
|
|
|
|
if (!(a)) { \
|
|
|
|
ESP_LOGE(MB_PORT_TAG, "%s(%u): " str, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
|
2019-11-08 08:55:42 +00:00
|
|
|
return ret_val; \
|
2018-06-28 15:45:41 +00:00
|
|
|
}
|
|
|
|
|
2018-10-19 13:51:27 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
PR_BEGIN_EXTERN_C
|
|
|
|
#endif /* __cplusplus */
|
2018-06-28 15:45:41 +00:00
|
|
|
|
2018-10-19 13:51:27 +00:00
|
|
|
#ifndef TRUE
|
|
|
|
#define TRUE 1
|
|
|
|
#endif
|
2019-03-07 08:51:25 +00:00
|
|
|
|
2018-10-19 13:51:27 +00:00
|
|
|
#ifndef FALSE
|
|
|
|
#define FALSE 0
|
|
|
|
#endif
|
2018-06-28 15:45:41 +00:00
|
|
|
|
|
|
|
typedef char BOOL;
|
|
|
|
|
|
|
|
typedef unsigned char UCHAR;
|
|
|
|
typedef char CHAR;
|
|
|
|
|
|
|
|
typedef unsigned short USHORT;
|
|
|
|
typedef short SHORT;
|
|
|
|
|
|
|
|
typedef unsigned long ULONG;
|
|
|
|
typedef long LONG;
|
|
|
|
|
2020-07-21 16:34:04 +00:00
|
|
|
#if MB_TCP_DEBUG
|
|
|
|
typedef enum
|
|
|
|
{
|
|
|
|
MB_LOG_DEBUG,
|
|
|
|
MB_LOG_INFO,
|
|
|
|
MB_LOG_WARN,
|
|
|
|
MB_LOG_ERROR
|
|
|
|
} eMBPortLogLevel;
|
|
|
|
#endif
|
|
|
|
|
|
|
|
typedef enum
|
|
|
|
{
|
|
|
|
MB_PROTO_TCP,
|
|
|
|
MB_PROTO_UDP,
|
|
|
|
} eMBPortProto;
|
|
|
|
|
|
|
|
typedef enum {
|
|
|
|
MB_PORT_IPV4 = 0, /*!< TCP IPV4 addressing */
|
|
|
|
MB_PORT_IPV6 = 1 /*!< TCP IPV6 addressing */
|
|
|
|
} eMBPortIpVer;
|
|
|
|
|
2021-10-12 15:06:13 +00:00
|
|
|
typedef struct {
|
|
|
|
esp_timer_handle_t xTimerIntHandle;
|
|
|
|
USHORT usT35Ticks;
|
|
|
|
BOOL xTimerState;
|
|
|
|
} xTimerContext_t;
|
|
|
|
|
2019-07-16 09:33:30 +00:00
|
|
|
void vMBPortEnterCritical(void);
|
|
|
|
void vMBPortExitCritical(void);
|
2018-06-28 15:45:41 +00:00
|
|
|
|
2020-07-21 16:34:04 +00:00
|
|
|
#define ENTER_CRITICAL_SECTION( ) { ESP_EARLY_LOGD(MB_PORT_TAG,"%s: Port enter critical.", __func__); \
|
2018-10-19 13:51:27 +00:00
|
|
|
vMBPortEnterCritical(); }
|
2018-06-28 15:45:41 +00:00
|
|
|
|
2018-10-19 13:51:27 +00:00
|
|
|
#define EXIT_CRITICAL_SECTION( ) { vMBPortExitCritical(); \
|
2020-07-21 16:34:04 +00:00
|
|
|
ESP_EARLY_LOGD(MB_PORT_TAG,"%s: Port exit critical", __func__); }
|
2018-06-28 15:45:41 +00:00
|
|
|
|
2019-12-10 06:27:09 +00:00
|
|
|
#define MB_PORT_CHECK_EVENT( event, mask ) ( event & mask )
|
|
|
|
#define MB_PORT_CLEAR_EVENT( event, mask ) do { event &= ~mask; } while(0)
|
|
|
|
|
2021-01-11 09:55:36 +00:00
|
|
|
#define MB_PORT_PARITY_GET(parity) ((parity != UART_PARITY_DISABLE) ? \
|
|
|
|
((parity == UART_PARITY_ODD) ? MB_PAR_ODD : MB_PAR_EVEN) : MB_PAR_NONE)
|
|
|
|
|
2020-07-21 16:34:04 +00:00
|
|
|
// Legacy Modbus logging function
|
|
|
|
#if MB_TCP_DEBUG
|
|
|
|
void vMBPortLog( eMBPortLogLevel eLevel, const CHAR * szModule,
|
|
|
|
const CHAR * szFmt, ... );
|
|
|
|
void prvvMBTCPLogFrame( const CHAR * pucMsg, UCHAR * pucFrame, USHORT usFrameLen );
|
|
|
|
#endif
|
|
|
|
|
|
|
|
void vMBPortSetMode( UCHAR ucMode );
|
|
|
|
UCHAR ucMBPortGetMode( void );
|
|
|
|
|
2018-06-28 15:45:41 +00:00
|
|
|
#ifdef __cplusplus
|
2018-10-19 13:51:27 +00:00
|
|
|
PR_END_EXTERN_C
|
2018-06-28 15:45:41 +00:00
|
|
|
#endif /* __cplusplus */
|
|
|
|
|
2018-10-19 13:51:27 +00:00
|
|
|
#endif /* PORT_COMMON_H_ */
|