From 67c05fb6bb35b5ac1ba9e2ae5bd660ee7e94924a Mon Sep 17 00:00:00 2001 From: gitee-bot Date: Fri, 4 Jul 2025 01:32:00 +0000 Subject: [PATCH] Update README.md --- README.md | 42 +++++++++++++++++++++++++++++++++++++++++- 1 file changed, 41 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9cf0e20..c00d8d4 100644 --- a/README.md +++ b/README.md @@ -1 +1,41 @@ -https://blog.csdn.net/weixin_42992743/article/details/136906701 \ No newline at end of file + + +# 通信协议核心模块 + +## 项目简介 +本项目实现了一个通信协议核心模块,包含数据帧处理和环形缓冲区管理两个核心功能。适用于嵌入式系统中的数据传输场景,提供了数据缓冲、帧处理、超时控制等实用功能。 + +## 主要功能 +- **数据帧处理**:实现数据帧的初始化、数据写入、超时检测等功能 +- **环形缓冲区**:提供高效的缓冲区管理,包含数据存取、长度查询、空间检查等接口 + +## 核心模块 +### 数据帧模块 (`b_protocol_core.c`) +- 数据帧初始化:`b_frame_init` +- 数据写入:`b_frame_put` +- 数据读取:`b_frame_fifo_get` +- 缓冲区清理:`b_frame_fifo_clear` +- 超时检测:`b_frame_idie_timer` +- 数据校验:`b_check_head` + +### 环形缓冲区模块 (`ringbuffer.c`) +- 缓冲区初始化:`ring_buf_init` +- 数据存取:`ring_buf_put` / `ring_buf_get` +- 缓冲区查询:`ring_buf_len` / `ring_buf_free_space` +- 缓冲区清理:`ring_buf_clr` / `ring_buf_clr_len` +- 数据预览:`ring_buf_check_get` + +## 使用方法 +1. 初始化数据帧结构体和环形缓冲区 +2. 使用`b_frame_put`写入数据 +3. 通过`b_frame_fifo_get`读取处理后的数据帧 +4. 使用`ring_buf_put`/`ring_buf_get`进行底层缓冲区管理 + +## 贡献指南 +欢迎提交Issue和Pull Request。贡献代码请确保: +- 遵循原有代码风格 +- 提供清晰的注释说明 +- 保持接口简洁稳定 + +## 许可协议 +本项目遵循MIT开源协议,详细条款请参阅LICENSE文件。 \ No newline at end of file -- Gitee