Commit Graph

543 Commits

Author SHA1 Message Date
Jeppe Odgaard
2e14671749 doc: services: storage: fcb: remove deprecated settings recommendation
The recommended back-end depends on the use case. There exists another note
(recommendation) in doc/services/storage/settings/index.rst which is up to
date.

Signed-off-by: Jeppe Odgaard <jeppe.odgaard@prevas.dk>
2025-07-16 16:40:43 -05:00
Ryan McClelland
d84348fbd1 docs: device: remove action for device pm
It is not possible to go from ACTIVE to OFF with device pm
actions.

Signed-off-by: Ryan McClelland <ryanmcclelland@meta.com>
2025-07-16 05:22:47 -10:00
Helmut Lord
15d324cbd4 doc: services: shell: add reference to west rtt
Adds a reference to west rtt as alternative to using putty. Also provides
a command that prints supported rtt runners for the specific build.

This issue is encountered now with the nRF54L1, for example, because
the nrfutil runner does not support RTT at this time.

Signed-off-by: Helmut Lord <kellyhlord@gmail.com>
2025-06-25 15:29:56 -10:00
Jamie McCrae
4af0a02b4c doc: services: device_mgmt: smp_groups: Add boot_mode details
Adds details on a new optional parameter for the OS mgmt reset
command which can specify the boot mode

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-06-18 17:48:44 -04:00
Glenn Andrews
94084e5aba Lib: SMF: Add return code to signal event propagation
See Discussion https://github.com/zephyrproject-rtos/zephyr/discussions/83659
for information about the purpose of this change.

Modifies run actions of hierarchical state machines
to return a value indicating if the event was handled
by the run action or should be propagated up to the
parent run action. Flat state machines are not affected,
and their run action returns void.

smf_set_handled() has been removed and replaced by
this return value. smf_set_state() will not propagate
events regardless of the return value as the transition
is considered to have occurred.

Documentation, tests, samples, has been updated.
USB-C and hawkBit use SMF and have been updated to use
the new return codes.

Signed-off-by: Glenn Andrews <glenn.andrews.42@gmail.com>
2025-06-17 16:04:04 +02:00
Alex Ivanov
5a9394a1e0 llext: add dynamic heap allocation support
Some applications require loading extensions into the memory which does
not exist during the boot time and cannot be allocated statically. Make
the application responsible for LLEXT heap allocation. Do not allocate
LLEXT heap statically.

Signed-off-by: Alex Ivanov <alexivanov@google.com>
2025-06-04 15:50:57 -04:00
Benjamin Cabé
b751bc00e2 doc: secure_storage: update Kconfig options formatting
Revised the documentation for PSA Secure Storage API configuration to
use the new :kconfig:option-regex: role for Kconfig options.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-06-03 09:15:19 +02:00
Flavio Ceolin
287984f629 docs: pm: Update runtime PM documentation and release notes
Add new configuration options for runtime PM to the release notes,
including stack size, priority, and system work queue usage. Update
the runtime PM documentation to explain the implications of using the
system work queue and disabling asynchronous operations. Include a new
version of the sequence diagram for asynchronous operations.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2025-05-27 14:45:07 +02:00
Pieter De Gendt
280171076e doc: services: storage: settings: Fix kconfig directive
Add CONFIG_ prefix to kconfig directive.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2025-05-22 13:45:06 +02:00
Rodrigo Peixoto
6cd508f111 doc: zbus: Runtime observers pool
Add documentation of the runtime observers pool.

Signed-off-by: Rodrigo Peixoto <rodrigopex@gmail.com>
2025-05-16 09:37:20 +02:00
Anas Nashif
5fe84d5b69 arch: nios2: remove arch
Remove architecture and dependencies.
Remove altera HAL supporting nios2

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2025-05-15 20:01:05 -04:00
Riadh Ghaddab
7f716f1522 doc: settings: new API functions
Add references to the new API functions that were added
"csi_load_one" and "csi_get_val_len"

Signed-off-by: Riadh Ghaddab <rghaddab@baylibre.com>
2025-05-15 17:53:26 +02:00
Chris Friedt
4c9fb2e274 doc: posix: add doc for XSI_SINGLE_PROCESS Option Group
Mark the XSI_SINGLE_PROCESS Option Group as supported.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2025-05-13 22:23:21 -04:00
Erik Tamlin
4f6d0c1910 doc: tracing: Added Percepio View section
Added Percepio View section to documentation.

Signed-off-by: Erik Tamlin <erik.tamlin@percepio.com>
2025-04-26 11:14:56 -04:00
Chris Friedt
d29a2a599c doc: posix: option groups: add c_lang_support_r section.
Document that the POSIX_C_LANG_SUPPORT_R Option Group is already
complete.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2025-04-16 08:07:24 +02:00
Jordan Yates
19d123fc43 doc: zbus: update CONFIG_ZBUS_RUNTIME_OBSERVERS
Update the documentation for `CONFIG_ZBUS_RUNTIME_OBSERVERS`.

Signed-off-by: Jordan Yates <jordan@embeint.com>
2025-04-14 20:03:09 +02:00
Simone Orru
c82bf03e6d uuid: Add documentation for UUID utilities
Include the UUID utilities in the Miscellaneous
documentation page.
The UUID is being placed in a new Identifier
APIs section.

Signed-off-by: Simone Orru <simone.orru@secomind.com>
2025-04-14 09:47:26 +02:00
Daniel Mangum
25b083dff4 doc: shell: fix typo of Segger
Fixes Segger typo in shell Segger RTT backend docs.

Signed-off-by: Daniel Mangum <georgedanielmangum@gmail.com>
2025-04-11 10:54:29 +02:00
Krzysztof Chruściński
eb1081e8f4 doc: services: logging: Clarify limitations
Add note about limitation regarding logging strings with width. Clarify
that it is required to cast character pointer to non-character pointer
when used with %p format specifier.

Signed-off-by: Krzysztof Chruściński <krzysztof.chruscinski@nordicsemi.no>
2025-04-10 10:12:11 +02:00
Benjamin Cabé
776c0cab9a doc: boards: nordic: Adopt zephyr:board directives
Migrate all Nordic boards to leverage the full extent of zephyr:board
directives.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-03-31 22:00:02 +02:00
TOKITA Hiroshi
352f5d7717 doc: services: logging: Remove reference for nonexistent test
The `tests/subsys/logging/log_stack` test no longer exists.

Remove a reference to the test from the document.

Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>
2025-03-29 10:47:58 +01:00
Luca Burelli
766122f0cd doc: llext: add note on the loader types
Add a note on the new loader types available in LLEXT..

Signed-off-by: Luca Burelli <l.burelli@arduino.cc>

Signed-off-by:
2025-03-21 14:41:30 -04:00
Fabio Baltieri
60a9a202df kscan: drop kscan and any reference
Drop the whole kscan subsystem and reference to it.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2025-03-13 16:56:26 +00:00
Luca Burelli
6debfe7934 llext-edk: export board information to EDK files
Export the currently used board name and (when applicable) qualifiers
and revisions to the EDK files.  This information can be used by EDK
users who deal with multiple targets to differentiate between them.

Uses the existing 'zephyr_string' function to sanitize the strings
instead of a custom regex replace.

Signed-off-by: Luca Burelli <l.burelli@arduino.cc>
2025-03-12 19:02:45 +01:00
Krzysztof Chruściński
f68a086005 doc: debugging: Add section about CPU load
Add documentation for CPU load module.

Signed-off-by: Krzysztof Chruściński <krzysztof.chruscinski@nordicsemi.no>
2025-03-12 14:03:48 +00:00
Riadh Ghaddab
f3630157e0 doc: settings: add reference to ZMS backend
Add reference to the new settings backend ZMS and add more details about
how it works.

Signed-off-by: Riadh Ghaddab <rghaddab@baylibre.com>
2025-03-06 12:48:50 +01:00
Jamie McCrae
01c5edcd5c doc: serices: device_mgmt: smp_groups: smp_group_1: Add doc anchor
Adds an anchor so that the section text can be linked to

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-02-26 22:04:36 +00:00
Riadh Ghaddab
5f7cda5e06 fs: zms: multiple style fixes from previous PR review
This resolves some addressed comments in this PR zephyrproject-rtos#77930
as well as this PR zephyrproject-rtos#80407

Signed-off-by: Riadh Ghaddab <rghaddab@baylibre.com>
2025-02-21 11:29:50 +00:00
Benjamin Cabé
e831669d12 doc: mgmt: mcumgr: consolidate TOC for SMP Groups
Sphinx documents should not appear in multiple toctrees.
Consolidate SMP Groups under SMP Protocol Specification.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-02-19 14:50:25 +00:00
Andrej Butok
c489a0d315 doc: storage: move "Secure Storage" and "Settings" chapters to "Storage"
Moves the "Secure Storage" and "Settings" chapters to the Storage folder.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2025-02-14 17:05:58 +01:00
Dominik Kilian
84a215aff8 ipc_service: icmsg: Add "unbound" functionality
In some cases, CPUs that may need to reset or
temporary stop communication. This commit adds "unbound"
functionality that provides a callback to IPC service user
when connection was interrupted for some reason, e.g.
expected or unexpected CPU reset, closing the
endpoint. The "unbound" callback is optional to implement
by endpoints. This commit implements it in the ICMsg
backend.

Signed-off-by: Dominik Kilian <Dominik.Kilian@nordicsemi.no>
2025-02-14 13:34:49 +01:00
Luca Burelli
44c7a1401e llext: add ELF inspection APIs
Add APIs to inspect the contents of an ELF file loaded as an extension.
This is useful for applications that need to access the contents of the
extension in a more fine-grained way than the existing LLEXT APIs.

Use of these APIs requires the 'keep_elf_data' option to be provided via
struct llext_load_param to the 'llext_load()' call.

Signed-off-by: Luca Burelli <l.burelli@arduino.cc>
2025-02-13 16:43:29 +01:00
Emil Gydesen
bf95ad47be docs: Rename BLE to Bluetooth (LE) where applicable
The BLE acronym is not an official description of Bluetooth
LE, and the Bluetooth SIG only ever refers to it as Bluetooth
Low Energy or Bluetooth LE, so Zephyr should as well.

This commit does not change any board or vendor specific
documentation, and the term BLE may still be used in those.
It will be up to the vendors to update it if they want,
since many of them are using the term BLE in their
products.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2025-02-12 12:24:18 +01:00
Toon Stegen
7b09ccedf3 doc: tracing: fix typo sys_trace_named_event
fix typo in tracing documentation

Signed-off-by: Toon Stegen <toon@toostsolutions.be>
2025-02-05 05:40:44 +01:00
Chris Friedt
1237c8699a doc: posix: mark XSI_REALTIME as supported
Mark the XSI_REALTIME Option Group as supported, such that the
_XOPEN_REALTIME feature test macro may be tested.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2025-02-03 09:05:09 +01:00
Jamie McCrae
943a93667d doc: services: retention: Fix device names
Fixes device names to use correctly defined values

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-01-30 11:15:41 +01:00
Chris Friedt
166493c2bb doc: posix: correct anchor for posix-option-shared-memory-objects
Since _POSIX_SHARED_MEMORY_OBJECTS is a POSIX Option, the anchor
should be named consistently with other POSIX Option anchors.

A "deprecated" anchor is left, because otherwise there would be
a broken link in the 3.7 release notes.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2025-01-28 23:42:43 +01:00
Luca Burelli
00ccbce2c4 doc: llext: add extension debugging guide
Add a new section to the llext documentation that explains how to debug
extensions and how to address the issues that may arise when doing so.

Signed-off-by: Luca Burelli <l.burelli@arduino.cc>
2025-01-27 08:54:44 +01:00
Jordan Yates
2bd49bbfbe doc: zbus: document ZBUS_CHAN_DEFINE_WITH_ID
Add documentation for the `ZBUS_CHAN_DEFINE_WITH_ID` feature.

Signed-off-by: Jordan Yates <jordan@embeint.com>
2025-01-24 01:15:00 +01:00
Haiyue Wang
4cc76e8a9a doc: Update the File Systems samples link syntax
The commit 16183f665e ("samples: subsys: fs: create common fs sample")
renames the sample name for FAT fs from 'fat_fs' to 'fs_sample'.

To avoid this kind of errors, ":zephyr:code-sample:`xxx`" is introduced.

Signed-off-by: Haiyue Wang <haiyuewa@163.com>
2025-01-16 22:56:44 +01:00
Pieter De Gendt
b65a97ef0c modules: nanopb: Move pip dependencies to optional module
The west packages extension can be used to install module dependencies.

Upstream nanopb has added the pip package dependencies to the
zephyr/module.yml file. Remove in-tree pip package dependencies.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2024-12-19 15:20:11 +01:00
Ilya Tagunov
ce50ea2f1f llext: disable for Harvard ARC variants
Some ARC processor configurations have separate memory for code (ICCM)
and for data (DCCM). Such configurations are unsuitable for LLEXT,
except for some quite special cases. For now, disable LLEXT and its
tests for these devices completely.

Signed-off-by: Ilya Tagunov <Ilya.Tagunov@synopsys.com>
2024-12-16 18:25:16 +01:00
Dane Wagner
fd1e9f7445 doc: cache: Create caching overview
Expands the caching documentation to include a high-level overview
of caching strategies and the features available in Zephyr.

Signed-off-by: Dane Wagner <dane.wagner@gmail.com>
2024-12-11 21:33:29 +01:00
Krzysztof Chruściński
ca557d8140 doc: shell: Add section about PuTTY RTT configuration
Add section which explains how to configure PuTTY to use RTT
shell there with all shell features. There is an alternative
approach which also works but it does not allow to use all
shell features.

Signed-off-by: Krzysztof Chruściński <krzysztof.chruscinski@nordicsemi.no>
2024-12-11 21:30:19 +01:00
Benjamin Cabé
a68d32f386 doc: thread-analyzer: add links to kconfigs and use definition list
This makes the list of Kconfig associated to the thread analyzer feature
more readable and also adds links to the detailed Kconfig documentation.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-12-05 15:17:06 +01:00
Benjamin Cabé
7d3aa194de Revert "modules: nanopb: Move pip dependencies to optional module"
This reverts commit 26614832f2.
A bug in upstream nanopb, which this commit was pulling as part
of the submanifest update, seems to be causing test failures
on big-endian platforms.
Upstream bug: https://github.com/nanopb/nanopb/issues/1039

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-11-29 21:45:54 +01:00
Pieter De Gendt
26614832f2 modules: nanopb: Move pip dependencies to optional module
The west packages extension can be used to install module dependencies.

Upstream nanopb has added the pip package dependencies to the
zephyr/module.yml file. Remove in-tree pip package dependencies.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2024-11-29 15:25:06 +01:00
Yong Cong Sin
027c79add7 doc: posix: option_groups: add section for POSIX_FILE_SYSTEM_R
Add section for POSIX_FILE_SYSTEM_R which contains only `readdir_r()`.

Signed-off-by: Yong Cong Sin <yongcong.sin@gmail.com>
2024-11-21 09:18:09 +01:00
Lauren Murphy
99a5236b40 llext: add support for arc
Adds compiler flag(s) and some architecture-specific relocations
for ARC. No userspace support, doesn't support all relocations.

Signed-off-by: Lauren Murphy <lauren.murphy@intel.com>
2024-11-16 15:08:51 -05:00
Chris Friedt
95f4912e72 doc: posix: options: correct anchor for thread safe functions
Previously, the anchor for `_POSIX_THREAD_SAFE_FUNCTIONS` was
`posix_thread_safe_functions` but it should have been
`posix_option_thread_safe_functions`.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-11-15 11:10:20 -06:00