Skip to content

Commit

Permalink
doc: add initial doc for gd32vf103c_dlink board
Browse files Browse the repository at this point in the history
Signed-off-by: Huaqi Fang <[email protected]>
  • Loading branch information
fanghuaqi committed Feb 22, 2024
1 parent fec38db commit 264842c
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 0 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
60 changes: 60 additions & 0 deletions doc/source/design/board/gd32vf103c_dlink.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
.. _design_board_gd32vf103c_dlink:

GD32VF103C DLink Debugger
=========================

.. _design_board_gd32vf103c_dlink_overview:

Overview
--------

This GD32VF103C DLink Debugger is used to debug Nuclei RISC-V CPU from Nuclei
using **GD32VF103CVBT6** as main MCU.

.. _figure_design_board_gd32vf103c_dlink_1:

.. figure:: /asserts/images/gd32vf103c_dlink_board.jpg
:width: 80 %
:align: center
:alt: GD32VF103C DLink Debugger Board

GD32VF103C DLink Debugger Board

Click https://github.com/nuclei-Software/nuclei-dlink to learn more about
Nuclei DLink project.

.. _design_board_gd32vf103c_dlink_setup:

Setup
-----


.. _design_board_gd32vf103c_dlink_usage:

How to use
----------

For **GD32VF103C DLink Debugger** board, the **DOWNLOAD** and **CORE** variables
are fixed to ``flashxip`` and ``n205``.

* You can find its linker script in ``SoC/gd32vf103/Board/gd32vf103c_dlink/Source/GCC/``

- ``gcc_gd32vf103_flashxip.ld``: Linker script file for ``DOWNLOAD=flashxip``

* If you want to specify your own modified linker script, you can follow steps described in :ref:`develop_appdev_linkscript`
* You can find its openocd configuration file in ``SoC/gd32vf103/Board/gd32vf103c_dlink/openocd_gd32vf103.cfg``

To run this application in GD32VF103C DLink Debugger board in Nuclei SDK,
you just need to use this **SOC** and **BOARD** variables.

.. code-block:: shell
# Clean the application
make SOC=gd32vf103 BOARD=gd32vf103c_dlink clean
# Build the application
make SOC=gd32vf103 BOARD=gd32vf103c_dlink all
# Upload the application using openocd and gdb
make SOC=gd32vf103 BOARD=gd32vf103c_dlink upload
# Debug the application using openocd and gdb
make SOC=gd32vf103 BOARD=gd32vf103c_dlink debug
1 change: 1 addition & 0 deletions doc/source/design/board/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,5 @@ Board
gd32vf103v_rvstar.rst
gd32vf103v_eval.rst
gd32vf103c_longan_nano.rst
gd32vf103c_dlink.rst
gd32vf103c_t_display.rst
2 changes: 2 additions & 0 deletions doc/source/develop/buildsystem.rst
Original file line number Diff line number Diff line change
Expand Up @@ -513,6 +513,8 @@ Currently we support the following SoCs.
- Reference
* - gd32vf103v_rvstar
- :ref:`design_board_gd32vf103v_rvstar`
* - gd32vf103c_dlink
- :ref:`design_board_gd32vf103c_dlink`
* - gd32vf103v_eval
- :ref:`design_board_gd32vf103v_eval`
* - gd32vf103c_longan_nano
Expand Down

0 comments on commit 264842c

Please sign in to comment.