Commit Graph

156 Commits

Author SHA1 Message Date
Dawid Niedzwiecki
c8c149dce8 mgmt: ec_host_cmd: add logging system
Add a native way to log Host Command communication.

Use Zephyr logging system to do it. Use debug and normal levels.

Signed-off-by: Dawid Niedzwiecki <dawidn@google.com>
2023-06-26 16:13:42 +02:00
Christopher Friedt
b416a90672 doc: services: posix: pthread_mutexattr_destroy init supported
The functions pthread_mutexattr_destroy()
and pthread_mutexattr_init() are implemented (they just do nothing).

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-06-25 02:47:47 -04:00
Christopher Friedt
64a477342d doc: services: posix: pthread_condattr_destroy and init supported
The functions pthread_condattr_destroy()
and pthread_condattr_init() are implemented (they just do nothing).

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-06-25 02:47:47 -04:00
Christopher Friedt
675a660727 doc: services: posix: _POSIX_THREAD_PRIO_INHERIT unsupported
_POSIX_THREAD_PRIO_INHERIT was mistakenly marked supported in
commit a07774eada presumably because we have prototypes for the
functions below.

pthread_mutexattr_getprotocol()
pthread_mutexattr_setprotocol()

However, the functions are not actually implemented in Zephyr.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-06-25 02:47:47 -04:00
Christopher Friedt
88dd32c38c doc: services: posix: fix setvbuf typo
Fix a typo in the spelling of `setvbuf()`.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-06-25 02:47:47 -04:00
Lucas Tamborrino
9ae80aabd9 doc: services: debug: coredump: add flash partition
Add flash partition guide to coredump documentation.

Signed-off-by: Lucas Tamborrino <lucas.tamborrino@espressif.com>
2023-06-21 16:06:06 -04:00
Anas Nashif
9fd9c9dd4f doc: sensing: fix structure and remove top doxygen reference
Move sections out of the Overview section and put API documentation in
one section without bullets, which was causing duplication in headers
and text.

This also fixes the issue with PDF generation which is currently
blocking publication of HTML pages on docs.zephyrproject.org.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-06-19 22:09:47 -04:00
Hebo Hu
703ad12188 doc: Add documents for Sensing Subsystem
Add documents for sensing subsystem.

Signed-off-by: Hebo Hu <hebo.hu@intel.com>
2023-06-17 07:43:25 -04:00
Johann Fischer
b335c19bcb doc: move USB documentation to connectivity
Mostly moved and reorganised content to the Connectivity chapter,
separated API references. Fill in some gaps in the USB device
documentation.

Signed-off-by: Johann Fischer <johann.fischer@nordicsemi.no>
2023-06-15 05:53:44 -04:00
Jamie McCrae
3f8156d0a4 doc: mgmt: smp: Fix slot and image to be unsigned
Fixes the documentation to show image and slot number for get
state of image response being unsigned, not signed.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-06-14 13:47:08 -04:00
Jamie McCrae
6981e2e3cf doc: services: device_mgmt: mcumgr: Update callback documentation
Updates and fixes callback documentation to show functionality and
definitions that were recently updated.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-06-13 07:11:44 -04:00
Christopher Friedt
efe9111b21 doc: services: posix: update c-lang support section
Several C language items have gained support in Zephyr over
time.

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-06-11 05:08:35 -04:00
Christopher Friedt
533c1985dc doc: services: posix: update posix supported items
Several items needed to be updated in POSIX documentation.

* add `_POSIX_BARRIERS` top Option Requirements
* update `_POSIX_THREAD_ATTR_STACK*` in Option Requirements
* add `pthread_barrier_*()` to `POSIX_THREADS_BASE`
* update `pthread_cond_destroy()` and `pthread_setcancelstate()`

Signed-off-by: Christopher Friedt <cfriedt@meta.com>
2023-06-10 10:08:25 -04:00
Benjamin Cabé
c77811500c doc: mcumgr: update link to mcumgr root folder
MCUmgr does not live in subsys/mgmt/mcumgr/lib anymore.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-06-07 04:40:47 -04:00
Benjamin Cabé
a76396fb7a doc: update stale links to MCUboot documentation
mcuboot.com/documentation --> docs.mcuboot.com

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-06-07 04:40:47 -04:00
Benjamin Cabé
23f2a2066f doc: update stale srecord links
Updated 404 links to point to valid locations.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-06-07 04:40:47 -04:00
Gerard Marull-Paretas
30946d46fd usb: create top-level usb Doxygen group
Create a USB Doxygen group, part of the top-level connectivity group.
Added some existing groups to the usb group, note that USB Doxygen needs
to be improved, though.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-06-05 20:21:09 -04:00
Flavio Ceolin
50e35fad8d doc: pm: Add a note about multicore behavior
Add a note to make it clear devices suspension order in
multicore systems.

Signed-off-by: Flavio Ceolin <flavio.ceolin@intel.com>
2023-06-01 06:32:47 -04:00
Nick Ward
b1b0a36ca8 doc: pm: power_domain: fix spelling of below
Fix spelling of below

Signed-off-by: Nick Ward <nix.ward@gmail.com>
2023-05-29 05:21:10 -04:00
Rodrigo Peixoto
1cbcaecac3 doc: zbus: improve suggested uses
Developers may be uncertain about which observer type to use in zbus,
potentially resulting in improper subsystem use. Fix that by adding an
explicit differentiation between the observer's type in the `Suggested
uses` section.

Fixes #58004

Signed-off-by: Rodrigo Peixoto <rodrigopex@gmail.com>
2023-05-26 14:56:28 -04:00
Jamie McCrae
cfbcd45afb doc: service: device_mgmt: Tidy documentation
Tidies and corrects some minor documentation issues.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-05-26 10:22:17 +02:00
Gerard Marull-Paretas
5b049f35b5 doc: drop usage of numref
Usage of numfig=True option in conf.py significantly increases doc build
time. While it is a nice feature, it's not extensively used in Zephyr
documentation, so let's remove its usage in favor of faster doc builds.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-05-22 11:08:53 +02:00
Dawid Niedzwiecki
0a17aa8605 mgmt: ec_host_cmd: add autoinit config
Add a separate config to enable autoinitialization of the host command
subsystem, called by the chosen backend.

It allows setting the chosen backend without autoinit.

Signed-off-by: Dawid Niedzwiecki <dawidn@google.com>
2023-05-18 09:46:37 +02:00
Fabio Baltieri
42d9cf1b9a doc: input: expand the kscan compatibility description
Add few details about the kscan compatibility driver, mention the
relevant Kconfig options and an example (which is also present in the
binding file).

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-05-17 09:49:31 +02:00
Jamie McCrae
794f3df08e doc: services: device_mgmt: Add version field
Adds the SMP version field to the diagram and description.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-05-15 09:27:16 +02:00
Grant Ramsay
4ed404a27f drivers: virtualization: Add interface for ivshmem-v2
ivshmem-v2 is primarily used for IPC in the Jailhouse hypervisor

Signed-off-by: Grant Ramsay <gramsay@enphaseenergy.com>
2023-05-14 18:17:33 -04:00
Jamie McCrae
bb0a85ae4b doc: services: device_mgmt: smp_groups: img_mgmt: Add sha has note
Adds a note on when the "sha" hash field can be provided or not
and what the difference in operation is.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-05-09 14:29:05 +02:00
Yasushi SHOJI
143dfda9d0 doc: services: storage: flash_map: Fix include references
We have moved all header files under include/zephyr/ for Zephyr 3.1.
Update the document accordingly.

Signed-off-by: Yasushi SHOJI <yashi@spacecubics.com>
2023-05-03 12:39:49 +02:00
Emil Obalski
e1d7b0a0ca doc: ipc: Update the documentation
Update the doc for IPC service icmsg backend.

Signed-off-by: Emil Obalski <Emil.Obalski@nordicsemi.no>
2023-04-29 12:24:17 +02:00
Nicolas VINCENT
84a7feab45 doc: flash_map: add const to code snippet
flash_area_open() uses an argument of type 'const struct flash_area **'
while the code snippet suggested 'struct flash_area **'
Update code snippet

Signed-off-by: Nicolas VINCENT <nicolas.vincent@vossloh.com>
2023-04-24 13:35:07 +02:00
Jamie McCrae
9c6e394731 doc: Add documentation for retention subsystem
Adds documentation for the retention subsystem and boot mode
interface. Also marks the retention subsystem as experimental.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-04-24 13:27:53 +02:00
Dawid Niedzwiecki
7f7e48e66e mgmt: ec_host_cmd: create chosen string per backend
Create strings to set the chosen node per backend. It is done for
better clarity.

Signed-off-by: Dawid Niedzwiecki <dawidn@google.com>
2023-04-21 16:29:59 +02:00
Dawid Niedzwiecki
1d62002bba mgmt: ec_host_cmd: update configs naming
Just use better namings for the buffer sizes configs.

Signed-off-by: Dawid Niedzwiecki <dawidn@google.com>
2023-04-21 16:29:59 +02:00
Gerard Marull-Paretas
667eeb11fb shell: fix MISRA 5.7 violations on struct shell
MISRA Rule 5.7 requires uniqueness of tag identifiers. Shell is
frequently problematic because many code uses `const struct shell
*shell`. This causes CI noise every time one of these shell files is
edited, so let's update all of them with `const struct shell *sh`
instead.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-04-14 12:21:08 +02:00
Keith Packard
3a197934fc doc: Switch main return type from void to int.
As both C and C++ standards require applications running under an OS to
return 'int', adapt that for Zephyr to align with those standard. This also
eliminates errors when building with clang when not using -ffreestanding,
and reduces the need for compiler flags to silence warnings for both clang
and gcc.

Signed-off-by: Keith Packard <keithp@keithp.com>
2023-04-14 07:49:41 +09:00
Maurits Fassaert
6bfb663167 shell: backends: add SHELL_BACKEND_RTT_BUFFER option
This new configuration option, SHELL_BACKEND_RTT_BUFFER, allows selecting
an alternative buffer for the Shell's RTT backend. By default buffer 0 is
used, which conflicts with the default logging subsystem RTT backend
buffer.
This option is the counterpart to the logger's LOG_BACKEND_RTT_BUFFER.

Signed-off-by: Maurits Fassaert <maurits.fassaert@sensorfy.ai>
2023-04-13 11:43:28 +02:00
Yuval Peress
06d4a8be26 rtio: add mempool documentation
Add documentation about the mempool feature along with a few examples

Signed-off-by: Yuval Peress <peress@google.com>
2023-04-12 13:29:11 -04:00
Jamie McCrae
16ada3e7a7 doc: services: device_mgmt: Fix doc issues
Fixes some issues with the documentation for MCUmgr.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-04-12 14:25:30 +02:00
Tomasz Bursztyka
31c8042e5b doc: Add NVMe documentation in storage service part
NVMe disks are supported, let's provide some documentation about the
driver and how to enable it.

Signed-off-by: Tomasz Bursztyka <tomasz.bursztyka@linux.intel.com>
2023-04-07 13:28:47 +02:00
Dawid Niedzwiecki
4ef47888ef ec_host_cmd: add UART backend
Add a new backend for Host Commands that uses UART. The backend bases
asynchronous UART API.

The UART backend is mainly used by FPMCU.

Signed-off-by: Dawid Niedzwiecki <dawidn@google.com>
2023-04-07 13:05:59 +02:00
Jamie McCrae
79d3eed9b8 doc: services: mcumgr: Fix Kconfig name
Fixes missing CONFIG_ prefixes from Kconfig options and fixes
wrong names.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-04-04 11:51:43 +02:00
Jamie McCrae
20417bfaeb doc: services: mcumgr: Add fs_mgmt updates and file close command
Adds information on updated fs_mgmt functionality and describes
the new optional file close command.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-04-04 11:51:43 +02:00
Jordan Yates
738b75171b doc: pm: device_runtime: document new devicetree flag
Document the new devicetree flag and provide an example of how to use
it.

Signed-off-by: Jordan Yates <jordan.yates@data61.csiro.au>
2023-03-29 12:21:13 -04:00
Dominik Ermel
cbacf4ce87 doc/device_mgmt/mcumgr/img: Correct note on "upgrade" parameter
The note previously mentioned that, when "upgrade" flag is present,
uploaded image version can not be lower than version of a running
application; this has been corrected as uploaded image should
have version higher than running, as "upgrade" only flag makes
no sense when same version is uploaded.
Additionally note that Zephyr does not support this feature has
been removed, as MCUmgr library within Zephyr does actually
perform the version check when "upgrade" flag is set.

Signed-off-by: Dominik Ermel <dominik.ermel@nordicsemi.no>
2023-03-29 11:31:19 +02:00
Jamie McCrae
f0e42234b3 doc: device_mgmt: smp_groups: smp_group_1: Add upload hash note
Adds a note that the upload response hash is partially
optionally from the point of view of MCUboot's serial recovery.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-03-29 11:30:36 +02:00
Fabio Baltieri
f8468ee76e doc: input: add a reference to the kscan adapter driver
Add a reference to the kscan input adapter to the input documentation
page.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-03-28 20:57:53 -04:00
Fabio Baltieri
fce6eee760 doc: input: add the initial input subsystem documentation
Add the initial documentation for the input subsystem.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-03-06 11:47:32 -08:00
Mathis Raemy
e75b72234c doc: services: device_mgmt: smp_groups: Correct smp img upload request
The specification of que CBOR request 'image upload request' field
'sha' was decalred as type (str) but is (byte str).
Just replaced the field type after verified with code here:
/subsys/mgmt/mcumgr/grp/img_mgmt/src/img_mgmt.c#L383

Signed-off-by: Mathis Raemy <mathis.raemy@gmail.com>
2023-03-02 21:14:11 +01:00
Dawid Niedzwiecki
2d0a784c41 subsys/mgmt/ec_host_cmd: rework Host Command support
Rework the Host Command support. It includes:
-change API to backend
-change a way of defining rx and tx buffers
-fix synchronization between the handler and backend layer
-simplify the HC handler

Signed-off-by: Dawid Niedzwiecki <dawidn@google.com>
2023-02-28 10:42:23 +01:00
Dean Sellers
0c9ca9aefa doc: services: device_mgmt: mcumgr: Fix issue with confirm
Instead of no hash being passed when using image confirm on a
test upgrade and empty hash should be passed, otherwise an error
is returned.

Signed-off-by: Dean Sellers <dsellers@evos.com.au>
2023-02-23 14:35:16 +01:00