瑞萨RA6M5移植FreeModbus库实现Modbus从机

xinmeng_wit

一、简介

Modbus是一种串行通信协议，是Modicon公司（现在的施耐德电气 Schneider Electric）于1979年为使用可编程逻辑控制器（PLC）通信而发表。
Modbus已经成为工业领域通信协议的业界标准（De facto），并且现在是工业电子设备之间常用的连接方式。

Modbus通信协议是一种主从的协议，在一个Modbus网络里面只能有一个主机，但是可以有多个从机，从机与从机之间通过地址进行区分，每个从机都具有唯一的设备地址。
每次通讯必须由主机进行发起，从机进行响应。

本次基于开发板的485硬件接口移植Modbus开源协议栈FreeModbus实现Modbus从机。
（FreeModbus目前只能支持从机）


二、FSP驱动配置

FreeModbus库需要用到硬件资源包括：
①485接口（开发板已经板载有TTL转485芯片，对于MCU来说就是配置UART）
②timer定时器

（1）、UART配置
首先打开原理图，确认板载的485接口接在开发板的哪个串口上，引脚号是多少



从原理图可以看到，第一路485接在uart5上，端口号为：P501,P502,P503

因此FSP配置UART5如下：








（2）、配置timer

为了能够与FreeModbus对接，驱动需要配置时间基准为50us的定时器，并开启溢出中断。

根据手册，RA6M5一共有10个通用定时器，其中0~3为32位定时器，其余为16位定时器，如下：



我这里就选择timer3来进行配置：



另外，可以根据需要再配置一路uart作为调试串口使用，我配置了uart4作为调试串口，配置方法与uart5基本类似。

现在，需要配置的硬件都已经配置好了（别忘了点击按钮生成代码哦），可以正式开始移植了。

三、移植FreeModbus

（1）、下载FreeModbus源码

源码下载地址：https://www.embedded-experts.at/en/freemodbus-downloads/



（2）、将源码加入工程

源码解压后，得到如下文件和文件夹：



我们需要的是modbus这个文件夹，和demo->BARE下的port文件夹。

将这个两个文件夹添加到工程中：



添加头文件路径“



（3）、修改portserial.c文件

portserial.c文件主要是对UART驱动的对接，需要对接的函数主要有4个。

① void vMBPortSerialEnable( BOOL xRxEnable, BOOL xTxEnable )
用于对串口发送和接收进行使能或者失能

② BOOL xMBPortSerialInit( UCHAR ucPORT, ULONG ulBaudRate, UCHAR ucDataBits, eMBParity eParity )
用于对485进行初始化

③BOOLxMBPortSerialPutByte( CHAR ucByte )
用于485发送一个字节

④BOOLxMBPortSerialGetByte( CHAR * pucByte )
用于485读取一个字节

另外，我将uart的回调函数也是放在这个文件中。
对接后完整portserial.c文件如下：

1. /*
   
2. * FreeModbus Libary: BARE Port
   
3. * Copyright (C) 2006 Christian Walter <wolti@sil.at>
   
4. *
   
5. * This library is free software; you can redistribute it and/or
   
6. * modify it under the terms of the GNU Lesser General Public
   
7. * License as published by the Free Software Foundation; either
   
8. * version 2.1 of the License, or (at your option) any later version.
   
9. *
   
10. * This library is distributed in the hope that it will be useful,
    
11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
    
12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    
13. * Lesser General Public License for more details.
    
14. *
    
15. * You should have received a copy of the GNU Lesser General Public
    
16. * License along with this library; if not, write to the Free Software
    
17. * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    
18. *
    
19. * File: $Id$
    
20. */
    
21. 
    
22. #include "port.h"
    
23. #include "uart.h"
    
24. #include "hal_data.h"
    
25. 
    
26. /* ----------------------- Modbus includes ----------------------------------*/
    
27. #include "mb.h"
    
28. #include "mbport.h"
    
29. 
    
30. /* ----------------------- static functions ---------------------------------*/
    
31. static void prvvUARTTxReadyISR( void );
    
32. static void prvvUARTRxISR( void );
    
33. 
    
34. /* ----------------------- Start implementation -----------------------------*/
    
35. void
    
36. vMBPortSerialEnable( BOOL xRxEnable, BOOL xTxEnable )
    
37. {
    
38.     /* If xRXEnable enable serial receive interrupts. If xTxENable enable
    
39.      * transmitter empty interrupts.
    
40.      */
    
41.     if (xRxEnable == TRUE)
    
42.     {
    
43.         uart5_rx_state = UART5_RX_ENABLE;
    
44.     }
    
45.     else
    
46.     {
    
47.         uart5_rx_state = UART5_RX_DISABLE;
    
48.     }
    
49. 
    
50.     if (xTxEnable == TRUE)
    
51.     {
    
52.         uart5_tx_state = UART5_TX_ENABLE;
    
53.     }
    
54.     else
    
55.     {
    
56.         uart5_tx_state = UART5_TX_DISABLE;
    
57.     }   
    
58. }
    
59. 
    
60. BOOL
    
61. xMBPortSerialInit( UCHAR ucPORT, ULONG ulBaudRate, UCHAR ucDataBits, eMBParity eParity )
    
62. {
    
63.     uart5_init();
    
64.     return TRUE;
    
65. }
    
66. 
    
67. BOOL
    
68. xMBPortSerialPutByte( CHAR ucByte )
    
69. {
    
70.     /* Put a byte in the UARTs transmit buffer. This function is called
    
71.      * by the protocol stack if pxMBFrameCBTransmitterEmpty( ) has been
    
72.      * called. */
    
73.     R_SCI_UART_Write(&g_uart5_ctrl, &ucByte, 1);
    
74.     return TRUE;
    
75. }
    
76. 
    
77. BOOL
    
78. xMBPortSerialGetByte( CHAR * pucByte )
    
79. {
    
80.     /* Return the byte in the UARTs receive buffer. This function is called
    
81.      * by the protocol stack after pxMBFrameCBByteReceived( ) has been called.
    
82.      */
    
83.     //R_SCI_UART_Read (&g_uart5_ctrl, pucByte, 1);
    
84.     *pucByte = uart5_recv_data;
    
85.     return TRUE;
    
86. }
    
87. 
    
88. /* Create an interrupt handler for the transmit buffer empty interrupt
    
89. * (or an equivalent) for your target processor. This function should then
    
90. * call pxMBFrameCBTransmitterEmpty( ) which tells the protocol stack that
    
91. * a new character can be sent. The protocol stack will then call
    
92. * xMBPortSerialPutByte( ) to send the character.
    
93. */
    
94. static void prvvUARTTxReadyISR( void )
    
95. {
    
96.     pxMBFrameCBTransmitterEmpty(  );
    
97. }
    
98. 
    
99. /* Create an interrupt handler for the receive interrupt for your target
    
100. * processor. This function should then call pxMBFrameCBByteReceived( ). The
     
101. * protocol stack will then call xMBPortSerialGetByte( ) to retrieve the
     
102. * character.
     
103. */
     
104. static void prvvUARTRxISR( void )
     
105. {
     
106.     pxMBFrameCBByteReceived(  );
     
107. }
     
108. 
     
109. /* uart4中断回调函数 */
     
110. void uart5_callback (uart_callback_args_t * p_args)
     
111. {
     
112.     /* Handle the UART event */
     
113.     switch (p_args->event)
     
114.     {
     
115.         /* Received a character */
     
116.         case UART_EVENT_RX_CHAR:
     
117.         {
     
118.             if (uart5_rx_state == UART5_RX_ENABLE)
     
119.             {
     
120.                 uart5_recv_data = p_args->data;
     
121.                 //R_SCI_UART_Write(&g_uart4_ctrl, &uart5_recv_data, 1);
     
122.                 prvvUARTRxISR();               
     
123.             }
     
124. 
     
125.             break;
     
126.         }
     
127.         /* Receive complete */
     
128.         case UART_EVENT_RX_COMPLETE:
     
129.         {
     
130.             break;
     
131.         }
     
132.         /* Transmit complete */
     
133.         case UART_EVENT_TX_COMPLETE:
     
134.         {
     
135.             //uart4_tx_complete = true;
     
136.             if (uart5_tx_state == UART5_TX_ENABLE)
     
137.             {
     
138.                 prvvUARTTxReadyISR();
     
139.             }
     
140.             break;
     
141.         }
     
142.         default:
     
143.         {
     
144.         }
     
145.     }
     
146. }
     

复制代码

（4）、修改porttimer.c文件

该文件需要对接3个函数。

① BOOL xMBPortTimersInit( USHORT usTim1Timerout50us )
用于对timer进行初始化

② void vMBPortTimersEnable(  )
用于使能timer，让timer开始计数

③ void vMBPortTimersDisable(  )
用于失能timer，让timer停止计数

另外，timer中断的回调函数也是放在这个文件中。
对接后完整porttimer.c文件如下：

1. /*
   
2. * FreeModbus Libary: BARE Port
   
3. * Copyright (C) 2006 Christian Walter <wolti@sil.at>
   
4. *
   
5. * This library is free software; you can redistribute it and/or
   
6. * modify it under the terms of the GNU Lesser General Public
   
7. * License as published by the Free Software Foundation; either
   
8. * version 2.1 of the License, or (at your option) any later version.
   
9. *
   
10. * This library is distributed in the hope that it will be useful,
    
11. * but WITHOUT ANY WARRANTY; without even the implied warranty of
    
12. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    
13. * Lesser General Public License for more details.
    
14. *
    
15. * You should have received a copy of the GNU Lesser General Public
    
16. * License along with this library; if not, write to the Free Software
    
17. * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
    
18. *
    
19. * File: $Id$
    
20. */
    
21. 
    
22. /* ----------------------- Platform includes --------------------------------*/
    
23. #include "port.h"
    
24. 
    
25. /* ----------------------- Modbus includes ----------------------------------*/
    
26. #include "mb.h"
    
27. #include "mbport.h"
    
28. #include "hal_data.h"
    
29. #include <stdio.h>
    
30. /* ----------------------- static functions ---------------------------------*/
    
31. static void prvvTIMERExpiredISR( void );
    
32. 
    
33. /* ----------------------- Start implementation -----------------------------*/
    
34. BOOL
    
35. xMBPortTimersInit( USHORT usTim1Timerout50us )
    
36. {
    
37.     /* Initializes the module. */
    
38.     fsp_err_t err = R_GPT_Open(&g_timer3_ctrl, &g_timer3_cfg);
    
39.     if(err != FSP_SUCCESS)
    
40.     {
    
41.         printf("gpt3 open error\r\n");
    
42.     }  
    
43. 
    
44.     /* 设置timer的中断周期
    
45.     ** 100表示timer的计数时钟是100MHz
    
46.      */
    
47.     err = R_GPT_PeriodSet(&g_timer3_ctrl, (uint32_t)usTim1Timerout50us * 50U * 100U);
    
48.     if(err != FSP_SUCCESS)
    
49.     {
    
50.         printf("gpt3 periodset error\r\n");
    
51.     }  
    
52.     return TRUE;
    
53. }
    
54. 
    
55. 
    
56. void
    
57. vMBPortTimersEnable(  )
    
58. {
    
59.     /* Enable the timer with the timeout passed to xMBPortTimersInit( ) */
    
60. 
    
61.     fsp_err_t err = R_GPT_Reset (&g_timer3_ctrl);
    
62.     if(err != FSP_SUCCESS)
    
63.     {
    
64.         printf("gpt3 reset error\r\n");
    
65.     }   
    
66. 
    
67.     /* Start the timer. */
    
68.     err = R_GPT_Start(&g_timer3_ctrl);
    
69.     if(err != FSP_SUCCESS)
    
70.     {
    
71.         printf("gpt3 start error\r\n");
    
72.     }      
    
73. }
    
74. 
    
75. void
    
76. vMBPortTimersDisable(  )
    
77. {
    
78.     /* Disable any pending timers. */
    
79.     fsp_err_t err = R_GPT_Stop (&g_timer3_ctrl);
    
80.     if(err != FSP_SUCCESS)
    
81.     {
    
82.         printf("gpt3 stop error\r\n");
    
83.     }      
    
84. }
    
85. 
    
86. /* Create an ISR which is called whenever the timer has expired. This function
    
87. * must then call pxMBPortCBTimerExpired( ) to notify the protocol stack that
    
88. * the timer has expired.
    
89. */
    
90. static void prvvTIMERExpiredISR( void )
    
91. {
    
92.     ( void )pxMBPortCBTimerExpired(  );
    
93. }
    
94. 
    
95. 
    
96. /* 定时器中断回调函数. */
    
97. void g_timer3_callback (timer_callback_args_t * p_args)
    
98. {
    
99.     if (TIMER_EVENT_CYCLE_END == p_args->event)
    
100.     {
     
101.         uint8_t led_status;   
     
102.         R_IOPORT_PinRead (&g_ioport_ctrl, BSP_IO_PORT_04_PIN_00, (bsp_io_level_t *)&led_status);
     
103.         if(led_status)
     
104.         {
     
105.             R_IOPORT_PinWrite(&g_ioport_ctrl, BSP_IO_PORT_04_PIN_00, BSP_IO_LEVEL_LOW);
     
106.         }
     
107.         else
     
108.         {
     
109.             R_IOPORT_PinWrite(&g_ioport_ctrl, BSP_IO_PORT_04_PIN_00, BSP_IO_LEVEL_HIGH);
     
110.         }
     
111.         /* Add application code to be called periodically here. */
     
112.         prvvTIMERExpiredISR();
     
113.     }
     
114. }
     

复制代码

（5）、定义Modbus寄存器并实现读写函数

我将寄存器定义和读写函数的实现放在了自己定义的modbus_read_write.c文件中，完整代码如下：
注意：这个几个函数必须实现，否则会报错

1. 
   
2. /* ----------------------- Platform includes --------------------------------*/
   
3. #include "port.h"
   
4. 
   
5. /* ----------------------- Modbus includes ----------------------------------*/
   
6. #include "mb.h"
   
7. #include "mbport.h"
   
8. 
   
9. /* ----------------------- Defines ------------------------------------------*/
   
10. #define REG_INPUT_START   1000
    
11. #define REG_INPUT_NREGS   4
    
12. #define REG_HOLDING_START 1000
    
13. #define REG_HOLDING_NREGS 130
    
14. 
    
15. /* ----------------------- Static variables ---------------------------------*/
    
16. static USHORT   usRegInputStart = REG_INPUT_START;
    
17. static USHORT   usRegInputBuf[REG_INPUT_NREGS] = {1,2,3,4};
    
18. static USHORT   usRegHoldingStart = REG_HOLDING_START;
    
19. static USHORT   usRegHoldingBuf[REG_HOLDING_NREGS] = {10,11,12,13};
    
20. 
    
21. /* ----------------------- Start implementation -----------------------------*/
    
22. 
    
23. void free_modbus_init(eMBMode eMode, UCHAR ucSlaveAddress, UCHAR ucPort, ULONG ulBaudRate, eMBParity eParity)
    
24. {
    
25.     eMBInit( eMode, ucSlaveAddress, ucPort, ulBaudRate, eParity );
    
26.     eMBEnable();
    
27. }
    
28. 
    
29. eMBErrorCode
    
30. eMBRegInputCB( UCHAR * pucRegBuffer, USHORT usAddress, USHORT usNRegs )
    
31. {
    
32.     eMBErrorCode    eStatus = MB_ENOERR;
    
33.     int             iRegIndex;
    
34. 
    
35.     if( ( usAddress >= REG_INPUT_START )
    
36.         && ( usAddress + usNRegs <= REG_INPUT_START + REG_INPUT_NREGS ) )
    
37.     {
    
38.         iRegIndex = ( int )( usAddress - usRegInputStart );
    
39.         while( usNRegs > 0 )
    
40.         {
    
41.             *pucRegBuffer++ = ( unsigned char )( usRegInputBuf[iRegIndex] >> 8 );
    
42.             *pucRegBuffer++ = ( unsigned char )( usRegInputBuf[iRegIndex] & 0xFF );
    
43.             iRegIndex++;
    
44.             usNRegs--;
    
45.         }
    
46.     }
    
47.     else
    
48.     {
    
49.         eStatus = MB_ENOREG;
    
50.     }
    
51. 
    
52.     return eStatus;
    
53. }
    
54. 
    
55. eMBErrorCode
    
56. eMBRegHoldingCB( UCHAR * pucRegBuffer, USHORT usAddress, USHORT usNRegs, eMBRegisterMode eMode )
    
57. {
    
58.     eMBErrorCode    eStatus = MB_ENOERR;
    
59.     int             iRegIndex;
    
60. 
    
61.     if( ( usAddress >= REG_HOLDING_START ) &&
    
62.         ( usAddress + usNRegs <= REG_HOLDING_START + REG_HOLDING_NREGS ) )
    
63.     {
    
64.         iRegIndex = ( int )( usAddress - usRegHoldingStart );
    
65.         switch ( eMode )
    
66.         {
    
67.             /* Pass current register values to the protocol stack. */
    
68.         case MB_REG_READ:
    
69.             while( usNRegs > 0 )
    
70.             {
    
71.                 *pucRegBuffer++ = ( unsigned char )( usRegHoldingBuf[iRegIndex] >> 8 );
    
72.                 *pucRegBuffer++ = ( unsigned char )( usRegHoldingBuf[iRegIndex] & 0xFF );
    
73.                 iRegIndex++;
    
74.                 usNRegs--;
    
75.             }
    
76.             break;
    
77. 
    
78.             /* Update current register values with new values from the
    
79.              * protocol stack. */
    
80.         case MB_REG_WRITE:
    
81.             while( usNRegs > 0 )
    
82.             {
    
83.                 usRegHoldingBuf[iRegIndex] = *pucRegBuffer++ << 8;
    
84.                 usRegHoldingBuf[iRegIndex] |= *pucRegBuffer++;
    
85.                 iRegIndex++;
    
86.                 usNRegs--;
    
87.             }
    
88.         }
    
89.     }
    
90.     else
    
91.     {
    
92.         eStatus = MB_ENOREG;
    
93.     }
    
94.     return eStatus;
    
95. }
    
96. 
    
97. eMBErrorCode
    
98. eMBRegCoilsCB( UCHAR * pucRegBuffer, USHORT usAddress, USHORT usNCoils, eMBRegisterMode eMode )
    
99. {
    
100.     return MB_ENOREG;
     
101. }
     
102. 
     
103. eMBErrorCode
     
104. eMBRegDiscreteCB( UCHAR * pucRegBuffer, USHORT usAddress, USHORT usNDiscrete )
     
105. {
     
106.     return MB_ENOREG;
     
107. }
     

复制代码

（6）、修改hal_entry.c文件

在hal_entry()函数中加入Modbus初始化相关内容和状态轮询函数，完整内容如下：

1. void hal_entry(void)
   
2. {
   
3.     /* TODO: add your own code here */
   
4.     /* 初始化GPIO端口 */
   
5.     R_IOPORT_Open(&g_ioport_ctrl, &g_bsp_pin_cfg);
   
6.     /* 初始化uart4，作为调试串口使S用 */
   
7.     uart4_init();
   
8.     //uart5_init();//初始化uart5
   
9.     printf("Renesas RA6M5 Start...\r\n");
   
10.     /* 初始化Modbus端口和状态 */
    
11.     free_modbus_init(MB_RTU, 1, 5, 9600, MB_PAR_NONE);
    
12.     while(1)
    
13.     {
    
14.         /* 状态机轮询 */
    
15.         ( void )eMBPoll();               
    
16.     }
    
17. #if BSP_TZ_SECURE_BUILD
    
18.     /* Enter non-secure code */
    
19.     R_BSP_NonSecureEnter();
    
20. #endif
    
21. }

复制代码

（7）、修改mbrtu.c文件

修改mbrtu.c中eMBRTUSend函数，如果不修改无法触发485发送。



修改后MBRTUSend函数完整内容如下：

1. eMBErrorCode
   
2. eMBRTUSend( UCHAR ucSlaveAddress, const UCHAR * pucFrame, USHORT usLength )
   
3. {
   
4.     eMBErrorCode    eStatus = MB_ENOERR;
   
5.     USHORT          usCRC16;
   
6. 
   
7.     ENTER_CRITICAL_SECTION(  );
   
8. 
   
9.     /* Check if the receiver is still in idle state. If not we where to
   
10.      * slow with processing the received frame and the master sent another
    
11.      * frame on the network. We have to abort sending the frame.
    
12.      */
    
13.     if( eRcvState == STATE_RX_IDLE )
    
14.     {
    
15.         /* First byte before the Modbus-PDU is the slave address. */
    
16.         pucSndBufferCur = ( UCHAR * ) pucFrame - 1;
    
17.         usSndBufferCount = 1;
    
18. 
    
19.         /* Now copy the Modbus-PDU into the Modbus-Serial-Line-PDU. */
    
20.         pucSndBufferCur[MB_SER_PDU_ADDR_OFF] = ucSlaveAddress;
    
21.         usSndBufferCount += usLength;
    
22. 
    
23.         /* Calculate CRC16 checksum for Modbus-Serial-Line-PDU. */
    
24.         usCRC16 = usMBCRC16( ( UCHAR * ) pucSndBufferCur, usSndBufferCount );
    
25.         ucRTUBuf[usSndBufferCount++] = ( UCHAR )( usCRC16 & 0xFF );
    
26.         ucRTUBuf[usSndBufferCount++] = ( UCHAR )( usCRC16 >> 8 );
    
27. 
    
28.         /* Activate the transmitter. */
    
29.         eSndState = STATE_TX_XMIT;
    
30. 
    
31.         //启动第一次发送，后面才能进完成中断
    
32.         xMBPortSerialPutByte((CHAR)*pucSndBufferCur);
    
33.         pucSndBufferCur++;
    
34.         usSndBufferCount--;
    
35. 
    
36.         vMBPortSerialEnable( FALSE, TRUE );
    
37.     }
    
38.     else
    
39.     {
    
40.         eStatus = MB_EIO;
    
41.     }
    
42.     EXIT_CRITICAL_SECTION(  );
    
43.     return eStatus;
    
44. }

复制代码

（8）、修改mbconfig.h文件

取消对ASCII的支持



（9）、去掉寄存器地址自动加一

需要修改四个文件，分别为mbfunccoils.c、mbfuncdisc.c、mbfuncholding.c、mbfuncinput.c

直接去对应的文件搜索：usRegAddress++;
然后屏蔽掉。
mbfunccoils.c里面有三处
mbfuncdisc.c里面有一处
mbfuncholding.c里面有三处
mbfuncinput.c里面有一处

如果不修改，绝对不能正常工作。

四、测试

编译下载运行，并使用PC端工具Modbus Poll模拟Modbus主机来进行测试。
如下：



经过测试，实测开发板能正确与Modbus Poll相互通讯。
至此，FreeModbus开源库移植成功/

濮黛娥

谢谢分享，学习一个

a123123

好帖, 多谢分享!

西点

好帖, 多谢分享!

lrz

牛

zjlsmhfd

楼主能否把uart 相关的几个文件也发出来学习下，调试一直不成功~~