gpio: documenatation: fix GPIO_LOOKUP{,_IDX} documentation
authorGabor Juhos <juhosg@openwrt.org>
Thu, 25 Feb 2016 07:00:45 +0000 (08:00 +0100)
committerLinus Walleij <linus.walleij@linaro.org>
Thu, 25 Feb 2016 15:01:51 +0000 (16:01 +0100)
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>
Documentation/gpio/board.txt

index 3092178628c402c61ee44513a726da5ae7dccb2a..86d3fa95fd12828f5110d4ae19e6721740af8d85 100644 (file)
@@ -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",