杰理 SDK 文档中心
首页
首页
  • 项目概览与快速开始

    • 项目概述与芯片支持
    • 环境搭建与工具链
    • 工程与构建系统
    • 烧录与升级工具
    • 文档与硬件资料
  • 系统架构与芯片平台

    • 芯片平台与启动流程
    • 预编译库与头文件体系
    • 消息、定时器与中断服务
    • 通用外设驱动
  • 存储与文件系统

    • 文件系统实现
    • 存储设备驱动
    • VM 参数存储系统
  • 音频处理

    • 音频解码器
    • 音频编码器
    • MIDI 合成与播放
    • 音效、变速变调与降噪
  • 语音玩具应用

    • 应用框架与状态机
    • 音乐播放与外部音源
    • MIDI 乐器模式
    • 录音应用
    • 待机、电源管理与 USB 从机
  • 小音箱应用

    • 应用框架与模式管理
    • 播放源:音乐、FM、录音与 LineIn
  • 应用层与示例工程

    • 通用 MCU 应用
  • 固件更新与补丁

    • 固件升级机制
    • AD14N 主动降噪补丁

文档与硬件资料

本页介绍 fw-AD1x-4578_AC104_SDK(AD14N / AD15N / AC104N / AD17N / AD18N 系列通用 MCU SDK)仓库内 doc/ 目录所随附的全部文档与硬件资料,包括芯片手册、数据手册(Datasheet)、参考原理图、硬件设计注意事项、裸片(Dice/COB)资料、SDK 手册与版本信息,以及官方在线文档中心等外部资料入口。

Purpose and Scope

本页是开发者获取与使用本 SDK 配套文档和硬件资料的总入口,覆盖以下内容:

  • doc/ 目录的完整结构与各子目录的资料分布
  • 各芯片系列(AD14N / AD15N / AD17N / AD18N / AC104N)对应的芯片手册、数据手册与参考原理图
  • 跨芯片通用的硬件设计注意事项、裸片(COB)设计资料
  • SDK 手册、SDK 发布版本信息等公共文档
  • 官方在线文档中心、编译工具链、烧录工具等外部资料链接
  • 资料的命名规范与使用流程

以下内容不属于本页范围,由仓库其他目录项或外部文档中心覆盖:

  • 环境搭建与工具链安装:见 README「三、环境搭建」及杰理在线文档中心(doc.zh-jieli.com)
  • 工程结构与编译指南:见 README「五、工程结构」「七、编译指南」
  • 应用开发与示例工程:见「应用与示例」相关页面
  • 烧录与升级操作:见「烧录与升级」相关页面及 USB 升级工具使用文档

Overview

杰理 AD1x 系列通用 MCU SDK 以「代码仓库 + 随附文档」的方式交付。仓库根目录的 doc/ 目录集中存放了芯片选型、硬件设计、软件开发所需的全部权威资料,是硬件工程师(原理图设计、PCB 布局、量产烧写)与软件工程师(SDK 使用、外设驱动开发、产品调试)共同依赖的资料基准。

SDK 覆盖五个芯片平台,每个平台对应一套独立的芯片手册与数据手册:

CPU 平台芯片系列应用领域主要资料目录
sh54AD14N语音玩具 / 通用 MCUdoc/ad14n/
sh55AD15N语音玩具 / 通用 MCUdoc/ad15n/
sh57AD17N语音玩具 / 通用 MCUdoc/ad17n/
ch58AD18N语音玩具 / 通用 MCU(支持段码 LCD)doc/ad18n/
—AC104N小音箱(mbox_mg)doc/ac104n/

芯片型号/规格书/原理图资料请查阅:doc/ 目录

设计上,资料按「芯片系列」分目录存放,每类资料再按「资料类型」分子目录(datasheet/、schematic/、dice/),同时将跨芯片通用的 SDK 手册、版本信息放在 doc/ 根目录。这种组织方式的意图是:开发者先按目标芯片定位目录,再按工作阶段(选型 → 原理图 → 裸片/COB → 软件开发)快速找到对应文档,避免在大量 PDF 中盲目翻找。

Architecture

下图展示 doc/ 目录的资料组织架构及各资料类型与使用阶段的关系:

flowchart TD
    subgraph sg_doc["doc/ 资料根目录"]
        subgraph sg_chip["芯片系列子目录(按平台划分)"]
            AD14N["ad14n/<br/>芯片手册 + 数据手册 + 开发板原理图PCB + 裸片"]
            AD15N["ad15n/<br/>芯片手册 + 数据手册 + 硬件环境资料 + 裸片"]
            AD17N["ad17n/<br/>芯片手册 + 数据手册 + 语音MCU参考原理图"]
            AD18N["ad18n/<br/>芯片手册 + 数据手册 + 参考原理图"]
            AC104N["ac104n/<br/>芯片手册 + 数据手册 + 音箱方案标准原理图"]
        end
        subgraph sg_common["公共资料(根目录)"]
            SDKMAN["SDK 手册<br/>AD14N/AD15N/AD17N/AD18N/AC104N"]
            VERINFO["SDK 发布版本信息 PDF"]
            STUFF["stuff/ 杂项<br/>钉钉群 / 烧录工具文档"]
        end
    end

    subgraph sg_stage["资料使用阶段"]
        SELECT["芯片选型"] --> CHIPMAN["芯片手册 / 数据手册"]
        HW["硬件设计"] --> SCHEM["参考原理图 / 硬件设计注意事项"]
        COB["COB 封装 / 量产"] --> DICE["裸片 pad 位置 / COB 设计注意事项"]
        SW["SDK 开发"] --> SDKMAN
        SW --> VERINFO
    end

    sg_chip --> sg_stage
    sg_common --> sg_stage

架构说明

  • 按芯片系列分目录:ad14n/、ad15n/、ad17n/、ad18n/、ac104n/ 五个目录承载各自平台的专属资料,目录名与 SDK 工程、include_lib/liba/ 下的平台目录(sh54/sh55/sh57/ch58)一一对应,方便交叉定位。
  • 按资料类型分子目录:每个芯片目录下统一使用 datasheet/(芯片数据手册)、schematic/(参考原理图)、dice/(裸片/COB 资料)三级结构;各芯片的封装型号资料(如 AD15N 系列的 AD152A/AD153A/AD156A 等)以版本号命名文件,便于追溯。
  • 公共资料置于根目录:SDK 手册、SDK 发布版本信息不针对单一芯片,放在 doc/ 根目录,避免重复存放;stuff/ 存放钉钉群二维码、USB 升级工具文档等杂项资料。
  • 使用阶段映射:选型阶段看芯片手册与数据手册,硬件设计阶段看参考原理图与《硬件设计注意事项》,COB 量产阶段看裸片 pad 位置与 COB 设计注意事项,软件开发阶段看 SDK 手册与版本信息。四个阶段与 doc/ 的目录结构形成一一映射,这正是该目录分层设计的核心意图。

doc/ 目录结构详解

根据仓库实际文件列表,doc/ 目录的完整结构如下(各系列子目录以实际存在的文件为准):

doc/
├── AD14N_AD15N_AD17N_AD18N_AC104N_SDK手册.pdf   # 多平台通用 SDK 手册
├── AD1x-4578_AC104_SDK_发布版本信息.pdf          # SDK 版本历史(README 引用)
├── ad14n/                                        # AD14N 系列资料
│   ├── AC104N&AD14N&AD15N硬件设计注意事项.pdf
│   ├── AD14N_AC104N_芯片手册.pdf
│   ├── AD14N开发板原理图PCB.pdf
│   ├── datasheet/                                # AD142A0 / AD142A4 / AD145A0 / AD145A4 / AD146A
│   └── dice/                                     # AD140_pad_location.pdf / COB设计注意事项
├── ad15n/                                        # AD15N 系列资料
│   ├── AC104N&AD14N&AD15N硬件设计注意事项.pdf
│   ├── AD15N_芯片手册.pdf
│   ├── AD15N硬件开发环境资料20210510.pdf
│   ├── datasheet/                                # AD152A / AD152A0 / AD153A / AD154 / AD155A / AD155A0 / AD156A / AD156A0 / AD156B / AD157A0 / AD158A / AD159A
│   ├── dice/                                     # AD15N_DICE.PCB / AD15N_pad_location外发.pdf / COB设计注意事项
│   └── schematic/                                # AD152A(0) / AD153A 语音MCU参考原理图
├── ad17n/                                        # AD17N 系列资料
│   ├── AD17N_芯片手册.pdf
│   ├── AD176A_MCU_TOP_V1.0.pdf
│   ├── datasheet/                                # AD172A / AD174A / AD175A0 / AD175C / AD176A / AD177A0 / AD178A / AD179A
│   └── schematic/                                # AD172A(0) / AD174A(0) / AD175A0 / AD175C / AD176A0 / AD177A0 / AD178A / AD179A 语音MCU参考原理图
├── ac104n/                                       # AC104N 系列资料
│   ├── AC104N&AD14N&AD15N硬件设计注意事项.pdf
│   ├── AD14N_AC104N_芯片手册.pdf
│   ├── datasheet/                                # AC1042A / AC1042B / AC1044A
│   └── schematic/                                # AC1042A / AC1042B 音箱方案标准原理图、AC1044A 七端数码管音箱方案、MP3 Speaker DEMO
└── stuff/                                        # 杂项(钉钉群、USB升级工具文档等)

目录结构与各目录作用的说明见 README.md 的工程结构章节:doc/ 被明确标注为「文档:芯片手册、原理图、SDK 手册、选型表」。

资料类型说明

资料类型存放位置用途典型文件
芯片手册(Chip Manual)芯片系列目录根芯片整体架构、引脚定义、电气特性、封装信息AD15N_芯片手册.pdf、AD14N_AC104N_芯片手册.pdf
数据手册(Datasheet)datasheet/ 子目录具体型号(如 AD156A)的管脚/参数/封装规格AD156A_Datasheet_V1.4.pdf
参考原理图(Schematic)schematic/ 子目录硬件设计的起点,提供最小系统与典型应用电路AD152A(0)语音MCU参考原理图V2.1.pdf
硬件设计注意事项芯片系列目录根PCB 布局、电源、去耦、ESD 等设计约束AC104N&AD14N&AD15N硬件设计注意事项.pdf
裸片/COB 资料dice/ 子目录COB 封装设计、邦定 pad 位置AD15N_pad_location外发.pdf、COB设计注意事项(20210303).pdf
SDK 手册doc/ 根目录软件开发总体指南(多平台通用)AD14N_AD15N_AD17N_AD18N_AC104N_SDK手册.pdf
版本信息doc/ 根目录SDK 各发布版本变更记录AD1x-4578_AC104_SDK_发布版本信息.pdf

命名规范解读

资料文件名遵循统一的版本化命名,其设计意图是保证资料可追溯:

  • 型号 + 版本:数据手册如 AD156A_Datasheet_V1.4.pdf,版本号(V1.4)标识该型号文档的修订历史;同一型号不同封装/规格(如 AD152A 与 AD152A0)以型号后缀区分。
  • 功能 + 适用系列:如 AC104N_MP3_Speaker_DEMO_V1.1(SDK测试环境原理图).pdf,文件名直接标注用途(SDK 测试环境),避免误用。
  • 时间戳辅助:如 AD15N硬件开发环境资料20210510.pdf,以日期区分内容更新版本。

各芯片系列资料详解

AD15N 系列(sh55 平台,主推语音 MCU)

AD15N 是 SDK 的主推平台之一(工程入口为 AD15N_voice_toy.cbp 与 AD15N_mcu.cbp),其资料在 doc/ad15n/ 下最完整:

  • 芯片手册:AD15N_芯片手册.pdf——芯片整体规格权威依据
  • 硬件开发环境资料:AD15N硬件开发环境资料20210510.pdf——开发板/仿真环境说明
  • 数据手册(datasheet/):覆盖 AD152A、AD152A0、AD153A、AD154、AD155A、AD155A0、AD156A、AD156A0、AD156B、AD157A0、AD158A、AD159A 共 12 个型号,版本 V1.2~V1.4,对应不同 Flash 容量与封装组合
  • 参考原理图(schematic/):AD152A(0)、AD153A 语音 MCU 参考原理图 V2.1
  • 裸片资料(dice/):AD15N_DICE.PCB(裸片封装 PCB 文件)、AD15N_pad_location外发.pdf(邦定 pad 位置,外发加工用)、COB设计注意事项(20210303).pdf

AD14N 系列(sh54 平台)

doc/ad14n/ 提供:

  • 芯片手册:AD14N_AC104N_芯片手册.pdf(与 AC104N 共用手册)
  • 硬件设计注意事项:AC104N&AD14N&AD15N硬件设计注意事项.pdf
  • 开发板资料:AD14N开发板原理图PCB.pdf——官方开发板完整原理图与 PCB
  • 数据手册(datasheet/):AD142A0、AD142A4、AD145A0、AD145A4、AD146A(V1.2/V1.3)
  • 裸片资料(dice/):AD140_pad_location.pdf、COB设计注意事项(20210303).pdf

AD17N 系列(sh57 平台)

doc/ad17n/ 提供:

  • 芯片手册:AD17N_芯片手册.pdf;另附 AD176A_MCU_TOP_V1.0.pdf(MCU TOP 图)
  • 数据手册(datasheet/):AD172A、AD174A、AD175A0、AD175C、AD176A、AD177A0、AD178A、AD179A(V1.1~V1.3)
  • 参考原理图(schematic/):上述型号对应的语音 MCU 参考原理图 V1.0/V1.1,覆盖最小系统与典型外设电路

AC104N 系列(小音箱平台,mbox_mg)

doc/ac104n/ 提供:

  • 芯片手册:与 AD14N 共用 AD14N_AC104N_芯片手册.pdf
  • 硬件设计注意事项:与 AD14N/AD15N 共用
  • 数据手册(datasheet/):AC1042A、AC1042B、AC1044A(V1.0)
  • 音箱方案标准原理图(schematic/):
    • AC1042A音箱方案标准原理图V1.1.pdf、AC1042B音箱方案标准原理图V1.0.pdf
    • AC1044A七端数码管音箱方案标准原理图V1.1.pdf(七端数码管显示方案)
    • AC104N_MP3_Speaker_DEMO_V1.1(SDK测试环境原理图).pdf——与 SDK 测试环境对应的 DEMO 原理图

AD18N 系列(ch58 平台,支持段码 LCD)

AD18N 支持段码 LCD 显示,适合带显示的语音/控制产品。其资料同样按 doc/ad18n/ 组织(芯片手册、数据手册、参考原理图),具体型号清单以仓库目录为准。

外部资料入口

仓库 README 同时给出以下官方外部资料渠道,与 doc/ 目录形成互补:

资料入口说明
在线文档中心doc.zh-jieli.com/AD14中文在线文档中心,覆盖 SDK 使用、工具链、开发指南
SDK 版本历史doc/AD1x-4578_AC104_SDK_发布版本信息.pdf仓库内 PDF,记录各版本变更
杰理编译工具链dev_env 文档交叉编译工具链安装说明
USB 升级工具forced_upgrade 文档固件烧录到目标板
生产烧写工具burner_1tuo2 文档量产/裸片烧写(代理商处获取)
音频工具百度网盘(提取码 3jey)打包、音频转换、MIDI 等通用音频工具

上述入口在 README.md 与 README.md 中给出,README 是进入所有资料的首页导航。

核心使用流程

下图展示一位开发者从拿到 SDK 到完成硬件设计与软件开发过程中,如何按阶段使用 doc/ 中的资料:

sequenceDiagram
    participant Dev as 开发者
    participant Doc as doc/ 目录
    participant Online as 在线文档中心
    participant HW as 硬件设计/量产

    Dev->>Doc: 1. 按目标芯片进入系列目录(如 ad15n/)
    Doc-->>Dev: 2. 芯片手册 / 数据手册(选型确认)
    Dev->>Doc: 3. 参考原理图 + 硬件设计注意事项
    Doc-->>HW: 4. 原理图设计 / PCB 布局
    HW-->>Dev: 5. COB 方案?读取 dice/ 裸片资料
    Dev->>Doc: 6. SDK 手册 + 发布版本信息(了解 API 与版本)
    Dev->>Online: 7. 工具链 / 烧录 / 升级文档
    Online-->>Dev: 8. 编译、烧录、调试
    Doc-->>Dev: 9. 全部资料归档于 doc/,随仓库版本可追溯

流程要点:

  1. 选型阶段:先读芯片手册与对应型号数据手册,确认 Flash、封装、外设能力是否满足产品需求。
  2. 硬件设计阶段:以 schematic/ 下的参考原理图为基础搭建最小系统,再依据《硬件设计注意事项》处理电源、去耦、ESD 等细节。
  3. 量产阶段:COB 封装产品需使用 dice/ 下的 pad location 文件与 COB 设计注意事项;裸片烧写需生产烧写工具。
  4. 软件阶段:SDK 手册与版本信息是开发总纲;具体 API 细节以 sdk/include_lib/ 头文件与在线文档中心为准。
  5. 资料追溯:所有资料随仓库版本管理,文件名带版本号,可精确回溯所用资料版本。

使用示例

以下示例均从仓库实际源码(README.md)中提取,展示如何通过仓库自身导航到文档与硬件资料。

示例一:通过 README 定位 doc/ 目录

README 在「支持的芯片与平台」章节中直接引导开发者查阅 doc/ 目录:

> 芯片型号/规格书/原理图资料请查阅:[doc/ 目录](https://gitee.com/Jieli-Tech/fw-AD15N/tree/main/doc/)

Source: README.md

该引导位于芯片平台表格(sh54/sh55/sh57/ch58/AC104N)之后,设计意图是:开发者在确定目标平台后,立即获得该平台硬件资料的官方入口。

示例二:README 工程结构中对 doc/ 的定义

README 的工程结构章节将 doc/ 明确定义为文档根目录,并列出其内部结构:

├── doc/                           # 文档
│   ├── ad14n/                     #   AD14N 规格书/原理图
│   ├── ad15n/                     #   AD15N 规格书/原理图
│   ├── ad17n/                     #   AD17N 规格书/原理图
│   ├── ad18n/                     #   AD18N 规格书/原理图
│   ├── ac104n/                    #   AC104N 规格书/原理图
│   ├── stuff/                     #   杂项(钉钉群、USB升级工具文档等)
│   └── *.pdf                      #   SDK 手册 / 版本信息 / 选型表

Source: README.md

示例三:外部资料入口导航

README 顶部提供了文档中心、版本历史与问题反馈的统一入口:

[English](https://gitee.com/Jieli-Tech/fw-AD15N/blob/main/README-en.md) · [文档中心](https://doc.zh-jieli.com/AD14/zh-cn/master/index.html) · [SDK 版本历史](https://gitee.com/Jieli-Tech/fw-AD15N/blob/main/doc/AD1x-4578_AC104_SDK_%E5%8F%91%E5%B8%83%E7%89%88%E6%9C%AC%E4%BF%A1%E6%81%AF.pdf) · [报告问题](https://gitee.com/Jieli-Tech/fw-AD15N/issues)

Source: README.md

该导航行的设计意图:英文用户切英文 README,需要权威开发文档的进在线文档中心,需要核对 SDK 版本变更的打开版本信息 PDF,遇到问题直接到 Gitee Issues 反馈——所有资料渠道在一行内完成分流。

示例四:工具链与烧录工具文档获取

| **USB 升级工具** | 将固件烧录到目标板 | [申请链接](https://item.taobao.com/item.htm?id=620295020803) · [使用文档](https://doc.zh-jieli.com/Tools/zh-cn/dev_tools/forced_upgrade/index.html) |
| **生产烧写工具** | 量产/裸片烧写 | **代理商处** · [使用文档](https://doc.zh-jieli.com/Tools/zh-cn/mass_prod_tools/burner_1tuo2/index.html) |

Source: README.md

资料使用注意事项与边界情况

  • 资料为 PDF/PCB 二进制文件:仓库内 doc/ 下的资料均为 PDF(个别为 PCB 文件),无法在代码仓库中直接 diff;版本差异以文件名中的版本号(如 _V1.4)与日期戳为准。升级 SDK 时请对照 AD1x-4578_AC104_SDK_发布版本信息.pdf 确认配套资料版本。
  • 跨系列共用手册:AD14N_AC104N_芯片手册.pdf 与 AC104N&AD14N&AD15N硬件设计注意事项.pdf 被多个系列目录共享,查阅时注意确认内容覆盖范围(如 AD15N 注意事项是否适用于当前型号)。
  • 型号后缀区分:数据手册文件名中 A0、B 等后缀对应不同封装/Flash 组合(如 AD152A 与 AD152A0),选型时必须与实物丝印核对,避免原理图与实物不符。
  • 版本差异:同一型号不同版本数据手册(如 AD156A V1.4 vs 其他型号 V1.2)修订内容未在仓库内单独说明;量产前建议向代理商或官方确认最新版本。
  • 外部链接失效:在线文档中心、网盘等外部链接由杰理官方维护,若失效可通过仓库 Issues(报告问题)反馈;仓库内 doc/ 资料不依赖外部网络,可离线使用。
  • AD18N 资料完整性:本仓库 doc/ 已列出 ad18n 目录(README 工程结构中有说明),具体文件以实际目录为准;如缺失,建议结合在线文档中心获取。

扩展与维护建议

  • 新增芯片平台:遵循既有结构,在 doc/ 下新建 adXXn/ 目录,内部按 datasheet/、schematic/、dice/ 分类,并在 README 工程结构章节同步登记。
  • 资料版本管理:沿用「型号 + _V主.次 + 用途说明」的命名规范,避免文件名歧义;重大变更可在 SDK 发布版本信息 PDF 中登记。
  • 与在线文档中心配合:仓库内资料适合离线随包分发与版本追溯,在线文档中心适合检索与最新内容查阅,两者互补使用。

Related Links

  • README.md(仓库总导航)
  • README-en.md(英文版)
  • SDK 手册(AD14N/AD15N/AD17N/AD18N/AC104N)
  • SDK 发布版本信息
  • doc/ 目录总入口
  • 在线文档中心:doc.zh-jieli.com/AD14
  • 环境搭建与工具链:见「环境搭建」相关页面
  • 工程结构与编译:见「工程结构」「编译指南」相关页面
  • 烧录与升级:见「烧录与升级」相关页面
Prev
烧录与升级工具