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/uaccess.h>
21 #include <linux/pinctrl/machine.h>
22 #include <linux/pinctrl/pinctrl.h>
23 #include <linux/pinctrl/pinconf.h>
27 int pinconf_check_ops(struct pinctrl_dev *pctldev)
29 const struct pinconf_ops *ops = pctldev->desc->confops;
31 /* We have to be able to config the pins in SOME way */
32 if (!ops->pin_config_set && !ops->pin_config_group_set) {
34 "pinconf has to be able to set a pins config\n");
40 int pinconf_validate_map(struct pinctrl_map const *map, int i)
42 if (!map->data.configs.group_or_pin) {
43 pr_err("failed to register map %s (%d): no group/pin given\n",
48 if (!map->data.configs.num_configs ||
49 !map->data.configs.configs) {
50 pr_err("failed to register map %s (%d): no configs given\n",
58 int pin_config_get_for_pin(struct pinctrl_dev *pctldev, unsigned pin,
59 unsigned long *config)
61 const struct pinconf_ops *ops = pctldev->desc->confops;
63 if (!ops || !ops->pin_config_get) {
64 dev_dbg(pctldev->dev, "cannot get pin configuration, missing "
65 "pin_config_get() function in driver\n");
69 return ops->pin_config_get(pctldev, pin, config);
72 int pin_config_group_get(const char *dev_name, const char *pin_group,
73 unsigned long *config)
75 struct pinctrl_dev *pctldev;
76 const struct pinconf_ops *ops;
79 pctldev = get_pinctrl_dev_from_devname(dev_name);
85 mutex_lock(&pctldev->mutex);
87 ops = pctldev->desc->confops;
89 if (!ops || !ops->pin_config_group_get) {
90 dev_dbg(pctldev->dev, "cannot get configuration for pin "
91 "group, missing group config get function in "
97 selector = pinctrl_get_group_selector(pctldev, pin_group);
103 ret = ops->pin_config_group_get(pctldev, selector, config);
106 mutex_unlock(&pctldev->mutex);
110 int pinconf_map_to_setting(struct pinctrl_map const *map,
111 struct pinctrl_setting *setting)
113 struct pinctrl_dev *pctldev = setting->pctldev;
116 switch (setting->type) {
117 case PIN_MAP_TYPE_CONFIGS_PIN:
118 pin = pin_get_from_name(pctldev,
119 map->data.configs.group_or_pin);
121 dev_err(pctldev->dev, "could not map pin config for \"%s\"",
122 map->data.configs.group_or_pin);
125 setting->data.configs.group_or_pin = pin;
127 case PIN_MAP_TYPE_CONFIGS_GROUP:
128 pin = pinctrl_get_group_selector(pctldev,
129 map->data.configs.group_or_pin);
131 dev_err(pctldev->dev, "could not map group config for \"%s\"",
132 map->data.configs.group_or_pin);
135 setting->data.configs.group_or_pin = pin;
141 setting->data.configs.num_configs = map->data.configs.num_configs;
142 setting->data.configs.configs = map->data.configs.configs;
147 void pinconf_free_setting(struct pinctrl_setting const *setting)
151 int pinconf_apply_setting(struct pinctrl_setting const *setting)
153 struct pinctrl_dev *pctldev = setting->pctldev;
154 const struct pinconf_ops *ops = pctldev->desc->confops;
158 dev_err(pctldev->dev, "missing confops\n");
162 switch (setting->type) {
163 case PIN_MAP_TYPE_CONFIGS_PIN:
164 if (!ops->pin_config_set) {
165 dev_err(pctldev->dev, "missing pin_config_set op\n");
168 ret = ops->pin_config_set(pctldev,
169 setting->data.configs.group_or_pin,
170 setting->data.configs.configs,
171 setting->data.configs.num_configs);
173 dev_err(pctldev->dev,
174 "pin_config_set op failed for pin %d\n",
175 setting->data.configs.group_or_pin);
179 case PIN_MAP_TYPE_CONFIGS_GROUP:
180 if (!ops->pin_config_group_set) {
181 dev_err(pctldev->dev,
182 "missing pin_config_group_set op\n");
185 ret = ops->pin_config_group_set(pctldev,
186 setting->data.configs.group_or_pin,
187 setting->data.configs.configs,
188 setting->data.configs.num_configs);
190 dev_err(pctldev->dev,
191 "pin_config_group_set op failed for group %d\n",
192 setting->data.configs.group_or_pin);
203 #ifdef CONFIG_DEBUG_FS
205 void pinconf_show_map(struct seq_file *s, struct pinctrl_map const *map)
207 struct pinctrl_dev *pctldev;
208 const struct pinconf_ops *confops;
211 pctldev = get_pinctrl_dev_from_devname(map->ctrl_dev_name);
213 confops = pctldev->desc->confops;
218 case PIN_MAP_TYPE_CONFIGS_PIN:
219 seq_printf(s, "pin ");
221 case PIN_MAP_TYPE_CONFIGS_GROUP:
222 seq_printf(s, "group ");
228 seq_printf(s, "%s\n", map->data.configs.group_or_pin);
230 for (i = 0; i < map->data.configs.num_configs; i++) {
231 seq_printf(s, "config ");
232 if (confops && confops->pin_config_config_dbg_show)
233 confops->pin_config_config_dbg_show(pctldev, s,
234 map->data.configs.configs[i]);
236 seq_printf(s, "%08lx", map->data.configs.configs[i]);
241 void pinconf_show_setting(struct seq_file *s,
242 struct pinctrl_setting const *setting)
244 struct pinctrl_dev *pctldev = setting->pctldev;
245 const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
246 const struct pinconf_ops *confops = pctldev->desc->confops;
247 struct pin_desc *desc;
250 switch (setting->type) {
251 case PIN_MAP_TYPE_CONFIGS_PIN:
252 desc = pin_desc_get(setting->pctldev,
253 setting->data.configs.group_or_pin);
254 seq_printf(s, "pin %s (%d)",
255 desc->name ? desc->name : "unnamed",
256 setting->data.configs.group_or_pin);
258 case PIN_MAP_TYPE_CONFIGS_GROUP:
259 seq_printf(s, "group %s (%d)",
260 pctlops->get_group_name(pctldev,
261 setting->data.configs.group_or_pin),
262 setting->data.configs.group_or_pin);
269 * FIXME: We should really get the pin controler to dump the config
270 * values, so they can be decoded to something meaningful.
272 for (i = 0; i < setting->data.configs.num_configs; i++) {
274 if (confops && confops->pin_config_config_dbg_show)
275 confops->pin_config_config_dbg_show(pctldev, s,
276 setting->data.configs.configs[i]);
278 seq_printf(s, "%08lx",
279 setting->data.configs.configs[i]);
285 static void pinconf_dump_pin(struct pinctrl_dev *pctldev,
286 struct seq_file *s, int pin)
288 const struct pinconf_ops *ops = pctldev->desc->confops;
290 /* no-op when not using generic pin config */
291 pinconf_generic_dump_pin(pctldev, s, pin);
292 if (ops && ops->pin_config_dbg_show)
293 ops->pin_config_dbg_show(pctldev, s, pin);
296 static int pinconf_pins_show(struct seq_file *s, void *what)
298 struct pinctrl_dev *pctldev = s->private;
299 const struct pinconf_ops *ops = pctldev->desc->confops;
302 seq_puts(s, "Pin config settings per pin\n");
303 seq_puts(s, "Format: pin (name): configs\n");
305 mutex_lock(&pctldev->mutex);
307 /* The pin number can be retrived from the pin controller descriptor */
308 for (i = 0; i < pctldev->desc->npins; i++) {
309 struct pin_desc *desc;
311 pin = pctldev->desc->pins[i].number;
312 desc = pin_desc_get(pctldev, pin);
313 /* Skip if we cannot search the pin */
317 seq_printf(s, "pin %d (%s):", pin,
318 desc->name ? desc->name : "unnamed");
320 pinconf_dump_pin(pctldev, s, pin);
325 mutex_unlock(&pctldev->mutex);
330 static void pinconf_dump_group(struct pinctrl_dev *pctldev,
331 struct seq_file *s, unsigned selector,
334 const struct pinconf_ops *ops = pctldev->desc->confops;
336 /* no-op when not using generic pin config */
337 pinconf_generic_dump_group(pctldev, s, gname);
338 if (ops && ops->pin_config_group_dbg_show)
339 ops->pin_config_group_dbg_show(pctldev, s, selector);
342 static int pinconf_groups_show(struct seq_file *s, void *what)
344 struct pinctrl_dev *pctldev = s->private;
345 const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
346 const struct pinconf_ops *ops = pctldev->desc->confops;
347 unsigned ngroups = pctlops->get_groups_count(pctldev);
348 unsigned selector = 0;
350 seq_puts(s, "Pin config settings per pin group\n");
351 seq_puts(s, "Format: group (name): configs\n");
353 while (selector < ngroups) {
354 const char *gname = pctlops->get_group_name(pctldev, selector);
356 seq_printf(s, "%u (%s):", selector, gname);
357 pinconf_dump_group(pctldev, s, selector, gname);
366 static int pinconf_pins_open(struct inode *inode, struct file *file)
368 return single_open(file, pinconf_pins_show, inode->i_private);
371 static int pinconf_groups_open(struct inode *inode, struct file *file)
373 return single_open(file, pinconf_groups_show, inode->i_private);
376 static const struct file_operations pinconf_pins_ops = {
377 .open = pinconf_pins_open,
380 .release = single_release,
383 static const struct file_operations pinconf_groups_ops = {
384 .open = pinconf_groups_open,
387 .release = single_release,
390 #define MAX_NAME_LEN 15
393 enum pinctrl_map_type map_type;
394 char dev_name[MAX_NAME_LEN+1];
395 char state_name[MAX_NAME_LEN+1];
396 char pin_name[MAX_NAME_LEN+1];
400 * Goal is to keep this structure as global in order to simply read the
401 * pinconf-config file after a write to check config is as expected
403 static struct dbg_cfg pinconf_dbg_conf;
406 * pinconf_dbg_config_print() - display the pinctrl config from the pinctrl
407 * map, of the dev/pin/state that was last written to pinconf-config file.
408 * @s: string filled in with config description
411 static int pinconf_dbg_config_print(struct seq_file *s, void *d)
413 struct pinctrl_maps *maps_node;
414 const struct pinctrl_map *map;
415 const struct pinctrl_map *found = NULL;
416 struct pinctrl_dev *pctldev;
417 const struct pinconf_ops *confops = NULL;
418 struct dbg_cfg *dbg = &pinconf_dbg_conf;
420 unsigned long config;
422 mutex_lock(&pinctrl_maps_mutex);
424 /* Parse the pinctrl map and look for the elected pin/state */
425 for_each_maps(maps_node, i, map) {
426 if (map->type != dbg->map_type)
428 if (strcmp(map->dev_name, dbg->dev_name))
430 if (strcmp(map->name, dbg->state_name))
433 for (j = 0; j < map->data.configs.num_configs; j++) {
434 if (!strcmp(map->data.configs.group_or_pin,
436 /* We found the right pin / state */
444 seq_printf(s, "No config found for dev/state/pin, expected:\n");
445 seq_printf(s, "Searched dev:%s\n", dbg->dev_name);
446 seq_printf(s, "Searched state:%s\n", dbg->state_name);
447 seq_printf(s, "Searched pin:%s\n", dbg->pin_name);
448 seq_printf(s, "Use: modify config_pin <devname> "\
449 "<state> <pinname> <value>\n");
453 pctldev = get_pinctrl_dev_from_devname(found->ctrl_dev_name);
454 config = *found->data.configs.configs;
455 seq_printf(s, "Dev %s has config of %s in state %s: 0x%08lX\n",
456 dbg->dev_name, dbg->pin_name,
457 dbg->state_name, config);
460 confops = pctldev->desc->confops;
462 if (confops && confops->pin_config_config_dbg_show)
463 confops->pin_config_config_dbg_show(pctldev, s, config);
466 mutex_unlock(&pinctrl_maps_mutex);
472 * pinconf_dbg_config_write() - modify the pinctrl config in the pinctrl
473 * map, of a dev/pin/state entry based on user entries to pinconf-config
474 * @user_buf: contains the modification request with expected format:
475 * modify config_pin <devicename> <state> <pinname> <newvalue>
476 * modify is literal string, alternatives like add/delete not supported yet
477 * config_pin is literal, alternatives like config_mux not supported yet
478 * <devicename> <state> <pinname> are values that should match the pinctrl-maps
479 * <newvalue> reflects the new config and is driver dependant
481 static ssize_t pinconf_dbg_config_write(struct file *file,
482 const char __user *user_buf, size_t count, loff_t *ppos)
484 struct pinctrl_maps *maps_node;
485 const struct pinctrl_map *map;
486 const struct pinctrl_map *found = NULL;
487 struct pinctrl_dev *pctldev;
488 const struct pinconf_ops *confops = NULL;
489 struct dbg_cfg *dbg = &pinconf_dbg_conf;
490 const struct pinctrl_map_configs *configs;
491 char config[MAX_NAME_LEN+1];
498 /* Get userspace string and assure termination */
499 buf_size = min(count, sizeof(buf) - 1);
500 if (copy_from_user(buf, user_buf, buf_size))
505 * need to parse entry and extract parameters:
506 * modify configs_pin devicename state pinname newvalue
509 /* Get arg: 'modify' */
510 token = strsep(&b, " ");
513 if (strcmp(token, "modify"))
516 /* Get arg type: "config_pin" type supported so far */
517 token = strsep(&b, " ");
520 if (strcmp(token, "config_pin"))
522 dbg->map_type = PIN_MAP_TYPE_CONFIGS_PIN;
524 /* get arg 'device_name' */
525 token = strsep(&b, " ");
528 if (strlen(token) >= MAX_NAME_LEN)
530 strncpy(dbg->dev_name, token, MAX_NAME_LEN);
532 /* get arg 'state_name' */
533 token = strsep(&b, " ");
536 if (strlen(token) >= MAX_NAME_LEN)
538 strncpy(dbg->state_name, token, MAX_NAME_LEN);
540 /* get arg 'pin_name' */
541 token = strsep(&b, " ");
544 if (strlen(token) >= MAX_NAME_LEN)
546 strncpy(dbg->pin_name, token, MAX_NAME_LEN);
548 /* get new_value of config' */
549 token = strsep(&b, " ");
552 if (strlen(token) >= MAX_NAME_LEN)
554 strncpy(config, token, MAX_NAME_LEN);
556 mutex_lock(&pinctrl_maps_mutex);
558 /* Parse the pinctrl map and look for the selected dev/state/pin */
559 for_each_maps(maps_node, i, map) {
560 if (strcmp(map->dev_name, dbg->dev_name))
562 if (map->type != dbg->map_type)
564 if (strcmp(map->name, dbg->state_name))
567 /* we found the right pin / state, so overwrite config */
568 if (!strcmp(map->data.configs.group_or_pin, dbg->pin_name)) {
579 pctldev = get_pinctrl_dev_from_devname(found->ctrl_dev_name);
581 confops = pctldev->desc->confops;
583 if (confops && confops->pin_config_dbg_parse_modify) {
584 configs = &found->data.configs;
585 for (i = 0; i < configs->num_configs; i++) {
586 confops->pin_config_dbg_parse_modify(pctldev,
588 &configs->configs[i]);
593 mutex_unlock(&pinctrl_maps_mutex);
598 static int pinconf_dbg_config_open(struct inode *inode, struct file *file)
600 return single_open(file, pinconf_dbg_config_print, inode->i_private);
603 static const struct file_operations pinconf_dbg_pinconfig_fops = {
604 .open = pinconf_dbg_config_open,
605 .write = pinconf_dbg_config_write,
608 .release = single_release,
609 .owner = THIS_MODULE,
612 void pinconf_init_device_debugfs(struct dentry *devroot,
613 struct pinctrl_dev *pctldev)
615 debugfs_create_file("pinconf-pins", S_IFREG | S_IRUGO,
616 devroot, pctldev, &pinconf_pins_ops);
617 debugfs_create_file("pinconf-groups", S_IFREG | S_IRUGO,
618 devroot, pctldev, &pinconf_groups_ops);
619 debugfs_create_file("pinconf-config", (S_IRUGO | S_IWUSR | S_IWGRP),
620 devroot, pctldev, &pinconf_dbg_pinconfig_fops);