Files
STM32F4-Base/App/README.md
T
wandering1 2053f6d913 docs(iec60870): 把 104 板端落地文档归入 docs/iec60870/板端落地
四篇讲「本项目怎么接 104」的文档原来散在子系统设计与网络两个目录,
和随库迁入的 36 篇协议库设计混在一起。现集中到 docs/iec60870/板端落地/:

- IEC104上行设计说明.md(原 docs/子系统设计/)
- IEC104_Net适配契约.md(原 docs/网络/)
- IEC104_MCU落地规划.md(原 docs/子系统设计/)
- IEC104_MCU最小可行性验证.md(原 docs/子系统设计/)

改动:
- 四篇 git mv 保留历史,全库引用经 rename_ref.py 逐篇改写(27 个文件
  54 处引用行),旧路径残留扫描为 0。
- docs/README.md:§5.3 改为「IEC 60870-5-104 文档(40 篇)」,拆成
  「板端落地 4 篇」与「协议库设计与接口 36 篇」两张表,说明两条轴的分工;
  从 §5.1 功能子系统表里移除这三篇的重复条目。
- docs/iec60870/README.md:新增两条轴入口与板端落地表,原阅读顺序
  改标注为「协议库部分」。

验证:
- check_doc_links.py --all --sections-strict:310 篇 0 问题。
- 三份索引 markdown 链接可达性逐个 exists() 校验,断链 0;索引表覆盖
  36 篇协议库文档,与实际磁盘文件双向差集为空。
- 板端落地目录 4 篇 BOM / CR / U+FFFD 均为 0。
- 工作树 Keil 权威构建 0 errors 0 warnings(Code=365896 RO=48336
  RW=2736 ZI=173104),此后预提交 21 Passed / 0 Failed。
2026-11-18 23:31:37 +08:00

52 lines
3.8 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# App/ — 应用层
> **自研代码**(非 CubeMX 生成、非第三方库)。本目录是项目的**应用层**:任务编排、业务逻辑、
> 日志与配置引擎、工具函数。所有文件遵循 `docs/代码规范/嵌入式C语言代码规范_V1.0.md`。
## 职责
`Src/main.c`(CubeMX 初始化)→ `app_main_init`(本目录 `app/app_main.c`)→ `osKernelStart` →
6 个 FreeRTOS 任务(见 `task/`)。**`osKernelStart` 之前全是内核启动前代码,禁止调用任何
FreeRTOS/CMSIS-RTOS API**(本条与「就绪屏障位必须 `osFlagsNoClear`」的理由 → `docs/子系统设计/控制台单写者日志设计.md` §2.5 与 `docs/架构设计/项目启动顺序管理.md`)。
## 目录结构(按职责分层)
| 目录 | 内容 | README |
|---|---|---|
| `app/` | **应用入口与全局**:`app_main.c/h`(初始化入口)、`app_cfg.h`(裁剪决策占位说明,当前无宏)、`sys_events.h`(就绪事件) | [`app/README.md`](app/README.md) |
| `cfg/` | **配置引擎**:`/config.ini` 解析 + 原子持久化(旧二进制档已废弃,2026-10-10) | [`cfg/README.md`](cfg/README.md) |
| `sync/` | **时间同步任务**:`time_sync.c/h` | [`sync/README.md`](sync/README.md) |
| `algo/` | **采集与算法层**:语义取数 + 有效性判定 + 采样环/相量/测频 + 定值模型 + 保护元件框架 | [`algo/README.md`](algo/README.md)(索引);设计 → `docs/算法/采集与算法层设计说明.md` |
| `log/` | **日志子系统**:syslog(NAND)+ 控制台单写者日志 | [`log/README.md`](log/README.md) |
| `task/` | **FreeRTOS 任务实现**(6 个任务) | [`task/README.md`](task/README.md) |
| `util/` | **通用工具**:CRC / 环形缓冲 / 墙钟时间 | [`util/README.md`](util/README.md) |
| `iec60870/` | **通信协议**:IEC 60870-5-104,只维护一个实现——`common/` 编解码 + `104/` 协议与平台适配(core/source/net_mcu/dtu_table/comm 同目录) | [`iec60870/README.md`](iec60870/README.md)(目录说明与设计约束);结构见本文末节 |
## 关键约束
- **配置引擎单任务收敛**:`cfg/` 为静态态、属主是 defaultTask;UI 保存请求经
`SYS_EVT_CFG_SAVE` 事件唤醒,netTask/uiTask **不得直接触碰**配置引擎
- **syslog 唯一写者**:`/log/*` 只由 defaultTask 写入
- 新增任务/缓冲/栈前**必须先核算 RAM 余量**(`docs/内存管理/`)
## 通信协议:`iec60870/` 结构
**104 只维护一个实现**。2026-11-18 由 `App/protocol/` 迁入(该中间层目录已删除),同日把
原独立的 `104_port/` 适配层并入 `104/`,此后不再有「协议核心」与「适配层」两个平行目录:
| 子目录 | 内容 |
|---|---|
| `common/` | ASDU / 信息对象 / 时间编解码与从站主体(与 101 等其它 60870 协议共用) |
| `104/` | APCI 传输(Link / Connection / TcpServer / SendManager / AsduQueue)+ 业务状态机(`104/business/`)+ **平台适配与装配**(`iec104_core` / `iec104_source` / `iec104_net_mcu` / `iec104_dtu_table` / `iec104_comm`)+ DTU 点表 profile(`iec104_dtu_profile.h`) |
改动口径:全部按项目自有代码对待(命名、注释、结构遵循 `docs/代码规范/`);
`iec104_*` 是本项目自己的装配与平台层,`IEC104_*` / `IEC60870_*` 是协议主体与共享编解码。
设计入口 → `docs/iec60870/板端落地/IEC104上行设计说明.md`;目录说明与改动纪律 → [`iec60870/README.md`](iec60870/README.md)。
## 相关文档
- 架构全景:`docs/架构设计/项目架构总览.md`
- 启动顺序:`docs/架构设计/项目启动顺序管理.md`
- 配置引擎:`docs/子系统设计/配置文件设计.md`
- 日志:`docs/子系统设计/控制台单写者日志设计.md`、`docs/子系统设计/运行与自检记录设计.md`