Commit Graph

4248 Commits

Author SHA1 Message Date
Emil Gydesen
2e145a3109 doc: Bluetooth: Upstream existing LE Audio shell rsts
Upstream the LE Audio shell rsts that briefly describe
how some of the LE Audio modules work.

Signed-off-by: Emil Gydesen <emil.gydesen@nordicsemi.no>
2022-06-28 14:50:11 +02:00
Robert Lubos
5825c60b3d doc: net: Add HTTP client library page
Add brief documentation for the HTTP client library and reference its
API.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2022-06-27 16:29:16 +02:00
Daniel Leung
74c7bf5ae5 doc: release-3.2: note on removal of deprecated work queue API
This adds a note about removal of deprecated work queue API.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2022-06-27 12:46:21 +02:00
Robert Lubos
4ec098ac5a doc: net: Document POSIX wrappers for socket operations
Document POSIX wrappers for socket operations, by referencing a
corresponsding `zsock_*` function. The documentation will generate a
link where user can read the actual documentation on the socket
operation.

In order to include the POSIX wrappers in to the documentation however,
it's needed to add CONFIG_NET_SOCKETS_POSIX_NAMES to predefined symbol
list in zephyr.doxyfile.in.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2022-06-24 20:29:37 +02:00
Lauren Murphy
318e6db239 debug: coredump: add xtensa intel adsp, support toolchains
Adds compatibility with Intel ADSP GDB from Zephyr SDK and
from Cadence toolchain to coredump_gdbserver.py.

Adds CAVS 15-25 (APL) register definitions. Implements
handle_register_single_read_packet to serve ADSP GDB
p packets.

Prevents BSA from changing between stack dump printout
and coredump by taking lock. Observed to be necessary for
accurate results on slower simulated platforms.

Signed-off-by: Lauren Murphy <lauren.murphy@intel.com>
2022-06-23 15:44:45 -04:00
Dominik Ermel
492e2ed741 doc/guides/device_mgmt/smp: Extend reset command with force option
The commit documents OS reset command extension that allows to
force reset, when OS responds with busy "rc" code to reset
attempts.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-06-21 11:55:19 +02:00
Dominik Ermel
0a5525358c mgmt/mcumgr/lib: Add BUSY error code
The commit reserves adds MGMT_ERR_EBUSY (10) error code and adds
documentaiton for it.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-06-21 11:55:19 +02:00
Stephanos Ioannidis
bd0f5f9816 doc: project: Fix role nomination template URL
This commit fixes the URL for the role nomination template that
incorrectly specified the 'bug' label instead of the 'Role Nomination'
label.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-06-17 10:27:49 -05:00
Krzysztof Chruscinski
c5f2cdef09 logging: Remove logging v1 from the logging
Remove v1 implementation from log_core and all references in the tree.
Remove modules used by v1: log_list and log_msg.
Remove Kconfig v1 specific options.
Remove Kconfig flags used for distinction between v1 and v2.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-06-16 10:51:15 -04:00
Carlo Caione
b6a3d598f3 device_mmio: Introduce DEVICE_MMIO_NAMED_ROM_INIT_BY_NAME
Currently the device MMIO APIs is only able to map single DT-defined
regions and also the _NAMED variant is assuming that each DT-defined
device has only one single region to map.

This is a limitation and a problem when in the DT are defined devices
with multiple regions that need to be mapped.

This patch is trying to overcome this limitation by introducing the
DEVICE_MMIO_NAMED_ROM_INIT_BY_NAME macro that leveraged the 'reg-names'
DT property to map multiple regions defined by a single device.

So for example in the DT we can have a device like:

  driver@c4000000 {
    reg = <0xc4000000 0x1000>, <0xc4001000 0x1000>;
    reg-names = "region0", "region1";
  };

and then we can use DEVICE_MMIO_NAMED_ROM_INIT_BY_NAME doing:

  struct driver_config config = {
    DEVICE_MMIO_NAMED_ROM_INIT_BY_NAME(region0, DT_DRV_INST(0)),
    DEVICE_MMIO_NAMED_ROM_INIT_BY_NAME(region1, DT_DRV_INST(0)),
  };

Signed-off-by: Carlo Caione <ccaione@baylibre.com>
2022-06-16 11:26:10 +02:00
Al Semjonovs
92bc3e47c0 ztest: Test selection documentation.
Explain usage of the `-test` command line argument for
posix builds.

Signed-off-by: Al Semjonovs <asemjonovs@google.com>
2022-06-15 18:06:54 -04:00
Gerard Marull-Paretas
c7e4388b1d doc: contribute: guidelines: replace uncrustify with clang-format
Prefer clang-format over uncrustify for source code formatting.
uncrustify configuration files will be removed in future commits.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-06-15 09:37:30 -04:00
Krzysztof Chruscinski
fd622650c3 doc: logging: Remove references to logging v1
Remove references to logging v1 from the logging documentation.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-06-15 09:14:05 +02:00
Carles Cufi
26294ced09 doc: Rename API meeting to Architecture meeting
As per the decision to rename this meeting and make it into a working
group, document this in the official docs.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-06-14 16:07:38 +02:00
Anas Nashif
798a552daf boards: intel_s1000_crb: remove board/soc
Remove the intel_s1000_crb board. it is no longer available or supported
in the zephyr tree.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-06-13 16:19:51 -04:00
Martí Bolívar
b9e833366f doc: dts: bindings: formalize case and separator
It is a general recommendation to use lowercase characters and dashes
in property names instead of uppercase and underscores. Make this a
formal rule for upstream Zephyr bindings.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-06-10 12:26:33 -07:00
Kumar Gala
a7af8ce6a7 drivers: disk: Remove use of unused devicetree "label" property
We should avoid use of the label property in devicetrees.  The
'zephyr,sdmmc-disk' compatible node has a 'label' property set
but there isn't any code utilizing this so removing the property
from any devicetrees that have it set (as well as example in docs).

Signed-off-by: Kumar Gala <galak@kernel.org>
2022-06-10 09:46:46 +02:00
Gerard Marull-Paretas
3009b8d9e6 doc: getting_started: add missing python3-venv installation
The venv package is not installed by default on Ubuntu, however, it is
required to follow the virtual environment installation path.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-06-09 14:35:18 +02:00
Connor Graydon
70cca36acc doc: release: Fix typo in release-notes-3.1.rst
Fix a spelling typo and grammar in release-notes-3.1.rst

Signed-off-by: Connor Graydon <connor.graydon@intel.com>
2022-06-09 11:34:48 +02:00
Seppo Takalo
e0296ca0b9 net: lwm2m: Allow initializing opaque and string data to zero length
By default, any string or opaque data that LwM2M engine initializes
sets data lenght to same value as given buffer length for that
resource.

However, on run time, engine keeps track how much data is written
to each resource, so when reading from any resource, should only
return data that has been written there. But uninitialized resources
return the content of the whole buffer.

Fixed the problem by introducing macros INIT_OBJ_RES_LEN(),
INIT_OBJ_RES_MULTI_DATA_LEN() and INIT_OBJ_RES_DATA_LEN() that
allows you to give the amount of data existing in buffer when
the resource is initialized. This sets the data_len and max_data_len
variables correctly.

Also introduced new functions lwm2m_engine_get_res_buf() and
lwm2m_engine_set_res_buf() that distinct between data size and
buffer size. Deprecated the previous functions
lwm2m_engine_get_res_data() and lwm2m_engine_set_res_data()

Signed-off-by: Seppo Takalo <seppo.takalo@nordicsemi.no>
2022-06-09 11:30:37 +02:00
Connor Graydon
d84989a718 doc: release: Fix a couple more typos in release doc
Fixing a couple more typos in release-notes-3.1.rst

Signed-off-by: Connor Graydon <connor.graydon@intel.com>
2022-06-08 18:48:38 -04:00
Carles Cufi
0a758c36c8 doc: gsg: Include instructions to set SDK env vars
The basic environment variables need to be set to be able to build
blinky (at least ZEPHYR_TOOLCHAIN_VARIANT) but were not inlcuded in the
GSG.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
Co-authored-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
2022-06-07 10:45:31 -07:00
Krzysztof Chruscinski
03e36855d3 doc: kernel: Add documentation to spsc_pbuf
Add documentation to spsc_pbuf module.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-06-07 19:04:35 +02:00
Gerard Marull-Paretas
c62e5bc4fc doc: board_porting: remove pinmux example
Pinmux should no longer happen in board C files since the addition of
the pinctrl API, so remove such guidelines from the board porting
guidelines.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-06-06 15:39:50 -07:00
Flavio Ceolin
b26ea8b428 vulnerabilities: Add CVE information
Add information about CVE-2022-0553.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2022-06-06 17:59:28 +02:00
Dominik Ermel
078fb60b11 doc/release-notes: Add note on new Kconfig option for mcumgr
The commit adds note on addition of
CONFIG_IMG_MGMT_USE_HEAP_FOR_FLASH_IMG_CONTEXT.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-06-06 12:05:29 +02:00
Stephanos Ioannidis
62770eb9c0 doc: Update PDF documentation Zephyr logo
This commit replaces the Zephyr logo for the PDF documentations with
the new registered trademark version.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-06-06 00:02:55 +09:00
Stephanos Ioannidis
29f06ca29b doc: Update HTML documentation Zephyr logo
This commit replaces the Zephyr logo for the HTML documentations with
the new registered trademark version.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-06-06 00:02:55 +09:00
Stephanos Ioannidis
2999db065f readme: Update Zephyr logo
This commit replaces the Zephyr logo for the README page with the new
registered trademark version.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-06-06 00:02:55 +09:00
Mark Holden
44c388fb33 coredump: drivers: Add coredump device
Add a pseudo device diver with device tree bindings for coredump.
The device tree bindings exposes memory address/size values to be
included in any dump. And the driver exposes an API to add/remove
dump memory regions at runtime.

Signed-off-by: Mark Holden <mholden@fb.com>
2022-06-05 14:28:34 +02:00
Martí Bolívar
2ddd73feaf release: Zephyr 3.1.0
Update versions for release v3.1.0.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-06-05 13:19:10 +02:00
Martí Bolívar
dccf0e4e4e doc: api: update overview page
Update the versions modified based on the commit logs.

I'm guessing this hasn't been done in a while.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-06-05 13:19:10 +02:00
Martí Bolívar
e27565e34d doc: release: 3.1.0 notes are no longer a working draft
Remove that from the title.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-06-03 19:19:25 -05:00
Martí Bolívar
3ba2078761 doc: release: manually curate list_issues.py output
Apply suggestions from Dan Kalowsky to clean up extraneous issues
included in the script's output.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-06-03 19:19:25 -05:00
Martí Bolívar
d0db31abe1 doc: releases: unify disjoint issue related sections for v3.1.0
There are three lists of issues in the release notes:

- security vulnerabilities which received CVEs
- other open bugs
- resolved issues

(Here, "issue" is a strictly more general term than "bug": every bug
is an issue, not every issue is a bug. This is GitHub-specific
jargon.)

The current structure is awkward. Clean it up by unifying the
lists under a single top level section and cleaning up the distinction
between issues and bugs.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-06-03 19:19:25 -05:00
Martí Bolívar
f9d8165d3d doc: releases: unite disjoint bluetooth sections for v3.1.0
For some reason, there are two different sections covering bluetooth.
This is clearly incorrect; fix it by moving the content into a single
section.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-06-03 19:19:25 -05:00
Martí Bolívar
aea7696e6a doc: releases: fix location of "new APIs" content for v3.1.0
This needs to be in the "API changes" section, instead of in a
"Bluetooth" section where it currently is.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-06-03 19:19:25 -05:00
Martí Bolívar
5889b5ba86 doc: releases: fixes for v3.1.0
Make a pass through the file, trying to fix as many issues as possible
with how the notes are written. This includes fixes for tense and
invalid .rst role usage, as well as removal of any sections which have
missing content.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-06-03 19:19:25 -05:00
Martí Bolívar
ce091d30d0 doc: releases: known issues for v3.1.0
Every release notes page includes a section for known issues.

In previous releases, we have linked to a GitHub query which displays
open issues. The problem with this approach is that the information
immediately goes stale, making this section's content less than useful.

We can do better now that we have a bug snapshot workflow and a script
capable of dumping snapshot contents in the same almost-rst-format
used by list_issues.py.

Use it as follows to archive the known open bugs at time of release:

$ wget https://builds.zephyrproject.io/zephyr/bug-snapshot/zephyr-bugs-2022-06-03.pickle.xz
$ unxz zephyr-bugs-2022-06-03.pickle.xz
$ ./scripts/dump_bugs_pickle.py zephyr-bugs-2022-06-03.pickle

Then copy paste the output into the release notes and handle .rst
escapes in the same way has previously been done for closed issues
since the last release.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-06-03 19:19:25 -05:00
Martí Bolívar
3c9e977347 doc: releases: resolved issues for v3.1.0
Follow along with the release checklist (#43286) like this:

$ ./scripts/release/list_issues.py -o zephyrproject-rtos -r zephyr -s
2022-02-22 -f issues.txt

Then copy issues.txt into the right place in the doc, and clean up the
resulting .rst errors by properly escaping and converting the markdown
format used in github issue titles.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-06-03 19:19:25 -05:00
Andrzej Głąbek
1491ab181b doc: release-notes-3.1: Add entry about dt_nodelabel_has_compat
Add information about redefined Kconfig preprocessor function
dt_nodelabel_has_compat.

Signed-off-by: Andrzej Głąbek <andrzej.glabek@nordicsemi.no>
2022-06-03 13:48:49 -07:00
Andrzej Głąbek
e7163cde62 doc: release-notes-3.1: Add more entries in ADC and PWM driver sections
Add information about new ADC facilities and about significant changes
in nRF PWM drivers.

Signed-off-by: Andrzej Głąbek <andrzej.glabek@nordicsemi.no>
2022-06-03 13:48:49 -07:00
Martí Bolívar
5c6aaf709c doc: release: build and infrastructure for v3.1
Two significant highlights are the build system internals revamp and
the new Zephyr SDK.

Fixes: #46221

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-06-03 09:24:51 -07:00
Johann Fischer
f2e2bbd864 doc: release-notes-3.1: add release notes for USB
Add release notes for USB.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2022-06-03 16:23:46 +02:00
Krzysztof Chruscinski
540d26a010 release_notes: Add section about Logging and Shell
Update release_notes section for logging and shell.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-06-03 15:11:42 +02:00
Krzysztof Chruscinski
605822d775 release_notes: Update section about Counter driver
Add information about changes in counter driver.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-06-03 15:11:42 +02:00
Krzysztof Chruscinski
2b01713f81 release_notes: Add section about utilities
Add information about UTIL_LISTIFY deprecation.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
2022-06-03 15:11:42 +02:00
Andrzej Głąbek
a5265c56b2 doc: releases: Add GPIO and I2S release notes for v3.1
Add release notes related to GPIO and I2S drivers.

Signed-off-by: Andrzej Głąbek <andrzej.glabek@nordicsemi.no>
2022-06-03 14:58:06 +02:00
Carles Cufi
2464bfe40d doc: relnotes: Add timer relnotes
Just a couple of mentions to relevant changes.

Closes #46222.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-06-03 14:57:39 +02:00
Carles Cufi
5fd8a59c72 doc: relnotes: Add SPI release notes
Not much activity, but a few changes to remark on the relnotes.

Closes #46218.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-06-03 14:57:39 +02:00