docs: 优化所有协议文件可读性,增加完整注释和doxygen说明,结构更清晰

This commit is contained in:
claw committed 2026-04-02 22:51:17 +08:00
1 parent e3519bf1f4
commit 102e59d033
6 files changed
+535 -253

No files matched your search

+107 -33
View File
@@ -1,6 +1,6 @@
/*
* modbustcpslave.c
* Modbus TCP从站服务
* @file modbustcpslave.c
* @brief Modbus TCP从站服务 + Modbus TCP转RTU转发
*/
#include "modbustcpslave.h"
@@ -12,45 +12,86 @@
#include <string.h>
#include "gpio.h"
// ============================================================================
// 全局变量
// ============================================================================
uint8_t loopback_tcps_modbus_rxbuf[1024];
uint8_t loopback_tcps_modbus_txbuf[1024];
// 将Modbus TCP转RTU (转发到485)
// ============================================================================
// 工具函数
// ============================================================================
/**
* @brief Modbus TCP转RTU格式
* @param tcp_buf: TCP输入缓冲区
* @param rtu_buf: RTU输出缓冲区
* @return RTU帧总长度
*/
uint16_t tcp_to_rtu(uint8_t *tcp_buf, uint8_t *rtu_buf) {
uint16_t len = ((tcp_buf[4] << 8) | tcp_buf[5]) - 1; // 去掉UnitID前的长度
memcpy(rtu_buf, &tcp_buf[6], len + 1); // 从UnitID开始拷贝
// TCP长度字段 - 去掉MBAP头中的UnitID之前的长度
uint16_t len = ((tcp_buf[4] << 8) | tcp_buf[5]) - 1;
// 从UnitID开始拷贝
memcpy(rtu_buf, &tcp_buf[6], len + 1);
// 计算CRC16并添加到末尾
uint16_t crc = crc16(rtu_buf, len + 1);
rtu_buf[len + 1] = crc & 0xFF;
rtu_buf[len + 2] = (crc >> 8) & 0xFF;
return len + 3; // 返回总长度
return len + 3; // 返回RTU总长度
}
// 将Modbus RTU转TCP (从485转发回TCP)
/**
* @brief Modbus RTU转TCP格式
* @param rtu_buf: RTU输入缓冲区
* @param tcp_buf: TCP输出缓冲区
* @param rtu_len: RTU帧长度
* @param rx_buf: 原TCP接收缓冲区,用于拷贝MBAP头
* @return TCP帧总长度,0表示CRC错误
*/
uint16_t rtu_to_tcp(uint8_t *rtu_buf, uint8_t *tcp_buf, uint16_t rtu_len, uint8_t *rx_buf) {
// 校验CRC
uint16_t crc_calc = crc16(rtu_buf, rtu_len - 2);
uint16_t crc_recv = rtu_buf[rtu_len - 2] | (rtu_buf[rtu_len - 1] << 8);
if (crc_calc != crc_recv) {
return 0; // CRC错误
}
// 还原MBAP头
memcpy(tcp_buf, rx_buf, 6); // Transaction ID, Protocol ID, Length先拷贝
tcp_buf[6] = rtu_buf[0]; // UnitID
memcpy(&tcp_buf[7], &rtu_buf[1], rtu_len - 3); // 功能码+数据
// 拷贝原MBAP头
memcpy(tcp_buf, rx_buf, 6);
// Unit ID
tcp_buf[6] = rtu_buf[0];
// 功能码+数据
memcpy(&tcp_buf[7], &rtu_buf[1], rtu_len - 3);
uint16_t pdu_len = rtu_len - 3; // PDU长度
uint16_t mbap_len = pdu_len + 1; // 必须 +1 包含 UnitID
// 设置长度
uint16_t pdu_len = rtu_len - 3;
uint16_t mbap_len = pdu_len + 1; // +1 包含UnitID
tcp_buf[4] = (mbap_len >> 8) & 0xFF;
tcp_buf[5] = (mbap_len) & 0xFF;
tcp_buf[5] = mbap_len & 0xFF;
return 7 + pdu_len; // MBAP(7) + PDU
}
// ============================================================================
// 状态机定义
// ============================================================================
enum {
STATE_IDLE, STATE_WAIT_RTU
STATE_IDLE, // 空闲,等待TCP请求
STATE_WAIT_RTU // 已经转发RTU,等待RS485响应
} modbus_state = STATE_IDLE;
// Modbus TCP服务主函数
// ============================================================================
// 公共接口
// ============================================================================
/**
* @brief Modbus TCP服务主函数,W5500socket主循环处理
* @param sn: socket编号
* @param port: 监听端口 (通常502)
* @return 0/正表示正常,负表示错误
*/
int32_t loopback_tcps_modbus(uint8_t sn, uint16_t port) {
int32_t ret;
uint16_t size = 0, sentsize = 0;
@@ -71,16 +112,22 @@ int32_t loopback_tcps_modbus(uint8_t sn, uint16_t port) {
#endif
setSn_IR(sn, Sn_IR_CON);
}
if ((size = getSn_RX_RSR(sn)) > 0) {
if (size > DATA_BUF_SIZE)
size = DATA_BUF_SIZE;
ret = recv(sn, loopback_tcps_modbus_rxbuf, size);
if (ret <= 0)
return ret;
// 接收请求
if ((size = getSn_RX_RSR(sn)) > 0) {
if (size > DATA_BUF_SIZE) {
size = DATA_BUF_SIZE;
}
ret = recv(sn, loopback_tcps_modbus_rxbuf, size);
if (ret <= 0) {
return ret;
}
// 处理Modbus TCP请求
uint16_t rxbuf_size = handleModbusTcp(loopback_tcps_modbus_rxbuf, loopback_tcps_modbus_txbuf);
if (rxbuf_size > 0) {
sentsize = 0;
// 分片发送直到完成
while (rxbuf_size != sentsize) {
ret = send(sn, loopback_tcps_modbus_txbuf + sentsize, rxbuf_size - sentsize);
if (ret < 0) {
@@ -92,40 +139,55 @@ int32_t loopback_tcps_modbus(uint8_t sn, uint16_t port) {
}
}
break;
case SOCK_CLOSE_WAIT:
#ifdef _LOOPBACK_DEBUG_
//printf("%d:CloseWait\r\n",sn);
#endif
if ((ret = disconnect(sn)) != SOCK_OK)
if ((ret = disconnect(sn)) != SOCK_OK) {
return ret;
}
#ifdef _LOOPBACK_DEBUG_
printf("%d:Socket Closed\r\n", sn);
#endif
break;
case SOCK_INIT:
#ifdef _LOOPBACK_DEBUG_
printf("%d:Listen, TCP server loopback, port [%d]\r\n", sn, port);
#endif
if ((ret = listen(sn)) != SOCK_OK)
if ((ret = listen(sn)) != SOCK_OK) {
return ret;
}
break;
case SOCK_CLOSED:
#ifdef _LOOPBACK_DEBUG_
//printf("%d:TCP server loopback start\r\n",sn);
#endif
if ((ret = socket(sn, Sn_MR_TCP, port, 0x00)) != sn)
if ((ret = socket(sn, Sn_MR_TCP, port, 0x00)) != sn) {
return ret;
}
#ifdef _LOOPBACK_DEBUG_
//printf("%d:Socket opened\r\n",sn);
#endif
break;
default:
break;
}
return 1;
}
// Modbus TCP转RTU转发主函数
/**
* @brief Modbus TCP转RTU转发,TCP请求转RS485RTU,RTU响应转TCP返回
* @param sn: socket编号
* @param buf: TCP接收缓冲区
* @param port: 监听端口
* @param timeout: 超时计数指针
* @param rtu_rx: RTU接收状态结构体
* @return 0/正表示正常,负表示错误
*/
int32_t loopback_tcps_modbus_to485(uint8_t sn, uint8_t *buf, uint16_t port, uint16_t *timeout, RtuRxST *rtu_rx) {
int32_t ret;
uint16_t size = 0, sentsize = 0;
@@ -152,13 +214,16 @@ int32_t loopback_tcps_modbus_to485(uint8_t sn, uint8_t *buf, uint16_t port, uint
switch (modbus_state) {
case STATE_WAIT_RTU:
// RTU响应接收完成,转TCP返回
if (rtu_rx->done) {
rxbuf_size = rtu_to_tcp(rtu_rx->buf, sendbuf, rtu_rx->size, buf);
}
// 超时也回到空闲
if (rtu_rx->done || *timeout > 1000) {
rtu_rx->done = 0;
modbus_state = STATE_IDLE;
}
// 同时检查是否有新的TCP请求
if ((size = getSn_RX_RSR(sn)) > 0) {
ret = recv(sn, buf, size);
if (ret <= 0) {
@@ -169,18 +234,23 @@ int32_t loopback_tcps_modbus_to485(uint8_t sn, uint8_t *buf, uint16_t port, uint
case STATE_IDLE:
if ((size = getSn_RX_RSR(sn)) > 0) {
if (size > DATA_BUF_SIZE)
if (size > DATA_BUF_SIZE) {
size = DATA_BUF_SIZE;
}
ret = recv(sn, buf, size);
if (ret <= 0)
if (ret <= 0) {
return ret;
}
// UnitID匹配本地从站地址,本地处理
if (buf[6] == get_slaveid()) {
rxbuf_size = handleModbusTcp(buf, sendbuf);
} else {
}
// 不匹配,转发到RS485RTU
else {
uint8_t rtu_tx[256];
uint16_t rtu_tx_len = tcp_to_rtu(buf, rtu_tx);
RE_SET;
RE_SET; // 485芯片设置为发送
HAL_UART_Transmit_DMA(&huart1, rtu_tx, rtu_tx_len);
*timeout = 0;
rtu_rx->done = 0;
@@ -193,6 +263,7 @@ int32_t loopback_tcps_modbus_to485(uint8_t sn, uint8_t *buf, uint16_t port, uint
break;
}
// 发送响应
if (rxbuf_size > 0) {
sentsize = 0;
while (rxbuf_size != sentsize) {
@@ -210,8 +281,9 @@ int32_t loopback_tcps_modbus_to485(uint8_t sn, uint8_t *buf, uint16_t port, uint
#ifdef _LOOPBACK_DEBUG_
//printf("%d:CloseWait\r\n",sn);
#endif
if ((ret = disconnect(sn)) != SOCK_OK)
if ((ret = disconnect(sn)) != SOCK_OK) {
return ret;
}
#ifdef _LOOPBACK_DEBUG_
printf("%d:Socket Closed\r\n", sn);
#endif
@@ -221,16 +293,18 @@ int32_t loopback_tcps_modbus_to485(uint8_t sn, uint8_t *buf, uint16_t port, uint
#ifdef _LOOPBACK_DEBUG_
printf("%d:Listen, TCP server loopback, port [%d]\r\n", sn, port);
#endif
if ((ret = listen(sn)) != SOCK_OK)
if ((ret = listen(sn)) != SOCK_OK) {
return ret;
}
break;
case SOCK_CLOSED:
#ifdef _LOOPBACK_DEBUG_
//printf("%d:TCP server loopback start\r\n",sn);
#endif
if ((ret = socket(sn, Sn_MR_TCP, port, 0x00)) != sn)
if ((ret = socket(sn, Sn_MR_TCP, port, 0x00)) != sn) {
return ret;
}
#ifdef _LOOPBACK_DEBUG_
//printf("%d:Socket opened\r\n",sn);
#endif