core.c 40.9 KB
Newer Older
1 2 3
/*
 * Core driver for the pin control subsystem
 *
4
 * Copyright (C) 2011-2012 ST-Ericsson SA
5 6 7 8 9
 * Written on behalf of Linaro for ST-Ericsson
 * Based on bits of regulator core, gpio core and clk core
 *
 * Author: Linus Walleij <linus.walleij@linaro.org>
 *
10 11
 * Copyright (C) 2012 NVIDIA CORPORATION. All rights reserved.
 *
12 13 14 15 16
 * License terms: GNU General Public License (GPL) version 2
 */
#define pr_fmt(fmt) "pinctrl core: " fmt

#include <linux/kernel.h>
17
#include <linux/kref.h>
18
#include <linux/export.h>
19 20 21 22 23 24 25 26
#include <linux/init.h>
#include <linux/device.h>
#include <linux/slab.h>
#include <linux/err.h>
#include <linux/list.h>
#include <linux/sysfs.h>
#include <linux/debugfs.h>
#include <linux/seq_file.h>
27
#include <linux/pinctrl/consumer.h>
28 29
#include <linux/pinctrl/pinctrl.h>
#include <linux/pinctrl/machine.h>
30
#include <asm-generic/gpio.h>
31
#include "core.h"
32
#include "devicetree.h"
33
#include "pinmux.h"
34
#include "pinconf.h"
35

36

37 38
static bool pinctrl_dummy_state;

39 40 41 42
/* Mutex taken by all entry points */
DEFINE_MUTEX(pinctrl_mutex);

/* Global list of pin control devices (struct pinctrl_dev) */
43
LIST_HEAD(pinctrldev_list);
44

45
/* List of pin controller handles (struct pinctrl) */
46 47
static LIST_HEAD(pinctrl_list);

48
/* List of pinctrl maps (struct pinctrl_maps) */
49
LIST_HEAD(pinctrl_maps);
50

51

52 53 54 55 56 57 58 59 60 61 62 63 64
/**
 * pinctrl_provide_dummies() - indicate if pinctrl provides dummy state support
 *
 * Usually this function is called by platforms without pinctrl driver support
 * but run with some shared drivers using pinctrl APIs.
 * After calling this function, the pinctrl core will return successfully
 * with creating a dummy state for the driver to keep going smoothly.
 */
void pinctrl_provide_dummies(void)
{
	pinctrl_dummy_state = true;
}

65 66 67 68 69 70 71
const char *pinctrl_dev_get_name(struct pinctrl_dev *pctldev)
{
	/* We're not allowed to register devices without name */
	return pctldev->desc->name;
}
EXPORT_SYMBOL_GPL(pinctrl_dev_get_name);

72 73 74 75 76 77
const char *pinctrl_dev_get_devname(struct pinctrl_dev *pctldev)
{
	return dev_name(pctldev->dev);
}
EXPORT_SYMBOL_GPL(pinctrl_dev_get_devname);

78 79 80 81 82 83 84
void *pinctrl_dev_get_drvdata(struct pinctrl_dev *pctldev)
{
	return pctldev->driver_data;
}
EXPORT_SYMBOL_GPL(pinctrl_dev_get_drvdata);

/**
85 86
 * get_pinctrl_dev_from_devname() - look up pin controller device
 * @devname: the name of a device instance, as returned by dev_name()
87 88 89 90
 *
 * Looks up a pin control device matching a certain device name or pure device
 * pointer, the pure device pointer will take precedence.
 */
91
struct pinctrl_dev *get_pinctrl_dev_from_devname(const char *devname)
92 93 94 95
{
	struct pinctrl_dev *pctldev = NULL;
	bool found = false;

96 97 98
	if (!devname)
		return NULL;

99
	list_for_each_entry(pctldev, &pinctrldev_list, node) {
100
		if (!strcmp(dev_name(pctldev->dev), devname)) {
101 102 103 104 105 106 107 108 109
			/* Matched on device name */
			found = true;
			break;
		}
	}

	return found ? pctldev : NULL;
}

110 111 112 113 114 115 116
/**
 * pin_get_from_name() - look up a pin number from a name
 * @pctldev: the pin control device to lookup the pin on
 * @name: the name of the pin to look up
 */
int pin_get_from_name(struct pinctrl_dev *pctldev, const char *name)
{
117
	unsigned i, pin;
118

119 120
	/* The pin number can be retrived from the pin controller descriptor */
	for (i = 0; i < pctldev->desc->npins; i++) {
121 122
		struct pin_desc *desc;

123
		pin = pctldev->desc->pins[i].number;
124 125 126 127 128 129 130 131 132 133 134
		desc = pin_desc_get(pctldev, pin);
		/* Pin space may be sparse */
		if (desc == NULL)
			continue;
		if (desc->name && !strcmp(name, desc->name))
			return pin;
	}

	return -EINVAL;
}

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153
/**
 * pin_get_name_from_id() - look up a pin name from a pin id
 * @pctldev: the pin control device to lookup the pin on
 * @name: the name of the pin to look up
 */
const char *pin_get_name(struct pinctrl_dev *pctldev, const unsigned pin)
{
	const struct pin_desc *desc;

	desc = pin_desc_get(pctldev, pin);
	if (desc == NULL) {
		dev_err(pctldev->dev, "failed to get pin(%d) name\n",
			pin);
		return NULL;
	}

	return desc->name;
}

154 155 156 157 158 159 160 161 162 163 164 165 166 167 168
/**
 * pin_is_valid() - check if pin exists on controller
 * @pctldev: the pin control device to check the pin on
 * @pin: pin to check, use the local pin controller index number
 *
 * This tells us whether a certain pin exist on a certain pin controller or
 * not. Pin lists may be sparse, so some pins may not exist.
 */
bool pin_is_valid(struct pinctrl_dev *pctldev, int pin)
{
	struct pin_desc *pindesc;

	if (pin < 0)
		return false;

169
	mutex_lock(&pinctrl_mutex);
170
	pindesc = pin_desc_get(pctldev, pin);
171
	mutex_unlock(&pinctrl_mutex);
172

173
	return pindesc != NULL;
174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
}
EXPORT_SYMBOL_GPL(pin_is_valid);

/* Deletes a range of pin descriptors */
static void pinctrl_free_pindescs(struct pinctrl_dev *pctldev,
				  const struct pinctrl_pin_desc *pins,
				  unsigned num_pins)
{
	int i;

	for (i = 0; i < num_pins; i++) {
		struct pin_desc *pindesc;

		pindesc = radix_tree_lookup(&pctldev->pin_desc_tree,
					    pins[i].number);
		if (pindesc != NULL) {
			radix_tree_delete(&pctldev->pin_desc_tree,
					  pins[i].number);
192 193
			if (pindesc->dynamic_name)
				kfree(pindesc->name);
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
		}
		kfree(pindesc);
	}
}

static int pinctrl_register_one_pin(struct pinctrl_dev *pctldev,
				    unsigned number, const char *name)
{
	struct pin_desc *pindesc;

	pindesc = pin_desc_get(pctldev, number);
	if (pindesc != NULL) {
		pr_err("pin %d already registered on %s\n", number,
		       pctldev->desc->name);
		return -EINVAL;
	}

	pindesc = kzalloc(sizeof(*pindesc), GFP_KERNEL);
212 213
	if (pindesc == NULL) {
		dev_err(pctldev->dev, "failed to alloc struct pin_desc\n");
214
		return -ENOMEM;
215
	}
216

217 218 219
	/* Set owner */
	pindesc->pctldev = pctldev;

220
	/* Copy basic pin info */
L
Linus Walleij 已提交
221
	if (name) {
222 223 224
		pindesc->name = name;
	} else {
		pindesc->name = kasprintf(GFP_KERNEL, "PIN%u", number);
225 226
		if (pindesc->name == NULL) {
			kfree(pindesc);
227
			return -ENOMEM;
228
		}
229 230
		pindesc->dynamic_name = true;
	}
231 232 233

	radix_tree_insert(&pctldev->pin_desc_tree, number, pindesc);
	pr_debug("registered pin %d (%s) on %s\n",
234
		 number, pindesc->name, pctldev->desc->name);
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
	return 0;
}

static int pinctrl_register_pins(struct pinctrl_dev *pctldev,
				 struct pinctrl_pin_desc const *pins,
				 unsigned num_descs)
{
	unsigned i;
	int ret = 0;

	for (i = 0; i < num_descs; i++) {
		ret = pinctrl_register_one_pin(pctldev,
					       pins[i].number, pins[i].name);
		if (ret)
			return ret;
	}

	return 0;
}

/**
 * pinctrl_match_gpio_range() - check if a certain GPIO pin is in range
 * @pctldev: pin controller device to check
 * @gpio: gpio pin to check taken from the global GPIO pin space
 *
 * Tries to match a GPIO pin number to the ranges handled by a certain pin
 * controller, return the range or NULL
 */
static struct pinctrl_gpio_range *
pinctrl_match_gpio_range(struct pinctrl_dev *pctldev, unsigned gpio)
{
	struct pinctrl_gpio_range *range = NULL;

	/* Loop over the ranges */
	list_for_each_entry(range, &pctldev->gpio_ranges, node) {
		/* Check if we're in the valid range */
		if (gpio >= range->base &&
		    gpio < range->base + range->npins) {
			return range;
		}
	}

	return NULL;
}

280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312
/**
 * pinctrl_ready_for_gpio_range() - check if other GPIO pins of
 * the same GPIO chip are in range
 * @gpio: gpio pin to check taken from the global GPIO pin space
 *
 * This function is complement of pinctrl_match_gpio_range(). If the return
 * value of pinctrl_match_gpio_range() is NULL, this function could be used
 * to check whether pinctrl device is ready or not. Maybe some GPIO pins
 * of the same GPIO chip don't have back-end pinctrl interface.
 * If the return value is true, it means that pinctrl device is ready & the
 * certain GPIO pin doesn't have back-end pinctrl device. If the return value
 * is false, it means that pinctrl device may not be ready.
 */
static bool pinctrl_ready_for_gpio_range(unsigned gpio)
{
	struct pinctrl_dev *pctldev;
	struct pinctrl_gpio_range *range = NULL;
	struct gpio_chip *chip = gpio_to_chip(gpio);

	/* Loop over the pin controllers */
	list_for_each_entry(pctldev, &pinctrldev_list, node) {
		/* Loop over the ranges */
		list_for_each_entry(range, &pctldev->gpio_ranges, node) {
			/* Check if any gpio range overlapped with gpio chip */
			if (range->base + range->npins - 1 < chip->base ||
			    range->base > chip->base + chip->ngpio - 1)
				continue;
			return true;
		}
	}
	return false;
}

313 314 315 316 317 318 319 320
/**
 * pinctrl_get_device_gpio_range() - find device for GPIO range
 * @gpio: the pin to locate the pin controller for
 * @outdev: the pin control device if found
 * @outrange: the GPIO range if found
 *
 * Find the pin controller handling a certain GPIO pin from the pinspace of
 * the GPIO subsystem, return the device and the matching GPIO range. Returns
321 322
 * -EPROBE_DEFER if the GPIO range could not be found in any device since it
 * may still have not been registered.
323
 */
S
Stephen Warren 已提交
324 325 326
static int pinctrl_get_device_gpio_range(unsigned gpio,
					 struct pinctrl_dev **outdev,
					 struct pinctrl_gpio_range **outrange)
327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
{
	struct pinctrl_dev *pctldev = NULL;

	/* Loop over the pin controllers */
	list_for_each_entry(pctldev, &pinctrldev_list, node) {
		struct pinctrl_gpio_range *range;

		range = pinctrl_match_gpio_range(pctldev, gpio);
		if (range != NULL) {
			*outdev = pctldev;
			*outrange = range;
			return 0;
		}
	}

342
	return -EPROBE_DEFER;
343 344 345 346 347 348 349 350 351 352 353 354 355
}

/**
 * pinctrl_add_gpio_range() - register a GPIO range for a controller
 * @pctldev: pin controller device to add the range to
 * @range: the GPIO range to add
 *
 * This adds a range of GPIOs to be handled by a certain pin controller. Call
 * this to register handled ranges after registering your pin controller.
 */
void pinctrl_add_gpio_range(struct pinctrl_dev *pctldev,
			    struct pinctrl_gpio_range *range)
{
356
	mutex_lock(&pinctrl_mutex);
357
	list_add_tail(&range->node, &pctldev->gpio_ranges);
358
	mutex_unlock(&pinctrl_mutex);
359
}
S
Stephen Warren 已提交
360
EXPORT_SYMBOL_GPL(pinctrl_add_gpio_range);
361

362 363 364 365 366 367 368 369 370 371 372
void pinctrl_add_gpio_ranges(struct pinctrl_dev *pctldev,
			     struct pinctrl_gpio_range *ranges,
			     unsigned nranges)
{
	int i;

	for (i = 0; i < nranges; i++)
		pinctrl_add_gpio_range(pctldev, &ranges[i]);
}
EXPORT_SYMBOL_GPL(pinctrl_add_gpio_ranges);

L
Linus Walleij 已提交
373
struct pinctrl_dev *pinctrl_find_and_add_gpio_range(const char *devname,
374 375 376 377
		struct pinctrl_gpio_range *range)
{
	struct pinctrl_dev *pctldev = get_pinctrl_dev_from_devname(devname);

378 379 380 381 382
	/*
	 * If we can't find this device, let's assume that is because
	 * it has not probed yet, so the driver trying to register this
	 * range need to defer probing.
	 */
383
	if (!pctldev)
384
		return ERR_PTR(-EPROBE_DEFER);
385 386 387 388

	pinctrl_add_gpio_range(pctldev, range);
	return pctldev;
}
L
Linus Walleij 已提交
389
EXPORT_SYMBOL_GPL(pinctrl_find_and_add_gpio_range);
390

391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
/**
 * pinctrl_find_gpio_range_from_pin() - locate the GPIO range for a pin
 * @pctldev: the pin controller device to look in
 * @pin: a controller-local number to find the range for
 */
struct pinctrl_gpio_range *
pinctrl_find_gpio_range_from_pin(struct pinctrl_dev *pctldev,
				 unsigned int pin)
{
	struct pinctrl_gpio_range *range = NULL;

	/* Loop over the ranges */
	list_for_each_entry(range, &pctldev->gpio_ranges, node) {
		/* Check if we're in the valid range */
		if (pin >= range->pin_base &&
		    pin < range->pin_base + range->npins) {
			return range;
		}
	}

	return NULL;
}
EXPORT_SYMBOL_GPL(pinctrl_find_gpio_range_from_pin);

415 416 417 418 419 420 421 422 423 424 425 426 427 428
/**
 * pinctrl_remove_gpio_range() - remove a range of GPIOs fro a pin controller
 * @pctldev: pin controller device to remove the range from
 * @range: the GPIO range to remove
 */
void pinctrl_remove_gpio_range(struct pinctrl_dev *pctldev,
			       struct pinctrl_gpio_range *range)
{
	mutex_lock(&pinctrl_mutex);
	list_del(&range->node);
	mutex_unlock(&pinctrl_mutex);
}
EXPORT_SYMBOL_GPL(pinctrl_remove_gpio_range);

429 430 431 432 433 434 435 436 437
/**
 * pinctrl_get_group_selector() - returns the group selector for a group
 * @pctldev: the pin controller handling the group
 * @pin_group: the pin group to look up
 */
int pinctrl_get_group_selector(struct pinctrl_dev *pctldev,
			       const char *pin_group)
{
	const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
438
	unsigned ngroups = pctlops->get_groups_count(pctldev);
439 440
	unsigned group_selector = 0;

441
	while (group_selector < ngroups) {
442 443 444
		const char *gname = pctlops->get_group_name(pctldev,
							    group_selector);
		if (!strcmp(gname, pin_group)) {
445
			dev_dbg(pctldev->dev,
446 447 448 449 450 451 452 453 454
				"found group selector %u for %s\n",
				group_selector,
				pin_group);
			return group_selector;
		}

		group_selector++;
	}

455
	dev_err(pctldev->dev, "does not have pin group %s\n",
456 457 458 459 460
		pin_group);

	return -EINVAL;
}

461 462 463 464 465 466 467 468 469 470 471 472 473 474 475
/**
 * pinctrl_request_gpio() - request a single pin to be used in as GPIO
 * @gpio: the GPIO pin number from the GPIO subsystem number space
 *
 * This function should *ONLY* be used from gpiolib-based GPIO drivers,
 * as part of their gpio_request() semantics, platforms and individual drivers
 * shall *NOT* request GPIO pins to be muxed in.
 */
int pinctrl_request_gpio(unsigned gpio)
{
	struct pinctrl_dev *pctldev;
	struct pinctrl_gpio_range *range;
	int ret;
	int pin;

476 477
	mutex_lock(&pinctrl_mutex);

478
	ret = pinctrl_get_device_gpio_range(gpio, &pctldev, &range);
479
	if (ret) {
480 481
		if (pinctrl_ready_for_gpio_range(gpio))
			ret = 0;
482
		mutex_unlock(&pinctrl_mutex);
483
		return ret;
484
	}
485 486 487 488

	/* Convert to the pin controllers number space */
	pin = gpio - range->base + range->pin_base;

489 490 491 492
	ret = pinmux_request_gpio(pctldev, range, pin, gpio);

	mutex_unlock(&pinctrl_mutex);
	return ret;
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510
}
EXPORT_SYMBOL_GPL(pinctrl_request_gpio);

/**
 * pinctrl_free_gpio() - free control on a single pin, currently used as GPIO
 * @gpio: the GPIO pin number from the GPIO subsystem number space
 *
 * This function should *ONLY* be used from gpiolib-based GPIO drivers,
 * as part of their gpio_free() semantics, platforms and individual drivers
 * shall *NOT* request GPIO pins to be muxed out.
 */
void pinctrl_free_gpio(unsigned gpio)
{
	struct pinctrl_dev *pctldev;
	struct pinctrl_gpio_range *range;
	int ret;
	int pin;

511 512
	mutex_lock(&pinctrl_mutex);

513
	ret = pinctrl_get_device_gpio_range(gpio, &pctldev, &range);
514 515
	if (ret) {
		mutex_unlock(&pinctrl_mutex);
516
		return;
517
	}
518 519 520 521

	/* Convert to the pin controllers number space */
	pin = gpio - range->base + range->pin_base;

522 523 524
	pinmux_free_gpio(pctldev, pin, range);

	mutex_unlock(&pinctrl_mutex);
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 552 553 554
}
EXPORT_SYMBOL_GPL(pinctrl_free_gpio);

static int pinctrl_gpio_direction(unsigned gpio, bool input)
{
	struct pinctrl_dev *pctldev;
	struct pinctrl_gpio_range *range;
	int ret;
	int pin;

	ret = pinctrl_get_device_gpio_range(gpio, &pctldev, &range);
	if (ret)
		return ret;

	/* Convert to the pin controllers number space */
	pin = gpio - range->base + range->pin_base;

	return pinmux_gpio_direction(pctldev, range, pin, input);
}

/**
 * pinctrl_gpio_direction_input() - request a GPIO pin to go into input mode
 * @gpio: the GPIO pin number from the GPIO subsystem number space
 *
 * This function should *ONLY* be used from gpiolib-based GPIO drivers,
 * as part of their gpio_direction_input() semantics, platforms and individual
 * drivers shall *NOT* touch pin control GPIO calls.
 */
int pinctrl_gpio_direction_input(unsigned gpio)
{
555 556 557 558 559
	int ret;
	mutex_lock(&pinctrl_mutex);
	ret = pinctrl_gpio_direction(gpio, true);
	mutex_unlock(&pinctrl_mutex);
	return ret;
560 561 562 563 564 565 566 567 568 569 570 571 572
}
EXPORT_SYMBOL_GPL(pinctrl_gpio_direction_input);

/**
 * pinctrl_gpio_direction_output() - request a GPIO pin to go into output mode
 * @gpio: the GPIO pin number from the GPIO subsystem number space
 *
 * This function should *ONLY* be used from gpiolib-based GPIO drivers,
 * as part of their gpio_direction_output() semantics, platforms and individual
 * drivers shall *NOT* touch pin control GPIO calls.
 */
int pinctrl_gpio_direction_output(unsigned gpio)
{
573 574 575 576 577
	int ret;
	mutex_lock(&pinctrl_mutex);
	ret = pinctrl_gpio_direction(gpio, false);
	mutex_unlock(&pinctrl_mutex);
	return ret;
578 579 580
}
EXPORT_SYMBOL_GPL(pinctrl_gpio_direction_output);

581 582
static struct pinctrl_state *find_state(struct pinctrl *p,
					const char *name)
583
{
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615
	struct pinctrl_state *state;

	list_for_each_entry(state, &p->states, node)
		if (!strcmp(state->name, name))
			return state;

	return NULL;
}

static struct pinctrl_state *create_state(struct pinctrl *p,
					  const char *name)
{
	struct pinctrl_state *state;

	state = kzalloc(sizeof(*state), GFP_KERNEL);
	if (state == NULL) {
		dev_err(p->dev,
			"failed to alloc struct pinctrl_state\n");
		return ERR_PTR(-ENOMEM);
	}

	state->name = name;
	INIT_LIST_HEAD(&state->settings);

	list_add_tail(&state->node, &p->states);

	return state;
}

static int add_setting(struct pinctrl *p, struct pinctrl_map const *map)
{
	struct pinctrl_state *state;
616
	struct pinctrl_setting *setting;
617
	int ret;
618

619 620 621 622 623
	state = find_state(p, map->name);
	if (!state)
		state = create_state(p, map->name);
	if (IS_ERR(state))
		return PTR_ERR(state);
624

625 626 627
	if (map->type == PIN_MAP_TYPE_DUMMY_STATE)
		return 0;

628 629 630 631 632 633
	setting = kzalloc(sizeof(*setting), GFP_KERNEL);
	if (setting == NULL) {
		dev_err(p->dev,
			"failed to alloc struct pinctrl_setting\n");
		return -ENOMEM;
	}
634

635 636
	setting->type = map->type;

637 638 639
	setting->pctldev = get_pinctrl_dev_from_devname(map->ctrl_dev_name);
	if (setting->pctldev == NULL) {
		kfree(setting);
L
Linus Walleij 已提交
640 641 642
		/* Do not defer probing of hogs (circular loop) */
		if (!strcmp(map->ctrl_dev_name, map->dev_name))
			return -ENODEV;
643 644 645 646
		/*
		 * OK let us guess that the driver is not there yet, and
		 * let's defer obtaining this pinctrl handle to later...
		 */
L
Linus Walleij 已提交
647 648
		dev_info(p->dev, "unknown pinctrl device %s in map entry, deferring probe",
			map->ctrl_dev_name);
649
		return -EPROBE_DEFER;
650 651
	}

652 653
	setting->dev_name = map->dev_name;

654 655 656 657 658 659 660 661 662 663 664 665
	switch (map->type) {
	case PIN_MAP_TYPE_MUX_GROUP:
		ret = pinmux_map_to_setting(map, setting);
		break;
	case PIN_MAP_TYPE_CONFIGS_PIN:
	case PIN_MAP_TYPE_CONFIGS_GROUP:
		ret = pinconf_map_to_setting(map, setting);
		break;
	default:
		ret = -EINVAL;
		break;
	}
666 667 668 669 670 671 672 673 674 675 676 677 678 679
	if (ret < 0) {
		kfree(setting);
		return ret;
	}

	list_add_tail(&setting->node, &state->settings);

	return 0;
}

static struct pinctrl *find_pinctrl(struct device *dev)
{
	struct pinctrl *p;

680
	list_for_each_entry(p, &pinctrl_list, node)
681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
		if (p->dev == dev)
			return p;

	return NULL;
}

static void pinctrl_put_locked(struct pinctrl *p, bool inlist);

static struct pinctrl *create_pinctrl(struct device *dev)
{
	struct pinctrl *p;
	const char *devname;
	struct pinctrl_maps *maps_node;
	int i;
	struct pinctrl_map const *map;
	int ret;
697 698 699 700 701 702

	/*
	 * create the state cookie holder struct pinctrl for each
	 * mapping, this is what consumers will get when requesting
	 * a pin control handle with pinctrl_get()
	 */
703
	p = kzalloc(sizeof(*p), GFP_KERNEL);
704 705
	if (p == NULL) {
		dev_err(dev, "failed to alloc struct pinctrl\n");
706
		return ERR_PTR(-ENOMEM);
707
	}
708
	p->dev = dev;
709
	INIT_LIST_HEAD(&p->states);
710 711 712 713 714 715 716
	INIT_LIST_HEAD(&p->dt_maps);

	ret = pinctrl_dt_to_map(p);
	if (ret < 0) {
		kfree(p);
		return ERR_PTR(ret);
	}
717 718

	devname = dev_name(dev);
719 720

	/* Iterate over the pin control maps to locate the right ones */
721
	for_each_maps(maps_node, i, map) {
722 723 724 725
		/* Map must be for this device */
		if (strcmp(map->dev_name, devname))
			continue;

726
		ret = add_setting(p, map);
L
Linus Walleij 已提交
727 728 729 730 731 732 733 734 735 736 737 738 739 740
		/*
		 * At this point the adding of a setting may:
		 *
		 * - Defer, if the pinctrl device is not yet available
		 * - Fail, if the pinctrl device is not yet available,
		 *   AND the setting is a hog. We cannot defer that, since
		 *   the hog will kick in immediately after the device
		 *   is registered.
		 *
		 * If the error returned was not -EPROBE_DEFER then we
		 * accumulate the errors to see if we end up with
		 * an -EPROBE_DEFER later, as that is the worst case.
		 */
		if (ret == -EPROBE_DEFER) {
741 742
			pinctrl_put_locked(p, false);
			return ERR_PTR(ret);
743
		}
744
	}
L
Linus Walleij 已提交
745 746 747 748 749
	if (ret < 0) {
		/* If some other error than deferral occured, return here */
		pinctrl_put_locked(p, false);
		return ERR_PTR(ret);
	}
750

751 752
	kref_init(&p->users);

L
Linus Walleij 已提交
753
	/* Add the pinctrl handle to the global list */
754
	list_add_tail(&p->node, &pinctrl_list);
755 756

	return p;
757
}
758

759 760 761
static struct pinctrl *pinctrl_get_locked(struct device *dev)
{
	struct pinctrl *p;
762

763 764 765
	if (WARN_ON(!dev))
		return ERR_PTR(-EINVAL);

766 767 768 769 770
	/*
	 * See if somebody else (such as the device core) has already
	 * obtained a handle to the pinctrl for this device. In that case,
	 * return another pointer to it.
	 */
771
	p = find_pinctrl(dev);
772 773 774 775 776
	if (p != NULL) {
		dev_dbg(dev, "obtain a copy of previously claimed pinctrl\n");
		kref_get(&p->users);
		return p;
	}
777

778
	return create_pinctrl(dev);
779
}
780 781

/**
782 783
 * pinctrl_get() - retrieves the pinctrl handle for a device
 * @dev: the device to obtain the handle for
784
 */
785
struct pinctrl *pinctrl_get(struct device *dev)
786 787 788
{
	struct pinctrl *p;

789
	mutex_lock(&pinctrl_mutex);
790
	p = pinctrl_get_locked(dev);
791
	mutex_unlock(&pinctrl_mutex);
792 793 794

	return p;
}
795 796
EXPORT_SYMBOL_GPL(pinctrl_get);

797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
static void pinctrl_free_setting(bool disable_setting,
				 struct pinctrl_setting *setting)
{
	switch (setting->type) {
	case PIN_MAP_TYPE_MUX_GROUP:
		if (disable_setting)
			pinmux_disable_setting(setting);
		pinmux_free_setting(setting);
		break;
	case PIN_MAP_TYPE_CONFIGS_PIN:
	case PIN_MAP_TYPE_CONFIGS_GROUP:
		pinconf_free_setting(setting);
		break;
	default:
		break;
	}
}

815
static void pinctrl_put_locked(struct pinctrl *p, bool inlist)
816
{
817 818 819 820 821
	struct pinctrl_state *state, *n1;
	struct pinctrl_setting *setting, *n2;

	list_for_each_entry_safe(state, n1, &p->states, node) {
		list_for_each_entry_safe(setting, n2, &state->settings, node) {
822
			pinctrl_free_setting(state == p->state, setting);
823 824 825 826 827
			list_del(&setting->node);
			kfree(setting);
		}
		list_del(&state->node);
		kfree(state);
828
	}
829

830 831
	pinctrl_dt_free_maps(p);

832 833
	if (inlist)
		list_del(&p->node);
834 835 836 837
	kfree(p);
}

/**
838 839 840
 * pinctrl_release() - release the pinctrl handle
 * @kref: the kref in the pinctrl being released
 */
841
static void pinctrl_release(struct kref *kref)
842 843 844 845 846 847 848 849
{
	struct pinctrl *p = container_of(kref, struct pinctrl, users);

	pinctrl_put_locked(p, true);
}

/**
 * pinctrl_put() - decrease use count on a previously claimed pinctrl handle
850
 * @p: the pinctrl handle to release
851
 */
852 853 854
void pinctrl_put(struct pinctrl *p)
{
	mutex_lock(&pinctrl_mutex);
855
	kref_put(&p->users, pinctrl_release);
856 857 858 859
	mutex_unlock(&pinctrl_mutex);
}
EXPORT_SYMBOL_GPL(pinctrl_put);

860 861
static struct pinctrl_state *pinctrl_lookup_state_locked(struct pinctrl *p,
							 const char *name)
862
{
863
	struct pinctrl_state *state;
864

865
	state = find_state(p, name);
866 867 868 869 870 871
	if (!state) {
		if (pinctrl_dummy_state) {
			/* create dummy state */
			dev_dbg(p->dev, "using pinctrl dummy state (%s)\n",
				name);
			state = create_state(p, name);
872 873
		} else
			state = ERR_PTR(-ENODEV);
874
	}
875

876
	return state;
877 878 879
}

/**
880 881 882
 * pinctrl_lookup_state() - retrieves a state handle from a pinctrl handle
 * @p: the pinctrl handle to retrieve the state from
 * @name: the state name to retrieve
883
 */
884
struct pinctrl_state *pinctrl_lookup_state(struct pinctrl *p, const char *name)
885
{
886 887
	struct pinctrl_state *s;

888
	mutex_lock(&pinctrl_mutex);
889
	s = pinctrl_lookup_state_locked(p, name);
890
	mutex_unlock(&pinctrl_mutex);
891 892

	return s;
893
}
894
EXPORT_SYMBOL_GPL(pinctrl_lookup_state);
895

896 897
static int pinctrl_select_state_locked(struct pinctrl *p,
				       struct pinctrl_state *state)
898
{
899 900
	struct pinctrl_setting *setting, *setting2;
	int ret;
901

902 903
	if (p->state == state)
		return 0;
904

905 906 907 908 909 910 911 912 913 914 915 916
	if (p->state) {
		/*
		 * The set of groups with a mux configuration in the old state
		 * may not be identical to the set of groups with a mux setting
		 * in the new state. While this might be unusual, it's entirely
		 * possible for the "user"-supplied mapping table to be written
		 * that way. For each group that was configured in the old state
		 * but not in the new state, this code puts that group into a
		 * safe/disabled state.
		 */
		list_for_each_entry(setting, &p->state->settings, node) {
			bool found = false;
917 918
			if (setting->type != PIN_MAP_TYPE_MUX_GROUP)
				continue;
919
			list_for_each_entry(setting2, &state->settings, node) {
920 921 922 923
				if (setting2->type != PIN_MAP_TYPE_MUX_GROUP)
					continue;
				if (setting2->data.mux.group ==
						setting->data.mux.group) {
924 925 926 927 928 929 930 931 932 933 934 935 936
					found = true;
					break;
				}
			}
			if (!found)
				pinmux_disable_setting(setting);
		}
	}

	p->state = state;

	/* Apply all the settings for the new state */
	list_for_each_entry(setting, &state->settings, node) {
937 938 939 940 941 942 943 944 945 946 947 948
		switch (setting->type) {
		case PIN_MAP_TYPE_MUX_GROUP:
			ret = pinmux_enable_setting(setting);
			break;
		case PIN_MAP_TYPE_CONFIGS_PIN:
		case PIN_MAP_TYPE_CONFIGS_GROUP:
			ret = pinconf_apply_setting(setting);
			break;
		default:
			ret = -EINVAL;
			break;
		}
949 950 951 952
		if (ret < 0) {
			/* FIXME: Difficult to return to prev state */
			return ret;
		}
953
	}
954 955

	return 0;
956 957 958
}

/**
959 960 961
 * pinctrl_select() - select/activate/program a pinctrl state to HW
 * @p: the pinctrl handle for the device that requests configuratio
 * @state: the state handle to select/activate/program
962
 */
963
int pinctrl_select_state(struct pinctrl *p, struct pinctrl_state *state)
964
{
965 966
	int ret;

967
	mutex_lock(&pinctrl_mutex);
968
	ret = pinctrl_select_state_locked(p, state);
969
	mutex_unlock(&pinctrl_mutex);
970 971

	return ret;
972
}
973
EXPORT_SYMBOL_GPL(pinctrl_select_state);
974

975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
static void devm_pinctrl_release(struct device *dev, void *res)
{
	pinctrl_put(*(struct pinctrl **)res);
}

/**
 * struct devm_pinctrl_get() - Resource managed pinctrl_get()
 * @dev: the device to obtain the handle for
 *
 * If there is a need to explicitly destroy the returned struct pinctrl,
 * devm_pinctrl_put() should be used, rather than plain pinctrl_put().
 */
struct pinctrl *devm_pinctrl_get(struct device *dev)
{
	struct pinctrl **ptr, *p;

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

	p = pinctrl_get(dev);
	if (!IS_ERR(p)) {
		*ptr = p;
		devres_add(dev, ptr);
	} else {
		devres_free(ptr);
	}

	return p;
}
EXPORT_SYMBOL_GPL(devm_pinctrl_get);

static int devm_pinctrl_match(struct device *dev, void *res, void *data)
{
	struct pinctrl **p = res;

	return *p == data;
}

/**
 * devm_pinctrl_put() - Resource managed pinctrl_put()
 * @p: the pinctrl handle to release
 *
 * Deallocate a struct pinctrl obtained via devm_pinctrl_get(). Normally
 * this function will not need to be called and the resource management
 * code will ensure that the resource is freed.
 */
void devm_pinctrl_put(struct pinctrl *p)
{
1024
	WARN_ON(devres_release(p->dev, devm_pinctrl_release,
1025 1026 1027 1028
			       devm_pinctrl_match, p));
}
EXPORT_SYMBOL_GPL(devm_pinctrl_put);

1029 1030
int pinctrl_register_map(struct pinctrl_map const *maps, unsigned num_maps,
			 bool dup, bool locked)
1031
{
1032
	int i, ret;
1033
	struct pinctrl_maps *maps_node;
1034 1035 1036 1037 1038

	pr_debug("add %d pinmux maps\n", num_maps);

	/* First sanity check the new mapping */
	for (i = 0; i < num_maps; i++) {
1039 1040 1041 1042 1043 1044
		if (!maps[i].dev_name) {
			pr_err("failed to register map %s (%d): no device given\n",
			       maps[i].name, i);
			return -EINVAL;
		}

1045 1046
		if (!maps[i].name) {
			pr_err("failed to register map %d: no map name given\n",
1047
			       i);
1048 1049 1050
			return -EINVAL;
		}

1051 1052
		if (maps[i].type != PIN_MAP_TYPE_DUMMY_STATE &&
				!maps[i].ctrl_dev_name) {
1053 1054 1055 1056 1057
			pr_err("failed to register map %s (%d): no pin control device given\n",
			       maps[i].name, i);
			return -EINVAL;
		}

1058 1059 1060 1061 1062 1063
		switch (maps[i].type) {
		case PIN_MAP_TYPE_DUMMY_STATE:
			break;
		case PIN_MAP_TYPE_MUX_GROUP:
			ret = pinmux_validate_map(&maps[i], i);
			if (ret < 0)
1064
				return ret;
1065 1066 1067 1068 1069
			break;
		case PIN_MAP_TYPE_CONFIGS_PIN:
		case PIN_MAP_TYPE_CONFIGS_GROUP:
			ret = pinconf_validate_map(&maps[i], i);
			if (ret < 0)
1070
				return ret;
1071 1072 1073
			break;
		default:
			pr_err("failed to register map %s (%d): invalid type given\n",
1074
			       maps[i].name, i);
1075 1076
			return -EINVAL;
		}
1077 1078
	}

1079 1080 1081 1082 1083
	maps_node = kzalloc(sizeof(*maps_node), GFP_KERNEL);
	if (!maps_node) {
		pr_err("failed to alloc struct pinctrl_maps\n");
		return -ENOMEM;
	}
1084

1085
	maps_node->num_maps = num_maps;
1086 1087 1088 1089 1090 1091 1092 1093 1094 1095
	if (dup) {
		maps_node->maps = kmemdup(maps, sizeof(*maps) * num_maps,
					  GFP_KERNEL);
		if (!maps_node->maps) {
			pr_err("failed to duplicate mapping table\n");
			kfree(maps_node);
			return -ENOMEM;
		}
	} else {
		maps_node->maps = maps;
1096 1097
	}

1098 1099
	if (!locked)
		mutex_lock(&pinctrl_mutex);
1100
	list_add_tail(&maps_node->node, &pinctrl_maps);
1101 1102
	if (!locked)
		mutex_unlock(&pinctrl_mutex);
1103

1104 1105 1106
	return 0;
}

1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131
/**
 * pinctrl_register_mappings() - register a set of pin controller mappings
 * @maps: the pincontrol mappings table to register. This should probably be
 *	marked with __initdata so it can be discarded after boot. This
 *	function will perform a shallow copy for the mapping entries.
 * @num_maps: the number of maps in the mapping table
 */
int pinctrl_register_mappings(struct pinctrl_map const *maps,
			      unsigned num_maps)
{
	return pinctrl_register_map(maps, num_maps, true, false);
}

void pinctrl_unregister_map(struct pinctrl_map const *map)
{
	struct pinctrl_maps *maps_node;

	list_for_each_entry(maps_node, &pinctrl_maps, node) {
		if (maps_node->maps == map) {
			list_del(&maps_node->node);
			return;
		}
	}
}

1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
/**
 * pinctrl_force_sleep() - turn a given controller device into sleep state
 * @pctldev: pin controller device
 */
int pinctrl_force_sleep(struct pinctrl_dev *pctldev)
{
	if (!IS_ERR(pctldev->p) && !IS_ERR(pctldev->hog_sleep))
		return pinctrl_select_state(pctldev->p, pctldev->hog_sleep);
	return 0;
}
EXPORT_SYMBOL_GPL(pinctrl_force_sleep);

/**
 * pinctrl_force_default() - turn a given controller device into default state
 * @pctldev: pin controller device
 */
int pinctrl_force_default(struct pinctrl_dev *pctldev)
{
	if (!IS_ERR(pctldev->p) && !IS_ERR(pctldev->hog_default))
		return pinctrl_select_state(pctldev->p, pctldev->hog_default);
	return 0;
}
EXPORT_SYMBOL_GPL(pinctrl_force_default);

1156 1157 1158 1159 1160 1161
#ifdef CONFIG_DEBUG_FS

static int pinctrl_pins_show(struct seq_file *s, void *what)
{
	struct pinctrl_dev *pctldev = s->private;
	const struct pinctrl_ops *ops = pctldev->desc->pctlops;
1162
	unsigned i, pin;
1163 1164 1165

	seq_printf(s, "registered pins: %d\n", pctldev->desc->npins);

1166 1167
	mutex_lock(&pinctrl_mutex);

1168 1169
	/* The pin number can be retrived from the pin controller descriptor */
	for (i = 0; i < pctldev->desc->npins; i++) {
1170 1171
		struct pin_desc *desc;

1172
		pin = pctldev->desc->pins[i].number;
1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187
		desc = pin_desc_get(pctldev, pin);
		/* Pin space may be sparse */
		if (desc == NULL)
			continue;

		seq_printf(s, "pin %d (%s) ", pin,
			   desc->name ? desc->name : "unnamed");

		/* Driver-specific info per pin */
		if (ops->pin_dbg_show)
			ops->pin_dbg_show(pctldev, s, pin);

		seq_puts(s, "\n");
	}

1188 1189
	mutex_unlock(&pinctrl_mutex);

1190 1191 1192 1193 1194 1195 1196
	return 0;
}

static int pinctrl_groups_show(struct seq_file *s, void *what)
{
	struct pinctrl_dev *pctldev = s->private;
	const struct pinctrl_ops *ops = pctldev->desc->pctlops;
1197
	unsigned ngroups, selector = 0;
1198

1199
	ngroups = ops->get_groups_count(pctldev);
1200 1201
	mutex_lock(&pinctrl_mutex);

1202
	seq_puts(s, "registered pin groups:\n");
1203
	while (selector < ngroups) {
1204
		const unsigned *pins;
1205 1206
		unsigned num_pins;
		const char *gname = ops->get_group_name(pctldev, selector);
1207
		const char *pname;
1208 1209 1210 1211 1212 1213 1214 1215 1216
		int ret;
		int i;

		ret = ops->get_group_pins(pctldev, selector,
					  &pins, &num_pins);
		if (ret)
			seq_printf(s, "%s [ERROR GETTING PINS]\n",
				   gname);
		else {
1217 1218 1219
			seq_printf(s, "group: %s\n", gname);
			for (i = 0; i < num_pins; i++) {
				pname = pin_get_name(pctldev, pins[i]);
1220 1221
				if (WARN_ON(!pname)) {
					mutex_unlock(&pinctrl_mutex);
1222
					return -EINVAL;
1223
				}
1224 1225 1226
				seq_printf(s, "pin %d (%s)\n", pins[i], pname);
			}
			seq_puts(s, "\n");
1227 1228 1229 1230
		}
		selector++;
	}

1231
	mutex_unlock(&pinctrl_mutex);
1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242

	return 0;
}

static int pinctrl_gpioranges_show(struct seq_file *s, void *what)
{
	struct pinctrl_dev *pctldev = s->private;
	struct pinctrl_gpio_range *range = NULL;

	seq_puts(s, "GPIO ranges handled:\n");

1243 1244
	mutex_lock(&pinctrl_mutex);

1245 1246
	/* Loop over the ranges */
	list_for_each_entry(range, &pctldev->gpio_ranges, node) {
1247 1248 1249 1250 1251
		seq_printf(s, "%u: %s GPIOS [%u - %u] PINS [%u - %u]\n",
			   range->id, range->name,
			   range->base, (range->base + range->npins - 1),
			   range->pin_base,
			   (range->pin_base + range->npins - 1));
1252
	}
1253 1254

	mutex_unlock(&pinctrl_mutex);
1255 1256 1257 1258 1259 1260 1261 1262

	return 0;
}

static int pinctrl_devices_show(struct seq_file *s, void *what)
{
	struct pinctrl_dev *pctldev;

1263
	seq_puts(s, "name [pinmux] [pinconf]\n");
1264 1265 1266

	mutex_lock(&pinctrl_mutex);

1267 1268 1269
	list_for_each_entry(pctldev, &pinctrldev_list, node) {
		seq_printf(s, "%s ", pctldev->desc->name);
		if (pctldev->desc->pmxops)
1270 1271 1272 1273
			seq_puts(s, "yes ");
		else
			seq_puts(s, "no ");
		if (pctldev->desc->confops)
1274 1275 1276 1277 1278
			seq_puts(s, "yes");
		else
			seq_puts(s, "no");
		seq_puts(s, "\n");
	}
1279 1280

	mutex_unlock(&pinctrl_mutex);
1281 1282 1283 1284

	return 0;
}

1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300
static inline const char *map_type(enum pinctrl_map_type type)
{
	static const char * const names[] = {
		"INVALID",
		"DUMMY_STATE",
		"MUX_GROUP",
		"CONFIGS_PIN",
		"CONFIGS_GROUP",
	};

	if (type >= ARRAY_SIZE(names))
		return "UNKNOWN";

	return names[type];
}

1301 1302 1303 1304 1305 1306 1307 1308
static int pinctrl_maps_show(struct seq_file *s, void *what)
{
	struct pinctrl_maps *maps_node;
	int i;
	struct pinctrl_map const *map;

	seq_puts(s, "Pinctrl maps:\n");

1309 1310
	mutex_lock(&pinctrl_mutex);

1311
	for_each_maps(maps_node, i, map) {
1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332
		seq_printf(s, "device %s\nstate %s\ntype %s (%d)\n",
			   map->dev_name, map->name, map_type(map->type),
			   map->type);

		if (map->type != PIN_MAP_TYPE_DUMMY_STATE)
			seq_printf(s, "controlling device %s\n",
				   map->ctrl_dev_name);

		switch (map->type) {
		case PIN_MAP_TYPE_MUX_GROUP:
			pinmux_show_map(s, map);
			break;
		case PIN_MAP_TYPE_CONFIGS_PIN:
		case PIN_MAP_TYPE_CONFIGS_GROUP:
			pinconf_show_map(s, map);
			break;
		default:
			break;
		}

		seq_printf(s, "\n");
1333
	}
1334 1335

	mutex_unlock(&pinctrl_mutex);
1336 1337 1338 1339

	return 0;
}

1340 1341 1342
static int pinctrl_show(struct seq_file *s, void *what)
{
	struct pinctrl *p;
1343
	struct pinctrl_state *state;
1344
	struct pinctrl_setting *setting;
1345 1346

	seq_puts(s, "Requested pin control handlers their pinmux maps:\n");
1347 1348 1349

	mutex_lock(&pinctrl_mutex);

1350
	list_for_each_entry(p, &pinctrl_list, node) {
1351 1352 1353 1354 1355 1356
		seq_printf(s, "device: %s current state: %s\n",
			   dev_name(p->dev),
			   p->state ? p->state->name : "none");

		list_for_each_entry(state, &p->states, node) {
			seq_printf(s, "  state: %s\n", state->name);
1357

1358
			list_for_each_entry(setting, &state->settings, node) {
1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375
				struct pinctrl_dev *pctldev = setting->pctldev;

				seq_printf(s, "    type: %s controller %s ",
					   map_type(setting->type),
					   pinctrl_dev_get_name(pctldev));

				switch (setting->type) {
				case PIN_MAP_TYPE_MUX_GROUP:
					pinmux_show_setting(s, setting);
					break;
				case PIN_MAP_TYPE_CONFIGS_PIN:
				case PIN_MAP_TYPE_CONFIGS_GROUP:
					pinconf_show_setting(s, setting);
					break;
				default:
					break;
				}
1376
			}
1377 1378 1379
		}
	}

1380 1381
	mutex_unlock(&pinctrl_mutex);

1382 1383 1384
	return 0;
}

1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404
static int pinctrl_pins_open(struct inode *inode, struct file *file)
{
	return single_open(file, pinctrl_pins_show, inode->i_private);
}

static int pinctrl_groups_open(struct inode *inode, struct file *file)
{
	return single_open(file, pinctrl_groups_show, inode->i_private);
}

static int pinctrl_gpioranges_open(struct inode *inode, struct file *file)
{
	return single_open(file, pinctrl_gpioranges_show, inode->i_private);
}

static int pinctrl_devices_open(struct inode *inode, struct file *file)
{
	return single_open(file, pinctrl_devices_show, NULL);
}

1405 1406 1407 1408 1409
static int pinctrl_maps_open(struct inode *inode, struct file *file)
{
	return single_open(file, pinctrl_maps_show, NULL);
}

1410 1411 1412 1413 1414
static int pinctrl_open(struct inode *inode, struct file *file)
{
	return single_open(file, pinctrl_show, NULL);
}

1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435
static const struct file_operations pinctrl_pins_ops = {
	.open		= pinctrl_pins_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
};

static const struct file_operations pinctrl_groups_ops = {
	.open		= pinctrl_groups_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
};

static const struct file_operations pinctrl_gpioranges_ops = {
	.open		= pinctrl_gpioranges_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
};

1436 1437
static const struct file_operations pinctrl_devices_ops = {
	.open		= pinctrl_devices_open,
1438 1439 1440 1441 1442
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
};

1443 1444
static const struct file_operations pinctrl_maps_ops = {
	.open		= pinctrl_maps_open,
1445 1446 1447 1448 1449
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
};

1450 1451 1452 1453 1454 1455 1456
static const struct file_operations pinctrl_ops = {
	.open		= pinctrl_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= single_release,
};

1457 1458 1459 1460
static struct dentry *debugfs_root;

static void pinctrl_init_device_debugfs(struct pinctrl_dev *pctldev)
{
1461
	struct dentry *device_root;
1462

1463
	device_root = debugfs_create_dir(dev_name(pctldev->dev),
1464
					 debugfs_root);
1465 1466
	pctldev->device_root = device_root;

1467 1468
	if (IS_ERR(device_root) || !device_root) {
		pr_warn("failed to create debugfs directory for %s\n",
1469
			dev_name(pctldev->dev));
1470 1471 1472 1473 1474 1475 1476 1477 1478
		return;
	}
	debugfs_create_file("pins", S_IFREG | S_IRUGO,
			    device_root, pctldev, &pinctrl_pins_ops);
	debugfs_create_file("pingroups", S_IFREG | S_IRUGO,
			    device_root, pctldev, &pinctrl_groups_ops);
	debugfs_create_file("gpio-ranges", S_IFREG | S_IRUGO,
			    device_root, pctldev, &pinctrl_gpioranges_ops);
	pinmux_init_device_debugfs(device_root, pctldev);
1479
	pinconf_init_device_debugfs(device_root, pctldev);
1480 1481
}

1482 1483 1484 1485 1486
static void pinctrl_remove_device_debugfs(struct pinctrl_dev *pctldev)
{
	debugfs_remove_recursive(pctldev->device_root);
}

1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497
static void pinctrl_init_debugfs(void)
{
	debugfs_root = debugfs_create_dir("pinctrl", NULL);
	if (IS_ERR(debugfs_root) || !debugfs_root) {
		pr_warn("failed to create debugfs directory\n");
		debugfs_root = NULL;
		return;
	}

	debugfs_create_file("pinctrl-devices", S_IFREG | S_IRUGO,
			    debugfs_root, NULL, &pinctrl_devices_ops);
1498 1499
	debugfs_create_file("pinctrl-maps", S_IFREG | S_IRUGO,
			    debugfs_root, NULL, &pinctrl_maps_ops);
1500 1501
	debugfs_create_file("pinctrl-handles", S_IFREG | S_IRUGO,
			    debugfs_root, NULL, &pinctrl_ops);
1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513
}

#else /* CONFIG_DEBUG_FS */

static void pinctrl_init_device_debugfs(struct pinctrl_dev *pctldev)
{
}

static void pinctrl_init_debugfs(void)
{
}

1514 1515 1516 1517
static void pinctrl_remove_device_debugfs(struct pinctrl_dev *pctldev)
{
}

1518 1519
#endif

1520 1521 1522 1523 1524
static int pinctrl_check_ops(struct pinctrl_dev *pctldev)
{
	const struct pinctrl_ops *ops = pctldev->desc->pctlops;

	if (!ops ||
1525
	    !ops->get_groups_count ||
1526 1527 1528 1529
	    !ops->get_group_name ||
	    !ops->get_group_pins)
		return -EINVAL;

1530 1531 1532
	if (ops->dt_node_to_map && !ops->dt_free_map)
		return -EINVAL;

1533 1534 1535
	return 0;
}

1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547
/**
 * pinctrl_register() - register a pin controller device
 * @pctldesc: descriptor for this pin controller
 * @dev: parent device for this pin controller
 * @driver_data: private pin controller data for this pin controller
 */
struct pinctrl_dev *pinctrl_register(struct pinctrl_desc *pctldesc,
				    struct device *dev, void *driver_data)
{
	struct pinctrl_dev *pctldev;
	int ret;

1548
	if (!pctldesc)
1549
		return NULL;
1550
	if (!pctldesc->name)
1551 1552
		return NULL;

1553
	pctldev = kzalloc(sizeof(*pctldev), GFP_KERNEL);
1554 1555
	if (pctldev == NULL) {
		dev_err(dev, "failed to alloc struct pinctrl_dev\n");
1556
		return NULL;
1557
	}
1558 1559 1560 1561 1562 1563 1564 1565 1566

	/* Initialize pin control device struct */
	pctldev->owner = pctldesc->owner;
	pctldev->desc = pctldesc;
	pctldev->driver_data = driver_data;
	INIT_RADIX_TREE(&pctldev->pin_desc_tree, GFP_KERNEL);
	INIT_LIST_HEAD(&pctldev->gpio_ranges);
	pctldev->dev = dev;

1567
	/* check core ops for sanity */
1568
	if (pinctrl_check_ops(pctldev)) {
1569
		dev_err(dev, "pinctrl ops lacks necessary functions\n");
1570 1571 1572
		goto out_err;
	}

1573 1574
	/* If we're implementing pinmuxing, check the ops for sanity */
	if (pctldesc->pmxops) {
1575
		if (pinmux_check_ops(pctldev))
1576
			goto out_err;
1577 1578
	}

1579 1580
	/* If we're implementing pinconfig, check the ops for sanity */
	if (pctldesc->confops) {
1581
		if (pinconf_check_ops(pctldev))
1582
			goto out_err;
1583 1584
	}

1585
	/* Register all the pins */
1586
	dev_dbg(dev, "try to register %d pins ...\n",  pctldesc->npins);
1587 1588
	ret = pinctrl_register_pins(pctldev, pctldesc->pins, pctldesc->npins);
	if (ret) {
1589
		dev_err(dev, "error during pin registration\n");
1590 1591
		pinctrl_free_pindescs(pctldev, pctldesc->pins,
				      pctldesc->npins);
1592
		goto out_err;
1593 1594
	}

1595 1596
	mutex_lock(&pinctrl_mutex);

1597
	list_add_tail(&pctldev->node, &pinctrldev_list);
1598

1599 1600
	pctldev->p = pinctrl_get_locked(pctldev->dev);
	if (!IS_ERR(pctldev->p)) {
1601
		pctldev->hog_default =
1602 1603
			pinctrl_lookup_state_locked(pctldev->p,
						    PINCTRL_STATE_DEFAULT);
1604
		if (IS_ERR(pctldev->hog_default)) {
1605 1606
			dev_dbg(dev, "failed to lookup the default state\n");
		} else {
1607 1608
			if (pinctrl_select_state_locked(pctldev->p,
						pctldev->hog_default))
1609 1610 1611
				dev_err(dev,
					"failed to select default state\n");
		}
1612 1613 1614 1615 1616 1617

		pctldev->hog_sleep =
			pinctrl_lookup_state_locked(pctldev->p,
						    PINCTRL_STATE_SLEEP);
		if (IS_ERR(pctldev->hog_sleep))
			dev_dbg(dev, "failed to lookup the sleep state\n");
1618
	}
1619 1620 1621

	mutex_unlock(&pinctrl_mutex);

1622 1623
	pinctrl_init_device_debugfs(pctldev);

1624 1625
	return pctldev;

1626 1627
out_err:
	kfree(pctldev);
1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639
	return NULL;
}
EXPORT_SYMBOL_GPL(pinctrl_register);

/**
 * pinctrl_unregister() - unregister pinmux
 * @pctldev: pin controller to unregister
 *
 * Called by pinmux drivers to unregister a pinmux.
 */
void pinctrl_unregister(struct pinctrl_dev *pctldev)
{
1640
	struct pinctrl_gpio_range *range, *n;
1641 1642 1643
	if (pctldev == NULL)
		return;

1644
	pinctrl_remove_device_debugfs(pctldev);
1645 1646 1647

	mutex_lock(&pinctrl_mutex);

1648 1649
	if (!IS_ERR(pctldev->p))
		pinctrl_put_locked(pctldev->p, true);
1650

1651 1652 1653 1654 1655
	/* TODO: check that no pinmuxes are still active? */
	list_del(&pctldev->node);
	/* Destroy descriptor tree */
	pinctrl_free_pindescs(pctldev, pctldev->desc->pins,
			      pctldev->desc->npins);
1656 1657 1658 1659
	/* remove gpio ranges map */
	list_for_each_entry_safe(range, n, &pctldev->gpio_ranges, node)
		list_del(&range->node);

1660
	kfree(pctldev);
1661 1662

	mutex_unlock(&pinctrl_mutex);
1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674
}
EXPORT_SYMBOL_GPL(pinctrl_unregister);

static int __init pinctrl_init(void)
{
	pr_info("initialized pinctrl subsystem\n");
	pinctrl_init_debugfs();
	return 0;
}

/* init early since many drivers really need to initialized pinmux early */
core_initcall(pinctrl_init);