Commit graph

4121 commits

Author SHA1 Message Date
Magdalena Kasenberg aceefa90ec doc: autopts: Remove WSL setup
Since Zephyr SDK 0.14.0 building under Windows is supported.

Signed-off-by: Magdalena Kasenberg <magdalena.kasenberg@codecoup.pl>
2022-05-04 16:44:23 -04:00
Daniel DeGrasse 83c79d1051 doc: add sdhc api to API overview list
add SDHC api to the api overview list, as an experimental API introduced
in 3.1.

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2022-04-29 14:21:36 -05:00
Daniel DeGrasse db6890eebf doc: release: add release notes for SD subsystem
add release notes about SDHC driver, as well as binding changes for SPI
mode SD cards.

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2022-04-29 14:21:36 -05:00
Daniel DeGrasse e74d8457c4 doc: storage: update storage documentation for SD subsystem
add section about SD subsystem to disk documentation, and document new
SDHC SPI bindings

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2022-04-29 14:21:36 -05:00
Daniel DeGrasse 8dc3d510b8 doc: peripherals: add documentation for SDHC peripheral
add documentation for SDHC peripheral driver.

Signed-off-by: Daniel DeGrasse <daniel.degrasse@nxp.com>
2022-04-29 14:21:36 -05:00
Guennadi Liakhovetski 7a85ff7683 sparse: add sparse support
With this adding "-DSPARSE=y" to the "west build" command line
performs a sparse check of the project build. So far only gcc-based
builds are supported.

Signed-off-by: Guennadi Liakhovetski <guennadi.liakhovetski@linux.intel.com>
2022-04-28 08:54:21 -04:00
Gerard Marull-Paretas 523e5a6bd5 doc: release-notes: inform anout PWM changes
- Inform about deprecated functions
- Mention the pwm_dt_spec additions

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2022-04-28 11:29:38 +02:00
Stephanos Ioannidis 8c36140408 doc: Suggest filing GitHub issue for broken links
This commit updates the documentation 404 page to suggest filing a
GitHub issue for broken links instead of sending an email or using the
"contact us" form.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-04-28 10:26:03 +02:00
Carles Cufi d50b5658bb doc: west: Add an example of using the credential store for GitHub
A simple one-liner to help users authenticate with GitHub using its
Personal Access Token and the Git credential store.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-04-26 21:15:26 -04:00
Aleksandar Markovic a07774eada doc: Fix the layout of POSIX-related tables
Several tables in the section on POSIX support have a column
"Supported" which is supposed to indicate whether a feature,
a function, or similar, is supported in Zephyr or not. This
indication is done by placing character "+" in relevant cells.

However, in restructuredText, "+" is a sign for an element of
a bulleted list (as is the case with "*" and several other
characters). This, in turn, causes very inefficient rendering of
all these cells with "+", since restructuredText adds spacing
before and after any bulleted list.

Fix this by replacing all "+" characters by a simple "yes".

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-04-25 14:07:42 -04:00
Aleksandar Markovic d2f2fa6d37 doc: Improve layout of network Kconfig options table
The layout of this table unreasonably assigns narrow widths for
for column(s) with lots of content, and wise-versa.

Define relative column widths to be more in sync with column
content. This will potentially produce more compact table, making
it more readable, clearer and more visually pleasing.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-04-25 14:06:31 -04:00
Aleksandar Markovic 9f33129bdf doc: Improve layout of Zephyr-specific DTS properties table
The layout of this table unreasonably assigns narrow widths for
for column(s) with lots of content, and wise-versa.

Define relative column widths to be more in sync with column
content. This will potentially produce more compact table, making
it more readable, clearer and more visually pleasing.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-04-25 14:06:31 -04:00
Aleksandar Markovic 4e7afc4af1 doc: Improve layout of net-shell commands table
The layout of this table unreasonably assigns narrow widths for
for column(s) with lots of content, and wise-versa.

Define relative column widths to be more in sync with column
content. This will potentially produce more compact table, making
it more readable, clearer and more visually pleasing.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-04-25 14:06:31 -04:00
Aleksandar Markovic 019c90e28f doc: Improve layout of MISRA-C rules table
The layout of this table unreasonably assigns narrow widths for
for column(s) with lots of content, and wise-versa.

Define relative column widths to be more in sync with column
content. This will potentially produce more compact table, making
it more readable, clearer and more visually pleasing.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-04-25 14:06:31 -04:00
Martí Bolívar d1ae18c342 doc: west 0.13.1 release notes
This is a bug fix point release.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
2022-04-24 19:47:33 +02:00
Bartosz Bilas 536fe6a948 drivers: spi: mark old spi_cs_control fields deprecated
Since gpio_dt_spec is finally available within spi_cs_control
struct, mark the old fields deprecated in order to use
gpio_dt_spec struct.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
Co-authored-by: Jordan Yates <jordan.yates@data61.csiro.au>
Signed-off-by: Bartosz Bilas <bartosz.bilas@hotmail.com>
Co-authored-by: Bartosz Bilas <bartosz.bilas@hotmail.com>
2022-04-22 09:45:53 +02:00
Aleksandar Markovic d95c126961 doc: Fix link to soc/arm/common/cortex_m/arm_mpu_regions.c
Corect link to source file arm_mpu_regions.c.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-04-21 18:35:16 -04:00
Aleksandar Markovic 9e4e858bee doc: Fix link to tests/subsys/pm/power_states_api/
tests/subsys/pm/power_state_api/ should be
tests/subsys/pm/power_states_api/.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-04-21 18:35:16 -04:00
Aleksandar Markovic 7af3b8cbb3 doc: Fix links to Zephyr include directory on Github
At some recent point, directory <zephyr-root>/include was moved to
<zephyr-root>/include/zephyr. However, links from documentation to
Zephyr source on Github were not updated. Update them now.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-04-21 18:35:16 -04:00
Jordan Yates bd40865aca doc: arch: semihost: fix broken link
Fix a broken link in the documentation added in #44358.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2022-04-21 11:37:15 -04:00
Yuval Peress 41e7f30d0f include: update documentation to use zephyr/ prefix
Issue #41543

Signed-off-by: Yuval Peress <peress@google.com>
2022-04-21 07:40:54 -05:00
Carlo Caione 1dcea253d2 shared_multi_heap: Rework framework
Entirely rework the shared_multi_heap framework. Refer to the
documentation for more information.

Signed-off-by: Carlo Caione <ccaione@baylibre.com>
2022-04-21 13:15:26 +02:00
Jordan Yates f2d80c1b11 doc: guides: semihost: added
Add a guide section on how to use semihosting with an example code
section on opening a file to read data from it.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2022-04-21 13:04:52 +02:00
Al Semjonovs fef6e46f01 ztest: Add Z_TEST_SKIP_IFDEF macro
Defined Z_TEST_SKIP_IFDEF macro to skip tests when specified
config is enabled.

Signed-off-by: Al Semjonovs <asemjonovs@google.com>
2022-04-20 15:28:14 -04:00
Peter Mitsis 111865a8c5 doc: threads: Clarify ready/running states
Updates the threads documentation to clarify the distinction between
ready and running states.

Fixes 44255

Signed-off-by: Peter Mitsis <peter.mitsis@intel.com>
2022-04-20 10:25:59 -04:00
Robert Lubos 536e061181 doc: net: sockets: Add offloading and dispatcher documentation
Add brief documentation for socket offloading and socket dispatcher.

Signed-off-by: Robert Lubos <robert.lubos@nordicsemi.no>
2022-04-20 11:27:05 +02:00
Anas Nashif 80f6a3adbc doc: release process: update milestone definition
Update milestone definitions to reflect current state of the release
process.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-19 12:26:38 -04:00
Anas Nashif 92c285e038 doc: releases: remove moderation levels
Remove obsolete information about moderation.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-19 12:26:38 -04:00
Anas Nashif c2f1b8db7b doc: releases: replace merge window terminology
Do not use the merge window terminology which can be confusing and use
"development phase" and "stabilisation phase" instead.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-19 12:26:38 -04:00
Stephanos Ioannidis 82b6a2a020 doc: Update to Zephyr SDK 0.14.1
Update the Getting Started Guide to point to the Zephyr SDK 0.14.1
release.

Signed-off-by: Stephanos Ioannidis <root@stephanos.io>
2022-04-19 09:15:06 -04:00
Aleksandar Markovic 8a32b05905 doc: Fix spelling errors in .rst files
Fix spelling errors in assorted .rst files. The errors were found
using a tool called 'codespell'.

Signed-off-by: Aleksandar Markovic <aleksandar.markovic.sa@gmail.com>
2022-04-19 11:48:26 +02:00
Pavel Vasilyev 442e477116 doc: mcumgr: Update instruction for go version 1.18+
go get is deprecated starting from go tool version 1.18:
https://go.dev/doc/go-get-install-deprecation

Signed-off-by: Pavel Vasilyev <pavel.vasilyev@nordicsemi.no>
2022-04-15 11:52:44 -07:00
Jaska Uimonen 783a96a71b drivers: add new audio dai driver interface
The DAI (digital audio interface) API is a high level audio driver
abstraction. It provides support for the standard I2S (SSP), DMIC, HDA
and SDW backends. The API has a config function with bespoke data
argument for device/vendor specific config. There are also optional
timestamping functions to get device specific audio clock time.

Signed-off-by: Jaska Uimonen <jaska.uimonen@linux.intel.com>
2022-04-14 11:42:08 -04:00
Jamie McCrae f0bdb53927 doc: guides: device_mgmt: smp: os: Add os reset hook details
Adds details about the os reset request hook that applications can use
to allow or decline the request or tidy up.

Signed-off-by: Jamie McCrae <jamie.mccrae@lairdconnect.com>
2022-04-13 14:05:57 -07:00
Jamie McCrae 51e3cecb31 doc: mcumgr: Fix reference formatting
Documentation build for 2.7 was failing due to using only a single
character instead of double for showing a module name.

Signed-off-by: Jamie McCrae <jamie.mccrae@lairdconnect.com>
2022-04-13 13:40:16 -07:00
Jamie McCrae c19e8c9a23 doc: release-notes: Add mcumgr file status, file hash/checksum details
This adds release notes for the new file status and file hash/checksum
mcumgr fs commands.

Signed-off-by: Jamie McCrae <jamie.mccrae@lairdconnect.com>
2022-04-12 12:05:30 +02:00
Jamie McCrae 13c00fb96d doc: guides: device_mgmt: smp: fs: Add hash/checksum/status details
This adds documentation which explains fs mcumgr commands for the status
and hash/checksum commands.

Signed-off-by: Jamie McCrae <jamie.mccrae@lairdconnect.com>
2022-04-12 12:05:30 +02:00
Pavel Vasilyev 32fa349735 doc: bluetooth: mesh: Fix links in Bluetooth mesh documentation
@ref directive is not working. Replacing it with correct directives.

Signed-off-by: Pavel Vasilyev <pavel.vasilyev@nordicsemi.no>
2022-04-12 09:53:52 +02:00
Dominik Ermel 0495e0cb4c doc: relese-notes: Note on MCUMGR Parameters command added
Added notes on MCUMGR parameters command added to OS group.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-04-11 12:10:20 +02:00
Dominik Ermel aa53dfab02 doc/guides/device_mgmt: Add MCUMGR parameters command to OS grp
The commit add description of a new OS group command for MCUMGR
parameters retrieval.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2022-04-11 12:10:20 +02:00
Yuval Peress 1ec0c6f530 build: make non zephyr/ include prefix configurable
Add a Kconfig to disable non prefixed includes. By setting
`CONFIG_LEGACY_INCLUDE_PATH=n` developers can disable having
`include/zephyr` in the search path. This means that includes such
as `#include <kernel.h>` will no longer work.

Internally, every header should be updated to add the `zephyr/`
prefix to the headers. Only then, will developers be able to use
this config value for their applications.

Signed-off-by: Yuval Peress <peress@google.com>
2022-04-08 19:03:32 +02:00
Carles Cufi 8257b0e3f5 modules: tinycbor: Deprecate the module
See #40591 for details, TinyCBOR (or rather the fork of TinyCBOR that we
had) is being replaced by zcbor.

Closes #40591.

Signed-off-by: Carles Cufi <carles.cufi@nordicsemi.no>
2022-04-08 15:58:49 +02:00
Anas Nashif 656f87a89f doc: add new redirects
Autogenerated redirects from git diff for new structure.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 21:20:17 -04:00
Anas Nashif e3e67f206c doc: update existing redirects
Change redirects to point to new locations.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 21:20:17 -04:00
Anas Nashif 0e727cf5a9 doc: get rid of reference section
Move last remaining items from reference section to the appropriate new
section in the new structure.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00
Anas Nashif 65b3815ba6 doc: rearrange top level index pages
Re-arrange top level index pages based on proposal.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00
Anas Nashif 7ad2f76720 doc: remove guides and split content
Remove the old guides section and move all remaining items into new
sections.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00
Anas Nashif a084be3ba9 doc: move sections from guides
Move remaining items from guides into the appropriate locations using
the new structure.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00
Anas Nashif 0ee7e42ef0 doc: move flashing/debugging section to developing with zephyr
This section belongs in the intro about developing with Zephyr.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00
Anas Nashif b40344bf4b doc: move hardware emulator docs to hardware section
HW emulation goes under hardware support.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2022-04-07 16:35:19 +02:00