]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
Documentation: gpio: update the preferred method for using software node lookup
authorBartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>
Fri, 3 Apr 2026 13:04:55 +0000 (15:04 +0200)
committerBartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>
Wed, 8 Apr 2026 13:52:26 +0000 (15:52 +0200)
commitd129779da5e3f8878e105fb3ca8519d9ff759a91
tree9405f895cdff633a74e060de63eb49c89029429a
parent4a0fc189859bb564fddded12752e1893ad318263
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>
Documentation/driver-api/gpio/board.rst
Documentation/driver-api/gpio/legacy-boards.rst