feat: 添加杰理 JL7016 SOC 代码生成模板

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-08-19 16:05:36 +08:00
parent 0eda925f58
commit 16bffd16b2
914 changed files with 254709 additions and 45 deletions
@@ -1,64 +1,88 @@
-# soc-codegen-template
+# JL7016 SOC 开发框架

-见宝科技 **SOC 代码生成模板仓库**。见宝工具箱生成/分发 SOC 工程时，从此仓库按分支拉取对应芯片模板。
+基于杰理 **JL7016 / AC7016C（BR28）** 的耳机 SOC 工程模板。应用层含 `jb_protocol`，BLE 能力由 `apps/usr_le_code` 静态库提供。

-**远程地址：** https://git.jianbao-tech.com/pets-device/soc-codegen-template.git
+适用芯片：AC7016C（BR28）  
+SDK 名称：AC701N Earphone SDK

 ---

-## 分支说明
-
-本仓库 **`main` 分支仅作索引**，不含具体芯片工程。
-
-每个 SOC 模板对应一个独立分支，命名规则：**`厂商-型号`**。
-
-| 分支 | 说明 |
-|------|------|
-| **`main`** | 本页：分支索引与使用说明 |
-| **`JieLi-JL7016`** | 杰理 JL7016 / AC7016C（BR28）· 耳机 SDK + jb_protocol |
-
-完整分支表见 [`docs/branch-index.md`](docs/branch-index.md)。
-
---
-
-## 快速使用
-
-```bash
-# 克隆并切换到 JL7016 模板
-git clone https://git.jianbao-tech.com/pets-device/soc-codegen-template.git
-cd soc-codegen-template
-git checkout JieLi-JL7016
-```
-
-切换后阅读该分支根目录 **`README.md`** 了解构建、OTA 配置与打包方式。
-
---
-
-## 仓库结构（SOC 分支通用）
+## 目录结构

 ```text
-<SOC分支>/
-├── apps/              应用（earphone / usr_jb_proto / usr_periph / usr_le_code）
-├── cpu/               芯片平台代码与下载工具
-├── include_lib/       SDK 头文件
-├── tools/             构建与打包脚本
-├── Makefile           一键编译入口
-└── *.cbp              Code::Blocks 工程
+JieLi-JL7016/
+├── apps/
+│   ├── common/          # SDK 公共模块
+│   ├── earphone/        # 耳机应用
+│   ├── usr_jb_proto/    # 应用协议层（jb_protocol / jb_product）
+│   ├── usr_periph/      # 板级外设（RTC 等，源码开放）
+│   └── usr_le_code/     # BLE 协议库（静态库 + 公开头文件）
+├── cpu/                 # 芯片平台代码与下载工具（br28）
+├── include_lib/         # SDK 头文件
+├── tools/               # 工程工具与打包脚本
+├── Makefile             # 一键编译入口
+├── AC701N.cbp           # Code::Blocks 工程
+└── JBao_JL7016_SOC_SDK_README.md
 ```

-> 各芯片目录细节以对应分支 README 为准。
+### 封装模块公开接口
+
+**apps/usr_le_code**
+
+- 静态库：`apps/usr_le_code/lib/libusr_le_code.a`
+- 公开头文件：
+  - `apps/usr_le_code/usr_le_api.h`
+  - `apps/usr_le_code/usr_le_product.h`

 ---

-## 维护者
+## 快速开始

- 新增 SOC：新建 `厂商-型号` 分支，更新 `docs/branch-index.md` 与本 README 表格
- 模板发版：在对应 SOC 分支打 tag，如 `JieLi-JL7016/v1.0.0`
+### 环境要求
+
+- 杰理 AC701N 工具链（Windows 默认 `C:/JL/pi32/bin`）
+- Code::Blocks（打开 `AC701N.cbp`）或命令行 `make`
+
+### 1) 命令行编译
+
+```bash
+make
+```
+
+显示详细编译过程：
+
+```bash
+make VERBOSE=1
+```
+
+清除编译临时文件：
+
+```bash
+make clean
+```
+
+### 2) 协议与产品对接
+
+| 目的 | 文件 |
+|------|------|
+| 产品/版本定义 | `apps/usr_jb_proto/Protocol/jb_product.h` |
+| 用户层实现 | `apps/usr_jb_proto/Protocol/jb_product.c` |
+| 协议入口 | `apps/usr_jb_proto/usr_jb_main.c` |
+| BLE 公开接口 | `apps/usr_le_code/usr_le_api.h` |
+| 板级 RTC | `apps/usr_periph/usr_rtc.c` |
+
+---
+
+## 关键注意点
+
+- **厂商预置 blob 必须保留**：`cpu/br28/tools/` 下 `ota.bin`、`p11_code.bin`、`br28loader.bin`、`eq_*.bin` 等是打包/下载依赖，不要当编译产物删掉。
+- **编译产物不入库**：`objs/`、`sdk.elf`、`sdk.map`、`app.bin` 以及 `download/` 下生成的 `.fw` / `.ufw` 已由 `.gitignore` 忽略。
+- **rom.lst 必须入库**：链接脚本输入，不在忽略列表中。
+- 打包发版可使用 `tools/package_release.py`。

 ---

 ## 相关链接

- [分支索引详情](docs/branch-index.md)
- [Gitea 仓库](https://git.jianbao-tech.com/pets-device/soc-codegen-template)
+- [SOC 模板仓库 main 索引](https://git.jianbao-tech.com/pets-device/soc-codegen-template)
 - [MCU 模板仓库](https://git.jianbao-tech.com/pets-device/mcu-codegen-template)