* [PATCH v3 1/2] gpio: Add devm_fwnode_gpiod_get_optional() helpers
@ 2020-08-27 6:28 Krzysztof Kozlowski
2020-08-27 6:28 ` [PATCH v3 2/2] Input: gpio_keys - Simplify with dev_err_probe() Krzysztof Kozlowski
2020-08-27 8:17 ` [PATCH v3 1/2] gpio: Add devm_fwnode_gpiod_get_optional() helpers Andy Shevchenko
0 siblings, 2 replies; 3+ messages in thread
From: Krzysztof Kozlowski @ 2020-08-27 6:28 UTC (permalink / raw)
To: Linus Walleij, Bartosz Golaszewski, Dmitry Torokhov,
Nathan Chancellor, Nick Desaulniers, Gustavo A. R. Silva,
Krzysztof Kozlowski, Hans de Goede, linux-gpio, linux-kernel,
linux-input, clang-built-linux
Cc: Andy Shevchenko
Add devm_fwnode_gpiod_get_optional() and
devm_fwnode_gpiod_get_index_optional() helpers, similar to regular
devm_gpiod optional versions. Drivers getting GPIOs from a firmware
node might use it to remove some boilerplate code.
Signed-off-by: Krzysztof Kozlowski <krzk@kernel.org>
---
Changes since v2:
1. Return NULL
Changes since v1:
1. New patch
---
drivers/gpio/gpiolib-devres.c | 71 +++++++++++++++++++++++++++++++++++
include/linux/gpio/consumer.h | 30 +++++++++++++++
2 files changed, 101 insertions(+)
diff --git a/drivers/gpio/gpiolib-devres.c b/drivers/gpio/gpiolib-devres.c
index 7dbce4c4ebdf..f8476f6a65cc 100644
--- a/drivers/gpio/gpiolib-devres.c
+++ b/drivers/gpio/gpiolib-devres.c
@@ -184,6 +184,37 @@ struct gpio_desc *devm_gpiod_get_from_of_node(struct device *dev,
}
EXPORT_SYMBOL_GPL(devm_gpiod_get_from_of_node);
+/**
+ * devm_fwnode_gpiod_get_optional - Resource-managed fwnode_gpiod_get_index()
+ * for optional GPIO
+ * @dev: GPIO consumer
+ * @fwnode: firmware node containing GPIO reference
+ * @con_id: function within the GPIO consumer
+ * @flags: GPIO initialization flags
+ * @label: label to attach to the requested GPIO
+ *
+ * GPIO descriptors returned from this function are automatically disposed on
+ * driver detach.
+ *
+ * This is equivalent to devm_fwnode_gpiod_get_index(), except that when no
+ * GPIO with the specified index was assigned to the requested function it will
+ * return NULL. This is convenient for drivers that need to handle optional
+ * GPIOs.
+ *
+ * On successful request the GPIO pin is configured in accordance with
+ * provided @flags.
+ */
+struct gpio_desc *devm_fwnode_gpiod_get_optional(struct device *dev,
+ struct fwnode_handle *fwnode,
+ const char *con_id,
+ enum gpiod_flags flags,
+ const char *label)
+{
+ return devm_fwnode_gpiod_get_index_optional(dev, fwnode, con_id, 0,
+ flags, label);
+}
+EXPORT_SYMBOL_GPL(devm_fwnode_gpiod_get_optional);
+
/**
* devm_fwnode_gpiod_get_index - get a GPIO descriptor from a given node
* @dev: GPIO consumer
@@ -226,6 +257,46 @@ struct gpio_desc *devm_fwnode_gpiod_get_index(struct device *dev,
}
EXPORT_SYMBOL_GPL(devm_fwnode_gpiod_get_index);
+/**
+ * devm_fwnode_gpiod_get_index_optional - Resource-managed fwnode_gpiod_get_index()
+ * for optional GPIO
+ * @dev: GPIO consumer
+ * @fwnode: firmware node containing GPIO reference
+ * @con_id: function within the GPIO consumer
+ * @index: index of the GPIO to obtain in the consumer
+ * @flags: GPIO initialization flags
+ * @label: label to attach to the requested GPIO
+ *
+ * GPIO descriptors returned from this function are automatically disposed on
+ * driver detach.
+ *
+ * This is equivalent to devm_fwnode_gpiod_get_index(), except that when no
+ * GPIO with the specified index was assigned to the requested function it will
+ * return NULL. This is convenient for drivers that need to handle optional
+ * GPIOs.
+ *
+ * On successful request the GPIO pin is configured in accordance with
+ * provided @flags.
+ */
+struct gpio_desc *devm_fwnode_gpiod_get_index_optional(struct device *dev,
+ struct fwnode_handle *fwnode,
+ const char *con_id, int index,
+ enum gpiod_flags flags,
+ const char *label)
+{
+ struct gpio_desc *desc;
+
+ desc = devm_fwnode_gpiod_get_index(dev, fwnode, con_id, index, flags,
+ label);
+ if (IS_ERR(desc)) {
+ if (PTR_ERR(desc) == -ENOENT)
+ return NULL;
+ }
+
+ return desc;
+}
+EXPORT_SYMBOL_GPL(devm_fwnode_gpiod_get_index_optional);
+
/**
* devm_gpiod_get_index_optional - Resource-managed gpiod_get_index_optional()
* @dev: GPIO consumer
diff --git a/include/linux/gpio/consumer.h b/include/linux/gpio/consumer.h
index 901aab89d025..7854d80b1e9a 100644
--- a/include/linux/gpio/consumer.h
+++ b/include/linux/gpio/consumer.h
@@ -183,11 +183,21 @@ struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode,
const char *con_id, int index,
enum gpiod_flags flags,
const char *label);
+struct gpio_desc *devm_fwnode_gpiod_get_optional(struct device *dev,
+ struct fwnode_handle *fwnode,
+ const char *con_id,
+ enum gpiod_flags flags,
+ const char *label);
struct gpio_desc *devm_fwnode_gpiod_get_index(struct device *dev,
struct fwnode_handle *child,
const char *con_id, int index,
enum gpiod_flags flags,
const char *label);
+struct gpio_desc *devm_fwnode_gpiod_get_index_optional(struct device *dev,
+ struct fwnode_handle *fwnode,
+ const char *con_id, int index,
+ enum gpiod_flags flags,
+ const char *label);
#else /* CONFIG_GPIOLIB */
@@ -562,6 +572,16 @@ struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode,
return ERR_PTR(-ENOSYS);
}
+static inline
+struct gpio_desc *devm_fwnode_gpiod_get_optional(struct device *dev,
+ struct fwnode_handle *fwnode,
+ const char *con_id,
+ enum gpiod_flags flags,
+ const char *label)
+{
+ return NULL;
+}
+
static inline
struct gpio_desc *devm_fwnode_gpiod_get_index(struct device *dev,
struct fwnode_handle *fwnode,
@@ -572,6 +592,16 @@ struct gpio_desc *devm_fwnode_gpiod_get_index(struct device *dev,
return ERR_PTR(-ENOSYS);
}
+static inline
+struct gpio_desc *devm_fwnode_gpiod_get_index_optional(struct device *dev,
+ struct fwnode_handle *fwnode,
+ const char *con_id, int index,
+ enum gpiod_flags flags,
+ const char *label)
+{
+ return NULL;
+}
+
#endif /* CONFIG_GPIOLIB */
static inline
--
2.17.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* [PATCH v3 2/2] Input: gpio_keys - Simplify with dev_err_probe()
2020-08-27 6:28 [PATCH v3 1/2] gpio: Add devm_fwnode_gpiod_get_optional() helpers Krzysztof Kozlowski
@ 2020-08-27 6:28 ` Krzysztof Kozlowski
2020-08-27 8:17 ` [PATCH v3 1/2] gpio: Add devm_fwnode_gpiod_get_optional() helpers Andy Shevchenko
1 sibling, 0 replies; 3+ messages in thread
From: Krzysztof Kozlowski @ 2020-08-27 6:28 UTC (permalink / raw)
To: Linus Walleij, Bartosz Golaszewski, Dmitry Torokhov,
Nathan Chancellor, Nick Desaulniers, Gustavo A. R. Silva,
Krzysztof Kozlowski, Hans de Goede, linux-gpio, linux-kernel,
linux-input, clang-built-linux
Cc: Andy Shevchenko
Common pattern of handling deferred probe can be simplified with
dev_err_probe() and devm_fwnode_gpiod_get_optional(). Less code and
the error value gets printed.
Signed-off-by: Krzysztof Kozlowski <krzk@kernel.org>
Reviewed-by: Hans de Goede <hdegoede@redhat.com>
---
Changes since v2:
1. Preserve comment,
2. Include <device.h> to fix warning on clang (reported by kbuild),
3. Fix use of uninitialized "error" variable.
Changes since v1:
1. Use devm_fwnode_gpiod_get_optional
---
drivers/input/keyboard/gpio_keys.c | 25 ++++++++-----------------
1 file changed, 8 insertions(+), 17 deletions(-)
diff --git a/drivers/input/keyboard/gpio_keys.c b/drivers/input/keyboard/gpio_keys.c
index f2d4e4daa818..160d94b1c2c0 100644
--- a/drivers/input/keyboard/gpio_keys.c
+++ b/drivers/input/keyboard/gpio_keys.c
@@ -18,6 +18,7 @@
#include <linux/sysctl.h>
#include <linux/proc_fs.h>
#include <linux/delay.h>
+#include <linux/device.h>
#include <linux/platform_device.h>
#include <linux/input.h>
#include <linux/gpio_keys.h>
@@ -494,23 +495,13 @@ static int gpio_keys_setup_key(struct platform_device *pdev,
spin_lock_init(&bdata->lock);
if (child) {
- bdata->gpiod = devm_fwnode_gpiod_get(dev, child,
- NULL, GPIOD_IN, desc);
- if (IS_ERR(bdata->gpiod)) {
- error = PTR_ERR(bdata->gpiod);
- if (error == -ENOENT) {
- /*
- * GPIO is optional, we may be dealing with
- * purely interrupt-driven setup.
- */
- bdata->gpiod = NULL;
- } else {
- if (error != -EPROBE_DEFER)
- dev_err(dev, "failed to get gpio: %d\n",
- error);
- return error;
- }
- }
+ /*
+ * GPIO is optional, we may be dealing with purely
+ * interrupt-driven setup.
+ */
+ bdata->gpiod = devm_fwnode_gpiod_get_optional(dev, child, NULL, GPIOD_IN, desc);
+ if (IS_ERR(bdata->gpiod))
+ return dev_err_probe(dev, PTR_ERR(bdata->gpiod), "failed to get gpio\n");
} else if (gpio_is_valid(button->gpio)) {
/*
* Legacy GPIO number, so request the GPIO here and
--
2.17.1
^ permalink raw reply related [flat|nested] 3+ messages in thread
* Re: [PATCH v3 1/2] gpio: Add devm_fwnode_gpiod_get_optional() helpers
2020-08-27 6:28 [PATCH v3 1/2] gpio: Add devm_fwnode_gpiod_get_optional() helpers Krzysztof Kozlowski
2020-08-27 6:28 ` [PATCH v3 2/2] Input: gpio_keys - Simplify with dev_err_probe() Krzysztof Kozlowski
@ 2020-08-27 8:17 ` Andy Shevchenko
1 sibling, 0 replies; 3+ messages in thread
From: Andy Shevchenko @ 2020-08-27 8:17 UTC (permalink / raw)
To: Krzysztof Kozlowski
Cc: Linus Walleij, Bartosz Golaszewski, Dmitry Torokhov,
Nathan Chancellor, Nick Desaulniers, Gustavo A. R. Silva,
Hans de Goede, open list:GPIO SUBSYSTEM,
Linux Kernel Mailing List, linux-input, clang-built-linux
On Thu, Aug 27, 2020 at 9:28 AM Krzysztof Kozlowski <krzk@kernel.org> wrote:
>
> Add devm_fwnode_gpiod_get_optional() and
> devm_fwnode_gpiod_get_index_optional() helpers, similar to regular
> devm_gpiod optional versions. Drivers getting GPIOs from a firmware
> node might use it to remove some boilerplate code.
>
For both:
Reviewed-by: Andy Shevchenko <andy.shevchenko@gmail.com>
> Signed-off-by: Krzysztof Kozlowski <krzk@kernel.org>
>
> ---
>
> Changes since v2:
> 1. Return NULL
>
> Changes since v1:
> 1. New patch
> ---
> drivers/gpio/gpiolib-devres.c | 71 +++++++++++++++++++++++++++++++++++
> include/linux/gpio/consumer.h | 30 +++++++++++++++
> 2 files changed, 101 insertions(+)
>
> diff --git a/drivers/gpio/gpiolib-devres.c b/drivers/gpio/gpiolib-devres.c
> index 7dbce4c4ebdf..f8476f6a65cc 100644
> --- a/drivers/gpio/gpiolib-devres.c
> +++ b/drivers/gpio/gpiolib-devres.c
> @@ -184,6 +184,37 @@ struct gpio_desc *devm_gpiod_get_from_of_node(struct device *dev,
> }
> EXPORT_SYMBOL_GPL(devm_gpiod_get_from_of_node);
>
> +/**
> + * devm_fwnode_gpiod_get_optional - Resource-managed fwnode_gpiod_get_index()
> + * for optional GPIO
> + * @dev: GPIO consumer
> + * @fwnode: firmware node containing GPIO reference
> + * @con_id: function within the GPIO consumer
> + * @flags: GPIO initialization flags
> + * @label: label to attach to the requested GPIO
> + *
> + * GPIO descriptors returned from this function are automatically disposed on
> + * driver detach.
> + *
> + * This is equivalent to devm_fwnode_gpiod_get_index(), except that when no
> + * GPIO with the specified index was assigned to the requested function it will
> + * return NULL. This is convenient for drivers that need to handle optional
> + * GPIOs.
> + *
> + * On successful request the GPIO pin is configured in accordance with
> + * provided @flags.
> + */
> +struct gpio_desc *devm_fwnode_gpiod_get_optional(struct device *dev,
> + struct fwnode_handle *fwnode,
> + const char *con_id,
> + enum gpiod_flags flags,
> + const char *label)
> +{
> + return devm_fwnode_gpiod_get_index_optional(dev, fwnode, con_id, 0,
> + flags, label);
> +}
> +EXPORT_SYMBOL_GPL(devm_fwnode_gpiod_get_optional);
> +
> /**
> * devm_fwnode_gpiod_get_index - get a GPIO descriptor from a given node
> * @dev: GPIO consumer
> @@ -226,6 +257,46 @@ struct gpio_desc *devm_fwnode_gpiod_get_index(struct device *dev,
> }
> EXPORT_SYMBOL_GPL(devm_fwnode_gpiod_get_index);
>
> +/**
> + * devm_fwnode_gpiod_get_index_optional - Resource-managed fwnode_gpiod_get_index()
> + * for optional GPIO
> + * @dev: GPIO consumer
> + * @fwnode: firmware node containing GPIO reference
> + * @con_id: function within the GPIO consumer
> + * @index: index of the GPIO to obtain in the consumer
> + * @flags: GPIO initialization flags
> + * @label: label to attach to the requested GPIO
> + *
> + * GPIO descriptors returned from this function are automatically disposed on
> + * driver detach.
> + *
> + * This is equivalent to devm_fwnode_gpiod_get_index(), except that when no
> + * GPIO with the specified index was assigned to the requested function it will
> + * return NULL. This is convenient for drivers that need to handle optional
> + * GPIOs.
> + *
> + * On successful request the GPIO pin is configured in accordance with
> + * provided @flags.
> + */
> +struct gpio_desc *devm_fwnode_gpiod_get_index_optional(struct device *dev,
> + struct fwnode_handle *fwnode,
> + const char *con_id, int index,
> + enum gpiod_flags flags,
> + const char *label)
> +{
> + struct gpio_desc *desc;
> +
> + desc = devm_fwnode_gpiod_get_index(dev, fwnode, con_id, index, flags,
> + label);
> + if (IS_ERR(desc)) {
> + if (PTR_ERR(desc) == -ENOENT)
> + return NULL;
> + }
> +
> + return desc;
> +}
> +EXPORT_SYMBOL_GPL(devm_fwnode_gpiod_get_index_optional);
> +
> /**
> * devm_gpiod_get_index_optional - Resource-managed gpiod_get_index_optional()
> * @dev: GPIO consumer
> diff --git a/include/linux/gpio/consumer.h b/include/linux/gpio/consumer.h
> index 901aab89d025..7854d80b1e9a 100644
> --- a/include/linux/gpio/consumer.h
> +++ b/include/linux/gpio/consumer.h
> @@ -183,11 +183,21 @@ struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode,
> const char *con_id, int index,
> enum gpiod_flags flags,
> const char *label);
> +struct gpio_desc *devm_fwnode_gpiod_get_optional(struct device *dev,
> + struct fwnode_handle *fwnode,
> + const char *con_id,
> + enum gpiod_flags flags,
> + const char *label);
> struct gpio_desc *devm_fwnode_gpiod_get_index(struct device *dev,
> struct fwnode_handle *child,
> const char *con_id, int index,
> enum gpiod_flags flags,
> const char *label);
> +struct gpio_desc *devm_fwnode_gpiod_get_index_optional(struct device *dev,
> + struct fwnode_handle *fwnode,
> + const char *con_id, int index,
> + enum gpiod_flags flags,
> + const char *label);
>
> #else /* CONFIG_GPIOLIB */
>
> @@ -562,6 +572,16 @@ struct gpio_desc *fwnode_gpiod_get_index(struct fwnode_handle *fwnode,
> return ERR_PTR(-ENOSYS);
> }
>
> +static inline
> +struct gpio_desc *devm_fwnode_gpiod_get_optional(struct device *dev,
> + struct fwnode_handle *fwnode,
> + const char *con_id,
> + enum gpiod_flags flags,
> + const char *label)
> +{
> + return NULL;
> +}
> +
> static inline
> struct gpio_desc *devm_fwnode_gpiod_get_index(struct device *dev,
> struct fwnode_handle *fwnode,
> @@ -572,6 +592,16 @@ struct gpio_desc *devm_fwnode_gpiod_get_index(struct device *dev,
> return ERR_PTR(-ENOSYS);
> }
>
> +static inline
> +struct gpio_desc *devm_fwnode_gpiod_get_index_optional(struct device *dev,
> + struct fwnode_handle *fwnode,
> + const char *con_id, int index,
> + enum gpiod_flags flags,
> + const char *label)
> +{
> + return NULL;
> +}
> +
> #endif /* CONFIG_GPIOLIB */
>
> static inline
> --
> 2.17.1
>
--
With Best Regards,
Andy Shevchenko
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2020-08-27 8:17 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-08-27 6:28 [PATCH v3 1/2] gpio: Add devm_fwnode_gpiod_get_optional() helpers Krzysztof Kozlowski
2020-08-27 6:28 ` [PATCH v3 2/2] Input: gpio_keys - Simplify with dev_err_probe() Krzysztof Kozlowski
2020-08-27 8:17 ` [PATCH v3 1/2] gpio: Add devm_fwnode_gpiod_get_optional() helpers Andy Shevchenko
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).