gpiolib.c 78.6 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
#include <linux/idr.h>
20 21 22 23
#include <linux/cdev.h>
#include <linux/fs.h>
#include <linux/uaccess.h>
#include <uapi/linux/gpio.h>
24

25 26
#include "gpiolib.h"

27 28
#define CREATE_TRACE_POINTS
#include <trace/events/gpio.h>
29

30
/* Implementation infrastructure for GPIO interfaces.
31
 *
32 33 34
 * 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.
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49
 */


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

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

58 59 60 61
/* 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.
 */
62
DEFINE_SPINLOCK(gpio_lock);
63

64 65
static DEFINE_MUTEX(gpio_lookup_lock);
static LIST_HEAD(gpio_lookup_list);
66
LIST_HEAD(gpio_devices);
67 68 69 70 71

static void gpiochip_free_hogs(struct gpio_chip *chip);
static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip);


72 73 74 75 76
static inline void desc_set_label(struct gpio_desc *d, const char *label)
{
	d->label = label;
}

77 78 79
/**
 * Convert a GPIO number to its descriptor
 */
80
struct gpio_desc *gpio_to_desc(unsigned gpio)
81
{
82
	struct gpio_device *gdev;
83 84 85 86
	unsigned long flags;

	spin_lock_irqsave(&gpio_lock, flags);

87
	list_for_each_entry(gdev, &gpio_devices, list) {
88 89
		if (gdev->base <= gpio &&
		    gdev->base + gdev->ngpio > gpio) {
90
			spin_unlock_irqrestore(&gpio_lock, flags);
91
			return &gdev->descs[gpio - gdev->base];
92 93 94 95 96
		}
	}

	spin_unlock_irqrestore(&gpio_lock, flags);

97 98 99
	if (!gpio_is_valid(gpio))
		WARN(1, "invalid GPIO %d\n", gpio);

100
	return NULL;
101
}
102
EXPORT_SYMBOL_GPL(gpio_to_desc);
103

104
/**
105
 * Get the GPIO descriptor corresponding to the given hw number for this chip.
106
 */
107 108
struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
				    u16 hwnum)
109
{
110 111 112
	struct gpio_device *gdev = chip->gpiodev;

	if (hwnum >= gdev->ngpio)
113
		return ERR_PTR(-EINVAL);
114

115
	return &gdev->descs[hwnum];
116
}
117 118 119 120 121 122

/**
 * 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
 */
123
int desc_to_gpio(const struct gpio_desc *desc)
124
{
125
	return desc->gdev->base + (desc - &desc->gdev->descs[0]);
126
}
127
EXPORT_SYMBOL_GPL(desc_to_gpio);
128 129


130 131 132 133 134
/**
 * 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)
135
{
136 137 138
	if (!desc || !desc->gdev || !desc->gdev->chip)
		return NULL;
	return desc->gdev->chip;
139
}
140
EXPORT_SYMBOL_GPL(gpiod_to_chip);
141

142 143 144
/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
static int gpiochip_find_base(int ngpio)
{
145
	struct gpio_device *gdev;
146
	int base = ARCH_NR_GPIOS - ngpio;
147

148
	list_for_each_entry_reverse(gdev, &gpio_devices, list) {
149
		/* found a free space? */
150
		if (gdev->base + gdev->ngpio <= base)
151 152 153
			break;
		else
			/* nope, check the space right before the chip */
154
			base = gdev->base - ngpio;
155 156
	}

157
	if (gpio_is_valid(base)) {
158
		pr_debug("%s: found new base at %d\n", __func__, base);
159 160 161 162
		return base;
	} else {
		pr_err("%s: cannot find free range\n", __func__);
		return -ENOSPC;
Anton Vorontsov's avatar
Anton Vorontsov committed
163 164 165
	}
}

166 167 168 169 170 171 172 173
/**
 * 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.
 */
174
int gpiod_get_direction(struct gpio_desc *desc)
175 176
{
	struct gpio_chip	*chip;
177
	unsigned		offset;
178 179
	int			status = -EINVAL;

180 181
	chip = gpiod_to_chip(desc);
	offset = gpio_chip_hwgpio(desc);
182 183 184 185

	if (!chip->get_direction)
		return status;

186
	status = chip->get_direction(chip, offset);
187 188 189
	if (status > 0) {
		/* GPIOF_DIR_IN, or other positive */
		status = 1;
190
		clear_bit(FLAG_IS_OUT, &desc->flags);
191 192 193
	}
	if (status == 0) {
		/* GPIOF_DIR_OUT */
194
		set_bit(FLAG_IS_OUT, &desc->flags);
195 196 197
	}
	return status;
}
198
EXPORT_SYMBOL_GPL(gpiod_get_direction);
199

200 201
/*
 * Add a new chip to the global chips list, keeping the list of chips sorted
202
 * by range(means [base, base + ngpio - 1]) order.
203 204 205 206
 *
 * Return -EBUSY if the new chip overlaps with some other chip's integer
 * space.
 */
207
static int gpiodev_add_to_list(struct gpio_device *gdev)
208
{
209 210 211 212 213
	struct gpio_device *iterator;
	struct gpio_device *previous = NULL;

	if (!gdev->chip)
		return -EINVAL;
214

215 216
	if (list_empty(&gpio_devices)) {
		list_add_tail(&gdev->list, &gpio_devices);
217
		return 0;
218 219
	}

220
	list_for_each_entry(iterator, &gpio_devices, list) {
221
		if (iterator->base >= gdev->base + gdev->ngpio) {
222 223 224 225
			/*
			 * Iterator is the first GPIO chip so there is no
			 * previous one
			 */
226
			if (!previous) {
227 228 229 230 231 232 233
				goto found;
			} else {
				/*
				 * We found a valid range(means
				 * [base, base + ngpio - 1]) between previous
				 * and iterator chip.
				 */
234 235
				if (previous->base + previous->ngpio
				    <= gdev->base)
236 237
					goto found;
			}
238
		}
239
		previous = iterator;
240 241
	}

242 243 244 245 246 247
	/*
	 * We are beyond the last chip in the list and iterator now
	 * points to the head.
	 * Let iterator point to the last chip in the list.
	 */

248
	iterator = list_last_entry(&gpio_devices, struct gpio_device, list);
249
	if (iterator->base + iterator->ngpio <= gdev->base) {
250
		list_add(&gdev->list, &iterator->list);
251
		return 0;
252 253
	}

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

258
found:
259
	list_add_tail(&gdev->list, &iterator->list);
260
	return 0;
261 262
}

263 264 265 266 267
/**
 * Convert a GPIO name to its descriptor
 */
static struct gpio_desc *gpio_name_to_desc(const char * const name)
{
268
	struct gpio_device *gdev;
269 270 271 272
	unsigned long flags;

	spin_lock_irqsave(&gpio_lock, flags);

273
	list_for_each_entry(gdev, &gpio_devices, list) {
274 275
		int i;

276 277
		for (i = 0; i != gdev->ngpio; ++i) {
			struct gpio_desc *desc = &gdev->descs[i];
278

279
			if (!desc->name || !name)
280 281
				continue;

282
			if (!strcmp(desc->name, name)) {
283
				spin_unlock_irqrestore(&gpio_lock, flags);
284
				return desc;
285 286 287 288 289 290 291 292 293
			}
		}
	}

	spin_unlock_irqrestore(&gpio_lock, flags);

	return NULL;
}

294 295 296 297
/*
 * Takes the names from gc->names and checks if they are all unique. If they
 * are, they are assigned to their gpio descriptors.
 *
298
 * Warning if one of the names is already used for a different GPIO.
299 300 301
 */
static int gpiochip_set_desc_names(struct gpio_chip *gc)
{
302
	struct gpio_device *gdev = gc->gpiodev;
303 304 305 306 307 308 309 310 311 312
	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]);
313
		if (gpio)
314
			dev_warn(&gdev->dev,
315
				 "Detected name collision for GPIO name '%s'\n",
316
				 gc->names[i]);
317 318 319 320
	}

	/* Then add all names to the GPIO descriptors */
	for (i = 0; i != gc->ngpio; ++i)
321
		gdev->descs[i].name = gc->names[i];
322 323 324 325

	return 0;
}

326 327 328 329 330 331 332 333 334 335 336 337 338
/**
 * 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;
	int __user *ip = (int __user *)arg;

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

339
	/* Fill in the struct and pass to userspace */
340
	if (cmd == GPIO_GET_CHIPINFO_IOCTL) {
341 342
		struct gpiochip_info chipinfo;

343 344 345
		strncpy(chipinfo.name, dev_name(&gdev->dev),
			sizeof(chipinfo.name));
		chipinfo.name[sizeof(chipinfo.name)-1] = '\0';
346 347 348
		strncpy(chipinfo.label, gdev->label,
			sizeof(chipinfo.label));
		chipinfo.label[sizeof(chipinfo.label)-1] = '\0';
349
		chipinfo.lines = gdev->ngpio;
350 351 352
		if (copy_to_user(ip, &chipinfo, sizeof(chipinfo)))
			return -EFAULT;
		return 0;
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
	} 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;
		if (lineinfo.line_offset > gdev->ngpio)
			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) {
			strncpy(lineinfo.label, desc->label,
				sizeof(lineinfo.label));
			lineinfo.label[sizeof(lineinfo.label)-1] = '\0';
		} else {
			lineinfo.label[0] = '\0';
		}

		/*
		 * Userspace only need to know that the kernel is using
		 * this GPIO so it can't use it.
		 */
		lineinfo.flags = 0;
383 384 385 386 387
		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))
388
			lineinfo.flags |= GPIOLINE_FLAG_KERNEL;
389
		if (test_bit(FLAG_IS_OUT, &desc->flags))
390
			lineinfo.flags |= GPIOLINE_FLAG_IS_OUT;
391
		if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
392
			lineinfo.flags |= GPIOLINE_FLAG_ACTIVE_LOW;
393
		if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
394
			lineinfo.flags |= GPIOLINE_FLAG_OPEN_DRAIN;
395
		if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
396 397 398 399 400
			lineinfo.flags |= GPIOLINE_FLAG_OPEN_SOURCE;

		if (copy_to_user(ip, &lineinfo, sizeof(lineinfo)))
			return -EFAULT;
		return 0;
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
	}
	return -EINVAL;
}

/**
 * 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,
	.compat_ioctl = gpio_ioctl,
};

451 452 453 454
static void gpiodevice_release(struct device *dev)
{
	struct gpio_device *gdev = dev_get_drvdata(dev);

455
	cdev_del(&gdev->chrdev);
456 457
	list_del(&gdev->list);
	ida_simple_remove(&gpio_ida, gdev->id);
458
	kfree(gdev);
459 460
}

461
/**
462
 * gpiochip_add_data() - register a gpio_chip
463
 * @chip: the chip to register, with chip->base initialized
464
 * Context: potentially before irqs will work
465 466 467 468
 *
 * 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.
469
 *
470
 * When gpiochip_add_data() is called very early during boot, so that GPIOs
471
 * can be freely used, the chip->parent device must be registered before
David Brownell's avatar
David Brownell committed
472 473 474
 * the gpio framework's arch_initcall().  Otherwise sysfs initialization
 * for GPIOs will fail rudely.
 *
475 476
 * If chip->base is negative, this requests dynamic assignment of
 * a range of valid GPIOs.
477
 */
478
int gpiochip_add_data(struct gpio_chip *chip, void *data)
479 480 481
{
	unsigned long	flags;
	int		status = 0;
482
	unsigned	i;
483
	int		base = chip->base;
484
	struct gpio_device *gdev;
485

486 487 488 489
	/*
	 * First: allocate and populate the internal stat container, and
	 * set up the struct device.
	 */
490
	gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
491
	if (!gdev)
492
		return -ENOMEM;
493
	gdev->dev.bus = &gpio_bus_type;
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
	gdev->chip = chip;
	chip->gpiodev = gdev;
	if (chip->parent) {
		gdev->dev.parent = chip->parent;
		gdev->dev.of_node = chip->parent->of_node;
	} else {
#ifdef CONFIG_OF_GPIO
	/* If the gpiochip has an assigned OF node this takes precedence */
		if (chip->of_node)
			gdev->dev.of_node = chip->of_node;
#endif
	}
	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;
521

522 523 524
	gdev->descs = devm_kcalloc(&gdev->dev, chip->ngpio,
				   sizeof(gdev->descs[0]), GFP_KERNEL);
	if (!gdev->descs) {
525 526 527 528
		status = -ENOMEM;
		goto err_free_gdev;
	}

529 530
	if (chip->ngpio == 0) {
		chip_err(chip, "tried to insert a GPIO chip with zero lines\n");
531
		status = -EINVAL;
532
		goto err_free_gdev;
533
	}
534 535 536 537 538 539 540 541 542 543

	if (chip->label)
		gdev->label = devm_kstrdup(&gdev->dev, chip->label, GFP_KERNEL);
	else
		gdev->label = devm_kstrdup(&gdev->dev, "unknown", GFP_KERNEL);
	if (!gdev->label) {
		status = -ENOMEM;
		goto err_free_gdev;
	}

544
	gdev->ngpio = chip->ngpio;
545
	gdev->data = data;
546

547 548
	spin_lock_irqsave(&gpio_lock, flags);

549 550 551 552 553 554 555
	/*
	 * 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.
	 */
556 557 558 559
	if (base < 0) {
		base = gpiochip_find_base(chip->ngpio);
		if (base < 0) {
			status = base;
560
			spin_unlock_irqrestore(&gpio_lock, flags);
561
			goto err_free_gdev;
562
		}
563 564 565 566 567 568
		/*
		 * 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.
		 */
569 570
		chip->base = base;
	}
571
	gdev->base = base;
572

573
	status = gpiodev_add_to_list(gdev);
574 575
	if (status) {
		spin_unlock_irqrestore(&gpio_lock, flags);
576
		goto err_free_gdev;
577
	}
578

579
	for (i = 0; i < chip->ngpio; i++) {
580
		struct gpio_desc *desc = &gdev->descs[i];
581

582
		desc->gdev = gdev;
583 584 585 586 587 588 589 590

		/* 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.
		 */
		desc->flags = !chip->direction_input ? (1 << FLAG_IS_OUT) : 0;
591
	}
592

593 594
	spin_unlock_irqrestore(&gpio_lock, flags);

595
#ifdef CONFIG_PINCTRL
596
	INIT_LIST_HEAD(&gdev->pin_ranges);
597 598
#endif

599 600 601 602
	status = gpiochip_set_desc_names(chip);
	if (status)
		goto err_remove_from_list;

603 604 605 606
	status = of_gpiochip_add(chip);
	if (status)
		goto err_remove_chip;

607
	acpi_gpiochip_add(chip);
608

609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
	/*
	 * 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.
	 */
	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(chip, "failed to add char device %d:%d\n",
			  MAJOR(gpio_devt), gdev->id);
	else
		chip_dbg(chip, "added GPIO chardev (%d:%d)\n",
			 MAJOR(gpio_devt), gdev->id);
626
	status = device_add(&gdev->dev);
627
	if (status)
628
		goto err_remove_chardev;
629

630
	status = gpiochip_sysfs_register(gdev);
631 632 633 634 635 636
	if (status)
		goto err_remove_device;

	/* From this point, the .release() function cleans up gpio_device */
	gdev->dev.release = gpiodevice_release;
	get_device(&gdev->dev);
637 638 639
	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), chip->label ? : "generic");
640

641
	return 0;
642

643 644
err_remove_device:
	device_del(&gdev->dev);
645 646
err_remove_chardev:
	cdev_del(&gdev->chrdev);
647 648
err_remove_chip:
	acpi_gpiochip_remove(chip);
649
	gpiochip_free_hogs(chip);
650
	of_gpiochip_remove(chip);
651
err_remove_from_list:
652
	spin_lock_irqsave(&gpio_lock, flags);
653
	list_del(&gdev->list);
654
	spin_unlock_irqrestore(&gpio_lock, flags);
655 656
err_free_gdev:
	ida_simple_remove(&gpio_ida, gdev->id);
657
	/* failures here can mean systems won't boot... */
658
	pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
659 660 661
	       gdev->base, gdev->base + gdev->ngpio - 1,
	       chip->label ? : "generic");
	kfree(gdev);
662 663
	return status;
}
664
EXPORT_SYMBOL_GPL(gpiochip_add_data);
665

666 667 668 669 670 671 672 673 674
/**
 * 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);

675 676 677 678 679 680
/**
 * gpiochip_remove() - unregister a gpio_chip
 * @chip: the chip to unregister
 *
 * A gpio_chip with any GPIOs still requested may not be removed.
 */
681
void gpiochip_remove(struct gpio_chip *chip)
682
{
683
	struct gpio_device *gdev = chip->gpiodev;
Johan Hovold's avatar
Johan Hovold committed
684
	struct gpio_desc *desc;
685
	unsigned long	flags;
686
	unsigned	i;
Johan Hovold's avatar
Johan Hovold committed
687
	bool		requested = false;
688

689
	/* FIXME: should the legacy sysfs handling be moved to gpio_device? */
690
	gpiochip_sysfs_unregister(gdev);
691 692
	/* Numb the device, cancelling all outstanding operations */
	gdev->chip = NULL;
693
	gpiochip_irqchip_remove(chip);
694
	acpi_gpiochip_remove(chip);
695
	gpiochip_remove_pin_ranges(chip);
696
	gpiochip_free_hogs(chip);
697
	of_gpiochip_remove(chip);
698 699 700 701 702
	/*
	 * We accept no more calls into the driver from this point, so
	 * NULL the driver data pointer
	 */
	gdev->data = NULL;
703

704
	spin_lock_irqsave(&gpio_lock, flags);
705
	for (i = 0; i < gdev->ngpio; i++) {
706
		desc = &gdev->descs[i];
Johan Hovold's avatar
Johan Hovold committed
707 708
		if (test_bit(FLAG_REQUESTED, &desc->flags))
			requested = true;
709 710
	}
	spin_unlock_irqrestore(&gpio_lock, flags);
711

Johan Hovold's avatar
Johan Hovold committed
712
	if (requested)
713
		dev_crit(&gdev->dev,
714
			 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
Johan Hovold's avatar
Johan Hovold committed
715

716 717 718 719 720 721 722
	/*
	 * The gpiochip side puts its use of the device to rest here:
	 * if there are no userspace clients, the chardev and device will
	 * be removed, else it will be dangling until the last user is
	 * gone.
	 */
	put_device(&gdev->dev);
723 724 725
}
EXPORT_SYMBOL_GPL(gpiochip_remove);

726 727 728 729 730 731 732 733 734 735 736
/**
 * 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.
 */
737
struct gpio_chip *gpiochip_find(void *data,
738
				int (*match)(struct gpio_chip *chip,
739
					     void *data))
740
{
741
	struct gpio_device *gdev;
742
	struct gpio_chip *chip;
743 744 745
	unsigned long flags;

	spin_lock_irqsave(&gpio_lock, flags);
746 747
	list_for_each_entry(gdev, &gpio_devices, list)
		if (match(gdev->chip, data))
748
			break;
749 750

	/* No match? */
751
	if (&gdev->list == &gpio_devices)
752
		chip = NULL;
753 754 755
	else
		chip = gdev->chip;

756 757 758 759
	spin_unlock_irqrestore(&gpio_lock, flags);

	return chip;
}
Jean Delvare's avatar
Jean Delvare committed
760
EXPORT_SYMBOL_GPL(gpiochip_find);
761

762 763 764 765 766 767 768 769 770 771 772 773
static int gpiochip_match_name(struct gpio_chip *chip, void *data)
{
	const char *name = data;

	return !strcmp(chip->label, name);
}

static struct gpio_chip *find_chip_by_name(const char *name)
{
	return gpiochip_find((void *)name, gpiochip_match_name);
}

774 775 776 777 778 779 780
#ifdef CONFIG_GPIOLIB_IRQCHIP

/*
 * The following is irqchip helper code for gpiochips.
 */

/**
781 782 783
 * gpiochip_set_chained_irqchip() - sets a chained irqchip to a gpiochip
 * @gpiochip: the gpiochip to set the irqchip chain to
 * @irqchip: the irqchip to chain to the gpiochip
784 785 786
 * @parent_irq: the irq number corresponding to the parent IRQ for this
 * chained irqchip
 * @parent_handler: the parent interrupt handler for the accumulated IRQ
787 788
 * coming out of the gpiochip. If the interrupt is nested rather than
 * cascaded, pass NULL in this handler argument
789 790 791 792 793 794
 */
void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
				  struct irq_chip *irqchip,
				  int parent_irq,
				  irq_flow_handler_t parent_handler)
{
795 796 797 798 799
	unsigned int offset;

	if (!gpiochip->irqdomain) {
		chip_err(gpiochip, "called %s before setting up irqchip\n",
			 __func__);
800 801 802
		return;
	}

803 804 805 806 807 808 809 810 811 812 813
	if (parent_handler) {
		if (gpiochip->can_sleep) {
			chip_err(gpiochip,
				 "you cannot have chained interrupts on a "
				 "chip that may sleep\n");
			return;
		}
		/*
		 * The parent irqchip is already using the chip_data for this
		 * irqchip, so our callbacks simply use the handler_data.
		 */
814 815
		irq_set_chained_handler_and_data(parent_irq, parent_handler,
						 gpiochip);
816 817

		gpiochip->irq_parent = parent_irq;
818
	}
819 820 821 822 823

	/* Set the parent IRQ for all affected IRQs */
	for (offset = 0; offset < gpiochip->ngpio; offset++)
		irq_set_parent(irq_find_mapping(gpiochip->irqdomain, offset),
			       parent_irq);
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842
}
EXPORT_SYMBOL_GPL(gpiochip_set_chained_irqchip);

/**
 * gpiochip_irq_map() - maps an IRQ into a GPIO irqchip
 * @d: the irqdomain used by this irqchip
 * @irq: the global irq number used by this GPIO irqchip irq
 * @hwirq: the local IRQ/GPIO line offset on this gpiochip
 *
 * This function will set up the mapping for a certain IRQ line on a
 * gpiochip by assigning the gpiochip as chip data, and using the irqchip
 * stored inside the gpiochip.
 */
static int gpiochip_irq_map(struct irq_domain *d, unsigned int irq,
			    irq_hw_number_t hwirq)
{
	struct gpio_chip *chip = d->host_data;

	irq_set_chip_data(irq, chip);
843 844 845 846 847
	/*
	 * This lock class tells lockdep that GPIO irqs are in a different
	 * category than their parents, so it won't report false recursion.
	 */
	irq_set_lockdep_class(irq, chip->lock_key);
848
	irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler);
849
	/* Chips that can sleep need nested thread handlers */
850
	if (chip->can_sleep && !chip->irq_not_threaded)
851
		irq_set_nested_thread(irq, 1);
852
	irq_set_noprobe(irq);
853

854 855 856 857 858 859
	/*
	 * No set-up of the hardware will happen if IRQ_TYPE_NONE
	 * is passed as default type.
	 */
	if (chip->irq_default_type != IRQ_TYPE_NONE)
		irq_set_irq_type(irq, chip->irq_default_type);
860 861 862 863

	return 0;
}

Linus Walleij's avatar
Linus Walleij committed
864 865
static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
{
866 867 868 869
	struct gpio_chip *chip = d->host_data;

	if (chip->can_sleep)
		irq_set_nested_thread(irq, 0);
Linus Walleij's avatar
Linus Walleij committed
870 871 872 873
	irq_set_chip_and_handler(irq, NULL, NULL);
	irq_set_chip_data(irq, NULL);
}

874 875
static const struct irq_domain_ops gpiochip_domain_ops = {
	.map	= gpiochip_irq_map,
Linus Walleij's avatar
Linus Walleij committed
876
	.unmap	= gpiochip_irq_unmap,
877 878 879 880 881 882 883 884
	/* Virtually all GPIO irqchips are twocell:ed */
	.xlate	= irq_domain_xlate_twocell,
};

static int gpiochip_irq_reqres(struct irq_data *d)
{
	struct gpio_chip *chip = irq_data_get_irq_chip_data(d);

885
	if (!try_module_get(chip->gpiodev->owner))
886 887
		return -ENODEV;

888
	if (gpiochip_lock_as_irq(chip, d->hwirq)) {
889 890 891
		chip_err(chip,
			"unable to lock HW IRQ %lu for IRQ\n",
			d->hwirq);
892
		module_put(chip->gpiodev->owner);
893 894 895 896 897 898 899 900 901
		return -EINVAL;
	}
	return 0;
}

static void gpiochip_irq_relres(struct irq_data *d)
{
	struct gpio_chip *chip = irq_data_get_irq_chip_data(d);

902
	gpiochip_unlock_as_irq(chip, d->hwirq);
903
	module_put(chip->gpiodev->owner);
904 905 906 907 908 909 910 911 912 913 914 915 916 917 918
}

static int gpiochip_to_irq(struct gpio_chip *chip, unsigned offset)
{
	return irq_find_mapping(chip->irqdomain, offset);
}

/**
 * gpiochip_irqchip_remove() - removes an irqchip added to a gpiochip
 * @gpiochip: the gpiochip to remove the irqchip from
 *
 * This is called only from gpiochip_remove()
 */
static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip)
{
Linus Walleij's avatar
Linus Walleij committed
919 920
	unsigned int offset;

921 922
	acpi_gpiochip_free_interrupts(gpiochip);

923 924 925 926 927
	if (gpiochip->irq_parent) {
		irq_set_chained_handler(gpiochip->irq_parent, NULL);
		irq_set_handler_data(gpiochip->irq_parent, NULL);
	}

Linus Walleij's avatar
Linus Walleij committed
928 929 930
	/* Remove all IRQ mappings and delete the domain */
	if (gpiochip->irqdomain) {
		for (offset = 0; offset < gpiochip->ngpio; offset++)
931 932
			irq_dispose_mapping(
				irq_find_mapping(gpiochip->irqdomain, offset));
933
		irq_domain_remove(gpiochip->irqdomain);
Linus Walleij's avatar
Linus Walleij committed
934
	}
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949

	if (gpiochip->irqchip) {
		gpiochip->irqchip->irq_request_resources = NULL;
		gpiochip->irqchip->irq_release_resources = NULL;
		gpiochip->irqchip = NULL;
	}
}

/**
 * gpiochip_irqchip_add() - adds an irqchip to a gpiochip
 * @gpiochip: the gpiochip to add the irqchip to
 * @irqchip: the irqchip to add to the gpiochip
 * @first_irq: if not dynamically assigned, the base (first) IRQ to
 * allocate gpiochip irqs from
 * @handler: the irq handler to use (often a predefined irq core function)
950 951
 * @type: the default type for IRQs on this irqchip, pass IRQ_TYPE_NONE
 * to have the core avoid setting up any default type in the hardware.
952
 * @lock_key: lockdep class
953 954 955 956 957
 *
 * This function closely associates a certain irqchip with a certain
 * gpiochip, providing an irq domain to translate the local IRQs to
 * global irqs in the gpiolib core, and making sure that the gpiochip
 * is passed as chip data to all related functions. Driver callbacks
Linus Walleij's avatar
Linus Walleij committed
958
 * need to use gpiochip_get_data() to get their local state containers back
959 960 961 962 963
 * from the gpiochip passed as chip data. An irqdomain will be stored
 * in the gpiochip that shall be used by the driver to handle IRQ number
 * translation. The gpiochip will need to be initialized and registered
 * before calling this function.
 *
Linus Walleij's avatar
Linus Walleij committed
964 965
 * This function will handle two cell:ed simple IRQs and assumes all
 * the pins on the gpiochip can generate a unique IRQ. Everything else
966 967
 * need to be open coded.
 */
968 969 970 971 972 973
int _gpiochip_irqchip_add(struct gpio_chip *gpiochip,
			  struct irq_chip *irqchip,
			  unsigned int first_irq,
			  irq_flow_handler_t handler,
			  unsigned int type,
			  struct lock_class_key *lock_key)
974 975 976
{
	struct device_node *of_node;
	unsigned int offset;
Linus Walleij's avatar
Linus Walleij committed
977
	unsigned irq_base = 0;
978 979 980 981

	if (!gpiochip || !irqchip)
		return -EINVAL;

982
	if (!gpiochip->parent) {
983 984 985
		pr_err("missing gpiochip .dev parent pointer\n");
		return -EINVAL;
	}
986
	of_node = gpiochip->parent->of_node;
987 988
#ifdef CONFIG_OF_GPIO
	/*
989
	 * If the gpiochip has an assigned OF node this takes precedence
990 991
	 * FIXME: get rid of this and use gpiochip->parent->of_node
	 * everywhere
992 993 994 995 996 997 998 999
	 */
	if (gpiochip->of_node)
		of_node = gpiochip->of_node;
#endif
	gpiochip->irqchip = irqchip;
	gpiochip->irq_handler = handler;
	gpiochip->irq_default_type = type;
	gpiochip->to_irq = gpiochip_to_irq;
1000
	gpiochip->lock_key = lock_key;
1001 1002 1003 1004 1005 1006 1007
	gpiochip->irqdomain = irq_domain_add_simple(of_node,
					gpiochip->ngpio, first_irq,
					&gpiochip_domain_ops, gpiochip);
	if (!gpiochip->irqdomain) {
		gpiochip->irqchip = NULL;
		return -EINVAL;
	}
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017

	/*
	 * It is possible for a driver to override this, but only if the
	 * alternative functions are both implemented.
	 */
	if (!irqchip->irq_request_resources &&
	    !irqchip->irq_release_resources) {
		irqchip->irq_request_resources = gpiochip_irq_reqres;
		irqchip->irq_release_resources = gpiochip_irq_relres;
	}
1018 1019 1020 1021 1022 1023

	/*
	 * Prepare the mapping since the irqchip shall be orthogonal to
	 * any gpiochip calls. If the first_irq was zero, this is
	 * necessary to allocate descriptors for all IRQs.
	 */
Linus Walleij's avatar
Linus Walleij committed
1024 1025 1026 1027 1028 1029 1030 1031 1032
	for (offset = 0; offset < gpiochip->ngpio; offset++) {
		irq_base = irq_create_mapping(gpiochip->irqdomain, offset);
		if (offset == 0)
			/*
			 * Store the base into the gpiochip to be used when
			 * unmapping the irqs.
			 */
			gpiochip->irq_base = irq_base;
	}
1033

1034 1035
	acpi_gpiochip_request_interrupts(gpiochip);

1036 1037
	return 0;
}
1038
EXPORT_SYMBOL_GPL(_gpiochip_irqchip_add);
1039 1040 1041 1042 1043 1044 1045

#else /* CONFIG_GPIOLIB_IRQCHIP */

static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {}

#endif /* CONFIG_GPIOLIB_IRQCHIP */

1046 1047