2 * Core driver for the pin config portions of the pin control subsystem
4 * Copyright (C) 2011 ST-Ericsson SA
5 * Written on behalf of Linaro for ST-Ericsson
7 * Author: Linus Walleij <linus.walleij@linaro.org>
9 * License terms: GNU General Public License (GPL) version 2
11 #define pr_fmt(fmt) "pinconfig core: " fmt
13 #include <linux/kernel.h>
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/device.h>
17 #include <linux/slab.h>
18 #include <linux/debugfs.h>
19 #include <linux/seq_file.h>
20 #include <linux/pinctrl/machine.h>
21 #include <linux/pinctrl/pinctrl.h>
22 #include <linux/pinctrl/pinconf.h>
26 int pinconf_check_ops(struct pinctrl_dev *pctldev)
28 const struct pinconf_ops *ops = pctldev->desc->confops;
30 /* We must be able to read out pin status */
31 if (!ops->pin_config_get && !ops->pin_config_group_get)
33 /* We have to be able to config the pins in SOME way */
34 if (!ops->pin_config_set && !ops->pin_config_group_set)
39 int pinconf_validate_map(struct pinctrl_map const *map, int i)
41 if (!map->data.configs.group_or_pin) {
42 pr_err("failed to register map %s (%d): no group/pin given\n",
47 if (map->data.configs.num_configs &&
48 !map->data.configs.configs) {
49 pr_err("failed to register map %s (%d): no configs ptr given\n",
57 int pin_config_get_for_pin(struct pinctrl_dev *pctldev, unsigned pin,
58 unsigned long *config)
60 const struct pinconf_ops *ops = pctldev->desc->confops;
62 if (!ops || !ops->pin_config_get) {
63 dev_err(pctldev->dev, "cannot get pin configuration, missing "
64 "pin_config_get() function in driver\n");
68 return ops->pin_config_get(pctldev, pin, config);
72 * pin_config_get() - get the configuration of a single pin parameter
73 * @dev_name: name of the pin controller device for this pin
74 * @name: name of the pin to get the config for
75 * @config: the config pointed to by this argument will be filled in with the
76 * current pin state, it can be used directly by drivers as a numeral, or
77 * it can be dereferenced to any struct.
79 int pin_config_get(const char *dev_name, const char *name,
80 unsigned long *config)
82 struct pinctrl_dev *pctldev;
85 mutex_lock(&pinctrl_mutex);
87 pctldev = get_pinctrl_dev_from_devname(dev_name);
93 pin = pin_get_from_name(pctldev, name);
97 pin = pin_config_get_for_pin(pctldev, pin, config);
100 mutex_unlock(&pinctrl_mutex);
103 EXPORT_SYMBOL(pin_config_get);
105 static int pin_config_set_for_pin(struct pinctrl_dev *pctldev, unsigned pin,
106 unsigned long config)
108 const struct pinconf_ops *ops = pctldev->desc->confops;
111 if (!ops || !ops->pin_config_set) {
112 dev_err(pctldev->dev, "cannot configure pin, missing "
113 "config function in driver\n");
117 ret = ops->pin_config_set(pctldev, pin, config);
119 dev_err(pctldev->dev,
120 "unable to set pin configuration on pin %d\n", pin);
128 * pin_config_set() - set the configuration of a single pin parameter
129 * @dev_name: name of pin controller device for this pin
130 * @name: name of the pin to set the config for
131 * @config: the config in this argument will contain the desired pin state, it
132 * can be used directly by drivers as a numeral, or it can be dereferenced
135 int pin_config_set(const char *dev_name, const char *name,
136 unsigned long config)
138 struct pinctrl_dev *pctldev;
141 mutex_lock(&pinctrl_mutex);
143 pctldev = get_pinctrl_dev_from_devname(dev_name);
149 pin = pin_get_from_name(pctldev, name);
155 ret = pin_config_set_for_pin(pctldev, pin, config);
158 mutex_unlock(&pinctrl_mutex);
161 EXPORT_SYMBOL(pin_config_set);
163 int pin_config_group_get(const char *dev_name, const char *pin_group,
164 unsigned long *config)
166 struct pinctrl_dev *pctldev;
167 const struct pinconf_ops *ops;
170 mutex_lock(&pinctrl_mutex);
172 pctldev = get_pinctrl_dev_from_devname(dev_name);
177 ops = pctldev->desc->confops;
179 if (!ops || !ops->pin_config_group_get) {
180 dev_err(pctldev->dev, "cannot get configuration for pin "
181 "group, missing group config get function in "
187 selector = pinctrl_get_group_selector(pctldev, pin_group);
193 ret = ops->pin_config_group_get(pctldev, selector, config);
196 mutex_unlock(&pinctrl_mutex);
199 EXPORT_SYMBOL(pin_config_group_get);
201 int pin_config_group_set(const char *dev_name, const char *pin_group,
202 unsigned long config)
204 struct pinctrl_dev *pctldev;
205 const struct pinconf_ops *ops;
206 const struct pinctrl_ops *pctlops;
208 const unsigned *pins;
213 mutex_lock(&pinctrl_mutex);
215 pctldev = get_pinctrl_dev_from_devname(dev_name);
220 ops = pctldev->desc->confops;
221 pctlops = pctldev->desc->pctlops;
223 if (!ops || (!ops->pin_config_group_set && !ops->pin_config_set)) {
224 dev_err(pctldev->dev, "cannot configure pin group, missing "
225 "config function in driver\n");
230 selector = pinctrl_get_group_selector(pctldev, pin_group);
236 ret = pctlops->get_group_pins(pctldev, selector, &pins, &num_pins);
238 dev_err(pctldev->dev, "cannot configure pin group, error "
244 * If the pin controller supports handling entire groups we use that
247 if (ops->pin_config_group_set) {
248 ret = ops->pin_config_group_set(pctldev, selector, config);
250 * If the pin controller prefer that a certain group be handled
251 * pin-by-pin as well, it returns -EAGAIN.
258 * If the controller cannot handle entire groups, we configure each pin
261 if (!ops->pin_config_set) {
266 for (i = 0; i < num_pins; i++) {
267 ret = ops->pin_config_set(pctldev, pins[i], config);
275 mutex_unlock(&pinctrl_mutex);
279 EXPORT_SYMBOL(pin_config_group_set);
281 int pinconf_map_to_setting(struct pinctrl_map const *map,
282 struct pinctrl_setting *setting)
284 struct pinctrl_dev *pctldev = setting->pctldev;
287 switch (setting->type) {
288 case PIN_MAP_TYPE_CONFIGS_PIN:
289 pin = pin_get_from_name(pctldev,
290 map->data.configs.group_or_pin);
292 dev_err(pctldev->dev, "could not map pin config for \"%s\"",
293 map->data.configs.group_or_pin);
296 setting->data.configs.group_or_pin = pin;
298 case PIN_MAP_TYPE_CONFIGS_GROUP:
299 pin = pinctrl_get_group_selector(pctldev,
300 map->data.configs.group_or_pin);
302 dev_err(pctldev->dev, "could not map group config for \"%s\"",
303 map->data.configs.group_or_pin);
306 setting->data.configs.group_or_pin = pin;
312 setting->data.configs.num_configs = map->data.configs.num_configs;
313 setting->data.configs.configs = map->data.configs.configs;
318 void pinconf_free_setting(struct pinctrl_setting const *setting)
322 int pinconf_apply_setting(struct pinctrl_setting const *setting)
324 struct pinctrl_dev *pctldev = setting->pctldev;
325 const struct pinconf_ops *ops = pctldev->desc->confops;
329 dev_err(pctldev->dev, "missing confops\n");
333 switch (setting->type) {
334 case PIN_MAP_TYPE_CONFIGS_PIN:
335 if (!ops->pin_config_set) {
336 dev_err(pctldev->dev, "missing pin_config_set op\n");
339 for (i = 0; i < setting->data.configs.num_configs; i++) {
340 ret = ops->pin_config_set(pctldev,
341 setting->data.configs.group_or_pin,
342 setting->data.configs.configs[i]);
344 dev_err(pctldev->dev,
345 "pin_config_set op failed for pin %d config %08lx\n",
346 setting->data.configs.group_or_pin,
347 setting->data.configs.configs[i]);
352 case PIN_MAP_TYPE_CONFIGS_GROUP:
353 if (!ops->pin_config_group_set) {
354 dev_err(pctldev->dev,
355 "missing pin_config_group_set op\n");
358 for (i = 0; i < setting->data.configs.num_configs; i++) {
359 ret = ops->pin_config_group_set(pctldev,
360 setting->data.configs.group_or_pin,
361 setting->data.configs.configs[i]);
363 dev_err(pctldev->dev,
364 "pin_config_group_set op failed for group %d config %08lx\n",
365 setting->data.configs.group_or_pin,
366 setting->data.configs.configs[i]);
378 #ifdef CONFIG_DEBUG_FS
380 void pinconf_show_map(struct seq_file *s, struct pinctrl_map const *map)
385 case PIN_MAP_TYPE_CONFIGS_PIN:
386 seq_printf(s, "pin ");
388 case PIN_MAP_TYPE_CONFIGS_GROUP:
389 seq_printf(s, "group ");
395 seq_printf(s, "%s\n", map->data.configs.group_or_pin);
397 for (i = 0; i < map->data.configs.num_configs; i++)
398 seq_printf(s, "config %08lx\n", map->data.configs.configs[i]);
401 void pinconf_show_setting(struct seq_file *s,
402 struct pinctrl_setting const *setting)
404 struct pinctrl_dev *pctldev = setting->pctldev;
405 const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
406 struct pin_desc *desc;
409 switch (setting->type) {
410 case PIN_MAP_TYPE_CONFIGS_PIN:
411 desc = pin_desc_get(setting->pctldev,
412 setting->data.configs.group_or_pin);
413 seq_printf(s, "pin %s (%d)",
414 desc->name ? desc->name : "unnamed",
415 setting->data.configs.group_or_pin);
417 case PIN_MAP_TYPE_CONFIGS_GROUP:
418 seq_printf(s, "group %s (%d)",
419 pctlops->get_group_name(pctldev,
420 setting->data.configs.group_or_pin),
421 setting->data.configs.group_or_pin);
428 * FIXME: We should really get the pin controler to dump the config
429 * values, so they can be decoded to something meaningful.
431 for (i = 0; i < setting->data.configs.num_configs; i++)
432 seq_printf(s, " %08lx", setting->data.configs.configs[i]);
437 static void pinconf_dump_pin(struct pinctrl_dev *pctldev,
438 struct seq_file *s, int pin)
440 const struct pinconf_ops *ops = pctldev->desc->confops;
442 /* no-op when not using generic pin config */
443 pinconf_generic_dump_pin(pctldev, s, pin);
444 if (ops && ops->pin_config_dbg_show)
445 ops->pin_config_dbg_show(pctldev, s, pin);
448 static int pinconf_pins_show(struct seq_file *s, void *what)
450 struct pinctrl_dev *pctldev = s->private;
453 seq_puts(s, "Pin config settings per pin\n");
454 seq_puts(s, "Format: pin (name): pinmux setting array\n");
456 mutex_lock(&pinctrl_mutex);
458 /* The pin number can be retrived from the pin controller descriptor */
459 for (i = 0; i < pctldev->desc->npins; i++) {
460 struct pin_desc *desc;
462 pin = pctldev->desc->pins[i].number;
463 desc = pin_desc_get(pctldev, pin);
464 /* Skip if we cannot search the pin */
468 seq_printf(s, "pin %d (%s):", pin,
469 desc->name ? desc->name : "unnamed");
471 pinconf_dump_pin(pctldev, s, pin);
476 mutex_unlock(&pinctrl_mutex);
481 static void pinconf_dump_group(struct pinctrl_dev *pctldev,
482 struct seq_file *s, unsigned selector,
485 const struct pinconf_ops *ops = pctldev->desc->confops;
487 /* no-op when not using generic pin config */
488 pinconf_generic_dump_group(pctldev, s, gname);
489 if (ops && ops->pin_config_group_dbg_show)
490 ops->pin_config_group_dbg_show(pctldev, s, selector);
493 static int pinconf_groups_show(struct seq_file *s, void *what)
495 struct pinctrl_dev *pctldev = s->private;
496 const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
497 const struct pinconf_ops *ops = pctldev->desc->confops;
498 unsigned selector = 0;
500 if (!ops || !ops->pin_config_group_get)
503 seq_puts(s, "Pin config settings per pin group\n");
504 seq_puts(s, "Format: group (name): pinmux setting array\n");
506 mutex_lock(&pinctrl_mutex);
508 while (pctlops->list_groups(pctldev, selector) >= 0) {
509 const char *gname = pctlops->get_group_name(pctldev, selector);
511 seq_printf(s, "%u (%s):", selector, gname);
512 pinconf_dump_group(pctldev, s, selector, gname);
518 mutex_unlock(&pinctrl_mutex);
523 static int pinconf_pins_open(struct inode *inode, struct file *file)
525 return single_open(file, pinconf_pins_show, inode->i_private);
528 static int pinconf_groups_open(struct inode *inode, struct file *file)
530 return single_open(file, pinconf_groups_show, inode->i_private);
533 static const struct file_operations pinconf_pins_ops = {
534 .open = pinconf_pins_open,
537 .release = single_release,
540 static const struct file_operations pinconf_groups_ops = {
541 .open = pinconf_groups_open,
544 .release = single_release,
547 void pinconf_init_device_debugfs(struct dentry *devroot,
548 struct pinctrl_dev *pctldev)
550 debugfs_create_file("pinconf-pins", S_IFREG | S_IRUGO,
551 devroot, pctldev, &pinconf_pins_ops);
552 debugfs_create_file("pinconf-groups", S_IFREG | S_IRUGO,
553 devroot, pctldev, &pinconf_groups_ops);