2024-06-10 13:59:41

by Andrew Davis

[permalink] [raw]
Subject: [PATCH] gpiolib: Remove data-less gpiochip_add() function

GPIO chips should be added with driver-private data associated with the
chip. If none is needed, NULL can be used. All users already do this
except one, fix that here. With no more users of the base gpiochip_add()
we can drop this function so no more users show up later.

Signed-off-by: Andrew Davis <[email protected]>
---
Documentation/driver-api/gpio/driver.rst | 5 ++---
drivers/staging/greybus/gpio.c | 2 +-
include/linux/gpio/driver.h | 4 ----
3 files changed, 3 insertions(+), 8 deletions(-)

diff --git a/Documentation/driver-api/gpio/driver.rst b/Documentation/driver-api/gpio/driver.rst
index e541bd2e898b5..ae433261e11a0 100644
--- a/Documentation/driver-api/gpio/driver.rst
+++ b/Documentation/driver-api/gpio/driver.rst
@@ -69,9 +69,8 @@ driver code:

The code implementing a gpio_chip should support multiple instances of the
controller, preferably using the driver model. That code will configure each
-gpio_chip and issue gpiochip_add(), gpiochip_add_data(), or
-devm_gpiochip_add_data(). Removing a GPIO controller should be rare; use
-gpiochip_remove() when it is unavoidable.
+gpio_chip and issue gpiochip_add_data() or devm_gpiochip_add_data(). Removing
+a GPIO controller should be rare; use gpiochip_remove() when it is unavoidable.

Often a gpio_chip is part of an instance-specific structure with states not
exposed by the GPIO interfaces, such as addressing, power management, and more.
diff --git a/drivers/staging/greybus/gpio.c b/drivers/staging/greybus/gpio.c
index 2a115a8fc263f..5217aacfcf54c 100644
--- a/drivers/staging/greybus/gpio.c
+++ b/drivers/staging/greybus/gpio.c
@@ -579,7 +579,7 @@ static int gb_gpio_probe(struct gbphy_device *gbphy_dev,
if (ret)
goto exit_line_free;

- ret = gpiochip_add(gpio);
+ ret = gpiochip_add_data(gpio, NULL);
if (ret) {
dev_err(&gbphy_dev->dev, "failed to add gpio chip: %d\n", ret);
goto exit_line_free;
diff --git a/include/linux/gpio/driver.h b/include/linux/gpio/driver.h
index 0032bb6e7d8fe..6d31388dde0ab 100644
--- a/include/linux/gpio/driver.h
+++ b/include/linux/gpio/driver.h
@@ -632,10 +632,6 @@ int gpiochip_add_data_with_key(struct gpio_chip *gc, void *data,
devm_gpiochip_add_data_with_key(dev, gc, data, NULL, NULL)
#endif /* CONFIG_LOCKDEP */

-static inline int gpiochip_add(struct gpio_chip *gc)
-{
- return gpiochip_add_data(gc, NULL);
-}
void gpiochip_remove(struct gpio_chip *gc);
int devm_gpiochip_add_data_with_key(struct device *dev, struct gpio_chip *gc,
void *data, struct lock_class_key *lock_key,
--
2.39.2



2024-06-11 06:39:57

by Greg Kroah-Hartman

[permalink] [raw]
Subject: Re: [PATCH] gpiolib: Remove data-less gpiochip_add() function

On Mon, Jun 10, 2024 at 08:53:13AM -0500, Andrew Davis wrote:
> GPIO chips should be added with driver-private data associated with the
> chip. If none is needed, NULL can be used. All users already do this
> except one, fix that here. With no more users of the base gpiochip_add()
> we can drop this function so no more users show up later.
>
> Signed-off-by: Andrew Davis <[email protected]>
> ---
> Documentation/driver-api/gpio/driver.rst | 5 ++---
> drivers/staging/greybus/gpio.c | 2 +-
> include/linux/gpio/driver.h | 4 ----
> 3 files changed, 3 insertions(+), 8 deletions(-)

Acked-by: Greg Kroah-Hartman <[email protected]>

2024-06-11 22:36:52

by Bartosz Golaszewski

[permalink] [raw]
Subject: Re: [PATCH] gpiolib: Remove data-less gpiochip_add() function

From: Bartosz Golaszewski <[email protected]>


On Mon, 10 Jun 2024 08:53:13 -0500, Andrew Davis wrote:
> GPIO chips should be added with driver-private data associated with the
> chip. If none is needed, NULL can be used. All users already do this
> except one, fix that here. With no more users of the base gpiochip_add()
> we can drop this function so no more users show up later.
>
>

Applied, thanks!

[1/1] gpiolib: Remove data-less gpiochip_add() function
commit: 3ff1180a39fbc43ae69d4238e6922c57e3278910

Best regards,
--
Bartosz Golaszewski <[email protected]>