New descriptor-based GPIO interface
Subsystems (3)
v3 cover New descriptor-based GPIO interface
Hi Linus,
This version should merge as-is in your tree (I hope!). A patch for documentation will follow soon.
Changes since v2:
- rebased on top of Linus' for-next branch
- exported new gpiod_(un)lock_as_irq() functions in driver.h
- squashed a fix for a compilation error
Alexandre Courbot (3):
gpiolib: export descriptor-based GPIO interface
gpiolib: port of_ functions to use gpiod
gpiolib: add gpiod_get() and gpiod_put() functions
drivers/gpio/devres.c | 83 ++++++ drivers/gpio/gpiolib-of.c | 28 +- drivers/gpio/gpiolib.c | 623 +++++++++++++++++++++++++++++------------- include/asm-generic/gpio.h | 222 +++++---------- include/linux/gpio.h | 11 +- include/linux/gpio/consumer.h | 253 +++++++++++++++++ include/linux/gpio/driver.h | 183 +++++++++++++ include/linux/of_gpio.h | 29 +- 8 files changed, 1055 insertions(+), 377 deletions(-) create mode 100644 include/linux/gpio/consumer.h create mode 100644 include/linux/gpio/driver.h
Signature · 6 lines
1.8.4 -- To unsubscribe from this list: send the line "unsubscribe devicetree" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
PATCH v3 1/3 gpiolib: export descriptor-based GPIO interface
This patch exports the gpiod_* family of API functions, a safer alternative to the legacy GPIO interface. Differences between the gpiod and legacy gpio APIs are:
- gpio works with integers, whereas gpiod operates on opaque handlers which cannot be forged or used before proper acquisition
- gpiod get/set functions are aware of the active low state of a GPIO
- gpio consumers should now include <linux/gpio/consumer.h> to access the new interface, whereas chips drivers will use <linux/gpio/driver.h>
The legacy gpio API is now built as inline functions on top of gpiod.
--- drivers/gpio/gpiolib.c | 422 ++++++++++++++++++++++-------------------- include/asm-generic/gpio.h | 222 +++++++--------------- include/linux/gpio.h | 11 +- include/linux/gpio/consumer.h | 238 ++++++++++++++++++++++++ include/linux/gpio/driver.h | 127 +++++++++++++ 5 files changed, 658 insertions(+), 362 deletions(-) create mode 100644 include/linux/gpio/consumer.h create mode 100644 include/linux/gpio/driver.h
drivers/gpio/gpiolib.c +224 -198
@@ -16,16 +16,11 @@#define CREATE_TRACE_POINTS #include <trace/events/gpio.h> -/* Optional implementation infrastructure for GPIO interfaces. +/* Implementation infrastructure for GPIO interfaces. * -* Platforms may want to use this if they tend to use very many GPIOs -* that aren't part of a System-On-Chip core; or across I2C/SPI/etc. -* -* When kernel footprint or instruction count is an issue, simpler -* implementations may be preferred. The GPIO programming interface -* allows for inlining speed-critical get/set operations for common -* cases, so that access to SOC-integrated GPIOs can sometimes cost -* only an instruction or two per bit. +* The GPIO programming interface allows for inlining speed-critical +* get/set operations for common cases, so that access to SOC-integrated +* GPIOs can sometimes cost only an instruction or two per bit. */
@@ -57,7 +52,7 @@ struct gpio_desc {#define FLAG_SYSFS 3/* exported via /sys/class/gpio/control */ #define FLAG_TRIG_FALL 4/* trigger on falling edge */ #define FLAG_TRIG_RISE 5/* trigger on rising edge */ -#define FLAG_ACTIVE_LOW 6/* sysfs value has active low */ +#define FLAG_ACTIVE_LOW 6/* value has active low */ #define FLAG_OPEN_DRAIN 7/* Gpio is open drain type */ #define FLAG_OPEN_SOURCE 8/* Gpio is open source type */ #define FLAG_USED_AS_IRQ 9/* GPIO is connected to an IRQ */
@@ -81,29 +76,8 @@ static LIST_HEAD(gpio_chips);static DEFINE_IDR (dirent_idr);#endif -/* -* Internal gpiod_* API using descriptors instead of the integer namespace. -* Most of this should eventually go public. -*/ static int gpiod_request (struct gpio_desc *desc,const char *label);static void gpiod_free (struct gpio_desc *desc); -static int gpiod_direction_input (struct gpio_desc *desc); -static int gpiod_direction_output (struct gpio_desc *desc,int value); -static int gpiod_get_direction (const struct gpio_desc *desc); -static int gpiod_set_debounce (struct gpio_desc *desc,unsigned debounce); -static int gpiod_get_value_cansleep (const struct gpio_desc *desc); -static void gpiod_set_value_cansleep (struct gpio_desc *desc,int value); -static int gpiod_get_value (const struct gpio_desc *desc); -static void gpiod_set_value (struct gpio_desc *desc,int value); -static int gpiod_cansleep (const struct gpio_desc *desc); -static int gpiod_to_irq (const struct gpio_desc *desc); -static int gpiod_lock_as_irq (struct gpio_desc *desc); -static void gpiod_unlock_as_irq (struct gpio_desc *desc); -static int gpiod_export (struct gpio_desc *desc,bool direction_may_change); -static int gpiod_export_link (struct device *dev,const char *name, -struct gpio_desc *desc); -static int gpiod_sysfs_set_active_low (struct gpio_desc *desc,int value); -static void gpiod_unexport (struct gpio_desc *desc);#ifdef CONFIG_DEBUG_FS #define gpiod_emerg (desc, fmt, ...) \
@@ -157,13 +131,14 @@ static int gpio_chip_hwgpio(const struct gpio_desc *desc)/** * Convert a GPIO number to its descriptor */ -static struct gpio_desc *gpio_to_desc (unsigned gpio) +struct gpio_desc *gpio_to_desc (unsigned gpio) {if (WARN (!gpio_is_valid (gpio),"invalid GPIO %d\n" , gpio))return NULL ;else return &gpio_desc[gpio]; } +EXPORT_SYMBOL_GPL (gpio_to_desc);/** * Convert an offset on a certain chip to a corresponding descriptor
@@ -181,10 +156,11 @@ static struct gpio_desc *gpiochip_offset_to_desc(struct gpio_chip *chip,* This should disappear in the future but is needed since we still * use GPIO numbers for error messages and sysfs nodes */ -static int desc_to_gpio (const struct gpio_desc *desc) +int desc_to_gpio (const struct gpio_desc *desc) {return desc - &gpio_desc[0 ]; } +EXPORT_SYMBOL_GPL (desc_to_gpio);/* Warn when drivers omit gpio_request() calls -- legal but ill-advised
@@ -219,16 +195,15 @@ static int gpio_ensure_requested(struct gpio_desc *desc)return 0 ; } -static struct gpio_chip *gpiod_to_chip (const struct gpio_desc *desc) +/** +* gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs +* @desc: descriptor to return the chip of +*/ +struct gpio_chip *gpiod_to_chip (const struct gpio_desc *desc) {return desc ? desc->chip :NULL ; } - -/* caller holds gpio_lock *OR* gpio is marked as requested */ -struct gpio_chip *gpio_to_chip (unsigned gpio) -{ -return gpiod_to_chip (gpio_to_desc (gpio)); -} +EXPORT_SYMBOL_GPL (gpiod_to_chip);/* dynamic allocation of GPIOs, e.g. on a hotplugged device */ static int gpiochip_find_base (int ngpio)
@@ -254,8 +229,15 @@ static int gpiochip_find_base(int ngpio) } } -/* caller ensures gpio is valid and requested, chip->get_direction may sleep */ -static int gpiod_get_direction (const struct gpio_desc *desc) +/** +* gpiod_get_direction - return the current direction of a GPIO +* @desc: GPIO to get the direction of +* +* Return GPIOF_DIR_IN or GPIOF_DIR_OUT, or an error code in case of error. +* +* This function may sleep if gpiod_cansleep() is true. +*/ +int gpiod_get_direction (const struct gpio_desc *desc) {struct gpio_chip *chip;unsigned offset;
@@ -281,6 +263,7 @@ static int gpiod_get_direction(const struct gpio_desc *desc) }return status; } +EXPORT_SYMBOL_GPL (gpiod_get_direction);#ifdef CONFIG_GPIO_SYSFS
@@ -365,17 +348,10 @@ static ssize_t gpio_value_show(struct device *dev,mutex_lock (&sysfs_lock); -if (!test_bit (FLAG_EXPORT , &desc->flags)) { +if (!test_bit (FLAG_EXPORT , &desc->flags)) status = -EIO ; - }else { -int value; - - value = !!gpiod_get_value_cansleep (desc); -if (test_bit (FLAG_ACTIVE_LOW , &desc->flags)) - value = !value; - - status =sprintf (buf,"%d\n" , value); - } +else + status =sprintf (buf,"%d\n" ,gpiod_get_value_cansleep (desc));mutex_unlock (&sysfs_lock);return status;
@@ -398,9 +374,7 @@ static ssize_t gpio_value_store(struct device *dev, status =kstrtol (buf,0 , &value);if (status ==0 ) { -if (test_bit (FLAG_ACTIVE_LOW , &desc->flags)) - value = !value; -gpiod_set_value_cansleep (desc, value !=0 ); +gpiod_set_value_cansleep (desc, value); status = size; } }
@@ -790,7 +764,7 @@ static struct class gpio_class = {/** -* gpio_export - export a GPIO through sysfs +* gpiod_export - export a GPIO through sysfs * @gpio: gpio to make available, already requested * @direction_may_change: true if userspace may change gpio direction * Context: arch_initcall or later
@@ -804,7 +778,7 @@ static struct class gpio_class = {* * Returns zero on success, else an error. */ -static int gpiod_export (struct gpio_desc *desc,bool direction_may_change) +int gpiod_export (struct gpio_desc *desc,bool direction_may_change) {unsigned long flags;int status;
@@ -882,12 +856,7 @@ fail_unlock: status);return status; } - -int gpio_export (unsigned gpio,bool direction_may_change) -{ -return gpiod_export (gpio_to_desc (gpio), direction_may_change); -} -EXPORT_SYMBOL_GPL (gpio_export); +EXPORT_SYMBOL_GPL (gpiod_export);static int match_export (struct device *dev,const void *data) {
@@ -895,7 +864,7 @@ static int match_export(struct device *dev, const void *data) }/** -* gpio_export_link - create a sysfs link to an exported GPIO node +* gpiod_export_link - create a sysfs link to an exported GPIO node * @dev: device under which to create symlink * @name: name of the symlink * @gpio: gpio to create symlink to, already exported
@@ -905,8 +874,8 @@ static int match_export(struct device *dev, const void *data)* * Returns zero on success, else an error. */ -static int gpiod_export_link (struct device *dev,const char *name, -struct gpio_desc *desc) +int gpiod_export_link (struct device *dev,const char *name, +struct gpio_desc *desc) {int status = -EINVAL ;
@@ -937,15 +906,10 @@ static int gpiod_export_link(struct device *dev, const char *name,return status; } - -int gpio_export_link (struct device *dev,const char *name,unsigned gpio) -{ -return gpiod_export_link (dev, name,gpio_to_desc (gpio)); -} -EXPORT_SYMBOL_GPL (gpio_export_link); +EXPORT_SYMBOL_GPL (gpiod_export_link);/** -* gpio_sysfs_set_active_low - set the polarity of gpio sysfs value +* gpiod_sysfs_set_active_low - set the polarity of gpio sysfs value * @gpio: gpio to change * @value: non-zero to use active low, i.e. inverted values *
@@ -956,7 +920,7 @@ EXPORT_SYMBOL_GPL(gpio_export_link);* * Returns zero on success, else an error. */ -static int gpiod_sysfs_set_active_low (struct gpio_desc *desc,int value) +int gpiod_sysfs_set_active_low (struct gpio_desc *desc,int value) {struct device *dev =NULL ;int status = -EINVAL ;
@@ -987,20 +951,15 @@ unlock:return status; } - -int gpio_sysfs_set_active_low (unsigned gpio,int value) -{ -return gpiod_sysfs_set_active_low (gpio_to_desc (gpio), value); -} -EXPORT_SYMBOL_GPL (gpio_sysfs_set_active_low); +EXPORT_SYMBOL_GPL (gpiod_sysfs_set_active_low);/** -* gpio_unexport - reverse effect of gpio_export() +* gpiod_unexport - reverse effect of gpio_export() * @gpio: gpio to make unavailable * * This is implicit on gpio_free(). */ -static void gpiod_unexport (struct gpio_desc *desc) +void gpiod_unexport (struct gpio_desc *desc) {int status =0 ;struct device *dev =NULL ;
@@ -1033,12 +992,7 @@ static void gpiod_unexport(struct gpio_desc *desc)pr_debug ("%s: gpio%d status %d\n" , __func__,desc_to_gpio (desc), status); } - -void gpio_unexport (unsigned gpio) -{ -gpiod_unexport (gpio_to_desc (gpio)); -} -EXPORT_SYMBOL_GPL (gpio_unexport); +EXPORT_SYMBOL_GPL (gpiod_unexport);static int gpiochip_export (struct gpio_chip *chip) {
@@ -1145,27 +1099,6 @@ static inline void gpiochip_unexport(struct gpio_chip *chip) { } -static inline int gpiod_export (struct gpio_desc *desc, -bool direction_may_change) -{ -return -ENOSYS ; -} - -static inline int gpiod_export_link (struct device *dev,const char *name, -struct gpio_desc *desc) -{ -return -ENOSYS ; -} - -static inline int gpiod_sysfs_set_active_low (struct gpio_desc *desc,int value) -{ -return -ENOSYS ; -} - -static inline void gpiod_unexport (struct gpio_desc *desc) -{ -} -#endif /* CONFIG_GPIO_SYSFS */ /*
@@ -1677,7 +1610,16 @@ EXPORT_SYMBOL_GPL(gpiochip_is_requested);* rely on gpio_request() having been called beforehand. */ -static int gpiod_direction_input (struct gpio_desc *desc) +/** +* gpiod_direction_input - set the GPIO direction to input +* @desc: GPIO to set to input +* +* Set the direction of the passed GPIO to input, such as gpiod_get_value() can +* be called safely on it. +* +* Return 0 in case of success, else an error code. +*/ +int gpiod_direction_input (struct gpio_desc *desc) {unsigned long flags;struct gpio_chip *chip;
@@ -1734,14 +1676,19 @@ fail:gpiod_dbg (desc,"%s status %d\n" , __func__, status);return status; } +EXPORT_SYMBOL_GPL (gpiod_direction_input); -int gpio_direction_input (unsigned gpio) -{ -return gpiod_direction_input (gpio_to_desc (gpio)); -} -EXPORT_SYMBOL_GPL (gpio_direction_input); - -static int gpiod_direction_output (struct gpio_desc *desc,int value) +/** +* gpiod_direction_output - set the GPIO direction to input +* @desc: GPIO to set to output +* @value: initial output value of the GPIO +* +* Set the direction of the passed GPIO to output, such as gpiod_set_value() can +* be called safely on it. The initial value of the output must be specified. +* +* Return 0 in case of success, else an error code. +*/ +int gpiod_direction_output (struct gpio_desc *desc,int value) {unsigned long flags;struct gpio_chip *chip;
@@ -1814,22 +1761,17 @@ fail:gpiod_dbg (desc,"%s: gpio status %d\n" , __func__, status);return status; } - -int gpio_direction_output (unsigned gpio,int value) -{ -return gpiod_direction_output (gpio_to_desc (gpio), value); -} -EXPORT_SYMBOL_GPL (gpio_direction_output); +EXPORT_SYMBOL_GPL (gpiod_direction_output);/** -* gpio_set_debounce - sets @debounce time for a @gpio +* gpiod_set_debounce - sets @debounce time for a @gpio * @gpio: the gpio to set debounce time * @debounce: debounce time is microseconds * * returns -ENOTSUPP if the controller does not support setting * debounce. */ -static int gpiod_set_debounce (struct gpio_desc *desc,unsigned debounce) +int gpiod_set_debounce (struct gpio_desc *desc,unsigned debounce) {unsigned long flags;struct gpio_chip *chip;
@@ -1871,12 +1813,19 @@ fail:return status; } +EXPORT_SYMBOL_GPL (gpiod_set_debounce); -int gpio_set_debounce (unsigned gpio,unsigned debounce) +/** +* gpiod_is_active_low - test whether a GPIO is active-low or not +* @desc: the gpio descriptor to test +* +* Returns 1 if the GPIO is active-low, 0 otherwise. +*/ +int gpiod_is_active_low (const struct gpio_desc *desc) { -return gpiod_set_debounce (gpio_to_desc (gpio), debounce); +return test_bit (FLAG_ACTIVE_LOW , &desc->flags); } -EXPORT_SYMBOL_GPL (gpio_set_debounce); +EXPORT_SYMBOL_GPL (gpiod_is_active_low);/* I/O calls are only valid after configuration completed; the relevant * "is this a valid GPIO" error checks should already have been done.
@@ -1900,7 +1849,7 @@ EXPORT_SYMBOL_GPL(gpio_set_debounce);* that the GPIO was actually requested. */ -static int _gpiod_get_value (const struct gpio_desc *desc) +static int _gpiod_get_raw_value (const struct gpio_desc *desc) {struct gpio_chip *chip;int value;
@@ -1914,33 +1863,54 @@ static int _gpiod_get_value(const struct gpio_desc *desc) }/** -* __gpio_get_value() - return a gpio's value -* @gpio: gpio whose value will be returned -* Context: any +* gpiod_get_raw_value() - return a gpio's raw value +* @desc: gpio whose value will be returned * -* This is used directly or indirectly to implement gpio_get_value(). -* It returns the zero or nonzero value provided by the associated -* gpio_chip.get() method; or zero if no such method is provided. +* Return the GPIO's raw value, i.e. the value of the physical line disregarding +* its ACTIVE_LOW status. +* +* This function should be called from contexts where we cannot sleep, and will +* complain if the GPIO chip functions potentially sleep. */ -static int gpiod_get_value (const struct gpio_desc *desc) +int gpiod_get_raw_value (const struct gpio_desc *desc) {if (!desc)return 0 ;/* Should be using gpio_get_value_cansleep() */ WARN_ON (desc->chip->can_sleep); -return _gpiod_get_value (desc); +return _gpiod_get_raw_value (desc); } +EXPORT_SYMBOL_GPL (gpiod_get_raw_value); -int __gpio_get_value (unsigned gpio) +/** +* gpiod_get_value() - return a gpio's value +* @desc: gpio whose value will be returned +* +* Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into +* account. +* +* This function should be called from contexts where we cannot sleep, and will +* complain if the GPIO chip functions potentially sleep. +*/ +int gpiod_get_value (const struct gpio_desc *desc) { -return gpiod_get_value (gpio_to_desc (gpio)); +int value; +if (!desc) +return 0 ; +/* Should be using gpio_get_value_cansleep() */ +WARN_ON (desc->chip->can_sleep); + + value =_gpiod_get_raw_value (desc); +if (test_bit (FLAG_ACTIVE_LOW , &desc->flags)) + value = !value; + +return value; } -EXPORT_SYMBOL_GPL (__gpio_get_value); +EXPORT_SYMBOL_GPL (gpiod_get_value);/* * _gpio_set_open_drain_value() - Set the open drain gpio's value. -* @gpio: Gpio whose state need to be set. -* @chip: Gpio chip. +* @desc: gpio descriptor whose state need to be set. * @value: Non-zero for setting it HIGH otherise it will set to LOW. */ static void _gpio_set_open_drain_value (struct gpio_desc *desc,int value)
@@ -1966,9 +1936,8 @@ static void _gpio_set_open_drain_value(struct gpio_desc *desc, int value) }/* -* _gpio_set_open_source() - Set the open source gpio's value. -* @gpio: Gpio whose state need to be set. -* @chip: Gpio chip. +* _gpio_set_open_source_value() - Set the open source gpio's value. +* @desc: gpio descriptor whose state need to be set. * @value: Non-zero for setting it HIGH otherise it will set to LOW. */ static void _gpio_set_open_source_value (struct gpio_desc *desc,int value)
@@ -1993,7 +1962,7 @@ static void _gpio_set_open_source_value(struct gpio_desc *desc, int value) __func__, err); } -static void _gpiod_set_value (struct gpio_desc *desc,int value) +static void _gpiod_set_raw_value (struct gpio_desc *desc,int value) {struct gpio_chip *chip;
@@ -2008,62 +1977,70 @@ static void _gpiod_set_value(struct gpio_desc *desc, int value) }/** -* __gpio_set_value() - assign a gpio's value -* @gpio: gpio whose value will be assigned +* gpiod_set_raw_value() - assign a gpio's raw value +* @desc: gpio whose value will be assigned * @value: value to assign -* Context: any * -* This is used directly or indirectly to implement gpio_set_value(). -* It invokes the associated gpio_chip.set() method. +* Set the raw value of the GPIO, i.e. the value of its physical line without +* regard for its ACTIVE_LOW status. +* +* This function should be called from contexts where we cannot sleep, and will +* complain if the GPIO chip functions potentially sleep. */ -static void gpiod_set_value (struct gpio_desc *desc,int value) +void gpiod_set_raw_value (struct gpio_desc *desc,int value) { -if (!desc)return ;/* Should be using gpio_set_value_cansleep() */ WARN_ON (desc->chip->can_sleep); -_gpiod_set_value (desc, value); +_gpiod_set_raw_value (desc, value); } +EXPORT_SYMBOL_GPL (gpiod_set_raw_value); -void __gpio_set_value (unsigned gpio,int value) +/** +* gpiod_set_value() - assign a gpio's value +* @desc: gpio whose value will be assigned +* @value: value to assign +* +* Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into +* account +* +* This function should be called from contexts where we cannot sleep, and will +* complain if the GPIO chip functions potentially sleep. +*/ +void gpiod_set_value (struct gpio_desc *desc,int value) { -return gpiod_set_value (gpio_to_desc (gpio), value); +if (!desc) +return ; +/* Should be using gpio_set_value_cansleep() */ +WARN_ON (desc->chip->can_sleep); +if (test_bit (FLAG_ACTIVE_LOW , &desc->flags)) + value = !value; +_gpiod_set_raw_value (desc, value); } -EXPORT_SYMBOL_GPL (__gpio_set_value); +EXPORT_SYMBOL_GPL (gpiod_set_value);/** -* __gpio_cansleep() - report whether gpio value access will sleep -* @gpio: gpio in question -* Context: any +* gpiod_cansleep() - report whether gpio value access may sleep +* @desc: gpio to check * -* This is used directly or indirectly to implement gpio_cansleep(). It -* returns nonzero if access reading or writing the GPIO value can sleep. */ -static int gpiod_cansleep (const struct gpio_desc *desc) +int gpiod_cansleep (const struct gpio_desc *desc) {if (!desc)return 0 ; -/* only call this on GPIOs that are valid! */ return desc->chip->can_sleep; } - -int __gpio_cansleep (unsigned gpio) -{ -return gpiod_cansleep (gpio_to_desc (gpio)); -} -EXPORT_SYMBOL_GPL (__gpio_cansleep); +EXPORT_SYMBOL_GPL (gpiod_cansleep);/** -* __gpio_to_irq() - return the IRQ corresponding to a GPIO -* @gpio: gpio whose IRQ will be returned (already requested) -* Context: any +* gpiod_to_irq() - return the IRQ corresponding to a GPIO +* @desc: gpio whose IRQ will be returned (already requested) * -* This is used directly or indirectly to implement gpio_to_irq(). -* It returns the number of the IRQ signaled by this (input) GPIO, -* or a negative errno. +* Return the IRQ corresponding to the passed GPIO, or an error code in case of +* error. */ -static int gpiod_to_irq (const struct gpio_desc *desc) +int gpiod_to_irq (const struct gpio_desc *desc) {struct gpio_chip *chip;int offset;
@@ -2074,12 +2051,7 @@ static int gpiod_to_irq(const struct gpio_desc *desc) offset =gpio_chip_hwgpio (desc);return chip->to_irq ? chip->to_irq (chip, offset) : -ENXIO ; } - -int __gpio_to_irq (unsigned gpio) -{ -return gpiod_to_irq (gpio_to_desc (gpio)); -} -EXPORT_SYMBOL_GPL (__gpio_to_irq); +EXPORT_SYMBOL_GPL (gpiod_to_irq);/** * gpiod_lock_as_irq() - lock a GPIO to be used as IRQ
@@ -2091,7 +2063,7 @@ EXPORT_SYMBOL_GPL(__gpio_to_irq);* of its irq_chip implementation if the GPIO is known from that * code. */ -static int gpiod_lock_as_irq (struct gpio_desc *desc) +int gpiod_lock_as_irq (struct gpio_desc *desc) {if (!desc)return -EINVAL ;
@@ -2106,6 +2078,7 @@ static int gpiod_lock_as_irq(struct gpio_desc *desc)set_bit (FLAG_USED_AS_IRQ , &desc->flags);return 0 ; } +EXPORT_SYMBOL_GPL (gpiod_lock_as_irq);int gpio_lock_as_irq (struct gpio_chip *chip,unsigned int offset) {
@@ -2120,13 +2093,14 @@ EXPORT_SYMBOL_GPL(gpio_lock_as_irq);* This is used directly by GPIO drivers that want to indicate * that a certain GPIO is no longer used exclusively for IRQ. */ -static void gpiod_unlock_as_irq (struct gpio_desc *desc) +void gpiod_unlock_as_irq (struct gpio_desc *desc) {if (!desc)return ;clear_bit (FLAG_USED_AS_IRQ , &desc->flags); } +EXPORT_SYMBOL_GPL (gpiod_unlock_as_irq);void gpio_unlock_as_irq (struct gpio_chip *chip,unsigned int offset) {
@@ -2134,37 +2108,89 @@ void gpio_unlock_as_irq(struct gpio_chip *chip, unsigned int offset) }EXPORT_SYMBOL_GPL (gpio_unlock_as_irq); -/* There's no value in making it easy to inline GPIO calls that may sleep. -* Common examples include ones connected to I2C or SPI chips. +/** +* gpiod_get_raw_value_cansleep() - return a gpio's raw value +* @desc: gpio whose value will be returned +* +* Return the GPIO's raw value, i.e. the value of the physical line disregarding +* its ACTIVE_LOW status. +* +* This function is to be called from contexts that can sleep. */ - -static int gpiod_get_value_cansleep (const struct gpio_desc *desc) +int gpiod_get_raw_value_cansleep (const struct gpio_desc *desc) {might_sleep_if (extra_checks);if (!desc)return 0 ; -return _gpiod_get_value (desc); +return _gpiod_get_raw_value (desc); } +EXPORT_SYMBOL_GPL (gpiod_get_raw_value_cansleep); -int gpio_get_value_cansleep (unsigned gpio) +/** +* gpiod_get_value_cansleep() - return a gpio's value +* @desc: gpio whose value will be returned +* +* Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into +* account. +* +* This function is to be called from contexts that can sleep. +*/ +int gpiod_get_value_cansleep (const struct gpio_desc *desc) { -return gpiod_get_value_cansleep (gpio_to_desc (gpio)); +int value; + +might_sleep_if (extra_checks); +if (!desc) +return 0 ; + + value =_gpiod_get_raw_value (desc); +if (test_bit (FLAG_ACTIVE_LOW , &desc->flags)) + value = !value; + +return value; } -EXPORT_SYMBOL_GPL (gpio_get_value_cansleep); +EXPORT_SYMBOL_GPL (gpiod_get_value_cansleep); -static void gpiod_set_value_cansleep (struct gpio_desc *desc,int value) +/** +* gpiod_set_raw_value_cansleep() - assign a gpio's raw value +* @desc: gpio whose value will be assigned +* @value: value to assign +* +* Set the raw value of the GPIO, i.e. the value of its physical line without +* regard for its ACTIVE_LOW status. +* +* This function is to be called from contexts that can sleep. +*/ +void gpiod_set_raw_value_cansleep (struct gpio_desc *desc,int value) {might_sleep_if (extra_checks);if (!desc)return ; -_gpiod_set_value (desc, value); +_gpiod_set_raw_value (desc, value); } +EXPORT_SYMBOL_GPL (gpiod_set_raw_value_cansleep); -void gpio_set_value_cansleep (unsigned gpio,int value) +/** +* gpiod_set_value_cansleep() - assign a gpio's value +* @desc: gpio whose value will be assigned +* @value: value to assign +* +* Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into +* account +* +* This function is to be called from contexts that can sleep. +*/ +void gpiod_set_value_cansleep (struct gpio_desc *desc,int value) { -return gpiod_set_value_cansleep (gpio_to_desc (gpio), value); +might_sleep_if (extra_checks); +if (!desc) +return ; + +if (test_bit (FLAG_ACTIVE_LOW , &desc->flags)) + value = !value; +_gpiod_set_raw_value (desc, value); } -EXPORT_SYMBOL_GPL (gpio_set_value_cansleep); +EXPORT_SYMBOL_GPL (gpiod_set_value_cansleep);#ifdef CONFIG_DEBUG_FS
include/asm-generic/gpio.h +62 -160
265 lines not on this page · raw message
include/linux/gpio.h +7 -4
@@ -16,14 +16,17 @@#define GPIOF_OUT_INIT_LOW (GPIOF_DIR_OUT | GPIOF_INIT_LOW)#define GPIOF_OUT_INIT_HIGH (GPIOF_DIR_OUT | GPIOF_INIT_HIGH) +/* Gpio pin is active-low */ +#define GPIOF_ACTIVE_LOW (1 << 2) +/* Gpio pin is open drain */ -#define GPIOF_OPEN_DRAIN (1 << 2) +#define GPIOF_OPEN_DRAIN (1 << 3)/* Gpio pin is open source */ -#define GPIOF_OPEN_SOURCE (1 << 3) +#define GPIOF_OPEN_SOURCE (1 << 4) -#define GPIOF_EXPORT (1 << 4) -#define GPIOF_EXPORT_CHANGEABLE (1 << 5) +#define GPIOF_EXPORT (1 << 5) +#define GPIOF_EXPORT_CHANGEABLE (1 << 6)#define GPIOF_EXPORT_DIR_FIXED (GPIOF_EXPORT)#define GPIOF_EXPORT_DIR_CHANGEABLE (GPIOF_EXPORT | GPIOF_EXPORT_CHANGEABLE)
include/linux/gpio/consumer.h new file +238 -0
238 lines not on this page · raw message
include/linux/gpio/driver.h new file +127 -0
127 lines not on this page · raw message
Signature · 1 line
1.8.4
PATCH v3 2/3 gpiolib: port of_ functions to use gpiod
In reply to Alexandre CourbotRefactor the of_ functions of gpiolib to use the now public gpiod interface, and export of_get_named_gpiod_flags() and of_get_gpiod_flags() functions.
--- drivers/gpio/gpiolib-of.c | 28 +++++++++++++++++----------- include/linux/of_gpio.h | 29 ++++++++++++++++++++++++----- 2 files changed, 41 insertions(+), 16 deletions(-)
drivers/gpio/gpiolib-of.c +17 -11
@@ -15,19 +15,21 @@#include <linux/errno.h> #include <linux/module.h> #include <linux/io.h> -#include <linux/gpio.h> +#include <linux/gpio/consumer.h> #include <linux/of.h> #include <linux/of_address.h> #include <linux/of_gpio.h> #include <linux/pinctrl/pinctrl.h> #include <linux/slab.h> +struct gpio_desc ; +/* Private data structure for of_gpiochip_find_and_xlate */ struct gg_data {enum of_gpio_flags *flags;struct of_phandle_args gpiospec; -int out_gpio; +struct gpio_desc *out_gpio; };/* Private function for resolving node pointer to gpio_chip */
@@ -45,28 +47,31 @@ static int of_gpiochip_find_and_xlate(struct gpio_chip *gc, void *data)if (ret <0 )return false; - gg_data->out_gpio = ret + gc->base; + gg_data->out_gpio =gpio_to_desc (ret + gc->base);return true; }/** -* of_get_named_gpio_flags() - Get a GPIO number and flags to use with GPIO API +* of_get_named_gpiod_flags() - Get a GPIO descriptor and flags for GPIO API * @np: device node to get GPIO from * @propname: property name containing gpio specifier(s) * @index: index of the GPIO * @flags: a flags pointer to fill in * -* Returns GPIO number to use with Linux generic GPIO API, or one of the errno +* Returns GPIO descriptor to use with Linux GPIO API, or one of the errno * value on the error condition. If @flags is not NULL the function also fills * in flags for the GPIO. */ -int of_get_named_gpio_flags (struct device_node *np,const char *propname, -int index,enum of_gpio_flags *flags) +struct gpio_desc *of_get_named_gpiod_flags (struct device_node *np, +const char *propname,int index,enum of_gpio_flags *flags) {/* Return -EPROBE_DEFER to support probe() functions to be called * later when the GPIO actually becomes available */ -struct gg_data gg_data = { .flags = flags, .out_gpio = -EPROBE_DEFER }; +struct gg_data gg_data = { + .flags = flags, + .out_gpio =ERR_PTR (-EPROBE_DEFER ) + };int ret;/* .of_xlate might decide to not fill in the flags, so clear it. */
@@ -78,16 +83,17 @@ int of_get_named_gpio_flags(struct device_node *np, const char *propname,if (ret) {pr_debug ("%s: can't parse gpios property of node '%s[%d]'\n" , __func__, np->full_name, index); -return ret; +return ERR_PTR (ret); }gpiochip_find (&gg_data, of_gpiochip_find_and_xlate);of_node_put (gg_data.gpiospec.np); -pr_debug ("%s exited with status %d\n" , __func__, gg_data.out_gpio); +pr_debug ("%s exited with status %d\n" , __func__, +PTR_RET (gg_data.out_gpio));return gg_data.out_gpio; } -EXPORT_SYMBOL (of_get_named_gpio_flags); +EXPORT_SYMBOL (of_get_named_gpiod_flags);/** * of_gpio_simple_xlate - translate gpio_spec to the GPIO number and flags
include/linux/of_gpio.h +24 -5
@@ -21,6 +21,7 @@#include <linux/of.h> struct device_node ; +struct gpio_desc ;/* * This is Linux-specific flags. By default controllers' and Linux' mapping
@@ -47,7 +48,7 @@ static inline struct of_mm_gpio_chip *to_of_mm_gpio_chip(struct gpio_chip *gc) return container_of(gc, struct of_mm_gpio_chip, gc); } -extern int of_get_named_gpio_flags (struct device_node *np, +extern struct gpio_desc *of_get_named_gpiod_flags (struct device_node *np,const char *list_name,int index,enum of_gpio_flags *flags); extern int of_mm_gpiochip_add(struct device_node *np,
@@ -62,10 +63,10 @@ extern int of_gpio_simple_xlate(struct gpio_chip *gc,#else /* CONFIG_OF_GPIO */ /* Drivers may not strictly depend on the GPIO support, so let them link. */ -static inline int of_get_named_gpio_flags (struct device_node *np, +static inline struct gpio_desc *of_get_named_gpiod_flags (struct device_node *np,const char *list_name,int index,enum of_gpio_flags *flags) { -return -ENOSYS ; +return ERR_PTR (-ENOSYS ); } static inline int of_gpio_simple_xlate(struct gpio_chip *gc,
@@ -80,6 +81,18 @@ static inline void of_gpiochip_remove(struct gpio_chip *gc) { }#endif /* CONFIG_OF_GPIO */ +static inline int of_get_named_gpio_flags (struct device_node *np, +const char *list_name,int index,enum of_gpio_flags *flags) +{ +struct gpio_desc *desc; + desc =of_get_named_gpiod_flags (np, list_name, index, flags); + +if (IS_ERR (desc)) +return PTR_ERR (desc); +else +return desc_to_gpio (desc); +} +/** * of_gpio_named_count() - Count GPIOs for a device * @np: device node to count GPIOs for
@@ -117,15 +130,21 @@ static inline int of_gpio_count(struct device_node *np) }/** -* of_get_gpio_flags() - Get a GPIO number and flags to use with GPIO API +* of_get_gpiod_flags() - Get a GPIO descriptor and flags to use with GPIO API * @np: device node to get GPIO from * @index: index of the GPIO * @flags: a flags pointer to fill in * -* Returns GPIO number to use with Linux generic GPIO API, or one of the errno +* Returns GPIO descriptor to use with Linux generic GPIO API, or a errno * value on the error condition. If @flags is not NULL the function also fills * in flags for the GPIO. */ +static inline struct gpio_desc *of_get_gpiod_flags (struct device_node *np, +int index,enum of_gpio_flags *flags) +{ +return of_get_named_gpiod_flags (np,"gpios" , index, flags); +} +static inline int of_get_gpio_flags (struct device_node *np,int index,enum of_gpio_flags *flags) {
Signature · 1 line
1.8.4
PATCH v3 3/3 gpiolib: add gpiod_get() and gpiod_put() functions
In reply to Alexandre CourbotAdd gpiod_get(), gpiod_get_index() and gpiod_put() functions that provide safer management of GPIOs.
These functions put the GPIO framework in line with the conventions of other frameworks in the kernel, and help ensure every GPIO is declared properly and valid while it is used.
--- drivers/gpio/devres.c | 83 +++++++++++++++++ drivers/gpio/gpiolib.c | 203 ++++++++++++++++++++++++++++++++++++++++++ include/linux/gpio/consumer.h | 15 ++++ include/linux/gpio/driver.h | 56 ++++++++++++ 4 files changed, 357 insertions(+)
drivers/gpio/devres.c +83 -0
@@ -19,6 +19,89 @@#include <linux/device.h> #include <linux/gfp.h> +static void devm_gpiod_release (struct device *dev,void *res) +{ +struct gpio_desc **desc = res; + +gpiod_put (*desc); +} + +static int devm_gpiod_match (struct device *dev,void *res,void *data) +{ +struct gpio_desc **this = res, **gpio = data; + +return *this == *gpio; +} + +/** +* devm_gpiod_get - Resource-managed gpiod_get() +* @dev: GPIO consumer +* @con_id: function within the GPIO consumer +* +* Managed gpiod_get(). GPIO descriptors returned from this function are +* automatically disposed on driver detach. See gpiod_get() for detailed +* information about behavior and return values. +*/ +struct gpio_desc *__must_check devm_gpiod_get (struct device *dev, +const char *con_id) +{ +return devm_gpiod_get_index (dev, con_id,0 ); +} +EXPORT_SYMBOL (devm_gpiod_get); + +/** +* devm_gpiod_get_index - Resource-managed gpiod_get_index() +* @dev: GPIO consumer +* @con_id: function within the GPIO consumer +* @idx: index of the GPIO to obtain in the consumer +* +* Managed gpiod_get_index(). GPIO descriptors returned from this function are +* automatically disposed on driver detach. See gpiod_get_index() for detailed +* information about behavior and return values. +*/ +struct gpio_desc *__must_check devm_gpiod_get_index (struct device *dev, +const char *con_id, +unsigned int idx) +{ +struct gpio_desc **dr; +struct gpio_desc *desc; + + dr =devres_alloc (devm_gpiod_release,sizeof (struct gpiod_desc *), +GFP_KERNEL ); +if (!dr) +return ERR_PTR (-ENOMEM ); + + desc =gpiod_get_index (dev, con_id, idx); +if (IS_ERR (desc)) { +devres_free (dr); +return desc; + } + + *dr = desc; +devres_add (dev, dr); + +return 0 ; +} +EXPORT_SYMBOL (devm_gpiod_get_index); + +/** +* devm_gpiod_put - Resource-managed gpiod_put() +* @desc: GPIO descriptor to dispose of +* +* Dispose of a GPIO descriptor obtained with devm_gpiod_get() or +* devm_gpiod_get_index(). Normally this function will not be called as the GPIO +* will be disposed of by the resource management code. +*/ +void devm_gpiod_put (struct device *dev,struct gpio_desc *desc) +{ +WARN_ON (devres_release (dev, devm_gpiod_release, devm_gpiod_match, + &desc)); +} +EXPORT_SYMBOL (devm_gpiod_put); + + + +static void devm_gpio_release (struct device *dev,void *res) {unsigned *gpio = res;
drivers/gpio/gpiolib.c +203 -0
215 lines not on this page · raw message
include/linux/gpio/consumer.h +15 -0
@@ -18,6 +18,21 @@ struct gpio_chip;*/ struct gpio_desc ; +/* Acquire and dispose GPIOs */ +struct gpio_desc *__must_check gpiod_get (struct device *dev, +const char *con_id); +struct gpio_desc *__must_check gpiod_get_index (struct device *dev, +const char *con_id, +unsigned int idx); +void gpiod_put (struct gpio_desc *desc); + +struct gpio_desc *__must_check devm_gpiod_get (struct device *dev, +const char *con_id); +struct gpio_desc *__must_check devm_gpiod_get_index (struct device *dev, +const char *con_id, +unsigned int idx); +void devm_gpiod_put (struct device *dev,struct gpio_desc *desc); +int gpiod_get_direction (const struct gpio_desc *desc);int gpiod_direction_input (struct gpio_desc *desc);int gpiod_direction_output (struct gpio_desc *desc,int value);
include/linux/gpio/driver.h +56 -0
60 lines not on this page · raw message
Signature · 1 line
1.8.4
Quoted 9 lines · Alexandre Courbot
Hi Linus,
This version should merge as-is in your tree (I hope!). A patch for documentation will follow soon.
Changes since v2:
- rebased on top of Linus' for-next branch
- exported new gpiod_(un)lock_as_irq() functions indriver.h
- squashed a fix for a compilation error
Thanks, let's see if I can get this into v3.13, right now it's unclear if I'll dare to do this. These do not apply right off as it requires the late fixes to the gpiod code which currently are in Torvalds' tree and on my fixes branch, so I'll merge in v3.12-rc6 as it arrives, and then attempt to apply this on top, but I don't know if I dare to do this so late.
The outage of linux-next also contributes to this situation.
We might have to take this as the first thing after the merge window and targeted for v3.14.
Yours,
Linus Walleij
Quoted 19 lines · Linus Walleij
Quoted 9 lines · Alexandre Courbot
Hi Linus,
This version should merge as-is in your tree (I hope!). A patch for documentation will follow soon.
Changes since v2:
- rebased on top of Linus' for-next branch
- exported new gpiod_(un)lock_as_irq() functions indriver.h
- squashed a fix for a compilation errorThanks, let's see if I can get this into v3.13, right now it's unclear if I'll dare to do this. These do not apply right off as it requires the late fixes to the gpiod code which currently are in Torvalds' tree and on my fixes branch, so I'll merge in v3.12-rc6 as it arrives, and then attempt to apply this on top, but I don't know if I dare to do this so late.
Quoted 4 lines
The outage of linux-next also contributes to this situation.
We might have to take this as the first thing after the merge window and targeted for v3.14.
No particular pressure from my side to get this in 3.13. Do for the best, and don't hesitate to delay them to 3.14 if you feel they are not tested enough. I'll already feel better once I know they are under your tree. ;)
Thanks,
Alex.
Quoted 9 lines · Alexandre Courbot
Quoted 2 lines · Linus Walleij
We might have to take this as the first thing after the merge window and targeted for v3.14.
No particular pressure from my side to get this in 3.13. Do for the best, and don't hesitate to delay them to 3.14 if you feel they are not tested enough. I'll already feel better once I know they are under your tree. ;)
I applied it now anyway, I will try to also apply the ACPI stuff making use of this interface and then throw it at the autobuild to see what happens.
Yours,
Linus Walleij
Quoted 6 lines · Linus Walleij
Quoted 5 lines · Alexandre Courbot
Quoted 2 lines · Linus Walleij
We might have to take this as the first thing after the merge window and targeted for v3.14.
Quoted 8 lines
Quoted 4 lines
No particular pressure from my side to get this in 3.13. Do for the best, and don't hesitate to delay them to 3.14 if you feel they are not tested enough. I'll already feel better once I know they are under your tree. ;)
I applied it now anyway, I will try to also apply the ACPI stuff making use of this interface and then throw it at the autobuild to see what happens.
Autobuild was unfortunately not too happy with one of the patches, sorry about that. I have sent a small series that addresses the issues it highlighted. Not sure if you are ok with squashing the first two into bae48da2, but IMHO that would be the preferred way.
Thanks,
Alex.
Linus Walleij
AppliedQuoted 4 lines · Alexandre Courbot
Autobuild was unfortunately not too happy with one of the patches, sorry about that. I have sent a small series that addresses the issues it highlighted. Not sure if you are ok with squashing the first two into
bae48da2, but IMHO that would be the preferred way.
I applied them as-is. I don't think it's going to be a major issue.
Yours,
Linus Walleij