gpiolib.c 51.4 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

18 19
#include "gpiolib.h"

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

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


/* 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.
 */
47
DEFINE_SPINLOCK(gpio_lock);
48 49 50

static struct gpio_desc gpio_desc[ARCH_NR_GPIOS];

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

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

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

62 63 64
/**
 * Convert a GPIO number to its descriptor
 */
65
struct gpio_desc *gpio_to_desc(unsigned gpio)
66 67 68 69 70 71
{
	if (WARN(!gpio_is_valid(gpio), "invalid GPIO %d\n", gpio))
		return NULL;
	else
		return &gpio_desc[gpio];
}
72
EXPORT_SYMBOL_GPL(gpio_to_desc);
73

74
/**
75
 * Get the GPIO descriptor corresponding to the given hw number for this chip.
76
 */
77 78
struct gpio_desc *gpiochip_get_desc(struct gpio_chip *chip,
				    u16 hwnum)
79
{
80
	if (hwnum >= chip->ngpio)
81
		return ERR_PTR(-EINVAL);
82

83
	return &chip->desc[hwnum];
84
}
85 86 87 88 89 90

/**
 * 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
 */
91
int desc_to_gpio(const struct gpio_desc *desc)
92
{
93
	return desc - &gpio_desc[0];
94
}
95
EXPORT_SYMBOL_GPL(desc_to_gpio);
96 97


98 99 100 101
/* Warn when drivers omit gpio_request() calls -- legal but ill-advised
 * when setting direction, and otherwise illegal.  Until board setup code
 * and drivers use explicit requests everywhere (which won't happen when
 * those calls have no teeth) we can't avoid autorequesting.  This nag
David Brownell's avatar
David Brownell committed
102 103
 * message should motivate switching to explicit requests... so should
 * the weaker cleanup after faults, compared to gpio_request().
104 105 106 107
 *
 * NOTE: the autorequest mechanism is going away; at this point it's
 * only "legal" in the sense that (old) code using it won't break yet,
 * but instead only triggers a WARN() stack dump.
108
 */
109
static int gpio_ensure_requested(struct gpio_desc *desc)
110
{
111
	const struct gpio_chip *chip = desc->chip;
112
	const int gpio = desc_to_gpio(desc);
David Brownell's avatar
David Brownell committed
113

114 115
	if (WARN(test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0,
			"autorequest GPIO-%d\n", gpio)) {
David Brownell's avatar
David Brownell committed
116
		if (!try_module_get(chip->owner)) {
117 118
			gpiod_err(desc, "%s: module can't be gotten\n",
					__func__);
David Brownell's avatar
David Brownell committed
119 120 121 122
			clear_bit(FLAG_REQUESTED, &desc->flags);
			/* lose */
			return -EIO;
		}
123
		desc_set_label(desc, "[auto]");
David Brownell's avatar
David Brownell committed
124 125 126
		/* caller must chip->request() w/o spinlock */
		if (chip->request)
			return 1;
127
	}
David Brownell's avatar
David Brownell committed
128
	return 0;
129 130
}

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

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

147 148 149 150 151 152 153
	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;
154 155
	}

156
	if (gpio_is_valid(base)) {
157
		pr_debug("%s: found new base at %d\n", __func__, base);
158 159 160 161
		return base;
	} else {
		pr_err("%s: cannot find free range\n", __func__);
		return -ENOSPC;
Anton Vorontsov's avatar
Anton Vorontsov committed
162 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.
 */
int gpiod_get_direction(const struct gpio_desc *desc)
174 175
{
	struct gpio_chip	*chip;
176
	unsigned		offset;
177 178
	int			status = -EINVAL;

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

	if (!chip->get_direction)
		return status;

185
	status = chip->get_direction(chip, offset);
186 187 188
	if (status > 0) {
		/* GPIOF_DIR_IN, or other positive */
		status = 1;
189 190 191
		/* FLAG_IS_OUT is just a cache of the result of get_direction(),
		 * so it does not affect constness per se */
		clear_bit(FLAG_IS_OUT, &((struct gpio_desc *)desc)->flags);
192 193 194
	}
	if (status == 0) {
		/* GPIOF_DIR_OUT */
195
		set_bit(FLAG_IS_OUT, &((struct gpio_desc *)desc)->flags);
196 197 198
	}
	return status;
}
199
EXPORT_SYMBOL_GPL(gpiod_get_direction);
200

201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237
/*
 * 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;
}

238 239 240 241 242 243 244 245
/**
 * gpiochip_add() - register a gpio_chip
 * @chip: the chip to register, with chip->base initialized
 * Context: potentially before irqs or kmalloc 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.
246
 *
David Brownell's avatar
David Brownell committed
247 248 249 250 251
 * 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.
 *
252 253
 * If chip->base is negative, this requests dynamic assignment of
 * a range of valid GPIOs.
254 255 256 257 258 259
 */
int gpiochip_add(struct gpio_chip *chip)
{
	unsigned long	flags;
	int		status = 0;
	unsigned	id;
260
	int		base = chip->base;
261

Trent Piepho's avatar
Trent Piepho committed
262
	if ((!gpio_is_valid(base) || !gpio_is_valid(base + chip->ngpio - 1))
263
			&& base >= 0) {
264 265 266 267 268 269
		status = -EINVAL;
		goto fail;
	}

	spin_lock_irqsave(&gpio_lock, flags);

270 271 272 273
	if (base < 0) {
		base = gpiochip_find_base(chip->ngpio);
		if (base < 0) {
			status = base;
David Brownell's avatar
David Brownell committed
274
			goto unlock;
275 276 277 278
		}
		chip->base = base;
	}

279 280
	status = gpiochip_add_to_list(chip);

281
	if (status == 0) {
282 283 284 285 286
		chip->desc = &gpio_desc[chip->base];

		for (id = 0; id < chip->ngpio; id++) {
			struct gpio_desc *desc = &chip->desc[id];
			desc->chip = chip;
David Brownell's avatar
David Brownell committed
287 288 289 290 291

			/* 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,
292
			 * and in case chip->get_direction is not set,
David Brownell's avatar
David Brownell committed
293 294
			 * we may expose the wrong direction in sysfs.
			 */
295
			desc->flags = !chip->direction_input
David Brownell's avatar
David Brownell committed
296 297
				? (1 << FLAG_IS_OUT)
				: 0;
298 299 300
		}
	}

301 302
	spin_unlock_irqrestore(&gpio_lock, flags);

303 304 305 306
#ifdef CONFIG_PINCTRL
	INIT_LIST_HEAD(&chip->pin_ranges);
#endif

307
	of_gpiochip_add(chip);
308
	acpi_gpiochip_add(chip);
309

310 311 312 313 314 315 316
	if (status)
		goto fail;

	status = gpiochip_export(chip);
	if (status)
		goto fail;

317
	pr_debug("%s: registered GPIOs %d to %d on device: %s\n", __func__,
318 319 320
		chip->base, chip->base + chip->ngpio - 1,
		chip->label ? : "generic");

321
	return 0;
322 323 324

unlock:
	spin_unlock_irqrestore(&gpio_lock, flags);
325 326
fail:
	/* failures here can mean systems won't boot... */
327
	pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
328 329
		chip->base, chip->base + chip->ngpio - 1,
		chip->label ? : "generic");
330 331 332 333
	return status;
}
EXPORT_SYMBOL_GPL(gpiochip_add);

334 335 336
/* Forward-declaration */
static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip);

337 338 339 340 341 342 343 344 345 346 347 348
/**
 * gpiochip_remove() - unregister a gpio_chip
 * @chip: the chip to unregister
 *
 * A gpio_chip with any GPIOs still requested may not be removed.
 */
int gpiochip_remove(struct gpio_chip *chip)
{
	unsigned long	flags;
	int		status = 0;
	unsigned	id;

349 350
	acpi_gpiochip_remove(chip);

351 352
	spin_lock_irqsave(&gpio_lock, flags);

353
	gpiochip_irqchip_remove(chip);
354
	gpiochip_remove_pin_ranges(chip);
355 356
	of_gpiochip_remove(chip);

357 358
	for (id = 0; id < chip->ngpio; id++) {
		if (test_bit(FLAG_REQUESTED, &chip->desc[id].flags)) {
359 360 361 362 363
			status = -EBUSY;
			break;
		}
	}
	if (status == 0) {
364 365
		for (id = 0; id < chip->ngpio; id++)
			chip->desc[id].chip = NULL;
366 367

		list_del(&chip->list);
368 369 370
	}

	spin_unlock_irqrestore(&gpio_lock, flags);
David Brownell's avatar
David Brownell committed
371 372 373 374

	if (status == 0)
		gpiochip_unexport(chip);

375 376 377 378
	return status;
}
EXPORT_SYMBOL_GPL(gpiochip_remove);

379 380 381 382 383 384 385 386 387 388 389
/**
 * 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.
 */
390
struct gpio_chip *gpiochip_find(void *data,
391
				int (*match)(struct gpio_chip *chip,
392
					     void *data))
393
{
394
	struct gpio_chip *chip;
395 396 397
	unsigned long flags;

	spin_lock_irqsave(&gpio_lock, flags);
398 399
	list_for_each_entry(chip, &gpio_chips, list)
		if (match(chip, data))
400
			break;
401 402 403 404

	/* No match? */
	if (&chip->list == &gpio_chips)
		chip = NULL;
405 406 407 408
	spin_unlock_irqrestore(&gpio_lock, flags);

	return chip;
}
Jean Delvare's avatar
Jean Delvare committed
409
EXPORT_SYMBOL_GPL(gpiochip_find);
410

411 412 413 414 415 416 417 418 419 420 421 422
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);
}

423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
#ifdef CONFIG_GPIOLIB_IRQCHIP

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

/**
 * gpiochip_add_chained_irqchip() - adds a chained irqchip to a gpiochip
 * @gpiochip: the gpiochip to add the irqchip to
 * @irqchip: the irqchip to add to the gpiochip
 * @parent_irq: the irq number corresponding to the parent IRQ for this
 * chained irqchip
 * @parent_handler: the parent interrupt handler for the accumulated IRQ
 * coming out of the gpiochip
 */
void gpiochip_set_chained_irqchip(struct gpio_chip *gpiochip,
				  struct irq_chip *irqchip,
				  int parent_irq,
				  irq_flow_handler_t parent_handler)
{
443 444 445 446 447
	if (gpiochip->can_sleep) {
		chip_err(gpiochip, "you cannot have chained interrupts on a chip that may sleep\n");
		return;
	}

448 449 450 451 452 453 454 455 456
	irq_set_chained_handler(parent_irq, parent_handler);
	/*
	 * 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);
}
EXPORT_SYMBOL_GPL(gpiochip_set_chained_irqchip);

457 458 459 460 461 462
/*
 * 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;

463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478
/**
 * 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);
479
	irq_set_lockdep_class(irq, &gpiochip_irq_lock_class);
480
	irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler);
481 482 483
	/* Chips that can sleep need nested thread handlers */
	if (chip->can_sleep)
		irq_set_nested_thread(irq, 1);
484 485 486 487 488
#ifdef CONFIG_ARM
	set_irq_flags(irq, IRQF_VALID);
#else
	irq_set_noprobe(irq);
#endif
489 490 491 492 493 494
	/*
	 * 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);
495 496 497 498

	return 0;
}

Linus Walleij's avatar
Linus Walleij committed
499 500
static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
{
501 502
	struct gpio_chip *chip = d->host_data;

Linus Walleij's avatar
Linus Walleij committed
503 504 505
#ifdef CONFIG_ARM
	set_irq_flags(irq, 0);
#endif
506 507
	if (chip->can_sleep)
		irq_set_nested_thread(irq, 0);
Linus Walleij's avatar
Linus Walleij committed
508 509 510 511
	irq_set_chip_and_handler(irq, NULL, NULL);
	irq_set_chip_data(irq, NULL);
}

512 513
static const struct irq_domain_ops gpiochip_domain_ops = {
	.map	= gpiochip_irq_map,
Linus Walleij's avatar
Linus Walleij committed
514
	.unmap	= gpiochip_irq_unmap,
515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551
	/* 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);

	if (gpio_lock_as_irq(chip, d->hwirq)) {
		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);

	gpio_unlock_as_irq(chip, d->hwirq);
}

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
552 553 554 555 556 557
	unsigned int offset;

	/* Remove all IRQ mappings and delete the domain */
	if (gpiochip->irqdomain) {
		for (offset = 0; offset < gpiochip->ngpio; offset++)
			irq_dispose_mapping(gpiochip->irq_base + offset);
558
		irq_domain_remove(gpiochip->irqdomain);
Linus Walleij's avatar
Linus Walleij committed
559
	}
560 561 562 563 564 565 566 567 568 569 570 571 572 573 574

	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)
575 576
 * @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.
577 578 579 580 581 582 583 584 585 586 587
 *
 * 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
588 589
 * This function will handle two cell:ed simple IRQs and assumes all
 * the pins on the gpiochip can generate a unique IRQ. Everything else
590 591 592 593 594 595 596 597 598 599
 * 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
600
	unsigned irq_base = 0;
601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636

	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
637 638 639 640 641 642 643 644 645
	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;
	}
646 647 648 649 650 651 652 653 654 655 656

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

657
#ifdef CONFIG_PINCTRL
658

659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674
/**
 * 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) {
675
		chip_err(chip, "failed to allocate pin ranges\n");
676 677 678 679 680 681 682 683 684 685 686 687 688
		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);
689 690
	if (ret < 0) {
		kfree(pin_range);
691
		return ret;
692
	}
693 694 695

	pinctrl_add_gpio_range(pctldev, &pin_range->range);

696 697
	chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
		 gpio_offset, gpio_offset + pin_range->range.npins - 1,
698 699 700 701 702 703 704 705
		 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);

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

722
	pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
723
	if (!pin_range) {
724
		chip_err(chip, "failed to allocate pin ranges\n");
725
		return -ENOMEM;
726 727
	}

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

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

	return 0;
751
}
752
EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
753

754 755 756 757
/**
 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
 * @chip: the chip to remove all the mappings for
 */
758 759 760 761 762 763 764 765
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);
766
		kfree(pin_range);
767 768
	}
}
769 770 771
EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);

#endif /* CONFIG_PINCTRL */
772

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

783 784
	spin_lock_irqsave(&gpio_lock, flags);

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

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

	if (chip->request) {
		/* chip->request may sleep */
		spin_unlock_irqrestore(&gpio_lock, flags);
800
		status = chip->request(chip, gpio_chip_hwgpio(desc));
David Brownell's avatar
David Brownell committed
801 802 803 804 805
		spin_lock_irqsave(&gpio_lock, flags);

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

820
int gpiod_request(struct gpio_desc *desc, const char *label)
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839
{
	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);
	}

840 841
done:
	if (status)
842
		gpiod_dbg(desc, "%s: status %d\n", __func__, status);
843

844 845
	return status;
}
846

847
static bool __gpiod_free(struct gpio_desc *desc)
848
{
849
	bool			ret = false;
850
	unsigned long		flags;
David Brownell's avatar
David Brownell committed
851
	struct gpio_chip	*chip;
852

853 854
	might_sleep();

855
	gpiod_unexport(desc);
David Brownell's avatar
David Brownell committed
856

857 858
	spin_lock_irqsave(&gpio_lock, flags);

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

	spin_unlock_irqrestore(&gpio_lock, flags);
876 877 878
	return ret;
}

879
void gpiod_free(struct gpio_desc *desc)
880 881 882 883 884
{
	if (desc && __gpiod_free(desc))
		module_put(desc->chip->owner);
	else
		WARN_ON(extra_checks);
885
}
886

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

904
	if (!GPIO_OFFSET_VALID(chip, offset))
905
		return NULL;
906 907 908

	desc = &chip->desc[offset];

909
	if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
910
		return NULL;
911
	return desc->label;
912 913 914
}
EXPORT_SYMBOL_GPL(gpiochip_is_requested);

915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945
/**
 * 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).
 */
int gpiochip_request_own_desc(struct gpio_desc *desc, const char *label)
{
	if (!desc || !desc->chip)
		return -EINVAL;

	return __gpiod_request(desc, label);
}

/**
 * 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);
}
946 947 948 949 950 951 952 953 954 955

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

956 957 958 959 960 961 962 963 964 965
/**
 * 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)
966 967 968 969
{
	unsigned long		flags;
	struct gpio_chip	*chip;
	int			status = -EINVAL;
970
	int			offset;
971

972
	if (!desc || !desc->chip) {
973 974 975 976
		pr_warn("%s: invalid GPIO\n", __func__);
		return -EINVAL;
	}

977 978
	chip = desc->chip;
	if (!chip->get || !chip->direction_input) {
979 980
		gpiod_warn(desc,
			"%s: missing get() or direction_input() operations\n",
981
			__func__);
982 983 984
		return -EIO;
	}

985 986
	spin_lock_irqsave(&gpio_lock, flags);

987
	status = gpio_ensure_requested(desc);
David Brownell's avatar
David Brownell committed
988 989
	if (status < 0)
		goto fail;
990 991 992 993 994

	/* now we know the gpio is valid and chip won't vanish */

	spin_unlock_irqrestore(&gpio_lock, flags);

995
	might_sleep_if(chip->can_sleep);
996

997
	offset = gpio_chip_hwgpio(desc);
David Brownell's avatar
David Brownell committed
998
	if (status) {
999
		status = chip->request(chip, offset);
David Brownell's avatar
David Brownell committed
1000
		if (status < 0) {
1001 1002
			gpiod_dbg(desc, "%s: chip request fail, %d\n",
					__func__, status);
David Brownell's avatar
David Brownell committed
1003 1004 1005 1006 1007 1008 1009
			/* and it's not available to anyone else ...
			 * gpio_request() is the fully clean solution.
			 */
			goto lose;
		}
	}

1010
	status = chip->direction_input(chip, offset);
1011 1012
	if (status == 0)
		clear_bit(FLAG_IS_OUT, &desc->flags);
1013

1014
	trace_gpio_direction(desc_to_gpio(desc), 1, status);
David Brownell's avatar
David Brownell committed
1015
lose:
1016 1017 1018
	return status;
fail:
	spin_unlock_irqrestore(&gpio_lock, flags);
1019
	if (status)
1020
		gpiod_dbg(desc, "%s: status %d\n", __func__, status);
1021 1022
	return status;
}
1023
EXPORT_SYMBOL_GPL(gpiod_direction_input);
1024

1025
static int _gpiod_direction_output_raw(struct gpio_desc *desc, int value)
1026 1027 1028 1029
{
	unsigned long		flags;
	struct gpio_chip	*chip;
	int			status = -EINVAL;
1030
	int offset;
1031

1032 1033 1034 1035 1036 1037 1038 1039
	/* 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;
	}

1040 1041
	/* Open drain pin should not be driven to 1 */
	if (value && test_bit(FLAG_OPEN_DRAIN,  &desc->flags))
1042
		return gpiod_direction_input(desc);
1043

1044 1045
	/* Open source pin should not be driven to 0 */
	if (!value && test_bit(FLAG_OPEN_SOURCE,  &desc->flags))
1046
		return gpiod_direction_input(desc);
1047

1048 1049
	chip = desc->chip;
	if (!chip->set || !chip->direction_output) {
1050 1051 1052
		gpiod_warn(desc,
		       "%s: missing set() or direction_output() operations\n",
		       __func__);
1053 1054 1055
		return -EIO;
	}

1056 1057
	spin_lock_irqsave(&gpio_lock, flags);

1058
	status = gpio_ensure_requested(desc);
David Brownell's avatar
David Brownell committed
1059 1060
	if (status < 0)
		goto fail;
1061 1062 1063 1064 1065

	/* now we know the gpio is valid and chip won't vanish */

	spin_unlock_irqrestore(&gpio_lock, flags);

1066
	might_sleep_if(chip->can_sleep);
1067

1068
	offset = gpio_chip_hwgpio(desc);
David Brownell's avatar
David Brownell committed
1069
	if (status) {
1070
		status = chip->request(chip, offset);
David Brownell's avatar
David Brownell committed
1071
		if (status < 0) {
1072 1073
			gpiod_dbg(desc, "%s: chip request fail, %d\n",
					__func__, status);
David Brownell's avatar
David Brownell committed
1074 1075 1076 1077 1078 1079 1080
			/* and it's not available to anyone else ...
			 * gpio_request() is the fully clean solution.
			 */
			goto lose;
		}
	}

1081
	status = chip->direction_output(chip, offset, value);
1082 1083
	if (status == 0)
		set_bit(FLAG_IS_OUT, &desc->flags);
1084 1085
	trace_gpio_value(desc_to_gpio(desc), 0, value);
	trace_gpio_direction(desc_to_gpio(desc), 0, status);
David Brownell's avatar
David Brownell committed
1086
lose:
1087 1088 1089
	return status;
fail:
	spin_unlock_irqrestore(&gpio_lock, flags);
1090
	if (status)
1091
		gpiod_dbg(desc, "%s: gpio status %d\n", __func__, status);
1092 1093
	return status;
}
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116

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

/**
1117
 * gpiod_direction_output - set the GPIO direction to output