gpiolib.c 57.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>
David Brownell's avatar
David Brownell committed
7 8 9 10 11
#include <linux/device.h>
#include <linux/err.h>
#include <linux/debugfs.h>
#include <linux/seq_file.h>
#include <linux/gpio.h>
12
#include <linux/of_gpio.h>
13
#include <linux/idr.h>
14
#include <linux/slab.h>
15
#include <linux/acpi.h>
16
#include <linux/gpio/driver.h>
17
#include <linux/gpio/machine.h>
18

19 20
#include "gpiolib.h"

21 22
#define CREATE_TRACE_POINTS
#include <trace/events/gpio.h>
23

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


/* When debugging, extend minimal trust to callers and platform code.
 * Also emit diagnostic messages that may help initial bringup, when
 * board setup or driver bugs are most common.
 *
 * Otherwise, minimize overhead in what may be bitbanging codepaths.
 */
#ifdef	DEBUG
#define	extra_checks	1
#else
#define	extra_checks	0
#endif

/* gpio_lock prevents conflicts during gpio_desc[] table updates.
 * While any GPIO is requested, its gpio_chip is not removable;
 * each GPIO's "requested" flag serves as a lock and refcount.
 */
48
DEFINE_SPINLOCK(gpio_lock);
49

50 51
#define GPIO_OFFSET_VALID(chip, offset) (offset >= 0 && offset < chip->ngpio)

52 53
static DEFINE_MUTEX(gpio_lookup_lock);
static LIST_HEAD(gpio_lookup_list);
54
LIST_HEAD(gpio_chips);
55

56 57 58 59 60
static inline void desc_set_label(struct gpio_desc *d, const char *label)
{
	d->label = label;
}

61 62 63
/**
 * Convert a GPIO number to its descriptor
 */
64
struct gpio_desc *gpio_to_desc(unsigned gpio)
65
{
66 67 68 69 70 71 72 73 74 75 76 77 78 79
	struct gpio_chip *chip;
	unsigned long flags;

	spin_lock_irqsave(&gpio_lock, flags);

	list_for_each_entry(chip, &gpio_chips, list) {
		if (chip->base <= gpio && chip->base + chip->ngpio > gpio) {
			spin_unlock_irqrestore(&gpio_lock, flags);
			return &chip->desc[gpio - chip->base];
		}
	}

	spin_unlock_irqrestore(&gpio_lock, flags);

80 81 82
	if (!gpio_is_valid(gpio))
		WARN(1, "invalid GPIO %d\n", gpio);

83
	return NULL;
84
}
85
EXPORT_SYMBOL_GPL(gpio_to_desc);
86

87
/**
88
 * Get the GPIO descriptor corresponding to the given hw number for this chip.
89
 */
90 91
struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
				    u16 hwnum)
92
{
93
	if (hwnum >= chip->ngpio)
94
		return ERR_PTR(-EINVAL);
95

96
	return &chip->desc[hwnum];
97
}
98 99 100 101 102 103

/**
 * 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
 */
104
int desc_to_gpio(const struct gpio_desc *desc)
105
{
106
	return desc->chip->base + (desc - &desc->chip->desc[0]);
107
}
108
EXPORT_SYMBOL_GPL(desc_to_gpio);
109 110


111 112 113 114 115
/**
 * 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)
116
{
117
	return desc ? desc->chip : NULL;
118
}
119
EXPORT_SYMBOL_GPL(gpiod_to_chip);
120

121 122 123
/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
static int gpiochip_find_base(int ngpio)
{
124 125
	struct gpio_chip *chip;
	int base = ARCH_NR_GPIOS - ngpio;
126

127 128 129 130 131 132 133
	list_for_each_entry_reverse(chip, &gpio_chips, list) {
		/* found a free space? */
		if (chip->base + chip->ngpio <= base)
			break;
		else
			/* nope, check the space right before the chip */
			base = chip->base - ngpio;
134 135
	}

136
	if (gpio_is_valid(base)) {
137
		pr_debug("%s: found new base at %d\n", __func__, base);
138 139 140 141
		return base;
	} else {
		pr_err("%s: cannot find free range\n", __func__);
		return -ENOSPC;
Anton Vorontsov's avatar
Anton Vorontsov committed
142 143 144
	}
}

145 146 147 148 149 150 151 152
/**
 * 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.
 */
153
int gpiod_get_direction(struct gpio_desc *desc)
154 155
{
	struct gpio_chip	*chip;
156
	unsigned		offset;
157 158
	int			status = -EINVAL;

159 160
	chip = gpiod_to_chip(desc);
	offset = gpio_chip_hwgpio(desc);
161 162 163 164

	if (!chip->get_direction)
		return status;

165
	status = chip->get_direction(chip, offset);
166 167 168
	if (status > 0) {
		/* GPIOF_DIR_IN, or other positive */
		status = 1;
169
		clear_bit(FLAG_IS_OUT, &desc->flags);
170 171 172
	}
	if (status == 0) {
		/* GPIOF_DIR_OUT */
173
		set_bit(FLAG_IS_OUT, &desc->flags);
174 175 176
	}
	return status;
}
177
EXPORT_SYMBOL_GPL(gpiod_get_direction);
178

179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
/*
 * Add a new chip to the global chips list, keeping the list of chips sorted
 * by base order.
 *
 * Return -EBUSY if the new chip overlaps with some other chip's integer
 * space.
 */
static int gpiochip_add_to_list(struct gpio_chip *chip)
{
	struct list_head *pos = &gpio_chips;
	struct gpio_chip *_chip;
	int err = 0;

	/* find where to insert our chip */
	list_for_each(pos, &gpio_chips) {
		_chip = list_entry(pos, struct gpio_chip, list);
		/* shall we insert before _chip? */
		if (_chip->base >= chip->base + chip->ngpio)
			break;
	}

	/* are we stepping on the chip right before? */
	if (pos != &gpio_chips && pos->prev != &gpio_chips) {
		_chip = list_entry(pos->prev, struct gpio_chip, list);
		if (_chip->base + _chip->ngpio > chip->base) {
			dev_err(chip->dev,
			       "GPIO integer space overlap, cannot add chip\n");
			err = -EBUSY;
		}
	}

	if (!err)
		list_add_tail(&chip->list, pos);

	return err;
}

216 217 218
/**
 * gpiochip_add() - register a gpio_chip
 * @chip: the chip to register, with chip->base initialized
219
 * Context: potentially before irqs will work
220 221 222 223
 *
 * 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.
224
 *
David Brownell's avatar
David Brownell committed
225 226 227 228 229
 * When gpiochip_add() is called very early during boot, so that GPIOs
 * can be freely used, the chip->dev device must be registered before
 * the gpio framework's arch_initcall().  Otherwise sysfs initialization
 * for GPIOs will fail rudely.
 *
230 231
 * If chip->base is negative, this requests dynamic assignment of
 * a range of valid GPIOs.
232 233 234 235 236 237
 */
int gpiochip_add(struct gpio_chip *chip)
{
	unsigned long	flags;
	int		status = 0;
	unsigned	id;
238
	int		base = chip->base;
239
	struct gpio_desc *descs;
240

241 242 243
	descs = kcalloc(chip->ngpio, sizeof(descs[0]), GFP_KERNEL);
	if (!descs)
		return -ENOMEM;
244 245 246

	spin_lock_irqsave(&gpio_lock, flags);

247 248 249 250
	if (base < 0) {
		base = gpiochip_find_base(chip->ngpio);
		if (base < 0) {
			status = base;
251 252
			spin_unlock_irqrestore(&gpio_lock, flags);
			goto err_free_descs;
253 254 255 256
		}
		chip->base = base;
	}

257
	status = gpiochip_add_to_list(chip);
258 259 260 261
	if (status) {
		spin_unlock_irqrestore(&gpio_lock, flags);
		goto err_free_descs;
	}
262

263 264 265 266 267 268 269 270 271 272 273 274
	for (id = 0; id < chip->ngpio; id++) {
		struct gpio_desc *desc = &descs[id];

		desc->chip = chip;

		/* REVISIT: most hardware initializes GPIOs as inputs (often
		 * with pullups enabled) so power usage is minimized. Linux
		 * code should set the gpio direction first thing; but until
		 * it does, and in case chip->get_direction is not set, we may
		 * expose the wrong direction in sysfs.
		 */
		desc->flags = !chip->direction_input ? (1 << FLAG_IS_OUT) : 0;
275 276
	}

277 278
	chip->desc = descs;

279 280
	spin_unlock_irqrestore(&gpio_lock, flags);

281 282 283 284
#ifdef CONFIG_PINCTRL
	INIT_LIST_HEAD(&chip->pin_ranges);
#endif

285
	of_gpiochip_add(chip);
286
	acpi_gpiochip_add(chip);
287

288
	status = gpiochip_export(chip);
289 290
	if (status)
		goto err_remove_chip;
291

292
	pr_debug("%s: registered GPIOs %d to %d on device: %s\n", __func__,
293 294 295
		chip->base, chip->base + chip->ngpio - 1,
		chip->label ? : "generic");

296
	return 0;
297

298 299 300 301 302
err_remove_chip:
	acpi_gpiochip_remove(chip);
	of_gpiochip_remove(chip);
	spin_lock_irqsave(&gpio_lock, flags);
	list_del(&chip->list);
303
	spin_unlock_irqrestore(&gpio_lock, flags);
304
	chip->desc = NULL;
305
err_free_descs:
306 307
	kfree(descs);

308
	/* failures here can mean systems won't boot... */
309
	pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
310 311
		chip->base, chip->base + chip->ngpio - 1,
		chip->label ? : "generic");
312 313 314 315
	return status;
}
EXPORT_SYMBOL_GPL(gpiochip_add);

316 317 318
/* Forward-declaration */
static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip);

319 320 321 322 323 324
/**
 * gpiochip_remove() - unregister a gpio_chip
 * @chip: the chip to unregister
 *
 * A gpio_chip with any GPIOs still requested may not be removed.
 */
325
void gpiochip_remove(struct gpio_chip *chip)
326 327 328 329
{
	unsigned long	flags;
	unsigned	id;

330 331
	gpiochip_irqchip_remove(chip);

332
	acpi_gpiochip_remove(chip);
333
	gpiochip_remove_pin_ranges(chip);
334 335
	of_gpiochip_remove(chip);

336
	spin_lock_irqsave(&gpio_lock, flags);
337
	for (id = 0; id < chip->ngpio; id++) {
338 339
		if (test_bit(FLAG_REQUESTED, &chip->desc[id].flags))
			dev_crit(chip->dev, "REMOVING GPIOCHIP WITH GPIOS STILL REQUESTED\n");
340
	}
341 342
	for (id = 0; id < chip->ngpio; id++)
		chip->desc[id].chip = NULL;
343

344
	list_del(&chip->list);
345
	spin_unlock_irqrestore(&gpio_lock, flags);
346
	gpiochip_unexport(chip);
347 348 349

	kfree(chip->desc);
	chip->desc = NULL;
350 351 352
}
EXPORT_SYMBOL_GPL(gpiochip_remove);

353 354 355 356 357 358 359 360 361 362 363
/**
 * 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.
 */
364
struct gpio_chip *gpiochip_find(void *data,
365
				int (*match)(struct gpio_chip *chip,
366
					     void *data))
367
{
368
	struct gpio_chip *chip;
369 370 371
	unsigned long flags;

	spin_lock_irqsave(&gpio_lock, flags);
372 373
	list_for_each_entry(chip, &gpio_chips, list)
		if (match(chip, data))
374
			break;
375 376 377 378

	/* No match? */
	if (&chip->list == &gpio_chips)
		chip = NULL;
379 380 381 382
	spin_unlock_irqrestore(&gpio_lock, flags);

	return chip;
}
Jean Delvare's avatar
Jean Delvare committed
383
EXPORT_SYMBOL_GPL(gpiochip_find);
384

385 386 387 388 389 390 391 392 393 394 395 396
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);
}

397 398 399 400 401 402 403
#ifdef CONFIG_GPIOLIB_IRQCHIP

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

/**
404 405 406
 * 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
407 408 409
 * @parent_irq: the irq number corresponding to the parent IRQ for this
 * chained irqchip
 * @parent_handler: the parent interrupt handler for the accumulated IRQ
410 411
 * coming out of the gpiochip. If the interrupt is nested rather than
 * cascaded, pass NULL in this handler argument
412 413 414 415 416 417
 */
void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
				  struct irq_chip *irqchip,
				  int parent_irq,
				  irq_flow_handler_t parent_handler)
{
418 419 420 421 422
	unsigned int offset;

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

426 427 428 429 430 431 432 433 434 435 436 437
	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.
		 */
		irq_set_handler_data(parent_irq, gpiochip);
438
		irq_set_chained_handler(parent_irq, parent_handler);
439
	}
440 441 442 443 444

	/* 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);
445 446 447
}
EXPORT_SYMBOL_GPL(gpiochip_set_chained_irqchip);

448 449 450 451 452 453
/*
 * This lock class tells lockdep that GPIO irqs are in a different
 * category than their parents, so it won't report false recursion.
 */
static struct lock_class_key gpiochip_irq_lock_class;

454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
/**
 * 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);
470
	irq_set_lockdep_class(irq, &gpiochip_irq_lock_class);
471
	irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler);
472
	/* Chips that can sleep need nested thread handlers */
473
	if (chip->can_sleep && !chip->irq_not_threaded)
474
		irq_set_nested_thread(irq, 1);
475 476 477 478 479
#ifdef CONFIG_ARM
	set_irq_flags(irq, IRQF_VALID);
#else
	irq_set_noprobe(irq);
#endif
480 481 482 483 484 485
	/*
	 * 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);
486 487 488 489

	return 0;
}

Linus Walleij's avatar
Linus Walleij committed
490 491
static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
{
492 493
	struct gpio_chip *chip = d->host_data;

Linus Walleij's avatar
Linus Walleij committed
494 495 496
#ifdef CONFIG_ARM
	set_irq_flags(irq, 0);
#endif
497 498
	if (chip->can_sleep)
		irq_set_nested_thread(irq, 0);
Linus Walleij's avatar
Linus Walleij committed
499 500 501 502
	irq_set_chip_and_handler(irq, NULL, NULL);
	irq_set_chip_data(irq, NULL);
}

503 504
static const struct irq_domain_ops gpiochip_domain_ops = {
	.map	= gpiochip_irq_map,
Linus Walleij's avatar
Linus Walleij committed
505
	.unmap	= gpiochip_irq_unmap,
506 507 508 509 510 511 512 513
	/* 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);

514
	if (gpiochip_lock_as_irq(chip, d->hwirq)) {
515 516 517 518 519 520 521 522 523 524 525 526
		chip_err(chip,
			"unable to lock HW IRQ %lu for IRQ\n",
			d->hwirq);
		return -EINVAL;
	}
	return 0;
}

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

527
	gpiochip_unlock_as_irq(chip, d->hwirq);
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
}

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

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

545 546
	acpi_gpiochip_free_interrupts(gpiochip);

Linus Walleij's avatar
Linus Walleij committed
547 548 549
	/* Remove all IRQ mappings and delete the domain */
	if (gpiochip->irqdomain) {
		for (offset = 0; offset < gpiochip->ngpio; offset++)
550 551
			irq_dispose_mapping(
				irq_find_mapping(gpiochip->irqdomain, offset));
552
		irq_domain_remove(gpiochip->irqdomain);
Linus Walleij's avatar
Linus Walleij committed
553
	}
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568

	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)
569 570
 * @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.
571 572 573 574 575 576 577 578 579 580 581
 *
 * 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
 * need to use container_of() to get their local state containers back
 * from the gpiochip passed as chip data. An irqdomain will be stored
 * in the gpiochip that shall be used by the driver to handle IRQ number
 * translation. The gpiochip will need to be initialized and registered
 * before calling this function.
 *
Linus Walleij's avatar
Linus Walleij committed
582 583
 * This function will handle two cell:ed simple IRQs and assumes all
 * the pins on the gpiochip can generate a unique IRQ. Everything else
584 585 586 587 588 589 590 591 592 593
 * need to be open coded.
 */
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 device_node *of_node;
	unsigned int offset;
Linus Walleij's avatar
Linus Walleij committed
594
	unsigned irq_base = 0;
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630

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

	if (!gpiochip->dev) {
		pr_err("missing gpiochip .dev parent pointer\n");
		return -EINVAL;
	}
	of_node = gpiochip->dev->of_node;
#ifdef CONFIG_OF_GPIO
	/*
	 * If the gpiochip has an assigned OF node this takes precendence
	 * FIXME: get rid of this and use gpiochip->dev->of_node everywhere
	 */
	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;
	gpiochip->irqdomain = irq_domain_add_simple(of_node,
					gpiochip->ngpio, first_irq,
					&gpiochip_domain_ops, gpiochip);
	if (!gpiochip->irqdomain) {
		gpiochip->irqchip = NULL;
		return -EINVAL;
	}
	irqchip->irq_request_resources = gpiochip_irq_reqres;
	irqchip->irq_release_resources = gpiochip_irq_relres;

	/*
	 * Prepare the mapping since the irqchip shall be orthogonal to
	 * any gpiochip calls. If the first_irq was zero, this is
	 * necessary to allocate descriptors for all IRQs.
	 */
Linus Walleij's avatar
Linus Walleij committed
631 632 633 634 635 636 637 638 639
	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;
	}
640

641 642
	acpi_gpiochip_request_interrupts(gpiochip);

643 644 645 646 647 648 649 650 651 652
	return 0;
}
EXPORT_SYMBOL_GPL(gpiochip_irqchip_add);

#else /* CONFIG_GPIOLIB_IRQCHIP */

static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip) {}

#endif /* CONFIG_GPIOLIB_IRQCHIP */

653
#ifdef CONFIG_PINCTRL
654

655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
/**
 * gpiochip_add_pingroup_range() - add a range for GPIO <-> pin mapping
 * @chip: the gpiochip to add the range for
 * @pinctrl: the dev_name() of the pin controller to map to
 * @gpio_offset: the start offset in the current gpio_chip number space
 * @pin_group: name of the pin group inside the pin controller
 */
int gpiochip_add_pingroup_range(struct gpio_chip *chip,
			struct pinctrl_dev *pctldev,
			unsigned int gpio_offset, const char *pin_group)
{
	struct gpio_pin_range *pin_range;
	int ret;

	pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
	if (!pin_range) {
671
		chip_err(chip, "failed to allocate pin ranges\n");
672 673 674 675 676 677 678 679 680 681 682 683 684
		return -ENOMEM;
	}

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

	ret = pinctrl_get_group_pins(pctldev, pin_group,
					&pin_range->range.pins,
					&pin_range->range.npins);
685 686
	if (ret < 0) {
		kfree(pin_range);
687
		return ret;
688
	}
689 690 691

	pinctrl_add_gpio_range(pctldev, &pin_range->range);

692 693
	chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
		 gpio_offset, gpio_offset + pin_range->range.npins - 1,
694 695 696 697 698 699 700 701
		 pinctrl_dev_get_devname(pctldev), pin_group);

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

	return 0;
}
EXPORT_SYMBOL_GPL(gpiochip_add_pingroup_range);

702 703 704 705
/**
 * 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
706 707
 * @gpio_offset: the start offset in the current gpio_chip number space
 * @pin_offset: the start offset in the pin controller number space
708 709 710
 * @npins: the number of pins from the offset of each pin space (GPIO and
 *	pin controller) to accumulate in this range
 */
711
int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
712
			   unsigned int gpio_offset, unsigned int pin_offset,
713
			   unsigned int npins)
714 715
{
	struct gpio_pin_range *pin_range;
716
	int ret;
717

718
	pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
719
	if (!pin_range) {
720
		chip_err(chip, "failed to allocate pin ranges\n");
721
		return -ENOMEM;
722 723
	}

724
	/* Use local offset as range ID */
725
	pin_range->range.id = gpio_offset;
726
	pin_range->range.gc = chip;
727
	pin_range->range.name = chip->label;
728 729
	pin_range->range.base = chip->base + gpio_offset;
	pin_range->range.pin_base = pin_offset;
730
	pin_range->range.npins = npins;
Linus Walleij's avatar
Linus Walleij committed
731
	pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
732
			&pin_range->range);
733
	if (IS_ERR(pin_range->pctldev)) {
734
		ret = PTR_ERR(pin_range->pctldev);
735
		chip_err(chip, "could not create pin range\n");
736
		kfree(pin_range);
737
		return ret;
738
	}
739 740
	chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
		 gpio_offset, gpio_offset + npins - 1,
741 742
		 pinctl_name,
		 pin_offset, pin_offset + npins - 1);
743 744

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

	return 0;
747
}
748
EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
749

750 751 752 753
/**
 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
 * @chip: the chip to remove all the mappings for
 */
754 755 756 757 758 759 760 761
void gpiochip_remove_pin_ranges(struct gpio_chip *chip)
{
	struct gpio_pin_range *pin_range, *tmp;

	list_for_each_entry_safe(pin_range, tmp, &chip->pin_ranges, node) {
		list_del(&pin_range->node);
		pinctrl_remove_gpio_range(pin_range->pctldev,
				&pin_range->range);
762
		kfree(pin_range);
763 764
	}
}
765 766 767
EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);

#endif /* CONFIG_PINCTRL */
768

769 770 771 772
/* 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.
 */
773
static int __gpiod_request(struct gpio_desc *desc, const char *label)
774
{
775 776
	struct gpio_chip	*chip = desc->chip;
	int			status;
777 778
	unsigned long		flags;

779 780
	spin_lock_irqsave(&gpio_lock, flags);

781
	/* NOTE:  gpio_request() can be called in early boot,
David Brownell's avatar
David Brownell committed
782
	 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
783 784 785 786 787
	 */

	if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
		desc_set_label(desc, label ? : "?");
		status = 0;
788
	} else {
789
		status = -EBUSY;
790
		goto done;
David Brownell's avatar
David Brownell committed
791 792 793 794 795
	}

	if (chip->request) {
		/* chip->request may sleep */
		spin_unlock_irqrestore(&gpio_lock, flags);
796
		status = chip->request(chip, gpio_chip_hwgpio(desc));
David Brownell's avatar
David Brownell committed
797 798 799 800 801
		spin_lock_irqsave(&gpio_lock, flags);

		if (status < 0) {
			desc_set_label(desc, NULL);
			clear_bit(FLAG_REQUESTED, &desc->flags);
802
			goto done;
David Brownell's avatar
David Brownell committed
803
		}
804
	}
805 806 807
	if (chip->get_direction) {
		/* chip->get_direction may sleep */
		spin_unlock_irqrestore(&gpio_lock, flags);
808
		gpiod_get_direction(desc);
809 810
		spin_lock_irqsave(&gpio_lock, flags);
	}
811 812 813 814 815
done:
	spin_unlock_irqrestore(&gpio_lock, flags);
	return status;
}

816
int gpiod_request(struct gpio_desc *desc, const char *label)
817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
{
	int status = -EPROBE_DEFER;
	struct gpio_chip *chip;

	if (!desc) {
		pr_warn("%s: invalid GPIO\n", __func__);
		return -EINVAL;
	}

	chip = desc->chip;
	if (!chip)
		goto done;

	if (try_module_get(chip->owner)) {
		status = __gpiod_request(desc, label);
		if (status < 0)
			module_put(chip->owner);
	}

836 837
done:
	if (status)
838
		gpiod_dbg(desc, "%s: status %d\n", __func__, status);
839

840 841
	return status;
}
842

843
static bool __gpiod_free(struct gpio_desc *desc)
844
{
845
	bool			ret = false;
846
	unsigned long		flags;
David Brownell's avatar
David Brownell committed
847
	struct gpio_chip	*chip;
848

849 850
	might_sleep();

851
	gpiod_unexport(desc);
David Brownell's avatar
David Brownell committed
852

853 854
	spin_lock_irqsave(&gpio_lock, flags);

David Brownell's avatar
David Brownell committed
855 856 857 858
	chip = desc->chip;
	if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
		if (chip->free) {
			spin_unlock_irqrestore(&gpio_lock, flags);
859
			might_sleep_if(chip->can_sleep);
860
			chip->free(chip, gpio_chip_hwgpio(desc));
David Brownell's avatar
David Brownell committed
861 862
			spin_lock_irqsave(&gpio_lock, flags);
		}
863
		desc_set_label(desc, NULL);
864
		clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
David Brownell's avatar
David Brownell committed
865
		clear_bit(FLAG_REQUESTED, &desc->flags);
866
		clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
867
		clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
868 869
		ret = true;
	}
870 871

	spin_unlock_irqrestore(&gpio_lock, flags);
872 873 874
	return ret;
}

875
void gpiod_free(struct gpio_desc *desc)
876 877 878 879 880
{
	if (desc && __gpiod_free(desc))
		module_put(desc->chip->owner);
	else
		WARN_ON(extra_checks);
881
}
882

883 884 885 886 887 888
/**
 * 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.
889 890
 * The string returned is the label passed to gpio_request(); if none has been
 * passed it is a meaningless, non-NULL constant.
891 892 893 894 895 896 897
 *
 * 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)
{
898
	struct gpio_desc *desc;
899

900
	if (!GPIO_OFFSET_VALID(chip, offset))
901
		return NULL;
902 903 904

	desc = &chip->desc[offset];

905
	if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
906
		return NULL;
907
	return desc->label;
908 909 910
}
EXPORT_SYMBOL_GPL(gpiochip_is_requested);

911 912 913 914 915 916 917 918 919 920 921
/**
 * 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).
 */
922 923
struct gpio_desc *gpiochip_request_own_desc(struct gpio_chip *chip, u16 hwnum,
					    const char *label)
924
{
925 926
	struct gpio_desc *desc = gpiochip_get_desc(chip, hwnum);
	int err;
927

928 929 930 931 932 933 934 935
	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);
936

937
	return desc;
938
}
939
EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
940 941 942 943 944 945 946 947 948 949 950 951 952

/**
 * 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);
}
953
EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
954 955 956 957 958 959 960 961 962 963

/* Drivers MUST set GPIO direction before making get/set calls.  In
 * 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.
 */

964 965 966 967 968 969 970 971 972 973
/**
 * 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)
974 975 976 977
{
	struct gpio_chip	*chip;
	int			status = -EINVAL;

978
	if (!desc || !desc->chip) {
979 980 981 982
		pr_warn("%s: invalid GPIO\n", __func__);
		return -EINVAL;
	}

983 984
	chip = desc->chip;
	if (!chip->get || !chip->direction_input) {
985 986
		gpiod_warn(desc,
			"%s: missing get() or direction_input() operations\n",
987
			__func__);
988 989 990
		return -EIO;
	}

991
	status = chip->direction_input(chip, gpio_chip_hwgpio(desc));
992 993
	if (status == 0)
		clear_bit(FLAG_IS_OUT, &desc->flags);
994

995
	trace_gpio_direction(desc_to_gpio(desc), 1, status);
996

997 998
	return status;
}
999
EXPORT_SYMBOL_GPL(gpiod_direction_input);
1000

1001
static int _gpiod_direction_output_raw(struct gpio_desc *desc, int value)
1002 1003 1004 1005
{
	struct gpio_chip	*chip;
	int			status = -EINVAL;

1006 1007 1008 1009 1010 1011 1012 1013
	/* 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;
	}

1014 1015
	/* Open drain pin should not be driven to 1 */
	if (value && test_bit(FLAG_OPEN_DRAIN,  &desc->flags))
1016
		return gpiod_direction_input(desc);
1017

1018 1019
	/* Open source pin should not be driven to 0 */
	if (!value && test_bit(FLAG_OPEN_SOURCE,  &desc->flags))
1020
		return gpiod_direction_input(desc);
1021

1022 1023
	chip = desc->chip;
	if (!chip->set || !chip->direction_output) {
1024 1025 1026
		gpiod_warn(desc,
		       "%s: missing set() or direction_output() operations\n",
		       __func__);
1027 1028 1029
		return -EIO;
	}

1030
	status = chip->direction_output(chip, gpio_chip_hwgpio(desc), value);
1031 1032
	if (status == 0)
		set_bit(FLAG_IS_OUT, &desc->flags);
1033 1034
	trace_gpio_value(desc_to_gpio(desc), 0, value);
	trace_gpio_direction(desc_to_gpio(desc), 0, status);
1035 1036
	return status;
}
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059

/**
 * 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)
{
	if (!desc || !desc->chip) {
		pr_warn("%s: invalid GPIO\n", __func__);
		return -EINVAL;
	}
	return _gpiod_direction_output_raw(desc, value);
}
EXPORT_SYMBOL_GPL(gpiod_direction_output_raw);

/**
1060
 * gpiod_direction_output - set the GPIO direction to output
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080
 * @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)
{
	if (!desc || !desc->chip) {
		pr_warn("%s: invalid GPIO\n", __func__);
		return -EINVAL;
	}
	if (test_bit(FLAG_ACTIVE_LOW, &desc->flags))
		value = !value;
	return _gpiod_direction_output_raw(desc, value);
}
1081
EXPORT_SYMBOL_GPL(gpiod_direction_output);
1082

1083
/**
1084
 * gpiod_set_debounce - sets @debounce time for a @gpio
1085 1086
 * @gpio: the gpio to set debounce time
 * @debounce: debounce time is microseconds
1087 1088 1089
 *
 * returns -ENOTSUPP if the controller does not support setting
 * debounce.
1090
 */
1091
int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
1092 1093 1094
{
	struct gpio_chip	*chip;