UbiquitousOS
/
OpenCloudOS-Kernel
mirror of https://gitee.com/OpenCloudOS/OpenCloudOS-Kernel.git
11
0
Fork 0
Code Issues Projects Releases Wiki Activity
OpenCloudOS-Kernel/Documentation/driver-api/gpio/index.rst

49 lines
706 B
ReStructuredText
Raw Normal View History

docs: driver-api: Add GPIO section This adds a section about the various parts of the GPIO subsystem to the driver API documentation. Note that this isn't exhaustive documentation, but rather focusses on pulling in the kerneldoc from various sources, in order to improve coverage of kerneldoc processing. Signed-off-by: Thierry Reding <treding@nvidia.com> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2017-07-24 22:57:27 +08:00
===================================
General Purpose Input/Output (GPIO)
===================================
Documentation: gpio: Move introduction to driver-api Move gpio/intro.txt to driver-api/gpio/intro.rst and make sure it builds cleanly as ReST. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-03-09 07:40:19 +08:00
Contents:
.. toctree::
:maxdepth: 2
intro
Documentation: gpio: Move driver documentation to driver-api Move gpio/driver.txt to driver-api/gpio/driver.rst and make sure it builds cleanly as ReST. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-03-09 07:40:20 +08:00
driver
Documentation: gpio: Move gpiod_* consumer documentation to driver-api Move gpio/consumer.txt to driver-api/gpio/consumer.rst and make sure it builds cleanly as ReST. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-03-09 07:40:22 +08:00
consumer
Documentation: gpio: Move GPIO mapping documentation to driver-api Move gpio/board.txt to driver-api/gpio/board.rst and make sure it builds cleanly as ReST. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-03-09 07:40:23 +08:00
board
Documentation: gpio: Move drivers-on-gpio.txt to driver-api Move gpio/drivers-on-gpio.txt to driver-api/gpio/drivers-on-gpio.rst and make sure it builds cleanly as ReST. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-03-09 07:40:24 +08:00
drivers-on-gpio
Documentation: gpio: Move legacy documentation to driver-api Move gpio/gpio-legacy.txt to driver-api/gpio/legacy.rst and make sure it builds cleanly as ReST. Also move the legacy API reference from index.rst to legacy.rst. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-03-09 07:40:21 +08:00
legacy
Documentation: gpio: Move introduction to driver-api Move gpio/intro.txt to driver-api/gpio/intro.rst and make sure it builds cleanly as ReST. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-03-09 07:40:19 +08:00
docs: driver-api: Add GPIO section This adds a section about the various parts of the GPIO subsystem to the driver API documentation. Note that this isn't exhaustive documentation, but rather focusses on pulling in the kerneldoc from various sources, in order to improve coverage of kerneldoc processing. Signed-off-by: Thierry Reding <treding@nvidia.com> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2017-07-24 22:57:27 +08:00
Core
====
.. kernel-doc:: include/linux/gpio/driver.h
:internal:
.. kernel-doc:: drivers/gpio/gpiolib.c
:export:
ACPI support
============
.. kernel-doc:: drivers/gpio/gpiolib-acpi.c
:export:
Device tree support
===================
.. kernel-doc:: drivers/gpio/gpiolib-of.c
:export:
Device-managed API
==================
gpio: fix kernel-doc after devres.c file rename Fix gpio kernel-doc generation after rename of the devres.c file. Fixes these errors & warning: Error: Cannot open file ../drivers/gpio/devres.c Error: Cannot open file ../drivers/gpio/devres.c WARNING: kernel-doc '../scripts/kernel-doc -rst -enable-lineno -export ../drivers/gpio/devres.c' failed with return code 2 Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2018-10-08 06:57:00 +08:00
.. kernel-doc:: drivers/gpio/gpiolib-devres.c
docs: driver-api: Add GPIO section This adds a section about the various parts of the GPIO subsystem to the driver API documentation. Note that this isn't exhaustive documentation, but rather focusses on pulling in the kerneldoc from various sources, in order to improve coverage of kerneldoc processing. Signed-off-by: Thierry Reding <treding@nvidia.com> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2017-07-24 22:57:27 +08:00
:export:
sysfs helpers
=============
.. kernel-doc:: drivers/gpio/gpiolib-sysfs.c
:export: