Commit graph

5998 commits

Author SHA1 Message Date
Emil Gydesen 9c8ec58beb Bluetooth: GMAP: Add GMAP shell
Add the GMAP shell module with support for running the
various audio configurations in an easy way.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2023-12-11 18:30:57 +01:00
Aleksandr Khromykh d175ac0572 Bluetooth: Mesh: access tx msg randomizer
Commit adds implementation of the specification
recommendations regarding randomization of
responses on the access layer.
3.7.3.1 Transmitting an Access messages

Signed-off-by: Aleksandr Khromykh <aleksandr.khromykh@nordicsemi.no>
2023-12-11 09:50:18 +01:00
Flavio Ceolin 052590b0c1 doc: vuln: Disclose information about CVE-2023-4424
Information about CVE-2023-4424

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2023-12-09 15:31:42 -05:00
Daniel Leung 397c001181 doc: kernel/mm: add a page about virtual memory
This adds a page about virtual memory under kernel's memory
management.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2023-12-08 08:31:15 -05:00
Flavio Ceolin 4e9f73b0dd doc: pm: nrf target does not enable PM
samples/boards/nrf/system_off does not enable CONFIG_PM so
it should not be listed as an example in system power management
documentation.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2023-12-08 10:27:18 +00:00
Lingao Meng 1106b86bde doc: release: Add migration for bluetooth uuid
The Bluetooth UUID has been declare as rodata.

Signed-off-by: Lingao Meng <menglingao@xiaomi.com>
2023-12-07 16:16:43 +00:00
Pieter De Gendt a51af14729 doc: release: 3.6: Add note on net_mgmt worker Kconfig
Added an entry for the Kconfig choice CONFIG_NET_MGMT_EVENT_WORKER.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2023-12-07 16:15:53 +00:00
Jamie McCrae 227905ac4d doc: release: 3.6: Add note on fixed MCUboot erase issue
Adds a note that the shell mcuboot erase command can no
longer erase the MCUboot or application slots

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-12-07 14:24:48 +00:00
Torsten Rasmussen 0c26bdd86f doc: add EXTRA_DTC_OVERLAY_FILE to list of important build variables
The EXTRA_DTC_OVERLAY_FILE is also an important build system variable,
therefore add it to the list and give a brief description.

Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2023-12-07 10:38:05 +00:00
Robert Lubos ffc425191e net: doc: Remove Network Connectivity API page
The Network Connectivity API page is kind of pointless, as it provides
little information (which can be found elsewhere as well) and it was
pointer out that it kind of creates noise in the documentation as it can
be confused with the page which provides a summary of network APIs.

Therefore, remove the page, and move the information from it elsewhere.
The brief summary of what APIs to use was moved the Networking APIs
index page. The information about the samples demonstrating BSD sockets
API usage was moved to the BSD sockets documentation page itself.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2023-12-07 10:37:15 +00:00
Robert Lubos b9453d52ed net: doc: Reference the Kconfig option that enables app libraries
Several application protocol libraries documentation missed information
on how can they be enabled (i. e. missed info about associated Kconfig
symbol). This commit fixes it.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2023-12-07 10:37:15 +00:00
Pieter De Gendt ac520e6f99 doc: release: 3.6: Add CoAP events documentation
Update the release notes and migration guide for CoAP events using
the Network Events subsystem.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2023-12-07 10:34:39 +00:00
Pieter De Gendt 1f52a755d3 doc: connectivity: networking: Update CoAP event handling example
Change the CoAP documentation to demonstrate CoAP events using
net_mgmt.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2023-12-07 10:34:39 +00:00
Jamie McCrae 29e0c6c809 doc: migration-guide: 3.6: Add note on prj_board.conf removal
Adds a note on the removal of this option and how to adapt projects

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-12-06 10:28:12 -05:00
Dmitrii Golovanov 47da4e2e76 twister: Improve recording at Harness
The Console Harness is able to parse its log with patterns to compose
extracted fields into records in 'recording.csv' file in the test's build
directory. This feature allows to extract custom test results like
performance counters.
With this change the extracted records are also written into 'twister.json'
as a part of each test suite object. This makes easier to store
all the data collected by the test for its further processing.

Other improvements:
 - compile parsing pattern only once instead of at each input line;
 - quote fields in '.csv' to avoid unexpected field separators;
 - make 'regex' a required schema field of 'harness_config';
 - Twister documentation update.

Signed-off-by: Dmitrii Golovanov <dmitrii.golovanov@intel.com>
2023-12-06 10:26:35 -05:00
Daniel Leung ede9b0337c doc: ext/gh_utils: pass MAINTAINERS.yml to Maintainers
This changes to pass full path of MAINTAINERS.yml to
get_maintainer.Maintainers(). Without this, Maintainers would
use git to find the top level of Zephyr tree. This restricts
building of doc only when the build directory is under Zephyr
root. Since we have ZEPHYR_BASE in gh_utils, we can pass full
path of MAINTAINERS.yml to Maintainers() so that doc build
directory no longer has to be under Zephyr root.

Fixes #65037

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2023-12-06 12:11:57 +00:00
Fabio Baltieri 33c30795bc doc: redirects: add sorted block checks
Add marker to keep the link list sorted.

Suggested-by: Benjamin Cabé <benjamin@zephyrproject.org>
Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-12-06 09:30:55 +00:00
Benjamin Cabé 571f94309e doc: net: sockets: fix terms list for Socket offloading section
This commit fixes incorrect rendering of the list detailing the various
parameters for the NET_SOCKET_OFFLOAD_REGISTER macro.
This also improves the spelling and grammar of said list.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-12-06 09:25:28 +00:00
Benjamin Cabé aa1ca171aa doc: sphinx: Load RTD theme as a Sphinx extension
This commit loads the RTD theme as a Sphinx extension, which has the
benefit of going through said extension's "setup" method, effectively
setting useful settings such as default permalink icon (moving away from
the default, not so pretty, "¶").

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-12-06 09:23:36 +00:00
Seppo Takalo 9102821fbe doc: Clarify documentation of LwM2M events
Properly document the actions that application should
take on certain events.

This clarifies the events that indicate that the LwM2M
engine is stopped.

Add missing events to the state machine diagram and
apply color coding to states.

Signed-off-by: Seppo Takalo <seppo.takalo@nordicsemi.no>
2023-12-05 16:40:06 -06:00
Pieter De Gendt d7625ce57f doc: release: 3.6: Add note on NET_MGMT_REGISTER_EVENT_HANDLER
Add a release entry to networking/miscellaneous about compile time
network event handlers.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2023-12-05 09:17:42 -05:00
Pieter De Gendt 21ba08c575 doc: connectivity: networking: Document NET_MGMT_REGISTER_EVENT_HANDLER
Add an example using the macro NET_MGMT_REGISTER_EVENT_HANDLER to the
network management documentation.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2023-12-05 09:17:42 -05:00
Christopher Friedt 25ad028376 doc: posix: denote pthread_sigmask() as implemented
Mark pthread_sigmask() as implemented in POSIX_THREADS_BASE.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-12-04 20:49:35 -05:00
Andrej Butok 7536021599 doc: blobs: fix double 'command'
Fix double 'command' in the "Fetching blobs" chapter.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2023-12-04 16:39:32 +00:00
Jukka Rissanen 1aac715c23 doc: release: 3.6: Add info for IPv4/6 multicast socket options
Add information about the IPv4 multicast IP_ADD_MEMBERSHIP and
IP_DROP_MEMBERSHIP socket options.
Add information about the IPv6 multicast IPV6_ADD_MEMBERSHIP and
IPV6_DROP_MEMBERSHIP socket options.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
2023-12-04 16:38:49 +00:00
Jukka Rissanen ae8c3283eb doc: release: 3.6: IPv4 TTL and IPv6 hoplimit changes
Add information about IPv4 TTL and IPv6 hoplimit changes
for unicast and multicast packets.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
2023-12-04 15:07:43 +01:00
Jukka Rissanen 7582160623 doc: migration-guide: 3.6: IPv4 TTL and IPv6 hoplimit changes
Add information about IPv4 TTL and IPv6 hoplimit changes
for unicast and multicast packets.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
2023-12-04 15:07:43 +01:00
Alberto Escolar Piedras 5d72075d97 doc: migration-guide: 3.6: Add recommended change to native_sim
native_sim is superceeding native_posix.
Let's recommend users to use it instead.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-12-04 09:06:22 +01:00
Martí Bolívar b1532ce449 devicetree: remove label property accessors
These were first deprecated in v3.2. We have kept support for them
for as long as we can, but now their presence is causing CI failures
in some configurations. Specifically, using the deprecated 'label'
property is causing a warning which is promoted to an error in some
twister runs. This is blocking other forward progress in the
devicetree API.

I tried to rework the tests to avoid this, but it was too much effort
for the time I had to work on the task. Removing the APIs is therefore
unfortunately the best way forward to unblocking other work.

Re-work the test suite a bit to maintain coverage where we are using
the label property to test other macros.

Add a migration guide section to help with the transition.

Signed-off-by: Martí Bolívar <mbolivar@amperecomputing.com>
2023-12-01 13:09:56 -08:00
Aymeric Aillet ca3c970a1d doc: release: 3.6: Add new R-Car Gen4 SoC series
Added support to R-Car Gen4 SoCs & boards
Existing drivers now supports Gen4 SoCs

Signed-off-by: Aymeric Aillet <aymeric.aillet@iot.bzh>
2023-12-01 12:35:43 +01:00
Mia Koen 0bcad09392 bluetooth: mesh: Doc fix Bluetooth mesh to Mesh
SIG has changed Bluetooth mesh to Bluetooth Mesh
Updating zephyr docs accordingly
Leaving out old release notes

Signed-off-by: Mia Koen <mia.koen@nordicsemi.no>
2023-12-01 10:56:18 +00:00
Ryan McClelland c6b935f4f8 doc: releases: add i3c dcr/lvr rename note
Add a note to the v3.6 release notes about renaming the I3C_DCR_I2C_*
to I3C_LVR_I2C_*.

Signed-off-by: Ryan McClelland <ryanmcclelland@meta.com>
2023-12-01 10:48:31 +00:00
Alberto Escolar Piedras 44aaa03818 release_notes: native_sim replaces native_posix
Note that native_sim is replacing native_posix as default
test platform.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-12-01 10:54:57 +01:00
Daniel Leung 8f9fd239eb doc: porting/arch: add missing sections to overview list
The section overview list at the beginning of the document
is missing a few sections which were added after the list
was first created. So add them.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2023-11-30 21:01:47 -05:00
Daniel Leung 34c6b17680 doc: fixed already renamed _Cstart to z_cstart
The function _Cstart has already been renamed to z_cstart,
so change the remaining references of it in various docs.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2023-11-30 21:01:47 -05:00
Daniel Leung e3aa22bfda doc: porting/arch: fixed missing stack object memory map
The stack object memory map was missing from the doc due to
incorrect indentation. Fix it so that it shows up in the doc.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2023-11-30 21:01:47 -05:00
Ederson de Souza 10ec2b129c scripts/pylib/twister/twisterlib: Support multiple --pytest-args
One can not even replace sucessfully pytest basic sample `pytest-args`
with command line "--pytest-args", as all it does is to append a single
string to current list of commands, making it impossible to send several
arguments.

This patch fixes that by allowing several instances of `--pytest-args`
to compose the whole list of arguments to be passed to pytest.

Signed-off-by: Ederson de Souza <ederson.desouza@intel.com>
2023-11-30 10:03:01 +01:00
Daniel Baluta 915f8a10b6 doc: point to new zephyr sdk: 0.16.4
Change docs to point to new Zephyr SDK.

Signed-off-by: Daniel Baluta <daniel.baluta@nxp.com>
2023-11-30 14:49:54 +09:00
Adam Bozanich 9e4328cdcd doc: build: dts: bindings-syntax: compatible typo
The discussion and bindings for this node
assume that it is compatible with `"bar,pwm"`.

Signed-off-by: Adam Bozanich <adam.boz@gmail.com>
2023-11-29 17:39:30 -08:00
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
Fabio Baltieri 297c41031b doc: input: add a input_kbd_matrix group, fix few missing doc entries
Add a input_kbd_matrix doxygen group and add this to the other Input
APIs page, add few missing argument documentation entries.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-11-15 11:41:25 +01:00
Andrej Butok 2e97e5daa8 doc: mpsc: Add missed 'end'
Adds missed 'end' in the 'Internals' chapter.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2023-11-15 10:05:27 +01:00
Xudong Zheng f2f81361d8 doc: extensions: kconfig: allow paste event to trigger search
The "keyup" event is not triggered when pasting with mouse (right click,
paste) or when pasting on a phone/tablet.

Signed-off-by: Xudong Zheng <7pkvm5aw@slicealias.com>
2023-11-15 10:04:42 +01:00
Alberto Escolar Piedras d0f554dd6a docs: networing: Replace references to native_posix w native_sim
Let's replace the references to native_posix with native_sim.

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-15 10:03:17 +01:00
Alberto Escolar Piedras e44c43cc2c docs: Networking with native_posix: Rename
Rename
Networking with native_posix
to
Networking with native_sim
replace all links to this page accordingly
and replace its references to native_posix with native_sim.

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-15 10:03:17 +01:00
Thien Nguyen a0b746ed74 doc: drivers: deprecate driver init levels
Remove deprecated driver initialization levels in the docs.

Signed-off-by: Thien Nguyen <nguyenmthien@live.com>
2023-11-14 10:20:53 -05:00
Alberto Escolar Piedras 85b54358a1 docs: Introduction: Replace references to native_posix w native_sim
Let's replace the references to native_posix with native_sim,
in the introduction and beyond the getting started guide.

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-14 14:38:10 +01:00
Alberto Escolar Piedras b4d0791d1a services/tracing doc & samples: Replace native_posix w native_sim
In the docs replace the references to native_posix with native_sim.
In the sample, add overlays for native_sim, and add native_sim to filter
and as default integration platform.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-11-14 13:06:01 +01:00
Alberto Escolar Piedras 373f2d21c1 doc/develop/test: Replace references to native_posix w native_sim
Replace the references to native_posix with native_sim.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-11-14 06:51:38 -05:00
Georges Oates_Larsen 9f093ab731 net: tls_credetials: Add TLS Credentials shell
Adds a shell interface for TLS Credentials, allowing management of
credentials via the Zephyr shell

Signed-off-by: Georges Oates_Larsen <georges.larsen@nordicsemi.no>
2023-11-14 10:40:02 +00:00
Alberto Escolar Piedras 74d22a4b35 tests/drivers/eeprom: Several fixes and improvements
* Fix app path in documentation
* Move the at24 emulator overlays to be general instead of
  native_posix specific
* Switch default test platform from native_posix to native_sim
* From build only test, exclude platforms which are used
  in the build and run test.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-11-14 11:11:53 +01:00
Alberto Escolar Piedras 8366c1adb4 doc/hardware: Replace references to native_posix w native_sim
Replace the references to native_posix with native_sim.

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-14 11:11:53 +01:00
Tom Burdick d9a30c1f0a docs: Remove out of date examples
The examples in the RTIO docs were nice but continuously became out of
date without being updated. This is unfortunately the downside of
doc-only samples like this.

Some real, buildable, samples right be better but will take a little
time to write up. In the meantime drop the examples in the docs to avoid
confusion.

Signed-off-by: Tom Burdick <thomas.burdick@intel.com>
2023-11-14 09:25:54 +01:00
Jordan Yates e74676223a bluetooth: host: gatt: statically init callback list
Statically initialise the callback list so that subscriptions can be
registered before the call to `bt_enable`.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2023-11-14 09:21:16 +01:00
Alberto Escolar Piedras d427169845 docs: bluetooth: Replace reference to native_posix w native_sim
Let's replace the references to native_posix with native_sim,

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-14 09:52:34 +02:00
Benjamin Cabé a2a18e3fa4 doc: pdf: Add Glossary of Terms to PDF output
Add the Glossary page to the PDF so that :term: roles are properly
resolved.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-13 12:17:51 -05:00
Jamie McCrae 8334f1d385 doc: migration-guide: 3.6: Fix spurious character
Fixes a spurious tilde character at the end of a change

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-13 10:28:08 +00:00
Dominik Kilian 28df44946f ipc: add dynamically allocated buffers to icmsg
The icmsg and icmsg_me backends has limitations in context of
concurrent access to single instance. Some limitations are:
* sending by more thread at the same time may cause -EBUSY
* allocating TX buffer will cause errors in other threads that want
  to allocate before first thread sent the message,
* during no-copy receive, when RX buffer is on hold receiving is
  totally blocked.
This backend resolves those limitations by adding dynamically allocated
buffers on shared memory next to ICmsg circular buffer. The data is
passed using those buffers, so concurrency is not a problem. The ICmsg
is used only to pass short 2-byte messages containing references to
those buffers. The backend also supports multiple endpoint.
The ipc/icmsg_me sample was modified to support this backend.

Signed-off-by: Dominik Kilian <Dominik.Kilian@nordicsemi.no>
2023-11-13 11:11:43 +01:00
Martin Jäger 8b7c8b09ec lorawan: rename lorawan_set_battery_level_callback and make it void
Rename the lorawan_set_battery_level_callback to
lorawan_register_battery_level_callback to make it consistent with other
functions for downlink and data rate changed callbacks.

Also making the function void for consistency. The get_battery_level
already checks if the callback is NULL before invoking it.

Signed-off-by: Martin Jäger <martin@libre.solar>
2023-11-13 09:53:32 +01:00
Alberto Escolar Piedras f9e0a3dbd0 doc: pytest: Correct native device type name
The native device type name is "native", "native posix" is just
one of the possible target boards (which is going to be deprecated
in the next release).

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2023-11-13 09:50:26 +01:00
Jamie McCrae 5c05b61ecd doc: mgmt: mcumgr: Remove OS mgmt datetime unimplemented note
This functionality is now implemented

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-13 09:48:13 +01:00
Jamie McCrae 20f0e37413 doc: release: 3.6: Add note on MCUmgr OS mgmt datetime
Adds a note that datetime support has been added to MCUmgr

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-13 09:48:13 +01:00
Chris Friedt c0064f1de8 logging: uart: support multiple instances
Extends the log_backend_uart to support logging to multiple
UART instances.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-11-13 09:47:06 +01:00
Tomasz Moń c275fa737b doc: connectivity: usb: Document CDC ACM ECHO mitigation
Explain the root cause behind garbage characters received in shell
applications, what Zephyr does to mitigate the issue and what is
expected from host userspace applications.

Signed-off-by: Tomasz Moń <tomasz.mon@nordicsemi.no>
2023-11-13 09:43:46 +01:00
Emil Gydesen fc2a54b80c doc: Bluetooth: Audio Stack status table
Adds table of the status of the LE Audio stack in
the Bluetooth subsystem.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2023-11-13 09:43:35 +01:00
Carles Cufi 9a44f7f583 doc: gsg: Windows: Clarify usage of terminal/cmd.exe
Responding to feedback from the community, clarify that the cmd.exe
window needs to be closed and reopened.

Also be specific about the type of terminal window to be used.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2023-11-10 13:40:03 +00:00
Carles Cufi 318836af23 doc: gsg: macOS: Include instructions to add homebrew to the path
Multiple users have failed to read the output from the Homebrew
installation script, which instructs the user how to add it to the
path. Include the instructions in the guide.

Also add a step to include the Homebrew Python executable to the path,
which allows then for invocation of python and pip as well as python3
and pip3.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2023-11-10 11:14:12 +00:00
Tom Burdick 344d24bcb7 docs: Better document the DMA API and expectations
The DMA API has several expectations for drivers and callers that were
underdocumented or undocumented. Better clarify the driver expectations
and caller expectations.

The DMA API from the caller side is not a portable API and really cannot
be as each DMA has unique properties and expectations of memory,
peripheral interaction, and features. The API in effect provides a union
of all useful DMA functionality drivers have needed in the tree. It can
still be a good abstraction, with care, for peripheral devices for
vendors where the DMA IP might be very similar but have slight
variances.

From the driver implementation side expectations around synchronization,
state transitions, and memory management for transfer descriptors is now
described in documentation rather than solely from me in github review
comments.

Signed-off-by: Tom Burdick <thomas.burdick@intel.com>
2023-11-10 10:40:10 +01:00
Ricardo Rivera-Matos 2253ba571b docs: charger: Corrects text in the Properties section
Correct Properties subsection of the document to be accurate
to the latest implementation of the charger API.

Signed-off-by: Ricardo Rivera-Matos <ricardo.rivera-matos@cirrus.com>
2023-11-09 17:26:03 -05:00
Ricardo Rivera-Matos d291ef4577 doc: charger: Removes misleading statement at introduction
Removes a statement at the introduction claiming only getting
properties is supported by the API. The charger API can get/set
properties.

Signed-off-by: Ricardo Rivera-Matos <ricardo.rivera-matos@cirrus.com>
2023-11-09 17:26:03 -05:00
Benjamin Cabé abc334016f doc: pdf: Use single column for the index
The index at the end of the PDF document can contain pretty long strings
that don't fit in the default 2-column layout.
This commit makes the index use a single-column.

Note: this relies on LaTeX package idxlayout which should already be
included in the packages recommended for installation in our
instructions.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-09 15:33:40 +01:00
Daniel DeGrasse 47ce94527a doc: services: pm: fix function prototype for PM device support
Function prototype in PM device implementation documentation had the
incorrect prototype for device power management. Fix this to align
with the correct prototype.

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2023-11-09 15:32:01 +01:00
Yong Cong Sin 30940418b3 doc: kconfig: sort devicetree functions alphabetically
Sort these entries alphabetically to make it easier to read.

Signed-off-by: Yong Cong Sin <ycsin@meta.com>
2023-11-09 15:31:38 +01:00
Yong Cong Sin 4b0fa40c71 doc: kconfig: remove duplicated devicetree function
These devicetree function entries already existed in the doc
since #21133.

Signed-off-by: Yong Cong Sin <ycsin@meta.com>
2023-11-09 15:31:38 +01:00
Benjamin Cabé 7d3381f9c8 doc: Rename "report an issue" label
Clarify the "Report an issue" label in HTML documentation.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-09 14:50:21 +01:00
Benjamin Cabé 6cf694a2ad doc: gh_utils: Use MAINTAINERS file to add labels to opened issues
Use get_maintainer.py to add more meaningful labels to issues creates
from a documentation page.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-09 14:50:21 +01:00
Benjamin Cabé a3ed8f827f doc: gh_utils: Use "doc:" prefix in opened issue title
Not sure why I used square brackets for "[doc]" prefix of the default
Github issue title. Change it to "doc:".

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-09 14:50:21 +01:00
Benjamin Cabé f6400f17cb doc: gh_utils: Fix incorrect condition for empty string
Page prefix can be an empty string.
Fixed the condition so that it only evaluates to try when prefix is
truly None.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-09 14:50:21 +01:00
Benjamin Cabé 61dd68a5ee doc: gh_utils: use doc2path method from BuildEnvironment
Use BuildEnvironment to get the path of a document.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-09 14:50:21 +01:00
Benjamin Cabé cf52afb3fb doc: gh_utils: Remove unnecessary ZEPHYR_BASE config option
Compute ZEPHYR_BASE like other extensions do rather than artificially
pretend it's a config option.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-09 14:50:21 +01:00
Benjamin Cabé 0f07889bcd doc: gh_utils: add docstring for get_page_prefix
Add documentation to the get_page_prefix method.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-09 14:50:21 +01:00
Benjamin Cabé df6a9f2d30 doc: css: fix dark theme for gui roles
Fix dark theme issues with guilabel and menuselection roles.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-09 10:23:31 +00:00
Benjamin Cabé 00758b3e9a doc: gsg: macOS: Use menuselection role
Small tweak to use Sphinx `menuselection` role and make the menu output
more readable.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-09 10:23:31 +00:00
Fabio Baltieri 702399080e Kconfig: drop COMPAT_INCLUDES
Last reference of this was dropped in 01b7800bc8, almost 2y ago.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-11-09 11:22:40 +01:00
Pieter De Gendt 98052aabb7 doc: releases: migration: Add CoAP API changes
Add a note to the 3.6 migration guide about the CoAP API changes
introduced with the CoAP server subsystem.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2023-11-09 11:21:42 +01:00
Pieter De Gendt b81ce1f957 doc: connectivity: networking: api: Add subsystem link notes to CoAP
The CoAP documentation has server/clients sample usages, added a
note about the available subsystems that can be used instead.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2023-11-09 11:21:42 +01:00
Pieter De Gendt 230c989590 doc: connectivity: networking: api: Add CoAP server documentation
Created a dedicated page for CoAP service and resource examples.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2023-11-09 11:21:42 +01:00
Benjamin Cabé 559424285f doc: develop: update ram and rom report sample and reduce width
Update the sample outputs for ram and rom report commands to reflect
current look&feel, and reduce the width of the output to better fit
on narrow screens & PDF output.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-08 16:03:48 -05:00
Jamie McCrae 07328c4afa doc: migration-guide: 3.6: Add note on MCUboot Kconfig
Adds a note about how to replicate the functionality of the now
removed MCUboot mass erase Kconfig option

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-08 10:10:43 +01:00
Andrej Butok 583fd8a79e doc: slist: fix duplicated sys_sfnode_flags_get()
Replace duplicated sys_sfnode_flags_get() by sys_sfnode_flags_set().

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2023-11-08 10:10:27 +01:00
Andrej Butok dc92b32ceb doc: fix link to extensions.cmake
"cmake/extensions.cmake" does not exist. The link is broken.
Fix it to correct one "cmake/modules/extensions.cmake".

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2023-11-08 10:10:02 +01:00
Andrej Butok 5730dd6fb7 doc: fix typos
Add missed "space".
Add missed "been".

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2023-11-08 10:09:44 +01:00
Aleksandr Khromykh 50d17a0d52 Bluetooth: Mesh: split gatt client and solicitation pdu sending
The ability to send the solicitation PDU doesn't
depend on GATT Client role.
Commit makes independent one functionality from
another.

Signed-off-by: Aleksandr Khromykh <aleksandr.khromykh@nordicsemi.no>
2023-11-08 10:08:36 +01:00
Fabio Baltieri 8816852c2c doc: dts: api: update the inter-node dependencies documentation
Update the inter-node dependencies documentation to clarify the child
node dependency inheritance recently introduced in 403640b75e.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-11-08 10:06:57 +01:00
Jordan Yates ee57b56ba5 doc: contribute: instructions for local viewing of docs
Add instructions for serving the generated HTML docs on a local IP
address.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2023-11-07 09:54:22 +01:00
Benjamin Cabé 08ca98fbd1 doc: gsg: Remove misleading mention of Powershell
While we will probably want to properly document how to use Powershell
on Windows in the near future, current Getting Started Guide contained a
misleading mention to activating Pythonv venv using Powershell that this
commit removes.

Addresses comments raised in #64682.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-07 09:53:30 +01:00
Andrej Butok 95a5f5178f doc: memory: Fix SYS_MEM_BLOCKS_DEFINE_STATIC description
Fix SYS_MEM_BLOCKS_DEFINE_STATIC() description.
Use a "memory blocks allocator" instead of "slab",
which is most probably was copy-pasted from
the previous "slab" chapter by mistake.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2023-11-06 19:03:29 -05:00
Benjamin Cabé e76a2b9b4b doc: application: add missing language attribute
Make sure application-kconfig.include is properly highlighted by setting
the :language: attribute.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-06 18:57:51 -05:00
Armando Visconti f39dba5da5 drivers/sensor: lsm6dsv16x: add in DT both INT1 and INT2 pin
Add in DT the possibility to configure both INT1 and INT2
pin. The driver will then assign one of the two (either 1
or 2, according to what value drdy_pin is set) to a gpio
for receiving drdy interrupts.

The other pin may be used in the future to receive event
interrupts.

Signed-off-by: Armando Visconti <armando.visconti@st.com>
2023-11-06 10:13:38 +01:00
Fabio Baltieri acb784eb56 doc: migration guide: add a note about touchscreen reset polarity change
Add a note about the fix in reset polarity for ft5336 and gt911.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-11-06 08:50:33 +00:00
Anas Nashif 7cacfe8403 doc: define internal API group
Group all internal APIs under this doxygen group.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-03 11:46:52 +01:00
Anas Nashif a08bfeb49c syscall: rename Z_OOPS -> K_OOPS
Rename internal API to not use z_/Z_.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-03 11:46:52 +01:00
Anas Nashif ee9f278323 syscall: rename Z_SYSCALL_VERIFY -> K_SYSCALL_VERIFY
Rename internal API to not use z_/Z_.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-03 11:46:52 +01:00
Anas Nashif 1a9de05767 syscall: rename Z_SYSCALL_DRIVER_ -> K_SYSCALL_DRIVER_
Rename internal API to not use z_/Z_.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-03 11:46:52 +01:00
Anas Nashif 9c4d881183 syscall: rename Z_SYSCALL_ to K_SYSCALL_
Rename internal API to not use z_/Z_.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-03 11:46:52 +01:00
Anas Nashif 9c1aeb5fd3 syscall: rename z_user_ to k_usermode_
Rename internal API to not use z_/Z_.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-03 11:46:52 +01:00
Anas Nashif 56fddd805a syscall: rename z_user_from_copy -> k_usermode_from_copy
Rename internal API to not use z_/Z_.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-03 11:46:52 +01:00
Anas Nashif 21254b2f40 syscall: rename z_object_validate -> k_object_validate
Rename internal API to not use z_/Z_.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-03 11:46:52 +01:00
Anas Nashif df9428991a syscall: Z_SYSCALL_MEMORY_ARRAY -> K_SYSCALL_MEMORY_ARRAY
Rename macros and do not use Z_ for internal APIs.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-03 11:46:52 +01:00
Anas Nashif 684b8fcdd0 syscall: Z_SYSCALL_VERIFY_MSG -> K_SYSCALL_VERIFY_MSG
Rename macros and do not use Z_ for internal APIs.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-03 11:46:52 +01:00
Anas Nashif 4e396174ce kernel: move syscall_handler.h to internal include directory
Move the syscall_handler.h header, used internally only to a dedicated
internal folder that should not be used outside of Zephyr.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-03 11:46:52 +01:00
Anas Nashif a6b490073e kernel: object: rename z_object -> k_object
Do not use z_ for internal structures and rename to k_object instead.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-03 11:46:52 +01:00
Anas Nashif c91cad735a kernel: object: rename z_object_init to k_object_init
Do not use z_ for internal API and rename to k_object_init.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-11-03 11:46:52 +01:00
David Corbeil 724c162821 shell: backends: telnet: Added support for echo option
Adding support for echo option if telnet commands are supported. This is
useful when the telnet client is in character mode. It allows to use the
arrow keys, ctrl-c and more. Something to keep in mind is that when
character mode is turned on by the client, network traffic is
considerably increased as each typed character is sent over the wire.

Note: echo mode is only supported if SHELL_TELNET_SUPPORT_COMMAND is
enabled.

Signed-off-by: David Corbeil <david.corbeil@dynon.com>
2023-11-03 11:46:08 +01:00
Benjamin Cabé d4cf7b6357 doc: gsg: Update Windows instructions regarding Python 3.12
Python 3.12 is not (yet) providing a seamless experience for Windows
developers. Update Install instructions to invite people to stick to
Python 3.11 for the time being.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-11-03 09:59:28 +01:00
Henrik Brix Andersen ec75b7704f docs: migration-guide-3.6: add a note about optional modules
Add a note about modules moved to optional and how to enable them again.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2023-11-03 09:57:45 +01:00
Jamie McCrae 0bc239f23d doc: develop: getting_started: Change ubuntu version to 20.04 LTS
Ubuntu 18.04 LTS support was dropped in May 2023, therefore bump
version to oldest supported LTS release

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-03 09:57:15 +01:00
Henrik Brix Andersen f811a05044 doc: releases: remove v3.3.0 from supported releases
As of October 31, 2023, Zephyr v3.3.0 is no longer supported.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2023-11-03 09:56:58 +01:00
Bjarki Arge Andreasen 011adfa4ca modem: Add experimental tag
The modem subsystem is novel and should therefore be marked
experimental.

Signed-off-by: Bjarki Arge Andreasen <bjarkix123@gmail.com>
2023-11-03 09:56:30 +01:00
Omkar Kulkarni 30c36525ef Doc: Bluetooth: Mesh: Specify RPR Server limitations
Specifies RPR Server limitations.

Signed-off-by: Omkar Kulkarni <omkar.kulkarni@nordicsemi.no>
2023-11-03 09:54:03 +01:00
Ludvig Jordet 596fc48509 doc: bluetooth: mesh: Improve CDP128+ docs
Improves the documentation about how CDP 128, 129 and 130, as well as
Models Metadata Page 128 are created, as well as which functions the
application will have to call to store the correct contents in the
pages.

Signed-off-by: Ludvig Jordet <ludvig.jordet@nordicsemi.no>
2023-11-02 12:24:47 +01:00
Jamie McCrae 3ce916d68f doc: migration-guide: 3.6: Add note on MCUmgr CRC change
Adds a note that an additional Kconfig needs to be selected if a
serial MCUmgr transport is used

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-02 09:48:26 +01:00
Jamie McCrae bd4bada151 doc: release: 3.6: Add notes on MCUmgr fixes
Adds notes on fixed MCUmgr issues and a smp_svr sample issue

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-11-02 09:48:26 +01:00
Fabio Baltieri 125e0e8741 docs: migration-guide-3.5: add a note about optional modules
Add a note about modules moved to optional and how to enable them again.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-11-02 09:45:47 +01:00
Seppo Takalo 2eb804a558 net: lwm2m: Add shell support for deleting object and resource instances
Extend the previous support of creating object instances by allowing
creation of resource instances as well.
Similarly, add support for deleting.

Signed-off-by: Seppo Takalo <seppo.takalo@nordicsemi.no>
2023-11-02 09:27:55 +01:00
Carles Cufi 9cf07bbdb5 bluetooth: Rename rpmsg HCI driver and sample to ipc
The existing driver and sample:

- drivers/bluetooth/hci/rpmsg
- samples/bluetooth/hci_rpmsg

are no longer correctly named, since they now use the IPC subsystem to
send and receive data. The IPC subsystem can use RPMsg as a transport,
but that is one of several selectable backends.

I initially wanted to deprecated both the BT_RPMSG Kconfig option as
well as the zephyr,bt-hci-rpmsg-ipc chosen node in Devicetree. However,
this proved to be undoable in the case of the Kconfig option. This is
because it's a choice option, and those have special behavior. In
particular, the only practical way to deprecate would've been to keep
the old Kconfig option outside the choice (much like it's done in this
commit) but then also add a 'depends on !BT_RPMSG' on each of the
remaining choice symbols *except* on the new BT_HCI_IPC one. This, however,
only works correctly for .conf files. If a board instead sets the
default BT_HCI_BUS_TYPE in the Kconfig.defconfig file then the Kconfig
tree parsing would fail, because it'd try to set it to a value
(BT_RPMSG) that is no longer part of the choice.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2023-11-02 08:32:20 +02:00
Henrik Brix Andersen 5d5249d85b drivers: can: unify spelling of CAN Flexible Data-rate abbreviation
Unify spelling of CAN Flexible Data-rate abbreviation to "CAN FD" instead
of "CAN-FD". The former aligns with the CAN in Automation (CiA)
recommendation.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2023-11-01 11:17:17 +00:00
Fabio Baltieri d89938f4b9 doc: guidelines: fix title level
Specialized driver requirements should have been one level up, it now
nests under "treewide".

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-10-31 16:33:04 +00:00
Henrik Brix Andersen 435b8a25d6 doc: hardware: peripherals: can: split CAN transceiver from controller
Split out the CAN transceiver API documentation from the CAN controller API
documentation. The CAN transceiver API was introduced in Zephyr v3.1.0.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2023-10-31 09:02:00 +01:00
Flavio Ceolin 32d7b3645a toolchain: Add nonnull attribute
Add a new macro for __attribute__((nonnull))). This attribute
allows functions to declare which parameters shouldn't be null.
This helps to catch errors like:

void test(void *a, void *b, void *c) __attribute_nonnull(1, 3);

/zephyrproject/zephyr/samples/hello_world/src/main.c:28:9: warning:
argument 3 null where non-null expected [-Wnonnull]
   28 |         test(a, NULL, NULL);
      |         ^~~~

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2023-10-31 09:00:02 +01:00
Bjarki Arge Andreasen 42676e322b doc: gnss: Add GNSS documentation
- Added GNSS documentation entry to peripherals
- Added GNSS API entry to the API overview as 3.6 experimental

Signed-off-by: Bjarki Arge Andreasen <bjarkix123@gmail.com>
2023-10-30 11:43:19 -04:00
Benjamin Cabé 26d7c61370 doc: samples: Show related code samples contents by default
Add required class so that sphinx-togglebutton admonition is expanded by
default.

Also remove sphinx-immaterial code that should not be there.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-10-30 12:27:00 +01:00
Benjamin Cabé cf1fdc3ea8 doc: samples: Use definition list for code samples
Using an UL with "manually" formatted text was probably an oversight.
Show related samples as a "definition list", with sample name as the
"term" and the description as the "definition".

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-10-30 12:27:00 +01:00
Benjamin Cabé 9e0c46f81b doc: fix Doxygen light theme
As per Doxygen Awesome documentation:
"HTML_COLORSTYLE must be set to LIGHT since Doxygen 1.9.5!"

Fixes #64505

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-10-30 09:25:48 +01:00
Henrik Brix Andersen eddfba487d doc: can: move the documention for high-level protocols to connectivity
Move the documentation for high-level CAN protocols (for now only covering
ISO-TP) from the peripherals section to the connectivity section.

This matches the layout in code, where the CAN controllers are under the
drivers/can directory and the protocols are under the subsys/canbus/
directory.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2023-10-30 09:25:40 +01:00
Fabio Baltieri bc43e890fd doc: drivers: add a paragraph mentioning the initlevels target
Add a paragraph mentioning the initlevels target for inspecting the
DEVICE_DEFINE and SYS_INIT sequence.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-10-28 23:19:59 +02:00
Grzegorz Chwierut fffe0b9fad twister: pytest: Parametrize scope of the dut fixture
Added pytest_dut_scope keyword under harness_config section.
New keyword is used to determine the scope of dut and shell
fixtures in pytest-twister-harness plugin.

Signed-off-by: Grzegorz Chwierut <grzegorz.chwierut@nordicsemi.no>
2023-10-27 13:35:14 -05:00
Flavio Ceolin 253e266fc5 doc: vuln: Disclose information about CVE-2023-5139
Information about CVE-2023-5139

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2023-10-27 10:52:26 +02:00
Krzysztof Chruściński 503422b91e doc: logging: Add new Kconfig options
Add CONFIG_LOG_SIMPLE_MSG_OPTIMIZE and CONFIG_LOG_FRONTEND_OPT_API

Signed-off-by: Krzysztof Chruściński <krzysztof.chruscinski@nordicsemi.no>
2023-10-27 10:50:39 +02:00
Anas Nashif a6bfbedbf5 doc: project roles: Further finetune language
More details about roles and responsibilities and reviewer expectations.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-10-27 10:49:47 +02:00
Anas Nashif 8663449055 doc: reviewer expectations: minor optimizations
Minor layout and language optimization to the review expectations
document.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-10-27 10:49:47 +02:00
Anas Nashif d8709301a2 doc: update technical escalation proccess
Update process for technical PR escalation.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-10-27 10:49:47 +02:00
Benjamin Cabé 353f42d8bd doc: refactor vcs_link and git_info extensions
Refactor all git/github related extensions into one file, as they are
working hand in hand.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-10-27 10:49:11 +02:00
Benjamin Cabé 701f59ee1e doc: Make it easier to report issues in the documentation
- Add extension to get git metadata (date, SHA-1, ...) regarding the
  latest update made to a page
- Add date of last "actual" update to each manually authored doc page
- Add admonition inviting to report issues
- Add button in breadcrumb to report issue

Fixes #60622.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-10-27 10:49:11 +02:00
Benjamin Cabé 32cd631a1b doc: extensions: Add method to get vcs link to report issue
This adds a vcs_link_get_open_issue_url Jinja filter to craft the URL
allowing to report an issue for a given Sphinx page

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-10-27 10:49:11 +02:00
Benjamin Cabé eb1968fa10 doc: extensions: Add ability to edit doc page on GitHub
Update the vcs_link extension to also support generating "edit" URL
vcs_link_version is also now a Sphinx config making its value available
to extensions.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-10-27 10:49:11 +02:00
Andrej Butok 3fab7624eb doc: pipes: Fix the pipe read example.
Replaces sizeof(header) which is equal to the size of the pointer,
by sizeof (*header), which is equal to the size of struct message_header.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2023-10-26 10:29:37 -04:00
Jordan Yates 7aae40e844 doc: build: kconfig: document configdefault
Document the new `configdefault` Kconfig extension.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2023-10-26 09:47:06 +02:00
Jordan Yates ee1acd8ae5 doc: build: kconfig: expand on multiple symbols
Convert the warning about multiple symbol definitions to a dedicated
section. This allows the warning to be restricted to the information
that is non-intuitive, with a note for actions that should be taken
when working with multiple definitions.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2023-10-26 09:47:06 +02:00
Manuel Argüelles 006a650690 doc: flash_debug: add NXP S32 debug probe docs
Document needed steps to download, install and setup the debug host
tools for NXP S32 Debug Probe.

Signed-off-by: Manuel Argüelles <manuel.arguelles@nxp.com>
2023-10-25 18:14:51 -07:00
Anders Storrø c51bb9c13b Bluetooth: Mesh: Update spec ref 1.0.1->1.1
Updates Bluetooth mesh specification references:

- Change "Profile" to "Protocol" since the main specification has
changed its name.
- Update/align formating of specification references. This will
make it easier to find spec references in the future.
- Change some section references to point to the correct section of the
newest version of the specification (v1.1).

Signed-off-by: Anders Storrø <anders.storro@nordicsemi.no>
2023-10-25 14:50:14 +02:00