[docs] update api rst

This commit is contained in:
jzlv 2021-07-01 19:35:27 +08:00
parent 21e87ac8ca
commit af049a8ef8
156 changed files with 3156 additions and 508 deletions

View file

@ -55,39 +55,54 @@ BL706_AVB 开发板如下图所示
Sipeed RV-Debugger plus
**Windows**
^^^^^^^^^^^^^^^^^^^
- Sipeed RV-Debugger Plus 调试器在 Windows 系统中所以时我们需要将驱动更换为 ``Win USB`` 驱动
Sipeed RV-Debugger Plus 调试器在 Windows 系统中所以时我们需要将驱动更换为 ``Win USB`` 驱动
- 1. 首先,将调试器 Type-C USB 接口使用 USB 数据线连接到 PC 主机,打开 PC 的设备管理器,在端口一栏可以看到调试器被识别为两个串口(*注:不是开发板上的串口*),或者在 ``通用串行总线控制器`` 看到 ``USB Serial Converter A````USB Serial Converter B``
.. important:: **注意:** 若在设备管理器中看到的串口名称为 “``USB 串行设备(COM*)``”,说明调试器进入了 ``Boot`` 模式。请将调试器断电重新上电,注意先不要将调试器连接到目标板;此时在到设备管理器中看是否正常
- 1. 首先,将调试器 Type-C USB 接口使用 USB 数据线连接到 PC 主机,打开 PC 的设备管理器,在端口一栏可以看到调试器被识别为两个串口(*注:不是开发板上的串口*),或者在 ``通用串行总线控制器`` 看到 ``USB Serial Converter A````USB Serial Converter B``
.. figure:: img/sipeed_rv_debugger_1.png
.. figure:: img/sipeed_rv_debugger_4.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.
.. important:: 1. 调试器的端口号必须以 ``usb serial port`` 开头,如果插了多个类似的设备,请只留一个,确认调试器端口号
.. important:: 2. 若在设备管理器中看到的串口名称为 “``USB 串行设备(COM*)``”,说明调试器进入了 ``Boot`` 模式。请将调试器断电重新上电,注意先不要将调试器连接到目标板;此时在到设备管理器中看是否正常
.. figure:: img/sipeed_rv_debugger_7.png
.. important:: 3. 若在设备管理器中没有串口,显示其他设备,请到 `FTDI 官网 <https://ftdichip.com/drivers/vcp-drivers/>`_ 下载与系统匹配的驱动
.. figure:: img/sipeed_rv_debugger_6.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. 再次打开设备管理器, 看到其中一个串口被替换成通用串行总线设备就说明安装成功
- 4. 找到 JTAG Debugger(Interface 0),然后选择替换的驱动为 ``WinUSB`` 点击 Replace Driver 替换
- 5. 再次打开设备管理器, 看到其中一个串口被替换成通用串行总线设备就说明安装成功
.. figure:: img/sipeed_rv_debugger_2.png
- 6. 到这里 Sipeed RV-Debugger Plus 的设备驱动就更换好了,接下来就可以愉快的玩耍啦~
- 6. 到这里 Sipeed RV-Debugger Plus 的设备驱动就更换好了,接下来就可以愉快的玩耍啦~
**可能出现的问题:**
.. caution:: 1. 调试器接上时没有出现两个串口,调试器上有一个 LED 常亮,那么应该是进入了 Boot 模式。请将调试器断电重新上电,注意先不要将调试器连接到目标板;调试器上电后,正常情况下两个 LED 灯会闪烁一下熄灭;此时再看一下任务管理器中的设备是否正确。
.. 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 模式,重新刷入固件后;断电重启
.. caution:: 2. 如果经过上面的操作还是不能正常使用,没有出现正确的现象,那么建议从 Sipeed 官方 `GitHub <https://github.com/sipeed/RV-Debugger-BL702>`_ 仓库获取固件,重新烧写;按住调试器上的 ``Boot`` 键不要释放,将调试器插入电脑上电,使调试器进入 Boot 模式,重新刷入固件后;断电重启
**Linux**
^^^^^^^^^^^^^^^^^^^
- 首先,将调试器 Type-C USB 接口使用 USB 数据线连接到 PC 主机,执行以下命令,查看是否存在
.. code-block:: bash
$ lsusb
.. figure:: img/sipeed_rv_debugger_8.png
- 安装 Openocd 及其需要的依赖项

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB