Files
STM32F4-Base/App/iec60870/common/IEC60870_UserLogFile.h
T
wandering1 c0cef2fca0 refactor(app): 去掉 App/protocol 层,104 迁入 App/iec60870/104_port
IEC 60870 是标准族(含 104/101),原 App/protocol/ 把它拆成
iec60870/(vendor 核心)+ iec104/(我方适配)两棵同级树,多一层且
看不出「104 只维护一个」。现按标准族收口:

  App/protocol/iec60870        -> App/iec60870
  App/protocol/iec104          -> App/iec60870/104_port
  App/protocol/{README.md,.gitkeep}  删除
  App/protocol/iec104/iec104_asdu.h  删除(零 include / 零注册的孤儿)

vendor 子树(104/ common/ examples/)逐字节未改:91 个 R100 重命名、
git diff --cached -M 后 0 insertions / 0 deletions,另按字节直比 89/89
一致;UPSTREAM.sha256 差异集仍等于既有 17 项受控差异,非篡改。
适配层只改注释里的路径字样,无逻辑行。

门禁配套:
- coding-standard 的 exclude 不能写祖先 App/iec60870/——rename_ref 机械
  改出的祖先形态会把 2,191 行适配层一起豁免掉。改为三条精确前缀
  common/ 104/ examples/,适配层 11/11 回到受检;vendor 直调脚本仍报
  88 处违规而钩子 Skipped,证明确实由 exclude 生效而非空跑。
- check_registration 的 KNOWN_GAPS 键与理由文本同步到新路径。

验证:Keil 0 errors 0 warnings(Code=367464 RO-data=48492
RW-data=2288 ZI-data=173544),构建日志与 .d 依赖证明 5 个适配 .o
真被编入;模拟器 0 警告并跑通 iec104-tcp 13/13 真实 TCP 回环;
pre-commit 25 Passed / 0 Failed;doc-links 30 处问题全在
IEC60870-Slave/ 供应商快照,我方文档零新增。

顺带删掉仓根误入库且零引用的 _all_hook.txt 与 _scope.txt。
2026-11-18 14:15:10 +08:00

39 lines
2.4 KiB
C

/* 附录 C XML 编码:同步流式输出,不分配堆内存,不操作文件系统。 */
#ifndef IEC60870_USER_LOG_FILE_H
#define IEC60870_USER_LOG_FILE_H
#include "IEC60870_UserLog.h"
#ifdef __cplusplus
extern "C" {
#endif
/* 传输使用的完整虚拟路径,大小写固定;不代表编码器会创建文件系统目录。
* 设备 ID 上限不含 NUL,调用方存放最大长度字符串时需另留一个终止字节。 */
#define IEC60870_USER_LOG_FILE_NAME "HISTORY/ULOG/ulog.xml"
#define IEC60870_USER_LOG_DEVICE_ID_MAX 24U
/* 成功须同步保存全部 length 字节;短写或错误返回 false。bytes 只在回调
* 期间有效,不含隐式 NUL,调用方不得保留指针或修改/重入日志实例。
* 失败可能已写出文件前缀,调用方必须丢弃整个候选文件。 */
typedef bool (*IEC60870_UserLogFileWriteFn)(void *context,
const uint8_t *bytes, size_t length);
/**
* 功能:按递增序号输出保留的全部记录,允许 num=0。
* 输入参数:log——用户日志核心实例;device_id——设备标识;write——同步接收输出片段的回调;context——传给输出回调的调用方上下文。
* 输出参数:log——复用读取工作区及读取错误可能锁存的故障状态;size——仅完整成功时写入文件字节数,不含NUL;允许NULL的入口不强制输出。
* 返回值:true表示完整文件已输出;false表示参数、读取校验或输出回调失败,候选内容不可发布。
* 说明:device_id 为非空、最多 24 字节的可打印 ASCII,编码器转义 XML 属性中的特殊字符。记录时标以固定 UTC+8 输出两位年份。实例、字符串、sink context
* 全部由调用方持有,本次 同步调用期间须独占日志实例,成功产物应冻结后再交给文件服务。 非法输入、存储错误、sink 失败或长度溢出返回 false;size 可空,仅完整 成功后写入字节数,
* 不含 NUL,失败保持输出不变且丢弃已输出的任何前缀。 使用附录 C 正式模板的 Ulog/devID/txt 字段;不扩展内部序号等私有属性。 空库仍输出完整 Header 和空
* DataRec,不为凑满 1024 条创建虚构日志。
*/
bool IEC60870_UserLogFile_Write(IEC60870_UserLog_t *log, const char *device_id,
IEC60870_UserLogFileWriteFn write, void *context, uint32_t *size);
#ifdef __cplusplus
}
#endif
#endif /* IEC60870_USER_LOG_FILE_H */