Skip to content

Commit 3d18687

Browse files
FrancescoSerrlubos
authored andcommitted
doc: Updated 54h index page
Updated 54h index page to clarify structure. Updated various 54H doc pages to improve clarity and consistency. Signed-off-by: Francesco Domenico Servidio <francesco.servidio@nordicsemi.no>
1 parent b15d896 commit 3d18687

14 files changed

Lines changed: 57 additions & 31 deletions

doc/nrf/app_dev/device_guides/nrf54h/images/nRF54H20_Domains.svg renamed to doc/nrf/app_dev/device_guides/nrf54h/images/nRF54H20_domains.svg

File renamed without changes.

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

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,6 @@
33
Developing with nRF54H Series
44
#############################
55

6-
.. note::
7-
8-
All software for the nRF54H20 SoC is experimental, and hardware availability is restricted to the participants in the customer sampling program.
9-
106
.. |nrf_series| replace:: devices of the nRF54H Series
117

128
.. include:: /includes/guides_complementary_to_app_dev.txt
@@ -30,23 +26,52 @@ Zephyr and the |NCS| provide support and contain board definitions for developin
3026

3127
.. toctree::
3228
:maxdepth: 2
33-
:caption: Subpages:
29+
:caption: Get started with the nRF54H20 DK
3430

3531
ug_nrf54h20_gs
32+
33+
.. toctree::
34+
:maxdepth: 2
35+
:caption: Understand the hardware
36+
3637
ug_nrf54h20_architecture
38+
39+
.. toctree::
40+
:maxdepth: 2
41+
:caption: Configure the nRF54H20 SoC on your custom PCB
42+
43+
ug_nrf54h20_custom_pcb
44+
45+
.. toctree::
46+
:maxdepth: 2
47+
:caption: Develop and debug
48+
3749
ug_nrf54h20_configuration
38-
ug_nrf54h20_keys
3950
ug_nrf54h20_logging
4051
ug_nrf54h20_debugging
41-
ug_nrf54h20_custom_pcb
42-
ug_nrf54h20_ironside
4352
ug_nrf54h20_flpr
4453
ug_nrf54h20_ppr
4554
ug_nrf54h20_zms
55+
56+
.. toctree::
57+
:maxdepth: 2
58+
:caption: Secure your application
59+
60+
ug_nrf54h20_ironside
61+
ug_nrf54h20_keys
62+
63+
.. toctree::
64+
:maxdepth: 2
65+
:caption: Configure bootloader for Device Firmware Update (DFU)
66+
4667
ug_nrf54h20_mcuboot_dfu
4768
ug_nrf54h20_partitioning_merged
4869
ug_nrf54h20_mcuboot_manifest
4970
ug_nrf54h20_mcuboot_requests
5071
ug_nrf54h_ecies_x25519
72+
73+
.. toctree::
74+
:maxdepth: 2
75+
:caption: Optimize the power management of your application
76+
5177
ug_nrf54h20_pm_optimization
52-
ug_nrf54h20_architecture_pinmap

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,4 @@ The following pages briefly describe topics like the responsibilities of the cor
2424
ug_nrf54h20_architecture_pm
2525
ug_nrf54h20_architecture_clockman
2626
ug_nrf54h20_architecture_reset
27+
ug_nrf54h20_architecture_pinmap

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ The following is a description of the boot sequence steps:
7676
#. Each of the local domains is responsible to configure its local resources partitioning.
7777

7878
.. note::
79-
To better understand the boot process and how the |ISE| works, it is strongly suggested to read the entire :ref:`ug_nrf54h20_ironside` documentation page.
79+
Read the entire :ref:`ug_nrf54h20_ironside` documentation page to better understand the boot process and how the |ISE| works.
8080

8181
Boot sequence with MCUboot
8282
==========================

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ Global HSFLL
107107
============
108108

109109
The firmware can request this clock to run at a lower frequency than its default of 320 MHz.
110-
It is recommended to leave this clock at its default frequency.
110+
Leave this clock at its default frequency.
111111
Note the following if the frequency is lowered:
112112

113113
* The MRAM access latency will be increased, thus lowering overall CPU performance when running code from MRAM.
@@ -123,7 +123,7 @@ Local HSFLL
123123
===========
124124

125125
The firmware can request this clock to run at a lower frequency than its default.
126-
It is recommended to leave this clock at its default frequency.
126+
Leave this clock at its default frequency.
127127
If the frequency is lowered, the CPU performance will decrease.
128128
This results in the CPU running for longer, thus increasing power consumption.
129129
Furthermore, the ISR handling latency will be increased.

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ nRF54H20 domains
77
:local:
88
:depth: 2
99

10-
The nRF54H20 is partitioned into functional blocks, called *Domains*.
11-
The domains containing the user-programmable main CPUs and associated functions are called *Cores*.
10+
The nRF54H20 is partitioned into functional blocks, called *domains*.
11+
The domains containing the user-programmable main CPUs and associated functions are called *cores*.
1212
Most memory and peripherals can be flexibly allocated to cores at compile time.
1313
To make this possible, the memory and peripherals are located in a separate area called the Global Domain.
1414
Security functions are centralized into the Secure Domain.
1515

1616
The following image shows the domains in the nRF54H20:
1717

18-
.. figure:: images/nRF54H20_Domains.svg
19-
:alt: nRF54H20 Domains
18+
.. figure:: images/nRF54H20_domains.svg
19+
:alt: nRF54H20 domains
2020

21-
nRF54h20 Domains
21+
nRF54H20 domains
2222

2323
The CPU cores in the nRF54H20 are based on two types of CPU architectures:
2424

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Technical solution
2020
******************
2121

2222
A single Interprocessor Communication instance used in the nRF54H20 SoC allows full-duplex communication between two cores.
23-
It support only unicast messages.
23+
It supports only unicast messages.
2424

2525
To communicate with multiple peers, a core requires multiple IPC instances, at least as many as the number of peers.
2626
It is possible to create multiple IPC instances towards a single peer to separate messages with different priority levels.
@@ -116,8 +116,8 @@ Each ICMsg library instance requires the following:
116116

117117
The ICMsg library is designed to efficiently send short messages to a peer.
118118
Its buffer allocation is not optimized for bulk transfer of long messages and it does not provide a zero-copy model.
119-
To transfer bigger amount of data (like network packets) between two cores, ICMsg can be used as control plane.
120-
However, you must use as data plane memory allocation mechanisms optimized for bigger data and supporting flexible memory allocation and a zero-copy model (like Zephyr's :ref:`zephyr:net_buf_interface`).
119+
To transfer larger amounts of data (like network packets) between two cores, use ICMsg as the control plane.
120+
For the data plane, use a memory allocation mechanism that supports flexible allocation and a zero-copy model, such as Zephyr's :ref:`zephyr:net_buf_interface`.
121121

122122
.. note::
123123
The memory allocation mechanism for the data plane is a single-core memory allocation working on shared memory buffers.
@@ -136,7 +136,7 @@ This library provides a unified API for IPC transports and it integrates specifi
136136
ICMsg is integrated as one of the available IPC service backends.
137137
The library is responsible for creating IPC instances based on the system configuration described in the devicetree.
138138

139-
It is recommended to use the ipc_service API to perform inter-processor communication in the nRF54H20 SoC.
139+
Use the ipc_service API to perform interprocessor communication in the nRF54H20 SoC.
140140

141141
For more information, consult the :ref:`IPC service <zephyr:ipc_service>` library documentation.
142142

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ There is also a large part of the RAM in the global domain to be shared between
3434
Local RAM
3535
=========
3636

37-
Local RAM is present in each of local domains
37+
Local RAM is present in each of the local domains
3838

3939
Application core RAM
4040
--------------------

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The ARM Cortex CPUs of the nRF54H20 SoC currently support the following software
2828
Each CPU in the nRF54H20 SoC tries to preserve as much power as possible, independently from other CPUs.
2929
The power management subsystem, operating independently within each CPU, continuously selects the most optimal power state based on the current conditions of the CPU.
3030

31-
The following sections describes the details of each of the software power states available on the nRF54H20 SoC.
31+
The following sections describe the details of each of the software power states available on the nRF54H20 SoC.
3232

3333
Active
3434
======

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Prepare your PCB
1414

1515
First, you need to create your PCB for the nRF54H20 SoC.
1616

17-
It is highly recommended to use the PCB layouts and component values provided by Nordic Semiconductor, especially for clock and power sources, considering the following limitations:
17+
Use the PCB layouts and component values provided by Nordic Semiconductor, especially for clock and power sources, considering the following limitations:
1818

1919
* The DC/DC inductor must be present on the PCB for any of the supported power schemes.
2020
Use one of the following power supply options:

0 commit comments

Comments
 (0)