Commit graph

5380 commits

Author SHA1 Message Date
Anders Storrø 51707daade doc: Bluetooth: Mesh: Fix comp data doc entries
Minor cleanup of the mesh composition data pages
documentation.

Signed-off-by: Anders Storrø <anders.storro@nordicsemi.no>
2023-09-09 12:16:05 +03:00
Keith Packard 28e6839db6 doc/releases: Add picolibc migration notes
There aren't any 'required' or 'recommended' changes when switching from
the minimal C library to picolibc, but there are a bunch of things which
application developers might need to be aware of. Add a separate section to
list those.

Signed-off-by: Keith Packard <keithp@keithp.com>
2023-09-08 19:07:37 +02:00
Anders Storrø 81c6ae8908 doc: Bluetooth: Mesh: Add docs for comp data pages
Adds documentation for all supported composition data pages.

Signed-off-by: Anders Storrø <anders.storro@nordicsemi.no>
2023-09-08 14:44:25 +02:00
Benjamin Cabé c26679be42 samples: net: cloud: drop Google Cloud IoT Core
Google Cloud IoT Core has been retired on August 16, 2023.
Removed the sample and the link to it in a previous release note.
Added a redirect to other IoT cloud samples.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-08 11:04:25 +02:00
Ricardo Rivera-Matos a627035290 charger: Adds basic stub API doc
Adds a short stub doc as a placeholder for future documentation in the
charger API.

Signed-off-by: Ricardo Rivera-Matos <rriveram@opensource.cirrus.com>
2023-09-07 13:03:13 -04:00
Michał Barnaś 9b2b964616 doc: add documenatation about I2C_DUMP_MESSAGES
Add the documentation about I2C_DUMP_MESSAGES and about the
I2C_DUMP_MESSAGES_FILTER in the develop/debug/index.rst doc file.

Signed-off-by: Michał Barnaś <mb@semihalf.com>
2023-09-06 17:54:53 +02:00
Michał Barnaś 8f01cb8147 doc: extract the documentation about debugging to another file
Move the chapters about Application Debugging and
Debugging using Eclipse to another file for easier search and
to allow more debugging chapters to be inserted here.

Signed-off-by: Michał Barnaś <mb@semihalf.com>
2023-09-06 17:54:53 +02:00
Michał Barnaś 528a14329a doc: fix missing and remove obsolete links
Fix text that should be linking to the URLs but was missing
the link reference and remove the obsolete links.

Signed-off-by: Michał Barnaś <mb@semihalf.com>
2023-09-06 17:54:53 +02:00
Jamie McCrae e6d5b3f9a6 doc: twister: Add details on required_snippets
Adds information on the new required_snippets feature

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-09-06 16:40:53 +02:00
Jamie McCrae 9509831e1d doc: release: 3.5: Add note on required_snippets twister addition
Adds a note that twister now supports applying snippets

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-09-06 16:40:53 +02:00
Andrei Hutanu 868450ce53 docs: develop: ztest: fix for ztest example build
the Test Framework example present in documentation does not work
out of the box and has to be slightly modified. This is an attempt
to fix the example so it would just work directly from documentation.

Signed-off-by: Andrei Hutanu <andrei.hutanu.i@gmail.com>
2023-09-06 15:18:37 +02:00
Keith Short abf26affe0 doc: Add instructions for installing Python dependencies
The Python dependencies specific to building the documentation were
recently removed from the common requirements. Point users to the
documentation generation instructions and provide details on installing
the doc specific dependencies.

Signed-off-by: Keith Short <keithshort@google.com>
2023-09-06 15:16:38 +02:00
Jamie McCrae 2f05af891d doc: services: device_mgmt: smp: Add SMP version 2 details
Adds SMP version 2 error response details to the documentation.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-09-06 13:05:40 +02:00
Benjamin Cabé b2977b7657 doc: Make code-samples admonition collapsible
Use sphinx-toggle to make "Related code samples" collapsible.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-06 12:11:28 +02:00
Benjamin Cabé e7829752ae doc: Update sample.tmpl with new directive
Update the sample.tmpl file so that it encourages people to use the new
:zephyr:code-sample: directive.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-06 12:11:28 +02:00
Benjamin Cabé 3c5f3da4d8 doc: Add Sphinx extension for code samples
This adds a new Sphinx extension for both a code-sample directive and role.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-09-06 12:11:28 +02:00
Yves Vandervennet 1477865a7a linkserver: doc: updates for NXP's mimxrt1170
This commit adds the documentation details for the linkserver support
on rt1170.

Signed-off-by: Yves Vandervennet <yves.vandervennet@nxp.com>
2023-09-06 09:35:24 +02:00
Johann Fischer ad498aa550 usb: device: hid: remove CONFIG_USB_HID_PROTOCOL_CODE
Kconfig option USB_HID_PROTOCOL_CODE, deprecated in v2.6,
is finally removed.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2023-09-05 16:16:56 +02:00
Grzegorz Swiderski a768a05e62 doc: sysbuild: Add documentation for image ordering
Add a brief subsection to explain `sysbuild_add_dependencies()`.

Signed-off-by: Grzegorz Swiderski <grzegorz.swiderski@nordicsemi.no>
2023-09-05 15:27:04 +02:00
Carles Cufi 8c748fd005 kernel: Modify the signature of k_mem_slab_free()
Modify the signature of the k_mem_slab_free() function with a new one,
replacing the old void **mem with void *mem as a parameter.

The following function:
void k_mem_slab_free(struct k_mem_slab *slab, void **mem);

has the wrong signature. mem is only used as a regular pointer, so there
is no need to use a double-pointer. The correct signature should be:
void k_mem_slab_free(struct k_mem_slab *slab, void *mem);

The issue with the current signature, although functional, is that it is
extremely confusing. I myself, a veteran Zephyr developer, was confused
by this parameter when looking at it recently.

All in-tree uses of the function have been adapted.

Fixes #61888.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2023-09-03 18:20:59 -04:00
Mykola Kvach c5619cd001 doc: release: 3.5: add notes about changes related to fs subsystem
Add support of mounting littlefs on the block device from the shell/fs.
Add alignment parameter to FS_LITTLEFS_DECLARE_CUSTOM_CONFIG macro.

Signed-off-by: Mykola Kvach <mykola_kvach@epam.com>
2023-09-01 17:44:15 +02:00
Johan Hedberg e3d5f5072f doc: redirects: Add redirects for renamed Intel boards
The ehl_crb and rpl_crb boards directories were renamed to intel_ehl and
intel_rpl respectively.

Signed-off-by: Johan Hedberg <johan.hedberg@intel.com>
2023-09-01 17:40:30 +02:00
Carles Cufi a7b0ce614a release: Introduce a migration guide
Instead of documenting API changes, deprecations, additions and
deletions in the main release notes, create a new specific document to
help users migrate from one release to another one.

This new document has only two sections:

- Required changes
- Recommended changes

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Co-authored-by: Benjamin Cabé <kartben@gmail.com>
2023-09-01 14:05:46 +02:00
Andrei Emeltchenko 8e0fc8095e doc: ivshmem: Simple syntax correction
Correct some trivial syntax issues in ivshmem.rst.

Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
2023-08-31 10:00:06 -04:00
Dominik Ermel 48795a00f5 doc/release/3.5: Add note on new MCUmgr Kconfig options
Note on addition of:
  CONFIG_MCUMGR_GRP_IMG_ALLOW_CONFIRM_NON_ACTIVE_IMAGE_SECONDARY
  CONFIG_MCUMGR_GRP_IMG_ALLOW_CONFIRM_NON_ACTIVE_IMAGE_ANY
  CONFIG_MCUMGR_GRP_IMG_ALLOW_ERASE_PENDING

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2023-08-31 10:19:15 +02:00
Georges Oates_Larsen 3b3f95223c net: conn_mgr: Mark as experimental in the API table
Mark conn_mgr as experimental in the API table, since it is currently
experimental.

Signed-off-by: Georges Oates_Larsen <georges.larsen@nordicsemi.no>
2023-08-29 16:13:37 +02:00
Rodrigo Peixoto 654aa9baa1 doc: zbus: adjust documentation to comply with iterable section observers
Add details of the new VDED sequence;
Change the function iterators documentation considering `user_data`;
Adjust the runtime observers' allocation information. Now it uses heap
instead of memory slabs;
Adjust the configuration list and details of it.

Signed-off-by: Rodrigo Peixoto <rodrigopex@gmail.com>
2023-08-29 10:18:55 +02:00
Iuliana Prodan 4cf9d67432 west: sign: do not make rimage configuration and platform name mandatory
Now, if the rimage target (meaning rimage configuration and platform name)
is not defined in board.cmake the sign script returns fatal error.
Change this to a warning since there are configurations that are
not using 'west sign' or is used just to glue the headers of the
final image.

Also, update the documentation accordingly.

Signed-off-by: Iuliana Prodan <iuliana.prodan@nxp.com>
Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2023-08-28 09:17:02 -07:00
Nick Ward 2d65acca3a drivers: gpio: use gpio_is_ready_dt helper function
Update `struct gpio_dt_spec` use with gpio_is_ready_dt()

Signed-off-by: Nick Ward <nix.ward@gmail.com>
2023-08-28 08:48:35 -05:00
Pavel Vasilyev 1630323de3 docs: bluetooth: mesh: Add missing space in od_srv.rst
This fixes rendering in od_srv.rst.

Signed-off-by: Pavel Vasilyev <pavel.vasilyev@nordicsemi.no>
2023-08-28 10:12:54 +02:00
Benjamin Cabé fc489739a1 doc: extensions: Clean-up and order imports
Remove unused imports + order.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-08-25 14:58:18 +02:00
Benjamin Cabé be962bec0a doc: extensions: Show Kconfig options in search
Show Kconfig options in search results, since that's how some people would
expect to be able to find more details about
them.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-08-25 14:58:18 +02:00
Jamie McCrae f5c25d3d65 doc: release: 3.5: Add note on MCUmgr settings management
Adds a note that settings management has been added to MCUmgr.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-08-25 10:54:06 +01:00
Jamie McCrae 09a2c7acaa doc: mgmt: mcumgr: Add settings management group documentation
Adds documentation for the new settings management MCUmgr group.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-08-25 10:54:06 +01:00
Fabio Baltieri bef540b178 doc: guidelines: add an item about avoiding binary literals
Add an item to the coding style list asking to avoid using binary
literals.

Link: https://github.com/zephyrproject-rtos/zephyr/issues/61798
Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-08-24 10:21:12 +02:00
Benjamin Cabé 69fcc52ce1 Revert "doc: Switch to using docleaf for doxygen entities"
This reverts commit 20986ec45d.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-08-24 09:19:37 +01:00
Benjamin Cabé 30b59483fb Revert "doc: Update requirements-doc.txt to use docleaf"
This reverts commit 30c3ce4a92.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-08-24 09:19:37 +01:00
Benjamin Cabé b667c2cd7e Revert "doc: Replace instances of 'Breathe' with 'Docleaf'"
This reverts commit 10cb87dc2b.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-08-24 09:19:37 +01:00
Benjamin Cabé 0e4ab8f083 Revert "doc: Adjust docleaf configuration as needed"
This reverts commit a3b7102273.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-08-24 09:19:37 +01:00
Benjamin Cabé c71d6af304 Revert "doc: Remove :members: on doxygengroup directives"
This reverts commit 88c1519414.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-08-24 09:19:37 +01:00
Diego Elio Pettenò 52426c284e doc: move puncover down on the page.
The puncover tool does not appear to be maintained anymore and it is
affected by multiple issues. Providing it as the first in the list
is a disservice to users as they might get frustrated and not notice
the `ram_report` tool that actually works.

Move the information at the bottom of the section, and add a warning
about the fact that this is a third party tool that might or might
not be working.

(Also make the link consistent to avoid "here" being a hyperlink, it
adds nothing to the reader either in RST or HTML.)

Signed-off-by: Diego Elio Pettenò <flameeyes@meta.com>
2023-08-23 18:01:06 +02:00
Pieter De Gendt 27f8c218cd cmake: sca: codechecker: Support storing results
Introduce CODECHECKER_STORE parameters to upload results to an active
CodeChecker server.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2023-08-23 14:45:03 +02:00
Pieter De Gendt 82b1c990de doc: develop: sca: Remove obsolete -s
Removed obsolete -s from west build example commands.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2023-08-23 14:45:03 +02:00
Andrej Butok 33c3052964 doc: tfm: Update TFM overview.rst
- Updated TFM v1.4 to v1.8
- Delete the TFM "Audit log" service, as it was removed from TFM.
- Delete not used secure service abbreviations.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2023-08-23 10:05:45 +02:00
Nicola Ochsenbein a4e6c91664 release notes: 3.5: Add new CONFIG_ETH_NATIVE_POSIX_RX_TIMEOUT option
Add new CONFIG_ETH_NATIVE_POSIX_RX_TIMEOUT option in release notes 3.5.

Signed-off-by: Nicola Ochsenbein <Nicola.Ochsenbein@husqvarnagroup.com>
2023-08-22 18:06:18 +02:00
Aaron Massey 82bfb26446 fuel_gauge: Add battery cutoff support
Many fuel gauge ICs offer a battery cutoff/shipping mode functionality that
cutoff charge from the battery. This is often useful for preserving battery
charge on devices while in storage.

Add battery cutoff support to the fuel gauge API with a generic default SBS
driver showing an example of support in tests.

Signed-off-by: Aaron Massey <aaronmassey@google.com>
2023-08-22 18:05:50 +02:00
Victor Chavez 33c922a771 Bluetooth: Userchan: Add support for TCP Connection
Added support to connect to an HCI TCP Server. This
allows to do integration tests with other frameworks
that support a virtual hci interface.

Signed-off-by: Victor Chavez <chavez-bermudez@fh-aachen.de>
2023-08-22 15:50:56 +02:00
Pieter De Gendt 4fc9686c41 doc: release: 3.5: Add CodeChecker entry
Add a release note entry for CodeChecker SCA support.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2023-08-21 17:51:30 +01:00
Gerard Marull-Paretas 11d782ce56 cmake: modules: add support for board extensions
Board extensions are board fragments that may be present in any board
root folder, under `${BOARD_ROOT}/extensions/${BOARD}`. The board
extension directory may contain Kconfig fragments and/or devicetree
overlays.  Board extensions are automatically loaded and applied on top
of board files, before anything else. There is no guarantee on which
order extensions are applied, in case multiple exist.

Board extensions may be useful in the context of Zephyr modules, such as
`example-application`. In some situations, certain hardware description
or choices can not be added in the upstream Zephyr context, but they do
in a downstream project, where custom bindings or driver classes can
also be created. This feature may also be useful in development phases,
when the board skeleton lives upstream, but other board features are not
yet present.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
2023-08-21 16:28:22 +02:00
Dawid Niedzwiecki 63af3c00e9 mgmt: ec_host_cmd: add SPI SMT32 backend
Add support for SPI host command backend for STM32 chips family.

Unfortunately, the current SPI API can't be used to handle the host
commands communication. The main issues are unknown command size sent
by the host(the SPI transaction sends/receives specific number of bytes)
and need to constant sending status byte(the SPI module is enabled and
disabled per transaction). Thus the SPI backend includes basic SPI STM32
driver adjusted to host command specification.

Signed-off-by: Dawid Niedzwiecki <dawidn@google.com>
2023-08-21 15:11:21 +02:00