Commit graph

6336 commits

Author SHA1 Message Date
Jamie McCrae ff823c63ee doc: build: flashing: Add documentation
Adds documentation on the new flashing configuration system

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2024-04-29 17:56:19 +01:00
Pieter De Gendt 79b8285c6b doc: releases: 3.5: Fix COFNIG typo
Fixing a typo for a `Kconfig` option.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2024-04-29 17:40:39 +01:00
Jamie McCrae 0408eee229 doc: release: 3.7: Add socs folder note
Adds release notes about the addition of a socs folder for
applications to store Kconfig fragments and devicetree overlays

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2024-04-29 15:08:35 +01:00
Jamie McCrae af467659de doc: build: Add details on SoC overlays
Adds details about Kconfig fragments and devicetree overlay files
that will be included in a build if they are found in the
``socs`` folder

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2024-04-29 15:08:35 +01:00
Andrej Butok c8f12c9273 doc: kconfig: fix HAS_CONFIGURABLE_FOO
Use HAS_CONFIGURABLE_FOO instead of wrong HAS_CONFIGURABLE.

Signed-off-by: Andrej Butok <andrey.butok@nxp.com>
2024-04-29 15:53:34 +02:00
Chris Friedt 35429debb6 doc: posix: add visualization diagram for aep, si, pse51-pse53
Add a diagram that was first created for eoss 2024 to help
visualize the relation between the different application
environment profiles of IEEE 1003.13-2003.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-04-29 14:08:59 +02:00
Chris Friedt c0dc8d1426 doc: posix: aep: condense aep documentation
The POSIX Application Environment Profiles are additive and
offer incrementally more features over the System Interfaces.

For example, PSE51 includes all of the features of the Minimal
Realtime System Profile plus all of the System Interfaces.
PSE52 includes all of the features of the Realtime Controller
System Profile, plus the features of PSE51, plus the System
Interfaces, and so on.

It makes sense to take advantage of that and to condense the
AEP documenation.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-04-29 14:08:59 +02:00
Chris Friedt 37462aec6d doc: posix: option_groups: additional options and option groups
Define additional options and option groups for PSE51 to PSE53.

The options groups added in this commit are:

POSIX_SIGNAL_JUMP
POSIX_FILE_SYSTEM
POSIX_PIPE
POSIX_FILE_LOCKING

The options added in this commit are:

_POSIX_MEMLOCK
_POSIX_MEMLOCK_RANGE
_POSIX_MONOTONIC_CLOCK
_POSIX_SHARED_MEMORY_OBJECTS
_POSIX_THREAD_CPUTIME

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-04-29 14:08:59 +02:00
Chris Friedt 57ff7c9f7e doc: posix: conformance: reorder _POSIX_THREAD_CPUTIME
_POSIX_THREAD_CPUTIME was listed out of alphabetical order.

Move it to the correct location.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-04-29 14:08:59 +02:00
Chris Friedt ee2c2f6488 doc: posix: overview: add missing :ref: in subprofiles section
Previously, some links were not resolving properly since they
lacked the :ref: prefix, so it was added.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-04-29 14:08:59 +02:00
Chris Friedt 28a69a8e80 doc: posix: mark asyncronous io as being supported
Mark the _POSIX_ASYNCHRONOUS_IO headers as supported, and note
the deviation that they return -1 and set errno to ENOTSUP.

At some later date, it might be possible to implement the
standard functions with other Zephyr API calls.

Signed-off-by: Chris Friedt <cfriedt@tenstorrent.com>
2024-04-29 11:02:11 +02:00
Johan Hedberg d590bcb5e0 Bluetooth: Remove BT_HCI_RESERVE and BT_HCI_RAW_RESERVE
In most cases these were defined as 1. Saving one byte for the rest
doesn't really justify the added complexity that comes with these
options. Removing them also simplifies the interface between HCI
transports/drivers and the host stack, which in turn helps pave the way
for having HCI as a proper Zephyr driver API.

Fixes #71907

Signed-off-by: Johan Hedberg <johan.hedberg@gmail.com>
2024-04-29 11:01:27 +02:00
Flavio Ceolin c059405da5 docs: pm: Fix typo
s/seatures/features/g

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-27 11:06:06 +03:00
Flavio Ceolin a9cf4a16ad docs: pm: Change API section name
Add APIs suffix to distinguish this section from others
power management sections.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Flavio Ceolin 1aaf597e4f docs: pm: Add introduction section in system pm
Create a introduction section just like the others chapters.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Flavio Ceolin bbd9d3dc5d docs: pm: Add examples to power domains
Add specific power dmains samples in power domains section.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Flavio Ceolin b4d3f47466 docs: pm: Add examples to device runtime pm
Add specific device runtime power management samples to device runtime
pm section.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Flavio Ceolin eff0e4f6b1 docs: pm: Add examples to device pm
Add specific device power management samples to device pm section.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Flavio Ceolin 63d7e459bb docs: pm: Organize device pm sections
Instead of chapters, make device runtime power management and
system-managed device power management sections.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Flavio Ceolin d07f3c3da3 doc: pm: Remove power domain section in device
There is a whole section dedicated to power domains. The brief
information in device power management was not adding anything.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2024-04-26 16:12:16 +02:00
Tim Lin 130ead6f20 doc: migration-guide-3.7 & release-notes-3.7: Rename the Kconfig symbol
Rename the Kconfig symbol for all ITE SoC variants.
Rename the SOC_SERITES_ITE_IT8XXX2 to SOC_SERIES_IT8XXX2.

Signed-off-by: Tim Lin <tim2.lin@ite.corp-partner.google.com>
2024-04-26 16:10:55 +02:00
Daniel Baluta 3948a5e8f9 doc: board_porting: Add Cadence HIFI4 core to documentation
This enhances the description of i.MX8MPlus SoC with the Cadence HIFI4
core and thus will make this example more relevant to the benefits of
HWMv2.

Signed-off-by: Daniel Baluta <daniel.baluta@nxp.com>
2024-04-25 18:01:36 -04:00
Fabio Baltieri a466fb05d0 doc: services: pm: mention the pm shell option
Add a paragraph about the CONFIG_PM_DEVICE_SHELL option and how to use
it.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2024-04-25 18:00:05 -04:00
Håvard Reierstad f597e7d2a9 doc: Bluetooth: Mesh: Remove experimental DFU statement
Removes statement saying the implementation for Mesh DFU is
experimental.

Signed-off-by: Håvard Reierstad <haavard.reierstad@nordicsemi.no>
2024-04-25 09:45:51 -04:00
Daniel DeGrasse 7150877801 doc: develop: flash_debug: add note for LinkServer breakpoints
LinkServer does not set a breakpoint at reset by default when debugging
platforms, so if the user single steps after loading an application they
will likely step through ROM code for the target. Add a note clarifying
that users need to set a breakpoint at the reset handler or "main" in
order to pause their application there.

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2024-04-25 08:59:44 -04:00
Pieter De Gendt 01bd72b9eb doc: releases: release-notes: 3.7: mention deprecation of CSTD
Add an entry that the CSTD cmake property is deprecated and replaced
with a kconfig choice.

Signed-off-by: Pieter De Gendt <pieter.degendt@basalte.be>
2024-04-25 09:54:39 +00:00
Yong Cong Sin 30b122b3f0 arch: riscv: print callee-saved-registers in fatal error
Print callee-saved registers during fatal error
to help with debugging.

Signed-off-by: Yong Cong Sin <ycsin@meta.com>
2024-04-24 15:57:40 -04:00
Tomi Fontanilles 21efdc23c9 drivers: gnss: nmea_generic: implement basic power management
As of now only the resume action is supported, and doesn't perform
any power action on the GNSS modem.
It allows to initialize the GNSS driver later than it would otherwise
be.

Also, the driver now runs a modem-specific chat script on resumption.

Signed-off-by: Tomi Fontanilles <tomi.fontanilles@nordicsemi.no>
2024-04-24 15:00:10 -04:00
Paulo Santos 6173f71d42 samples: drivers: adc: naming adc sample
The adc sample was in the root directory of the adc samples.
Move all the files to a subdirectory adc_dt.

Signed-off-by: Paulo Santos <pauloroberto.santos@edge.ufal.br>
2024-04-24 09:53:18 +02:00
Lukasz Mrugala 5a9ae4547f doc: release: Add information about blackbox tests
Major development work is concluded for Twister tests.
We should release appropriate information.

Signed-off-by: Lukasz Mrugala <lukaszx.mrugala@intel.com>
2024-04-23 19:44:36 -04:00
Anas Nashif 7f721bada2 doc: expand ZTEST macros in doxygen
This will allow expansion of various ZTEST macros to display the actual
test function rather than the ZTEST macro itself.

Inspired by a change in #71402 by @gmarull.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2024-04-23 21:46:38 +00:00
Théo Battrel 909ad8170c Bluetooth: Host: Deprecate auto name in AD
Deprecate the advertiser options `BT_LE_ADV_OPT_USE_NAME` and
`BT_LE_ADV_OPT_FORCE_NAME_IN_AD`.

Reasons:

- It is out of place in the advertiser options, as it acts on
  advertising data and not configuration
- The behavior is not clear. All of these are trick questions:
  - where does the data for the name go?
  - do I have to allocate memory for this?
  - does it work the same in legacy vs extended advertising?
- The trade-off between UX improvement and extra complexity in the host
  is debatable. Hundreds of lines in the stack to avoid making the user
  type out less than ten.

Also deprecate the following macros that uses those options:

- `BT_LE_ADV_CONN_NAME`
- `BT_LE_ADV_CONN_NAME_AD`
- `BT_LE_ADV_NCONN_NAME`
- `BT_LE_EXT_ADV_CONN_NAME`
- `BT_LE_EXT_ADV_SCAN_NAME`
- `BT_LE_EXT_ADV_NCONN_NAME`
- `BT_LE_EXT_ADV_CODED_NCONN_NAME`

Update the migration guide and the release note for Zephyr 3.7 to
describe those changes.

Signed-off-by: Théo Battrel <theo.battrel@nordicsemi.no>
2024-04-23 12:42:24 +02:00
Théo Battrel 6c9010be9f Bluetooth: Shell: Remove usage of auto name in AD
The advertiser options to automatically add the name in the scan
response and the advertising data will be deprecated.

Update the Bluetooth shell and its documentation to not use those
options anymore.

The option of the legacy advertiser run with `bt advertise` and the
behavior hasn't changed. The code has been updated to no longer use the
advertiser option but the original behavior has been reproduced.

The option of the extended advertiser have been updated to be more
explicit. The options `name` and `name-ad` have been removed from the
`bt adv-create` and `bt adv-param`. The option `name` and `dev-name`
have been added to the `bt adv-data` command.

- `name <str>` will advertise the given name.
- `dev-name` will advertise the device name.

Signed-off-by: Théo Battrel <theo.battrel@nordicsemi.no>
2024-04-23 12:42:24 +02:00
Peter Mitsis 41676df683 doc: Add Xtensa HiFi documentation
Adds some documentation about the Xtensa HiFi AudioEngine DSP and
how to enable its use with Zephyr.

Signed-off-by: Peter Mitsis <peter.mitsis@intel.com>
2024-04-22 15:21:15 -04:00
Fin Maaß bb2e53656f doc: release-notes: 3.7: new hawkbit features
Mention new features of hawkbit in the release notes.

Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>
2024-04-22 09:09:56 -04:00
Karthikeyan Krishnasamy 5233a4fa92 doc: posix: mark ftruncate as supported
Add POSIX FD_MGMT option and mark ftruncate as supported
in POSIX Option group Documentation

Signed-off-by: Karthikeyan Krishnasamy <karthikeyan@linumiz.com>
2024-04-22 04:33:16 -07:00
Karthikeyan Krishnasamy 1ddefc6ba0 doc: posix: mark fynsc as supported
Mark fsync as supported in POSIX options Documentation

Signed-off-by: Karthikeyan Krishnasamy <karthikeyan@linumiz.com>
2024-04-22 04:33:16 -07:00
Yong Cong Sin 6a497ac373 doc: release: add notes on RISC-V's stack unwinding
Add an entry in the RISC-V arch section about the
implementation of frame-pointer based stack unwinding.

Signed-off-by: Yong Cong Sin <ycsin@meta.com>
2024-04-20 13:54:43 -04:00
Fin Maaß 9292864a19 doc: releases: 3.7: change of hawkbit
Mention change of hawkbit in the migration guide and the release notes.

Signed-off-by: Fin Maaß <f.maass@vogl-electronic.com>
2024-04-19 16:39:31 +00:00
Ajay Parida edba435f76 doc: release-notes: Set RTS threshold
Added support to set RTS threshold.

Signed-off-by: Ajay Parida <ajay.parida@nordicsemi.no>
2024-04-18 08:42:29 -07:00
Jamie McCrae 3d48ad90c9 doc: develop: application: Fix missed HWMv2 changes
Fixes outdated information that was missed with the HWMv2 migration

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2024-04-18 08:06:49 -07:00
Declan Snyder 2c4e75587f doc: migration-guide-3.7: Add NXP ENET info
Add to migration guide info about the nxp,enet binding change.

Signed-off-by: Declan Snyder <declan.snyder@nxp.com>
2024-04-18 11:18:31 +02:00
Declan Snyder fdbba0341c drivers: nxp_enet: Deprecate ETH_MCUX
Deprecate ETH_MCUX, by:

- Marking it as DEPRECATED in Kconfig, obviously.
- Unmarking the new driver as experimental.
- Putting the new and old drivers in the same folder.
- Reworking the menu appearance of the driver selection.
  Note that technically now it is possible to choose the wrong
  driver than what is enabled in DT, this is intentional, but
  the correct one will obviously be enabled by default.
- Convert all sample overlays to the new Kconfigs. This was
  part of the motivation for the shared overlays, as it was
  causing twister/CI logs to look ugly and misleading due
  to Kconfig warnings.

Signed-off-by: Declan Snyder <declan.snyder@nxp.com>
2024-04-18 11:18:31 +02:00
Dmytro Yaskov fc68d26e9c doc: hardware: peripherals: mipi_dbi: Added a newline to fix a typo
Added a newline to display the list correctly

The list is displayed like:
MIPI DBI defines 3 interface types: * Type A: Motorola 6800 parallel bus
 * Type B: Intel 8080 parallel bus

But it should be like:
MIPI DBI defines 3 interface types:
 * Type A: Motorola 6800 parallel bus
 * Type B: Intel 8080 parallel bus

This was fixed by an example from another doc:
doc/hardware/peripherals/i3c.rst

Signed-off-by: Dmytro Yaskov <dmytro.v.yaskov@gmail.com>
2024-04-18 11:16:09 +02:00
Carles Cufi db801c5e9b doc: porting: boards: Update the terminology diagram
The current diagram uses a custom font that does not render correctly on
some browsers. Replace it with a common font (Courier New) instead so
that there are no rendering issues.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2024-04-18 11:09:10 +02:00
Andries Kruithof d96f98188c Bluetooth: CAP: Shell: Add cancel command
We didn't have a cancel command for the CAP commander, so adding this
command here.

Signed-off-by: Andries Kruithof <andries.kruithof@nordicsemi.no>
2024-04-17 14:31:56 +02:00
Benjamin Cabé 9ebf341977 west: spdx: introduce support for SPDX 2.3
Minor update to existing zspdx implementation to add support for
PrimaryPackagePurpose introduced in SPDX 2.3.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2024-04-16 10:07:49 -07:00
Emil Gydesen 2314a2ca64 docs: Bluetooth: Add additional notes about LE Audio
LE Audio sticks out in a few ways that's worth knowing
not only as a contributor, but also as an application
developer. These things have been documented, and may be
expanded upon later.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-04-15 10:55:14 -07:00
Emil Gydesen 2b7f5dce25 Bluetooth: Audio: Shell: Runtime config of CAP/GMAP ACs
Modifies the audio configuration (ac) commands for CAP
and GMAP to use the default presets instead of supplying
the preset as arguments. This will allow the user to
use the `bap preset` command to configure everything in the
codec configuration before the AC commands are issued.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-04-15 12:56:33 +02:00
Emil Gydesen 06b31aa4b9 docs: Bluetooth: Audio: Add notes on the design and data placements
Add notes on how the LE Audio stack is designed and why data is
sometimes placed and controlled by the stack or the application.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2024-04-15 12:54:58 +02:00