gpiolib.c 49.3 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>
David Brownell's avatar
David Brownell committed
6 7 8 9 10
#include <linux/device.h>
#include <linux/err.h>
#include <linux/debugfs.h>
#include <linux/seq_file.h>
#include <linux/gpio.h>
11
#include <linux/of_gpio.h>
12
#include <linux/idr.h>
13
#include <linux/slab.h>
14

15 16
#define CREATE_TRACE_POINTS
#include <trace/events/gpio.h>
17 18 19 20 21 22 23 24 25 26 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 54

/* Optional implementation infrastructure for GPIO interfaces.
 *
 * Platforms may want to use this if they tend to use very many GPIOs
 * that aren't part of a System-On-Chip core; or across I2C/SPI/etc.
 *
 * When kernel footprint or instruction count is an issue, simpler
 * implementations may be preferred.  The GPIO programming interface
 * allows for inlining speed-critical get/set operations for common
 * cases, so that access to SOC-integrated GPIOs can sometimes cost
 * only an instruction or two per bit.
 */


/* 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
Anton Vorontsov's avatar
Anton Vorontsov committed
55
#define FLAG_RESERVED	2
David Brownell's avatar
David Brownell committed
56 57
#define FLAG_EXPORT	3	/* protected by sysfs_lock */
#define FLAG_SYSFS	4	/* exported via /sys/class/gpio/control */
58 59
#define FLAG_TRIG_FALL	5	/* trigger on falling edge */
#define FLAG_TRIG_RISE	6	/* trigger on rising edge */
60
#define FLAG_ACTIVE_LOW	7	/* sysfs value has active low */
61
#define FLAG_OPEN_DRAIN	8	/* Gpio is open drain type */
62
#define FLAG_OPEN_SOURCE 9	/* Gpio is open source type */
63

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

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

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

75
#ifdef CONFIG_GPIO_SYSFS
76
static DEFINE_IDR(dirent_idr);
77 78
#endif

79 80 81 82 83 84 85 86 87 88 89
static inline void desc_set_label(struct gpio_desc *d, const char *label)
{
#ifdef CONFIG_DEBUG_FS
	d->label = label;
#endif
}

/* 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
90 91
 * message should motivate switching to explicit requests... so should
 * the weaker cleanup after faults, compared to gpio_request().
92 93 94 95
 *
 * 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.
96
 */
David Brownell's avatar
David Brownell committed
97
static int gpio_ensure_requested(struct gpio_desc *desc, unsigned offset)
98
{
99 100
	const struct gpio_chip *chip = desc->chip;
	const int gpio = chip->base + offset;
David Brownell's avatar
David Brownell committed
101

102 103
	if (WARN(test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0,
			"autorequest GPIO-%d\n", gpio)) {
David Brownell's avatar
David Brownell committed
104 105 106 107 108 109
		if (!try_module_get(chip->owner)) {
			pr_err("GPIO-%d: module can't be gotten \n", gpio);
			clear_bit(FLAG_REQUESTED, &desc->flags);
			/* lose */
			return -EIO;
		}
110
		desc_set_label(desc, "[auto]");
David Brownell's avatar
David Brownell committed
111 112 113
		/* caller must chip->request() w/o spinlock */
		if (chip->request)
			return 1;
114
	}
David Brownell's avatar
David Brownell committed
115
	return 0;
116 117 118
}

/* caller holds gpio_lock *OR* gpio is marked as requested */
119
struct gpio_chip *gpio_to_chip(unsigned gpio)
120 121 122 123
{
	return gpio_desc[gpio].chip;
}

124 125 126 127 128 129 130 131
/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
static int gpiochip_find_base(int ngpio)
{
	int i;
	int spare = 0;
	int base = -ENOSPC;

	for (i = ARCH_NR_GPIOS - 1; i >= 0 ; i--) {
Anton Vorontsov's avatar
Anton Vorontsov committed
132 133
		struct gpio_desc *desc = &gpio_desc[i];
		struct gpio_chip *chip = desc->chip;
134

Anton Vorontsov's avatar
Anton Vorontsov committed
135
		if (!chip && !test_bit(FLAG_RESERVED, &desc->flags)) {
136 137 138 139 140 141 142
			spare++;
			if (spare == ngpio) {
				base = i;
				break;
			}
		} else {
			spare = 0;
Anton Vorontsov's avatar
Anton Vorontsov committed
143 144
			if (chip)
				i -= chip->ngpio - 1;
145 146 147 148 149 150 151 152
		}
	}

	if (gpio_is_valid(base))
		pr_debug("%s: found new base at %d\n", __func__, base);
	return base;
}

Anton Vorontsov's avatar
Anton Vorontsov committed
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
/**
 * gpiochip_reserve() - reserve range of gpios to use with platform code only
 * @start: starting gpio number
 * @ngpio: number of gpios to reserve
 * Context: platform init, potentially before irqs or kmalloc will work
 *
 * Returns a negative errno if any gpio within the range is already reserved
 * or registered, else returns zero as a success code.  Use this function
 * to mark a range of gpios as unavailable for dynamic gpio number allocation,
 * for example because its driver support is not yet loaded.
 */
int __init gpiochip_reserve(int start, int ngpio)
{
	int ret = 0;
	unsigned long flags;
	int i;

Trent Piepho's avatar
Trent Piepho committed
170
	if (!gpio_is_valid(start) || !gpio_is_valid(start + ngpio - 1))
Anton Vorontsov's avatar
Anton Vorontsov committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
		return -EINVAL;

	spin_lock_irqsave(&gpio_lock, flags);

	for (i = start; i < start + ngpio; i++) {
		struct gpio_desc *desc = &gpio_desc[i];

		if (desc->chip || test_bit(FLAG_RESERVED, &desc->flags)) {
			ret = -EBUSY;
			goto err;
		}

		set_bit(FLAG_RESERVED, &desc->flags);
	}

	pr_debug("%s: reserved gpios from %d to %d\n",
		 __func__, start, start + ngpio - 1);
err:
	spin_unlock_irqrestore(&gpio_lock, flags);

	return ret;
}

194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
/* caller ensures gpio is valid and requested, chip->get_direction may sleep  */
static int gpio_get_direction(unsigned gpio)
{
	struct gpio_chip	*chip;
	struct gpio_desc	*desc = &gpio_desc[gpio];
	int			status = -EINVAL;

	chip = gpio_to_chip(gpio);
	gpio -= chip->base;

	if (!chip->get_direction)
		return status;

	status = chip->get_direction(chip, gpio);
	if (status > 0) {
		/* GPIOF_DIR_IN, or other positive */
		status = 1;
		clear_bit(FLAG_IS_OUT, &desc->flags);
	}
	if (status == 0) {
		/* GPIOF_DIR_OUT */
		set_bit(FLAG_IS_OUT, &desc->flags);
	}
	return status;
}

David Brownell's avatar
David Brownell committed
220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
#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
237 238 239 240
 *   /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"
241 242 243 244 245
 *   /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
246 247 248 249 250 251
 */

static ssize_t gpio_direction_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
	const struct gpio_desc	*desc = dev_get_drvdata(dev);
252
	unsigned		gpio = desc - gpio_desc;
David Brownell's avatar
David Brownell committed
253 254 255 256 257 258 259
	ssize_t			status;

	mutex_lock(&sysfs_lock);

	if (!test_bit(FLAG_EXPORT, &desc->flags))
		status = -EIO;
	else
260
		gpio_get_direction(gpio);
David Brownell's avatar
David Brownell committed
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
		status = sprintf(buf, "%s\n",
			test_bit(FLAG_IS_OUT, &desc->flags)
				? "out" : "in");

	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)
{
	const struct gpio_desc	*desc = dev_get_drvdata(dev);
	unsigned		gpio = desc - gpio_desc;
	ssize_t			status;

	mutex_lock(&sysfs_lock);

	if (!test_bit(FLAG_EXPORT, &desc->flags))
		status = -EIO;
	else if (sysfs_streq(buf, "high"))
		status = gpio_direction_output(gpio, 1);
	else if (sysfs_streq(buf, "out") || sysfs_streq(buf, "low"))
		status = gpio_direction_output(gpio, 0);
	else if (sysfs_streq(buf, "in"))
		status = gpio_direction_input(gpio);
	else
		status = -EINVAL;

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

293
static /* const */ DEVICE_ATTR(direction, 0644,
David Brownell's avatar
David Brownell committed
294 295 296 297 298 299 300 301 302 303 304
		gpio_direction_show, gpio_direction_store);

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

	mutex_lock(&sysfs_lock);

305
	if (!test_bit(FLAG_EXPORT, &desc->flags)) {
David Brownell's avatar
David Brownell committed
306
		status = -EIO;
307 308 309 310 311 312 313 314 315
	} else {
		int value;

		value = !!gpio_get_value_cansleep(gpio);
		if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
			value = !value;

		status = sprintf(buf, "%d\n", value);
	}
David Brownell's avatar
David Brownell committed
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338

	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)
{
	const struct gpio_desc	*desc = dev_get_drvdata(dev);
	unsigned		gpio = desc - gpio_desc;
	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;

		status = strict_strtol(buf, 0, &value);
		if (status == 0) {
339 340
			if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
				value = !value;
David Brownell's avatar
David Brownell committed
341 342 343 344 345 346 347 348 349
			gpio_set_value_cansleep(gpio, value != 0);
			status = size;
		}
	}

	mutex_unlock(&sysfs_lock);
	return status;
}

350
static const DEVICE_ATTR(value, 0644,
David Brownell's avatar
David Brownell committed
351 352
		gpio_value_show, gpio_value_store);

353 354
static irqreturn_t gpio_sysfs_irq(int irq, void *priv)
{
355
	struct sysfs_dirent	*value_sd = priv;
356

357
	sysfs_notify_dirent(value_sd);
358 359 360 361 362 363
	return IRQ_HANDLED;
}

static int gpio_setup_irq(struct gpio_desc *desc, struct device *dev,
		unsigned long gpio_flags)
{
364
	struct sysfs_dirent	*value_sd;
365 366 367 368 369 370 371 372 373 374
	unsigned long		irq_flags;
	int			ret, irq, id;

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

	irq = gpio_to_irq(desc - gpio_desc);
	if (irq < 0)
		return -EIO;

375 376 377 378
	id = desc->flags >> ID_SHIFT;
	value_sd = idr_find(&dirent_idr, id);
	if (value_sd)
		free_irq(irq, value_sd);
379 380 381 382 383

	desc->flags &= ~GPIO_TRIGGER_MASK;

	if (!gpio_flags) {
		ret = 0;
384
		goto free_id;
385 386 387 388
	}

	irq_flags = IRQF_SHARED;
	if (test_bit(FLAG_TRIG_FALL, &gpio_flags))
389 390
		irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
			IRQF_TRIGGER_RISING : IRQF_TRIGGER_FALLING;
391
	if (test_bit(FLAG_TRIG_RISE, &gpio_flags))
392 393
		irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
			IRQF_TRIGGER_FALLING : IRQF_TRIGGER_RISING;
394

395 396 397 398
	if (!value_sd) {
		value_sd = sysfs_get_dirent(dev->kobj.sd, NULL, "value");
		if (!value_sd) {
			ret = -ENODEV;
399 400 401 402 403
			goto err_out;
		}

		do {
			ret = -ENOMEM;
404 405 406
			if (idr_pre_get(&dirent_idr, GFP_KERNEL))
				ret = idr_get_new_above(&dirent_idr, value_sd,
							1, &id);
407 408 409
		} while (ret == -EAGAIN);

		if (ret)
410
			goto free_sd;
411 412

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

415
		if (desc->flags >> ID_SHIFT != id) {
416 417 418 419 420
			ret = -ERANGE;
			goto free_id;
		}
	}

421
	ret = request_any_context_irq(irq, gpio_sysfs_irq, irq_flags,
422
				"gpiolib", value_sd);
423
	if (ret < 0)
424
		goto free_id;
425 426 427 428 429

	desc->flags |= gpio_flags;
	return 0;

free_id:
430
	idr_remove(&dirent_idr, id);
431
	desc->flags &= GPIO_FLAGS_MASK;
432 433 434
free_sd:
	if (value_sd)
		sysfs_put(value_sd);
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
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);

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 568 569 570 571 572 573 574 575
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;

		status = strict_strtol(buf, 0, &value);
		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
576 577
static const struct attribute *gpio_attrs[] = {
	&dev_attr_value.attr,
578
	&dev_attr_active_low.attr,
David Brownell's avatar
David Brownell committed
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 625 626 627 628 629 630 631 632 633 634 635 636
	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
 */
637 638 639
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
640 641 642 643 644 645 646 647 648 649 650 651 652 653
{
	long	gpio;
	int	status;

	status = strict_strtol(buf, 0, &gpio);
	if (status < 0)
		goto done;

	/* 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.
	 */

	status = gpio_request(gpio, "sysfs");
654 655 656
	if (status < 0) {
		if (status == -EPROBE_DEFER)
			status = -ENODEV;
David Brownell's avatar
David Brownell committed
657
		goto done;
658
	}
David Brownell's avatar
David Brownell committed
659 660 661 662 663 664 665 666 667 668 669 670
	status = gpio_export(gpio, true);
	if (status < 0)
		gpio_free(gpio);
	else
		set_bit(FLAG_SYSFS, &gpio_desc[gpio].flags);

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

671 672 673
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
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 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734
{
	long	gpio;
	int	status;

	status = strict_strtol(buf, 0, &gpio);
	if (status < 0)
		goto done;

	status = -EINVAL;

	/* reject bogus commands (gpio_unexport ignores them) */
	if (!gpio_is_valid(gpio))
		goto done;

	/* 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.
	 */
	if (test_and_clear_bit(FLAG_SYSFS, &gpio_desc[gpio].flags)) {
		status = 0;
		gpio_free(gpio);
	}
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,
};


/**
 * gpio_export - export a GPIO through sysfs
 * @gpio: gpio to make available, already requested
 * @direction_may_change: true if userspace may change gpio direction
 * Context: arch_initcall or later
 *
 * 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.
 */
int gpio_export(unsigned gpio, bool direction_may_change)
{
	unsigned long		flags;
	struct gpio_desc	*desc;
Ryan Mallon's avatar
Ryan Mallon committed
735
	int			status;
736
	const char		*ioname = NULL;
Ryan Mallon's avatar
Ryan Mallon committed
737
	struct device		*dev;
David Brownell's avatar
David Brownell committed
738 739 740 741 742 743 744

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

Ryan Mallon's avatar
Ryan Mallon committed
745 746 747 748
	if (!gpio_is_valid(gpio)) {
		pr_debug("%s: gpio %d is not valid\n", __func__, gpio);
		return -EINVAL;
	}
David Brownell's avatar
David Brownell committed
749 750 751 752 753

	mutex_lock(&sysfs_lock);

	spin_lock_irqsave(&gpio_lock, flags);
	desc = &gpio_desc[gpio];
Ryan Mallon's avatar
Ryan Mallon committed
754 755 756 757 758 759 760
	if (!test_bit(FLAG_REQUESTED, &desc->flags) ||
	     test_bit(FLAG_EXPORT, &desc->flags)) {
		spin_unlock_irqrestore(&gpio_lock, flags);
		pr_debug("%s: gpio %d unavailable (requested=%d, exported=%d)\n",
				__func__, gpio,
				test_bit(FLAG_REQUESTED, &desc->flags),
				test_bit(FLAG_EXPORT, &desc->flags));
761 762
		status = -EPERM;
		goto fail_unlock;
David Brownell's avatar
David Brownell committed
763
	}
Ryan Mallon's avatar
Ryan Mallon committed
764 765 766

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

769 770 771
	if (desc->chip->names && desc->chip->names[gpio - desc->chip->base])
		ioname = desc->chip->names[gpio - desc->chip->base];

Ryan Mallon's avatar
Ryan Mallon committed
772 773 774 775 776
	dev = device_create(&gpio_class, desc->chip->dev, MKDEV(0, 0),
			    desc, ioname ? ioname : "gpio%u", gpio);
	if (IS_ERR(dev)) {
		status = PTR_ERR(dev);
		goto fail_unlock;
David Brownell's avatar
David Brownell committed
777 778
	}

Ryan Mallon's avatar
Ryan Mallon committed
779
	status = sysfs_create_group(&dev->kobj, &gpio_attr_group);
David Brownell's avatar
David Brownell committed
780
	if (status)
Ryan Mallon's avatar
Ryan Mallon committed
781
		goto fail_unregister_device;
David Brownell's avatar
David Brownell committed
782

Ryan Mallon's avatar
Ryan Mallon committed
783 784 785 786 787 788 789 790 791 792 793 794
	if (direction_may_change) {
		status = device_create_file(dev, &dev_attr_direction);
		if (status)
			goto fail_unregister_device;
	}

	if (gpio_to_irq(gpio) >= 0 && (direction_may_change ||
				       !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
795

Ryan Mallon's avatar
Ryan Mallon committed
796 797 798 799 800 801 802 803 804
	set_bit(FLAG_EXPORT, &desc->flags);
	mutex_unlock(&sysfs_lock);
	return 0;

fail_unregister_device:
	device_unregister(dev);
fail_unlock:
	mutex_unlock(&sysfs_lock);
	pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
David Brownell's avatar
David Brownell committed
805 806 807 808 809 810 811 812 813
	return status;
}
EXPORT_SYMBOL_GPL(gpio_export);

static int match_export(struct device *dev, void *data)
{
	return dev_get_drvdata(dev) == data;
}

814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858
/**
 * gpio_export_link - create a sysfs link to an exported GPIO node
 * @dev: device under which to create symlink
 * @name: name of the symlink
 * @gpio: gpio to create symlink to, already exported
 *
 * 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.
 */
int gpio_export_link(struct device *dev, const char *name, unsigned gpio)
{
	struct gpio_desc	*desc;
	int			status = -EINVAL;

	if (!gpio_is_valid(gpio))
		goto done;

	mutex_lock(&sysfs_lock);

	desc = &gpio_desc[gpio];

	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);

done:
	if (status)
		pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);

	return status;
}
EXPORT_SYMBOL_GPL(gpio_export_link);

859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905

/**
 * gpio_sysfs_set_active_low - set the polarity of gpio sysfs value
 * @gpio: gpio to change
 * @value: non-zero to use active low, i.e. inverted values
 *
 * 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.
 */
int gpio_sysfs_set_active_low(unsigned gpio, int value)
{
	struct gpio_desc	*desc;
	struct device		*dev = NULL;
	int			status = -EINVAL;

	if (!gpio_is_valid(gpio))
		goto done;

	mutex_lock(&sysfs_lock);

	desc = &gpio_desc[gpio];

	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);

done:
	if (status)
		pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);

	return status;
}
EXPORT_SYMBOL_GPL(gpio_sysfs_set_active_low);

David Brownell's avatar
David Brownell committed
906 907 908 909 910 911 912 913 914
/**
 * gpio_unexport - reverse effect of gpio_export()
 * @gpio: gpio to make unavailable
 *
 * This is implicit on gpio_free().
 */
void gpio_unexport(unsigned gpio)
{
	struct gpio_desc	*desc;
915
	int			status = 0;
916
	struct device		*dev = NULL;
David Brownell's avatar
David Brownell committed
917

918 919
	if (!gpio_is_valid(gpio)) {
		status = -EINVAL;
David Brownell's avatar
David Brownell committed
920
		goto done;
921
	}
David Brownell's avatar
David Brownell committed
922 923 924 925

	mutex_lock(&sysfs_lock);

	desc = &gpio_desc[gpio];
926

David Brownell's avatar
David Brownell committed
927 928 929 930
	if (test_bit(FLAG_EXPORT, &desc->flags)) {

		dev = class_find_device(&gpio_class, NULL, desc, match_export);
		if (dev) {
931
			gpio_setup_irq(desc, dev, 0);
David Brownell's avatar
David Brownell committed
932 933 934 935 936 937
			clear_bit(FLAG_EXPORT, &desc->flags);
		} else
			status = -ENODEV;
	}

	mutex_unlock(&sysfs_lock);
938 939 940 941
	if (dev) {
		device_unregister(dev);
		put_device(dev);
	}
David Brownell's avatar
David Brownell committed
942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
done:
	if (status)
		pr_debug("%s: gpio%d status %d\n", __func__, gpio, status);
}
EXPORT_SYMBOL_GPL(gpio_unexport);

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);
965
	if (!IS_ERR(dev)) {
David Brownell's avatar
David Brownell committed
966 967 968
		status = sysfs_create_group(&dev->kobj,
				&gpiochip_attr_group);
	} else
969
		status = PTR_ERR(dev);
David Brownell's avatar
David Brownell committed
970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
	chip->exported = (status == 0);
	mutex_unlock(&sysfs_lock);

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

		spin_lock_irqsave(&gpio_lock, flags);
		gpio = chip->base;
		while (gpio_desc[gpio].chip == chip)
			gpio_desc[gpio++].chip = NULL;
		spin_unlock_irqrestore(&gpio_lock, flags);

		pr_debug("%s: chip %s status %d\n", __func__,
				chip->label, status);
	}

	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);
		chip->exported = 0;
		status = 0;
	} else
		status = -ENODEV;
	mutex_unlock(&sysfs_lock);

	if (status)
		pr_debug("%s: chip %s status %d\n", __func__,
				chip->label, status);
}

static int __init gpiolib_sysfs_init(void)
{
	int		status;
	unsigned long	flags;
	unsigned	gpio;

	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);
	for (gpio = 0; gpio < ARCH_NR_GPIOS; gpio++) {
		struct gpio_chip	*chip;

		chip = gpio_desc[gpio].chip;
		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 */

1058 1059 1060 1061 1062 1063 1064 1065
/**
 * 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.
1066
 *
David Brownell's avatar
David Brownell committed
1067 1068 1069 1070 1071
 * 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.
 *
1072 1073
 * If chip->base is negative, this requests dynamic assignment of
 * a range of valid GPIOs.
1074 1075 1076 1077 1078 1079
 */
int gpiochip_add(struct gpio_chip *chip)
{
	unsigned long	flags;
	int		status = 0;
	unsigned	id;
1080
	int		base = chip->base;
1081

Trent Piepho's avatar
Trent Piepho committed
1082
	if ((!gpio_is_valid(base) || !gpio_is_valid(base + chip->ngpio - 1))
1083
			&& base >= 0) {
1084 1085 1086 1087 1088 1089
		status = -EINVAL;
		goto fail;
	}

	spin_lock_irqsave(&gpio_lock, flags);

1090 1091 1092 1093
	if (base < 0) {
		base = gpiochip_find_base(chip->ngpio);
		if (base < 0) {
			status = base;
David Brownell's avatar
David Brownell committed
1094
			goto unlock;
1095 1096 1097 1098
		}
		chip->base = base;
	}

1099
	/* these GPIO numbers must not be managed by another gpio_chip */
1100
	for (id = base; id < base + chip->ngpio; id++) {
1101 1102 1103 1104 1105 1106
		if (gpio_desc[id].chip != NULL) {
			status = -EBUSY;
			break;
		}
	}
	if (status == 0) {
1107
		for (id = base; id < base + chip->ngpio; id++) {
1108
			gpio_desc[id].chip = chip;
David Brownell's avatar
David Brownell committed
1109 1110 1111 1112 1113

			/* REVISIT:  most hardware initializes GPIOs as
			 * inputs (often with pullups enabled) so power
			 * usage is minimized.  Linux code should set the
			 * gpio direction first thing; but until it does,
1114
			 * and in case chip->get_direction is not set,
David Brownell's avatar
David Brownell committed
1115 1116 1117 1118 1119
			 * we may expose the wrong direction in sysfs.
			 */
			gpio_desc[id].flags = !chip->direction_input
				? (1 << FLAG_IS_OUT)
				: 0;
1120 1121 1122
		}
	}

1123 1124 1125 1126
#ifdef CONFIG_PINCTRL
	INIT_LIST_HEAD(&chip->pin_ranges);
#endif

1127 1128
	of_gpiochip_add(chip);

David Brownell's avatar
David Brownell committed
1129
unlock:
1130
	spin_unlock_irqrestore(&gpio_lock, flags);
1131 1132 1133 1134 1135 1136 1137 1138

	if (status)
		goto fail;

	status = gpiochip_export(chip);
	if (status)
		goto fail;

1139
	pr_debug("gpiochip_add: registered GPIOs %d to %d on device: %s\n",
1140 1141 1142
		chip->base, chip->base + chip->ngpio - 1,
		chip->label ? : "generic");

1143
	return 0;
1144 1145
fail:
	/* failures here can mean systems won't boot... */
1146 1147 1148
	pr_err("gpiochip_add: gpios %d..%d (%s) failed to register\n",
		chip->base, chip->base + chip->ngpio - 1,
		chip->label ? : "generic");
1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166
	return status;
}
EXPORT_SYMBOL_GPL(gpiochip_add);

/**
 * gpiochip_remove() - unregister a gpio_chip
 * @chip: the chip to unregister
 *
 * A gpio_chip with any GPIOs still requested may not be removed.
 */
int gpiochip_remove(struct gpio_chip *chip)
{
	unsigned long	flags;
	int		status = 0;
	unsigned	id;

	spin_lock_irqsave(&gpio_lock, flags);

1167
	gpiochip_remove_pin_ranges(chip);
1168 1169
	of_gpiochip_remove(chip);

1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181
	for (id = chip->base; id < chip->base + chip->ngpio; id++) {
		if (test_bit(FLAG_REQUESTED, &gpio_desc[id].flags)) {
			status = -EBUSY;
			break;
		}
	}
	if (status == 0) {
		for (id = chip->base; id < chip->base + chip->ngpio; id++)
			gpio_desc[id].chip = NULL;
	}

	spin_unlock_irqrestore(&gpio_lock, flags);
David Brownell's avatar
David Brownell committed
1182 1183 1184 1185

	if (status == 0)
		gpiochip_unexport(chip);

1186 1187 1188 1189
	return status;
}
EXPORT_SYMBOL_GPL(gpiochip_remove);

1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200
/**
 * gpiochip_find() - iterator for locating a specific gpio_chip
 * @data: data to pass to match function
 * @callback: Callback function to check gpio_chip
 *
 * Similar to bus_find_device.  It returns a reference to a gpio_chip as
 * determined by a user supplied @match callback.  The callback should return
 * 0 if the device doesn't match and non-zero if it does.  If the callback is
 * non-zero, this function will return to the caller and not iterate over any
 * more gpio_chips.
 */
1201
struct gpio_chip *gpiochip_find(void *data,
1202
				int (*match)(struct gpio_chip *chip,
1203
					     void *data))
1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
{
	struct gpio_chip *chip = NULL;
	unsigned long flags;
	int i;

	spin_lock_irqsave(&gpio_lock, flags);
	for (i = 0; i < ARCH_NR_GPIOS; i++) {
		if (!gpio_desc[i].chip)
			continue;

		if (match(gpio_desc[i].chip, data)) {
			chip = gpio_desc[i].chip;
			break;
		}
	}
	spin_unlock_irqrestore(&gpio_lock, flags);

	return chip;
}
Jean Delvare's avatar
Jean Delvare committed
1223
EXPORT_SYMBOL_GPL(gpiochip_find);
1224

1225
#ifdef CONFIG_PINCTRL
1226

1227 1228 1229 1230
/**
 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
 * @chip: the gpiochip to add the range for
 * @pinctrl_name: the dev_name() of the pin controller to map to
1231 1232
 * @gpio_offset: the start offset in the current gpio_chip number space
 * @pin_offset: the start offset in the pin controller number space
1233 1234 1235
 * @npins: the number of pins from the offset of each pin space (GPIO and
 *	pin controller) to accumulate in this range
 */
1236
int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
1237
			   unsigned int gpio_offset, unsigned int pin_offset,
1238
			   unsigned int npins)
1239 1240
{
	struct gpio_pin_range *pin_range;
1241
	int ret;
1242

1243
	pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1244 1245 1246
	if (!pin_range) {
		pr_err("%s: GPIO chip: failed to allocate pin ranges\n",
				chip->label);
1247
		return -ENOMEM;
1248 1249
	}

1250
	/* Use local offset as range ID */
1251
	pin_range->range.id = gpio_offset;
1252
	pin_range->range.gc = chip;
1253
	pin_range->range.name = chip->label;
1254 1255
	pin_range->range.base = chip->base + gpio_offset;
	pin_range->range.pin_base = pin_offset;
1256
	pin_range->range.npins = npins;
Linus Walleij's avatar
Linus Walleij committed
1257
	pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
1258
			&pin_range->range);
1259
	if (IS_ERR(pin_range->pctldev)) {
1260
		ret = PTR_ERR(pin_range->pctldev);
1261 1262 1263
		pr_err("%s: GPIO chip: could not create pin range\n",
		       chip->label);
		kfree(pin_range);
1264
		return ret;
1265
	}
1266 1267 1268 1269
	pr_debug("GPIO chip %s: created GPIO range %d->%d ==> %s PIN %d->%d\n",
		 chip->label, gpio_offset, gpio_offset + npins - 1,
		 pinctl_name,
		 pin_offset, pin_offset + npins - 1);
1270 1271

	list_add_tail(&pin_range->node, &chip->pin_ranges);
1272 1273

	return 0;
1274
}
1275
EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
1276

1277 1278 1279 1280
/**
 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
 * @chip: the chip to remove all the mappings for
 */
1281 1282 1283 1284 1285 1286 1287 1288
void gpiochip_remove_pin_ranges(struct gpio_chip *chip)
{
	struct gpio_pin_range *pin_range, *tmp;

	list_for_each_entry_safe(pin_range, tmp, &chip->pin_ranges, node) {
		list_del(&pin_range->node);
		pinctrl_remove_gpio_range(pin_range->pctldev,
				&pin_range->range);
1289
		kfree(pin_range);
1290 1291
	}
}
1292 1293 1294
EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);

#endif /* CONFIG_PINCTRL */
1295

1296 1297 1298 1299 1300 1301 1302
/* These "optional" allocation calls help prevent drivers from stomping
 * on each other, and help provide better diagnostics in debugfs.
 * They're called even less than the "set direction" calls.
 */
int gpio_request(unsigned gpio, const char *label)
{
	struct gpio_desc	*desc;
David Brownell's avatar
David Brownell committed
1303
	struct gpio_chip	*chip;
1304
	int			status = -EPROBE_DEFER;
1305 1306 1307 1308
	unsigned long		flags;

	spin_lock_irqsave(&gpio_lock, flags);

1309 1310
	if (!gpio_is_valid(gpio)) {
		status = -EINVAL;
1311
		goto done;
1312
	}
1313
	desc = &gpio_desc[gpio];
David Brownell's avatar
David Brownell committed
1314 1315
	chip = desc->chip;
	if (chip == NULL)
1316 1317
		goto done;

David Brownell's avatar
David Brownell committed
1318
	if (!try_module_get(chip->owner))
1319 1320
		goto done;

1321
	/* NOTE:  gpio_request() can be called in early boot,
David Brownell's avatar
David Brownell committed
1322
	 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
1323 1324 1325 1326 1327
	 */

	if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
		desc_set_label(desc, label ? : "?");
		status = 0;
1328
	} else {
1329
		status = -EBUSY;
David Brownell's avatar
David Brownell committed
1330
		module_put(chip->owner);
1331
		goto done;
David Brownell's avatar
David Brownell committed
1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343
	}

	if (chip->request) {
		/* chip->request may sleep */
		spin_unlock_irqrestore(&gpio_lock, flags);
		status = chip->request(chip, gpio - chip->base);
		spin_lock_irqsave(&gpio_lock, flags);

		if (status < 0) {
			desc_set_label(desc, NULL);
			module_put(chip->owner);
			clear_bit(FLAG_REQUESTED, &desc->flags);
1344
			goto done;
David Brownell's avatar
David Brownell committed
1345
		}
1346
	}
1347 1348 1349 1350 1351 1352
	if (chip->get_direction) {
		/* chip->get_direction may sleep */
		spin_unlock_irqrestore(&gpio_lock, flags);
		gpio_get_direction(gpio);
		spin_lock_irqsave(&gpio_lock, flags);
	}
1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365
done:
	if (status)
		pr_debug("gpio_request: gpio-%d (%s) status %d\n",
			gpio, label ? : "?", status);
	spin_unlock_irqrestore(&gpio_lock, flags);
	return status;
}
EXPORT_SYMBOL_GPL(gpio_request);

void gpio_free(unsigned gpio)
{
	unsigned long		flags;
	struct gpio_desc	*desc;
David Brownell's avatar
David Brownell committed
1366
	struct gpio_chip	*chip;
1367

1368 1369
	might_sleep();

1370
	if (!gpio_is_valid(gpio)) {
1371 1372 1373 1374
		WARN_ON(extra_checks);
		return;
	}

David Brownell's avatar
David Brownell committed
1375 1376
	gpio_unexport(gpio);

1377 1378 1379
	spin_lock_irqsave(&gpio_lock, flags);

	desc = &gpio_desc[gpio];
David Brownell's avatar
David Brownell committed
1380 1381 1382 1383
	chip = desc->chip;
	if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
		if (chip->free) {
			spin_unlock_irqrestore(&gpio_lock, flags);
1384
			might_sleep_if(chip->can_sleep);
David Brownell's avatar
David Brownell committed
1385 1386 1387
			chip->free(chip, gpio - chip->base);
			spin_lock_irqsave(&gpio_lock, flags);
		}
1388
		desc_set_label(desc, NULL);
1389
		module_put(desc->chip->owner);
1390
		clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
David Brownell's avatar
David Brownell committed
1391
		clear_bit(FLAG_REQUESTED, &desc->flags);
1392
		clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
1393
		clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
1394
	} else
1395 1396 1397 1398 1399 1400
		WARN_ON(extra_checks);

	spin_unlock_irqrestore(&gpio_lock, flags);
}
EXPORT_SYMBOL_GPL(gpio_free);

1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414
/**
 * gpio_request_one - request a single GPIO with initial configuration
 * @gpio:	the GPIO number
 * @flags:	GPIO configuration as specified by GPIOF_*
 * @label:	a literal description string of this GPIO
 */
int gpio_request_one(unsigned gpio, unsigned long flags, const char *label)
{
	int err;

	err = gpio_request(gpio, label);
	if (err)
		return err;

1415 1416 1417
	if (flags & GPIOF_OPEN_DRAIN)
		set_bit(FLAG_OPEN_DRAIN, &gpio_desc[gpio].flags);

1418 1419 1420
	if (flags & GPIOF_OPEN_SOURCE)
		set_bit(FLAG_OPEN_SOURCE, &gpio_desc[gpio].flags);

1421 1422 1423 1424 1425 1426
	if (flags & GPIOF_DIR_IN)
		err = gpio_direction_input(gpio);
	else
		err = gpio_direction_output(gpio,
				(flags & GPIOF_INIT_HIGH) ? 1 : 0);