diff options
| author | Joey Gouly <joey.gouly@arm.com> | 2022-03-18 12:12:33 +0000 |
|---|---|---|
| committer | Bartosz Golaszewski <brgl@bgdev.pl> | 2022-03-31 16:24:16 +0200 |
| commit | 48ec13d36d3ff716a8a08e6583a925def7a2564d (patch) | |
| tree | 4a24797a7bc83e5bf76880288835ee746af61424 | |
| parent | 576892a84f37875c7deb20eee11d5b88dd5e1097 (diff) | |
| download | linux-48ec13d36d3ff716a8a08e6583a925def7a2564d.tar.gz | |
gpio: Properly document parent data union
Suppress a warning in the html docs by documenting these fields separately.
Signed-off-by: Joey Gouly <joey.gouly@arm.com>
Link: https://lore.kernel.org/lkml/20211027220118.71a229ab@canb.auug.org.au/
Cc: Linus Walleij <linus.walleij@linaro.org>
Cc: Bartosz Golaszewski <brgl@bgdev.pl>
Cc: Marc Zyngier <maz@kernel.org>
Cc: Stephen Rothwell <sfr@canb.auug.org.au>
Reviewed-by: Linus Walleij <linus.walleij@linaro.org>
Signed-off-by: Bartosz Golaszewski <brgl@bgdev.pl>
| -rw-r--r-- | include/linux/gpio/driver.h | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h index b0728c8ad90ce9..98c93510640e93 100644 --- a/include/linux/gpio/driver.h +++ b/include/linux/gpio/driver.h @@ -168,13 +168,16 @@ struct gpio_irq_chip { /** * @parent_handler_data: + * + * If @per_parent_data is false, @parent_handler_data is a single + * pointer used as the data associated with every parent interrupt. + * * @parent_handler_data_array: * - * Data associated, and passed to, the handler for the parent - * interrupt. Can either be a single pointer if @per_parent_data - * is false, or an array of @num_parents pointers otherwise. If - * @per_parent_data is true, @parent_handler_data_array cannot be - * NULL. + * If @per_parent_data is true, @parent_handler_data_array is + * an array of @num_parents pointers, and is used to associate + * different data for each parent. This cannot be NULL if + * @per_parent_data is true. */ union { void *parent_handler_data; |