pinmux.c 21.2 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0-only
2 3 4
/*
 * Core driver for the pin muxing portions of the pin control subsystem
 *
5
 * Copyright (C) 2011-2012 ST-Ericsson SA
6 7 8 9 10
 * 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>
 *
11
 * Copyright (C) 2012 NVIDIA CORPORATION. All rights reserved.
12 13 14 15 16 17 18 19 20 21 22
 */
#define pr_fmt(fmt) "pinmux core: " fmt

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/init.h>
#include <linux/device.h>
#include <linux/slab.h>
#include <linux/radix-tree.h>
#include <linux/err.h>
#include <linux/list.h>
23
#include <linux/string.h>
24 25 26 27 28
#include <linux/debugfs.h>
#include <linux/seq_file.h>
#include <linux/pinctrl/machine.h>
#include <linux/pinctrl/pinmux.h>
#include "core.h"
29
#include "pinmux.h"
30

31 32 33
int pinmux_check_ops(struct pinctrl_dev *pctldev)
{
	const struct pinmux_ops *ops = pctldev->desc->pmxops;
34
	unsigned nfuncs;
35 36 37
	unsigned selector = 0;

	/* Check that we implement required operations */
38 39
	if (!ops ||
	    !ops->get_functions_count ||
40 41
	    !ops->get_function_name ||
	    !ops->get_function_groups ||
42
	    !ops->set_mux) {
43
		dev_err(pctldev->dev, "pinmux ops lacks necessary functions\n");
44
		return -EINVAL;
45
	}
46
	/* Check that all functions registered have names */
47
	nfuncs = ops->get_functions_count(pctldev);
48
	while (selector < nfuncs) {
49 50 51
		const char *fname = ops->get_function_name(pctldev,
							   selector);
		if (!fname) {
52
			dev_err(pctldev->dev, "pinmux ops has no name for function%u\n",
53 54 55 56 57 58 59 60 61
				selector);
			return -EINVAL;
		}
		selector++;
	}

	return 0;
}

62
int pinmux_validate_map(const struct pinctrl_map *map, int i)
63 64 65 66 67 68 69 70 71 72
{
	if (!map->data.mux.function) {
		pr_err("failed to register map %s (%d): no function given\n",
		       map->name, i);
		return -EINVAL;
	}

	return 0;
}

73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
/**
 * pinmux_can_be_used_for_gpio() - check if a specific pin
 *	is either muxed to a different function or used as gpio.
 *
 * @pin: the pin number in the global pin space
 *
 * Controllers not defined as strict will always return true,
 * menaning that the gpio can be used.
 */
bool pinmux_can_be_used_for_gpio(struct pinctrl_dev *pctldev, unsigned pin)
{
	struct pin_desc *desc = pin_desc_get(pctldev, pin);
	const struct pinmux_ops *ops = pctldev->desc->pmxops;

	/* Can't inspect pin, assume it can be used */
88
	if (!desc || !ops)
89 90 91 92 93 94 95 96
		return true;

	if (ops->strict && desc->mux_usecount)
		return false;

	return !(ops->strict && !!desc->gpio_owner);
}

97 98 99
/**
 * pin_request() - request a single pin to be muxed in, typically for GPIO
 * @pin: the pin number in the global pin space
100 101
 * @owner: a representation of the owner of this pin; typically the device
 *	name that controls its mux function, or the requested GPIO name
102 103 104 105
 * @gpio_range: the range matching the GPIO pin if this is a request for a
 *	single GPIO pin
 */
static int pin_request(struct pinctrl_dev *pctldev,
106
		       int pin, const char *owner,
107 108 109 110 111 112 113 114
		       struct pinctrl_gpio_range *gpio_range)
{
	struct pin_desc *desc;
	const struct pinmux_ops *ops = pctldev->desc->pmxops;
	int status = -EINVAL;

	desc = pin_desc_get(pctldev, pin);
	if (desc == NULL) {
115
		dev_err(pctldev->dev,
116 117
			"pin %d is not registered so it cannot be requested\n",
			pin);
118 119 120
		goto out;
	}

121 122 123
	dev_dbg(pctldev->dev, "request pin %d (%s) for %s\n",
		pin, desc->name, owner);

124 125 126 127 128 129 130 131 132 133 134 135 136 137
	if ((!gpio_range || ops->strict) &&
	    desc->mux_usecount && strcmp(desc->mux_owner, owner)) {
		dev_err(pctldev->dev,
			"pin %s already requested by %s; cannot claim for %s\n",
			desc->name, desc->mux_owner, owner);
		goto out;
	}

	if ((gpio_range || ops->strict) && desc->gpio_owner) {
		dev_err(pctldev->dev,
			"pin %s already requested by %s; cannot claim for %s\n",
			desc->name, desc->gpio_owner, owner);
		goto out;
	}
138

139
	if (gpio_range) {
140 141 142 143 144 145 146 147
		desc->gpio_owner = owner;
	} else {
		desc->mux_usecount++;
		if (desc->mux_usecount > 1)
			return 0;

		desc->mux_owner = owner;
	}
148 149 150

	/* Let each pin increase references to this module */
	if (!try_module_get(pctldev->owner)) {
151
		dev_err(pctldev->dev,
152 153 154 155 156 157 158 159 160 161
			"could not increase module refcount for pin %d\n",
			pin);
		status = -EINVAL;
		goto out_free_pin;
	}

	/*
	 * If there is no kind of request function for the pin we just assume
	 * we got it by default and proceed.
	 */
162
	if (gpio_range && ops->gpio_request_enable)
163 164 165 166 167 168 169
		/* This requests and enables a single GPIO pin */
		status = ops->gpio_request_enable(pctldev, gpio_range, pin);
	else if (ops->request)
		status = ops->request(pctldev, pin);
	else
		status = 0;

170
	if (status) {
171
		dev_err(pctldev->dev, "request() failed for pin %d\n", pin);
172 173 174
		module_put(pctldev->owner);
	}

175
out_free_pin:
176
	if (status) {
177 178 179 180 181 182 183
		if (gpio_range) {
			desc->gpio_owner = NULL;
		} else {
			desc->mux_usecount--;
			if (!desc->mux_usecount)
				desc->mux_owner = NULL;
		}
184
	}
185 186
out:
	if (status)
187
		dev_err(pctldev->dev, "pin-%d (%s) status %d\n",
188
			pin, owner, status);
189 190 191 192 193 194 195 196

	return status;
}

/**
 * pin_free() - release a single muxed in pin so something else can be muxed
 * @pctldev: pin controller device handling this pin
 * @pin: the pin to free
197 198
 * @gpio_range: the range matching the GPIO pin if this is a request for a
 *	single GPIO pin
L
Linus Walleij 已提交
199
 *
200 201
 * This function returns a pointer to the previous owner. This is used
 * for callers that dynamically allocate an owner name so it can be freed
L
Linus Walleij 已提交
202
 * once the pin is free. This is done for GPIO request functions.
203
 */
204 205
static const char *pin_free(struct pinctrl_dev *pctldev, int pin,
			    struct pinctrl_gpio_range *gpio_range)
206 207 208
{
	const struct pinmux_ops *ops = pctldev->desc->pmxops;
	struct pin_desc *desc;
209
	const char *owner;
210 211 212

	desc = pin_desc_get(pctldev, pin);
	if (desc == NULL) {
213
		dev_err(pctldev->dev,
214
			"pin is not registered so it cannot be freed\n");
215
		return NULL;
216 217
	}

218
	if (!gpio_range) {
219 220 221 222 223
		/*
		 * A pin should not be freed more times than allocated.
		 */
		if (WARN_ON(!desc->mux_usecount))
			return NULL;
224 225 226 227
		desc->mux_usecount--;
		if (desc->mux_usecount)
			return NULL;
	}
228

229 230 231 232 233 234 235
	/*
	 * If there is no kind of request function for the pin we just assume
	 * we got it by default and proceed.
	 */
	if (gpio_range && ops->gpio_disable_free)
		ops->gpio_disable_free(pctldev, gpio_range, pin);
	else if (ops->free)
236 237
		ops->free(pctldev, pin);

238 239 240 241 242 243 244 245 246
	if (gpio_range) {
		owner = desc->gpio_owner;
		desc->gpio_owner = NULL;
	} else {
		owner = desc->mux_owner;
		desc->mux_owner = NULL;
		desc->mux_setting = NULL;
	}

247
	module_put(pctldev->owner);
248

249
	return owner;
250 251 252
}

/**
253 254 255 256
 * pinmux_request_gpio() - request pinmuxing for a GPIO pin
 * @pctldev: pin controller device affected
 * @pin: the pin to mux in for GPIO
 * @range: the applicable GPIO range
257
 */
258 259 260
int pinmux_request_gpio(struct pinctrl_dev *pctldev,
			struct pinctrl_gpio_range *range,
			unsigned pin, unsigned gpio)
261
{
262
	const char *owner;
263 264 265
	int ret;

	/* Conjure some name stating what chip and pin this is taken by */
266
	owner = kasprintf(GFP_KERNEL, "%s:%d", range->name, gpio);
267
	if (!owner)
268
		return -ENOMEM;
269

270
	ret = pin_request(pctldev, pin, owner, range);
271
	if (ret < 0)
272
		kfree(owner);
273 274

	return ret;
275 276 277
}

/**
278 279 280 281
 * pinmux_free_gpio() - release a pin from GPIO muxing
 * @pctldev: the pin controller device for the pin
 * @pin: the affected currently GPIO-muxed in pin
 * @range: applicable GPIO range
282
 */
283 284
void pinmux_free_gpio(struct pinctrl_dev *pctldev, unsigned pin,
		      struct pinctrl_gpio_range *range)
285
{
286
	const char *owner;
287

288 289
	owner = pin_free(pctldev, pin, range);
	kfree(owner);
290 291
}

292 293 294 295 296 297 298 299 300 301
/**
 * pinmux_gpio_direction() - set the direction of a single muxed-in GPIO pin
 * @pctldev: the pin controller handling this pin
 * @range: applicable GPIO range
 * @pin: the affected GPIO pin in this controller
 * @input: true if we set the pin as input, false for output
 */
int pinmux_gpio_direction(struct pinctrl_dev *pctldev,
			  struct pinctrl_gpio_range *range,
			  unsigned pin, bool input)
302 303 304 305 306 307 308 309 310 311 312 313 314 315
{
	const struct pinmux_ops *ops;
	int ret;

	ops = pctldev->desc->pmxops;

	if (ops->gpio_set_direction)
		ret = ops->gpio_set_direction(pctldev, range, pin, input);
	else
		ret = 0;

	return ret;
}

316 317
static int pinmux_func_name_to_selector(struct pinctrl_dev *pctldev,
					const char *function)
318 319
{
	const struct pinmux_ops *ops = pctldev->desc->pmxops;
320
	unsigned nfuncs = ops->get_functions_count(pctldev);
321 322 323
	unsigned selector = 0;

	/* See if this pctldev has this function */
324
	while (selector < nfuncs) {
325
		const char *fname = ops->get_function_name(pctldev, selector);
326

327 328
		if (!strcmp(function, fname))
			return selector;
329 330 331 332 333 334 335

		selector++;
	}

	return -EINVAL;
}

336
int pinmux_map_to_setting(const struct pinctrl_map *map,
337
			  struct pinctrl_setting *setting)
338
{
339 340 341 342
	struct pinctrl_dev *pctldev = setting->pctldev;
	const struct pinmux_ops *pmxops = pctldev->desc->pmxops;
	char const * const *groups;
	unsigned num_groups;
343
	int ret;
344
	const char *group;
345

346 347 348 349 350
	if (!pmxops) {
		dev_err(pctldev->dev, "does not support mux function\n");
		return -EINVAL;
	}

351
	ret = pinmux_func_name_to_selector(pctldev, map->data.mux.function);
352 353 354
	if (ret < 0) {
		dev_err(pctldev->dev, "invalid function %s in map table\n",
			map->data.mux.function);
355
		return ret;
356
	}
357
	setting->data.mux.func = ret;
358

359
	ret = pmxops->get_function_groups(pctldev, setting->data.mux.func,
360
					  &groups, &num_groups);
361 362 363
	if (ret < 0) {
		dev_err(pctldev->dev, "can't query groups for function %s\n",
			map->data.mux.function);
364
		return ret;
365 366 367 368 369
	}
	if (!num_groups) {
		dev_err(pctldev->dev,
			"function %s can't be selected on any group\n",
			map->data.mux.function);
370
		return -EINVAL;
371
	}
372 373
	if (map->data.mux.group) {
		group = map->data.mux.group;
374 375
		ret = match_string(groups, num_groups, group);
		if (ret < 0) {
376 377 378
			dev_err(pctldev->dev,
				"invalid group \"%s\" for function \"%s\"\n",
				group, map->data.mux.function);
379
			return ret;
380
		}
381 382
	} else {
		group = groups[0];
383 384
	}

385
	ret = pinctrl_get_group_selector(pctldev, group);
386 387 388
	if (ret < 0) {
		dev_err(pctldev->dev, "invalid group %s in map table\n",
			map->data.mux.group);
389
		return ret;
390
	}
391
	setting->data.mux.group = ret;
392 393 394 395

	return 0;
}

396
void pinmux_free_setting(const struct pinctrl_setting *setting)
397
{
398
	/* This function is currently unused */
399 400
}

401
int pinmux_enable_setting(const struct pinctrl_setting *setting)
402
{
403
	struct pinctrl_dev *pctldev = setting->pctldev;
404
	const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
405
	const struct pinmux_ops *ops = pctldev->desc->pmxops;
406 407 408
	int ret = 0;
	const unsigned *pins = NULL;
	unsigned num_pins = 0;
409 410 411
	int i;
	struct pin_desc *desc;

412 413 414 415
	if (pctlops->get_group_pins)
		ret = pctlops->get_group_pins(pctldev, setting->data.mux.group,
					      &pins, &num_pins);

416
	if (ret) {
417 418
		const char *gname;

419
		/* errors only affect debug data, so just warn */
420 421
		gname = pctlops->get_group_name(pctldev,
						setting->data.mux.group);
422
		dev_warn(pctldev->dev,
423 424
			 "could not get pins for group %s\n",
			 gname);
425 426 427
		num_pins = 0;
	}

428 429 430 431
	/* Try to allocate all pins in this group, one by one */
	for (i = 0; i < num_pins; i++) {
		ret = pin_request(pctldev, pins[i], setting->dev_name, NULL);
		if (ret) {
432 433 434 435 436 437 438
			const char *gname;
			const char *pname;

			desc = pin_desc_get(pctldev, pins[i]);
			pname = desc ? desc->name : "non-existing";
			gname = pctlops->get_group_name(pctldev,
						setting->data.mux.group);
439
			dev_err(pctldev->dev,
440 441 442 443
				"could not request pin %d (%s) from group %s "
				" on device %s\n",
				pins[i], pname, gname,
				pinctrl_dev_get_name(pctldev));
444
			goto err_pin_request;
445 446 447 448
		}
	}

	/* Now that we have acquired the pins, encode the mux setting */
449 450 451 452 453 454 455 456 457 458
	for (i = 0; i < num_pins; i++) {
		desc = pin_desc_get(pctldev, pins[i]);
		if (desc == NULL) {
			dev_warn(pctldev->dev,
				 "could not get pin desc for pin %d\n",
				 pins[i]);
			continue;
		}
		desc->mux_setting = &(setting->data.mux);
	}
459

460 461
	ret = ops->set_mux(pctldev, setting->data.mux.func,
			   setting->data.mux.group);
462 463

	if (ret)
464
		goto err_set_mux;
465 466 467

	return 0;

468
err_set_mux:
469 470 471 472 473 474 475 476 477 478 479
	for (i = 0; i < num_pins; i++) {
		desc = pin_desc_get(pctldev, pins[i]);
		if (desc)
			desc->mux_setting = NULL;
	}
err_pin_request:
	/* On error release all taken pins */
	while (--i >= 0)
		pin_free(pctldev, pins[i], NULL);

	return ret;
480 481
}

482
void pinmux_disable_setting(const struct pinctrl_setting *setting)
483
{
484
	struct pinctrl_dev *pctldev = setting->pctldev;
485
	const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
486 487 488
	int ret = 0;
	const unsigned *pins = NULL;
	unsigned num_pins = 0;
489 490 491
	int i;
	struct pin_desc *desc;

492 493 494
	if (pctlops->get_group_pins)
		ret = pctlops->get_group_pins(pctldev, setting->data.mux.group,
					      &pins, &num_pins);
495
	if (ret) {
496 497
		const char *gname;

498
		/* errors only affect debug data, so just warn */
499 500
		gname = pctlops->get_group_name(pctldev,
						setting->data.mux.group);
501
		dev_warn(pctldev->dev,
502 503
			 "could not get pins for group %s\n",
			 gname);
504 505 506
		num_pins = 0;
	}

507
	/* Flag the descs that no setting is active */
508 509 510 511 512 513 514 515
	for (i = 0; i < num_pins; i++) {
		desc = pin_desc_get(pctldev, pins[i]);
		if (desc == NULL) {
			dev_warn(pctldev->dev,
				 "could not get pin desc for pin %d\n",
				 pins[i]);
			continue;
		}
516 517
		if (desc->mux_setting == &(setting->data.mux)) {
			pin_free(pctldev, pins[i], NULL);
518 519 520 521 522 523 524 525 526
		} else {
			const char *gname;

			gname = pctlops->get_group_name(pctldev,
						setting->data.mux.group);
			dev_warn(pctldev->dev,
				 "not freeing pin %d (%s) as part of "
				 "deactivating group %s - it is already "
				 "used for some other setting",
527
				 pins[i], desc->name, gname);
528
		}
529
	}
530 531 532 533 534 535 536 537 538
}

#ifdef CONFIG_DEBUG_FS

/* Called from pincontrol core */
static int pinmux_functions_show(struct seq_file *s, void *what)
{
	struct pinctrl_dev *pctldev = s->private;
	const struct pinmux_ops *pmxops = pctldev->desc->pmxops;
539
	unsigned nfuncs;
540 541
	unsigned func_selector = 0;

542 543
	if (!pmxops)
		return 0;
544

545
	mutex_lock(&pctldev->mutex);
546
	nfuncs = pmxops->get_functions_count(pctldev);
547
	while (func_selector < nfuncs) {
548 549 550 551 552 553 554 555 556
		const char *func = pmxops->get_function_name(pctldev,
							  func_selector);
		const char * const *groups;
		unsigned num_groups;
		int ret;
		int i;

		ret = pmxops->get_function_groups(pctldev, func_selector,
						  &groups, &num_groups);
557
		if (ret) {
558 559
			seq_printf(s, "function %s: COULD NOT GET GROUPS\n",
				   func);
560 561 562
			func_selector++;
			continue;
		}
563 564 565 566 567 568 569 570 571

		seq_printf(s, "function: %s, groups = [ ", func);
		for (i = 0; i < num_groups; i++)
			seq_printf(s, "%s ", groups[i]);
		seq_puts(s, "]\n");

		func_selector++;
	}

572
	mutex_unlock(&pctldev->mutex);
573

574 575 576 577 578 579
	return 0;
}

static int pinmux_pins_show(struct seq_file *s, void *what)
{
	struct pinctrl_dev *pctldev = s->private;
580 581
	const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
	const struct pinmux_ops *pmxops = pctldev->desc->pmxops;
582
	unsigned i, pin;
583

584 585 586
	if (!pmxops)
		return 0;

587
	seq_puts(s, "Pinmux settings per pin\n");
588 589 590 591 592 593
	if (pmxops->strict)
		seq_puts(s,
		 "Format: pin (name): mux_owner|gpio_owner (strict) hog?\n");
	else
		seq_puts(s,
		"Format: pin (name): mux_owner gpio_owner hog?\n");
594

595
	mutex_lock(&pctldev->mutex);
596

597 598
	/* The pin number can be retrived from the pin controller descriptor */
	for (i = 0; i < pctldev->desc->npins; i++) {
599
		struct pin_desc *desc;
600
		bool is_hog = false;
601

602
		pin = pctldev->desc->pins[i].number;
603
		desc = pin_desc_get(pctldev, pin);
604
		/* Skip if we cannot search the pin */
605 606 607
		if (desc == NULL)
			continue;

608 609
		if (desc->mux_owner &&
		    !strcmp(desc->mux_owner, pinctrl_dev_get_name(pctldev)))
610 611
			is_hog = true;

612 613 614
		if (pmxops->strict) {
			if (desc->mux_owner)
				seq_printf(s, "pin %d (%s): device %s%s",
615
					   pin, desc->name, desc->mux_owner,
616 617 618
					   is_hog ? " (HOG)" : "");
			else if (desc->gpio_owner)
				seq_printf(s, "pin %d (%s): GPIO %s",
619
					   pin, desc->name, desc->gpio_owner);
620 621
			else
				seq_printf(s, "pin %d (%s): UNCLAIMED",
622
					   pin, desc->name);
623 624
		} else {
			/* For non-strict controllers */
625
			seq_printf(s, "pin %d (%s): %s %s%s", pin, desc->name,
626 627 628 629 630 631
				   desc->mux_owner ? desc->mux_owner
				   : "(MUX UNCLAIMED)",
				   desc->gpio_owner ? desc->gpio_owner
				   : "(GPIO UNCLAIMED)",
				   is_hog ? " (HOG)" : "");
		}
632

633
		/* If mux: print function+group claiming the pin */
634 635 636 637 638 639 640
		if (desc->mux_setting)
			seq_printf(s, " function %s group %s\n",
				   pmxops->get_function_name(pctldev,
					desc->mux_setting->func),
				   pctlops->get_group_name(pctldev,
					desc->mux_setting->group));
		else
641
			seq_putc(s, '\n');
642 643
	}

644
	mutex_unlock(&pctldev->mutex);
645

646 647 648
	return 0;
}

649
void pinmux_show_map(struct seq_file *s, const struct pinctrl_map *map)
650 651 652 653 654 655 656
{
	seq_printf(s, "group %s\nfunction %s\n",
		map->data.mux.group ? map->data.mux.group : "(default)",
		map->data.mux.function);
}

void pinmux_show_setting(struct seq_file *s,
657
			 const struct pinctrl_setting *setting)
658
{
659 660 661 662
	struct pinctrl_dev *pctldev = setting->pctldev;
	const struct pinmux_ops *pmxops = pctldev->desc->pmxops;
	const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;

663 664 665 666 667
	seq_printf(s, "group: %s (%u) function: %s (%u)\n",
		   pctlops->get_group_name(pctldev, setting->data.mux.group),
		   setting->data.mux.group,
		   pmxops->get_function_name(pctldev, setting->data.mux.func),
		   setting->data.mux.func);
668 669
}

670 671
DEFINE_SHOW_ATTRIBUTE(pinmux_functions);
DEFINE_SHOW_ATTRIBUTE(pinmux_pins);
672 673 674 675 676

void pinmux_init_device_debugfs(struct dentry *devroot,
			 struct pinctrl_dev *pctldev)
{
	debugfs_create_file("pinmux-functions", S_IFREG | S_IRUGO,
677
			    devroot, pctldev, &pinmux_functions_fops);
678
	debugfs_create_file("pinmux-pins", S_IFREG | S_IRUGO,
679
			    devroot, pctldev, &pinmux_pins_fops);
680 681 682
}

#endif /* CONFIG_DEBUG_FS */
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763

#ifdef CONFIG_GENERIC_PINMUX_FUNCTIONS

/**
 * pinmux_generic_get_function_count() - returns number of functions
 * @pctldev: pin controller device
 */
int pinmux_generic_get_function_count(struct pinctrl_dev *pctldev)
{
	return pctldev->num_functions;
}
EXPORT_SYMBOL_GPL(pinmux_generic_get_function_count);

/**
 * pinmux_generic_get_function_name() - returns the function name
 * @pctldev: pin controller device
 * @selector: function number
 */
const char *
pinmux_generic_get_function_name(struct pinctrl_dev *pctldev,
				 unsigned int selector)
{
	struct function_desc *function;

	function = radix_tree_lookup(&pctldev->pin_function_tree,
				     selector);
	if (!function)
		return NULL;

	return function->name;
}
EXPORT_SYMBOL_GPL(pinmux_generic_get_function_name);

/**
 * pinmux_generic_get_function_groups() - gets the function groups
 * @pctldev: pin controller device
 * @selector: function number
 * @groups: array of pin groups
 * @num_groups: number of pin groups
 */
int pinmux_generic_get_function_groups(struct pinctrl_dev *pctldev,
				       unsigned int selector,
				       const char * const **groups,
				       unsigned * const num_groups)
{
	struct function_desc *function;

	function = radix_tree_lookup(&pctldev->pin_function_tree,
				     selector);
	if (!function) {
		dev_err(pctldev->dev, "%s could not find function%i\n",
			__func__, selector);
		return -EINVAL;
	}
	*groups = function->group_names;
	*num_groups = function->num_group_names;

	return 0;
}
EXPORT_SYMBOL_GPL(pinmux_generic_get_function_groups);

/**
 * pinmux_generic_get_function() - returns a function based on the number
 * @pctldev: pin controller device
 * @group_selector: function number
 */
struct function_desc *pinmux_generic_get_function(struct pinctrl_dev *pctldev,
						  unsigned int selector)
{
	struct function_desc *function;

	function = radix_tree_lookup(&pctldev->pin_function_tree,
				     selector);
	if (!function)
		return NULL;

	return function;
}
EXPORT_SYMBOL_GPL(pinmux_generic_get_function);

/**
764
 * pinmux_generic_add_function() - adds a function group
765 766 767 768 769 770 771 772 773 774 775 776 777
 * @pctldev: pin controller device
 * @name: name of the function
 * @groups: array of pin groups
 * @num_groups: number of pin groups
 * @data: pin controller driver specific data
 */
int pinmux_generic_add_function(struct pinctrl_dev *pctldev,
				const char *name,
				const char **groups,
				const unsigned int num_groups,
				void *data)
{
	struct function_desc *function;
778 779 780 781 782 783 784 785 786 787
	int selector;

	if (!name)
		return -EINVAL;

	selector = pinmux_func_name_to_selector(pctldev, name);
	if (selector >= 0)
		return selector;

	selector = pctldev->num_functions;
788 789 790 791 792 793 794 795 796 797

	function = devm_kzalloc(pctldev->dev, sizeof(*function), GFP_KERNEL);
	if (!function)
		return -ENOMEM;

	function->name = name;
	function->group_names = groups;
	function->num_group_names = num_groups;
	function->data = data;

798
	radix_tree_insert(&pctldev->pin_function_tree, selector, function);
799 800 801

	pctldev->num_functions++;

802
	return selector;
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
}
EXPORT_SYMBOL_GPL(pinmux_generic_add_function);

/**
 * pinmux_generic_remove_function() - removes a numbered function
 * @pctldev: pin controller device
 * @selector: function number
 *
 * Note that the caller must take care of locking.
 */
int pinmux_generic_remove_function(struct pinctrl_dev *pctldev,
				   unsigned int selector)
{
	struct function_desc *function;

	function = radix_tree_lookup(&pctldev->pin_function_tree,
				     selector);
	if (!function)
		return -ENOENT;

	radix_tree_delete(&pctldev->pin_function_tree, selector);
	devm_kfree(pctldev->dev, function);

	pctldev->num_functions--;

	return 0;
}
EXPORT_SYMBOL_GPL(pinmux_generic_remove_function);

/**
 * pinmux_generic_free_functions() - removes all functions
 * @pctldev: pin controller device
 *
836 837 838
 * Note that the caller must take care of locking. The pinctrl
 * functions are allocated with devm_kzalloc() so no need to free
 * them here.
839 840 841 842
 */
void pinmux_generic_free_functions(struct pinctrl_dev *pctldev)
{
	struct radix_tree_iter iter;
843
	void __rcu **slot;
844 845

	radix_tree_for_each_slot(slot, &pctldev->pin_function_tree, &iter, 0)
846
		radix_tree_delete(&pctldev->pin_function_tree, iter.index);
847 848 849 850 851

	pctldev->num_functions = 0;
}

#endif /* CONFIG_GENERIC_PINMUX_FUNCTIONS */