Commit Graph

250 Commits

Author SHA1 Message Date
Philipp Steiner
f5b201e0d6 doc: fuel_gauge: upate api documentation
removes outdated description and adds missing api call.

Signed-off-by: Philipp Steiner <philipp.steiner1987@gmail.com>
2025-06-17 16:27:51 -05:00
Jamie McCrae
47abade244 doc: hardware: porting: board_porting: Update example
Updates an example with newer settings

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-06-13 10:10:48 +02:00
Jamie McCrae
f8717d756b doc: hardware: porting: soc_porting: Fix cluster typo
Fixes 2 minor issues in the documentation

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2025-06-10 08:48:13 +02:00
Mathieu Choplain
8bc3a14c05 doc: board_porting: fix minor typo
Correct a minor typo in the hardware/porting/board_porting documentation
page.

Signed-off-by: Mathieu Choplain <mathieu.choplain@st.com>
2025-06-03 13:51:46 +02:00
Jakub Michalski
43b3781f93 docs: virtio: add virtio docs
This commit adds virtio section in documentation, describing
virtio-related concepts

Signed-off-by: Jakub Michalski <jmichalski@antmicro.com>
Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
2025-06-02 17:37:07 +02:00
Sudan Landge
5ab74ff1de doc: arm: cortex_m: Update PACBTI support
Update PACBTI support for architecture variants in the features table
and add a new section introducing PACBTI support/limitations.

Signed-off-by: Sudan Landge <sudan.landge@arm.com>
2025-05-31 06:55:18 -04:00
Sudan Landge
c6d1932b17 doc: arm: cortex_m: Update feature table
Add Cortex-M85 under the Arm v8.1-M architecture variant column.
Cortex-M85 shares feature support with Cortex-M55, including Privileged
Execute Never (PXN), and additionally introduces Pointer Authentication
and Branch Target Identification (PACBTI) extensions.

Signed-off-by: Sudan Landge <sudan.landge@arm.com>
2025-05-31 06:55:18 -04:00
Benjamin Cabé
804915841a shields: doc: allow to indicate supported hw features
Shield authors can now indicate an optional list of hardware features
that the shield supports, in the form of the same kind of "binding type"
already used for boards.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-05-28 15:33:50 +02:00
Sudan Landge
b853f01010 doc: Update on switch to CMSIS_6
Add a note to announce the switch to CMSIS_6 for Cortex-M arch.

Signed-off-by: Sudan Landge <sudan.landge@arm.com>
2025-05-23 17:40:55 -04:00
Benjamin Cabé
79e3ecb7a9 doc: boards: catalog: add shields to board catalog
Populate board catalog with shields as well and have them show up in the
boards/index page.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-05-23 17:19:58 +02:00
Benjamin Cabé
3a62b17b85 cmake: shields: introduce shield.yml
While legacy shields are still supported, this introduces a shield.yml
file similar to board.yml that allows to more explicitly declare a
shield and to set some useful metadata such as vendor and full name.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-05-23 17:19:58 +02:00
Benjamin Cabé
0c82c3516f Revert "cmake: shields: introduce shield.yml"
This reverts commit 9d5b19710b.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-05-21 09:30:30 +02:00
Benjamin Cabé
928472b4c7 Revert "doc: boards: catalog: add shields to board catalog"
This reverts commit 11fea40a40.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-05-21 09:30:30 +02:00
Benjamin Cabé
11fea40a40 doc: boards: catalog: add shields to board catalog
Populate board catalog with shields as well and have them show up in the
boards/index page.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-05-20 15:23:34 +02:00
Benjamin Cabé
9d5b19710b cmake: shields: introduce shield.yml
While legacy shields are still supported, this introduces a shield.yml
file similar to board.yml that allows to more explicitly declare a
shield and to set some useful metadata such as vendor and full name.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-05-20 15:23:34 +02:00
Paul Schaetzle
9b1969a206 doc: dts: explain the usage of pre_dt_shield.cmake
Mention the possible use of pre_dt_shield.cmake in the devicetree and
shield documentation.

Signed-off-by: Paul Schaetzle <paulschaetzle@mailbox.org>
2025-05-20 12:47:00 +02:00
Bjarki Arge Andreasen
9b4cd8a089 doc: rtc: add device driver design section
Add section describing how to write RTC device drivers. This should
help ensure consistent RTC behavior across system reboots.

Signed-off-by: Bjarki Arge Andreasen <bjarki.andreasen@nordicsemi.no>
2025-04-25 14:03:45 +02:00
Bjarki Arge Andreasen
76453e5b73 doc: rtc: move down "History of RTCs in Zephyr" section
Move down the "History of RTCs in Zephyr" which is least relevant,
especially now that the RTC API is well established.

Signed-off-by: Bjarki Arge Andreasen <bjarki.andreasen@nordicsemi.no>
2025-04-25 14:03:45 +02:00
Anas Nashif
9aba1323ce doc: cache: fix cache doc structure
Wrong levels and cache topic appearing in the wrong table of contents.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2025-04-24 11:57:36 +02:00
Anas Nashif
a07b6563a8 doc: semihosting: fix section level
Wrong section level makes this section appear in the wrong table of
contents.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2025-04-23 17:54:47 +02:00
Egill Sigurdur
6d710a21cb doc: Make SD card peripheral docs more generic, fix one acronym
Fixes an issue in which "SDHC" had been incorrectly expanded to
"Secure Digital High Capacity" instead of "SD Host Controller".

Since this page is listed under "Peripherals" and since the
SD Host Controller API is not supposed to be used by applications,
the more generic and recognizable title "SD card interface" is used,
and users are pointed to pages relevant to them (disk access API
and SD card subsystem).

Signed-off-by: Egill Sigurdur <egill@egill.xyz>
2025-04-22 16:53:05 +02:00
Qiang Zhao
c412ee4597 drivers: firmware: scmi: add cpu domain protocol
Added helpers for NXP SCMI cpu dmomain protocol.

Signed-off-by: Qiang Zhao <qiang.zhao@nxp.com>
2025-04-21 22:03:27 +02:00
Peter Mitsis
9416ef2684 doc: Update context switching for arch porting
Updates the context switching documentation for arch porting
to reflect the current state.

Signed-off-by: Peter Mitsis <peter.mitsis@intel.com>
2025-04-16 01:10:15 +02:00
Peter Mitsis
0a9019f09a doc: Remove stale reference to _IntExit
_IntExit() no longer exists.

Signed-off-by: Peter Mitsis <peter.mitsis@intel.com>
2025-04-16 01:10:15 +02:00
Peter Mitsis
4131e9bcf3 doc: Replace references to _Swap with z_swap
_Swap() is obsolete. Replace references to it with z_swap().

Signed-off-by: Peter Mitsis <peter.mitsis@intel.com>
2025-04-16 01:10:15 +02:00
Jilay Pandya
b53937239f doc: stepper: add information about stepper test suite
Add brief information about how stepper api test suites could be used

Signed-off-by: Jilay Pandya <jilay.pandya@outlook.com>
2025-04-08 11:45:40 +02:00
Jilay Pandya
6bfea730b1 doc: migration-guide: 4.2: add migration guide entry for enable
- Add migration guide entry for enable->enable/disable function
- Add stepper_disable to stepper.rst

Signed-off-by: Jilay Pandya <jilay.pandya@outlook.com>
2025-04-03 00:03:29 +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
Ryan McClelland
9628d97ad9 drivers: i3c: remove group addr definition
The i3c group address support is rather very incomplete here. Remove
references to it. This could all easily come back when/if group support
comes in.

Signed-off-by: Ryan McClelland <ryanmcclelland@meta.com>
2025-03-26 00:47:00 +01:00
Sudan Landge
d7c629696d arch: arm: Add PXN support for Armv8.1-M
What is the change?
This commit adds support for Armv8.1-M MPU architecture's PXN attribute.
This includes support for configuring MPU regions with PXN via
custom mpu_config, devicetree and static mpu_config.
The existing MPU region attribute macros are updated to retain existing
behaviour with this change with an addition of REGION_RAM_ATTR_PXN to be
used if one needs to configure a RAM region with PXN MPU attribute.

Why do we need this change?
Armv8.1-M architecture introduced a new MPU region attribute called
Privilege eXecute Never (PXN).
If an MPU region is configured with the PXN attribute set and if the,
processor attempts to execute code in this region while at
privileged level, a Memory Management Fault exception is triggered.

This ensures that specific tasks are executed only in unprivileged mode
and helps in preventing secure privilege escalation attacks.

Signed-off-by: Sudan Landge <sudan.landge@arm.com>
2025-03-20 12:17:11 +01: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
Carles Cufi
9fc84e78e7 boards: nrf: Default to nRF Util for flashing
Nordic has a new tool, nRF Util (`nrfutil`) which is replacing the
previous set of command-line tools (particularly `nrfjprog`) that Zephyr
had been using by default in many of the boards to flash the firmware
onto the device.

Since nRF Util is already mature and is going to be replacing the existing
tools, including `nrfjprog`, it is now a good time to change the default
flash tool to reflect this fact.

Note that `nrfjprog` support is not being removed at all, but this may
be a breaking change for users that do not have nRF Util installed. For
this reason we also add a note in the migration guide.

More info:
https://devzone.nordicsemi.com/nordic/nordic-blog/b/blog/posts/nrf-util-unified-command-line-utility

Installation:
https://www.nordicsemi.com/Products/Development-tools/nrf-util

Documentation:
https://docs.nordicsemi.com/bundle/nrfutil/page/README.html

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2025-03-10 21:31:43 +01:00
Benjamin Cabé
66a3c6c9ef doc: adopt allowlist/blocklist terminology
Fixed a few occurrences of non-inclusive language.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2025-02-19 18:48:15 +01:00
Shan Pen
6584862897 doc: fixes minor typo in ../sensor/triggers.rst
not sure "micro controller" is a typo.
Happy to update it if needed,
or feel free to close this. Thanks for your work!

Signed-off-by: Shan Pen <bricle031@gmail.com>
2025-02-14 03:04:11 +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
Filip Kokosinski
83f3fafde9 doc/hardware/arch/risc-v: update SMP documentation
This commit updates the SMP section documentation so that it reflects the
current status of SMP support in Zephyr for RISC-V, including pointing to
hardware-based platforms that as of date support SMP.

Signed-off-by: Filip Kokosinski <fkokosinski@antmicro.com>
2025-02-07 17:46:43 +01:00
Jilay Pandya
8272b36b5b drivers: stepper: tmc50xx: extend tmc5041 to tmc50xx
Extend tmc5041 to tmc50xx in order to accomodate tmc5072

Signed-off-by: Jilay Pandya <jilay.pandya@outlook.com>
2025-02-05 01:14:47 +01:00
Yangbo Lu
7c57fec0d0 drivers: firmware: scmi: add power domain protocol
Added helpers for ARM SCMI power dmomain protocol.

Signed-off-by: Yangbo Lu <yangbo.lu@nxp.com>
2025-01-15 19:03:00 +01:00
Fabian Blatz
dfaca867ca doc: hardware: peripherals: stepper: Migrate to step interval API
Migrates the peripherals documentation to the new step interval based APi
instead of the velocity one.

Signed-off-by: Fabian Blatz <fabianblatz@gmail.com>
2025-01-15 15:06:37 +01:00
Johann Fischer
59a7b972a2 doc: porting: add note about CDC ACM UART configuration
Clarify how to configure serial output for the console for the two most
common cases. Follow up on commit 0cae816b27
("boards: add common configuration for CDC ACM UART")

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2024-12-20 12:36:31 +01:00
Valerio Setti
dbbdd212f1 Revert "doc: updates concerning ENTROPY_GENRATOR auto-enabling"
This reverts commit a43cae0b3e40681def6f4a3385fe27e5c0e7ea6c.

Signed-off-by: Valerio Setti <vsetti@baylibre.com>
2024-12-12 00:15:39 +00: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
Valerio Setti
35324319b9 doc: updates concerning ENTROPY_GENRATOR auto-enabling
Update the migration-guide to inform the users that now
CONFIG_ENTROPY_GENERATOR is automatically enabled as soon as
devicetree property "zephyr,entropy" is set.

Update also the "General recommendations" section of the Board Porting
Guide on the same topic.

Signed-off-by: Valerio Setti <vsetti@baylibre.com>
2024-12-10 08:05:33 +01:00
Jilay Pandya
030444822e drivers: stepper: api: rename stepper_set_target_pos to stepper_move_to
rename stepper_set_target_position to stepper_move_to in following files:
- doc/hardware/peripherals/stepper.rst
- doc/releases/migration-guide-4.1.rst
- drivers/stepper/adi_tmc/adi_tmc5041_stepper_controller.c
- drivers/stepper/fake_stepper_controller.c
- drivers/stepper/gpio_stepper_controller.c
- drivers/stepper/stepper_shell.c
- include/zephyr/drivers/stepper.h
- include/zephyr/drivers/stepper/stepper_fake.h
- tests/drivers/stepper/shell/src/main.c
- tests/drivers/stepper/stepper_api/src/main.c

Signed-off-by: Jilay Pandya <jilay.pandya@outlook.com>
2024-12-06 22:21:44 +01:00
Jilay Pandya
05e94ed234 drivers: stepper: api: rename stepper_move to stepper_move_by
rename stepper_move to stepper_move_by in following files:
- include/zephyr/drivers/stepper.h
- include/zephyr/drivers/stepper/stepper_fake.h
- doc/hardware/peripherals/stepper.rst
- doc/releases/migration-guide-4.1.rst
- drivers/stepper/adi_tmc/adi_tmc5041_stepper_controller.c
- drivers/stepper/fake_stepper_controller.c
- drivers/stepper/gpio_stepper_controller.c
- drivers/stepper/stepper_shell.c
- tests/drivers/stepper/shell/src/main.c

Signed-off-by: Jilay Pandya <jilay.pandya@outlook.com>
2024-12-06 22:21:44 +01:00
Jilay Pandya
af68d97507 drivers: stepper: api: rename enable_constant_velocity_mode to run
rename enable_constant_velocity_mode to run in following files:
- include/zephyr/drivers/stepper.h
- include/zephyr/drivers/stepper/stepper_fake.h
- doc/hardware/peripherals/stepper.rst
- doc/releases/migration-guide-4.1.rst
- drivers/stepper/adi_tmc/adi_tmc5041_stepper_controller.c
- drivers/stepper/fake_stepper_controller.c
- drivers/stepper/gpio_stepper_controller.c
- drivers/stepper/stepper_shell.c
- tests/drivers/stepper/shell/src/main.c

Signed-off-by: Jilay Pandya <jilay.pandya@outlook.com>
2024-12-04 09:24:05 +01:00
Jilay Pandya
719cd2639c drivers: stepper: refactor set_actual_position to set_reference_position
This commit refactos set_actual_position to set_reference_position.
stepper_set_reference_position is more apt in regards to what this func
actually does

Signed-off-by: Jilay Pandya <jilay.pandya@outlook.com>
2024-11-27 10:29:47 +01:00
Jilay Pandya
195c2c1360 drivers: stepper: fix stepper_set_event_callback c prototype and definition
This commit fixes incorrect c prototype and defintion of
stepper_set_callback to stepper_set_event_callback

Signed-off-by: Jilay Pandya <jilay.pandya@outlook.com>
2024-11-18 19:37:37 -05:00
Jilay Pandya
843625a29b drivers: stepper: change gpio-stepper dt-compatible
This commit changes compatible of gpio-stepper in driver

Signed-off-by: Jilay Pandya <jilay.pandya@outlook.com>
2024-11-18 19:37:37 -05:00
Reto Schneider
057528b894 docs: dma: Fix typo and grammar
This fixes the spelling of the word expected, ads a missing comma.

Signed-off-by: Reto Schneider <reto.schneider@husqvarnagroup.com>
2024-11-18 19:31:10 -05:00