docs: 优化所有协议文件可读性,增加完整注释和doxygen说明,结构更清晰
This commit is contained in:
1 parent
e3519bf1f4
commit
102e59d033
6 files changed
+535
-253
No files matched your search
@@ -1,3 +1,7 @@
|
||||
/**
|
||||
* @file slmptcpmaster.h
|
||||
* @brief 三菱SLMP协议TCP客户端主站头文件
|
||||
*/
|
||||
#ifndef SLMPTCPMASTER_H
|
||||
#define SLMPTCPMASTER_H
|
||||
|
||||
@@ -8,24 +12,47 @@ extern "C" {
|
||||
#include <stdint.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
extern uint8_t slmp_txbuf[1024];
|
||||
extern uint8_t slmp_rxbuf[1024];
|
||||
extern uint16_t slmp_idx;
|
||||
extern uint16_t slmp_addr;
|
||||
extern uint16_t slmp_size;
|
||||
extern uint16_t slmpTimegap;
|
||||
extern uint16_t comm_count;
|
||||
// ============================================================================
|
||||
// 全局变量
|
||||
// ============================================================================
|
||||
|
||||
// 处理接收到的SLMP响应
|
||||
extern uint8_t slmp_txbuf[1024]; // 发送缓冲区
|
||||
extern uint8_t slmp_rxbuf[1024]; // 接收缓冲区
|
||||
extern uint16_t slmp_idx; // 当前轮询索引 (0~9)
|
||||
extern uint16_t slmp_addr; // 当前请求起始地址
|
||||
extern uint16_t slmp_size; // 当前请求点数
|
||||
extern uint16_t slmpTimegap; // 超时计数,由主循环递增
|
||||
extern uint16_t comm_count; // 通信计数
|
||||
|
||||
// ============================================================================
|
||||
// 接口函数
|
||||
// ============================================================================
|
||||
|
||||
/**
|
||||
* @brief 处理接收到的SLMP响应
|
||||
* @param size: 接收数据长度
|
||||
* @return true: 处理成功,false: 不是有效的读响应
|
||||
*/
|
||||
_Bool slmp_handle_recv(uint16_t size);
|
||||
|
||||
// 构建SLMP请求,返回发送长度
|
||||
/**
|
||||
* @brief 构建SLMP请求帧
|
||||
* @return 发送长度,0表示不发送(参数非法)
|
||||
*/
|
||||
uint16_t slmp_build_send(void);
|
||||
|
||||
// 超时计数,由主循环调用
|
||||
/**
|
||||
* @brief 超时计数,由主循环每次调用递增
|
||||
*/
|
||||
void update_timeout_slmp(void);
|
||||
|
||||
// SLMP TCP客户端主函数
|
||||
/**
|
||||
* @brief SLMP TCP客户端主函数,W5500socket主循环处理
|
||||
* @param sn: socket编号
|
||||
* @param destip: 目标IP地址
|
||||
* @param destport: 目标端口
|
||||
* @return 0/正表示正常,负表示错误
|
||||
*/
|
||||
int32_t loopback_tcpc_slmp(uint8_t sn, uint8_t *destip, uint16_t destport);
|
||||
|
||||
#ifdef __cplusplus
|
||||
|
||||
Reference in new issue
Block a user