449d2a6367
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
107 lines
5.1 KiB
C
107 lines
5.1 KiB
C
/* Copyright 2018 Espressif Systems (Shanghai) PTE LTD
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
#ifndef _MB_CONTROLLER_MASTER_H
|
|
#define _MB_CONTROLLER_MASTER_H
|
|
|
|
#include "freertos/FreeRTOS.h" // for task creation and queue access
|
|
#include "freertos/task.h" // for task api access
|
|
#include "freertos/event_groups.h" // for event groups
|
|
#include "driver/uart.h" // for UART types
|
|
#include "errno.h" // for errno
|
|
#include "esp_log.h" // for log write
|
|
#include "string.h" // for strerror()
|
|
#include "esp_modbus_common.h" // for common types
|
|
#include "esp_modbus_master.h" // for public master types
|
|
#include "esp_modbus_callbacks.h"
|
|
|
|
/* ----------------------- Defines ------------------------------------------*/
|
|
|
|
#define MB_MASTER_TAG "MB_CONTROLLER_MASTER"
|
|
|
|
#define MB_MASTER_CHECK(a, ret_val, str, ...) \
|
|
if (!(a)) { \
|
|
ESP_LOGE(MB_MASTER_TAG, "%s(%u): " str, __FUNCTION__, __LINE__, ##__VA_ARGS__); \
|
|
return (ret_val); \
|
|
}
|
|
|
|
#define MB_MASTER_ASSERT(con) do { \
|
|
if (!(con)) { ESP_LOGE(MB_MASTER_TAG, "assert errno:%d, errno_str: !(%s)", errno, strerror(errno)); assert(0 && #con); } \
|
|
} while (0)
|
|
|
|
/**
|
|
* @brief Request mode for parameter to use in data dictionary
|
|
*/
|
|
typedef enum {
|
|
MB_PARAM_READ, /*!< Read parameter values. */
|
|
MB_PARAM_WRITE /*!< Write parameter values. */
|
|
} mb_param_mode_t;
|
|
|
|
/**
|
|
* @brief Device communication parameters for master
|
|
*/
|
|
typedef struct {
|
|
mb_mode_type_t mode; /*!< Modbus communication mode */
|
|
uint8_t dummy; /*!< Dummy field */
|
|
uart_port_t port; /*!< Modbus communication port (UART) number */
|
|
uint32_t baudrate; /*!< Modbus baudrate */
|
|
uart_parity_t parity; /*!< Modbus UART parity settings */
|
|
} mb_master_comm_info_t;
|
|
|
|
/**
|
|
* @brief Modbus controller handler structure
|
|
*/
|
|
typedef struct {
|
|
mb_port_type_t port_type; /*!< Modbus port type */
|
|
mb_communication_info_t mbm_comm; /*!< Modbus communication info */
|
|
uint8_t* mbm_reg_buffer_ptr; /*!< Modbus data buffer pointer */
|
|
uint16_t mbm_reg_buffer_size; /*!< Modbus data buffer size */
|
|
TaskHandle_t mbm_task_handle; /*!< Modbus task handle */
|
|
EventGroupHandle_t mbm_event_group; /*!< Modbus controller event group */
|
|
const mb_parameter_descriptor_t* mbm_param_descriptor_table; /*!< Modbus controller parameter description table */
|
|
size_t mbm_param_descriptor_size; /*!< Modbus controller parameter description table size*/
|
|
} mb_master_options_t;
|
|
|
|
typedef esp_err_t (*iface_get_cid_info)(uint16_t, const mb_parameter_descriptor_t**); /*!< Interface get_cid_info method */
|
|
typedef esp_err_t (*iface_get_parameter)(uint16_t, char*, uint8_t*, uint8_t*); /*!< Interface get_parameter method */
|
|
typedef esp_err_t (*iface_send_request)(mb_param_request_t*, void*); /*!< Interface send_request method */
|
|
typedef esp_err_t (*iface_set_descriptor)(const mb_parameter_descriptor_t*, const uint16_t); /*!< Interface set_descriptor method */
|
|
typedef esp_err_t (*iface_set_parameter)(uint16_t, char*, uint8_t*, uint8_t*); /*!< Interface set_parameter method */
|
|
|
|
/**
|
|
* @brief Modbus controller interface structure
|
|
*/
|
|
typedef struct {
|
|
// Master object interface options
|
|
mb_master_options_t opts;
|
|
|
|
// Public interface methods
|
|
iface_init init; /*!< Interface method init */
|
|
iface_destroy destroy; /*!< Interface method destroy */
|
|
iface_setup setup; /*!< Interface method setup */
|
|
iface_start start; /*!< Interface method start */
|
|
iface_get_cid_info get_cid_info; /*!< Interface get_cid_info method */
|
|
iface_get_parameter get_parameter; /*!< Interface get_parameter method */
|
|
iface_send_request send_request; /*!< Interface send_request method */
|
|
iface_set_descriptor set_descriptor; /*!< Interface set_descriptor method */
|
|
iface_set_parameter set_parameter; /*!< Interface set_parameter method */
|
|
// Modbus register calback function pointers
|
|
reg_discrete_cb master_reg_cb_discrete; /*!< Stack callback discrete rw method */
|
|
reg_input_cb master_reg_cb_input; /*!< Stack callback input rw method */
|
|
reg_holding_cb master_reg_cb_holding; /*!< Stack callback holding rw method */
|
|
reg_coils_cb master_reg_cb_coils; /*!< Stack callback coils rw method */
|
|
} mb_master_interface_t;
|
|
|
|
#endif //_MB_CONTROLLER_MASTER_H
|