doc: Bare Metal 1.0.0 doc release updates

b-gent · b-gent · commit 9e9ae0d19272 · 2025-12-16T12:39:43.000+01:00
Typical updates related to release plus late changes.

Signed-off-by: Bartosz Gentkowski &lt;bartosz.gentkowski@nordicsemi.no&gt;
diff --git a/doc/nrf-bm/doxygen/mainpage.dox b/doc/nrf-bm/doxygen/mainpage.dox
@@ -1,5 +1,5 @@
 /**
-@mainpage nRF Connect SDK Bare Metal option 1.0.0-rc2 API documentation
+@mainpage nRF Connect SDK Bare Metal option v1.0.0 API documentation
 
 <a href="topics.html">API Reference</a>
 
diff --git a/doc/nrf-bm/drivers.rst b/doc/nrf-bm/drivers.rst
@@ -11,45 +11,18 @@ This will mostly be more higher-level drivers and should be seen as a supplement
    Only the drivers located under :file:`nrf-bm/drivers` and the ones provided in nrfx are in the scope of the |BMshort|.
    All other drivers that are included in the distribution must be ignored when working with the Bare Metal option.
 
-Pre-allocated resources
-***********************
-
-Some peripherals will be pre-allocated by the system and must not be accessed directly by the application.
+Some peripherals are pre-allocated by the system and must not be accessed directly by the application.
 
 By default, |BMshort| initializes a system timer that is used by both the :ref:`lib_bm_timer` and logging timestamp.
-This will allocate ``GRTC`` channel ``0`` and ``GRTC_2_IRQn``.
+This allocates the ``GRTC`` channel ``0`` and ``GRTC_2_IRQn``.
 The initialization starts ``GRTC`` and enables ``SYSCOUNTER``, as required by the SoftDevice.
 
-When SoftDevice is enabled, it takes the ownership of the peripherals that it needs.
+When the SoftDevice is enabled, it takes the ownership of the peripherals that it needs.
 They will not be available for application to use.
-The SoftDevice is reusing both the `SoftDevice Controller`_ and the `Multiprotocol Service Layer`_ from the nRF Connect SDK.
+The SoftDevice is reusing both the `SoftDevice Controller`_ and the `Multiprotocol Service Layer`_ from the |NCS|.
 See the Integration Notes documentation for these libraries to get an overview of the resource it will be using.
 
-For details on SoftDevice behavior, see the `S115 SoftDevice Specification`_.
-
-nrfx
-****
-
-The |BMshort| is set up to use nrfx that comes with the nRF Connect SDK.
-
-In |BMshort|, it is expected that the application uses either the nrfx driver or, if needed, interacts directly with the peripheral register interface (nrf hal).
-
-To learn more, see the `nrfx documentation`_ that is distributed as separate bundle.
-The nrfx source code is located in :file:`../modules/hal/nordic/nrfx`.
-
-.. note::
-
-   The CMake in Bare Metal option is already set up to include the source code from nrfx.
-
-To include and start using the nrfx driver:
-
- * Include the interface file, like :file:`#include <nrfx_spim.h>` for the SPI Master driver.
- * Start adding code in your application to set up, initialize and start using the driver.
-
-To start interacting directly with a peripheral through the register interface:
-
-* Include the interface file, like :file:`#include <hal/nrf_gpio.h>` for GPIO.
-* Start adding code interacting with the register interface (:file:`nrf_gpio_pin_write(….)` ).
+For details on the SoftDevice behavior, see the `S115 SoftDevice Specification`_.
 
 .. toctree::
    :maxdepth: 1
diff --git a/doc/nrf-bm/drivers/bm_nrfx.rst b/doc/nrf-bm/drivers/bm_nrfx.rst
@@ -0,0 +1,25 @@
+.. _driver_nrfx:
+
+nrfx
+####
+
+The |BMshort| is set up to use nrfx that comes with the |NCS|.
+
+In |BMshort|, it is expected that the application uses either the nrfx driver or, if needed, interacts directly with the peripheral register interface (nrf hal).
+
+To learn more, see the `nrfx documentation`_ that is distributed as a separate bundle.
+The nrfx source code is located in :file:`../modules/hal/nordic/nrfx`.
+
+.. note::
+
+   The CMake in |BMshort| is already set up to include the source code from nrfx.
+
+To include and start using the nrfx driver:
+
+ * Include the interface file, like :file:`#include <nrfx_spim.h>` for the SPI Master driver.
+ * Start adding code in your application to set up, initialize, and start using the driver.
+
+To start interacting directly with a peripheral through the register interface:
+
+* Include the interface file, like :file:`#include <hal/nrf_gpio.h>` for GPIO.
+* Start adding code interacting with the register interface (:file:`nrf_gpio_pin_write(….)`).
diff --git a/doc/nrf-bm/install_nrf_bm.rst b/doc/nrf-bm/install_nrf_bm.rst
@@ -73,7 +73,7 @@ Every |BMlong| release consists of:
 
       #. In the next page you will be prompted to **Select SDK type**, click :guilabel:`nRF Connect SDK Bare Metal`.
 
-      #. In the next page you will be prompted to **Select an SDK version (or enter the branch, tag or commit SHA) to install...**, click :guilabel:`v0.9.0` marked on the right by the label :guilabel:`Pre-packaged SDKs & Toolchains`.
+      #. In the next page you will be prompted to **Select an SDK version (or enter the branch, tag or commit SHA) to install...**, click :guilabel:`v1.0.0` marked on the right by the label :guilabel:`Pre-packaged SDKs & Toolchains`.
 
       #. In the next page you will be prompted to select a destination for the SDK. The default suggestion is recommended. Then press **Enter**.
          This will proceed by installing |BMshort| and the respective Toolchain it requires.
@@ -119,7 +119,7 @@ Every |BMlong| release consists of:
 
             #. In the next page you will be prompted to **Select SDK type**, click :guilabel:`nRF Connect SDK Bare Metal`.
 
-            #. In the next page you will be prompted to **Select an SDK version (or enter the branch, tag or commit SHA) to install...**, click :guilabel:`v0.9.0` marked on the right by the label :guilabel:`GitHub`.
+            #. In the next page you will be prompted to **Select an SDK version (or enter the branch, tag or commit SHA) to install...**, click :guilabel:`v1.0.0` marked on the right by the label :guilabel:`GitHub`.
 
             #. In the next page you will be prompted to select a destination for the SDK. The default suggestion is recommended. Then press **Enter**.
                This will proceed by installing |BMshort|.
diff --git a/doc/nrf-bm/links.txt b/doc/nrf-bm/links.txt
@@ -13,7 +13,9 @@
 .. ### Source: docs.nordicsemi
 
 .. _`nRF54L15 DK`: https://docs.nordicsemi.com/bundle/ncs-latest/page/zephyr/boards/nordic/nrf54l15dk/doc/index.html#nrf54l15dk-nrf54l15
+.. _`nRF54L15 DK v1.0.0`: https://docs.nordicsemi.com/bundle/comp_matrix_nrf54l15/page/COMP/nrf54l15/nrf54l15_ic_rev_comp_with_dev_hw.html
 .. _`nRF54L15 DK v0.9.3`: https://docs.nordicsemi.com/bundle/comp_matrix_nrf54l15/page/COMP/nrf54l15/nrf54l15_ic_rev_comp_with_dev_hw.html
+.. _`v3.2.0 software maturity levels`: https://docs.nordicsemi.com/bundle/ncs-3.2.0/page/nrf/releases_and_maturity/software_maturity.html
 
 .. ### Installation
 
@@ -89,7 +91,8 @@
 
 .. ### Release notes and migration
 
-.. _`nrfx migration guides`: https://github.com/NordicSemiconductor/nrfx/wiki/nrfx-2.11.0-to-3.0.0
+.. _`nrfx 3.0 migration guide`: https://github.com/NordicSemiconductor/nrfx/wiki/nrfx-2.11.0-to-3.0.0
+.. _`nrfx 4.0 migration guide`: https://github.com/NordicSemiconductor/nrfx/wiki/nrfx-3.14.0-to-4.0.0
 .. _`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
 .. _`S115 9.0.0-3.prototype API reference`: https://docs.nordicsemi.com/bundle/s115_9.0.0-3.prototype_api/page/topics.html
 .. _`nRF5 SDK DFU memory layout`: https://docs.nordicsemi.com/bundle/sdk_nrf5_v17.1.0/page/lib_bootloader.html
diff --git a/doc/nrf-bm/migration/nrf5_bm_migration.rst b/doc/nrf-bm/migration/nrf5_bm_migration.rst
@@ -120,15 +120,19 @@ The Bluetooth LE services currently offered in |BMshort| are the following:
 
 * Peripheral services:
 
+  * Battery (peripheral)
+  * Bond Management (peripheral, experimental)
+  * Continuous Glucose Monitor (peripheral, experimental)
+  * Device Information (peripheral)
   * Heart Rate Monitor (peripheral)
+  * Human Interface Device (peripheral)
+  * MCUmgr (peripheral)
   * Nordic UART (NUS) (peripheral)
   * Nordic LED Button (LBS) (peripheral)
-  * Continuous Glucose Monitor (peripheral)
-  * Battery (peripheral)
 
-* MCUMgr service (DFU service)
-* Bond Management
-* Device Information
+* Central services:
+
+  * Heart Rate Service (central, experimental)
 
 Utility libraries for Bluetooth LE are available in |BMshort|, though their collection may not be as complete, and their functionality and API may be slightly different than their respective nRF5 implementation.
 
@@ -153,10 +157,10 @@ See table below for a summary of supported libraries.
      -
      -
    * - ``ble_db_discovery``
-     - No
-     -
      - Yes
      -
+     -
+     - Experimental
    * - ``ble_conn_params``
      - Yes
      - Name unchanged
@@ -198,19 +202,19 @@ See table below for a summary of supported libraries.
      -
      -
    * - ``nrf_ble_scan``
-     - No
-     -
      - Yes
+     - ``ble_scan``
      -
+     - Experimental
    * - ``ble_link_ctx_manager``
      - No
      -
      - No
      - Functionality implemented manually where needed
    * - ``ble_radio_notification``
-     - No
-     -
      - Yes
+     - Name unchanged
+     -
      -
    * - ``peer_manager``
      - Yes
@@ -222,7 +226,7 @@ SoftDevice integration
 **********************
 
 The SoftDevice, serving as a Bluetooth Low Energy protocol stack, maintains a consistent API from the nRF5 SDK to the |BMshort| environment.
-For instance, the API functionalities in SoftDevice S115 are comparable to those in S113.
+For instance, the API functionalities in SoftDevice S115 and S145 are comparable to those in S113 and S140, respectively.
 
 However, notable changes have occurred in how the SoftDevice is integrated within the system.
 
@@ -240,7 +244,7 @@ Interrupt Handling
 The responsibility for interrupt handling has shifted in |BMshort| - the application must now manage interrupts and forward them to the SoftDevice as needed.
 
 It is important to note that while the API remains compatible, the SoftDevices themselves are not binary-compatible between the two environments.
-SoftDevices from the nRF5 SDK cannot be reused in |BMshort|, and similarly, the S115 SoftDevice is not compatible with the nRF5 SDK.
+SoftDevices from the nRF5 SDK cannot be reused in |BMshort|, and similarly, the S115 and S145 SoftDevices are not compatible with the nRF5 SDK.
 
 Other libraries
 ***************
@@ -255,6 +259,30 @@ This is due to several factors, including:
 * Different project configuration mechanism, inherently affecting how libraries are configured.
 * Different coding standard in the |NCS| (for example, limited use of ``typedef``).
 
+Error codes
+***********
+
+nRF5 mainly used the unsigned nRF errors defined in ``nrf_error.h`` for error handling, with ``NRF_SUCCESS`` for successful operations and errors such as ``NRF_ERROR_NO_MEM`` and ``NRF_ERROR_FORBIDDEN``.
+In addition to the generic nRF errors, the nRF5 also used BLE SoftDevice errors defined in ``nrf_error_soc.h`` and ``nrf_error_sdm.h``, and the errors from the nrfx header within the same error scope, but with a diffeent base offset.
+
+|BMshort| uses the nRF errors for BLE related libraries and services, including the SoftDevice APIs.
+For other libraries and drivers, including nRFX, the signed ``errno`` error space is used.
+Defined as a signed integer (``int``) with ``0`` reprecenting a successful operation and errors returned as negative values, e.g. ``-ENOMEM`` and ``-EPERM``.
+
+In |BMshort| the return type of a function can be a good indication of the error space used, together with the header location:
+
+* If the header resides within a ``bluetooth`` folder it is likely using the nRF error space.
+  Else it is using the ``errno`` error space.
+* If the return type is ``uint32_t`` it is likely using the nRF error space.
+  If the return type is ``int`` it is likely using the ``errno`` error space.
+* For return values using the nRF error space, the variable is typically named ``nrf_error``.
+  If the variable used to store the return variable is named ``err``, ``retval`` or ``ret`` it is more likely to use the ``errno`` error space.
+
+.. note::
+
+  In |BMshort| ``NRF_SUCCESS`` is defined as ``0``.
+  You will therefore find checks such as ``if (nrf_error)`` in the code, though the generic solution would be ``if (nrf_error != NRF_SUCCESS)``.
+
 .. _nrf5_bm_migration_dfu:
 
 DFU
@@ -313,4 +341,5 @@ The desktop and mobile tools available for the |NCS| are also compatible with th
 Drivers
 *******
 
-For migration of nrfx drivers, see `nrfx migration guides`_.
+For migration of nrfx drivers, see the `nrfx 3.0 migration guide`_ and the `nrfx 4.0 migration guide`_.
+|BMshort| is using nRFX 4.0, though details from `nrfx 3.0 migration guide`_ might be required when migrating from nRF5.
diff --git a/doc/nrf-bm/release_notes.rst b/doc/nrf-bm/release_notes.rst
@@ -1,15 +1,16 @@
 .. _release_notes_bm:
 
-Release notes
-#############
+Releases and maturity
+#####################
 
 The following is a list of all release notes documents for various releases of the |BMlong|.
 
 .. toctree::
    :maxdepth: 1
    :caption: Subpages:
 
-   release_notes/release_notes_changelog
+   release_notes/bm_software_maturity
+   release_notes/release_notes_1.0.0
    release_notes/release_notes_0.9.0
    release_notes/release_notes_0.8.0
    release_notes/release_notes_0.7.0
diff --git a/doc/nrf-bm/release_notes/bm_software_maturity.rst b/doc/nrf-bm/release_notes/bm_software_maturity.rst
@@ -0,0 +1,16 @@
+.. _bm_software_maturity:
+
+Software maturity levels
+########################
+
+.. contents::
+   :local:
+   :depth: 2
+
+This release of |BMlong| is based on |NCS| |ncs_release|.
+
+Refer to `v3.2.0 software maturity levels`_ for the detailed description of software maturity categories and levels in this release of |BMshort|.
+
+.. note::
+
+   Keep in mind that |Bmshort| offers a subset of the features included in |NCS|.
diff --git a/doc/nrf-bm/release_notes/release_notes_1.0.0.rst b/doc/nrf-bm/release_notes/release_notes_1.0.0.rst
diff --git a/doc/nrf-bm/release_notes/release_notes_changelog.rst b/doc/nrf-bm/release_notes/release_notes_changelog.rst
diff --git a/doc/nrf-bm/shortcuts.txt b/doc/nrf-bm/shortcuts.txt
