gpiolib.c 65.7 KB
Newer Older
1 2
#include <linux/kernel.h>
#include <linux/module.h>
3
#include <linux/interrupt.h>
4 5
#include <linux/irq.h>
#include <linux/spinlock.h>
6
#include <linux/list.h>
David Brownell's avatar
David Brownell committed
7 8 9 10 11
#include <linux/device.h>
#include <linux/err.h>
#include <linux/debugfs.h>
#include <linux/seq_file.h>
#include <linux/gpio.h>
12
#include <linux/of_gpio.h>
13
#include <linux/acpi_gpio.h>
14
#include <linux/idr.h>
15
#include <linux/slab.h>
16
#include <linux/acpi.h>
17
#include <linux/gpio/driver.h>
18

19 20
#define CREATE_TRACE_POINTS
#include <trace/events/gpio.h>
21

22
/* Implementation infrastructure for GPIO interfaces.
23
 *
24 25 26
 * The GPIO programming interface allows for inlining speed-critical
 * get/set operations for common cases, so that access to SOC-integrated
 * GPIOs can sometimes cost only an instruction or two per bit.
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
 */


/* When debugging, extend minimal trust to callers and platform code.
 * Also emit diagnostic messages that may help initial bringup, when
 * board setup or driver bugs are most common.
 *
 * Otherwise, minimize overhead in what may be bitbanging codepaths.
 */
#ifdef	DEBUG
#define	extra_checks	1
#else
#define	extra_checks	0
#endif

/* gpio_lock prevents conflicts during gpio_desc[] table updates.
 * While any GPIO is requested, its gpio_chip is not removable;
 * each GPIO's "requested" flag serves as a lock and refcount.
 */
static DEFINE_SPINLOCK(gpio_lock);

struct gpio_desc {
	struct gpio_chip	*chip;
	unsigned long		flags;
/* flag symbols are bit numbers */
#define FLAG_REQUESTED	0
#define FLAG_IS_OUT	1
54 55 56 57
#define FLAG_EXPORT	2	/* protected by sysfs_lock */
#define FLAG_SYSFS	3	/* exported via /sys/class/gpio/control */
#define FLAG_TRIG_FALL	4	/* trigger on falling edge */
#define FLAG_TRIG_RISE	5	/* trigger on rising edge */
58
#define FLAG_ACTIVE_LOW	6	/* value has active low */
59 60
#define FLAG_OPEN_DRAIN	7	/* Gpio is open drain type */
#define FLAG_OPEN_SOURCE 8	/* Gpio is open source type */
61
#define FLAG_USED_AS_IRQ 9	/* GPIO is connected to an IRQ */
62

63
#define ID_SHIFT	16	/* add new flags before this one */
64

65
#define GPIO_FLAGS_MASK		((1 << ID_SHIFT) - 1)
66
#define GPIO_TRIGGER_MASK	(BIT(FLAG_TRIG_FALL) | BIT(FLAG_TRIG_RISE))
67 68 69 70 71 72 73

#ifdef CONFIG_DEBUG_FS
	const char		*label;
#endif
};
static struct gpio_desc gpio_desc[ARCH_NR_GPIOS];

74 75
#define GPIO_OFFSET_VALID(chip, offset) (offset >= 0 && offset < chip->ngpio)

76 77
static DEFINE_MUTEX(gpio_lookup_lock);
static LIST_HEAD(gpio_lookup_list);
78 79
static LIST_HEAD(gpio_chips);

80
#ifdef CONFIG_GPIO_SYSFS
81
static DEFINE_IDR(dirent_idr);
82 83
#endif

84 85 86
static int gpiod_request(struct gpio_desc *desc, const char *label);
static void gpiod_free(struct gpio_desc *desc);

87 88
/* With descriptor prefix */

89
#ifdef CONFIG_DEBUG_FS
90 91
#define gpiod_emerg(desc, fmt, ...)					       \
	pr_emerg("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
92
                 ##__VA_ARGS__)
93 94
#define gpiod_crit(desc, fmt, ...)					       \
	pr_crit("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
95
                 ##__VA_ARGS__)
96 97
#define gpiod_err(desc, fmt, ...)					       \
	pr_err("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",  \
98
                 ##__VA_ARGS__)
99 100
#define gpiod_warn(desc, fmt, ...)					       \
	pr_warn("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
101
                 ##__VA_ARGS__)
102 103
#define gpiod_info(desc, fmt, ...)					       \
	pr_info("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?", \
104
                ##__VA_ARGS__)
105 106
#define gpiod_dbg(desc, fmt, ...)					       \
	pr_debug("gpio-%d (%s): " fmt, desc_to_gpio(desc), desc->label ? : "?",\
107 108
                 ##__VA_ARGS__)
#else
109
#define gpiod_emerg(desc, fmt, ...)					\
110
	pr_emerg("gpio-%d: " fmt, desc_to_gpio(desc), ##__VA_ARGS__)
111
#define gpiod_crit(desc, fmt, ...)					\
112
	pr_crit("gpio-%d: " fmt, desc_to_gpio(desc), ##__VA_ARGS__)
113
#define gpiod_err(desc, fmt, ...)					\
114
	pr_err("gpio-%d: " fmt, desc_to_gpio(desc), ##__VA_ARGS__)
115
#define gpiod_warn(desc, fmt, ...)					\
116
	pr_warn("gpio-%d: " fmt, desc_to_gpio(desc), ##__VA_ARGS__)
117
#define gpiod_info(desc, fmt, ...)					\
118
	pr_info("gpio-%d: " fmt, desc_to_gpio(desc), ##__VA_ARGS__)
119
#define gpiod_dbg(desc, fmt, ...)					\
120
	pr_debug("gpio-%d: " fmt, desc_to_gpio(desc), ##__VA_ARGS__)
121
#endif
122

123 124 125 126 127 128 129 130 131 132 133 134 135 136 137
/* With chip prefix */

#define chip_emerg(chip, fmt, ...)					\
	pr_emerg("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
#define chip_crit(chip, fmt, ...)					\
	pr_crit("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
#define chip_err(chip, fmt, ...)					\
	pr_err("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
#define chip_warn(chip, fmt, ...)					\
	pr_warn("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
#define chip_info(chip, fmt, ...)					\
	pr_info("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)
#define chip_dbg(chip, fmt, ...)					\
	pr_debug("GPIO chip %s: " fmt, chip->label, ##__VA_ARGS__)

138 139 140 141 142 143 144
static inline void desc_set_label(struct gpio_desc *d, const char *label)
{
#ifdef CONFIG_DEBUG_FS
	d->label = label;
#endif
}

145 146 147 148 149
/*
 * Return the GPIO number of the passed descriptor relative to its chip
 */
static int gpio_chip_hwgpio(const struct gpio_desc *desc)
{
150
	return desc - &desc->chip->desc[0];
151 152 153 154 155
}

/**
 * Convert a GPIO number to its descriptor
 */
156
struct gpio_desc *gpio_to_desc(unsigned gpio)
157 158 159 160 161 162
{
	if (WARN(!gpio_is_valid(gpio), "invalid GPIO %d\n", gpio))
		return NULL;
	else
		return &gpio_desc[gpio];
}
163
EXPORT_SYMBOL_GPL(gpio_to_desc);
164

165 166 167 168 169 170
/**
 * Convert an offset on a certain chip to a corresponding descriptor
 */
static struct gpio_desc *gpiochip_offset_to_desc(struct gpio_chip *chip,
						 unsigned int offset)
{
171 172
	if (offset >= chip->ngpio)
		return ERR_PTR(-EINVAL);
173

174
	return &chip->desc[offset];
175
}
176 177 178 179 180 181

/**
 * Convert a GPIO descriptor to the integer namespace.
 * This should disappear in the future but is needed since we still
 * use GPIO numbers for error messages and sysfs nodes
 */
182
int desc_to_gpio(const struct gpio_desc *desc)
183
{
184
	return desc - &gpio_desc[0];
185
}
186
EXPORT_SYMBOL_GPL(desc_to_gpio);
187 188


189 190 191 192
/* Warn when drivers omit gpio_request() calls -- legal but ill-advised
 * when setting direction, and otherwise illegal.  Until board setup code
 * and drivers use explicit requests everywhere (which won't happen when
 * those calls have no teeth) we can't avoid autorequesting.  This nag
David Brownell's avatar
David Brownell committed
193 194
 * message should motivate switching to explicit requests... so should
 * the weaker cleanup after faults, compared to gpio_request().
195 196 197 198
 *
 * NOTE: the autorequest mechanism is going away; at this point it's
 * only "legal" in the sense that (old) code using it won't break yet,
 * but instead only triggers a WARN() stack dump.
199
 */
200
static int gpio_ensure_requested(struct gpio_desc *desc)
201
{
202
	const struct gpio_chip *chip = desc->chip;
203
	const int gpio = desc_to_gpio(desc);
David Brownell's avatar
David Brownell committed
204

205 206
	if (WARN(test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0,
			"autorequest GPIO-%d\n", gpio)) {
David Brownell's avatar
David Brownell committed
207
		if (!try_module_get(chip->owner)) {
208 209
			gpiod_err(desc, "%s: module can't be gotten\n",
					__func__);
David Brownell's avatar
David Brownell committed
210 211 212 213
			clear_bit(FLAG_REQUESTED, &desc->flags);
			/* lose */
			return -EIO;
		}
214
		desc_set_label(desc, "[auto]");
David Brownell's avatar
David Brownell committed
215 216 217
		/* caller must chip->request() w/o spinlock */
		if (chip->request)
			return 1;
218
	}
David Brownell's avatar
David Brownell committed
219
	return 0;
220 221
}

222 223 224 225 226
/**
 * gpiod_to_chip - Return the GPIO chip to which a GPIO descriptor belongs
 * @desc:	descriptor to return the chip of
 */
struct gpio_chip *gpiod_to_chip(const struct gpio_desc *desc)
227
{
228
	return desc ? desc->chip : NULL;
229
}
230
EXPORT_SYMBOL_GPL(gpiod_to_chip);
231

232 233 234
/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
static int gpiochip_find_base(int ngpio)
{
235 236
	struct gpio_chip *chip;
	int base = ARCH_NR_GPIOS - ngpio;
237

238 239 240 241 242 243 244
	list_for_each_entry_reverse(chip, &gpio_chips, list) {
		/* found a free space? */
		if (chip->base + chip->ngpio <= base)
			break;
		else
			/* nope, check the space right before the chip */
			base = chip->base - ngpio;
245 246
	}

247
	if (gpio_is_valid(base)) {
248
		pr_debug("%s: found new base at %d\n", __func__, base);
249 250 251 252
		return base;
	} else {
		pr_err("%s: cannot find free range\n", __func__);
		return -ENOSPC;
Anton Vorontsov's avatar
Anton Vorontsov committed
253 254 255
	}
}

256 257 258 259 260 261 262 263 264
/**
 * gpiod_get_direction - return the current direction of a GPIO
 * @desc:	GPIO to get the direction of
 *
 * Return GPIOF_DIR_IN or GPIOF_DIR_OUT, or an error code in case of error.
 *
 * This function may sleep if gpiod_cansleep() is true.
 */
int gpiod_get_direction(const struct gpio_desc *desc)
265 266
{
	struct gpio_chip	*chip;
267
	unsigned		offset;
268 269
	int			status = -EINVAL;

270 271
	chip = gpiod_to_chip(desc);
	offset = gpio_chip_hwgpio(desc);
272 273 274 275

	if (!chip->get_direction)
		return status;

276
	status = chip->get_direction(chip, offset);
277 278 279
	if (status > 0) {
		/* GPIOF_DIR_IN, or other positive */
		status = 1;
280 281 282
		/* FLAG_IS_OUT is just a cache of the result of get_direction(),
		 * so it does not affect constness per se */
		clear_bit(FLAG_IS_OUT, &((struct gpio_desc *)desc)->flags);
283 284 285
	}
	if (status == 0) {
		/* GPIOF_DIR_OUT */
286
		set_bit(FLAG_IS_OUT, &((struct gpio_desc *)desc)->flags);
287 288 289
	}
	return status;
}
290
EXPORT_SYMBOL_GPL(gpiod_get_direction);
291

David Brownell's avatar
David Brownell committed
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
#ifdef CONFIG_GPIO_SYSFS

/* lock protects against unexport_gpio() being called while
 * sysfs files are active.
 */
static DEFINE_MUTEX(sysfs_lock);

/*
 * /sys/class/gpio/gpioN... only for GPIOs that are exported
 *   /direction
 *      * MAY BE OMITTED if kernel won't allow direction changes
 *      * is read/write as "in" or "out"
 *      * may also be written as "high" or "low", initializing
 *        output value as specified ("out" implies "low")
 *   /value
 *      * always readable, subject to hardware behavior
 *      * may be writable, as zero/nonzero
309 310 311 312
 *   /edge
 *      * configures behavior of poll(2) on /value
 *      * available only if pin can generate IRQs on input
 *      * is read/write as "none", "falling", "rising", or "both"
313 314 315 316 317
 *   /active_low
 *      * configures polarity of /value
 *      * is read/write as zero/nonzero
 *      * also affects existing and subsequent "falling" and "rising"
 *        /edge configuration
David Brownell's avatar
David Brownell committed
318 319 320 321 322
 */

static ssize_t gpio_direction_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
323
	const struct gpio_desc	*desc = dev_get_drvdata(dev);
David Brownell's avatar
David Brownell committed
324 325 326 327
	ssize_t			status;

	mutex_lock(&sysfs_lock);

328
	if (!test_bit(FLAG_EXPORT, &desc->flags)) {
David Brownell's avatar
David Brownell committed
329
		status = -EIO;
330
	} else {
331
		gpiod_get_direction(desc);
David Brownell's avatar
David Brownell committed
332 333 334
		status = sprintf(buf, "%s\n",
			test_bit(FLAG_IS_OUT, &desc->flags)
				? "out" : "in");
335
	}
David Brownell's avatar
David Brownell committed
336 337 338 339 340 341 342 343

	mutex_unlock(&sysfs_lock);
	return status;
}

static ssize_t gpio_direction_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t size)
{
344
	struct gpio_desc	*desc = dev_get_drvdata(dev);
David Brownell's avatar
David Brownell committed
345 346 347 348 349 350 351
	ssize_t			status;

	mutex_lock(&sysfs_lock);

	if (!test_bit(FLAG_EXPORT, &desc->flags))
		status = -EIO;
	else if (sysfs_streq(buf, "high"))
352
		status = gpiod_direction_output(desc, 1);
David Brownell's avatar
David Brownell committed
353
	else if (sysfs_streq(buf, "out") || sysfs_streq(buf, "low"))
354
		status = gpiod_direction_output(desc, 0);
David Brownell's avatar
David Brownell committed
355
	else if (sysfs_streq(buf, "in"))
356
		status = gpiod_direction_input(desc);
David Brownell's avatar
David Brownell committed
357 358 359 360 361 362 363
	else
		status = -EINVAL;

	mutex_unlock(&sysfs_lock);
	return status ? : size;
}

364
static /* const */ DEVICE_ATTR(direction, 0644,
David Brownell's avatar
David Brownell committed
365 366 367 368 369
		gpio_direction_show, gpio_direction_store);

static ssize_t gpio_value_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
370
	struct gpio_desc	*desc = dev_get_drvdata(dev);
David Brownell's avatar
David Brownell committed
371 372 373 374
	ssize_t			status;

	mutex_lock(&sysfs_lock);

375
	if (!test_bit(FLAG_EXPORT, &desc->flags))
David Brownell's avatar
David Brownell committed
376
		status = -EIO;
377 378
	else
		status = sprintf(buf, "%d\n", gpiod_get_value_cansleep(desc));
David Brownell's avatar
David Brownell committed
379 380 381 382 383 384 385 386

	mutex_unlock(&sysfs_lock);
	return status;
}

static ssize_t gpio_value_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t size)
{
387
	struct gpio_desc	*desc = dev_get_drvdata(dev);
David Brownell's avatar
David Brownell committed
388 389 390 391 392 393 394 395 396 397 398
	ssize_t			status;

	mutex_lock(&sysfs_lock);

	if (!test_bit(FLAG_EXPORT, &desc->flags))
		status = -EIO;
	else if (!test_bit(FLAG_IS_OUT, &desc->flags))
		status = -EPERM;
	else {
		long		value;

399
		status = kstrtol(buf, 0, &value);
David Brownell's avatar
David Brownell committed
400
		if (status == 0) {
401
			gpiod_set_value_cansleep(desc, value);
David Brownell's avatar
David Brownell committed
402 403 404 405 406 407 408 409
			status = size;
		}
	}

	mutex_unlock(&sysfs_lock);
	return status;
}

410
static const DEVICE_ATTR(value, 0644,
David Brownell's avatar
David Brownell committed
411 412
		gpio_value_show, gpio_value_store);

413 414
static irqreturn_t gpio_sysfs_irq(int irq, void *priv)
{
415
	struct sysfs_dirent	*value_sd = priv;
416

417
	sysfs_notify_dirent(value_sd);
418 419 420 421 422 423
	return IRQ_HANDLED;
}

static int gpio_setup_irq(struct gpio_desc *desc, struct device *dev,
		unsigned long gpio_flags)
{
424
	struct sysfs_dirent	*value_sd;
425 426 427 428 429 430
	unsigned long		irq_flags;
	int			ret, irq, id;

	if ((desc->flags & GPIO_TRIGGER_MASK) == gpio_flags)
		return 0;

431
	irq = gpiod_to_irq(desc);
432 433 434
	if (irq < 0)
		return -EIO;

435 436 437 438
	id = desc->flags >> ID_SHIFT;
	value_sd = idr_find(&dirent_idr, id);
	if (value_sd)
		free_irq(irq, value_sd);
439 440 441 442

	desc->flags &= ~GPIO_TRIGGER_MASK;

	if (!gpio_flags) {
443
		gpiod_unlock_as_irq(desc);
444
		ret = 0;
445
		goto free_id;
446 447 448 449
	}

	irq_flags = IRQF_SHARED;
	if (test_bit(FLAG_TRIG_FALL, &gpio_flags))
450 451
		irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
			IRQF_TRIGGER_RISING : IRQF_TRIGGER_FALLING;
452
	if (test_bit(FLAG_TRIG_RISE, &gpio_flags))
453 454
		irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
			IRQF_TRIGGER_FALLING : IRQF_TRIGGER_RISING;
455

456
	if (!value_sd) {
Tejun Heo's avatar
Tejun Heo committed
457
		value_sd = sysfs_get_dirent(dev->kobj.sd, "value");
458 459
		if (!value_sd) {
			ret = -ENODEV;
460 461 462
			goto err_out;
		}

Tejun Heo's avatar
Tejun Heo committed
463 464
		ret = idr_alloc(&dirent_idr, value_sd, 1, 0, GFP_KERNEL);
		if (ret < 0)
465
			goto free_sd;
Tejun Heo's avatar
Tejun Heo committed
466
		id = ret;
467 468

		desc->flags &= GPIO_FLAGS_MASK;
469
		desc->flags |= (unsigned long)id << ID_SHIFT;
470

471
		if (desc->flags >> ID_SHIFT != id) {
472 473 474 475 476
			ret = -ERANGE;
			goto free_id;
		}
	}

477
	ret = request_any_context_irq(irq, gpio_sysfs_irq, irq_flags,
478
				"gpiolib", value_sd);
479
	if (ret < 0)
480
		goto free_id;
481

482 483 484 485 486 487
	ret = gpiod_lock_as_irq(desc);
	if (ret < 0) {
		gpiod_warn(desc, "failed to flag the GPIO for IRQ\n");
		goto free_id;
	}

488 489 490 491
	desc->flags |= gpio_flags;
	return 0;

free_id:
492
	idr_remove(&dirent_idr, id);
493
	desc->flags &= GPIO_FLAGS_MASK;
494 495 496
free_sd:
	if (value_sd)
		sysfs_put(value_sd);
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567
err_out:
	return ret;
}

static const struct {
	const char *name;
	unsigned long flags;
} trigger_types[] = {
	{ "none",    0 },
	{ "falling", BIT(FLAG_TRIG_FALL) },
	{ "rising",  BIT(FLAG_TRIG_RISE) },
	{ "both",    BIT(FLAG_TRIG_FALL) | BIT(FLAG_TRIG_RISE) },
};

static ssize_t gpio_edge_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	const struct gpio_desc	*desc = dev_get_drvdata(dev);
	ssize_t			status;

	mutex_lock(&sysfs_lock);

	if (!test_bit(FLAG_EXPORT, &desc->flags))
		status = -EIO;
	else {
		int i;

		status = 0;
		for (i = 0; i < ARRAY_SIZE(trigger_types); i++)
			if ((desc->flags & GPIO_TRIGGER_MASK)
					== trigger_types[i].flags) {
				status = sprintf(buf, "%s\n",
						 trigger_types[i].name);
				break;
			}
	}

	mutex_unlock(&sysfs_lock);
	return status;
}

static ssize_t gpio_edge_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t size)
{
	struct gpio_desc	*desc = dev_get_drvdata(dev);
	ssize_t			status;
	int			i;

	for (i = 0; i < ARRAY_SIZE(trigger_types); i++)
		if (sysfs_streq(trigger_types[i].name, buf))
			goto found;
	return -EINVAL;

found:
	mutex_lock(&sysfs_lock);

	if (!test_bit(FLAG_EXPORT, &desc->flags))
		status = -EIO;
	else {
		status = gpio_setup_irq(desc, dev, trigger_types[i].flags);
		if (!status)
			status = size;
	}

	mutex_unlock(&sysfs_lock);

	return status;
}

static DEVICE_ATTR(edge, 0644, gpio_edge_show, gpio_edge_store);

568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624
static int sysfs_set_active_low(struct gpio_desc *desc, struct device *dev,
				int value)
{
	int			status = 0;

	if (!!test_bit(FLAG_ACTIVE_LOW, &desc->flags) == !!value)
		return 0;

	if (value)
		set_bit(FLAG_ACTIVE_LOW, &desc->flags);
	else
		clear_bit(FLAG_ACTIVE_LOW, &desc->flags);

	/* reconfigure poll(2) support if enabled on one edge only */
	if (dev != NULL && (!!test_bit(FLAG_TRIG_RISE, &desc->flags) ^
				!!test_bit(FLAG_TRIG_FALL, &desc->flags))) {
		unsigned long trigger_flags = desc->flags & GPIO_TRIGGER_MASK;

		gpio_setup_irq(desc, dev, 0);
		status = gpio_setup_irq(desc, dev, trigger_flags);
	}

	return status;
}

static ssize_t gpio_active_low_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	const struct gpio_desc	*desc = dev_get_drvdata(dev);
	ssize_t			status;

	mutex_lock(&sysfs_lock);

	if (!test_bit(FLAG_EXPORT, &desc->flags))
		status = -EIO;
	else
		status = sprintf(buf, "%d\n",
				!!test_bit(FLAG_ACTIVE_LOW, &desc->flags));

	mutex_unlock(&sysfs_lock);

	return status;
}

static ssize_t gpio_active_low_store(struct device *dev,
		struct device_attribute *attr, const char *buf, size_t size)
{
	struct gpio_desc	*desc = dev_get_drvdata(dev);
	ssize_t			status;

	mutex_lock(&sysfs_lock);

	if (!test_bit(FLAG_EXPORT, &desc->flags)) {
		status = -EIO;
	} else {
		long		value;

625
		status = kstrtol(buf, 0, &value);
626 627 628 629 630 631 632 633 634 635 636 637
		if (status == 0)
			status = sysfs_set_active_low(desc, dev, value != 0);
	}

	mutex_unlock(&sysfs_lock);

	return status ? : size;
}

static const DEVICE_ATTR(active_low, 0644,
		gpio_active_low_show, gpio_active_low_store);

David Brownell's avatar
David Brownell committed
638 639
static const struct attribute *gpio_attrs[] = {
	&dev_attr_value.attr,
640
	&dev_attr_active_low.attr,
David Brownell's avatar
David Brownell committed
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
	NULL,
};

static const struct attribute_group gpio_attr_group = {
	.attrs = (struct attribute **) gpio_attrs,
};

/*
 * /sys/class/gpio/gpiochipN/
 *   /base ... matching gpio_chip.base (N)
 *   /label ... matching gpio_chip.label
 *   /ngpio ... matching gpio_chip.ngpio
 */

static ssize_t chip_base_show(struct device *dev,
			       struct device_attribute *attr, char *buf)
{
	const struct gpio_chip	*chip = dev_get_drvdata(dev);

	return sprintf(buf, "%d\n", chip->base);
}
static DEVICE_ATTR(base, 0444, chip_base_show, NULL);

static ssize_t chip_label_show(struct device *dev,
			       struct device_attribute *attr, char *buf)
{
	const struct gpio_chip	*chip = dev_get_drvdata(dev);

	return sprintf(buf, "%s\n", chip->label ? : "");
}
static DEVICE_ATTR(label, 0444, chip_label_show, NULL);

static ssize_t chip_ngpio_show(struct device *dev,
			       struct device_attribute *attr, char *buf)
{
	const struct gpio_chip	*chip = dev_get_drvdata(dev);

	return sprintf(buf, "%u\n", chip->ngpio);
}
static DEVICE_ATTR(ngpio, 0444, chip_ngpio_show, NULL);

static const struct attribute *gpiochip_attrs[] = {
	&dev_attr_base.attr,
	&dev_attr_label.attr,
	&dev_attr_ngpio.attr,
	NULL,
};

static const struct attribute_group gpiochip_attr_group = {
	.attrs = (struct attribute **) gpiochip_attrs,
};

/*
 * /sys/class/gpio/export ... write-only
 *	integer N ... number of GPIO to export (full access)
 * /sys/class/gpio/unexport ... write-only
 *	integer N ... number of GPIO to unexport
 */
699 700 701
static ssize_t export_store(struct class *class,
				struct class_attribute *attr,
				const char *buf, size_t len)
David Brownell's avatar
David Brownell committed
702
{
703 704 705
	long			gpio;
	struct gpio_desc	*desc;
	int			status;
David Brownell's avatar
David Brownell committed
706

707
	status = kstrtol(buf, 0, &gpio);
David Brownell's avatar
David Brownell committed
708 709 710
	if (status < 0)
		goto done;

711
	desc = gpio_to_desc(gpio);
712 713 714 715 716
	/* reject invalid GPIOs */
	if (!desc) {
		pr_warn("%s: invalid GPIO %ld\n", __func__, gpio);
		return -EINVAL;
	}
717

David Brownell's avatar
David Brownell committed
718 719 720 721 722
	/* No extra locking here; FLAG_SYSFS just signifies that the
	 * request and export were done by on behalf of userspace, so
	 * they may be undone on its behalf too.
	 */

723
	status = gpiod_request(desc, "sysfs");
724 725 726
	if (status < 0) {
		if (status == -EPROBE_DEFER)
			status = -ENODEV;
David Brownell's avatar
David Brownell committed
727
		goto done;
728
	}
729
	status = gpiod_export(desc, true);
David Brownell's avatar
David Brownell committed
730
	if (status < 0)
731
		gpiod_free(desc);
David Brownell's avatar
David Brownell committed
732
	else
733
		set_bit(FLAG_SYSFS, &desc->flags);
David Brownell's avatar
David Brownell committed
734 735 736 737 738 739 740

done:
	if (status)
		pr_debug("%s: status %d\n", __func__, status);
	return status ? : len;
}

741 742 743
static ssize_t unexport_store(struct class *class,
				struct class_attribute *attr,
				const char *buf, size_t len)
David Brownell's avatar
David Brownell committed
744
{
745 746 747
	long			gpio;
	struct gpio_desc	*desc;
	int			status;
David Brownell's avatar
David Brownell committed
748

749
	status = kstrtol(buf, 0, &gpio);
David Brownell's avatar
David Brownell committed
750 751 752
	if (status < 0)
		goto done;

753
	desc = gpio_to_desc(gpio);
David Brownell's avatar
David Brownell committed
754
	/* reject bogus commands (gpio_unexport ignores them) */
755 756 757 758 759 760
	if (!desc) {
		pr_warn("%s: invalid GPIO %ld\n", __func__, gpio);
		return -EINVAL;
	}

	status = -EINVAL;
David Brownell's avatar
David Brownell committed
761 762 763 764 765

	/* No extra locking here; FLAG_SYSFS just signifies that the
	 * request and export were done by on behalf of userspace, so
	 * they may be undone on its behalf too.
	 */
766
	if (test_and_clear_bit(FLAG_SYSFS, &desc->flags)) {
David Brownell's avatar
David Brownell committed
767
		status = 0;
768
		gpiod_free(desc);
David Brownell's avatar
David Brownell committed
769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
	}
done:
	if (status)
		pr_debug("%s: status %d\n", __func__, status);
	return status ? : len;
}

static struct class_attribute gpio_class_attrs[] = {
	__ATTR(export, 0200, NULL, export_store),
	__ATTR(unexport, 0200, NULL, unexport_store),
	__ATTR_NULL,
};

static struct class gpio_class = {
	.name =		"gpio",
	.owner =	THIS_MODULE,

	.class_attrs =	gpio_class_attrs,
};


/**
791
 * gpiod_export - export a GPIO through sysfs
David Brownell's avatar
David Brownell committed
792 793 794 795 796 797 798 799 800 801 802 803 804
 * @gpio: gpio to make available, already requested
 * @direction_may_change: true if userspace may change gpio direction
 * Context: arch_initcall or later
 *
 * When drivers want to make a GPIO accessible to userspace after they
 * have requested it -- perhaps while debugging, or as part of their
 * public interface -- they may use this routine.  If the GPIO can
 * change direction (some can't) and the caller allows it, userspace
 * will see "direction" sysfs attribute which may be used to change
 * the gpio's direction.  A "value" attribute will always be provided.
 *
 * Returns zero on success, else an error.
 */
805
int gpiod_export(struct gpio_desc *desc, bool direction_may_change)
David Brownell's avatar
David Brownell committed
806 807
{
	unsigned long		flags;
Ryan Mallon's avatar
Ryan Mallon committed
808
	int			status;
809
	const char		*ioname = NULL;
Ryan Mallon's avatar
Ryan Mallon committed
810
	struct device		*dev;
811
	int			offset;
David Brownell's avatar
David Brownell committed
812 813 814 815 816 817 818

	/* can't export until sysfs is available ... */
	if (!gpio_class.p) {
		pr_debug("%s: called too early!\n", __func__);
		return -ENOENT;
	}

819 820
	if (!desc) {
		pr_debug("%s: invalid gpio descriptor\n", __func__);
Ryan Mallon's avatar
Ryan Mallon committed
821 822
		return -EINVAL;
	}
David Brownell's avatar
David Brownell committed
823 824 825 826

	mutex_lock(&sysfs_lock);

	spin_lock_irqsave(&gpio_lock, flags);
Ryan Mallon's avatar
Ryan Mallon committed
827 828 829
	if (!test_bit(FLAG_REQUESTED, &desc->flags) ||
	     test_bit(FLAG_EXPORT, &desc->flags)) {
		spin_unlock_irqrestore(&gpio_lock, flags);
830 831
		gpiod_dbg(desc, "%s: unavailable (requested=%d, exported=%d)\n",
				__func__,
Ryan Mallon's avatar
Ryan Mallon committed
832 833
				test_bit(FLAG_REQUESTED, &desc->flags),
				test_bit(FLAG_EXPORT, &desc->flags));
834 835
		status = -EPERM;
		goto fail_unlock;
David Brownell's avatar
David Brownell committed
836
	}
Ryan Mallon's avatar
Ryan Mallon committed
837 838 839

	if (!desc->chip->direction_input || !desc->chip->direction_output)
		direction_may_change = false;
David Brownell's avatar
David Brownell committed
840 841
	spin_unlock_irqrestore(&gpio_lock, flags);

842 843 844
	offset = gpio_chip_hwgpio(desc);
	if (desc->chip->names && desc->chip->names[offset])
		ioname = desc->chip->names[offset];
845

Ryan Mallon's avatar
Ryan Mallon committed
846
	dev = device_create(&gpio_class, desc->chip->dev, MKDEV(0, 0),
847 848
			    desc, ioname ? ioname : "gpio%u",
			    desc_to_gpio(desc));
Ryan Mallon's avatar
Ryan Mallon committed
849 850 851
	if (IS_ERR(dev)) {
		status = PTR_ERR(dev);
		goto fail_unlock;
David Brownell's avatar
David Brownell committed
852 853
	}

Ryan Mallon's avatar
Ryan Mallon committed
854
	status = sysfs_create_group(&dev->kobj, &gpio_attr_group);
David Brownell's avatar
David Brownell committed
855
	if (status)
Ryan Mallon's avatar
Ryan Mallon committed
856
		goto fail_unregister_device;
David Brownell's avatar
David Brownell committed
857

Ryan Mallon's avatar
Ryan Mallon committed
858 859 860 861 862 863
	if (direction_may_change) {
		status = device_create_file(dev, &dev_attr_direction);
		if (status)
			goto fail_unregister_device;
	}

864
	if (gpiod_to_irq(desc) >= 0 && (direction_may_change ||
Ryan Mallon's avatar
Ryan Mallon committed
865 866 867 868 869
				       !test_bit(FLAG_IS_OUT, &desc->flags))) {
		status = device_create_file(dev, &dev_attr_edge);
		if (status)
			goto fail_unregister_device;
	}
David Brownell's avatar
David Brownell committed
870

Ryan Mallon's avatar
Ryan Mallon committed
871 872 873 874 875 876 877 878
	set_bit(FLAG_EXPORT, &desc->flags);
	mutex_unlock(&sysfs_lock);
	return 0;

fail_unregister_device:
	device_unregister(dev);
fail_unlock:
	mutex_unlock(&sysfs_lock);
879
	gpiod_dbg(desc, "%s: status %d\n", __func__, status);
David Brownell's avatar
David Brownell committed
880 881
	return status;
}
882
EXPORT_SYMBOL_GPL(gpiod_export);
David Brownell's avatar
David Brownell committed
883

884
static int match_export(struct device *dev, const void *data)
David Brownell's avatar
David Brownell committed
885 886 887 888
{
	return dev_get_drvdata(dev) == data;
}

889
/**
890
 * gpiod_export_link - create a sysfs link to an exported GPIO node
891 892 893 894 895 896 897 898 899
 * @dev: device under which to create symlink
 * @name: name of the symlink
 * @gpio: gpio to create symlink to, already exported
 *
 * Set up a symlink from /sys/.../dev/name to /sys/class/gpio/gpioN
 * node. Caller is responsible for unlinking.
 *
 * Returns zero on success, else an error.
 */
900 901
int gpiod_export_link(struct device *dev, const char *name,
		      struct gpio_desc *desc)
902 903 904
{
	int			status = -EINVAL;

905 906 907 908
	if (!desc) {
		pr_warn("%s: invalid GPIO\n", __func__);
		return -EINVAL;
	}
909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926

	mutex_lock(&sysfs_lock);

	if (test_bit(FLAG_EXPORT, &desc->flags)) {
		struct device *tdev;

		tdev = class_find_device(&gpio_class, NULL, desc, match_export);
		if (tdev != NULL) {
			status = sysfs_create_link(&dev->kobj, &tdev->kobj,
						name);
		} else {
			status = -ENODEV;
		}
	}

	mutex_unlock(&sysfs_lock);

	if (status)
927
		gpiod_dbg(desc, "%s: status %d\n", __func__, status);
928 929 930

	return status;
}
931
EXPORT_SYMBOL_GPL(gpiod_export_link);
932 933

/**
934
 * gpiod_sysfs_set_active_low - set the polarity of gpio sysfs value
935 936 937 938 939 940 941 942 943 944
 * @gpio: gpio to change
 * @value: non-zero to use active low, i.e. inverted values
 *
 * Set the polarity of /sys/class/gpio/gpioN/value sysfs attribute.
 * The GPIO does not have to be exported yet.  If poll(2) support has
 * been enabled for either rising or falling edge, it will be
 * reconfigured to follow the new polarity.
 *
 * Returns zero on success, else an error.
 */
945
int gpiod_sysfs_set_active_low(struct gpio_desc *desc, int value)
946 947 948 949
{
	struct device		*dev = NULL;
	int			status = -EINVAL;

950 951 952 953
	if (!desc) {
		pr_warn("%s: invalid GPIO\n", __func__);
		return -EINVAL;
	}
954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970

	mutex_lock(&sysfs_lock);

	if (test_bit(FLAG_EXPORT, &desc->flags)) {
		dev = class_find_device(&gpio_class, NULL, desc, match_export);
		if (dev == NULL) {
			status = -ENODEV;
			goto unlock;
		}
	}

	status = sysfs_set_active_low(desc, dev, value);

unlock:
	mutex_unlock(&sysfs_lock);

	if (status)
971
		gpiod_dbg(desc, "%s: status %d\n", __func__, status);
972 973 974

	return status;
}
975
EXPORT_SYMBOL_GPL(gpiod_sysfs_set_active_low);
976

David Brownell's avatar
David Brownell committed
977
/**
978
 * gpiod_unexport - reverse effect of gpio_export()
David Brownell's avatar
David Brownell committed
979 980 981 982
 * @gpio: gpio to make unavailable
 *
 * This is implicit on gpio_free().
 */
983
void gpiod_unexport(struct gpio_desc *desc)
David Brownell's avatar
David Brownell committed
984
{
985
	int			status = 0;
986
	struct device		*dev = NULL;
David Brownell's avatar
David Brownell committed
987

988
	if (!desc) {
989 990
		pr_warn("%s: invalid GPIO\n", __func__);
		return;
991
	}
David Brownell's avatar
David Brownell committed
992 993 994 995 996 997 998

	mutex_lock(&sysfs_lock);

	if (test_bit(FLAG_EXPORT, &desc->flags)) {

		dev = class_find_device(&gpio_class, NULL, desc, match_export);
		if (dev) {
999
			gpio_setup_irq(desc, dev, 0);
David Brownell's avatar
David Brownell committed
1000 1001 1002 1003 1004 1005
			clear_bit(FLAG_EXPORT, &desc->flags);
		} else
			status = -ENODEV;
	}

	mutex_unlock(&sysfs_lock);
1006

1007 1008 1009 1010
	if (dev) {
		device_unregister(dev);
		put_device(dev);
	}
1011

David Brownell's avatar
David Brownell committed
1012
	if (status)
1013
		gpiod_dbg(desc, "%s: status %d\n", __func__, status);
1014
}
1015
EXPORT_SYMBOL_GPL(gpiod_unexport);
David Brownell's avatar
David Brownell committed
1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033

static int gpiochip_export(struct gpio_chip *chip)
{
	int		status;
	struct device	*dev;

	/* Many systems register gpio chips for SOC support very early,
	 * before driver model support is available.  In those cases we
	 * export this later, in gpiolib_sysfs_init() ... here we just
	 * verify that _some_ field of gpio_class got initialized.
	 */
	if (!gpio_class.p)
		return 0;

	/* use chip->base for the ID; it's already known to be unique */
	mutex_lock(&sysfs_lock);
	dev = device_create(&gpio_class, chip->dev, MKDEV(0, 0), chip,
				"gpiochip%d", chip->base);
1034
	if (!IS_ERR(dev)) {
David Brownell's avatar
David Brownell committed
1035 1036 1037
		status = sysfs_create_group(&dev->kobj,
				&gpiochip_attr_group);
	} else
1038
		status = PTR_ERR(dev);
David Brownell's avatar
David Brownell committed
1039 1040 1041 1042 1043 1044 1045 1046
	chip->exported = (status == 0);
	mutex_unlock(&sysfs_lock);

	if (status) {
		unsigned long	flags;
		unsigned	gpio;

		spin_lock_irqsave(&gpio_lock, flags);
1047 1048 1049
		gpio = 0;
		while (gpio < chip->ngpio)
			chip->desc[gpio++].chip = NULL;
David Brownell's avatar
David Brownell committed
1050 1051
		spin_unlock_irqrestore(&gpio_lock, flags);

1052
		chip_dbg(chip, "%s: status %d\n", __func__, status);
David Brownell's avatar
David Brownell committed
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
	}

	return status;
}

static void gpiochip_unexport(struct gpio_chip *chip)
{
	int			status;
	struct device		*dev;

	mutex_lock(&sysfs_lock);
	dev = class_find_device(&gpio_class, NULL, chip, match_export);
	if (dev) {
		put_device(dev);
		device_unregister(dev);
1068
		chip->exported = false;
David Brownell's avatar
David Brownell committed
1069 1070 1071 1072 1073 1074
		status = 0;
	} else
		status = -ENODEV;
	mutex_unlock(&sysfs_lock);

	if (status)
1075
		chip_dbg(chip, "%s: status %d\n", __func__, status);
David Brownell's avatar
David Brownell committed
1076 1077 1078 1079 1080 1081
}

static int __init gpiolib_sysfs_init(void)
{
	int		status;
	unsigned long	flags;
1082
	struct gpio_chip *chip;
David Brownell's avatar
David Brownell committed
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094

	status = class_register(&gpio_class);
	if (status < 0)
		return status;

	/* Scan and register the gpio_chips which registered very
	 * early (e.g. before the class_register above was called).
	 *
	 * We run before arch_initcall() so chip->dev nodes can have
	 * registered, and so arch_initcall() can always gpio_export().
	 */
	spin_lock_irqsave(&gpio_lock, flags);
1095
	list_for_each_entry(chip, &gpio_chips, list) {
David Brownell's avatar
David Brownell committed
1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
		if (!chip || chip->exported)
			continue;

		spin_unlock_irqrestore(&gpio_lock, flags);
		status = gpiochip_export(chip);
		spin_lock_irqsave(&gpio_lock, flags);
	}
	spin_unlock_irqrestore(&gpio_lock, flags);


	return status;
}
postcore_initcall(gpiolib_sysfs_init);

#else
static inline int gpiochip_export(struct gpio_chip *chip)
{
	return 0;
}

static inline void gpiochip_unexport(struct gpio_chip *chip)
{
}

#endif /* CONFIG_GPIO_SYSFS */

1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158
/*
 * Add a new chip to the global chips list, keeping the list of chips sorted
 * by base order.
 *
 * Return -EBUSY if the new chip overlaps with some other chip's integer
 * space.
 */
static int gpiochip_add_to_list(struct gpio_chip *chip)
{
	struct list_head *pos = &gpio_chips;
	struct gpio_chip *_chip;
	int err = 0;

	/* find where to insert our chip */
	list_for_each(pos, &gpio_chips) {
		_chip = list_entry(pos, struct gpio_chip, list);
		/* shall we insert before _chip? */
		if (_chip->base >= chip->base + chip->ngpio)
			break;
	}

	/* are we stepping on the chip right before? */
	if (pos != &gpio_chips && pos->prev != &gpio_chips) {
		_chip = list_entry(pos->prev, struct gpio_chip, list);
		if (_chip->base + _chip->ngpio > chip->base) {
			dev_err(chip->dev,
			       "GPIO integer space overlap, cannot add chip\n");
			err = -EBUSY;
		}
	}

	if (!err)
		list_add_tail(&chip->list, pos);

	return err;
}

1159 1160 1161 1162 1163 1164 1165 1166
/**
 * gpiochip_add() - register a gpio_chip
 * @chip: the chip to register, with chip->base initialized
 * Context: potentially before irqs or kmalloc will work
 *
 * Returns a negative errno if the chip can't be registered, such as
 * because the chip->base is invalid or already associated with a
 * different chip.  Otherwise it returns zero as a success code.
1167
 *
David Brownell's avatar
David Brownell committed
1168 1169 1170 1171 1172
 * When gpiochip_add() is called very early during boot, so that GPIOs
 * can be freely used, the chip->dev device must be registered before
 * the gpio framework's arch_initcall().  Otherwise sysfs initialization
 * for GPIOs will fail rudely.
 *
1173 1174
 * If chip->base is negative, this requests dynamic assignment of
 * a range of valid GPIOs.
1175 1176 1177 1178 1179 1180
 */
int gpiochip_add(struct gpio_chip *chip)
{
	unsigned long	flags;
	int		status = 0;
	unsigned	id;
1181
	int		base = chip->base;
1182

Trent Piepho's avatar
Trent Piepho committed
1183
	if ((!gpio_is_valid(base) || !gpio_is_valid(base + chip->ngpio - 1))
1184
			&& base >= 0) {
1185 1186 1187 1188 1189 1190
		status = -EINVAL;
		goto fail;
	}

	spin_lock_irqsave(&gpio_lock, flags);