docs: 优化所有协议文件可读性,增加完整注释和doxygen说明,结构更清晰
This commit is contained in:
1 parent
e3519bf1f4
commit
102e59d033
6 files changed
+535
-253
No files matched your search
+170
-112
@@ -1,8 +1,13 @@
|
||||
/*
|
||||
* slmptcpmaster.c
|
||||
* 三菱SLMP TCP通信主站
|
||||
* 轮询方式: slmp_idx 0~9轮转, 奇数索引读(readST), 偶数索引写(writeST)
|
||||
* 和FINS完全相同的架构
|
||||
* @file slmptcpmaster.c
|
||||
* @brief 三菱SLMP协议TCP客户端主站实现
|
||||
*
|
||||
* 轮询机制 (和欧姆龙FINS完全一致):
|
||||
* - slmp_idx: 0~9 轮转索引,对应 readST[10] / writeST[10]
|
||||
* - **奇数索引**: 读操作,从PLC读取数据存储到 1200 + (idx*20) + i
|
||||
* - **偶数索引**: 写操作,从 1000 + (idx*20) + i 读取数据写入PLC
|
||||
* - 每次主循环调用 update_timeout_slmp() 递增超时计数
|
||||
* - 超时计数 > 1000 时发送下一帧,接收后重置超时为 900
|
||||
*/
|
||||
|
||||
#include "slmptcpmaster.h"
|
||||
@@ -12,43 +17,53 @@
|
||||
#include "main.h"
|
||||
#include <string.h>
|
||||
|
||||
// 24位小端存储结构体 (SLMP使用)
|
||||
// ============================================================================
|
||||
// 结构体定义
|
||||
// ============================================================================
|
||||
|
||||
// 24位地址,SLMP使用小端序存储 (低字节在前)
|
||||
typedef union {
|
||||
uint8_t bytes[3];
|
||||
uint8_t bytes[3]; // 按字节访问
|
||||
struct {
|
||||
uint8_t byte0; // 最低字节
|
||||
uint8_t byte1; // 中间字节
|
||||
uint8_t byte2; // 最高字节
|
||||
uint8_t byte0; // 最低字节 (bit 0~7)
|
||||
uint8_t byte1; // 中间字节 (bit 8~15)
|
||||
uint8_t byte2; // 最高字节 (bit 16~23)
|
||||
};
|
||||
} slmp_uint24_t;
|
||||
|
||||
// SLMP帧联合体 - 支持结构化访问和字节访问
|
||||
// SLMP请求帧联合体,支持结构化访问和字节访问
|
||||
typedef union {
|
||||
struct __attribute__((__packed__)){
|
||||
uint16_t header; // 固定0x0050
|
||||
uint16_t target; // 固定0xff00
|
||||
uint16_t index; // 固定0x03FF
|
||||
uint8_t subIdx; // 固定0x00
|
||||
uint16_t requestSize; // 请求数据长度
|
||||
uint16_t timeout; // 固定0x0004 (4秒超时)
|
||||
uint16_t cmd; // 命令: 0x0401=读,0x1401=写
|
||||
uint16_t subCmd; // 固定0x0000
|
||||
slmp_uint24_t start; // 起始地址(24位小端)
|
||||
uint8_t dm; // 固定0xA8 (D寄存器)
|
||||
uint16_t size; // 读写点数
|
||||
uint16_t header; // 固定值: 0x0050
|
||||
uint16_t target; // 固定值: 0xff00
|
||||
uint16_t index; // 固定值: 0x03FF
|
||||
uint8_t subIdx; // 固定值: 0x00
|
||||
uint16_t requestSize; // 请求数据长度
|
||||
uint16_t timeout; // 超时: 0x0004 (4秒)
|
||||
uint16_t cmd; // 命令码: 0x0401=读,0x1401=写
|
||||
uint16_t subCmd; // 子命令: 固定0x0000
|
||||
slmp_uint24_t start; // 起始地址 (24位小端)
|
||||
uint8_t dm; // 软元件类型: 0xA8 = D寄存器
|
||||
uint16_t size; // 读写点数
|
||||
} frameStruct;
|
||||
uint8_t frameU8[21]; // 帧头最大长度21字节
|
||||
uint8_t frameU8[21]; // 按字节访问,帧头最大21字节
|
||||
} SLMPFrame;
|
||||
|
||||
// SLMP全局变量
|
||||
uint8_t slmp_txbuf[1024]; // 发送缓冲区
|
||||
uint8_t slmp_rxbuf[1024]; // 接收缓冲区
|
||||
uint16_t slmp_read_resp_header[7] = { 0xD0, 0x00, 0x00, 0xFF, 0xFF, 0x03, 0x00 };
|
||||
uint16_t slmp_idx = 0; // 轮询索引 (0~9)
|
||||
uint16_t slmp_curr_idx; // 当前处理的索引
|
||||
uint16_t slmp_addr; // 当前读写地址
|
||||
uint16_t slmp_size; // 当前读写点数
|
||||
// ============================================================================
|
||||
// 全局变量
|
||||
// ============================================================================
|
||||
|
||||
uint8_t slmp_txbuf[1024]; // 发送缓冲区 (最大1024字节)
|
||||
uint8_t slmp_rxbuf[1024]; // 接收缓冲区 (最大1024字节)
|
||||
uint16_t slmp_read_resp_header[7] = { 0xD0, 0x00, 0x00, 0xFF, 0xFF, 0x03, 0x00 };
|
||||
// 读响应固定头,用于识别读响应
|
||||
uint16_t slmp_idx = 0; // 当前轮询索引 (0~9)
|
||||
uint16_t slmp_curr_idx; // 当前正在处理的索引
|
||||
uint16_t slmp_addr; // 当前请求的起始地址
|
||||
uint16_t slmp_size; // 当前请求的点数
|
||||
uint16_t slmpTimegap = 0; // 超时间隔计数,由主循环递增
|
||||
|
||||
// SLMP帧静态初始化,固定值填充
|
||||
static SLMPFrame slmp_frame = {
|
||||
.frameStruct.header = 0x0050,
|
||||
.frameStruct.target = 0xff00,
|
||||
@@ -59,7 +74,15 @@ static SLMPFrame slmp_frame = {
|
||||
.frameStruct.dm = 0xA8
|
||||
};
|
||||
|
||||
// 32位转换为SLMP 24位小端
|
||||
// ============================================================================
|
||||
// 内部工具函数
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* @brief 32位地址转SLMP 24位小端格式
|
||||
* @param val: 32位地址
|
||||
* @return slmp_uint24_t: 转换后的24位
|
||||
*/
|
||||
static slmp_uint24_t u32_to_slmp24(uint32_t val) {
|
||||
slmp_uint24_t r;
|
||||
r.byte0 = val & 0xFF;
|
||||
@@ -68,139 +91,170 @@ static slmp_uint24_t u32_to_slmp24(uint32_t val) {
|
||||
return r;
|
||||
}
|
||||
|
||||
// 处理SLMP接收到的响应
|
||||
// 返回1: 处理成功,0: 不是有效响应
|
||||
// ============================================================================
|
||||
// 公共接口
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* @brief 处理接收到的SLMP响应
|
||||
* @param size: 接收数据长度
|
||||
* @return true: 处理成功,false: 不是有效的读响应
|
||||
* @note 只有读响应需要存储数据,写响应不需要处理
|
||||
*/
|
||||
_Bool slmp_handle_recv(uint16_t size) {
|
||||
// 只有读响应需要处理数据,写响应不需要存储
|
||||
// 比对读响应头确认
|
||||
// 1. 识别读响应: 比对前7字节响应头
|
||||
if (memcmp(slmp_rxbuf, slmp_read_resp_header, 7) != 0) {
|
||||
return 0; // 不是读响应,直接忽略
|
||||
return false; // 不是读响应(是写响应),直接忽略
|
||||
}
|
||||
|
||||
// 找到上一次发送对应的索引 (发送后索引+1,响应对应前一个)
|
||||
// 2. 获取上一次发送对应的索引
|
||||
// 因为发送后索引立即+1,所以响应对应发送前的索引
|
||||
uint16_t prevIdx;
|
||||
if (slmp_idx == 0) {
|
||||
prevIdx = 9;
|
||||
prevIdx = 9; // 绕回
|
||||
} else {
|
||||
prevIdx = slmp_idx - 1;
|
||||
}
|
||||
|
||||
// 读使用奇数索引,验证一下
|
||||
// 3. 验证索引: 读必须是奇数索引
|
||||
if (prevIdx % 2 != 1) {
|
||||
return 0; // 不匹配,丢弃
|
||||
return false; // 不匹配,丢弃
|
||||
}
|
||||
|
||||
uint16_t thisSize = get_register(readST[prevIdx].size);
|
||||
// 大小检查 + 边界保护 (最大20个寄存器)
|
||||
if (thisSize > 20 || thisSize * 2 + 11 != size) {
|
||||
return 0;
|
||||
// 4. 获取参数,检查长度合法性
|
||||
uint16_t pointNum = get_register(readST[prevIdx].size);
|
||||
if (pointNum > 20 || pointNum * 2 + 11 != size) {
|
||||
return false; // 长度不匹配或超出最大限制,丢弃
|
||||
}
|
||||
|
||||
// SLMP使用小端序: 低字节在前,高字节在后
|
||||
for (int i = 0; i < thisSize; i++) {
|
||||
// 5. 解析响应数据,存储到寄存器映射
|
||||
// SLMP数据使用小端序: 低字节在前,高字节在后
|
||||
for (int i = 0; i < pointNum; i++) {
|
||||
uint8_t byte_l = slmp_rxbuf[i * 2 + 11];
|
||||
uint8_t byte_h = slmp_rxbuf[i * 2 + 12];
|
||||
uint16_t value = ((uint16_t)byte_l) | (((uint16_t)byte_h) << 8);
|
||||
// 存储位置: 1200 + (索引*20) + 偏移
|
||||
// 存储地址: 1200 + (索引*20) + 偏移
|
||||
set_register(1200 + (20 * prevIdx) + i, value);
|
||||
}
|
||||
return 1;
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
// 构建SLMP请求,返回发送长度
|
||||
/**
|
||||
* @brief 构建SLMP请求帧
|
||||
* @return 发送长度,0表示不发送(参数非法)
|
||||
* @note 奇数索引 -> 读操作(readST), 偶数索引 -> 写操作(writeST)
|
||||
*/
|
||||
uint16_t slmp_build_send(void) {
|
||||
uint16_t sendsize = 0;
|
||||
uint16_t slave_id;
|
||||
uint16_t plc_address;
|
||||
uint16_t size;
|
||||
uint16_t pointNum;
|
||||
|
||||
// 奇数索引 -> 读操作 (和FINS一致,读使用readST)
|
||||
// ========== 奇数索引: 读操作 ==========
|
||||
if (slmp_idx % 2 == 1) {
|
||||
slave_id = get_register(readST[slmp_idx].slave_id);
|
||||
// 从readST获取参数
|
||||
slave_id = get_register(readST[slmp_idx].slave_id);
|
||||
plc_address = get_register(readST[slmp_idx].plc_address);
|
||||
size = get_register(readST[slmp_idx].size);
|
||||
pointNum = get_register(readST[slmp_idx].size);
|
||||
|
||||
if (slave_id < 0x01 || slave_id > 0xF7 || size == 0 || size > 20) {
|
||||
sendsize = 0;
|
||||
} else if ((plc_address + size) >= 8000) {
|
||||
sendsize = 0;
|
||||
} else {
|
||||
// 构建读请求帧
|
||||
slmp_frame.frameStruct.cmd = 0x0401; // 读命令
|
||||
slmp_frame.frameStruct.requestSize = 0x000C; // 请求长度固定12字节
|
||||
slmp_frame.frameStruct.start = u32_to_slmp24(plc_address);
|
||||
slmp_frame.frameStruct.size = size;
|
||||
sendsize = 21; // 帧头长度固定21字节,无额外数据
|
||||
// 拷贝到发送缓冲区,带边界检查
|
||||
for (int i = 0; i < sendsize && i < sizeof(slmp_txbuf); i++) {
|
||||
slmp_txbuf[i] = slmp_frame.frameU8[i];
|
||||
}
|
||||
// 参数合法性检查
|
||||
if (slave_id < 0x01 || slave_id > 0xF7 || pointNum == 0 || pointNum > 20) {
|
||||
return 0;
|
||||
}
|
||||
if ((plc_address + pointNum) >= 8000) {
|
||||
return 0; // 地址越界
|
||||
}
|
||||
|
||||
} else {
|
||||
// 偶数索引 -> 写操作 (和FINS一致,写使用writeST)
|
||||
slave_id = get_register(writeST[slmp_idx].slave_id);
|
||||
// 构建读请求帧
|
||||
slmp_frame.frameStruct.cmd = 0x0401; // 读命令码
|
||||
slmp_frame.frameStruct.requestSize = 0x000C; // 请求长度固定12字节
|
||||
slmp_frame.frameStruct.start = u32_to_slmp24(plc_address);
|
||||
slmp_frame.frameStruct.size = pointNum;
|
||||
sendsize = 21; // 读请求只有帧头,固定21字节
|
||||
|
||||
// 拷贝帧头到发送缓冲区,带边界检查
|
||||
for (int i = 0; i < sendsize && i < sizeof(slmp_txbuf); i++) {
|
||||
slmp_txbuf[i] = slmp_frame.frameU8[i];
|
||||
}
|
||||
}
|
||||
// ========== 偶数索引: 写操作 ==========
|
||||
else {
|
||||
// 从writeST获取参数
|
||||
slave_id = get_register(writeST[slmp_idx].slave_id);
|
||||
plc_address = get_register(writeST[slmp_idx].plc_address);
|
||||
size = get_register(writeST[slmp_idx].size);
|
||||
pointNum = get_register(writeST[slmp_idx].size);
|
||||
|
||||
if (slave_id < 0x01 || slave_id > 0xF7 || size == 0 || size > 20) {
|
||||
sendsize = 0;
|
||||
} else if ((plc_address + size) >= 8000) {
|
||||
sendsize = 0;
|
||||
} else {
|
||||
sendsize = 21 + (size * 2); // 帧头 + 数据
|
||||
// 检查缓冲区边界,防止越界
|
||||
if (sendsize > sizeof(slmp_txbuf)) {
|
||||
return 0;
|
||||
}
|
||||
// 参数合法性检查
|
||||
if (slave_id < 0x01 || slave_id > 0xF7 || pointNum == 0 || pointNum > 20) {
|
||||
return 0;
|
||||
}
|
||||
if ((plc_address + pointNum) >= 8000) {
|
||||
return 0; // 地址越界
|
||||
}
|
||||
|
||||
// 构建写请求帧
|
||||
slmp_frame.frameStruct.cmd = 0x1401; // 写命令
|
||||
slmp_frame.frameStruct.requestSize = 0x000C + (size * 2);
|
||||
slmp_frame.frameStruct.start = u32_to_slmp24(plc_address);
|
||||
slmp_frame.frameStruct.size = size;
|
||||
sendsize = 21 + (pointNum * 2); // 帧头21字节 + 数据2字节*点数
|
||||
if (sendsize > sizeof(slmp_txbuf)) {
|
||||
return 0; // 超出缓冲区,安全保护
|
||||
}
|
||||
|
||||
// 填充数据,SLMP小端序: 低字节在前
|
||||
for (int i = 0; i < size; i++) {
|
||||
uint16_t value = get_register(1000 + (20 * slmp_idx) + i);
|
||||
slmp_txbuf[i * 2 + 21] = value & 0xFF; // 低字节在前
|
||||
slmp_txbuf[i * 2 + 22] = (value >> 8) & 0xFF; // 高字节在后
|
||||
}
|
||||
// 构建写请求帧
|
||||
slmp_frame.frameStruct.cmd = 0x1401; // 写命令码
|
||||
slmp_frame.frameStruct.requestSize = 0x000C + (pointNum * 2);
|
||||
slmp_frame.frameStruct.start = u32_to_slmp24(plc_address);
|
||||
slmp_frame.frameStruct.size = pointNum;
|
||||
|
||||
// 拷贝帧头到发送缓冲区
|
||||
for (int i = 0; i < 21 && i < sizeof(slmp_txbuf); i++) {
|
||||
slmp_txbuf[i] = slmp_frame.frameU8[i];
|
||||
}
|
||||
// 填充数据: SLMP小端序,低字节在前
|
||||
for (int i = 0; i < pointNum; i++) {
|
||||
uint16_t value = get_register(1000 + (20 * slmp_idx) + i);
|
||||
slmp_txbuf[i * 2 + 21] = value & 0xFF; // 低字节在前
|
||||
slmp_txbuf[i * 2 + 22] = (value >> 8) & 0xFF; // 高字节在后
|
||||
}
|
||||
|
||||
// 拷贝帧头到发送缓冲区
|
||||
for (int i = 0; i < 21 && i < sizeof(slmp_txbuf); i++) {
|
||||
slmp_txbuf[i] = slmp_frame.frameU8[i];
|
||||
}
|
||||
}
|
||||
|
||||
// 索引轮转 (0~9对应10个通道)
|
||||
// 索引轮转,下次处理下一个通道
|
||||
slmp_idx = (slmp_idx + 1) % 10;
|
||||
return sendsize;
|
||||
}
|
||||
|
||||
// SLMP超时计数,由主循环调用 (和FINS一致)
|
||||
/**
|
||||
* @brief 超时计数,由主循环每次调用递增
|
||||
* @note 和FINS完全一致
|
||||
*/
|
||||
void update_timeout_slmp(void) {
|
||||
if (slmpTimegap < 0xffff) {
|
||||
slmpTimegap++;
|
||||
}
|
||||
}
|
||||
|
||||
// SLMP TCP客户端主函数 (和FINS相同结构)
|
||||
/**
|
||||
* @brief SLMP TCP客户端主函数,由顶层loopback_comm调用
|
||||
* @param sn: W5500 socket编号
|
||||
* @param destip: 目标IP地址
|
||||
* @param destport: 目标端口
|
||||
* @return int32_t: 0/正表示正常,负表示错误
|
||||
*/
|
||||
int32_t loopback_tcpc_slmp(uint8_t sn, uint8_t *destip, uint16_t destport) {
|
||||
int32_t ret;
|
||||
uint16_t size = 0, sentsize = 0;
|
||||
static uint16_t any_port = 50000;
|
||||
static uint16_t any_port = 50000; // 本地端口,自动递增
|
||||
|
||||
switch (getSn_SR(sn)) {
|
||||
uint8_t sr_status = getSn_SR(sn);
|
||||
switch (sr_status) {
|
||||
// ========== 连接已建立: 收发数据 ==========
|
||||
case SOCK_ESTABLISHED:
|
||||
if (getSn_IR(sn) & Sn_IR_CON) {
|
||||
setSn_IR(sn, Sn_IR_CON);
|
||||
setSn_IR(sn, Sn_IR_CON); // 清连接中断标志
|
||||
}
|
||||
|
||||
// 接收响应
|
||||
// 1. 接收响应
|
||||
if ((size = getSn_RX_RSR(sn)) > 0) {
|
||||
// 边界保护,不超过缓冲区大小
|
||||
// 边界保护,不超过缓冲区
|
||||
if (size > sizeof(slmp_rxbuf)) {
|
||||
size = sizeof(slmp_rxbuf);
|
||||
}
|
||||
@@ -209,21 +263,21 @@ int32_t loopback_tcpc_slmp(uint8_t sn, uint8_t *destip, uint16_t destport) {
|
||||
return ret;
|
||||
} else {
|
||||
comm_count++;
|
||||
slmp_handle_recv(ret);
|
||||
slmpTimegap = 900; // 重置超时
|
||||
slmp_handle_recv(ret); // 处理响应
|
||||
slmpTimegap = 900; // 重置超时
|
||||
}
|
||||
}
|
||||
|
||||
// 超时到了,发送下一个请求
|
||||
// 2. 超时到了,发送下一个请求
|
||||
size = 0;
|
||||
if (slmpTimegap > 1000) {
|
||||
size = slmp_build_send();
|
||||
size = slmp_build_send(); // 构建请求
|
||||
if (size == 0) {
|
||||
slmpTimegap = 1000;
|
||||
slmpTimegap = 1000; // 参数非法,等待下一次
|
||||
}
|
||||
}
|
||||
|
||||
// 发送请求
|
||||
// 3. 发送请求(分片发送,直到发完)
|
||||
sentsize = 0;
|
||||
while (size != 0 && sentsize != size) {
|
||||
ret = send(sn, slmp_txbuf + sentsize, size - sentsize);
|
||||
@@ -235,21 +289,24 @@ int32_t loopback_tcpc_slmp(uint8_t sn, uint8_t *destip, uint16_t destport) {
|
||||
}
|
||||
break;
|
||||
|
||||
// ========== 对方关闭连接 ==========
|
||||
case SOCK_CLOSE_WAIT:
|
||||
if ((ret = disconnect(sn)) != SOCK_OK) {
|
||||
return ret;
|
||||
}
|
||||
break;
|
||||
|
||||
// ========== 初始化: 发起连接 ==========
|
||||
case SOCK_INIT:
|
||||
if ((ret = connect(sn, destip, destport)) != SOCK_OK) {
|
||||
return ret;
|
||||
}
|
||||
break;
|
||||
|
||||
// ========== socket未打开: 新建socket ==========
|
||||
case SOCK_CLOSED:
|
||||
close(sn);
|
||||
// 端口绕回处理 (和FINS一致)
|
||||
// 端口绕回,超过最大值后重置
|
||||
if (any_port == 0xffff) {
|
||||
any_port = 50000;
|
||||
}
|
||||
@@ -261,5 +318,6 @@ int32_t loopback_tcpc_slmp(uint8_t sn, uint8_t *destip, uint16_t destport) {
|
||||
default:
|
||||
break;
|
||||
}
|
||||
|
||||
return 1;
|
||||
}
|
||||
Reference in new issue
Block a user