Commit graph

5361 commits

Author SHA1 Message Date
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
Jamie McCrae 6b654bdc87 doc: release: 3.5: Add MCUmgr SMP version 2 stable change note
Adds a note on the stable API change of changing the MCUmgr SMP
version 2 error entry name to avoid a collision with shell_mgmt
which already used "ret".

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-08-21 10:18:50 +02:00
Jamie McCrae 5c88d45544 treewide: mgmt: mcumgr: Change "ret" to "err" for SMP version 2
This is a stable API treewide change changing the newly introduced
"ret" response to "err" as it was overlooked that the shell_mgmt
group already used "ret" to return the exit code of the command
and this created a collision. Since SMP version 2 was only recently
introduced, there should not be any public implementations of it
as of yet, but the original function has been kept and marked as
deprecated.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-08-21 10:18:50 +02:00
David Brown 73e69b4290 doc: services: tfm: Update version in overview
Update the mention of the "currently integrated" version of TFM to match
the latest upgrade.

Signed-off-by: David Brown <david.brown@linaro.org>
2023-08-18 10:14:27 +02:00
Declan Snyder 6dd8601716 doc: disk: Mention eMMC support in disk subsystem
Include mention of MMC in disk/SD/SDHC doc pages.

Signed-off-by: Declan Snyder <declan.snyder@nxp.com>
2023-08-18 10:14:01 +02:00
Grant Ramsay 7670ae4c68 doc: networking: Add documentation on qemu_cortex_a53 networking
Add documentation on qemu_cortex_a53 networking

Signed-off-by: Grant Ramsay <gramsay@enphaseenergy.com>
2023-08-18 10:13:12 +02:00
Fabio Baltieri 83e4ed1fc5 Revert "doc: release-notes: document aarch32 cortex_a_r linker command file changes"
This reverts commit eb731abeb8.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-08-17 20:56:32 +01:00
Anders Storrø 254ee94fc0 Bluetooth: Mesh: Remove conflicting shell OOB func
Removes redundant mesh shell OOB implementation that makes
existing command implementation fail. Alters capabilities
CB to print provisionee caps.

Signed-off-by: Anders Storrø <anders.storro@nordicsemi.no>
2023-08-17 16:50:28 +02:00
Xudong Zheng d2ba2ec987 doc: sysbuild: Update note regarding CONFIG_ZEPHYR_TRY_MASS_ERASE
The configuration option was deprecated and removed as the default in
MCUBoot commit 9315654d7951fb2c269251db94e04cd062d0b89a.

Signed-off-by: Xudong Zheng <7pkvm5aw@slicealias.com>
2023-08-17 15:12:57 +02:00
Nico Lüthi cd2a0389ed cmake: add ZephyrAppConfiguration package
Fixes #56200
Add the ZephyrAppConfiguration package and update the corresponding
documentation. This adds flexibility to the CMake build configuration
by providing a workspace configuration package and an application
package, which only applies to the current application. The workspace
package stays the same as before, but the application package is
new and lives, per default, inside the application folder.

Signed-off-by: Nico Lüthi <nylnx@outlook.com>
2023-08-17 10:36:45 +02:00
Tom Burdick dae2f33e5e rtio: Remove references to simple executor
The simple executor was removed with the usage of the spsc queue but
some stray references remained. Remove those.

Signed-off-by: Tom Burdick <thomas.burdick@intel.com>
2023-08-16 20:41:18 +02:00
Flavio Ceolin 3c1394c17a doc: vulnerabilities: Add information about CVE-2023-4265
Add information about CVE-2023-4265

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2023-08-16 15:05:35 +02:00
Pieter De Gendt 517bdeb2bb cmake: sca: Add CodeChecker native support
Add CodeChecker as a static code analysis tool for zephyr.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2023-08-15 21:35:25 -04:00
Aaron Massey 7692623970 ztest: Document ZTEST_DMEM & ZTEST_BMEM
We use ZTEST_DMEM and ZTEST_BMEM for running tests with memory shared
between userspace and kernelspace. This ought to be documented.

Document ZTEST_DMEM and ZTEST_BMEM.

Signed-off-by: Aaron Massey <aaronmassey@google.com>
2023-08-15 21:34:49 -04:00
Keith Short cc5595df0d doc: release: 3.5: document CONFIG_GPIO_NCT38XX_ALERT
Document the rename of CONFIG_GPIO_NCT38XX_INTERRUPT to
CONFIG_GPIO_NCT38XX_ALERT.

Signed-off-by: Keith Short <keithshort@google.com>
2023-08-15 21:55:31 +00:00
Emil Gydesen 5b888c361d Bluetooth: BAP: Shell: Remove use of broadcast sink scan API
The broadcast sink scan API is no longer used by the BAP
shell, which handles everything related to PA sync and scan
itself now.

It has also been made easier to sync to a broadcast
source by simply using create_broadcast_sink.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2023-08-14 13:34:26 +00:00
Evgeniy Paltsev 57623bc7db doc: ARC: update ARC support status page regarding VPX support
Update ARC support status page as now we have scalar ARC VPX
port upstreamed.

Signed-off-by: Eugeniy Paltsev <Eugeniy.Paltsev@synopsys.com>
Signed-off-by: Evgeniy Paltsev <PaltsevEvgeniy@gmail.com>
2023-08-11 19:45:48 +00:00
Jamie McCrae e9dd938821 doc: mgmt: mcumgr: groups: smp_group_0: Minor typo fixes
Fixes a couple of typos in the documentation.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-08-11 12:02:12 +00:00
Grzegorz Ferenc e39b6c5195 doc: develop/application: add info about VERSION
Added the VERSION file to the list of application files.
Added link to the application version management page.

Signed-off-by: Grzegorz Ferenc <Grzegorz.Ferenc@nordicsemi.no>
2023-08-10 18:07:33 +00:00
Joshua Lilly cce530cae4 scripts: build: gen_isr_tables: make bit masks configurable
Some architectures such as RISC-v support more than 255 interrupts
per aggrigator. This diff adds the ability to forgo the aggrigator
pattern and use a configurable number of bits for multilevel
interruts.

Signed-off-by: Joshua Lilly <jgl@meta.com>
2023-08-10 10:55:41 -04:00