Skip to content

Commit ca35668

Browse files
tomchyrlubos
authored andcommitted
doc: Add support for nRF52840 dongle bare variant
Add a documentation, describing nRF52840 dongle bare variant. Signed-off-by: Tomasz Chyrowicz <[email protected]>
1 parent 31e6e97 commit ca35668

File tree

3 files changed

+24
-8
lines changed

3 files changed

+24
-8
lines changed

doc/nrf/app_dev/board_names.rst

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,15 +46,24 @@ While the board name is always present, other elements, such as the board revisi
4646
Check the Product Specification of the given SoC for more information about the available CPU clusters.
4747

4848
* :ref:`Variant <zephyr:glossary>` - You can use this board qualifier to build for a particular type or configuration of a build for a combination of SoC and CPU cluster.
49-
In the |NCS|, variants are used for indicating the usage of Cortex-M Security Extensions (CMSE) (security by separation):
49+
In the |NCS|, board variants are used for the following purposes:
5050

51-
* Entries without ``*/ns`` (for example, ``cpuapp``) - When you choose this target, you build the application core firmware as a single execution environment that does not use CMSE (:ref:`Trusted Firmware-M (TF-M) <ug_tfm>`).
52-
* Entries with ``*/ns`` (for example, ``cpuapp/ns``) - Recommended for more security.
53-
When you choose this target, you build the application with CMSE using security by separation.
54-
The application core firmware is placed in Non-Secure Processing Environment (NSPE) and uses Secure Processing Environment (SPE) for security features.
55-
By default, the build system automatically includes :ref:`Trusted Firmware-M (TF-M) <ug_tfm>` in SPE and merges it with NSPE.
51+
* Changing the default memory map - This applies to the entry for the nRF52840 Dongle with the ``*/bare`` variant (``nrf52840dongle/nrf52840/bare``).
52+
When you select this target, the firmware does not account for the onboard USB bootloader.
53+
This corresponds to using :zephyr:board:`flashing option 3 with an external debug probe <nrf52840dongle>`.
5654

57-
Read more about separation of processing environments on the :ref:`ug_tfm_security_by_separation` page.
55+
* Indicating the use of Cortex-M Security Extensions (CMSE), also known as security by separation:
56+
57+
* Variants without ``*/ns`` (for example, ``cpuapp``) - When you select this target, you build the application core firmware as a single execution environment without CMSE.
58+
See :ref:`Trusted Firmware-M (TF-M) <ug_tfm>` for more information.
59+
60+
* Variants with ``*/ns`` (for example, ``cpuapp/ns``) - Recommended for enhanced security.
61+
When you select this target, you build the application with CMSE enabled, using security by separation.
62+
63+
The application core firmware is placed in Non-Secure Processing Environment (NSPE) and uses Secure Processing Environment (SPE) for security features.
64+
By default, the build system automatically includes :ref:`Trusted Firmware-M (TF-M) <ug_tfm>` in SPE and merges it with NSPE.
65+
66+
Read more about separation of processing environments on the :ref:`ug_tfm_security_by_separation` page.
5867

5968
.. note::
6069
This board name scheme was introduced in the |NCS| before the v2.7.0 release following changes in Zephyr v3.6.0.
@@ -142,6 +151,8 @@ Also see the :ref:`zephyr:boards` section in the Zephyr documentation.
142151
| | | :ref:`nrf52840dk <zephyr:nrf52840dk_nrf52811>` | ``nrf52840dk/nrf52811`` |
143152
+-------------------+------------+--------------------------------------------------------+--------------------------------------------------------------------------+
144153
| nRF52840 Dongle | PCA10059 | :zephyr:board:`nrf52840dongle <nrf52840dongle>` | ``nrf52840dongle/nrf52840`` |
154+
| | | | |
155+
| | | | ``nrf52840dongle/nrf52840/bare`` |
145156
+-------------------+------------+--------------------------------------------------------+--------------------------------------------------------------------------+
146157
| nRF52833 DK | PCA10100 | :zephyr:board:`nrf52833dk <nrf52833dk>` | ``nrf52833dk/nrf52833`` |
147158
| | | | |

doc/nrf/app_dev/device_guides/nrf52/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ Zephyr and the |NCS| provide support and contain board definitions for developin
5555
- `Product Specification <nRF52805 Product Specification_>`_
5656
* - :zephyr:board:`nrf52840dongle`
5757
- PCA10059
58-
- ``nrf52840dongle/nrf52840``
58+
- | ``nrf52840dongle/nrf52840``
59+
| ``nrf52840dongle/nrf52840/bare``
5960
- | `Product Specification <nRF52840 Product Specification_>`_
6061
| `User Guide <nRF52840 Dongle User Guide_>`_
6162
* - :zephyr:board:`nrf21540dk`

doc/nrf/includes/sample_board_rows.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,10 @@
1414

1515
| :ref:`nRF52840 Dongle <ug_nrf52>` | PCA10059 | :zephyr:board:`nrf52840dongle <nrf52840dongle>` | ``nrf52840dongle/nrf52840`` |
1616

17+
.. nrf52840dongle_nrf52840_bare
18+
19+
| nRF52840 Dongle (:ref:`variant without onboard USB bootloader <app_boards>`) | PCA10059 | :zephyr:board:`nrf52840dongle <nrf52840dongle>` | ``nrf52840dongle/nrf52840/bare`` |
20+
1721
.. nrf9160dk_nrf9160
1822

1923
| :ref:`nRF9160 DK <ug_nrf9160>` | PCA10090 | :ref:`nrf9160dk <zephyr:nrf9160dk_nrf9160>` | ``nrf9160dk/nrf9160`` |

0 commit comments

Comments
 (0)