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

121 122 123 124 125 126 127
static inline void desc_set_label(struct gpio_desc *d, const char *label)
{
#ifdef CONFIG_DEBUG_FS
	d->label = label;
#endif
}

128 129 130 131 132
/*
 * Return the GPIO number of the passed descriptor relative to its chip
 */
static int gpio_chip_hwgpio(const struct gpio_desc *desc)
{
133
	return desc - &desc->chip->desc[0];
134 135 136 137 138
}

/**
 * Convert a GPIO number to its descriptor
 */
139
struct gpio_desc *gpio_to_desc(unsigned gpio)
140 141 142 143 144 145
{
	if (WARN(!gpio_is_valid(gpio), "invalid GPIO %d\n", gpio))
		return NULL;
	else
		return &gpio_desc[gpio];
}
146
EXPORT_SYMBOL_GPL(gpio_to_desc);
147

148 149 150 151 152 153 154 155 156 157
/**
 * 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)
{
	unsigned int gpio = chip->base + offset;

	return gpio_to_desc(gpio);
}
158 159 160 161 162 163

/**
 * 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
 */
164
int desc_to_gpio(const struct gpio_desc *desc)
165
{
166
	return desc - &gpio_desc[0];
167
}
168
EXPORT_SYMBOL_GPL(desc_to_gpio);
169 170


171 172 173 174
/* 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
175 176
 * message should motivate switching to explicit requests... so should
 * the weaker cleanup after faults, compared to gpio_request().
177 178 179 180
 *
 * 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.
181
 */
182
static int gpio_ensure_requested(struct gpio_desc *desc)
183
{
184
	const struct gpio_chip *chip = desc->chip;
185
	const int gpio = desc_to_gpio(desc);
David Brownell's avatar
David Brownell committed
186

187 188
	if (WARN(test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0,
			"autorequest GPIO-%d\n", gpio)) {
David Brownell's avatar
David Brownell committed
189 190 191 192 193 194
		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;
		}
195
		desc_set_label(desc, "[auto]");
David Brownell's avatar
David Brownell committed
196 197 198
		/* caller must chip->request() w/o spinlock */
		if (chip->request)
			return 1;
199
	}
David Brownell's avatar
David Brownell committed
200
	return 0;
201 202
}

203 204 205 206 207
/**
 * 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)
208
{
209
	return desc ? desc->chip : NULL;
210
}
211
EXPORT_SYMBOL_GPL(gpiod_to_chip);
212

213 214 215
/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
static int gpiochip_find_base(int ngpio)
{
216 217
	struct gpio_chip *chip;
	int base = ARCH_NR_GPIOS - ngpio;
218

219 220 221 222 223 224 225
	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;
226 227
	}

228
	if (gpio_is_valid(base)) {
229
		pr_debug("%s: found new base at %d\n", __func__, base);
230 231 232 233
		return base;
	} else {
		pr_err("%s: cannot find free range\n", __func__);
		return -ENOSPC;
Anton Vorontsov's avatar
Anton Vorontsov committed
234 235 236
	}
}

237 238 239 240 241 242 243 244 245
/**
 * 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)
246 247
{
	struct gpio_chip	*chip;
248
	unsigned		offset;
249 250
	int			status = -EINVAL;

251 252
	chip = gpiod_to_chip(desc);
	offset = gpio_chip_hwgpio(desc);
253 254 255 256

	if (!chip->get_direction)
		return status;

257
	status = chip->get_direction(chip, offset);
258 259 260
	if (status > 0) {
		/* GPIOF_DIR_IN, or other positive */
		status = 1;
261 262 263
		/* 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);
264 265 266
	}
	if (status == 0) {
		/* GPIOF_DIR_OUT */
267
		set_bit(FLAG_IS_OUT, &((struct gpio_desc *)desc)->flags);
268 269 270
	}
	return status;
}
271
EXPORT_SYMBOL_GPL(gpiod_get_direction);
272

David Brownell's avatar
David Brownell committed
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289
#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
290 291 292 293
 *   /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"
294 295 296 297 298
 *   /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
299 300 301 302 303
 */

static ssize_t gpio_direction_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
304
	const struct gpio_desc	*desc = dev_get_drvdata(dev);
David Brownell's avatar
David Brownell committed
305 306 307 308
	ssize_t			status;

	mutex_lock(&sysfs_lock);

309
	if (!test_bit(FLAG_EXPORT, &desc->flags)) {
David Brownell's avatar
David Brownell committed
310
		status = -EIO;
311
	} else {
312
		gpiod_get_direction(desc);
David Brownell's avatar
David Brownell committed
313 314 315
		status = sprintf(buf, "%s\n",
			test_bit(FLAG_IS_OUT, &desc->flags)
				? "out" : "in");
316
	}
David Brownell's avatar
David Brownell committed
317 318 319 320 321 322 323 324

	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)
{
325
	struct gpio_desc	*desc = dev_get_drvdata(dev);
David Brownell's avatar
David Brownell committed
326 327 328 329 330 331 332
	ssize_t			status;

	mutex_lock(&sysfs_lock);

	if (!test_bit(FLAG_EXPORT, &desc->flags))
		status = -EIO;
	else if (sysfs_streq(buf, "high"))
333
		status = gpiod_direction_output(desc, 1);
David Brownell's avatar
David Brownell committed
334
	else if (sysfs_streq(buf, "out") || sysfs_streq(buf, "low"))
335
		status = gpiod_direction_output(desc, 0);
David Brownell's avatar
David Brownell committed
336
	else if (sysfs_streq(buf, "in"))
337
		status = gpiod_direction_input(desc);
David Brownell's avatar
David Brownell committed
338 339 340 341 342 343 344
	else
		status = -EINVAL;

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

345
static /* const */ DEVICE_ATTR(direction, 0644,
David Brownell's avatar
David Brownell committed
346 347 348 349 350
		gpio_direction_show, gpio_direction_store);

static ssize_t gpio_value_show(struct device *dev,
		struct device_attribute *attr, char *buf)
{
351
	struct gpio_desc	*desc = dev_get_drvdata(dev);
David Brownell's avatar
David Brownell committed
352 353 354 355
	ssize_t			status;

	mutex_lock(&sysfs_lock);

356
	if (!test_bit(FLAG_EXPORT, &desc->flags))
David Brownell's avatar
David Brownell committed
357
		status = -EIO;
358 359
	else
		status = sprintf(buf, "%d\n", gpiod_get_value_cansleep(desc));
David Brownell's avatar
David Brownell committed
360 361 362 363 364 365 366 367

	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)
{
368
	struct gpio_desc	*desc = dev_get_drvdata(dev);
David Brownell's avatar
David Brownell committed
369 370 371 372 373 374 375 376 377 378 379
	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;

380
		status = kstrtol(buf, 0, &value);
David Brownell's avatar
David Brownell committed
381
		if (status == 0) {
382
			gpiod_set_value_cansleep(desc, value);
David Brownell's avatar
David Brownell committed
383 384 385 386 387 388 389 390
			status = size;
		}
	}

	mutex_unlock(&sysfs_lock);
	return status;
}

391
static const DEVICE_ATTR(value, 0644,
David Brownell's avatar
David Brownell committed
392 393
		gpio_value_show, gpio_value_store);

394 395
static irqreturn_t gpio_sysfs_irq(int irq, void *priv)
{
396
	struct sysfs_dirent	*value_sd = priv;
397

398
	sysfs_notify_dirent(value_sd);
399 400 401 402 403 404
	return IRQ_HANDLED;
}

static int gpio_setup_irq(struct gpio_desc *desc, struct device *dev,
		unsigned long gpio_flags)
{
405
	struct sysfs_dirent	*value_sd;
406 407 408 409 410 411
	unsigned long		irq_flags;
	int			ret, irq, id;

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

412
	irq = gpiod_to_irq(desc);
413 414 415
	if (irq < 0)
		return -EIO;

416 417 418 419
	id = desc->flags >> ID_SHIFT;
	value_sd = idr_find(&dirent_idr, id);
	if (value_sd)
		free_irq(irq, value_sd);
420 421 422 423

	desc->flags &= ~GPIO_TRIGGER_MASK;

	if (!gpio_flags) {
424
		gpiod_unlock_as_irq(desc);
425
		ret = 0;
426
		goto free_id;
427 428 429 430
	}

	irq_flags = IRQF_SHARED;
	if (test_bit(FLAG_TRIG_FALL, &gpio_flags))
431 432
		irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
			IRQF_TRIGGER_RISING : IRQF_TRIGGER_FALLING;
433
	if (test_bit(FLAG_TRIG_RISE, &gpio_flags))
434 435
		irq_flags |= test_bit(FLAG_ACTIVE_LOW, &desc->flags) ?
			IRQF_TRIGGER_FALLING : IRQF_TRIGGER_RISING;
436

437
	if (!value_sd) {
Tejun Heo's avatar
Tejun Heo committed
438
		value_sd = sysfs_get_dirent(dev->kobj.sd, "value");
439 440
		if (!value_sd) {
			ret = -ENODEV;
441 442 443
			goto err_out;
		}

Tejun Heo's avatar
Tejun Heo committed
444 445
		ret = idr_alloc(&dirent_idr, value_sd, 1, 0, GFP_KERNEL);
		if (ret < 0)
446
			goto free_sd;
Tejun Heo's avatar
Tejun Heo committed
447
		id = ret;
448 449

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

452
		if (desc->flags >> ID_SHIFT != id) {
453 454 455 456 457
			ret = -ERANGE;
			goto free_id;
		}
	}

458
	ret = request_any_context_irq(irq, gpio_sysfs_irq, irq_flags,
459
				"gpiolib", value_sd);
460
	if (ret < 0)
461
		goto free_id;
462

463 464 465 466 467 468
	ret = gpiod_lock_as_irq(desc);
	if (ret < 0) {
		gpiod_warn(desc, "failed to flag the GPIO for IRQ\n");
		goto free_id;
	}

469 470 471 472
	desc->flags |= gpio_flags;
	return 0;

free_id:
473
	idr_remove(&dirent_idr, id);
474
	desc->flags &= GPIO_FLAGS_MASK;
475 476 477
free_sd:
	if (value_sd)
		sysfs_put(value_sd);
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 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
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);

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

606
		status = kstrtol(buf, 0, &value);
607 608 609 610 611 612 613 614 615 616 617 618
		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
619 620
static const struct attribute *gpio_attrs[] = {
	&dev_attr_value.attr,
621
	&dev_attr_active_low.attr,
David Brownell's avatar
David Brownell committed
622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 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
	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
 */
680 681 682
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
683
{
684 685 686
	long			gpio;
	struct gpio_desc	*desc;
	int			status;
David Brownell's avatar
David Brownell committed
687

688
	status = kstrtol(buf, 0, &gpio);
David Brownell's avatar
David Brownell committed
689 690 691
	if (status < 0)
		goto done;

692
	desc = gpio_to_desc(gpio);
693 694 695 696 697
	/* reject invalid GPIOs */
	if (!desc) {
		pr_warn("%s: invalid GPIO %ld\n", __func__, gpio);
		return -EINVAL;
	}
698

David Brownell's avatar
David Brownell committed
699 700 701 702 703
	/* 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.
	 */

704
	status = gpiod_request(desc, "sysfs");
705 706 707
	if (status < 0) {
		if (status == -EPROBE_DEFER)
			status = -ENODEV;
David Brownell's avatar
David Brownell committed
708
		goto done;
709
	}
710
	status = gpiod_export(desc, true);
David Brownell's avatar
David Brownell committed
711
	if (status < 0)
712
		gpiod_free(desc);
David Brownell's avatar
David Brownell committed
713
	else
714
		set_bit(FLAG_SYSFS, &desc->flags);
David Brownell's avatar
David Brownell committed
715 716 717 718 719 720 721

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

722 723 724
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
725
{
726 727 728
	long			gpio;
	struct gpio_desc	*desc;
	int			status;
David Brownell's avatar
David Brownell committed
729

730
	status = kstrtol(buf, 0, &gpio);
David Brownell's avatar
David Brownell committed
731 732 733
	if (status < 0)
		goto done;

734
	desc = gpio_to_desc(gpio);
David Brownell's avatar
David Brownell committed
735
	/* reject bogus commands (gpio_unexport ignores them) */
736 737 738 739 740 741
	if (!desc) {
		pr_warn("%s: invalid GPIO %ld\n", __func__, gpio);
		return -EINVAL;
	}

	status = -EINVAL;
David Brownell's avatar
David Brownell committed
742 743 744 745 746

	/* 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.
	 */
747
	if (test_and_clear_bit(FLAG_SYSFS, &desc->flags)) {
David Brownell's avatar
David Brownell committed
748
		status = 0;
749
		gpiod_free(desc);
David Brownell's avatar
David Brownell committed
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771
	}
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,
};


/**
772
 * gpiod_export - export a GPIO through sysfs
David Brownell's avatar
David Brownell committed
773 774 775 776 777 778 779 780 781 782 783 784 785
 * @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.
 */
786
int gpiod_export(struct gpio_desc *desc, bool direction_may_change)
David Brownell's avatar
David Brownell committed
787 788
{
	unsigned long		flags;
Ryan Mallon's avatar
Ryan Mallon committed
789
	int			status;
790
	const char		*ioname = NULL;
Ryan Mallon's avatar
Ryan Mallon committed
791
	struct device		*dev;
792
	int			offset;
David Brownell's avatar
David Brownell committed
793 794 795 796 797 798 799

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

800 801
	if (!desc) {
		pr_debug("%s: invalid gpio descriptor\n", __func__);
Ryan Mallon's avatar
Ryan Mallon committed
802 803
		return -EINVAL;
	}
David Brownell's avatar
David Brownell committed
804 805 806 807

	mutex_lock(&sysfs_lock);

	spin_lock_irqsave(&gpio_lock, flags);
Ryan Mallon's avatar
Ryan Mallon committed
808 809 810 811
	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",
812
				__func__, desc_to_gpio(desc),
Ryan Mallon's avatar
Ryan Mallon committed
813 814
				test_bit(FLAG_REQUESTED, &desc->flags),
				test_bit(FLAG_EXPORT, &desc->flags));
815 816
		status = -EPERM;
		goto fail_unlock;
David Brownell's avatar
David Brownell committed
817
	}
Ryan Mallon's avatar
Ryan Mallon committed
818 819 820

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

823 824 825
	offset = gpio_chip_hwgpio(desc);
	if (desc->chip->names && desc->chip->names[offset])
		ioname = desc->chip->names[offset];
826

Ryan Mallon's avatar
Ryan Mallon committed
827
	dev = device_create(&gpio_class, desc->chip->dev, MKDEV(0, 0),
828 829
			    desc, ioname ? ioname : "gpio%u",
			    desc_to_gpio(desc));
Ryan Mallon's avatar
Ryan Mallon committed
830 831 832
	if (IS_ERR(dev)) {
		status = PTR_ERR(dev);
		goto fail_unlock;
David Brownell's avatar
David Brownell committed
833 834
	}

Ryan Mallon's avatar
Ryan Mallon committed
835
	status = sysfs_create_group(&dev->kobj, &gpio_attr_group);
David Brownell's avatar
David Brownell committed
836
	if (status)
Ryan Mallon's avatar
Ryan Mallon committed
837
		goto fail_unregister_device;
David Brownell's avatar
David Brownell committed
838

Ryan Mallon's avatar
Ryan Mallon committed
839 840 841 842 843 844
	if (direction_may_change) {
		status = device_create_file(dev, &dev_attr_direction);
		if (status)
			goto fail_unregister_device;
	}

845
	if (gpiod_to_irq(desc) >= 0 && (direction_may_change ||
Ryan Mallon's avatar
Ryan Mallon committed
846 847 848 849 850
				       !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
851

Ryan Mallon's avatar
Ryan Mallon committed
852 853 854 855 856 857 858 859
	set_bit(FLAG_EXPORT, &desc->flags);
	mutex_unlock(&sysfs_lock);
	return 0;

fail_unregister_device:
	device_unregister(dev);
fail_unlock:
	mutex_unlock(&sysfs_lock);
860 861
	pr_debug("%s: gpio%d status %d\n", __func__, desc_to_gpio(desc),
		 status);
David Brownell's avatar
David Brownell committed
862 863
	return status;
}
864
EXPORT_SYMBOL_GPL(gpiod_export);
David Brownell's avatar
David Brownell committed
865

866
static int match_export(struct device *dev, const void *data)
David Brownell's avatar
David Brownell committed
867 868 869 870
{
	return dev_get_drvdata(dev) == data;
}

871
/**
872
 * gpiod_export_link - create a sysfs link to an exported GPIO node
873 874 875 876 877 878 879 880 881
 * @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.
 */
882 883
int gpiod_export_link(struct device *dev, const char *name,
		      struct gpio_desc *desc)
884 885 886
{
	int			status = -EINVAL;

887 888 889 890
	if (!desc) {
		pr_warn("%s: invalid GPIO\n", __func__);
		return -EINVAL;
	}
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908

	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)
909 910
		pr_debug("%s: gpio%d status %d\n", __func__, desc_to_gpio(desc),
			 status);
911 912 913

	return status;
}
914
EXPORT_SYMBOL_GPL(gpiod_export_link);
915 916

/**
917
 * gpiod_sysfs_set_active_low - set the polarity of gpio sysfs value
918 919 920 921 922 923 924 925 926 927
 * @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.
 */
928
int gpiod_sysfs_set_active_low(struct gpio_desc *desc, int value)
929 930 931 932
{
	struct device		*dev = NULL;
	int			status = -EINVAL;

933 934 935 936
	if (!desc) {
		pr_warn("%s: invalid GPIO\n", __func__);
		return -EINVAL;
	}
937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953

	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)
954 955
		pr_debug("%s: gpio%d status %d\n", __func__, desc_to_gpio(desc),
			 status);
956 957 958

	return status;
}
959
EXPORT_SYMBOL_GPL(gpiod_sysfs_set_active_low);
960

David Brownell's avatar
David Brownell committed
961
/**
962
 * gpiod_unexport - reverse effect of gpio_export()
David Brownell's avatar
David Brownell committed
963 964 965 966
 * @gpio: gpio to make unavailable
 *
 * This is implicit on gpio_free().
 */
967
void gpiod_unexport(struct gpio_desc *desc)
David Brownell's avatar
David Brownell committed
968
{
969
	int			status = 0;
970
	struct device		*dev = NULL;
David Brownell's avatar
David Brownell committed
971

972
	if (!desc) {
973 974
		pr_warn("%s: invalid GPIO\n", __func__);
		return;
975
	}
David Brownell's avatar
David Brownell committed
976 977 978 979 980 981 982

	mutex_lock(&sysfs_lock);

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

		dev = class_find_device(&gpio_class, NULL, desc, match_export);
		if (dev) {
983
			gpio_setup_irq(desc, dev, 0);
David Brownell's avatar
David Brownell committed
984 985 986 987 988 989
			clear_bit(FLAG_EXPORT, &desc->flags);
		} else
			status = -ENODEV;
	}

	mutex_unlock(&sysfs_lock);
990

991 992 993 994
	if (dev) {
		device_unregister(dev);
		put_device(dev);
	}
995

David Brownell's avatar
David Brownell committed
996
	if (status)
997 998 999
		pr_debug("%s: gpio%d status %d\n", __func__, desc_to_gpio(desc),
			 status);
}
1000
EXPORT_SYMBOL_GPL(gpiod_unexport);
David Brownell's avatar
David Brownell committed
1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018

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);
1019
	if (!IS_ERR(dev)) {
David Brownell's avatar
David Brownell committed
1020 1021 1022
		status = sysfs_create_group(&dev->kobj,
				&gpiochip_attr_group);
	} else
1023
		status = PTR_ERR(dev);
David Brownell's avatar
David Brownell committed
1024 1025 1026 1027 1028 1029 1030 1031
	chip->exported = (status == 0);
	mutex_unlock(&sysfs_lock);

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

		spin_lock_irqsave(&gpio_lock, flags);
1032 1033 1034
		gpio = 0;
		while (gpio < chip->ngpio)
			chip->desc[gpio++].chip = NULL;
David Brownell's avatar
David Brownell committed
1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068
		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;
1069
	struct gpio_chip *chip;
David Brownell's avatar
David Brownell committed
1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081

	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);
1082
	list_for_each_entry(chip, &gpio_chips, list) {
David Brownell's avatar
David Brownell committed
1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
		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 */

1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
/*
 * 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;
}

1146 1147 1148 1149 1150 1151 1152 1153
/**
 * 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.
1154
 *
David Brownell's avatar
David Brownell committed
1155 1156 1157 1158 1159
 * 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.
 *
1160 1161
 * If chip->base is negative, this requests dynamic assignment of
 * a range of valid GPIOs.
1162 1163 1164 1165 1166 1167
 */
int gpiochip_add(struct gpio_chip *chip)
{
	unsigned long	flags;
	int		status = 0;
	unsigned	id;
1168
	int		base = chip->base;
1169

Trent Piepho's avatar
Trent Piepho committed
1170
	if ((!gpio_is_valid(base) || !gpio_is_valid(base + chip->ngpio - 1))
1171
			&& base >= 0) {
1172 1173 1174 1175 1176 1177
		status = -EINVAL;
		goto fail;
	}

	spin_lock_irqsave(&gpio_lock, flags);

1178 1179 1180 1181
	if (base < 0) {
		base = gpiochip_find_base(chip->ngpio);
		if (base < 0) {
			status = base;
David Brownell's avatar
David Brownell committed
1182
			goto unlock;
1183 1184 1185 1186
		}
		chip->base = base;
	}

1187 1188
	status = gpiochip_add_to_list(chip);

1189
	if (status == 0) {
1190 1191 1192 1193 1194
		chip->desc = &gpio_desc[chip->base];

		for (id = 0; id < chip->ngpio; id++) {
			struct gpio_desc *desc = &chip->desc[id];
			desc->chip = chip;
David Brownell's avatar
David Brownell committed
1195 1196 1197 1198 1199

			/* 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,
1200
			 * and in case chip->get_direction is not set,
David Brownell's avatar
David Brownell committed
1201 1202
			 * we may expose the wrong direction in sysfs.
			 */
1203
			desc->flags = !chip->direction_input
David Brownell's avatar
David Brownell committed
1204 1205
				? (1 << FLAG_IS_OUT)
				: 0;
1206 1207 1208
		}
	}

1209 1210
	spin_unlock_irqrestore(&gpio_lock, flags);

1211 1212 1213 1214
#ifdef CONFIG_PINCTRL
	INIT_LIST_HEAD(&chip->pin_ranges);
#endif

1215 1216
	of_gpiochip_add(chip);

1217 1218 1219 1220 1221 1222 1223
	if (status)
		goto fail;

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

1224
	pr_debug("gpiochip_add: registered GPIOs %d to %d on device: %s\n",
1225 1226 1227
		chip->base, chip->base + chip->ngpio - 1,
		chip->label ? : "generic");

1228
	return 0;
1229 1230 1231

unlock:
	spin_unlock_irqrestore(&gpio_lock, flags);
1232 1233
fail:
	/* failures here can mean systems won't boot... */
1234 1235 1236
	pr_err("gpiochip_add: gpios %d..%d (%s) failed to register\n",
		chip->base, chip->base + chip->ngpio - 1,
		chip->label ? : "generic");
1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253