Skip to content
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.

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

applications: nrf_desktop: enable zms for nrf54h20 DK target #18924

Merged
merged 1 commit into from
Nov 18, 2024

Conversation

kapi-no
Copy link
Contributor

@kapi-no kapi-no commented Nov 18, 2024

Enabled the ZMS file system for the nRF54H20 DK in the nRF Desktop application. All board targets with the MRAM technology now use ZMS by default.

Ref: NCSDK-30319

@kapi-no kapi-no requested review from a team as code owners November 18, 2024 09:18
@github-actions github-actions bot added the doc-required PR must not be merged without tech writer approval. label Nov 18, 2024
@NordicBuilder
Copy link
Contributor

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 Publish GitHub Action.

@@ -203,7 +203,8 @@ nRF5340 Audio
nRF Desktop
-----------

|no_changes_yet_note|
* Updated all :ref:`zephyr:nrf54h20dk_nrf54h20` configurations to migrate from the NVS file system to the ZMS file system.
Copy link
Contributor

Choose a reason for hiding this comment

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

Please mention that it's for settings backend (a reflink to nRF Desktop's Settings loader module page could be useful here too). The application does not explicitly use these file systems, the file systems only act as a backend for settings.

Copy link
Contributor

Choose a reason for hiding this comment

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

A brief update of the nRF Desktop's Settings loader module page (https://docs.nordicsemi.com/bundle/ncs-latest/page/nrf/applications/nrf_desktop/doc/settings_loader.html) might be needed too

@@ -203,7 +203,8 @@ nRF5340 Audio
nRF Desktop
-----------

|no_changes_yet_note|
* Updated the `nrf_desktop_settings_loader` to make the :ref:`Zephyr Memory Storage (ZMS) <zephyr:zms_api>` the default file system for all board targets that use the MRAM technology.
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
* Updated the `nrf_desktop_settings_loader` to make the :ref:`Zephyr Memory Storage (ZMS) <zephyr:zms_api>` the default file system for all board targets that use the MRAM technology.
* Updated the :ref:`nrf_desktop_settings_loader` to make the :ref:`Zephyr Memory Storage (ZMS) <zephyr:zms_api>` the default file system for all board targets that use the MRAM technology.

Comment on lines 38 to 42
* :ref:`Zephyr Memory Storage (ZMS) <zephyr:zms_api>` - see the following :kconfig:option:`CONFIG_SETTINGS_ZMS` Kconfig option for more details.
* :ref:`Non-Volatile Storage (NVS) <zephyr:nvs_api>` - see the following :kconfig:option:`CONFIG_SETTINGS_NVS` Kconfig option for more details.

ZMS is used for the devices with the RRAM or MRAM non-volatile memory that do not require explicit erase.
Otherwise, the NVS is used.
Copy link
Contributor

@MarekPieta MarekPieta Nov 18, 2024

Choose a reason for hiding this comment

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

I would simplify it a bit:

Suggested change
* :ref:`Zephyr Memory Storage (ZMS) <zephyr:zms_api>` - see the following :kconfig:option:`CONFIG_SETTINGS_ZMS` Kconfig option for more details.
* :ref:`Non-Volatile Storage (NVS) <zephyr:nvs_api>` - see the following :kconfig:option:`CONFIG_SETTINGS_NVS` Kconfig option for more details.
ZMS is used for the devices with the RRAM or MRAM non-volatile memory that do not require explicit erase.
Otherwise, the NVS is used.
* :ref:`Zephyr Memory Storage (ZMS) <zephyr:zms_api>` - used for the devices with non-volatile memory that does not require explicit erase (MRAM, RRAM).
* :ref:`Non-Volatile Storage (NVS) <zephyr:nvs_api>` - used for the devices with non-volatile memory that requires explicit erase (FLASH).

We should point to doc page instead of Kconfig option help for details

Comment on lines 206 to 207
* Updated the `nrf_desktop_settings_loader` to make the :ref:`Zephyr Memory Storage (ZMS) <zephyr:zms_api>` the default file system for all board targets that use the MRAM technology.
As a result, all :ref:`zephyr:nrf54h20dk_nrf54h20` configurations were migrated from the NVS file system to the ZMS file system.
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
* Updated the `nrf_desktop_settings_loader` to make the :ref:`Zephyr Memory Storage (ZMS) <zephyr:zms_api>` the default file system for all board targets that use the MRAM technology.
As a result, all :ref:`zephyr:nrf54h20dk_nrf54h20` configurations were migrated from the NVS file system to the ZMS file system.
* Updated the :ref:`nrf_desktop_settings_loader` to make the :ref:`Zephyr Memory Storage (ZMS) <zephyr:zms_api>` the default settings backend for all board targets that use the MRAM technology.
As a result, all :ref:`zephyr:nrf54h20dk_nrf54h20` configurations were migrated from the NVS settings backend to the ZMS settings backend.

Copy link
Contributor

@peknis peknis left a comment

Choose a reason for hiding this comment

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

Approved with a nit.

applications/nrf_desktop/doc/settings_loader.rst Outdated Show resolved Hide resolved
@kapi-no
Copy link
Contributor Author

kapi-no commented Nov 18, 2024

Fixed changelog conflict and addressed one minor comment

@NordicBuilder
Copy link
Contributor

NordicBuilder commented Nov 18, 2024

CI Information

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

Inputs:

Sources:

sdk-nrf: PR head: 939a4b2ec4831e68874d7fca1e0e12966ce359b2

more details

sdk-nrf:

PR head: 939a4b2ec4831e68874d7fca1e0e12966ce359b2
merge base: f067e19ca105c5a59bcbb82b3898b9deabc080de
target head (main): 2f3f82c9e338f9adc15138e1bb458e9fc8f59757
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 (3)
applications
│  ├── nrf_desktop
│  │  ├── doc
│  │  │  │ settings_loader.rst
│  │  ├── src
│  │  │  ├── modules
│  │  │  │  │ Kconfig.caf_settings_loader.default
doc
│  ├── nrf
│  │  ├── releases_and_maturity
│  │  │  ├── releases
│  │  │  │  │ release-notes-changelog.rst

Outputs:

Toolchain

Version: f51bdba1d9
Build docker image: docker-dtr.nordicsemi.no/sw-production/ncs-build:f51bdba1d9_912848a074

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

  • ◻️ Toolchain - Skipped: existing toolchain is used
  • ✅ Build twister
    • sdk-nrf test count: 82
  • ✅ Integration tests
    • ✅ desktop52_verification
Disabled integration tests
    • doc-internal
    • 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_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-ps
    • test-fw-nrfconnect-rpc
    • test-fw-nrfconnect-rs
    • test-fw-nrfconnect-tfm
    • test-fw-nrfconnect-thread
    • test-fw-nrfconnect-zigbee
    • test-low-level
    • 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

Copy link
Contributor

@divipillai divipillai left a comment

Choose a reason for hiding this comment

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

nit

applications/nrf_desktop/doc/settings_loader.rst Outdated Show resolved Hide resolved
@kapi-no
Copy link
Contributor Author

kapi-no commented Nov 18, 2024

@nordicjm or @tejlmand, could you take a look as build system codeowners?

Copy link
Contributor

@nordicjm nordicjm left a comment

Choose a reason for hiding this comment

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

Kconfig is OK, some plural parts in documentation that are flipped

applications/nrf_desktop/doc/settings_loader.rst Outdated Show resolved Hide resolved
applications/nrf_desktop/doc/settings_loader.rst Outdated Show resolved Hide resolved
Enabled the ZMS file system for the nRF54H20 DK in the nRF Desktop
application. All board targets with the MRAM technology now use ZMS
by default.

Ref: NCSDK-30319

Signed-off-by: Kamil Piszczek <[email protected]>
@rlubos rlubos merged commit b6c93e1 into nrfconnect:main Nov 18, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-required PR must not be merged without tech writer approval.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants