Skip to content

Commit 8fc3ed3

Browse files
cowilelinusw
authored andcommitted
gpio: Correct kernel-doc inconsistency
Fix kernel-doc comment to match parameter name change "chip" to "gc" in gpiochip_add_data function. Signed-off-by: Colton Lewis <[email protected]> Link: https://lore.kernel.org/r/[email protected] Signed-off-by: Linus Walleij <[email protected]>
1 parent 4530a84 commit 8fc3ed3

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

include/linux/gpio/driver.h

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -497,25 +497,25 @@ extern int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
497497

498498
/**
499499
* gpiochip_add_data() - register a gpio_chip
500-
* @gc: the chip to register, with chip->base initialized
500+
* @gc: the chip to register, with gc->base initialized
501501
* @data: driver-private data associated with this chip
502502
*
503503
* Context: potentially before irqs will work
504504
*
505505
* When gpiochip_add_data() is called very early during boot, so that GPIOs
506-
* can be freely used, the chip->parent device must be registered before
506+
* can be freely used, the gc->parent device must be registered before
507507
* the gpio framework's arch_initcall(). Otherwise sysfs initialization
508508
* for GPIOs will fail rudely.
509509
*
510510
* gpiochip_add_data() must only be called after gpiolib initialization,
511511
* ie after core_initcall().
512512
*
513-
* If chip->base is negative, this requests dynamic assignment of
513+
* If gc->base is negative, this requests dynamic assignment of
514514
* a range of valid GPIOs.
515515
*
516516
* Returns:
517517
* A negative errno if the chip can't be registered, such as because the
518-
* chip->base is invalid or already associated with a different chip.
518+
* gc->base is invalid or already associated with a different chip.
519519
* Otherwise it returns zero as a success code.
520520
*/
521521
#ifdef CONFIG_LOCKDEP

0 commit comments

Comments
 (0)