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
123 lines
4 KiB
C
123 lines
4 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 _ESP_MB_SLAVE_INTERFACE_H
|
|
#define _ESP_MB_SLAVE_INTERFACE_H
|
|
|
|
// Public interface header for slave
|
|
#include <stdint.h> // for standard int types definition
|
|
#include <stddef.h> // for NULL and std defines
|
|
#include "soc/soc.h" // for BITN definitions
|
|
#include "freertos/FreeRTOS.h" // for task creation and queues access
|
|
#include "freertos/event_groups.h" // for event groups
|
|
#include "esp_modbus_common.h" // for common types
|
|
|
|
/**
|
|
* @brief Parameter access event information type
|
|
*/
|
|
typedef struct {
|
|
uint32_t time_stamp; /*!< Timestamp of Modbus Event (uS)*/
|
|
uint16_t mb_offset; /*!< Modbus register offset */
|
|
mb_event_group_t type; /*!< Modbus event type */
|
|
uint8_t* address; /*!< Modbus data storage address */
|
|
size_t size; /*!< Modbus event register size (number of registers)*/
|
|
} mb_param_info_t;
|
|
|
|
/**
|
|
* @brief Parameter storage area descriptor
|
|
*/
|
|
typedef struct {
|
|
uint16_t start_offset; /*!< Modbus start address for area descriptor */
|
|
mb_param_type_t type; /*!< Type of storage area descriptor */
|
|
void* address; /*!< Instance address for storage area descriptor */
|
|
size_t size; /*!< Instance size for area descriptor (bytes) */
|
|
} mb_register_area_descriptor_t;
|
|
|
|
/**
|
|
* @brief Initialize Modbus controller and stack
|
|
*
|
|
* @param[out] handler handler(pointer) to master data structure
|
|
* @param[in] port_type type of stack
|
|
* @return
|
|
* - ESP_OK Success
|
|
* - ESP_ERR_NO_MEM Parameter error
|
|
*/
|
|
//esp_err_t mbc_slave_init(mb_port_type_t port_type, void** handler);
|
|
esp_err_t mbc_slave_init(mb_port_type_t port_type, void** handler);
|
|
|
|
/**
|
|
* @brief Destroy Modbus controller and stack
|
|
*
|
|
* @return
|
|
* - ESP_OK Success
|
|
* - ESP_ERR_INVALID_STATE Parameter error
|
|
*/
|
|
esp_err_t mbc_slave_destroy(void);
|
|
|
|
/**
|
|
* @brief Start Modbus communication stack
|
|
*
|
|
* @return
|
|
* - ESP_OK Success
|
|
* - ESP_ERR_INVALID_ARG Modbus stack start error
|
|
*/
|
|
esp_err_t mbc_slave_start(void);
|
|
|
|
/**
|
|
* @brief Set Modbus communication parameters for the controller
|
|
*
|
|
* @param comm_info Communication parameters structure.
|
|
*
|
|
* @return
|
|
* - ESP_OK Success
|
|
* - ESP_ERR_INVALID_ARG Incorrect parameter data
|
|
*/
|
|
esp_err_t mbc_slave_setup(void* comm_info);
|
|
|
|
/**
|
|
* @brief Wait for specific event on parameter change.
|
|
*
|
|
* @param group Group event bit mask to wait for change
|
|
*
|
|
* @return
|
|
* - mb_event_group_t event bits triggered
|
|
*/
|
|
mb_event_group_t mbc_slave_check_event(mb_event_group_t group);
|
|
|
|
/**
|
|
* @brief Get parameter information
|
|
*
|
|
* @param[out] reg_info parameter info structure
|
|
* @param timeout Timeout in milliseconds to read information from
|
|
* parameter queue
|
|
* @return
|
|
* - ESP_OK Success
|
|
* - ESP_ERR_TIMEOUT Can not get data from parameter queue
|
|
* or queue overflow
|
|
*/
|
|
esp_err_t mbc_slave_get_param_info(mb_param_info_t* reg_info, uint32_t timeout);
|
|
|
|
/**
|
|
* @brief Set Modbus area descriptor
|
|
*
|
|
* @param descr_data Modbus registers area descriptor structure
|
|
*
|
|
* @return
|
|
* - ESP_OK: The appropriate descriptor is set
|
|
* - ESP_ERR_INVALID_ARG: The argument is incorrect
|
|
*/
|
|
esp_err_t mbc_slave_set_descriptor(mb_register_area_descriptor_t descr_data);
|
|
|
|
#endif
|