summaryrefslogtreecommitdiffstats
path: root/Documentation/driver-api/gpio.rst
diff options
context:
space:
mode:
authorThierry Reding <treding@nvidia.com>2017-07-24 16:57:27 +0200
committerLinus Walleij <linus.walleij@linaro.org>2017-08-14 15:01:13 +0200
commit486707b7372be5978973993dc751ebe0db158343 (patch)
treec039a4778e38c96a9fb8575a5d80a2df82a00491 /Documentation/driver-api/gpio.rst
parentgpio: sysfs: Fixup kerneldoc (diff)
downloadlinux-486707b7372be5978973993dc751ebe0db158343.tar.xz
linux-486707b7372be5978973993dc751ebe0db158343.zip
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>
Diffstat (limited to 'Documentation/driver-api/gpio.rst')
-rw-r--r--Documentation/driver-api/gpio.rst45
1 files changed, 45 insertions, 0 deletions
diff --git a/Documentation/driver-api/gpio.rst b/Documentation/driver-api/gpio.rst
new file mode 100644
index 000000000000..6dd4aa647f27
--- /dev/null
+++ b/Documentation/driver-api/gpio.rst
@@ -0,0 +1,45 @@
+===================================
+General Purpose Input/Output (GPIO)
+===================================
+
+Core
+====
+
+.. kernel-doc:: include/linux/gpio/driver.h
+ :internal:
+
+.. kernel-doc:: drivers/gpio/gpiolib.c
+ :export:
+
+Legacy API
+==========
+
+The functions listed in this section are deprecated. The GPIO descriptor based
+API described above should be used in new code.
+
+.. kernel-doc:: drivers/gpio/gpiolib-legacy.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
+==================
+
+.. kernel-doc:: drivers/gpio/devres.c
+ :export:
+
+sysfs helpers
+=============
+
+.. kernel-doc:: drivers/gpio/gpiolib-sysfs.c
+ :export: