Commit graph

6239 commits

Author SHA1 Message Date
Declan Snyder 0c7325e3ef doc: board_porting: Update hierarchy presentation
Update the presentation of the hardware hierarchy description so that it
does not appear to have missing words at the end of the bullet points,
by using a paragraph instead. And tweak the wording slightly.

Signed-off-by: Declan Snyder <declan.snyder@nxp.com>
2024-03-26 19:29:33 -04:00
Jonathan Rico 08ba810ffe doc: Bluetooth: LE host touch-ups
Addresses review comments on text I only moved.

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-26 16:19:30 -04:00
Jonathan Rico 629795d1ad doc: Bluetooth: add LE Host page
We now have Classic activity in the tree.
Make the distinction clearer.

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-26 16:19:30 -04:00
Jonathan Rico 89b64f8210 doc: Bluetooth: Audio -> LE Audio
We now have BT Classic audio activity, we should be more specific.

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-26 16:19:30 -04:00
Jonathan Rico e701188bce doc: Bluetooth: Change ordering of sections
It makes more sense that way:
A developer wants to know in order:
- what features we have
- if they are qualified/qualifiable
- how the stack is architected / what parts are where
- how to develop an app
- tools to develop said apps (+ shell)

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-26 16:19:30 -04:00
Jonathan Rico 698a0c3193 doc: Bluetooth: Remove "Bluetooth" from titles
It adds unnecessary noise in the navigation pane.

We don't do this for other chapters (e.g. kernel services don't say
"Kernel Services System Threads" in the title, just "System Threads").

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-26 16:19:30 -04:00
Jonathan Rico e043f06fb7 doc: Bluetooth: Rename overview.rst and add links
This page only ever had one section: supported features.
Added links to the relevant sections for each layer.

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-26 16:19:30 -04:00
Jonathan Rico b6aefe9a67 doc: Bluetooth: move -pics.rst into ics/ folder
Less clutter.

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-26 16:19:30 -04:00
Jonathan Rico c44cbaf868 doc: Bluetooth: Add ToC to bluetooth-tools.rst
Also capitalize title like the other pages.

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-26 16:19:30 -04:00
Jonathan Rico 89d05bbc76 doc: Bluetooth: organize API page in sections
Makes it easier to find what you're looking for.

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-26 16:19:30 -04:00
Jonathan Rico d14baba122 doc: Bluetooth: add sections and links to -dev
Add sections and links for `bluetooth-dev.rst`

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-26 16:19:30 -04:00
Jonathan Rico fbe91cd654 doc: Bluetooth: move btmon instructions
Move so both sections referring to btmon are on the same page.

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-26 16:19:30 -04:00
Lukasz Madej a64a64b3c2 drivers: charger: charger_max20355: handle thermistor mode
Allow to configure thermistor monitoring mode.

Signed-off-by: Lukasz Madej <l.madej@grinn-global.com>
2024-03-26 16:18:31 -04:00
Lukasz Madej bda4c18fc9 drivers: charger: charger_max20355: handle recharge threshold
Allow to configure recharge threshold.

Signed-off-by: Lukasz Madej <l.madej@grinn-global.com>
2024-03-26 16:18:31 -04:00
Lukasz Madej e8788deafa dts: battery: add property
Add `re-charge-voltage-microvolt` property allowing to set
limit to automatically start charging again.

Signed-off-by: Lukasz Madej <l.madej@grinn-global.com>
2024-03-26 16:18:31 -04:00
Lukasz Madej f1b35a5c78 drivers: charger: charger_max20335: handle minimum system voltage
Allow to configure minimum system voltage threshold parameter.

Signed-off-by: Lukasz Madej <l.madej@grinn-global.com>
2024-03-26 16:18:31 -04:00
Lukasz Madej 20bfa7d38d dts: bindings: charger: max20335: use enum for property
Add enum for `constant-charge-voltage-max-microvolt` property to
signalize improper values given with device tree at compile time.

Signed-off-by: Lukasz Madej <l.madej@grinn-global.com>
2024-03-26 16:18:31 -04:00
Lukasz Madej d791526dd8 drivers: charger: charger_max20355: fix configuration
Maximum charging current is selected with an external resistor in
the MAX20335 charger. Therefore it is not possible to configure it
with software directly. There is only a capability to limit current
set with hardware but configuration of the limiter is not
straight-forward.

To reflect real functionality, drop usage of
`constant-charge-current-max-microamp` property as an required one and
use custom `chgin-to-sys-current-limit-microamp` instead.
Use enum in binding file to signalize improper values at compile time.

Drop support for `CHARGER_PROP_CONSTANT_CHARGE_CURRENT_UA` API property
since this cannot be handled.

The `max20335_get_constant_charge_current()` function become useless so
remove it.

Signed-off-by: Lukasz Madej <l.madej@grinn-global.com>
2024-03-26 16:18:31 -04:00
Flavio Ceolin 9c27b21ecb doc: security: Add information about Open Security Training
Add information and links for open source security training.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-03-26 16:16:08 -04:00
Alberto Escolar Piedras f207cfec54 docs twister: Mention the env filter
Quite many users do not know that it exists, as we
don't seem to have it documented anywhere.

Signed-off-by: Alberto Escolar Piedras <alberto.escolar.piedras@nordicsemi.no>
2024-03-26 11:21:22 -05:00
Jordan Yates 2e3f8a5f98 doc: _extensions: support snippets option
Support `zephyr-app-commands` being provided with a `snippets`,
option, to specify building with the listed snippets.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2024-03-26 11:14:46 -05:00
Ravi Dondaputi cdd929ff33 doc: migration-guide-3.7: Add wifi shell connect cmd info
Make note of the modifications done to Wi-Fi connect
command in Wi-Fi shell.

Signed-off-by: Ravi Dondaputi <ravi.dondaputi@nordicsemi.no>
2024-03-26 11:13:21 -05:00
Fabio Baltieri 55c14e6fa6 input: analog_axis: rework deadzone calibration code
Rework the data scaling algorithm for the "deadzone" mode so that the
deadzone is subtracted from the input rather than from the output. This
makes the whole output range usable rather than making the output jump
from the center value to the minimum deadzone range.

This changes the calibration data structure as well so now all values
refer to the input data, which is more coherent.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2024-03-26 11:10:10 -04:00
Hessel van der Molen 17d2906cca scripts/size_report: display object address in overview
Shows RAM/ROM address of object in RAM/ROM-report.

Signed-off-by: Hessel van der Molen <hvandermolen@dexels.com>
2024-03-26 10:49:04 -04:00
Kevin ORourke 98aa10d6ea scripts: coredump: coredump_gdbserver in pipeline
Add support to coredump_gdbserver.py for running in a pipeline,
communicating through stdin/stdout instead of a socket.

This allows starting it from inside gdb, with:

    target remote | coredump_gdbserver.py --pipe <elf_file>  <log_file>

Signed-off-by: Kevin ORourke <kevin.orourke@ferroamp.se>
2024-03-26 08:51:49 -04:00
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