Commit graph

6514 commits

Author SHA1 Message Date
Reto Schneider
5a49b7c90d doc: releases: Fix GH link in migration guide v3.6
Putting a space between :github: and the PR number causes the rendered
text to not link to the issue.

Signed-off-by: Reto Schneider <reto.schneider@husqvarnagroup.com>
2024-03-26 08:45:02 -04:00
Chris Friedt
b5a15c980f doc: posix: remove unneeded notes about XSI_THREADS_EXT
Previously, XSI_THREADS_EXT included a note about
undefined behaviour. However, the required functions
pthread_attr_getstack(), pthread_attr_setstack(),
pthread_getconcurrency(), and pthread_setconcurrency()
are all conformant.

Remove the unneeded note (all of them)

Signed-off-by: Chris Friedt <chrisfriedt@gmail.com>
2024-03-26 06:54:27 -04:00
Jonathan Rico
b96efd78ce doc: Bluetooth: clarify qualification state
The BT subsystem has not been officially qualified for a somewhat long
time now. The code has diverged quite a bit from what it was.

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-26 10:37:42 +01:00
Jonathan Rico
e074f392f5 doc: Bluetooth: move AutoPTS setup pages
In preparation of further cleanup commits.
Removes noise in the navigation pane in the rendered docs.

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-26 10:37:42 +01:00
Tomi Fontanilles
18170ebce1 modem: cmux: make work buffer size configurable
A Kconfig item is added and the buffer
is embedded into the modem_cmux struct.
The default value is increased from 16 to 64 bytes in
an effort to reduce the number of modem_pipe_receive() calls.

CONFIG_MODEM_CHAT_LOG_BUFFER is renamed
to CONFIG_MODEM_CHAT_LOG_BUFFER_SIZE for consistency.

Signed-off-by: Tomi Fontanilles <tomi.fontanilles@nordicsemi.no>
2024-03-26 09:29:55 +00:00
Jukka Rissanen
e0133cfa17 doc: migration-guide-3.7: Add virtual net interface information
The virtual interface API "input" callback is removed and
its functionality is implemented in "recv" callback.
This change affected the IP tunneling implementation in the
network stack.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
2024-03-25 17:07:43 +01:00
Daniel Leung
6ea749de52 arch: rename arch_start_cpu() to arch_cpu_start()
Rename arch_start_cpu() to arch_cpu_start() so it belongs to
the "cpu" namespace.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2024-03-25 09:58:35 +00:00
Christopher Friedt
8de8bcc99c doc: posix: mark pthread_rwlockattr_setpshared as supported
Mark pthread_rwlockattr_setpshared() and
pthread_rwlockattr_getpshared() as supported in the POSIX
Options documentation.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2024-03-22 16:19:57 -04:00
Christopher Friedt
457e44073b doc: posix: mark clock_getres() as supported
Mark clock_getres() as supported in the POSIX_TIMERS Option
Group.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2024-03-22 16:19:27 -04:00
Jonathan Rico
06f6c5c992 doc: bsim: Move contents into .rst
This makes the information more discoverable and linkable in the docs.

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-22 15:59:49 -04:00
Marcin Niestroj
64ff60a870 doc: networking: document native_sim with offloaded sockets
Document how offloaded sockets can be used with 'native_sim' for networking
capability.

Signed-off-by: Marcin Niestroj <m.niestroj@emb.dev>
2024-03-22 14:39:27 +01:00
Luis Ubieda
0186a96419 doc: release: Add information on UART over Bluetooth LE and NUS Service
Add documentation on relevant sections to list addition of Bluetooth LE
service NUS (Nordic UART Service), as well as the UART driver for UART
over Bluetooth LE and snippets to easily enable it.

Signed-off-by: Luis Ubieda <luisf@croxel.com>
2024-03-22 10:25:37 +01:00
Christopher Friedt
98a121da0c doc: posix: aep: mark POSIX_SINGLE_PROCESS as supported
Mark the POSIX_SINGLE_PROCESS Option Group as supported
in PSE51, PSE52, and PSE53 Application Environment
Profiles.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2024-03-22 08:57:44 +01:00
Christopher Friedt
601c0bed33 doc: posix: mark confstr() as supported
Mark confstr() as supported in POSIX Option Groups.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2024-03-22 08:57:44 +01:00
Christopher Friedt
cb9384e597 doc: posix: mark _POSIX_CPUTIME as supported
The `_POSIX_CPUTIME` interface requires
`CLOCK_PROCESS_CPUTIME_ID` and `clock_getcpuclockid()` to be
present. Both of those are now available and therefore we can
mark `_POSIX_CPUTIME` as supported for PSE53.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2024-03-22 08:54:17 +01:00
Christopher Friedt
b31b6f9feb doc: posix: correct note of XSI_THREADS_EXT
Previously, XSI_THREADS_EXT included a note about
undefined behaviour. However, the required functions
pthread_attr_getstack(), pthread_attr_setstack(),
pthread_getconcurrency(), and pthread_setconcurrency()
are all conformant.

Remove the unneeded note.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2024-03-22 08:53:57 +01:00
Flavio Ceolin
6704557bf9 doc: security: cve-2023-7060 left embargo
Disclose information about cve-2023-7060.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-03-21 17:51:31 -04:00
Torsten Rasmussen
732c504e4c terminology: adopt CMake, python, and Kconfig code to use qualifiers
Followup: #69905

Adopting new board terminology for CMake, python, and Kconfig code to
use qualifiers instead of identifiers.

Also adjusted to board target where applicable.

Signed-off-by: Torsten Rasmussen <Torsten.Rasmussen@nordicsemi.no>
2024-03-21 15:32:17 +01:00
Jordan Yates
ca36feeca8 doc: logging: document LOG_WRN_ONCE
Document the existence of `LOG_WRN_ONCE`.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2024-03-21 10:07:36 +00:00
Alberto Escolar Piedras
bd68ec9568 doc/develop/application: Replace native_posix w native_sim
As we are replacing native_posix with native_sim, let's
use native_sim instead of native_posix as example platform.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2024-03-20 15:43:05 +01:00
Carles Cufi
68eb97ea05 doc: add board terminology section to board porting guide
Add a terminology section to the board porting guide.
This provides a single location where terminologies used for boards can
be found and linked to.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2024-03-20 13:00:55 +01:00
Glenn Andrews
aeea1d10de Lib: SMF: Fix typo in documentation
Fixes a typo found by @bryceschober

Spell-checked the rest of the document and found no issues.

Signed-off-by: Glenn Andrews <glenn.andrews.42@gmail.com>
2024-03-19 11:45:27 -04:00
Marina Kalashina
611d284fc6 doc: develop: tools: CLion tutorial
This commit adds a tutorial on how to set up, build, and debug
a sample Zephyr application in CLion.

Signed-off-by: Marina Kalashina <marina.kalashina@jetbrains.com>
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-03-19 14:27:11 +01:00
Ederson de Souza
9ab243d671 doc: Generate develop/api/overview.rst API table from doxygen
A new extension, api_overview.py, is used to, leveraging doxygen's
Python module doxmlparser, parse the doxygen generated XML files.
All groups ('defgroup' and 'addtogroup' tags) are collected, alongside
their 'version' and 'since' info.

From there, a new Sphinx directive `api-overview-table` is populated,
including the name of the group, and if available, their 'since' and
'version' information.

Signed-off-by: Ederson de Souza <ederson.desouza@intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-03-19 13:13:45 +01:00
Ederson de Souza
4fe0a1dc7f doc: Include doxmlparser on requirements.txt
It will be necessary to parse the doxygen XML files to extract `since`
and `version` from them.

Signed-off-by: Ederson de Souza <ederson.desouza@intel.com>
2024-03-19 13:13:45 +01:00
Ederson de Souza
28d08ada28 include/zephyr: Add 'version' and 'since' tag to groups
Based on information from doc/develop/api/overview.rst, add current
version for some groups representing APIs, following the following
table:

  - Experimental:   0.1.0
  - Unstable:       0.8.0
  - Stable:         1.0.0

Also based on doc/develop/api/overview.rst, add 'since' tag to the
groups.

Signed-off-by: Ederson de Souza <ederson.desouza@intel.com>
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-03-19 13:13:45 +01:00
Gaetan Perrot
990ebd5c94 doc: posix: mark set and get scope APIs for pthread attr as supported
`pthread_attr_setscope()` and `pthread_attr_getscope()`
are now implemented, mark it so.

signed-off-by: Gaetan Perrot <gaetanperrotpro@gmail.com>
2024-03-18 10:15:53 +01:00
Henrik Brix Andersen
2f6b41a694 doc: releases: release-notes: 3.7: mention optional CAN DTS properties
Add a note about the ``sample-point`` and ``sample-point-data`` CAN
devicetree properties now being optional.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2024-03-17 15:36:19 +01:00
Gaetan Perrot
b519041948 doc: posix: sched functions will fail with ENOSYS
Mark `sched_setparam()` , `sched_setscheduler()`
and `sched_rr_get_interval()`
have implemented but will fail with ``ENOSYS``
Were missing on the documentation before.

signed-off-by: Gaetan Perrot <gaetanperrotpro@gmail.com>
2024-03-16 18:19:21 +09:00
Gaetan Perrot
f913af8a4d doc: posix: mark putmsg as supported
Mark `putmsg()` as implemented but will fail with ``ENOSYS``
Was missing on the documentation before.

signed-off-by: Gaetan Perrot <gaetanperrotpro@gmail.com>
2024-03-16 18:19:21 +09:00
Benjamin Cabé
27f91456a4 doc: dts: fix link to reel board DTS file
fix broken link following hwmv2 migration

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-03-15 18:21:05 -04:00
Benjamin Cabé
36a9a9cee0 doc: guidelines: fix dead links
fix zephyr_file and zephyr_raw broken links

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-03-15 18:21:05 -04:00
Benjamin Cabé
40d3ffa603 doc: fix double backticks in sphinx roles
fixed a few improperly formatted sphinx roles causing dead references.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-03-15 18:21:05 -04:00
Benjamin Cabé
1015ae3d4f doc: hwmv2: board_porting: fix broken links
DTS files for FRDM-K64F and Hexiwear K64 have moved.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-03-15 18:21:05 -04:00
Alberto Escolar Piedras
ae358704d2 docs/Kconfig help: Replace native_[posix,sim]_64
Replace uses of native_[posix,sim]_64 in the documentation
and kconfig help messages with native_[posix,sim]/native/64
to match the hwmv2 naming.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2024-03-15 16:13:12 +01:00
Théo Battrel
4a55bc00f0 Bluetooth: Shell: Add support for EAD
Add new commands to manage the Encrypted Advertising Data feature.

Overview of those new commands:

- `bt encrypted-ad set-keys`: set key materials (session key and
  initialisation vector) used for encrypted and decryption of EAD;
- `bt encrypted-ad add-ad`: store a given advertising data structure;
- `bt encrypted-ad add-ead`: encrypt the given advertising data
  structres and store the generated AD structure;
- `bt encrypted-ad commit-ad`: set the AD of the selected advertiser
  with the stored AD;
- `bt encrypted-ad clear-ad`: remove all stored AD;
- `bt encrypted-ad decrypt-scan`: decrypt data using the previously set
  key materials when receiving AD with type `0x31`.

The documentation of the Bluetooth Shell has been updated to include
those new commands.

Signed-off-by: Théo Battrel <theo.battrel@nordicsemi.no>
2024-03-13 18:51:03 +02:00
Alberto Escolar Piedras
e1b7b450c8 doc/develop api_lifecycle: Mention adding the arch review label
For breaking API changes, let's mention explicity the PR should
be labelled with the "Architecture Review" label, as that is
the one we base the automation on.
As otherwise it is not clear enough for developers that they
should add it, and without it (and the automation surrounding it),
it is too easy for a PR to be merged by mistake.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2024-03-13 16:45:38 +00:00
TaiJu Wu
1f5f0cf838 sched: Remove multi-level queue priority limit
Modified bitmask to  bitmask array, it can make multilevel queue remove
32 bit prioriry limit.

We can scan bitmask array to find which queue have ready thread.

Only need the number of queues as priority because the priority
is checked on create_thread.

Signed-off-by: TaiJu Wu <tjwu1217@gmail.com>
2024-03-12 19:37:40 -04:00
Emil Gydesen
164529145b Bluetooth: Audio: Shell: CAP change microphone gain command
Adds the change microphone gain command to the CAP commander shell.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-03-12 17:56:09 +00:00
Emil Gydesen
8f0e648e48 Bluetooth: CAP: Shell: Add proper broadcast commands
Adds additional broadcast commands and modifies the existing
ones to use the CAP API.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-03-12 09:45:10 +00:00
Henrik Brix Andersen
8dd03c63d6 doc: releases: release-notes: 3.7: support minimum suported CAN bitrates
Add release notes related to the added support for minimum supported CAN
transceiver/controller bitrates.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2024-03-12 10:43:36 +01:00
Gaetan Perrot
dfefac8208 doc: posix: mark getmsg and getpmsg as supported
`getmsg()` and `getpmsg()`  are now implemented, mark it so.
There are place holder so will fail with ENOSYS.

signed-off-by: Gaetan Perrot <gaetanperrotpro@gmail.com>
2024-03-11 14:25:26 +01:00
Aleksandr Khromykh
aa87ed5d8a Bluetooth: Mesh: make models metadata const
Commit adds const qualifier to models metadata.
Specification claims: Composition Metadata Page 0
shall not change during a term of a node on the network.

Signed-off-by: Aleksandr Khromykh <aleksandr.khromykh@nordicsemi.no>
2024-03-11 09:26:12 +01:00
Emil Gydesen
826ac0755b bluetooth: audio: shell: Improve indentation when printing codecs
Codecs can be printed at different levels:
level 0: Generic and unicast
level 1: subgroup codec configs
level 2: BIS codec configs

This commit ensures that the indentation level
is correctly increase based on where the codec configuration
data is printed.

This also updates the documentation for the BAP shell.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-03-09 14:10:17 -06:00
Benjamin Cabé
cb26820c51 hwmv2: scripts: handle Kconfig sources in a Windows compatible way
Move away from os.join.path and only rely on pathlib magic, and serialize
all paths using POSIX path separators.
This fixes documentation build and compliance check script on Windows.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-03-08 15:19:04 +00:00
Christopher Friedt
284cecd4cc doc: posix: add environ, getenv, setenv, and unsetenv
Mark environ, getenv(), setevn(), and unsetenv as supported.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2024-03-08 04:28:47 -05:00
Emilio Benavente
04b240c830 dts: bindings: renamed binding used for pit
Renamed pit binding from nxp,kinetis-pit
to nxp,pit

Signed-off-by: Emilio Benavente <emilio.benavente@nxp.com>
2024-03-07 13:23:58 -06:00
Florian La Roche
f9f44b6dcd doc: arch: fix typo in arm_cortex_m.rst
fix typo in arm_cortex_m.rst

Signed-off-by: Florian La Roche <Florian.LaRoche@gmail.com>
2024-03-07 12:15:35 +01:00
Aleksandr Khromykh
a96293b093 doc: Bluetooth: Mesh: add missed lcd shell commands
Commit adds description of the Large Composition Data
client's shell commands into documentation.

Signed-off-by: Aleksandr Khromykh <aleksandr.khromykh@nordicsemi.no>
2024-03-07 10:58:53 +00:00
Lyle Zhu
4e079831b7 doc: releases: migration-guide-3.7: Rename BT_BREDR to BT_CLASSIC
Due to the source/header files are moved to subfolder "classic",
rename the kconfig option BT_BREDR to BT_CLASSIC to make the
folder name and kconfig option name consistent.

Signed-off-by: Lyle Zhu <lyle.zhu@nxp.com>
2024-03-07 11:26:45 +02:00