[feat] update peripheral api and demo

docs/development_guide/source/get_started/Linux_quick_start_ubuntu.rst

@@ -0,0 +1,136 @@
+Linux OR WSL 环境开发指南
+=============================
+
+本文档介绍了如何在 Linux 安装配置 BL702 系列 MCU 需要的软件开发工具。而 WSL 的安装配置方式与 linux 下一样。唯一的区别就是一个运行在linux上，比如 Ubuntu ，一个运行在 windows 上。如果不想装虚拟机或者linux系统，可以选择 WSL。
+
+**Windows Subsystem for Linux** （简称 WSL ）是一个在 Windows 10 上能够运行原生 Linux 二进制可执行文件（ELF格式）的兼容层。它是由微软与Canonical公司合作开发，其目标是使纯正的Ubuntu 14.04 "Trusty Tahr"映像能下载和解压到用户的本地计算机，并且映像内的工具和实用工具能在此子系统上原生运行。因此，在 WSL 下的操作方式和 linux 下的操作方式是完全相同的。
+
+
+
+需要的软硬件环境
+-----------------------------
+
+-  一根 mini USB 数据线
+-  一个 USB-TTL 串口模块
+-  杜邦线若干
+
+配置 RISC-V 工具链
+-----------------------------
+
+.. code-block:: bash
+   :linenos:
+   :emphasize-lines: 4-6
+
+   $ cd ~
+   $ wget -c https://dev.bouffalolab.com/media/upload/download/riscv64-elf-x86_64-20210120.tar.gz
+   $ mkdir -p riscv64-elf-20210120
+   $ tar -zxvf riscv64-elf-x86_64-20210120.tar.gz -C riscv64-elf-20210120
+   $ sudo cp ~/riscv64-elf-20210120  /usr/bin
+   $ echo "export PATH=\"$PATH:/usr/bin/riscv64-elf-20210120/bin\""  >> ~/.bashrc
+   $ source ~/.bashrc
+
+配置 cmake & make 工具
+----------------------------
+
+.. code-block:: bash
+   :linenos:
+   :emphasize-lines: 5-7
+
+   $ sudo apt update
+   $ sudo apt install make
+   $ cd ~
+   $ wget -c https://cmake.org/files/v3.19/cmake-3.19.3-Linux-x86_64.tar.gz 
+   $ tar -zxvf cmake-3.19.3-Linux-x86_64.tar.gz
+   $ sudo cp ~/cmake-3.19.3-Linux-x86_64  /usr/bin
+   $ echo "export PATH=\"$PATH:/usr/bin/cmake-3.19.3-Linux-x86_64/bin\""  >> ~/.bashrc
+   $ source ~/.bashrc
+
+
+硬件连接
+----------------------
+
+-  具体开发板的连接, 请参考 :ref:`connect_hardware` 部分
+-  请确保开发板正确设置后再进行下面的步骤 (建议 Linux 下采用串口连接)
+
+
+获取 bl_mcu_sdk
+---------------------------
+
+-  打开终端输入以下命令获取 bl_mcu_sdk
+
+.. code-block:: bash
+   :linenos:
+
+    $ cd ~
+    $ git clone https://gitee.com/bouffalolab/bl_mcu_sdk.git  --recursive
+
+
+测试 Hello World 工程
+------------------------------
+
+打开 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  获取到 SDK 后，进入 sdk 中的 ``examples/hellowd/helloworld`` 目录下，打开 ``main.c``，即可编辑 helloworld 的相关代码。
+
+.. code-block:: bash
+   :linenos:
+
+    $ cd ~/bl_mcu_sdk/examples/hellowd/helloworld
+    $ vi main.c
+
+-  若编辑完成后，保存修改并关闭文件，接下来进行编译
+
+编译 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. code-block:: bash
+   :linenos:
+
+    $ cd ~/bl_mcu_sdk
+    $ make build BOARD=bl706_iot APP=helloworld
+
+
+烧写 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  烧写前请先确认烧写方式，若采用串口烧写，请先按住板子上的 ``boot`` 键不要释放，此时在按下 ``rst`` 键，然后释放两个键，此时板子进入 boot_rom 状态。
+-  这时在终端中输入以下命令进行烧写
+
+.. code-block:: bash
+   :linenos:
+
+    $ cd ~/bl_mcu_sdk
+    $ make download INTERFACE=uart
+
+-  如果下载失败请检查：
+
+   -  1. 是否使用串口烧写，开发板是否供电，硬件连接是否正确。
+   -  2. 烧写命令是否在 ``bl_mcu_sdk`` 目录下执行
+   -  3. 是否进入 boot_rom 模式
+   -  4. 串口是否被占用
+
+运行 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  打开新的终端，安装、运行串口工具
+
+.. code-block:: bash
+   :linenos:
+
+    $ sudo apt install picocom   # 若已经安装请忽略
+    $ picocom -b 2000000 /dev/ttyUSB0 
+
+-  按一下开发板上的 ``rst`` 按键，即可在串口终端中看到 ``hello world！``
+
+.. figure:: img/linux1.png
+   :alt:
+
+   helloworld!
+
+
+调试 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+
+

docs/development_guide/source/get_started/Windows_quick_start_cdk.rst

@@ -0,0 +1,166 @@
+.. _windows_cdk_quick_start:
+
+Windows 下使用 CDK (类 MDK Keil)开发指南
+=============================================
+
+本文档介绍了如何在 Windows 下使用 `平头哥半导体 <https://www.t-heah.cn/about>`_ 开发的 CDK 集成开发环境，
+来完成博流 BL702 系列 MCU 的相关软件开发工作。
+
+关于剑池 CDK ，这是一款由平头哥半导体开发打造的集成开发环境。它拥有和传统 MCU 开发环境十分近似的操作和设置，旨在不改变用户开发习惯的基础上，全面接入云端开发资源，结合图形化的 OSTracer、Profiling 等调试分析工具，加速用户产品开发。
+
+
+需要的软硬件环境
+-----------------------------
+
+-  剑池 CDK 软件
+-  一根 USB Type-A 数据线
+-  一个 CK-Link 仿真器
+-  一个 USB-TTL 串口模块
+-  杜邦线若干
+
+
+下载剑池 CDK 软件安装包
+-----------------------------
+
+- `剑池CDK <https://occ.t-head.cn/development/series/download?id=3864775351511420928&type=kind&softPlatformType=4#sticky>`_ 软件安装可以从平头哥半导体 OCC 官网获取到。
+
+- 下载完成后，解压缩，双击 ``setup.exe``，按照其提示，完成软件安装即可。
+
+
+下载 bl_mcu_sdk 软件开发包
+----------------------------
+
+-  从开源社区下载 bl_mcu_sdk 软件开发包。
+
+   - 可以使用 ``git clone`` 或者直接 ``download`` 的方式下 SDK
+   - 使用 ``git clone`` 前请确保已正确安装 ``git``，打开支持 ``git`` 的终端输入以下命令即可获取最新的 SDK。
+
+   .. code-block:: bash
+      :linenos:
+      :emphasize-lines: 1
+
+      $ git clone https://gitee.com/bouffalolab/bl_mcu_sdk.git  --recursive
+
+
+硬件连接
+----------------------
+
+-  具体开发板的连接, 请参考 :ref:`connect_hardware` 部分
+-  请确保开发板被正确设置后再进行下面的步骤
+   
+
+测试 Hello World 工程
+------------------------------
+
+打开 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  获取到 SDK 后，进入 sdk 中的 ``examples/hellowd/helloworld/cdk`` 目录下，双击 ``helloworld.cdkproj``，即可打开 ``Helloworld`` 工程。
+
+
+编译 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+.. figure:: img/cdk1.png
+   :alt:
+
+   helloworld.cdkproj
+
+-  在 CDK 工具栏中，点击编译图标即可编译工程
+
+   -  点击 ``1`` 处 图标 ``Build Project`` 即可编译当前选中的工程
+   -  点击 ``2`` 处 图标 ``Clean Project`` 即可清除上次编译的结果
+   -  点击 ``3`` 处 图标 ``Flash Download`` 即可将编译好的代码下载到芯片中
+   -  点击 ``4`` 处 图标 ``Start/Stop Debug`` 即可进行 debug 的相关操作
+   -  也可以在 ``Project`` 中，右击工程名称，通过右击菜单中的选项对项目进行编译等操作
+
+
+烧写 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  由于目前 CDK 软件中还没有包含我们的 flash 算法，所以需要我们手动将 flash 算法放到 CDK 安装目录，具体操作如下：
+
+   -  进入 SDK 目录下 ``tools\cdk_flashloader`` 目录
+   -  将目录下的 ``bl70x_flasher.elf`` 文件，拷贝到 CDK 工具的 ``C-Sky\CDK\CSKY\Flash`` 目录中
+
+   .. figure:: img/cdk7.png
+      :alt:
+
+      CDK Flash Loader
+
+
+
+.. figure:: img/cdk8.png
+   :alt:
+
+   CDK Project Setting
+   
+-  点击 ``Project View`` 中的项目设置按钮，打开 ``Project Setting`` 窗口，或者通过右击 ``Project`` 名称中右击菜单栏中打开
+
+- 在打开的 ``Project Setting`` 窗口中，选择 ``Flash`` 标签，配置需要的 Flash 算法
+
+.. figure:: img/cdk9.png
+   :alt:
+
+   CDK Project Flash setting
+
+-  在 ``Flash`` 标签中，点击 ``Add`` 按纽，在打开的列表中选择 ``bl70x_flash`` 算法，点击 ``Add`` 添加到工程中，``Flash`` 标签下的其他设置，如图所示：
+
+-  点击 OK 后，如配置正确，点击 ``Flash Download`` 即可将编译好的代码下载到芯片中
+   
+
+.. figure:: img/cdk5.png
+   :alt:
+
+   CDK Flashdownload Success
+
+-  如下载失败请检查：
+
+   -  1. 代码是否被正确编译，并生成 ``.elf`` ``.bin`` 等文件
+   -  2. Flash 算法是否被正确设置
+   -  3. CK-Link 与开发板是否正确连接
+   -  4. 开发板是否正常供电，电源指示灯是否点亮
+
+运行 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  从 CDK 的菜单栏 ``View->Serial Pane``，打开串口面板，在打开的 ``Serial Pane`` 中右击，进行串口设置，选择你对应的串口号和波特率
+
+.. figure:: img/cdk4.png
+.. figure:: img/cdk3.png
+   :alt:
+
+   CDK Serial Pane setting
+
+-  按下板子上的 ``RST`` 按键，即可在串口中看到代码的运行结果
+
+.. figure:: img/cdk6.png
+   :alt:
+
+   HelloWorld！
+
+
+调试 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  点击工具栏上方的 ``Start/Stop Debugger`` 按钮，进入 debug 界面，如下图所示
+
+.. figure:: img/cdk10.png
+   :alt:
+
+   Debug HelloWorld！
+
+-  在 debug 界面下，左侧的 ``Register`` 窗口中，可以查看 ``CPU`` 内部寄存器数据；右侧的 ``Peripherals`` 外设面板中，
+   可以查看相应外设寄存器数据，外设的选择可以在顶部菜单栏的 ``Peripherals->System Viewer`` 选择；
+   点击上方工具栏中的相关调试按钮可以进行断点设置、单步调试、指令单步和全速运行等操作。
+   当然这些操作都有相应的快捷键和快捷设置方法，详情请参考 ``CDK Help``，这里就不作过多介绍了。
+
+-  我们点击单步运行按钮，运行代码，即可看到指示光标移动到下一句代码，同时可以看到串口面板中显示了我们输出的 ``Hello World！`` 
+
+.. figure:: img/cdk11.png
+   :alt:
+
+   Debug HelloWorld！
+
+
+

docs/development_guide/source/get_started/Windows_quick_start_eclipse.rst

@@ -0,0 +1,175 @@
+Windows 下使用 Eclipse 开发指南
+================================
+
+本文档介绍了如何在 Windows 下使用 eclipse，构建 BL702 系列 MCU 的软件开发环境。
+
+
+需要的软硬件环境
+-----------------------------
+
+-  Eclipse 免安装软件包
+-  串口助手软件
+-  一根 USB Type-A 数据线
+-  一个 j-link 仿真器
+-  一个 USB-TTL 串口模块
+-  杜邦线若干
+
+
+下载 Eclipse 安装包
+-----------------------------
+
+-  从 Bouffalo Lab 开发者社区下载带有 RISC-V 工具链的 `Eclipse https://dev.bouffalolab.com/download <https://dev.bouffalolab.com/media/upload/download/BouffaloLab_eclipse_x86_64_win.zip>`_ 安装包。
+
+下载 bl_mcu_sdk
+-----------------------------
+
+-  从开源社区下载 `bl_mcu_sdk <https://gitee.com/bouffalolab/bl_mcu_sdk.git>`_ 软件开发包。
+
+- 可以使用 ``git clone`` 或者直接 ``download`` 的方式下 SDK
+- 使用 ``git clone`` 前请确保已正确安装 ``git``，打开支持 ``git`` 的终端输入以下命令即可获取最新的 SDK。
+
+.. code-block:: bash
+   :linenos:
+   :emphasize-lines: 1
+
+   $ git clone https://gitee.com/bouffalolab/bl_mcu_sdk.git  --recursive
+
+
+配置 eclipse 开发环境
+----------------------------
+
+-  将获取到的 eclipse 压缩包拷贝到您的工作目录，解压 eclipse 压缩包
+-  进入 eclipse 目录，双击 ``eclipse.exe`` 启动 eclipse
+-  选择您的 ``Workspace`` 目录，点击 ``Launch`` 进入工作空间
+
+   .. figure:: img/pic1.png
+      :alt:
+
+-  点击菜单栏中 ``Window->preferences`` 打开环境配置相关页面，准备导入相关的配置环境
+
+   .. figure:: img/pic2.png
+      :alt:
+
+-  点击下图 1 处的图标，打开导入配置界面，按照如图所示步骤，选择 ``eclipse.exe`` 目录下的 ``bflb_mcu_preferences.epf`` 配置文件。
+
+   .. figure:: img/pic3.png
+      :alt:
+
+-  选择好对应的文件后，点击 ``Finish``，在弹出的对话框选中点击 ``cancel`` ，不用重新启动。
+
+   .. figure:: img/pic4.png
+      :alt:
+
+导入 bl_mcu_sdk
+--------------------------
+
+-  点击 菜单栏 ``File->Import`` ，打开导入项目的配置界面
+
+   .. figure:: img/pic5.png
+      :alt:
+
+-  在打开的 ``Import`` 窗口中选择 ``General->Existing Projects into Workspace`` ，然后点击 ``Next``
+
+   .. figure:: img/pic6.png
+      :alt:
+
+-  加载 bl_mcu_sdk 的工程路径后，点击 ``Finsh`` 完成导入
+
+   .. figure:: img/pic7.png
+      :alt:
+
+-  导入完成后，关闭 ``Welcome`` 窗口即可看到导入的工程
+
+   .. figure:: img/pic8.png
+      :alt:
+
+   .. figure:: img/pic9.png
+      :alt:
+
+-  展开 ``Build Target`` 目录，即可看到 ``bl_clean``、``bl_make``、``download`` 三个功能按钮。
+
+   -  双击 ``bl_clean`` 按钮，会清除 ``build`` 和 ``out`` 两个目录下的编译缓存
+   -  双击 ``bl_make`` 按钮，会正常编译设置的 case，若没有修改默认配置则会编译 ``helloworld`` 工程
+   -  双击 ``download`` 按钮，会下载代码到芯片中，若没有编译成功则会下载默认的或者上一次的 ``.bin`` 文件
+
+
+硬件连接
+----------------------
+
+-  具体开发板的连接, 请参考 :ref:`connect_hardware` 部分；（eclipse 环境建议使用 ``j-link`` 烧写、调试）
+-  请确保开发板正确设置后再进行下面的步骤
+
+
+测试 Hello World 工程
+------------------------------
+
+
+打开 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  打开 ``examples/hellowd/helloworld/main.c`` 文件，即可编辑、修改 ``helloworld`` 测试 demo 的代码，若修改了，请保存后在执行编译
+
+
+编译 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  双击 ``bl_make`` 即可编 helloworld 工程
+
+-  编译成功后 ``Console`` 窗口可以看到如下图所示的 log 信息
+
+.. figure:: img/pic10.png
+
+
+烧写 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  双击 ``download`` 即可烧写 helloworld 工程 ``bin`` 文件到芯片中
+
+-  下载成功后 ``Console`` 窗口可以看到如下图所示的 log 信息
+
+.. figure:: img/pic11.png
+
+
+运行 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  将开发板的 ``TXD0``、``RXD0`` 和 ``GND`` 引脚使用杜邦线连接到 USB-TTL 串口模块，将串口模块插入 PC 主机， 使用任意的串口助手软件打开串口
+-  烧写成功后，按下板子上的 ``rst`` 按键，如果下载正确，即可在串口助手软件中看到如下图所示的 log 信息。
+
+.. figure:: img/eclipse_run.png
+
+
+调试 Hello World
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  点击 eclipse 工具栏中的 ``Debug`` 按钮，进入 debug 配置窗口
+-  选择 ``GDB SEGGER J-Link Debugging->Jlink_bl_mcu_sdk``  Debug 配置，在 ``C/C++ Application:`` 选项中选择需要调试的 ``.elf`` 文件
+-  先点击 ``Apply`` 后，在点击 ``Debug`` 即可进行 ``Debug`` 
+
+.. figure:: img/pic14.png
+   :alt:
+
+-  进入 Debug 界面后，即可看到程序停在了 ``main``，点击上方工具栏中的 ``Step Over``，按钮即可对代码工程进行单步调试。
+
+.. figure:: img/pic15.png
+   :alt:
+   
+   Eclipse Debugging
+
+
+编译烧写不同的目标工程
+-----------------------
+
+-  当右击 ``bl_make`` 按钮，点击 ``Edit`` 后，会弹出更换目标工程的配置界面，如下图所示
+
+.. figure:: img/pic12.png
+   :alt:
+
+
+-  其中 ``APP=xxx`` 用户可以修改其内容，改为需要编译烧写的目标工程名，例如想要编译烧写 ``gpio/gpio_blink`` 工程，将其修改为 ``APP=gpio_blink`` 即可
+-  ``Build command`` 中 ``make BOARD=bl706_iot`` 会指定不同的 Board 类型以指定适配不同类型的开发板。
+
+-  ``Board`` 类型决定编译时选择相应的 ``borad`` 头文件。默认选择的是 BL706 的 iot 开发板 ``make build BOARD=bl706_iot``
+
+
+

docs/development_guide/source/get_started/bl_dev_cube.rst

@@ -0,0 +1,94 @@
+.. _bl_dev_cube:
+
+BLDevCube 烧录工具指南
+=======================
+
+本文档将简要介绍一下如何使用 Bouffalo Lab Dev Cube 集成开发工具进行代码的烧写，更多详情请参考 `BLDevCube 用户手册 <https://dev.bouffalolab.com/media/upload/doc/DevCube%E7%94%A8%E6%88%B7%E6%89%8B%E5%86%8Cv1.2.pdf>`_
+
+
+下载安装 Bouffalo Lab Dev Cube 工具
+------------------------------------
+
+-  从博流智能开发者社区下载适合您操作系统的版本，下载地址：`https://dev.bouffalolab.com/download <https://dev.bouffalolab.com/download>`_ ，从这里可以获取到最新版本工具
+
+   -  没有注册开发者账号的用户，可以点击开发者入口，使用 ``guest`` 用户进入
+
+-  下载完成后，解压后即可使用
+
+
+配置工具下载方式
+----------------
+
+-  双击解压后文件夹的 ``BLDevCube.exe``, 在 ``Chip Selection`` 对话框中，在 ``Chip Type`` 的下拉框中，选择您要开发的对应芯片的型号，点击 ``Finish`` 进入 ``Dev Cube`` 主界面
+-  进入主界面后在上方的菜单栏 ``View`` 标签下选择 ``MCU`` 下载方式，进入 MCU 程序下载主界面
+
+.. figure:: img/dev_cube_view_mcu.png
+   :alt:
+
+   select mcu
+
+-  在 ``Image`` 标签下 ``Interface`` 栏选择相应的下载方式，根据您的实际物理链接进行选择
+-  ``Image file`` 栏配置您想要下载的镜像绝对路径地址，可以点击 ``Browse`` 按钮来选择您的 **Bin** 文件
+-  点击 ``click here to show advanced options`` 时，会展开高级镜像配置，通常情况下保持默认配置即可；需要注意的是， ``Flash Clock`` 会同时影响到 Flash 和 PSRAM 的时钟频率，在需要使用 PSRAM 的情况下可以适当提高该时钟频率以获得更好的性能
+
+使用 UART 下载程序
+^^^^^^^^^^^^^^^^^^
+
+-  ``COM Port`` 栏用于使用 UART 进行下载时，选择与芯片连接的 COM 口号，可以点击 Refresh 按钮进行 COM 号的刷新
+-  ``Uart Speed`` 栏用于使用 UART 下时，配置合适的波特率，默认 2M
+
+-  下载前请确保硬件配置正确：
+
+   -  使用 ``Type-C USB`` 数据线 or ``Mini USB`` 数据线连接到开发板上对应的 USB ``Type-C`` 接口 or ``Mini`` 接口上。
+   -  按下开发板上的 ``Boot`` 键，不要释放
+   -  按下开发板上的 ``RST`` 键，此时已经进入 ``Boot ROM``，可以释放两个按键
+   -  这时就可以从 ``Bouffalo Lab Dev Cube`` 中看到相应的串口 ``COM`` 号，如没有出现，请点击 ``Refresh`` 按钮刷新一下
+-  在正确完成上述配置后，点击 ``Create&Program`` 按钮进行下载
+
+-  下载成功后即可看到状态栏变成绿色并显示 ``Success``
+
+.. figure:: img/dev_cube_download.png
+   :alt:
+
+   download success!
+
+使用 Openocd 下载程序
+^^^^^^^^^^^^^^^^^^^^^^
+
+-  使用 openocd 下载程序与使用串口下载时工具配置基本相同，只需要将 ``Interface`` 切换成 ``Openocd`` 即可
+-  硬件连接需要更改为支持 Openocd 的调试器连接（本教程以 Sipeed RV Debugger 为例）：
+
+   -  1. 首先将 RV 调试器连接到电脑的 USB 接口，打开设备管理器，会发现调试器被识别为两个串口（注：不是开发板上的串口）
+   
+   .. figure:: img/sipeed_rv_debugger_1.png
+
+   -  2. 从 sipeed 下载 ``zadig-2.4`` 替换驱动程序。下载地址：`http://dl.sipeed.com/MAIX/tools/sipeed-rv-debugger/zadig-2.4.exe <http://dl.sipeed.com/MAIX/tools/sipeed-rv-debugger/zadig-2.4.exe>`_
+   -  3. 下载好双击打开 ``zadig-2.4.exe``，选择 Options 勾选 List All Devices.
+   
+   .. figure:: img/sipeed_rv_debugger_3.png
+   
+   -  4. 找到 JTAG Debugger(Interface 0)，然后选择替换的驱动为 WinUSB 点击 Replace Driver 替换
+   -  5. 再次打开设备管理器， 看到其中一个串口被替换成通用串行总线设备就说明安装成功
+   
+   .. figure:: img/sipeed_rv_debugger_2.png
+
+   -  6.将调试器的 JTAG 引脚与开发板的 JTAG 引脚连接起来
+
+-  在正确完成上述配置后，点击 ``Create&Program`` 按钮进行下载
+
+-  下载成功后即可看到状态栏变成绿色并显示 ``Success``
+
+使用 Jlink 下载程序
+^^^^^^^^^^^^^^^^^^^^^^
+
+-  使用 Jlink 下载程序与使用 Openocd 下载时工具配置基本相同，只需要将 ``Interface`` 切换成 ``Jlink`` 即可
+-  硬件连接需要更改为使用 Jlink 连接（本教程以 Jlink V11 为例，建议使用 Jlink V10 以上版本）：
+
+   -  1. 首先从 Segger 官网下载合适的 Jlink 驱动程序并安装
+   -  2. 将 Jlink 调试器连接到电脑的 USB 接口
+   -  3. 将 JLink 调试器的 JTAG 引脚与开发板的 JTAG 引脚连接起来
+
+-  在正确完成上述配置后，点击 ``Create&Program`` 按钮进行下载
+
+-  下载成功后即可看到状态栏变成绿色并显示 ``Success``
+

docs/development_guide/source/get_started/cmake_quick_start.rst

@@ -0,0 +1,20 @@
+基于 cmake 框架构建自己的工程
+================================
+
+添加demo工程
+---------------
+
+添加demo工程+依赖源文件
+-----------------------
+
+添加demo工程+依赖库
+-----------------------
+
+添加demo工程+私有编译选项（gcc option）
+----------------------------------------
+
+添加demo工程+私有链接脚本（ld）
+---------------------------------
+
+添加demo工程+依赖源文件+依赖库
+---------------------------------

docs/development_guide/source/get_started/connecting_hardware.rst

@@ -0,0 +1,97 @@
+.. _connect_hardware:
+
+硬件连接
+================
+
+本文档介绍了如何连接 BL70x 系列 MCU 的开发板
+
+BL706_IOT 开发板
+-------------------------
+
+使用 CK-Link 烧写、调试连接方法
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  将 CK-Link USB 接口使用合适的 USB 数据线正确连接到 PC 主机
+-  将 Iot 开发板的 ``HD3`` 组的标准 ``JTAG`` 引脚使用杜邦线与 ``CK-Link`` 对应的 ``JTAG`` 引脚连接起来
+-  若没有使用 CK-Link 给开发板供电，需要给开发板单独供电
+
+::
+
+    bl706-iot board         CK-Link
+    -------------------------------
+        JTAG_TDI     <-->     TDI
+        JTAG_TDO     <-->     TDO 
+        JTAG_TCK     <-->     TCK 
+        JTAG_TMS     <-->     TMS
+        VDD33        <-->     VREF
+        GND          <-->     GND
+
+
+.. figure:: img/ck_link_connect_bl706_iot.png
+   :alt:
+
+   ck_link connect bl706-iot board
+
+
+使用 J-Link 烧写、调试连接方法
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  将 j-link 的 USB 接口使用合适的 USB 数据线正确连接到 PC 主机
+-  将 Iot 开发板的 ``HD3`` 组的标准 ``JTAG`` 引脚使用杜邦线与 ``j-link`` 对应的 ``JTAG`` 引脚连接起来
+-  j-link 连接的情况下需要给开发板独立供电，并且将开发板的电源接到 j-link 的 ``VTref`` 引脚
+
+::
+
+    bl706-iot board          j-link
+    -------------------------------
+        JTAG_TDI     <-->     TDI
+        JTAG_TDO     <-->     TDO 
+        JTAG_TCK     <-->     TCK 
+        JTAG_TMS     <-->     TMS
+        VDD33        <-->     VTref
+        GND          <-->     GND
+
+
+.. figure:: img/jlink_connect_bl706_iot.png
+   :alt:
+
+   jlink connect bl706-iot board
+
+
+使用串口烧写程序连接方法
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  使用串口烧写前，请确保正确安装了 ``Bouffalo Lab Dev Cube`` 或命令行烧写工具
+
+   -  使用 ``Type-C USB`` 数据线 or ``Mini USB`` 数据线连接到开发板上对应的 ``Type-C`` 接口 or ``Mini`` 接口上。
+   -  按下开发板上的 ``Boot`` 键，不要释放
+   -  按下开发板上的 ``RST`` 键，此时已经进入 ``Boot ROM``，可以释放两个按键
+   -  这时就可以从 ``Bouffalo Lab Dev Cube`` 中看到相应的串口 ``COM`` 号，如没有出现，请点击 ``Refresh`` 按钮刷新一下
+
+
+-  如没有合适的数据线，也可以使用一些常见的 ``USB-TTL`` 模块，连接到开发板的 ``UART0`` 端口进行烧写。 ``UART0`` 在 ``HD1`` 组上，连接方法如下：
+
+::
+
+   USB-TTL      BL702_IoT
+   ----------------------
+     3V3   <-->   VDD
+     TXD   <-->   RX0
+     RXD   <-->   TX0
+     GND   <-->   GND
+
+-  烧写方法同上
+
+BL702_AVB 开发板
+--------------------------
+
+使用 CK-Link 烧写、调试连接方法
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  ``TO DO``
+
+使用串口烧写程序连接方法
+^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+-  ``TO DO``
+

docs/development_guide/source/get_started/get_started.rst

@@ -0,0 +1,43 @@
+开发前的准备
+=============================
+
+硬件环境准备
+-----------------------------
+
+- 一块 BL702 系列 MCU 的开发板：
+
+  - BL706_IOT 开发板， or
+  - BL706_AVB 开发板
+
+BL706_Iot 开发板如下图所示
+
+.. figure:: img/bl702_iot.png
+   :alt:
+   
+   BL706_IoT
+
+BL706_AVB 开发板如下图所示
+
+.. figure:: img/bl706_avb.png
+   :alt:
+   
+   BL706_AVB
+
+-  一个支持标准 JTAG 功能的调试器：
+
+  - CK-Link 仿真器，or
+  - Jlink V11 仿真器，or
+  - Sipeed USB-JTAG/TTL 调试器，or
+  - Bouffalo Lab Debugger 调试器
+
+-  一台 PC 主机（运行 Windows 或者 Linux 系统）
+
+软件环境准备
+--------------------------------
+
+为了更好的进行 BL702 系列 MCU 的开发，建议您应当具备以下开发环境：
+
+-  Windows 使用 `CDK <Windows_quick_start_cdk.html>`_ 环境开发 (建议 Windows 7 以上版本。) ，or
+-  `Windows <Windows_quick_start_eclipse.html>`_ 使用 Eclipse 环境开发 (建议 Windows 7 以上版本。) ，or
+-  `Linux <Linux_quick_start_ubuntu.html>`_ (建议使用 Ubuntu 18 以上的 LTS 版本)
+