gpiolib: unexport gpiod_set_transitory()
PATCH 1/1 gpiolib: unexport gpiod_set_transitory()
From: Bartosz Golaszewski <[email protected]>
There are no and never have been any users of gpiod_set_transitory() outside the core GPIOLIB code. Make it private.
--- drivers/gpio/gpiolib.c | 1 - drivers/gpio/gpiolib.h | 2 ++ include/linux/gpio/consumer.h | 8 -------- 3 files changed, 2 insertions(+), 9 deletions(-)
drivers/gpio/gpiolib.c +0 -1
@@ -2774,7 +2774,6 @@ int gpiod_set_transitory(struct gpio_desc *desc, bool transitory)PIN_CONFIG_PERSIST_STATE , !transitory); } -EXPORT_SYMBOL_GPL (gpiod_set_transitory);/** * gpiod_is_active_low - test whether a GPIO is active-low or not
drivers/gpio/gpiolib.h +2 -0
@@ -132,6 +132,8 @@ int gpiod_set_array_value_complex(bool raw, bool can_sleep,struct gpio_array *array_info, unsigned long *value_bitmap); +int gpiod_set_transitory (struct gpio_desc *desc,bool transitory); +extern spinlock_t gpio_lock;extern struct list_head gpio_devices;
include/linux/gpio/consumer.h +0 -8
@@ -159,7 +159,6 @@ int gpiod_set_raw_array_value_cansleep(unsigned int array_size,int gpiod_set_config (struct gpio_desc *desc,unsigned long config);int gpiod_set_debounce (struct gpio_desc *desc,unsigned int debounce); -int gpiod_set_transitory (struct gpio_desc *desc,bool transitory);void gpiod_toggle_active_low (struct gpio_desc *desc);int gpiod_is_active_low (const struct gpio_desc *desc);
@@ -494,13 +493,6 @@ static inline int gpiod_set_debounce(struct gpio_desc *desc, unsigned int debounreturn -ENOSYS ; } -static inline int gpiod_set_transitory (struct gpio_desc *desc,bool transitory) -{ -/* GPIO can never have been requested */ -WARN_ON (desc); -return -ENOSYS ; -} -static inline void gpiod_toggle_active_low (struct gpio_desc *desc) {/* GPIO can never have been requested */
Signature · 1 line
2.39.2
Quoted 6 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
There are no and never have been any users of
gpiod_set_transitory()outside the core GPIOLIB code. Make it private.Signed-off-by Bartosz Golaszewski <[email protected]>
Well spotted!
Yours,
Linus Walleij
Quoted 4 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
There are no and never have been any users of
gpiod_set_transitory()outside the core GPIOLIB code. Make it private.
And rename to be gpio_desc_...()?
With this done,
The rationale has been explained in the other threads with renaming matters.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Quoted 7 lines · Andy Shevchenko
Quoted 4 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
There are no and never have been any users of
gpiod_set_transitory()outside the core GPIOLIB code. Make it private.
Quoted 7 lines
And rename to be gpio_desc_...()?
With this done,
Reviewed-by Andy Shevchenko <[email protected]>The rationale has been explained in the other threads with renaming matters.
I'm not buying this explanation. Public GPIO functions don't have a monopoly on the gpiod_ prefix. Eventually I'd love to unify the naming convention for the three important structures that we use:gpio_device, gpio_chip and gpio_desc, no matter whether they're public or private as that's already clear from their placement in include/linux/ or drivers/gpio/.
Bartosz
Quoted 5 lines
--
With Best Regards,
Andy Shevchenko
Quoted 13 lines · Bartosz Golaszewski
Quoted 11 lines · Andy Shevchenko
Quoted 4 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
There are no and never have been any users of
gpiod_set_transitory()outside the core GPIOLIB code. Make it private.And rename to be gpio_desc_...()?
With this done,
Reviewed-by Andy Shevchenko <[email protected]>
Quoted 8 lines
Quoted 1 line
The rationale has been explained in the other threads with renaming matters.
I'm not buying this explanation. Public GPIO functions don't have a monopoly on the
gpiod_prefix. Eventually I'd love to unify the naming convention for the three important structures that we use:gpio_device,gpio_chipandgpio_desc, no matter whether they're public or private as that's already clear from their placement ininclude/linux/ordrivers/gpio/.
And I would like to avoid adding confusion by mixing internal and external APIs under the same prefix.
Personally I do not like this change, when gpiod_ is being used. So, you may override this, you are the maintainer, but then here is the formal NAK from me (as a user of these APIs internally and externally).
Signature · 2 lines
With Best Regards, Andy Shevchenko
Quoted 24 lines · Andy Shevchenko
Quoted 13 lines · Bartosz Golaszewski
Quoted 11 lines · Andy Shevchenko
Quoted 4 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
There are no and never have been any users of
gpiod_set_transitory()outside the core GPIOLIB code. Make it private.And rename to be gpio_desc_...()?
With this done,
Reviewed-by Andy Shevchenko <[email protected]>Quoted 8 lines
Quoted 1 line
The rationale has been explained in the other threads with renaming matters.
I'm not buying this explanation. Public GPIO functions don't have a monopoly on the
gpiod_prefix. Eventually I'd love to unify the naming convention for the three important structures that we use:gpio_device,gpio_chipandgpio_desc, no matter whether they're public or private as that's already clear from their placement ininclude/linux/ordrivers/gpio/.
Quoted 6 lines
And I would like to avoid adding confusion by mixing internal and external APIs under the same prefix.
Personally I do not like this change, when
gpiod_is being used. So, you may override this, you are the maintainer, but then here is the formal NAK from me (as a user of these APIs internally and externally).
This is still inconsistent with the rest of the public symbols - especially those in gpio/driver.h. My long-term plan - before making locking great again - is to limit the usage of any gpiochip_ symbols to GPIO providers (as the chip is not guaranteed to be valid, unlike gpio_device) and provide a bunch of gpio_device_ or gpiodev_ interfaces for use by those who *really* need it. Now am I going to make up two distinct prefixes for public and non-public APIs? That will be even more confusing IMO.
Just like in C++ you don't make up special names for public vs private methods except for some deranged coding styles that also require you to name arguments like "in_foo" and "out_bar".
Bart
Quoted 2 lines · Bartosz Golaszewski
On Mon, Sep 4, 2023 at 1:19 PM Andy Shevchenko
<[email protected]> wrote:
...
Quoted 9 lines
This is still inconsistent with the rest of the public symbols - especially those in
gpio/driver.h. My long-term plan - before making locking great again - is to limit the usage of anygpiochip_symbols to GPIO providers (as the chip is not guaranteed to be valid, unlikegpio_device) and provide a bunch ofgpio_device_orgpiodev_interfaces for use by those who *really* need it. Now am I going to make up two distinct prefixes for public and non-public APIs? That will be even more confusing IMO.
Quoted 3 lines
Just like in C++ you don't make up special names for public vs private methods except for some deranged coding styles that also require you to name arguments like "
in_foo" and "out_bar".
Yeah, I understand your point of view on this, but as I said "disagree and commit" (used to be corporate value at some point :-).
On my side I criticized and proposed... It's your turn what to do with that, I'm not insisting on my way, I'm just telling I don't like yours, but I will survive, no hard feelings :-)
Signature · 2 lines
With Best Regards, Andy Shevchenko