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 must be able to read out pin status */
32 if (!ops->pin_config_get && !ops->pin_config_group_get) {
34 "pinconf must be able to read out pin status\n");
37 /* We have to be able to config the pins in SOME way */
38 if (!ops->pin_config_set && !ops->pin_config_group_set
39 && !ops->pin_config_set_bulk
40 && !ops->pin_config_group_set_bulk) {
42 "pinconf has to be able to set a pins config\n");
48 int pinconf_validate_map(struct pinctrl_map const *map, int i)
50 if (!map->data.configs.group_or_pin) {
51 pr_err("failed to register map %s (%d): no group/pin given\n",
56 if (!map->data.configs.num_configs ||
57 !map->data.configs.configs) {
58 pr_err("failed to register map %s (%d): no configs given\n",
66 int pin_config_get_for_pin(struct pinctrl_dev *pctldev, unsigned pin,
67 unsigned long *config)
69 const struct pinconf_ops *ops = pctldev->desc->confops;
71 if (!ops || !ops->pin_config_get) {
72 dev_err(pctldev->dev, "cannot get pin configuration, missing "
73 "pin_config_get() function in driver\n");
77 return ops->pin_config_get(pctldev, pin, config);
80 int pin_config_group_get(const char *dev_name, const char *pin_group,
81 unsigned long *config)
83 struct pinctrl_dev *pctldev;
84 const struct pinconf_ops *ops;
87 pctldev = get_pinctrl_dev_from_devname(dev_name);
93 mutex_lock(&pctldev->mutex);
95 ops = pctldev->desc->confops;
97 if (!ops || !ops->pin_config_group_get) {
98 dev_err(pctldev->dev, "cannot get configuration for pin "
99 "group, missing group config get function in "
105 selector = pinctrl_get_group_selector(pctldev, pin_group);
111 ret = ops->pin_config_group_get(pctldev, selector, config);
114 mutex_unlock(&pctldev->mutex);
118 int pinconf_map_to_setting(struct pinctrl_map const *map,
119 struct pinctrl_setting *setting)
121 struct pinctrl_dev *pctldev = setting->pctldev;
124 switch (setting->type) {
125 case PIN_MAP_TYPE_CONFIGS_PIN:
126 pin = pin_get_from_name(pctldev,
127 map->data.configs.group_or_pin);
129 dev_err(pctldev->dev, "could not map pin config for \"%s\"",
130 map->data.configs.group_or_pin);
133 setting->data.configs.group_or_pin = pin;
135 case PIN_MAP_TYPE_CONFIGS_GROUP:
136 pin = pinctrl_get_group_selector(pctldev,
137 map->data.configs.group_or_pin);
139 dev_err(pctldev->dev, "could not map group config for \"%s\"",
140 map->data.configs.group_or_pin);
143 setting->data.configs.group_or_pin = pin;
149 setting->data.configs.num_configs = map->data.configs.num_configs;
150 setting->data.configs.configs = map->data.configs.configs;
155 void pinconf_free_setting(struct pinctrl_setting const *setting)
159 int pinconf_apply_setting(struct pinctrl_setting const *setting)
161 struct pinctrl_dev *pctldev = setting->pctldev;
162 const struct pinconf_ops *ops = pctldev->desc->confops;
166 dev_err(pctldev->dev, "missing confops\n");
170 switch (setting->type) {
171 case PIN_MAP_TYPE_CONFIGS_PIN:
172 if (!ops->pin_config_set && !ops->pin_config_set_bulk) {
173 dev_err(pctldev->dev, "missing pin_config_set op\n");
176 if (ops->pin_config_set_bulk) {
177 ret = ops->pin_config_set_bulk(pctldev,
178 setting->data.configs.group_or_pin,
179 setting->data.configs.configs,
180 setting->data.configs.num_configs);
182 dev_err(pctldev->dev,
183 "pin_config_set_bulk op failed for pin %d\n",
184 setting->data.configs.group_or_pin);
187 } else if (ops->pin_config_set) {
188 for (i = 0; i < setting->data.configs.num_configs; i++) {
189 ret = ops->pin_config_set(pctldev,
190 setting->data.configs.group_or_pin,
191 setting->data.configs.configs[i]);
193 dev_err(pctldev->dev,
194 "pin_config_set op failed for pin %d config %08lx\n",
195 setting->data.configs.group_or_pin,
196 setting->data.configs.configs[i]);
202 case PIN_MAP_TYPE_CONFIGS_GROUP:
203 if (!ops->pin_config_group_set &&
204 !ops->pin_config_group_set_bulk) {
205 dev_err(pctldev->dev,
206 "missing pin_config_group_set op\n");
209 if (ops->pin_config_group_set_bulk) {
210 ret = ops->pin_config_group_set_bulk(pctldev,
211 setting->data.configs.group_or_pin,
212 setting->data.configs.configs,
213 setting->data.configs.num_configs);
215 dev_err(pctldev->dev,
216 "pin_config_group_set_bulk op failed for group %d\n",
217 setting->data.configs.group_or_pin);
220 } else if (ops->pin_config_group_set) {
221 for (i = 0; i < setting->data.configs.num_configs; i++) {
222 ret = ops->pin_config_group_set(pctldev,
223 setting->data.configs.group_or_pin,
224 setting->data.configs.configs[i]);
226 dev_err(pctldev->dev,
227 "pin_config_group_set op failed for group %d config %08lx\n",
228 setting->data.configs.group_or_pin,
229 setting->data.configs.configs[i]);
242 #ifdef CONFIG_DEBUG_FS
244 void pinconf_show_map(struct seq_file *s, struct pinctrl_map const *map)
246 struct pinctrl_dev *pctldev;
247 const struct pinconf_ops *confops;
250 pctldev = get_pinctrl_dev_from_devname(map->ctrl_dev_name);
252 confops = pctldev->desc->confops;
257 case PIN_MAP_TYPE_CONFIGS_PIN:
258 seq_printf(s, "pin ");
260 case PIN_MAP_TYPE_CONFIGS_GROUP:
261 seq_printf(s, "group ");
267 seq_printf(s, "%s\n", map->data.configs.group_or_pin);
269 for (i = 0; i < map->data.configs.num_configs; i++) {
270 seq_printf(s, "config ");
271 if (confops && confops->pin_config_config_dbg_show)
272 confops->pin_config_config_dbg_show(pctldev, s,
273 map->data.configs.configs[i]);
275 seq_printf(s, "%08lx", map->data.configs.configs[i]);
280 void pinconf_show_setting(struct seq_file *s,
281 struct pinctrl_setting const *setting)
283 struct pinctrl_dev *pctldev = setting->pctldev;
284 const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
285 const struct pinconf_ops *confops = pctldev->desc->confops;
286 struct pin_desc *desc;
289 switch (setting->type) {
290 case PIN_MAP_TYPE_CONFIGS_PIN:
291 desc = pin_desc_get(setting->pctldev,
292 setting->data.configs.group_or_pin);
293 seq_printf(s, "pin %s (%d)",
294 desc->name ? desc->name : "unnamed",
295 setting->data.configs.group_or_pin);
297 case PIN_MAP_TYPE_CONFIGS_GROUP:
298 seq_printf(s, "group %s (%d)",
299 pctlops->get_group_name(pctldev,
300 setting->data.configs.group_or_pin),
301 setting->data.configs.group_or_pin);
308 * FIXME: We should really get the pin controler to dump the config
309 * values, so they can be decoded to something meaningful.
311 for (i = 0; i < setting->data.configs.num_configs; i++) {
313 if (confops && confops->pin_config_config_dbg_show)
314 confops->pin_config_config_dbg_show(pctldev, s,
315 setting->data.configs.configs[i]);
317 seq_printf(s, "%08lx",
318 setting->data.configs.configs[i]);
324 static void pinconf_dump_pin(struct pinctrl_dev *pctldev,
325 struct seq_file *s, int pin)
327 const struct pinconf_ops *ops = pctldev->desc->confops;
329 /* no-op when not using generic pin config */
330 pinconf_generic_dump_pin(pctldev, s, pin);
331 if (ops && ops->pin_config_dbg_show)
332 ops->pin_config_dbg_show(pctldev, s, pin);
335 static int pinconf_pins_show(struct seq_file *s, void *what)
337 struct pinctrl_dev *pctldev = s->private;
338 const struct pinconf_ops *ops = pctldev->desc->confops;
341 if (!ops || !ops->pin_config_get)
344 seq_puts(s, "Pin config settings per pin\n");
345 seq_puts(s, "Format: pin (name): configs\n");
347 mutex_lock(&pctldev->mutex);
349 /* The pin number can be retrived from the pin controller descriptor */
350 for (i = 0; i < pctldev->desc->npins; i++) {
351 struct pin_desc *desc;
353 pin = pctldev->desc->pins[i].number;
354 desc = pin_desc_get(pctldev, pin);
355 /* Skip if we cannot search the pin */
359 seq_printf(s, "pin %d (%s):", pin,
360 desc->name ? desc->name : "unnamed");
362 pinconf_dump_pin(pctldev, s, pin);
367 mutex_unlock(&pctldev->mutex);
372 static void pinconf_dump_group(struct pinctrl_dev *pctldev,
373 struct seq_file *s, unsigned selector,
376 const struct pinconf_ops *ops = pctldev->desc->confops;
378 /* no-op when not using generic pin config */
379 pinconf_generic_dump_group(pctldev, s, gname);
380 if (ops && ops->pin_config_group_dbg_show)
381 ops->pin_config_group_dbg_show(pctldev, s, selector);
384 static int pinconf_groups_show(struct seq_file *s, void *what)
386 struct pinctrl_dev *pctldev = s->private;
387 const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
388 const struct pinconf_ops *ops = pctldev->desc->confops;
389 unsigned ngroups = pctlops->get_groups_count(pctldev);
390 unsigned selector = 0;
392 if (!ops || !ops->pin_config_group_get)
395 seq_puts(s, "Pin config settings per pin group\n");
396 seq_puts(s, "Format: group (name): configs\n");
398 while (selector < ngroups) {
399 const char *gname = pctlops->get_group_name(pctldev, selector);
401 seq_printf(s, "%u (%s):", selector, gname);
402 pinconf_dump_group(pctldev, s, selector, gname);
411 static int pinconf_pins_open(struct inode *inode, struct file *file)
413 return single_open(file, pinconf_pins_show, inode->i_private);
416 static int pinconf_groups_open(struct inode *inode, struct file *file)
418 return single_open(file, pinconf_groups_show, inode->i_private);
421 static const struct file_operations pinconf_pins_ops = {
422 .open = pinconf_pins_open,
425 .release = single_release,
428 static const struct file_operations pinconf_groups_ops = {
429 .open = pinconf_groups_open,
432 .release = single_release,
435 #define MAX_NAME_LEN 15
438 enum pinctrl_map_type map_type;
439 char dev_name[MAX_NAME_LEN+1];
440 char state_name[MAX_NAME_LEN+1];
441 char pin_name[MAX_NAME_LEN+1];
445 * Goal is to keep this structure as global in order to simply read the
446 * pinconf-config file after a write to check config is as expected
448 static struct dbg_cfg pinconf_dbg_conf;
451 * pinconf_dbg_config_print() - display the pinctrl config from the pinctrl
452 * map, of the dev/pin/state that was last written to pinconf-config file.
453 * @s: string filled in with config description
456 static int pinconf_dbg_config_print(struct seq_file *s, void *d)
458 struct pinctrl_maps *maps_node;
459 const struct pinctrl_map *map;
460 struct pinctrl_dev *pctldev = NULL;
461 const struct pinconf_ops *confops = NULL;
462 const struct pinctrl_map_configs *configs;
463 struct dbg_cfg *dbg = &pinconf_dbg_conf;
466 unsigned long config;
468 mutex_lock(&pinctrl_maps_mutex);
470 /* Parse the pinctrl map and look for the elected pin/state */
471 for_each_maps(maps_node, i, map) {
472 if (map->type != dbg->map_type)
474 if (strcmp(map->dev_name, dbg->dev_name))
476 if (strcmp(map->name, dbg->state_name))
479 for (j = 0; j < map->data.configs.num_configs; j++) {
480 if (!strcmp(map->data.configs.group_or_pin,
483 * We found the right pin / state, read the
484 * config and he pctldev for later use
486 configs = &map->data.configs;
487 pctldev = get_pinctrl_dev_from_devname
488 (map->ctrl_dev_name);
496 seq_printf(s, "No config found for dev/state/pin, expected:\n");
497 seq_printf(s, "Searched dev:%s\n", dbg->dev_name);
498 seq_printf(s, "Searched state:%s\n", dbg->state_name);
499 seq_printf(s, "Searched pin:%s\n", dbg->pin_name);
500 seq_printf(s, "Use: modify config_pin <devname> "\
501 "<state> <pinname> <value>\n");
505 config = *(configs->configs);
506 seq_printf(s, "Dev %s has config of %s in state %s: 0x%08lX\n",
507 dbg->dev_name, dbg->pin_name,
508 dbg->state_name, config);
511 confops = pctldev->desc->confops;
513 if (confops && confops->pin_config_config_dbg_show)
514 confops->pin_config_config_dbg_show(pctldev, s, config);
517 mutex_unlock(&pinctrl_maps_mutex);
523 * pinconf_dbg_config_write() - modify the pinctrl config in the pinctrl
524 * map, of a dev/pin/state entry based on user entries to pinconf-config
525 * @user_buf: contains the modification request with expected format:
526 * modify config_pin <devicename> <state> <pinname> <newvalue>
527 * modify is literal string, alternatives like add/delete not supported yet
528 * config_pin is literal, alternatives like config_mux not supported yet
529 * <devicename> <state> <pinname> are values that should match the pinctrl-maps
530 * <newvalue> reflects the new config and is driver dependant
532 static int pinconf_dbg_config_write(struct file *file,
533 const char __user *user_buf, size_t count, loff_t *ppos)
535 struct pinctrl_maps *maps_node;
536 const struct pinctrl_map *map;
537 struct pinctrl_dev *pctldev = NULL;
538 const struct pinconf_ops *confops = NULL;
539 struct dbg_cfg *dbg = &pinconf_dbg_conf;
540 const struct pinctrl_map_configs *configs;
541 char config[MAX_NAME_LEN+1];
549 /* Get userspace string and assure termination */
550 buf_size = min(count, (sizeof(buf)-1));
551 if (copy_from_user(buf, user_buf, buf_size))
556 * need to parse entry and extract parameters:
557 * modify configs_pin devicename state pinname newvalue
560 /* Get arg: 'modify' */
561 token = strsep(&b, " ");
564 if (strcmp(token, "modify"))
567 /* Get arg type: "config_pin" type supported so far */
568 token = strsep(&b, " ");
571 if (strcmp(token, "config_pin"))
573 dbg->map_type = PIN_MAP_TYPE_CONFIGS_PIN;
575 /* get arg 'device_name' */
576 token = strsep(&b, " ");
579 if (strlen(token) >= MAX_NAME_LEN)
581 strncpy(dbg->dev_name, token, MAX_NAME_LEN);
583 /* get arg 'state_name' */
584 token = strsep(&b, " ");
587 if (strlen(token) >= MAX_NAME_LEN)
589 strncpy(dbg->state_name, token, MAX_NAME_LEN);
591 /* get arg 'pin_name' */
592 token = strsep(&b, " ");
595 if (strlen(token) >= MAX_NAME_LEN)
597 strncpy(dbg->pin_name, token, MAX_NAME_LEN);
599 /* get new_value of config' */
600 token = strsep(&b, " ");
603 if (strlen(token) >= MAX_NAME_LEN)
605 strncpy(config, token, MAX_NAME_LEN);
607 mutex_lock(&pinctrl_maps_mutex);
609 /* Parse the pinctrl map and look for the selected dev/state/pin */
610 for_each_maps(maps_node, i, map) {
611 if (strcmp(map->dev_name, dbg->dev_name))
613 if (map->type != dbg->map_type)
615 if (strcmp(map->name, dbg->state_name))
618 /* we found the right pin / state, so overwrite config */
619 if (!strcmp(map->data.configs.group_or_pin, dbg->pin_name)) {
621 pctldev = get_pinctrl_dev_from_devname(
623 configs = &map->data.configs;
634 confops = pctldev->desc->confops;
636 if (confops && confops->pin_config_dbg_parse_modify) {
637 for (i = 0; i < configs->num_configs; i++) {
638 confops->pin_config_dbg_parse_modify(pctldev,
640 &configs->configs[i]);
645 mutex_unlock(&pinctrl_maps_mutex);
650 static int pinconf_dbg_config_open(struct inode *inode, struct file *file)
652 return single_open(file, pinconf_dbg_config_print, inode->i_private);
655 static const struct file_operations pinconf_dbg_pinconfig_fops = {
656 .open = pinconf_dbg_config_open,
657 .write = pinconf_dbg_config_write,
660 .release = single_release,
661 .owner = THIS_MODULE,
664 void pinconf_init_device_debugfs(struct dentry *devroot,
665 struct pinctrl_dev *pctldev)
667 debugfs_create_file("pinconf-pins", S_IFREG | S_IRUGO,
668 devroot, pctldev, &pinconf_pins_ops);
669 debugfs_create_file("pinconf-groups", S_IFREG | S_IRUGO,
670 devroot, pctldev, &pinconf_groups_ops);
671 debugfs_create_file("pinconf-config", (S_IRUGO | S_IWUSR | S_IWGRP),
672 devroot, pctldev, &pinconf_dbg_pinconfig_fops);