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

static struct gpio_desc gpio_desc[ARCH_NR_GPIOS];

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

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

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

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

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

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

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


99 100 101 102 103
/**
 * 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)
104
{
105
	return desc ? desc->chip : NULL;
106
}
107
EXPORT_SYMBOL_GPL(gpiod_to_chip);
108

109 110 111
/* dynamic allocation of GPIOs, e.g. on a hotplugged device */
static int gpiochip_find_base(int ngpio)
{
112 113
	struct gpio_chip *chip;
	int base = ARCH_NR_GPIOS - ngpio;
114

115 116 117 118 119 120 121
	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;
122 123
	}

124
	if (gpio_is_valid(base)) {
125
		pr_debug("%s: found new base at %d\n", __func__, base);
126 127 128 129
		return base;
	} else {
		pr_err("%s: cannot find free range\n", __func__);
		return -ENOSPC;
Anton Vorontsov's avatar
Anton Vorontsov committed
130 131 132
	}
}

133 134 135 136 137 138 139 140 141
/**
 * 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)
142 143
{
	struct gpio_chip	*chip;
144
	unsigned		offset;
145 146
	int			status = -EINVAL;

147 148
	chip = gpiod_to_chip(desc);
	offset = gpio_chip_hwgpio(desc);
149 150 151 152

	if (!chip->get_direction)
		return status;

153
	status = chip->get_direction(chip, offset);
154 155 156
	if (status > 0) {
		/* GPIOF_DIR_IN, or other positive */
		status = 1;
157 158 159
		/* 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);
160 161 162
	}
	if (status == 0) {
		/* GPIOF_DIR_OUT */
163
		set_bit(FLAG_IS_OUT, &((struct gpio_desc *)desc)->flags);
164 165 166
	}
	return status;
}
167
EXPORT_SYMBOL_GPL(gpiod_get_direction);
168

169 170 171 172 173 174 175 176 177 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
/*
 * 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;
}

206 207 208 209 210 211 212 213
/**
 * 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.
214
 *
David Brownell's avatar
David Brownell committed
215 216 217 218 219
 * 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.
 *
220 221
 * If chip->base is negative, this requests dynamic assignment of
 * a range of valid GPIOs.
222 223 224 225 226 227
 */
int gpiochip_add(struct gpio_chip *chip)
{
	unsigned long	flags;
	int		status = 0;
	unsigned	id;
228
	int		base = chip->base;
229

Trent Piepho's avatar
Trent Piepho committed
230
	if ((!gpio_is_valid(base) || !gpio_is_valid(base + chip->ngpio - 1))
231
			&& base >= 0) {
232 233 234 235 236 237
		status = -EINVAL;
		goto fail;
	}

	spin_lock_irqsave(&gpio_lock, flags);

238 239 240 241
	if (base < 0) {
		base = gpiochip_find_base(chip->ngpio);
		if (base < 0) {
			status = base;
David Brownell's avatar
David Brownell committed
242
			goto unlock;
243 244 245 246
		}
		chip->base = base;
	}

247 248
	status = gpiochip_add_to_list(chip);

249
	if (status == 0) {
250 251 252 253 254
		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
255 256 257 258 259

			/* 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,
260
			 * and in case chip->get_direction is not set,
David Brownell's avatar
David Brownell committed
261 262
			 * we may expose the wrong direction in sysfs.
			 */
263
			desc->flags = !chip->direction_input
David Brownell's avatar
David Brownell committed
264 265
				? (1 << FLAG_IS_OUT)
				: 0;
266 267 268
		}
	}

269 270
	spin_unlock_irqrestore(&gpio_lock, flags);

271 272 273 274
#ifdef CONFIG_PINCTRL
	INIT_LIST_HEAD(&chip->pin_ranges);
#endif

275
	of_gpiochip_add(chip);
276
	acpi_gpiochip_add(chip);
277

278 279 280 281 282 283 284
	if (status)
		goto fail;

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

285
	pr_debug("%s: registered GPIOs %d to %d on device: %s\n", __func__,
286 287 288
		chip->base, chip->base + chip->ngpio - 1,
		chip->label ? : "generic");

289
	return 0;
290 291 292

unlock:
	spin_unlock_irqrestore(&gpio_lock, flags);
293 294
fail:
	/* failures here can mean systems won't boot... */
295
	pr_err("%s: GPIOs %d..%d (%s) failed to register\n", __func__,
296 297
		chip->base, chip->base + chip->ngpio - 1,
		chip->label ? : "generic");
298 299 300 301
	return status;
}
EXPORT_SYMBOL_GPL(gpiochip_add);

302 303 304
/* Forward-declaration */
static void gpiochip_irqchip_remove(struct gpio_chip *gpiochip);

305 306 307 308 309 310 311 312 313 314 315 316
/**
 * 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;

317 318
	acpi_gpiochip_remove(chip);

319 320
	spin_lock_irqsave(&gpio_lock, flags);

321
	gpiochip_irqchip_remove(chip);
322
	gpiochip_remove_pin_ranges(chip);
323 324
	of_gpiochip_remove(chip);

325 326
	for (id = 0; id < chip->ngpio; id++) {
		if (test_bit(FLAG_REQUESTED, &chip->desc[id].flags)) {
327 328 329 330 331
			status = -EBUSY;
			break;
		}
	}
	if (status == 0) {
332 333
		for (id = 0; id < chip->ngpio; id++)
			chip->desc[id].chip = NULL;
334 335

		list_del(&chip->list);
336 337 338
	}

	spin_unlock_irqrestore(&gpio_lock, flags);
David Brownell's avatar
David Brownell committed
339 340 341 342

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

343 344 345 346
	return status;
}
EXPORT_SYMBOL_GPL(gpiochip_remove);

347 348 349 350 351 352 353 354 355 356 357
/**
 * 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.
 */
358
struct gpio_chip *gpiochip_find(void *data,
359
				int (*match)(struct gpio_chip *chip,
360
					     void *data))
361
{
362
	struct gpio_chip *chip;
363 364 365
	unsigned long flags;

	spin_lock_irqsave(&gpio_lock, flags);
366 367
	list_for_each_entry(chip, &gpio_chips, list)
		if (match(chip, data))
368
			break;
369 370 371 372

	/* No match? */
	if (&chip->list == &gpio_chips)
		chip = NULL;
373 374 375 376
	spin_unlock_irqrestore(&gpio_lock, flags);

	return chip;
}
Jean Delvare's avatar
Jean Delvare committed
377
EXPORT_SYMBOL_GPL(gpiochip_find);
378

379 380 381 382 383 384 385 386 387 388 389 390
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);
}

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
#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)
{
411 412 413 414 415
	if (gpiochip->can_sleep) {
		chip_err(gpiochip, "you cannot have chained interrupts on a chip that may sleep\n");
		return;
	}

416 417 418 419 420 421 422 423 424
	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);

425 426 427 428 429 430
/*
 * 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;

431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
/**
 * 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);
447
	irq_set_lockdep_class(irq, &gpiochip_irq_lock_class);
448
	irq_set_chip_and_handler(irq, chip->irqchip, chip->irq_handler);
449 450 451
	/* Chips that can sleep need nested thread handlers */
	if (chip->can_sleep)
		irq_set_nested_thread(irq, 1);
452 453 454 455 456
#ifdef CONFIG_ARM
	set_irq_flags(irq, IRQF_VALID);
#else
	irq_set_noprobe(irq);
#endif
457 458 459 460 461 462
	/*
	 * 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);
463 464 465 466

	return 0;
}

Linus Walleij's avatar
Linus Walleij committed
467 468
static void gpiochip_irq_unmap(struct irq_domain *d, unsigned int irq)
{
469 470
	struct gpio_chip *chip = d->host_data;

Linus Walleij's avatar
Linus Walleij committed
471 472 473
#ifdef CONFIG_ARM
	set_irq_flags(irq, 0);
#endif
474 475
	if (chip->can_sleep)
		irq_set_nested_thread(irq, 0);
Linus Walleij's avatar
Linus Walleij committed
476 477 478 479
	irq_set_chip_and_handler(irq, NULL, NULL);
	irq_set_chip_data(irq, NULL);
}

480 481
static const struct irq_domain_ops gpiochip_domain_ops = {
	.map	= gpiochip_irq_map,
Linus Walleij's avatar
Linus Walleij committed
482
	.unmap	= gpiochip_irq_unmap,
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519
	/* 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
520 521 522 523 524 525
	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);
526
		irq_domain_remove(gpiochip->irqdomain);
Linus Walleij's avatar
Linus Walleij committed
527
	}
528 529 530 531 532 533 534 535 536 537 538 539 540 541 542

	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)
543 544
 * @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.
545 546 547 548 549 550 551 552 553 554 555
 *
 * 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
556 557
 * This function will handle two cell:ed simple IRQs and assumes all
 * the pins on the gpiochip can generate a unique IRQ. Everything else
558 559 560 561 562 563 564 565 566 567
 * 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
568
	unsigned irq_base = 0;
569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604

	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
605 606 607 608 609 610 611 612 613
	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;
	}
614 615 616 617 618 619 620 621 622 623 624

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

625
#ifdef CONFIG_PINCTRL
626

627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642
/**
 * 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) {
643
		chip_err(chip, "failed to allocate pin ranges\n");
644 645 646 647 648 649 650 651 652 653 654 655 656
		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);
657 658
	if (ret < 0) {
		kfree(pin_range);
659
		return ret;
660
	}
661 662 663

	pinctrl_add_gpio_range(pctldev, &pin_range->range);

664 665
	chip_dbg(chip, "created GPIO range %d->%d ==> %s PINGRP %s\n",
		 gpio_offset, gpio_offset + pin_range->range.npins - 1,
666 667 668 669 670 671 672 673
		 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);

674 675 676 677
/**
 * 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
678 679
 * @gpio_offset: the start offset in the current gpio_chip number space
 * @pin_offset: the start offset in the pin controller number space
680 681 682
 * @npins: the number of pins from the offset of each pin space (GPIO and
 *	pin controller) to accumulate in this range
 */
683
int gpiochip_add_pin_range(struct gpio_chip *chip, const char *pinctl_name,
684
			   unsigned int gpio_offset, unsigned int pin_offset,
685
			   unsigned int npins)
686 687
{
	struct gpio_pin_range *pin_range;
688
	int ret;
689

690
	pin_range = kzalloc(sizeof(*pin_range), GFP_KERNEL);
691
	if (!pin_range) {
692
		chip_err(chip, "failed to allocate pin ranges\n");
693
		return -ENOMEM;
694 695
	}

696
	/* Use local offset as range ID */
697
	pin_range->range.id = gpio_offset;
698
	pin_range->range.gc = chip;
699
	pin_range->range.name = chip->label;
700 701
	pin_range->range.base = chip->base + gpio_offset;
	pin_range->range.pin_base = pin_offset;
702
	pin_range->range.npins = npins;
Linus Walleij's avatar
Linus Walleij committed
703
	pin_range->pctldev = pinctrl_find_and_add_gpio_range(pinctl_name,
704
			&pin_range->range);
705
	if (IS_ERR(pin_range->pctldev)) {
706
		ret = PTR_ERR(pin_range->pctldev);
707
		chip_err(chip, "could not create pin range\n");
708
		kfree(pin_range);
709
		return ret;
710
	}
711 712
	chip_dbg(chip, "created GPIO range %d->%d ==> %s PIN %d->%d\n",
		 gpio_offset, gpio_offset + npins - 1,
713 714
		 pinctl_name,
		 pin_offset, pin_offset + npins - 1);
715 716

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

	return 0;
719
}
720
EXPORT_SYMBOL_GPL(gpiochip_add_pin_range);
721

722 723 724 725
/**
 * gpiochip_remove_pin_ranges() - remove all the GPIO <-> pin mappings
 * @chip: the chip to remove all the mappings for
 */
726 727 728 729 730 731 732 733
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);
734
		kfree(pin_range);
735 736
	}
}
737 738 739
EXPORT_SYMBOL_GPL(gpiochip_remove_pin_ranges);

#endif /* CONFIG_PINCTRL */
740

741 742 743 744
/* 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.
 */
745
static int __gpiod_request(struct gpio_desc *desc, const char *label)
746
{
747 748
	struct gpio_chip	*chip = desc->chip;
	int			status;
749 750
	unsigned long		flags;

751 752
	spin_lock_irqsave(&gpio_lock, flags);

753
	/* NOTE:  gpio_request() can be called in early boot,
David Brownell's avatar
David Brownell committed
754
	 * before IRQs are enabled, for non-sleeping (SOC) GPIOs.
755 756 757 758 759
	 */

	if (test_and_set_bit(FLAG_REQUESTED, &desc->flags) == 0) {
		desc_set_label(desc, label ? : "?");
		status = 0;
760
	} else {
761
		status = -EBUSY;
762
		goto done;
David Brownell's avatar
David Brownell committed
763 764 765 766 767
	}

	if (chip->request) {
		/* chip->request may sleep */
		spin_unlock_irqrestore(&gpio_lock, flags);
768
		status = chip->request(chip, gpio_chip_hwgpio(desc));
David Brownell's avatar
David Brownell committed
769 770 771 772 773
		spin_lock_irqsave(&gpio_lock, flags);

		if (status < 0) {
			desc_set_label(desc, NULL);
			clear_bit(FLAG_REQUESTED, &desc->flags);
774
			goto done;
David Brownell's avatar
David Brownell committed
775
		}
776
	}
777 778 779
	if (chip->get_direction) {
		/* chip->get_direction may sleep */
		spin_unlock_irqrestore(&gpio_lock, flags);
780
		gpiod_get_direction(desc);
781 782
		spin_lock_irqsave(&gpio_lock, flags);
	}
783 784 785 786 787
done:
	spin_unlock_irqrestore(&gpio_lock, flags);
	return status;
}

788
int gpiod_request(struct gpio_desc *desc, const char *label)
789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
{
	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);
	}

808 809
done:
	if (status)
810
		gpiod_dbg(desc, "%s: status %d\n", __func__, status);
811

812 813
	return status;
}
814

815
static bool __gpiod_free(struct gpio_desc *desc)
816
{
817
	bool			ret = false;
818
	unsigned long		flags;
David Brownell's avatar
David Brownell committed
819
	struct gpio_chip	*chip;
820

821 822
	might_sleep();

823
	gpiod_unexport(desc);
David Brownell's avatar
David Brownell committed
824

825 826
	spin_lock_irqsave(&gpio_lock, flags);

David Brownell's avatar
David Brownell committed
827 828 829 830
	chip = desc->chip;
	if (chip && test_bit(FLAG_REQUESTED, &desc->flags)) {
		if (chip->free) {
			spin_unlock_irqrestore(&gpio_lock, flags);
831
			might_sleep_if(chip->can_sleep);
832
			chip->free(chip, gpio_chip_hwgpio(desc));
David Brownell's avatar
David Brownell committed
833 834
			spin_lock_irqsave(&gpio_lock, flags);
		}
835
		desc_set_label(desc, NULL);
836
		clear_bit(FLAG_ACTIVE_LOW, &desc->flags);
David Brownell's avatar
David Brownell committed
837
		clear_bit(FLAG_REQUESTED, &desc->flags);
838
		clear_bit(FLAG_OPEN_DRAIN, &desc->flags);
839
		clear_bit(FLAG_OPEN_SOURCE, &desc->flags);
840 841
		ret = true;
	}
842 843

	spin_unlock_irqrestore(&gpio_lock, flags);
844 845 846
	return ret;
}

847
void gpiod_free(struct gpio_desc *desc)
848 849 850 851 852
{
	if (desc && __gpiod_free(desc))
		module_put(desc->chip->owner);
	else
		WARN_ON(extra_checks);
853
}
854

855 856 857 858 859 860
/**
 * 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.
861 862
 * The string returned is the label passed to gpio_request(); if none has been
 * passed it is a meaningless, non-NULL constant.
863 864 865 866 867 868 869
 *
 * 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)
{
870
	struct gpio_desc *desc;
871

872
	if (!GPIO_OFFSET_VALID(chip, offset))
873
		return NULL;
874 875 876

	desc = &chip->desc[offset];

877
	if (test_bit(FLAG_REQUESTED, &desc->flags) == 0)
878
		return NULL;
879
	return desc->label;
880 881 882
}
EXPORT_SYMBOL_GPL(gpiochip_is_requested);

883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900
/**
 * 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);
}
901
EXPORT_SYMBOL_GPL(gpiochip_request_own_desc);
902 903 904 905 906 907 908 909 910 911 912 913 914

/**
 * 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);
}
915
EXPORT_SYMBOL_GPL(gpiochip_free_own_desc);
916 917 918 919 920 921 922 923 924 925

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

926 927 928 929 930 931 932 933 934 935
/**
 * 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)
936 937 938 939
{
	struct gpio_chip	*chip;
	int			status = -EINVAL;

940
	if (!desc || !desc->chip) {
941 942 943 944
		pr_warn("%s: invalid GPIO\n", __func__);
		return -EINVAL;
	}

945 946
	chip = desc->chip;
	if (!chip->get || !chip->direction_input) {
947 948
		gpiod_warn(desc,
			"%s: missing get() or direction_input() operations\n",
949
			__func__);
950 951 952
		return -EIO;
	}

953
	status = chip->direction_input(chip, gpio_chip_hwgpio(desc));
954 955
	if (status == 0)
		clear_bit(FLAG_IS_OUT, &desc->flags);
956

957
	trace_gpio_direction(desc_to_gpio(desc), 1, status);
958

959 960
	return status;
}
961
EXPORT_SYMBOL_GPL(gpiod_direction_input);
962

963
static int _gpiod_direction_output_raw(struct gpio_desc *desc, int value)
964 965 966 967
{
	struct gpio_chip	*chip;
	int			status = -EINVAL;

968 969 970 971 972 973 974 975
	/* 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;
	}

976 977
	/* Open drain pin should not be driven to 1 */
	if (value && test_bit(FLAG_OPEN_DRAIN,  &desc->flags))
978
		return gpiod_direction_input(desc);
979

980 981
	/* Open source pin should not be driven to 0 */
	if (!value && test_bit(FLAG_OPEN_SOURCE,  &desc->flags))
982
		return gpiod_direction_input(desc);
983

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

992
	status = chip->direction_output(chip, gpio_chip_hwgpio(desc), value);
993 994
	if (status == 0)
		set_bit(FLAG_IS_OUT, &desc->flags);
995 996
	trace_gpio_value(desc_to_gpio(desc), 0, value);
	trace_gpio_direction(desc_to_gpio(desc), 0, status);
997 998
	return status;
}
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021

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

/**
1022
 * gpiod_direction_output - set the GPIO direction to output
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042
 * @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);
}
1043
EXPORT_SYMBOL_GPL(gpiod_direction_output);
1044

1045
/**
1046
 * gpiod_set_debounce - sets @debounce time for a @gpio
1047 1048
 * @gpio: the gpio to set debounce time
 * @debounce: debounce time is microseconds
1049 1050 1051
 *
 * returns -ENOTSUPP if the controller does not support setting
 * debounce.
1052
 */
1053
int gpiod_set_debounce(struct gpio_desc *desc, unsigned debounce)
1054 1055 1056
{
	struct gpio_chip	*chip;

1057
	if (!desc || !desc->chip) {
1058 1059 1060 1061
		pr_warn("%s: invalid GPIO\n", __func__);
		return -EINVAL;
	}

1062
	chip = desc->chip;
1063
	if (!chip->set || !chip->set_debounce) {
1064 1065 1066
		gpiod_dbg(desc,
			  "%s: missing set() or set_debounce() operations\n",
			  __func__);
1067
		return -ENOTSUPP;
1068 1069
	}

1070
	return chip->set_debounce(chip, gpio_chip_hwgpio(desc), debounce);
1071
}
1072
EXPORT_SYMBOL_GPL(gpiod_set_debounce);
1073

1074 1075 1076 1077 1078 1079 1080
/**
 * 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)
1081
{
1082
	return test_bit(FLAG_ACTIVE_LOW, &desc->flags);
1083
}
1084
EXPORT_SYMBOL_GPL(gpiod_is_active_low);
1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107

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

1108
static bool _gpiod_get_raw_value(const struct gpio_desc *desc)
1109 1110
{
	struct gpio_chip	*chip;
1111
	bool value;
1112
	int offset;
1113

1114 1115
	chip = desc->chip;
	offset = gpio_chip_hwgpio(desc);
1116
	value = chip->get ? chip->get(chip, offset) : false;
1117
	trace_gpio_value(desc_to_gpio(desc), 1, value);
1118
	return value;
1119
}
1120

1121
/**
1122 1123
 * gpiod_get_raw_value() - return a gpio's raw value
 * @desc: gpio whose value will be returned
1124
 *
1125 1126 1127 1128 1129
 * Return the GPIO's raw value, i.e. the value of the physical line disregarding
 * 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.
1130
 */
1131
int gpiod_get_raw_value(const struct gpio_desc *desc)
1132
{
1133 1134
	if (!desc)
		return 0;