Commit graph

6975 commits

Author SHA1 Message Date
Carles Cufi
caa25827a7 doc: soc porting: Fix introduction paragraph
The introductory paragraph had a broken link and was arbitrarily
referencing a couple of files that will be described extensively later.
Instead, just present the content generically.

Fixes #69990.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2024-06-21 14:57:30 -04:00
Fabian Blatz
2b2f35511c doc: releases: Add LVGL paragraph to the migration guide
Adds a paragraph detailing the deprecation of `LV_Z_POINTER_KSCAN` to the
migration guide 3.7.

Signed-off-by: Fabian Blatz <fabianblatz@gmail.com>
2024-06-21 11:54:11 -04:00
Jonathan Rico
62368ba489 doc: Bluetooth: Add release notes for TX path rework
Add release notes mentioning the recent TX path rework.

https://github.com/zephyrproject-rtos/zephyr/pull/72090

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-06-21 11:37:59 -04:00
TOKITA Hiroshi
5e295ac39e doc: release: 3.7: Add hyperlinks for boards
Add hyperlinks to each board's page for added in this release.

Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>
2024-06-21 10:11:53 +02:00
TOKITA Hiroshi
bcb7d42ac7 doc: releases: 3.7: Correct RaspberryPi5 identifier
`rpi_5` is the correct identifier for RaspberryPi5.

Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>
2024-06-21 10:11:53 +02:00
TOKITA Hiroshi
82c380b988 doc: add release note about Renesas RA
updated release notes for 3.7

Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>
2024-06-21 10:11:53 +02:00
Flavio Ceolin
38ef4b3749 doc: vuln: Add CVE under embargo
Add an entry to CVE-2024-6137

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-06-20 17:02:58 -04:00
Flavio Ceolin
3010a1f8a4 doc: vuln: Add CVE under embargo
Add an entry to CVE-2024-6135

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-06-20 17:02:58 -04:00
Flavio Ceolin
310cb3cad3 doc: relnotes/3.7: Add info about CVE-2024-6135
Information about CVE-2024-6135 in release notes.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-06-20 17:02:58 -04:00
Lothar Felten
d1a900266f doc: release: 3.6: Release notes for Lilygo boards
Add Lilygo boards that are supported in release 3.6

Signed-off-by: Lothar Felten <lothar.felten@gmail.com>
2024-06-20 17:02:27 -04:00
Benjamin Cabé
704421cc83 doc: clean-up Development Environment and Tools page
GitHub labels were hard to visually parse so use guilabel role to make them
stand out more, and put them in tabular format.
Other minor cosmetic tweaks

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-06-20 14:07:32 -04:00
Benjamin Cabé
a8573a985c doc: fix incorrect bullet lists
ReStructuredText bullet lists should be preceded by an empty
line

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-06-20 14:07:32 -04:00
Benjamin Cabé
0bd8a2faca doc: use proper pygment for Kconfig code-blocks
Kconfig snippets should use "kconfig" pygment to get proper highlighting

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-06-20 14:07:32 -04:00
Benjamin Cabé
b4b623c26c doc: use proper pygment for .conf code-blocks
config file snippets should use "cfg" pygment to get proper highlighting
This commit updates all occurences where "kconfig" or other languages
were used.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-06-20 14:07:32 -04:00
Ben Marsh
23736ee7d1 doc: releases: Add PR #73422 fix to release notes
Add the mDNS Resolver/Responder coexistence fix from PR #73422 to the
v3.7 release notes.

Signed-off-by: Ben Marsh <ben.marsh@helvar.com>
2024-06-20 08:57:55 +02:00
Johann Fischer
7e123084e2 doc: usb: document USB message notifications
Add documentation about USB message notifications. Use literalinclude to
pull code snippets from the samples.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2024-06-18 19:56:54 -04:00
Johann Fischer
afa6411139 doc: usb: include group usbd_msg_api
Include group usbd_msg_api to reference its members.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2024-06-18 19:56:54 -04:00
Tomasz Moń
e653816665 doc: usb: include new MSC device API
Add doxygen group with MSC device API and document macro to create
mapping between disk access and MSC LUN.

Signed-off-by: Tomasz Moń <tomasz.mon@nordicsemi.no>
Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2024-06-18 19:56:54 -04:00
Johann Fischer
52dbc3377b doc: usb: make example code most left-aligned
Make example code most left-aligned.
Also use :samp: to format identification strings in the table.
Followup on commit 8739efe0fc
("doc: usb: add initial USB device configuraiton howto").

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2024-06-18 19:56:54 -04:00
TOKITA Hiroshi
2393aef169 doc: add release note about RaspberryPi/RaspberryPiPico
updated release notes for 3.7

Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>
2024-06-18 19:56:26 -04:00
Daniel DeGrasse
a837117403 doc: flash_debug: fix some issues with probes documentation
Fix a few issues with the probes documentation for NXP boards:
- fix references to debug probe type in probes page introduction
- add an explicit "Install the host tools" step for the LPC-Link and
  MCU-Link based debug probe update steps.

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2024-06-18 14:34:47 -04:00
Daniel DeGrasse
2792f2e3fd doc: releases: 3.7: add release notes for SD
Add release notes for SD subsystem for 3.7

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2024-06-18 14:33:42 -04:00
Daniel DeGrasse
5c638cd679 doc: release: 3.7: add SDHC driver release notes
Add SDHC driver release notes for changes since 3.6

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2024-06-18 14:33:42 -04:00
Daniel DeGrasse
3e16122574 doc: release: 3.7: add disk driver release notes
Add release notes for changes to disk drivers since 3.6

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2024-06-18 14:33:42 -04:00
Daniel DeGrasse
1616bf8ecd doc: releases: migration-guide-3.7: add note for ssd16xx displays
The `orientation-flipped` dt property was dropped from the devicetree
binding for the ssd16xx display driver. Add a note to the migration
guide directing users to now set orientation at runtime.

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2024-06-18 15:52:35 +02:00
Daniel DeGrasse
109431ec23 doc: release: 3.7: add display release notes
Add display release notes for Zephyr 3.7

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2024-06-18 15:52:35 +02:00
Rodrigo Peixoto
d0a2451b6d doc: zbus: isolated pool by channel
Add the information about the possibility of isolating the pool per
channel.

Signed-off-by: Rodrigo Peixoto <rodrigopex@gmail.com>
2024-06-17 21:20:05 -04:00
Benjamin Cabé
02ad7ef1f9 doc: Add build env variable to know if doxygen has run
Some extensions may be able to run faster if they can check if Doxygen
contents has changed from one build to the other

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-06-17 12:11:34 -04:00
Chris Friedt
4d0a8c1e8b doc: posix: async-io: clean up async-io documentation
The async-io documentation was in need of some beautification.

Rather than repeating the same thing inside of the table, just
mention that the whole option is expected to fail enosys.

At this time, there does not seem to be sufficient need for
implementing async io, so it is only present so that conforming
applications can still link properly.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-06-16 06:38:27 -04:00
Yong Cong Sin
e0956f09d1 docs: posix: fix for unimplemented functions
The following functions are not implemented:
- getc_unlocked()
- getchar_unlocked()
- putc_unlocked()
- putchar_unlocked()

Signed-off-by: Yong Cong Sin <ycsin@meta.com>
2024-06-16 06:37:54 -04:00
Chris Friedt
12cc7bbd8a net: sockets: use z_finalize_typed_fd() to identify as sockets
Fill-in the mode field of the fd_entry so that the
implementation can be made aware that the specific file
descriptors created are sockets.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-06-15 07:47:12 -04:00
Noah Pendleton
f61950a782 cmake: sca: Enable CodeChecker error exit status
Normally the return code of `CodeChecker analyze` and `CodeChecker parse`
is suppressed, so all the enabled commands can execute instead of
crashing the build.

Add a new option, `CODECHECKER_PARSE_EXIT_STATUS`, to permit failing the
build if `CodeChecker parse` returns non-zero.

Signed-off-by: Noah Pendleton <noah.pendleton@gmail.com>
2024-06-15 05:14:48 -04:00
Swift Tian
25d01eaed4 doc: Add MSPI to bus emulator documentation
Add the MSPI bus emulator to documentation.

Signed-off-by: Swift Tian <swift.tian@ambiq.com>
2024-06-14 21:07:00 -04:00
Swift Tian
a86bbd3ebf doc: Add MSPI API documentation
Add the mspi.rst doc and related things for document generation.

Signed-off-by: Swift Tian <swift.tian@ambiq.com>
2024-06-14 21:07:00 -04:00
Thomas Gagneret
0d05318c96 scripts: zephyr_module: Add URL, version to SPDX
Improve the SPDX with the current values:
 - URL: extracted from `git remote`. If more than one remote, URL is not
 set.
 - Version: extracted from `git rev-parse` (commit id).
 - PURL and CPE for Zephyr: generated from URL and version.

For zephyr, the tag is extracted, if present, and replace the commit id for
the version field.
Since official modules does not have tags, tags are not yet extracted for
modules.

To track vulnerabilities from modules dependencies, a new SBOM,
`modules-deps.spdx` was created. It contains the `external-references`
provided by the modules. It allows to easily track vulnerabilities from
these external dependencies.

Signed-off-by: Thomas Gagneret <thomas.gagneret@hexploy.com>
2024-06-14 19:07:48 -04:00
David Ullmann
eb2fc22967 doc: add release note about Reyax LoRa module
updated release notes for 3.7

Signed-off-by: David Ullmann <davidl.ullmann@gmail.com>
2024-06-14 17:12:49 -04:00
Daniel DeGrasse
94ade2578c doc: releases: migration-guide: add migration note for GC9X01 display
Add migration note to GC9X01 display, which has been converted to the
MIPI DBI API.

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2024-06-14 17:11:20 -04:00
Tomi Fontanilles
f2c643ba02 storage: flash_map: replace TinyCrypt by PSA
As part of ongoing work to move away from TinyCrypt and towards PSA
(#43712), introduce a PSA option and remove the TinyCrypt one for the
SHA-256 implementation.

The Mbed TLS implementation is modified to use `mbedtls_sha256`
directly for smaller code size.

As of now the implementation defaults to PSA only if TF-M is enabled
because a dependency loop happens if using `PSA_CRYPTO_CLIENT` as a
condition in `FLASH_AREA_CHECK_INTEGRITY_BACKEND`.

A test case is added for the PSA implementation, and an NS platform is
added to the base test case to verify the compilation on a TF-M-enabled
platform.

Signed-off-by: Tomi Fontanilles <tomi.fontanilles@nordicsemi.no>
2024-06-14 14:02:08 -04:00
Tomi Fontanilles
703e5258eb mgmt: updatehub: replace TinyCrypt by PSA
As part of ongoing work to move away from TinyCrypt and towards PSA
(#43712), introduce a PSA option and remove the TinyCrypt one for the
SHA-256 implementation.

The Mbed TLS implementation is modified to use `mbedtls_sha256`
directly for smaller code size.

The reliance of mgmt/updatehub on storage/flash_map's configuration
(`FLASH_AREA_CHECK_INTEGRITY_BACKEND`) is removed.
The choice of which implementation to use is made automatically,
based on whether a PSA API provider is present (`PSA_CRYPTO_CLIENT`).

This commit also add a test case with PSA (based on Mbed TLS)
in samples/subsys/mgmt/updatehub/sample.yaml.

Signed-off-by: Tomi Fontanilles <tomi.fontanilles@nordicsemi.no>
Signed-off-by: Valerio Setti <vsetti@baylibre.com>
2024-06-14 14:02:08 -04:00
Chris Friedt
0af0187095 doc: posix: mark memory protection as supported
Mark _POSIX_MEMORY_PROTECTION as supported (i.e. a
conformant application will link). Zephyr's mm API does not
currently support modifying memory protection bits after
pages have been mapped, so use of this function may result
in undefined behaviour.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-06-14 14:01:05 -04:00
Chris Friedt
24378ed08a doc: posix: mark shared memory objects as supported
Mark _POSIX_SHARED_MEMORY_OBJECTS as supported.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-06-14 14:01:05 -04:00
Chris Friedt
2fd7297aed doc: posix: mark mlockall() and munlockall() as supported
Mark mlockall() and munlockall() as supported, as well as the
_POSIX_MEMLOCK Option.

These functions are currently expected to fail, but are
required so that conformant applications can still link
successfully.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-06-14 14:01:05 -04:00
Chris Friedt
d44047120b doc: posix: mark mlock() and munlock() as supported.
Mark mlock() and munlock() as supported, as well as the
_POSIX_MEMLOCK_RANGE Option.

These functions are currently expected to fail, but are
required so that conformant applications can still link
successfully.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-06-14 14:01:05 -04:00
Chris Friedt
510be57d7f doc: posix: mark mapped files as supported
Mark POSIX_MAPPED_FILES as supported.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-06-14 14:01:05 -04:00
Chris Friedt
65020f5b1f doc: posix: mark fstat() as implemented
The fstat() function is implemented as part of the
POSIX_FILE_SYSTEM Option Group, but it is implemented through
zvfs, as an ioctl, which allows other file descriptor types to
support queries of file descriptor status.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-06-14 14:01:05 -04:00
Daniel DeGrasse
2c7cd3dc1e doc: releases: migration-guide-3.7: add note for UC81xx displays
Add note for UC81xx displays, which have been migrated to the MIPI DBI
API. This note describes how to define the MIPI DBI wrapper device
needed for the UC81xx display

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2024-06-14 19:32:39 +02:00
Johann Fischer
8739efe0fc doc: usb: add initial USB device configuraiton howto
Add initial documentation how to configure and enable new USB device
support. Use literalinclude to pull code snippets from the samples.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2024-06-14 19:17:13 +02:00
Johann Fischer
9e80d4f976 doc: usb: rework new USB device support overview description
Rework new USB device support overview description.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2024-06-14 19:17:13 +02:00
Johann Fischer
1d0616a33b doc: usb: include Audio Class 2 device API
Include new Audio Class 2 device API.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2024-06-14 19:17:13 +02:00
Johann Fischer
7f2320ae08 doc: usb: include new HID device API
Include new HID device API.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2024-06-14 19:17:13 +02:00