Modbus代码和软件结构简介

在这里先感谢下FreeModbus作者Christian Walter,让我们能学到开放的ModBus源码。不过源码中只有从设备的代码，但这已经足够了，后面有时间添加主模式代码。学习之前先了解下代码结构和各个模块的功能。

1.freemodbus-v1.6源码下载

外国的网站可能有点慢，坚持下载下来吧。
https://www.embedded-solutions.at/wp-content/uploads/2018/09/freemodbus-v1.6.zip

2.freemodbus源码目录及和简介

FreeModbus源码目录很清晰也很简单。源码解压后能看到下面的目录结构。

D:\code\modubus\freemodbus-v1.6\freemodbus-v1.6>ls
bsd.txt  Changelog.txt  demo/  doc/  gpl.txt  lgpl.txt  modbus/  tools/

下面是visual studio上呈现出来的目录结构，其中Modbus项就是源码目录下直接映射过来的，port是和具体硬件有关的，里面需要实现相应的接口，具体接口含义后面再说。例程是官方win32例程，实现在demo/win32中。

【1】modbus目录
modbus根目录结构如下，这基本包含了modbus全部有效代码。

	D:\CODE\MODUBUS\FREEMODBUS-V1.6\FREEMODBUS-V1.6\MODBUS
	├───ascii
	├───functions
	├───include
	├───rtu
	└───tcp

• ascii和rtu:这是两种封包格式，具体使用哪种方式，在代码中打开对应的宏即可。同时对应方式实现的start、start、receive、send等接口会注册到mb.c,具体接口如下面的代码片段。

• tcp：使用tcp/udp通讯进行网络传输时，需要使用此接口中的code。当然同样需要使能此模式配置宏。

以上ascii、rtu、tcp通讯模式是互斥的，在工作时只能选择其中一种。

	//eMBRTUInit做一些初始化动作，比如初始化串口和定时器
	eMBErrorCode    eMBRTUInit( UCHAR slaveAddress, UCHAR ucPort, ULONG ulBaudRate,
							    eMBParity eParity );
	//使能串口和定时器，此时接受状态机设置为STATE_RX_INIT，如果T3.5时间超时后，接受状态机设置为STATE_RX_IDLE，方便下次接收数据
	void            eMBRTUStart( void );
	//disable 串口和定时器
	void            eMBRTUStop( void );
	//接受完整一帧时会触发这个方法，用来进行验证帧完整性
	eMBErrorCode    eMBRTUReceive( UCHAR * pucRcvAddress, UCHAR ** pucFrame, USHORT * pusLength );
	//当一帧数据准备好后，使用此接口发送数据
	eMBErrorCode    eMBRTUSend( UCHAR slaveAddress, const UCHAR * pucFrame, USHORT usLength );
	//单字符接受状态机，每接受到一个字符，就会触发一次这个方法，可以把它理解为，串口接收中断方法。
	BOOL            xMBRTUReceiveFSM( void );
	//单字符发送状态机，每发送完一个字符，就会触发一次这个方法，可以把它理解成，串口发送中断方法。
	BOOL            xMBRTUTransmitFSM( void );
	//帧内字符之间，如果小于1.5个字符传输时间，就会放弃当前帧
	BOOL            xMBRTUTimerT15Expired( void );
	//帧间隔，如果小于T3.5字符传输时间，则会放弃当前帧。具体逻辑后面介绍代码时在记录下
	BOOL            xMBRTUTimerT35Expired( void );

---

【2】port
这里实现了与硬件相关的代码。移植到具体的平台需要修改这里的代码。

-rw-r--r-- 1 armwind 1049089 2005 9月  14  2018 port.h
-rw-r--r-- 1 armwind 1049089 2197 9月  14  2018 portevent.c
-rw-r--r-- 1 armwind 1049089 2675 9月  14  2018 portother.c
-rw-r--r-- 1 armwind 1049089 8428 9月  14  2018 portserial.c
-rw-r--r-- 1 armwind 1049089 2388 2月  10 18:05 porttimer.c

• protevent.c
  与事件相关的操作都在这里呢，需要实现的就3个接口，见明知意EventPost,EventGet.看起来高大上，其实这几个接口专门给eMBPoll()状态机使用。

BOOL            xMBPortEventInit( void );
BOOL            xMBPortEventPost( eMBEventType eEvent ); //将事件赋值给变量，或者push到事件队列中
BOOL            xMBPortEventGet(  /*@out@ */ eMBEventType * eEvent );//获取事件或者从队列中获取事件对象

• portserial.c
  与串口相关的控制逻辑都在这里，其中最后面2个接口是平台逐个get和put单个字节的，具体实现后面阅读源码在描述吧。

BOOL            xMBPortSerialInit( UCHAR ucPort, ULONG ulBaudRate,
                                   UCHAR ucDataBits, eMBParity eParity );//串口初始化
void            vMBPortClose( void );//关闭串口
void            xMBPortSerialClose( void );//这个一般不需要实现
void            vMBPortSerialEnable( BOOL xRxEnable, BOOL xTxEnable );//是能串口的TX，RX	
BOOL            xMBPortSerialGetByte( CHAR * pucByte );//从缓冲区获取一个字节
BOOL            xMBPortSerialPutByte( CHAR ucByte );//设置一个字节到缓冲区中

• porttimer.c
  定时器需要实现的接口如下所示，这里主要是为了帧间的超时问题。Modbus检测到2帧之间的时间超过了3.5个字符传送时间，具体这些细节在后续博文更新。

BOOL            xMBPortTimersInit( USHORT usTimeOut50us );//定时器初始化
void            xMBPortTimersClose( void );//关闭定时器
void            vMBPortTimersEnable( void );//使能定时器并重置定时器，
void            vMBPortTimersDisable( void );//关闭停止定时器
void            vMBPortTimersDelay( USHORT usTimeOutMS );//延时函数

3.freemodbus软件结构简介

freeModbus代码相当简单，只要掌握了事件驱动流程，状态机工作顺序，理解很简单。其工作流程简单分下面几步。

• 选择工作模式(ASCii，RTU，TCP)，只能选择一种模式。
• 注册各个工作模式对应的start，stop，receive，send，receivefsm，sendfsm给mb.c核心文件。方便统一由port模块调用。
• receivefsm，sendfsm这个两个单字节状态机循环接受和发送数据，这俩接口可以理解成串口中断程序，接受和发送缓冲区分别保存在portserial.c中的缓冲区中。
• 当一帧接受或者发送完毕后，由超时函数置mb.c中的事件状态机为receive frame或send frame状态，转而去做后续的工作。