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) {
40 "pinconf has to be able to set a pins config\n");
46 int pinconf_validate_map(struct pinctrl_map const *map, int i)
48 if (!map->data.configs.group_or_pin) {
49 pr_err("failed to register map %s (%d): no group/pin given\n",
54 if (!map->data.configs.num_configs ||
55 !map->data.configs.configs) {
56 pr_err("failed to register map %s (%d): no configs given\n",
64 int pin_config_get_for_pin(struct pinctrl_dev *pctldev, unsigned pin,
65 unsigned long *config)
67 const struct pinconf_ops *ops = pctldev->desc->confops;
69 if (!ops || !ops->pin_config_get) {
70 dev_err(pctldev->dev, "cannot get pin configuration, missing "
71 "pin_config_get() function in driver\n");
75 return ops->pin_config_get(pctldev, pin, config);
78 int pin_config_group_get(const char *dev_name, const char *pin_group,
79 unsigned long *config)
81 struct pinctrl_dev *pctldev;
82 const struct pinconf_ops *ops;
85 pctldev = get_pinctrl_dev_from_devname(dev_name);
91 mutex_lock(&pctldev->mutex);
93 ops = pctldev->desc->confops;
95 if (!ops || !ops->pin_config_group_get) {
96 dev_err(pctldev->dev, "cannot get configuration for pin "
97 "group, missing group config get function in "
103 selector = pinctrl_get_group_selector(pctldev, pin_group);
109 ret = ops->pin_config_group_get(pctldev, selector, config);
112 mutex_unlock(&pctldev->mutex);
116 int pinconf_map_to_setting(struct pinctrl_map const *map,
117 struct pinctrl_setting *setting)
119 struct pinctrl_dev *pctldev = setting->pctldev;
122 switch (setting->type) {
123 case PIN_MAP_TYPE_CONFIGS_PIN:
124 pin = pin_get_from_name(pctldev,
125 map->data.configs.group_or_pin);
127 dev_err(pctldev->dev, "could not map pin config for \"%s\"",
128 map->data.configs.group_or_pin);
131 setting->data.configs.group_or_pin = pin;
133 case PIN_MAP_TYPE_CONFIGS_GROUP:
134 pin = pinctrl_get_group_selector(pctldev,
135 map->data.configs.group_or_pin);
137 dev_err(pctldev->dev, "could not map group config for \"%s\"",
138 map->data.configs.group_or_pin);
141 setting->data.configs.group_or_pin = pin;
147 setting->data.configs.num_configs = map->data.configs.num_configs;
148 setting->data.configs.configs = map->data.configs.configs;
153 void pinconf_free_setting(struct pinctrl_setting const *setting)
157 int pinconf_apply_setting(struct pinctrl_setting const *setting)
159 struct pinctrl_dev *pctldev = setting->pctldev;
160 const struct pinconf_ops *ops = pctldev->desc->confops;
164 dev_err(pctldev->dev, "missing confops\n");
168 switch (setting->type) {
169 case PIN_MAP_TYPE_CONFIGS_PIN:
170 if (!ops->pin_config_set && !ops->pin_config_set_bulk) {
171 dev_err(pctldev->dev, "missing pin_config_set op\n");
174 if (ops->pin_config_group_set_bulk) {
175 ret = ops->pin_config_group_set_bulk(pctldev,
176 setting->data.configs.group_or_pin,
177 setting->data.configs.configs,
178 setting->data.configs.num_configs);
180 dev_err(pctldev->dev,
181 "pin_config_set op failed for pin %d\n",
182 setting->data.configs.group_or_pin);
185 } else if (ops->pin_config_set) {
186 for (i = 0; i < setting->data.configs.num_configs; i++) {
187 ret = ops->pin_config_set(pctldev,
188 setting->data.configs.group_or_pin,
189 setting->data.configs.configs[i]);
191 dev_err(pctldev->dev,
192 "pin_config_set op failed for pin %d config %08lx\n",
193 setting->data.configs.group_or_pin,
194 setting->data.configs.configs[i]);
200 case PIN_MAP_TYPE_CONFIGS_GROUP:
201 if (!ops->pin_config_group_set &&
202 !ops->pin_config_group_set_bulk) {
203 dev_err(pctldev->dev,
204 "missing pin_config_group_set op\n");
207 if (ops->pin_config_group_set_bulk) {
208 ret = ops->pin_config_group_set_bulk(pctldev,
209 setting->data.configs.group_or_pin,
210 setting->data.configs.configs,
211 setting->data.configs.num_configs);
213 dev_err(pctldev->dev,
214 "pin_config_group_set op failed for group %d\n",
215 setting->data.configs.group_or_pin);
218 } else if (ops->pin_config_group_set) {
219 for (i = 0; i < setting->data.configs.num_configs; i++) {
220 ret = ops->pin_config_group_set(pctldev,
221 setting->data.configs.group_or_pin,
222 setting->data.configs.configs[i]);
224 dev_err(pctldev->dev,
225 "pin_config_group_set op failed for group %d config %08lx\n",
226 setting->data.configs.group_or_pin,
227 setting->data.configs.configs[i]);
240 #ifdef CONFIG_DEBUG_FS
242 void pinconf_show_map(struct seq_file *s, struct pinctrl_map const *map)
244 struct pinctrl_dev *pctldev;
245 const struct pinconf_ops *confops;
248 pctldev = get_pinctrl_dev_from_devname(map->ctrl_dev_name);
250 confops = pctldev->desc->confops;
255 case PIN_MAP_TYPE_CONFIGS_PIN:
256 seq_printf(s, "pin ");
258 case PIN_MAP_TYPE_CONFIGS_GROUP:
259 seq_printf(s, "group ");
265 seq_printf(s, "%s\n", map->data.configs.group_or_pin);
267 for (i = 0; i < map->data.configs.num_configs; i++) {
268 seq_printf(s, "config ");
269 if (confops && confops->pin_config_config_dbg_show)
270 confops->pin_config_config_dbg_show(pctldev, s,
271 map->data.configs.configs[i]);
273 seq_printf(s, "%08lx", map->data.configs.configs[i]);
278 void pinconf_show_setting(struct seq_file *s,
279 struct pinctrl_setting const *setting)
281 struct pinctrl_dev *pctldev = setting->pctldev;
282 const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
283 const struct pinconf_ops *confops = pctldev->desc->confops;
284 struct pin_desc *desc;
287 switch (setting->type) {
288 case PIN_MAP_TYPE_CONFIGS_PIN:
289 desc = pin_desc_get(setting->pctldev,
290 setting->data.configs.group_or_pin);
291 seq_printf(s, "pin %s (%d)",
292 desc->name ? desc->name : "unnamed",
293 setting->data.configs.group_or_pin);
295 case PIN_MAP_TYPE_CONFIGS_GROUP:
296 seq_printf(s, "group %s (%d)",
297 pctlops->get_group_name(pctldev,
298 setting->data.configs.group_or_pin),
299 setting->data.configs.group_or_pin);
306 * FIXME: We should really get the pin controler to dump the config
307 * values, so they can be decoded to something meaningful.
309 for (i = 0; i < setting->data.configs.num_configs; i++) {
311 if (confops && confops->pin_config_config_dbg_show)
312 confops->pin_config_config_dbg_show(pctldev, s,
313 setting->data.configs.configs[i]);
315 seq_printf(s, "%08lx",
316 setting->data.configs.configs[i]);
322 static void pinconf_dump_pin(struct pinctrl_dev *pctldev,
323 struct seq_file *s, int pin)
325 const struct pinconf_ops *ops = pctldev->desc->confops;
327 /* no-op when not using generic pin config */
328 pinconf_generic_dump_pin(pctldev, s, pin);
329 if (ops && ops->pin_config_dbg_show)
330 ops->pin_config_dbg_show(pctldev, s, pin);
333 static int pinconf_pins_show(struct seq_file *s, void *what)
335 struct pinctrl_dev *pctldev = s->private;
336 const struct pinconf_ops *ops = pctldev->desc->confops;
339 if (!ops || !ops->pin_config_get)
342 seq_puts(s, "Pin config settings per pin\n");
343 seq_puts(s, "Format: pin (name): configs\n");
345 mutex_lock(&pctldev->mutex);
347 /* The pin number can be retrived from the pin controller descriptor */
348 for (i = 0; i < pctldev->desc->npins; i++) {
349 struct pin_desc *desc;
351 pin = pctldev->desc->pins[i].number;
352 desc = pin_desc_get(pctldev, pin);
353 /* Skip if we cannot search the pin */
357 seq_printf(s, "pin %d (%s):", pin,
358 desc->name ? desc->name : "unnamed");
360 pinconf_dump_pin(pctldev, s, pin);
365 mutex_unlock(&pctldev->mutex);
370 static void pinconf_dump_group(struct pinctrl_dev *pctldev,
371 struct seq_file *s, unsigned selector,
374 const struct pinconf_ops *ops = pctldev->desc->confops;
376 /* no-op when not using generic pin config */
377 pinconf_generic_dump_group(pctldev, s, gname);
378 if (ops && ops->pin_config_group_dbg_show)
379 ops->pin_config_group_dbg_show(pctldev, s, selector);
382 static int pinconf_groups_show(struct seq_file *s, void *what)
384 struct pinctrl_dev *pctldev = s->private;
385 const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
386 const struct pinconf_ops *ops = pctldev->desc->confops;
387 unsigned ngroups = pctlops->get_groups_count(pctldev);
388 unsigned selector = 0;
390 if (!ops || !ops->pin_config_group_get)
393 seq_puts(s, "Pin config settings per pin group\n");
394 seq_puts(s, "Format: group (name): configs\n");
396 while (selector < ngroups) {
397 const char *gname = pctlops->get_group_name(pctldev, selector);
399 seq_printf(s, "%u (%s):", selector, gname);
400 pinconf_dump_group(pctldev, s, selector, gname);
409 static int pinconf_pins_open(struct inode *inode, struct file *file)
411 return single_open(file, pinconf_pins_show, inode->i_private);
414 static int pinconf_groups_open(struct inode *inode, struct file *file)
416 return single_open(file, pinconf_groups_show, inode->i_private);
419 static const struct file_operations pinconf_pins_ops = {
420 .open = pinconf_pins_open,
423 .release = single_release,
426 static const struct file_operations pinconf_groups_ops = {
427 .open = pinconf_groups_open,
430 .release = single_release,
433 #define MAX_NAME_LEN 15
436 enum pinctrl_map_type map_type;
437 char dev_name[MAX_NAME_LEN+1];
438 char state_name[MAX_NAME_LEN+1];
439 char pin_name[MAX_NAME_LEN+1];
443 * Goal is to keep this structure as global in order to simply read the
444 * pinconf-config file after a write to check config is as expected
446 static struct dbg_cfg pinconf_dbg_conf;
449 * pinconf_dbg_config_print() - display the pinctrl config from the pinctrl
450 * map, of the dev/pin/state that was last written to pinconf-config file.
451 * @s: string filled in with config description
454 static int pinconf_dbg_config_print(struct seq_file *s, void *d)
456 struct pinctrl_maps *maps_node;
457 const struct pinctrl_map *map;
458 struct pinctrl_dev *pctldev = NULL;
459 const struct pinconf_ops *confops = NULL;
460 const struct pinctrl_map_configs *configs;
461 struct dbg_cfg *dbg = &pinconf_dbg_conf;
464 unsigned long config;
466 mutex_lock(&pinctrl_maps_mutex);
468 /* Parse the pinctrl map and look for the elected pin/state */
469 for_each_maps(maps_node, i, map) {
470 if (map->type != dbg->map_type)
472 if (strcmp(map->dev_name, dbg->dev_name))
474 if (strcmp(map->name, dbg->state_name))
477 for (j = 0; j < map->data.configs.num_configs; j++) {
478 if (!strcmp(map->data.configs.group_or_pin,
481 * We found the right pin / state, read the
482 * config and he pctldev for later use
484 configs = &map->data.configs;
485 pctldev = get_pinctrl_dev_from_devname
486 (map->ctrl_dev_name);
494 seq_printf(s, "No config found for dev/state/pin, expected:\n");
495 seq_printf(s, "Searched dev:%s\n", dbg->dev_name);
496 seq_printf(s, "Searched state:%s\n", dbg->state_name);
497 seq_printf(s, "Searched pin:%s\n", dbg->pin_name);
498 seq_printf(s, "Use: modify config_pin <devname> "\
499 "<state> <pinname> <value>\n");
503 config = *(configs->configs);
504 seq_printf(s, "Dev %s has config of %s in state %s: 0x%08lX\n",
505 dbg->dev_name, dbg->pin_name,
506 dbg->state_name, config);
509 confops = pctldev->desc->confops;
511 if (confops && confops->pin_config_config_dbg_show)
512 confops->pin_config_config_dbg_show(pctldev, s, config);
515 mutex_unlock(&pinctrl_maps_mutex);
521 * pinconf_dbg_config_write() - modify the pinctrl config in the pinctrl
522 * map, of a dev/pin/state entry based on user entries to pinconf-config
523 * @user_buf: contains the modification request with expected format:
524 * modify config_pin <devicename> <state> <pinname> <newvalue>
525 * modify is literal string, alternatives like add/delete not supported yet
526 * config_pin is literal, alternatives like config_mux not supported yet
527 * <devicename> <state> <pinname> are values that should match the pinctrl-maps
528 * <newvalue> reflects the new config and is driver dependant
530 static int pinconf_dbg_config_write(struct file *file,
531 const char __user *user_buf, size_t count, loff_t *ppos)
533 struct pinctrl_maps *maps_node;
534 const struct pinctrl_map *map;
535 struct pinctrl_dev *pctldev = NULL;
536 const struct pinconf_ops *confops = NULL;
537 struct dbg_cfg *dbg = &pinconf_dbg_conf;
538 const struct pinctrl_map_configs *configs;
539 char config[MAX_NAME_LEN+1];
547 /* Get userspace string and assure termination */
548 buf_size = min(count, (sizeof(buf)-1));
549 if (copy_from_user(buf, user_buf, buf_size))
554 * need to parse entry and extract parameters:
555 * modify configs_pin devicename state pinname newvalue
558 /* Get arg: 'modify' */
559 token = strsep(&b, " ");
562 if (strcmp(token, "modify"))
565 /* Get arg type: "config_pin" type supported so far */
566 token = strsep(&b, " ");
569 if (strcmp(token, "config_pin"))
571 dbg->map_type = PIN_MAP_TYPE_CONFIGS_PIN;
573 /* get arg 'device_name' */
574 token = strsep(&b, " ");
577 if (strlen(token) >= MAX_NAME_LEN)
579 strncpy(dbg->dev_name, token, MAX_NAME_LEN);
581 /* get arg 'state_name' */
582 token = strsep(&b, " ");
585 if (strlen(token) >= MAX_NAME_LEN)
587 strncpy(dbg->state_name, token, MAX_NAME_LEN);
589 /* get arg 'pin_name' */
590 token = strsep(&b, " ");
593 if (strlen(token) >= MAX_NAME_LEN)
595 strncpy(dbg->pin_name, token, MAX_NAME_LEN);
597 /* get new_value of config' */
598 token = strsep(&b, " ");
601 if (strlen(token) >= MAX_NAME_LEN)
603 strncpy(config, token, MAX_NAME_LEN);
605 mutex_lock(&pinctrl_maps_mutex);
607 /* Parse the pinctrl map and look for the selected dev/state/pin */
608 for_each_maps(maps_node, i, map) {
609 if (strcmp(map->dev_name, dbg->dev_name))
611 if (map->type != dbg->map_type)
613 if (strcmp(map->name, dbg->state_name))
616 /* we found the right pin / state, so overwrite config */
617 if (!strcmp(map->data.configs.group_or_pin, dbg->pin_name)) {
619 pctldev = get_pinctrl_dev_from_devname(
621 configs = &map->data.configs;
632 confops = pctldev->desc->confops;
634 if (confops && confops->pin_config_dbg_parse_modify) {
635 for (i = 0; i < configs->num_configs; i++) {
636 confops->pin_config_dbg_parse_modify(pctldev,
638 &configs->configs[i]);
643 mutex_unlock(&pinctrl_maps_mutex);
648 static int pinconf_dbg_config_open(struct inode *inode, struct file *file)
650 return single_open(file, pinconf_dbg_config_print, inode->i_private);
653 static const struct file_operations pinconf_dbg_pinconfig_fops = {
654 .open = pinconf_dbg_config_open,
655 .write = pinconf_dbg_config_write,
658 .release = single_release,
659 .owner = THIS_MODULE,
662 void pinconf_init_device_debugfs(struct dentry *devroot,
663 struct pinctrl_dev *pctldev)
665 debugfs_create_file("pinconf-pins", S_IFREG | S_IRUGO,
666 devroot, pctldev, &pinconf_pins_ops);
667 debugfs_create_file("pinconf-groups", S_IFREG | S_IRUGO,
668 devroot, pctldev, &pinconf_groups_ops);
669 debugfs_create_file("pinconf-config", (S_IRUGO | S_IWUSR | S_IWGRP),
670 devroot, pctldev, &pinconf_dbg_pinconfig_fops);