Files
STM32F4-Base/App/README.md
T
wandering1 4784df923e refactor(iec60870): 解除第三方钉死,104 协议栈按项目自有代码维护
这个目录里的 104 协议栈原先按「第三方导入、逐字节保真」的方式管理:
改动要登记进哈希清单,门禁靠对比上游字节来判断有没有被动过。现在它已经是
团队自己的代码(用户裁定有完整处置权),这套机制就变成了纯粹的阻力——
它会让正常的功能修改看起来像篡改。这一版把它拆掉。

主要动作:

- App/iec60870/IMPORT.md 改名为 README.md。原来的名字本身就在说「这是导入的」,
  而按仓库文档规范,每个自建代码目录都该有 README。
- 删除 App/iec60870/UPSTREAM.sha256(84 条上游哈希)。它唯一的运行时消费者
  是 transport 测试的源文件清单,那个脚本已改成显式列出 27 个 .c。
- 许可证表述改为项目自有。仓库根的 IEC60870-Slave/ 是另一件事:那份仍是原始
  快照、仅作独立验证基线,许可状态未确认,不因本目录收编而改变。
- 四个子目录 README 从 4~6 行扩写到 32~69 行,各自说清职责、边界与改动纪律。
- coding-standard 的排除面收窄:从排除整个 104/ 改为只排除 business/ 与
  大写开头的 IEC104_*。我们自己的适配层 iec104_*.{c,h} 重新进入受检面,
  11 个文件实测 RC=0。

保留的技术知识(没有随保真框架一起删掉):C99 静态断言为何需要 shim 与
43 处断言条件未改、SOE 深度 128 的合规依据、点表元素 12B 降到 8B 以放进
const Flash、无符号上界比较消诊断、FaultEvent 的链接依赖、11 个容量宏的
默认值表、以及能力边界(历史/录波/文件/升级后端未导入)。

验证:

- 全量 pre-commit 12 Passed / 0 Failed
- doc-links 308 篇 / 30 处问题,全部在 IEC60870-Slave/ 内,我方零新增
- transport 测试改前改后编译集逐字节一致(27 个 .c,哈希相同),10 条用例全过
- 8 个改动文件字节体检 BOM=False / CR=0 / U+FFFD=0
2026-11-18 21:31:03 +08:00

53 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`) |
| `examples/` | DTU 点表 profile(`iec104_dtu_profile.h`) |
改动口径:全部按项目自有代码对待(命名、注释、结构遵循 `docs/代码规范/`);
`iec104_*` 是本项目自己的装配与平台层,`IEC104_*` / `IEC60870_*` 是协议主体与共享编解码。
设计入口 → `docs/子系统设计/IEC104上行设计说明.md`;目录说明与改动纪律 → [`iec60870/README.md`](iec60870/README.md)。
## 相关文档
- 架构全景:`docs/架构设计/项目架构总览.md`
- 启动顺序:`docs/架构设计/项目启动顺序管理.md`
- 配置引擎:`docs/子系统设计/配置文件设计.md`
- 日志:`docs/子系统设计/控制台单写者日志设计.md`、`docs/子系统设计/运行与自检记录设计.md`