mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
e26318bcac
Initial version of freemodbus master port files have been added to ESP-IDF based on https://github.com/armink/FreeModbus_Slave-Master-RTT-STM32. The overall repository license, at the time of adding these files, has been BSD 3-clause. However at that time, several port files carried LGPL license headers. As the author of these files confirmed in https://github.com/armink/FreeModbus_Slave-Master-RTT-STM32/issues/61#issuecomment-977828450, this wasn't intentional. ESP-IDF version of modbus master port has been rewritten to target FreeRTOS instead of RT-Thread, but the license headers remained from the original version. This commit corrects this, replacing the license of these files with BSD 3-clause.
289 lines
11 KiB
C
289 lines
11 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.
|
|
*/
|
|
/*
|
|
* FreeModbus Libary: ESP32 Port
|
|
* 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.
|
|
*
|
|
* File: $Id: portother.c,v 1.1 2010/06/06 13:07:20 wolti Exp $
|
|
*/
|
|
#include "port.h"
|
|
#include "driver/uart.h"
|
|
#include "freertos/queue.h" // for queue support
|
|
#include "soc/uart_periph.h"
|
|
#include "driver/gpio.h"
|
|
#include "esp_log.h" // for esp_log
|
|
#include "esp_err.h" // for ESP_ERROR_CHECK macro
|
|
|
|
/* ----------------------- Modbus includes ----------------------------------*/
|
|
#include "mb.h"
|
|
#include "mbport.h"
|
|
#include "sdkconfig.h" // for KConfig options
|
|
#include "port_serial_slave.h"
|
|
|
|
// Note: This code uses mixed coding standard from legacy IDF code and used freemodbus stack
|
|
|
|
// A queue to handle UART event.
|
|
static QueueHandle_t xMbUartQueue;
|
|
static TaskHandle_t xMbTaskHandle;
|
|
static const CHAR *TAG = "MB_SERIAL";
|
|
|
|
// The UART hardware port number
|
|
static UCHAR ucUartNumber = UART_NUM_MAX - 1;
|
|
|
|
static BOOL bRxStateEnabled = FALSE; // Receiver enabled flag
|
|
static BOOL bTxStateEnabled = FALSE; // Transmitter enabled flag
|
|
|
|
void vMBPortSerialEnable(BOOL bRxEnable, BOOL bTxEnable)
|
|
{
|
|
// This function can be called from xMBRTUTransmitFSM() of different task
|
|
if (bTxEnable) {
|
|
bTxStateEnabled = TRUE;
|
|
} else {
|
|
bTxStateEnabled = FALSE;
|
|
}
|
|
if (bRxEnable) {
|
|
//uart_enable_rx_intr(ucUartNumber);
|
|
bRxStateEnabled = TRUE;
|
|
vTaskResume(xMbTaskHandle); // Resume receiver task
|
|
} else {
|
|
vTaskSuspend(xMbTaskHandle); // Block receiver task
|
|
bRxStateEnabled = FALSE;
|
|
}
|
|
}
|
|
|
|
static USHORT usMBPortSerialRxPoll(size_t xEventSize)
|
|
{
|
|
BOOL xReadStatus = TRUE;
|
|
USHORT usCnt = 0;
|
|
|
|
if (bRxStateEnabled) {
|
|
// Get received packet into Rx buffer
|
|
while(xReadStatus && (usCnt++ <= MB_SERIAL_BUF_SIZE)) {
|
|
// Call the Modbus stack callback function and let it fill the buffers.
|
|
xReadStatus = pxMBFrameCBByteReceived(); // callback to execute receive FSM
|
|
}
|
|
uart_flush_input(ucUartNumber);
|
|
// Send event EV_FRAME_RECEIVED to allow stack process packet
|
|
#if !CONFIG_FMB_TIMER_PORT_ENABLED
|
|
// Let the stack know that T3.5 time is expired and data is received
|
|
(void)pxMBPortCBTimerExpired(); // calls callback xMBRTUTimerT35Expired();
|
|
#endif
|
|
ESP_LOGD(TAG, "RX: %d bytes\n", usCnt);
|
|
}
|
|
return usCnt;
|
|
}
|
|
|
|
BOOL xMBPortSerialTxPoll(void)
|
|
{
|
|
USHORT usCount = 0;
|
|
BOOL bNeedPoll = TRUE;
|
|
|
|
if( bTxStateEnabled ) {
|
|
// Continue while all response bytes put in buffer or out of buffer
|
|
while((bNeedPoll) && (usCount++ < MB_SERIAL_BUF_SIZE)) {
|
|
// Calls the modbus stack callback function to let it fill the UART transmit buffer.
|
|
bNeedPoll = pxMBFrameCBTransmitterEmpty( ); // callback to transmit FSM
|
|
}
|
|
ESP_LOGD(TAG, "MB_TX_buffer send: (%d) bytes\n", (uint16_t)usCount);
|
|
// Waits while UART sending the packet
|
|
esp_err_t xTxStatus = uart_wait_tx_done(ucUartNumber, MB_SERIAL_TX_TOUT_TICKS);
|
|
vMBPortSerialEnable(TRUE, FALSE);
|
|
MB_PORT_CHECK((xTxStatus == ESP_OK), FALSE, "mb serial sent buffer failure.");
|
|
return TRUE;
|
|
}
|
|
return FALSE;
|
|
}
|
|
|
|
static void vUartTask(void *pvParameters)
|
|
{
|
|
uart_event_t xEvent;
|
|
USHORT usResult = 0;
|
|
for(;;) {
|
|
if (xQueueReceive(xMbUartQueue, (void*)&xEvent, portMAX_DELAY) == pdTRUE) {
|
|
ESP_LOGD(TAG, "MB_uart[%d] event:", ucUartNumber);
|
|
switch(xEvent.type) {
|
|
//Event of UART receving data
|
|
case UART_DATA:
|
|
ESP_LOGD(TAG,"Data event, length: %d", xEvent.size);
|
|
// This flag set in the event means that no more
|
|
// data received during configured timeout and UART TOUT feature is triggered
|
|
if (xEvent.timeout_flag) {
|
|
// Read received data and send it to modbus stack
|
|
usResult = usMBPortSerialRxPoll(xEvent.size);
|
|
ESP_LOGD(TAG,"Timeout occured, processed: %d bytes", usResult);
|
|
}
|
|
break;
|
|
//Event of HW FIFO overflow detected
|
|
case UART_FIFO_OVF:
|
|
ESP_LOGD(TAG, "hw fifo overflow\n");
|
|
xQueueReset(xMbUartQueue);
|
|
break;
|
|
//Event of UART ring buffer full
|
|
case UART_BUFFER_FULL:
|
|
ESP_LOGD(TAG, "ring buffer full\n");
|
|
xQueueReset(xMbUartQueue);
|
|
uart_flush_input(ucUartNumber);
|
|
break;
|
|
//Event of UART RX break detected
|
|
case UART_BREAK:
|
|
ESP_LOGD(TAG, "uart rx break\n");
|
|
break;
|
|
//Event of UART parity check error
|
|
case UART_PARITY_ERR:
|
|
ESP_LOGD(TAG, "uart parity error\n");
|
|
break;
|
|
//Event of UART frame error
|
|
case UART_FRAME_ERR:
|
|
ESP_LOGD(TAG, "uart frame error\n");
|
|
break;
|
|
default:
|
|
ESP_LOGD(TAG, "uart event type: %d\n", xEvent.type);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
vTaskDelete(NULL);
|
|
}
|
|
|
|
BOOL xMBPortSerialInit(UCHAR ucPORT, ULONG ulBaudRate,
|
|
UCHAR ucDataBits, eMBParity eParity)
|
|
{
|
|
esp_err_t xErr = ESP_OK;
|
|
// Set communication port number
|
|
ucUartNumber = ucPORT;
|
|
// Configure serial communication parameters
|
|
UCHAR ucParity = UART_PARITY_DISABLE;
|
|
UCHAR ucData = UART_DATA_8_BITS;
|
|
switch(eParity){
|
|
case MB_PAR_NONE:
|
|
ucParity = UART_PARITY_DISABLE;
|
|
break;
|
|
case MB_PAR_ODD:
|
|
ucParity = UART_PARITY_ODD;
|
|
break;
|
|
case MB_PAR_EVEN:
|
|
ucParity = UART_PARITY_EVEN;
|
|
break;
|
|
default:
|
|
ESP_LOGE(TAG, "Incorrect parity option: %d", eParity);
|
|
return FALSE;
|
|
}
|
|
switch(ucDataBits){
|
|
case 5:
|
|
ucData = UART_DATA_5_BITS;
|
|
break;
|
|
case 6:
|
|
ucData = UART_DATA_6_BITS;
|
|
break;
|
|
case 7:
|
|
ucData = UART_DATA_7_BITS;
|
|
break;
|
|
case 8:
|
|
ucData = UART_DATA_8_BITS;
|
|
break;
|
|
default:
|
|
ucData = UART_DATA_8_BITS;
|
|
break;
|
|
}
|
|
uart_config_t xUartConfig = {
|
|
.baud_rate = ulBaudRate,
|
|
.data_bits = ucData,
|
|
.parity = ucParity,
|
|
.stop_bits = UART_STOP_BITS_1,
|
|
.flow_ctrl = UART_HW_FLOWCTRL_DISABLE,
|
|
.rx_flow_ctrl_thresh = 2,
|
|
.use_ref_tick = UART_SCLK_APB,
|
|
};
|
|
// Set UART config
|
|
xErr = uart_param_config(ucUartNumber, &xUartConfig);
|
|
MB_PORT_CHECK((xErr == ESP_OK),
|
|
FALSE, "mb config failure, uart_param_config() returned (0x%x).", xErr);
|
|
// Install UART driver, and get the queue.
|
|
xErr = uart_driver_install(ucUartNumber, MB_SERIAL_BUF_SIZE, MB_SERIAL_BUF_SIZE,
|
|
MB_QUEUE_LENGTH, &xMbUartQueue, MB_PORT_SERIAL_ISR_FLAG);
|
|
MB_PORT_CHECK((xErr == ESP_OK), FALSE,
|
|
"mb serial driver failure, uart_driver_install() returned (0x%x).", xErr);
|
|
#if !CONFIG_FMB_TIMER_PORT_ENABLED
|
|
// Set timeout for TOUT interrupt (T3.5 modbus time)
|
|
xErr = uart_set_rx_timeout(ucUartNumber, MB_SERIAL_TOUT);
|
|
MB_PORT_CHECK((xErr == ESP_OK), FALSE,
|
|
"mb serial set rx timeout failure, uart_set_rx_timeout() returned (0x%x).", xErr);
|
|
#endif
|
|
|
|
// Set always timeout flag to trigger timeout interrupt even after rx fifo full
|
|
uart_set_always_rx_timeout(ucUartNumber, true);
|
|
|
|
// Create a task to handle UART events
|
|
BaseType_t xStatus = xTaskCreatePinnedToCore(vUartTask, "uart_queue_task",
|
|
MB_SERIAL_TASK_STACK_SIZE,
|
|
NULL, MB_SERIAL_TASK_PRIO,
|
|
&xMbTaskHandle, MB_PORT_TASK_AFFINITY);
|
|
if (xStatus != pdPASS) {
|
|
vTaskDelete(xMbTaskHandle);
|
|
// Force exit from function with failure
|
|
MB_PORT_CHECK(FALSE, FALSE,
|
|
"mb stack serial task creation error. xTaskCreate() returned (0x%x).",
|
|
xStatus);
|
|
} else {
|
|
vTaskSuspend(xMbTaskHandle); // Suspend serial task while stack is not started
|
|
}
|
|
return TRUE;
|
|
}
|
|
|
|
void vMBPortSerialClose(void)
|
|
{
|
|
(void)vTaskSuspend(xMbTaskHandle);
|
|
(void)vTaskDelete(xMbTaskHandle);
|
|
ESP_ERROR_CHECK(uart_driver_delete(ucUartNumber));
|
|
}
|
|
|
|
BOOL xMBPortSerialPutByte(CHAR ucByte)
|
|
{
|
|
// Send one byte to UART transmission buffer
|
|
// This function is called by Modbus stack
|
|
UCHAR ucLength = uart_write_bytes(ucUartNumber, &ucByte, 1);
|
|
return (ucLength == 1);
|
|
}
|
|
|
|
// Get one byte from intermediate RX buffer
|
|
BOOL xMBPortSerialGetByte(CHAR* pucByte)
|
|
{
|
|
assert(pucByte != NULL);
|
|
USHORT usLength = uart_read_bytes(ucUartNumber, (uint8_t*)pucByte, 1, MB_SERIAL_RX_TOUT_TICKS);
|
|
return (usLength == 1);
|
|
}
|