Commit graph

5809 commits

Author SHA1 Message Date
Jamie McCrae b35cd5f7b8 doc: migration-guide: 3.6: Add note on nrf Kconfig removal
Adds a note on a now removed Nordic GPREGRET Kconfig which was
deprecated in Zephyr 3.4

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-29 13:38:29 +01:00
Armin Brauns 5b1b260f80 bluetooth: add HCI driver parameter to set controller's public address
This allows HCI drivers to expose vendor-specific functions to set the
public address.

Signed-off-by: Armin Brauns <armin.brauns@embedded-solutions.at>
2023-11-29 10:44:25 +01:00
Jamie McCrae 78a819bb33 doc: release: 3.6: Add note on fixed MCUmgr UART console FIFO
Adds a note that the UART FIFO is no longer read when the driver
is configured

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-29 10:09:38 +01:00
Jamie McCrae 55dbe1e42b doc: release: 3.6: Add note on Nordic implying XIP
Adds a note that nordic SoCs now imply the XIP Kconfig option
instead of selecting it

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-29 10:09:38 +01:00
Jamie McCrae b32b228697 doc: release: 3.6: Add note on fixed board revision 0
Adds a note that board revision 0 now correctly has the overlay
file included

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-29 10:09:38 +01:00
Jamie McCrae c8d5344584 doc: release: 3.6: Fix wrong list character
Fixes wrongly using a dash instead of an asterisk for a list

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-29 10:09:38 +01:00
Christopher Friedt e260201204 doc: posix: mark pthread_cleanup_push() and pop() as supported
Update docs to reflect additional support of
pthread_cleanup_push() and pthread_cleanup_pop().

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-11-29 10:08:44 +01:00
Børre A. Opedal Lunde 6c6712d104 doc: timers: correct grammar and typos
Minor grammatical errors and mistyped words were
corrected to improve clarity.

Signed-off-by: Børre A. Opedal Lunde <borre97@live.no>
2023-11-28 17:17:58 -05:00
Bartosz Bilas ce812c1b25 zbus: rework buffer allocation Kconfig options
Add a name for the Kconfig choice symbol
indicating the Zbus subscriber buffer allocation
and adjust the name of the existing choices.

Signed-off-by: Bartosz Bilas <bartosz.bilas@hotmail.com>
2023-11-28 15:33:42 +01:00
Carlo Caione 06571fc87b doc: Add documentation for the new allocator
Add new documentation for the new attribute-based memory allocator.

Signed-off-by: Carlo Caione <ccaione@baylibre.com>
2023-11-27 19:56:48 +01:00
Benjamin Cabé c1656a4486 doc: redirects: fix redirect for POSIX portability homepage
Add a proper redirect for pre-3.5.99 POSIX portabiltity home page.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-27 09:23:07 -06:00
Christopher Friedt 5bfed9ef6b doc: posix; mark pthread_getconcurrency() supported
Mark pthread_getconcurrency() and pthread_setconcurrency()
as supported in documentation.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-11-27 08:26:31 -05:00
Christopher Friedt 5da13ea30a docs: posix: correct spelling of XSI_THREADS_EXT
The option group includes a trailing S

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-11-26 19:58:54 -05:00
Christopher Friedt 4d8442d3a5 docs: posix: update the XSI_THREADS_EXT option group
Previously pthread_attr_getguardsize() and
pthread_attr_setguardsize() were part of the
XSI_THREADS_EXT option group. That is no longer the case.

In IEEE 1003.1-2017 they are part of the POSIX_THREADS_EXT
option group.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-11-26 19:58:54 -05:00
Christopher Friedt ecd2961160 doc: services: portability: posix: add pthread_setcanceltype()
The function pthread_setcanceltype() is supported and mandatory
for conforming implementations.

Mark it as supported since the preceding commit.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-11-26 05:55:08 -05:00
Benjamin Cabé 0b39da6869 doc: Do not fail when manually authored doc file is not tracked by git
This fixes a bug where a newly created documentation file not yet
tracked by git would cause the documentation generation to fail.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-25 08:55:18 -05:00
Bartosz Bilas 20acd64a1b doc: zbus: fix msg subscriber thread signatures
Fix the thread function signatures to match k_thread_entry_t.

Signed-off-by: Bartosz Bilas <b.bilas@grinn-global.com>
2023-11-24 09:27:10 +01:00
Jamie McCrae 2a9f914db2 doc: mgmt: mcumgr: Add list of libraries/tools
Adds a list of tools and libraries that are available

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-24 09:22:44 +01:00
Benjamin Cabé cce77c8902 doc: latex: enable pdflscape package
Enable the pdflscape package (available in the Latex distros recommended
 for Zephyr) to allow for some pages to be rendered in landscape mode.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-24 09:22:44 +01:00
Grzegorz Chwierut a1698b691d twister: pytest: Add --pytest-args to Twister command line
Extend Twister command line with --pytest-args. This parameter
is passed to pytest subprocess. It allows to select a specific
testcase from a test suite.

Signed-off-by: Grzegorz Chwierut <grzegorz.chwierut@nordicsemi.no>
2023-11-23 10:03:11 +01:00
Bartosz Bilas e7c7c5a769 doc: zbus: add missing timeout arg for zbus_chan_add/rm_obs funcs
zbus_chan_add_obs and zbus_chan_rm_obs functions require
a timeout as their third arg.

Signed-off-by: Bartosz Bilas <bartosz.bilas@hotmail.com>
2023-11-23 10:02:13 +01:00
Flavio Ceolin b43271dc2d doc: vuln: Disclose information about CVE-2023-5055
Information about CVE-2023-5055

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2023-11-23 10:01:30 +01:00
Christopher Friedt 1d501a76af doc: services: portability: posix: pthread_atfork() supported
Mark pthread_atfork() as supported in the documentation.

This option is a mandatory requirement (i.e. it must be present)
even when calling it produces undefined behaviour. That is the
case here, and documentation sbould be updated to reflect that.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-11-23 00:59:32 -05:00
Christopher Friedt 3b45235887 doc: posix: structural reorganization of posix docs
Revise the structure of the POSIX API docs. This separates
related items out to dedicated pages. Further improvements
could yet be made - e.g. using the 'collapse' feature to
expand and collapse large sections of text or tables.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-11-22 22:47:26 -05:00
ingram weeks 45a5cedfd6 doc: Console.rst added to os_services docs
Barebones Console.rst added to os_services docs

Signed-off-by: ingram weeks <ingram.weeks@gmail.com>
2023-11-22 09:37:38 +00:00
Jamie McCrae f03192f489 doc: mcumgr: Add missing Settings management text
Adds that settings (config) management is supported to the list of
supported command groups

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-22 09:51:57 +01:00
Jamie McCrae 3613f94fdc doc: mcumgr: smp_group_63: Add zephyr mgmt group documentation
Adds documentation describing the MCUmgr Zephyr management group
and supported commands

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-22 09:51:57 +01:00
Jamie McCrae 300746310e doc: mcumgr: smp_group_3: Fix rc text
Fixes the "rc" text to include that it can also be returned when
SMP version 2 is used to indicate an SMP error instead of a group
error.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-22 09:51:57 +01:00
Ibe Van de Veire a43e516ff2 doc: migration guide: add note about IGMP migration
Added note about the migration steps needed to support the new IGMP api.
The api now expects an additional argument used for joining an IGMPv3
group.

Signed-off-by: Ibe Van de Veire <ibe.vandeveire@basalte.be>
2023-11-21 15:50:31 +01:00
Alexander Leris 7d63942c31 doc: logging: Fix some grammar issues
Fixes some grammar issues in the documentation.

Signed-off-by: Alexander Leris <alexander.leris@gmail.com>
2023-11-21 14:21:35 +01:00
Keith Packard a4a8120b69 doc: Update picolibc section in 3.5 migration guide for 1.8.5
Picolibc 1.8.5 includes more control over printf capabilities, document
those in the migration guide.

Signed-off-by: Keith Packard <keithp@keithp.com>
2023-11-20 06:07:58 -05:00
Alberto Escolar Piedras 641784cd59 tests/ztest/fail: Replace native_posix with native_sim
In the docs replace references to native_posix with native_sim
Switch the default test platform to native_sim from native_posix

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-11-20 12:02:48 +01:00
Alberto Escolar Piedras 97b9bce995 doc/services/sensing: Refer to native_sim overlay instead of native_posix
Refer to the native_sim overlay instead of the native_posix one,
as native_posix is going to be deprecated soon.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-11-20 12:02:48 +01:00
Armando Visconti 237891973b doc: migration-guide-3.6.rst: recommend use of DT macros for ST sensors
Recommend use of DT macros for ST sensors as described in #65410.

Signed-off-by: Armando Visconti <armando.visconti@st.com>
2023-11-20 09:24:37 +01:00
Lingao Meng 7fcc3f0696 doc/migartion: Add migration guide for element
The Bluetooth Mesh ``element`` declaration has been changed to add
prefix ``const``. The ``elem->addr``field has been changed to the
new runtime structure, replaced by ``elem->rt->addr``.

Signed-off-by: Lingao Meng <menglingao@xiaomi.com>
2023-11-20 09:22:55 +01:00
Fabio Baltieri 9234088306 samples: kscan_touch: drop the kscan_touch sample
All in-tree touchscreen drivers have been migrated over to input, the
compatibility node has been removed from those boards as well, this
sample can be dropped now.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-11-20 09:22:03 +01:00
Henrik Brix Andersen 62f2ae1c5e docs: releases: migration: 3.6: change in defaults for shell modules
Mention the change in the default value for subsystem/driver shell module
Kconfigs.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2023-11-20 09:21:40 +01:00
Andrej Butok f345378db1 doc: application: Fix application build comment
Fix the application build comment
to make it valid for both ninja and make build tools.
It generated the wrong "ninja" comment for "make".

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2023-11-20 09:21:22 +01:00
Fabio Baltieri 190f0dde26 doc: migration-guide: annotate various entry with the PR numbers
Add a PR number reference to various migration guide entries.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-11-17 09:27:26 +01:00
Seppo Takalo 8cfede8f2e net: lwm2m: Support DTLS Connection Identifier
DTLS Connection Identifier support requires DTLS stack
that supports it. MbedTLS support in Zephyr is already
ported in, also some offloaded sockets support it.

Signed-off-by: Seppo Takalo <seppo.takalo@nordicsemi.no>
2023-11-17 09:23:29 +01:00
Alberto Escolar Piedras b9977592a5 doc/develop/test/bsim: Update with nrf5340bsim info
Update this page to account for the fact that now
we have several bsim boards in tree.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-11-16 17:53:25 +01:00
Alberto Escolar Piedras 05c03eb258 bluetooth dev doc: Update with nrf5340bsim info
Now that we also have this target board, we have
some more options.
Update the docs to reflect these.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-11-16 17:53:25 +01:00
Lingao Meng d896213ef4 doc/release: Add incompatible change for bt mesh
https://github.com/zephyrproject-rtos/zephyr/issues/57267

Signed-off-by: Lingao Meng <menglingao@xiaomi.com>
2023-11-16 16:52:14 +01:00
Lingao Meng ab08f34fd9 Bluetooth: Mesh: Make bt_mesh_model as rodata
Since model struct most of member should not change at run time,
so mark as const will be suitable and safely.

Signed-off-by: Lingao Meng <menglingao@xiaomi.com>
2023-11-16 16:52:14 +01:00
Anas Nashif 538abf3332 doc: clarify role of CODEOWNERS and MAINTAINERS files
Change docs to use MAINTAINERS file as the main file for managing code
areas and 'ownership'.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-16 08:19:15 -05:00
Alberto Escolar Piedras 9fe225d2b8 doc/connectivity/usb: Replace references to native_posix w native_sim
Replace the references to native_posix with native_sim,
and update link names accordingly.

Background: during this release native_sim is replacing
native_posix as the main host test/development platform.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-11-16 09:37:59 +01:00
Benjamin Cabé 155420522b doc: Fix occurrences of repeated words
Another round of repeated words cleanup. This commit tries to keep the
diff minimal and line wrapping was mostly left intact in the touched
files, as having them consistent across the documentation is probably
the topic of a future tree-wide cleanup (or not)

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-15 17:34:39 -05:00
Andrej Butok 287b30eb78 doc: Fix double 'the'
Fix double 'the' in all .rst documentation.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2023-11-15 14:25:11 +00:00
Carles Cufi e91040917c doc: Reuse the same Zephyr SDK installation instructions
Instead of keeping 2 copies of the same Zephyr SDK installation
instructions, reuse a single copy by including it in the getting stated
guide from the Zephyr SDK doc page.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2023-11-15 14:03:31 +00:00
Carles Cufi 7fc83e36a3 doc: gsg: macOS: Do not require wget, use curl instead
macOS ships with curl by default. There's no need to add additional
tools to the installation when a perfectly good one ships with the OS.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2023-11-15 14:03:31 +00:00