doc: Documentation edits for 2.7.99-cs1 release #17015

FrancescoSer · 2024-08-26T13:19:33Z

Added firmware bundle compatibility table.
Updated nRF54H20 GS guide.
Added initial power management documentation.
Added initial clock control documentation

NordicBuilder · 2024-08-26T13:20:50Z

CI Information

^{To view the history of this post, clich the 'edited' button above}
Build number: 22

Inputs:

Sources:

sdk-nrf: PR head: 8f816f4e70588b67d28891077a5681f223c31829

more details

sdk-nrf:

PR head: 8f816f4e70588b67d28891077a5681f223c31829
merge base: f7b59d26db4cc55c6936a0a88f3daa7e0b7b2085
target head (main): 2e9c82cc67f61bebcd5feaff24e4a807da028389> 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 (10)

doc
│  ├── nrf
│  │  ├── app_dev
│  │  │  ├── device_guides
│  │  │  │  ├── nrf54h.rst
│  │  │  │  ├── working_with_nrf
│  │  │  │  │  ├── nrf54h
│  │  │  │  │  │  ├── ug_nrf54h20_architecture.rst
│  │  │  │  │  │  ├── ug_nrf54h20_architecture_clockman.rst
│  │  │  │  │  │  ├── ug_nrf54h20_architecture_pm.rst
│  │  │  │  │  │  │ ug_nrf54h20_gs.rst
│  │  ├── links.txt
│  │  ├── releases_and_maturity
│  │  │  ├── migration
│  │  │  │  ├── migration_guide_nRF54H20_cs_to_2_7.rst
│  │  │  │  │ migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst
│  │  ├── samples
│  │  │  │ other.rst
tests
│  ├── benchmarks
│  │  ├── multicore
│  │  │  ├── idle
│  │  │  │  │ README.rst

Outputs:

Toolchain

Version:
Build docker image:

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

◻️ Toolchain
◻️ Build twister
◻️ Integration tests
- ◻️ test-low-level

Disable integration tests

- desktop52_verification
- doc-internal
- latest/ble/nrf/test_ble_nrf_config
- test-fw-nrfconnect-apps
- test-fw-nrfconnect-ble_mesh
- test-fw-nrfconnect-ble_samples
- test-fw-nrfconnect-boot
- 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_mosh
- test-fw-nrfconnect-nrf-iot_nrf_provisioning
- test-fw-nrfconnect-nrf-iot_positioning
- 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-proprietary_esb
- test-fw-nrfconnect-ps
- test-fw-nrfconnect-rpc
- test-fw-nrfconnect-rs
- test-fw-nrfconnect-tfm
- test-fw-nrfconnect-thread
- test-fw-nrfconnect-zigbee
- test-sdk-audio
- test-sdk-dfu
- test-sdk-find-my
- test-sdk-mcuboot
- test-sdk-pmic-samples
- test-sdk-sidewalk
- test-sdk-wifi

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

NordicBuilder · 2024-08-26T14:01:49Z

You can find the documentation preview for this PR at this link. It will be updated about 10 minutes after the documentation build succeeds.

Note: This comment is automatically posted by the Documentation Publishing GitHub Action.

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

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

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

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

doc/nrf/samples/other.rst

divipillai · 2024-08-28T15:28:08Z

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

+Active
+======
+
+*Active* is the power state in which the CPU is actively processing.


Should the power states be made italic. I haven't see these mentioned as Italic in other docs.

Not highlighting long power states name like "Local suspend to Ram" might render sentences containing these quite difficult to read. They don't have to be necessarily in italics, but I believe that they should be highlighted in some way.

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

FrancescoSer · 2024-08-28T15:52:01Z

@hubertmis @divipillai Implemented most of your suggestions, and added additional sections in the architecture_pm document. While I'll implement the remaining suggestions, please feel free to rereview that document.

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

annwoj

just some general suggestions

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

annwoj · 2024-08-28T16:55:09Z

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

+The application-facing APIs expose only the domain that directly clocks the component used by the application.
+The management of the clocks on which this domain depends is handled internally by the clock driver associated with this domain.
+
+For example, a firmware module might request better timing accuracy for a fast UART instance.


Suggested change

For example, a firmware module might request better timing accuracy for a fast UART instance.

For example, a firmware module might request better timing accuracy for a high-speed UART instance.

tbc - would it be a correct wording here?

@hubertmis Could you check this?

Not sure. In IPS I can find a term "Fast clock domain", but nothing directly about peripherals. The "fast UART" is the one in the "fast clock domain".

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

doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst

kenr · 2024-08-29T06:34:06Z

doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_gs.rst


-You can install the |NCS| v2.7.0 and its toolchain by using Toolchain Manager.
+You can install the |NCS| v2.7.99-cs1 and its toolchain by using Toolchain Manager.


@jangalda-nsc , the v2.7.99-cs1 is published?

doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst

doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_gs.rst

bjarki-andreasen

Nice work :) I only have two minor nits

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

Added firmware bundle compatibility table. Updated nRF54H20 GS guide. Added initial power management documentation. Added initial clock control documentation. Migration notes for |NCS| v2.7.99-cs1 and the nRF54H20 DK. Signed-off-by: Francesco Domenico Servidio <francesco.servidio@nordicsemi.no>

kl-cruz · 2024-08-29T09:04:04Z

doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_gs.rst

@@ -214,17 +214,17 @@ To prepare the nRF54H20 DK for first use, you must manually program the values o

 #. Move the BICR HEX file to a folder of your choice, then program the BICR by running nRF Util from that folder using the following command::


I do not think that this step is required. This command can be executed from Downloads directory.
Additionally - Can we program BICR after switching to ROT LCS?

Yes, BICR can be programmed at LCS ROT.

nordic-piks · 2024-08-29T09:13:15Z

doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_gs.rst


-      nrfutil install device=2.4.0 --force
+      nrfutil install device=2.4.6 --force


I just did those steps at windows and got:

Downloads\nrfutil>nrfutil.exe --version nrfutil 7.6.0 (92ce3a0 2023-08-15) commit-hash: 92ce3a0c1cc7e203326d85919d826009510dc631 commit-date: 2023-08-15 host: x86_64-pc-windows-msvc build-timestamp: 2023-08-23T08:25:25.3155777Z classification: nrf-external Downloads\nrfutil>nrfutil self-upgrade Error: Could not update package registry Caused by: 0: failed to fetch `https://github.com/nordicsemiconductor/nrfutil-package-index` 1: network failure seems to have happened if a proxy or similar is necessary, setting the environment variable `NRFUTIL_NET_GIT_FETCH_WITH_CLI` to `true` may help here 2: failed to set hostkey preference: The requested method(s) are not currently supported; class=Ssh (23) Downloads\nrfutil>nrfutil install device=2.4.6 --force Error: Could not update package registry Caused by: 0: failed to fetch `https://github.com/nordicsemiconductor/nrfutil-package-index` 1: network failure seems to have happened if a proxy or similar is necessary, setting the environment variable `NRFUTIL_NET_GIT_FETCH_WITH_CLI` to `true` may help here 2: failed to set hostkey preference: The requested method(s) are not currently supported; class=Ssh (23)

Can someone confirm?

Works at linux (WSL)

doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_gs.rst

hubertmis · 2024-08-29T09:25:30Z

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

+The application-facing APIs expose only the domain that directly clocks the component used by the application.
+The management of the clocks on which this domain depends is handled internally by the clock driver associated with this domain.
+
+For example, a firmware module might request better timing accuracy for a fast UART instance.


Not sure. In IPS I can find a term "Fast clock domain", but nothing directly about peripherals. The "fast UART" is the one in the "fast clock domain".

hubertmis · 2024-08-29T09:28:11Z

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

+*Local Suspend to RAM* is a sleep state that balances between power consumption and wake-up latency.
+
+This state is available only for DVFS-capable domains.
+Other domains, such as Radio, cannot retain the CPU and local peripherals in the *System ON (All) Idle* state.


This looks like typo.

Suggested change

Other domains, such as Radio, cannot retain the CPU and local peripherals in the *System ON (All) Idle* state.

Other domains, such as Radio, can retain the CPU and local peripherals in hardware flip-flops in the *System ON (All) Idle* state.

nordic-piks · 2024-08-29T10:45:20Z

doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst

+
+  #. Move the BICR HEX file to a folder of your choice, then program the BICR by running nRF Util from that folder using the following command::
+
+        nrfutil device program --options chip_erase_mode=ERASE_NONE --firmware <path_to_bicr.hex> --core Secure --serial-number <serialnumber>


--core Application
@FrancescoSer That needs to be updated too.
With Secure and device already provisioned (LCS ROT), it will fail.

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 Aug 26, 2024

FrancescoSer force-pushed the 54Hprerelease_docedits branch 4 times, most recently from 408d986 to d073dcc Compare August 28, 2024 14:37

FrancescoSer requested review from hubertmis, ns-tolu, divipillai, annwoj and kl-cruz August 28, 2024 14:39

FrancescoSer added this to the 2.7.99-cs1 milestone Aug 28, 2024

FrancescoSer requested review from annwoj and removed request for annwoj August 28, 2024 14:40

FrancescoSer force-pushed the 54Hprerelease_docedits branch from d073dcc to d0a205e Compare August 28, 2024 15:09

hubertmis reviewed Aug 28, 2024

View reviewed changes

FrancescoSer force-pushed the 54Hprerelease_docedits branch from d0a205e to 0838bb1 Compare August 28, 2024 15:32

FrancescoSer marked this pull request as ready for review August 28, 2024 15:34

FrancescoSer requested review from carlescufi and greg-fer as code owners August 28, 2024 15:34

divipillai reviewed Aug 28, 2024

View reviewed changes

FrancescoSer force-pushed the 54Hprerelease_docedits branch 4 times, most recently from 6bd0a84 to 1855d1e Compare August 28, 2024 15:50

hubertmis reviewed Aug 28, 2024

View reviewed changes

doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_architecture_pm.rst Outdated Show resolved Hide resolved

annwoj reviewed Aug 28, 2024

View reviewed changes

divipillai reviewed Aug 29, 2024

View reviewed changes

doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst Outdated Show resolved Hide resolved

doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst Outdated Show resolved Hide resolved

shanthanordic requested a review from kenr August 29, 2024 06:27

kenr reviewed Aug 29, 2024

View reviewed changes

ns-tolu reviewed Aug 29, 2024

View reviewed changes

doc/nrf/releases_and_maturity/migration/migration_guide_nRF54H20_cs_to_2_7_99-cs1.rst Outdated Show resolved Hide resolved

kenr reviewed Aug 29, 2024

View reviewed changes

doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_gs.rst Show resolved Hide resolved

divipillai mentioned this pull request Aug 29, 2024

doc: update documentation for 2.7.99-cs1 #16337

Merged

FrancescoSer force-pushed the 54Hprerelease_docedits branch from 73786a0 to b090335 Compare August 29, 2024 07:40

FrancescoSer requested review from adamkondraciuk and a team as code owners August 29, 2024 07:40

FrancescoSer requested review from jangalda-nsc, kenr, ns-tolu and divipillai August 29, 2024 07:42

ns-tolu approved these changes Aug 29, 2024

View reviewed changes

bjarki-andreasen approved these changes Aug 29, 2024

View reviewed changes

doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_architecture_clockman.rst Outdated Show resolved Hide resolved

doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_architecture_clockman.rst Outdated Show resolved Hide resolved

FrancescoSer force-pushed the 54Hprerelease_docedits branch 4 times, most recently from e7e68d8 to 94b9e3d Compare August 29, 2024 08:15

FrancescoSer force-pushed the 54Hprerelease_docedits branch from 94b9e3d to 8f816f4 Compare August 29, 2024 08:16

divipillai approved these changes Aug 29, 2024

View reviewed changes

kl-cruz reviewed Aug 29, 2024

View reviewed changes

kl-cruz approved these changes Aug 29, 2024

View reviewed changes

nordic-piks reviewed Aug 29, 2024

View reviewed changes

gmarull approved these changes Aug 29, 2024

View reviewed changes

gmarull merged commit 32b91a8 into nrfconnect:main Aug 29, 2024
13 checks passed

nordic-piks reviewed Aug 29, 2024

View reviewed changes

doc/nrf/app_dev/device_guides/working_with_nrf/nrf54h/ug_nrf54h20_gs.rst Show resolved Hide resolved

hubertmis approved these changes Aug 29, 2024

View reviewed changes

nordic-piks reviewed Aug 29, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc: Documentation edits for 2.7.99-cs1 release #17015

doc: Documentation edits for 2.7.99-cs1 release #17015

FrancescoSer commented Aug 26, 2024 •

edited

Loading

NordicBuilder commented Aug 26, 2024 •

edited

Loading

NordicBuilder commented Aug 26, 2024

divipillai Aug 28, 2024

FrancescoSer Aug 28, 2024 •

edited

Loading

FrancescoSer commented Aug 28, 2024

annwoj left a comment

annwoj Aug 28, 2024

FrancescoSer Aug 28, 2024

hubertmis Aug 29, 2024

kenr Aug 29, 2024

bjarki-andreasen left a comment

kl-cruz Aug 29, 2024

nordic-piks Aug 29, 2024

nordic-piks Aug 29, 2024 •

edited

Loading

nordic-piks Aug 29, 2024

hubertmis Aug 29, 2024

hubertmis Aug 29, 2024

nordic-piks Aug 29, 2024

	For example, a firmware module might request better timing accuracy for a fast UART instance.
	For example, a firmware module might request better timing accuracy for a high-speed UART instance.


		You can install the \|NCS\| v2.7.0 and its toolchain by using Toolchain Manager.
		You can install the \|NCS\| v2.7.99-cs1 and its toolchain by using Toolchain Manager.

		@@ -214,17 +214,17 @@ To prepare the nRF54H20 DK for first use, you must manually program the values o

		#. Move the BICR HEX file to a folder of your choice, then program the BICR by running nRF Util from that folder using the following command::


		nrfutil install device=2.4.0 --force
		nrfutil install device=2.4.6 --force

	Other domains, such as Radio, cannot retain the CPU and local peripherals in the System ON (All) Idle state.
	Other domains, such as Radio, can retain the CPU and local peripherals in hardware flip-flops in the System ON (All) Idle state.


		#. Move the BICR HEX file to a folder of your choice, then program the BICR by running nRF Util from that folder using the following command::

		nrfutil device program --options chip_erase_mode=ERASE_NONE --firmware <path_to_bicr.hex> --core Secure --serial-number <serialnumber>

doc: Documentation edits for 2.7.99-cs1 release #17015

doc: Documentation edits for 2.7.99-cs1 release #17015

Conversation

FrancescoSer commented Aug 26, 2024 • edited Loading

NordicBuilder commented Aug 26, 2024 • edited Loading

CI Information

Inputs:

Sources:

Github labels

Outputs:

Toolchain

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

NordicBuilder commented Aug 26, 2024

Choose a reason for hiding this comment

FrancescoSer Aug 28, 2024 • edited Loading

Choose a reason for hiding this comment

FrancescoSer commented Aug 28, 2024

annwoj left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bjarki-andreasen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nordic-piks Aug 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

FrancescoSer commented Aug 26, 2024 •

edited

Loading

NordicBuilder commented Aug 26, 2024 •

edited

Loading

FrancescoSer Aug 28, 2024 •

edited

Loading

nordic-piks Aug 29, 2024 •

edited

Loading