Commit graph zephyr/doc/services
Author SHA1 Message Date
Martin Stumpf
7595864175 docs: mcumgr: Update mcumgr-toolkit
As of 0.13.0, mcumgr-toolkit now supports all SMP groups.
Also, its CLI tool is now mentioned specifically.

Signed-off-by: Martin Stumpf <finomnis@gmail.com>
2026-04-11 10:09:00 -04:00
Pieter De Gendt
c5d6cdc523 doc: device_mgmt: mcumgr_callbacks: migrations: Fix hook symbols
Fix the Kconfig symbols required for callbacks of the corresponding enums.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2026-04-07 15:36:52 -04:00
Eden Frosst
29f9ed1711 doc: pm: device_runtime: update return code in example
Code example for `pm_device_runtime_enable` referenced a return value
that does not exist anymore.

Signed-off-by: Eden Frosst <eden.frosst@rbr-global.com>
2026-04-04 10:58:38 -05:00
Eve Redero
223ba366e3 doc: nvmem: more explanations on MAC and nvmem
Add some more explanations on how to configure MAC
addresses with nvmem

Signed-off-by: Eve Redero <eve.redero@gmail.com>
Co-authored-by: Pieter De Gendt <pieter.degendt@gmail.com>
2026-03-31 13:53:59 -05:00
Lauren Murphy
e43d5b72c2 llext: doc: clarify heap custom section placement
Adds language explaining why the LLEXT heap section may not
be placed for the user's board or architecture, and how they
can fix that.

Signed-off-by: Lauren Murphy <lauren.murphy@intel.com>
2026-03-24 15:40:38 -05:00
Trond F. Christiansen
205917cb87 doc: zbus: add documentation for multi-domain zbus
Add documentation for the multi-domain zbus feature

Signed-off-by: Trond F. Christiansen <trond.christiansen@nordicsemi.no>
2026-03-21 00:47:22 +00:00
Lauren Murphy
d77e760189 llext: nits in doc, kconfig, testcase
Fixes a couple nits in the docs, Kconfig and testcase.

Signed-off-by: Lauren Murphy <lauren.murphy@intel.com>
2026-03-19 17:12:57 -05:00
Lauren Murphy
890eb11be9 llext: memblk kconfigs in docs
Adds missing descriptions of sys_mem_blocks heap Kconfigs.

Signed-off-by: Lauren Murphy <lauren.murphy@intel.com>
2026-03-16 10:07:20 -04:00
Lauren Murphy
8bcc333e65 llext: custom sections for heap
Places heaps in custom sections with default placements.

Signed-off-by: Lauren Murphy <lauren.murphy@intel.com>
2026-03-16 10:07:20 -04:00
Flavio Ceolin
44763bcd1d doc: crypto/random: Document possible options
Improve Kconfig options with information about different build symbols
and document devicetree configuration used / needed when entropy
drivers are used.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2026-03-13 14:26:24 -07:00
Flavio Ceolin
bb6c0f0cfe doc: crypto/random: Add API usage section
Add a new section with examples of usage of both, cryptographically
and non-cryptographically APIs.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2026-03-13 14:26:24 -07:00
Flavio Ceolin
5c36e616eb doc: crypto/random: Simplify subsys overview
Simplify the subsys overview expliciting stating two different
types of random number generator APIs and use cases.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2026-03-13 14:26:24 -07:00
Glenn Andrews
4cf56ae059 Lib: SMF: Add instrumentation for SMF
Add instrumentation hooks for transitions and actions, as well as
error states. This will allow us to track the state of the state
machine during testing, and also provide a way to debug issues
that may arise during execution.

Signed-off-by: Glenn Andrews <andrewsglenn@meta.com>
2026-03-13 16:29:57 +01:00
Flavio Ceolin
b92d516907 random: ctr-drbg: Use PSA crypto instead of MBED TLS
Change ctr_drb random implementation to use PSA Crypto API.
Since name convention is very different and PSA abstracts the
algorithm used to generate CSPRNG, file and Kconfig options were
changed. Current symbols were deprecated and just select the new
one.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2026-03-12 11:32:15 +01:00
Zhaoxiang Jin
db125026d7 doc: pm: Clarify pm_device_driver_init error handling
Document that pm_device_driver_init returns 0 on success
and propagates errors from the PM action callback.
Clarify that when the callback fails during initialization
(e.g., on PM_DEVICE_ACTION_RESUME), the device is not marked
ACTIVE and remains in its previous state (typically SUSPENDED
or OFF for devices supporting PM).

Update documentation to reflect that the device is moved
to the "expected initial state" rather than specifically
to "ACTIVE" state, as the actual state depends on the
success of the initialization sequence.

Signed-off-by: Zhaoxiang Jin <Zhaoxiang.Jin_1@nxp.com>
2026-03-11 11:42:06 +01:00
Zhaoxiang Jin
0dc65d097c doc: shell: add ADC shell commands to documentation
Add documentation for ADC shell commands in the shell services index.
This includes the general ADC shell commands (CONFIG_ADC_SHELL) and
the ADC emulator shell commands (CONFIG_ADC_EMUL_SHELL).

The ADC emulator shell requires both CONFIG_ADC_EMUL and
CONFIG_ADC_EMUL_SHELL to be enabled.

Signed-off-by: Zhaoxiang Jin <Zhaoxiang.Jin_1@nxp.com>
2026-03-09 11:05:50 +01:00
Dominik Tacke
73a6279146 docs: tcp net logger backend
Extended docu to include tcp syslog server option.
Verified on STM32U5 chip to a Grafana Alloy telemetry
collector,

Signed-off-by: Dominik Tacke <dominik.tacke@siemens.com>
2026-02-26 12:34:52 +01:00
Seppo Takalo
e07ba60d22 doc: modem: Add cellular modem info regarding drivers and chat scripts
Add information regarding the missing Modem Chat module and
explaing the Cellular Modem architecture.

Add own section regarding support for new modems.

Signed-off-by: Seppo Takalo <seppo.takalo@nordicsemi.no>
2026-02-26 10:31:36 +01:00
Andreas Anderberg
c439a1c632 doc: zms: document forced mount recovery
Document zms_mount_force() in the mounting section and move this
capability from future features to existing features.

Signed-off-by: Andreas Anderberg <andreas.anderberg@u-blox.com>
2026-02-25 13:04:53 +01:00
Benjamin Cabé
a910195a93 doc: services: uuid: Add dedicated page for UUID API
Add more complete/dedicated documentation page for UUID API.
Drop the old services/misc page as it's empty/deleted now

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-02-24 16:03:15 -06:00
Benjamin Cabé
979c69eedd doc: services: jwt: Add dedicated page for JWT API
Add more complete/dedicated documentation page for JWT API

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-02-18 14:42:22 +00:00
Erik Tamlin
1b1b5bfd7c manifest: update percepio
Update the percepio module to use TraceRecorder v4.11.1

Signed-off-by: Erik Tamlin <erik.tamlin@percepio.com>
2026-02-12 20:03:39 +01:00
Dominik Ermel
b9fcb5efa4 kvss: Create Key-Value Storage subsystem
Add new subsystem and move NVS and ZMS under that subsystem.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2026-02-12 10:55:27 +01:00
Pieter De Gendt
354e93deec doc: services: shell: Add readline user input section
Add information on how to use shell_readline to the shell documentation.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2026-02-11 17:47:50 -06:00
Mathieu Choplain
93b25d101c boards: nordic: use zephyr:board-supported-hw
Replace legacy hand-mantained tables with the new directive that generates
a table automatically based on platform device tree. While at it, in some
boards, the existing "markers" have been replaced with the zephyr:board
role as it is required for proper operation of zephyr:board-supported-hw.
Some documentation pages which contained a reference to the marker are also
updated to use zephyr:board instead.

Signed-off-by: Mathieu Choplain <mathieu.choplain-ext@st.com>
2026-02-11 15:01:22 -06:00
Pieter De Gendt
8100484e5d doc: services: nvmem: Add CONFIG_NVMEM_BBRAM mention
Add entry for CONFIG_NVMEM_BBRAM in the Kconfig options for the NVMEM
subsystem.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2026-02-11 10:39:41 +01:00
Andreas Klinger
53a8c429db doc: add zyclictest shell services command
Add documentation about Zyclictest which is a tool for measuring worst case
latencies.

Signed-off-by: Andreas Klinger <ak@it-klinger.de>
2026-02-05 10:27:48 +00:00
Sean Kyer
c273ce7989 cpu_freq: pressure: Introduce pressure policy
Add pressure policy to cpu_freq subsystem. The
pressure policy evaluates system load by accumulating
the priorities of runnable threads to inform P-state
transitions.

As more threads of higher priorities queue as ready
in the scheduluer, the system pressure increases
and the policy may decide to choose a more aggressive
P-state.

Signed-off-by: Sean Kyer <sean.actor@gmail.com>
2026-02-05 10:27:38 +00:00
Benjamin Cabé
18e5a700a0 doc: treewide: drop reST substitutions for non-ASCII characters
Copyright sign, trademark sign, registered trademark sign, ... and other
non-ASCII characters are OK to use in the documentation source files.
Replace them with the corresponding Unicode characters.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-02-03 14:26:41 -06:00
Martin Stumpf
83d47c472a docs: mcumgr: Add mcumgr-toolkit to tools table
Disclaimer: I'm the author and maintainer of this tool.

Signed-off-by: Martin Stumpf <finomnis@gmail.com>
2026-02-03 14:24:33 -06:00
Martin Stumpf
4cad994b9d docs: mcumgr: Add LoRaWAN transport in tools table
There's now the KConfig option `CONFIG_MCUMGR_TRANSPORT_LORAWAN`,
but no corresponding entry in the tools table exists yet.

Signed-off-by: Martin Stumpf <finomnis@gmail.com>
2026-02-03 14:24:33 -06:00
Muhammad Waleed Badar
6383c67622 doc: shell: improve wildcard feature documentation
Add a note about '*' and '?' characters usage.

Signed-off-by: Muhammad Waleed Badar <walid.badar@gmail.com>
2026-01-27 15:21:19 -06:00
Jamie McCrae
5123838cff doc: services: device_mgmt: smp_transport: Add raw SMP protocol
Adds details of this new transport

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2026-01-27 10:23:45 -06:00
Alessandro Manganaro
429350b1be pm: add optional custom ticks hook for system suspend
Add an optional power policy hook to provide custom "next event"
ticks during pm_system_suspend(), in addition to the existing
kernel ticks and policy event list.

This hook enables applications and SoC-specific code to derive
the next wake-up time directly from proprietary or
hardware-specific data structures (e.g. hardware registers,
binary-only modules, complex schedulers) that are not
practical to convert into the standard PM policy event list.

The feature is gated by CONFIG_PM_CUSTOM_TICKS_HOOK and is fully
backwards compatible when disabled.

Signed-off-by: Alessandro Manganaro <alessandro.manganaro@st.com>
2026-01-26 10:13:53 -06:00
Gillian Minnehan
edc952e641 doc: develop: manifests: external: add memfault
Add documentation to external module section for adding the
Memfault firmware SDK to a Zephyr project. Additionally, refer to the
module in OTA docs.

Signed-off-by: Gillian Minnehan <gillian.minnehan@nordicsemi.no>
2026-01-26 14:16:59 +01:00
Flavio Ceolin
12f61f81b7 doc: pm/power_domain: Fix wrong function signature
Fix a wrong type in the code snippet. In the pm action, the
action parameter is not a pointer.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2026-01-26 12:05:42 +01:00
Flavio Ceolin
1ec8feb98d doc: pm/device: Typo fixes
Fix a wrong uppercase after a comma and s/unsolicitet/unsolicited

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2026-01-26 12:05:42 +01:00
Flavio Ceolin
4ff318311d doc: pm/device: Fix variable names in code snippet
The driver config struct was declaring `int_pin` while the code was
using `int_gpio`. Another issue was the variable name used for
`dev->config`, changed it to `config` instead of `dev_config` as used
in the code.

Signed-off-by: Flavio Ceolin <flavio@hubblenetwork.com>
2026-01-26 12:05:42 +01:00
Chris Friedt
25c2aaef9b posix: xsi: streams: deprecate CONFIG_XOPEN_STREAMS (again)
CONFIG_XOPEN_STREAMS does not follow the pattern of other XSI Option
Groups, where the Option Group name is not the same as the feature
test macro that indicates it is supported by the implementation.

Deprecate CONFIG_XOPEN_STREAMS and rename it to CONFIG_XSI_STREAMS.

For more information, please see
https://pubs.opengroup.org/onlinepubs/9699919799/basedefs/\
V1_chap02.html#tag_02_01_05_09

Signed-off-by: Chris Friedt <chris@fr4.co>
2026-01-20 13:24:51 +00:00
Gatien Chevallier
624e018a5f nvmem: Add OTP API support
OTP drivers are the interface to One Time Programmable memory, which
is NVMEM. Add the interface with the OTP API to the NVMEM one.

Signed-off-by: Gatien Chevallier <gatien.chevallier@foss.st.com>
2026-01-16 11:42:50 +00:00
Mathieu Choplain
8f5a5bb7cd doc: services: mem_mgmt: cleanup zephyr,memory-attr examples
Remove whitespace between parentheses and value. This seems to be the only
place in tree where such a pattern is found, and it violates the rules of
the Devicetree linter executed by CI.

Replace ARM-specific MPU attributes with their plain variant, also removing
the unnecessary parentheses in the process.

Signed-off-by: Mathieu Choplain <mathieu.choplain-ext@st.com>
2026-01-12 11:55:36 +01:00
Mathieu Choplain
219cdf756a boards: arm: use zephyr:board-supported-hw
Replace legacy hand-mantained tables with the new directive that generates
a table automatically based on platform device tree.

Signed-off-by: Mathieu Choplain <mathieu.choplain-ext@st.com>
Signed-off-by: Sudan Landge <sudan.landge@arm.com>
2026-01-06 13:36:30 +00:00
Benjamin Cabé
18c1a63891 doc: fix bad indentation causing elements to render as definition lists
Fixes documents where blocks where indented to the right of their parent
causing them to render as definition lists.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-12-18 23:37:50 +01:00
Tobias Kässer
858acad5ac doc: fix CONFIG_PM_DEVICE_RUNTIME_ASYNC typo
Fixed typo CONFIOG_PM_DEVICE_RUNTIME_ASYNC to
CONFIG_PM_DEVICE_RUNTIME_ASYNC in device runtime PM documentation.

Signed-off-by: Tobias Kässer <t.kaesser@gmail.com>
2025-12-17 10:57:32 +02:00
Benjamin Cabé
fd24cefd01 doc: spelling/typo fixes
minor spelling/typo fixes, mainly around using proper US English

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-12-11 16:32:58 -05:00
Seppo Takalo
392665578c doc: modem: Add documentation regarding CMUX power saving
Add documentation and state machine diagrams for CMUX power saving
feature and how to use it with Zephyr.

Signed-off-by: Seppo Takalo <seppo.takalo@nordicsemi.no>
2025-12-04 05:24:38 -05:00
Benjamin Cabé
d55b7be1ac doc: services: crc: add CRC doc page
Add a page for documenting CRC services

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-12-01 12:25:05 -05:00
Benjamin Cabé
da95e8499a doc: services: storage: sort ToC entries alphabetically
Sort entries alphabetically instead of the current somewhat random order.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-12-01 08:27:52 +01:00
Benjamin Cabé
4ee5499f67 doc: storage: nvmem: move nvmem docs under storage
This moves nvmem docs to a better suited home since we already have
a section for all things storage.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-12-01 08:27:52 +01:00
Benjamin Cabé
bd62f24893 doc: storage: fs: move file system docs under storage
This moves fs docs to a better suited home since we already have
a section for all things storage.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-12-01 08:27:52 +01:00