linux/Documentation/driver-api/gpio
Bartosz Golaszewski d129779da5 Documentation: gpio: update the preferred method for using software node lookup
In its current version, the manual for converting of board files from
using GPIO lookup tables to software nodes recommends leaving the
software nodes representing GPIO controllers as "free-floating", not
attached objects and relying on the matching of their names against the
GPIO controller's name. This is an abuse of the software node API and
makes it impossible to create fw_devlinks between GPIO suppliers and
consumers in this case. We want to remove this behavior from GPIOLIB and
to this end, work on converting all existing drivers to using "attached"
software nodes.

Except for a few corner-cases where board files define consumers
depending on GPIO controllers described in firmware - where we need to
reference a real firmware node from a software node - which requires a
more complex approach, most board files can easily be converted to using
propert firmware node lookup.

Update the documentation to recommend attaching the GPIO chip's software
nodes to the actual platform devices and show how to do it.

Reviewed-by: Linus Walleij <linusw@kernel.org>
Link: https://patch.msgid.link/20260403-doc-gpio-swnodes-v2-1-c705f5897b80@oss.qualcomm.com
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>
2026-04-08 15:52:26 +02:00
..
board.rst Documentation: gpio: update the preferred method for using software node lookup 2026-04-08 15:52:26 +02:00
bt8xxgpio.rst docs: driver-api: bt8xxgpio: Revive dead link 2019-10-09 11:13:36 +02:00
consumer.rst gpio: Remove legacy API documentation 2024-05-27 16:50:03 +02:00
driver.rst gpio: Document line value semantics 2026-03-09 10:16:00 +01:00
drivers-on-gpio.rst pwm: Add GPIO PWM driver 2024-07-10 17:52:47 +02:00
index.rst Documentation: gpio: Add a compatibility and feature list for PCA953x 2025-11-19 12:07:39 +01:00
intro.rst gpio: Remove legacy API documentation 2024-05-27 16:50:03 +02:00
legacy-boards.rst Documentation: gpio: update the preferred method for using software node lookup 2026-04-08 15:52:26 +02:00
pca953x.rst Documentation: gpio: pca953x: clarify interrupt source detection 2026-01-08 10:50:33 +01:00
using-gpio.rst docs: driver-api: gpio: Fix some typos 2022-06-24 13:12:20 -06:00