gpiolib.c 94.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/idr.h>
14
#include <linux/slab.h>
15
#include <linux/acpi.h>
16
#include <linux/gpio/driver.h>
17
#include <linux/gpio/machine.h>
18
#include <linux/pinctrl/consumer.h>
19 20 21
#include <linux/cdev.h>
#include <linux/fs.h>
#include <linux/uaccess.h>
22
#include <linux/compat.h>
23
#include <linux/anon_inodes.h>
24 25 26
#include <linux/kfifo.h>
#include <linux/poll.h>
#include <linux/timekeeping.h>
27
#include <uapi/linux/gpio.h>
28

29 30
#include "gpiolib.h"

31 32
#define CREATE_TRACE_POINTS
#include <trace/events/gpio.h>
33

34
/* Implementation infrastructure for GPIO interfaces.
35
 *
36 37 38
 * 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.
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

54 55
/* Device and char device-related information */
static DEFINE_IDA(gpio_ida);
56 57 58 59 60
static dev_t gpio_devt;
#define GPIO_DEV_MAX 256 /* 256 GPIO chip devices supported */
static struct bus_type gpio_bus_type = {
	.name = "gpio",
};
61

62 63 64 65
/* 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.
 */
66
DEFINE_SPINLOCK(gpio_lock);
67

68 69
static DEFINE_MUTEX(gpio_lookup_lock);
static LIST_HEAD(gpio_lookup_list);
70
LIST_HEAD(gpio_devices);
71 72 73

static void gpiochip_free_hogs(struct gpio_chip *chip);
static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip);
74 75
static int gpiochip_irqchip_init_valid_mask(struct gpio_chip *gpiochip);
static void gpiochip_irqchip_free_valid_mask(struct gpio_chip *gpiochip);
76

77
static bool gpiolib_initialized;
78

79 80 81 82 83
static inline void desc_set_label(struct gpio_desc *d, const char *label)
{
	d->label = label;
}

84 85 86
/**
 * Convert a GPIO number to its descriptor
 */
87
struct gpio_desc *gpio_to_desc(unsigned gpio)
88
{
89
	struct gpio_device *gdev;
90 91 92 93
	unsigned long flags;

	spin_lock_irqsave(&gpio_lock, flags);

94
	list_for_each_entry(gdev, &gpio_devices, list) {
95 96
		if (gdev->base <= gpio &&
		    gdev->base + gdev->ngpio > gpio) {
97
			spin_unlock_irqrestore(&gpio_lock, flags);
98
			return &gdev->descs[gpio - gdev->base];
99 100 101 102 103
		}
	}

	spin_unlock_irqrestore(&gpio_lock, flags);

104 105 106
	if (!gpio_is_valid(gpio))
		WARN(1, "invalid GPIO %d\n", gpio);

107
	return NULL;
108
}
109
EXPORT_SYMBOL_GPL(gpio_to_desc);
110

111
/**
112
 * Get the GPIO descriptor corresponding to the given hw number for this chip.
113
 */
114 115
struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
				    u16 hwnum)
116
{
117 118 119
	struct gpio_device *gdev = chip->gpiodev;

	if (hwnum >= gdev->ngpio)
120
		return ERR_PTR(-EINVAL);
121

122
	return &gdev->descs[hwnum];
123
}
124 125 126 127 128 129

/**
 * 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
 */
130
int desc_to_gpio(const struct gpio_desc *desc)
131
{
132
	return desc->gdev->base + (desc - &desc->gdev->descs[0]);
133
}
134
EXPORT_SYMBOL_GPL(desc_to_gpio);
135 136


137 138 139 140 141
/**
 * 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)
142
{
143 144 145
	if (!desc || !desc->gdev || !desc->gdev->chip)
		return NULL;
	return desc->gdev->chip;
146
}
147
EXPORT_SYMBOL_GPL(gpiod_to_chip);
148

149 150 151
/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
static int gpiochip_find_base(int ngpio)
{
152
	struct gpio_device *gdev;
153
	int base = ARCH_NR_GPIOS - ngpio;
154

155
	list_for_each_entry_reverse(gdev, &gpio_devices, list) {
156
		/* found a free space? */
157
		if (gdev->base + gdev->ngpio <= base)
158 159 160
			break;
		else
			/* nope, check the space right before the chip */
161
			base = gdev->base - ngpio;
162 163
	}

164
	if (gpio_is_valid(base)) {
165
		pr_debug("%s: found new base at %d\n", __func__, base);
166 167 168 169
		return base;
	} else {
		pr_err("%s: cannot find free range\n", __func__);
		return -ENOSPC;
Anton Vorontsov's avatar
Anton Vorontsov committed
170 171 172
	}
}

173 174 175 176 177 178 179 180
/**
 * 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.
 */
181
int gpiod_get_direction(struct gpio_desc *desc)
182 183
{
	struct gpio_chip	*chip;
184
	unsigned		offset;
185 186
	int			status = -EINVAL;

187 188
	chip = gpiod_to_chip(desc);
	offset = gpio_chip_hwgpio(desc);
189 190 191 192

	if (!chip->get_direction)
		return status;

193
	status = chip->get_direction(chip, offset);
194 195 196
	if (status > 0) {
		/* GPIOF_DIR_IN, or other positive */
		status = 1;
197
		clear_bit(FLAG_IS_OUT, &desc->flags);
198 199 200
	}
	if (status == 0) {
		/* GPIOF_DIR_OUT */
201
		set_bit(FLAG_IS_OUT, &desc->flags);
202 203 204
	}
	return status;
}
205
EXPORT_SYMBOL_GPL(gpiod_get_direction);
206

207 208
/*
 * Add a new chip to the global chips list, keeping the list of chips sorted
209
 * by range(means [base, base + ngpio - 1]) order.
210 211 212 213
 *
 * Return -EBUSY if the new chip overlaps with some other chip's integer
 * space.
 */
214
static int gpiodev_add_to_list(struct gpio_device *gdev)
215
{
216
	struct gpio_device *prev, *next;
217

218
	if (list_empty(&gpio_devices)) {
219
		/* initial entry in list */
220
		list_add_tail(&gdev->list, &gpio_devices);
221
		return 0;
222 223
	}

224 225 226 227 228
	next = list_entry(gpio_devices.next, struct gpio_device, list);
	if (gdev->base + gdev->ngpio <= next->base) {
		/* add before first entry */
		list_add(&gdev->list, &gpio_devices);
		return 0;
229 230
	}

231 232 233 234
	prev = list_entry(gpio_devices.prev, struct gpio_device, list);
	if (prev->base + prev->ngpio <= gdev->base) {
		/* add behind last entry */
		list_add_tail(&gdev->list, &gpio_devices);
235
		return 0;
236 237
	}

238 239 240 241
	list_for_each_entry_safe(prev, next, &gpio_devices, list) {
		/* at the end of the list */
		if (&next->list == &gpio_devices)
			break;
242

243 244 245 246 247 248 249 250 251 252
		/* add between prev and next */
		if (prev->base + prev->ngpio <= gdev->base
				&& gdev->base + gdev->ngpio <= next->base) {
			list_add(&gdev->list, &prev->list);
			return 0;
		}
	}

	dev_err(&gdev->dev, "GPIO integer space overlap, cannot add chip\n");
	return -EBUSY;
253 254
}

255 256 257 258 259
/**
 * Convert a GPIO name to its descriptor
 */
static struct gpio_desc *gpio_name_to_desc(const char * const name)
{
260
	struct gpio_device *gdev;
261 262 263 264
	unsigned long flags;

	spin_lock_irqsave(&gpio_lock, flags);

265
	list_for_each_entry(gdev, &gpio_devices, list) {
266 267
		int i;

268 269
		for (i = 0; i != gdev->ngpio; ++i) {
			struct gpio_desc *desc = &gdev->descs[i];
270

271
			if (!desc->name || !name)
272 273
				continue;

274
			if (!strcmp(desc->name, name)) {
275
				spin_unlock_irqrestore(&gpio_lock, flags);
276
				return desc;
277 278 279 280 281 282 283 284 285
			}
		}
	}

	spin_unlock_irqrestore(&gpio_lock, flags);

	return NULL;
}

286 287 288 289
/*
 * Takes the names from gc->names and checks if they are all unique. If they
 * are, they are assigned to their gpio descriptors.
 *
290
 * Warning if one of the names is already used for a different GPIO.
291 292 293
 */
static int gpiochip_set_desc_names(struct gpio_chip *gc)
{
294
	struct gpio_device *gdev = gc->gpiodev;
295 296 297 298 299 300 301 302 303 304
	int i;

	if (!gc->names)
		return 0;

	/* First check all names if they are unique */
	for (i = 0; i != gc->ngpio; ++i) {
		struct gpio_desc *gpio;

		gpio = gpio_name_to_desc(gc->names[i]);
305
		if (gpio)
306
			dev_warn(&gdev->dev,
307
				 "Detected name collision for GPIO name '%s'\n",
308
				 gc->names[i]);
309 310 311 312
	}

	/* Then add all names to the GPIO descriptors */
	for (i = 0; i != gc->ngpio; ++i)
313
		gdev->descs[i].name = gc->names[i];
314 315 316 317

	return 0;
}

318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 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
/*
 * GPIO line handle management
 */

/**
 * struct linehandle_state - contains the state of a userspace handle
 * @gdev: the GPIO device the handle pertains to
 * @label: consumer label used to tag descriptors
 * @descs: the GPIO descriptors held by this handle
 * @numdescs: the number of descriptors held in the descs array
 */
struct linehandle_state {
	struct gpio_device *gdev;
	const char *label;
	struct gpio_desc *descs[GPIOHANDLES_MAX];
	u32 numdescs;
};

static long linehandle_ioctl(struct file *filep, unsigned int cmd,
			     unsigned long arg)
{
	struct linehandle_state *lh = filep->private_data;
	void __user *ip = (void __user *)arg;
	struct gpiohandle_data ghd;
	int i;

	if (cmd == GPIOHANDLE_GET_LINE_VALUES_IOCTL) {
		int val;

		/* TODO: check if descriptors are really input */
		for (i = 0; i < lh->numdescs; i++) {
			val = gpiod_get_value_cansleep(lh->descs[i]);
			if (val < 0)
				return val;
			ghd.values[i] = val;
		}

		if (copy_to_user(ip, &ghd, sizeof(ghd)))
			return -EFAULT;

		return 0;
	} else if (cmd == GPIOHANDLE_SET_LINE_VALUES_IOCTL) {
		int vals[GPIOHANDLES_MAX];

		/* TODO: check if descriptors are really output */
		if (copy_from_user(&ghd, ip, sizeof(ghd)))
			return -EFAULT;

		/* Clamp all values to [0,1] */
		for (i = 0; i < lh->numdescs; i++)
			vals[i] = !!ghd.values[i];

		/* Reuse the array setting function */
		gpiod_set_array_value_complex(false,
					      true,
					      lh->numdescs,
					      lh->descs,
					      vals);
		return 0;
	}
	return -EINVAL;
}

#ifdef CONFIG_COMPAT
static long linehandle_ioctl_compat(struct file *filep, unsigned int cmd,
			     unsigned long arg)
{
	return linehandle_ioctl(filep, cmd, (unsigned long)compat_ptr(arg));
}
#endif

static int linehandle_release(struct inode *inode, struct file *filep)
{
	struct linehandle_state *lh = filep->private_data;
	struct gpio_device *gdev = lh->gdev;
	int i;

	for (i = 0; i < lh->numdescs; i++)
		gpiod_free(lh->descs[i]);
	kfree(lh->label);
	kfree(lh);
	put_device(&gdev->dev);
	return 0;
}

static const struct file_operations linehandle_fileops = {
	.release = linehandle_release,
	.owner = THIS_MODULE,
	.llseek = noop_llseek,
	.unlocked_ioctl = linehandle_ioctl,
#ifdef CONFIG_COMPAT
	.compat_ioctl = linehandle_ioctl_compat,
#endif
};

static int linehandle_create(struct gpio_device *gdev, void __user *ip)
{
	struct gpiohandle_request handlereq;
	struct linehandle_state *lh;
	int fd, i, ret;

	if (copy_from_user(&handlereq, ip, sizeof(handlereq)))
		return -EFAULT;
	if ((handlereq.lines == 0) || (handlereq.lines > GPIOHANDLES_MAX))
		return -EINVAL;

	lh = kzalloc(sizeof(*lh), GFP_KERNEL);
	if (!lh)
		return -ENOMEM;
	lh->gdev = gdev;
	get_device(&gdev->dev);

	/* Make sure this is terminated */
	handlereq.consumer_label[sizeof(handlereq.consumer_label)-1] = '\0';
	if (strlen(handlereq.consumer_label)) {
		lh->label = kstrdup(handlereq.consumer_label,
				    GFP_KERNEL);
		if (!lh->label) {
			ret = -ENOMEM;
			goto out_free_lh;
		}
	}

	/* Request each GPIO */
	for (i = 0; i < handlereq.lines; i++) {
		u32 offset = handlereq.lineoffsets[i];
		u32 lflags = handlereq.flags;
		struct gpio_desc *desc;

		desc = &gdev->descs[offset];
		ret = gpiod_request(desc, lh->label);
		if (ret)
			goto out_free_descs;
		lh->descs[i] = desc;

		if (lflags & GPIOHANDLE_REQUEST_ACTIVE_LOW)
			set_bit(FLAG_ACTIVE_LOW, &desc->flags);
		if (lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN)
			set_bit(FLAG_OPEN_DRAIN, &desc->flags);
		if (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE)
			set_bit(FLAG_OPEN_SOURCE, &desc->flags);

		/*
		 * Lines have to be requested explicitly for input
		 * or output, else the line will be treated "as is".
		 */
		if (lflags & GPIOHANDLE_REQUEST_OUTPUT) {
			int val = !!handlereq.default_values[i];

			ret = gpiod_direction_output(desc, val);
			if (ret)
				goto out_free_descs;
		} else if (lflags & GPIOHANDLE_REQUEST_INPUT) {
			ret = gpiod_direction_input(desc);
			if (ret)
				goto out_free_descs;
		}
		dev_dbg(&gdev->dev, "registered chardev handle for line %d\n",
			offset);
	}
478 479
	/* Let i point at the last handle */
	i--;
480 481 482 483 484 485 486 487 488 489 490 491
	lh->numdescs = handlereq.lines;

	fd = anon_inode_getfd("gpio-linehandle",
			      &linehandle_fileops,
			      lh,
			      O_RDONLY | O_CLOEXEC);
	if (fd < 0) {
		ret = fd;
		goto out_free_descs;
	}

	handlereq.fd = fd;
492 493 494 495
	if (copy_to_user(ip, &handlereq, sizeof(handlereq))) {
		ret = -EFAULT;
		goto out_free_descs;
	}
496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511

	dev_dbg(&gdev->dev, "registered chardev handle for %d lines\n",
		lh->numdescs);

	return 0;

out_free_descs:
	for (; i >= 0; i--)
		gpiod_free(lh->descs[i]);
	kfree(lh->label);
out_free_lh:
	kfree(lh);
	put_device(&gdev->dev);
	return ret;
}

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 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 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
/*
 * GPIO line event management
 */

/**
 * struct lineevent_state - contains the state of a userspace event
 * @gdev: the GPIO device the event pertains to
 * @label: consumer label used to tag descriptors
 * @desc: the GPIO descriptor held by this event
 * @eflags: the event flags this line was requested with
 * @irq: the interrupt that trigger in response to events on this GPIO
 * @wait: wait queue that handles blocking reads of events
 * @events: KFIFO for the GPIO events
 * @read_lock: mutex lock to protect reads from colliding with adding
 * new events to the FIFO
 */
struct lineevent_state {
	struct gpio_device *gdev;
	const char *label;
	struct gpio_desc *desc;
	u32 eflags;
	int irq;
	wait_queue_head_t wait;
	DECLARE_KFIFO(events, struct gpioevent_data, 16);
	struct mutex read_lock;
};

static unsigned int lineevent_poll(struct file *filep,
				   struct poll_table_struct *wait)
{
	struct lineevent_state *le = filep->private_data;
	unsigned int events = 0;

	poll_wait(filep, &le->wait, wait);

	if (!kfifo_is_empty(&le->events))
		events = POLLIN | POLLRDNORM;

	return events;
}


static ssize_t lineevent_read(struct file *filep,
			      char __user *buf,
			      size_t count,
			      loff_t *f_ps)
{
	struct lineevent_state *le = filep->private_data;
	unsigned int copied;
	int ret;

	if (count < sizeof(struct gpioevent_data))
		return -EINVAL;

	do {
		if (kfifo_is_empty(&le->events)) {
			if (filep->f_flags & O_NONBLOCK)
				return -EAGAIN;

			ret = wait_event_interruptible(le->wait,
					!kfifo_is_empty(&le->events));
			if (ret)
				return ret;
		}

		if (mutex_lock_interruptible(&le->read_lock))
			return -ERESTARTSYS;
		ret = kfifo_to_user(&le->events, buf, count, &copied);
		mutex_unlock(&le->read_lock);

		if (ret)
			return ret;

		/*
		 * If we couldn't read anything from the fifo (a different
		 * thread might have been faster) we either return -EAGAIN if
		 * the file descriptor is non-blocking, otherwise we go back to
		 * sleep and wait for more data to arrive.
		 */
		if (copied == 0 && (filep->f_flags & O_NONBLOCK))
			return -EAGAIN;

	} while (copied == 0);

	return copied;
}

static int lineevent_release(struct inode *inode, struct file *filep)
{
	struct lineevent_state *le = filep->private_data;
	struct gpio_device *gdev = le->gdev;

	free_irq(le->irq, le);
	gpiod_free(le->desc);
	kfree(le->label);
	kfree(le);
	put_device(&gdev->dev);
	return 0;
}

static long lineevent_ioctl(struct file *filep, unsigned int cmd,
			    unsigned long arg)
{
	struct lineevent_state *le = filep->private_data;
	void __user *ip = (void __user *)arg;
	struct gpiohandle_data ghd;

	/*
	 * We can get the value for an event line but not set it,
	 * because it is input by definition.
	 */
	if (cmd == GPIOHANDLE_GET_LINE_VALUES_IOCTL) {
		int val;

		val = gpiod_get_value_cansleep(le->desc);
		if (val < 0)
			return val;
		ghd.values[0] = val;

		if (copy_to_user(ip, &ghd, sizeof(ghd)))
			return -EFAULT;

		return 0;
	}
	return -EINVAL;
}

#ifdef CONFIG_COMPAT
static long lineevent_ioctl_compat(struct file *filep, unsigned int cmd,
				   unsigned long arg)
{
	return lineevent_ioctl(filep, cmd, (unsigned long)compat_ptr(arg));
}
#endif

static const struct file_operations lineevent_fileops = {
	.release = lineevent_release,
	.read = lineevent_read,
	.poll = lineevent_poll,
	.owner = THIS_MODULE,
	.llseek = noop_llseek,
	.unlocked_ioctl = lineevent_ioctl,
#ifdef CONFIG_COMPAT
	.compat_ioctl = lineevent_ioctl_compat,
#endif
};

659
static irqreturn_t lineevent_irq_thread(int irq, void *p)
660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
{
	struct lineevent_state *le = p;
	struct gpioevent_data ge;
	int ret;

	ge.timestamp = ktime_get_real_ns();

	if (le->eflags & GPIOEVENT_REQUEST_BOTH_EDGES) {
		int level = gpiod_get_value_cansleep(le->desc);

		if (level)
			/* Emit low-to-high event */
			ge.id = GPIOEVENT_EVENT_RISING_EDGE;
		else
			/* Emit high-to-low event */
			ge.id = GPIOEVENT_EVENT_FALLING_EDGE;
	} else if (le->eflags & GPIOEVENT_REQUEST_RISING_EDGE) {
		/* Emit low-to-high event */
		ge.id = GPIOEVENT_EVENT_RISING_EDGE;
	} else if (le->eflags & GPIOEVENT_REQUEST_FALLING_EDGE) {
		/* Emit high-to-low event */
		ge.id = GPIOEVENT_EVENT_FALLING_EDGE;
682 683
	} else {
		return IRQ_NONE;
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 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
	}

	ret = kfifo_put(&le->events, ge);
	if (ret != 0)
		wake_up_poll(&le->wait, POLLIN);

	return IRQ_HANDLED;
}

static int lineevent_create(struct gpio_device *gdev, void __user *ip)
{
	struct gpioevent_request eventreq;
	struct lineevent_state *le;
	struct gpio_desc *desc;
	u32 offset;
	u32 lflags;
	u32 eflags;
	int fd;
	int ret;
	int irqflags = 0;

	if (copy_from_user(&eventreq, ip, sizeof(eventreq)))
		return -EFAULT;

	le = kzalloc(sizeof(*le), GFP_KERNEL);
	if (!le)
		return -ENOMEM;
	le->gdev = gdev;
	get_device(&gdev->dev);

	/* Make sure this is terminated */
	eventreq.consumer_label[sizeof(eventreq.consumer_label)-1] = '\0';
	if (strlen(eventreq.consumer_label)) {
		le->label = kstrdup(eventreq.consumer_label,
				    GFP_KERNEL);
		if (!le->label) {
			ret = -ENOMEM;
			goto out_free_le;
		}
	}

	offset = eventreq.lineoffset;
	lflags = eventreq.handleflags;
	eflags = eventreq.eventflags;

	/* This is just wrong: we don't look for events on output lines */
	if (lflags & GPIOHANDLE_REQUEST_OUTPUT) {
		ret = -EINVAL;
		goto out_free_label;
	}

	desc = &gdev->descs[offset];
	ret = gpiod_request(desc, le->label);
	if (ret)
		goto out_free_desc;
	le->desc = desc;
	le->eflags = eflags;

	if (lflags & GPIOHANDLE_REQUEST_ACTIVE_LOW)
		set_bit(FLAG_ACTIVE_LOW, &desc->flags);
	if (lflags & GPIOHANDLE_REQUEST_OPEN_DRAIN)
		set_bit(FLAG_OPEN_DRAIN, &desc->flags);
	if (lflags & GPIOHANDLE_REQUEST_OPEN_SOURCE)
		set_bit(FLAG_OPEN_SOURCE, &desc->flags);

	ret = gpiod_direction_input(desc);
	if (ret)
		goto out_free_desc;

	le->irq = gpiod_to_irq(desc);
	if (le->irq <= 0) {
		ret = -ENODEV;
		goto out_free_desc;
	}

	if (eflags & GPIOEVENT_REQUEST_RISING_EDGE)
		irqflags |= IRQF_TRIGGER_RISING;
	if (eflags & GPIOEVENT_REQUEST_FALLING_EDGE)
		irqflags |= IRQF_TRIGGER_FALLING;
	irqflags |= IRQF_ONESHOT;
	irqflags |= IRQF_SHARED;

	INIT_KFIFO(le->events);
	init_waitqueue_head(&le->wait);
	mutex_init(&le->read_lock);

	/* Request a thread to read the events */
	ret = request_threaded_irq(le->irq,
			NULL,
			lineevent_irq_thread,
			irqflags,
			le->label,
			le);
	if (ret)
		goto out_free_desc;

	fd = anon_inode_getfd("gpio-event",
			      &lineevent_fileops,
			      le,
			      O_RDONLY | O_CLOEXEC);
	if (fd < 0) {
		ret = fd;
		goto out_free_irq;
	}

	eventreq.fd = fd;
790 791 792 793
	if (copy_to_user(ip, &eventreq, sizeof(eventreq))) {
		ret = -EFAULT;
		goto out_free_irq;
	}
794 795 796 797 798 799 800 801 802 803 804 805 806 807 808

	return 0;

out_free_irq:
	free_irq(le->irq, le);
out_free_desc:
	gpiod_free(le->desc);
out_free_label:
	kfree(le->label);
out_free_le:
	kfree(le);
	put_device(&gdev->dev);
	return ret;
}

809 810 811 812 813 814 815
/**
 * gpio_ioctl() - ioctl handler for the GPIO chardev
 */
static long gpio_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
{
	struct gpio_device *gdev = filp->private_data;
	struct gpio_chip *chip = gdev->chip;
816
	void __user *ip = (void __user *)arg;
817 818 819 820 821

	/* We fail any subsequent ioctl():s when the chip is gone */
	if (!chip)
		return -ENODEV;

822
	/* Fill in the struct and pass to userspace */
823
	if (cmd == GPIO_GET_CHIPINFO_IOCTL) {
824 825
		struct gpiochip_info chipinfo;

826 827
		memset(&chipinfo, 0, sizeof(chipinfo));

828 829 830
		strncpy(chipinfo.name, dev_name(&gdev->dev),
			sizeof(chipinfo.name));
		chipinfo.name[sizeof(chipinfo.name)-1] = '\0';
831 832 833
		strncpy(chipinfo.label, gdev->label,
			sizeof(chipinfo.label));
		chipinfo.label[sizeof(chipinfo.label)-1] = '\0';
834
		chipinfo.lines = gdev->ngpio;
835 836 837
		if (copy_to_user(ip, &chipinfo, sizeof(chipinfo)))
			return -EFAULT;
		return 0;
838 839 840 841 842 843
	} else if (cmd == GPIO_GET_LINEINFO_IOCTL) {
		struct gpioline_info lineinfo;
		struct gpio_desc *desc;

		if (copy_from_user(&lineinfo, ip, sizeof(lineinfo)))
			return -EFAULT;
844
		if (lineinfo.line_offset >= gdev->ngpio)
845 846 847 848 849 850 851 852 853 854 855
			return -EINVAL;

		desc = &gdev->descs[lineinfo.line_offset];
		if (desc->name) {
			strncpy(lineinfo.name, desc->name,
				sizeof(lineinfo.name));
			lineinfo.name[sizeof(lineinfo.name)-1] = '\0';
		} else {
			lineinfo.name[0] = '\0';
		}
		if (desc->label) {
856 857 858
			strncpy(lineinfo.consumer, desc->label,
				sizeof(lineinfo.consumer));
			lineinfo.consumer[sizeof(lineinfo.consumer)-1] = '\0';
859
		} else {
860
			lineinfo.consumer[0] = '\0';
861 862 863 864 865 866 867
		}

		/*
		 * Userspace only need to know that the kernel is using
		 * this GPIO so it can't use it.
		 */
		lineinfo.flags = 0;
868 869 870 871 872
		if (test_bit(FLAG_REQUESTED, &desc->flags) ||
		    test_bit(FLAG_IS_HOGGED, &desc->flags) ||
		    test_bit(FLAG_USED_AS_IRQ, &desc->flags) ||
		    test_bit(FLAG_EXPORT, &desc->flags) ||
		    test_bit(FLAG_SYSFS, &desc->flags))
873
			lineinfo.flags |= GPIOLINE_FLAG_KERNEL;
874
		if (test_bit(FLAG_IS_OUT, &desc->flags))
875
			lineinfo.flags |= GPIOLINE_FLAG_IS_OUT;
876
		if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
877
			lineinfo.flags |= GPIOLINE_FLAG_ACTIVE_LOW;
878
		if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
879
			lineinfo.flags |= GPIOLINE_FLAG_OPEN_DRAIN;
880
		if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
881 882 883 884 885
			lineinfo.flags |= GPIOLINE_FLAG_OPEN_SOURCE;

		if (copy_to_user(ip, &lineinfo, sizeof(lineinfo)))
			return -EFAULT;
		return 0;
886 887
	} else if (cmd == GPIO_GET_LINEHANDLE_IOCTL) {
		return linehandle_create(gdev, ip);
888 889
	} else if (cmd == GPIO_GET_LINEEVENT_IOCTL) {
		return lineevent_create(gdev, ip);
890 891 892 893
	}
	return -EINVAL;
}

894 895 896 897 898 899 900 901
#ifdef CONFIG_COMPAT
static long gpio_ioctl_compat(struct file *filp, unsigned int cmd,
			      unsigned long arg)
{
	return gpio_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));
}
#endif

902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944
/**
 * gpio_chrdev_open() - open the chardev for ioctl operations
 * @inode: inode for this chardev
 * @filp: file struct for storing private data
 * Returns 0 on success
 */
static int gpio_chrdev_open(struct inode *inode, struct file *filp)
{
	struct gpio_device *gdev = container_of(inode->i_cdev,
					      struct gpio_device, chrdev);

	/* Fail on open if the backing gpiochip is gone */
	if (!gdev || !gdev->chip)
		return -ENODEV;
	get_device(&gdev->dev);
	filp->private_data = gdev;
	return 0;
}

/**
 * gpio_chrdev_release() - close chardev after ioctl operations
 * @inode: inode for this chardev
 * @filp: file struct for storing private data
 * Returns 0 on success
 */
static int gpio_chrdev_release(struct inode *inode, struct file *filp)
{
	struct gpio_device *gdev = container_of(inode->i_cdev,
					      struct gpio_device, chrdev);

	if (!gdev)
		return -ENODEV;
	put_device(&gdev->dev);
	return 0;
}


static const struct file_operations gpio_fileops = {
	.release = gpio_chrdev_release,
	.open = gpio_chrdev_open,
	.owner = THIS_MODULE,
	.llseek = noop_llseek,
	.unlocked_ioctl = gpio_ioctl,
945 946 947
#ifdef CONFIG_COMPAT
	.compat_ioctl = gpio_ioctl_compat,
#endif
948 949
};

950 951 952 953 954 955
static void gpiodevice_release(struct device *dev)
{
	struct gpio_device *gdev = dev_get_drvdata(dev);

	list_del(&gdev->list);
	ida_simple_remove(&gpio_ida, gdev->id);
956 957
	kfree(gdev->label);
	kfree(gdev->descs);
958
	kfree(gdev);
959 960
}

961 962 963 964 965 966 967 968 969 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
static int gpiochip_setup_dev(struct gpio_device *gdev)
{
	int status;

	cdev_init(&gdev->chrdev, &gpio_fileops);
	gdev->chrdev.owner = THIS_MODULE;
	gdev->chrdev.kobj.parent = &gdev->dev.kobj;
	gdev->dev.devt = MKDEV(MAJOR(gpio_devt), gdev->id);
	status = cdev_add(&gdev->chrdev, gdev->dev.devt, 1);
	if (status < 0)
		chip_warn(gdev->chip, "failed to add char device %d:%d\n",
			  MAJOR(gpio_devt), gdev->id);
	else
		chip_dbg(gdev->chip, "added GPIO chardev (%d:%d)\n",
			 MAJOR(gpio_devt), gdev->id);
	status = device_add(&gdev->dev);
	if (status)
		goto err_remove_chardev;

	status = gpiochip_sysfs_register(gdev);
	if (status)
		goto err_remove_device;

	/* From this point, the .release() function cleans up gpio_device */
	gdev->dev.release = gpiodevice_release;
	pr_debug("%s: registered GPIOs %d to %d on device: %s (%s)\n",
		 __func__, gdev->base, gdev->base + gdev->ngpio - 1,
		 dev_name(&gdev->dev), gdev->chip->label ? : "generic");

	return 0;

err_remove_device:
	device_del(&gdev->dev);
err_remove_chardev:
	cdev_del(&gdev->chrdev);
	return status;
}

static void gpiochip_setup_devs(void)
{
	struct gpio_device *gdev;
	int err;

	list_for_each_entry(gdev, &gpio_devices, list) {
		err = gpiochip_setup_dev(gdev);
		if (err)
			pr_err("%s: Failed to initialize gpio device (%d)\n",
			       dev_name(&gdev->dev), err);
	}
}

1012
/**
1013
 * gpiochip_add_data() - register a gpio_chip
1014
 * @chip: the chip to register, with chip->base initialized
1015
 * Context: potentially before irqs will work
1016 1017 1018 1019
 *
 * 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.
1020
 *
1021
 * When gpiochip_add_data() is called very early during boot, so that GPIOs
1022
 * can be freely used, the chip->parent device must be registered before
David Brownell's avatar
David Brownell committed
1023 1024 1025
 * the gpio framework's arch_initcall().  Otherwise sysfs initialization
 * for GPIOs will fail rudely.
 *
1026 1027 1028
 * gpiochip_add_data() must only be called after gpiolib initialization,
 * ie after core_initcall().
 *
1029 1030
 * If chip->base is negative, this requests dynamic assignment of
 * a range of valid GPIOs.
1031
 */
1032
int gpiochip_add_data(struct gpio_chip *chip, void *data)
1033 1034 1035
{
	unsigned long	flags;
	int		status = 0;
1036
	unsigned	i;
1037
	int		base = chip->base;
1038
	struct gpio_device *gdev;
1039

1040 1041 1042 1043
	/*
	 * First: allocate and populate the internal stat container, and
	 * set up the struct device.
	 */
1044
	gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
1045
	if (!gdev)
1046
		return -ENOMEM;
1047
	gdev->dev.bus = &gpio_bus_type;
1048 1049 1050 1051 1052
	gdev->chip = chip;
	chip->gpiodev = gdev;
	if (chip->parent) {
		gdev->dev.parent = chip->parent;
		gdev->dev.of_node = chip->parent->of_node;
1053 1054
	}

1055 1056
#ifdef CONFIG_OF_GPIO
	/* If the gpiochip has an assigned OF node this takes precedence */
1057 1058
	if (chip->of_node)
		gdev->dev.of_node = chip->of_node;
1059
#endif
1060

1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075
	gdev->id = ida_simple_get(&gpio_ida, 0, 0, GFP_KERNEL);
	if (gdev->id < 0) {
		status = gdev->id;
		goto err_free_gdev;
	}
	dev_set_name(&gdev->dev, "gpiochip%d", gdev->id);
	device_initialize(&gdev->dev);
	dev_set_drvdata(&gdev->dev, gdev);
	if (chip->parent && chip->parent->driver)
		gdev->owner = chip->parent->driver->owner;
	else if (chip->owner)
		/* TODO: remove chip->owner */
		gdev->owner = chip->owner;
	else
		gdev->owner = THIS_MODULE;
1076

1077
	gdev->descs = kcalloc(chip->ngpio, sizeof(gdev->descs[0]), GFP_KERNEL);
1078
	if (!gdev->descs) {
1079 1080 1081 1082
		status = -ENOMEM;
		goto err_free_gdev;
	}

1083 1084
	if (chip->ngpio == 0) {
		chip_err(chip, "tried to insert a GPIO chip with zero lines\n");
1085
		status = -EINVAL;
1086
		goto err_free_descs;
1087
	}
1088 1089

	if (chip->label)
1090
		gdev->label = kstrdup(chip->label, GFP_KERNEL);
1091
	else
1092
		gdev->label = kstrdup("unknown", GFP_KERNEL);
1093 1094
	if (!gdev->label) {
		status = -ENOMEM;
1095
		goto err_free_descs;
1096 1097
	}

1098
	gdev->ngpio = chip->ngpio;
1099
	gdev->data = data;
1100

1101 1102
	spin_lock_irqsave(&gpio_lock, flags);

1103 1104 1105 1106 1107 1108 1109
	/*
	 * TODO: this allocates a Linux GPIO number base in the global
	 * GPIO numberspace for this chip. In the long run we want to
	 * get *rid* of this numberspace and use only descriptors, but
	 * it may be a pipe dream. It will not happen before we get rid
	 * of the sysfs interface anyways.
	 */
1110 1111 1112 1113
	if (base < 0) {
		base = gpiochip_find_base(chip->ngpio);
		if (base < 0) {
			status = base;
1114
			spin_unlock_irqrestore(&gpio_lock, flags);
1115
			goto err_free_label;
1116
		}
1117 1118 1119 1120 1121 1122
		/*
		 * TODO: it should not be necessary to reflect the assigned
		 * base outside of the GPIO subsystem. Go over drivers and
		 * see if anyone makes use of this, else drop this and assign
		 * a poison instead.
		 */
1123 1124
		chip->base = base;
	}
1125
	gdev->base = base;
1126

1127
	status = gpiodev_add_to_list(gdev);
1128 1129
	if (status) {
		spin_unlock_irqrestore(&gpio_lock, flags);
1130
		goto err_free_label;
1131
	}
1132

1133 1134
	spin_unlock_irqrestore(&gpio_lock, flags);

1135
	for (i = 0; i < chip->ngpio; i++) {
1136
		struct gpio_desc *desc = &gdev->descs[i];
1137

1138
		desc->gdev = gdev;
1139 1140 1141 1142 1143 1144 1145
		/*
		 * 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, and in case
		 * chip->get_direction is not set, we may expose the
		 * wrong direction in sysfs.
1146
		 */
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163

		if (chip->get_direction) {
			/*
			 * If we have .get_direction, set up the initial
			 * direction flag from the hardware.
			 */
			int dir = chip->get_direction(chip, i);

			if (!dir)
				set_bit(FLAG_IS_OUT, &desc->flags);
		} else if (!chip->direction_input) {
			/*
			 * If the chip lacks the .direction_input callback
			 * we logically assume all lines are outputs.
			 */
			set_bit(FLAG_IS_OUT, &desc->flags);
		}
1164
	}
1165

1166
#ifdef CONFIG_PINCTRL
1167
	INIT_LIST_HEAD(&gdev->pin_ranges);
1168 1169
#endif

1170 1171 1172 1173
	status = gpiochip_set_desc_names(chip);
	if (status)
		goto err_remove_from_list;

1174 1175 1176 1177
	status = gpiochip_irqchip_init_valid_mask(chip);
	if (status)
		goto err_remove_from_list;

1178 1179 1180 1181
	status = of_gpiochip_add(chip);
	if (status)
		goto err_remove_chip;

1182
	acpi_gpiochip_add(chip);
1183

1184 1185 1186 1187 1188
	/*
	 * By first adding the chardev, and then adding the device,
	 * we get a device node entry in sysfs under
	 * /sys/bus/gpio/devices/gpiochipN/dev that can be used for
	 * coldplug of device nodes and other udev business.
1189 1190
	 * We can do this only if gpiolib has been initialized.
	 * Otherwise, defer until later.
1191
	 */
1192 1193 1194 1195 1196
	if (gpiolib_initialized) {
		status = gpiochip_setup_dev(gdev);
		if (status)
			goto err_remove_chip;
	}
1197
	return 0;
1198

1199 1200
err_remove_chip:
	acpi_gpiochip_remove(chip);
1201
	gpiochip_free_hogs(chip);
1202
	of_gpiochip_remove(chip);
1203
	gpiochip_irqchip_free_valid_mask(chip);
1204
err_remove_from_list:
1205
	spin_lock_irqsave(&gpio_lock, flags);
1206
	list_del(&gdev->list);
1207
	spin_unlock_irqrestore(&gpio_lock, flags);
1208 1209 1210 1211
err_free_label:
	kfree(gdev->label);
err_free_descs:
	kfree(gdev->descs);
1212 1213
err_free_gdev:
	ida_simple_remove(&gpio_ida, gdev->id);
1214
	/* failures here can mean systems won't boot... */
1215
	pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
1216 1217 1218
	       gdev->base, gdev->base + gdev->ngpio - 1,
	       chip->label ? : "generic");
	kfree(gdev);
1219 1220
	return status;
}
1221
EXPORT_SYMBOL_GPL(gpiochip_add_data);
1222

1223 1224 1225 1226 1227 1228 1229 1230 1231
/**
 * gpiochip_get_data() - get per-subdriver data for the chip
 */
void *gpiochip_get_data(struct gpio_chip *chip)
{
	return chip->gpiodev->data;
}
EXPORT_SYMBOL_GPL(gpiochip_get_data);

1232 1233 1234 1235 1236 1237
/**
 * gpiochip_remove() - unregister a gpio_chip
 * @chip: the chip to unregister
 *
 * A gpio_chip with any GPIOs still requested may not be removed.
 */
1238
void gpiochip_remove(struct gpio_chip *chip)
1239
{
1240
	struct gpio_device *gdev = chip->gpiodev;
Johan Hovold's avatar
Johan Hovold committed
1241
	struct gpio_desc *desc;
1242
	unsigned long	flags;
1243
	unsigned	i;
Johan Hovold's avatar
Johan Hovold committed
1244
	bool		requested = false;
1245

1246
	/* FIXME: should the legacy sysfs handling be moved to gpio_device? */
1247
	gpiochip_sysfs_unregister(gdev);
1248 1249
	/* Numb the device, cancelling all outstanding operations */
	gdev->chip = NULL;
1250
	gpiochip_irqchip_remove(chip);
1251
	acpi_gpiochip_remove(chip);
1252
	gpiochip_remove_pin_ranges(chip);
1253
	gpiochip_free_hogs(chip);
1254
	of_gpiochip_remove(chip);
1255 1256 1257 1258 1259
	/*
	 * We accept no more calls into the driver from this point, so
	 * NULL the driver data pointer
	 */
	gdev->data = NULL;
1260

1261
	spin_lock_irqsave(&gpio_lock, flags);
1262
	for (i = 0; i < gdev->ngpio; i++) {
1263
		desc = &gdev->descs[i];
Johan Hovold's avatar
Johan Hovold committed
1264 1265
		if (test_bit(FLAG_REQUESTED, &desc->flags))
			requested = true;
1266