Skip to content

Commit 48ec13d

Browse files
jgoulybrgl
authored andcommitted
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>
1 parent 576892a commit 48ec13d

1 file changed

Lines changed: 8 additions & 5 deletions

File tree

include/linux/gpio/driver.h

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -168,13 +168,16 @@ struct gpio_irq_chip {
168168

169169
/**
170170
* @parent_handler_data:
171+
*
172+
* If @per_parent_data is false, @parent_handler_data is a single
173+
* pointer used as the data associated with every parent interrupt.
174+
*
171175
* @parent_handler_data_array:
172176
*
173-
* Data associated, and passed to, the handler for the parent
174-
* interrupt. Can either be a single pointer if @per_parent_data
175-
* is false, or an array of @num_parents pointers otherwise. If
176-
* @per_parent_data is true, @parent_handler_data_array cannot be
177-
* NULL.
177+
* If @per_parent_data is true, @parent_handler_data_array is
178+
* an array of @num_parents pointers, and is used to associate
179+
* different data for each parent. This cannot be NULL if
180+
* @per_parent_data is true.
178181
*/
179182
union {
180183
void *parent_handler_data;

0 commit comments

Comments
 (0)