doc: bootloader build and flash documentation (#52)

mercedes-benz · Apr 25, 2024 · 13863b1 · 13863b1
1 parent c300b38
commit 13863b1
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 5 deletions.
diff --git a/doc/bootloader_mode/index.rst → doc/bootloader/index.rst b/doc/bootloader_mode/index.rst → doc/bootloader/index.rst
@@ -1,11 +1,45 @@
-.. _bootloader_mode:
-
-Bootloader mode
-###############
+.. _bootloader:
+   
+Bootloader
+##########
 
 .. contents::
    :local:
    :depth: 2
+
+Building the bootloader
++++++++++++++++++++++++
+
+The bootloader can be build with:
+
+.. code-block:: bash
+   
+    west ardep build-bootloader
+
+The first line of the output gives you the expanded `west build` command.
+
+
+Flashing the bootloader
++++++++++++++++++++++++
+
+The bootloader is flashed with an external debug probe (e.g. J-Link) using the `west flash` command.
+
+For this connect the SWD Pins of the ARDEP board to the debug probe an run:
+
+.. code-block:: bash
+   
+    west flash -d {BUILD_DIR}
+
+The Pinout of the SWD connector is printed on the boards backside.
+
+See the `board.cmake` file under `boards/arm/ardep` for more info about supported debuggers.
+
+
+.. _bootloader_mode:
+
+Bootloader mode
++++++++++++++++
+
 
 In this mode, the ardep board does not load any firmware and waits for a firmware upgrade via the ``dfu-util`` tool.
 This is handy if your firmware is broken and you can't update it from there.

diff --git a/doc/index.rst b/doc/index.rst
@@ -12,7 +12,7 @@ Welcome to the ARDEP documentation!
 
    introduction/index.rst
    getting_started/index.rst
-   bootloader_mode/index.rst
+   bootloader/index.rst
    console/index.rst
    error_handling/index.rst
    README.rst