gpiolib.c 80.7 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>
D
David Brownell 已提交
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;
A
Anton Vorontsov 已提交
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
	struct gpio_device *prev, *next;
210

211
	if (list_empty(&gpio_devices)) {
212
		/* initial entry in list */
213
		list_add_tail(&gdev->list, &gpio_devices);
S
Sudip Mukherjee 已提交
214
		return 0;
215 216
	}

217 218 219 220 221
	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;
222 223
	}

224 225 226 227
	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);
228
		return 0;
229 230
	}

231 232 233 234
	list_for_each_entry_safe(prev, next, &gpio_devices, list) {
		/* at the end of the list */
		if (&next->list == &gpio_devices)
			break;
235

236 237 238 239 240 241 242 243 244 245
		/* 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;
246 247
}

248 249 250 251 252
/**
 * Convert a GPIO name to its descriptor
 */
static struct gpio_desc *gpio_name_to_desc(const char * const name)
{
253
	struct gpio_device *gdev;
254 255 256 257
	unsigned long flags;

	spin_lock_irqsave(&gpio_lock, flags);

258
	list_for_each_entry(gdev, &gpio_devices, list) {
259 260
		int i;

261 262
		for (i = 0; i != gdev->ngpio; ++i) {
			struct gpio_desc *desc = &gdev->descs[i];
263

264
			if (!desc->name || !name)
265 266
				continue;

267
			if (!strcmp(desc->name, name)) {
268
				spin_unlock_irqrestore(&gpio_lock, flags);
269
				return desc;
270 271 272 273 274 275 276 277 278
			}
		}
	}

	spin_unlock_irqrestore(&gpio_lock, flags);

	return NULL;
}

279 280 281 282
/*
 * Takes the names from gc->names and checks if they are all unique. If they
 * are, they are assigned to their gpio descriptors.
 *
283
 * Warning if one of the names is already used for a different GPIO.
284 285 286
 */
static int gpiochip_set_desc_names(struct gpio_chip *gc)
{
287
	struct gpio_device *gdev = gc->gpiodev;
288 289 290 291 292 293 294 295 296 297
	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]);
298
		if (gpio)
299
			dev_warn(&gdev->dev,
300
				 "Detected name collision for GPIO name '%s'\n",
301
				 gc->names[i]);
302 303 304 305
	}

	/* Then add all names to the GPIO descriptors */
	for (i = 0; i != gc->ngpio; ++i)
306
		gdev->descs[i].name = gc->names[i];
307 308 309 310

	return 0;
}

311 312 313 314 315 316 317 318 319 320 321 322 323
/**
 * 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;

324
	/* Fill in the struct and pass to userspace */
325
	if (cmd == GPIO_GET_CHIPINFO_IOCTL) {
326 327
		struct gpiochip_info chipinfo;

328 329 330
		strncpy(chipinfo.name, dev_name(&gdev->dev),
			sizeof(chipinfo.name));
		chipinfo.name[sizeof(chipinfo.name)-1] = '\0';
331 332 333
		strncpy(chipinfo.label, gdev->label,
			sizeof(chipinfo.label));
		chipinfo.label[sizeof(chipinfo.label)-1] = '\0';
334
		chipinfo.lines = gdev->ngpio;
335 336 337
		if (copy_to_user(ip, &chipinfo, sizeof(chipinfo)))
			return -EFAULT;
		return 0;
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
	} 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) {
356 357 358
			strncpy(lineinfo.consumer, desc->label,
				sizeof(lineinfo.consumer));
			lineinfo.consumer[sizeof(lineinfo.consumer)-1] = '\0';
359
		} else {
360
			lineinfo.consumer[0] = '\0';
361 362 363 364 365 366 367
		}

		/*
		 * Userspace only need to know that the kernel is using
		 * this GPIO so it can't use it.
		 */
		lineinfo.flags = 0;
368 369 370 371 372
		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))
373
			lineinfo.flags |= GPIOLINE_FLAG_KERNEL;
374
		if (test_bit(FLAG_IS_OUT, &desc->flags))
375
			lineinfo.flags |= GPIOLINE_FLAG_IS_OUT;
376
		if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
377
			lineinfo.flags |= GPIOLINE_FLAG_ACTIVE_LOW;
378
		if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
379
			lineinfo.flags |= GPIOLINE_FLAG_OPEN_DRAIN;
380
		if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
381 382 383 384 385
			lineinfo.flags |= GPIOLINE_FLAG_OPEN_SOURCE;

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

436 437 438 439
static void gpiodevice_release(struct device *dev)
{
	struct gpio_device *gdev = dev_get_drvdata(dev);

440
	cdev_del(&gdev->chrdev);
441 442
	list_del(&gdev->list);
	ida_simple_remove(&gpio_ida, gdev->id);
443
	kfree(gdev);
444 445
}

446
/**
447
 * gpiochip_add_data() - register a gpio_chip
448
 * @chip: the chip to register, with chip->base initialized
449
 * Context: potentially before irqs will work
450 451 452 453
 *
 * 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.
454
 *
455
 * When gpiochip_add_data() is called very early during boot, so that GPIOs
456
 * can be freely used, the chip->parent device must be registered before
D
David Brownell 已提交
457 458 459
 * the gpio framework's arch_initcall().  Otherwise sysfs initialization
 * for GPIOs will fail rudely.
 *
460 461
 * If chip->base is negative, this requests dynamic assignment of
 * a range of valid GPIOs.
462
 */
463
int gpiochip_add_data(struct gpio_chip *chip, void *data)
464 465 466
{
	unsigned long	flags;
	int		status = 0;
467
	unsigned	i;
468
	int		base = chip->base;
469
	struct gpio_device *gdev;
470

471 472 473 474
	/*
	 * First: allocate and populate the internal stat container, and
	 * set up the struct device.
	 */
475
	gdev = kzalloc(sizeof(*gdev), GFP_KERNEL);
476
	if (!gdev)
477
		return -ENOMEM;
478
	gdev->dev.bus = &gpio_bus_type;
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505
	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;
506

507 508 509
	gdev->descs = devm_kcalloc(&gdev->dev, chip->ngpio,
				   sizeof(gdev->descs[0]), GFP_KERNEL);
	if (!gdev->descs) {
510 511 512 513
		status = -ENOMEM;
		goto err_free_gdev;
	}

514 515
	if (chip->ngpio == 0) {
		chip_err(chip, "tried to insert a GPIO chip with zero lines\n");
516
		status = -EINVAL;
517
		goto err_free_gdev;
518
	}
519 520 521 522 523 524 525 526 527 528

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

529
	gdev->ngpio = chip->ngpio;
530
	gdev->data = data;
531

532 533
	spin_lock_irqsave(&gpio_lock, flags);

534 535 536 537 538 539 540
	/*
	 * 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.
	 */
541 542 543 544
	if (base < 0) {
		base = gpiochip_find_base(chip->ngpio);
		if (base < 0) {
			status = base;
545
			spin_unlock_irqrestore(&gpio_lock, flags);
546
			goto err_free_gdev;
547
		}
548 549 550 551 552 553
		/*
		 * 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.
		 */
554 555
		chip->base = base;
	}
556
	gdev->base = base;
557

558
	status = gpiodev_add_to_list(gdev);
559 560
	if (status) {
		spin_unlock_irqrestore(&gpio_lock, flags);
561
		goto err_free_gdev;
562
	}
563

564
	for (i = 0; i < chip->ngpio; i++) {
565
		struct gpio_desc *desc = &gdev->descs[i];
566

567
		desc->gdev = gdev;
568 569 570 571 572 573 574 575

		/* 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;
576
	}
577

578 579
	spin_unlock_irqrestore(&gpio_lock, flags);

580
#ifdef CONFIG_PINCTRL
581
	INIT_LIST_HEAD(&gdev->pin_ranges);
582 583
#endif

584 585 586 587
	status = gpiochip_set_desc_names(chip);
	if (status)
		goto err_remove_from_list;

588 589 590 591
	status = of_gpiochip_add(chip);
	if (status)
		goto err_remove_chip;

592
	acpi_gpiochip_add(chip);
593

594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610
	/*
	 * 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);
611
	status = device_add(&gdev->dev);
612
	if (status)
613
		goto err_remove_chardev;
614

615
	status = gpiochip_sysfs_register(gdev);
616 617 618 619 620 621
	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);
622 623 624
	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");
625

626
	return 0;
627

628 629
err_remove_device:
	device_del(&gdev->dev);
630 631
err_remove_chardev:
	cdev_del(&gdev->chrdev);
632 633
err_remove_chip:
	acpi_gpiochip_remove(chip);
634
	gpiochip_free_hogs(chip);
635
	of_gpiochip_remove(chip);
636
err_remove_from_list:
637
	spin_lock_irqsave(&gpio_lock, flags);
638
	list_del(&gdev->list);
639
	spin_unlock_irqrestore(&gpio_lock, flags);
640 641
err_free_gdev:
	ida_simple_remove(&gpio_ida, gdev->id);
642
	/* failures here can mean systems won't boot... */
643
	pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
644 645 646
	       gdev->base, gdev->base + gdev->ngpio - 1,
	       chip->label ? : "generic");
	kfree(gdev);
647 648
	return status;
}
649
EXPORT_SYMBOL_GPL(gpiochip_add_data);
650

651 652 653 654 655 656 657 658 659
/**
 * 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);

660 661 662 663 664 665
/**
 * gpiochip_remove() - unregister a gpio_chip
 * @chip: the chip to unregister
 *
 * A gpio_chip with any GPIOs still requested may not be removed.
 */
666
void gpiochip_remove(struct gpio_chip *chip)
667
{
668
	struct gpio_device *gdev = chip->gpiodev;
J
Johan Hovold 已提交
669
	struct gpio_desc *desc;
670
	unsigned long	flags;
671
	unsigned	i;
J
Johan Hovold 已提交
672
	bool		requested = false;
673

674
	/* FIXME: should the legacy sysfs handling be moved to gpio_device? */
675
	gpiochip_sysfs_unregister(gdev);
676 677
	/* Numb the device, cancelling all outstanding operations */
	gdev->chip = NULL;
678
	gpiochip_irqchip_remove(chip);
679
	acpi_gpiochip_remove(chip);
680
	gpiochip_remove_pin_ranges(chip);
B
Benoit Parrot 已提交
681
	gpiochip_free_hogs(chip);
682
	of_gpiochip_remove(chip);
683 684 685 686 687
	/*
	 * We accept no more calls into the driver from this point, so
	 * NULL the driver data pointer
	 */
	gdev->data = NULL;
688

689
	spin_lock_irqsave(&gpio_lock, flags);
690
	for (i = 0; i < gdev->ngpio; i++) {
691
		desc = &gdev->descs[i];
J
Johan Hovold 已提交
692 693
		if (test_bit(FLAG_REQUESTED, &desc->flags))
			requested = true;
694 695
	}
	spin_unlock_irqrestore(&gpio_lock, flags);
696

J
Johan Hovold 已提交
697
	if (requested)
698
		dev_crit(&gdev->dev,
699
			 "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
J
Johan Hovold 已提交
700

701 702 703 704 705 706 707
	/*
	 * 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);
708 709 710
}
EXPORT_SYMBOL_GPL(gpiochip_remove);

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
static void devm_gpio_chip_release(struct device *dev, void *res)
{
	struct gpio_chip *chip = *(struct gpio_chip **)res;

	gpiochip_remove(chip);
}

static int devm_gpio_chip_match(struct device *dev, void *res, void *data)

{
	struct gpio_chip **r = res;

	if (!r || !*r) {
		WARN_ON(!r || !*r);
		return 0;
	}

	return *r == data;
}

/**
 * devm_gpiochip_add_data() - Resource manager piochip_add_data()
 * @dev: the device pointer on which irq_chip belongs to.
 * @chip: the chip to register, with chip->base initialized
 * Context: potentially before irqs will work
 *
 * Returns a negative errno if the chip can't be registered, such as
 * because the chip->base is invalid or already associated with a
 * different chip.  Otherwise it returns zero as a success code.
 *
 * The gpio chip automatically be released when the device is unbound.
 */
int devm_gpiochip_add_data(struct device *dev, struct gpio_chip *chip,
			   void *data)
{
	struct gpio_chip **ptr;
	int ret;

	ptr = devres_alloc(devm_gpio_chip_release, sizeof(*ptr),
			     GFP_KERNEL);
	if (!ptr)
		return -ENOMEM;

	ret = gpiochip_add_data(chip, data);
	if (ret < 0) {
		devres_free(ptr);
		return ret;
	}

	*ptr = chip;
	devres_add(dev, ptr);

	return 0;
}
EXPORT_SYMBOL_GPL(devm_gpiochip_add_data);

/**
 * devm_gpiochip_remove() - Resource manager of gpiochip_remove()
 * @dev: device for which which resource was allocated
 * @chip: the chip to remove
 *
 * A gpio_chip with any GPIOs still requested may not be removed.
 */
void devm_gpiochip_remove(struct device *dev, struct gpio_chip *chip)
{
	int ret;

	ret = devres_release(dev, devm_gpio_chip_release,
			     devm_gpio_chip_match, chip);
	if (!ret)
		WARN_ON(ret);
}
EXPORT_SYMBOL_GPL(devm_gpiochip_remove);

785 786 787 788 789 790 791 792 793 794 795
/**
 * 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.
 */
796
struct gpio_chip *gpiochip_find(void *data,
797
				int (*match)(struct gpio_chip *chip,
798
					     void *data))
799
{
800
	struct gpio_device *gdev;
801
	struct gpio_chip *chip;
802 803 804
	unsigned long flags;

	spin_lock_irqsave(&gpio_lock, flags);
805 806
	list_for_each_entry(gdev, &gpio_devices, list)
		if (match(gdev->chip, data))
807
			break;
808 809

	/* No match? */
810
	if (&gdev->list == &gpio_devices)
811
		chip = NULL;
812 813 814
	else
		chip = gdev->chip;

815 816 817 818
	spin_unlock_irqrestore(&gpio_lock, flags);

	return chip;
}
J
Jean Delvare 已提交
819
EXPORT_SYMBOL_GPL(gpiochip_find);
820

821 822 823 824 825 826 827 828 829 830 831 832
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);
}

833 834 835 836 837 838 839
#ifdef CONFIG_GPIOLIB_IRQCHIP

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

/**
840 841 842
 * 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
843 844 845
 * @parent_irq: the irq number corresponding to the parent IRQ for this
 * chained irqchip
 * @parent_handler: the parent interrupt handler for the accumulated IRQ
846 847
 * coming out of the gpiochip. If the interrupt is nested rather than
 * cascaded, pass NULL in this handler argument
848 849 850 851 852 853
 */
void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
				  struct irq_chip *irqchip,
				  int parent_irq,
				  irq_flow_handler_t parent_handler)
{
854 855 856 857 858
	unsigned int offset;

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

862 863 864 865 866 867 868 869 870 871 872
	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.
		 */
873 874
		irq_set_chained_handler_and_data(parent_irq, parent_handler,
						 gpiochip);
875 876

		gpiochip->irq_parent = parent_irq;
877
	}
878 879 880 881 882

	/* 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);
883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
}
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);
902 903 904 905 906
	/*
	 * 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);
907
	irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler);
908
	/* Chips that can sleep need nested thread handlers */
909
	if (chip->can_sleep && !chip->irq_not_threaded)
910
		irq_set_nested_thread(irq, 1);
911
	irq_set_noprobe(irq);
R
Rob Herring 已提交
912

913 914 915 916 917 918
	/*
	 * 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);
919 920 921 922

	return 0;
}

L
Linus Walleij 已提交
923 924
static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
{
925 926 927 928
	struct gpio_chip *chip = d->host_data;

	if (chip->can_sleep)
		irq_set_nested_thread(irq, 0);
L
Linus Walleij 已提交
929 930 931 932
	irq_set_chip_and_handler(irq, NULL, NULL);
	irq_set_chip_data(irq, NULL);
}

933 934
static const struct irq_domain_ops gpiochip_domain_ops = {
	.map	= gpiochip_irq_map,
L
Linus Walleij 已提交
935
	.unmap	= gpiochip_irq_unmap,
936 937 938 939 940 941 942 943
	/* 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);

944
	if (!try_module_get(chip->gpiodev->owner))
945 946
		return -ENODEV;

947
	if (gpiochip_lock_as_irq(chip, d->hwirq)) {
948 949 950
		chip_err(chip,
			"unable to lock HW IRQ %lu for IRQ\n",
			d->hwirq);
951
		module_put(chip->gpiodev->owner);
952 953 954 955 956 957 958 959 960
		return -EINVAL;
	}
	return 0;
}

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

961
	gpiochip_unlock_as_irq(chip, d->hwirq);
962
	module_put(chip->gpiodev->owner);
963 964 965 966 967 968 969 970 971 972 973 974 975 976 977
}

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)
{
L
Linus Walleij 已提交
978 979
	unsigned int offset;

980 981
	acpi_gpiochip_free_interrupts(gpiochip);

982 983 984 985 986
	if (gpiochip->irq_parent) {
		irq_set_chained_handler(gpiochip->irq_parent, NULL);
		irq_set_handler_data(gpiochip->irq_parent, NULL);
	}

L
Linus Walleij 已提交
987 988 989
	/* Remove all IRQ mappings and delete the domain */
	if (gpiochip->irqdomain) {
		for (offset = 0; offset < gpiochip->ngpio; offset++)
990 991
			irq_dispose_mapping(
				irq_find_mapping(gpiochip->irqdomain, offset));
992
		irq_domain_remove(gpiochip->irqdomain);
L
Linus Walleij 已提交
993
	}
994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008

	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)
1009 1010
 * @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.
1011
 * @lock_key: lockdep class
1012 1013 1014 1015 1016
 *
 * 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
L
Linus Walleij 已提交
1017
 * need to use gpiochip_get_data() to get their local state containers back
1018 1019 1020 1021 1022
 * 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.
 *
L
Linus Walleij 已提交
1023 1024
 * This function will handle two cell:ed simple IRQs and assumes all
 * the pins on the gpiochip can generate a unique IRQ. Everything else
1025 1026
 * need to be open coded.
 */
1027 1028 1029 1030 1031 1032
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)
1033 1034 1035
{
	struct device_node *of_node;
	unsigned int offset;
L
Linus Walleij 已提交
1036
	unsigned irq_base = 0;
1037 1038 1039 1040

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

1041
	if (!gpiochip->parent) {
1042 1043 1044
		pr_err("missing gpiochip .dev parent pointer\n");
		return -EINVAL;
	}
1045
	of_node = gpiochip->parent->of_node;
1046 1047
#ifdef CONFIG_OF_GPIO
	/*
1048
	 * If the gpiochip has an assigned OF node this takes precedence
1049 1050
	 * FIXME: get rid of this and use gpiochip->parent->of_node
	 * everywhere
1051 1052 1053 1054 1055 1056 1057 1058
	 */
	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;
1059
	gpiochip->lock_key = lock_key;
1060 1061 1062 1063 1064 1065 1066
	gpiochip->irqdomain = irq_domain_add_simple(of_node,
					gpiochip->ngpio, first_irq,
					&gpiochip_domain_ops, gpiochip);
	if (!gpiochip->irqdomain) {
		gpiochip->irqchip = NULL;
		return -EINVAL;
	}
1067 1068 1069 1070 1071 1072 1073 1074 1075 1076

	/*
	 * 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;
	}
1077 1078 1079 1080 1081 1082

	/*
	 * 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.
	 */
L
Linus Walleij 已提交
1083 1084 1085 1086 1087 1088 1089 1090 1091
	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;
	}
1092

1093 1094
	acpi_gpiochip_request_interrupts(gpiochip);

1095 1096
	return 0;
}
1097
EXPORT_SYMBOL_GPL(_gpiochip_irqchip_add);
1098 1099 1100 1101 1102 1103 1104

#else /* CONFIG_GPIOLIB_IRQCHIP */

static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {}

#endif /* CONFIG_GPIOLIB_IRQCHIP */

1105 1106 1107 1108 1109 1110 1111
/**
 * 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)
{
1112
	return pinctrl_request_gpio(chip->gpiodev->base + offset);
1113 1114 1115 1116 1117 1118 1119 1120 1121 1122
}
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)
{
1123
	pinctrl_free_gpio(chip->gpiodev->base + offset);
1124 1125 1126
}
EXPORT_SYMBOL_GPL(gpiochip_generic_free);

1127
#ifdef CONFIG_PINCTRL
1128

1129 1130 1131
/**
 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
 * @chip: the gpiochip to add the range for
1132
 * @pctldev: the pin controller to map to
1133 1134 1135 1136 1137 1138 1139 1140
 * @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;
1141
	struct gpio_device *gdev = chip->gpiodev;
1142 1143 1144 1145
	int ret;

	pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
	if (!pin_range) {
1146
		chip_err(chip, "failed to allocate pin ranges\n");
1147 1148 1149 1150 1151 1152 1153
		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;
1154
	pin_range->range.base = gdev->base + gpio_offset;
1155 1156 1157 1158 1159
	pin_range->pctldev = pctldev;

	ret = pinctrl_get_group_pins(pctldev, pin_group,
					&pin_range->range.pins,
					&pin_range->range.npins);
1160 1161
	if (ret < 0) {
		kfree(pin_range);
1162
		return ret;
1163
	}
1164 1165 1166

	pinctrl_add_gpio_range(pctldev, &pin_range->range);

1167 1168
	chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
		 gpio_offset, gpio_offset + pin_range->range.npins - 1,
1169 1170
		 pinctrl_dev_get_devname(pctldev), pin_group);

1171
	list_add_tail(&pin_range->node, &gdev->pin_ranges);
1172 1173 1174 1175 1176

	return 0;
}
EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);

1177 1178 1179 1180
/**
 * 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
1181 1182
 * @gpio_offset: the start offset in the current gpio_chip number space
 * @pin_offset: the start offset in the pin controller number space
1183 1184 1185
 * @npins: the number of pins from the offset of each pin space (GPIO and
 *	pin controller) to accumulate in this range
 */
1186
int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
1187
			   unsigned int gpio_offset, unsigned int pin_offset,
1188
			   unsigned int npins)
1189 1190
{
	struct gpio_pin_range *pin_range;
1191
	struct gpio_device *gdev = chip->gpiodev;
1192
	int ret;
1193

1194
	pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
1195
	if (!pin_range) {
1196
		chip_err(chip, "failed to allocate pin ranges\n");
1197
		return -ENOMEM;
1198 1199
	}

1200
	/* Use local offset as range ID */
1201
	pin_range->range.id = gpio_offset;
1202
	pin_range->range.gc = chip;
1203
	pin_range->range.name = chip->label;
1204
	pin_range->range.base = gdev->base + gpio_offset;
1205
	pin_range->range.pin_base = pin_offset;
1206
	pin_range->range.npins = npins;
L
Linus Walleij 已提交
1207
	pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
1208
			&pin_range->range);
1209
	if (IS_ERR(pin_range->pctldev)) {
1210
		ret = PTR_ERR(pin_range->pctldev);
1211
		chip_err(chip, "could not create pin range\n");
1212
		kfree(pin_range);
1213
		return ret;
1214
	}
1215 1216
	chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
		 gpio_offset, gpio_offset + npins - 1,
1217 1218
		 pinctl_name,
		 pin_offset, pin_offset + npins - 1);
1219

1220
	list_add_tail(&pin_range->node, &gdev->pin_ranges);
1221 1222

	return 0;
1223
}
1224
EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
1225

1226 1227 1228 1229
/**
 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
 * @chip: the chip to remove all the mappings for
 */
1230 1231 1232
void gpiochip_remove_pin_ranges(struct gpio_chip *chip)
{
	struct gpio_pin_range *pin_range, *tmp;
1233
	struct gpio_device *gdev = chip->gpiodev;
1234

1235
	list_for_each_entry_safe(pin_range, tmp, &gdev->pin_ranges, node) {
1236 1237 1238
		list_del(&pin_range->node);
		pinctrl_remove_gpio_range(pin_range->pctldev,
				&pin_range->range);
1239
		kfree(pin_range);
1240 1241
	}
}
1242 1243 1244
EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);

#endif /* CONFIG_PINCTRL */
1245

1246 1247 1248 1249
/* These "optional" allocation calls help prevent drivers from stomping
 * on each other, and help provide better diagnostics in debugfs.
 * They're called even less than the "set direction" calls.
 */
1250
static int __gpiod_request(struct gpio_desc *desc, const char *label)
1251
{
1252
	struct gpio_chip	*chip = desc->gdev->chip;
1253
	int			status;
1254 1255
	unsigned long		flags;

1256 1257
	spin_lock_irqsave(&gpio_lock, flags);

1258
	/* NOTE:  gpio_request() can be called in early boot,
D
David Brownell 已提交
1259
	 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
1260 1261 1262 1263 1264
	 */

	if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
		desc_set_label(desc, label ? : "?");
		status = 0;
1265
	} else {
1266
		status = -EBUSY;
M
Magnus Damm 已提交
1267
		goto done;
D
David Brownell 已提交
1268 1269 1270 1271 1272
	}

	if (chip->request) {
		/* chip->request may sleep */
		spin_unlock_irqrestore(&gpio_lock, flags);
1273
		status = chip->request(chip, gpio_chip_hwgpio(desc));
D
David Brownell 已提交
1274 1275 1276 1277 1278
		spin_lock_irqsave(&gpio_lock, flags);

		if (status < 0) {
			desc_set_label(desc, NULL);
			clear_bit(FLAG_REQUESTED, &desc->flags);
1279
			goto done;
D
David Brownell 已提交
1280
		}
1281
	}
1282 1283 1284
	if (chip->get_direction) {
		/* chip->get_direction may sleep */
		spin_unlock_irqrestore(&gpio_lock, flags);
1285
		gpiod_get_direction(desc);
1286 1287
		spin_lock_irqsave(&gpio_lock, flags);
	}
1288
done:
1289 1290 1291 1292 1293 1294 1295 1296
	if (status < 0) {
		/* Clear flags that might have been set by the caller before
		 * requesting the GPIO.
		 */
		clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
		clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
		clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
	}
1297 1298 1299 1300
	spin_unlock_irqrestore(&gpio_lock, flags);
	return status;
}

1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328
/*
 * This descriptor validation needs to be inserted verbatim into each
 * function taking a descriptor, so we need to use a preprocessor
 * macro to avoid endless duplication.
 */
#define VALIDATE_DESC(desc) do { \
	if (!desc || !desc->gdev) { \
		pr_warn("%s: invalid GPIO\n", __func__); \
		return -EINVAL; \
	} \
	if ( !desc->gdev->chip ) { \
		dev_warn(&desc->gdev->dev, \
			 "%s: backing chip is gone\n", __func__); \
		return 0; \
	} } while (0)

#define VALIDATE_DESC_VOID(desc) do { \
	if (!desc || !desc->gdev) { \
		pr_warn("%s: invalid GPIO\n", __func__); \
		return; \
	} \
	if (!desc->gdev->chip) { \
		dev_warn(&desc->gdev->dev, \
			 "%s: backing chip is gone\n", __func__); \
		return; \
	} } while (0)


1329
int gpiod_request(struct gpio_desc *desc, const char *label)
1330 1331
{
	int status = -EPROBE_DEFER;
1332
	struct gpio_device *gdev;
1333

1334 1335
	VALIDATE_DESC(desc);
	gdev = desc->gdev;
1336

1337
	if (try_module_get(gdev->owner)) {
1338 1339
		status = __gpiod_request(desc, label);
		if (status < 0)
1340
			module_put(gdev->owner);
1341 1342
		else
			get_device(&gdev->dev);
1343 1344
	}

1345
	if (status)
1346
		gpiod_dbg(desc, "%s: status %d\n", __func__, status);
1347

1348 1349
	return status;
}
1350

1351
static bool __gpiod_free(struct gpio_desc *desc)
1352
{
1353
	bool			ret = false;
1354
	unsigned long		flags;
D
David Brownell 已提交
1355
	struct gpio_chip	*chip;
1356

1357 1358
	might_sleep();

1359
	gpiod_unexport(desc);
D
David Brownell 已提交
1360

1361 1362
	spin_lock_irqsave(&gpio_lock, flags);

1363
	chip = desc->gdev->chip;
D
David Brownell 已提交
1364 1365 1366
	if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
		if (chip->free) {
			spin_unlock_irqrestore(&gpio_lock, flags);
1367
			might_sleep_if(chip->can_sleep);
1368
			chip->free(chip, gpio_chip_hwgpio(desc));
D
David Brownell 已提交
1369 1370
			spin_lock_irqsave(&gpio_lock, flags);
		}
1371
		desc_set_label(desc, NULL);
1372
		clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
D
David Brownell 已提交
1373
		clear_bit(FLAG_REQUESTED, &desc->flags);
1374
		clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
1375
		clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
B
Benoit Parrot 已提交
1376
		clear_bit(FLAG_IS_HOGGED, &desc->flags);
1377 1378
		ret = true;
	}
1379 1380

	spin_unlock_irqrestore(&gpio_lock, flags);
1381 1382 1383
	return ret;
}

1384
void gpiod_free(struct gpio_desc *desc)
1385
{
1386
	if (desc && desc->gdev && __gpiod_free(desc)) {
1387
		module_put(desc->gdev->owner);
1388 1389
		put_device(&desc->gdev->dev);
	} else {
1390
		WARN_ON(extra_checks);
1391
	}
1392
}
1393

1394 1395 1396 1397 1398 1399
/**
 * gpiochip_is_requested - return string iff signal was requested
 * @chip: controller managing the signal
 * @offset: of signal within controller's 0..(ngpio - 1) range
 *
 * Returns NULL if the GPIO is not currently requested, else a string.
1400 1401
 * The string returned is the label passed to gpio_request(); if none has been
 * passed it is a meaningless, non-NULL constant.
1402 1403 1404 1405 1406 1407 1408
 *
 * This function is for use by GPIO controller drivers.  The label can
 * help with diagnostics, and knowing that the signal is used as a GPIO
 * can help avoid accidentally multiplexing it to another controller.
 */
const char *gpiochip_is_requested(struct gpio_chip *chip, unsigned offset)
{
1409
	struct gpio_desc *desc;
1410

1411
	if (offset >= chip->ngpio)
1412
		return NULL;
1413

1414
	desc = &chip->gpiodev->descs[offset];
1415

1416
	if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
1417
		return NULL;
1418
	return desc->label;
1419 1420 1421
}
EXPORT_SYMBOL_GPL(gpiochip_is_requested);

1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
/**
 * gpiochip_request_own_desc - Allow GPIO chip to request its own descriptor
 * @desc: GPIO descriptor to request
 * @label: label for the GPIO
 *
 * Function allows GPIO chip drivers to request and use their own GPIO
 * descriptors via gpiolib API. Difference to gpiod_request() is that this
 * function will not increase reference count of the GPIO chip module. This
 * allows the GPIO chip module to be unloaded as needed (we assume that the
 * GPIO chip driver handles freeing the GPIOs it has requested).
 */
1433 1434
struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *chip, u16 hwnum,
					    const char *label)
1435
{
1436 1437
	struct gpio_desc *desc = gpiochip_get_desc(chip, hwnum);
	int err;
1438

1439 1440 1441 1442 1443 1444 1445 1446
	if (IS_ERR(desc)) {
		chip_err(chip, "failed to get GPIO descriptor\n");
		return desc;
	}

	err = __gpiod_request(desc, label);
	if (err < 0)
		return ERR_PTR(err);
1447

1448
	return desc;
1449
}
1450
EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463

/**
 * gpiochip_free_own_desc - Free GPIO requested by the chip driver
 * @desc: GPIO descriptor to free
 *
 * Function frees the given GPIO requested previously with
 * gpiochip_request_own_desc().
 */
void gpiochip_free_own_desc(struct gpio_desc *desc)
{
	if (desc)
		__gpiod_free(desc);
}
1464
EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
1465

1466 1467
/*
 * Drivers MUST set GPIO direction before making get/set calls.  In
1468 1469 1470 1471 1472 1473 1474 1475
 * some cases this is done in early boot, before IRQs are enabled.
 *
 * As a rule these aren't called more than once (except for drivers
 * using the open-drain emulation idiom) so these are natural places
 * to accumulate extra debugging checks.  Note that we can't (yet)
 * rely on gpio_request() having been called beforehand.
 */

1476 1477 1478 1479 1480 1481 1482 1483 1484 1485
/**
 * gpiod_direction_input - set the GPIO direction to input
 * @desc:	GPIO to set to input
 *
 * Set the direction of the passed GPIO to input, such as gpiod_get_value() can
 * be called safely on it.
 *
 * Return 0 in case of success, else an error code.
 */
int gpiod_direction_input(struct gpio_desc *desc)
1486 1487 1488 1489
{
	struct gpio_chip	*chip;
	int			status = -EINVAL;

1490 1491
	VALIDATE_DESC(desc);
	chip = desc->gdev->chip;
1492

1493
	if (!chip->get || !chip->direction_input) {
1494 1495
		gpiod_warn(desc,
			"%s: missing get() or direction_input() operations\n",
1496
			__func__);
1497 1498 1499
		return -EIO;
	}

1500
	status = chip->direction_input(chip, gpio_chip_hwgpio(desc));
1501 1502
	if (status == 0)
		clear_bit(FLAG_IS_OUT, &desc->flags);
1503

1504
	trace_gpio_direction(desc_to_gpio(desc), 1, status);
1505

1506 1507
	return status;
}
1508
EXPORT_SYMBOL_GPL(gpiod_direction_input);
1509

1510
static int _gpiod_direction_output_raw(struct gpio_desc *desc, int value)
1511
{
1512 1513
	struct gpio_chip *gc = desc->gdev->chip;
	int ret;
1514

1515 1516 1517 1518 1519 1520 1521 1522
	/* GPIOs used for IRQs shall not be set as output */
	if (test_bit(FLAG_USED_AS_IRQ, &desc->flags)) {
		gpiod_err(desc,
			  "%s: tried to set a GPIO tied to an IRQ as output\n",
			  __func__);
		return -EIO;
	}

1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551
	if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
		/* First see if we can enable open drain in hardware */
		if (gc->set_single_ended) {
			ret = gc->set_single_ended(gc, gpio_chip_hwgpio(desc),
						   LINE_MODE_OPEN_DRAIN);
			if (!ret)
				goto set_output_value;
		}
		/* Emulate open drain by not actively driving the line high */
		if (value)
			return gpiod_direction_input(desc);
	}
	else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
		if (gc->set_single_ended) {
			ret = gc->set_single_ended(gc, gpio_chip_hwgpio(desc),
						   LINE_MODE_OPEN_SOURCE);
			if (!ret)
				goto set_output_value;
		}
		/* Emulate open source by not actively driving the line low */
		if (!value)
			return gpiod_direction_input(desc);
	} else {
		/* Make sure to disable open drain/source hardware, if any */
		if (gc->set_single_ended)
			gc->set_single_ended(gc,
					     gpio_chip_hwgpio(desc),
					     LINE_MODE_PUSH_PULL);
	}
1552

1553 1554
set_output_value:
	if (!gc->set || !gc->direction_output) {
1555 1556 1557
		gpiod_warn(desc,
		       "%s: missing set() or direction_output() operations\n",
		       __func__);
1558 1559 1560
		return -EIO;
	}

1561 1562
	ret = gc->direction_output(gc, gpio_chip_hwgpio(desc), value);
	if (!ret)
1563
		set_bit(FLAG_IS_OUT, &desc->flags);
1564
	trace_gpio_value(desc_to_gpio(desc), 0, value);
1565 1566
	trace_gpio_direction(desc_to_gpio(desc), 0, ret);
	return ret;
1567
}
1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581

/**
 * gpiod_direction_output_raw - set the GPIO direction to output
 * @desc:	GPIO to set to output
 * @value:	initial output value of the GPIO
 *
 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
 * be called safely on it. The initial value of the output must be specified
 * as raw value on the physical line without regard for the ACTIVE_LOW status.
 *
 * Return 0 in case of success, else an error code.
 */
int gpiod_direction_output_raw(struct gpio_desc *desc, int value)
{
1582
	VALIDATE_DESC(desc);
1583 1584 1585 1586 1587
	return _gpiod_direction_output_raw(desc, value);
}
EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);

/**
1588
 * gpiod_direction_output - set the GPIO direction to output
1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600
 * @desc:	GPIO to set to output
 * @value:	initial output value of the GPIO
 *
 * Set the direction of the passed GPIO to output, such as gpiod_set_value() can
 * be called safely on it. The initial value of the output must be specified
 * as the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
 * account.
 *
 * Return 0 in case of success, else an error code.
 */
int gpiod_direction_output(struct gpio_desc *desc, int value)
{
1601
	VALIDATE_DESC(desc);
1602 1603 1604 1605
	if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
		value = !value;
	return _gpiod_direction_output_raw(desc, value);
}
1606
EXPORT_SYMBOL_GPL(gpiod_direction_output);
1607

1608
/**
1609
 * gpiod_set_debounce - sets @debounce time for a @gpio
1610 1611
 * @gpio: the gpio to set debounce time
 * @debounce: debounce time is microseconds
1612 1613 1614
 *
 * returns -ENOTSUPP if the controller does not support setting
 * debounce.
1615
 */
1616
int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
1617 1618 1619
{
	struct gpio_chip	*chip;

1620 1621
	VALIDATE_DESC(desc);
	chip = desc->gdev->chip;
1622
	if (!chip->set || !chip->set_debounce) {
1623 1624 1625
		gpiod_dbg(desc,
			  "%s: missing set() or set_debounce() operations\n",
			  __func__);
1626
		return -ENOTSUPP;
1627 1628
	}

1629
	return chip->set_debounce(chip, gpio_chip_hwgpio(desc), debounce);
1630
}
1631
EXPORT_SYMBOL_GPL(gpiod_set_debounce);
1632

1633 1634 1635 1636 1637 1638 1639
/**
 * gpiod_is_active_low - test whether a GPIO is active-low or not
 * @desc: the gpio descriptor to test
 *
 * Returns 1 if the GPIO is active-low, 0 otherwise.
 */
int gpiod_is_active_low(const struct gpio_desc *desc)
1640
{
1641
	VALIDATE_DESC(desc);
1642
	return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
1643
}
1644
EXPORT_SYMBOL_GPL(gpiod_is_active_low);
1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667

/* I/O calls are only valid after configuration completed; the relevant
 * "is this a valid GPIO" error checks should already have been done.
 *
 * "Get" operations are often inlinable as reading a pin value register,
 * and masking the relevant bit in that register.
 *
 * When "set" operations are inlinable, they involve writing that mask to
 * one register to set a low value, or a different register to set it high.
 * Otherwise locking is needed, so there may be little value to inlining.
 *
 *------------------------------------------------------------------------
 *
 * IMPORTANT!!!  The hot paths -- get/set value -- assume that callers
 * have requested the GPIO.  That can include implicit requesting by
 * a direction setting call.  Marking a gpio as requested locks its chip
 * in memory, guaranteeing that these table lookups need no more locking
 * and that gpiochip_remove() will fail.
 *
 * REVISIT when debugging, consider adding some instrumentation to ensure
 * that the GPIO was actually requested.
 */

1668
static int _gpiod_get_raw_value(const struct gpio_desc *desc)
1669 1670
{
	struct gpio_chip	*chip;
1671
	int offset;
1672
	int value;
1673

1674
	chip = desc->gdev->chip;
1675
	offset = gpio_chip_hwgpio(desc);
1676
	value = chip->get ? chip->get(chip, offset) : -EIO;
1677
	value = value < 0 ? value : !!value;
1678
	trace_gpio_value(desc_to_gpio(desc), 1, value);
1679
	return value;
1680
}
1681

1682
/**
1683 1684
 * gpiod_get_raw_value() - return a gpio's raw value
 * @desc: gpio whose value will be returned
1685
 *
1686
 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
1687
 * its ACTIVE_LOW status, or negative errno on failure.
1688 1689 1690
 *
 * This function should be called from contexts where we cannot sleep, and will
 * complain if the GPIO chip functions potentially sleep.
1691
 */
1692
int gpiod_get_raw_value(const struct gpio_desc *desc)
1693
{
1694
	VALIDATE_DESC(desc);
1695
	/* Should be using gpio_get_value_cansleep() */
1696
	WARN_ON(desc->gdev->chip->can_sleep);
1697
	return _gpiod_get_raw_value(desc);
1698
}
1699
EXPORT_SYMBOL_GPL(gpiod_get_raw_value);
1700

1701 1702 1703 1704 1705
/**
 * gpiod_get_value() - return a gpio's value
 * @desc: gpio whose value will be returned
 *
 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
1706
 * account, or negative errno on failure.
1707 1708 1709 1710 1711
 *
 * This function should be called from contexts where we cannot sleep, and will
 * complain if the GPIO chip functions potentially sleep.
 */
int gpiod_get_value(const struct gpio_desc *desc)
1712
{
1713
	int value;
1714 1715

	VALIDATE_DESC(desc);
1716
	/* Should be using gpio_get_value_cansleep() */
1717
	WARN_ON(desc->gdev->chip->can_sleep);
1718 1719

	value = _gpiod_get_raw_value(desc);
1720 1721 1722
	if (value < 0)
		return value;

1723 1724 1725 1726
	if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
		value = !value;

	return value;
1727
}
1728
EXPORT_SYMBOL_GPL(gpiod_get_value);
1729

1730 1731
/*
 *  _gpio_set_open_drain_value() - Set the open drain gpio's value.
1732
 * @desc: gpio descriptor whose state need to be set.
1733
 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
1734
 */
1735
static void _gpio_set_open_drain_value(struct gpio_desc *desc, bool value)
1736 1737
{
	int err = 0;
1738
	struct gpio_chip *chip = desc->gdev->chip;
1739 1740
	int offset = gpio_chip_hwgpio(desc);

1741
	if (value) {
1742
		err = chip->direction_input(chip, offset);
1743
		if (!err)
1744
			clear_bit(FLAG_IS_OUT, &desc->flags);
1745
	} else {
1746
		err = chip->direction_output(chip, offset, 0);
1747
		if (!err)
1748
			set_bit(FLAG_IS_OUT, &desc->flags);
1749
	}
1750
	trace_gpio_direction(desc_to_gpio(desc), value, err);
1751
	if (err < 0)
1752 1753 1754
		gpiod_err(desc,
			  "%s: Error in set_value for open drain err %d\n",
			  __func__, err);
1755 1756
}

1757
/*
1758 1759
 *  _gpio_set_open_source_value() - Set the open source gpio's value.
 * @desc: gpio descriptor whose state need to be set.
1760
 * @value: Non-zero for setting it HIGH otherwise it will set to LOW.
1761
 */
1762
static void _gpio_set_open_source_value(struct gpio_desc *desc, bool value)
1763 1764
{
	int err = 0;
1765
	struct gpio_chip *chip = desc->gdev->chip;
1766 1767
	int offset = gpio_chip_hwgpio(desc);

1768
	if (value) {
1769
		err = chip->direction_output(chip, offset, 1);
1770
		if (!err)
1771
			set_bit(FLAG_IS_OUT, &desc->flags);
1772
	} else {
1773
		err = chip->direction_input(chip, offset);
1774
		if (!err)
1775
			clear_bit(FLAG_IS_OUT, &desc->flags);
1776
	}
1777
	trace_gpio_direction(desc_to_gpio(desc), !value, err);
1778
	if (err < 0)
1779 1780 1781
		gpiod_err(desc,
			  "%s: Error in set_value for open source err %d\n",
			  __func__, err);
1782 1783
}

1784
static void _gpiod_set_raw_value(struct gpio_desc *desc, bool value)
1785 1786 1787
{
	struct gpio_chip	*chip;

1788
	chip = desc->gdev->chip;
1789 1790 1791 1792 1793
	trace_gpio_value(desc_to_gpio(desc), 0, value);
	if (test_bit(FLAG_OPEN_DRAIN, &desc->flags))
		_gpio_set_open_drain_value(desc, value);
	else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags))
		_gpio_set_open_source_value(desc, value);
1794
	else
1795 1796 1797
		chip->set(chip, gpio_chip_hwgpio(desc), value);
}

1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821
/*
 * set multiple outputs on the same chip;
 * use the chip's set_multiple function if available;
 * otherwise set the outputs sequentially;
 * @mask: bit mask array; one bit per output; BITS_PER_LONG bits per word
 *        defines which outputs are to be changed
 * @bits: bit value array; one bit per output; BITS_PER_LONG bits per word
 *        defines the values the outputs specified by mask are to be set to
 */
static void gpio_chip_set_multiple(struct gpio_chip *chip,
				   unsigned long *mask, unsigned long *bits)
{
	if (chip->set_multiple) {
		chip->set_multiple(chip, mask, bits);
	} else {
		int i;
		for (i = 0; i < chip->ngpio; i++) {
			if (mask[BIT_WORD(i)] == 0) {
				/* no more set bits in this mask word;
				 * skip ahead to the next word */
				i = (BIT_WORD(i) + 1) * BITS_PER_LONG - 1;
				continue;
			}
			/* set outputs if the corresponding mask bit is set */
D
Daniel Lockyer 已提交
1822
			if (__test_and_clear_bit(i, mask))
1823 1824 1825 1826 1827
				chip->set(chip, i, test_bit(i, bits));
		}
	}
}

1828 1829 1830 1831
void gpiod_set_array_value_complex(bool raw, bool can_sleep,
				   unsigned int array_size,
				   struct gpio_desc **desc_array,
				   int *value_array)
1832 1833 1834 1835
{
	int i = 0;

	while (i < array_size) {
1836
		struct gpio_chip *chip = desc_array[i]->gdev->chip;
1837 1838 1839 1840
		unsigned long mask[BITS_TO_LONGS(chip->ngpio)];
		unsigned long bits[BITS_TO_LONGS(chip->ngpio)];
		int count = 0;

D
Daniel Lockyer 已提交
1841
		if (!can_sleep)
1842
			WARN_ON(chip->can_sleep);
D
Daniel Lockyer 已提交
1843

1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857
		memset(mask, 0, sizeof(mask));
		do {
			struct gpio_desc *desc = desc_array[i];
			int hwgpio = gpio_chip_hwgpio(desc);
			int value = value_array[i];

			if (!raw && test_bit(FLAG_ACTIVE_LOW, &desc->flags))
				value = !value;
			trace_gpio_value(desc_to_gpio(desc), 0, value);
			/*
			 * collect all normal outputs belonging to the same chip
			 * open drain and open source outputs are set individually
			 */
			if (test_bit(FLAG_OPEN_DRAIN, &desc->flags)) {
D
Daniel Lockyer 已提交
1858
				_gpio_set_open_drain_value(desc, value);
1859 1860 1861 1862
			} else if (test_bit(FLAG_OPEN_SOURCE, &desc->flags)) {
				_gpio_set_open_source_value(desc, value);
			} else {
				__set_bit(hwgpio, mask);
D
Daniel Lockyer 已提交
1863
				if (value)
1864
					__set_bit(hwgpio, bits);
D
Daniel Lockyer 已提交
1865
				else
1866 1867 1868 1869
					__clear_bit(hwgpio, bits);
				count++;
			}
			i++;
1870 1871
		} while ((i < array_size) &&
			 (desc_array[i]->gdev->chip == chip));
1872
		/* push collected bits to outputs */
D
Daniel Lockyer 已提交
1873
		if (count != 0)
1874 1875 1876 1877
			gpio_chip_set_multiple(chip, mask, bits);
	}
}

1878
/**
1879 1880
 * gpiod_set_raw_value() - assign a gpio's raw value
 * @desc: gpio whose value will be assigned
1881 1882
 * @value: value to assign
 *
1883 1884 1885 1886 1887
 * Set the raw value of the GPIO, i.e. the value of its physical line without
 * regard for its ACTIVE_LOW status.
 *
 * This function should be called from contexts where we cannot sleep, and will
 * complain if the GPIO chip functions potentially sleep.
1888
 */
1889
void gpiod_set_raw_value(struct gpio_desc *desc, int value)
1890
{
1891
	VALIDATE_DESC_VOID(desc);
1892
	/* Should be using gpiod_set_value_cansleep() */
1893
	WARN_ON(desc->gdev->chip->can_sleep);
1894
	_gpiod_set_raw_value(desc, value);
1895
}
1896
EXPORT_SYMBOL_GPL(gpiod_set_raw_value);
1897 1898

/**
1899 1900 1901 1902 1903 1904
 * gpiod_set_value() - assign a gpio's value
 * @desc: gpio whose value will be assigned
 * @value: value to assign
 *
 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
 * account
1905
 *
1906 1907
 * This function should be called from contexts where we cannot sleep, and will
 * complain if the GPIO chip functions potentially sleep.
1908
 */
1909
void gpiod_set_value(struct gpio_desc *desc, int value)
1910
{
1911
	VALIDATE_DESC_VOID(desc);
1912
	/* Should be using gpiod_set_value_cansleep() */
1913
	WARN_ON(desc->gdev->chip->can_sleep);
1914 1915 1916
	if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
		value = !value;
	_gpiod_set_raw_value(desc, value);
1917
}
1918
EXPORT_SYMBOL_GPL(gpiod_set_value);
1919

1920
/**
1921
 * gpiod_set_raw_array_value() - assign values to an array of GPIOs
1922 1923 1924 1925 1926 1927 1928 1929 1930 1931
 * @array_size: number of elements in the descriptor / value arrays
 * @desc_array: array of GPIO descriptors whose values will be assigned
 * @value_array: array of values to assign
 *
 * Set the raw values of the GPIOs, i.e. the values of the physical lines
 * without regard for their ACTIVE_LOW status.
 *
 * This function should be called from contexts where we cannot sleep, and will
 * complain if the GPIO chip functions potentially sleep.
 */
1932
void gpiod_set_raw_array_value(unsigned int array_size,
1933 1934 1935 1936
			 struct gpio_desc **desc_array, int *value_array)
{
	if (!desc_array)
		return;
1937 1938
	gpiod_set_array_value_complex(true, false, array_size, desc_array,
				      value_array);
1939
}
1940
EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value);
1941 1942

/**
1943
 * gpiod_set_array_value() - assign values to an array of GPIOs
1944 1945 1946 1947 1948 1949 1950 1951 1952 1953
 * @array_size: number of elements in the descriptor / value arrays
 * @desc_array: array of GPIO descriptors whose values will be assigned
 * @value_array: array of values to assign
 *
 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
 * into account.
 *
 * This function should be called from contexts where we cannot sleep, and will
 * complain if the GPIO chip functions potentially sleep.
 */
1954 1955
void gpiod_set_array_value(unsigned int array_size,
			   struct gpio_desc **desc_array, int *value_array)
1956 1957 1958
{
	if (!desc_array)
		return;
1959 1960
	gpiod_set_array_value_complex(false, false, array_size, desc_array,
				      value_array);
1961
}
1962
EXPORT_SYMBOL_GPL(gpiod_set_array_value);
1963

1964
/**
1965 1966
 * gpiod_cansleep() - report whether gpio value access may sleep
 * @desc: gpio to check
1967 1968
 *
 */
1969
int gpiod_cansleep(const struct gpio_desc *desc)
1970
{
1971 1972
	VALIDATE_DESC(desc);
	return desc->gdev->chip->can_sleep;
1973
}
1974
EXPORT_SYMBOL_GPL(gpiod_cansleep);
1975

D
David Brownell 已提交
1976
/**
1977 1978
 * gpiod_to_irq() - return the IRQ corresponding to a GPIO
 * @desc: gpio whose IRQ will be returned (already requested)
D
David Brownell 已提交
1979
 *
1980 1981
 * Return the IRQ corresponding to the passed GPIO, or an error code in case of
 * error.
D
David Brownell 已提交
1982
 */
1983
int gpiod_to_irq(const struct gpio_desc *desc)
D
David Brownell 已提交
1984 1985
{
	struct gpio_chip	*chip;
1986
	int			offset;
D
David Brownell 已提交
1987

1988 1989
	VALIDATE_DESC(desc);
	chip = desc->gdev->chip;
1990 1991
	offset = gpio_chip_hwgpio(desc);
	return chip->to_irq ? chip->to_irq(chip, offset) : -ENXIO;
D
David Brownell 已提交
1992
}
1993
EXPORT_SYMBOL_GPL(gpiod_to_irq);
D
David Brownell 已提交
1994

1995
/**
1996
 * gpiochip_lock_as_irq() - lock a GPIO to be used as IRQ
1997 1998
 * @chip: the chip the GPIO to lock belongs to
 * @offset: the offset of the GPIO to lock as IRQ
1999 2000
 *
 * This is used directly by GPIO drivers that want to lock down
2001
 * a certain GPIO line to be used for IRQs.
2002
 */
2003
int gpiochip_lock_as_irq(struct gpio_chip *chip, unsigned int offset)
2004
{
2005
	if (offset >= chip->ngpio)
2006 2007
		return -EINVAL;

2008
	if (test_bit(FLAG_IS_OUT, &chip->gpiodev->descs[offset].flags)) {
2009
		chip_err(chip,
2010 2011 2012 2013 2014
			  "%s: tried to flag a GPIO set as output for IRQ\n",
			  __func__);
		return -EIO;
	}

2015
	set_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
2016
	return 0;
2017
}
2018
EXPORT_SYMBOL_GPL(gpiochip_lock_as_irq);
2019

2020
/**
2021
 * gpiochip_unlock_as_irq() - unlock a GPIO used as IRQ
2022 2023
 * @chip: the chip the GPIO to lock belongs to
 * @offset: the offset of the GPIO to lock as IRQ
2024 2025 2026
 *
 * This is used directly by GPIO drivers that want to indicate
 * that a certain GPIO is no longer used exclusively for IRQ.
2027
 */
2028
void gpiochip_unlock_as_irq(struct gpio_chip *chip, unsigned int offset)
2029
{
2030
	if (offset >= chip->ngpio)
2031
		return;
2032

2033
	clear_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
2034
}
2035
EXPORT_SYMBOL_GPL(gpiochip_unlock_as_irq);
2036

2037 2038 2039 2040 2041 2042 2043 2044 2045
bool gpiochip_line_is_irq(struct gpio_chip *chip, unsigned int offset)
{
	if (offset >= chip->ngpio)
		return false;

	return test_bit(FLAG_USED_AS_IRQ, &chip->gpiodev->descs[offset].flags);
}
EXPORT_SYMBOL_GPL(gpiochip_line_is_irq);

2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063
bool gpiochip_line_is_open_drain(struct gpio_chip *chip, unsigned int offset)
{
	if (offset >= chip->ngpio)
		return false;

	return test_bit(FLAG_OPEN_DRAIN, &chip->gpiodev->descs[offset].flags);
}
EXPORT_SYMBOL_GPL(gpiochip_line_is_open_drain);

bool gpiochip_line_is_open_source(struct gpio_chip *chip, unsigned int offset)
{
	if (offset >= chip->ngpio)
		return false;

	return test_bit(FLAG_OPEN_SOURCE, &chip->gpiodev->descs[offset].flags);
}
EXPORT_SYMBOL_GPL(gpiochip_line_is_open_source);

2064 2065 2066 2067 2068
/**
 * gpiod_get_raw_value_cansleep() - return a gpio's raw value
 * @desc: gpio whose value will be returned
 *
 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
2069
 * its ACTIVE_LOW status, or negative errno on failure.
2070 2071
 *
 * This function is to be called from contexts that can sleep.
2072
 */
2073
int gpiod_get_raw_value_cansleep(const struct gpio_desc *desc)
2074 2075
{
	might_sleep_if(extra_checks);
2076
	VALIDATE_DESC(desc);
2077
	return _gpiod_get_raw_value(desc);
2078
}
2079
EXPORT_SYMBOL_GPL(gpiod_get_raw_value_cansleep);
2080

2081 2082 2083 2084 2085
/**
 * gpiod_get_value_cansleep() - return a gpio's value
 * @desc: gpio whose value will be returned
 *
 * Return the GPIO's logical value, i.e. taking the ACTIVE_LOW status into
2086
 * account, or negative errno on failure.
2087 2088 2089 2090
 *
 * This function is to be called from contexts that can sleep.
 */
int gpiod_get_value_cansleep(const struct gpio_desc *desc)
2091
{
2092
	int value;
2093 2094

	might_sleep_if(extra_checks);
2095
	VALIDATE_DESC(desc);
2096
	value = _gpiod_get_raw_value(desc);
2097 2098 2099
	if (value < 0)
		return value;

2100 2101 2102
	if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
		value = !value;

2103
	return value;
2104
}
2105
EXPORT_SYMBOL_GPL(gpiod_get_value_cansleep);
2106

2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117
/**
 * gpiod_set_raw_value_cansleep() - assign a gpio's raw value
 * @desc: gpio whose value will be assigned
 * @value: value to assign
 *
 * Set the raw value of the GPIO, i.e. the value of its physical line without
 * regard for its ACTIVE_LOW status.
 *
 * This function is to be called from contexts that can sleep.
 */
void gpiod_set_raw_value_cansleep(struct gpio_desc *desc, int value)
2118
{
2119
	might_sleep_if(extra_checks);
2120
	VALIDATE_DESC_VOID(desc);
2121
	_gpiod_set_raw_value(desc, value);
2122
}
2123
EXPORT_SYMBOL_GPL(gpiod_set_raw_value_cansleep);
2124

2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135
/**
 * gpiod_set_value_cansleep() - assign a gpio's value
 * @desc: gpio whose value will be assigned
 * @value: value to assign
 *
 * Set the logical value of the GPIO, i.e. taking its ACTIVE_LOW status into
 * account
 *
 * This function is to be called from contexts that can sleep.
 */
void gpiod_set_value_cansleep(struct gpio_desc *desc, int value)
2136 2137
{
	might_sleep_if(extra_checks);
2138
	VALIDATE_DESC_VOID(desc);
2139 2140 2141
	if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
		value = !value;
	_gpiod_set_raw_value(desc, value);
2142
}
2143
EXPORT_SYMBOL_GPL(gpiod_set_value_cansleep);
2144

2145
/**
2146
 * gpiod_set_raw_array_value_cansleep() - assign values to an array of GPIOs
2147 2148 2149 2150 2151 2152 2153 2154 2155
 * @array_size: number of elements in the descriptor / value arrays
 * @desc_array: array of GPIO descriptors whose values will be assigned
 * @value_array: array of values to assign
 *
 * Set the raw values of the GPIOs, i.e. the values of the physical lines
 * without regard for their ACTIVE_LOW status.
 *
 * This function is to be called from contexts that can sleep.
 */
2156 2157 2158
void gpiod_set_raw_array_value_cansleep(unsigned int array_size,
					struct gpio_desc **desc_array,
					int *value_array)
2159 2160 2161 2162
{
	might_sleep_if(extra_checks);
	if (!desc_array)
		return;
2163 2164
	gpiod_set_array_value_complex(true, true, array_size, desc_array,
				      value_array);
2165
}
2166
EXPORT_SYMBOL_GPL(gpiod_set_raw_array_value_cansleep);
2167 2168

/**
2169
 * gpiod_set_array_value_cansleep() - assign values to an array of GPIOs
2170 2171 2172 2173 2174 2175 2176 2177 2178
 * @array_size: number of elements in the descriptor / value arrays
 * @desc_array: array of GPIO descriptors whose values will be assigned
 * @value_array: array of values to assign
 *
 * Set the logical values of the GPIOs, i.e. taking their ACTIVE_LOW status
 * into account.
 *
 * This function is to be called from contexts that can sleep.
 */
2179 2180 2181
void gpiod_set_array_value_cansleep(unsigned int array_size,
				    struct gpio_desc **desc_array,
				    int *value_array)
2182 2183 2184 2185
{
	might_sleep_if(extra_checks);
	if (!desc_array)
		return;
2186 2187
	gpiod_set_array_value_complex(false, true, array_size, desc_array,
				      value_array);
2188
}
2189
EXPORT_SYMBOL_GPL(gpiod_set_array_value_cansleep);
2190

2191
/**
2192 2193
 * gpiod_add_lookup_table() - register GPIO device consumers
 * @table: table of consumers to register
2194
 */
2195
void gpiod_add_lookup_table(struct gpiod_lookup_table *table)
2196 2197 2198
{
	mutex_lock(&gpio_lookup_lock);

2199
	list_add_tail(&table->list, &gpio_lookup_list);
2200 2201 2202 2203

	mutex_unlock(&gpio_lookup_lock);
}

2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216
/**
 * gpiod_remove_lookup_table() - unregister GPIO device consumers
 * @table: table of consumers to unregister
 */
void gpiod_remove_lookup_table(struct gpiod_lookup_table *table)
{
	mutex_lock(&gpio_lookup_lock);

	list_del(&table->list);

	mutex_unlock(&gpio_lookup_lock);
}

2217
static struct gpio_desc *of_find_gpio(struct device *dev, const char *con_id,
2218 2219
				      unsigned int idx,
				      enum gpio_lookup_flags *flags)
2220 2221 2222 2223
{
	char prop_name[32]; /* 32 is max size of property name */
	enum of_gpio_flags of_flags;
	struct gpio_desc *desc;
2224
	unsigned int i;
2225

2226
	for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
2227
		if (con_id)
2228
			snprintf(prop_name, sizeof(prop_name), "%s-%s", con_id,
2229
				 gpio_suffixes[i]);
2230
		else
2231
			snprintf(prop_name, sizeof(prop_name), "%s",
2232
				 gpio_suffixes[i]);
2233

2234 2235
		desc = of_get_named_gpiod_flags(dev->of_node, prop_name, idx,
						&of_flags);
2236
		if (!IS_ERR(desc) || (PTR_ERR(desc) == -EPROBE_DEFER))
2237 2238
			break;
	}
2239 2240 2241 2242 2243

	if (IS_ERR(desc))
		return desc;

	if (of_flags & OF_GPIO_ACTIVE_LOW)
2244
		*flags |= GPIO_ACTIVE_LOW;
2245

2246 2247 2248 2249 2250 2251 2252
	if (of_flags & OF_GPIO_SINGLE_ENDED) {
		if (of_flags & OF_GPIO_ACTIVE_LOW)
			*flags |= GPIO_OPEN_DRAIN;
		else
			*flags |= GPIO_OPEN_SOURCE;
	}

2253 2254
	return desc;
}
2255

2256
static struct gpio_desc *acpi_find_gpio(struct device *dev, const char *con_id,
2257 2258
					unsigned int idx,
					enum gpio_lookup_flags *flags)
2259
{
2260
	struct acpi_device *adev = ACPI_COMPANION(dev);
2261 2262
	struct acpi_gpio_info info;
	struct gpio_desc *desc;
2263 2264
	char propname[32];
	int i;
2265

2266
	/* Try first from _DSD */
2267
	for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
2268 2269
		if (con_id && strcmp(con_id, "gpios")) {
			snprintf(propname, sizeof(propname), "%s-%s",
2270
				 con_id, gpio_suffixes[i]);
2271 2272
		} else {
			snprintf(propname, sizeof(propname), "%s",
2273
				 gpio_suffixes[i]);
2274 2275 2276 2277 2278 2279 2280 2281 2282
		}

		desc = acpi_get_gpiod_by_index(adev, propname, idx, &info);
		if (!IS_ERR(desc) || (PTR_ERR(desc) == -EPROBE_DEFER))
			break;
	}

	/* Then from plain _CRS GPIOs */
	if (IS_ERR(desc)) {
2283 2284 2285
		if (!acpi_can_fallback_to_crs(adev, con_id))
			return ERR_PTR(-ENOENT);

2286 2287 2288 2289
		desc = acpi_get_gpiod_by_index(adev, NULL, idx, &info);
		if (IS_ERR(desc))
			return desc;
	}
2290

2291
	if (info.polarity == GPIO_ACTIVE_LOW)
2292
		*flags |= GPIO_ACTIVE_LOW;
2293 2294

	return desc;
2295 2296
}

2297
static struct gpiod_lookup_table *gpiod_find_lookup_table(struct device *dev)
2298 2299
{
	const char *dev_id = dev ? dev_name(dev) : NULL;
2300
	struct gpiod_lookup_table *table;
2301 2302 2303

	mutex_lock(&gpio_lookup_lock);

2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321
	list_for_each_entry(table, &gpio_lookup_list, list) {
		if (table->dev_id && dev_id) {
			/*
			 * Valid strings on both ends, must be identical to have
			 * a match
			 */
			if (!strcmp(table->dev_id, dev_id))
				goto found;
		} else {
			/*
			 * One of the pointers is NULL, so both must be to have
			 * a match
			 */
			if (dev_id == table->dev_id)
				goto found;
		}
	}
	table = NULL;
2322

2323 2324 2325 2326
found:
	mutex_unlock(&gpio_lookup_lock);
	return table;
}
2327

2328 2329 2330 2331
static struct gpio_desc *gpiod_find(struct device *dev, const char *con_id,
				    unsigned int idx,
				    enum gpio_lookup_flags *flags)
{
2332
	struct gpio_desc *desc = ERR_PTR(-ENOENT);
2333 2334
	struct gpiod_lookup_table *table;
	struct gpiod_lookup *p;
2335

2336 2337 2338
	table = gpiod_find_lookup_table(dev);
	if (!table)
		return desc;
2339

2340 2341
	for (p = &table->table[0]; p->chip_label; p++) {
		struct gpio_chip *chip;
2342

2343
		/* idx must always match exactly */
2344 2345 2346
		if (p->idx != idx)
			continue;

2347 2348 2349
		/* If the lookup entry has a con_id, require exact match */
		if (p->con_id && (!con_id || strcmp(p->con_id, con_id)))
			continue;
2350

2351
		chip = find_chip_by_name(p->chip_label);
2352

2353
		if (!chip) {
2354 2355 2356
			dev_err(dev, "cannot find GPIO chip %s\n",
				p->chip_label);
			return ERR_PTR(-ENODEV);
2357
		}
2358

2359
		if (chip->ngpio <= p->chip_hwnum) {
2360 2361 2362 2363
			dev_err(dev,
				"requested GPIO %d is out of range [0..%d] for chip %s\n",
				idx, chip->ngpio, chip->label);
			return ERR_PTR(-EINVAL);
2364 2365
		}

2366
		desc = gpiochip_get_desc(chip, p->chip_hwnum);
2367
		*flags = p->flags;
2368

2369
		return desc;
2370 2371 2372 2373 2374
	}

	return desc;
}

2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438
static int dt_gpio_count(struct device *dev, const char *con_id)
{
	int ret;
	char propname[32];
	unsigned int i;

	for (i = 0; i < ARRAY_SIZE(gpio_suffixes); i++) {
		if (con_id)
			snprintf(propname, sizeof(propname), "%s-%s",
				 con_id, gpio_suffixes[i]);
		else
			snprintf(propname, sizeof(propname), "%s",
				 gpio_suffixes[i]);

		ret = of_gpio_named_count(dev->of_node, propname);
		if (ret >= 0)
			break;
	}
	return ret;
}

static int platform_gpio_count(struct device *dev, const char *con_id)
{
	struct gpiod_lookup_table *table;
	struct gpiod_lookup *p;
	unsigned int count = 0;

	table = gpiod_find_lookup_table(dev);
	if (!table)
		return -ENOENT;

	for (p = &table->table[0]; p->chip_label; p++) {
		if ((con_id && p->con_id && !strcmp(con_id, p->con_id)) ||
		    (!con_id && !p->con_id))
			count++;
	}
	if (!count)
		return -ENOENT;

	return count;
}

/**
 * gpiod_count - return the number of GPIOs associated with a device / function
 *		or -ENOENT if no GPIO has been assigned to the requested function
 * @dev:	GPIO consumer, can be NULL for system-global GPIOs
 * @con_id:	function within the GPIO consumer
 */
int gpiod_count(struct device *dev, const char *con_id)
{
	int count = -ENOENT;

	if (IS_ENABLED(CONFIG_OF) && dev && dev->of_node)
		count = dt_gpio_count(dev, con_id);
	else if (IS_ENABLED(CONFIG_ACPI) && dev && ACPI_HANDLE(dev))
		count = acpi_gpio_count(dev, con_id);

	if (count < 0)
		count = platform_gpio_count(dev, con_id);

	return count;
}
EXPORT_SYMBOL_GPL(gpiod_count);

2439
/**
2440
 * gpiod_get - obtain a GPIO for a given GPIO function
2441
 * @dev:	GPIO consumer, can be NULL for system-global GPIOs
2442
 * @con_id:	function within the GPIO consumer
2443
 * @flags:	optional GPIO initialization flags
2444 2445
 *
 * Return the GPIO descriptor corresponding to the function con_id of device
2446
 * dev, -ENOENT if no GPIO has been assigned to the requested function, or
2447
 * another IS_ERR() code if an error occurred while trying to acquire the GPIO.
2448
 */
2449
struct gpio_desc *__must_check gpiod_get(struct device *dev, const char *con_id,
2450
					 enum gpiod_flags flags)
2451
{
2452
	return gpiod_get_index(dev, con_id, 0, flags);
2453
}
2454
EXPORT_SYMBOL_GPL(gpiod_get);
2455

2456 2457 2458 2459
/**
 * gpiod_get_optional - obtain an optional GPIO for a given GPIO function
 * @dev: GPIO consumer, can be NULL for system-global GPIOs
 * @con_id: function within the GPIO consumer
2460
 * @flags: optional GPIO initialization flags
2461 2462 2463 2464 2465
 *
 * This is equivalent to gpiod_get(), except that when no GPIO was assigned to
 * the requested function it will return NULL. This is convenient for drivers
 * that need to handle optional GPIOs.
 */
2466
struct gpio_desc *__must_check gpiod_get_optional(struct device *dev,
2467 2468
						  const char *con_id,
						  enum gpiod_flags flags)
2469
{
2470
	return gpiod_get_index_optional(dev, con_id, 0, flags);
2471
}
2472
EXPORT_SYMBOL_GPL(gpiod_get_optional);
2473

2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490
/**
 * gpiod_parse_flags - helper function to parse GPIO lookup flags
 * @desc:	gpio to be setup
 * @lflags:	gpio_lookup_flags - returned from of_find_gpio() or
 *		of_get_gpio_hog()
 *
 * Set the GPIO descriptor flags based on the given GPIO lookup flags.
 */
static void gpiod_parse_flags(struct gpio_desc *desc, unsigned long lflags)
{
	if (lflags & GPIO_ACTIVE_LOW)
		set_bit(FLAG_ACTIVE_LOW, &desc->flags);
	if (lflags & GPIO_OPEN_DRAIN)
		set_bit(FLAG_OPEN_DRAIN, &desc->flags);
	if (lflags & GPIO_OPEN_SOURCE)
		set_bit(FLAG_OPEN_SOURCE, &desc->flags);
}
B
Benoit Parrot 已提交
2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502

/**
 * gpiod_configure_flags - helper function to configure a given GPIO
 * @desc:	gpio whose value will be assigned
 * @con_id:	function within the GPIO consumer
 * @dflags:	gpiod_flags - optional GPIO initialization flags
 *
 * Return 0 on success, -ENOENT if no GPIO has been assigned to the
 * requested function and/or index, or another IS_ERR() code if an error
 * occurred while trying to acquire the GPIO.
 */
static int gpiod_configure_flags(struct gpio_desc *desc, const char *con_id,
2503
				 enum gpiod_flags dflags)
B
Benoit Parrot 已提交
2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522
{
	int status;

	/* No particular flag request, return here... */
	if (!(dflags & GPIOD_FLAGS_BIT_DIR_SET)) {
		pr_debug("no flags found for %s\n", con_id);
		return 0;
	}

	/* Process flags */
	if (dflags & GPIOD_FLAGS_BIT_DIR_OUT)
		status = gpiod_direction_output(desc,
					      dflags & GPIOD_FLAGS_BIT_DIR_VAL);
	else
		status = gpiod_direction_input(desc);

	return status;
}

2523 2524
/**
 * gpiod_get_index - obtain a GPIO from a multi-index GPIO function
2525
 * @dev:	GPIO consumer, can be NULL for system-global GPIOs
2526 2527
 * @con_id:	function within the GPIO consumer
 * @idx:	index of the GPIO to obtain in the consumer
2528
 * @flags:	optional GPIO initialization flags
2529 2530 2531 2532
 *
 * This variant of gpiod_get() allows to access GPIOs other than the first
 * defined one for functions that define several GPIOs.
 *
2533 2534
 * Return a valid GPIO descriptor, -ENOENT if no GPIO has been assigned to the
 * requested function and/or index, or another IS_ERR() code if an error
2535
 * occurred while trying to acquire the GPIO.
2536
 */
2537
struct gpio_desc *__must_check gpiod_get_index(struct device *dev,
2538
					       const char *con_id,
2539 2540
					       unsigned int idx,
					       enum gpiod_flags flags)
2541
{
2542
	struct gpio_desc *desc = NULL;
2543
	int status;
2544
	enum gpio_lookup_flags lookupflags = 0;
2545 2546 2547

	dev_dbg(dev, "GPIO lookup for consumer %s\n", con_id);

2548 2549 2550 2551 2552 2553 2554 2555 2556
	if (dev) {
		/* Using device tree? */
		if (IS_ENABLED(CONFIG_OF) && dev->of_node) {
			dev_dbg(dev, "using device tree for GPIO lookup\n");
			desc = of_find_gpio(dev, con_id, idx, &lookupflags);
		} else if (ACPI_COMPANION(dev)) {
			dev_dbg(dev, "using ACPI for GPIO lookup\n");
			desc = acpi_find_gpio(dev, con_id, idx, &lookupflags);
		}
2557 2558 2559 2560 2561 2562
	}

	/*
	 * Either we are not using DT or ACPI, or their lookup did not return
	 * a result. In that case, use platform lookup as a fallback.
	 */
2563
	if (!desc || desc == ERR_PTR(-ENOENT)) {
2564
		dev_dbg(dev, "using lookup tables for GPIO lookup\n");
2565
		desc = gpiod_find(dev, con_id, idx, &lookupflags);
2566 2567 2568
	}

	if (IS_ERR(desc)) {
2569
		dev_dbg(dev, "lookup for GPIO %s failed\n", con_id);
2570 2571 2572
		return desc;
	}

2573 2574
	gpiod_parse_flags(desc, lookupflags);

2575 2576 2577 2578
	status = gpiod_request(desc, con_id);
	if (status < 0)
		return ERR_PTR(status);

2579
	status = gpiod_configure_flags(desc, con_id, flags);
2580 2581 2582 2583 2584 2585
	if (status < 0) {
		dev_dbg(dev, "setup of GPIO %s failed\n", con_id);
		gpiod_put(desc);
		return ERR_PTR(status);
	}

2586 2587
	return desc;
}
2588
EXPORT_SYMBOL_GPL(gpiod_get_index);
2589

2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608
/**
 * fwnode_get_named_gpiod - obtain a GPIO from firmware node
 * @fwnode:	handle of the firmware node
 * @propname:	name of the firmware property representing the GPIO
 *
 * This function can be used for drivers that get their configuration
 * from firmware.
 *
 * Function properly finds the corresponding GPIO using whatever is the
 * underlying firmware interface and then makes sure that the GPIO
 * descriptor is requested before it is returned to the caller.
 *
 * In case of error an ERR_PTR() is returned.
 */
struct gpio_desc *fwnode_get_named_gpiod(struct fwnode_handle *fwnode,
					 const char *propname)
{
	struct gpio_desc *desc = ERR_PTR(-ENODEV);
	bool active_low = false;
2609
	bool single_ended = false;
2610 2611 2612 2613 2614 2615 2616 2617
	int ret;

	if (!fwnode)
		return ERR_PTR(-EINVAL);

	if (is_of_node(fwnode)) {
		enum of_gpio_flags flags;

2618
		desc = of_get_named_gpiod_flags(to_of_node(fwnode), propname, 0,
2619
						&flags);
2620
		if (!IS_ERR(desc)) {
2621
			active_low = flags & OF_GPIO_ACTIVE_LOW;
2622 2623
			single_ended = flags & OF_GPIO_SINGLE_ENDED;
		}
2624 2625 2626
	} else if (is_acpi_node(fwnode)) {
		struct acpi_gpio_info info;

2627
		desc = acpi_node_get_gpiod(fwnode, propname, 0, &info);
2628
		if (!IS_ERR(desc))
2629
			active_low = info.polarity == GPIO_ACTIVE_LOW;
2630 2631 2632 2633 2634 2635 2636 2637
	}

	if (IS_ERR(desc))
		return desc;

	if (active_low)
		set_bit(FLAG_ACTIVE_LOW, &desc->flags);

2638 2639 2640 2641 2642 2643 2644
	if (single_ended) {
		if (active_low)
			set_bit(FLAG_OPEN_DRAIN, &desc->flags);
		else
			set_bit(FLAG_OPEN_SOURCE, &desc->flags);
	}

2645 2646 2647 2648
	ret = gpiod_request(desc, NULL);
	if (ret)
		return ERR_PTR(ret);

2649 2650 2651 2652
	return desc;
}
EXPORT_SYMBOL_GPL(fwnode_get_named_gpiod);

2653 2654 2655 2656 2657 2658
/**
 * gpiod_get_index_optional - obtain an optional GPIO from a multi-index GPIO
 *                            function
 * @dev: GPIO consumer, can be NULL for system-global GPIOs
 * @con_id: function within the GPIO consumer
 * @index: index of the GPIO to obtain in the consumer
2659
 * @flags: optional GPIO initialization flags
2660 2661 2662 2663 2664
 *
 * This is equivalent to gpiod_get_index(), except that when no GPIO with the
 * specified index was assigned to the requested function it will return NULL.
 * This is convenient for drivers that need to handle optional GPIOs.
 */
2665
struct gpio_desc *__must_check gpiod_get_index_optional(struct device *dev,
2666
							const char *con_id,
2667 2668
							unsigned int index,
							enum gpiod_flags flags)
2669 2670 2671
{
	struct gpio_desc *desc;

2672
	desc = gpiod_get_index(dev, con_id, index, flags);
2673 2674 2675 2676 2677 2678 2679
	if (IS_ERR(desc)) {
		if (PTR_ERR(desc) == -ENOENT)
			return NULL;
	}

	return desc;
}
2680
EXPORT_SYMBOL_GPL(gpiod_get_index_optional);
2681

B
Benoit Parrot 已提交
2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700
/**
 * gpiod_hog - Hog the specified GPIO desc given the provided flags
 * @desc:	gpio whose value will be assigned
 * @name:	gpio line name
 * @lflags:	gpio_lookup_flags - returned from of_find_gpio() or
 *		of_get_gpio_hog()
 * @dflags:	gpiod_flags - optional GPIO initialization flags
 */
int gpiod_hog(struct gpio_desc *desc, const char *name,
	      unsigned long lflags, enum gpiod_flags dflags)
{
	struct gpio_chip *chip;
	struct gpio_desc *local_desc;
	int hwnum;
	int status;

	chip = gpiod_to_chip(desc);
	hwnum = gpio_chip_hwgpio(desc);

2701 2702
	gpiod_parse_flags(desc, lflags);

B
Benoit Parrot 已提交
2703 2704
	local_desc = gpiochip_request_own_desc(chip, hwnum, name);
	if (IS_ERR(local_desc)) {
2705 2706 2707 2708
		status = PTR_ERR(local_desc);
		pr_err("requesting hog GPIO %s (chip %s, offset %d) failed, %d\n",
		       name, chip->label, hwnum, status);
		return status;
B
Benoit Parrot 已提交
2709 2710
	}

2711
	status = gpiod_configure_flags(desc, name, dflags);
B
Benoit Parrot 已提交
2712
	if (status < 0) {
2713 2714
		pr_err("setup of hog GPIO %s (chip %s, offset %d) failed, %d\n",
		       name, chip->label, hwnum, status);
B
Benoit Parrot 已提交
2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741
		gpiochip_free_own_desc(desc);
		return status;
	}

	/* Mark GPIO as hogged so it can be identified and removed later */
	set_bit(FLAG_IS_HOGGED, &desc->flags);

	pr_info("GPIO line %d (%s) hogged as %s%s\n",
		desc_to_gpio(desc), name,
		(dflags&GPIOD_FLAGS_BIT_DIR_OUT) ? "output" : "input",
		(dflags&GPIOD_FLAGS_BIT_DIR_OUT) ?
		  (dflags&GPIOD_FLAGS_BIT_DIR_VAL) ? "/high" : "/low":"");

	return 0;
}

/**
 * gpiochip_free_hogs - Scan gpio-controller chip and release GPIO hog
 * @chip:	gpio chip to act on
 *
 * This is only used by of_gpiochip_remove to free hogged gpios
 */
static void gpiochip_free_hogs(struct gpio_chip *chip)
{
	int id;

	for (id = 0; id < chip->ngpio; id++) {
2742 2743
		if (test_bit(FLAG_IS_HOGGED, &chip->gpiodev->descs[id].flags))
			gpiochip_free_own_desc(&chip->gpiodev->descs[id]);
B
Benoit Parrot 已提交
2744 2745 2746
	}
}

2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812
/**
 * gpiod_get_array - obtain multiple GPIOs from a multi-index GPIO function
 * @dev:	GPIO consumer, can be NULL for system-global GPIOs
 * @con_id:	function within the GPIO consumer
 * @flags:	optional GPIO initialization flags
 *
 * This function acquires all the GPIOs defined under a given function.
 *
 * Return a struct gpio_descs containing an array of descriptors, -ENOENT if
 * no GPIO has been assigned to the requested function, or another IS_ERR()
 * code if an error occurred while trying to acquire the GPIOs.
 */
struct gpio_descs *__must_check gpiod_get_array(struct device *dev,
						const char *con_id,
						enum gpiod_flags flags)
{
	struct gpio_desc *desc;
	struct gpio_descs *descs;
	int count;

	count = gpiod_count(dev, con_id);
	if (count < 0)
		return ERR_PTR(count);

	descs = kzalloc(sizeof(*descs) + sizeof(descs->desc[0]) * count,
			GFP_KERNEL);
	if (!descs)
		return ERR_PTR(-ENOMEM);

	for (descs->ndescs = 0; descs->ndescs < count; ) {
		desc = gpiod_get_index(dev, con_id, descs->ndescs, flags);
		if (IS_ERR(desc)) {
			gpiod_put_array(descs);
			return ERR_CAST(desc);
		}
		descs->desc[descs->ndescs] = desc;
		descs->ndescs++;
	}
	return descs;
}
EXPORT_SYMBOL_GPL(gpiod_get_array);

/**
 * gpiod_get_array_optional - obtain multiple GPIOs from a multi-index GPIO
 *                            function
 * @dev:	GPIO consumer, can be NULL for system-global GPIOs
 * @con_id:	function within the GPIO consumer
 * @flags:	optional GPIO initialization flags
 *
 * This is equivalent to gpiod_get_array(), except that when no GPIO was
 * assigned to the requested function it will return NULL.
 */
struct gpio_descs *__must_check gpiod_get_array_optional(struct device *dev,
							const char *con_id,
							enum gpiod_flags flags)
{
	struct gpio_descs *descs;

	descs = gpiod_get_array(dev, con_id, flags);
	if (IS_ERR(descs) && (PTR_ERR(descs) == -ENOENT))
		return NULL;

	return descs;
}
EXPORT_SYMBOL_GPL(gpiod_get_array_optional);

2813 2814 2815 2816 2817 2818 2819 2820 2821
/**
 * gpiod_put - dispose of a GPIO descriptor
 * @desc:	GPIO descriptor to dispose of
 *
 * No descriptor can be used after gpiod_put() has been called on it.
 */
void gpiod_put(struct gpio_desc *desc)
{
	gpiod_free(desc);
2822
}
2823
EXPORT_SYMBOL_GPL(gpiod_put);
2824

2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839
/**
 * gpiod_put_array - dispose of multiple GPIO descriptors
 * @descs:	struct gpio_descs containing an array of descriptors
 */
void gpiod_put_array(struct gpio_descs *descs)
{
	unsigned int i;

	for (i = 0; i < descs->ndescs; i++)
		gpiod_put(descs->desc[i]);

	kfree(descs);
}
EXPORT_SYMBOL_GPL(gpiod_put_array);

2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859
static int __init gpiolib_dev_init(void)
{
	int ret;

	/* Register GPIO sysfs bus */
	ret  = bus_register(&gpio_bus_type);
	if (ret < 0) {
		pr_err("gpiolib: could not register GPIO bus type\n");
		return ret;
	}

	ret = alloc_chrdev_region(&gpio_devt, 0, GPIO_DEV_MAX, "gpiochip");
	if (ret < 0) {
		pr_err("gpiolib: failed to allocate char dev region\n");
		bus_unregister(&gpio_bus_type);
	}
	return ret;
}
core_initcall(gpiolib_dev_init);

2860 2861
#ifdef CONFIG_DEBUG_FS

2862
static void gpiolib_dbg_show(struct seq_file *s, struct gpio_device *gdev)
2863 2864
{
	unsigned		i;
2865 2866 2867
	struct gpio_chip	*chip = gdev->chip;
	unsigned		gpio = gdev->base;
	struct gpio_desc	*gdesc = &gdev->descs[0];
2868
	int			is_out;
2869
	int			is_irq;
2870

2871
	for (i = 0; i < gdev->ngpio; i++, gpio++, gdesc++) {
2872 2873 2874 2875 2876
		if (!test_bit(FLAG_REQUESTED, &gdesc->flags)) {
			if (gdesc->name) {
				seq_printf(s, " gpio-%-3d (%-20.20s)\n",
					   gpio, gdesc->name);
			}
2877
			continue;
2878
		}
2879

2880
		gpiod_get_direction(gdesc);
2881
		is_out = test_bit(FLAG_IS_OUT, &gdesc->flags);
2882
		is_irq = test_bit(FLAG_USED_AS_IRQ, &gdesc->flags);
2883 2884
		seq_printf(s, " gpio-%-3d (%-20.20s|%-20.20s) %s %s %s",
			gpio, gdesc->name ? gdesc->name : "", gdesc->label,
2885 2886 2887
			is_out ? "out" : "in ",
			chip->get
				? (chip->get(chip, i) ? "hi" : "lo")
2888 2889
				: "?  ",
			is_irq ? "IRQ" : "   ");
2890 2891 2892 2893
		seq_printf(s, "\n");
	}
}

2894
static void *gpiolib_seq_start(struct seq_file *s, loff_t *pos)
2895
{
2896
	unsigned long flags;
2897
	struct gpio_device *gdev = NULL;
2898
	loff_t index = *pos;
2899

2900
	s->private = "";
2901

2902
	spin_lock_irqsave(&gpio_lock, flags);
2903
	list_for_each_entry(gdev, &gpio_devices, list)
2904 2905
		if (index-- == 0) {
			spin_unlock_irqrestore(&gpio_lock, flags);
2906
			return gdev;
2907
		}
2908
	spin_unlock_irqrestore(&gpio_lock, flags);
2909

2910
	return NULL;
2911 2912 2913 2914
}

static void *gpiolib_seq_next(struct seq_file *s, void *v, loff_t *pos)
{
2915
	unsigned long flags;
2916
	struct gpio_device *gdev = v;
2917 2918
	void *ret = NULL;

2919
	spin_lock_irqsave(&gpio_lock, flags);
2920
	if (list_is_last(&gdev->list, &gpio_devices))
2921 2922
		ret = NULL;
	else
2923
		ret = list_entry(gdev->list.next, struct gpio_device, list);
2924
	spin_unlock_irqrestore(&gpio_lock, flags);
2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937

	s->private = "\n";
	++*pos;

	return ret;
}

static void gpiolib_seq_stop(struct seq_file *s, void *v)
{
}

static int gpiolib_seq_show(struct seq_file *s, void *v)
{
2938 2939 2940 2941 2942 2943 2944 2945 2946
	struct gpio_device *gdev = v;
	struct gpio_chip *chip = gdev->chip;
	struct device *parent;

	if (!chip) {
		seq_printf(s, "%s%s: (dangling chip)", (char *)s->private,
			   dev_name(&gdev->dev));
		return 0;
	}
2947

2948 2949
	seq_printf(s, "%s%s: GPIOs %d-%d", (char *)s->private,
		   dev_name(&gdev->dev),
2950
		   gdev->base, gdev->base + gdev->ngpio - 1);
2951 2952 2953 2954 2955
	parent = chip->parent;
	if (parent)
		seq_printf(s, ", parent: %s/%s",
			   parent->bus ? parent->bus->name : "no-bus",
			   dev_name(parent));
2956 2957 2958 2959 2960 2961 2962 2963 2964
	if (chip->label)
		seq_printf(s, ", %s", chip->label);
	if (chip->can_sleep)
		seq_printf(s, ", can sleep");
	seq_printf(s, ":\n");

	if (chip->dbg_show)
		chip->dbg_show(s, chip);
	else
2965
		gpiolib_dbg_show(s, gdev);
2966

2967 2968 2969
	return 0;
}

2970 2971 2972 2973 2974 2975 2976
static const struct seq_operations gpiolib_seq_ops = {
	.start = gpiolib_seq_start,
	.next = gpiolib_seq_next,
	.stop = gpiolib_seq_stop,
	.show = gpiolib_seq_show,
};

2977 2978
static int gpiolib_open(struct inode *inode, struct file *file)
{
2979
	return seq_open(file, &gpiolib_seq_ops);
2980 2981
}

2982
static const struct file_operations gpiolib_operations = {
2983
	.owner		= THIS_MODULE,
2984 2985 2986
	.open		= gpiolib_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
2987
	.release	= seq_release,
2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999
};

static int __init gpiolib_debugfs_init(void)
{
	/* /sys/kernel/debug/gpio */
	(void) debugfs_create_file("gpio", S_IFREG | S_IRUGO,
				NULL, NULL, &gpiolib_operations);
	return 0;
}
subsys_initcall(gpiolib_debugfs_init);

#endif	/* DEBUG_FS */