mirror of
https://github.com/Fishwaldo/bl_mcu_sdk.git
synced 2025-07-13 08:18:36 +00:00
[docs] update quick start rst
This commit is contained in:
qqwang
jzlv
parent
38a8f4e0a5
commit
bdf17c5e46
67 changed files with 1170 additions and 577 deletions
|
|
@ -54,186 +54,16 @@ Windows 下使用 CDK (类 MDK Keil)开发指南
|
|||
|
||||
**使用 Sipeed RV-Debugger Plus 调试工程时请按照下面的步骤进行：**
|
||||
|
||||
打开 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 获取到 SDK 后，进入 sdk 中的 ``examples/hellowd/helloworld/cdk`` 目录下，双击 ``helloworld.cdkproj``，即可打开 ``Helloworld`` 工程
|
||||
|
||||
编译 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. figure:: img/cdk1.png
|
||||
:alt:
|
||||
|
||||
helloworld.cdkproj
|
||||
|
||||
- 在活动工程下拉菜单选择 ``OpenOCD_Debug`` 工程，由于 Sipeed RV-Debugger Plus 是使用 OpenOCD 调试的，所以本教程基于 ``OpenOCD_Debug`` 工程；
|
||||
- 如 Sipeed RV-Debugger Plus 没有正确安装驱动，请参考 :ref:`sipeed_rv_debugger_plus` 部分，设置好驱动程序，在进行下面的步骤
|
||||
|
||||
- 在 CDK 工具栏中，点击编译图标即可编译工程
|
||||
|
||||
- 点击 ``1`` 处 图标 ``Build Project`` 即可编译当前选中的工程
|
||||
- 点击 ``2`` 处 图标 ``Clean Project`` 即可清除上次编译的结果
|
||||
- 点击 ``3`` 处 图标 ``Flash Download`` 即可将编译好的代码下载到芯片中 （**使用 OpenOCD Debug 不能使用 Flash 下载功能**）
|
||||
- 点击 ``4`` 处 图标 ``Start/Stop Debug`` 即可进行 debug 的相关操作
|
||||
- 也可以在 ``Project`` 中，右击工程名称，通过右击菜单中的选项对项目进行编译等操作
|
||||
|
||||
|
||||
烧写 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 在 CDK 中使用 OpenOCD 模式的调试方式时，暂不支持直接使用 CDK 相关 flash 工具下载代码，所以请使用 BL Dev Cube 工具进行程序烧写，烧写代码请参考 :ref:`bl_dev_cube` 部分进行
|
||||
- 代码烧写完成后使用 CDK 进行 Debug
|
||||
|
||||
运行 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！``
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
使用 Sipeed RV-Debugger <cdk_rv_debugger_plus>
|
||||
|
||||
**使用 CK-Link 调试工程时请按照下面的步骤进行：**
|
||||
|
||||
打开 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
- 获取到 SDK 后，进入 sdk 中的 ``examples/hellowd/helloworld/cdk`` 目录下，双击 ``helloworld.cdkproj``，即可打开 ``Helloworld`` 工程
|
||||
|
||||
编译 Hello World
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
.. figure:: img/cdk1.png
|
||||
:alt:
|
||||
|
||||
helloworld.cdkproj
|
||||
|
||||
- 在活动工程下拉菜单可以选择 ``CK_Link_Debug`` 或者 ``OpenOCD_Debug`` 工程，本教程基于 ``CK_Link_Debug`` 工程
|
||||
|
||||
- 在 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！
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
使用 CK-Link <cdk_ck_link>
|
||||
|
||||
|
||||
|
|
|
|||
116
docs/development_guide/source/get_started/cdk_ck_link.rst
Normal file
116
docs/development_guide/source/get_started/cdk_ck_link.rst
Normal file
|
|
@ -0,0 +1,116 @@
|
|||
使用 CDK + CK-Link 编译调试
|
||||
=============================
|
||||
|
||||
|
||||
打开 Hello World
|
||||
------------------------------
|
||||
|
||||
- 获取到 SDK 后，进入 sdk 中的 ``examples/hellowd/helloworld/cdk`` 目录下，双击 ``helloworld.cdkproj``，即可打开 ``Helloworld`` 工程
|
||||
|
||||
编译 Hello World
|
||||
------------------------------
|
||||
|
||||
.. figure:: img/cdk1.png
|
||||
:alt:
|
||||
|
||||
helloworld.cdkproj
|
||||
|
||||
- 在活动工程下拉菜单可以选择 ``CK_Link_Debug`` 或者 ``OpenOCD_Debug`` 工程，本教程基于 ``CK_Link_Debug`` 工程
|
||||
|
||||
- 在 CDK 工具栏中，点击编译图标即可编译工程
|
||||
|
||||
- 点击 ``1`` 处 图标 ``Build Project`` 即可编译当前选中的工程
|
||||
- 点击 ``2`` 处 图标 ``Clean Project`` 即可清除上次编译的结果
|
||||
- 点击 ``3`` 处 图标 ``Flash Download`` 即可将编译好的代码下载到芯片中
|
||||
- 点击 ``4`` 处 图标 ``Start/Stop Debug`` 即可进行 debug 的相关操作（在使用 ``CK-Link`` 时可以先将代码 load 到 flash 中）
|
||||
- 点击 ``5`` 处 图标 ``Start/Stop Debug whitout Download`` 即可直接进行 debug , 不 load 当前 bin 文件
|
||||
- 也可以在 ``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！
|
||||
|
||||
|
|
@ -0,0 +1,70 @@
|
|||
使用 CDK + Sipeed RV-Debugger Plus 编译调试
|
||||
==============================================
|
||||
|
||||
打开 Hello World
|
||||
------------------------------
|
||||
|
||||
- 获取到 SDK 后，进入 sdk 中的 ``examples/hellowd/helloworld/cdk`` 目录下，双击 ``helloworld.cdkproj``，即可打开 ``Helloworld`` 工程
|
||||
|
||||
编译 Hello World
|
||||
------------------------------
|
||||
|
||||
.. figure:: img/cdk1.png
|
||||
:alt:
|
||||
|
||||
helloworld.cdkproj
|
||||
|
||||
- 在活动工程下拉菜单选择 ``OpenOCD_Debug`` 工程，由于 Sipeed RV-Debugger Plus 是使用 OpenOCD 调试的，所以本教程基于 ``OpenOCD_Debug`` 工程；
|
||||
- 如 Sipeed RV-Debugger Plus 没有正确安装驱动，请参考 :ref:`sipeed_rv_debugger_plus` 部分，设置好驱动程序，在进行下面的步骤
|
||||
|
||||
- 在 CDK 工具栏中，点击编译图标即可编译工程
|
||||
|
||||
- 点击 ``1`` 处 图标 ``Build Project`` 即可编译当前选中的工程
|
||||
- 点击 ``2`` 处 图标 ``Clean Project`` 即可清除上次编译的结果
|
||||
- 点击 ``3`` 处 图标 ``Flash Download`` 即可将编译好的代码下载到芯片中 （**使用 OpenOCD Debug 不能使用 Flash 下载功能**）
|
||||
- 点击 ``5`` 处 图标 ``Start/Stop Debug whitout Download`` 即可直接进行 debug , 不 load 当前 bin 文件
|
||||
- 也可以在 ``Project`` 中，右击工程名称，通过右击菜单中的选项对项目进行编译等操作
|
||||
|
||||
|
||||
烧写 Hello World
|
||||
----------------------------
|
||||
|
||||
- 在 CDK 中使用 OpenOCD 模式的调试方式时，暂不支持直接使用 CDK 相关 ``flash`` 工具下载代码，所以请使用 BL Dev Cube 工具进行程序烧写，烧写代码请参考 :ref:`bl_dev_cube` 部分进行
|
||||
- 代码烧写完成后使用 CDK 进行 Debug
|
||||
|
||||
运行 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！``
|
||||
|
||||
|
|
@ -60,6 +60,8 @@ BL706_AVB 开发板如下图所示
|
|||
|
||||
- 1. 首先，将调试器 Type-C USB 接口使用 USB 数据线连接到 PC 主机，打开 PC 的设备管理器，在端口一栏可以看到调试器被识别为两个串口（*注：不是开发板上的串口*），或者在 ``通用串行总线控制器`` 看到 ``USB Serial Converter A`` 和 ``USB Serial Converter B``
|
||||
|
||||
.. important:: **注意:** 若在设备管理器中看到的串口名称为 “``USB 串行设备(COM*)``”，说明调试器进入了 ``Boot`` 模式。请将调试器断电重新上电，注意先不要将调试器连接到目标板；此时在到设备管理器中看是否正常
|
||||
|
||||
.. figure:: img/sipeed_rv_debugger_1.png
|
||||
|
||||
.. figure:: img/sipeed_rv_debugger_4.png
|
||||
|
|
@ -83,6 +85,8 @@ BL706_AVB 开发板如下图所示
|
|||
|
||||
.. caution:: 2. 在设备管理器中没有看到任何串口，但是在``通用串行总线控制器``中看到 ``USB Serial Converter A`` 和 ``USB Serial Converter B``；遇到这种情况，请到 `FTDI 官网 <https://ftdichip.com/drivers/vcp-drivers/>`_ 下载与系统匹配的驱动，将 ``USB Serial Converter B`` 重新安装为串口；``USB Serial Converter A`` 也即 Interface 0，使用 ``zadig-2.4.exe`` 替换为 WinUSB 驱动。
|
||||
|
||||
.. caution:: 3. 如果经过上面的操作还是不能正常使用，没有出现正确的现象，那么建议从 Sipeed 官方 `GitHub <https://github.com/sipeed/RV-Debugger-BL702>`_ 仓库获取固件，重新烧写；按住调试器上的 ``Boot`` 键不要释放，将调试器插入电脑上电，使调试器进入 Boot 模式，重新刷入固件后；断电重启
|
||||
|
||||
**Linux**
|
||||
|
||||
- 安装 Openocd 及其需要的依赖项
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 86 KiB After Width: | Height: | Size: 84 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.2 KiB |
|
|
@ -16,7 +16,7 @@ BL MCU SDK 将为您提供博流 BL70X 系列 MCU 开发的全方位支持。
|
|||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: 快速开发指南
|
||||
:numbered:
|
||||
:numbered: 3
|
||||
|
||||
get_started/get_started
|
||||
get_started/index
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue