Skip to content

Commit

Permalink
doc/host-tools: Add tabs to SAM-BA section to improve readability
Browse files Browse the repository at this point in the history
Reformats the three sections on flash configuration for devices with
different bootloader compatibility into tabs to streamline instructions

Signed-off-by: Julia Hathaway <[email protected]>
  • Loading branch information
Julia-Hathaway authored and cfriedt committed Jul 22, 2021
1 parent 573e70b commit 9708610
Showing 1 changed file with 29 additions and 31 deletions.
60 changes: 29 additions & 31 deletions doc/guides/flash_debug/host-tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,46 +31,44 @@ The typical command to flash the board is:
west flash [ -r bossac ] [ -p /dev/ttyX ]
Flash configuration for devices:

Devices with ROM bootloader
---------------------------
.. tabs::

These devices don't need any special configuration. After building your
application, just run ``west flash`` to flash the board.
.. tab:: With ROM bootloader

These devices don't need any special configuration. After building your
application, just run ``west flash`` to flash the board.

Devices without ROM bootloader
------------------------------
.. tab:: Without ROM bootloader

For these devices, the user should:
For these devices, the user should:

1. Define flash partitions required to accommodate the bootloader and
application image; see :ref:`flash_map_api` for details.
2. Have board :file:`.defconfig` file with the
:kconfig:`CONFIG_USE_DT_CODE_PARTITION` Kconfig option set to ``y`` to
instruct the build system to use these partitions for code relocation.
This option can also be set in ``prj.conf`` or any other Kconfig fragment.
3. Build and flash the SAM-BA bootloader on the device.
1. Define flash partitions required to accommodate the bootloader and
application image; see :ref:`flash_map_api` for details.
2. Have board :file:`.defconfig` file with the
:kconfig:`CONFIG_USE_DT_CODE_PARTITION` Kconfig option set to ``y`` to
instruct the build system to use these partitions for code relocation.
This option can also be set in ``prj.conf`` or any other Kconfig fragment.
3. Build and flash the SAM-BA bootloader on the device.

.. tab:: With compatible SAM-BA bootloader

Devices with compatible SAM-BA bootloader
-----------------------------------------
For these devices, the user should:

For these devices, the user should:

1. Define flash partitions required to accommodate the bootloader and
application image; see :ref:`flash_map_api` for details.
2. Have board :file:`.defconfig` file with the
:kconfig:`CONFIG_BOOTLOADER_BOSSA` Kconfig option set to ``y``. This will
automatically select the :kconfig:`CONFIG_USE_DT_CODE_PARTITION` Kconfig
option which instruct the build system to use these partitions for code
relocation. The board :file:`.defconfig` file should have
:kconfig:`CONFIG_BOOTLOADER_BOSSA_ARDUINO` ,
:kconfig:`CONFIG_BOOTLOADER_BOSSA_ADAFRUIT_UF2` or the
:kconfig:`CONFIG_BOOTLOADER_BOSSA_LEGACY` Kconfig option set to ``y``
to select the right compatible SAM-BA bootloader mode.
These options can also be set in ``prj.conf`` or any other Kconfig fragment.
3. Build and flash the SAM-BA bootloader on the device.
1. Define flash partitions required to accommodate the bootloader and
application image; see :ref:`flash_map_api` for details.
2. Have board :file:`.defconfig` file with the
:kconfig:`CONFIG_BOOTLOADER_BOSSA` Kconfig option set to ``y``. This will
automatically select the :kconfig:`CONFIG_USE_DT_CODE_PARTITION` Kconfig
option which instruct the build system to use these partitions for code
relocation. The board :file:`.defconfig` file should have
:kconfig:`CONFIG_BOOTLOADER_BOSSA_ARDUINO` ,
:kconfig:`CONFIG_BOOTLOADER_BOSSA_ADAFRUIT_UF2` or the
:kconfig:`CONFIG_BOOTLOADER_BOSSA_LEGACY` Kconfig option set to ``y``
to select the right compatible SAM-BA bootloader mode.
These options can also be set in ``prj.conf`` or any other Kconfig fragment.
3. Build and flash the SAM-BA bootloader on the device.

.. note::

Expand Down

0 comments on commit 9708610

Please sign in to comment.