gpio: Add devm_fwnode_gpiod_get_optional() helpers
Subsystems (3)
PATCH v3 1/2 gpio: Add devm_fwnode_gpiod_get_optional() helpers
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.
---
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(+)
drivers/gpio/gpiolib-devres.c +71 -0
@@ -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
include/linux/gpio/consumer.h +30 -0
@@ -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
Signature · 1 line
2.17.1
PATCH v3 2/2 Input: gpio_keys - Simplify with dev_err_probe()
Common pattern of handling deferred probe can be simplified withdev_err_probe() and devm_fwnode_gpiod_get_optional(). Less code and
the error value gets printed.
---
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(-)
drivers/input/keyboard/gpio_keys.c +8 -17
@@ -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
Signature · 1 line
2.17.1
Quoted 6 lines · Krzysztof Kozlowski
Add
devm_fwnode_gpiod_get_optional()anddevm_fwnode_gpiod_get_index_optional()helpers, similar to regulardevm_gpiodoptional versions. Drivers getting GPIOs from a firmware node might use it to remove some boilerplate code.
For both:
Quoted 166 lines
Signed-off-by Krzysztof Kozlowski <[email protected]>---
Changes since v2:
1. Return NULLChanges since v1:
1. New patch--- drivers/gpio/gpiolib-devres.c | 71 +++++++++++++++++++++++++++++++++++ include/linux/gpio/consumer.h | 30 +++++++++++++++ 2 files changed, 101 insertions(+)drivers/gpio/gpiolib-devres.c +71
-0@@ -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 include/linux/gpio/consumer.h +30
-1@@ -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
Signature · 2 lines
With Best Regards, Andy Shevchenko