为自建代码目录补齐 README,建立目录级导航体系
- 新增 26 份目录 README:App/(+log,task,util,protocol)、Drivers/BSP/(+8子系统)、 Src/、Inc/、scripts/、tools/(+6子工具)、test/、MDK-ARM/、simulator/(+sim,tests) - 每份含:定位、文件清单表、关键约束/陷阱、指向 docs 权威文档 - 第三方库与生成代码目录排除(CMSIS/HAL/Middlewares/Lib/SDL2) - docs/文档规范.md 新增 §1.1b 代码目录 README 约定;根 README 目录结构加入说明
This commit is contained in:
@@ -0,0 +1,41 @@
|
||||
# Drivers/BSP/NET/lftpd/ — 轻量 FTP 服务器(第三方移植)
|
||||
|
||||
> ⚠️ **第三方开源库移植**(lftpd,许可证见 [`LICENSE.txt`](LICENSE.txt)),**非自研代码**。
|
||||
> 本目录 README 仅说明其在本项目中的**定位与对接方式**;库内部逻辑请参考上游。
|
||||
|
||||
## 文件一览
|
||||
|
||||
| 文件 | 作用 |
|
||||
|---|---|
|
||||
| `lftpd.c/h` | FTP 服务器主体(命令解析、状态机、数据通道) |
|
||||
| `lftpd_io.c` | I/O 适配层(**本项目对接 FatFs 的关键所在**) |
|
||||
| `lftpd_inet.c` | 网络适配(对接本项目的 BSD Socket API) |
|
||||
| `lftpd_log.c` | 日志输出适配 |
|
||||
| `lftpd_string.c` | 字符串工具 |
|
||||
| `private/*.h` | 内部头文件 |
|
||||
| `LICENSE.txt` | 上游许可证 |
|
||||
|
||||
## 在本项目中的对接
|
||||
|
||||
```
|
||||
ftpTask(App/ 侧创建)
|
||||
↓ 等待 SYS_EVT_NET_READY + SYS_EVT_STORAGE_READY(osFlagsNoClear!)
|
||||
lftpd(本目录)
|
||||
├── lftpd_inet.c → Drivers/BSP/NET/net_socket.c(BSD Socket API)
|
||||
└── lftpd_io.c → Lib/FatFs(文件读写)
|
||||
```
|
||||
|
||||
## ⚠️ 项目相关注意
|
||||
|
||||
- **ftpTask 就绪屏障**:`osEventFlagsWait` 等两位就绪必须加 `osFlagsNoClear`,
|
||||
否则位被先到的消费者清掉 → FTP 21 端口静默不监听(无日志无报错)
|
||||
- **lftpd 大局部缓冲**:已按 `docs/内存管理/RAM使用分析与优化方案.md` §1.4 静态化 9 处
|
||||
大局部缓冲(BSS +4.6KB),使 ftpTask 栈峰值从 3480B 降到 1184B——**勿改回局部变量**
|
||||
- **上传中止截断**:FTP STOR 中途断开后首笔复连被截断(Trap 23)已在 `net_socket.c` 侧修复
|
||||
- 本目录受 pre-commit 的**部分排除**(第三方代码)
|
||||
|
||||
## 相关文档
|
||||
|
||||
- 测试指南:`docs/测试说明/FTP_Test_Guide.md`
|
||||
- 台架探针:`MDK-ARM/ftp_abort_probe.py`、`MDK-ARM/ftp_freeze_probe.py`
|
||||
- 内存优化:`docs/内存管理/RAM使用分析与优化方案.md` §1.4
|
||||
Reference in New Issue
Block a user