blob: 2ebc9071e354884a80de8c17a978ba7bb3d28077 [file] [log] [blame]
David Brownelld2876d02008-02-04 22:28:20 -08001#include <linux/kernel.h>
2#include <linux/module.h>
Daniel Glöcknerff77c352009-09-22 16:46:38 -07003#include <linux/interrupt.h>
David Brownelld2876d02008-02-04 22:28:20 -08004#include <linux/irq.h>
5#include <linux/spinlock.h>
Alexandre Courbot1a989d02013-02-03 01:29:24 +09006#include <linux/list.h>
David Brownelld8f388d2008-07-25 01:46:07 -07007#include <linux/device.h>
8#include <linux/err.h>
9#include <linux/debugfs.h>
10#include <linux/seq_file.h>
11#include <linux/gpio.h>
Anton Vorontsov391c9702010-06-08 07:48:17 -060012#include <linux/of_gpio.h>
Daniel Glöcknerff77c352009-09-22 16:46:38 -070013#include <linux/idr.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090014#include <linux/slab.h>
Rafael J. Wysocki7b199812013-11-11 22:41:56 +010015#include <linux/acpi.h>
Alexandre Courbot53e7cac2013-11-16 21:44:52 +090016#include <linux/gpio/driver.h>
David Brownelld2876d02008-02-04 22:28:20 -080017
Mika Westerberg664e3e52014-01-08 12:40:54 +020018#include "gpiolib.h"
19
Uwe Kleine-König3f397c212011-05-20 00:40:19 -060020#define CREATE_TRACE_POINTS
21#include <trace/events/gpio.h>
David Brownelld2876d02008-02-04 22:28:20 -080022
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070023/* Implementation infrastructure for GPIO interfaces.
David Brownelld2876d02008-02-04 22:28:20 -080024 *
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070025 * The GPIO programming interface allows for inlining speed-critical
26 * get/set operations for common cases, so that access to SOC-integrated
27 * GPIOs can sometimes cost only an instruction or two per bit.
David Brownelld2876d02008-02-04 22:28:20 -080028 */
29
30
31/* When debugging, extend minimal trust to callers and platform code.
32 * Also emit diagnostic messages that may help initial bringup, when
33 * board setup or driver bugs are most common.
34 *
35 * Otherwise, minimize overhead in what may be bitbanging codepaths.
36 */
37#ifdef DEBUG
38#define extra_checks 1
39#else
40#define extra_checks 0
41#endif
42
43/* gpio_lock prevents conflicts during gpio_desc[] table updates.
44 * While any GPIO is requested, its gpio_chip is not removable;
45 * each GPIO's "requested" flag serves as a lock and refcount.
46 */
47static DEFINE_SPINLOCK(gpio_lock);
48
49struct gpio_desc {
50 struct gpio_chip *chip;
51 unsigned long flags;
52/* flag symbols are bit numbers */
53#define FLAG_REQUESTED 0
54#define FLAG_IS_OUT 1
Alexandre Courbot710b40e2013-02-02 23:44:06 +090055#define FLAG_EXPORT 2 /* protected by sysfs_lock */
56#define FLAG_SYSFS 3 /* exported via /sys/class/gpio/control */
57#define FLAG_TRIG_FALL 4 /* trigger on falling edge */
58#define FLAG_TRIG_RISE 5 /* trigger on rising edge */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -070059#define FLAG_ACTIVE_LOW 6 /* value has active low */
Alexandre Courbot710b40e2013-02-02 23:44:06 +090060#define FLAG_OPEN_DRAIN 7 /* Gpio is open drain type */
61#define FLAG_OPEN_SOURCE 8 /* Gpio is open source type */
Linus Walleijd468bf92013-09-24 11:54:38 +020062#define FLAG_USED_AS_IRQ 9 /* GPIO is connected to an IRQ */
Daniel Glöcknerff77c352009-09-22 16:46:38 -070063
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -070064#define ID_SHIFT 16 /* add new flags before this one */
Daniel Glöcknerff77c352009-09-22 16:46:38 -070065
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -070066#define GPIO_FLAGS_MASK ((1 << ID_SHIFT) - 1)
Daniel Glöcknerff77c352009-09-22 16:46:38 -070067#define GPIO_TRIGGER_MASK (BIT(FLAG_TRIG_FALL) | BIT(FLAG_TRIG_RISE))
David Brownelld2876d02008-02-04 22:28:20 -080068
69#ifdef CONFIG_DEBUG_FS
70 const char *label;
71#endif
72};
73static struct gpio_desc gpio_desc[ARCH_NR_GPIOS];
74
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +090075#define GPIO_OFFSET_VALID(chip, offset) (offset >= 0 && offset < chip->ngpio)
76
Alexandre Courbotbae48da2013-10-17 10:21:38 -070077static DEFINE_MUTEX(gpio_lookup_lock);
78static LIST_HEAD(gpio_lookup_list);
Alexandre Courbot1a989d02013-02-03 01:29:24 +090079static LIST_HEAD(gpio_chips);
80
Daniel Glöcknerff77c352009-09-22 16:46:38 -070081#ifdef CONFIG_GPIO_SYSFS
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -070082static DEFINE_IDR(dirent_idr);
Daniel Glöcknerff77c352009-09-22 16:46:38 -070083#endif
84
Alexandre Courbot372e7222013-02-03 01:29:29 +090085static int gpiod_request(struct gpio_desc *desc, const char *label);
86static void gpiod_free(struct gpio_desc *desc);
Alexandre Courbot372e7222013-02-03 01:29:29 +090087
Andy Shevchenko1a2a99c2013-12-05 11:26:24 +020088/* With descriptor prefix */
89
Mark Brown7b17b592013-09-09 10:33:50 +010090#ifdef CONFIG_DEBUG_FS
Andy Shevchenko7589e592013-12-05 11:26:23 +020091#define gpiod_emerg(desc, fmt, ...) \
92 pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
Mark Brown7b17b592013-09-09 10:33:50 +010093 ##__VA_ARGS__)
Andy Shevchenko7589e592013-12-05 11:26:23 +020094#define gpiod_crit(desc, fmt, ...) \
95 pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
Mark Brown7b17b592013-09-09 10:33:50 +010096 ##__VA_ARGS__)
Andy Shevchenko7589e592013-12-05 11:26:23 +020097#define gpiod_err(desc, fmt, ...) \
98 pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
Mark Brown7b17b592013-09-09 10:33:50 +010099 ##__VA_ARGS__)
Andy Shevchenko7589e592013-12-05 11:26:23 +0200100#define gpiod_warn(desc, fmt, ...) \
101 pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
Mark Brown7b17b592013-09-09 10:33:50 +0100102 ##__VA_ARGS__)
Andy Shevchenko7589e592013-12-05 11:26:23 +0200103#define gpiod_info(desc, fmt, ...) \
104 pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
Mark Brown7b17b592013-09-09 10:33:50 +0100105 ##__VA_ARGS__)
Andy Shevchenko7589e592013-12-05 11:26:23 +0200106#define gpiod_dbg(desc, fmt, ...) \
107 pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
Mark Brown7b17b592013-09-09 10:33:50 +0100108 ##__VA_ARGS__)
109#else
Andy Shevchenko7589e592013-12-05 11:26:23 +0200110#define gpiod_emerg(desc, fmt, ...) \
Mark Brown6424de52013-09-09 10:33:49 +0100111 pr_emerg("gpio-%d: " fmt, desc_to_gpio(desc), ##__VA_ARGS__)
Andy Shevchenko7589e592013-12-05 11:26:23 +0200112#define gpiod_crit(desc, fmt, ...) \
Mark Brown6424de52013-09-09 10:33:49 +0100113 pr_crit("gpio-%d: " fmt, desc_to_gpio(desc), ##__VA_ARGS__)
Andy Shevchenko7589e592013-12-05 11:26:23 +0200114#define gpiod_err(desc, fmt, ...) \
Mark Brown6424de52013-09-09 10:33:49 +0100115 pr_err("gpio-%d: " fmt, desc_to_gpio(desc), ##__VA_ARGS__)
Andy Shevchenko7589e592013-12-05 11:26:23 +0200116#define gpiod_warn(desc, fmt, ...) \
Mark Brown6424de52013-09-09 10:33:49 +0100117 pr_warn("gpio-%d: " fmt, desc_to_gpio(desc), ##__VA_ARGS__)
Andy Shevchenko7589e592013-12-05 11:26:23 +0200118#define gpiod_info(desc, fmt, ...) \
Mark Brown6424de52013-09-09 10:33:49 +0100119 pr_info("gpio-%d: " fmt, desc_to_gpio(desc), ##__VA_ARGS__)
Andy Shevchenko7589e592013-12-05 11:26:23 +0200120#define gpiod_dbg(desc, fmt, ...) \
Mark Brown6424de52013-09-09 10:33:49 +0100121 pr_debug("gpio-%d: " fmt, desc_to_gpio(desc), ##__VA_ARGS__)
Mark Brown7b17b592013-09-09 10:33:50 +0100122#endif
Alexandre Courbot372e7222013-02-03 01:29:29 +0900123
Andy Shevchenko1a2a99c2013-12-05 11:26:24 +0200124/* With chip prefix */
125
126#define chip_emerg(chip, fmt, ...) \
127 pr_emerg("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
128#define chip_crit(chip, fmt, ...) \
129 pr_crit("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
130#define chip_err(chip, fmt, ...) \
131 pr_err("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
132#define chip_warn(chip, fmt, ...) \
133 pr_warn("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
134#define chip_info(chip, fmt, ...) \
135 pr_info("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
136#define chip_dbg(chip, fmt, ...) \
137 pr_debug("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
138
David Brownelld2876d02008-02-04 22:28:20 -0800139static inline void desc_set_label(struct gpio_desc *d, const char *label)
140{
141#ifdef CONFIG_DEBUG_FS
142 d->label = label;
143#endif
144}
145
Alexandre Courbot372e7222013-02-03 01:29:29 +0900146/*
147 * Return the GPIO number of the passed descriptor relative to its chip
148 */
149static int gpio_chip_hwgpio(const struct gpio_desc *desc)
150{
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +0900151 return desc - &desc->chip->desc[0];
Alexandre Courbot372e7222013-02-03 01:29:29 +0900152}
153
154/**
155 * Convert a GPIO number to its descriptor
156 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700157struct gpio_desc *gpio_to_desc(unsigned gpio)
Alexandre Courbot372e7222013-02-03 01:29:29 +0900158{
159 if (WARN(!gpio_is_valid(gpio), "invalid GPIO %d\n", gpio))
160 return NULL;
161 else
162 return &gpio_desc[gpio];
163}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700164EXPORT_SYMBOL_GPL(gpio_to_desc);
Alexandre Courbot372e7222013-02-03 01:29:29 +0900165
166/**
Alexandre Courbotbb1e88c2014-02-09 17:43:54 +0900167 * Get the GPIO descriptor corresponding to the given hw number for this chip.
Linus Walleijd468bf92013-09-24 11:54:38 +0200168 */
Alexandre Courbotbb1e88c2014-02-09 17:43:54 +0900169struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
170 u16 hwnum)
Linus Walleijd468bf92013-09-24 11:54:38 +0200171{
Alexandre Courbotbb1e88c2014-02-09 17:43:54 +0900172 if (hwnum >= chip->ngpio)
Alexandre Courbotb7d0a282013-12-03 12:31:11 +0900173 return ERR_PTR(-EINVAL);
Linus Walleijd468bf92013-09-24 11:54:38 +0200174
Alexandre Courbotbb1e88c2014-02-09 17:43:54 +0900175 return &chip->desc[hwnum];
Linus Walleijd468bf92013-09-24 11:54:38 +0200176}
Alexandre Courbotbb1e88c2014-02-09 17:43:54 +0900177EXPORT_SYMBOL_GPL(gpiochip_get_desc);
Alexandre Courbot372e7222013-02-03 01:29:29 +0900178
179/**
180 * Convert a GPIO descriptor to the integer namespace.
181 * This should disappear in the future but is needed since we still
182 * use GPIO numbers for error messages and sysfs nodes
183 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700184int desc_to_gpio(const struct gpio_desc *desc)
Alexandre Courbot372e7222013-02-03 01:29:29 +0900185{
Alexandre Courbot8c0fca82013-10-04 10:59:57 -0700186 return desc - &gpio_desc[0];
Alexandre Courbot372e7222013-02-03 01:29:29 +0900187}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700188EXPORT_SYMBOL_GPL(desc_to_gpio);
Alexandre Courbot372e7222013-02-03 01:29:29 +0900189
190
David Brownelld2876d02008-02-04 22:28:20 -0800191/* Warn when drivers omit gpio_request() calls -- legal but ill-advised
192 * when setting direction, and otherwise illegal. Until board setup code
193 * and drivers use explicit requests everywhere (which won't happen when
194 * those calls have no teeth) we can't avoid autorequesting. This nag
David Brownell35e8bb52008-10-15 22:03:16 -0700195 * message should motivate switching to explicit requests... so should
196 * the weaker cleanup after faults, compared to gpio_request().
David Brownell8a0cecf2009-04-02 16:57:06 -0700197 *
198 * NOTE: the autorequest mechanism is going away; at this point it's
199 * only "legal" in the sense that (old) code using it won't break yet,
200 * but instead only triggers a WARN() stack dump.
David Brownelld2876d02008-02-04 22:28:20 -0800201 */
Alexandre Courbot372e7222013-02-03 01:29:29 +0900202static int gpio_ensure_requested(struct gpio_desc *desc)
David Brownelld2876d02008-02-04 22:28:20 -0800203{
David Brownell8a0cecf2009-04-02 16:57:06 -0700204 const struct gpio_chip *chip = desc->chip;
Alexandre Courbot372e7222013-02-03 01:29:29 +0900205 const int gpio = desc_to_gpio(desc);
David Brownell35e8bb52008-10-15 22:03:16 -0700206
David Brownell8a0cecf2009-04-02 16:57:06 -0700207 if (WARN(test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0,
208 "autorequest GPIO-%d\n", gpio)) {
David Brownell35e8bb52008-10-15 22:03:16 -0700209 if (!try_module_get(chip->owner)) {
Andy Shevchenko7589e592013-12-05 11:26:23 +0200210 gpiod_err(desc, "%s: module can't be gotten\n",
211 __func__);
David Brownell35e8bb52008-10-15 22:03:16 -0700212 clear_bit(FLAG_REQUESTED, &desc->flags);
213 /* lose */
214 return -EIO;
215 }
David Brownelld2876d02008-02-04 22:28:20 -0800216 desc_set_label(desc, "[auto]");
David Brownell35e8bb52008-10-15 22:03:16 -0700217 /* caller must chip->request() w/o spinlock */
218 if (chip->request)
219 return 1;
David Brownelld2876d02008-02-04 22:28:20 -0800220 }
David Brownell35e8bb52008-10-15 22:03:16 -0700221 return 0;
David Brownelld2876d02008-02-04 22:28:20 -0800222}
223
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700224/**
225 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
226 * @desc: descriptor to return the chip of
227 */
228struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
Alexandre Courbot372e7222013-02-03 01:29:29 +0900229{
Alexandre Courbotbcabdef2013-02-15 14:46:14 +0900230 return desc ? desc->chip : NULL;
Alexandre Courbot372e7222013-02-03 01:29:29 +0900231}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700232EXPORT_SYMBOL_GPL(gpiod_to_chip);
David Brownelld2876d02008-02-04 22:28:20 -0800233
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700234/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
235static int gpiochip_find_base(int ngpio)
236{
Alexandre Courbot83cabe32013-02-03 01:29:28 +0900237 struct gpio_chip *chip;
238 int base = ARCH_NR_GPIOS - ngpio;
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700239
Alexandre Courbot83cabe32013-02-03 01:29:28 +0900240 list_for_each_entry_reverse(chip, &gpio_chips, list) {
241 /* found a free space? */
242 if (chip->base + chip->ngpio <= base)
243 break;
244 else
245 /* nope, check the space right before the chip */
246 base = chip->base - ngpio;
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700247 }
248
Alexandre Courbot83cabe32013-02-03 01:29:28 +0900249 if (gpio_is_valid(base)) {
Anton Vorontsov8d0aab22008-04-28 02:14:46 -0700250 pr_debug("%s: found new base at %d\n", __func__, base);
Alexandre Courbot83cabe32013-02-03 01:29:28 +0900251 return base;
252 } else {
253 pr_err("%s: cannot find free range\n", __func__);
254 return -ENOSPC;
Anton Vorontsov169b6a72008-04-28 02:14:47 -0700255 }
Anton Vorontsov169b6a72008-04-28 02:14:47 -0700256}
257
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700258/**
259 * gpiod_get_direction - return the current direction of a GPIO
260 * @desc: GPIO to get the direction of
261 *
262 * Return GPIOF_DIR_IN or GPIOF_DIR_OUT, or an error code in case of error.
263 *
264 * This function may sleep if gpiod_cansleep() is true.
265 */
266int gpiod_get_direction(const struct gpio_desc *desc)
Mathias Nyman80b0a602012-10-24 17:25:27 +0300267{
268 struct gpio_chip *chip;
Alexandre Courbot372e7222013-02-03 01:29:29 +0900269 unsigned offset;
Mathias Nyman80b0a602012-10-24 17:25:27 +0300270 int status = -EINVAL;
271
Alexandre Courbot372e7222013-02-03 01:29:29 +0900272 chip = gpiod_to_chip(desc);
273 offset = gpio_chip_hwgpio(desc);
Mathias Nyman80b0a602012-10-24 17:25:27 +0300274
275 if (!chip->get_direction)
276 return status;
277
Alexandre Courbot372e7222013-02-03 01:29:29 +0900278 status = chip->get_direction(chip, offset);
Mathias Nyman80b0a602012-10-24 17:25:27 +0300279 if (status > 0) {
280 /* GPIOF_DIR_IN, or other positive */
281 status = 1;
Alexandre Courbotdef63432013-02-15 14:46:15 +0900282 /* FLAG_IS_OUT is just a cache of the result of get_direction(),
283 * so it does not affect constness per se */
284 clear_bit(FLAG_IS_OUT, &((struct gpio_desc *)desc)->flags);
Mathias Nyman80b0a602012-10-24 17:25:27 +0300285 }
286 if (status == 0) {
287 /* GPIOF_DIR_OUT */
Alexandre Courbotdef63432013-02-15 14:46:15 +0900288 set_bit(FLAG_IS_OUT, &((struct gpio_desc *)desc)->flags);
Mathias Nyman80b0a602012-10-24 17:25:27 +0300289 }
290 return status;
291}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700292EXPORT_SYMBOL_GPL(gpiod_get_direction);
Mathias Nyman80b0a602012-10-24 17:25:27 +0300293
David Brownelld8f388d2008-07-25 01:46:07 -0700294#ifdef CONFIG_GPIO_SYSFS
295
296/* lock protects against unexport_gpio() being called while
297 * sysfs files are active.
298 */
299static DEFINE_MUTEX(sysfs_lock);
300
301/*
302 * /sys/class/gpio/gpioN... only for GPIOs that are exported
303 * /direction
304 * * MAY BE OMITTED if kernel won't allow direction changes
305 * * is read/write as "in" or "out"
306 * * may also be written as "high" or "low", initializing
307 * output value as specified ("out" implies "low")
308 * /value
309 * * always readable, subject to hardware behavior
310 * * may be writable, as zero/nonzero
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700311 * /edge
312 * * configures behavior of poll(2) on /value
313 * * available only if pin can generate IRQs on input
314 * * is read/write as "none", "falling", "rising", or "both"
Jani Nikula07697462009-12-15 16:46:20 -0800315 * /active_low
316 * * configures polarity of /value
317 * * is read/write as zero/nonzero
318 * * also affects existing and subsequent "falling" and "rising"
319 * /edge configuration
David Brownelld8f388d2008-07-25 01:46:07 -0700320 */
321
322static ssize_t gpio_direction_show(struct device *dev,
323 struct device_attribute *attr, char *buf)
324{
Alexandre Courbotdef63432013-02-15 14:46:15 +0900325 const struct gpio_desc *desc = dev_get_drvdata(dev);
David Brownelld8f388d2008-07-25 01:46:07 -0700326 ssize_t status;
327
328 mutex_lock(&sysfs_lock);
329
Alexandre Courbot476171ce2013-02-04 17:42:04 +0900330 if (!test_bit(FLAG_EXPORT, &desc->flags)) {
David Brownelld8f388d2008-07-25 01:46:07 -0700331 status = -EIO;
Alexandre Courbot476171ce2013-02-04 17:42:04 +0900332 } else {
Alexandre Courbot372e7222013-02-03 01:29:29 +0900333 gpiod_get_direction(desc);
David Brownelld8f388d2008-07-25 01:46:07 -0700334 status = sprintf(buf, "%s\n",
335 test_bit(FLAG_IS_OUT, &desc->flags)
336 ? "out" : "in");
Alexandre Courbot476171ce2013-02-04 17:42:04 +0900337 }
David Brownelld8f388d2008-07-25 01:46:07 -0700338
339 mutex_unlock(&sysfs_lock);
340 return status;
341}
342
343static ssize_t gpio_direction_store(struct device *dev,
344 struct device_attribute *attr, const char *buf, size_t size)
345{
Alexandre Courbot372e7222013-02-03 01:29:29 +0900346 struct gpio_desc *desc = dev_get_drvdata(dev);
David Brownelld8f388d2008-07-25 01:46:07 -0700347 ssize_t status;
348
349 mutex_lock(&sysfs_lock);
350
351 if (!test_bit(FLAG_EXPORT, &desc->flags))
352 status = -EIO;
353 else if (sysfs_streq(buf, "high"))
Philipp Zabelef70bbe2014-01-07 12:34:11 +0100354 status = gpiod_direction_output_raw(desc, 1);
David Brownelld8f388d2008-07-25 01:46:07 -0700355 else if (sysfs_streq(buf, "out") || sysfs_streq(buf, "low"))
Philipp Zabelef70bbe2014-01-07 12:34:11 +0100356 status = gpiod_direction_output_raw(desc, 0);
David Brownelld8f388d2008-07-25 01:46:07 -0700357 else if (sysfs_streq(buf, "in"))
Alexandre Courbot372e7222013-02-03 01:29:29 +0900358 status = gpiod_direction_input(desc);
David Brownelld8f388d2008-07-25 01:46:07 -0700359 else
360 status = -EINVAL;
361
362 mutex_unlock(&sysfs_lock);
363 return status ? : size;
364}
365
Jani Nikula07697462009-12-15 16:46:20 -0800366static /* const */ DEVICE_ATTR(direction, 0644,
David Brownelld8f388d2008-07-25 01:46:07 -0700367 gpio_direction_show, gpio_direction_store);
368
369static ssize_t gpio_value_show(struct device *dev,
370 struct device_attribute *attr, char *buf)
371{
Alexandre Courbot372e7222013-02-03 01:29:29 +0900372 struct gpio_desc *desc = dev_get_drvdata(dev);
David Brownelld8f388d2008-07-25 01:46:07 -0700373 ssize_t status;
374
375 mutex_lock(&sysfs_lock);
376
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700377 if (!test_bit(FLAG_EXPORT, &desc->flags))
David Brownelld8f388d2008-07-25 01:46:07 -0700378 status = -EIO;
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700379 else
380 status = sprintf(buf, "%d\n", gpiod_get_value_cansleep(desc));
David Brownelld8f388d2008-07-25 01:46:07 -0700381
382 mutex_unlock(&sysfs_lock);
383 return status;
384}
385
386static ssize_t gpio_value_store(struct device *dev,
387 struct device_attribute *attr, const char *buf, size_t size)
388{
Alexandre Courbot372e7222013-02-03 01:29:29 +0900389 struct gpio_desc *desc = dev_get_drvdata(dev);
David Brownelld8f388d2008-07-25 01:46:07 -0700390 ssize_t status;
391
392 mutex_lock(&sysfs_lock);
393
394 if (!test_bit(FLAG_EXPORT, &desc->flags))
395 status = -EIO;
396 else if (!test_bit(FLAG_IS_OUT, &desc->flags))
397 status = -EPERM;
398 else {
399 long value;
400
Jingoo Hana3d88c92013-07-19 16:12:50 +0900401 status = kstrtol(buf, 0, &value);
David Brownelld8f388d2008-07-25 01:46:07 -0700402 if (status == 0) {
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700403 gpiod_set_value_cansleep(desc, value);
David Brownelld8f388d2008-07-25 01:46:07 -0700404 status = size;
405 }
406 }
407
408 mutex_unlock(&sysfs_lock);
409 return status;
410}
411
Jani Nikula07697462009-12-15 16:46:20 -0800412static const DEVICE_ATTR(value, 0644,
David Brownelld8f388d2008-07-25 01:46:07 -0700413 gpio_value_show, gpio_value_store);
414
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700415static irqreturn_t gpio_sysfs_irq(int irq, void *priv)
416{
Tejun Heo324a56e2013-12-11 14:11:53 -0500417 struct kernfs_node *value_sd = priv;
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700418
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -0700419 sysfs_notify_dirent(value_sd);
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700420 return IRQ_HANDLED;
421}
422
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700423static int gpio_setup_irq(struct gpio_desc *desc, struct device *dev,
424 unsigned long gpio_flags)
425{
Tejun Heo324a56e2013-12-11 14:11:53 -0500426 struct kernfs_node *value_sd;
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700427 unsigned long irq_flags;
428 int ret, irq, id;
429
430 if ((desc->flags & GPIO_TRIGGER_MASK) == gpio_flags)
431 return 0;
432
Alexandre Courbot372e7222013-02-03 01:29:29 +0900433 irq = gpiod_to_irq(desc);
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700434 if (irq < 0)
435 return -EIO;
436
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -0700437 id = desc->flags >> ID_SHIFT;
438 value_sd = idr_find(&dirent_idr, id);
439 if (value_sd)
440 free_irq(irq, value_sd);
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700441
442 desc->flags &= ~GPIO_TRIGGER_MASK;
443
444 if (!gpio_flags) {
Linus Walleijd468bf92013-09-24 11:54:38 +0200445 gpiod_unlock_as_irq(desc);
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700446 ret = 0;
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -0700447 goto free_id;
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700448 }
449
450 irq_flags = IRQF_SHARED;
451 if (test_bit(FLAG_TRIG_FALL, &gpio_flags))
Jani Nikula07697462009-12-15 16:46:20 -0800452 irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
453 IRQF_TRIGGER_RISING : IRQF_TRIGGER_FALLING;
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700454 if (test_bit(FLAG_TRIG_RISE, &gpio_flags))
Jani Nikula07697462009-12-15 16:46:20 -0800455 irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
456 IRQF_TRIGGER_FALLING : IRQF_TRIGGER_RISING;
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700457
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -0700458 if (!value_sd) {
Tejun Heo388975c2013-09-11 23:19:13 -0400459 value_sd = sysfs_get_dirent(dev->kobj.sd, "value");
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -0700460 if (!value_sd) {
461 ret = -ENODEV;
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700462 goto err_out;
463 }
464
Tejun Heo62f516b2013-02-27 17:04:06 -0800465 ret = idr_alloc(&dirent_idr, value_sd, 1, 0, GFP_KERNEL);
466 if (ret < 0)
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -0700467 goto free_sd;
Tejun Heo62f516b2013-02-27 17:04:06 -0800468 id = ret;
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700469
470 desc->flags &= GPIO_FLAGS_MASK;
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -0700471 desc->flags |= (unsigned long)id << ID_SHIFT;
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700472
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -0700473 if (desc->flags >> ID_SHIFT != id) {
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700474 ret = -ERANGE;
475 goto free_id;
476 }
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700477 }
478
Daniel Gl?ckner364fadb32010-08-10 18:02:26 -0700479 ret = request_any_context_irq(irq, gpio_sysfs_irq, irq_flags,
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -0700480 "gpiolib", value_sd);
Daniel Gl?ckner364fadb32010-08-10 18:02:26 -0700481 if (ret < 0)
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -0700482 goto free_id;
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700483
Linus Walleijd468bf92013-09-24 11:54:38 +0200484 ret = gpiod_lock_as_irq(desc);
485 if (ret < 0) {
486 gpiod_warn(desc, "failed to flag the GPIO for IRQ\n");
487 goto free_id;
488 }
489
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700490 desc->flags |= gpio_flags;
491 return 0;
492
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700493free_id:
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -0700494 idr_remove(&dirent_idr, id);
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700495 desc->flags &= GPIO_FLAGS_MASK;
Daniel Gl?ckner5ba18212010-08-10 18:02:25 -0700496free_sd:
497 if (value_sd)
498 sysfs_put(value_sd);
Daniel Glöcknerff77c352009-09-22 16:46:38 -0700499err_out:
500 return ret;
501}
502
503static const struct {
504 const char *name;
505 unsigned long flags;
506} trigger_types[] = {
507 { "none", 0 },
508 { "falling", BIT(FLAG_TRIG_FALL) },
509 { "rising", BIT(FLAG_TRIG_RISE) },
510 { "both", BIT(FLAG_TRIG_FALL) | BIT(FLAG_TRIG_RISE) },
511};
512
513static ssize_t gpio_edge_show(struct device *dev,
514 struct device_attribute *attr, char *buf)
515{
516 const struct gpio_desc *desc = dev_get_drvdata(dev);
517 ssize_t status;
518
519 mutex_lock(&sysfs_lock);
520
521 if (!test_bit(FLAG_EXPORT, &desc->flags))
522 status = -EIO;
523 else {
524 int i;
525
526 status = 0;
527 for (i = 0; i < ARRAY_SIZE(trigger_types); i++)
528 if ((desc->flags & GPIO_TRIGGER_MASK)
529 == trigger_types[i].flags) {
530 status = sprintf(buf, "%s\n",
531 trigger_types[i].name);
532 break;
533 }
534 }
535
536 mutex_unlock(&sysfs_lock);
537 return status;
538}
539
540static ssize_t gpio_edge_store(struct device *dev,
541 struct device_attribute *attr, const char *buf, size_t size)
542{
543 struct gpio_desc *desc = dev_get_drvdata(dev);
544 ssize_t status;
545 int i;
546
547 for (i = 0; i < ARRAY_SIZE(trigger_types); i++)
548 if (sysfs_streq(trigger_types[i].name, buf))
549 goto found;
550 return -EINVAL;
551
552found:
553 mutex_lock(&sysfs_lock);
554
555 if (!test_bit(FLAG_EXPORT, &desc->flags))
556 status = -EIO;
557 else {
558 status = gpio_setup_irq(desc, dev, trigger_types[i].flags);
559 if (!status)
560 status = size;
561 }
562
563 mutex_unlock(&sysfs_lock);
564
565 return status;
566}
567
568static DEVICE_ATTR(edge, 0644, gpio_edge_show, gpio_edge_store);
569
Jani Nikula07697462009-12-15 16:46:20 -0800570static int sysfs_set_active_low(struct gpio_desc *desc, struct device *dev,
571 int value)
572{
573 int status = 0;
574
575 if (!!test_bit(FLAG_ACTIVE_LOW, &desc->flags) == !!value)
576 return 0;
577
578 if (value)
579 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
580 else
581 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
582
583 /* reconfigure poll(2) support if enabled on one edge only */
584 if (dev != NULL && (!!test_bit(FLAG_TRIG_RISE, &desc->flags) ^
585 !!test_bit(FLAG_TRIG_FALL, &desc->flags))) {
586 unsigned long trigger_flags = desc->flags & GPIO_TRIGGER_MASK;
587
588 gpio_setup_irq(desc, dev, 0);
589 status = gpio_setup_irq(desc, dev, trigger_flags);
590 }
591
592 return status;
593}
594
595static ssize_t gpio_active_low_show(struct device *dev,
596 struct device_attribute *attr, char *buf)
597{
598 const struct gpio_desc *desc = dev_get_drvdata(dev);
599 ssize_t status;
600
601 mutex_lock(&sysfs_lock);
602
603 if (!test_bit(FLAG_EXPORT, &desc->flags))
604 status = -EIO;
605 else
606 status = sprintf(buf, "%d\n",
607 !!test_bit(FLAG_ACTIVE_LOW, &desc->flags));
608
609 mutex_unlock(&sysfs_lock);
610
611 return status;
612}
613
614static ssize_t gpio_active_low_store(struct device *dev,
615 struct device_attribute *attr, const char *buf, size_t size)
616{
617 struct gpio_desc *desc = dev_get_drvdata(dev);
618 ssize_t status;
619
620 mutex_lock(&sysfs_lock);
621
622 if (!test_bit(FLAG_EXPORT, &desc->flags)) {
623 status = -EIO;
624 } else {
625 long value;
626
Jingoo Hana3d88c92013-07-19 16:12:50 +0900627 status = kstrtol(buf, 0, &value);
Jani Nikula07697462009-12-15 16:46:20 -0800628 if (status == 0)
629 status = sysfs_set_active_low(desc, dev, value != 0);
630 }
631
632 mutex_unlock(&sysfs_lock);
633
634 return status ? : size;
635}
636
637static const DEVICE_ATTR(active_low, 0644,
638 gpio_active_low_show, gpio_active_low_store);
639
David Brownelld8f388d2008-07-25 01:46:07 -0700640static const struct attribute *gpio_attrs[] = {
David Brownelld8f388d2008-07-25 01:46:07 -0700641 &dev_attr_value.attr,
Jani Nikula07697462009-12-15 16:46:20 -0800642 &dev_attr_active_low.attr,
David Brownelld8f388d2008-07-25 01:46:07 -0700643 NULL,
644};
645
646static const struct attribute_group gpio_attr_group = {
647 .attrs = (struct attribute **) gpio_attrs,
648};
649
650/*
651 * /sys/class/gpio/gpiochipN/
652 * /base ... matching gpio_chip.base (N)
653 * /label ... matching gpio_chip.label
654 * /ngpio ... matching gpio_chip.ngpio
655 */
656
657static ssize_t chip_base_show(struct device *dev,
658 struct device_attribute *attr, char *buf)
659{
660 const struct gpio_chip *chip = dev_get_drvdata(dev);
661
662 return sprintf(buf, "%d\n", chip->base);
663}
664static DEVICE_ATTR(base, 0444, chip_base_show, NULL);
665
666static ssize_t chip_label_show(struct device *dev,
667 struct device_attribute *attr, char *buf)
668{
669 const struct gpio_chip *chip = dev_get_drvdata(dev);
670
671 return sprintf(buf, "%s\n", chip->label ? : "");
672}
673static DEVICE_ATTR(label, 0444, chip_label_show, NULL);
674
675static ssize_t chip_ngpio_show(struct device *dev,
676 struct device_attribute *attr, char *buf)
677{
678 const struct gpio_chip *chip = dev_get_drvdata(dev);
679
680 return sprintf(buf, "%u\n", chip->ngpio);
681}
682static DEVICE_ATTR(ngpio, 0444, chip_ngpio_show, NULL);
683
684static const struct attribute *gpiochip_attrs[] = {
685 &dev_attr_base.attr,
686 &dev_attr_label.attr,
687 &dev_attr_ngpio.attr,
688 NULL,
689};
690
691static const struct attribute_group gpiochip_attr_group = {
692 .attrs = (struct attribute **) gpiochip_attrs,
693};
694
695/*
696 * /sys/class/gpio/export ... write-only
697 * integer N ... number of GPIO to export (full access)
698 * /sys/class/gpio/unexport ... write-only
699 * integer N ... number of GPIO to unexport
700 */
Andi Kleen28812fe2010-01-05 12:48:07 +0100701static ssize_t export_store(struct class *class,
702 struct class_attribute *attr,
703 const char *buf, size_t len)
David Brownelld8f388d2008-07-25 01:46:07 -0700704{
Alexandre Courbot372e7222013-02-03 01:29:29 +0900705 long gpio;
706 struct gpio_desc *desc;
707 int status;
David Brownelld8f388d2008-07-25 01:46:07 -0700708
Jingoo Hana3d88c92013-07-19 16:12:50 +0900709 status = kstrtol(buf, 0, &gpio);
David Brownelld8f388d2008-07-25 01:46:07 -0700710 if (status < 0)
711 goto done;
712
Alexandre Courbot372e7222013-02-03 01:29:29 +0900713 desc = gpio_to_desc(gpio);
Alexandre Courbotbcabdef2013-02-15 14:46:14 +0900714 /* reject invalid GPIOs */
715 if (!desc) {
716 pr_warn("%s: invalid GPIO %ld\n", __func__, gpio);
717 return -EINVAL;
718 }
Alexandre Courbot372e7222013-02-03 01:29:29 +0900719
David Brownelld8f388d2008-07-25 01:46:07 -0700720 /* No extra locking here; FLAG_SYSFS just signifies that the
721 * request and export were done by on behalf of userspace, so
722 * they may be undone on its behalf too.
723 */
724
Alexandre Courbot372e7222013-02-03 01:29:29 +0900725 status = gpiod_request(desc, "sysfs");
Mathias Nymanad2fab32012-10-25 14:03:03 +0300726 if (status < 0) {
727 if (status == -EPROBE_DEFER)
728 status = -ENODEV;
David Brownelld8f388d2008-07-25 01:46:07 -0700729 goto done;
Mathias Nymanad2fab32012-10-25 14:03:03 +0300730 }
Alexandre Courbot372e7222013-02-03 01:29:29 +0900731 status = gpiod_export(desc, true);
David Brownelld8f388d2008-07-25 01:46:07 -0700732 if (status < 0)
Alexandre Courbot372e7222013-02-03 01:29:29 +0900733 gpiod_free(desc);
David Brownelld8f388d2008-07-25 01:46:07 -0700734 else
Alexandre Courbot372e7222013-02-03 01:29:29 +0900735 set_bit(FLAG_SYSFS, &desc->flags);
David Brownelld8f388d2008-07-25 01:46:07 -0700736
737done:
738 if (status)
739 pr_debug("%s: status %d\n", __func__, status);
740 return status ? : len;
741}
742
Andi Kleen28812fe2010-01-05 12:48:07 +0100743static ssize_t unexport_store(struct class *class,
744 struct class_attribute *attr,
745 const char *buf, size_t len)
David Brownelld8f388d2008-07-25 01:46:07 -0700746{
Alexandre Courbot372e7222013-02-03 01:29:29 +0900747 long gpio;
748 struct gpio_desc *desc;
749 int status;
David Brownelld8f388d2008-07-25 01:46:07 -0700750
Jingoo Hana3d88c92013-07-19 16:12:50 +0900751 status = kstrtol(buf, 0, &gpio);
David Brownelld8f388d2008-07-25 01:46:07 -0700752 if (status < 0)
753 goto done;
754
Alexandre Courbot372e7222013-02-03 01:29:29 +0900755 desc = gpio_to_desc(gpio);
David Brownelld8f388d2008-07-25 01:46:07 -0700756 /* reject bogus commands (gpio_unexport ignores them) */
Alexandre Courbotbcabdef2013-02-15 14:46:14 +0900757 if (!desc) {
758 pr_warn("%s: invalid GPIO %ld\n", __func__, gpio);
759 return -EINVAL;
760 }
761
762 status = -EINVAL;
David Brownelld8f388d2008-07-25 01:46:07 -0700763
764 /* No extra locking here; FLAG_SYSFS just signifies that the
765 * request and export were done by on behalf of userspace, so
766 * they may be undone on its behalf too.
767 */
Alexandre Courbot372e7222013-02-03 01:29:29 +0900768 if (test_and_clear_bit(FLAG_SYSFS, &desc->flags)) {
David Brownelld8f388d2008-07-25 01:46:07 -0700769 status = 0;
Alexandre Courbot372e7222013-02-03 01:29:29 +0900770 gpiod_free(desc);
David Brownelld8f388d2008-07-25 01:46:07 -0700771 }
772done:
773 if (status)
774 pr_debug("%s: status %d\n", __func__, status);
775 return status ? : len;
776}
777
778static struct class_attribute gpio_class_attrs[] = {
779 __ATTR(export, 0200, NULL, export_store),
780 __ATTR(unexport, 0200, NULL, unexport_store),
781 __ATTR_NULL,
782};
783
784static struct class gpio_class = {
785 .name = "gpio",
786 .owner = THIS_MODULE,
787
788 .class_attrs = gpio_class_attrs,
789};
790
791
792/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700793 * gpiod_export - export a GPIO through sysfs
David Brownelld8f388d2008-07-25 01:46:07 -0700794 * @gpio: gpio to make available, already requested
795 * @direction_may_change: true if userspace may change gpio direction
796 * Context: arch_initcall or later
797 *
798 * When drivers want to make a GPIO accessible to userspace after they
799 * have requested it -- perhaps while debugging, or as part of their
800 * public interface -- they may use this routine. If the GPIO can
801 * change direction (some can't) and the caller allows it, userspace
802 * will see "direction" sysfs attribute which may be used to change
803 * the gpio's direction. A "value" attribute will always be provided.
804 *
805 * Returns zero on success, else an error.
806 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700807int gpiod_export(struct gpio_desc *desc, bool direction_may_change)
David Brownelld8f388d2008-07-25 01:46:07 -0700808{
809 unsigned long flags;
Ryan Mallonfc4e2512012-10-22 11:39:12 +1100810 int status;
Uwe Kleine-König62154992010-05-26 14:42:17 -0700811 const char *ioname = NULL;
Ryan Mallonfc4e2512012-10-22 11:39:12 +1100812 struct device *dev;
Alexandre Courbot372e7222013-02-03 01:29:29 +0900813 int offset;
David Brownelld8f388d2008-07-25 01:46:07 -0700814
815 /* can't export until sysfs is available ... */
816 if (!gpio_class.p) {
817 pr_debug("%s: called too early!\n", __func__);
818 return -ENOENT;
819 }
820
Alexandre Courbot372e7222013-02-03 01:29:29 +0900821 if (!desc) {
822 pr_debug("%s: invalid gpio descriptor\n", __func__);
Ryan Mallonfc4e2512012-10-22 11:39:12 +1100823 return -EINVAL;
824 }
David Brownelld8f388d2008-07-25 01:46:07 -0700825
826 mutex_lock(&sysfs_lock);
827
828 spin_lock_irqsave(&gpio_lock, flags);
Ryan Mallonfc4e2512012-10-22 11:39:12 +1100829 if (!test_bit(FLAG_REQUESTED, &desc->flags) ||
830 test_bit(FLAG_EXPORT, &desc->flags)) {
831 spin_unlock_irqrestore(&gpio_lock, flags);
Andy Shevchenko7589e592013-12-05 11:26:23 +0200832 gpiod_dbg(desc, "%s: unavailable (requested=%d, exported=%d)\n",
833 __func__,
Ryan Mallonfc4e2512012-10-22 11:39:12 +1100834 test_bit(FLAG_REQUESTED, &desc->flags),
835 test_bit(FLAG_EXPORT, &desc->flags));
Dan Carpenter529f2ad2012-10-26 09:59:43 +0300836 status = -EPERM;
837 goto fail_unlock;
David Brownelld8f388d2008-07-25 01:46:07 -0700838 }
Ryan Mallonfc4e2512012-10-22 11:39:12 +1100839
840 if (!desc->chip->direction_input || !desc->chip->direction_output)
841 direction_may_change = false;
David Brownelld8f388d2008-07-25 01:46:07 -0700842 spin_unlock_irqrestore(&gpio_lock, flags);
843
Alexandre Courbot372e7222013-02-03 01:29:29 +0900844 offset = gpio_chip_hwgpio(desc);
845 if (desc->chip->names && desc->chip->names[offset])
846 ioname = desc->chip->names[offset];
Daniel Silverstone926b6632009-04-02 16:57:05 -0700847
Ryan Mallonfc4e2512012-10-22 11:39:12 +1100848 dev = device_create(&gpio_class, desc->chip->dev, MKDEV(0, 0),
Alexandre Courbot372e7222013-02-03 01:29:29 +0900849 desc, ioname ? ioname : "gpio%u",
850 desc_to_gpio(desc));
Ryan Mallonfc4e2512012-10-22 11:39:12 +1100851 if (IS_ERR(dev)) {
852 status = PTR_ERR(dev);
853 goto fail_unlock;
David Brownelld8f388d2008-07-25 01:46:07 -0700854 }
855
Ryan Mallonfc4e2512012-10-22 11:39:12 +1100856 status = sysfs_create_group(&dev->kobj, &gpio_attr_group);
David Brownelld8f388d2008-07-25 01:46:07 -0700857 if (status)
Ryan Mallonfc4e2512012-10-22 11:39:12 +1100858 goto fail_unregister_device;
David Brownelld8f388d2008-07-25 01:46:07 -0700859
Ryan Mallonfc4e2512012-10-22 11:39:12 +1100860 if (direction_may_change) {
861 status = device_create_file(dev, &dev_attr_direction);
862 if (status)
863 goto fail_unregister_device;
864 }
865
Alexandre Courbot372e7222013-02-03 01:29:29 +0900866 if (gpiod_to_irq(desc) >= 0 && (direction_may_change ||
Ryan Mallonfc4e2512012-10-22 11:39:12 +1100867 !test_bit(FLAG_IS_OUT, &desc->flags))) {
868 status = device_create_file(dev, &dev_attr_edge);
869 if (status)
870 goto fail_unregister_device;
871 }
872
873 set_bit(FLAG_EXPORT, &desc->flags);
874 mutex_unlock(&sysfs_lock);
875 return 0;
876
877fail_unregister_device:
878 device_unregister(dev);
879fail_unlock:
880 mutex_unlock(&sysfs_lock);
Andy Shevchenko7589e592013-12-05 11:26:23 +0200881 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
David Brownelld8f388d2008-07-25 01:46:07 -0700882 return status;
883}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700884EXPORT_SYMBOL_GPL(gpiod_export);
David Brownelld8f388d2008-07-25 01:46:07 -0700885
Michał Mirosław9f3b7952013-02-01 20:40:17 +0100886static int match_export(struct device *dev, const void *data)
David Brownelld8f388d2008-07-25 01:46:07 -0700887{
888 return dev_get_drvdata(dev) == data;
889}
890
891/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700892 * gpiod_export_link - create a sysfs link to an exported GPIO node
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700893 * @dev: device under which to create symlink
894 * @name: name of the symlink
895 * @gpio: gpio to create symlink to, already exported
896 *
897 * Set up a symlink from /sys/.../dev/name to /sys/class/gpio/gpioN
898 * node. Caller is responsible for unlinking.
899 *
900 * Returns zero on success, else an error.
901 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700902int gpiod_export_link(struct device *dev, const char *name,
903 struct gpio_desc *desc)
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700904{
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700905 int status = -EINVAL;
906
Alexandre Courbotbcabdef2013-02-15 14:46:14 +0900907 if (!desc) {
908 pr_warn("%s: invalid GPIO\n", __func__);
909 return -EINVAL;
910 }
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700911
912 mutex_lock(&sysfs_lock);
913
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700914 if (test_bit(FLAG_EXPORT, &desc->flags)) {
915 struct device *tdev;
916
917 tdev = class_find_device(&gpio_class, NULL, desc, match_export);
918 if (tdev != NULL) {
919 status = sysfs_create_link(&dev->kobj, &tdev->kobj,
920 name);
921 } else {
922 status = -ENODEV;
923 }
924 }
925
926 mutex_unlock(&sysfs_lock);
927
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700928 if (status)
Andy Shevchenko7589e592013-12-05 11:26:23 +0200929 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700930
931 return status;
932}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700933EXPORT_SYMBOL_GPL(gpiod_export_link);
Jani Nikula07697462009-12-15 16:46:20 -0800934
935/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700936 * gpiod_sysfs_set_active_low - set the polarity of gpio sysfs value
Jani Nikula07697462009-12-15 16:46:20 -0800937 * @gpio: gpio to change
938 * @value: non-zero to use active low, i.e. inverted values
939 *
940 * Set the polarity of /sys/class/gpio/gpioN/value sysfs attribute.
941 * The GPIO does not have to be exported yet. If poll(2) support has
942 * been enabled for either rising or falling edge, it will be
943 * reconfigured to follow the new polarity.
944 *
945 * Returns zero on success, else an error.
946 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700947int gpiod_sysfs_set_active_low(struct gpio_desc *desc, int value)
Jani Nikula07697462009-12-15 16:46:20 -0800948{
Jani Nikula07697462009-12-15 16:46:20 -0800949 struct device *dev = NULL;
950 int status = -EINVAL;
951
Alexandre Courbotbcabdef2013-02-15 14:46:14 +0900952 if (!desc) {
953 pr_warn("%s: invalid GPIO\n", __func__);
954 return -EINVAL;
955 }
Jani Nikula07697462009-12-15 16:46:20 -0800956
957 mutex_lock(&sysfs_lock);
958
Jani Nikula07697462009-12-15 16:46:20 -0800959 if (test_bit(FLAG_EXPORT, &desc->flags)) {
Jani Nikula07697462009-12-15 16:46:20 -0800960 dev = class_find_device(&gpio_class, NULL, desc, match_export);
961 if (dev == NULL) {
962 status = -ENODEV;
963 goto unlock;
964 }
965 }
966
967 status = sysfs_set_active_low(desc, dev, value);
968
969unlock:
970 mutex_unlock(&sysfs_lock);
971
Jani Nikula07697462009-12-15 16:46:20 -0800972 if (status)
Andy Shevchenko7589e592013-12-05 11:26:23 +0200973 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
Jani Nikula07697462009-12-15 16:46:20 -0800974
975 return status;
976}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700977EXPORT_SYMBOL_GPL(gpiod_sysfs_set_active_low);
Jani Nikula07697462009-12-15 16:46:20 -0800978
Jani Nikulaa4177ee2009-09-22 16:46:33 -0700979/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700980 * gpiod_unexport - reverse effect of gpio_export()
David Brownelld8f388d2008-07-25 01:46:07 -0700981 * @gpio: gpio to make unavailable
982 *
983 * This is implicit on gpio_free().
984 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -0700985void gpiod_unexport(struct gpio_desc *desc)
David Brownelld8f388d2008-07-25 01:46:07 -0700986{
Jon Povey6a99ad42010-07-27 13:18:06 -0700987 int status = 0;
Ming Lei864533c2012-02-13 22:53:20 +0800988 struct device *dev = NULL;
David Brownelld8f388d2008-07-25 01:46:07 -0700989
Alexandre Courbot372e7222013-02-03 01:29:29 +0900990 if (!desc) {
Alexandre Courbotbcabdef2013-02-15 14:46:14 +0900991 pr_warn("%s: invalid GPIO\n", __func__);
992 return;
Jon Povey6a99ad42010-07-27 13:18:06 -0700993 }
David Brownelld8f388d2008-07-25 01:46:07 -0700994
995 mutex_lock(&sysfs_lock);
996
David Brownelld8f388d2008-07-25 01:46:07 -0700997 if (test_bit(FLAG_EXPORT, &desc->flags)) {
David Brownelld8f388d2008-07-25 01:46:07 -0700998
999 dev = class_find_device(&gpio_class, NULL, desc, match_export);
1000 if (dev) {
Daniel Glöcknerff77c352009-09-22 16:46:38 -07001001 gpio_setup_irq(desc, dev, 0);
David Brownelld8f388d2008-07-25 01:46:07 -07001002 clear_bit(FLAG_EXPORT, &desc->flags);
David Brownelld8f388d2008-07-25 01:46:07 -07001003 } else
1004 status = -ENODEV;
1005 }
1006
1007 mutex_unlock(&sysfs_lock);
Alexandre Courbot372e7222013-02-03 01:29:29 +09001008
Ming Lei864533c2012-02-13 22:53:20 +08001009 if (dev) {
1010 device_unregister(dev);
1011 put_device(dev);
1012 }
Alexandre Courbotbcabdef2013-02-15 14:46:14 +09001013
David Brownelld8f388d2008-07-25 01:46:07 -07001014 if (status)
Andy Shevchenko7589e592013-12-05 11:26:23 +02001015 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
Alexandre Courbot372e7222013-02-03 01:29:29 +09001016}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001017EXPORT_SYMBOL_GPL(gpiod_unexport);
David Brownelld8f388d2008-07-25 01:46:07 -07001018
1019static int gpiochip_export(struct gpio_chip *chip)
1020{
1021 int status;
1022 struct device *dev;
1023
1024 /* Many systems register gpio chips for SOC support very early,
1025 * before driver model support is available. In those cases we
1026 * export this later, in gpiolib_sysfs_init() ... here we just
1027 * verify that _some_ field of gpio_class got initialized.
1028 */
1029 if (!gpio_class.p)
1030 return 0;
1031
1032 /* use chip->base for the ID; it's already known to be unique */
1033 mutex_lock(&sysfs_lock);
1034 dev = device_create(&gpio_class, chip->dev, MKDEV(0, 0), chip,
1035 "gpiochip%d", chip->base);
Sergei Shtylyovd62668e2009-11-11 14:26:50 -08001036 if (!IS_ERR(dev)) {
David Brownelld8f388d2008-07-25 01:46:07 -07001037 status = sysfs_create_group(&dev->kobj,
1038 &gpiochip_attr_group);
1039 } else
Sergei Shtylyovd62668e2009-11-11 14:26:50 -08001040 status = PTR_ERR(dev);
David Brownelld8f388d2008-07-25 01:46:07 -07001041 chip->exported = (status == 0);
1042 mutex_unlock(&sysfs_lock);
1043
1044 if (status) {
1045 unsigned long flags;
1046 unsigned gpio;
1047
1048 spin_lock_irqsave(&gpio_lock, flags);
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +09001049 gpio = 0;
1050 while (gpio < chip->ngpio)
1051 chip->desc[gpio++].chip = NULL;
David Brownelld8f388d2008-07-25 01:46:07 -07001052 spin_unlock_irqrestore(&gpio_lock, flags);
1053
Andy Shevchenko1a2a99c2013-12-05 11:26:24 +02001054 chip_dbg(chip, "%s: status %d\n", __func__, status);
David Brownelld8f388d2008-07-25 01:46:07 -07001055 }
1056
1057 return status;
1058}
1059
1060static void gpiochip_unexport(struct gpio_chip *chip)
1061{
1062 int status;
1063 struct device *dev;
1064
1065 mutex_lock(&sysfs_lock);
1066 dev = class_find_device(&gpio_class, NULL, chip, match_export);
1067 if (dev) {
1068 put_device(dev);
1069 device_unregister(dev);
Linus Walleij9fb1f392013-12-04 14:42:46 +01001070 chip->exported = false;
David Brownelld8f388d2008-07-25 01:46:07 -07001071 status = 0;
1072 } else
1073 status = -ENODEV;
1074 mutex_unlock(&sysfs_lock);
1075
1076 if (status)
Andy Shevchenko1a2a99c2013-12-05 11:26:24 +02001077 chip_dbg(chip, "%s: status %d\n", __func__, status);
David Brownelld8f388d2008-07-25 01:46:07 -07001078}
1079
1080static int __init gpiolib_sysfs_init(void)
1081{
1082 int status;
1083 unsigned long flags;
Alexandre Courbot65493e32013-02-03 01:29:25 +09001084 struct gpio_chip *chip;
David Brownelld8f388d2008-07-25 01:46:07 -07001085
1086 status = class_register(&gpio_class);
1087 if (status < 0)
1088 return status;
1089
1090 /* Scan and register the gpio_chips which registered very
1091 * early (e.g. before the class_register above was called).
1092 *
1093 * We run before arch_initcall() so chip->dev nodes can have
1094 * registered, and so arch_initcall() can always gpio_export().
1095 */
1096 spin_lock_irqsave(&gpio_lock, flags);
Alexandre Courbot65493e32013-02-03 01:29:25 +09001097 list_for_each_entry(chip, &gpio_chips, list) {
David Brownelld8f388d2008-07-25 01:46:07 -07001098 if (!chip || chip->exported)
1099 continue;
1100
1101 spin_unlock_irqrestore(&gpio_lock, flags);
1102 status = gpiochip_export(chip);
1103 spin_lock_irqsave(&gpio_lock, flags);
1104 }
1105 spin_unlock_irqrestore(&gpio_lock, flags);
1106
1107
1108 return status;
1109}
1110postcore_initcall(gpiolib_sysfs_init);
1111
1112#else
1113static inline int gpiochip_export(struct gpio_chip *chip)
1114{
1115 return 0;
1116}
1117
1118static inline void gpiochip_unexport(struct gpio_chip *chip)
1119{
1120}
1121
1122#endif /* CONFIG_GPIO_SYSFS */
1123
Alexandre Courbot1a989d02013-02-03 01:29:24 +09001124/*
1125 * Add a new chip to the global chips list, keeping the list of chips sorted
1126 * by base order.
1127 *
1128 * Return -EBUSY if the new chip overlaps with some other chip's integer
1129 * space.
1130 */
1131static int gpiochip_add_to_list(struct gpio_chip *chip)
1132{
1133 struct list_head *pos = &gpio_chips;
1134 struct gpio_chip *_chip;
1135 int err = 0;
1136
1137 /* find where to insert our chip */
1138 list_for_each(pos, &gpio_chips) {
1139 _chip = list_entry(pos, struct gpio_chip, list);
1140 /* shall we insert before _chip? */
1141 if (_chip->base >= chip->base + chip->ngpio)
1142 break;
1143 }
1144
1145 /* are we stepping on the chip right before? */
1146 if (pos != &gpio_chips && pos->prev != &gpio_chips) {
1147 _chip = list_entry(pos->prev, struct gpio_chip, list);
1148 if (_chip->base + _chip->ngpio > chip->base) {
1149 dev_err(chip->dev,
1150 "GPIO integer space overlap, cannot add chip\n");
1151 err = -EBUSY;
1152 }
1153 }
1154
1155 if (!err)
1156 list_add_tail(&chip->list, pos);
1157
1158 return err;
1159}
1160
Anton Vorontsov169b6a72008-04-28 02:14:47 -07001161/**
David Brownelld2876d02008-02-04 22:28:20 -08001162 * gpiochip_add() - register a gpio_chip
1163 * @chip: the chip to register, with chip->base initialized
1164 * Context: potentially before irqs or kmalloc will work
1165 *
1166 * Returns a negative errno if the chip can't be registered, such as
1167 * because the chip->base is invalid or already associated with a
1168 * different chip. Otherwise it returns zero as a success code.
Anton Vorontsov8d0aab22008-04-28 02:14:46 -07001169 *
David Brownelld8f388d2008-07-25 01:46:07 -07001170 * When gpiochip_add() is called very early during boot, so that GPIOs
1171 * can be freely used, the chip->dev device must be registered before
1172 * the gpio framework's arch_initcall(). Otherwise sysfs initialization
1173 * for GPIOs will fail rudely.
1174 *
Anton Vorontsov8d0aab22008-04-28 02:14:46 -07001175 * If chip->base is negative, this requests dynamic assignment of
1176 * a range of valid GPIOs.
David Brownelld2876d02008-02-04 22:28:20 -08001177 */
1178int gpiochip_add(struct gpio_chip *chip)
1179{
1180 unsigned long flags;
1181 int status = 0;
1182 unsigned id;
Anton Vorontsov8d0aab22008-04-28 02:14:46 -07001183 int base = chip->base;
David Brownelld2876d02008-02-04 22:28:20 -08001184
Trent Piephobff5fda2008-05-23 13:04:44 -07001185 if ((!gpio_is_valid(base) || !gpio_is_valid(base + chip->ngpio - 1))
Anton Vorontsov8d0aab22008-04-28 02:14:46 -07001186 && base >= 0) {
David Brownelld2876d02008-02-04 22:28:20 -08001187 status = -EINVAL;
1188 goto fail;
1189 }
1190
1191 spin_lock_irqsave(&gpio_lock, flags);
1192
Anton Vorontsov8d0aab22008-04-28 02:14:46 -07001193 if (base < 0) {
1194 base = gpiochip_find_base(chip->ngpio);
1195 if (base < 0) {
1196 status = base;
David Brownelld8f388d2008-07-25 01:46:07 -07001197 goto unlock;
Anton Vorontsov8d0aab22008-04-28 02:14:46 -07001198 }
1199 chip->base = base;
1200 }
1201
Alexandre Courbot1a989d02013-02-03 01:29:24 +09001202 status = gpiochip_add_to_list(chip);
1203
David Brownelld2876d02008-02-04 22:28:20 -08001204 if (status == 0) {
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +09001205 chip->desc = &gpio_desc[chip->base];
1206
1207 for (id = 0; id < chip->ngpio; id++) {
1208 struct gpio_desc *desc = &chip->desc[id];
1209 desc->chip = chip;
David Brownelld8f388d2008-07-25 01:46:07 -07001210
1211 /* REVISIT: most hardware initializes GPIOs as
1212 * inputs (often with pullups enabled) so power
1213 * usage is minimized. Linux code should set the
1214 * gpio direction first thing; but until it does,
Mathias Nyman80b0a602012-10-24 17:25:27 +03001215 * and in case chip->get_direction is not set,
David Brownelld8f388d2008-07-25 01:46:07 -07001216 * we may expose the wrong direction in sysfs.
1217 */
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +09001218 desc->flags = !chip->direction_input
David Brownelld8f388d2008-07-25 01:46:07 -07001219 ? (1 << FLAG_IS_OUT)
1220 : 0;
David Brownelld2876d02008-02-04 22:28:20 -08001221 }
1222 }
1223
Zhangfei Gao3bae4812013-06-09 11:08:32 +08001224 spin_unlock_irqrestore(&gpio_lock, flags);
1225
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301226#ifdef CONFIG_PINCTRL
1227 INIT_LIST_HEAD(&chip->pin_ranges);
1228#endif
1229
Anton Vorontsov391c9702010-06-08 07:48:17 -06001230 of_gpiochip_add(chip);
Mika Westerberg664e3e52014-01-08 12:40:54 +02001231 acpi_gpiochip_add(chip);
Anton Vorontsov391c9702010-06-08 07:48:17 -06001232
Anton Vorontsovcedb1882010-06-08 07:48:15 -06001233 if (status)
1234 goto fail;
1235
1236 status = gpiochip_export(chip);
1237 if (status)
1238 goto fail;
1239
Andy Shevchenko7589e592013-12-05 11:26:23 +02001240 pr_debug("%s: registered GPIOs %d to %d on device: %s\n", __func__,
Grant Likely64842aa2011-11-06 11:36:18 -07001241 chip->base, chip->base + chip->ngpio - 1,
1242 chip->label ? : "generic");
1243
Anton Vorontsovcedb1882010-06-08 07:48:15 -06001244 return 0;
Zhangfei Gao3bae4812013-06-09 11:08:32 +08001245
1246unlock:
1247 spin_unlock_irqrestore(&gpio_lock, flags);
David Brownelld2876d02008-02-04 22:28:20 -08001248fail:
1249 /* failures here can mean systems won't boot... */
Andy Shevchenko7589e592013-12-05 11:26:23 +02001250 pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
Anton Vorontsovcedb1882010-06-08 07:48:15 -06001251 chip->base, chip->base + chip->ngpio - 1,
1252 chip->label ? : "generic");
David Brownelld2876d02008-02-04 22:28:20 -08001253 return status;
1254}
1255EXPORT_SYMBOL_GPL(gpiochip_add);
1256
Linus Walleij14250522014-03-25 10:40:18 +01001257/* Forward-declaration */
1258static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip);
1259
David Brownelld2876d02008-02-04 22:28:20 -08001260/**
1261 * gpiochip_remove() - unregister a gpio_chip
1262 * @chip: the chip to unregister
1263 *
1264 * A gpio_chip with any GPIOs still requested may not be removed.
1265 */
1266int gpiochip_remove(struct gpio_chip *chip)
1267{
1268 unsigned long flags;
1269 int status = 0;
1270 unsigned id;
1271
Mika Westerberg6072b9d2014-03-10 14:54:53 +02001272 acpi_gpiochip_remove(chip);
1273
David Brownelld2876d02008-02-04 22:28:20 -08001274 spin_lock_irqsave(&gpio_lock, flags);
1275
Linus Walleij14250522014-03-25 10:40:18 +01001276 gpiochip_irqchip_remove(chip);
Linus Walleij9ef0d6f2012-11-06 15:15:44 +01001277 gpiochip_remove_pin_ranges(chip);
Anton Vorontsov391c9702010-06-08 07:48:17 -06001278 of_gpiochip_remove(chip);
1279
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +09001280 for (id = 0; id < chip->ngpio; id++) {
1281 if (test_bit(FLAG_REQUESTED, &chip->desc[id].flags)) {
David Brownelld2876d02008-02-04 22:28:20 -08001282 status = -EBUSY;
1283 break;
1284 }
1285 }
1286 if (status == 0) {
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +09001287 for (id = 0; id < chip->ngpio; id++)
1288 chip->desc[id].chip = NULL;
Alexandre Courbot1a989d02013-02-03 01:29:24 +09001289
1290 list_del(&chip->list);
David Brownelld2876d02008-02-04 22:28:20 -08001291 }
1292
1293 spin_unlock_irqrestore(&gpio_lock, flags);
David Brownelld8f388d2008-07-25 01:46:07 -07001294
1295 if (status == 0)
1296 gpiochip_unexport(chip);
1297
David Brownelld2876d02008-02-04 22:28:20 -08001298 return status;
1299}
1300EXPORT_SYMBOL_GPL(gpiochip_remove);
1301
Grant Likely594fa262010-06-08 07:48:16 -06001302/**
1303 * gpiochip_find() - iterator for locating a specific gpio_chip
1304 * @data: data to pass to match function
1305 * @callback: Callback function to check gpio_chip
1306 *
1307 * Similar to bus_find_device. It returns a reference to a gpio_chip as
1308 * determined by a user supplied @match callback. The callback should return
1309 * 0 if the device doesn't match and non-zero if it does. If the callback is
1310 * non-zero, this function will return to the caller and not iterate over any
1311 * more gpio_chips.
1312 */
Grant Likely07ce8ec2012-05-18 23:01:05 -06001313struct gpio_chip *gpiochip_find(void *data,
Grant Likely6e2cf652012-03-02 15:56:03 -07001314 int (*match)(struct gpio_chip *chip,
Grant Likely3d0f7cf2012-05-17 13:54:40 -06001315 void *data))
Grant Likely594fa262010-06-08 07:48:16 -06001316{
Alexandre Courbot125eef92013-02-03 01:29:26 +09001317 struct gpio_chip *chip;
Grant Likely594fa262010-06-08 07:48:16 -06001318 unsigned long flags;
Grant Likely594fa262010-06-08 07:48:16 -06001319
1320 spin_lock_irqsave(&gpio_lock, flags);
Alexandre Courbot125eef92013-02-03 01:29:26 +09001321 list_for_each_entry(chip, &gpio_chips, list)
1322 if (match(chip, data))
Grant Likely594fa262010-06-08 07:48:16 -06001323 break;
Alexandre Courbot125eef92013-02-03 01:29:26 +09001324
1325 /* No match? */
1326 if (&chip->list == &gpio_chips)
1327 chip = NULL;
Grant Likely594fa262010-06-08 07:48:16 -06001328 spin_unlock_irqrestore(&gpio_lock, flags);
1329
1330 return chip;
1331}
Jean Delvare8fa0c9b2011-05-20 00:40:18 -06001332EXPORT_SYMBOL_GPL(gpiochip_find);
David Brownelld2876d02008-02-04 22:28:20 -08001333
Alexandre Courbot79697ef2013-11-16 21:39:32 +09001334static int gpiochip_match_name(struct gpio_chip *chip, void *data)
1335{
1336 const char *name = data;
1337
1338 return !strcmp(chip->label, name);
1339}
1340
1341static struct gpio_chip *find_chip_by_name(const char *name)
1342{
1343 return gpiochip_find((void *)name, gpiochip_match_name);
1344}
1345
Linus Walleij14250522014-03-25 10:40:18 +01001346#ifdef CONFIG_GPIOLIB_IRQCHIP
1347
1348/*
1349 * The following is irqchip helper code for gpiochips.
1350 */
1351
1352/**
1353 * gpiochip_add_chained_irqchip() - adds a chained irqchip to a gpiochip
1354 * @gpiochip: the gpiochip to add the irqchip to
1355 * @irqchip: the irqchip to add to the gpiochip
1356 * @parent_irq: the irq number corresponding to the parent IRQ for this
1357 * chained irqchip
1358 * @parent_handler: the parent interrupt handler for the accumulated IRQ
1359 * coming out of the gpiochip
1360 */
1361void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
1362 struct irq_chip *irqchip,
1363 int parent_irq,
1364 irq_flow_handler_t parent_handler)
1365{
Linus Walleij1c8732b2014-04-09 13:34:39 +02001366 if (gpiochip->can_sleep) {
1367 chip_err(gpiochip, "you cannot have chained interrupts on a chip that may sleep\n");
1368 return;
1369 }
1370
Linus Walleij14250522014-03-25 10:40:18 +01001371 irq_set_chained_handler(parent_irq, parent_handler);
1372 /*
1373 * The parent irqchip is already using the chip_data for this
1374 * irqchip, so our callbacks simply use the handler_data.
1375 */
1376 irq_set_handler_data(parent_irq, gpiochip);
1377}
1378EXPORT_SYMBOL_GPL(gpiochip_set_chained_irqchip);
1379
Linus Walleije45d1c82014-04-22 14:01:46 +02001380/*
1381 * This lock class tells lockdep that GPIO irqs are in a different
1382 * category than their parents, so it won't report false recursion.
1383 */
1384static struct lock_class_key gpiochip_irq_lock_class;
1385
Linus Walleij14250522014-03-25 10:40:18 +01001386/**
1387 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
1388 * @d: the irqdomain used by this irqchip
1389 * @irq: the global irq number used by this GPIO irqchip irq
1390 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
1391 *
1392 * This function will set up the mapping for a certain IRQ line on a
1393 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
1394 * stored inside the gpiochip.
1395 */
1396static int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
1397 irq_hw_number_t hwirq)
1398{
1399 struct gpio_chip *chip = d->host_data;
1400
Linus Walleij14250522014-03-25 10:40:18 +01001401 irq_set_chip_data(irq, chip);
Linus Walleije45d1c82014-04-22 14:01:46 +02001402 irq_set_lockdep_class(irq, &gpiochip_irq_lock_class);
Linus Walleij7633fb92014-04-09 13:20:38 +02001403 irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler);
Linus Walleij1c8732b2014-04-09 13:34:39 +02001404 /* Chips that can sleep need nested thread handlers */
1405 if (chip->can_sleep)
1406 irq_set_nested_thread(irq, 1);
Linus Walleij14250522014-03-25 10:40:18 +01001407#ifdef CONFIG_ARM
1408 set_irq_flags(irq, IRQF_VALID);
1409#else
1410 irq_set_noprobe(irq);
1411#endif
Linus Walleij1333b902014-04-23 16:45:12 +02001412 /*
1413 * No set-up of the hardware will happen if IRQ_TYPE_NONE
1414 * is passed as default type.
1415 */
1416 if (chip->irq_default_type != IRQ_TYPE_NONE)
1417 irq_set_irq_type(irq, chip->irq_default_type);
Linus Walleij14250522014-03-25 10:40:18 +01001418
1419 return 0;
1420}
1421
Linus Walleijc3626fd2014-03-28 20:42:01 +01001422static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
1423{
Linus Walleij1c8732b2014-04-09 13:34:39 +02001424 struct gpio_chip *chip = d->host_data;
1425
Linus Walleijc3626fd2014-03-28 20:42:01 +01001426#ifdef CONFIG_ARM
1427 set_irq_flags(irq, 0);
1428#endif
Linus Walleij1c8732b2014-04-09 13:34:39 +02001429 if (chip->can_sleep)
1430 irq_set_nested_thread(irq, 0);
Linus Walleijc3626fd2014-03-28 20:42:01 +01001431 irq_set_chip_and_handler(irq, NULL, NULL);
1432 irq_set_chip_data(irq, NULL);
1433}
1434
Linus Walleij14250522014-03-25 10:40:18 +01001435static const struct irq_domain_ops gpiochip_domain_ops = {
1436 .map = gpiochip_irq_map,
Linus Walleijc3626fd2014-03-28 20:42:01 +01001437 .unmap = gpiochip_irq_unmap,
Linus Walleij14250522014-03-25 10:40:18 +01001438 /* Virtually all GPIO irqchips are twocell:ed */
1439 .xlate = irq_domain_xlate_twocell,
1440};
1441
1442static int gpiochip_irq_reqres(struct irq_data *d)
1443{
1444 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
1445
1446 if (gpio_lock_as_irq(chip, d->hwirq)) {
1447 chip_err(chip,
1448 "unable to lock HW IRQ %lu for IRQ\n",
1449 d->hwirq);
1450 return -EINVAL;
1451 }
1452 return 0;
1453}
1454
1455static void gpiochip_irq_relres(struct irq_data *d)
1456{
1457 struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
1458
1459 gpio_unlock_as_irq(chip, d->hwirq);
1460}
1461
1462static int gpiochip_to_irq(struct gpio_chip *chip, unsigned offset)
1463{
1464 return irq_find_mapping(chip->irqdomain, offset);
1465}
1466
1467/**
1468 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
1469 * @gpiochip: the gpiochip to remove the irqchip from
1470 *
1471 * This is called only from gpiochip_remove()
1472 */
1473static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip)
1474{
Linus Walleijc3626fd2014-03-28 20:42:01 +01001475 unsigned int offset;
1476
1477 /* Remove all IRQ mappings and delete the domain */
1478 if (gpiochip->irqdomain) {
1479 for (offset = 0; offset < gpiochip->ngpio; offset++)
1480 irq_dispose_mapping(gpiochip->irq_base + offset);
Linus Walleij14250522014-03-25 10:40:18 +01001481 irq_domain_remove(gpiochip->irqdomain);
Linus Walleijc3626fd2014-03-28 20:42:01 +01001482 }
Linus Walleij14250522014-03-25 10:40:18 +01001483
1484 if (gpiochip->irqchip) {
1485 gpiochip->irqchip->irq_request_resources = NULL;
1486 gpiochip->irqchip->irq_release_resources = NULL;
1487 gpiochip->irqchip = NULL;
1488 }
1489}
1490
1491/**
1492 * gpiochip_irqchip_add() - adds an irqchip to a gpiochip
1493 * @gpiochip: the gpiochip to add the irqchip to
1494 * @irqchip: the irqchip to add to the gpiochip
1495 * @first_irq: if not dynamically assigned, the base (first) IRQ to
1496 * allocate gpiochip irqs from
1497 * @handler: the irq handler to use (often a predefined irq core function)
Linus Walleij1333b902014-04-23 16:45:12 +02001498 * @type: the default type for IRQs on this irqchip, pass IRQ_TYPE_NONE
1499 * to have the core avoid setting up any default type in the hardware.
Linus Walleij14250522014-03-25 10:40:18 +01001500 *
1501 * This function closely associates a certain irqchip with a certain
1502 * gpiochip, providing an irq domain to translate the local IRQs to
1503 * global irqs in the gpiolib core, and making sure that the gpiochip
1504 * is passed as chip data to all related functions. Driver callbacks
1505 * need to use container_of() to get their local state containers back
1506 * from the gpiochip passed as chip data. An irqdomain will be stored
1507 * in the gpiochip that shall be used by the driver to handle IRQ number
1508 * translation. The gpiochip will need to be initialized and registered
1509 * before calling this function.
1510 *
Linus Walleijc3626fd2014-03-28 20:42:01 +01001511 * This function will handle two cell:ed simple IRQs and assumes all
1512 * the pins on the gpiochip can generate a unique IRQ. Everything else
Linus Walleij14250522014-03-25 10:40:18 +01001513 * need to be open coded.
1514 */
1515int gpiochip_irqchip_add(struct gpio_chip *gpiochip,
1516 struct irq_chip *irqchip,
1517 unsigned int first_irq,
1518 irq_flow_handler_t handler,
1519 unsigned int type)
1520{
1521 struct device_node *of_node;
1522 unsigned int offset;
Linus Walleijc3626fd2014-03-28 20:42:01 +01001523 unsigned irq_base = 0;
Linus Walleij14250522014-03-25 10:40:18 +01001524
1525 if (!gpiochip || !irqchip)
1526 return -EINVAL;
1527
1528 if (!gpiochip->dev) {
1529 pr_err("missing gpiochip .dev parent pointer\n");
1530 return -EINVAL;
1531 }
1532 of_node = gpiochip->dev->of_node;
1533#ifdef CONFIG_OF_GPIO
1534 /*
1535 * If the gpiochip has an assigned OF node this takes precendence
1536 * FIXME: get rid of this and use gpiochip->dev->of_node everywhere
1537 */
1538 if (gpiochip->of_node)
1539 of_node = gpiochip->of_node;
1540#endif
1541 gpiochip->irqchip = irqchip;
1542 gpiochip->irq_handler = handler;
1543 gpiochip->irq_default_type = type;
1544 gpiochip->to_irq = gpiochip_to_irq;
1545 gpiochip->irqdomain = irq_domain_add_simple(of_node,
1546 gpiochip->ngpio, first_irq,
1547 &gpiochip_domain_ops, gpiochip);
1548 if (!gpiochip->irqdomain) {
1549 gpiochip->irqchip = NULL;
1550 return -EINVAL;
1551 }
1552 irqchip->irq_request_resources = gpiochip_irq_reqres;
1553 irqchip->irq_release_resources = gpiochip_irq_relres;
1554
1555 /*
1556 * Prepare the mapping since the irqchip shall be orthogonal to
1557 * any gpiochip calls. If the first_irq was zero, this is
1558 * necessary to allocate descriptors for all IRQs.
1559 */
Linus Walleijc3626fd2014-03-28 20:42:01 +01001560 for (offset = 0; offset < gpiochip->ngpio; offset++) {
1561 irq_base = irq_create_mapping(gpiochip->irqdomain, offset);
1562 if (offset == 0)
1563 /*
1564 * Store the base into the gpiochip to be used when
1565 * unmapping the irqs.
1566 */
1567 gpiochip->irq_base = irq_base;
1568 }
Linus Walleij14250522014-03-25 10:40:18 +01001569
1570 return 0;
1571}
1572EXPORT_SYMBOL_GPL(gpiochip_irqchip_add);
1573
1574#else /* CONFIG_GPIOLIB_IRQCHIP */
1575
1576static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {}
1577
1578#endif /* CONFIG_GPIOLIB_IRQCHIP */
1579
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301580#ifdef CONFIG_PINCTRL
Linus Walleij165adc92012-11-06 14:49:39 +01001581
Linus Walleij3f0f8672012-11-20 12:40:15 +01001582/**
Christian Ruppert586a87e2013-10-15 15:37:54 +02001583 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
1584 * @chip: the gpiochip to add the range for
1585 * @pinctrl: the dev_name() of the pin controller to map to
1586 * @gpio_offset: the start offset in the current gpio_chip number space
1587 * @pin_group: name of the pin group inside the pin controller
1588 */
1589int gpiochip_add_pingroup_range(struct gpio_chip *chip,
1590 struct pinctrl_dev *pctldev,
1591 unsigned int gpio_offset, const char *pin_group)
1592{
1593 struct gpio_pin_range *pin_range;
1594 int ret;
1595
1596 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1597 if (!pin_range) {
Andy Shevchenko1a2a99c2013-12-05 11:26:24 +02001598 chip_err(chip, "failed to allocate pin ranges\n");
Christian Ruppert586a87e2013-10-15 15:37:54 +02001599 return -ENOMEM;
1600 }
1601
1602 /* Use local offset as range ID */
1603 pin_range->range.id = gpio_offset;
1604 pin_range->range.gc = chip;
1605 pin_range->range.name = chip->label;
1606 pin_range->range.base = chip->base + gpio_offset;
1607 pin_range->pctldev = pctldev;
1608
1609 ret = pinctrl_get_group_pins(pctldev, pin_group,
1610 &pin_range->range.pins,
1611 &pin_range->range.npins);
Michal Nazarewicz61c63752013-11-13 21:20:39 +01001612 if (ret < 0) {
1613 kfree(pin_range);
Christian Ruppert586a87e2013-10-15 15:37:54 +02001614 return ret;
Michal Nazarewicz61c63752013-11-13 21:20:39 +01001615 }
Christian Ruppert586a87e2013-10-15 15:37:54 +02001616
1617 pinctrl_add_gpio_range(pctldev, &pin_range->range);
1618
Andy Shevchenko1a2a99c2013-12-05 11:26:24 +02001619 chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
1620 gpio_offset, gpio_offset + pin_range->range.npins - 1,
Christian Ruppert586a87e2013-10-15 15:37:54 +02001621 pinctrl_dev_get_devname(pctldev), pin_group);
1622
1623 list_add_tail(&pin_range->node, &chip->pin_ranges);
1624
1625 return 0;
1626}
1627EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);
1628
1629/**
Linus Walleij3f0f8672012-11-20 12:40:15 +01001630 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
1631 * @chip: the gpiochip to add the range for
1632 * @pinctrl_name: the dev_name() of the pin controller to map to
Linus Walleij316511c2012-11-21 08:48:09 +01001633 * @gpio_offset: the start offset in the current gpio_chip number space
1634 * @pin_offset: the start offset in the pin controller number space
Linus Walleij3f0f8672012-11-20 12:40:15 +01001635 * @npins: the number of pins from the offset of each pin space (GPIO and
1636 * pin controller) to accumulate in this range
1637 */
Linus Walleij1e63d7b2012-11-06 16:03:35 +01001638int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
Linus Walleij316511c2012-11-21 08:48:09 +01001639 unsigned int gpio_offset, unsigned int pin_offset,
Linus Walleij3f0f8672012-11-20 12:40:15 +01001640 unsigned int npins)
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301641{
1642 struct gpio_pin_range *pin_range;
Axel Linb4d4b1f2012-11-21 14:33:56 +08001643 int ret;
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301644
Linus Walleij3f0f8672012-11-20 12:40:15 +01001645 pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301646 if (!pin_range) {
Andy Shevchenko1a2a99c2013-12-05 11:26:24 +02001647 chip_err(chip, "failed to allocate pin ranges\n");
Linus Walleij1e63d7b2012-11-06 16:03:35 +01001648 return -ENOMEM;
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301649 }
1650
Linus Walleij3f0f8672012-11-20 12:40:15 +01001651 /* Use local offset as range ID */
Linus Walleij316511c2012-11-21 08:48:09 +01001652 pin_range->range.id = gpio_offset;
Linus Walleij3f0f8672012-11-20 12:40:15 +01001653 pin_range->range.gc = chip;
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301654 pin_range->range.name = chip->label;
Linus Walleij316511c2012-11-21 08:48:09 +01001655 pin_range->range.base = chip->base + gpio_offset;
1656 pin_range->range.pin_base = pin_offset;
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301657 pin_range->range.npins = npins;
Linus Walleij192c3692012-11-20 14:03:37 +01001658 pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301659 &pin_range->range);
Linus Walleij8f23ca12012-11-20 14:56:25 +01001660 if (IS_ERR(pin_range->pctldev)) {
Axel Linb4d4b1f2012-11-21 14:33:56 +08001661 ret = PTR_ERR(pin_range->pctldev);
Andy Shevchenko1a2a99c2013-12-05 11:26:24 +02001662 chip_err(chip, "could not create pin range\n");
Linus Walleij3f0f8672012-11-20 12:40:15 +01001663 kfree(pin_range);
Axel Linb4d4b1f2012-11-21 14:33:56 +08001664 return ret;
Linus Walleij3f0f8672012-11-20 12:40:15 +01001665 }
Andy Shevchenko1a2a99c2013-12-05 11:26:24 +02001666 chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
1667 gpio_offset, gpio_offset + npins - 1,
Linus Walleij316511c2012-11-21 08:48:09 +01001668 pinctl_name,
1669 pin_offset, pin_offset + npins - 1);
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301670
1671 list_add_tail(&pin_range->node, &chip->pin_ranges);
Linus Walleij1e63d7b2012-11-06 16:03:35 +01001672
1673 return 0;
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301674}
Linus Walleij165adc92012-11-06 14:49:39 +01001675EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301676
Linus Walleij3f0f8672012-11-20 12:40:15 +01001677/**
1678 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
1679 * @chip: the chip to remove all the mappings for
1680 */
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301681void gpiochip_remove_pin_ranges(struct gpio_chip *chip)
1682{
1683 struct gpio_pin_range *pin_range, *tmp;
1684
1685 list_for_each_entry_safe(pin_range, tmp, &chip->pin_ranges, node) {
1686 list_del(&pin_range->node);
1687 pinctrl_remove_gpio_range(pin_range->pctldev,
1688 &pin_range->range);
Linus Walleij3f0f8672012-11-20 12:40:15 +01001689 kfree(pin_range);
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301690 }
1691}
Linus Walleij165adc92012-11-06 14:49:39 +01001692EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);
1693
1694#endif /* CONFIG_PINCTRL */
Shiraz Hashimf23f1512012-10-27 15:21:36 +05301695
David Brownelld2876d02008-02-04 22:28:20 -08001696/* These "optional" allocation calls help prevent drivers from stomping
1697 * on each other, and help provide better diagnostics in debugfs.
1698 * They're called even less than the "set direction" calls.
1699 */
Mika Westerberg77c2d792014-03-10 14:54:50 +02001700static int __gpiod_request(struct gpio_desc *desc, const char *label)
David Brownelld2876d02008-02-04 22:28:20 -08001701{
Mika Westerberg77c2d792014-03-10 14:54:50 +02001702 struct gpio_chip *chip = desc->chip;
1703 int status;
David Brownelld2876d02008-02-04 22:28:20 -08001704 unsigned long flags;
1705
1706 spin_lock_irqsave(&gpio_lock, flags);
1707
David Brownelld2876d02008-02-04 22:28:20 -08001708 /* NOTE: gpio_request() can be called in early boot,
David Brownell35e8bb52008-10-15 22:03:16 -07001709 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
David Brownelld2876d02008-02-04 22:28:20 -08001710 */
1711
1712 if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
1713 desc_set_label(desc, label ? : "?");
1714 status = 0;
Guennadi Liakhovetski438d8902008-04-28 02:14:44 -07001715 } else {
David Brownelld2876d02008-02-04 22:28:20 -08001716 status = -EBUSY;
Magnus Damm7460db52009-01-29 14:25:12 -08001717 goto done;
David Brownell35e8bb52008-10-15 22:03:16 -07001718 }
1719
1720 if (chip->request) {
1721 /* chip->request may sleep */
1722 spin_unlock_irqrestore(&gpio_lock, flags);
Alexandre Courbot372e7222013-02-03 01:29:29 +09001723 status = chip->request(chip, gpio_chip_hwgpio(desc));
David Brownell35e8bb52008-10-15 22:03:16 -07001724 spin_lock_irqsave(&gpio_lock, flags);
1725
1726 if (status < 0) {
1727 desc_set_label(desc, NULL);
David Brownell35e8bb52008-10-15 22:03:16 -07001728 clear_bit(FLAG_REQUESTED, &desc->flags);
Mathias Nyman80b0a602012-10-24 17:25:27 +03001729 goto done;
David Brownell35e8bb52008-10-15 22:03:16 -07001730 }
Guennadi Liakhovetski438d8902008-04-28 02:14:44 -07001731 }
Mathias Nyman80b0a602012-10-24 17:25:27 +03001732 if (chip->get_direction) {
1733 /* chip->get_direction may sleep */
1734 spin_unlock_irqrestore(&gpio_lock, flags);
Alexandre Courbot372e7222013-02-03 01:29:29 +09001735 gpiod_get_direction(desc);
Mathias Nyman80b0a602012-10-24 17:25:27 +03001736 spin_lock_irqsave(&gpio_lock, flags);
1737 }
David Brownelld2876d02008-02-04 22:28:20 -08001738done:
Mika Westerberg77c2d792014-03-10 14:54:50 +02001739 spin_unlock_irqrestore(&gpio_lock, flags);
1740 return status;
1741}
1742
1743static int gpiod_request(struct gpio_desc *desc, const char *label)
1744{
1745 int status = -EPROBE_DEFER;
1746 struct gpio_chip *chip;
1747
1748 if (!desc) {
1749 pr_warn("%s: invalid GPIO\n", __func__);
1750 return -EINVAL;
1751 }
1752
1753 chip = desc->chip;
1754 if (!chip)
1755 goto done;
1756
1757 if (try_module_get(chip->owner)) {
1758 status = __gpiod_request(desc, label);
1759 if (status < 0)
1760 module_put(chip->owner);
1761 }
1762
1763done:
David Brownelld2876d02008-02-04 22:28:20 -08001764 if (status)
Andy Shevchenko7589e592013-12-05 11:26:23 +02001765 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
Mika Westerberg77c2d792014-03-10 14:54:50 +02001766
David Brownelld2876d02008-02-04 22:28:20 -08001767 return status;
1768}
Alexandre Courbot372e7222013-02-03 01:29:29 +09001769
1770int gpio_request(unsigned gpio, const char *label)
1771{
1772 return gpiod_request(gpio_to_desc(gpio), label);
1773}
David Brownelld2876d02008-02-04 22:28:20 -08001774EXPORT_SYMBOL_GPL(gpio_request);
1775
Mika Westerberg77c2d792014-03-10 14:54:50 +02001776static bool __gpiod_free(struct gpio_desc *desc)
David Brownelld2876d02008-02-04 22:28:20 -08001777{
Mika Westerberg77c2d792014-03-10 14:54:50 +02001778 bool ret = false;
David Brownelld2876d02008-02-04 22:28:20 -08001779 unsigned long flags;
David Brownell35e8bb52008-10-15 22:03:16 -07001780 struct gpio_chip *chip;
David Brownelld2876d02008-02-04 22:28:20 -08001781
Uwe Kleine-König3d599d12008-10-15 22:03:12 -07001782 might_sleep();
1783
Alexandre Courbot372e7222013-02-03 01:29:29 +09001784 gpiod_unexport(desc);
David Brownelld8f388d2008-07-25 01:46:07 -07001785
David Brownelld2876d02008-02-04 22:28:20 -08001786 spin_lock_irqsave(&gpio_lock, flags);
1787
David Brownell35e8bb52008-10-15 22:03:16 -07001788 chip = desc->chip;
1789 if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
1790 if (chip->free) {
1791 spin_unlock_irqrestore(&gpio_lock, flags);
David Brownell9c4ba942010-08-10 18:02:24 -07001792 might_sleep_if(chip->can_sleep);
Alexandre Courbot372e7222013-02-03 01:29:29 +09001793 chip->free(chip, gpio_chip_hwgpio(desc));
David Brownell35e8bb52008-10-15 22:03:16 -07001794 spin_lock_irqsave(&gpio_lock, flags);
1795 }
David Brownelld2876d02008-02-04 22:28:20 -08001796 desc_set_label(desc, NULL);
Jani Nikula07697462009-12-15 16:46:20 -08001797 clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
David Brownell35e8bb52008-10-15 22:03:16 -07001798 clear_bit(FLAG_REQUESTED, &desc->flags);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301799 clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05301800 clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
Mika Westerberg77c2d792014-03-10 14:54:50 +02001801 ret = true;
1802 }
David Brownelld2876d02008-02-04 22:28:20 -08001803
1804 spin_unlock_irqrestore(&gpio_lock, flags);
Mika Westerberg77c2d792014-03-10 14:54:50 +02001805 return ret;
1806}
1807
1808static void gpiod_free(struct gpio_desc *desc)
1809{
1810 if (desc && __gpiod_free(desc))
1811 module_put(desc->chip->owner);
1812 else
1813 WARN_ON(extra_checks);
David Brownelld2876d02008-02-04 22:28:20 -08001814}
Alexandre Courbot372e7222013-02-03 01:29:29 +09001815
1816void gpio_free(unsigned gpio)
1817{
1818 gpiod_free(gpio_to_desc(gpio));
1819}
David Brownelld2876d02008-02-04 22:28:20 -08001820EXPORT_SYMBOL_GPL(gpio_free);
1821
Eric Miao3e45f1d2010-03-05 13:44:35 -08001822/**
1823 * gpio_request_one - request a single GPIO with initial configuration
1824 * @gpio: the GPIO number
1825 * @flags: GPIO configuration as specified by GPIOF_*
1826 * @label: a literal description string of this GPIO
1827 */
1828int gpio_request_one(unsigned gpio, unsigned long flags, const char *label)
1829{
Alexandre Courbot372e7222013-02-03 01:29:29 +09001830 struct gpio_desc *desc;
Eric Miao3e45f1d2010-03-05 13:44:35 -08001831 int err;
1832
Alexandre Courbot372e7222013-02-03 01:29:29 +09001833 desc = gpio_to_desc(gpio);
1834
1835 err = gpiod_request(desc, label);
Eric Miao3e45f1d2010-03-05 13:44:35 -08001836 if (err)
1837 return err;
1838
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301839 if (flags & GPIOF_OPEN_DRAIN)
Alexandre Courbot372e7222013-02-03 01:29:29 +09001840 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05301841
Laxman Dewangan25553ff2012-02-17 20:26:22 +05301842 if (flags & GPIOF_OPEN_SOURCE)
Alexandre Courbot372e7222013-02-03 01:29:29 +09001843 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05301844
Eric Miao3e45f1d2010-03-05 13:44:35 -08001845 if (flags & GPIOF_DIR_IN)
Alexandre Courbot372e7222013-02-03 01:29:29 +09001846 err = gpiod_direction_input(desc);
Eric Miao3e45f1d2010-03-05 13:44:35 -08001847 else
Philipp Zabelef70bbe2014-01-07 12:34:11 +01001848 err = gpiod_direction_output_raw(desc,
Eric Miao3e45f1d2010-03-05 13:44:35 -08001849 (flags & GPIOF_INIT_HIGH) ? 1 : 0);
1850
Aaro Koskinene2548112010-12-21 17:24:22 -08001851 if (err)
Wolfram Sangfc3a1f02011-12-13 18:34:01 +01001852 goto free_gpio;
Aaro Koskinene2548112010-12-21 17:24:22 -08001853
Wolfram Sangfc3a1f02011-12-13 18:34:01 +01001854 if (flags & GPIOF_EXPORT) {
Alexandre Courbot372e7222013-02-03 01:29:29 +09001855 err = gpiod_export(desc, flags & GPIOF_EXPORT_CHANGEABLE);
Wolfram Sangfc3a1f02011-12-13 18:34:01 +01001856 if (err)
1857 goto free_gpio;
1858 }
1859
1860 return 0;
1861
1862 free_gpio:
Alexandre Courbot372e7222013-02-03 01:29:29 +09001863 gpiod_free(desc);
Eric Miao3e45f1d2010-03-05 13:44:35 -08001864 return err;
1865}
1866EXPORT_SYMBOL_GPL(gpio_request_one);
1867
1868/**
1869 * gpio_request_array - request multiple GPIOs in a single call
1870 * @array: array of the 'struct gpio'
1871 * @num: how many GPIOs in the array
1872 */
Lars-Peter Clausen7c295972011-05-25 16:20:31 -07001873int gpio_request_array(const struct gpio *array, size_t num)
Eric Miao3e45f1d2010-03-05 13:44:35 -08001874{
1875 int i, err;
1876
1877 for (i = 0; i < num; i++, array++) {
1878 err = gpio_request_one(array->gpio, array->flags, array->label);
1879 if (err)
1880 goto err_free;
1881 }
1882 return 0;
1883
1884err_free:
1885 while (i--)
1886 gpio_free((--array)->gpio);
1887 return err;
1888}
1889EXPORT_SYMBOL_GPL(gpio_request_array);
1890
1891/**
1892 * gpio_free_array - release multiple GPIOs in a single call
1893 * @array: array of the 'struct gpio'
1894 * @num: how many GPIOs in the array
1895 */
Lars-Peter Clausen7c295972011-05-25 16:20:31 -07001896void gpio_free_array(const struct gpio *array, size_t num)
Eric Miao3e45f1d2010-03-05 13:44:35 -08001897{
1898 while (num--)
1899 gpio_free((array++)->gpio);
1900}
1901EXPORT_SYMBOL_GPL(gpio_free_array);
David Brownelld2876d02008-02-04 22:28:20 -08001902
1903/**
1904 * gpiochip_is_requested - return string iff signal was requested
1905 * @chip: controller managing the signal
1906 * @offset: of signal within controller's 0..(ngpio - 1) range
1907 *
1908 * Returns NULL if the GPIO is not currently requested, else a string.
1909 * If debugfs support is enabled, the string returned is the label passed
1910 * to gpio_request(); otherwise it is a meaningless constant.
1911 *
1912 * This function is for use by GPIO controller drivers. The label can
1913 * help with diagnostics, and knowing that the signal is used as a GPIO
1914 * can help avoid accidentally multiplexing it to another controller.
1915 */
1916const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset)
1917{
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +09001918 struct gpio_desc *desc;
David Brownelld2876d02008-02-04 22:28:20 -08001919
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +09001920 if (!GPIO_OFFSET_VALID(chip, offset))
David Brownelld2876d02008-02-04 22:28:20 -08001921 return NULL;
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +09001922
1923 desc = &chip->desc[offset];
1924
Alexandre Courbot372e7222013-02-03 01:29:29 +09001925 if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
David Brownelld2876d02008-02-04 22:28:20 -08001926 return NULL;
1927#ifdef CONFIG_DEBUG_FS
Alexandre Courbot372e7222013-02-03 01:29:29 +09001928 return desc->label;
David Brownelld2876d02008-02-04 22:28:20 -08001929#else
1930 return "?";
1931#endif
1932}
1933EXPORT_SYMBOL_GPL(gpiochip_is_requested);
1934
Mika Westerberg77c2d792014-03-10 14:54:50 +02001935/**
1936 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
1937 * @desc: GPIO descriptor to request
1938 * @label: label for the GPIO
1939 *
1940 * Function allows GPIO chip drivers to request and use their own GPIO
1941 * descriptors via gpiolib API. Difference to gpiod_request() is that this
1942 * function will not increase reference count of the GPIO chip module. This
1943 * allows the GPIO chip module to be unloaded as needed (we assume that the
1944 * GPIO chip driver handles freeing the GPIOs it has requested).
1945 */
1946int gpiochip_request_own_desc(struct gpio_desc *desc, const char *label)
1947{
1948 if (!desc || !desc->chip)
1949 return -EINVAL;
1950
1951 return __gpiod_request(desc, label);
1952}
1953
1954/**
1955 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
1956 * @desc: GPIO descriptor to free
1957 *
1958 * Function frees the given GPIO requested previously with
1959 * gpiochip_request_own_desc().
1960 */
1961void gpiochip_free_own_desc(struct gpio_desc *desc)
1962{
1963 if (desc)
1964 __gpiod_free(desc);
1965}
David Brownelld2876d02008-02-04 22:28:20 -08001966
1967/* Drivers MUST set GPIO direction before making get/set calls. In
1968 * some cases this is done in early boot, before IRQs are enabled.
1969 *
1970 * As a rule these aren't called more than once (except for drivers
1971 * using the open-drain emulation idiom) so these are natural places
1972 * to accumulate extra debugging checks. Note that we can't (yet)
1973 * rely on gpio_request() having been called beforehand.
1974 */
1975
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07001976/**
1977 * gpiod_direction_input - set the GPIO direction to input
1978 * @desc: GPIO to set to input
1979 *
1980 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
1981 * be called safely on it.
1982 *
1983 * Return 0 in case of success, else an error code.
1984 */
1985int gpiod_direction_input(struct gpio_desc *desc)
David Brownelld2876d02008-02-04 22:28:20 -08001986{
1987 unsigned long flags;
1988 struct gpio_chip *chip;
David Brownelld2876d02008-02-04 22:28:20 -08001989 int status = -EINVAL;
Alexandre Courbot372e7222013-02-03 01:29:29 +09001990 int offset;
David Brownelld2876d02008-02-04 22:28:20 -08001991
Linus Walleijbe1a4b12013-08-30 09:41:45 +02001992 if (!desc || !desc->chip) {
Alexandre Courbotbcabdef2013-02-15 14:46:14 +09001993 pr_warn("%s: invalid GPIO\n", __func__);
1994 return -EINVAL;
1995 }
1996
Linus Walleijbe1a4b12013-08-30 09:41:45 +02001997 chip = desc->chip;
1998 if (!chip->get || !chip->direction_input) {
Mark Brown6424de52013-09-09 10:33:49 +01001999 gpiod_warn(desc,
2000 "%s: missing get() or direction_input() operations\n",
Andy Shevchenko7589e592013-12-05 11:26:23 +02002001 __func__);
Linus Walleijbe1a4b12013-08-30 09:41:45 +02002002 return -EIO;
2003 }
2004
David Brownelld2876d02008-02-04 22:28:20 -08002005 spin_lock_irqsave(&gpio_lock, flags);
2006
Alexandre Courbot372e7222013-02-03 01:29:29 +09002007 status = gpio_ensure_requested(desc);
David Brownell35e8bb52008-10-15 22:03:16 -07002008 if (status < 0)
2009 goto fail;
David Brownelld2876d02008-02-04 22:28:20 -08002010
2011 /* now we know the gpio is valid and chip won't vanish */
2012
2013 spin_unlock_irqrestore(&gpio_lock, flags);
2014
David Brownell9c4ba942010-08-10 18:02:24 -07002015 might_sleep_if(chip->can_sleep);
David Brownelld2876d02008-02-04 22:28:20 -08002016
Alexandre Courbot372e7222013-02-03 01:29:29 +09002017 offset = gpio_chip_hwgpio(desc);
David Brownell35e8bb52008-10-15 22:03:16 -07002018 if (status) {
Alexandre Courbot372e7222013-02-03 01:29:29 +09002019 status = chip->request(chip, offset);
David Brownell35e8bb52008-10-15 22:03:16 -07002020 if (status < 0) {
Andy Shevchenko7589e592013-12-05 11:26:23 +02002021 gpiod_dbg(desc, "%s: chip request fail, %d\n",
2022 __func__, status);
David Brownell35e8bb52008-10-15 22:03:16 -07002023 /* and it's not available to anyone else ...
2024 * gpio_request() is the fully clean solution.
2025 */
2026 goto lose;
2027 }
2028 }
2029
Alexandre Courbot372e7222013-02-03 01:29:29 +09002030 status = chip->direction_input(chip, offset);
David Brownelld2876d02008-02-04 22:28:20 -08002031 if (status == 0)
2032 clear_bit(FLAG_IS_OUT, &desc->flags);
Uwe Kleine-König3f397c212011-05-20 00:40:19 -06002033
Alexandre Courbot372e7222013-02-03 01:29:29 +09002034 trace_gpio_direction(desc_to_gpio(desc), 1, status);
David Brownell35e8bb52008-10-15 22:03:16 -07002035lose:
David Brownelld2876d02008-02-04 22:28:20 -08002036 return status;
2037fail:
2038 spin_unlock_irqrestore(&gpio_lock, flags);
Alexandre Courbotbcabdef2013-02-15 14:46:14 +09002039 if (status)
Andy Shevchenko7589e592013-12-05 11:26:23 +02002040 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
David Brownelld2876d02008-02-04 22:28:20 -08002041 return status;
2042}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002043EXPORT_SYMBOL_GPL(gpiod_direction_input);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002044
Philipp Zabelef70bbe2014-01-07 12:34:11 +01002045static int _gpiod_direction_output_raw(struct gpio_desc *desc, int value)
David Brownelld2876d02008-02-04 22:28:20 -08002046{
2047 unsigned long flags;
2048 struct gpio_chip *chip;
David Brownelld2876d02008-02-04 22:28:20 -08002049 int status = -EINVAL;
Alexandre Courbot372e7222013-02-03 01:29:29 +09002050 int offset;
David Brownelld2876d02008-02-04 22:28:20 -08002051
Linus Walleijd468bf92013-09-24 11:54:38 +02002052 /* GPIOs used for IRQs shall not be set as output */
2053 if (test_bit(FLAG_USED_AS_IRQ, &desc->flags)) {
2054 gpiod_err(desc,
2055 "%s: tried to set a GPIO tied to an IRQ as output\n",
2056 __func__);
2057 return -EIO;
2058 }
2059
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05302060 /* Open drain pin should not be driven to 1 */
2061 if (value && test_bit(FLAG_OPEN_DRAIN, &desc->flags))
Alexandre Courbot372e7222013-02-03 01:29:29 +09002062 return gpiod_direction_input(desc);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05302063
Laxman Dewangan25553ff2012-02-17 20:26:22 +05302064 /* Open source pin should not be driven to 0 */
2065 if (!value && test_bit(FLAG_OPEN_SOURCE, &desc->flags))
Alexandre Courbot372e7222013-02-03 01:29:29 +09002066 return gpiod_direction_input(desc);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05302067
Linus Walleijbe1a4b12013-08-30 09:41:45 +02002068 chip = desc->chip;
2069 if (!chip->set || !chip->direction_output) {
Mark Brown6424de52013-09-09 10:33:49 +01002070 gpiod_warn(desc,
2071 "%s: missing set() or direction_output() operations\n",
2072 __func__);
Linus Walleijbe1a4b12013-08-30 09:41:45 +02002073 return -EIO;
2074 }
2075
David Brownelld2876d02008-02-04 22:28:20 -08002076 spin_lock_irqsave(&gpio_lock, flags);
2077
Alexandre Courbot372e7222013-02-03 01:29:29 +09002078 status = gpio_ensure_requested(desc);
David Brownell35e8bb52008-10-15 22:03:16 -07002079 if (status < 0)
2080 goto fail;
David Brownelld2876d02008-02-04 22:28:20 -08002081
2082 /* now we know the gpio is valid and chip won't vanish */
2083
2084 spin_unlock_irqrestore(&gpio_lock, flags);
2085
David Brownell9c4ba942010-08-10 18:02:24 -07002086 might_sleep_if(chip->can_sleep);
David Brownelld2876d02008-02-04 22:28:20 -08002087
Alexandre Courbot372e7222013-02-03 01:29:29 +09002088 offset = gpio_chip_hwgpio(desc);
David Brownell35e8bb52008-10-15 22:03:16 -07002089 if (status) {
Alexandre Courbot372e7222013-02-03 01:29:29 +09002090 status = chip->request(chip, offset);
David Brownell35e8bb52008-10-15 22:03:16 -07002091 if (status < 0) {
Andy Shevchenko7589e592013-12-05 11:26:23 +02002092 gpiod_dbg(desc, "%s: chip request fail, %d\n",
2093 __func__, status);
David Brownell35e8bb52008-10-15 22:03:16 -07002094 /* and it's not available to anyone else ...
2095 * gpio_request() is the fully clean solution.
2096 */
2097 goto lose;
2098 }
2099 }
2100
Alexandre Courbot372e7222013-02-03 01:29:29 +09002101 status = chip->direction_output(chip, offset, value);
David Brownelld2876d02008-02-04 22:28:20 -08002102 if (status == 0)
2103 set_bit(FLAG_IS_OUT, &desc->flags);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002104 trace_gpio_value(desc_to_gpio(desc), 0, value);
2105 trace_gpio_direction(desc_to_gpio(desc), 0, status);
David Brownell35e8bb52008-10-15 22:03:16 -07002106lose:
David Brownelld2876d02008-02-04 22:28:20 -08002107 return status;
2108fail:
2109 spin_unlock_irqrestore(&gpio_lock, flags);
Alexandre Courbotbcabdef2013-02-15 14:46:14 +09002110 if (status)
Mark Brown6424de52013-09-09 10:33:49 +01002111 gpiod_dbg(desc, "%s: gpio status %d\n", __func__, status);
David Brownelld2876d02008-02-04 22:28:20 -08002112 return status;
2113}
Philipp Zabelef70bbe2014-01-07 12:34:11 +01002114
2115/**
2116 * gpiod_direction_output_raw - set the GPIO direction to output
2117 * @desc: GPIO to set to output
2118 * @value: initial output value of the GPIO
2119 *
2120 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2121 * be called safely on it. The initial value of the output must be specified
2122 * as raw value on the physical line without regard for the ACTIVE_LOW status.
2123 *
2124 * Return 0 in case of success, else an error code.
2125 */
2126int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
2127{
2128 if (!desc || !desc->chip) {
2129 pr_warn("%s: invalid GPIO\n", __func__);
2130 return -EINVAL;
2131 }
2132 return _gpiod_direction_output_raw(desc, value);
2133}
2134EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);
2135
2136/**
Rahul Bedarkar90df4fe2014-02-08 11:55:25 +05302137 * gpiod_direction_output - set the GPIO direction to output
Philipp Zabelef70bbe2014-01-07 12:34:11 +01002138 * @desc: GPIO to set to output
2139 * @value: initial output value of the GPIO
2140 *
2141 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
2142 * be called safely on it. The initial value of the output must be specified
2143 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2144 * account.
2145 *
2146 * Return 0 in case of success, else an error code.
2147 */
2148int gpiod_direction_output(struct gpio_desc *desc, int value)
2149{
2150 if (!desc || !desc->chip) {
2151 pr_warn("%s: invalid GPIO\n", __func__);
2152 return -EINVAL;
2153 }
2154 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2155 value = !value;
2156 return _gpiod_direction_output_raw(desc, value);
2157}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002158EXPORT_SYMBOL_GPL(gpiod_direction_output);
David Brownelld2876d02008-02-04 22:28:20 -08002159
Felipe Balbic4b5be92010-05-26 14:42:23 -07002160/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002161 * gpiod_set_debounce - sets @debounce time for a @gpio
Felipe Balbic4b5be92010-05-26 14:42:23 -07002162 * @gpio: the gpio to set debounce time
2163 * @debounce: debounce time is microseconds
Linus Walleij65d87652013-09-04 14:17:08 +02002164 *
2165 * returns -ENOTSUPP if the controller does not support setting
2166 * debounce.
Felipe Balbic4b5be92010-05-26 14:42:23 -07002167 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002168int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
Felipe Balbic4b5be92010-05-26 14:42:23 -07002169{
2170 unsigned long flags;
2171 struct gpio_chip *chip;
Felipe Balbic4b5be92010-05-26 14:42:23 -07002172 int status = -EINVAL;
Alexandre Courbot372e7222013-02-03 01:29:29 +09002173 int offset;
Felipe Balbic4b5be92010-05-26 14:42:23 -07002174
Linus Walleijbe1a4b12013-08-30 09:41:45 +02002175 if (!desc || !desc->chip) {
Alexandre Courbotbcabdef2013-02-15 14:46:14 +09002176 pr_warn("%s: invalid GPIO\n", __func__);
2177 return -EINVAL;
2178 }
2179
Felipe Balbic4b5be92010-05-26 14:42:23 -07002180 chip = desc->chip;
Linus Walleijbe1a4b12013-08-30 09:41:45 +02002181 if (!chip->set || !chip->set_debounce) {
Mark Brown6424de52013-09-09 10:33:49 +01002182 gpiod_dbg(desc,
2183 "%s: missing set() or set_debounce() operations\n",
2184 __func__);
Linus Walleij65d87652013-09-04 14:17:08 +02002185 return -ENOTSUPP;
Linus Walleijbe1a4b12013-08-30 09:41:45 +02002186 }
2187
2188 spin_lock_irqsave(&gpio_lock, flags);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002189
2190 status = gpio_ensure_requested(desc);
Felipe Balbic4b5be92010-05-26 14:42:23 -07002191 if (status < 0)
2192 goto fail;
2193
2194 /* now we know the gpio is valid and chip won't vanish */
2195
2196 spin_unlock_irqrestore(&gpio_lock, flags);
2197
David Brownell9c4ba942010-08-10 18:02:24 -07002198 might_sleep_if(chip->can_sleep);
Felipe Balbic4b5be92010-05-26 14:42:23 -07002199
Alexandre Courbot372e7222013-02-03 01:29:29 +09002200 offset = gpio_chip_hwgpio(desc);
2201 return chip->set_debounce(chip, offset, debounce);
Felipe Balbic4b5be92010-05-26 14:42:23 -07002202
2203fail:
2204 spin_unlock_irqrestore(&gpio_lock, flags);
Alexandre Courbotbcabdef2013-02-15 14:46:14 +09002205 if (status)
Mark Brown6424de52013-09-09 10:33:49 +01002206 gpiod_dbg(desc, "%s: status %d\n", __func__, status);
Felipe Balbic4b5be92010-05-26 14:42:23 -07002207
2208 return status;
2209}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002210EXPORT_SYMBOL_GPL(gpiod_set_debounce);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002211
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002212/**
2213 * gpiod_is_active_low - test whether a GPIO is active-low or not
2214 * @desc: the gpio descriptor to test
2215 *
2216 * Returns 1 if the GPIO is active-low, 0 otherwise.
2217 */
2218int gpiod_is_active_low(const struct gpio_desc *desc)
Alexandre Courbot372e7222013-02-03 01:29:29 +09002219{
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002220 return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002221}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002222EXPORT_SYMBOL_GPL(gpiod_is_active_low);
David Brownelld2876d02008-02-04 22:28:20 -08002223
2224/* I/O calls are only valid after configuration completed; the relevant
2225 * "is this a valid GPIO" error checks should already have been done.
2226 *
2227 * "Get" operations are often inlinable as reading a pin value register,
2228 * and masking the relevant bit in that register.
2229 *
2230 * When "set" operations are inlinable, they involve writing that mask to
2231 * one register to set a low value, or a different register to set it high.
2232 * Otherwise locking is needed, so there may be little value to inlining.
2233 *
2234 *------------------------------------------------------------------------
2235 *
2236 * IMPORTANT!!! The hot paths -- get/set value -- assume that callers
2237 * have requested the GPIO. That can include implicit requesting by
2238 * a direction setting call. Marking a gpio as requested locks its chip
2239 * in memory, guaranteeing that these table lookups need no more locking
2240 * and that gpiochip_remove() will fail.
2241 *
2242 * REVISIT when debugging, consider adding some instrumentation to ensure
2243 * that the GPIO was actually requested.
2244 */
2245
Alexandre Courbot23600962014-03-11 15:52:09 +09002246static bool _gpiod_get_raw_value(const struct gpio_desc *desc)
David Brownelld2876d02008-02-04 22:28:20 -08002247{
2248 struct gpio_chip *chip;
Alexandre Courbot23600962014-03-11 15:52:09 +09002249 bool value;
Alexandre Courbot372e7222013-02-03 01:29:29 +09002250 int offset;
David Brownelld2876d02008-02-04 22:28:20 -08002251
Alexandre Courbot372e7222013-02-03 01:29:29 +09002252 chip = desc->chip;
2253 offset = gpio_chip_hwgpio(desc);
Alexandre Courbot23600962014-03-11 15:52:09 +09002254 value = chip->get ? chip->get(chip, offset) : false;
Alexandre Courbot372e7222013-02-03 01:29:29 +09002255 trace_gpio_value(desc_to_gpio(desc), 1, value);
Uwe Kleine-König3f397c212011-05-20 00:40:19 -06002256 return value;
David Brownelld2876d02008-02-04 22:28:20 -08002257}
Alexandre Courbot372e7222013-02-03 01:29:29 +09002258
David Brownelld2876d02008-02-04 22:28:20 -08002259/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002260 * gpiod_get_raw_value() - return a gpio's raw value
2261 * @desc: gpio whose value will be returned
David Brownelld2876d02008-02-04 22:28:20 -08002262 *
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002263 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2264 * its ACTIVE_LOW status.
2265 *
2266 * This function should be called from contexts where we cannot sleep, and will
2267 * complain if the GPIO chip functions potentially sleep.
David Brownelld2876d02008-02-04 22:28:20 -08002268 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002269int gpiod_get_raw_value(const struct gpio_desc *desc)
Alexandre Courbot372e7222013-02-03 01:29:29 +09002270{
David Brownelld2876d02008-02-04 22:28:20 -08002271 if (!desc)
2272 return 0;
David Brownelld2876d02008-02-04 22:28:20 -08002273 /* Should be using gpio_get_value_cansleep() */
Alexandre Courbotd8e0ac02013-09-04 20:29:25 +09002274 WARN_ON(desc->chip->can_sleep);
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002275 return _gpiod_get_raw_value(desc);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002276}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002277EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
David Brownelld2876d02008-02-04 22:28:20 -08002278
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002279/**
2280 * gpiod_get_value() - return a gpio's value
2281 * @desc: gpio whose value will be returned
2282 *
2283 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2284 * account.
2285 *
2286 * This function should be called from contexts where we cannot sleep, and will
2287 * complain if the GPIO chip functions potentially sleep.
2288 */
2289int gpiod_get_value(const struct gpio_desc *desc)
David Brownelld2876d02008-02-04 22:28:20 -08002290{
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002291 int value;
2292 if (!desc)
2293 return 0;
2294 /* Should be using gpio_get_value_cansleep() */
2295 WARN_ON(desc->chip->can_sleep);
2296
2297 value = _gpiod_get_raw_value(desc);
2298 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2299 value = !value;
2300
2301 return value;
David Brownelld2876d02008-02-04 22:28:20 -08002302}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002303EXPORT_SYMBOL_GPL(gpiod_get_value);
David Brownelld2876d02008-02-04 22:28:20 -08002304
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05302305/*
2306 * _gpio_set_open_drain_value() - Set the open drain gpio's value.
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002307 * @desc: gpio descriptor whose state need to be set.
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05302308 * @value: Non-zero for setting it HIGH otherise it will set to LOW.
2309 */
Alexandre Courbot23600962014-03-11 15:52:09 +09002310static void _gpio_set_open_drain_value(struct gpio_desc *desc, bool value)
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05302311{
2312 int err = 0;
Alexandre Courbot372e7222013-02-03 01:29:29 +09002313 struct gpio_chip *chip = desc->chip;
2314 int offset = gpio_chip_hwgpio(desc);
2315
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05302316 if (value) {
Alexandre Courbot372e7222013-02-03 01:29:29 +09002317 err = chip->direction_input(chip, offset);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05302318 if (!err)
Alexandre Courbot372e7222013-02-03 01:29:29 +09002319 clear_bit(FLAG_IS_OUT, &desc->flags);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05302320 } else {
Alexandre Courbot372e7222013-02-03 01:29:29 +09002321 err = chip->direction_output(chip, offset, 0);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05302322 if (!err)
Alexandre Courbot372e7222013-02-03 01:29:29 +09002323 set_bit(FLAG_IS_OUT, &desc->flags);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05302324 }
Alexandre Courbot372e7222013-02-03 01:29:29 +09002325 trace_gpio_direction(desc_to_gpio(desc), value, err);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05302326 if (err < 0)
Mark Brown6424de52013-09-09 10:33:49 +01002327 gpiod_err(desc,
2328 "%s: Error in set_value for open drain err %d\n",
2329 __func__, err);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05302330}
2331
Laxman Dewangan25553ff2012-02-17 20:26:22 +05302332/*
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002333 * _gpio_set_open_source_value() - Set the open source gpio's value.
2334 * @desc: gpio descriptor whose state need to be set.
Laxman Dewangan25553ff2012-02-17 20:26:22 +05302335 * @value: Non-zero for setting it HIGH otherise it will set to LOW.
2336 */
Alexandre Courbot23600962014-03-11 15:52:09 +09002337static void _gpio_set_open_source_value(struct gpio_desc *desc, bool value)
Laxman Dewangan25553ff2012-02-17 20:26:22 +05302338{
2339 int err = 0;
Alexandre Courbot372e7222013-02-03 01:29:29 +09002340 struct gpio_chip *chip = desc->chip;
2341 int offset = gpio_chip_hwgpio(desc);
2342
Laxman Dewangan25553ff2012-02-17 20:26:22 +05302343 if (value) {
Alexandre Courbot372e7222013-02-03 01:29:29 +09002344 err = chip->direction_output(chip, offset, 1);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05302345 if (!err)
Alexandre Courbot372e7222013-02-03 01:29:29 +09002346 set_bit(FLAG_IS_OUT, &desc->flags);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05302347 } else {
Alexandre Courbot372e7222013-02-03 01:29:29 +09002348 err = chip->direction_input(chip, offset);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05302349 if (!err)
Alexandre Courbot372e7222013-02-03 01:29:29 +09002350 clear_bit(FLAG_IS_OUT, &desc->flags);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05302351 }
Alexandre Courbot372e7222013-02-03 01:29:29 +09002352 trace_gpio_direction(desc_to_gpio(desc), !value, err);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05302353 if (err < 0)
Mark Brown6424de52013-09-09 10:33:49 +01002354 gpiod_err(desc,
2355 "%s: Error in set_value for open source err %d\n",
2356 __func__, err);
Laxman Dewangan25553ff2012-02-17 20:26:22 +05302357}
2358
Alexandre Courbot23600962014-03-11 15:52:09 +09002359static void _gpiod_set_raw_value(struct gpio_desc *desc, bool value)
David Brownelld2876d02008-02-04 22:28:20 -08002360{
2361 struct gpio_chip *chip;
2362
Alexandre Courbot372e7222013-02-03 01:29:29 +09002363 chip = desc->chip;
Alexandre Courbot372e7222013-02-03 01:29:29 +09002364 trace_gpio_value(desc_to_gpio(desc), 0, value);
2365 if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
2366 _gpio_set_open_drain_value(desc, value);
2367 else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
2368 _gpio_set_open_source_value(desc, value);
Laxman Dewanganaca5ce12012-02-17 20:26:21 +05302369 else
Alexandre Courbot372e7222013-02-03 01:29:29 +09002370 chip->set(chip, gpio_chip_hwgpio(desc), value);
2371}
2372
David Brownelld2876d02008-02-04 22:28:20 -08002373/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002374 * gpiod_set_raw_value() - assign a gpio's raw value
2375 * @desc: gpio whose value will be assigned
David Brownelld2876d02008-02-04 22:28:20 -08002376 * @value: value to assign
David Brownelld2876d02008-02-04 22:28:20 -08002377 *
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002378 * Set the raw value of the GPIO, i.e. the value of its physical line without
2379 * regard for its ACTIVE_LOW status.
2380 *
2381 * This function should be called from contexts where we cannot sleep, and will
2382 * complain if the GPIO chip functions potentially sleep.
David Brownelld2876d02008-02-04 22:28:20 -08002383 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002384void gpiod_set_raw_value(struct gpio_desc *desc, int value)
Alexandre Courbot372e7222013-02-03 01:29:29 +09002385{
David Brownelld2876d02008-02-04 22:28:20 -08002386 if (!desc)
2387 return;
David Brownelld2876d02008-02-04 22:28:20 -08002388 /* Should be using gpio_set_value_cansleep() */
Alexandre Courbotd8e0ac02013-09-04 20:29:25 +09002389 WARN_ON(desc->chip->can_sleep);
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002390 _gpiod_set_raw_value(desc, value);
David Brownelld2876d02008-02-04 22:28:20 -08002391}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002392EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
David Brownelld2876d02008-02-04 22:28:20 -08002393
2394/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002395 * gpiod_set_value() - assign a gpio's value
2396 * @desc: gpio whose value will be assigned
2397 * @value: value to assign
David Brownelld2876d02008-02-04 22:28:20 -08002398 *
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002399 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2400 * account
2401 *
2402 * This function should be called from contexts where we cannot sleep, and will
2403 * complain if the GPIO chip functions potentially sleep.
David Brownelld2876d02008-02-04 22:28:20 -08002404 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002405void gpiod_set_value(struct gpio_desc *desc, int value)
2406{
2407 if (!desc)
2408 return;
2409 /* Should be using gpio_set_value_cansleep() */
2410 WARN_ON(desc->chip->can_sleep);
2411 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2412 value = !value;
2413 _gpiod_set_raw_value(desc, value);
2414}
2415EXPORT_SYMBOL_GPL(gpiod_set_value);
2416
2417/**
2418 * gpiod_cansleep() - report whether gpio value access may sleep
2419 * @desc: gpio to check
2420 *
2421 */
2422int gpiod_cansleep(const struct gpio_desc *desc)
Alexandre Courbot372e7222013-02-03 01:29:29 +09002423{
Alexandre Courbotbcabdef2013-02-15 14:46:14 +09002424 if (!desc)
2425 return 0;
Alexandre Courbot372e7222013-02-03 01:29:29 +09002426 return desc->chip->can_sleep;
2427}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002428EXPORT_SYMBOL_GPL(gpiod_cansleep);
David Brownelld2876d02008-02-04 22:28:20 -08002429
David Brownell0f6d5042008-10-15 22:03:14 -07002430/**
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002431 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
2432 * @desc: gpio whose IRQ will be returned (already requested)
David Brownell0f6d5042008-10-15 22:03:14 -07002433 *
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002434 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
2435 * error.
David Brownell0f6d5042008-10-15 22:03:14 -07002436 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002437int gpiod_to_irq(const struct gpio_desc *desc)
David Brownell0f6d5042008-10-15 22:03:14 -07002438{
2439 struct gpio_chip *chip;
Alexandre Courbot372e7222013-02-03 01:29:29 +09002440 int offset;
David Brownell0f6d5042008-10-15 22:03:14 -07002441
Alexandre Courbotbcabdef2013-02-15 14:46:14 +09002442 if (!desc)
2443 return -EINVAL;
Alexandre Courbot372e7222013-02-03 01:29:29 +09002444 chip = desc->chip;
2445 offset = gpio_chip_hwgpio(desc);
2446 return chip->to_irq ? chip->to_irq(chip, offset) : -ENXIO;
2447}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002448EXPORT_SYMBOL_GPL(gpiod_to_irq);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002449
Linus Walleijd468bf92013-09-24 11:54:38 +02002450/**
2451 * gpiod_lock_as_irq() - lock a GPIO to be used as IRQ
2452 * @gpio: the GPIO line to lock as used for IRQ
2453 *
2454 * This is used directly by GPIO drivers that want to lock down
Linus Walleijf438acd2014-03-07 10:12:49 +08002455 * a certain GPIO line to be used for IRQs.
David Brownelld2876d02008-02-04 22:28:20 -08002456 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002457int gpiod_lock_as_irq(struct gpio_desc *desc)
David Brownelld2876d02008-02-04 22:28:20 -08002458{
Linus Walleijd468bf92013-09-24 11:54:38 +02002459 if (!desc)
2460 return -EINVAL;
2461
2462 if (test_bit(FLAG_IS_OUT, &desc->flags)) {
2463 gpiod_err(desc,
2464 "%s: tried to flag a GPIO set as output for IRQ\n",
2465 __func__);
2466 return -EIO;
2467 }
2468
2469 set_bit(FLAG_USED_AS_IRQ, &desc->flags);
2470 return 0;
2471}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002472EXPORT_SYMBOL_GPL(gpiod_lock_as_irq);
Linus Walleijd468bf92013-09-24 11:54:38 +02002473
2474int gpio_lock_as_irq(struct gpio_chip *chip, unsigned int offset)
2475{
Alexandre Courbotbb1e88c2014-02-09 17:43:54 +09002476 return gpiod_lock_as_irq(gpiochip_get_desc(chip, offset));
Linus Walleijd468bf92013-09-24 11:54:38 +02002477}
2478EXPORT_SYMBOL_GPL(gpio_lock_as_irq);
2479
2480/**
2481 * gpiod_unlock_as_irq() - unlock a GPIO used as IRQ
2482 * @gpio: the GPIO line to unlock from IRQ usage
2483 *
2484 * This is used directly by GPIO drivers that want to indicate
2485 * that a certain GPIO is no longer used exclusively for IRQ.
2486 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002487void gpiod_unlock_as_irq(struct gpio_desc *desc)
Linus Walleijd468bf92013-09-24 11:54:38 +02002488{
2489 if (!desc)
2490 return;
2491
2492 clear_bit(FLAG_USED_AS_IRQ, &desc->flags);
2493}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002494EXPORT_SYMBOL_GPL(gpiod_unlock_as_irq);
Linus Walleijd468bf92013-09-24 11:54:38 +02002495
2496void gpio_unlock_as_irq(struct gpio_chip *chip, unsigned int offset)
2497{
Alexandre Courbotbb1e88c2014-02-09 17:43:54 +09002498 return gpiod_unlock_as_irq(gpiochip_get_desc(chip, offset));
Linus Walleijd468bf92013-09-24 11:54:38 +02002499}
2500EXPORT_SYMBOL_GPL(gpio_unlock_as_irq);
David Brownelld2876d02008-02-04 22:28:20 -08002501
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002502/**
2503 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
2504 * @desc: gpio whose value will be returned
2505 *
2506 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2507 * its ACTIVE_LOW status.
2508 *
2509 * This function is to be called from contexts that can sleep.
David Brownelld2876d02008-02-04 22:28:20 -08002510 */
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002511int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
David Brownelld2876d02008-02-04 22:28:20 -08002512{
David Brownelld2876d02008-02-04 22:28:20 -08002513 might_sleep_if(extra_checks);
Alexandre Courbotbcabdef2013-02-15 14:46:14 +09002514 if (!desc)
2515 return 0;
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002516 return _gpiod_get_raw_value(desc);
David Brownelld2876d02008-02-04 22:28:20 -08002517}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002518EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002519
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002520/**
2521 * gpiod_get_value_cansleep() - return a gpio's value
2522 * @desc: gpio whose value will be returned
2523 *
2524 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2525 * account.
2526 *
2527 * This function is to be called from contexts that can sleep.
2528 */
2529int gpiod_get_value_cansleep(const struct gpio_desc *desc)
Alexandre Courbot372e7222013-02-03 01:29:29 +09002530{
David Brownelld2876d02008-02-04 22:28:20 -08002531 int value;
David Brownelld2876d02008-02-04 22:28:20 -08002532
2533 might_sleep_if(extra_checks);
2534 if (!desc)
2535 return 0;
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002536
2537 value = _gpiod_get_raw_value(desc);
2538 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2539 value = !value;
2540
David Brownelld2876d02008-02-04 22:28:20 -08002541 return value;
2542}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002543EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002544
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002545/**
2546 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
2547 * @desc: gpio whose value will be assigned
2548 * @value: value to assign
2549 *
2550 * Set the raw value of the GPIO, i.e. the value of its physical line without
2551 * regard for its ACTIVE_LOW status.
2552 *
2553 * This function is to be called from contexts that can sleep.
2554 */
2555void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
Alexandre Courbot372e7222013-02-03 01:29:29 +09002556{
David Brownelld2876d02008-02-04 22:28:20 -08002557 might_sleep_if(extra_checks);
Alexandre Courbotbcabdef2013-02-15 14:46:14 +09002558 if (!desc)
2559 return;
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002560 _gpiod_set_raw_value(desc, value);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002561}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002562EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
Alexandre Courbot372e7222013-02-03 01:29:29 +09002563
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002564/**
2565 * gpiod_set_value_cansleep() - assign a gpio's value
2566 * @desc: gpio whose value will be assigned
2567 * @value: value to assign
2568 *
2569 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
2570 * account
2571 *
2572 * This function is to be called from contexts that can sleep.
2573 */
2574void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
Alexandre Courbot372e7222013-02-03 01:29:29 +09002575{
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002576 might_sleep_if(extra_checks);
2577 if (!desc)
2578 return;
2579
2580 if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
2581 value = !value;
2582 _gpiod_set_raw_value(desc, value);
David Brownelld2876d02008-02-04 22:28:20 -08002583}
Alexandre Courbot79a9bec2013-10-17 10:21:36 -07002584EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
David Brownelld2876d02008-02-04 22:28:20 -08002585
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002586/**
Alexandre Courbotad824782013-12-03 12:20:11 +09002587 * gpiod_add_lookup_table() - register GPIO device consumers
2588 * @table: table of consumers to register
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002589 */
Alexandre Courbotad824782013-12-03 12:20:11 +09002590void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002591{
2592 mutex_lock(&gpio_lookup_lock);
2593
Alexandre Courbotad824782013-12-03 12:20:11 +09002594 list_add_tail(&table->list, &gpio_lookup_list);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002595
2596 mutex_unlock(&gpio_lookup_lock);
David Brownelld2876d02008-02-04 22:28:20 -08002597}
2598
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002599static struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id,
Alexandre Courbot53e7cac2013-11-16 21:44:52 +09002600 unsigned int idx,
2601 enum gpio_lookup_flags *flags)
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002602{
Thierry Redingdd34c372014-04-23 17:28:09 +02002603 static const char *suffixes[] = { "gpios", "gpio" };
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002604 char prop_name[32]; /* 32 is max size of property name */
2605 enum of_gpio_flags of_flags;
2606 struct gpio_desc *desc;
Thierry Redingdd34c372014-04-23 17:28:09 +02002607 unsigned int i;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002608
Thierry Redingdd34c372014-04-23 17:28:09 +02002609 for (i = 0; i < ARRAY_SIZE(suffixes); i++) {
2610 if (con_id)
2611 snprintf(prop_name, 32, "%s-%s", con_id, suffixes[i]);
2612 else
2613 snprintf(prop_name, 32, "%s", suffixes[i]);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002614
Thierry Redingdd34c372014-04-23 17:28:09 +02002615 desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx,
2616 &of_flags);
Tony Lindgren06fc3b72014-06-02 16:13:46 -07002617 if (!IS_ERR(desc) || (PTR_ERR(desc) == -EPROBE_DEFER))
Thierry Redingdd34c372014-04-23 17:28:09 +02002618 break;
2619 }
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002620
2621 if (IS_ERR(desc))
2622 return desc;
2623
2624 if (of_flags & OF_GPIO_ACTIVE_LOW)
Alexandre Courbot53e7cac2013-11-16 21:44:52 +09002625 *flags |= GPIO_ACTIVE_LOW;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002626
2627 return desc;
2628}
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002629
Mika Westerberg81f59e92013-10-10 11:01:09 +03002630static struct gpio_desc *acpi_find_gpio(struct device *dev, const char *con_id,
Alexandre Courbot53e7cac2013-11-16 21:44:52 +09002631 unsigned int idx,
2632 enum gpio_lookup_flags *flags)
Mika Westerberg81f59e92013-10-10 11:01:09 +03002633{
Mika Westerberge01f4402013-10-10 11:01:10 +03002634 struct acpi_gpio_info info;
2635 struct gpio_desc *desc;
2636
2637 desc = acpi_get_gpiod_by_index(dev, idx, &info);
2638 if (IS_ERR(desc))
2639 return desc;
2640
2641 if (info.gpioint && info.active_low)
Alexandre Courbot53e7cac2013-11-16 21:44:52 +09002642 *flags |= GPIO_ACTIVE_LOW;
Mika Westerberge01f4402013-10-10 11:01:10 +03002643
2644 return desc;
Mika Westerberg81f59e92013-10-10 11:01:09 +03002645}
2646
Alexandre Courbotad824782013-12-03 12:20:11 +09002647static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
2648{
2649 const char *dev_id = dev ? dev_name(dev) : NULL;
2650 struct gpiod_lookup_table *table;
2651
2652 mutex_lock(&gpio_lookup_lock);
2653
2654 list_for_each_entry(table, &gpio_lookup_list, list) {
2655 if (table->dev_id && dev_id) {
2656 /*
2657 * Valid strings on both ends, must be identical to have
2658 * a match
2659 */
2660 if (!strcmp(table->dev_id, dev_id))
2661 goto found;
2662 } else {
2663 /*
2664 * One of the pointers is NULL, so both must be to have
2665 * a match
2666 */
2667 if (dev_id == table->dev_id)
2668 goto found;
2669 }
2670 }
2671 table = NULL;
2672
2673found:
2674 mutex_unlock(&gpio_lookup_lock);
2675 return table;
2676}
2677
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002678static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
Alexandre Courbot53e7cac2013-11-16 21:44:52 +09002679 unsigned int idx,
2680 enum gpio_lookup_flags *flags)
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002681{
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002682 struct gpio_desc *desc = ERR_PTR(-ENOENT);
Alexandre Courbotad824782013-12-03 12:20:11 +09002683 struct gpiod_lookup_table *table;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002684 struct gpiod_lookup *p;
2685
Alexandre Courbotad824782013-12-03 12:20:11 +09002686 table = gpiod_find_lookup_table(dev);
2687 if (!table)
2688 return desc;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002689
Alexandre Courbotad824782013-12-03 12:20:11 +09002690 for (p = &table->table[0]; p->chip_label; p++) {
2691 struct gpio_chip *chip;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002692
Alexandre Courbotad824782013-12-03 12:20:11 +09002693 /* idx must always match exactly */
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002694 if (p->idx != idx)
2695 continue;
2696
Alexandre Courbotad824782013-12-03 12:20:11 +09002697 /* If the lookup entry has a con_id, require exact match */
2698 if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
2699 continue;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002700
Alexandre Courbotad824782013-12-03 12:20:11 +09002701 chip = find_chip_by_name(p->chip_label);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002702
Alexandre Courbotad824782013-12-03 12:20:11 +09002703 if (!chip) {
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002704 dev_err(dev, "cannot find GPIO chip %s\n",
2705 p->chip_label);
2706 return ERR_PTR(-ENODEV);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002707 }
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002708
Alexandre Courbotad824782013-12-03 12:20:11 +09002709 if (chip->ngpio <= p->chip_hwnum) {
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002710 dev_err(dev,
2711 "requested GPIO %d is out of range [0..%d] for chip %s\n",
2712 idx, chip->ngpio, chip->label);
2713 return ERR_PTR(-EINVAL);
Alexandre Courbotad824782013-12-03 12:20:11 +09002714 }
2715
Alexandre Courbotbb1e88c2014-02-09 17:43:54 +09002716 desc = gpiochip_get_desc(chip, p->chip_hwnum);
Alexandre Courbotad824782013-12-03 12:20:11 +09002717 *flags = p->flags;
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002718
2719 return desc;
Alexandre Courbotad824782013-12-03 12:20:11 +09002720 }
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002721
2722 return desc;
2723}
2724
2725/**
Thierry Reding08791622014-04-25 16:54:22 +02002726 * gpiod_get - obtain a GPIO for a given GPIO function
Alexandre Courbotad824782013-12-03 12:20:11 +09002727 * @dev: GPIO consumer, can be NULL for system-global GPIOs
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002728 * @con_id: function within the GPIO consumer
2729 *
2730 * Return the GPIO descriptor corresponding to the function con_id of device
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002731 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
2732 * another IS_ERR() code if an error occured while trying to acquire the GPIO.
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002733 */
2734struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id)
2735{
2736 return gpiod_get_index(dev, con_id, 0);
2737}
2738EXPORT_SYMBOL_GPL(gpiod_get);
2739
2740/**
Thierry Reding29a1f2332014-04-25 17:10:06 +02002741 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
2742 * @dev: GPIO consumer, can be NULL for system-global GPIOs
2743 * @con_id: function within the GPIO consumer
2744 *
2745 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
2746 * the requested function it will return NULL. This is convenient for drivers
2747 * that need to handle optional GPIOs.
2748 */
2749struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
2750 const char *con_id)
2751{
2752 return gpiod_get_index_optional(dev, con_id, 0);
2753}
2754EXPORT_SYMBOL_GPL(gpiod_get_optional);
2755
2756/**
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002757 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
Andy Shevchenkofdd6a5f2013-12-05 11:26:26 +02002758 * @dev: GPIO consumer, can be NULL for system-global GPIOs
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002759 * @con_id: function within the GPIO consumer
2760 * @idx: index of the GPIO to obtain in the consumer
2761 *
2762 * This variant of gpiod_get() allows to access GPIOs other than the first
2763 * defined one for functions that define several GPIOs.
2764 *
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002765 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
2766 * requested function and/or index, or another IS_ERR() code if an error
2767 * occured while trying to acquire the GPIO.
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002768 */
2769struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
2770 const char *con_id,
2771 unsigned int idx)
2772{
Alexandre Courbot35c5d7f2013-11-23 19:34:50 +09002773 struct gpio_desc *desc = NULL;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002774 int status;
Alexandre Courbot53e7cac2013-11-16 21:44:52 +09002775 enum gpio_lookup_flags flags = 0;
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002776
2777 dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);
2778
2779 /* Using device tree? */
2780 if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node) {
2781 dev_dbg(dev, "using device tree for GPIO lookup\n");
2782 desc = of_find_gpio(dev, con_id, idx, &flags);
Mika Westerberg81f59e92013-10-10 11:01:09 +03002783 } else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev)) {
2784 dev_dbg(dev, "using ACPI for GPIO lookup\n");
2785 desc = acpi_find_gpio(dev, con_id, idx, &flags);
Alexandre Courbot35c5d7f2013-11-23 19:34:50 +09002786 }
2787
2788 /*
2789 * Either we are not using DT or ACPI, or their lookup did not return
2790 * a result. In that case, use platform lookup as a fallback.
2791 */
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002792 if (!desc || desc == ERR_PTR(-ENOENT)) {
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002793 dev_dbg(dev, "using lookup tables for GPIO lookup");
Alexandre Courbot2a3cf6a2013-12-11 11:32:28 +09002794 desc = gpiod_find(dev, con_id, idx, &flags);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002795 }
2796
2797 if (IS_ERR(desc)) {
Heikki Krogerus351cfe02013-11-29 15:47:34 +02002798 dev_dbg(dev, "lookup for GPIO %s failed\n", con_id);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002799 return desc;
2800 }
2801
2802 status = gpiod_request(desc, con_id);
2803
2804 if (status < 0)
2805 return ERR_PTR(status);
2806
Alexandre Courbot53e7cac2013-11-16 21:44:52 +09002807 if (flags & GPIO_ACTIVE_LOW)
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002808 set_bit(FLAG_ACTIVE_LOW, &desc->flags);
Alexandre Courbot53e7cac2013-11-16 21:44:52 +09002809 if (flags & GPIO_OPEN_DRAIN)
2810 set_bit(FLAG_OPEN_DRAIN, &desc->flags);
2811 if (flags & GPIO_OPEN_SOURCE)
2812 set_bit(FLAG_OPEN_SOURCE, &desc->flags);
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002813
2814 return desc;
2815}
2816EXPORT_SYMBOL_GPL(gpiod_get_index);
2817
2818/**
Thierry Reding29a1f2332014-04-25 17:10:06 +02002819 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
2820 * function
2821 * @dev: GPIO consumer, can be NULL for system-global GPIOs
2822 * @con_id: function within the GPIO consumer
2823 * @index: index of the GPIO to obtain in the consumer
2824 *
2825 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
2826 * specified index was assigned to the requested function it will return NULL.
2827 * This is convenient for drivers that need to handle optional GPIOs.
2828 */
2829struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
2830 const char *con_id,
2831 unsigned int index)
2832{
2833 struct gpio_desc *desc;
2834
2835 desc = gpiod_get_index(dev, con_id, index);
2836 if (IS_ERR(desc)) {
2837 if (PTR_ERR(desc) == -ENOENT)
2838 return NULL;
2839 }
2840
2841 return desc;
2842}
2843EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
2844
2845/**
Alexandre Courbotbae48da2013-10-17 10:21:38 -07002846 * gpiod_put - dispose of a GPIO descriptor
2847 * @desc: GPIO descriptor to dispose of
2848 *
2849 * No descriptor can be used after gpiod_put() has been called on it.
2850 */
2851void gpiod_put(struct gpio_desc *desc)
2852{
2853 gpiod_free(desc);
2854}
2855EXPORT_SYMBOL_GPL(gpiod_put);
David Brownelld2876d02008-02-04 22:28:20 -08002856
David Brownelld2876d02008-02-04 22:28:20 -08002857#ifdef CONFIG_DEBUG_FS
2858
2859static void gpiolib_dbg_show(struct seq_file *s, struct gpio_chip *chip)
2860{
2861 unsigned i;
2862 unsigned gpio = chip->base;
Alexandre Courbot6c0b4e62013-02-03 01:29:30 +09002863 struct gpio_desc *gdesc = &chip->desc[0];
David Brownelld2876d02008-02-04 22:28:20 -08002864 int is_out;
Linus Walleijd468bf92013-09-24 11:54:38 +02002865 int is_irq;
David Brownelld2876d02008-02-04 22:28:20 -08002866
2867 for (i = 0; i < chip->ngpio; i++, gpio++, gdesc++) {
2868 if (!test_bit(FLAG_REQUESTED, &gdesc->flags))
2869 continue;
2870
Alexandre Courbot372e7222013-02-03 01:29:29 +09002871 gpiod_get_direction(gdesc);
David Brownelld2876d02008-02-04 22:28:20 -08002872 is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
Linus Walleijd468bf92013-09-24 11:54:38 +02002873 is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
2874 seq_printf(s, " gpio-%-3d (%-20.20s) %s %s %s",
David Brownelld2876d02008-02-04 22:28:20 -08002875 gpio, gdesc->label,
2876 is_out ? "out" : "in ",
2877 chip->get
2878 ? (chip->get(chip, i) ? "hi" : "lo")
Linus Walleijd468bf92013-09-24 11:54:38 +02002879 : "? ",
2880 is_irq ? "IRQ" : " ");
David Brownelld2876d02008-02-04 22:28:20 -08002881 seq_printf(s, "\n");
2882 }
2883}
2884
Thierry Redingf9c4a312012-04-12 13:26:01 +02002885static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
David Brownelld2876d02008-02-04 22:28:20 -08002886{
Grant Likely362432a2013-02-09 09:41:49 +00002887 unsigned long flags;
Thierry Redingf9c4a312012-04-12 13:26:01 +02002888 struct gpio_chip *chip = NULL;
Alexandre Courbotcb1650d2013-02-03 01:29:27 +09002889 loff_t index = *pos;
Thierry Redingf9c4a312012-04-12 13:26:01 +02002890
2891 s->private = "";
2892
Grant Likely362432a2013-02-09 09:41:49 +00002893 spin_lock_irqsave(&gpio_lock, flags);
Alexandre Courbotcb1650d2013-02-03 01:29:27 +09002894 list_for_each_entry(chip, &gpio_chips, list)
Grant Likely362432a2013-02-09 09:41:49 +00002895 if (index-- == 0) {
2896 spin_unlock_irqrestore(&gpio_lock, flags);
Alexandre Courbotcb1650d2013-02-03 01:29:27 +09002897 return chip;
Grant Likely362432a2013-02-09 09:41:49 +00002898 }
2899 spin_unlock_irqrestore(&gpio_lock, flags);
Alexandre Courbotcb1650d2013-02-03 01:29:27 +09002900
2901 return NULL;
Thierry Redingf9c4a312012-04-12 13:26:01 +02002902}
2903
2904static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
2905{
Grant Likely362432a2013-02-09 09:41:49 +00002906 unsigned long flags;
Thierry Redingf9c4a312012-04-12 13:26:01 +02002907 struct gpio_chip *chip = v;
Thierry Redingf9c4a312012-04-12 13:26:01 +02002908 void *ret = NULL;
2909
Grant Likely362432a2013-02-09 09:41:49 +00002910 spin_lock_irqsave(&gpio_lock, flags);
Alexandre Courbotcb1650d2013-02-03 01:29:27 +09002911 if (list_is_last(&chip->list, &gpio_chips))
2912 ret = NULL;
2913 else
2914 ret = list_entry(chip->list.next, struct gpio_chip, list);
Grant Likely362432a2013-02-09 09:41:49 +00002915 spin_unlock_irqrestore(&gpio_lock, flags);
Thierry Redingf9c4a312012-04-12 13:26:01 +02002916
2917 s->private = "\n";
2918 ++*pos;
2919
2920 return ret;
2921}
2922
2923static void gpiolib_seq_stop(struct seq_file *s, void *v)
2924{
2925}
2926
2927static int gpiolib_seq_show(struct seq_file *s, void *v)
2928{
2929 struct gpio_chip *chip = v;
2930 struct device *dev;
2931
2932 seq_printf(s, "%sGPIOs %d-%d", (char *)s->private,
2933 chip->base, chip->base + chip->ngpio - 1);
2934 dev = chip->dev;
2935 if (dev)
2936 seq_printf(s, ", %s/%s", dev->bus ? dev->bus->name : "no-bus",
2937 dev_name(dev));
2938 if (chip->label)
2939 seq_printf(s, ", %s", chip->label);
2940 if (chip->can_sleep)
2941 seq_printf(s, ", can sleep");
2942 seq_printf(s, ":\n");
2943
2944 if (chip->dbg_show)
2945 chip->dbg_show(s, chip);
2946 else
2947 gpiolib_dbg_show(s, chip);
2948
David Brownelld2876d02008-02-04 22:28:20 -08002949 return 0;
2950}
2951
Thierry Redingf9c4a312012-04-12 13:26:01 +02002952static const struct seq_operations gpiolib_seq_ops = {
2953 .start = gpiolib_seq_start,
2954 .next = gpiolib_seq_next,
2955 .stop = gpiolib_seq_stop,
2956 .show = gpiolib_seq_show,
2957};
2958
David Brownelld2876d02008-02-04 22:28:20 -08002959static int gpiolib_open(struct inode *inode, struct file *file)
2960{
Thierry Redingf9c4a312012-04-12 13:26:01 +02002961 return seq_open(file, &gpiolib_seq_ops);
David Brownelld2876d02008-02-04 22:28:20 -08002962}
2963
Alexey Dobriyan828c0952009-10-01 15:43:56 -07002964static const struct file_operations gpiolib_operations = {
Thierry Redingf9c4a312012-04-12 13:26:01 +02002965 .owner = THIS_MODULE,
David Brownelld2876d02008-02-04 22:28:20 -08002966 .open = gpiolib_open,
2967 .read = seq_read,
2968 .llseek = seq_lseek,
Thierry Redingf9c4a312012-04-12 13:26:01 +02002969 .release = seq_release,
David Brownelld2876d02008-02-04 22:28:20 -08002970};
2971
2972static int __init gpiolib_debugfs_init(void)
2973{
2974 /* /sys/kernel/debug/gpio */
2975 (void) debugfs_create_file("gpio", S_IFREG | S_IRUGO,
2976 NULL, NULL, &gpiolib_operations);
2977 return 0;
2978}
2979subsys_initcall(gpiolib_debugfs_init);
2980
2981#endif /* DEBUG_FS */