Skip to content

Commit 8317cb3

Browse files
jonathannilsenrlubos
authored andcommitted
doc: ironside: update PERIPHCONF generator description
nrf-regtool is no longer used, instead the script that generates PERIPHCONF entries from devicetree lives in zephyr. Update the description of the generation procedure accordingly. Ref: NCSDK-36373 Signed-off-by: Jonathan Nilsen <[email protected]>
1 parent f8077ac commit 8317cb3

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

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

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -488,27 +488,29 @@ After applying the entry, |ISE| performs a read-back check: it reads back the re
488488
The configuration procedure is aborted if an entry fails either the validation or the read-back check.
489489
If a failure occurs, BOOTSTATUS.BOOTERROR is set to indicate the error condition, and a description of the failed entry is written to the boot report.
490490

491-
Peripheral configuration using nrf-regtool
492-
------------------------------------------
491+
PERIPHCONF generation from devicetree
492+
-------------------------------------
493493

494-
The ``nrf-regtool`` utility generates a UICR.PERIPHCONF configuration from the devicetree.
495-
To determine which peripherals are in use, it analyzes the devicetree as follows:
494+
When :kconfig:option:`CONFIG_NRF_PERIPHCONF_GENERATE_ENTRIES` is enabled, the build system automatically generates entries for the PERIPHCONF partition based on the devicetree.
495+
To determine which peripherals are in use, the build system analyzes the devicetree as follows:
496496

497497
#. Enumerate all peripheral nodes and include only those with a ``status`` property set to ``okay``.
498498
#. Parse peripheral-specific attributes (for example, the ``owned-channels`` property in DPPIC nodes).
499499
#. Collect GPIO pin assignments from all pin references (for example, ``pinctrl`` entries).
500500

501501
It then generates the appropriate configuration values by reusing existing properties.
502+
The build system outputs the generated entries as a C file named :file:`periphconf_entries_generated.c` in the build directory, which is added as a source file to the build.
503+
The generated C code uses the macros defined in :file:`zephyr/soc/nordic/common/uicr/uicr.h` to insert entries into a special PERIPHCONF section in the ELF file which can be read by the UICR image.
502504

503-
See the following table for a mapping between the devicetree input used by ``nrf-regtool`` and the resulting output in the automatically migrated :file:`periconf_migrated.c` file.
505+
See the following table for a mapping between the devicetree input used by the PERIPHCONF entry generator script and the resulting output in the :file:`periphconf_entries_generated.c` file.
504506

505-
.. list-table:: Mapping between devicetree and Migrated PERIPHCONF output (UICR Configuration)
507+
.. list-table:: Mapping between devicetree and PERIPHCONF entry output (UICR Configuration)
506508
:header-rows: 1
507509
:widths: 25 15 35 25
508510

509511
* - Devicetree node type
510512
- Properties
511-
- Migrated PERIPHCONF output
513+
- PERIPHCONF entry output
512514
- Example generated output
513515
* - Peripheral Access Control
514516
-

0 commit comments

Comments
 (0)