gpiolib.c 74.9 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 88 89
	list_for_each_entry(gdev, &gpio_devices, list) {
		if (gdev->chip->base <= gpio &&
		    gdev->chip->base + gdev->chip->ngpio > gpio) {
90
			spin_unlock_irqrestore(&gpio_lock, flags);
91
			return &gdev->chip->desc[gpio - gdev->chip->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
	if (hwnum >= chip->ngpio)
111
		return ERR_PTR(-EINVAL);
112

113
	return &chip->desc[hwnum];
114
}
115 116 117 118 119 120

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


128 129 130 131 132
/**
 * 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)
133
{
134
	return desc ? desc->chip : NULL;
135
}
136
EXPORT_SYMBOL_GPL(gpiod_to_chip);
137

138 139 140
/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
static int gpiochip_find_base(int ngpio)
{
141
	struct gpio_device *gdev;
142
	int base = ARCH_NR_GPIOS - ngpio;
143

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

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

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

176 177
	chip = gpiod_to_chip(desc);
	offset = gpio_chip_hwgpio(desc);
178 179 180 181

	if (!chip->get_direction)
		return status;

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

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

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

211 212
	if (list_empty(&gpio_devices)) {
		list_add_tail(&gdev->list, &gpio_devices);
213
		return 0;
214 215
	}

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

245 246 247 248 249 250
	/*
	 * 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.
	 */

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

257
	dev_err(&gdev->dev,
258 259
	       "GPIO integer space overlap, cannot add chip\n");
	return -EBUSY;
260

261
found:
262
	list_add_tail(&gdev->list, &iterator->list);
263
	return 0;
264 265
}

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

	spin_lock_irqsave(&gpio_lock, flags);

276
	list_for_each_entry(gdev, &gpio_devices, list) {
277 278
		int i;

279 280
		for (i = 0; i != gdev->chip->ngpio; ++i) {
			struct gpio_desc *gpio = &gdev->chip->desc[i];
281

282
			if (!gpio->name || !name)
283 284 285 286 287 288 289 290 291 292 293 294 295 296
				continue;

			if (!strcmp(gpio->name, name)) {
				spin_unlock_irqrestore(&gpio_lock, flags);
				return gpio;
			}
		}
	}

	spin_unlock_irqrestore(&gpio_lock, flags);

	return NULL;
}

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

	/* Then add all names to the GPIO descriptors */
	for (i = 0; i != gc->ngpio; ++i)
		gc->desc[i].name = gc->names[i];

	return 0;
}

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
/**
 * 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;
	struct gpiochip_info chipinfo;

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

	if (cmd == GPIO_GET_CHIPINFO_IOCTL) {
		/* Fill in the struct and pass to userspace */
		strncpy(chipinfo.name, dev_name(&gdev->dev),
			sizeof(chipinfo.name));
		chipinfo.name[sizeof(chipinfo.name)-1] = '\0';
		chipinfo.lines = chip->ngpio;
		if (copy_to_user(ip, &chipinfo, sizeof(chipinfo)))
			return -EFAULT;
		return 0;
	}
	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,
};

401 402 403 404
static void gpiodevice_release(struct device *dev)
{
	struct gpio_device *gdev = dev_get_drvdata(dev);

405
	cdev_del(&gdev->chrdev);
406 407 408 409
	list_del(&gdev->list);
	ida_simple_remove(&gpio_ida, gdev->id);
}

410
/**
411
 * gpiochip_add_data() - register a gpio_chip
412
 * @chip: the chip to register, with chip->base initialized
413
 * Context: potentially before irqs will work
414 415 416 417
 *
 * 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.
418
 *
419
 * When gpiochip_add_data() is called very early during boot, so that GPIOs
420
 * can be freely used, the chip->parent device must be registered before
David Brownell's avatar
David Brownell committed
421 422 423
 * the gpio framework's arch_initcall().  Otherwise sysfs initialization
 * for GPIOs will fail rudely.
 *
424 425
 * If chip->base is negative, this requests dynamic assignment of
 * a range of valid GPIOs.
426
 */
427
int gpiochip_add_data(struct gpio_chip *chip, void *data)
428 429 430
{
	unsigned long	flags;
	int		status = 0;
431
	unsigned	i;
432
	int		base = chip->base;
433
	struct gpio_desc *descs;
434
	struct gpio_device *gdev;
435

436 437 438 439 440 441
	/*
	 * First: allocate and populate the internal stat container, and
	 * set up the struct device.
	 */
	gdev = kmalloc(sizeof(*gdev), GFP_KERNEL);
	if (!gdev)
442
		return -ENOMEM;
443
	gdev->dev.bus = &gpio_bus_type;
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
	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;
471

472 473 474 475 476 477 478 479
	/* FIXME: devm_kcalloc() these and move to gpio_device */
	descs = kcalloc(chip->ngpio, sizeof(descs[0]), GFP_KERNEL);
	if (!descs) {
		status = -ENOMEM;
		goto err_free_gdev;
	}

	/* FIXME: move driver data into gpio_device dev_set_drvdata() */
480 481
	chip->data = data;

482 483
	if (chip->ngpio == 0) {
		chip_err(chip, "tried to insert a GPIO chip with zero lines\n");
484 485
		status = -EINVAL;
		goto err_free_descs;
486 487
	}

488 489
	spin_lock_irqsave(&gpio_lock, flags);

490 491 492 493
	if (base < 0) {
		base = gpiochip_find_base(chip->ngpio);
		if (base < 0) {
			status = base;
494 495
			spin_unlock_irqrestore(&gpio_lock, flags);
			goto err_free_descs;
496 497 498 499
		}
		chip->base = base;
	}

500
	status = gpiodev_add_to_list(gdev);
501 502 503 504
	if (status) {
		spin_unlock_irqrestore(&gpio_lock, flags);
		goto err_free_descs;
	}
505

506 507
	for (i = 0; i < chip->ngpio; i++) {
		struct gpio_desc *desc = &descs[i];
508

509
		/* REVISIT: maybe a pointer to gpio_device is better */
510 511 512 513 514 515 516 517 518
		desc->chip = chip;

		/* 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;
519
	}
520 521
	chip->desc = descs;

522 523
	spin_unlock_irqrestore(&gpio_lock, flags);

524
#ifdef CONFIG_PINCTRL
525
	/* FIXME: move pin ranges to gpio_device */
526 527 528
	INIT_LIST_HEAD(&chip->pin_ranges);
#endif

529 530 531 532
	status = gpiochip_set_desc_names(chip);
	if (status)
		goto err_remove_from_list;

533 534 535 536
	status = of_gpiochip_add(chip);
	if (status)
		goto err_remove_chip;

537
	acpi_gpiochip_add(chip);
538

539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
	/*
	 * 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);
556
	status = device_add(&gdev->dev);
557
	if (status)
558
		goto err_remove_chardev;
559

560 561 562 563 564 565 566
	status = gpiochip_sysfs_register(chip);
	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);
567
	pr_debug("%s: registered GPIOs %d to %d on device: %s\n", __func__,
568 569 570
		chip->base, chip->base + chip->ngpio - 1,
		chip->label ? : "generic");

571
	return 0;
572

573 574
err_remove_device:
	device_del(&gdev->dev);
575 576
err_remove_chardev:
	cdev_del(&gdev->chrdev);
577 578
err_remove_chip:
	acpi_gpiochip_remove(chip);
579
	gpiochip_free_hogs(chip);
580
	of_gpiochip_remove(chip);
581
err_remove_from_list:
582
	spin_lock_irqsave(&gpio_lock, flags);
583
	list_del(&gdev->list);
584
	spin_unlock_irqrestore(&gpio_lock, flags);
585
	chip->desc = NULL;
586
err_free_descs:
587
	kfree(descs);
588 589 590
err_free_gdev:
	ida_simple_remove(&gpio_ida, gdev->id);
	kfree(gdev);
591
	/* failures here can mean systems won't boot... */
592
	pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
593 594
		chip->base, chip->base + chip->ngpio - 1,
		chip->label ? : "generic");
595 596
	return status;
}
597
EXPORT_SYMBOL_GPL(gpiochip_add_data);
598 599 600 601 602 603 604

/**
 * gpiochip_remove() - unregister a gpio_chip
 * @chip: the chip to unregister
 *
 * A gpio_chip with any GPIOs still requested may not be removed.
 */
605
void gpiochip_remove(struct gpio_chip *chip)
606
{
607
	struct gpio_device *gdev = chip->gpiodev;
Johan Hovold's avatar
Johan Hovold committed
608
	struct gpio_desc *desc;
609 610
	unsigned long	flags;
	unsigned	id;
Johan Hovold's avatar
Johan Hovold committed
611
	bool		requested = false;
612

613 614
	/* Numb the device, cancelling all outstanding operations */
	gdev->chip = NULL;
615

616 617
	/* FIXME: should the legacy sysfs handling be moved to gpio_device? */
	gpiochip_sysfs_unregister(chip);
618
	gpiochip_irqchip_remove(chip);
619
	acpi_gpiochip_remove(chip);
620
	gpiochip_remove_pin_ranges(chip);
621
	gpiochip_free_hogs(chip);
622 623
	of_gpiochip_remove(chip);

624
	spin_lock_irqsave(&gpio_lock, flags);
625
	for (id = 0; id < chip->ngpio; id++) {
Johan Hovold's avatar
Johan Hovold committed
626 627 628 629
		desc = &chip->desc[id];
		desc->chip = NULL;
		if (test_bit(FLAG_REQUESTED, &desc->flags))
			requested = true;
630 631
	}
	spin_unlock_irqrestore(&gpio_lock, flags);
632

Johan Hovold's avatar
Johan Hovold committed
633
	if (requested)
634
		dev_crit(&chip->gpiodev->dev,
635
			 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
Johan Hovold's avatar
Johan Hovold committed
636

637
	/* FIXME: need to be moved to gpio_device and held there */
638 639
	kfree(chip->desc);
	chip->desc = NULL;
640 641 642 643 644 645 646 647

	/*
	 * 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);
648 649 650
}
EXPORT_SYMBOL_GPL(gpiochip_remove);

651 652 653 654 655 656 657 658 659 660 661
/**
 * 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.
 */
662
struct gpio_chip *gpiochip_find(void *data,
663
				int (*match)(struct gpio_chip *chip,
664
					     void *data))
665
{
666
	struct gpio_device *gdev;
667
	struct gpio_chip *chip;
668 669 670
	unsigned long flags;

	spin_lock_irqsave(&gpio_lock, flags);
671 672
	list_for_each_entry(gdev, &gpio_devices, list)
		if (match(gdev->chip, data))
673
			break;
674 675

	/* No match? */
676
	if (&gdev->list == &gpio_devices)
677
		chip = NULL;
678 679 680
	else
		chip = gdev->chip;

681 682 683 684
	spin_unlock_irqrestore(&gpio_lock, flags);

	return chip;
}
Jean Delvare's avatar
Jean Delvare committed
685
EXPORT_SYMBOL_GPL(gpiochip_find);
686

687 688 689 690 691 692 693 694 695 696 697 698
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);
}

699 700 701 702 703 704 705
#ifdef CONFIG_GPIOLIB_IRQCHIP

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

/**
706 707 708
 * 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
709 710 711
 * @parent_irq: the irq number corresponding to the parent IRQ for this
 * chained irqchip
 * @parent_handler: the parent interrupt handler for the accumulated IRQ
712 713
 * coming out of the gpiochip. If the interrupt is nested rather than
 * cascaded, pass NULL in this handler argument
714 715 716 717 718 719
 */
void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
				  struct irq_chip *irqchip,
				  int parent_irq,
				  irq_flow_handler_t parent_handler)
{
720 721 722 723 724
	unsigned int offset;

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

728 729 730 731 732 733 734 735 736 737 738
	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.
		 */
739 740
		irq_set_chained_handler_and_data(parent_irq, parent_handler,
						 gpiochip);
741 742

		gpiochip->irq_parent = parent_irq;
743
	}
744 745 746 747 748

	/* 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);
749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767
}
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);
768 769 770 771 772
	/*
	 * 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);
773
	irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler);
774
	/* Chips that can sleep need nested thread handlers */
775
	if (chip->can_sleep && !chip->irq_not_threaded)
776
		irq_set_nested_thread(irq, 1);
777
	irq_set_noprobe(irq);
778

779 780 781 782 783 784
	/*
	 * 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);
785 786 787 788

	return 0;
}

Linus Walleij's avatar
Linus Walleij committed
789 790
static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
{
791 792 793 794
	struct gpio_chip *chip = d->host_data;

	if (chip->can_sleep)
		irq_set_nested_thread(irq, 0);
Linus Walleij's avatar
Linus Walleij committed
795 796 797 798
	irq_set_chip_and_handler(irq, NULL, NULL);
	irq_set_chip_data(irq, NULL);
}

799 800
static const struct irq_domain_ops gpiochip_domain_ops = {
	.map	= gpiochip_irq_map,
Linus Walleij's avatar
Linus Walleij committed
801
	.unmap	= gpiochip_irq_unmap,
802 803 804 805 806 807 808 809
	/* 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);

810
	if (!try_module_get(chip->gpiodev->owner))
811 812
		return -ENODEV;

813
	if (gpiochip_lock_as_irq(chip, d->hwirq)) {
814 815 816
		chip_err(chip,
			"unable to lock HW IRQ %lu for IRQ\n",
			d->hwirq);
817
		module_put(chip->gpiodev->owner);
818 819 820 821 822 823 824 825 826
		return -EINVAL;
	}
	return 0;
}

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

827
	gpiochip_unlock_as_irq(chip, d->hwirq);
828
	module_put(chip->gpiodev->owner);
829 830 831 832 833 834 835 836 837 838 839 840 841 842 843
}

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
844 845
	unsigned int offset;

846 847
	acpi_gpiochip_free_interrupts(gpiochip);

848 849 850 851 852
	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
853 854 855
	/* Remove all IRQ mappings and delete the domain */
	if (gpiochip->irqdomain) {
		for (offset = 0; offset < gpiochip->ngpio; offset++)
856 857
			irq_dispose_mapping(
				irq_find_mapping(gpiochip->irqdomain, offset));
858
		irq_domain_remove(gpiochip->irqdomain);
Linus Walleij's avatar
Linus Walleij committed
859
	}
860 861 862 863 864 865 866 867 868 869 870 871 872 873 874

	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)
875 876
 * @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.
877
 * @lock_key: lockdep class
878 879 880 881 882
 *
 * 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
883
 * need to use gpiochip_get_data() to get their local state containers back
884 885 886 887 888
 * 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
889 890
 * This function will handle two cell:ed simple IRQs and assumes all
 * the pins on the gpiochip can generate a unique IRQ. Everything else
891 892
 * need to be open coded.
 */
893 894 895 896 897 898
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)
899 900 901
{
	struct device_node *of_node;
	unsigned int offset;
Linus Walleij's avatar
Linus Walleij committed
902
	unsigned irq_base = 0;
903 904 905 906

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

907
	if (!gpiochip->parent) {
908 909 910
		pr_err("missing gpiochip .dev parent pointer\n");
		return -EINVAL;
	}
911
	of_node = gpiochip->parent->of_node;
912 913
#ifdef CONFIG_OF_GPIO
	/*
914
	 * If the gpiochip has an assigned OF node this takes precedence
915 916
	 * FIXME: get rid of this and use gpiochip->parent->of_node
	 * everywhere
917 918 919 920 921 922 923 924
	 */
	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;
925
	gpiochip->lock_key = lock_key;
926 927 928 929 930 931 932
	gpiochip->irqdomain = irq_domain_add_simple(of_node,
					gpiochip->ngpio, first_irq,
					&gpiochip_domain_ops, gpiochip);
	if (!gpiochip->irqdomain) {
		gpiochip->irqchip = NULL;
		return -EINVAL;
	}
933 934 935 936 937 938 939 940 941 942

	/*
	 * 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;
	}
943 944 945 946 947 948

	/*
	 * 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
949 950 951 952 953 954 955 956 957
	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;
	}
958

959 960
	acpi_gpiochip_request_interrupts(gpiochip);

961 962
	return 0;
}
963
EXPORT_SYMBOL_GPL(_gpiochip_irqchip_add);
964 965 966 967 968 969 970

#else /* CONFIG_GPIOLIB_IRQCHIP */

static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {}

#endif /* CONFIG_GPIOLIB_IRQCHIP */

971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992
/**
 * gpiochip_generic_request() - request the gpio function for a pin
 * @chip: the gpiochip owning the GPIO
 * @offset: the offset of the GPIO to request for GPIO function
 */
int gpiochip_generic_request(struct gpio_chip *chip, unsigned offset)
{
	return pinctrl_request_gpio(chip->base + offset);
}
EXPORT_SYMBOL_GPL(gpiochip_generic_request);

/**
 * gpiochip_generic_free() - free the gpio function from a pin
 * @chip: the gpiochip to request the gpio function for
 * @offset: the offset of the GPIO to free from GPIO function
 */
void gpiochip_generic_free(struct gpio_chip *chip, unsigned offset)
{
	pinctrl_free_gpio(chip->base + offset);
}
EXPORT_SYMBOL_GPL(gpiochip_generic_free);

993
#ifdef CONFIG_PINCTRL
994

995 996 997
/**
 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
 * @chip: the gpiochip to add the range for
998
 * @pctldev: the pin controller to map to
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
 * @gpio_offset: the start offset in the current gpio_chip number space
 * @pin_group: name of the pin group inside the pin controller
 */
int gpiochip_add_pingroup_range(struct gpio_chip *chip,
			struct pinctrl_dev *pctldev,
			unsigned int gpio_offset, const char *pin_group)
{
	struct gpio_pin_range *pin_range;
	int ret;

	pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
	if (!pin_range) {
1011
		chip_err(chip, "failed to allocate pin ranges\n");
1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024
		return -ENOMEM;
	}

	/* Use local offset as range ID */
	pin_range->range.id = gpio_offset;
	pin_range->range.gc = chip;
	pin_range->range.name = chip->label;
	pin_range->range.base = chip->base + gpio_offset;
	pin_range->pctldev = pctldev;

	ret = pinctrl_get_group_pins(pctldev, pin_group,
					&pin_range->range.pins,
					&pin_range->range.npins);
1025 1026
	if (ret < 0) {
		kfree(pin_range);
1027
		return ret;
1028
	}
1029 1030 1031

	pinctrl_add_gpio_range(pctldev, &pin_range->range);

1032 1033
	chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
		 gpio_offset, gpio_offset + pin_range->range.npins - 1,
1034 1035 1036 1037 1038 1039 1040 1041
		 pinctrl_dev_get_devname(pctldev), pin_group);

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

	return 0;
}
EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);

1042 1043 1044 1045
/**
 * gpiochip_add_pin_range() - add a range for GPIO <-> pin mapping
 * @chip: the gpiochip to add the range for
 * @pinctrl_name: the dev_name() of the pin controller to map to
1046 1047
 * @gpio_offset: the start offset in the current gpio_chip number space
 * @pin_offset: the start offset in the pin controller number space
1048 1049 1050
 * @npins: the number of pins from the offset of each pin space (GPIO and
 *	pin controller) to accumulate in this range
 */
1051
int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
1052
			   unsigned int gpio_offset, unsigned int pin_offset,
1053
			   unsigned int npins)
1054 1055
{
	struct gpio_pin_range *pin_range;
1056
	int ret;
1057

1058
	pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1059
	if (!pin_range) {
1060
		chip_err(chip, "failed to allocate pin ranges\n");
1061
		return -ENOMEM;
1062 1063
	}

1064
	/* Use local offset as range ID */
1065
	pin_range->range.id = gpio_offset;
1066
	pin_range->range.gc = chip;
1067
	pin_range->range.name = chip->label;
1068 1069
	pin_range->range.base = chip->base + gpio_offset;
	pin_range->range.pin_base = pin_offset;
1070
	pin_range->range.npins = npins;
Linus Walleij's avatar
Linus Walleij committed
1071
	pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
1072
			&pin_range->range);
1073
	if (IS_ERR(pin_range->pctldev)) {
1074
		ret = PTR_ERR(pin_range->pctldev);
1075
		chip_err(chip, "could not create pin range\n");
1076
		kfree(pin_range);
1077
		return ret;
1078
	}
1079 1080
	chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
		 gpio_offset, gpio_offset + npins - 1,