Skip to content

Commit 02dccfa

Browse files
b-genteivindj-nordic
authored andcommitted
doc: doc release PR for 0.8.0
Add release notes and other release-related doc updates. Signed-off-by: Bartosz Gentkowski <[email protected]>
1 parent c1b50b3 commit 02dccfa

File tree

16 files changed

+279
-28
lines changed

16 files changed

+279
-28
lines changed

doc/nrf-bm/api/api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. nrf_bm_api:
1+
.. _nrf_bm_api:
22

33
API documentation
44
#################

doc/nrf-bm/app_dev/dfu/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.. _app_bootloaders:
1+
.. _bm_dfu:
22

33
Device Firmware Update (DFU)
44
############################

doc/nrf-bm/app_dev/dfu/memory_partitioning.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ The memory in the device is divided into several partitions, each serving a spec
3232
- Begins immediately after the storage partition or the IRoT partition if the storage is not enabled.
3333
The size is maximized up to the start of the firmware loader.
3434
* - slot1_partition
35-
- Serves as the location for the DFU mode and contains the Firmware Loader.
36-
- This partition contains the Firmware Loader that is validated by the IRoT.
37-
The Firmware Loader is started when entering the DFU mode.
35+
- Serves as the location for the DFU mode and contains the firmware loader.
36+
- This partition contains the firmware loader that is validated by the IRoT.
37+
The firmware loader is started when entering the DFU mode.
3838
* - softdevice_partition
3939
- Used by the SoftDevice.
4040
- Includes an MCUboot header of size 0x800.
41-
The SoftDevice is used by both the Firmware Loader and the Application that is running from ``slot0``
41+
The SoftDevice is used by both the firmware loader and the application that is running from ``slot0``
4242
* - metadata_partition
4343
- Utilized by the firmware loader and IRoT for storing metadata.
4444
- Reserves 0.5 kB at the top of the memory.
@@ -65,7 +65,7 @@ Vector table alignment
6565

6666
For images that are run as a `main application` that has its own interrupt vector table there is an `Vector table requirement`_ on how to place the interrupt vector table in memory.
6767
The table must be placed starting at the 2 kB boundary.
68-
An example of such images are Application and Firmware Loader.
68+
An example of such images are application and firmware loader.
6969
The SoftDevice is not affected by this requirement.
7070

7171
SoftDevice placement

doc/nrf-bm/app_dev/dfu/single_bank_dfu.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -23,20 +23,20 @@ The following are key steps in the single-bank application update.
2323
If the firmware is not valid, the bootloader reverts the device to DFU mode, allowing for another update attempt.
2424
#. **Activation**: Upon successful validation, the new firmware is activated.
2525

26-
SoftDevice and Firmware Loader update
26+
SoftDevice and firmware loader update
2727
=====================================
2828

29-
The following are the DFU steps when the SoftDevice and/or Firmware Loader are also updated.
29+
The following are the DFU steps when the SoftDevice and/or firmware loader are also updated.
3030

3131
.. figure:: ../../images/dfu_steps_sd_fwl.svg
3232
:alt: DFU operations for a single-bank SoftDevice and/or FW Loader update
3333

3434
1. **Replacement of Existing Application**: The new firmware update process begins with the replacement of the existing application by a new DFU image.
35-
This image includes an Installer along with updates for the Firmware Loader and/or the SoftDevice.
36-
#. **Validation**: Once the new DFU image is transferred, the system validates both the Installer image and the additional image(s) (Firmware Loader and/or the SoftDevice).
35+
This image includes an Installer along with updates for the firmware loader and/or the SoftDevice.
36+
#. **Validation**: Once the new DFU image is transferred, the system validates both the Installer image and the additional image(s) (firmware loader and/or the SoftDevice).
3737
#. **Installation**: After successful validation, the Installer image is activated.
38-
The Installer carries out the necessary actions to copy the Firmware Loader and SoftDevice to their designated locations in the device's memory.
39-
#. **Device Restart and Final Validation**: Following the installation, the device restarts and performs a final validation of the newly installed Firmware Loader and SoftDevice.
38+
The Installer carries out the necessary actions to copy the firmware loader and SoftDevice to their designated locations in the device's memory.
39+
#. **Device Restart and Final Validation**: Following the installation, the device restarts and performs a final validation of the newly installed firmware loader and SoftDevice.
4040
#. **Entry into DFU Mode**: Once the final validation is complete, the device enters DFU mode, ready to receive any further new images.
4141

42-
After a successful update of the SoftDevice and/or Firmware Loader, the application must be updated again following the process described in `Application update`_.
42+
After a successful update of the SoftDevice and/or firmware loader, the application must be updated again following the process described in `Application update`_.

doc/nrf-bm/app_dev/dfu/ug_dfu.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,20 +75,20 @@ When DFU is enabled in the application, the build system outputs the following f
7575
+--------------------------------------------------------------------------------+----------------------------------------------+--------------------------------+
7676
| File | Description | Programming scenario |
7777
+================================================================================+==============================================+================================+
78-
| :file:`<build_dir>/firmware_loader/zephyr/zephyr.signed.hex` | Firmware Loader Image. | Programming board targets. |
78+
| :file:`<build_dir>/firmware_loader/zephyr/zephyr.signed.hex` | Firmware loader image. | Programming board targets. |
7979
+--------------------------------------------------------------------------------+----------------------------------------------+ |
80-
| :file:`<build_dir>/mcuboot/zephyr/zephyr_signed_softdevice_flash_metadata.hex` | MCUBoot Image with SoftDevice. | |
80+
| :file:`<build_dir>/mcuboot/zephyr/zephyr_signed_softdevice_flash_metadata.hex` | MCUBoot image with SoftDevice. | |
8181
+--------------------------------------------------------------------------------+----------------------------------------------+ |
82-
| :file:`<build_dir>/<app_name>/zephyr/zephyr.signed.hex` | Application Image. | |
82+
| :file:`<build_dir>/<app_name>/zephyr/zephyr.signed.hex` | Application image. | |
8383
+--------------------------------------------------------------------------------+----------------------------------------------+--------------------------------+
8484
| :file:`<build_dir>/production.hex` | Production hex file, containing: MCUboot, | Production device programming. |
8585
| | firmware loader, SoftDevice and main | |
8686
| | application images. | |
8787
+--------------------------------------------------------------------------------+----------------------------------------------+--------------------------------+
88-
| :file:`<build_dir>/installer_softdevice_firmware_loader.bin` | Installer Update Image (DFU) with SoftDevice | DFU process for board targets. |
88+
| :file:`<build_dir>/installer_softdevice_firmware_loader.bin` | Installer Update image (DFU) with SoftDevice | DFU process for board targets. |
8989
| | and firmware loader updates. | |
9090
+--------------------------------------------------------------------------------+----------------------------------------------+ |
91-
| :file:`<build_dir>/<app_name>/zephyr/zephyr.signed.bin` | Application Update Image (DFU). | |
91+
| :file:`<build_dir>/<app_name>/zephyr/zephyr.signed.bin` | Application Update image (DFU). | |
9292
+--------------------------------------------------------------------------------+----------------------------------------------+--------------------------------+
9393

9494
Running DFU in your application

doc/nrf-bm/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
# -- Project information -----------------------------------------------------
1919

20-
project = 'nRF Connect SDK Bare Metal option - 0.7.99'
20+
project = 'nRF Connect SDK Bare Metal option - 0.8.0'
2121
copyright = '2025, Nordic Semiconductor'
2222
author = 'Nordic Semiconductor'
2323

doc/nrf-bm/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,5 @@ The |BMlong| is a distinct repository that incorporates elements from the existi
4646
samples.rst
4747
app_dev/dfu/index.rst
4848
release_notes.rst
49-
migration/nrf5_bm_migration.rst
5049
s115_docs.rst
5150
api/api.rst

doc/nrf-bm/install_nrf_bm.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -146,11 +146,13 @@ Next steps
146146

147147
You can now proceed to test the :ref:`samples` included in this version of |BMshort|.
148148

149-
The samples can be found in the :file:`nrf-bm/samples` folder, and are divided into two subfolders:
149+
The samples can be found in the :file:`nrf-bm/samples` folder, and are divided into subfolders:
150150

151151
* :file:`bluetooth` for the samples showcasing Bluetooth® LE functionalities using the SoftDevice.
152152
See :ref:`ble_samples`.
153153
* :file:`peripherals` for the samples showcasing various peripheral functionalities that do not require the SoftDevice.
154154
See :ref:`peripheral_samples`.
155+
* :file:`boot` for the samples showcasing the functionalities related to Device Firmware Update.
156+
See :ref:`dfu_samples`.
155157

156158
Each sample documentation contains full information on how to build, flash, and test the respective sample.

doc/nrf-bm/links.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
.. ### Source: docs.nordicsemi
1212

1313
.. _`nRF54L15 DK`: https://docs.nordicsemi.com/bundle/ncs-latest/page/zephyr/boards/nordic/nrf54l15dk/doc/index.html#nrf54l15dk-nrf54l15
14+
.. _`nRF54L15 DK v0.9.3`: https://docs.nordicsemi.com/bundle/comp_matrix_nrf54l15/page/COMP/nrf54l15/nrf54l15_ic_rev_comp_with_dev_hw.html
1415

1516
.. ### Installation
1617

@@ -74,3 +75,5 @@
7475
.. ### Release notes and migration
7576

7677
.. _`nrfx migration guides`: https://github.com/NordicSemiconductor/nrfx/wiki/nrfx-2.11.0-to-3.0.0
78+
.. _`Migration notes - nRF5 SDK to nRF Connect SDK Bare Metal option`: https://docs.nordicsemi.com/bundle/nrf-bm-latest/page/migration/nrf5_bm_migration.html
79+
.. _`S115 9.0.0-3.prototype API reference`: https://docs.nordicsemi.com/bundle/s115_9.0.0-3.prototype_api/page/topics.html

doc/nrf-bm/migration/nrf5_bm_migration.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
:orphan:
2+
13
.. _nrf5_bm_migration:
24

35
Migration notes - nRF5 SDK to nRF Connect SDK Bare Metal

0 commit comments

Comments
 (0)