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:
parent
8645de581e
commit
5f35cdeece
4 changed files with 42 additions and 0 deletions
|
@ -267,6 +267,11 @@ current :ref:`stability level <api_lifecycle>`.
|
||||||
- 2.4
|
- 2.4
|
||||||
- 2.4
|
- 2.4
|
||||||
|
|
||||||
|
* - :ref:`reset_api`
|
||||||
|
- Experimental
|
||||||
|
- 3.1
|
||||||
|
- 3.1
|
||||||
|
|
||||||
* - :ref:`spi_api`
|
* - :ref:`spi_api`
|
||||||
- Stable
|
- Stable
|
||||||
- 1.0
|
- 1.0
|
||||||
|
|
|
@ -318,6 +318,14 @@ properties related to them.
|
||||||
|
|
||||||
.. doxygengroup:: devicetree-pwms
|
.. 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
|
SPI
|
||||||
===
|
===
|
||||||
|
|
||||||
|
|
|
@ -29,6 +29,7 @@ Peripherals
|
||||||
ps2.rst
|
ps2.rst
|
||||||
peci.rst
|
peci.rst
|
||||||
regulators.rst
|
regulators.rst
|
||||||
|
reset.rst
|
||||||
rtc.rst
|
rtc.rst
|
||||||
sensor.rst
|
sensor.rst
|
||||||
spi.rst
|
spi.rst
|
||||||
|
|
28
doc/reference/peripherals/reset.rst
Normal file
28
doc/reference/peripherals/reset.rst
Normal 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
|
Loading…
Add table
Add a link
Reference in a new issue