mirror of
https://github.com/espressif/esp-idf.git
synced 2024-10-05 20:47:46 -04:00
394c2c100f
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.
209 lines
9.3 KiB
C
209 lines
9.3 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) 2013 Armink <armink.ztl@gmail.com>
|
|
*
|
|
* 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: porttimer_m.c,v 1.60 2013/08/13 15:07:05 Armink add Master Functions$
|
|
*/
|
|
|
|
/* ----------------------- Platform includes --------------------------------*/
|
|
#include "port.h"
|
|
|
|
/* ----------------------- Modbus includes ----------------------------------*/
|
|
#include "mb_m.h"
|
|
#include "mbport.h"
|
|
#include "port_serial_master.h"
|
|
#include "sdkconfig.h"
|
|
|
|
#define MB_US50_FREQ (20000) // 20kHz 1/20000 = 50mks
|
|
#define MB_TICK_TIME_US (50) // 50uS = one tick for timer
|
|
|
|
#define MB_TIMER_PRESCALLER ((TIMER_BASE_CLK / MB_US50_FREQ) - 1);
|
|
#define MB_TIMER_SCALE (TIMER_BASE_CLK / TIMER_DIVIDER)
|
|
#define MB_TIMER_DIVIDER ((TIMER_BASE_CLK / 1000000UL) * MB_TICK_TIME_US - 1) // divider for 50uS
|
|
#define MB_TIMER_WITH_RELOAD (1)
|
|
|
|
// Timer group and timer number to measure time (configurable in KConfig)
|
|
#define MB_TIMER_INDEX (CONFIG_FMB_TIMER_INDEX)
|
|
#define MB_TIMER_GROUP (CONFIG_FMB_TIMER_GROUP)
|
|
|
|
/* ----------------------- Variables ----------------------------------------*/
|
|
static USHORT usT35TimeOut50us;
|
|
|
|
static const USHORT usTimerIndex = MB_TIMER_INDEX; // Initialize Modbus Timer index used by stack,
|
|
static const USHORT usTimerGroupIndex = MB_TIMER_GROUP; // Timer group index used by stack
|
|
static timer_isr_handle_t xTimerIntHandle; // Timer interrupt handle
|
|
|
|
/* ----------------------- static functions ---------------------------------*/
|
|
|
|
static void IRAM_ATTR vTimerGroupIsr(void *param)
|
|
{
|
|
assert((int)param == usTimerIndex);
|
|
// Retrieve the the counter value from the timer that reported the interrupt
|
|
timer_group_clr_intr_status_in_isr(usTimerGroupIndex, usTimerIndex);
|
|
(void)pxMBMasterPortCBTimerExpired(); // Timer expired callback function
|
|
// Enable alarm
|
|
timer_group_enable_alarm_in_isr(usTimerGroupIndex, usTimerIndex);
|
|
}
|
|
|
|
/* ----------------------- Start implementation -----------------------------*/
|
|
BOOL xMBMasterPortTimersInit(USHORT usTimeOut50us)
|
|
{
|
|
MB_PORT_CHECK((usTimeOut50us > 0), FALSE,
|
|
"Modbus timeout discreet is incorrect.");
|
|
// Save timer reload value for Modbus T35 period
|
|
usT35TimeOut50us = usTimeOut50us;
|
|
esp_err_t xErr;
|
|
timer_config_t config;
|
|
config.alarm_en = TIMER_ALARM_EN;
|
|
config.auto_reload = MB_TIMER_WITH_RELOAD;
|
|
config.counter_dir = TIMER_COUNT_UP;
|
|
config.divider = MB_TIMER_PRESCALLER;
|
|
config.intr_type = TIMER_INTR_LEVEL;
|
|
config.counter_en = TIMER_PAUSE;
|
|
// Configure timer
|
|
xErr = timer_init(usTimerGroupIndex, usTimerIndex, &config);
|
|
MB_PORT_CHECK((xErr == ESP_OK), FALSE,
|
|
"timer init failure, timer_init() returned (0x%x).", (uint32_t)xErr);
|
|
// Stop timer counter
|
|
xErr = timer_pause(usTimerGroupIndex, usTimerIndex);
|
|
MB_PORT_CHECK((xErr == ESP_OK), FALSE,
|
|
"stop timer failure, timer_pause() returned (0x%x).", (uint32_t)xErr);
|
|
// Reset counter value
|
|
xErr = timer_set_counter_value(usTimerGroupIndex, usTimerIndex, 0x00000000ULL);
|
|
MB_PORT_CHECK((xErr == ESP_OK), FALSE,
|
|
"timer set value failure, timer_set_counter_value() returned (0x%x).",
|
|
(uint32_t)xErr);
|
|
// wait3T5_us = 35 * 11 * 100000 / baud; // the 3.5T symbol time for baudrate
|
|
// Set alarm value for usTimeOut50us * 50uS
|
|
xErr = timer_set_alarm_value(usTimerGroupIndex, usTimerIndex, (uint32_t)(usTimeOut50us));
|
|
MB_PORT_CHECK((xErr == ESP_OK), FALSE,
|
|
"failure to set alarm failure, timer_set_alarm_value() returned (0x%x).",
|
|
(uint32_t)xErr);
|
|
// Register ISR for timer
|
|
xErr = timer_isr_register(usTimerGroupIndex, usTimerIndex,
|
|
vTimerGroupIsr, (void*)(uint32_t)usTimerIndex, MB_PORT_TIMER_ISR_FLAG, &xTimerIntHandle);
|
|
MB_PORT_CHECK((xErr == ESP_OK), FALSE,
|
|
"timer set value failure, timer_isr_register() returned (0x%x).",
|
|
(uint32_t)xErr);
|
|
return TRUE;
|
|
}
|
|
|
|
// Set alarm value for usTimerTimeOut50us * 50uS
|
|
static BOOL xMBMasterPortTimersEnable(USHORT usTimerTics50us)
|
|
{
|
|
MB_PORT_CHECK((usTimerTics50us > 0), FALSE,
|
|
"incorrect tick value for timer = (0x%x).",
|
|
(uint32_t)usTimerTics50us);
|
|
esp_err_t xErr;
|
|
xErr = timer_pause(usTimerGroupIndex, usTimerIndex); // stop timer
|
|
MB_PORT_CHECK((xErr == ESP_OK), FALSE,
|
|
"timer pause failure, timer_pause() returned (0x%x).",
|
|
(uint32_t)xErr);
|
|
xErr = timer_set_counter_value(usTimerGroupIndex, usTimerIndex, 0ULL); // reset timer
|
|
MB_PORT_CHECK((xErr == ESP_OK), FALSE,
|
|
"timer set counter failure, timer_set_counter_value() returned (0x%x).",
|
|
(uint32_t)xErr);
|
|
// Set alarm value to number of 50uS ticks
|
|
xErr = timer_set_alarm_value(usTimerGroupIndex, usTimerIndex,
|
|
(uint32_t)(usTimerTics50us));
|
|
MB_PORT_CHECK((xErr == ESP_OK), FALSE,
|
|
"timer set alarm failure, timer_set_alarm_value() returned (0x%x).",
|
|
(uint32_t)xErr);
|
|
xErr = timer_enable_intr(usTimerGroupIndex, usTimerIndex);
|
|
MB_PORT_CHECK((xErr == ESP_OK), FALSE,
|
|
"timer enable interrupt failure, timer_enable_intr() returned (0x%x).",
|
|
(uint32_t)xErr);
|
|
xErr = timer_start(usTimerGroupIndex, usTimerIndex); // start timer
|
|
MB_PORT_CHECK((xErr == ESP_OK), FALSE,
|
|
"timer start failure, timer_start() returned (0x%x).",
|
|
(uint32_t)xErr);
|
|
return TRUE;
|
|
}
|
|
|
|
void vMBMasterPortTimersT35Enable(void)
|
|
{
|
|
USHORT usTimerTicks = usT35TimeOut50us;
|
|
|
|
// Set current timer mode, don't change it.
|
|
vMBMasterSetCurTimerMode(MB_TMODE_T35);
|
|
// Set timer period
|
|
(void)xMBMasterPortTimersEnable(usTimerTicks);
|
|
}
|
|
|
|
void vMBMasterPortTimersConvertDelayEnable(void)
|
|
{
|
|
// Covert time in milliseconds into ticks
|
|
USHORT usTimerTicks = ((MB_MASTER_DELAY_MS_CONVERT * 1000) / MB_TICK_TIME_US);
|
|
|
|
// Set current timer mode
|
|
vMBMasterSetCurTimerMode(MB_TMODE_CONVERT_DELAY);
|
|
ESP_LOGD(MB_PORT_TAG,"%s Convert delay enable.", __func__);
|
|
(void)xMBMasterPortTimersEnable(usTimerTicks);
|
|
}
|
|
|
|
void vMBMasterPortTimersRespondTimeoutEnable(void)
|
|
{
|
|
USHORT usTimerTicks = (MB_MASTER_TIMEOUT_MS_RESPOND * 1000 / MB_TICK_TIME_US);
|
|
|
|
vMBMasterSetCurTimerMode(MB_TMODE_RESPOND_TIMEOUT);
|
|
ESP_LOGD(MB_PORT_TAG,"%s Respond enable timeout.", __func__);
|
|
(void)xMBMasterPortTimersEnable(usTimerTicks);
|
|
}
|
|
|
|
void MB_PORT_ISR_ATTR
|
|
vMBMasterPortTimersDisable()
|
|
{
|
|
if( (BOOL)xPortInIsrContext() ) {
|
|
timer_group_set_counter_enable_in_isr(usTimerGroupIndex, usTimerIndex, TIMER_PAUSE);
|
|
} else {
|
|
// Stop timer and then reload timer counter value
|
|
ESP_ERROR_CHECK(timer_pause(usTimerGroupIndex, usTimerIndex));
|
|
ESP_ERROR_CHECK(timer_set_counter_value(usTimerGroupIndex, usTimerIndex, 0ULL));
|
|
// Disable timer interrupt
|
|
ESP_ERROR_CHECK(timer_disable_intr(usTimerGroupIndex, usTimerIndex));
|
|
}
|
|
}
|
|
|
|
void vMBMasterPortTimerClose(void)
|
|
{
|
|
ESP_ERROR_CHECK(timer_pause(usTimerGroupIndex, usTimerIndex));
|
|
ESP_ERROR_CHECK(timer_disable_intr(usTimerGroupIndex, usTimerIndex));
|
|
ESP_ERROR_CHECK(esp_intr_free(xTimerIntHandle));
|
|
}
|