Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Gabor Juhos and committed by
Linus Walleij
cfb7428c 4fccbbde

+5 -6
+5 -6
Documentation/gpio/board.txt
··· 111 111 GPIOs are mapped by the means of tables of lookups, containing instances of the 112 112 gpiod_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) 115 - GPIO_LOOKUP_IDX(chip_label, chip_hwnum, dev_id, con_id, idx, flags) 114 + GPIO_LOOKUP(chip_label, chip_hwnum, con_id, flags) 115 + GPIO_LOOKUP_IDX(chip_label, chip_hwnum, con_id, idx, flags) 116 116 117 117 where 118 118 119 119 - chip_label is the label of the gpiod_chip instance providing the GPIO 120 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 121 - con_id is the name of the GPIO function from the device point of view. It 125 122 can be NULL, in which case it will match any function. 126 123 - idx is the index of the GPIO within the function. ··· 131 134 Note that GPIO_LOOKUP() is just a shortcut to GPIO_LOOKUP_IDX() where idx = 0. 132 135 133 136 A lookup table can then be defined as follows, with an empty entry defining its 134 - end: 137 + end. The 'dev_id' field of the table is the identifier of the device that will 138 + make use of these GPIOs. It can be NULL, in which case it will be matched for 139 + calls to gpiod_get() with a NULL device. 135 140 136 141 struct gpiod_lookup_table gpios_table = { 137 142 .dev_id = "foo.0",