Commit Graph

7119 Commits

Author SHA1 Message Date
Florian Grandel
247ce6cbe2 doc: build: kconfig: preprocessor: remove obsolete entry
The entry listed in the docs does not exist. The correct entry
(dt_compat_enabled) is present.

Fixes #79081

Signed-off-by: Florian Grandel <fgrandel@code-for-humans.de>
2024-09-28 08:14:45 -05:00
Jeppe Odgaard
6bca0347df doc: mcumgr: Use SPDX license list short identifier
Fix license notation inconsistency in the MCUmgr tools/libraries table.

Signed-off-by: Jeppe Odgaard <jeppe.odgaard@prevas.dk>
2024-09-27 10:56:36 +01:00
Jeppe Odgaard
a8859e7f87 doc: mcumgr: Fix license
mcumgr-client is Apache-2 and not BSD licensed. See:
https://github.com/vouch-opensource/mcumgr-client/blob/main/LICENSE

Signed-off-by: Jeppe Odgaard <jeppe.odgaard@prevas.dk>
2024-09-27 10:56:36 +01:00
Jamie McCrae
2485102606 doc: release: 4.0: Add note on new MCUmgr img mgmt slot info
Adds information on the new img mgmt slot info command

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2024-09-26 17:48:05 -04:00
Jamie McCrae
82d3400a1c doc: services: device_mgmt: smp: Add img mgmt slot info docs
Adds documentation describing the new slot info command

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2024-09-26 17:48:05 -04:00
Babak Arisian
c0cfe49a54 Bluetooth: BASS: Add support for dynamic registration of BASS
Added support for dynamic registration and unregistration of the
Broadcast Audio Scan Service (BASS) within the scan delegator.
This enables both scan delegator and BASS to be registered or
unregistered dynamically at runtime.

Signed-off-by: Babak Arisian <bbaa@demant.com>
2024-09-26 17:42:39 -04:00
Fin Maaß
38fb12f5ac doc: releases: mention change of kernel reboot
mention change of `kernel reboot` shell command.

Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>
2024-09-26 17:42:20 -04:00
Benjamin Cabé
c487259241 doc: extensions: samples: Add "browse source code" button
One of the first thing one wants to do when reading about a code sample
is checking the code itself. This commit adds a button to directly take
the user to the code sample' source code on GitHub.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-26 17:40:42 -04:00
Jordan Yates
cd03667a5d modules: tfm: split security counter from version
By default, TFM enables hardware rollback protection, which requires a
security counter to be embedded in the image trailer. The default
behaviour of constructing this counter from the image version breaks the
TFM `boot_nv_security_counter_update` implementation once the version
number is greater than `0.0.1024`. As such, explicitly specify the
desired security counter value. As per the MCUboot docs, this does not
need to be incremented on every firmware update.

Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-09-26 03:34:42 -04:00
Simon Hein
e401b80b61 doc: safety: Extend safety overview with IEC 61508 infomation
Extend the safety overview with information about the IEC 61508 standard
and why it was chosen for zephyr.
Add a new diagram which shows relations between the IEC 61508
and other standards.

Signed-off-by: Simon Hein <Shein@baumer.com>
2024-09-26 03:34:06 -04:00
Arrel Neumiller
703eadde5c Doc: Contribute: Add instructions for GitHub profile name and email
Fixes 78713
Add instructions to the "Git Setup" section to ensure that the user's
GitHub profile name is their full name (first and last) and that the
GitHub profile name and email address match the git config user.name
and user.email.

Page: contribute/guidelines
Tested with:
ninja html
python3 -m http.server 8000

Signed-off-by: Arrel Neumiller <rlneumiller@gmail.com>
2024-09-26 03:32:40 -04:00
Emil Gydesen
fff3ff02c5 Bluetooth: CSIP: Add bonding requirement for set lock/release
The CSIP spec states that the procedures shall only be done
on bonded devices, so a check for that was added.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-09-26 03:31:47 -04:00
Krzysztof Chruściński
3a4c5a9ebc doc: releases: Add not about CONFIG_UART_n_GPIO_MANAGEMENT removal
Add note that those Kconfig options were removed from Nordic UART driver
configuration.

Signed-off-by: Krzysztof Chruściński <krzysztof.chruscinski@nordicsemi.no>
2024-09-26 03:31:39 -04:00
Jordan Yates
fd58374663 doc: get output folder from environment
Pull the output build folder from the environment, instead of hardcoding
the HTML output folder, which is wrong for the latex build.

Signed-off-by: Jordan Yates <jordan@embeint.com>
2024-09-25 13:49:34 -05:00
Benedikt Schmidt
fe3287a9ac scripts: dts: extract pickled EDT generation
Separate the pickled EDT generation from the C-Macro header
generation in gen_defines.py to have a more clear responsibility
of the scripts in the DTS parsing process.

Signed-off-by: Benedikt Schmidt <benedikt.schmidt@embedded-solutions.at>
2024-09-25 13:46:32 -05:00
Ioannis Damigos
ea50b18e37 doc: twister: Document binaries keyword under testing
Document binaries keyword under testing keyword
in board's yaml.

Signed-off-by: Ioannis Damigos <ioannis.damigos.uj@renesas.com>
2024-09-23 18:06:39 -04:00
Gerard Marull-Paretas
bdad3fd17a doc: extensions: link-roles: missing module not critical
External projects building the documentation may not clone all modules, as
they have manifest filtering. Therefore, not having access to a module
should not produce a fatal documentation build error. Convert the error to
a debug log, so it is at least traced.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
2024-09-23 13:20:41 -05:00
Matt Rodgers
93356447ad doc: http_server: Document response_ctx used for dynamic resources
Update documentation to describe the method of returning response data
to the HTTP server using the response_ctx callback parameter.

Signed-off-by: Matt Rodgers <mrodgers@witekio.com>
2024-09-23 12:00:54 +02:00
Benjamin Cabé
1db9b009a7 doc: samples: Adopt code-sample-category across tree
This commit uses the new .. zephyr:code-sample-category directive to
categorize code samples across the tree.
Updates existing legacy references to manually defined targets to now
use :zephyr:code-sample-category: role instead.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-23 12:00:00 +02:00
Benjamin Cabé
793c70d095 doc: extensions: samples: Introduce code sample categories
This commit adds support for categorizing code samples in the
documentation.

It introduces two new directives:

- `zephyr:code-sample-category::` to create a category and associated
  brief description, that implicitly acts as a toctree too.

- `zephyr:code-sample-listing::` to allow dumping a list of samples
  corresponding to a category anywhere in the documentation.

Fixes #62453.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-23 12:00:00 +02:00
Benjamin Cabé
3d7bb30103 doc: extensions: move Zephyr domain extension to dedicated package
move domain.py to domain/ to make it easier to keep things organized
and e.g. add dedicated css/js resources, etc.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-23 12:00:00 +02:00
Emil Gydesen
7ef2f81413 Bluetooth: Audio: Add helpers for assisted listening stream
Added helper functions to set and get assisted listening
stream values for codec capabilities and codec configs.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-09-23 10:03:47 +02:00
Daniel Flodin
746c59c82a arch: kernel: lib: toolchain: Standardize TLS keyword
Up until now, the `__thread` keyword has been used for declaring
variables as Thread local storage. However, `__thread` is a GNU
specific keyword which thus limits compatibility with other
toolchains (for instance IAR).

This PR intoduces a new macro `Z_THREAD_LOCAL` which expands to the
corresponding C11, C23 or C++11 standard keyword based on the standard
that is specified during compilation, else it uses the old `__thread`
keyword.

Signed-off-by: Daniel Flodin <daniel.flodin@iar.com>
2024-09-23 10:01:48 +02:00
Stefan Gloor
1d8c3c013b doc: update MIPI DBI API compatibility
The MIPI DBI API supports MIPI DBI controllers type A, B, and C
(except with 16 write clocks). Update the documentation accordingly.

Signed-off-by: Stefan Gloor <code@stefan-gloor.ch>
2024-09-20 11:56:22 -05:00
Declan Snyder
f8a4a2ff5c doc: dts: Link Linux binding guidelines.
The Linux binding DO's and DONT's about designing DT bindings
pretty much all apply to Zephyr as well, and a lot of these issues
come up in reviews in Zephyr, which is the reason that Linux has
this page in the first place, to list common binding review topics.

Signed-off-by: Declan Snyder <declan.snyder@nxp.com>
2024-09-20 11:52:34 -05:00
Gerard Marull-Paretas
4b2c030ec4 doc: releases: migration-guide: add nRF53 L|HFXO changes
Infom users about Kconfig options deprecation, and provide code snippets
on what they have to do now.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
2024-09-20 11:08:39 +02:00
Emil Gydesen
82700b8b88 Bluetooth: Audio: Fix bad/missing groups for LE Audio APIs
Add or fix the groups for the public APIs for LE Audio.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-09-20 11:08:07 +02:00
Yong Cong Sin
b55f3c1c4f kernel: remove CONFIG_MP_NUM_CPUS
`CONFIG_MP_NUM_CPUS` has been deprecated for more than 2
releases, it's time to remove it.

Updated all usage of `CONFIG_MP_NUM_CPUS` to
`CONFIG_MP_MAX_NUM_CPUS`

Signed-off-by: Yong Cong Sin <ycsin@meta.com>
Signed-off-by: Yong Cong Sin <yongcong.sin@gmail.com>
2024-09-19 18:28:37 +01:00
Kamil Piszczek
8c0bc54ab0 mgmt: mcumgr: transport: bluetooth: add all gatt permission levels
Added new Kconfigs for defining permission level of GATT
characteristics that are part of the Bluetooth SMP service in the
MCUmgr subsys.

Removed the CONFIG_MCUMGR_TRANSPORT_BT_AUTHEN as the new Kconfig
options are mutually exclusive and need to be groupa as the Kconfig
choice option.

Signed-off-by: Kamil Piszczek <Kamil.Piszczek@nordicsemi.no>
2024-09-19 15:13:19 +02:00
Balaji Kulkarni
beb733919d docs: i3c: fix incorrect detail for SETDASA I3C CCC usage
Fix the recommended usage for SETDASA I3C CCC

Signed-off-by: Balaji Kulkarni <quic_bkulkarn@quicinc.com>
2024-09-19 03:53:17 -04:00
Arkadiusz Cholewinski
9d9089edd0 ztest: Add Support for Multiple Test Runs.
Introduces new kconfig options to enable multiple test runs in the ztest.

Signed-off-by: Arkadiusz Cholewinski <arkadiuszx.cholewinski@intel.com>
2024-09-18 15:32:28 +02:00
Benjamin Cabé
47a7da9e9f doc: Overhaul doc guidelines
- Improved document structure (was *very* flat before) by adding more
  meaningful top-level headings and re-ordering some of the existing
  sections
- Provide detailed and structured docs for all the custom Sphinx roles
  and directives available in Zephyr, including moving the docs for
  ``.. zephyr-app-commands`` directive and `:dtcompatible:` roles away
  from the extensions' source files to align with how Sphinx typically
  handles docs for custom roles/directives.
- Added more content regarding diagrams guidelines, images,
  cross-referencing of Doxygen documentation, ...

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-18 15:31:39 +02:00
Benjamin Cabé
145dbf820d doc: Increase navigation depth in side nav bar
Increase navigation depth by 1 to enable "local" toc navigation in the
side bar for those pages that are deeper in the documentation tree.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-09-18 15:31:39 +02:00
Henrik Brix Andersen
b63af21235 doc: develop: manifests: external: add CANnectivity USB to CAN adapter
Add a reference to the CANnectivity USB to CAN adapter firmware as an
external module.

Signed-off-by: Henrik Brix Andersen <henrik@brixandersen.dk>
2024-09-18 15:30:16 +02:00
Yong Cong Sin
119b238594 doc: release: 4.0: add missing colon
Add missing colon to the entry introduced in #78285.

Signed-off-by: Yong Cong Sin <ycsin@meta.com>
Signed-off-by: Yong Cong Sin <yongcong.sin@gmail.com>
2024-09-18 11:03:18 +02:00
Flavio Ceolin
d9bdb4af20 doc: security: Disclose CVE-2024-6259
Disclose information about published CVE.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-09-17 20:11:12 -04:00
Flavio Ceolin
d8df6abd69 doc: security: Disclose CVE-2024-6137
Disclose information about published CVE.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-09-17 20:11:12 -04:00
Flavio Ceolin
a4dcb8d259 doc: security: Disclose CVE-2024-6135
Disclose information about published CVE.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-09-17 20:11:12 -04:00
Flavio Ceolin
38db894cd9 doc: security: Disclose CVE-2024-5931
Disclose information about published CVE.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-09-17 20:11:12 -04:00
Flavio Ceolin
2f5b9577de doc: security: Disclose CVE-2024-6258
Disclose information about published CVE.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-09-17 20:11:12 -04:00
Flavio Ceolin
1142f95c8c doc: security: Disclose CVE-2024-5754
Disclose information about published CVE.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-09-17 20:11:12 -04:00
Flavio Ceolin
311b7ac3ec doc: security: Add CVE under embargo
Add an entry to CVE-2024-8798

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-09-17 20:11:12 -04:00
Flavio Ceolin
a6f57960cd doc: relnotes/4.0: Add info about CVE-2024-8798
Information about CVE-2024-8798 in release notes.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-09-17 20:11:12 -04:00
Arrel Neumiller
9bba5141f5 doc: i2c, i3c: remove unnecessary preposition 'in'
This commit removes the preposition "in" from the phrase
"in particularly"in the I2C and I3C Controller API sections
to improve readability.

Signed-off-by: Arrel Neumiller <rlneumiller@gmail.com>
2024-09-17 20:07:09 -04:00
Fabio Baltieri
f7c0a643df kscan: mark the kscan driver class as deprecated
All kscan drivers have been moved over to input, Mark the kscan driver
class as deprecated so it can be removed in the 4.2 release.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2024-09-17 14:52:50 -04:00
Jamie McCrae
c41d88740a doc: release: 4.0: Add note on new MCUmgr bootloader info hook
Adds a note on this newly added hook

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2024-09-17 17:45:04 +01:00
Anas Nashif
ac808d13dc doc: kernel: define additional doxygen groups
Some groups are used by multiple files/tests, define them globally in
doc/

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-09-17 05:24:09 -04:00
Stine Åkredalen
e1232a45e2 docs: Bluetooth: Mesh: add Subnet Bridge doc
Added high-level documentation for Subnet Bridge,
connecting models together and explaining usage.

Signed-off-by: Stine Åkredalen <stine.akredalen@nordicsemi.no>
2024-09-17 05:22:32 -04:00
Omkar Kulkarni
8210d2da1b Bluetooth: Mesh: Populate Bridge Config Server
Adds implementation for the Bridge Configuration Server model.

Updates `brg_cfg` module to add sanity check for
bt_mesh_brg_cfg_tbl_remove() API. Also, updates the unit test
accordingly.

Adds documentation for the Bridge Configuration Server model

Signed-off-by: Omkar Kulkarni <omkar.kulkarni@nordicsemi.no>
2024-09-17 05:22:32 -04:00
Håvard Reierstad
50a4c2d17a Bluetooth: Mesh: Add brg_cfg_cli commands to shell
Adds the Bridge Configuration Client commands to Mesh shell.

Unifies documentation for shell Kconfig options.

Signed-off-by: Håvard Reierstad <haavard.reierstad@nordicsemi.no>
2024-09-17 05:22:32 -04:00