Commit graph

3905 commits

Author SHA1 Message Date
Gerard Marull-Paretas 81d2768016 doc: remove reference to deleted Kconfig option
CONFIG_LOG_IMMEDIATE has been removed, replace reference with literal.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-02-08 07:02:47 -05:00
Gerard Marull-Paretas d7c48d0dfb doc: guides: pm: fix incorrect Kconfig reference
Kconfig options need CONFIG_ prefix when referenced.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-02-08 07:02:47 -05:00
Flavio Ceolin b64b4a49aa doc: releases: 3.0: Add security notes
Add information about vulnerabilities fixed in this release.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2022-02-08 07:02:36 -05:00
Flavio Ceolin ead018cb12 security: docs: Add CVE-2021-3861
Add information about CVE-2021-3861

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2022-02-08 07:02:36 -05:00
Flavio Ceolin 2a0ae5edac security: docs: Add CVE-2021-3835
Add information about CVE 2021-3835

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2022-02-08 07:02:36 -05:00
Aleksander Wasaznik d54ae955a2 Bluetooth: ATT: Fix conn parameter to req cb in att_reset
The conn pointer is still valid / not reused at this time and can be
used further up the stack as an identifer. This simplifies the API of
ATT, and fixes callbacks in GATT that pass on this value directly since
their API does not allow conn to be NULL.

Fixes #41794

Signed-off-by: Aleksander Wasaznik <aleksander.wasaznik@nordicsemi.no>
2022-02-07 17:00:51 +01:00
Gerard Marull-Paretas 956d49ad66 doc: extensions: doxyrunner: do not modify extension config
After the introduction of #41688, doxyrunner extension modifies the
fmt_vars content (from a variable defined in `conf.py`) when the output
directory variable is defined. This means that Sphinx will always get an
outdated environment and so will always perform a full build instead of
an incremental build. This patch makes a copy first to prevent this
situation.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-02-05 06:24:26 -05:00
Henrik Brix Andersen 8de57819e9 doc: releases: 3.0: add CAN related release notes
Add CAN related release notes for Zephyr v3.0.0.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2022-02-05 06:18:07 -05:00
Carles Cufi 7f6524949a lib: os: crc: Rework the crc16() implementation
As described in #42403, there was an issue with the existing crc16_ansi()
implementation, since it was not calculating the CRC-16-ANSI (aka
CRC-16-MODBUS). This is because the  existing crc16() function only
supported non-reflected input and output (and the CRC-16-ANSI requires
reflection on both) and also it did not seem to support correctly inial
seeds different from 0x0000 (and, again, the CRC-16-ANSI requires 0xffff
as an initial seed).

This commit replaces the existing crc16() with a functional pair,
crc16() and crc16_reflect(), that also work with any poly, any initial seed
and allow to select whether reflection is performed.
It also adapts crc16_ansi() so that it actually returns the correct CRC.

Fixes #42403.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-02-04 12:33:22 -05:00
Aymeric Aillet b2aa94850b doc: release: 3.0: Add new I2C switch support
Modified TCA9546a driver to support more switch references.
Added support for TCA9548A.

Signed-off-by: Aymeric Aillet <aymeric.aillet@iot.bzh>
2022-02-04 08:57:09 -06:00
Aymeric Aillet 34207ad7e3 doc: release: 3.0: Add new R-Car platform drivers
Added I2C driver.

Signed-off-by: Aymeric Aillet <aymeric.aillet@iot.bzh>
2022-02-04 08:57:09 -06:00
David Leach cbdc8652ff doc: release: Update 3.0 release notes with NXP changes
Capture SOC and board additions plus any support updates.

Signed-off-by: David Leach <david.leach@nxp.com>
2022-02-04 11:18:26 +01:00
Henrik Brix Andersen 127c621275 doc: releases: 3.0: add EEPROM related release notes
Add EEPROM related release notes for Zephyr v3.0.0.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2022-02-03 14:08:46 -06:00
Jonathan Hahn 623bee2e68 doc: devicetree: fix broken link in api.rst
The devicetree binding link for fixed-partitions was
broken.

Signed-off-by: Jonathan Hahn <Jonathan.Hahn@t-online.de>
2022-02-03 14:01:25 -06:00
Kevin Townsend 43a97c84bd doc: releases: 3.0: add TF-M release notes
Mention update to TF-M 1.5.0 in Zephyr 3.0.

Signed-off-by: Kevin Townsend <kevin.townsend@linaro.org>
2022-02-03 13:59:51 -06:00
Carles Cufi 7107f7a00d doc: guides: Building the documentation
Add a couple of missing Arch packages for the .pdf build.

Fixes #41887.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-02-03 07:32:43 -05:00
Daniel Leung 6964f2b130 doc: toolchain: add a few words about XCC
This adds a few words about setting up XCC.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2022-02-02 18:39:24 -05:00
Christopher Friedt f2d675b7c5 doc: spinlock: ensure spinlock api is added to doxygen
Previously, `k_spin_lock()` and friends had broken links
in html docs.

Fixes #42373

Signed-off-by: Christopher Friedt <chrisfriedt@gmail.com>
2022-02-02 08:57:14 -05:00
Tom Burdick 8236cdb30b doc: release_notes: Note all my changes
Changes made to i2c, dma, and tracing for improved debugability
and hardware support. Adding driver level stats, dma api improvements,
and syscall tracing.

Signed-off-by: Tom Burdick <thomas.burdick@intel.com>
2022-02-01 12:30:14 -05:00
Gerson Fernando Budke 7d108d54f5 doc: release: 3.0: Add notes related to Atmel
Add 3.0.0 release notes for Atmel SoCs, drivers and boards.

Signed-off-by: Gerson Fernando Budke <nandojve@gmail.com>
2022-02-01 12:10:44 -05:00
Gerard Marull-Paretas 84fd7f35d5 doc: release-notes: add GigaDevice changes
Initial support for GigaDevice is now available upstream. This patch
lists relevant additions such as supported boards, drivers, etc.

Signed-off-by: Gerard Marull-Paretas <gerard@teslabs.com>
2022-02-01 08:18:46 -05:00
Gerard Marull-Paretas 341b042a84 doc: release-notes: add pin control
Add a new section for pin control, mentioning the new API, link to the
guide and platforms already supporting the API.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-02-01 08:18:28 -05:00
Gerard Marull-Paretas 6f0fab162c doc: release-notes: add documentation highlights
Mention new Doxygen theme.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-02-01 08:18:28 -05:00
Gerard Marull-Paretas e2c514f9d9 doc: release-notes: add new Devicetree macros
Add list of new Devicetree macros.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-02-01 08:18:28 -05:00
Gerard Marull-Paretas 91198b762a doc: release-notes: add deprecated device API macros/functions
Add list of deprecated device API macros and functions.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-02-01 08:18:28 -05:00
Gerard Marull-Paretas 0e668396bd doc: release-notes: add power management release notes
Add relevant changes to the PM subsystem.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-02-01 08:18:28 -05:00
Andrzej Puzdrowski 48c0faba1f release-note: Record on removal of the flash write protection API
Added API removal record and ite_8xxx2 rework record.

Signed-off-by: Andrzej Puzdrowski <andrzej.puzdrowski@nordicsemi.no>
2022-02-01 10:46:28 +01:00
Maureen Helm 20c1e1a800 doc: release: Add sensor release notes for v3.0.0
Documents significant changes to sensor drivers in the v3.0.0 release,
including new drivers added and existing drivers modified.

Signed-off-by: Maureen Helm <maureen.helm@intel.com>
2022-01-31 19:04:26 -05:00
Gerard Marull-Paretas 81d43510a4 doc: getting_started: linux: reference to the 3rd party compilers page
The documentation was talking about not using Zephyr's SDK, but
referenced back to the GSG where only Zephyr SDK is covered in detail.
Refer to the 3rd party compilers page, where relevant information can be
found.

Fixes #42272

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-01-31 18:40:26 -05:00
Erwan Gouriou a053063178 doc/release-notes: V3.0: STM32 add-on
Update V3.0.0 release note with STM32 additions.

Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2022-01-28 19:15:31 -05:00
Daniel Leung 14ac190765 doc: release: 3.0: mention new UART API
This adds a brief mentioning of new UART API to support
datum wider than 8-bit.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2022-01-27 05:23:57 -05:00
Daniel Leung ce238f7acf doc: release: 3.0: add info for Xtensa
This adds a few bullet points in the 3.0 release note
for Xtensa.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2022-01-27 05:23:57 -05:00
Daniel Leung 6f3f752607 doc: release: 3.0: make API changes sub-headers visible
() There are two "Changes in this release" so combine them.
() Make "Removed" and "Deprecated" into headers so they appera
   in the TOC on the left.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2022-01-27 05:23:57 -05:00
Emil Gydesen 9140a8ac46 Bluetooth: shell: Add LE Audio shell commands
Adds audio.c which covers all the LE Audio shell commands.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2022-01-27 12:01:34 +02:00
Antony Pavlov ac0c1e4192 doc: mention MIPS architecture support
MIPS architecture support was introduced
in 0369998e61 ('arch: add MIPS architecture support').

Also sort supported architectures list alphabetically.

Signed-off-by: Antony Pavlov <antonynpavlov@gmail.com>
2022-01-24 17:11:42 -05:00
Maureen Helm 1a7bc06086 debug: Remove deprecated CONFIG_OPENOCD_SUPPORT
CONFIG_OPENOCD_SUPPORT was deprecated in favor of
CONFIG_DEBUG_THREAD_INFO in Zephyr v2.6.0 and can now be removed.

Signed-off-by: Maureen Helm <maureen.helm@intel.com>
2022-01-24 10:23:20 -05:00
Wealian Liao 7467dc4c12 tracing_user: Add ISR nest level parameter
For tracing_user, the sys_trace_isr_enter() & sys_trace_isr_exit()
block any nest interrupts & most SMP interrupts for the user. It is
hard to analyze the IRQ preemption(e.g., each IRQ counter and execution
time). This commit adds ISR nest level for each CPU to the user instead
of blocking user call back when nest interrupts.

Signed-off-by: Wealian Liao <WHLIAO@nuvoton.com>
2022-01-21 14:38:35 -05:00
Jordan Yates afa700d182 doc: guides: index: document Doxygen linking
Document the existance of `zephyr.tag` by providing a link on the main
documentation guide page. Also include an example of how to use this
file in an external project.

Implements #41529.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2022-01-21 14:26:14 -05:00
Jordan Yates b527915738 doc: generate Doxygen tag file
Generate the Doxygen tag file to static html sources directory so that
external documentation can use it as a source for linking. See:
    https://www.doxygen.nl/manual/external.html

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2022-01-21 14:26:14 -05:00
Anas Nashif 76ac2dc478 doc: update list of supported architectures
- Add MIPS to the list.
- Update ARC entry with ARCv3 support.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-01-21 07:27:07 -05:00
Andy Ross aa825d77b0 doc: Clarify k_poll() behavior with respect to signal synchronization
Bug #40189 tripped over an interesting synchronization scenario that
wasn't called out in the docs.  Poll signals are level triggered, and
if you're adjusting the level from a racing context (e.g. resetting it
before the next "event" from an ISR or another thread) the polling
thread might wake up but then miss the event.  Mention this case
explicitly in documentation.

Fixes #40189

Signed-off-by: Andy Ross <andrew.j.ross@intel.com>
2022-01-20 10:57:31 -05:00
Flavio Ceolin 2b9d2f6f6c docs: pm: Add power domain information
Document power domains on Zephyr.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2022-01-19 13:35:32 -05:00
Dominik Ermel b36f29243e doc/guides/mgmt: Mcumgr fixes backporting process
The commit adds guide on backporting mcumgr fixes to Zephyr 2.7.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
Co-Authored-By: Francesco Servidio <francesco.servidio@nordicsemi.no>
2022-01-18 13:15:38 -05:00
Gerard Marull-Paretas ab64a67008 doc: conf: specify which variable is used for output directory
This is needed so that it can be re-used by other Doxygen configuration
entries.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-01-18 13:14:05 -05:00
Gerard Marull-Paretas 7e88a29a7e doc: extensions: doxyrunner: add doxyrunner_outdir_var option
The doxyrunner_outdir_var option allows to specify which variable (if
any) is used to represent the output directory (as used by
OUTPUT_DIRECTORY). This makes sure that other options referencing it are
processed correctly, since the output directory is not passed as a
variable.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-01-18 13:14:05 -05:00
Erwan Gouriou 26cde3ab23 boards: b_u585i_iot02a: Add a non-secure target
Provide a _ns target for b_u585i_iot02a board.
Flash partition is given as default for most applications,
with the following sizes:
MCUBoot: 208K
Secure: 256K
Non secure: 512K

Tested using tfm_ipc sample.

Signed-off-by: Erwan Gouriou <erwan.gouriou@linaro.org>
2022-01-18 10:42:45 -05:00
Jian Kang b89a0f5d24 Fix: Add the doxygen group of heap listener
Add the doxygen contents of heap listener which is missed.
We already have some apis of heap listener, but cannot be display
in our documents. So add the group to show in the doc.

Signed-off-by: Jian Kang <jianx.kang@intel.com>
2022-01-18 10:39:01 -05:00
Krzysztof Chruscinski aff9cfc65a logging: Add assert when wrong backend is used
Add assert when logging v2 is enabled but backend doesn't support it.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-01-17 15:49:10 -05:00
Krzysztof Chruscinski 262cc55609 logging: Deprecate v1, default to v2
Reduced logging mode selection to deferred, immediate, minimal and
frontend. Decoupled logging version from mode and created CONFIG_LOG1
which can be used to explicitly select deprecated version.

From now on, chosing CONFIG_LOG_MODE_{IMMEDIATE,DEFERRED} will result
in version2.

Deprecated CONFIG_LOG2_MODE_{IMMEDIATE,DEFERRED} with cmake warning.

Codebase adapted to those changes.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-01-17 15:49:10 -05:00
Krzysztof Chruscinski dd4035c624 doc: logging: Add note about v1 deprecation
Added note about v1 deprecation.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-01-17 15:49:10 -05:00