summaryrefslogtreecommitdiff
path: root/Documentation/gpio/board.txt
diff options
context:
space:
mode:
authorGabor Juhos <juhosg@openwrt.org>2016-02-25 10:00:45 +0300
committerLinus Walleij <linus.walleij@linaro.org>2016-02-25 18:01:51 +0300
commitcfb7428c3d156e45bb4092864551439e65176db3 (patch)
treef116e459ba3428fd852606868a6fbd781bcf5769 /Documentation/gpio/board.txt
parent4fccbbde1164346b96f88c9dbba6adda07d2c86f (diff)
downloadlinux-cfb7428c3d156e45bb4092864551439e65176db3.tar.xz
gpio: documenatation: fix GPIO_LOOKUP{,_IDX} documentation
The 'dev_id' parameter of the GPIO_LOOKUP{,_IDX} macros were removed by commit ad824783fb23 ("gpio: better lookup method for platform GPIOs"). Update the documentation to reflect that. Signed-off-by: Gabor Juhos <juhosg@openwrt.org> Signed-off-by: Linus Walleij <linus.walleij@linaro.org>
Diffstat (limited to 'Documentation/gpio/board.txt')
-rw-r--r--Documentation/gpio/board.txt11
1 files changed, 5 insertions, 6 deletions
diff --git a/Documentation/gpio/board.txt b/Documentation/gpio/board.txt
index 3092178628c4..86d3fa95fd12 100644
--- a/Documentation/gpio/board.txt
+++ b/Documentation/gpio/board.txt
@@ -111,16 +111,13 @@ files that desire to do so need to include the following header:
GPIOs are mapped by the means of tables of lookups, containing instances of the
gpiod_lookup structure. Two macros are defined to help declaring such mappings:
- GPIO_LOOKUP(chip_label, chip_hwnum, dev_id, con_id, flags)
- GPIO_LOOKUP_IDX(chip_label, chip_hwnum, dev_id, con_id, idx, flags)
+ GPIO_LOOKUP(chip_label, chip_hwnum, con_id, flags)
+ GPIO_LOOKUP_IDX(chip_label, chip_hwnum, con_id, idx, flags)
where
- chip_label is the label of the gpiod_chip instance providing the GPIO
- chip_hwnum is the hardware number of the GPIO within the chip
- - dev_id is the identifier of the device that will make use of this GPIO. It
- can be NULL, in which case it will be matched for calls to gpiod_get()
- with a NULL device.
- con_id is the name of the GPIO function from the device point of view. It
can be NULL, in which case it will match any function.
- idx is the index of the GPIO within the function.
@@ -134,7 +131,9 @@ In the future, these flags might be extended to support more properties.
Note that GPIO_LOOKUP() is just a shortcut to GPIO_LOOKUP_IDX() where idx = 0.
A lookup table can then be defined as follows, with an empty entry defining its
-end:
+end. The 'dev_id' field of the table is the identifier of the device that will
+make use of these GPIOs. It can be NULL, in which case it will be matched for
+calls to gpiod_get() with a NULL device.
struct gpiod_lookup_table gpios_table = {
.dev_id = "foo.0",