Commit graph zephyr/doc
Author SHA1 Message Date
Mathieu Choplain
e146a86a5c doc: migration: 4.4: add hint on how to set Kconfig values for NUM_IRQS
CONFIG_NUM_IRQS is a promptless symbol so setting it is not trivial. Add a
pointer to the documentation page which explains how to do it in the STM32
section of the 4.4 migration guide related to CONFIG_NUM_IRQS changes.

Signed-off-by: Mathieu Choplain <mathieu.choplain-ext@st.com>
(cherry picked from commit 0ac4d66410)
2026-05-19 15:10:32 -05:00
Reto Schneider
d4cbe0f8bb docs: migration: fix link to Mbed-TLS/TF-PSA migration guide
Without the trailing underscore, the link gets rendered raw, and is not
clickable.

Signed-off-by: Reto Schneider <reto.schneider@husqvarnagroup.com>
(cherry picked from commit 110ba3ec16)
2026-05-07 17:59:06 -05:00
Szymon Janc
2b0cb548bc doc: release: Add note about Bluetooth Host qualification
Provide qualification scope summary and link to design listing.

Signed-off-by: Szymon Janc <szymon.janc@codecoup.pl>
(cherry picked from commit 9834ca4ef2)
2026-04-27 20:25:53 -05:00
Maureen Helm
c4a8fc21ef doc: releases: Remove 4.2 from the list of supported releases
4.2 has reached EOL.

Signed-off-by: Maureen Helm <maureen.helm@analog.com>
2026-04-14 14:45:49 -05:00
Maureen Helm
09f43af95d doc: releases: Add 4.4 to the list of supported releases
Adds 4.4 to the list of supported releases and updates references to the
next planned release as 4.5. The EOL date is set to one year after
release.

Signed-off-by: Maureen Helm <maureen.helm@analog.com>
2026-04-14 14:45:49 -05:00
Maureen Helm
66d163da2f doc: release: Finalize 4.4 release notes and migration guide
Removes working draft status from the 4.4 release notes and migration
guide.

Signed-off-by: Maureen Helm <maureen.helm@analog.com>
2026-04-14 14:45:49 -05:00
Benjamin Cabé
2ee0b2b3c0 doc: releases: improve FTL release highlight bullet point
Use tone consistent with other bullet points and link to the driver's
binding so that readers have a clear starting point to learn more.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-04-14 10:39:14 -05:00
Nicolas Pitre
0af51ca254 doc: releases: release-notes-4.4: add heap hardening and constants library
Add release note entries for:
- Tiered heap hardening (also mention in release highlights)
- zephyr_constants_library() CMake function

Signed-off-by: Nicolas Pitre <npitre@baylibre.com>
Co-authored-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-04-14 10:39:14 -05:00
Junfeng Li
ef14f1ad37 doc: vscode: fix broken sample path
Fix broken sample path: samples/blinky => samples/basic/blinky

Signed-off-by: Junfeng Li <junfengli@meta.com>
2026-04-14 10:38:05 -05:00
Maureen Helm
f51546195b doc: releases: Clean up 4.4 migration guide
Minor formatting and editorial cleanup.

Signed-off-by: Maureen Helm <maureen.helm@analog.com>
2026-04-14 10:36:48 -05:00
Maureen Helm
f26393b435 doc: releases: Clean up 4.4 release notes
Moves release notes documenting the removal of some Xtensa architecture
Kconfigs and some Bluetooth controller Kconfigs into the "Removed APIs
and options" section.

Signed-off-by: Maureen Helm <maureen.helm@analog.com>
2026-04-14 10:36:48 -05:00
Martí Bolívar
0d55eab2fb doc: releases: DT release notes for v4.4
Add release notes and fix the capitalization while we are here.

Signed-off-by: Martí Bolívar <marti.bolivar@oss.qualcomm.com>
2026-04-13 15:08:10 -05:00
Fabio Baltieri
92b52845d3 docs: migration: add a note about cmake deps to zephyr_generated_headers
Add a note about the new dependency of kernel.h to generated headers.
This has been a major source of breakages for us downstream, it'll
likely be useful to other users too.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2026-04-13 15:07:45 -05:00
Rodrigo Peixoto
433529fc34 doc: releases: Add zbus v4.4.0 release notes
Add zbus async listeners, improve multi-domain proxy agent notes, and add
new API entries to the v4.4.0 release notes.

Signed-off-by: Rodrigo Peixoto <rodrigopex@gmail.com>
2026-04-13 15:07:12 -05:00
Abderrahmane JARMOUNI
1f1992d09a doc: releases: migration-guide-4.4: rework display section
Rework Display section in v4.4.0 release migration guide

Signed-off-by: Abderrahmane JARMOUNI <git@jarmouni.me>
2026-04-13 11:06:20 -05:00
Abderrahmane JARMOUNI
ee1b10bdaf doc: releases: release-notes-4.4: add display elements
Complete Display section in v4.4.0 release notes.

Signed-off-by: Abderrahmane JARMOUNI <git@jarmouni.me>
2026-04-13 11:05:22 -05:00
Benjamin Cabé
17fdc1ea33 doc: test: benchmark: spelling fix and fix code block formatting
Fixes spelling of "Alternatively", adds proper link to kconfig option,
and fixes Sphinx code block markup.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-04-13 11:05:00 -05:00
Daniel Leung
232cbacefd doc: release-notes/4.4: new functions for userspace
Mention new functions added for userspace.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2026-04-11 10:09:31 -04:00
Daniel Leung
8160948369 doc: release-notes/4.4: mention CONFIG_EXCEPTION_DUMP_HOOK_ONLY
This mentions the new kconfig to add callback during exception
to emit more information.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2026-04-11 10:09:31 -04:00
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
Tomi Fontanilles
3f03865a0f doc: releases: document Mbed TLS changes for Zephyr 4.4.0
Fix up the existing migration guide entries.
Add missing bits.
Remove information about the PSA Crypto API changes; they belong to
upstream Mbed TLS.
Move `Mbed TLS` under `Modules` instead of `Other subsystems`.
Populate the release notes with the same information but in addition
add the new and deprecated Kconfig options.

Signed-off-by: Tomi Fontanilles <tomi.fontanilles@nordicsemi.no>
2026-04-11 10:07:44 -04:00
Fin Maaß
535bf0378a doc: usb: device: fix legacy API deprecation note
The correct version to remove is v4.5.0, since the API
was deprecated in version v4.3.0.

Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>
2026-04-11 10:06:20 -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
Tim Pambor
48f5d02a00 doc: releases: 4.4: Add NAND flash support
Add release notes for newly introduced NAND flash support.

Signed-off-by: Tim Pambor <tim.pambor@codewrights.de>
2026-04-07 15:32:58 -04:00
Nicolas Pitre
32b1399669 kernel/timeout: introduce sys_clock_lock() and sys_clock_announce_locked()
On SMP systems with tickless kernels, a race condition exists between
timer driver ISRs and the kernel's tick accounting. The driver updates
its hardware cycle baseline under a private lock, then calls
sys_clock_announce() which updates curr_tick under the separate
timeout_lock. In the gap between these two lock releases, any kernel
code calling sys_clock_elapsed() sees the new driver baseline but the
old curr_tick, producing inconsistent time values that can go backwards.

This affects every code path using the internal elapsed() helper:
uptime queries, timeout scheduling, timeout cancellation, remaining
time queries, and next-expiry calculations.

The root cause is two separate locks protecting state that must be
mutually consistent. Fix this by exposing the kernel's timeout_lock
to timer drivers via sys_clock_lock()/sys_clock_unlock(), and
providing sys_clock_announce_locked() which assumes the lock is
already held.

Timer drivers can now acquire the single lock, update their hardware
state, and announce ticks all under the same lock — eliminating the
race window entirely. The key is passed to sys_clock_announce_locked()
which consumes it (releasing the lock when it returns).

The existing sys_clock_announce() becomes a backward-compatible wrapper,
allowing incremental driver migration with no flag day.

Document that sys_clock_set_timeout(), sys_clock_elapsed(), and
sys_clock_idle_exit() are called by the kernel with the timer lock
held. Update the timer driver guide in clocks.rst accordingly.

Signed-off-by: Nicolas Pitre <npitre@baylibre.com>
2026-04-07 11:40:49 -05:00
Ofir Shemesh
4584d9a234 doc: add FlexSPI NOR soc-nv-flash migration entry
Add migration guide entry for the FlexSPI NOR DTS
restructuring to the soc-nv-flash child node
convention introduced in b1afb494b0.

Signed-off-by: Ofir Shemesh <ofirshemesh777@gmail.com>
2026-04-07 11:36:12 -05:00
Nicole Pappler
891e559f58 doc: safety: add getting started guide
This commit adds additional information for contributors
who whish to contribute safety requirements to the project.
Most importantly, the guide explains how to setup
strictdoc to work with the project's safety requirements
repo.

Signed-off-by: Nicole Pappler <nicole@alektometis.com>
Signed-off-by: nicpappler <github@pappler.eu>
2026-04-07 11:32:48 -05:00
Nicole Pappler
0a73ad2062 doc: safety: add safety requirements checklist
This commit adds the project's  Safety Requirements Checklist as
agreed on with the project's safety assessor.
The content is augmented with

* examples
* more explanation to help potential contributers and reviewers

Signed-off-by: Nicole Pappler <nicole@alektometis.com>
2026-04-07 11:32:48 -05:00
Nicole Pappler
f810af6912 doc: safety: push safety requirements to sub-folder
Move all safety requirements related content to its own
sub-folder.

Signed-off-by: Nicole Pappler <nicole@alektometis.com>
2026-04-07 11:32:48 -05:00
Flavio Ceolin
218c02e347 doc: release/4.4: Disclose CVE-2026-5590
Disclose information about published CVE.

Signed-off-by: Flavio Ceolin <flavio.ceolin@gmail.com>
2026-04-07 11:31:44 -05:00
Flavio Ceolin
75dafaf4e8 doc: security: Disclose CVE-2026-5590
Disclose information about published CVE.

Signed-off-by: Flavio Ceolin <flavio.ceolin@gmail.com>
2026-04-07 11:31:44 -05:00
Flavio Ceolin
159c7d424d doc: release/4.4: Add CVE under embargo
Add CVEs - 2026-5068 and 2026-5589 - under embargo fixed during 4.4
development

Signed-off-by: Flavio Ceolin <flavio.ceolin@gmail.com>
2026-04-07 11:31:44 -05:00
Flavio Ceolin
b5589fcc7b doc: vuln: Add CVE under embargo
Add an entry to CVE-2026-5589

Signed-off-by: Flavio Ceolin <flavio.ceolin@gmail.com>
2026-04-07 11:31:44 -05:00
Jukka Rissanen
d00e87bfae doc: release-notes: Add wifi information to 4.4
Add information about native wifi stack changes in 4.4.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
2026-04-07 11:30:56 -05:00
Robert Lubos
01bc91bb65 doc: release-notes-4.4: Update release notes for networking
Update release notes for 4.4.0 release with networking subsystem
changes.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2026-04-06 10:34:56 -05:00
Valerio Setti
5352976d61 doc: migration-guide|release-notes: Mbed TLS bump to v4.1
Add notes related to PRs:
- 104031
- 106089
- 106258
- 106478

Signed-off-by: Valerio Setti <vsetti@baylibre.com>
2026-04-06 10:31:40 -05: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
Guillaume Gautier
582d237f47 doc: releases: update migration guide for STM32 SPI pin slew-rate
Update migration guide to include the change of slew-rate for the STM32
SPI pins.

Signed-off-by: Guillaume Gautier <guillaume.gautier-ext@st.com>
2026-04-02 08:50:13 -05:00
Benjamin Cabé
5eaf23d723 doc: _scripts: gen_devicetree_rest.py: sort binding types alphabetically
Fix alphabetically sorting for binding types as it was previously
putting abbreviation (for which "raw" text started with ':abbr:...') as
first in the list.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-04-02 08:48:04 -05:00
Bhavin Umatiya
df1d9dbe53 doc: ieee802154: add exhaustive in-tree radio drivers overview
Add a new 'Supported Drivers' section to the IEEE 802.15.4
documentation listing all in-tree radio drivers with their vendor,
frequency band, bus interface, and Kconfig option.

The table covers all 14 drivers currently present in
drivers/ieee802154/CMakeLists.txt:
- TI: CC1200, CC13xx/CC26xx (2.4 GHz and Sub-GHz), CC2520
- Decawave (Qorvo): DW1000
- Espressif: ESP32
- NXP: KW41Z, MCR20A, MCXW
- Nordic Semiconductor: nRF5
- Atmel (Microchip): RF2XX
- STMicroelectronics: STM32WBA
- Telink Semiconductor: B91
- Virtual: UART Pipe (QEMU)

Fixes: #25663

Signed-off-by: Bhavin Umatiya <umatiyabhavin@gmail.com>
2026-04-02 08:44:45 -05:00
Benjamin Cabé
09136665f9 doc: releases: drop new driver mentions appearing in the wrong section
Drop a few mentions to new drivers appearing in an inappropriate section.
There is a dedicated "New Drivers" section for new drivers :)

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-04-02 08:43:10 -05:00
Benjamin Cabé
c9d4e4edf5 doc: releases: update list of boards/shields/samples/bindings added in 4.4
This commit updates the list of boards, shields, samples, and bindings
added in Zephyr 4.4, aiming for completeness now that project has entered
the feature freeze phase.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-04-02 08:43:10 -05:00
Nikhil Namjoshi
3bf912faff doc: Add info on net_pkt thread safety
At the moment, the documentation is not explicitly clear
on the thread safety of the net packets. So we need to make
it clear that the packet handling will always be done by
a single thread.

Signed-off-by: Nikhil Namjoshi <nikhilnamjoshi@google.com>
2026-04-01 11:54:09 -05:00
Benjamin Cabé
a40896a8be doc: requirements: refresh pinned requirements.txt to get latest pygments
Pygments latest release ships with multiple fixes in the Devicetree lexer
that we want to be able to use.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-04-01 11:53:29 -05:00
James Bennion-Pedley
278f199825 docs: migration: add note for renamed WCH SOC family
Adds note for unified renaming in CH32 series

Signed-off-by: James Bennion-Pedley <james@bojit.org>
2026-04-01 11:50:22 -05:00
Trond F. Christiansen
58a8c2793b doc: releases: Add release notes for Zbus proxy agent to 4.4
Added release notes for the Zbus proxy agent to the 4.4 release notes.

Signed-off-by: Trond F. Christiansen <trond.christiansen@nordicsemi.no>
2026-04-01 11:49:39 -05:00
Adrian Bieri
77517213c2 version: add extraversion in version.h
This commit adds EXTRAVERSION to code through version.h.
This aligns the symbols available in code with those available
in the VERSION file.

Signed-off-by: Adrian Bieri <adrian.bieri@loepfe.com>
2026-04-01 09:12:15 -05:00
Benjamin Cabé
dfaa055de8 doc: develop: update MCUXpresso Installer link in host-tools documentation
The previous link is now redirecting to
https://mcuxpresso.nxp.com/mcux-vscode/latest/html/MCUXpresso-Installer.html
so we might as well use that one directly :)

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-03-31 14:01:23 -05:00
Paulo Santos
ca7230d8ca doc: develop: manifests: external: fix zview cfg block
Fix identation of the cfg block for ZView docs.

Signed-off-by: Paulo Santos <pauloxrms@gmail.com>
2026-03-31 13:57:40 -05:00
Benjamin Cabé
e893b8be06 doc: releases: add Zephyr 4.4 release highlights
Complete the section about major highlights for Zephyr 4.4.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-03-31 13:57:20 -05:00