Commit Graph

6264 Commits

Author SHA1 Message Date
Fabio Baltieri e9dceed173 doc: guidelines: add a note about ascii and emojis
Add a note about source files encoding and emojis.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2024-04-05 11:54:39 +02:00
Flavio Ceolin d832c12a28 doc: release-notes-3.7: Add CVE-2024-3077 info
Add CVE-2024-3077 to release notes.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-04 12:22:57 -04:00
Flavio Ceolin 2e053e8116 doc: security: CVE-2024-3077 left embargo
Disclose information about CVE-2024-3077.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-04 12:22:57 -04:00
Jukka Rissanen c6ea98eb6f doc: net: Add information for cooked mode capture
Add cooked mode capturing information to network documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
2024-04-04 17:02:11 +02:00
Flavio Ceolin 6c68d62e48 doc: pm: Update device power management documentation
Update information about device power management.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-03 20:41:26 -04:00
Flavio Ceolin 0a44403c46 doc: pm: Change section in device pm
s/System Power Management/System Managed Device Power Management/g

System Power Management is confusing and does not tell
anything about device. Change it for something more explicit.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-03 20:41:26 -04:00
Robert Lubos f211cd6345 net: tcp: Deprecate CONFIG_NET_TCP_ACK_TIMEOUT
Deprecate CONFIG_NET_TCP_ACK_TIMEOUT as it is redundant with the
combination of CONFIG_NET_TCP_INIT_RETRANSMISSION_TIMEOUT and
CONFIG_NET_TCP_RETRY_COUNT. The total retransmission timeout (i. e.
waiting for ACK) should depend on the individual retransmission timeout
and retry count, having separate config is simply ambiguous and
confusing for users.

Moreover, the config was currently only used during TCP handshake, and
for that purpose we could use the very same timeout that is used for the
FIN timeout. Therefore, repurpose the fin_timeout_ms to be a generic,
maximum timeout at the TCP stack.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2024-04-03 15:32:45 -04:00
Stine Åkredalen 96364d29b7 doc: Bluetooth: Mesh: Clarify AES usage in DFU metadata
Added clarification on AES-CMAC usage in DFU metadata, emphasizing its
sole role as a hashing function for the incoming composition data hash.
Notably, it utilizes a fixed key and is not employed for encryption
purposes.

Signed-off-by: Stine Åkredalen <stine.akredalen@nordicsemi.no>
2024-04-03 15:42:45 +01:00
Benjamin Cabé 8f17c830ed doc: generate sitemap.xml
Generate a sitemap.xml for the documentation.
This aims at helping search engines react faster to the addition/removal
of new pages.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-04-03 12:34:04 +03:00
Théo Battrel f3c93e0302 Documentation: Update shell completion doc
- Remove OS specific instructions, instructions depend on the shell and
are the same across OS;
- Add fish shell to the documentation.

Signed-off-by: Théo Battrel <theo.util@protonmail.ch>
2024-04-02 15:07:19 +02:00
Luis Ubieda 92e0d0bbfc bluetooth: nus: Change Kconfigs prefix to BT_ZEPHYR_NUS
To prevent future conflicts with NCS's NUS implementation, whose
Kconfig's are prefixed with BT_NUS.

Signed-off-by: Luis Ubieda <luisf@croxel.com>
2024-04-02 10:36:01 +03:00
Armin Brauns 95227b6fd5 doc: relnotes: mention new FAT FS Kconfig option
See #69791.

Signed-off-by: Armin Brauns <armin.brauns@embedded-solutions.at>
2024-04-01 11:04:56 +01:00
Gaetan Perrot 97f8745eec doc: posix: mark set and get inheritsched as supported
`pthread_attr_getinheritsched()` and
`pthread_attr_setinheritsched()` are now implemented,
mark it so.

signed-off-by: Gaetan Perrot <gaetanperrotpro@gmail.com>
2024-04-01 11:04:35 +01:00
Robert Lubos 8e2722e1ca net: Provide separate configs for TX/RX memory pool for variable bufs
Instead of having a single config specifying the memory pool size for
variable-sized net buffers, have a separate one for TX and RX for better
configuration granularity when optimizing memory usage of the
application.

Deprecate the old configuration but use its value as a default (for now)
for the new configs. This will need to change when the config is
deleted.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2024-03-29 15:56:07 -05:00
Benjamin Cabé 566b4900ce doc: api: fix broken links to API overview
fix incorrectly formatted sphinx links

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-03-29 15:53:58 -05:00
Javan lacerda dbfc1aaec6 scripts: dts: update pyyaml version
The currently used PyYaml version has some vulnerabilies as
described on the pull request description. It updates to
version 6.0, removing these supply chain vulnerabily.
The OSSF Scorecard was the tool used for discovering
 these vulnerabilties.

Signed-off-by: Javan lacerda <javanlacerda@google.com>
2024-03-29 09:03:34 -04:00
Fin Maaß fe5313fa61 doc: releases: release-notes: 3.7: add informations on dhcpv4 options
Add documentation for new use of dhcpv4 options.

Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>
2024-03-29 11:15:42 +00:00
TOKITA Hiroshi ddf31820b0 doc: scripts: redirects: fix redirect for led_strip samples
Since I have integrated some samples into samples/drivers/led_strip,
seting up redirection from the deleted apa102, lpd8806, and ws2812.

Signed-off-by: TOKITA Hiroshi <tokita.hiroshi@gmail.com>
2024-03-28 09:43:05 +00:00
Jukka Rissanen 47f6048490 doc: migration-guide-3.7: Add Virtual LAN (VLAN) information
The Virtual LAN is changed to use the virtual network interfaces.
Add information what changes might be needed because of this.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
2024-03-28 09:41:38 +00:00
Jukka Rissanen b4bf23220d doc: migration-guide-3.7: Add NET_SOCKETS_POSIX_NAMES info
Add CONFIG_NET_SOCKETS_POSIX_NAMES deprecation information.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
2024-03-27 13:40:13 -05:00
Jukka Rissanen 9dad97ae95 doc: net: Remove the mention of NET_SOCKETS_POSIX_NAMES
The option is deprecated so remove it from documentation.

Signed-off-by: Jukka Rissanen <jukka.rissanen@nordicsemi.no>
2024-03-27 13:40:13 -05:00
Jonathan Rico d73b6e50b9 doc: bsim: Add three more rules
On the request of the maintainer.

Background:

We have recently had issues with tests timing out because of the
difference of speed between CI runners and a standard developer machine.

In that case, the logs are printed, and some tests (by yours truly) are
a bit on the chatty side. Github's UI chokes (for a good minute or more
lol) on more than a few hundred lines, so it's a bad experience for
contributors.

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-27 14:34:01 +00:00
Jonathan Rico 97d47204c5 doc: bsim: Reword test script conventions
Try to make it more terse, and remove duplicate lines.

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-27 14:34:01 +00:00
Jonathan Rico da7ce2f333 doc: bsim: Add paragraph about runner conventions
Alberto had a bad time.

Signed-off-by: Jonathan Rico <jonathan.rico@nordicsemi.no>
2024-03-27 14:34:01 +00:00
Chris Friedt 0bcf71e28a doc: posix: add POSIX_NETWORKING Option Group and mark supported
Mark the POSIX_NETWORKING Option Group as supported. The
POSIX_NETWORKING Option Group is required for PSE53 Conformance.

Signed-off-by: Chris Friedt <chrisfriedt@gmail.com>
2024-03-27 07:36:18 -04:00
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