aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGabor Juhos <juhosg@openwrt.org>2016-02-25 02:00:45 -0500
committerLinus Walleij <linus.walleij@linaro.org>2016-02-25 10:01:51 -0500
commitcfb7428c3d156e45bb4092864551439e65176db3 (patch)
treef116e459ba3428fd852606868a6fbd781bcf5769
parent4fccbbde1164346b96f88c9dbba6adda07d2c86f (diff)
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>
-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:
111GPIOs are mapped by the means of tables of lookups, containing instances of the 111GPIOs are mapped by the means of tables of lookups, containing instances of the
112gpiod_lookup structure. Two macros are defined to help declaring such mappings: 112gpiod_lookup structure. Two macros are defined to help declaring such mappings:
113 113
114 GPIO_LOOKUP(chip_label, chip_hwnum, dev_id, con_id, flags) 114 GPIO_LOOKUP(chip_label, chip_hwnum, con_id, flags)
115 GPIO_LOOKUP_IDX(chip_label, chip_hwnum, dev_id, con_id, idx, flags) 115 GPIO_LOOKUP_IDX(chip_label, chip_hwnum, con_id, idx, flags)
116 116
117where 117where
118 118
119 - chip_label is the label of the gpiod_chip instance providing the GPIO 119 - chip_label is the label of the gpiod_chip instance providing the GPIO
120 - chip_hwnum is the hardware number of the GPIO within the chip 120 - chip_hwnum is the hardware number of the GPIO within the chip
121 - dev_id is the identifier of the device that will make use of this GPIO. It
122 can be NULL, in which case it will be matched for calls to gpiod_get()
123 with a NULL device.
124 - con_id is the name of the GPIO function from the device point of view. It 121 - con_id is the name of the GPIO function from the device point of view. It
125 can be NULL, in which case it will match any function. 122 can be NULL, in which case it will match any function.
126 - idx is the index of the GPIO within the function. 123 - 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.
134Note that GPIO_LOOKUP() is just a shortcut to GPIO_LOOKUP_IDX() where idx = 0. 131Note that GPIO_LOOKUP() is just a shortcut to GPIO_LOOKUP_IDX() where idx = 0.
135 132
136A lookup table can then be defined as follows, with an empty entry defining its 133A lookup table can then be defined as follows, with an empty entry defining its
137end: 134end. The 'dev_id' field of the table is the identifier of the device that will
135make use of these GPIOs. It can be NULL, in which case it will be matched for
136calls to gpiod_get() with a NULL device.
138 137
139struct gpiod_lookup_table gpios_table = { 138struct gpiod_lookup_table gpios_table = {
140 .dev_id = "foo.0", 139 .dev_id = "foo.0",