2 * Core driver for the pin control subsystem
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
8 * Author: Linus Walleij <linus.walleij@linaro.org>
10 * Copyright (C) 2012 NVIDIA CORPORATION. All rights reserved.
12 * License terms: GNU General Public License (GPL) version 2
14 #define pr_fmt(fmt) "pinctrl core: " fmt
16 #include <linux/kernel.h>
17 #include <linux/export.h>
18 #include <linux/init.h>
19 #include <linux/device.h>
20 #include <linux/slab.h>
21 #include <linux/err.h>
22 #include <linux/list.h>
23 #include <linux/sysfs.h>
24 #include <linux/debugfs.h>
25 #include <linux/seq_file.h>
26 #include <linux/pinctrl/consumer.h>
27 #include <linux/pinctrl/pinctrl.h>
28 #include <linux/pinctrl/machine.h>
30 #include "devicetree.h"
35 * struct pinctrl_maps - a list item containing part of the mapping table
36 * @node: mapping table list node
37 * @maps: array of mapping table entries
38 * @num_maps: the number of entries in @maps
41 struct list_head node
;
42 struct pinctrl_map
const *maps
;
46 static bool pinctrl_dummy_state
;
48 /* Mutex taken by all entry points */
49 DEFINE_MUTEX(pinctrl_mutex
);
51 /* Global list of pin control devices (struct pinctrl_dev) */
52 LIST_HEAD(pinctrldev_list
);
54 /* List of pin controller handles (struct pinctrl) */
55 static LIST_HEAD(pinctrl_list
);
57 /* List of pinctrl maps (struct pinctrl_maps) */
58 static LIST_HEAD(pinctrl_maps
);
60 #define for_each_maps(_maps_node_, _i_, _map_) \
61 list_for_each_entry(_maps_node_, &pinctrl_maps, node) \
62 for (_i_ = 0, _map_ = &_maps_node_->maps[_i_]; \
63 _i_ < _maps_node_->num_maps; \
64 _i_++, _map_ = &_maps_node_->maps[_i_])
67 * pinctrl_provide_dummies() - indicate if pinctrl provides dummy state support
69 * Usually this function is called by platforms without pinctrl driver support
70 * but run with some shared drivers using pinctrl APIs.
71 * After calling this function, the pinctrl core will return successfully
72 * with creating a dummy state for the driver to keep going smoothly.
74 void pinctrl_provide_dummies(void)
76 pinctrl_dummy_state
= true;
79 const char *pinctrl_dev_get_name(struct pinctrl_dev
*pctldev
)
81 /* We're not allowed to register devices without name */
82 return pctldev
->desc
->name
;
84 EXPORT_SYMBOL_GPL(pinctrl_dev_get_name
);
86 void *pinctrl_dev_get_drvdata(struct pinctrl_dev
*pctldev
)
88 return pctldev
->driver_data
;
90 EXPORT_SYMBOL_GPL(pinctrl_dev_get_drvdata
);
93 * get_pinctrl_dev_from_devname() - look up pin controller device
94 * @devname: the name of a device instance, as returned by dev_name()
96 * Looks up a pin control device matching a certain device name or pure device
97 * pointer, the pure device pointer will take precedence.
99 struct pinctrl_dev
*get_pinctrl_dev_from_devname(const char *devname
)
101 struct pinctrl_dev
*pctldev
= NULL
;
107 list_for_each_entry(pctldev
, &pinctrldev_list
, node
) {
108 if (!strcmp(dev_name(pctldev
->dev
), devname
)) {
109 /* Matched on device name */
115 return found
? pctldev
: NULL
;
119 * pin_get_from_name() - look up a pin number from a name
120 * @pctldev: the pin control device to lookup the pin on
121 * @name: the name of the pin to look up
123 int pin_get_from_name(struct pinctrl_dev
*pctldev
, const char *name
)
127 /* The pin number can be retrived from the pin controller descriptor */
128 for (i
= 0; i
< pctldev
->desc
->npins
; i
++) {
129 struct pin_desc
*desc
;
131 pin
= pctldev
->desc
->pins
[i
].number
;
132 desc
= pin_desc_get(pctldev
, pin
);
133 /* Pin space may be sparse */
136 if (desc
->name
&& !strcmp(name
, desc
->name
))
144 * pin_get_name_from_id() - look up a pin name from a pin id
145 * @pctldev: the pin control device to lookup the pin on
146 * @name: the name of the pin to look up
148 const char *pin_get_name(struct pinctrl_dev
*pctldev
, const unsigned pin
)
150 const struct pin_desc
*desc
;
152 desc
= pin_desc_get(pctldev
, pin
);
154 dev_err(pctldev
->dev
, "failed to get pin(%d) name\n",
163 * pin_is_valid() - check if pin exists on controller
164 * @pctldev: the pin control device to check the pin on
165 * @pin: pin to check, use the local pin controller index number
167 * This tells us whether a certain pin exist on a certain pin controller or
168 * not. Pin lists may be sparse, so some pins may not exist.
170 bool pin_is_valid(struct pinctrl_dev
*pctldev
, int pin
)
172 struct pin_desc
*pindesc
;
177 mutex_lock(&pinctrl_mutex
);
178 pindesc
= pin_desc_get(pctldev
, pin
);
179 mutex_unlock(&pinctrl_mutex
);
181 return pindesc
!= NULL
;
183 EXPORT_SYMBOL_GPL(pin_is_valid
);
185 /* Deletes a range of pin descriptors */
186 static void pinctrl_free_pindescs(struct pinctrl_dev
*pctldev
,
187 const struct pinctrl_pin_desc
*pins
,
192 for (i
= 0; i
< num_pins
; i
++) {
193 struct pin_desc
*pindesc
;
195 pindesc
= radix_tree_lookup(&pctldev
->pin_desc_tree
,
197 if (pindesc
!= NULL
) {
198 radix_tree_delete(&pctldev
->pin_desc_tree
,
200 if (pindesc
->dynamic_name
)
201 kfree(pindesc
->name
);
207 static int pinctrl_register_one_pin(struct pinctrl_dev
*pctldev
,
208 unsigned number
, const char *name
)
210 struct pin_desc
*pindesc
;
212 pindesc
= pin_desc_get(pctldev
, number
);
213 if (pindesc
!= NULL
) {
214 pr_err("pin %d already registered on %s\n", number
,
215 pctldev
->desc
->name
);
219 pindesc
= kzalloc(sizeof(*pindesc
), GFP_KERNEL
);
220 if (pindesc
== NULL
) {
221 dev_err(pctldev
->dev
, "failed to alloc struct pin_desc\n");
226 pindesc
->pctldev
= pctldev
;
228 /* Copy basic pin info */
230 pindesc
->name
= name
;
232 pindesc
->name
= kasprintf(GFP_KERNEL
, "PIN%u", number
);
233 if (pindesc
->name
== NULL
) {
237 pindesc
->dynamic_name
= true;
240 radix_tree_insert(&pctldev
->pin_desc_tree
, number
, pindesc
);
241 pr_debug("registered pin %d (%s) on %s\n",
242 number
, pindesc
->name
, pctldev
->desc
->name
);
246 static int pinctrl_register_pins(struct pinctrl_dev
*pctldev
,
247 struct pinctrl_pin_desc
const *pins
,
253 for (i
= 0; i
< num_descs
; i
++) {
254 ret
= pinctrl_register_one_pin(pctldev
,
255 pins
[i
].number
, pins
[i
].name
);
264 * pinctrl_match_gpio_range() - check if a certain GPIO pin is in range
265 * @pctldev: pin controller device to check
266 * @gpio: gpio pin to check taken from the global GPIO pin space
268 * Tries to match a GPIO pin number to the ranges handled by a certain pin
269 * controller, return the range or NULL
271 static struct pinctrl_gpio_range
*
272 pinctrl_match_gpio_range(struct pinctrl_dev
*pctldev
, unsigned gpio
)
274 struct pinctrl_gpio_range
*range
= NULL
;
276 /* Loop over the ranges */
277 list_for_each_entry(range
, &pctldev
->gpio_ranges
, node
) {
278 /* Check if we're in the valid range */
279 if (gpio
>= range
->base
&&
280 gpio
< range
->base
+ range
->npins
) {
289 * pinctrl_get_device_gpio_range() - find device for GPIO range
290 * @gpio: the pin to locate the pin controller for
291 * @outdev: the pin control device if found
292 * @outrange: the GPIO range if found
294 * Find the pin controller handling a certain GPIO pin from the pinspace of
295 * the GPIO subsystem, return the device and the matching GPIO range. Returns
296 * -EPROBE_DEFER if the GPIO range could not be found in any device since it
297 * may still have not been registered.
299 static int pinctrl_get_device_gpio_range(unsigned gpio
,
300 struct pinctrl_dev
**outdev
,
301 struct pinctrl_gpio_range
**outrange
)
303 struct pinctrl_dev
*pctldev
= NULL
;
305 /* Loop over the pin controllers */
306 list_for_each_entry(pctldev
, &pinctrldev_list
, node
) {
307 struct pinctrl_gpio_range
*range
;
309 range
= pinctrl_match_gpio_range(pctldev
, gpio
);
317 return -EPROBE_DEFER
;
321 * pinctrl_add_gpio_range() - register a GPIO range for a controller
322 * @pctldev: pin controller device to add the range to
323 * @range: the GPIO range to add
325 * This adds a range of GPIOs to be handled by a certain pin controller. Call
326 * this to register handled ranges after registering your pin controller.
328 void pinctrl_add_gpio_range(struct pinctrl_dev
*pctldev
,
329 struct pinctrl_gpio_range
*range
)
331 mutex_lock(&pinctrl_mutex
);
332 list_add_tail(&range
->node
, &pctldev
->gpio_ranges
);
333 mutex_unlock(&pinctrl_mutex
);
335 EXPORT_SYMBOL_GPL(pinctrl_add_gpio_range
);
337 void pinctrl_add_gpio_ranges(struct pinctrl_dev
*pctldev
,
338 struct pinctrl_gpio_range
*ranges
,
343 for (i
= 0; i
< nranges
; i
++)
344 pinctrl_add_gpio_range(pctldev
, &ranges
[i
]);
346 EXPORT_SYMBOL_GPL(pinctrl_add_gpio_ranges
);
349 * pinctrl_get_group_selector() - returns the group selector for a group
350 * @pctldev: the pin controller handling the group
351 * @pin_group: the pin group to look up
353 int pinctrl_get_group_selector(struct pinctrl_dev
*pctldev
,
354 const char *pin_group
)
356 const struct pinctrl_ops
*pctlops
= pctldev
->desc
->pctlops
;
357 unsigned ngroups
= pctlops
->get_groups_count(pctldev
);
358 unsigned group_selector
= 0;
360 while (group_selector
< ngroups
) {
361 const char *gname
= pctlops
->get_group_name(pctldev
,
363 if (!strcmp(gname
, pin_group
)) {
364 dev_dbg(pctldev
->dev
,
365 "found group selector %u for %s\n",
368 return group_selector
;
374 dev_err(pctldev
->dev
, "does not have pin group %s\n",
381 * pinctrl_request_gpio() - request a single pin to be used in as GPIO
382 * @gpio: the GPIO pin number from the GPIO subsystem number space
384 * This function should *ONLY* be used from gpiolib-based GPIO drivers,
385 * as part of their gpio_request() semantics, platforms and individual drivers
386 * shall *NOT* request GPIO pins to be muxed in.
388 int pinctrl_request_gpio(unsigned gpio
)
390 struct pinctrl_dev
*pctldev
;
391 struct pinctrl_gpio_range
*range
;
395 mutex_lock(&pinctrl_mutex
);
397 ret
= pinctrl_get_device_gpio_range(gpio
, &pctldev
, &range
);
399 mutex_unlock(&pinctrl_mutex
);
403 /* Convert to the pin controllers number space */
404 pin
= gpio
- range
->base
+ range
->pin_base
;
406 ret
= pinmux_request_gpio(pctldev
, range
, pin
, gpio
);
408 mutex_unlock(&pinctrl_mutex
);
411 EXPORT_SYMBOL_GPL(pinctrl_request_gpio
);
414 * pinctrl_free_gpio() - free control on a single pin, currently used as GPIO
415 * @gpio: the GPIO pin number from the GPIO subsystem number space
417 * This function should *ONLY* be used from gpiolib-based GPIO drivers,
418 * as part of their gpio_free() semantics, platforms and individual drivers
419 * shall *NOT* request GPIO pins to be muxed out.
421 void pinctrl_free_gpio(unsigned gpio
)
423 struct pinctrl_dev
*pctldev
;
424 struct pinctrl_gpio_range
*range
;
428 mutex_lock(&pinctrl_mutex
);
430 ret
= pinctrl_get_device_gpio_range(gpio
, &pctldev
, &range
);
432 mutex_unlock(&pinctrl_mutex
);
436 /* Convert to the pin controllers number space */
437 pin
= gpio
- range
->base
+ range
->pin_base
;
439 pinmux_free_gpio(pctldev
, pin
, range
);
441 mutex_unlock(&pinctrl_mutex
);
443 EXPORT_SYMBOL_GPL(pinctrl_free_gpio
);
445 static int pinctrl_gpio_direction(unsigned gpio
, bool input
)
447 struct pinctrl_dev
*pctldev
;
448 struct pinctrl_gpio_range
*range
;
452 ret
= pinctrl_get_device_gpio_range(gpio
, &pctldev
, &range
);
456 /* Convert to the pin controllers number space */
457 pin
= gpio
- range
->base
+ range
->pin_base
;
459 return pinmux_gpio_direction(pctldev
, range
, pin
, input
);
463 * pinctrl_gpio_direction_input() - request a GPIO pin to go into input mode
464 * @gpio: the GPIO pin number from the GPIO subsystem number space
466 * This function should *ONLY* be used from gpiolib-based GPIO drivers,
467 * as part of their gpio_direction_input() semantics, platforms and individual
468 * drivers shall *NOT* touch pin control GPIO calls.
470 int pinctrl_gpio_direction_input(unsigned gpio
)
473 mutex_lock(&pinctrl_mutex
);
474 ret
= pinctrl_gpio_direction(gpio
, true);
475 mutex_unlock(&pinctrl_mutex
);
478 EXPORT_SYMBOL_GPL(pinctrl_gpio_direction_input
);
481 * pinctrl_gpio_direction_output() - request a GPIO pin to go into output mode
482 * @gpio: the GPIO pin number from the GPIO subsystem number space
484 * This function should *ONLY* be used from gpiolib-based GPIO drivers,
485 * as part of their gpio_direction_output() semantics, platforms and individual
486 * drivers shall *NOT* touch pin control GPIO calls.
488 int pinctrl_gpio_direction_output(unsigned gpio
)
491 mutex_lock(&pinctrl_mutex
);
492 ret
= pinctrl_gpio_direction(gpio
, false);
493 mutex_unlock(&pinctrl_mutex
);
496 EXPORT_SYMBOL_GPL(pinctrl_gpio_direction_output
);
498 static struct pinctrl_state
*find_state(struct pinctrl
*p
,
501 struct pinctrl_state
*state
;
503 list_for_each_entry(state
, &p
->states
, node
)
504 if (!strcmp(state
->name
, name
))
510 static struct pinctrl_state
*create_state(struct pinctrl
*p
,
513 struct pinctrl_state
*state
;
515 state
= kzalloc(sizeof(*state
), GFP_KERNEL
);
518 "failed to alloc struct pinctrl_state\n");
519 return ERR_PTR(-ENOMEM
);
523 INIT_LIST_HEAD(&state
->settings
);
525 list_add_tail(&state
->node
, &p
->states
);
530 static int add_setting(struct pinctrl
*p
, struct pinctrl_map
const *map
)
532 struct pinctrl_state
*state
;
533 struct pinctrl_setting
*setting
;
536 state
= find_state(p
, map
->name
);
538 state
= create_state(p
, map
->name
);
540 return PTR_ERR(state
);
542 if (map
->type
== PIN_MAP_TYPE_DUMMY_STATE
)
545 setting
= kzalloc(sizeof(*setting
), GFP_KERNEL
);
546 if (setting
== NULL
) {
548 "failed to alloc struct pinctrl_setting\n");
552 setting
->type
= map
->type
;
554 setting
->pctldev
= get_pinctrl_dev_from_devname(map
->ctrl_dev_name
);
555 if (setting
->pctldev
== NULL
) {
556 dev_info(p
->dev
, "unknown pinctrl device %s in map entry, deferring probe",
560 * OK let us guess that the driver is not there yet, and
561 * let's defer obtaining this pinctrl handle to later...
563 return -EPROBE_DEFER
;
566 setting
->dev_name
= map
->dev_name
;
569 case PIN_MAP_TYPE_MUX_GROUP
:
570 ret
= pinmux_map_to_setting(map
, setting
);
572 case PIN_MAP_TYPE_CONFIGS_PIN
:
573 case PIN_MAP_TYPE_CONFIGS_GROUP
:
574 ret
= pinconf_map_to_setting(map
, setting
);
585 list_add_tail(&setting
->node
, &state
->settings
);
590 static struct pinctrl
*find_pinctrl(struct device
*dev
)
594 list_for_each_entry(p
, &pinctrl_list
, node
)
601 static void pinctrl_put_locked(struct pinctrl
*p
, bool inlist
);
603 static struct pinctrl
*create_pinctrl(struct device
*dev
)
607 struct pinctrl_maps
*maps_node
;
609 struct pinctrl_map
const *map
;
613 * create the state cookie holder struct pinctrl for each
614 * mapping, this is what consumers will get when requesting
615 * a pin control handle with pinctrl_get()
617 p
= kzalloc(sizeof(*p
), GFP_KERNEL
);
619 dev_err(dev
, "failed to alloc struct pinctrl\n");
620 return ERR_PTR(-ENOMEM
);
623 INIT_LIST_HEAD(&p
->states
);
624 INIT_LIST_HEAD(&p
->dt_maps
);
626 ret
= pinctrl_dt_to_map(p
);
632 devname
= dev_name(dev
);
634 /* Iterate over the pin control maps to locate the right ones */
635 for_each_maps(maps_node
, i
, map
) {
636 /* Map must be for this device */
637 if (strcmp(map
->dev_name
, devname
))
640 ret
= add_setting(p
, map
);
642 pinctrl_put_locked(p
, false);
647 /* Add the pinmux to the global list */
648 list_add_tail(&p
->node
, &pinctrl_list
);
653 static struct pinctrl
*pinctrl_get_locked(struct device
*dev
)
658 return ERR_PTR(-EINVAL
);
660 p
= find_pinctrl(dev
);
662 return ERR_PTR(-EBUSY
);
664 return create_pinctrl(dev
);
668 * pinctrl_get() - retrieves the pinctrl handle for a device
669 * @dev: the device to obtain the handle for
671 struct pinctrl
*pinctrl_get(struct device
*dev
)
675 mutex_lock(&pinctrl_mutex
);
676 p
= pinctrl_get_locked(dev
);
677 mutex_unlock(&pinctrl_mutex
);
681 EXPORT_SYMBOL_GPL(pinctrl_get
);
683 static void pinctrl_put_locked(struct pinctrl
*p
, bool inlist
)
685 struct pinctrl_state
*state
, *n1
;
686 struct pinctrl_setting
*setting
, *n2
;
688 list_for_each_entry_safe(state
, n1
, &p
->states
, node
) {
689 list_for_each_entry_safe(setting
, n2
, &state
->settings
, node
) {
690 switch (setting
->type
) {
691 case PIN_MAP_TYPE_MUX_GROUP
:
692 if (state
== p
->state
)
693 pinmux_disable_setting(setting
);
694 pinmux_free_setting(setting
);
696 case PIN_MAP_TYPE_CONFIGS_PIN
:
697 case PIN_MAP_TYPE_CONFIGS_GROUP
:
698 pinconf_free_setting(setting
);
703 list_del(&setting
->node
);
706 list_del(&state
->node
);
710 pinctrl_dt_free_maps(p
);
718 * pinctrl_put() - release a previously claimed pinctrl handle
719 * @p: the pinctrl handle to release
721 void pinctrl_put(struct pinctrl
*p
)
723 mutex_lock(&pinctrl_mutex
);
724 pinctrl_put_locked(p
, true);
725 mutex_unlock(&pinctrl_mutex
);
727 EXPORT_SYMBOL_GPL(pinctrl_put
);
729 static struct pinctrl_state
*pinctrl_lookup_state_locked(struct pinctrl
*p
,
732 struct pinctrl_state
*state
;
734 state
= find_state(p
, name
);
736 if (pinctrl_dummy_state
) {
737 /* create dummy state */
738 dev_dbg(p
->dev
, "using pinctrl dummy state (%s)\n",
740 state
= create_state(p
, name
);
742 state
= ERR_PTR(-ENODEV
);
749 * pinctrl_lookup_state() - retrieves a state handle from a pinctrl handle
750 * @p: the pinctrl handle to retrieve the state from
751 * @name: the state name to retrieve
753 struct pinctrl_state
*pinctrl_lookup_state(struct pinctrl
*p
, const char *name
)
755 struct pinctrl_state
*s
;
757 mutex_lock(&pinctrl_mutex
);
758 s
= pinctrl_lookup_state_locked(p
, name
);
759 mutex_unlock(&pinctrl_mutex
);
763 EXPORT_SYMBOL_GPL(pinctrl_lookup_state
);
765 static int pinctrl_select_state_locked(struct pinctrl
*p
,
766 struct pinctrl_state
*state
)
768 struct pinctrl_setting
*setting
, *setting2
;
771 if (p
->state
== state
)
776 * The set of groups with a mux configuration in the old state
777 * may not be identical to the set of groups with a mux setting
778 * in the new state. While this might be unusual, it's entirely
779 * possible for the "user"-supplied mapping table to be written
780 * that way. For each group that was configured in the old state
781 * but not in the new state, this code puts that group into a
782 * safe/disabled state.
784 list_for_each_entry(setting
, &p
->state
->settings
, node
) {
786 if (setting
->type
!= PIN_MAP_TYPE_MUX_GROUP
)
788 list_for_each_entry(setting2
, &state
->settings
, node
) {
789 if (setting2
->type
!= PIN_MAP_TYPE_MUX_GROUP
)
791 if (setting2
->data
.mux
.group
==
792 setting
->data
.mux
.group
) {
798 pinmux_disable_setting(setting
);
804 /* Apply all the settings for the new state */
805 list_for_each_entry(setting
, &state
->settings
, node
) {
806 switch (setting
->type
) {
807 case PIN_MAP_TYPE_MUX_GROUP
:
808 ret
= pinmux_enable_setting(setting
);
810 case PIN_MAP_TYPE_CONFIGS_PIN
:
811 case PIN_MAP_TYPE_CONFIGS_GROUP
:
812 ret
= pinconf_apply_setting(setting
);
819 /* FIXME: Difficult to return to prev state */
828 * pinctrl_select() - select/activate/program a pinctrl state to HW
829 * @p: the pinctrl handle for the device that requests configuratio
830 * @state: the state handle to select/activate/program
832 int pinctrl_select_state(struct pinctrl
*p
, struct pinctrl_state
*state
)
836 mutex_lock(&pinctrl_mutex
);
837 ret
= pinctrl_select_state_locked(p
, state
);
838 mutex_unlock(&pinctrl_mutex
);
842 EXPORT_SYMBOL_GPL(pinctrl_select_state
);
844 static void devm_pinctrl_release(struct device
*dev
, void *res
)
846 pinctrl_put(*(struct pinctrl
**)res
);
850 * struct devm_pinctrl_get() - Resource managed pinctrl_get()
851 * @dev: the device to obtain the handle for
853 * If there is a need to explicitly destroy the returned struct pinctrl,
854 * devm_pinctrl_put() should be used, rather than plain pinctrl_put().
856 struct pinctrl
*devm_pinctrl_get(struct device
*dev
)
858 struct pinctrl
**ptr
, *p
;
860 ptr
= devres_alloc(devm_pinctrl_release
, sizeof(*ptr
), GFP_KERNEL
);
862 return ERR_PTR(-ENOMEM
);
864 p
= pinctrl_get(dev
);
867 devres_add(dev
, ptr
);
874 EXPORT_SYMBOL_GPL(devm_pinctrl_get
);
876 static int devm_pinctrl_match(struct device
*dev
, void *res
, void *data
)
878 struct pinctrl
**p
= res
;
884 * devm_pinctrl_put() - Resource managed pinctrl_put()
885 * @p: the pinctrl handle to release
887 * Deallocate a struct pinctrl obtained via devm_pinctrl_get(). Normally
888 * this function will not need to be called and the resource management
889 * code will ensure that the resource is freed.
891 void devm_pinctrl_put(struct pinctrl
*p
)
893 WARN_ON(devres_destroy(p
->dev
, devm_pinctrl_release
,
894 devm_pinctrl_match
, p
));
897 EXPORT_SYMBOL_GPL(devm_pinctrl_put
);
899 int pinctrl_register_map(struct pinctrl_map
const *maps
, unsigned num_maps
,
900 bool dup
, bool locked
)
903 struct pinctrl_maps
*maps_node
;
905 pr_debug("add %d pinmux maps\n", num_maps
);
907 /* First sanity check the new mapping */
908 for (i
= 0; i
< num_maps
; i
++) {
909 if (!maps
[i
].dev_name
) {
910 pr_err("failed to register map %s (%d): no device given\n",
916 pr_err("failed to register map %d: no map name given\n",
921 if (maps
[i
].type
!= PIN_MAP_TYPE_DUMMY_STATE
&&
922 !maps
[i
].ctrl_dev_name
) {
923 pr_err("failed to register map %s (%d): no pin control device given\n",
928 switch (maps
[i
].type
) {
929 case PIN_MAP_TYPE_DUMMY_STATE
:
931 case PIN_MAP_TYPE_MUX_GROUP
:
932 ret
= pinmux_validate_map(&maps
[i
], i
);
936 case PIN_MAP_TYPE_CONFIGS_PIN
:
937 case PIN_MAP_TYPE_CONFIGS_GROUP
:
938 ret
= pinconf_validate_map(&maps
[i
], i
);
943 pr_err("failed to register map %s (%d): invalid type given\n",
949 maps_node
= kzalloc(sizeof(*maps_node
), GFP_KERNEL
);
951 pr_err("failed to alloc struct pinctrl_maps\n");
955 maps_node
->num_maps
= num_maps
;
957 maps_node
->maps
= kmemdup(maps
, sizeof(*maps
) * num_maps
,
959 if (!maps_node
->maps
) {
960 pr_err("failed to duplicate mapping table\n");
965 maps_node
->maps
= maps
;
969 mutex_lock(&pinctrl_mutex
);
970 list_add_tail(&maps_node
->node
, &pinctrl_maps
);
972 mutex_unlock(&pinctrl_mutex
);
978 * pinctrl_register_mappings() - register a set of pin controller mappings
979 * @maps: the pincontrol mappings table to register. This should probably be
980 * marked with __initdata so it can be discarded after boot. This
981 * function will perform a shallow copy for the mapping entries.
982 * @num_maps: the number of maps in the mapping table
984 int pinctrl_register_mappings(struct pinctrl_map
const *maps
,
987 return pinctrl_register_map(maps
, num_maps
, true, false);
990 void pinctrl_unregister_map(struct pinctrl_map
const *map
)
992 struct pinctrl_maps
*maps_node
;
994 list_for_each_entry(maps_node
, &pinctrl_maps
, node
) {
995 if (maps_node
->maps
== map
) {
996 list_del(&maps_node
->node
);
1002 #ifdef CONFIG_DEBUG_FS
1004 static int pinctrl_pins_show(struct seq_file
*s
, void *what
)
1006 struct pinctrl_dev
*pctldev
= s
->private;
1007 const struct pinctrl_ops
*ops
= pctldev
->desc
->pctlops
;
1010 seq_printf(s
, "registered pins: %d\n", pctldev
->desc
->npins
);
1012 mutex_lock(&pinctrl_mutex
);
1014 /* The pin number can be retrived from the pin controller descriptor */
1015 for (i
= 0; i
< pctldev
->desc
->npins
; i
++) {
1016 struct pin_desc
*desc
;
1018 pin
= pctldev
->desc
->pins
[i
].number
;
1019 desc
= pin_desc_get(pctldev
, pin
);
1020 /* Pin space may be sparse */
1024 seq_printf(s
, "pin %d (%s) ", pin
,
1025 desc
->name
? desc
->name
: "unnamed");
1027 /* Driver-specific info per pin */
1028 if (ops
->pin_dbg_show
)
1029 ops
->pin_dbg_show(pctldev
, s
, pin
);
1034 mutex_unlock(&pinctrl_mutex
);
1039 static int pinctrl_groups_show(struct seq_file
*s
, void *what
)
1041 struct pinctrl_dev
*pctldev
= s
->private;
1042 const struct pinctrl_ops
*ops
= pctldev
->desc
->pctlops
;
1043 unsigned ngroups
, selector
= 0;
1045 ngroups
= ops
->get_groups_count(pctldev
);
1046 mutex_lock(&pinctrl_mutex
);
1048 seq_puts(s
, "registered pin groups:\n");
1049 while (selector
< ngroups
) {
1050 const unsigned *pins
;
1052 const char *gname
= ops
->get_group_name(pctldev
, selector
);
1057 ret
= ops
->get_group_pins(pctldev
, selector
,
1060 seq_printf(s
, "%s [ERROR GETTING PINS]\n",
1063 seq_printf(s
, "group: %s\n", gname
);
1064 for (i
= 0; i
< num_pins
; i
++) {
1065 pname
= pin_get_name(pctldev
, pins
[i
]);
1066 if (WARN_ON(!pname
)) {
1067 mutex_unlock(&pinctrl_mutex
);
1070 seq_printf(s
, "pin %d (%s)\n", pins
[i
], pname
);
1077 mutex_unlock(&pinctrl_mutex
);
1082 static int pinctrl_gpioranges_show(struct seq_file
*s
, void *what
)
1084 struct pinctrl_dev
*pctldev
= s
->private;
1085 struct pinctrl_gpio_range
*range
= NULL
;
1087 seq_puts(s
, "GPIO ranges handled:\n");
1089 mutex_lock(&pinctrl_mutex
);
1091 /* Loop over the ranges */
1092 list_for_each_entry(range
, &pctldev
->gpio_ranges
, node
) {
1093 seq_printf(s
, "%u: %s GPIOS [%u - %u] PINS [%u - %u]\n",
1094 range
->id
, range
->name
,
1095 range
->base
, (range
->base
+ range
->npins
- 1),
1097 (range
->pin_base
+ range
->npins
- 1));
1100 mutex_unlock(&pinctrl_mutex
);
1105 static int pinctrl_devices_show(struct seq_file
*s
, void *what
)
1107 struct pinctrl_dev
*pctldev
;
1109 seq_puts(s
, "name [pinmux] [pinconf]\n");
1111 mutex_lock(&pinctrl_mutex
);
1113 list_for_each_entry(pctldev
, &pinctrldev_list
, node
) {
1114 seq_printf(s
, "%s ", pctldev
->desc
->name
);
1115 if (pctldev
->desc
->pmxops
)
1116 seq_puts(s
, "yes ");
1119 if (pctldev
->desc
->confops
)
1126 mutex_unlock(&pinctrl_mutex
);
1131 static inline const char *map_type(enum pinctrl_map_type type
)
1133 static const char * const names
[] = {
1141 if (type
>= ARRAY_SIZE(names
))
1147 static int pinctrl_maps_show(struct seq_file
*s
, void *what
)
1149 struct pinctrl_maps
*maps_node
;
1151 struct pinctrl_map
const *map
;
1153 seq_puts(s
, "Pinctrl maps:\n");
1155 mutex_lock(&pinctrl_mutex
);
1157 for_each_maps(maps_node
, i
, map
) {
1158 seq_printf(s
, "device %s\nstate %s\ntype %s (%d)\n",
1159 map
->dev_name
, map
->name
, map_type(map
->type
),
1162 if (map
->type
!= PIN_MAP_TYPE_DUMMY_STATE
)
1163 seq_printf(s
, "controlling device %s\n",
1164 map
->ctrl_dev_name
);
1166 switch (map
->type
) {
1167 case PIN_MAP_TYPE_MUX_GROUP
:
1168 pinmux_show_map(s
, map
);
1170 case PIN_MAP_TYPE_CONFIGS_PIN
:
1171 case PIN_MAP_TYPE_CONFIGS_GROUP
:
1172 pinconf_show_map(s
, map
);
1178 seq_printf(s
, "\n");
1181 mutex_unlock(&pinctrl_mutex
);
1186 static int pinctrl_show(struct seq_file
*s
, void *what
)
1189 struct pinctrl_state
*state
;
1190 struct pinctrl_setting
*setting
;
1192 seq_puts(s
, "Requested pin control handlers their pinmux maps:\n");
1194 mutex_lock(&pinctrl_mutex
);
1196 list_for_each_entry(p
, &pinctrl_list
, node
) {
1197 seq_printf(s
, "device: %s current state: %s\n",
1199 p
->state
? p
->state
->name
: "none");
1201 list_for_each_entry(state
, &p
->states
, node
) {
1202 seq_printf(s
, " state: %s\n", state
->name
);
1204 list_for_each_entry(setting
, &state
->settings
, node
) {
1205 struct pinctrl_dev
*pctldev
= setting
->pctldev
;
1207 seq_printf(s
, " type: %s controller %s ",
1208 map_type(setting
->type
),
1209 pinctrl_dev_get_name(pctldev
));
1211 switch (setting
->type
) {
1212 case PIN_MAP_TYPE_MUX_GROUP
:
1213 pinmux_show_setting(s
, setting
);
1215 case PIN_MAP_TYPE_CONFIGS_PIN
:
1216 case PIN_MAP_TYPE_CONFIGS_GROUP
:
1217 pinconf_show_setting(s
, setting
);
1226 mutex_unlock(&pinctrl_mutex
);
1231 static int pinctrl_pins_open(struct inode
*inode
, struct file
*file
)
1233 return single_open(file
, pinctrl_pins_show
, inode
->i_private
);
1236 static int pinctrl_groups_open(struct inode
*inode
, struct file
*file
)
1238 return single_open(file
, pinctrl_groups_show
, inode
->i_private
);
1241 static int pinctrl_gpioranges_open(struct inode
*inode
, struct file
*file
)
1243 return single_open(file
, pinctrl_gpioranges_show
, inode
->i_private
);
1246 static int pinctrl_devices_open(struct inode
*inode
, struct file
*file
)
1248 return single_open(file
, pinctrl_devices_show
, NULL
);
1251 static int pinctrl_maps_open(struct inode
*inode
, struct file
*file
)
1253 return single_open(file
, pinctrl_maps_show
, NULL
);
1256 static int pinctrl_open(struct inode
*inode
, struct file
*file
)
1258 return single_open(file
, pinctrl_show
, NULL
);
1261 static const struct file_operations pinctrl_pins_ops
= {
1262 .open
= pinctrl_pins_open
,
1264 .llseek
= seq_lseek
,
1265 .release
= single_release
,
1268 static const struct file_operations pinctrl_groups_ops
= {
1269 .open
= pinctrl_groups_open
,
1271 .llseek
= seq_lseek
,
1272 .release
= single_release
,
1275 static const struct file_operations pinctrl_gpioranges_ops
= {
1276 .open
= pinctrl_gpioranges_open
,
1278 .llseek
= seq_lseek
,
1279 .release
= single_release
,
1282 static const struct file_operations pinctrl_devices_ops
= {
1283 .open
= pinctrl_devices_open
,
1285 .llseek
= seq_lseek
,
1286 .release
= single_release
,
1289 static const struct file_operations pinctrl_maps_ops
= {
1290 .open
= pinctrl_maps_open
,
1292 .llseek
= seq_lseek
,
1293 .release
= single_release
,
1296 static const struct file_operations pinctrl_ops
= {
1297 .open
= pinctrl_open
,
1299 .llseek
= seq_lseek
,
1300 .release
= single_release
,
1303 static struct dentry
*debugfs_root
;
1305 static void pinctrl_init_device_debugfs(struct pinctrl_dev
*pctldev
)
1307 struct dentry
*device_root
;
1309 device_root
= debugfs_create_dir(dev_name(pctldev
->dev
),
1311 pctldev
->device_root
= device_root
;
1313 if (IS_ERR(device_root
) || !device_root
) {
1314 pr_warn("failed to create debugfs directory for %s\n",
1315 dev_name(pctldev
->dev
));
1318 debugfs_create_file("pins", S_IFREG
| S_IRUGO
,
1319 device_root
, pctldev
, &pinctrl_pins_ops
);
1320 debugfs_create_file("pingroups", S_IFREG
| S_IRUGO
,
1321 device_root
, pctldev
, &pinctrl_groups_ops
);
1322 debugfs_create_file("gpio-ranges", S_IFREG
| S_IRUGO
,
1323 device_root
, pctldev
, &pinctrl_gpioranges_ops
);
1324 pinmux_init_device_debugfs(device_root
, pctldev
);
1325 pinconf_init_device_debugfs(device_root
, pctldev
);
1328 static void pinctrl_remove_device_debugfs(struct pinctrl_dev
*pctldev
)
1330 debugfs_remove_recursive(pctldev
->device_root
);
1333 static void pinctrl_init_debugfs(void)
1335 debugfs_root
= debugfs_create_dir("pinctrl", NULL
);
1336 if (IS_ERR(debugfs_root
) || !debugfs_root
) {
1337 pr_warn("failed to create debugfs directory\n");
1338 debugfs_root
= NULL
;
1342 debugfs_create_file("pinctrl-devices", S_IFREG
| S_IRUGO
,
1343 debugfs_root
, NULL
, &pinctrl_devices_ops
);
1344 debugfs_create_file("pinctrl-maps", S_IFREG
| S_IRUGO
,
1345 debugfs_root
, NULL
, &pinctrl_maps_ops
);
1346 debugfs_create_file("pinctrl-handles", S_IFREG
| S_IRUGO
,
1347 debugfs_root
, NULL
, &pinctrl_ops
);
1350 #else /* CONFIG_DEBUG_FS */
1352 static void pinctrl_init_device_debugfs(struct pinctrl_dev
*pctldev
)
1356 static void pinctrl_init_debugfs(void)
1360 static void pinctrl_remove_device_debugfs(struct pinctrl_dev
*pctldev
)
1366 static int pinctrl_check_ops(struct pinctrl_dev
*pctldev
)
1368 const struct pinctrl_ops
*ops
= pctldev
->desc
->pctlops
;
1371 !ops
->get_groups_count
||
1372 !ops
->get_group_name
||
1373 !ops
->get_group_pins
)
1376 if (ops
->dt_node_to_map
&& !ops
->dt_free_map
)
1383 * pinctrl_register() - register a pin controller device
1384 * @pctldesc: descriptor for this pin controller
1385 * @dev: parent device for this pin controller
1386 * @driver_data: private pin controller data for this pin controller
1388 struct pinctrl_dev
*pinctrl_register(struct pinctrl_desc
*pctldesc
,
1389 struct device
*dev
, void *driver_data
)
1391 struct pinctrl_dev
*pctldev
;
1396 if (!pctldesc
->name
)
1399 pctldev
= kzalloc(sizeof(*pctldev
), GFP_KERNEL
);
1400 if (pctldev
== NULL
) {
1401 dev_err(dev
, "failed to alloc struct pinctrl_dev\n");
1405 /* Initialize pin control device struct */
1406 pctldev
->owner
= pctldesc
->owner
;
1407 pctldev
->desc
= pctldesc
;
1408 pctldev
->driver_data
= driver_data
;
1409 INIT_RADIX_TREE(&pctldev
->pin_desc_tree
, GFP_KERNEL
);
1410 INIT_LIST_HEAD(&pctldev
->gpio_ranges
);
1413 /* check core ops for sanity */
1414 if (pinctrl_check_ops(pctldev
)) {
1415 dev_err(dev
, "pinctrl ops lacks necessary functions\n");
1419 /* If we're implementing pinmuxing, check the ops for sanity */
1420 if (pctldesc
->pmxops
) {
1421 if (pinmux_check_ops(pctldev
))
1425 /* If we're implementing pinconfig, check the ops for sanity */
1426 if (pctldesc
->confops
) {
1427 if (pinconf_check_ops(pctldev
))
1431 /* Register all the pins */
1432 dev_dbg(dev
, "try to register %d pins ...\n", pctldesc
->npins
);
1433 ret
= pinctrl_register_pins(pctldev
, pctldesc
->pins
, pctldesc
->npins
);
1435 dev_err(dev
, "error during pin registration\n");
1436 pinctrl_free_pindescs(pctldev
, pctldesc
->pins
,
1441 mutex_lock(&pinctrl_mutex
);
1443 list_add_tail(&pctldev
->node
, &pinctrldev_list
);
1445 pctldev
->p
= pinctrl_get_locked(pctldev
->dev
);
1446 if (!IS_ERR(pctldev
->p
)) {
1447 struct pinctrl_state
*s
=
1448 pinctrl_lookup_state_locked(pctldev
->p
,
1449 PINCTRL_STATE_DEFAULT
);
1451 dev_dbg(dev
, "failed to lookup the default state\n");
1453 if (pinctrl_select_state_locked(pctldev
->p
, s
))
1455 "failed to select default state\n");
1459 mutex_unlock(&pinctrl_mutex
);
1461 pinctrl_init_device_debugfs(pctldev
);
1469 EXPORT_SYMBOL_GPL(pinctrl_register
);
1472 * pinctrl_unregister() - unregister pinmux
1473 * @pctldev: pin controller to unregister
1475 * Called by pinmux drivers to unregister a pinmux.
1477 void pinctrl_unregister(struct pinctrl_dev
*pctldev
)
1479 struct pinctrl_gpio_range
*range
, *n
;
1480 if (pctldev
== NULL
)
1483 pinctrl_remove_device_debugfs(pctldev
);
1485 mutex_lock(&pinctrl_mutex
);
1487 if (!IS_ERR(pctldev
->p
))
1488 pinctrl_put_locked(pctldev
->p
, true);
1490 /* TODO: check that no pinmuxes are still active? */
1491 list_del(&pctldev
->node
);
1492 /* Destroy descriptor tree */
1493 pinctrl_free_pindescs(pctldev
, pctldev
->desc
->pins
,
1494 pctldev
->desc
->npins
);
1495 /* remove gpio ranges map */
1496 list_for_each_entry_safe(range
, n
, &pctldev
->gpio_ranges
, node
)
1497 list_del(&range
->node
);
1501 mutex_unlock(&pinctrl_mutex
);
1503 EXPORT_SYMBOL_GPL(pinctrl_unregister
);
1505 static int __init
pinctrl_init(void)
1507 pr_info("initialized pinctrl subsystem\n");
1508 pinctrl_init_debugfs();
1512 /* init early since many drivers really need to initialized pinmux early */
1513 core_initcall(pinctrl_init
);