doc: reference: added documentation for Reset Controller

added documentation for Reset Controller Driver

Signed-off-by: Andrei-Edward Popa <andrei.popa105@yahoo.com>
This commit is contained in:
Andrei-Edward Popa 2022-03-22 02:25:39 +02:00 committed by Carles Cufí
commit 5f35cdeece
4 changed files with 42 additions and 0 deletions

View file

@ -267,6 +267,11 @@ current :ref:`stability level <api_lifecycle>`.
- 2.4
- 2.4
* - :ref:`reset_api`
- Experimental
- 3.1
- 3.1
* - :ref:`spi_api`
- Stable
- 1.0

View file

@ -318,6 +318,14 @@ properties related to them.
.. doxygengroup:: devicetree-pwms
Reset Controller
================
These conveniences may be used for nodes which describe reset controllers and
properties related to them.
.. doxygengroup:: devicetree-reset-controller
SPI
===

View file

@ -29,6 +29,7 @@ Peripherals
ps2.rst
peci.rst
regulators.rst
reset.rst
rtc.rst
sensor.rst
spi.rst

View file

@ -0,0 +1,28 @@
.. _reset_api:
Reset Controller
################
Overview
********
Reset controllers are units that control the reset signals to multiple
peripherals. The reset controller API allows peripheral drivers to request
control over their reset input signals, including the ability to assert,
deassert and toggle those signals. Also, the reset status of the reset input
signal can be checked.
Mainly, the assert and deassert API functions are optional because in most
cases we want to toggle the reset signals.
Configuration Options
*********************
Related configuration options:
* :kconfig:option:`CONFIG_RESET`
API Reference
*************
.. doxygengroup:: reset_controller_interface