Commit Graph

34 Commits

Author SHA1 Message Date
Andrei Emeltchenko
124e0f57bf doc: api: Promote EDAC API as Unstable
Promote Error Detection And Correction (EDAC) API as Unstable.

Fixes: #58487

Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
2023-06-08 06:46:29 -04:00
Benjamin Cabé
b05842eb6d doc: api: Update status for auxdisplay API
auxdisplay API was introduced in 3.4, not 3.3.
Also update to "experimental" status to better reflect that the API is
new.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2023-06-08 04:09:31 -04:00
Martin Jäger
7b2034aaec doc: develop: api: overview: tag DAC API as Unstable
Promote DAC API from Experimental to Unstable.

The API is well adopted and used in more than 2 implementations.

Signed-off-by: Martin Jäger <martin@libre.solar>
2023-06-06 17:21:06 -04:00
Martin Jäger
059e56497e doc: develop: api: overview: tag Task Watchdog API as Unstable
Promote Task Watchdog API from Experimental to Unstable.

The API has proven to be suitable for its purpose.

Signed-off-by: Martin Jäger <martin@libre.solar>
2023-06-06 17:20:51 -04:00
Carlo Caione
f5c66e9708 doc: Add barriers API docs
Add an entry to the barriers API in the docs.

Signed-off-by: Carlo Caione <ccaione@baylibre.com>
2023-05-31 06:15:32 -04:00
Jamie McCrae
71e7cf888d doc: api: Add auxdisplay as unstable API
Adds the new auxiliary display peripheral as an unstable API.

Signed-off-by: Jamie McCrae <spam@helper3000.net>
2023-05-26 23:05:58 +02:00
Jamie McCrae
82147786d8 doc: api: Add MCUmgr as stable API
Adds MCUmgr as a stable API.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-05-23 17:05:24 +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
Bjarki Arge Andreasen
b557a1d711 include/drivers: Add RTC API header and handlers
This commit adds the rtc.h header file which contains
API functions for real-time-clocks, which are low power
devices which track and represent broken-down time.

It also changes one line of doxygen documentation in the
maxim_ds3132.h file to place it in its own group.

The handlers for use of the API from userspace is also
added with this commit.

The API is split into one mandatory section, setting and
getting time, and three optional sections, alarms, update
event callback, and clock calibration.

Signed-off-by: Bjarki Arge Andreasen <baa@trackunit.com>
2023-04-04 17:03:38 +02:00
Andrei Emeltchenko
90e6bf8e9f smbus: doc: Add Documentation for SMBus subsystem API
Add some basic documentation and API reference for SMBus.

Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
2023-03-22 08:16:23 -04:00
Jamie McCrae
69cb35e3ac doc: Add retained memory API and mark as experimental
Adds the the retained memory API to the list and marks it as
experimental.

Signed-off-by: Jamie McCrae <jamie.mccrae@nordicsemi.no>
2023-03-20 15:02:09 +01:00
Fabio Baltieri
456a1cab2f doc: api: overview: add an entry for input
Add an entry for the input subsystem, experimental, 3.4.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2023-03-06 11:47:32 -08:00
Dawid Niedzwiecki
b2674a4b34 subsys/mgmt/ec_host_cmd: rename peripheral to backend
Follow naming pattern in the subsystems(logging or shell) and name
the layer between generic handler and peripheral driver "backend".

The name doesn't suit that well to the SHI backend, because there isn't
SHI API itself and the SHI interface is used only for the host
communication. So the backend code includes the peripheral driver itself.

Signed-off-by: Dawid Niedzwiecki <dawidn@google.com>
2023-02-28 10:42:23 +01:00
Gerard Marull-Paretas
a1e983fef0 drivers: pinmux: drop driver class
Pinctrl is the new pinmux.

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2023-02-23 16:56:04 -05:00
Anas Nashif
9d6446a7a1 doc: api: rename API WG to Arch WG
The API WG was renamed to Architecture WG.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2023-02-21 08:23:37 -06:00
Henrik Brix Andersen
4c90d05452 doc: develop: api: overview: mark the CAN controller driver API stable
Mark the CAN controller driver API as stable.

Signed-off-by: Henrik Brix Andersen <hebad@vestas.com>
2023-01-10 17:05:05 +01:00
Yuval Peress
b38445eaa0 math: Introduce a DSP basicmath subsystem with a cmsis backend
Introduce an API mirroring the CMSIS-DSP's basicmath. If CMSIS_DSP is
enabled, then it will by default be used as a backend. Developers may
opt into a custom backend by setting CONFIG_DSP_BACKEND_CMSIS=n. If
done, the application must provide `zdsp_backend/dsp.h` and optionally
implement the functions in its own .c files.

Signed-off-by: Yuval Peress <peress@google.com>
2022-12-02 20:15:55 +01:00
Aaron Massey
5fa1abf1cb fuel_gauge: Add basic stub API doc.
Add a short stub doc as a placeholder for future documentation on the fuel
gauge API.

Signed-off-by: Aaron Massey <aaronmassey@google.com>
2022-11-19 17:56:05 -05:00
Fabio Baltieri
2875f000b1 doc: api: drop modified version column, link to release notes
The modified version information on the API overvirew don't seem very
useful and are updated inconsistently between releases. The release
notes contains much better information about API updates already grouped
by subsystem and release, link to those instead.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-11-03 10:25:43 +01:00
Sam Hurst
76730da1a2 doc: add API documentation for USB-C VBUS Driver
This commit adds the USB-C driver API documentation in peripherals section
of the reference guide. The USB-C VBUS API is declared experimental.

Signed-off-by: Sam Hurst <sbh1187@gmail.com>
2022-10-22 18:38:35 -04:00
Sam Hurst
0d68ebc52c doc: Document the USB-C Subsystem
Documents the USB-C Subsystem API.

Signed-off-by: Sam Hurst <sbh1187@gmail.com>
2022-10-22 18:38:35 -04:00
Fabio Baltieri
a2ba6cd0ee doc: api: update overview page
Update the API overview page, guessing based on gitk v3.1.0..main on the
various API headers.

Signed-off-by: Fabio Baltieri <fabiobaltieri@google.com>
2022-09-26 09:53:05 -05:00
Daniel Leung
16b22fa46a doc: i3c: add a few bits about the new I3C API
This adds a fews bits about the newly introduced I3C API
for I3C controller.

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
2022-09-09 17:42:33 -04:00
Thomas Stranger
cbd79250e3 doc: add api documentation for w1 driver
This commit adds the w1 driver API documentation in peripherals section
of the reference guide.
The 1-Wire API is declared as unstable in the API overview.

Signed-off-by: Thomas Stranger <thomas.stranger@outlook.com>
2022-07-05 23:06:45 +02:00
Tom Burdick
63478be651 docs: Update i2c API modified version to 3.2
Updates the API overview page describing that the i2c API has been modified
for 3.2.

Signed-off-by: Tom Burdick <thomas.burdick@intel.com>
2022-06-29 17:51:31 +02:00