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) {
65 "cannot get pin configuration, .pin_config_get missing 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 static void pinconf_show_config(struct seq_file *s, struct pinctrl_dev *pctldev,
206 unsigned long *configs, unsigned num_configs)
208 const struct pinconf_ops *confops;
212 confops = pctldev->desc->confops;
216 for (i = 0; i < num_configs; i++) {
217 seq_puts(s, "config ");
218 if (confops && confops->pin_config_config_dbg_show)
219 confops->pin_config_config_dbg_show(pctldev, s,
222 seq_printf(s, "%08lx", configs[i]);
227 void pinconf_show_map(struct seq_file *s, struct pinctrl_map const *map)
229 struct pinctrl_dev *pctldev;
231 pctldev = get_pinctrl_dev_from_devname(map->ctrl_dev_name);
234 case PIN_MAP_TYPE_CONFIGS_PIN:
235 seq_printf(s, "pin ");
237 case PIN_MAP_TYPE_CONFIGS_GROUP:
238 seq_printf(s, "group ");
244 seq_printf(s, "%s\n", map->data.configs.group_or_pin);
246 pinconf_show_config(s, pctldev, map->data.configs.configs,
247 map->data.configs.num_configs);
250 void pinconf_show_setting(struct seq_file *s,
251 struct pinctrl_setting const *setting)
253 struct pinctrl_dev *pctldev = setting->pctldev;
254 const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
255 struct pin_desc *desc;
257 switch (setting->type) {
258 case PIN_MAP_TYPE_CONFIGS_PIN:
259 desc = pin_desc_get(setting->pctldev,
260 setting->data.configs.group_or_pin);
261 seq_printf(s, "pin %s (%d)", desc->name,
262 setting->data.configs.group_or_pin);
264 case PIN_MAP_TYPE_CONFIGS_GROUP:
265 seq_printf(s, "group %s (%d)",
266 pctlops->get_group_name(pctldev,
267 setting->data.configs.group_or_pin),
268 setting->data.configs.group_or_pin);
275 * FIXME: We should really get the pin controler to dump the config
276 * values, so they can be decoded to something meaningful.
278 pinconf_show_config(s, pctldev, setting->data.configs.configs,
279 setting->data.configs.num_configs);
282 static void pinconf_dump_pin(struct pinctrl_dev *pctldev,
283 struct seq_file *s, int pin)
285 const struct pinconf_ops *ops = pctldev->desc->confops;
287 /* no-op when not using generic pin config */
288 pinconf_generic_dump_pins(pctldev, s, NULL, pin);
289 if (ops && ops->pin_config_dbg_show)
290 ops->pin_config_dbg_show(pctldev, s, pin);
293 static int pinconf_pins_show(struct seq_file *s, void *what)
295 struct pinctrl_dev *pctldev = s->private;
298 seq_puts(s, "Pin config settings per pin\n");
299 seq_puts(s, "Format: pin (name): configs\n");
301 mutex_lock(&pctldev->mutex);
303 /* The pin number can be retrived from the pin controller descriptor */
304 for (i = 0; i < pctldev->desc->npins; i++) {
305 struct pin_desc *desc;
307 pin = pctldev->desc->pins[i].number;
308 desc = pin_desc_get(pctldev, pin);
309 /* Skip if we cannot search the pin */
313 seq_printf(s, "pin %d (%s): ", pin, desc->name);
315 pinconf_dump_pin(pctldev, s, pin);
320 mutex_unlock(&pctldev->mutex);
325 static void pinconf_dump_group(struct pinctrl_dev *pctldev,
326 struct seq_file *s, unsigned selector,
329 const struct pinconf_ops *ops = pctldev->desc->confops;
331 /* no-op when not using generic pin config */
332 pinconf_generic_dump_pins(pctldev, s, gname, 0);
333 if (ops && ops->pin_config_group_dbg_show)
334 ops->pin_config_group_dbg_show(pctldev, s, selector);
337 static int pinconf_groups_show(struct seq_file *s, void *what)
339 struct pinctrl_dev *pctldev = s->private;
340 const struct pinctrl_ops *pctlops = pctldev->desc->pctlops;
341 unsigned ngroups = pctlops->get_groups_count(pctldev);
342 unsigned selector = 0;
344 seq_puts(s, "Pin config settings per pin group\n");
345 seq_puts(s, "Format: group (name): configs\n");
347 while (selector < ngroups) {
348 const char *gname = pctlops->get_group_name(pctldev, selector);
350 seq_printf(s, "%u (%s): ", selector, gname);
351 pinconf_dump_group(pctldev, s, selector, gname);
360 static int pinconf_pins_open(struct inode *inode, struct file *file)
362 return single_open(file, pinconf_pins_show, inode->i_private);
365 static int pinconf_groups_open(struct inode *inode, struct file *file)
367 return single_open(file, pinconf_groups_show, inode->i_private);
370 static const struct file_operations pinconf_pins_ops = {
371 .open = pinconf_pins_open,
374 .release = single_release,
377 static const struct file_operations pinconf_groups_ops = {
378 .open = pinconf_groups_open,
381 .release = single_release,
384 #define MAX_NAME_LEN 15
387 enum pinctrl_map_type map_type;
388 char dev_name[MAX_NAME_LEN+1];
389 char state_name[MAX_NAME_LEN+1];
390 char pin_name[MAX_NAME_LEN+1];
394 * Goal is to keep this structure as global in order to simply read the
395 * pinconf-config file after a write to check config is as expected
397 static struct dbg_cfg pinconf_dbg_conf;
400 * pinconf_dbg_config_print() - display the pinctrl config from the pinctrl
401 * map, of the dev/pin/state that was last written to pinconf-config file.
402 * @s: string filled in with config description
405 static int pinconf_dbg_config_print(struct seq_file *s, void *d)
407 struct pinctrl_maps *maps_node;
408 const struct pinctrl_map *map;
409 const struct pinctrl_map *found = NULL;
410 struct pinctrl_dev *pctldev;
411 struct dbg_cfg *dbg = &pinconf_dbg_conf;
414 mutex_lock(&pinctrl_maps_mutex);
416 /* Parse the pinctrl map and look for the elected pin/state */
417 for_each_maps(maps_node, i, map) {
418 if (map->type != dbg->map_type)
420 if (strcmp(map->dev_name, dbg->dev_name))
422 if (strcmp(map->name, dbg->state_name))
425 if (!strcmp(map->data.configs.group_or_pin, dbg->pin_name)) {
426 /* We found the right pin */
433 seq_printf(s, "No config found for dev/state/pin, expected:\n");
434 seq_printf(s, "Searched dev:%s\n", dbg->dev_name);
435 seq_printf(s, "Searched state:%s\n", dbg->state_name);
436 seq_printf(s, "Searched pin:%s\n", dbg->pin_name);
437 seq_printf(s, "Use: modify config_pin <devname> "\
438 "<state> <pinname> <value>\n");
442 pctldev = get_pinctrl_dev_from_devname(found->ctrl_dev_name);
443 seq_printf(s, "Dev %s has config of %s in state %s:\n",
444 dbg->dev_name, dbg->pin_name, dbg->state_name);
445 pinconf_show_config(s, pctldev, found->data.configs.configs,
446 found->data.configs.num_configs);
449 mutex_unlock(&pinctrl_maps_mutex);
455 * pinconf_dbg_config_write() - modify the pinctrl config in the pinctrl
456 * map, of a dev/pin/state entry based on user entries to pinconf-config
457 * @user_buf: contains the modification request with expected format:
458 * modify <config> <devicename> <state> <name> <newvalue>
459 * modify is literal string, alternatives like add/delete not supported yet
460 * <config> is the configuration to be changed. Supported configs are
461 * "config_pin" or "config_group", alternatives like config_mux are not
463 * <devicename> <state> <name> are values that should match the pinctrl-maps
464 * <newvalue> reflects the new config and is driver dependant
466 static ssize_t pinconf_dbg_config_write(struct file *file,
467 const char __user *user_buf, size_t count, loff_t *ppos)
469 struct pinctrl_maps *maps_node;
470 const struct pinctrl_map *map;
471 const struct pinctrl_map *found = NULL;
472 struct pinctrl_dev *pctldev;
473 const struct pinconf_ops *confops = NULL;
474 struct dbg_cfg *dbg = &pinconf_dbg_conf;
475 const struct pinctrl_map_configs *configs;
476 char config[MAX_NAME_LEN+1];
483 /* Get userspace string and assure termination */
484 buf_size = min(count, sizeof(buf) - 1);
485 if (copy_from_user(buf, user_buf, buf_size))
490 * need to parse entry and extract parameters:
491 * modify configs_pin devicename state pinname newvalue
494 /* Get arg: 'modify' */
495 token = strsep(&b, " ");
498 if (strcmp(token, "modify"))
502 * Get arg type: "config_pin" and "config_group"
503 * types are supported so far
505 token = strsep(&b, " ");
508 if (!strcmp(token, "config_pin"))
509 dbg->map_type = PIN_MAP_TYPE_CONFIGS_PIN;
510 else if (!strcmp(token, "config_group"))
511 dbg->map_type = PIN_MAP_TYPE_CONFIGS_GROUP;
515 /* get arg 'device_name' */
516 token = strsep(&b, " ");
519 if (strlen(token) >= MAX_NAME_LEN)
521 strncpy(dbg->dev_name, token, MAX_NAME_LEN);
523 /* get arg 'state_name' */
524 token = strsep(&b, " ");
527 if (strlen(token) >= MAX_NAME_LEN)
529 strncpy(dbg->state_name, token, MAX_NAME_LEN);
531 /* get arg 'pin_name' */
532 token = strsep(&b, " ");
535 if (strlen(token) >= MAX_NAME_LEN)
537 strncpy(dbg->pin_name, token, MAX_NAME_LEN);
539 /* get new_value of config' */
540 token = strsep(&b, " ");
543 if (strlen(token) >= MAX_NAME_LEN)
545 strncpy(config, token, MAX_NAME_LEN);
547 mutex_lock(&pinctrl_maps_mutex);
549 /* Parse the pinctrl map and look for the selected dev/state/pin */
550 for_each_maps(maps_node, i, map) {
551 if (strcmp(map->dev_name, dbg->dev_name))
553 if (map->type != dbg->map_type)
555 if (strcmp(map->name, dbg->state_name))
558 /* we found the right pin / state, so overwrite config */
559 if (!strcmp(map->data.configs.group_or_pin, dbg->pin_name)) {
570 pctldev = get_pinctrl_dev_from_devname(found->ctrl_dev_name);
572 confops = pctldev->desc->confops;
574 if (confops && confops->pin_config_dbg_parse_modify) {
575 configs = &found->data.configs;
576 for (i = 0; i < configs->num_configs; i++) {
577 confops->pin_config_dbg_parse_modify(pctldev,
579 &configs->configs[i]);
584 mutex_unlock(&pinctrl_maps_mutex);
589 static int pinconf_dbg_config_open(struct inode *inode, struct file *file)
591 return single_open(file, pinconf_dbg_config_print, inode->i_private);
594 static const struct file_operations pinconf_dbg_pinconfig_fops = {
595 .open = pinconf_dbg_config_open,
596 .write = pinconf_dbg_config_write,
599 .release = single_release,
600 .owner = THIS_MODULE,
603 void pinconf_init_device_debugfs(struct dentry *devroot,
604 struct pinctrl_dev *pctldev)
606 debugfs_create_file("pinconf-pins", S_IFREG | S_IRUGO,
607 devroot, pctldev, &pinconf_pins_ops);
608 debugfs_create_file("pinconf-groups", S_IFREG | S_IRUGO,
609 devroot, pctldev, &pinconf_groups_ops);
610 debugfs_create_file("pinconf-config", (S_IRUGO | S_IWUSR | S_IWGRP),
611 devroot, pctldev, &pinconf_dbg_pinconfig_fops);