gpiolib: Update gpiochip_find_base_unlocked() kerneldoc

This function albeit static was lacking a kerneldoc, and the
function returns a dangerous number for internal use so make
that clear in the kerneldoc.

Reported-by: Matthijs Kooijman <matthijs@stdin.nl>
Signed-off-by: Linus Walleij <linusw@kernel.org>
Link: https://patch.msgid.link/20260311-gpio-discourage-dynamic-v1-1-c8b68fc84203@kernel.org
Signed-off-by: Bartosz Golaszewski <bartosz.golaszewski@oss.qualcomm.com>
This commit is contained in:
Linus Walleij 2026-03-11 10:42:14 +01:00 committed by Bartosz Golaszewski
parent 8a3613898f
commit 803e822b00

View File

@ -338,7 +338,15 @@ struct gpio_chip *gpio_device_get_chip(struct gpio_device *gdev)
}
EXPORT_SYMBOL_GPL(gpio_device_get_chip);
/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
/**
* gpiochip_find_base_unlocked() - Find a global GPIO number base
* @ngpio: Number of consecutive GPIOs to number
*
* Finds and allocates a consecutive range of unsigned integers representing
* the GPIOs on the system. Using this numberspace outside of gpiolibs
* internals is STRONGLY DISCOURAGED, drivers and consumers should NOT concern
* themselves with this numberspace.
*/
static int gpiochip_find_base_unlocked(u16 ngpio)
{
unsigned int base = GPIO_DYNAMIC_BASE;