gpiolib: work towards removing gpiochip_find()
v3 cover gpiolib: work towards removing gpiochip_find()
From: Bartosz Golaszewski <[email protected]>
This is a reduced subset of patches from the initial sumbission[1] limited only to changes inside GPIOLIB. Once this is upstream, we can then slowly merge patches for other subsystems (like HTE) and then eventually remove gpiochip_find() entirely.
The GPIO subsystem does not handle hot-unplug events very well. We have recently patched the user-space part of it so that at least a rouge user cannot crash the kernel but in-kernel users are still affected by a lot of
issues: from incorrect locking or lack thereof to using structures that are private to GPIO drivers. Since almost all GPIO controllers can be unbound, not to mention that we have USB devices registering GPIO expanders as well as I2C-on-USB HID devices on which I2C GPIO expanders can live, various media gadgets etc., we really need to make GPIO hotplug/unplug friendly.
Before we can even get to fixing the locking, we need to address a serious abuse of the GPIO driver API - accessing struct gpio_chip by anyone who isn't the driver owning this object. This structure is owned by the GPIO provider and its lifetime is tied to that of that provider. It is destroyed when the device is unregistered and this may happen at any moment. struct gpio_device is the opaque, reference counted interface to struct gpio_chip (which is the low-level implementation) and all access should pass through it.
The end-goal is to make all gpio_device manipulators check the existence of gdev->chip and then lock it for the duration of any of the calls using SRCU. Before we can get there, we need to first provide a set of functions that will replace any gpio_chip functions and convert all in-kernel users.
This series adds several new helpers to the public GPIO API and uses them across the core GPIO code.
Note that this does not make everything correct just yet. Especially the GPIOLIB internal users release the reference returned by the lookup function after getting the descriptor of interest but before requesting it. This will eventually be addressed. This is not a regression either.
[1] https://lore.kernel.org/lkml/[email protected]/T/
v2 -> v3:
- use gpio_device_get_chip() consistently
- clarify comments
- fix buggy chip assignment
- check for PTR_ERR() in automatic cleanup
- rearrange code as requested by Andy
v1 -> v2:
- drop all non-GPIOLIB patches
- collect tags
- fix kernel docs
- use gpio_device_get_chip() and gpio_device_get_desc() where applicable
Bartosz Golaszewski (11):
gpiolib: make gpio_device_get() and gpio_device_put() public
gpiolib: add support for scope-based management to gpio_device
gpiolib: provide gpio_device_find()
gpiolib: provide gpio_device_find_by_label()
gpiolib: provide gpio_device_get_desc()
gpiolib: reluctantly provide gpio_device_get_chip()
gpiolib: replace find_chip_by_name() with gpio_device_find_by_label()
gpio: of: replace gpiochip_find_* with gpio_device_find_*
gpio: acpi: replace gpiochip_find() with gpio_device_find()
gpio: swnode: replace gpiochip_find() with gpio_device_find_by_label()
gpio: sysfs: drop the mention of gpiochip_find() from sysfs code
drivers/gpio/gpiolib-acpi.c | 12 +- drivers/gpio/gpiolib-of.c | 33 +++--- drivers/gpio/gpiolib-swnode.c | 33 +++--- drivers/gpio/gpiolib-sysfs.c | 2 +- drivers/gpio/gpiolib.c | 202 ++++++++++++++++++++++++++-------- drivers/gpio/gpiolib.h | 10 -- include/linux/gpio/driver.h | 16 +++ 7 files changed, 216 insertions(+), 92 deletions(-)
Signature · 1 line
2.39.2
PATCH v3 1/11 gpiolib: make gpio_device_get() and gpio_device_put() public
From: Bartosz Golaszewski <[email protected]>
In order to start migrating away from accessing struct gpio_chip by users other than their owners, let's first make the reference management functions for the opaque struct gpio_device public in the driver.h header.
--- drivers/gpio/gpiolib.c | 24 ++++++++++++++++++++++++ drivers/gpio/gpiolib.h | 10 ---------- include/linux/gpio/driver.h | 3 +++ 3 files changed, 27 insertions(+), 10 deletions(-)
drivers/gpio/gpiolib.c +24 -0
@@ -1058,6 +1058,30 @@ static struct gpio_chip *find_chip_by_name(const char *name)return gpiochip_find ((void *)name, gpiochip_match_name); } +/** +* gpio_device_get() - Increase the reference count of this GPIO device +* @gdev: GPIO device to increase the refcount for +* +* Returns: +* Pointer to @gdev. +*/ +struct gpio_device *gpio_device_get (struct gpio_device *gdev) +{ +return to_gpio_device (get_device (&gdev->dev)); +} +EXPORT_SYMBOL_GPL (gpio_device_get); + +/** +* gpio_device_put() - Decrease the reference count of this GPIO device and +* possibly free all resources associated with it. +* @gdev: GPIO device to decrease the reference count for +*/ +void gpio_device_put (struct gpio_device *gdev) +{ +put_device (&gdev->dev); +} +EXPORT_SYMBOL_GPL (gpio_device_put); +#ifdef CONFIG_GPIOLIB_IRQCHIP /*
drivers/gpio/gpiolib.h +0 -10
@@ -86,16 +86,6 @@ static inline struct gpio_device *to_gpio_device(struct device *dev) return container_of(dev, struct gpio_device, dev); } -static inline struct gpio_device *gpio_device_get (struct gpio_device *gdev) -{ -return to_gpio_device (get_device (&gdev->dev)); -} - -static inline void gpio_device_put (struct gpio_device *gdev) -{ -put_device (&gdev->dev); -} -/* gpio suffixes used for ACPI and device tree lookup */ static __maybe_unused const char *const gpio_suffixes[] = {"gpios" ,"gpio" };
include/linux/gpio/driver.h +3 -0
@@ -606,6 +606,9 @@ int devm_gpiochip_add_data_with_key(struct device *dev, struct gpio_chip *gc,struct gpio_chip *gpiochip_find (void *data,int (*match)(struct gpio_chip *gc,void *data)); +struct gpio_device *gpio_device_get (struct gpio_device *gdev); +void gpio_device_put (struct gpio_device *gdev); +bool gpiochip_line_is_irq (struct gpio_chip *gc,unsigned int offset);int gpiochip_reqres_irq (struct gpio_chip *gc,unsigned int offset);void gpiochip_relres_irq (struct gpio_chip *gc,unsigned int offset);
Signature · 1 line
2.39.2
PATCH v3 2/11 gpiolib: add support for scope-based management to gpio_device
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
As the few users that need to get the reference to the GPIO device often release it right after inspecting its properties, let's add support for the automatic reference release to struct gpio_device.
--- include/linux/gpio/driver.h | 5 +++++ 1 file changed, 5 insertions(+)
include/linux/gpio/driver.h +5 -0
@@ -3,6 +3,8 @@#define __LINUX_GPIO_DRIVER_H#include <linux/bits.h> +#include <linux/cleanup.h> +#include <linux/err.h> #include <linux/irqchip/chained_irq.h> #include <linux/irqdomain.h> #include <linux/irqhandler.h>
@@ -609,6 +611,9 @@ struct gpio_chip *gpiochip_find(void *data,struct gpio_device *gpio_device_get (struct gpio_device *gdev);void gpio_device_put (struct gpio_device *gdev); +DEFINE_FREE(gpio_device_put, struct gpio_device *, + if (IS_ERR_OR_NULL(_T)) gpio_device_put(_T)); +bool gpiochip_line_is_irq (struct gpio_chip *gc,unsigned int offset);int gpiochip_reqres_irq (struct gpio_chip *gc,unsigned int offset);void gpiochip_relres_irq (struct gpio_chip *gc,unsigned int offset);
Signature · 1 line
2.39.2
PATCH v3 3/11 gpiolib: provide gpio_device_find()
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
gpiochip_find() is wrong and its kernel doc is misleading as the function doesn't return a reference to the gpio_chip but just a raw pointer. The chip itself is not guaranteed to stay alive, in fact it can be deleted at any point. Also: other than GPIO drivers themselves, nobody else has any business accessing gpio_chip structs.
Provide a new gpio_device_find() function that returns a real reference to the opaque gpio_device structure that is guaranteed to stay alive for as long as there are active users of it.
--- drivers/gpio/gpiolib.c | 71 +++++++++++++++++++++++++++---------- include/linux/gpio/driver.h | 3 ++ 2 files changed, 56 insertions(+), 18 deletions(-)
drivers/gpio/gpiolib.c +53 -18
@@ -1014,16 +1014,10 @@ void gpiochip_remove(struct gpio_chip *gc) }EXPORT_SYMBOL_GPL (gpiochip_remove); -/** -* gpiochip_find() - iterator for locating a specific gpio_chip -* @data: data to pass to match function -* @match: Callback function to check gpio_chip +/* +* FIXME: This will be removed soon. * -* Similar to bus_find_device. It returns a reference to a gpio_chip as -* determined by a user supplied @match callback. The callback should return -* 0 if the device doesn't match and non-zero if it does. If the callback is -* non-zero, this function will return to the caller and not iterate over any -* more gpio_chips. +* This function is depracated, don't use. */ struct gpio_chip *gpiochip_find(void *data, int (*match)(struct gpio_chip *gc,
@@ -1031,21 +1025,62 @@ struct gpio_chip *gpiochip_find(void *data, {struct gpio_device *gdev;struct gpio_chip *gc =NULL ; -unsigned long flags; -spin_lock_irqsave (&gpio_lock, flags); -list_for_each_entry (gdev, &gpio_devices, list) -if (gdev->chip &&match (gdev->chip, data)) { - gc = gdev->chip; -break ; - } - -spin_unlock_irqrestore (&gpio_lock, flags); + gdev =gpio_device_find (data, match); +if (gdev) { + gc = gdev->chip; +gpio_device_put (gdev); + }return gc; }EXPORT_SYMBOL_GPL (gpiochip_find); +/** +* gpio_device_find() - find a specific GPIO device +* @data: data to pass to match function +* @match: Callback function to check gpio_chip +* +* Returns: +* New reference to struct gpio_device. +* +* Similar to bus_find_device(). It returns a reference to a gpio_device as +* determined by a user supplied @match callback. The callback should return +* 0 if the device doesn't match and non-zero if it does. If the callback +* returns non-zero, this function will return to the caller and not iterate +* over any more gpio_devices. +* +* The callback takes the GPIO chip structure as argument. During the execution +* of the callback function the chip is protected from being freed. TODO: This +* actually has yet to be implemented. +* +* If the function returns non-NULL, the returned reference must be freed by +* the caller using gpio_device_put(). +*/ +struct gpio_device *gpio_device_find (void *data, +int (*match)(struct gpio_chip *gc, +void *data)) +{ +struct gpio_device *gdev; + +/* +* Not yet but in the future the spinlock below will become a mutex. +* Annotate this function before anyone tries to use it in interrupt +* context like it happened with gpiochip_find(). +*/ +might_sleep (); + +guard (spinlock_irqsave)(&gpio_lock); + +list_for_each_entry (gdev, &gpio_devices, list) { +if (gdev->chip &&match (gdev->chip, data)) +return gpio_device_get (gdev); + } + +return NULL ; +} +EXPORT_SYMBOL_GPL (gpio_device_find); +static int gpiochip_match_name (struct gpio_chip *gc,void *data) {const char *name = data;
include/linux/gpio/driver.h +3 -0
@@ -608,6 +608,9 @@ int devm_gpiochip_add_data_with_key(struct device *dev, struct gpio_chip *gc,struct gpio_chip *gpiochip_find (void *data,int (*match)(struct gpio_chip *gc,void *data)); +struct gpio_device *gpio_device_find (void *data, +int (*match)(struct gpio_chip *gc,void *data)); +struct gpio_device *gpio_device_get (struct gpio_device *gdev);void gpio_device_put (struct gpio_device *gdev);
Signature · 1 line
2.39.2
PATCH v3 4/11 gpiolib: provide gpio_device_find_by_label()
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
By far the most common way of looking up GPIO devices is using their label. Provide a helpers for that to avoid every user implementing their own matching function.
--- drivers/gpio/gpiolib.c | 21 +++++++++++++++++++++ include/linux/gpio/driver.h | 1 + 2 files changed, 22 insertions(+)
drivers/gpio/gpiolib.c +21 -0
@@ -20,6 +20,7 @@#include <linux/seq_file.h> #include <linux/slab.h> #include <linux/spinlock.h> +#include <linux/string.h> #include <linux/gpio.h> #include <linux/gpio/driver.h>
@@ -1081,6 +1082,26 @@ struct gpio_device *gpio_device_find(void *data, }EXPORT_SYMBOL_GPL (gpio_device_find); +static int gpio_chip_match_by_label (struct gpio_chip *gc,void *label) +{ +return gc->label && !strcmp (gc->label, label); +} + +/** +* gpio_device_find_by_label() - wrapper around gpio_device_find() finding the +* GPIO device by its backing chip's label +* @label: Label to lookup +* +* Returns: +* Reference to the GPIO device or NULL. Reference must be released with +* gpio_device_put(). +*/ +struct gpio_device *gpio_device_find_by_label (const char *label) +{ +return gpio_device_find ((void *)label, gpio_chip_match_by_label); +} +EXPORT_SYMBOL_GPL (gpio_device_find_by_label); +static int gpiochip_match_name (struct gpio_chip *gc,void *data) {const char *name = data;
include/linux/gpio/driver.h +1 -0
@@ -610,6 +610,7 @@ struct gpio_chip *gpiochip_find(void *data,struct gpio_device *gpio_device_find (void *data,int (*match)(struct gpio_chip *gc,void *data)); +struct gpio_device *gpio_device_find_by_label (const char *label);struct gpio_device *gpio_device_get (struct gpio_device *gdev);void gpio_device_put (struct gpio_device *gdev);
Signature · 1 line
2.39.2
Re: [PATCH v3 04/11] gpiolib: provide gpio_device_find_by_label()
Quoted 5 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
By far the most common way of looking up GPIO devices is using their label. Provide a helpers for that to avoid every user implementing their own matching function.
...
drivers/gpio/gpiolib.c struct gpio_device *gpio_device_find(void *data, · line 1088
Quoted 4 lines
drivers/gpio/gpiolib.c +4
-0+static int gpio_chip_match_by_label (struct gpio_chip *gc,void *label) +{ +return gc->label && !strcmp (gc->label, label); +}
I am still wondering if we can oblige providers to have label to be non-empty.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v3 04/11] gpiolib: provide gpio_device_find_by_label()
Quoted 8 lines · Andy Shevchenko
Quoted 5 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
By far the most common way of looking up GPIO devices is using their label. Provide a helpers for that to avoid every user implementing their own matching function.
Quoted 9 lines
...
drivers/gpio/gpiolib.c struct gpio_device *gpio_device_find(void *data, · line 1088
Quoted 4 lines
drivers/gpio/gpiolib.c +4
-0+static int gpio_chip_match_by_label (struct gpio_chip *gc,void *label) +{ +return gc->label && !strcmp (gc->label, label); +}I am still wondering if we can oblige providers to have label to be non-empty.
Of course we can. Just bail out of gpiochip_add_data_with_key() if it is. But that's material for a different patch.
Bart
Re: [PATCH v3 04/11] gpiolib: provide gpio_device_find_by_label()
Quoted 9 lines · Bartosz Golaszewski
Quoted 7 lines · Andy Shevchenko
Quoted 5 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
By far the most common way of looking up GPIO devices is using their label. Provide a helpers for that to avoid every user implementing their own matching function.
...
Quoted 9 lines
Quoted 6 lines
drivers/gpio/gpiolib.c struct gpio_device *gpio_device_find(void *data, · line 1088
Quoted 4 lines
drivers/gpio/gpiolib.c +4
-0+static int gpio_chip_match_by_label (struct gpio_chip *gc,void *label) +{ +return gc->label && !strcmp (gc->label, label); +}I am still wondering if we can oblige providers to have label to be non-empty.
Of course we can. Just bail out of
gpiochip_add_data_with_key()if it is. But that's material for a different patch.
Yes, but my point here is that
1) the current users are already following this requirement;
2) the enforcement can be done explicitly somewhere (in the register function).
Is the 1) incorrect assumption?
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v3 04/11] gpiolib: provide gpio_device_find_by_label()
Quoted 21 lines · Andy Shevchenko
Quoted 9 lines · Bartosz Golaszewski
Quoted 7 lines · Andy Shevchenko
Quoted 5 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
By far the most common way of looking up GPIO devices is using their label. Provide a helpers for that to avoid every user implementing their own matching function.
...
Quoted 7 lines
Quoted 6 lines
drivers/gpio/gpiolib.c struct gpio_device *gpio_device_find(void *data, · line 1088
Quoted 4 lines
drivers/gpio/gpiolib.c +4
-0+static int gpio_chip_match_by_label (struct gpio_chip *gc,void *label) +{ +return gc->label && !strcmp (gc->label, label); +}I am still wondering if we can oblige providers to have label to be non-empty.
Quoted 9 lines
Quoted 2 lines
Of course we can. Just bail out of
gpiochip_add_data_with_key()if it is. But that's material for a different patch.Yes, but my point here is that
1) the current users are already following this requirement;
2) the enforcement can be done explicitly somewhere (in the register function).Is the 1) incorrect assumption?
I remember doing a quick glance over GPIO providers and it looks like ALL of them set the label. But I may have missed something. I would start with a warning.
Bart
Re: [PATCH v3 04/11] gpiolib: provide gpio_device_find_by_label()
Quoted 7 lines · Bartosz Golaszewski
Quoted 5 lines · Andy Shevchenko
Quoted 4 lines · Bartosz Golaszewski
Quoted 2 lines · Andy Shevchenko
Quoted 1 line · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
...
Quoted 14 lines
Quoted 14 lines
Quoted 9 lines
Quoted 6 lines
drivers/gpio/gpiolib.c struct gpio_device *gpio_device_find(void *data, · line 1088
Quoted 4 lines
drivers/gpio/gpiolib.c +4
-0+static int gpio_chip_match_by_label (struct gpio_chip *gc,void *label) +{ +return gc->label && !strcmp (gc->label, label); +}I am still wondering if we can oblige providers to have label to be non-empty.
Of course we can. Just bail out of
gpiochip_add_data_with_key()if it is. But that's material for a different patch.Yes, but my point here is that
1) the current users are already following this requirement;
2) the enforcement can be done explicitly somewhere (in the register function).
Quoted 5 lines
Quoted 1 line
Is the 1) incorrect assumption?
I remember doing a quick glance over GPIO providers and it looks like ALL of them set the label. But I may have missed something. I would start with a warning.
For now I would drop the NULL check. We will have a few weeks to see if somebody screams about. Meanwhile we can add the real error message patch if no-one complains.
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v3 04/11] gpiolib: provide gpio_device_find_by_label()
Quoted 28 lines · Andy Shevchenko
Quoted 7 lines · Bartosz Golaszewski
Quoted 5 lines · Andy Shevchenko
Quoted 4 lines · Bartosz Golaszewski
Quoted 2 lines · Andy Shevchenko
Quoted 1 line · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
...
Quoted 16 lines
Quoted 15 lines
Quoted 9 lines
Quoted 6 lines
drivers/gpio/gpiolib.c struct gpio_device *gpio_device_find(void *data, · line 1088
Quoted 4 lines
drivers/gpio/gpiolib.c +4
-0+static int gpio_chip_match_by_label (struct gpio_chip *gc,void *label) +{ +return gc->label && !strcmp (gc->label, label); +}I am still wondering if we can oblige providers to have label to be non-empty.
Of course we can. Just bail out of
gpiochip_add_data_with_key()if it is. But that's material for a different patch.Yes, but my point here is that
1) the current users are already following this requirement;
2) the enforcement can be done explicitly somewhere (in the register function).Is the 1) incorrect assumption?
Quoted 7 lines
Quoted 3 lines
I remember doing a quick glance over GPIO providers and it looks like ALL of them set the label. But I may have missed something. I would start with a warning.
For now I would drop the NULL check. We will have a few weeks to see if somebody screams about. Meanwhile we can add the real error message patch if no-one complains.
No, I'm not going to potentially break stuff like that as a way to detect bugs. That's not a hot path, we're not gaining much. Let's add a warning first, wait for some time, make it an error and then remove the check.
Bart
PATCH v3 5/11 gpiolib: provide gpio_device_get_desc()
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
Getting the GPIO descriptor directly from the gpio_chip struct is dangerous as we don't take the reference to the underlying GPIO device. In order to start working towards removing gpiochip_get_desc(), let's provide a safer variant that works with an existing reference to struct gpio_device.
--- drivers/gpio/gpiolib.c | 46 +++++++++++++++++++++++++++---------- include/linux/gpio/driver.h | 2 ++ 2 files changed, 36 insertions(+), 12 deletions(-)
drivers/gpio/gpiolib.c +34 -12
@@ -147,27 +147,49 @@ struct gpio_desc *gpio_to_desc(unsigned gpio) }EXPORT_SYMBOL_GPL (gpio_to_desc); -/** -* gpiochip_get_desc - get the GPIO descriptor corresponding to the given -* hardware number for this chip -* @gc: GPIO chip -* @hwnum: hardware number of the GPIO for this chip -* -* Returns: -* A pointer to the GPIO descriptor or ``ERR_PTR(-EINVAL)`` if no GPIO exists -* in the given chip for the specified hardware number. -*/ +/* This function is deprecated and will be removed soon, don't use. */ struct gpio_desc *gpiochip_get_desc (struct gpio_chip *gc,unsigned int hwnum) { -struct gpio_device *gdev = gc->gpiodev; +return gpio_device_get_desc (gc->gpiodev, hwnum); +} +EXPORT_SYMBOL_GPL (gpiochip_get_desc); + +/** +* gpio_device_get_desc() - get the GPIO descriptor corresponding to the given +* hardware number for this GPIO device +* @gdev: GPIO device to get the descriptor from +* @hwnum: hardware number of the GPIO for this chip +* +* Returns: +* A pointer to the GPIO descriptor or %EINVAL if no GPIO exists in the given +* chip for the specified hardware number or %ENODEV if the underlying chip +* already vanished. +* +* The reference count of struct gpio_device is *NOT* increased like when the +* GPIO is being requested for exclusive usage. It's up to the caller to make +* sure the GPIO device will stay alive together with the descriptor returned +* by this function. +*/ +struct gpio_desc * +gpio_device_get_desc (struct gpio_device *gdev,unsigned int hwnum) +{ +struct gpio_chip *gc; + +/* +* FIXME: This will be locked once we protect gdev->chip everywhere +* with SRCU. +*/ + gc = gdev->chip; +if (!gc) +return ERR_PTR (-ENODEV );if (hwnum >= gdev->ngpio)return ERR_PTR (-EINVAL );return &gdev->descs[hwnum]; } -EXPORT_SYMBOL_GPL (gpiochip_get_desc); +EXPORT_SYMBOL_GPL (gpio_device_get_desc);/** * desc_to_gpio - convert a GPIO descriptor to the integer namespace
include/linux/gpio/driver.h +2 -0
@@ -770,6 +770,8 @@ struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *gc,void gpiochip_free_own_desc (struct gpio_desc *desc);struct gpio_desc *gpiochip_get_desc (struct gpio_chip *gc,unsigned int hwnum); +struct gpio_desc * +gpio_device_get_desc (struct gpio_device *gdev,unsigned int hwnum);#ifdef CONFIG_GPIOLIB
Signature · 1 line
2.39.2
PATCH v3 6/11 gpiolib: reluctantly provide gpio_device_get_chip()
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
The process of converting all unauthorized users of struct gpio_chip to using dedicated struct gpio_device function will be long so in the meantime we must provide a way of retrieving the pointer to struct gpio_chip from a GPIO device.
--- drivers/gpio/gpiolib.c | 21 +++++++++++++++++++++ include/linux/gpio/driver.h | 2 ++ 2 files changed, 23 insertions(+)
drivers/gpio/gpiolib.c +21 -0
@@ -220,6 +220,27 @@ struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc) }EXPORT_SYMBOL_GPL (gpiod_to_chip); +/** +* gpio_device_get_chip() - Get the gpio_chip implementation of this GPIO device +* @gdev: GPIO device +* +* Returns: +* Address of the GPIO chip backing this device. +* +* Until we can get rid of all non-driver users of struct gpio_chip, we must +* provide a way of retrieving the pointer to it from struct gpio_device. This +* is *NOT* safe as the GPIO API is considered to be hot-unpluggable and the +* chip can dissapear at any moment (unlike reference-counted struct +* gpio_device). +* +* Use at your own risk. +*/ +struct gpio_chip *gpio_device_get_chip (struct gpio_device *gdev) +{ +return gdev->chip; +} +EXPORT_SYMBOL_GPL (gpio_device_get_chip); +/* dynamic allocation of GPIOs, e.g. on a hotplugged device */ static int gpiochip_find_base (int ngpio) {
include/linux/gpio/driver.h +2 -0
@@ -773,6 +773,8 @@ struct gpio_desc *gpiochip_get_desc(struct gpio_chip *gc, unsigned int hwnum);struct gpio_desc *gpio_device_get_desc (struct gpio_device *gdev,unsigned int hwnum); +struct gpio_chip *gpio_device_get_chip (struct gpio_device *gdev); +#ifdef CONFIG_GPIOLIB /* lock/unlock as IRQ */
Signature · 1 line
2.39.2
PATCH v3 7/11 gpiolib: replace find_chip_by_name() with gpio_device_find_by_label()
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
Remove all remaining uses of find_chip_by_name() (and subsequently:gpiochip_find()) from gpiolib.c and use the new gpio_device_find_by_label() instead.
--- drivers/gpio/gpiolib.c | 33 ++++++++++++--------------------- 1 file changed, 12 insertions(+), 21 deletions(-)
drivers/gpio/gpiolib.c +12 -21
@@ -1145,18 +1145,6 @@ struct gpio_device *gpio_device_find_by_label(const char *label) }EXPORT_SYMBOL_GPL (gpio_device_find_by_label); -static int gpiochip_match_name (struct gpio_chip *gc,void *data) -{ -const char *name = data; - -return !strcmp (gc->label, name); -} - -static struct gpio_chip *find_chip_by_name (const char *name) -{ -return gpiochip_find ((void *)name, gpiochip_match_name); -} -/** * gpio_device_get() - Increase the reference count of this GPIO device * @gdev: GPIO device to increase the refcount for
@@ -3908,21 +3896,22 @@ EXPORT_SYMBOL_GPL(gpiod_remove_lookup_table);*/ void gpiod_add_hogs (struct gpiod_hog *hogs) { -struct gpio_chip *gc;struct gpiod_hog *hog;mutex_lock (&gpio_machine_hogs_mutex);for (hog = &hogs[0 ]; hog->chip_label; hog++) { + struct gpio_device *gdev __free(gpio_device_put) = NULL; +list_add_tail (&hog->list, &gpio_machine_hogs);/* * The chip may have been registered earlier, so check if it * exists and, if so, try to hog the line now. */ - gc =find_chip_by_name (hog->chip_label); -if (gc) -gpiochip_machine_hog (gc, hog); + gdev =gpio_device_find_by_label (hog->chip_label); +if (gdev) +gpiochip_machine_hog (gpio_device_get_chip (gdev), hog); }mutex_unlock (&gpio_machine_hogs_mutex);
@@ -3977,13 +3966,14 @@ static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,struct gpio_desc *desc =ERR_PTR (-ENOENT );struct gpiod_lookup_table *table;struct gpiod_lookup *p; +struct gpio_chip *gc; table =gpiod_find_lookup_table (dev);if (!table)return desc;for (p = &table->table[0 ]; p->key; p++) { -struct gpio_chip *gc; + struct gpio_device *gdev __free(gpio_device_put) = NULL;/* idx must always match exactly */ if (p->idx != idx)
@@ -4005,9 +3995,8 @@ static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,return ERR_PTR (-EPROBE_DEFER ); } - gc =find_chip_by_name (p->key); - -if (!gc) { + gdev =gpio_device_find_by_label (p->key); +if (!gdev) {/* * As the lookup table indicates a chip with * p->key should exist, assume it may
@@ -4020,6 +4009,8 @@ static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,return ERR_PTR (-EPROBE_DEFER ); } + gc =gpio_device_get_chip (gdev); +if (gc->ngpio <= p->chip_hwnum) { dev_err(dev, "requested GPIO %u (%u) is out of range [0..%u] for chip %s\n",
@@ -4028,7 +4019,7 @@ static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,return ERR_PTR (-EINVAL ); } - desc =gpiochip_get_desc (gc, p->chip_hwnum); + desc =gpio_device_get_desc (gdev, p->chip_hwnum); *flags = p->flags;return desc;
Signature · 1 line
2.39.2
Re: [PATCH v3 07/11] gpiolib: replace find_chip_by_name() with gpio_device_find_by_label()
Quoted 5 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
Remove all remaining uses of
find_chip_by_name()(and subsequently:gpiochip_find()) fromgpiolib.cand use the newgpio_device_find_by_label()instead.
...
drivers/gpio/gpiolib.c struct gpio_device *gpio_device_find_by_label(const char *label) · line 1152
Quoted 5 lines
drivers/gpio/gpiolib.c +0
-5-static int gpiochip_match_name (struct gpio_chip *gc,void *data) -{ -const char *name = data; - -return !strcmp (gc->label, name);
And this we had no check for the label being NULL...
...
drivers/gpio/gpiolib.c static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
Quoted 5 lines
drivers/gpio/gpiolib.c +3
-0for (p = &table->table[0 ]; p->key; p++) { + struct gpio_device *gdev __free(gpio_device_put) = NULL; + gdev =gpio_device_find_by_label (p->key); +if (!gdev) {
I haven't got the fix for gpio-sim, shouldn't we have the same here, i.e. definition being done together with the assignment when __free() is in use?
Quoted 1 line
}
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v3 07/11] gpiolib: replace find_chip_by_name() with gpio_device_find_by_label()
Quoted 10 lines · Andy Shevchenko
Quoted 5 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
Remove all remaining uses of
find_chip_by_name()(and subsequently:gpiochip_find()) fromgpiolib.cand use the newgpio_device_find_by_label()instead....
Quoted 8 lines
drivers/gpio/gpiolib.c struct gpio_device *gpio_device_find_by_label(const char *label) · line 1152
Quoted 5 lines
drivers/gpio/gpiolib.c +0
-5-static int gpiochip_match_name (struct gpio_chip *gc,void *data) -{ -const char *name = data; - -return !strcmp (gc->label, name);And this we had no check for the label being NULL...
Yeah, it was wrong. But maybe all kernel users already do assign it in which case we should be safe just adding a check in gpiochip_add_data_with_key() that would return EINVAL if they don't.
Quoted 11 lines
...
drivers/gpio/gpiolib.c static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id, · line 3999
Quoted 5 lines
for (p = &table->table[0]; p->key; p++) {drivers/gpio/gpiolib.c +3
-0+ struct gpio_device *gdev __free(gpio_device_put) = NULL; + gdev =gpio_device_find_by_label (p->key); +if (!gdev) {I haven't got the fix for gpio-sim, shouldn't we have the same here, i.e. definition being done together with the assignment when
__free()is in use?
It should but I only got yelled at by Linus under the gpio-sim patch after I sent this one.
Bart
Quoted 7 lines
Quoted 1 line
}--
With Best Regards,
Andy Shevchenko
Re: [PATCH v3 07/11] gpiolib: replace find_chip_by_name() with gpio_device_find_by_label()
Quoted 6 lines · Bartosz Golaszewski
Quoted 3 lines · Andy Shevchenko
Quoted 2 lines
for (p = &table->table[0]; p->key; p++) {+ struct
gpio_device*gdev__free(gpio_device_put)= NULL;
Quoted 8 lines
Quoted 5 lines
drivers/gpio/gpiolib.c static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id, · line 3999
Quoted 2 lines
drivers/gpio/gpiolib.c +2
-0+ gdev =gpio_device_find_by_label (p->key); +if (!gdev) {I haven't got the fix for gpio-sim, shouldn't we have the same here, i.e. definition being done together with the assignment when
__free()is in use?It should but I only got yelled at by Linus under the gpio-sim patch after I sent this one.
That happens, it's all new.
I guess ideally we should patch checkpatch to just moan about this, I wonder how hard that could be (I've only patched it once in my life...)
Yours,
Linus Walleij
PATCH v3 8/11 gpio: of: replace gpiochip_find_* with gpio_device_find_*
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
We're porting all users of gpiochip_find() to using gpio_device_find(). Update the OF GPIO code.
--- drivers/gpio/gpiolib-of.c | 33 +++++++++++++++++---------------- 1 file changed, 17 insertions(+), 16 deletions(-)
drivers/gpio/gpiolib-of.c +17 -16
@@ -127,10 +127,10 @@ static int of_gpiochip_match_node_and_xlate(struct gpio_chip *chip, void *data) chip->of_xlate (chip, gpiospec,NULL ) >=0 ; } -static struct gpio_chip *of_find_gpiochip_by_xlate ( -struct of_phandle_args *gpiospec) +static struct gpio_device * +of_find_gpio_device_by_xlate (struct of_phandle_args *gpiospec) { -return gpiochip_find (gpiospec, of_gpiochip_match_node_and_xlate); +return gpio_device_find (gpiospec, of_gpiochip_match_node_and_xlate); } static struct gpio_desc *of_xlate_and_get_gpiod_flags(struct gpio_chip *chip,
@@ -362,8 +362,8 @@ static void of_gpio_flags_quirks(const struct device_node *np,static struct gpio_desc *of_get_named_gpiod_flags (const struct device_node *np,const char *propname,int index,enum of_gpio_flags *flags) { + struct gpio_device *gdev __free(gpio_device_put) = NULL;struct of_phandle_args gpiospec; -struct gpio_chip *chip;struct gpio_desc *desc;int ret;
@@ -375,13 +375,14 @@ static struct gpio_desc *of_get_named_gpiod_flags(const struct device_node *np,return ERR_PTR (ret); } - chip =of_find_gpiochip_by_xlate (&gpiospec); -if (!chip) { + gdev =of_find_gpio_device_by_xlate (&gpiospec); +if (!gdev) { desc =ERR_PTR (-EPROBE_DEFER ); goto out; } - desc =of_xlate_and_get_gpiod_flags (chip, &gpiospec, flags); + desc =of_xlate_and_get_gpiod_flags (gpio_device_get_chip (gdev), + &gpiospec, flags);if (IS_ERR (desc)) goto out;
@@ -813,16 +814,16 @@ static int of_gpiochip_match_node(struct gpio_chip *chip, void *data)return device_match_of_node (&chip->gpiodev->dev, data); } -static struct gpio_chip *of_find_gpiochip_by_node (struct device_node *np) +static struct gpio_device *of_find_gpio_device_by_node (struct device_node *np) { -return gpiochip_find (np, of_gpiochip_match_node); +return gpio_device_find (np, of_gpiochip_match_node); }static int of_gpio_notify (struct notifier_block *nb,unsigned long action,void *arg) { + struct gpio_device *gdev __free(gpio_device_put) = NULL;struct of_reconfig_data *rd = arg; -struct gpio_chip *chip;int ret;/*
@@ -839,11 +840,11 @@ static int of_gpio_notify(struct notifier_block *nb, unsigned long action,if (of_node_test_and_set_flag (rd->dn,OF_POPULATED ))return NOTIFY_DONE ; - chip =of_find_gpiochip_by_node (rd->dn->parent); -if (chip ==NULL ) + gdev =of_find_gpio_device_by_node (rd->dn->parent); +if (!gdev)return NOTIFY_DONE ;/* not for us */ - ret =of_gpiochip_add_hog (chip, rd->dn); + ret =of_gpiochip_add_hog (gpio_device_get_chip (gdev), rd->dn);if (ret <0 ) {pr_err ("%s: failed to add hogs for %pOF\n" , __func__, rd->dn);
@@ -856,11 +857,11 @@ static int of_gpio_notify(struct notifier_block *nb, unsigned long action,if (!of_node_check_flag (rd->dn,OF_POPULATED ))return NOTIFY_DONE ;/* already depopulated */ - chip =of_find_gpiochip_by_node (rd->dn->parent); -if (chip ==NULL ) + gdev =of_find_gpio_device_by_node (rd->dn->parent); +if (!gdev)return NOTIFY_DONE ;/* not for us */ -of_gpiochip_remove_hog (chip, rd->dn); +of_gpiochip_remove_hog (gpio_device_get_chip (gdev), rd->dn);of_node_clear_flag (rd->dn,OF_POPULATED );return NOTIFY_OK ; }
Signature · 1 line
2.39.2
PATCH v3 9/11 gpio: acpi: replace gpiochip_find() with gpio_device_find()
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
We're porting all users of gpiochip_find() to using gpio_device_find(). Update the ACPI GPIO code.
--- drivers/gpio/gpiolib-acpi.c | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-)
drivers/gpio/gpiolib-acpi.c +8 -4
@@ -143,7 +143,7 @@ static int acpi_gpiochip_find(struct gpio_chip *gc, void *data)*/ static struct gpio_desc *acpi_get_gpiod (char *path,unsigned int pin) { -struct gpio_chip *chip; + struct gpio_device *gdev __free(gpio_device_put) = NULL;acpi_handle handle;acpi_status status;
@@ -151,11 +151,15 @@ static struct gpio_desc *acpi_get_gpiod(char *path, unsigned int pin)if (ACPI_FAILURE (status))return ERR_PTR (-ENODEV ); - chip =gpiochip_find (handle, acpi_gpiochip_find); -if (!chip) + gdev =gpio_device_find (handle, acpi_gpiochip_find); +if (!gdev)return ERR_PTR (-EPROBE_DEFER ); -return gpiochip_get_desc (chip, pin); +/* +* FIXME: keep track of the reference to the GPIO device somehow +* instead of putting it here. +*/ +return gpio_device_get_desc (gdev, pin); }/**
Signature · 1 line
2.39.2
Re: [PATCH v3 09/11] gpio: acpi: replace gpiochip_find() with gpio_device_find()
Quoted 7 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
We're porting all users of
gpiochip_find()to usinggpio_device_find(). Update the ACPI GPIO code.Signed-off-by Bartosz Golaszewski <[email protected]>Reviewed-by Linus Walleij <[email protected]>
PATCH v3 10/11 gpio: swnode: replace gpiochip_find() with gpio_device_find_by_label()
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
We're porting all users of gpiochip_find() to using gpio_device_find(). Update the swnode GPIO code.
--- drivers/gpio/gpiolib-swnode.c | 33 ++++++++++++++++----------------- 1 file changed, 16 insertions(+), 17 deletions(-)
drivers/gpio/gpiolib-swnode.c +16 -17
@@ -31,31 +31,26 @@ static void swnode_format_propname(const char *con_id, char *propname,strscpy (propname,"gpios" , max_size); } -static int swnode_gpiochip_match_name (struct gpio_chip *chip,void *data) +static struct gpio_device *swnode_get_gpio_device (struct fwnode_handle *fwnode) { -return !strcmp (chip->label, data); -} +const struct software_node *gdev_node; +struct gpio_device *gdev; -static struct gpio_chip *swnode_get_chip (struct fwnode_handle *fwnode) -{ -const struct software_node *chip_node; -struct gpio_chip *chip; - - chip_node =to_software_node (fwnode); -if (!chip_node || !chip_node->name) + gdev_node =to_software_node (fwnode); +if (!gdev_node || !gdev_node->name)return ERR_PTR (-EINVAL ); - chip =gpiochip_find ((void *)chip_node->name, swnode_gpiochip_match_name); -return chip ?:ERR_PTR (-EPROBE_DEFER ); + gdev =gpio_device_find_by_label ((void *)gdev_node->name); +return gdev ?:ERR_PTR (-EPROBE_DEFER ); }struct gpio_desc *swnode_find_gpio (struct fwnode_handle *fwnode,const char *con_id,unsigned int idx,unsigned long *flags) { + struct gpio_device *gdev __free(gpio_device_put) = NULL;const struct software_node *swnode;struct fwnode_reference_args args; -struct gpio_chip *chip;struct gpio_desc *desc;char propname[32 ];/* 32 is max size of property name */ int error;
@@ -77,12 +72,16 @@ struct gpio_desc *swnode_find_gpio(struct fwnode_handle *fwnode,return ERR_PTR (error); } - chip =swnode_get_chip (args.fwnode); + gdev =swnode_get_gpio_device (args.fwnode);fwnode_handle_put (args.fwnode); -if (IS_ERR (chip)) -return ERR_CAST (chip); +if (IS_ERR (gdev)) +return ERR_CAST (gdev); - desc =gpiochip_get_desc (chip, args.args[0 ]); +/* +* FIXME: The GPIO device reference is put at return but the descriptor +* is passed on. Find a proper solution. +*/ + desc =gpio_device_get_desc (gdev, args.args[0 ]); *flags = args.args[1 ];/* We expect native GPIO flags */ pr_debug("%s: parsed '%s' property of node '%pfwP[%d]' - status (%d)\n",
Signature · 1 line
2.39.2
Re: [PATCH v3 10/11] gpio: swnode: replace gpiochip_find() with gpio_device_find_by_label()
Quoted 4 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
We're porting all users of
gpiochip_find()to usinggpio_device_find(). Update the swnode GPIO code.
...
drivers/gpio/gpiolib-swnode.c static void swnode_format_propname(const char *con_id, char *propname, · line 43
Quoted 1 line
drivers/gpio/gpiolib-swnode.c +1
-0+ gdev =gpio_device_find_by_label ((void *)gdev_node->name);
Why do you need casting here?
Signature · 2 lines
With Best Regards, Andy Shevchenko
Re: [PATCH v3 10/11] gpio: swnode: replace gpiochip_find() with gpio_device_find_by_label()
Quoted 4 lines · Andy Shevchenko
Quoted 2 lines · Bartosz Golaszewski
From: Bartosz Golaszewski <[email protected]>
Quoted 9 lines
Quoted 2 lines
We're porting all users of
gpiochip_find()to usinggpio_device_find(). Update the swnode GPIO code....
Quoted 1 line
+ gdev =
gpio_device_find_by_label((void *)gdev_node->name);Why do you need casting here?
Most likely not, I'll check later.
Bart
Quoted 5 lines
--
With Best Regards,
Andy Shevchenko
PATCH v3 11/11 gpio: sysfs: drop the mention of gpiochip_find() from sysfs code
In reply to Bartosz GolaszewskiFrom: Bartosz Golaszewski <[email protected]>
We have removed all callers of gpiochip_find() so don't mention it in gpiolib-sysfs.c.
--- drivers/gpio/gpiolib-sysfs.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/gpio/gpiolib-sysfs.c +1 -1
@@ -814,7 +814,7 @@ static int __init gpiolib_sysfs_init(void)* gpiochip_sysfs_register() acquires a mutex. This is unsafe * and needs to be fixed. * -* Also it would be nice to use gpiochip_find() here so we +* Also it would be nice to use gpio_device_find() here so we * can keep gpio_chips local to gpiolib.c, but the yield of * gpio_lock prevents us from doing this. */
Signature · 1 line
2.39.2