Commit Graph

524 Commits

Author SHA1 Message Date
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
Ahmed Adel
8034de73d5 doc: services: debugging: Remove unwanted reference link
Remove unwanted reference link to the section (Usage)
in ARM Coresight Trace Deformatter that shows up in
the main Debugging documentation page, by lowering
the level of (Usage) heading from ##### to *****

The commit also has a typo fix.

Signed-off-by: Ahmed Adel <a.adel2010@gmail.com>
2024-11-15 08:09:53 -06:00
Pisit Sawangvonganan
1175f57640 doc: fix typo in multiple directories before v4.0.0 release
Utilize a code spell-checking tool to scan for and correct spelling errors
in various files within the `doc` directory.

Signed-off-by: Pisit Sawangvonganan <pisit@ndrsolution.com>
2024-11-13 13:35:49 -06:00
Jamie McCrae
55e7cc659c doc: Fix renamed ARM MPS* board targets
Fixes some board target names that have changed or were not
updated for hwmv2

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2024-11-13 09:08:09 -06:00
Jordan Yates
35295f3663 zbus: observervation -> observation
Fix a typo in the doxygen and service documentation.

Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-11-12 12:15:55 -06:00
Simon Moser
a77d499e2d doc: fix body length in SMP UART transport
In the description of the partial-final frame of the SMP UART transport
specification was a typo in the maximum allowed raw body size. The size
must not be larger than MTU - 5 because there are 5 bytes occupied by
total length (2), frame termination (1) and crc (2).

Signed-off-by: Simon Moser <simon.github@mailbox.org>
2024-11-08 13:57:18 -06:00
Daniel DeGrasse
a1dc0b8b3e drivers: disk: sdmmc_subsys: remove CONFIG_SDMMC_VOLUME_NAME
Remove CONFIG_SDMMC_VOLUME_NAME, and set the disk name based on the
``disk-name`` property. This aligns with other disk drivers, and allows
for multiple instances of the sdmmc_subsys disk driver to be registered.

Add disk-name properties for all in tree definitions for the
sdmmc-subsys disk driver, and change all in tree usage of the disk name

Fixes #75004

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2024-11-05 15:25:10 -06:00
Benjamin Cabé
14d0a19cc2 doc: fix occurrences of broken zephyr_file: links
In preparation of adding a check for dead references, this commit fixes
currently broken zehpyr_file: links.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-10-30 09:43:50 -07:00
Riadh Ghaddab
46e1635773 fs: zms: multiple fixes from previous PR review
This resolves some addressed comments in this PR
https://github.com/zephyrproject-rtos/zephyr/pull/77930

It adds as well a section in the documentation about some
recommendations to increase ZMS performance.

Signed-off-by: Riadh Ghaddab <rghaddab@baylibre.com>
2024-10-29 07:07:13 -05:00
Sudan Landge
3092d96e5b boards: mps3: Add support for corstone300/an552
What is changed?
 - Added a new mps3 board an552 for the soc corstone300.
   The qualifier to build/run application with board mps3/an552 is
   `mps3/corstone300/an552` for secure and
   `mps3/corstone300/an552/ns` for non-secure.
 - Added FVP variant to enable FVP testing with corstone300
   and it uses the ARM FVP `FVP_Corstone_SSE-300_Ethos-U55`.
   The qualifier to build/run application with FVP is
   `mps3/corstone300/fvp` for secure and
   `mps3/corstone300/fvp/ns` for non-secure.
 - Note: the qualifier to build/run application with board mps3/an547
   is now changed to
   `mps3/corstone300/an547` for secure and
   `mps3/corstone300/an547/ns` for non-secure.

How is it changed?
 - Moved common code from mps3/an547 to corstone300.
 - Renamed soc for an547 to corstone300 and added
   a new soc corstone300/an552.

Why do we need this change?
 - This enables FVP support and testing for corstone300.
 - SOC/qualifier for mps3/an547 was renamed to reduce code redundancy
 - A separate FVP variant was added for AN552 because, the TFM board
   used for non-secure variant differs for FPGA and FVP.
   TFM board `arm/mps3/corstone300/fvp` should be used when testing
   AN552 with FVP and `arm/mps3/corstone300/an552` should be used when
   testing with AN552 FPGA.

Signed-off-by: Sudan Landge <sudan.landge@arm.com>
2024-10-26 03:58:05 +01:00
Laczen JMS
237a18928b settings: add note to documentation
Add information about commit priority to settings documentation.

Signed-off-by: Laczen JMS <laczenjms@gmail.com>
2024-10-24 22:04:07 +01:00
Riadh Ghaddab
3c4fcaa2c0 doc: zms: add documentation for ZMS
This adds the documentation for the Zephyr Memory Storage system.

Signed-off-by: Riadh Ghaddab <rghaddab@baylibre.com>
2024-10-24 16:57:12 +01:00
Benjamin Cabé
bcfbcc00af boards: qemu: adopt new zephyr:board directive and role
This updates the documentation of all the Qemu boards
to use the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-10-24 17:51:15 +02:00
Benjamin Cabé
a43009079f boards: st: adopt new zephyr:board directive and role
This updates the documentation of all the STM32 boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-10-24 17:51:15 +02:00
Benjamin Cabé
d885957fe8 boards: nxp: adopt new zephyr:board directive and role
This updates the documentation of all the NXP boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-10-24 17:51:15 +02:00
Benjamin Cabé
0ff3f0d364 boards: ezurio: adopt new zephyr:board directive and role
This updates the documentation of all the Ezurio boards to use
the new `zephyr:board::` directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-10-24 17:51:15 +02:00
Dominik Kilian
cbaafe209c boards: nordic: ipc: added dcache alignement
The nRF54 and nRF92 chips has data cache, which means
the ICMsg and ICBMsg must be configured to follow required
cache alignment of the shared memory.
The `dcache-alignement` needs to be defined for that.

Signed-off-by: Dominik Kilian <Dominik.Kilian@nordicsemi.no>
2024-10-24 03:45:35 +01:00
Dominik Kilian
8d99393530 doc: ipc: Add detailed protocol specs for ICBMsg backend
The details of how the ICBMsg communication is done, are hidden
inside the source code. This specification adds details about
the ICBMsg protocol.

Signed-off-by: Dominik Kilian <Dominik.Kilian@nordicsemi.no>
2024-10-23 17:01:54 +02:00
Dominik Kilian
7574602108 doc: ipc: Add detailed protocol specs for ICMsg backend
The details of how the ICMsg communication is done, are hidden
inside the source code. This specification adds details about
the ICBMsg protocol.

Signed-off-by: Dominik Kilian <Dominik.Kilian@nordicsemi.no>
2024-10-23 17:01:17 +02:00
Maureen Helm
dc9e0cbedb doc: tracing: Use SystemView RTT tracing snippet
Refactors the SystemView tracing documentation to use the rtt-tracing
snippet.

Signed-off-by: Maureen Helm <maureen.helm@analog.com>
2024-10-23 16:51:12 +02:00