Skip to content

doc: Added user guide for nRF54H20 Ironside #22940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

doc: Added user guide for nRF54H20 Ironside #22940

wants to merge 1 commit into from

Conversation

FrancescoSer
Copy link
Contributor

Added user guide for nRF54H20 Ironside.

@github-actions github-actions bot added doc-required PR must not be merged without tech writer approval. changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. labels Jun 24, 2025
@NordicBuilder
Copy link
Contributor

NordicBuilder commented Jun 24, 2025 •
edited
Loading

CI Information

To view the history of this post, clich the 'edited' button above
Build number: 13

Inputs:

Sources:

sdk-nrf: PR head: f422b426d1fb696c57e70e078101176f524f62e3

more details

sdk-nrf:

PR head: f422b426d1fb696c57e70e078101176f524f62e3
merge base: 2a9341442f977127e7aea14692a6640ff1568b07
target head (main): 465de1b4a646fda5ed151d52fa71a9a4fc088efe
Diff

Github labels

Enabled Name Description
ci-disabled Disable the ci execution
ci-all-test Run all of ci, no test spec filtering will be done
ci-force-downstream Force execution of downstream even if twister fails
ci-run-twister Force run twister
ci-run-zephyr-twister Force run zephyr twister
List of changed files detected by CI (1) 
doc
│  ├── nrf
│  │  ├── app_dev
│  │  │  ├── device_guides
│  │  │  │  ├── nrf54h
│  │  │  │  │  │ ug_nrf54h20_ironside.rst

Outputs:

Toolchain

Version:
Build docker image:

Test Spec & Results: ✅ Success; ❌ Failure; 🟠 Queued; 🟡 Progress; ◻️ Skipped; ⚠️ Quarantine

  • ◻️ Toolchain
  • ◻️ Build twister
  • ◻️ Integration tests
Disabled integration tests
    • desktop52_verification
    • doc-internal
    • test_ble_nrf_config
    • test-fw-nrfconnect-apps
    • test-fw-nrfconnect-ble_mesh
    • test-fw-nrfconnect-ble_samples
    • test-fw-nrfconnect-chip
    • test-fw-nrfconnect-fem
    • test-fw-nrfconnect-nfc
    • test-fw-nrfconnect-nrf-iot_cloud
    • test-fw-nrfconnect-nrf-iot_libmodem-nrf
    • test-fw-nrfconnect-nrf-iot_lwm2m
    • test-fw-nrfconnect-nrf-iot_samples
    • test-fw-nrfconnect-nrf-iot_serial_lte_modem
    • test-fw-nrfconnect-nrf-iot_thingy91
    • test-fw-nrfconnect-nrf-iot_zephyr_lwm2m
    • test-fw-nrfconnect-nrf_crypto
    • test-fw-nrfconnect-ps-main
    • test-fw-nrfconnect-rpc
    • test-fw-nrfconnect-rs
    • test-fw-nrfconnect-tfm
    • test-fw-nrfconnect-thread-main
    • test-low-level
    • test-sdk-audio
    • test-sdk-dfu
    • test-sdk-find-my
    • test-sdk-mcuboot
    • test-sdk-pmic-samples
    • test-sdk-wifi
    • test-secdom-samples-public

Note: This message is automatically posted and updated by the CI

@greg-fer greg-fer self-requested a review June 24, 2025 10:43
@FrancescoSer FrancescoSer force-pushed the h20_ironside_userguide branch 3 times, most recently from e8990e9 to 94ec585 Compare June 26, 2025 08:29
@FrancescoSer FrancescoSer force-pushed the h20_ironside_userguide branch 2 times, most recently from 7c56ea1 to 4d89d31 Compare July 9, 2025 13:14
@FrancescoSer FrancescoSer marked this pull request as ready for review July 9, 2025 13:15
@FrancescoSer FrancescoSer requested review from a team as code owners July 9, 2025 13:15
@FrancescoSer FrancescoSer force-pushed the h20_ironside_userguide branch from 4d89d31 to ab98c99 Compare July 9, 2025 13:20
@FrancescoSer FrancescoSer requested a review from a team as a code owner July 9, 2025 13:20
@github-actions github-actions bot removed the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jul 9, 2025
@greg-fer
Copy link
Contributor

greg-fer commented Jul 9, 2025

As discussed on chat, I won't review this @FrancescoSer until you poke me with information that the doc is ready for review.

@FrancescoSer FrancescoSer force-pushed the h20_ironside_userguide branch 2 times, most recently from 2442f40 to 27d5b64 Compare July 10, 2025 12:56
greg-fer
greg-fer requested changes Jul 10, 2025
View reviewed changes
Copy link
Contributor

@greg-fer greg-fer left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In its current form, this is a great documentation of hardware that does not however tell me how to work with IronSide SE in the nRF Connect SDK. I understand hardware parts cannot be moved to hardware datasheet, which is not available. However, the guide should include more information that ties it together with the software nRF Connect SDK documentation.

doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_ironside.rst Outdated
Global Resource configuration
*****************************

You can configure some global resources through the applications running on local domains (like the Application core).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How can I configure this? The section does not give me a link.

doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_ironside.rst Outdated

IronSide SE provides the following features:

* Global memory configuration (via UICR.MPCCONF)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Global memory configuration (via UICR.MPCCONF)
* Global memory configuration (through UICR.MPCCONF)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to be checked if still implemented

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IronSide doesn't currently apply UICR.MPCCONF. We have only defined the format/interface.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have to clarify how to configure UICRs then @jonathannilsen

doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_ironside.rst Outdated

IronSide SE provides the following features:

* Global memory configuration (via UICR.MPCCONF)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note that here you're not using any formatting for peripherals and registers, yet later you do use ``. As per https://nordicsemi.atlassian.net/wiki/spaces/TECHDOC/pages/120291747/Typographical+conventions no formatting is required -- caps are enough.

doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_ironside.rst Outdated
* ``ERASEPROTECT`` - Enables erase protection for the ``UICR``.
* ``PROTECTEDMEM`` - Specifies a memory region, starting at the end of IronSide SE memory, that is protected for integrity.
* ``RECOVERY`` - Contains the application-defined recovery mechanism details.
* ``ITS`` - Sets the location and size of the Internal Trusted Storage for the application and radio domains.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does IronSide SE use and implement ITS?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jonathannilsen Is ITS implemented? I remember recent feedback about it not being implemented yet, but cannot find source.

@FrancescoSer FrancescoSer force-pushed the h20_ironside_userguide branch 2 times, most recently from 4151028 to c9383dc Compare July 10, 2025 13:38
maciejpietras
maciejpietras reviewed Jul 11, 2025
View reviewed changes
Copy link
Contributor

@maciejpietras maciejpietras left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tomchy @FrancescoSer should we also add any chapter related to running MCUboot on Ironside?

@greg-fer greg-fer mentioned this pull request Jul 15, 2025
Merged
@FrancescoSer
Copy link
Contributor Author

Moving the BICR migration guide here: #23448

@FrancescoSer FrancescoSer force-pushed the h20_ironside_userguide branch from c9383dc to cde5048 Compare July 24, 2025 12:28
@github-actions github-actions bot added the changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. label Jul 24, 2025
@FrancescoSer FrancescoSer added this to the 3.1.0 milestone Jul 24, 2025
FrancescoSer
FrancescoSer commented Jul 29, 2025
View reviewed changes
doc/nrf/app_dev/device_guides/nrf54h/ug_nrf54h20_ironside.rst
@@ -0,0 +1,519 @@
:orphan:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: add feedback from Jon "The configuration nrf-regtool looks at is spread across the entire devicetree, for example it looks at the status property on the peripheral nodes and some properties like "owned-channels" etc. on specific node types like DPPIC. In general it tries to reuse existing DT properties where possible, so for example for GPIO pins it looks at all the pins that are referenced by peripheral nodes etc.

---- compile a list with the mapping between the devicetree and output in the PERIPHCONF"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jonathannilsen Just a reminder :)

@FrancescoSer
doc: Added user guide for nRF54H20 Ironside
f422b42 
Added user guide for nRF54H20 Ironside.
Removed SUIT docs.

Signed-off-by: Francesco Domenico Servidio <francesco.servidio@nordicsemi.no>
@FrancescoSer FrancescoSer force-pushed the h20_ironside_userguide branch from cde5048 to f422b42 Compare July 29, 2025 16:59
@FrancescoSer FrancescoSer requested a review from greg-fer July 29, 2025 16:59
@greg-fer greg-fer mentioned this pull request Jul 30, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@SebastianBoe SebastianBoe Awaiting requested review from SebastianBoe

@jonathannilsen jonathannilsen Awaiting requested review from jonathannilsen

@57300 57300 Awaiting requested review from 57300

@tomchy tomchy Awaiting requested review from tomchy

@maciejpietras maciejpietras Awaiting requested review from maciejpietras

@greg-fer greg-fer Awaiting requested review from greg-fer

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
changelog-entry-required Update changelog before merge. Remove label if entry is not needed or already added. doc only doc-required PR must not be merged without tech writer approval.
Projects
None yet
Milestone
3.1.0
Development

Successfully merging this pull request may close these issues.
6 participants
@FrancescoSer @NordicBuilder @greg-fer @jonathannilsen @maciejpietras @divipillai