为自建代码目录补齐 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,64 @@
|
||||
# Drivers/BSP/NET/ — 网络抽象层（BSD Socket API）
|
||||
|
||||
> 在 CH395F 硬件驱动之上提供 **BSD Socket 风格 API**，使上层（FTP 服务、时间同步、UI 推流）
|
||||
> 以标准 socket 语义编程，无需关心芯片细节。核心是**阻塞模型 + 事件驱动 + 周期对账自愈**。
|
||||
|
||||
## 文件一览
|
||||
|
||||
| 文件 | 作用 |
|
||||
|---|---|
|
||||
| `net_socket.c/h` | **BSD Socket API 实现**：`net_socket` / `net_connect` / `net_send` / `net_recv` / `net_close` / `net_listen` / `net_accept`，含 L3 挂起（pending）与错误码 |
|
||||
| `net_select.c/h` | `select`/`poll` 多路复用（基于芯片中断事件 + 周期轮询） |
|
||||
| `net_types.h` | 网络层公共类型定义 |
|
||||
| `net_config.h` | 网络层编译期配置（缓冲区大小、超时、对账周期等） |
|
||||
| `lftpd/` | **轻量 FTP 服务器**（第三方移植，见其子目录） |
|
||||
|
||||
## 核心机制
|
||||
|
||||
### 阻塞模型（L3 pending）
|
||||
|
||||
- 一期（RECV）已落地：`net_recv` 等支持带超时的阻塞（`pending` 挂起 + tick 唤醒）
|
||||
- 二期（ACCEPT + SEND）待做 → `docs/待处理内容.md` N-4
|
||||
|
||||
### 周期对账自愈（Trap 22 修复）
|
||||
|
||||
- `net_reconcile_tick()`（200ms）回读芯片状态修正三类失同步：
|
||||
本层 ESTABLISHED 而芯片已断 → 断开；本层 LISTENING 而芯片已握手 → 补 accept；
|
||||
本层 LISTENING 而芯片监听消失 → 重建
|
||||
- **去抖（连续 2 次）+ 冷却（1s）**——单次状态读的重建动作**必须去抖**，
|
||||
否则"刚 listen 未生效"瞬态会反复重建直至 `relisten give up`（三监听口全死）
|
||||
|
||||
### 异常复监听隔离（Trap 23 修复）
|
||||
|
||||
- 异常释放（TIMEOUT）的 socket 复监听前隔离：排空 RX 残渣 + 主动 close + 等 CLOSED
|
||||
- 400ms 起、800ms 上限强制放行（上限须 < 重试放弃时限 2000ms）
|
||||
- 仅异常路径生效，正常 FIN 路径零改动
|
||||
|
||||
### 错误码（E-03 修复）
|
||||
|
||||
- **按任务隔离**：`s_net_errno_slots[8]`（每槽 `{任务句柄, err}`），替代原全局 `s_net_errno`
|
||||
- `net_get_errno()` 只读本任务槽位，**对外语义不变**（成功不清零）
|
||||
|
||||
## 依赖关系
|
||||
|
||||
```
|
||||
上层（FTP / timeSync / UI 推流）
|
||||
↓ BSD Socket API
|
||||
net_socket.c ←→ net_select.c
|
||||
↓ ch395f_* 接口
|
||||
Drivers/BSP/CH395F/
|
||||
```
|
||||
|
||||
## ⚠️ 改本模块前必读
|
||||
|
||||
- 就绪屏障位（`SYS_EVT_NET_READY` 等）等待必须 `osFlagsNoClear`，**不能用默认消费型**
|
||||
- 每次 CH395F SPI 事务须 `ch395f_spi_begin()/end()` 包裹
|
||||
- **改任何自愈/重建逻辑必须去抖**，否则会引发重建风暴
|
||||
- 相关陷阱：`docs/问题记录/CH395F_Trap_Records.md` Trap 21/22/23
|
||||
|
||||
## 相关文档
|
||||
|
||||
- 上层用法：`docs/网络/BSD_Socket_API_使用指南.md`
|
||||
- 内部调用关系：`docs/网络/BSD_Socket_API_函数调用关系.md`
|
||||
- 演进方案：`docs/问题记录/Net层阻塞模型业界对照与演进方案.md`
|
||||
- 测试：`docs/测试说明/CH395F_Test_Guide.md`、`docs/测试说明/FTP_Test_Guide.md`
|
||||
@@ -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