pinctrl: create pinctrl_free_setting function
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / drivers / pinctrl / core.c
1 /*
2 * Core driver for the pin control subsystem
3 *
4 * Copyright (C) 2011-2012 ST-Ericsson SA
5 * Written on behalf of Linaro for ST-Ericsson
6 * Based on bits of regulator core, gpio core and clk core
7 *
8 * Author: Linus Walleij <linus.walleij@linaro.org>
9 *
10 * Copyright (C) 2012 NVIDIA CORPORATION. All rights reserved.
11 *
12 * License terms: GNU General Public License (GPL) version 2
13 */
14 #define pr_fmt(fmt) "pinctrl core: " fmt
15
16 #include <linux/kernel.h>
17 #include <linux/kref.h>
18 #include <linux/export.h>
19 #include <linux/init.h>
20 #include <linux/device.h>
21 #include <linux/slab.h>
22 #include <linux/err.h>
23 #include <linux/list.h>
24 #include <linux/sysfs.h>
25 #include <linux/debugfs.h>
26 #include <linux/seq_file.h>
27 #include <linux/pinctrl/consumer.h>
28 #include <linux/pinctrl/pinctrl.h>
29 #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 static bool pinctrl_dummy_state;
38
39 /* Mutex taken by all entry points */
40 DEFINE_MUTEX(pinctrl_mutex);
41
42 /* Global list of pin control devices (struct pinctrl_dev) */
43 LIST_HEAD(pinctrldev_list);
44
45 /* List of pin controller handles (struct pinctrl) */
46 static LIST_HEAD(pinctrl_list);
47
48 /* List of pinctrl maps (struct pinctrl_maps) */
49 LIST_HEAD(pinctrl_maps);
50
51
52 /**
53 * pinctrl_provide_dummies() - indicate if pinctrl provides dummy state support
54 *
55 * Usually this function is called by platforms without pinctrl driver support
56 * but run with some shared drivers using pinctrl APIs.
57 * After calling this function, the pinctrl core will return successfully
58 * with creating a dummy state for the driver to keep going smoothly.
59 */
60 void pinctrl_provide_dummies(void)
61 {
62 pinctrl_dummy_state = true;
63 }
64
65 const char *pinctrl_dev_get_name(struct pinctrl_dev *pctldev)
66 {
67 /* We're not allowed to register devices without name */
68 return pctldev->desc->name;
69 }
70 EXPORT_SYMBOL_GPL(pinctrl_dev_get_name);
71
72 const char *pinctrl_dev_get_devname(struct pinctrl_dev *pctldev)
73 {
74 return dev_name(pctldev->dev);
75 }
76 EXPORT_SYMBOL_GPL(pinctrl_dev_get_devname);
77
78 void *pinctrl_dev_get_drvdata(struct pinctrl_dev *pctldev)
79 {
80 return pctldev->driver_data;
81 }
82 EXPORT_SYMBOL_GPL(pinctrl_dev_get_drvdata);
83
84 /**
85 * get_pinctrl_dev_from_devname() - look up pin controller device
86 * @devname: the name of a device instance, as returned by dev_name()
87 *
88 * Looks up a pin control device matching a certain device name or pure device
89 * pointer, the pure device pointer will take precedence.
90 */
91 struct pinctrl_dev *get_pinctrl_dev_from_devname(const char *devname)
92 {
93 struct pinctrl_dev *pctldev = NULL;
94 bool found = false;
95
96 if (!devname)
97 return NULL;
98
99 list_for_each_entry(pctldev, &pinctrldev_list, node) {
100 if (!strcmp(dev_name(pctldev->dev), devname)) {
101 /* Matched on device name */
102 found = true;
103 break;
104 }
105 }
106
107 return found ? pctldev : NULL;
108 }
109
110 /**
111 * pin_get_from_name() - look up a pin number from a name
112 * @pctldev: the pin control device to lookup the pin on
113 * @name: the name of the pin to look up
114 */
115 int pin_get_from_name(struct pinctrl_dev *pctldev, const char *name)
116 {
117 unsigned i, pin;
118
119 /* The pin number can be retrived from the pin controller descriptor */
120 for (i = 0; i < pctldev->desc->npins; i++) {
121 struct pin_desc *desc;
122
123 pin = pctldev->desc->pins[i].number;
124 desc = pin_desc_get(pctldev, pin);
125 /* Pin space may be sparse */
126 if (desc == NULL)
127 continue;
128 if (desc->name && !strcmp(name, desc->name))
129 return pin;
130 }
131
132 return -EINVAL;
133 }
134
135 /**
136 * pin_get_name_from_id() - look up a pin name from a pin id
137 * @pctldev: the pin control device to lookup the pin on
138 * @name: the name of the pin to look up
139 */
140 const char *pin_get_name(struct pinctrl_dev *pctldev, const unsigned pin)
141 {
142 const struct pin_desc *desc;
143
144 desc = pin_desc_get(pctldev, pin);
145 if (desc == NULL) {
146 dev_err(pctldev->dev, "failed to get pin(%d) name\n",
147 pin);
148 return NULL;
149 }
150
151 return desc->name;
152 }
153
154 /**
155 * pin_is_valid() - check if pin exists on controller
156 * @pctldev: the pin control device to check the pin on
157 * @pin: pin to check, use the local pin controller index number
158 *
159 * This tells us whether a certain pin exist on a certain pin controller or
160 * not. Pin lists may be sparse, so some pins may not exist.
161 */
162 bool pin_is_valid(struct pinctrl_dev *pctldev, int pin)
163 {
164 struct pin_desc *pindesc;
165
166 if (pin < 0)
167 return false;
168
169 mutex_lock(&pinctrl_mutex);
170 pindesc = pin_desc_get(pctldev, pin);
171 mutex_unlock(&pinctrl_mutex);
172
173 return pindesc != NULL;
174 }
175 EXPORT_SYMBOL_GPL(pin_is_valid);
176
177 /* Deletes a range of pin descriptors */
178 static void pinctrl_free_pindescs(struct pinctrl_dev *pctldev,
179 const struct pinctrl_pin_desc *pins,
180 unsigned num_pins)
181 {
182 int i;
183
184 for (i = 0; i < num_pins; i++) {
185 struct pin_desc *pindesc;
186
187 pindesc = radix_tree_lookup(&pctldev->pin_desc_tree,
188 pins[i].number);
189 if (pindesc != NULL) {
190 radix_tree_delete(&pctldev->pin_desc_tree,
191 pins[i].number);
192 if (pindesc->dynamic_name)
193 kfree(pindesc->name);
194 }
195 kfree(pindesc);
196 }
197 }
198
199 static int pinctrl_register_one_pin(struct pinctrl_dev *pctldev,
200 unsigned number, const char *name)
201 {
202 struct pin_desc *pindesc;
203
204 pindesc = pin_desc_get(pctldev, number);
205 if (pindesc != NULL) {
206 pr_err("pin %d already registered on %s\n", number,
207 pctldev->desc->name);
208 return -EINVAL;
209 }
210
211 pindesc = kzalloc(sizeof(*pindesc), GFP_KERNEL);
212 if (pindesc == NULL) {
213 dev_err(pctldev->dev, "failed to alloc struct pin_desc\n");
214 return -ENOMEM;
215 }
216
217 /* Set owner */
218 pindesc->pctldev = pctldev;
219
220 /* Copy basic pin info */
221 if (name) {
222 pindesc->name = name;
223 } else {
224 pindesc->name = kasprintf(GFP_KERNEL, "PIN%u", number);
225 if (pindesc->name == NULL) {
226 kfree(pindesc);
227 return -ENOMEM;
228 }
229 pindesc->dynamic_name = true;
230 }
231
232 radix_tree_insert(&pctldev->pin_desc_tree, number, pindesc);
233 pr_debug("registered pin %d (%s) on %s\n",
234 number, pindesc->name, pctldev->desc->name);
235 return 0;
236 }
237
238 static int pinctrl_register_pins(struct pinctrl_dev *pctldev,
239 struct pinctrl_pin_desc const *pins,
240 unsigned num_descs)
241 {
242 unsigned i;
243 int ret = 0;
244
245 for (i = 0; i < num_descs; i++) {
246 ret = pinctrl_register_one_pin(pctldev,
247 pins[i].number, pins[i].name);
248 if (ret)
249 return ret;
250 }
251
252 return 0;
253 }
254
255 /**
256 * pinctrl_match_gpio_range() - check if a certain GPIO pin is in range
257 * @pctldev: pin controller device to check
258 * @gpio: gpio pin to check taken from the global GPIO pin space
259 *
260 * Tries to match a GPIO pin number to the ranges handled by a certain pin
261 * controller, return the range or NULL
262 */
263 static struct pinctrl_gpio_range *
264 pinctrl_match_gpio_range(struct pinctrl_dev *pctldev, unsigned gpio)
265 {
266 struct pinctrl_gpio_range *range = NULL;
267
268 /* Loop over the ranges */
269 list_for_each_entry(range, &pctldev->gpio_ranges, node) {
270 /* Check if we're in the valid range */
271 if (gpio >= range->base &&
272 gpio < range->base + range->npins) {
273 return range;
274 }
275 }
276
277 return NULL;
278 }
279
280 /**
281 * pinctrl_ready_for_gpio_range() - check if other GPIO pins of
282 * the same GPIO chip are in range
283 * @gpio: gpio pin to check taken from the global GPIO pin space
284 *
285 * This function is complement of pinctrl_match_gpio_range(). If the return
286 * value of pinctrl_match_gpio_range() is NULL, this function could be used
287 * to check whether pinctrl device is ready or not. Maybe some GPIO pins
288 * of the same GPIO chip don't have back-end pinctrl interface.
289 * If the return value is true, it means that pinctrl device is ready & the
290 * certain GPIO pin doesn't have back-end pinctrl device. If the return value
291 * is false, it means that pinctrl device may not be ready.
292 */
293 static bool pinctrl_ready_for_gpio_range(unsigned gpio)
294 {
295 struct pinctrl_dev *pctldev;
296 struct pinctrl_gpio_range *range = NULL;
297 struct gpio_chip *chip = gpio_to_chip(gpio);
298
299 /* Loop over the pin controllers */
300 list_for_each_entry(pctldev, &pinctrldev_list, node) {
301 /* Loop over the ranges */
302 list_for_each_entry(range, &pctldev->gpio_ranges, node) {
303 /* Check if any gpio range overlapped with gpio chip */
304 if (range->base + range->npins - 1 < chip->base ||
305 range->base > chip->base + chip->ngpio - 1)
306 continue;
307 return true;
308 }
309 }
310 return false;
311 }
312
313 /**
314 * pinctrl_get_device_gpio_range() - find device for GPIO range
315 * @gpio: the pin to locate the pin controller for
316 * @outdev: the pin control device if found
317 * @outrange: the GPIO range if found
318 *
319 * Find the pin controller handling a certain GPIO pin from the pinspace of
320 * the GPIO subsystem, return the device and the matching GPIO range. Returns
321 * -EPROBE_DEFER if the GPIO range could not be found in any device since it
322 * may still have not been registered.
323 */
324 static int pinctrl_get_device_gpio_range(unsigned gpio,
325 struct pinctrl_dev **outdev,
326 struct pinctrl_gpio_range **outrange)
327 {
328 struct pinctrl_dev *pctldev = NULL;
329
330 /* Loop over the pin controllers */
331 list_for_each_entry(pctldev, &pinctrldev_list, node) {
332 struct pinctrl_gpio_range *range;
333
334 range = pinctrl_match_gpio_range(pctldev, gpio);
335 if (range != NULL) {
336 *outdev = pctldev;
337 *outrange = range;
338 return 0;
339 }
340 }
341
342 return -EPROBE_DEFER;
343 }
344
345 /**
346 * pinctrl_add_gpio_range() - register a GPIO range for a controller
347 * @pctldev: pin controller device to add the range to
348 * @range: the GPIO range to add
349 *
350 * This adds a range of GPIOs to be handled by a certain pin controller. Call
351 * this to register handled ranges after registering your pin controller.
352 */
353 void pinctrl_add_gpio_range(struct pinctrl_dev *pctldev,
354 struct pinctrl_gpio_range *range)
355 {
356 mutex_lock(&pinctrl_mutex);
357 list_add_tail(&range->node, &pctldev->gpio_ranges);
358 mutex_unlock(&pinctrl_mutex);
359 }
360 EXPORT_SYMBOL_GPL(pinctrl_add_gpio_range);
361
362 void pinctrl_add_gpio_ranges(struct pinctrl_dev *pctldev,
363 struct pinctrl_gpio_range *ranges,
364 unsigned nranges)
365 {
366 int i;
367
368 for (i = 0; i < nranges; i++)
369 pinctrl_add_gpio_range(pctldev, &ranges[i]);
370 }
371 EXPORT_SYMBOL_GPL(pinctrl_add_gpio_ranges);
372
373 struct pinctrl_dev *pinctrl_find_and_add_gpio_range(const char *devname,
374 struct pinctrl_gpio_range *range)
375 {
376 struct pinctrl_dev *pctldev = get_pinctrl_dev_from_devname(devname);
377
378 /*
379 * If we can't find this device, let's assume that is because
380 * it has not probed yet, so the driver trying to register this
381 * range need to defer probing.
382 */
383 if (!pctldev)
384 return ERR_PTR(-EPROBE_DEFER);
385
386 pinctrl_add_gpio_range(pctldev, range);
387 return pctldev;
388 }
389 EXPORT_SYMBOL_GPL(pinctrl_find_and_add_gpio_range);
390
391 /**
392 * pinctrl_find_gpio_range_from_pin() - locate the GPIO range for a pin
393 * @pctldev: the pin controller device to look in
394 * @pin: a controller-local number to find the range for
395 */
396 struct pinctrl_gpio_range *
397 pinctrl_find_gpio_range_from_pin(struct pinctrl_dev *pctldev,
398 unsigned int pin)
399 {
400 struct pinctrl_gpio_range *range = NULL;
401
402 /* Loop over the ranges */
403 list_for_each_entry(range, &pctldev->gpio_ranges, node) {
404 /* Check if we're in the valid range */
405 if (pin >= range->pin_base &&
406 pin < range->pin_base + range->npins) {
407 return range;
408 }
409 }
410
411 return NULL;
412 }
413 EXPORT_SYMBOL_GPL(pinctrl_find_gpio_range_from_pin);
414
415 /**
416 * pinctrl_remove_gpio_range() - remove a range of GPIOs fro a pin controller
417 * @pctldev: pin controller device to remove the range from
418 * @range: the GPIO range to remove
419 */
420 void pinctrl_remove_gpio_range(struct pinctrl_dev *pctldev,
421 struct pinctrl_gpio_range *range)
422 {
423 mutex_lock(&pinctrl_mutex);
424 list_del(&range->node);
425 mutex_unlock(&pinctrl_mutex);
426 }
427 EXPORT_SYMBOL_GPL(pinctrl_remove_gpio_range);
428
429 /**
430 * pinctrl_get_group_selector() - returns the group selector for a group
431 * @pctldev: the pin controller handling the group
432 * @pin_group: the pin group to look up
433 */
434 int pinctrl_get_group_selector(struct pinctrl_dev *pctldev,
435 const char *pin_group)
436 {
437 const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
438 unsigned ngroups = pctlops->get_groups_count(pctldev);
439 unsigned group_selector = 0;
440
441 while (group_selector < ngroups) {
442 const char *gname = pctlops->get_group_name(pctldev,
443 group_selector);
444 if (!strcmp(gname, pin_group)) {
445 dev_dbg(pctldev->dev,
446 "found group selector %u for %s\n",
447 group_selector,
448 pin_group);
449 return group_selector;
450 }
451
452 group_selector++;
453 }
454
455 dev_err(pctldev->dev, "does not have pin group %s\n",
456 pin_group);
457
458 return -EINVAL;
459 }
460
461 /**
462 * pinctrl_request_gpio() - request a single pin to be used in as GPIO
463 * @gpio: the GPIO pin number from the GPIO subsystem number space
464 *
465 * This function should *ONLY* be used from gpiolib-based GPIO drivers,
466 * as part of their gpio_request() semantics, platforms and individual drivers
467 * shall *NOT* request GPIO pins to be muxed in.
468 */
469 int pinctrl_request_gpio(unsigned gpio)
470 {
471 struct pinctrl_dev *pctldev;
472 struct pinctrl_gpio_range *range;
473 int ret;
474 int pin;
475
476 mutex_lock(&pinctrl_mutex);
477
478 ret = pinctrl_get_device_gpio_range(gpio, &pctldev, &range);
479 if (ret) {
480 if (pinctrl_ready_for_gpio_range(gpio))
481 ret = 0;
482 mutex_unlock(&pinctrl_mutex);
483 return ret;
484 }
485
486 /* Convert to the pin controllers number space */
487 pin = gpio - range->base + range->pin_base;
488
489 ret = pinmux_request_gpio(pctldev, range, pin, gpio);
490
491 mutex_unlock(&pinctrl_mutex);
492 return ret;
493 }
494 EXPORT_SYMBOL_GPL(pinctrl_request_gpio);
495
496 /**
497 * pinctrl_free_gpio() - free control on a single pin, currently used as GPIO
498 * @gpio: the GPIO pin number from the GPIO subsystem number space
499 *
500 * This function should *ONLY* be used from gpiolib-based GPIO drivers,
501 * as part of their gpio_free() semantics, platforms and individual drivers
502 * shall *NOT* request GPIO pins to be muxed out.
503 */
504 void pinctrl_free_gpio(unsigned gpio)
505 {
506 struct pinctrl_dev *pctldev;
507 struct pinctrl_gpio_range *range;
508 int ret;
509 int pin;
510
511 mutex_lock(&pinctrl_mutex);
512
513 ret = pinctrl_get_device_gpio_range(gpio, &pctldev, &range);
514 if (ret) {
515 mutex_unlock(&pinctrl_mutex);
516 return;
517 }
518
519 /* Convert to the pin controllers number space */
520 pin = gpio - range->base + range->pin_base;
521
522 pinmux_free_gpio(pctldev, pin, range);
523
524 mutex_unlock(&pinctrl_mutex);
525 }
526 EXPORT_SYMBOL_GPL(pinctrl_free_gpio);
527
528 static int pinctrl_gpio_direction(unsigned gpio, bool input)
529 {
530 struct pinctrl_dev *pctldev;
531 struct pinctrl_gpio_range *range;
532 int ret;
533 int pin;
534
535 ret = pinctrl_get_device_gpio_range(gpio, &pctldev, &range);
536 if (ret)
537 return ret;
538
539 /* Convert to the pin controllers number space */
540 pin = gpio - range->base + range->pin_base;
541
542 return pinmux_gpio_direction(pctldev, range, pin, input);
543 }
544
545 /**
546 * pinctrl_gpio_direction_input() - request a GPIO pin to go into input mode
547 * @gpio: the GPIO pin number from the GPIO subsystem number space
548 *
549 * This function should *ONLY* be used from gpiolib-based GPIO drivers,
550 * as part of their gpio_direction_input() semantics, platforms and individual
551 * drivers shall *NOT* touch pin control GPIO calls.
552 */
553 int pinctrl_gpio_direction_input(unsigned gpio)
554 {
555 int ret;
556 mutex_lock(&pinctrl_mutex);
557 ret = pinctrl_gpio_direction(gpio, true);
558 mutex_unlock(&pinctrl_mutex);
559 return ret;
560 }
561 EXPORT_SYMBOL_GPL(pinctrl_gpio_direction_input);
562
563 /**
564 * pinctrl_gpio_direction_output() - request a GPIO pin to go into output mode
565 * @gpio: the GPIO pin number from the GPIO subsystem number space
566 *
567 * This function should *ONLY* be used from gpiolib-based GPIO drivers,
568 * as part of their gpio_direction_output() semantics, platforms and individual
569 * drivers shall *NOT* touch pin control GPIO calls.
570 */
571 int pinctrl_gpio_direction_output(unsigned gpio)
572 {
573 int ret;
574 mutex_lock(&pinctrl_mutex);
575 ret = pinctrl_gpio_direction(gpio, false);
576 mutex_unlock(&pinctrl_mutex);
577 return ret;
578 }
579 EXPORT_SYMBOL_GPL(pinctrl_gpio_direction_output);
580
581 static struct pinctrl_state *find_state(struct pinctrl *p,
582 const char *name)
583 {
584 struct pinctrl_state *state;
585
586 list_for_each_entry(state, &p->states, node)
587 if (!strcmp(state->name, name))
588 return state;
589
590 return NULL;
591 }
592
593 static struct pinctrl_state *create_state(struct pinctrl *p,
594 const char *name)
595 {
596 struct pinctrl_state *state;
597
598 state = kzalloc(sizeof(*state), GFP_KERNEL);
599 if (state == NULL) {
600 dev_err(p->dev,
601 "failed to alloc struct pinctrl_state\n");
602 return ERR_PTR(-ENOMEM);
603 }
604
605 state->name = name;
606 INIT_LIST_HEAD(&state->settings);
607
608 list_add_tail(&state->node, &p->states);
609
610 return state;
611 }
612
613 static int add_setting(struct pinctrl *p, struct pinctrl_map const *map)
614 {
615 struct pinctrl_state *state;
616 struct pinctrl_setting *setting;
617 int ret;
618
619 state = find_state(p, map->name);
620 if (!state)
621 state = create_state(p, map->name);
622 if (IS_ERR(state))
623 return PTR_ERR(state);
624
625 if (map->type == PIN_MAP_TYPE_DUMMY_STATE)
626 return 0;
627
628 setting = kzalloc(sizeof(*setting), GFP_KERNEL);
629 if (setting == NULL) {
630 dev_err(p->dev,
631 "failed to alloc struct pinctrl_setting\n");
632 return -ENOMEM;
633 }
634
635 setting->type = map->type;
636
637 setting->pctldev = get_pinctrl_dev_from_devname(map->ctrl_dev_name);
638 if (setting->pctldev == NULL) {
639 kfree(setting);
640 /* Do not defer probing of hogs (circular loop) */
641 if (!strcmp(map->ctrl_dev_name, map->dev_name))
642 return -ENODEV;
643 /*
644 * OK let us guess that the driver is not there yet, and
645 * let's defer obtaining this pinctrl handle to later...
646 */
647 dev_info(p->dev, "unknown pinctrl device %s in map entry, deferring probe",
648 map->ctrl_dev_name);
649 return -EPROBE_DEFER;
650 }
651
652 setting->dev_name = map->dev_name;
653
654 switch (map->type) {
655 case PIN_MAP_TYPE_MUX_GROUP:
656 ret = pinmux_map_to_setting(map, setting);
657 break;
658 case PIN_MAP_TYPE_CONFIGS_PIN:
659 case PIN_MAP_TYPE_CONFIGS_GROUP:
660 ret = pinconf_map_to_setting(map, setting);
661 break;
662 default:
663 ret = -EINVAL;
664 break;
665 }
666 if (ret < 0) {
667 kfree(setting);
668 return ret;
669 }
670
671 list_add_tail(&setting->node, &state->settings);
672
673 return 0;
674 }
675
676 static struct pinctrl *find_pinctrl(struct device *dev)
677 {
678 struct pinctrl *p;
679
680 list_for_each_entry(p, &pinctrl_list, node)
681 if (p->dev == dev)
682 return p;
683
684 return NULL;
685 }
686
687 static void pinctrl_put_locked(struct pinctrl *p, bool inlist);
688
689 static struct pinctrl *create_pinctrl(struct device *dev)
690 {
691 struct pinctrl *p;
692 const char *devname;
693 struct pinctrl_maps *maps_node;
694 int i;
695 struct pinctrl_map const *map;
696 int ret;
697
698 /*
699 * create the state cookie holder struct pinctrl for each
700 * mapping, this is what consumers will get when requesting
701 * a pin control handle with pinctrl_get()
702 */
703 p = kzalloc(sizeof(*p), GFP_KERNEL);
704 if (p == NULL) {
705 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 INIT_LIST_HEAD(&p->dt_maps);
711
712 ret = pinctrl_dt_to_map(p);
713 if (ret < 0) {
714 kfree(p);
715 return ERR_PTR(ret);
716 }
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 /* Map must be for this device */
723 if (strcmp(map->dev_name, devname))
724 continue;
725
726 ret = add_setting(p, map);
727 /*
728 * At this point the adding of a setting may:
729 *
730 * - Defer, if the pinctrl device is not yet available
731 * - Fail, if the pinctrl device is not yet available,
732 * AND the setting is a hog. We cannot defer that, since
733 * the hog will kick in immediately after the device
734 * is registered.
735 *
736 * If the error returned was not -EPROBE_DEFER then we
737 * accumulate the errors to see if we end up with
738 * an -EPROBE_DEFER later, as that is the worst case.
739 */
740 if (ret == -EPROBE_DEFER) {
741 pinctrl_put_locked(p, false);
742 return ERR_PTR(ret);
743 }
744 }
745 if (ret < 0) {
746 /* If some other error than deferral occured, return here */
747 pinctrl_put_locked(p, false);
748 return ERR_PTR(ret);
749 }
750
751 kref_init(&p->users);
752
753 /* Add the pinctrl handle to the global list */
754 list_add_tail(&p->node, &pinctrl_list);
755
756 return p;
757 }
758
759 static struct pinctrl *pinctrl_get_locked(struct device *dev)
760 {
761 struct pinctrl *p;
762
763 if (WARN_ON(!dev))
764 return ERR_PTR(-EINVAL);
765
766 /*
767 * See if somebody else (such as the device core) has already
768 * obtained a handle to the pinctrl for this device. In that case,
769 * return another pointer to it.
770 */
771 p = find_pinctrl(dev);
772 if (p != NULL) {
773 dev_dbg(dev, "obtain a copy of previously claimed pinctrl\n");
774 kref_get(&p->users);
775 return p;
776 }
777
778 return create_pinctrl(dev);
779 }
780
781 /**
782 * pinctrl_get() - retrieves the pinctrl handle for a device
783 * @dev: the device to obtain the handle for
784 */
785 struct pinctrl *pinctrl_get(struct device *dev)
786 {
787 struct pinctrl *p;
788
789 mutex_lock(&pinctrl_mutex);
790 p = pinctrl_get_locked(dev);
791 mutex_unlock(&pinctrl_mutex);
792
793 return p;
794 }
795 EXPORT_SYMBOL_GPL(pinctrl_get);
796
797 static void pinctrl_free_setting(bool disable_setting,
798 struct pinctrl_setting *setting)
799 {
800 switch (setting->type) {
801 case PIN_MAP_TYPE_MUX_GROUP:
802 if (disable_setting)
803 pinmux_disable_setting(setting);
804 pinmux_free_setting(setting);
805 break;
806 case PIN_MAP_TYPE_CONFIGS_PIN:
807 case PIN_MAP_TYPE_CONFIGS_GROUP:
808 pinconf_free_setting(setting);
809 break;
810 default:
811 break;
812 }
813 }
814
815 static void pinctrl_put_locked(struct pinctrl *p, bool inlist)
816 {
817 struct pinctrl_state *state, *n1;
818 struct pinctrl_setting *setting, *n2;
819
820 list_for_each_entry_safe(state, n1, &p->states, node) {
821 list_for_each_entry_safe(setting, n2, &state->settings, node) {
822 pinctrl_free_setting(state == p->state, setting);
823 list_del(&setting->node);
824 kfree(setting);
825 }
826 list_del(&state->node);
827 kfree(state);
828 }
829
830 pinctrl_dt_free_maps(p);
831
832 if (inlist)
833 list_del(&p->node);
834 kfree(p);
835 }
836
837 /**
838 * pinctrl_release() - release the pinctrl handle
839 * @kref: the kref in the pinctrl being released
840 */
841 static void pinctrl_release(struct kref *kref)
842 {
843 struct pinctrl *p = container_of(kref, struct pinctrl, users);
844
845 pinctrl_put_locked(p, true);
846 }
847
848 /**
849 * pinctrl_put() - decrease use count on a previously claimed pinctrl handle
850 * @p: the pinctrl handle to release
851 */
852 void pinctrl_put(struct pinctrl *p)
853 {
854 mutex_lock(&pinctrl_mutex);
855 kref_put(&p->users, pinctrl_release);
856 mutex_unlock(&pinctrl_mutex);
857 }
858 EXPORT_SYMBOL_GPL(pinctrl_put);
859
860 static struct pinctrl_state *pinctrl_lookup_state_locked(struct pinctrl *p,
861 const char *name)
862 {
863 struct pinctrl_state *state;
864
865 state = find_state(p, name);
866 if (!state) {
867 if (pinctrl_dummy_state) {
868 /* create dummy state */
869 dev_dbg(p->dev, "using pinctrl dummy state (%s)\n",
870 name);
871 state = create_state(p, name);
872 } else
873 state = ERR_PTR(-ENODEV);
874 }
875
876 return state;
877 }
878
879 /**
880 * pinctrl_lookup_state() - retrieves a state handle from a pinctrl handle
881 * @p: the pinctrl handle to retrieve the state from
882 * @name: the state name to retrieve
883 */
884 struct pinctrl_state *pinctrl_lookup_state(struct pinctrl *p, const char *name)
885 {
886 struct pinctrl_state *s;
887
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 static int pinctrl_select_state_locked(struct pinctrl *p,
897 struct pinctrl_state *state)
898 {
899 struct pinctrl_setting *setting, *setting2;
900 int ret;
901
902 if (p->state == state)
903 return 0;
904
905 if (p->state) {
906 /*
907 * The set of groups with a mux configuration in the old state
908 * may not be identical to the set of groups with a mux setting
909 * in the new state. While this might be unusual, it's entirely
910 * possible for the "user"-supplied mapping table to be written
911 * that way. For each group that was configured in the old state
912 * but not in the new state, this code puts that group into a
913 * safe/disabled state.
914 */
915 list_for_each_entry(setting, &p->state->settings, node) {
916 bool found = false;
917 if (setting->type != PIN_MAP_TYPE_MUX_GROUP)
918 continue;
919 list_for_each_entry(setting2, &state->settings, node) {
920 if (setting2->type != PIN_MAP_TYPE_MUX_GROUP)
921 continue;
922 if (setting2->data.mux.group ==
923 setting->data.mux.group) {
924 found = true;
925 break;
926 }
927 }
928 if (!found)
929 pinmux_disable_setting(setting);
930 }
931 }
932
933 p->state = state;
934
935 /* Apply all the settings for the new state */
936 list_for_each_entry(setting, &state->settings, node) {
937 switch (setting->type) {
938 case PIN_MAP_TYPE_MUX_GROUP:
939 ret = pinmux_enable_setting(setting);
940 break;
941 case PIN_MAP_TYPE_CONFIGS_PIN:
942 case PIN_MAP_TYPE_CONFIGS_GROUP:
943 ret = pinconf_apply_setting(setting);
944 break;
945 default:
946 ret = -EINVAL;
947 break;
948 }
949 if (ret < 0) {
950 /* FIXME: Difficult to return to prev state */
951 return ret;
952 }
953 }
954
955 return 0;
956 }
957
958 /**
959 * pinctrl_select() - select/activate/program a pinctrl state to HW
960 * @p: the pinctrl handle for the device that requests configuratio
961 * @state: the state handle to select/activate/program
962 */
963 int pinctrl_select_state(struct pinctrl *p, struct pinctrl_state *state)
964 {
965 int ret;
966
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 static void devm_pinctrl_release(struct device *dev, void *res)
976 {
977 pinctrl_put(*(struct pinctrl **)res);
978 }
979
980 /**
981 * struct devm_pinctrl_get() - Resource managed pinctrl_get()
982 * @dev: the device to obtain the handle for
983 *
984 * If there is a need to explicitly destroy the returned struct pinctrl,
985 * devm_pinctrl_put() should be used, rather than plain pinctrl_put().
986 */
987 struct pinctrl *devm_pinctrl_get(struct device *dev)
988 {
989 struct pinctrl **ptr, *p;
990
991 ptr = devres_alloc(devm_pinctrl_release, sizeof(*ptr), GFP_KERNEL);
992 if (!ptr)
993 return ERR_PTR(-ENOMEM);
994
995 p = pinctrl_get(dev);
996 if (!IS_ERR(p)) {
997 *ptr = p;
998 devres_add(dev, ptr);
999 } else {
1000 devres_free(ptr);
1001 }
1002
1003 return p;
1004 }
1005 EXPORT_SYMBOL_GPL(devm_pinctrl_get);
1006
1007 static int devm_pinctrl_match(struct device *dev, void *res, void *data)
1008 {
1009 struct pinctrl **p = res;
1010
1011 return *p == data;
1012 }
1013
1014 /**
1015 * devm_pinctrl_put() - Resource managed pinctrl_put()
1016 * @p: the pinctrl handle to release
1017 *
1018 * Deallocate a struct pinctrl obtained via devm_pinctrl_get(). Normally
1019 * this function will not need to be called and the resource management
1020 * code will ensure that the resource is freed.
1021 */
1022 void devm_pinctrl_put(struct pinctrl *p)
1023 {
1024 WARN_ON(devres_release(p->dev, devm_pinctrl_release,
1025 devm_pinctrl_match, p));
1026 }
1027 EXPORT_SYMBOL_GPL(devm_pinctrl_put);
1028
1029 int pinctrl_register_map(struct pinctrl_map const *maps, unsigned num_maps,
1030 bool dup, bool locked)
1031 {
1032 int i, ret;
1033 struct pinctrl_maps *maps_node;
1034
1035 pr_debug("add %d pinmux maps\n", num_maps);
1036
1037 /* First sanity check the new mapping */
1038 for (i = 0; i < num_maps; i++) {
1039 if (!maps[i].dev_name) {
1040 pr_err("failed to register map %s (%d): no device given\n",
1041 maps[i].name, i);
1042 return -EINVAL;
1043 }
1044
1045 if (!maps[i].name) {
1046 pr_err("failed to register map %d: no map name given\n",
1047 i);
1048 return -EINVAL;
1049 }
1050
1051 if (maps[i].type != PIN_MAP_TYPE_DUMMY_STATE &&
1052 !maps[i].ctrl_dev_name) {
1053 pr_err("failed to register map %s (%d): no pin control device given\n",
1054 maps[i].name, i);
1055 return -EINVAL;
1056 }
1057
1058 switch (maps[i].type) {
1059 case PIN_MAP_TYPE_DUMMY_STATE:
1060 break;
1061 case PIN_MAP_TYPE_MUX_GROUP:
1062 ret = pinmux_validate_map(&maps[i], i);
1063 if (ret < 0)
1064 return ret;
1065 break;
1066 case PIN_MAP_TYPE_CONFIGS_PIN:
1067 case PIN_MAP_TYPE_CONFIGS_GROUP:
1068 ret = pinconf_validate_map(&maps[i], i);
1069 if (ret < 0)
1070 return ret;
1071 break;
1072 default:
1073 pr_err("failed to register map %s (%d): invalid type given\n",
1074 maps[i].name, i);
1075 return -EINVAL;
1076 }
1077 }
1078
1079 maps_node = kzalloc(sizeof(*maps_node), GFP_KERNEL);
1080 if (!maps_node) {
1081 pr_err("failed to alloc struct pinctrl_maps\n");
1082 return -ENOMEM;
1083 }
1084
1085 maps_node->num_maps = num_maps;
1086 if (dup) {
1087 maps_node->maps = kmemdup(maps, sizeof(*maps) * num_maps,
1088 GFP_KERNEL);
1089 if (!maps_node->maps) {
1090 pr_err("failed to duplicate mapping table\n");
1091 kfree(maps_node);
1092 return -ENOMEM;
1093 }
1094 } else {
1095 maps_node->maps = maps;
1096 }
1097
1098 if (!locked)
1099 mutex_lock(&pinctrl_mutex);
1100 list_add_tail(&maps_node->node, &pinctrl_maps);
1101 if (!locked)
1102 mutex_unlock(&pinctrl_mutex);
1103
1104 return 0;
1105 }
1106
1107 /**
1108 * pinctrl_register_mappings() - register a set of pin controller mappings
1109 * @maps: the pincontrol mappings table to register. This should probably be
1110 * marked with __initdata so it can be discarded after boot. This
1111 * function will perform a shallow copy for the mapping entries.
1112 * @num_maps: the number of maps in the mapping table
1113 */
1114 int pinctrl_register_mappings(struct pinctrl_map const *maps,
1115 unsigned num_maps)
1116 {
1117 return pinctrl_register_map(maps, num_maps, true, false);
1118 }
1119
1120 void pinctrl_unregister_map(struct pinctrl_map const *map)
1121 {
1122 struct pinctrl_maps *maps_node;
1123
1124 list_for_each_entry(maps_node, &pinctrl_maps, node) {
1125 if (maps_node->maps == map) {
1126 list_del(&maps_node->node);
1127 return;
1128 }
1129 }
1130 }
1131
1132 /**
1133 * pinctrl_force_sleep() - turn a given controller device into sleep state
1134 * @pctldev: pin controller device
1135 */
1136 int pinctrl_force_sleep(struct pinctrl_dev *pctldev)
1137 {
1138 if (!IS_ERR(pctldev->p) && !IS_ERR(pctldev->hog_sleep))
1139 return pinctrl_select_state(pctldev->p, pctldev->hog_sleep);
1140 return 0;
1141 }
1142 EXPORT_SYMBOL_GPL(pinctrl_force_sleep);
1143
1144 /**
1145 * pinctrl_force_default() - turn a given controller device into default state
1146 * @pctldev: pin controller device
1147 */
1148 int pinctrl_force_default(struct pinctrl_dev *pctldev)
1149 {
1150 if (!IS_ERR(pctldev->p) && !IS_ERR(pctldev->hog_default))
1151 return pinctrl_select_state(pctldev->p, pctldev->hog_default);
1152 return 0;
1153 }
1154 EXPORT_SYMBOL_GPL(pinctrl_force_default);
1155
1156 #ifdef CONFIG_DEBUG_FS
1157
1158 static int pinctrl_pins_show(struct seq_file *s, void *what)
1159 {
1160 struct pinctrl_dev *pctldev = s->private;
1161 const struct pinctrl_ops *ops = pctldev->desc->pctlops;
1162 unsigned i, pin;
1163
1164 seq_printf(s, "registered pins: %d\n", pctldev->desc->npins);
1165
1166 mutex_lock(&pinctrl_mutex);
1167
1168 /* The pin number can be retrived from the pin controller descriptor */
1169 for (i = 0; i < pctldev->desc->npins; i++) {
1170 struct pin_desc *desc;
1171
1172 pin = pctldev->desc->pins[i].number;
1173 desc = pin_desc_get(pctldev, pin);
1174 /* Pin space may be sparse */
1175 if (desc == NULL)
1176 continue;
1177
1178 seq_printf(s, "pin %d (%s) ", pin,
1179 desc->name ? desc->name : "unnamed");
1180
1181 /* Driver-specific info per pin */
1182 if (ops->pin_dbg_show)
1183 ops->pin_dbg_show(pctldev, s, pin);
1184
1185 seq_puts(s, "\n");
1186 }
1187
1188 mutex_unlock(&pinctrl_mutex);
1189
1190 return 0;
1191 }
1192
1193 static int pinctrl_groups_show(struct seq_file *s, void *what)
1194 {
1195 struct pinctrl_dev *pctldev = s->private;
1196 const struct pinctrl_ops *ops = pctldev->desc->pctlops;
1197 unsigned ngroups, selector = 0;
1198
1199 ngroups = ops->get_groups_count(pctldev);
1200 mutex_lock(&pinctrl_mutex);
1201
1202 seq_puts(s, "registered pin groups:\n");
1203 while (selector < ngroups) {
1204 const unsigned *pins;
1205 unsigned num_pins;
1206 const char *gname = ops->get_group_name(pctldev, selector);
1207 const char *pname;
1208 int ret;
1209 int i;
1210
1211 ret = ops->get_group_pins(pctldev, selector,
1212 &pins, &num_pins);
1213 if (ret)
1214 seq_printf(s, "%s [ERROR GETTING PINS]\n",
1215 gname);
1216 else {
1217 seq_printf(s, "group: %s\n", gname);
1218 for (i = 0; i < num_pins; i++) {
1219 pname = pin_get_name(pctldev, pins[i]);
1220 if (WARN_ON(!pname)) {
1221 mutex_unlock(&pinctrl_mutex);
1222 return -EINVAL;
1223 }
1224 seq_printf(s, "pin %d (%s)\n", pins[i], pname);
1225 }
1226 seq_puts(s, "\n");
1227 }
1228 selector++;
1229 }
1230
1231 mutex_unlock(&pinctrl_mutex);
1232
1233 return 0;
1234 }
1235
1236 static int pinctrl_gpioranges_show(struct seq_file *s, void *what)
1237 {
1238 struct pinctrl_dev *pctldev = s->private;
1239 struct pinctrl_gpio_range *range = NULL;
1240
1241 seq_puts(s, "GPIO ranges handled:\n");
1242
1243 mutex_lock(&pinctrl_mutex);
1244
1245 /* Loop over the ranges */
1246 list_for_each_entry(range, &pctldev->gpio_ranges, node) {
1247 seq_printf(s, "%u: %s GPIOS [%u - %u] PINS [%u - %u]\n",
1248 range->id, range->name,
1249 range->base, (range->base + range->npins - 1),
1250 range->pin_base,
1251 (range->pin_base + range->npins - 1));
1252 }
1253
1254 mutex_unlock(&pinctrl_mutex);
1255
1256 return 0;
1257 }
1258
1259 static int pinctrl_devices_show(struct seq_file *s, void *what)
1260 {
1261 struct pinctrl_dev *pctldev;
1262
1263 seq_puts(s, "name [pinmux] [pinconf]\n");
1264
1265 mutex_lock(&pinctrl_mutex);
1266
1267 list_for_each_entry(pctldev, &pinctrldev_list, node) {
1268 seq_printf(s, "%s ", pctldev->desc->name);
1269 if (pctldev->desc->pmxops)
1270 seq_puts(s, "yes ");
1271 else
1272 seq_puts(s, "no ");
1273 if (pctldev->desc->confops)
1274 seq_puts(s, "yes");
1275 else
1276 seq_puts(s, "no");
1277 seq_puts(s, "\n");
1278 }
1279
1280 mutex_unlock(&pinctrl_mutex);
1281
1282 return 0;
1283 }
1284
1285 static inline const char *map_type(enum pinctrl_map_type type)
1286 {
1287 static const char * const names[] = {
1288 "INVALID",
1289 "DUMMY_STATE",
1290 "MUX_GROUP",
1291 "CONFIGS_PIN",
1292 "CONFIGS_GROUP",
1293 };
1294
1295 if (type >= ARRAY_SIZE(names))
1296 return "UNKNOWN";
1297
1298 return names[type];
1299 }
1300
1301 static int pinctrl_maps_show(struct seq_file *s, void *what)
1302 {
1303 struct pinctrl_maps *maps_node;
1304 int i;
1305 struct pinctrl_map const *map;
1306
1307 seq_puts(s, "Pinctrl maps:\n");
1308
1309 mutex_lock(&pinctrl_mutex);
1310
1311 for_each_maps(maps_node, i, map) {
1312 seq_printf(s, "device %s\nstate %s\ntype %s (%d)\n",
1313 map->dev_name, map->name, map_type(map->type),
1314 map->type);
1315
1316 if (map->type != PIN_MAP_TYPE_DUMMY_STATE)
1317 seq_printf(s, "controlling device %s\n",
1318 map->ctrl_dev_name);
1319
1320 switch (map->type) {
1321 case PIN_MAP_TYPE_MUX_GROUP:
1322 pinmux_show_map(s, map);
1323 break;
1324 case PIN_MAP_TYPE_CONFIGS_PIN:
1325 case PIN_MAP_TYPE_CONFIGS_GROUP:
1326 pinconf_show_map(s, map);
1327 break;
1328 default:
1329 break;
1330 }
1331
1332 seq_printf(s, "\n");
1333 }
1334
1335 mutex_unlock(&pinctrl_mutex);
1336
1337 return 0;
1338 }
1339
1340 static int pinctrl_show(struct seq_file *s, void *what)
1341 {
1342 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 mutex_lock(&pinctrl_mutex);
1349
1350 list_for_each_entry(p, &pinctrl_list, node) {
1351 seq_printf(s, "device: %s current state: %s\n",
1352 dev_name(p->dev),
1353 p->state ? p->state->name : "none");
1354
1355 list_for_each_entry(state, &p->states, node) {
1356 seq_printf(s, " state: %s\n", state->name);
1357
1358 list_for_each_entry(setting, &state->settings, node) {
1359 struct pinctrl_dev *pctldev = setting->pctldev;
1360
1361 seq_printf(s, " type: %s controller %s ",
1362 map_type(setting->type),
1363 pinctrl_dev_get_name(pctldev));
1364
1365 switch (setting->type) {
1366 case PIN_MAP_TYPE_MUX_GROUP:
1367 pinmux_show_setting(s, setting);
1368 break;
1369 case PIN_MAP_TYPE_CONFIGS_PIN:
1370 case PIN_MAP_TYPE_CONFIGS_GROUP:
1371 pinconf_show_setting(s, setting);
1372 break;
1373 default:
1374 break;
1375 }
1376 }
1377 }
1378 }
1379
1380 mutex_unlock(&pinctrl_mutex);
1381
1382 return 0;
1383 }
1384
1385 static int pinctrl_pins_open(struct inode *inode, struct file *file)
1386 {
1387 return single_open(file, pinctrl_pins_show, inode->i_private);
1388 }
1389
1390 static int pinctrl_groups_open(struct inode *inode, struct file *file)
1391 {
1392 return single_open(file, pinctrl_groups_show, inode->i_private);
1393 }
1394
1395 static int pinctrl_gpioranges_open(struct inode *inode, struct file *file)
1396 {
1397 return single_open(file, pinctrl_gpioranges_show, inode->i_private);
1398 }
1399
1400 static int pinctrl_devices_open(struct inode *inode, struct file *file)
1401 {
1402 return single_open(file, pinctrl_devices_show, NULL);
1403 }
1404
1405 static int pinctrl_maps_open(struct inode *inode, struct file *file)
1406 {
1407 return single_open(file, pinctrl_maps_show, NULL);
1408 }
1409
1410 static int pinctrl_open(struct inode *inode, struct file *file)
1411 {
1412 return single_open(file, pinctrl_show, NULL);
1413 }
1414
1415 static const struct file_operations pinctrl_pins_ops = {
1416 .open = pinctrl_pins_open,
1417 .read = seq_read,
1418 .llseek = seq_lseek,
1419 .release = single_release,
1420 };
1421
1422 static const struct file_operations pinctrl_groups_ops = {
1423 .open = pinctrl_groups_open,
1424 .read = seq_read,
1425 .llseek = seq_lseek,
1426 .release = single_release,
1427 };
1428
1429 static const struct file_operations pinctrl_gpioranges_ops = {
1430 .open = pinctrl_gpioranges_open,
1431 .read = seq_read,
1432 .llseek = seq_lseek,
1433 .release = single_release,
1434 };
1435
1436 static const struct file_operations pinctrl_devices_ops = {
1437 .open = pinctrl_devices_open,
1438 .read = seq_read,
1439 .llseek = seq_lseek,
1440 .release = single_release,
1441 };
1442
1443 static const struct file_operations pinctrl_maps_ops = {
1444 .open = pinctrl_maps_open,
1445 .read = seq_read,
1446 .llseek = seq_lseek,
1447 .release = single_release,
1448 };
1449
1450 static const struct file_operations pinctrl_ops = {
1451 .open = pinctrl_open,
1452 .read = seq_read,
1453 .llseek = seq_lseek,
1454 .release = single_release,
1455 };
1456
1457 static struct dentry *debugfs_root;
1458
1459 static void pinctrl_init_device_debugfs(struct pinctrl_dev *pctldev)
1460 {
1461 struct dentry *device_root;
1462
1463 device_root = debugfs_create_dir(dev_name(pctldev->dev),
1464 debugfs_root);
1465 pctldev->device_root = device_root;
1466
1467 if (IS_ERR(device_root) || !device_root) {
1468 pr_warn("failed to create debugfs directory for %s\n",
1469 dev_name(pctldev->dev));
1470 return;
1471 }
1472 debugfs_create_file("pins", S_IFREG | S_IRUGO,
1473 device_root, pctldev, &pinctrl_pins_ops);
1474 debugfs_create_file("pingroups", S_IFREG | S_IRUGO,
1475 device_root, pctldev, &pinctrl_groups_ops);
1476 debugfs_create_file("gpio-ranges", S_IFREG | S_IRUGO,
1477 device_root, pctldev, &pinctrl_gpioranges_ops);
1478 pinmux_init_device_debugfs(device_root, pctldev);
1479 pinconf_init_device_debugfs(device_root, pctldev);
1480 }
1481
1482 static void pinctrl_remove_device_debugfs(struct pinctrl_dev *pctldev)
1483 {
1484 debugfs_remove_recursive(pctldev->device_root);
1485 }
1486
1487 static void pinctrl_init_debugfs(void)
1488 {
1489 debugfs_root = debugfs_create_dir("pinctrl", NULL);
1490 if (IS_ERR(debugfs_root) || !debugfs_root) {
1491 pr_warn("failed to create debugfs directory\n");
1492 debugfs_root = NULL;
1493 return;
1494 }
1495
1496 debugfs_create_file("pinctrl-devices", S_IFREG | S_IRUGO,
1497 debugfs_root, NULL, &pinctrl_devices_ops);
1498 debugfs_create_file("pinctrl-maps", S_IFREG | S_IRUGO,
1499 debugfs_root, NULL, &pinctrl_maps_ops);
1500 debugfs_create_file("pinctrl-handles", S_IFREG | S_IRUGO,
1501 debugfs_root, NULL, &pinctrl_ops);
1502 }
1503
1504 #else /* CONFIG_DEBUG_FS */
1505
1506 static void pinctrl_init_device_debugfs(struct pinctrl_dev *pctldev)
1507 {
1508 }
1509
1510 static void pinctrl_init_debugfs(void)
1511 {
1512 }
1513
1514 static void pinctrl_remove_device_debugfs(struct pinctrl_dev *pctldev)
1515 {
1516 }
1517
1518 #endif
1519
1520 static int pinctrl_check_ops(struct pinctrl_dev *pctldev)
1521 {
1522 const struct pinctrl_ops *ops = pctldev->desc->pctlops;
1523
1524 if (!ops ||
1525 !ops->get_groups_count ||
1526 !ops->get_group_name ||
1527 !ops->get_group_pins)
1528 return -EINVAL;
1529
1530 if (ops->dt_node_to_map && !ops->dt_free_map)
1531 return -EINVAL;
1532
1533 return 0;
1534 }
1535
1536 /**
1537 * pinctrl_register() - register a pin controller device
1538 * @pctldesc: descriptor for this pin controller
1539 * @dev: parent device for this pin controller
1540 * @driver_data: private pin controller data for this pin controller
1541 */
1542 struct pinctrl_dev *pinctrl_register(struct pinctrl_desc *pctldesc,
1543 struct device *dev, void *driver_data)
1544 {
1545 struct pinctrl_dev *pctldev;
1546 int ret;
1547
1548 if (!pctldesc)
1549 return NULL;
1550 if (!pctldesc->name)
1551 return NULL;
1552
1553 pctldev = kzalloc(sizeof(*pctldev), GFP_KERNEL);
1554 if (pctldev == NULL) {
1555 dev_err(dev, "failed to alloc struct pinctrl_dev\n");
1556 return NULL;
1557 }
1558
1559 /* Initialize pin control device struct */
1560 pctldev->owner = pctldesc->owner;
1561 pctldev->desc = pctldesc;
1562 pctldev->driver_data = driver_data;
1563 INIT_RADIX_TREE(&pctldev->pin_desc_tree, GFP_KERNEL);
1564 INIT_LIST_HEAD(&pctldev->gpio_ranges);
1565 pctldev->dev = dev;
1566
1567 /* check core ops for sanity */
1568 if (pinctrl_check_ops(pctldev)) {
1569 dev_err(dev, "pinctrl ops lacks necessary functions\n");
1570 goto out_err;
1571 }
1572
1573 /* If we're implementing pinmuxing, check the ops for sanity */
1574 if (pctldesc->pmxops) {
1575 if (pinmux_check_ops(pctldev))
1576 goto out_err;
1577 }
1578
1579 /* If we're implementing pinconfig, check the ops for sanity */
1580 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 ret = pinctrl_register_pins(pctldev, pctldesc->pins, pctldesc->npins);
1588 if (ret) {
1589 dev_err(dev, "error during pin registration\n");
1590 pinctrl_free_pindescs(pctldev, pctldesc->pins,
1591 pctldesc->npins);
1592 goto out_err;
1593 }
1594
1595 mutex_lock(&pinctrl_mutex);
1596
1597 list_add_tail(&pctldev->node, &pinctrldev_list);
1598
1599 pctldev->p = pinctrl_get_locked(pctldev->dev);
1600 if (!IS_ERR(pctldev->p)) {
1601 pctldev->hog_default =
1602 pinctrl_lookup_state_locked(pctldev->p,
1603 PINCTRL_STATE_DEFAULT);
1604 if (IS_ERR(pctldev->hog_default)) {
1605 dev_dbg(dev, "failed to lookup the default state\n");
1606 } else {
1607 if (pinctrl_select_state_locked(pctldev->p,
1608 pctldev->hog_default))
1609 dev_err(dev,
1610 "failed to select default state\n");
1611 }
1612
1613 pctldev->hog_sleep =
1614 pinctrl_lookup_state_locked(pctldev->p,
1615 PINCTRL_STATE_SLEEP);
1616 if (IS_ERR(pctldev->hog_sleep))
1617 dev_dbg(dev, "failed to lookup the sleep state\n");
1618 }
1619
1620 mutex_unlock(&pinctrl_mutex);
1621
1622 pinctrl_init_device_debugfs(pctldev);
1623
1624 return pctldev;
1625
1626 out_err:
1627 kfree(pctldev);
1628 return NULL;
1629 }
1630 EXPORT_SYMBOL_GPL(pinctrl_register);
1631
1632 /**
1633 * pinctrl_unregister() - unregister pinmux
1634 * @pctldev: pin controller to unregister
1635 *
1636 * Called by pinmux drivers to unregister a pinmux.
1637 */
1638 void pinctrl_unregister(struct pinctrl_dev *pctldev)
1639 {
1640 struct pinctrl_gpio_range *range, *n;
1641 if (pctldev == NULL)
1642 return;
1643
1644 pinctrl_remove_device_debugfs(pctldev);
1645
1646 mutex_lock(&pinctrl_mutex);
1647
1648 if (!IS_ERR(pctldev->p))
1649 pinctrl_put_locked(pctldev->p, true);
1650
1651 /* TODO: check that no pinmuxes are still active? */
1652 list_del(&pctldev->node);
1653 /* Destroy descriptor tree */
1654 pinctrl_free_pindescs(pctldev, pctldev->desc->pins,
1655 pctldev->desc->npins);
1656 /* remove gpio ranges map */
1657 list_for_each_entry_safe(range, n, &pctldev->gpio_ranges, node)
1658 list_del(&range->node);
1659
1660 kfree(pctldev);
1661
1662 mutex_unlock(&pinctrl_mutex);
1663 }
1664 EXPORT_SYMBOL_GPL(pinctrl_unregister);
1665
1666 static int __init pinctrl_init(void)
1667 {
1668 pr_info("initialized pinctrl subsystem\n");
1669 pinctrl_init_debugfs();
1670 return 0;
1671 }
1672
1673 /* init early since many drivers really need to initialized pinmux early */
1674 core_initcall(pinctrl_init);