korg/linux
0
0
Fork 0
mirror of https://mirrors.bfsu.edu.cn/git/linux.git synced 2024-12-19 00:54:41 +08:00
Code Issues Packages Projects Releases Wiki Activity
6a0ee2a61a
linux/Documentation/driver-api/gpio/index.rst

51 lines
733 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
gpio: Add use guidance documentation The text in this new document is a response to recurring questions about the GPIO in-kernel API vs the userspace ABI. When do you use one or the other? It can be a bit intuitive, but I tried to sum it all up. Reviewed-by: Bartosz Golaszewski <bgolaszewski@baylibre.com> Link: https://lore.kernel.org/r/20200108001712.47500-1-linus.walleij@linaro.org Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2020-01-08 08:17:12 +08:00
using-gpio
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
docs: driver-api: Move bt8xxgpio to the gpio directory Let's declutter Documentation/driver-api a bit. Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net> Link: https://lore.kernel.org/r/20191004164059.10397-1-j.neuschaefer@gmx.net Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
2019-10-05 00:40:55 +08:00
bt8xxgpio
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:
Reference in New Issue Copy Permalink