From e4a47d5696e35355e1ec6969bd22c8807ceac2e3 Mon Sep 17 00:00:00 2001 From: Francesco Domenico Servidio Date: Tue, 1 Oct 2024 10:47:10 +0200 Subject: [PATCH] doc: Miscellaneous doc updates Miscellaneous doc updates and fixes. Signed-off-by: Francesco Domenico Servidio --- .../nrf54h/ug_nrf54h20_custom_pcb.rst | 2 +- doc/nrf/links.txt | 7 +++---- .../abi_compatibility.rst | 14 ++++++------- ...e_2.4.99-cs3_to_2.6.99-cs2_environment.rst | 8 ++++---- .../migration_guide_nRF54H20_cs_to_2_7.rst | 9 ++++----- ...ration_guide_nRF54H20_cs_to_2_7_99-cs1.rst | 8 ++++---- ...ration_guide_nRF54H20_cs_to_2_7_99-cs2.rst | 2 +- ...on_guide_2.4.99-cs3_to_2.7_application.rst | 6 +++--- ...on_guide_2.6.99-cs2_to_2.7_application.rst | 6 +++--- ...on_guide_2.6.99-cs2_to_2_7_environment.rst | 20 +++++++++---------- ...on_guide_2.4.99-cs3_to_2.7_environment.rst | 10 +++++----- 11 files changed, 45 insertions(+), 47 deletions(-) diff --git a/doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_custom_pcb.rst b/doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_custom_pcb.rst index 6fcfce643902..c0afcb1428fe 100644 --- a/doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_custom_pcb.rst +++ b/doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_custom_pcb.rst @@ -22,7 +22,7 @@ We highly recommend using the PCB layouts and component values provided by Nordi * For optimal performance, the output impedance of the **P6** and **P7** ports should match the PCB and external device pin impedance. * Use one of the following power supply options: - * VDDH higher than 2.2V + * VDDH higher than 2.05V. * VDDH shorted to VDD at 1.8V Prepare the configuration files for your custom board in the |NCS| diff --git a/doc/nrf/links.txt b/doc/nrf/links.txt index 08b0e185af1f..68057873d9ad 100644 --- a/doc/nrf/links.txt +++ b/doc/nrf/links.txt @@ -1690,10 +1690,9 @@ .. _`curl`: https://curl.se/ -.. _`nRF54H20 firmware bundle`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.5.0.zip -.. _`nRF54H20 firmware bundle v0.3.3`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.3.3.zip -.. _`nRF54H20 firmware bundle v0.5.0`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.5.0.zip -.. _`nRF54H20 firmware bundle v0.6.2`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.6.2.zip +.. _`nRF54H20 SoC Binaries v0.3.3`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.3.3.zip +.. _`nRF54H20 SoC Binaries v0.5.0`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.5.0.zip +.. _`nRF54H20 SoC Binaries v0.6.2`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.6.2.zip .. _`nRF54H20 SoC binaries v0.6.5`: https://files.nordicsemi.com/artifactory/SDSC/external/nrf54h20_soc_binaries_v0.6.5.zip .. _`BICR binary file`: https://files.nordicsemi.com/artifactory/SDSC/external/bicr_ext_loadcap.hex diff --git a/doc/nrf/releases_and_maturity/abi_compatibility.rst b/doc/nrf/releases_and_maturity/abi_compatibility.rst index b08de2eaad74..420cf9df5798 100644 --- a/doc/nrf/releases_and_maturity/abi_compatibility.rst +++ b/doc/nrf/releases_and_maturity/abi_compatibility.rst @@ -18,10 +18,10 @@ When ABI compatibility is maintained, binaries of one component can interface co For example, adding a new function to a library is typically an ABI-compatible change, as existing binaries remain functional. However, changes that affect data structure layouts, such as altering field order or size, break ABI compatibility as they change the memory layout expected by existing binaries. -ABI Compatibility Matrix for the nrf54h20_soc_binary bundle -=========================================================== +ABI Compatibility Matrix for the nRF54H20 SoC Binaries +====================================================== -The following table illustrates ABI compatibility between different versions of the nRF54H20 SoC binaries bundle and the |NCS|: +The following table illustrates ABI compatibility between different versions of the nRF54H20 SoC binaries and the |NCS|: .. list-table:: :header-rows: 1 @@ -29,13 +29,13 @@ The following table illustrates ABI compatibility between different versions of * - |NCS| versions - Compatible nRF54H20 SoC binaries version * - |NCS| v2.7.99-cs2 - - nrf54h20_soc_binaries v0.6.5 + - `nRF54H20 SoC Binaries v0.6.5`_ * - |NCS| v2.7.99-cs1 - - nrf54h20_soc_binaries v0.6.2 + - `nRF54H20 SoC Binaries v0.6.2`_ * - |NCS| v2.7.0 - - nrf54h20_soc_binaries v0.5.0 + - `nRF54H20 SoC Binaries v0.5.0`_ * - |NCS| v2.6.99-cs2 - - nrf54h20_soc_binaries v0.3.3 + - `nRF54H20 SoC Binaries v0.3.3`_ ABI compatibility ensures that the Secure Domain and System Controller firmware binaries do not need to be recompiled each time the Application, Radio binaries, or both are recompiled, as long as they are based on a compatible NCS version. Additionally, maintaining ABI compatibility allows the nRF54H20 SoC binaries components to work together without recompilation when updating to newer |NCS| versions. diff --git a/doc/nrf/releases_and_maturity/migration/2.4.99-cs3_to_2.6.99-cs2/migration_guide_2.4.99-cs3_to_2.6.99-cs2_environment.rst b/doc/nrf/releases_and_maturity/migration/2.4.99-cs3_to_2.6.99-cs2/migration_guide_2.4.99-cs3_to_2.6.99-cs2_environment.rst index b0a9ca02b9d4..49bf2e572dda 100644 --- a/doc/nrf/releases_and_maturity/migration/2.4.99-cs3_to_2.6.99-cs2/migration_guide_2.4.99-cs3_to_2.6.99-cs2_environment.rst +++ b/doc/nrf/releases_and_maturity/migration/2.4.99-cs3_to_2.6.99-cs2/migration_guide_2.4.99-cs3_to_2.6.99-cs2_environment.rst @@ -16,7 +16,7 @@ The main development environment changes introduced by 2.6.99-cs2 for the nRF54H * nRF Util has now replaced nRF Command Line Tools. The bootstrap script will now install and update nRF Util. * SDFW and SCFW are now provided as precompiled binaries. - The Secure Domain Firmware (SDFW) and System Controller Firmware (SCFW) are no longer built from the source during the application build process, but they must be provisioned as binaries from the provided firmware bundle before the DK can be used. + The Secure Domain Firmware (SDFW) and System Controller Firmware (SCFW) are no longer built from the source during the application build process, but they must be provisioned as binaries from the provided SoC binaries before the DK can be used. See the details in the `nRF54H20 DK bring-up`_ section below. * The nRF54H20 SoC lifecycle state must now be set to Root of Trust (RoT). See the details in the `Transitioning the nRF54H20 SoC to RoT`_ section. @@ -272,9 +272,9 @@ Programming the SDFW and SCFW ============================= After programming the BICR, the nRF54H20 SoC requires the provisioning of a bundle ( :file:`nrf54h20_soc_binaries_v0.3.3.zip`) containing the precompiled firmware for the Secure Domain and System Controller. -To program the Secure Domain Firmware (SDFW, also known as ``urot``) and the System Controller Firmware (SCFW) from the firmware bundle to the nRF54H20 DK, do the following: +To program the Secure Domain Firmware (SDFW, also known as ``urot``) and the System Controller Firmware (SCFW) from the SoC binaries to the nRF54H20 DK, do the following: -1. Download the `nRF54H20 firmware bundle`_. +1. Download the `nRF54H20 SoC binaries v0.3.3`_. #. Move the :file:`ZIP` bundle to a folder of your choice, then run nRF Util to program the binaries using the following command:: nrfutil device x-provision-nrf54h --firmware --serial-number @@ -284,7 +284,7 @@ To program the Secure Domain Firmware (SDFW, also known as ``urot``) and the Sys Updating the FICR ================= -After programming the SDFW and SCFW from the firmware bundle, you must update the Factory Information Configuration Registers (FICR) to correctly configure some trims of the nRF54H20 SoC. +After programming the SDFW and SCFW from the SoC binaries, you must update the Factory Information Configuration Registers (FICR) to correctly configure some trims of the nRF54H20 SoC. To update the FICR, you must run a J-Link script: 1. Get the Jlink script that updates the FICR:: diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7.rst index 76b759273996..faeeff027ef1 100644 --- a/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7.rst +++ b/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7.rst @@ -29,9 +29,8 @@ See the following documents, based on the version you are migrating from. nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2.7_application -.. toctree:: - :maxdepth: 1 - :caption: Other relevant migration documents - migration_hwmv2 - migration_sysbuild +Consult also the following pages about *Hardware model v2* and *Sysbuild*: + +* :ref:`hwmv1_to_v2_migration` +* :ref:`child_parent_to_sysbuild_migration` diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst index ff22d0bb91cc..615f6086bf7c 100644 --- a/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst +++ b/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst @@ -47,14 +47,14 @@ nRF54H20 BICR nrfutil device program --options chip_erase_mode=ERASE_NONE --firmware --core Application --serial-number SDFW and SCFW firmwares - The *nRF54H20 firmware bundle* has been updated to version 0.6.2. + The *nRF54H20 SoC binaries* have been updated to version 0.6.2. .. caution:: - Before proceeding with the firmware bundle update, you must first update the BICR as described in the previous chapter. + Before proceeding with the SoC binaries update, you must first update the BICR as described in the previous chapter. - To update the firmware bundle of your development kit while in Root of Trust, do the following: + To update the SoC binaries of your development kit while in Root of Trust, do the following: - 1. Download the `nRF54H20 firmware bundle v0.6.2`_. + 1. Download the `nRF54H20 SoC binaries v0.6.2`_. .. note:: On MacOS, ensure that the ZIP file is not unpacked automatically upon download. diff --git a/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst b/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst index 03f0db45c37e..fdc471bc30c7 100644 --- a/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst +++ b/doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs2.rst @@ -62,7 +62,7 @@ SDFW and SCFW firmwares The *nRF54H20 SoC binaries* bundle has been updated to version 0.6.5. .. caution:: - If migrating from |NCS| v2.7.0, before proceeding with the firmware bundle update, you must first update the BICR as described in the previous chapter. + If migrating from |NCS| v2.7.0, before proceeding with the SoC binaries update, you must first update the BICR as described in the previous chapter. To update the SoC binaries bundle of your development kit while in Root of Trust, do the following: diff --git a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.4.99-cs3_to_2.7_application.rst b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.4.99-cs3_to_2.7_application.rst index 3921f49180ab..af72d0beeca0 100644 --- a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.4.99-cs3_to_2.7_application.rst +++ b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.4.99-cs3_to_2.7_application.rst @@ -31,10 +31,10 @@ DTS changes The layout of DTS files and the names of DTS nodes related to the updated board names have been updated, which also affects overlay files from applications and samples. If your application required a specific custom board, you must update the custom board files to match the changes done to the nRF54H20 SoC DTS files. -SDFW and SCFW firmware bundle +nRF54H20 SoC binaries The Secure Domain Firmware (SDFW) and System Controller Firmware (SCFW) are no longer built from the source during the application build process. - They are provided as a firmware bundle (v0.5.0) and provisioned to the nRF54H20 during the bring-up steps. - The nRF54H20 DK must be in lifecycle state ``EMPTY`` to be provisioned with the new firmware bundle. + They are provided as a SoC binaries bundle (v0.5.0) and provisioned to the nRF54H20 during the bring-up steps. + The nRF54H20 DK must be in lifecycle state ``EMPTY`` to be provisioned with the new SoC binaries. For additional details, see :ref:`transition_cs3_to_2_7_env_bringup`. nRF Util is now the main command line backend utility. diff --git a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2.7_application.rst b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2.7_application.rst index 89a2c4ec0749..61a8934855ce 100644 --- a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2.7_application.rst +++ b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2.7_application.rst @@ -28,10 +28,10 @@ Hardware Model v2 A new hardware model was recently introduced in the |NCS|. For more information, see :ref:`hwmv1_to_v2_migration`. -SDFW and SCFW firmware bundle - A new version (v0.5.0) of the SDFW and SCFW firmware bundle was released. +nRF54H20 SoC binaries + A new version (v0.5.0) of the nRF54H20 SoC binaries was released. This is the only version compatible with the |NCS| v2.7.0. - The nRF54H20 DK must be in lifecycle state ``EMPTY`` to be provisioned with the new firmware bundle. + The nRF54H20 DK must be in lifecycle state ``EMPTY`` to be provisioned with the new SoC binaries. DTS changes The layout of DTS files and the names of DTS nodes related to the updated board names have been updated, which also affects overlay files from applications and samples. diff --git a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment.rst b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment.rst index 8bb949de0779..6bf1c40caa03 100644 --- a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment.rst +++ b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/migration_guide_2.6.99-cs2_to_2_7_environment.rst @@ -18,10 +18,10 @@ The following is a summary of the most important ones: Updated |NCS| toolchain The |NCS| toolchain has been updated. -SDFW and SCFW firmware bundle - A new version (v0.5.0) of the SDFW and SCFW firmware bundle was released. +SDFW and SCFW SoC binaries + A new version (v0.5.0) of the nRF54H20 SoC binaries bundle was released. This is the only version compatible with the |NCS| v2.7.0. - The nRF54H20 DK must be in lifecycle state ``EMPTY`` to be provisioned with the new firmware bundle. + The nRF54H20 DK must be in lifecycle state ``EMPTY`` to be provisioned with the new SoC binaries. Minimum requirements ******************** @@ -155,7 +155,7 @@ Verify the LCS of the device The current nRF54H20 DK is delivered with its lifecycle state (LCS) set to ``EMPTY``. To correctly operate, its lifecycle state must be transitioned to Root of Trust (``RoT``) through the bring-up steps. -To be compatible with |NCS| v2.7.0, the SDFW and SCFW firmware bundle programmed on the nRF54H20 DK during through the bring-up steps must be v0.5.0. +To be compatible with |NCS| v2.7.0, the nRF54H20 SoC binaries programmed on the nRF54H20 DK during through the bring-up steps must be v0.5.0. .. note:: The forward transition to LCS ``RoT`` is permanent. @@ -187,11 +187,11 @@ The output will look similar to the following:: If the lifecycle state (``psa_lifecycle``) shown is not ``RoT`` (``LIFECYCLE_EMPTY (0x1000)`` means the LCS is set to ``EMPTY``) you can follow the bring-up steps in the next chapter. If the lifecycle state (``psa_lifecycle``) shown is ``RoT`` (``LIFECYCLE_ROT (0x2000)``), the device is in Root of Trust: -* If your nRF54H20 DK was already programmed with the SDFW and SCFW firmware bundle version 0.5.0, you can jump to the :ref:`migration_cs2_to_2_7_env_nextsteps` chapter. -* If your current nRF54H20 DK was programmed with a firmware bundle version 0.3.x: +* If your nRF54H20 DK was already programmed with the nRF54H20 SoC binaries version 0.5.0, you can jump to the :ref:`migration_cs2_to_2_7_env_nextsteps` chapter. +* If your current nRF54H20 DK was programmed with the SoC binaries version 0.3.x: * Use a different nRF54H20 DK with LCS ``EMPTY`` and continue to the nRF54H20 bring-up. - * Use a different nRF54H20 DK with LCS ``RoT`` and already programmed with the firmware bundle version 0.5.0. + * Use a different nRF54H20 DK with LCS ``RoT`` and already programmed with the SoC binaries version 0.5.0. nRF54H20 DK bring-up ******************** @@ -231,9 +231,9 @@ Provisioning the SDFW and SCFW ============================== After programming the BICR, the nRF54H20 SoC requires the provisioning of a bundle ( :file:`nrf54h20_soc_binaries_v0.5.0.zip`) containing the precompiled firmware for the Secure Domain and System Controller. -To program the Secure Domain Firmware (SDFW, also known as ``urot``) and the System Controller Firmware (SCFW) from the firmware bundle to the nRF54H20 DK, do the following: +To program the Secure Domain Firmware (SDFW, also known as ``urot``) and the System Controller Firmware (SCFW) from the SoC binaries to the nRF54H20 DK, do the following: -1. Download the `nRF54H20 firmware bundle v0.5.0`_. +1. Download the `nRF54H20 SoC binaries v0.5.0`_. .. note:: On MacOS, ensure that the ZIP file is not unpacked automatically upon download. @@ -251,7 +251,7 @@ Updating the FICR This step is required only if your nRF54H20 DK is version PCA10175 v0.7.2 or v0.8.0 ES3.3. Jump to the next step if your DK is version ES4, meaning v0.8.0 with no ES markings. -After programming the SDFW and SCFW from the firmware bundle, you must update the Factory Information Configuration Registers (FICR) to correctly configure some trims of the nRF54H20 SoC. +After programming the SDFW and SCFW from the SoC binaries, you must update the Factory Information Configuration Registers (FICR) to correctly configure some trims of the nRF54H20 SoC. To update the FICR, you must run a J-Link script: 1. Get the Jlink script that updates the FICR:: diff --git a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/transition_guide_2.4.99-cs3_to_2.7_environment.rst b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/transition_guide_2.4.99-cs3_to_2.7_environment.rst index cd142644ac5f..62e7060f632b 100644 --- a/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/transition_guide_2.4.99-cs3_to_2.7_environment.rst +++ b/doc/nrf/releases_and_maturity/migration/nRF54H20_migration_2.7/transition_guide_2.4.99-cs3_to_2.7_environment.rst @@ -14,8 +14,8 @@ The main development environment changes introduced by v2.7.0 for the nRF54H20 D * The |NCS| toolchain has been updated. * nRF Util is now used by the build system. * The Secure Domain Firmware (SDFW) and System Controller Firmware (SCFW) are no longer built from the source during the application build process. - They are provided as a firmware bundle (v0.5.0) and provisioned to the nRF54H20 during the bring-up steps. - The nRF54H20 DK must be in lifecycle state ``EMPTY`` to be provisioned with the new firmware bundle. + They are provided as a SoC binaries bundle (v0.5.0) and provisioned to the nRF54H20 during the bring-up steps. + The nRF54H20 DK must be in lifecycle state ``EMPTY`` to be provisioned with the new SoC binaries. For additional details, see :ref:`transition_cs3_to_2_7_env_bringup`. See the details in the `nRF54H20 DK bring-up`_ section below. * To correctly operate the nRF54H20 DK, its lifecycle state must be set to ``RoT`` after the bring-up. @@ -236,9 +236,9 @@ Programming the SDFW and SCFW ============================= After programming the BICR, the nRF54H20 SoC requires the provisioning of a bundle ( :file:`nrf54h20_soc_binaries_v0.5.0.zip`) containing the precompiled firmware for the Secure Domain and System Controller. -To program the Secure Domain Firmware (SDFW, also known as ``urot``) and the System Controller Firmware (SCFW) from the firmware bundle to the nRF54H20 DK, do the following: +To program the Secure Domain Firmware (SDFW, also known as ``urot``) and the System Controller Firmware (SCFW) from the SoC binaries to the nRF54H20 DK, do the following: -1. Download the `nRF54H20 firmware bundle v0.5.0`_. +1. Download the `nRF54H20 SoC binaries v0.5.0`_. .. note:: On MacOS, ensure that the ZIP file is not unpacked automatically upon download. @@ -258,7 +258,7 @@ Updating the FICR This step is required only if your nRF54H20 DK is version PCA10175 v0.7.2 or v0.8.0 ES3.3. Jump to the next step if your DK is version ES4, meaning v0.8.0 with no ES markings. -After programming the SDFW and SCFW from the firmware bundle, you must update the Factory Information Configuration Registers (FICR) to correctly configure some trims of the nRF54H20 SoC. +After programming the SDFW and SCFW from the SoC binaries, you must update the Factory Information Configuration Registers (FICR) to correctly configure some trims of the nRF54H20 SoC. To update the FICR, you must run a J-Link script: 1. Get the J-Link script that updates the FICR::