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
) {
171 dev_err(pctldev
->dev
, "missing pin_config_set op\n");
174 ret
= ops
->pin_config_set(pctldev
,
175 setting
->data
.configs
.group_or_pin
,
176 setting
->data
.configs
.configs
,
177 setting
->data
.configs
.num_configs
);
179 dev_err(pctldev
->dev
,
180 "pin_config_set op failed for pin %d\n",
181 setting
->data
.configs
.group_or_pin
);
185 case PIN_MAP_TYPE_CONFIGS_GROUP
:
186 if (!ops
->pin_config_group_set
) {
187 dev_err(pctldev
->dev
,
188 "missing pin_config_group_set op\n");
191 ret
= ops
->pin_config_group_set(pctldev
,
192 setting
->data
.configs
.group_or_pin
,
193 setting
->data
.configs
.configs
,
194 setting
->data
.configs
.num_configs
);
196 dev_err(pctldev
->dev
,
197 "pin_config_group_set op failed for group %d\n",
198 setting
->data
.configs
.group_or_pin
);
209 #ifdef CONFIG_DEBUG_FS
211 void pinconf_show_map(struct seq_file
*s
, struct pinctrl_map
const *map
)
213 struct pinctrl_dev
*pctldev
;
214 const struct pinconf_ops
*confops
;
217 pctldev
= get_pinctrl_dev_from_devname(map
->ctrl_dev_name
);
219 confops
= pctldev
->desc
->confops
;
224 case PIN_MAP_TYPE_CONFIGS_PIN
:
225 seq_printf(s
, "pin ");
227 case PIN_MAP_TYPE_CONFIGS_GROUP
:
228 seq_printf(s
, "group ");
234 seq_printf(s
, "%s\n", map
->data
.configs
.group_or_pin
);
236 for (i
= 0; i
< map
->data
.configs
.num_configs
; i
++) {
237 seq_printf(s
, "config ");
238 if (confops
&& confops
->pin_config_config_dbg_show
)
239 confops
->pin_config_config_dbg_show(pctldev
, s
,
240 map
->data
.configs
.configs
[i
]);
242 seq_printf(s
, "%08lx", map
->data
.configs
.configs
[i
]);
247 void pinconf_show_setting(struct seq_file
*s
,
248 struct pinctrl_setting
const *setting
)
250 struct pinctrl_dev
*pctldev
= setting
->pctldev
;
251 const struct pinctrl_ops
*pctlops
= pctldev
->desc
->pctlops
;
252 const struct pinconf_ops
*confops
= pctldev
->desc
->confops
;
253 struct pin_desc
*desc
;
256 switch (setting
->type
) {
257 case PIN_MAP_TYPE_CONFIGS_PIN
:
258 desc
= pin_desc_get(setting
->pctldev
,
259 setting
->data
.configs
.group_or_pin
);
260 seq_printf(s
, "pin %s (%d)",
261 desc
->name
? desc
->name
: "unnamed",
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 for (i
= 0; i
< setting
->data
.configs
.num_configs
; i
++) {
280 if (confops
&& confops
->pin_config_config_dbg_show
)
281 confops
->pin_config_config_dbg_show(pctldev
, s
,
282 setting
->data
.configs
.configs
[i
]);
284 seq_printf(s
, "%08lx",
285 setting
->data
.configs
.configs
[i
]);
291 static void pinconf_dump_pin(struct pinctrl_dev
*pctldev
,
292 struct seq_file
*s
, int pin
)
294 const struct pinconf_ops
*ops
= pctldev
->desc
->confops
;
296 /* no-op when not using generic pin config */
297 pinconf_generic_dump_pin(pctldev
, s
, pin
);
298 if (ops
&& ops
->pin_config_dbg_show
)
299 ops
->pin_config_dbg_show(pctldev
, s
, pin
);
302 static int pinconf_pins_show(struct seq_file
*s
, void *what
)
304 struct pinctrl_dev
*pctldev
= s
->private;
305 const struct pinconf_ops
*ops
= pctldev
->desc
->confops
;
308 if (!ops
|| !ops
->pin_config_get
)
311 seq_puts(s
, "Pin config settings per pin\n");
312 seq_puts(s
, "Format: pin (name): configs\n");
314 mutex_lock(&pctldev
->mutex
);
316 /* The pin number can be retrived from the pin controller descriptor */
317 for (i
= 0; i
< pctldev
->desc
->npins
; i
++) {
318 struct pin_desc
*desc
;
320 pin
= pctldev
->desc
->pins
[i
].number
;
321 desc
= pin_desc_get(pctldev
, pin
);
322 /* Skip if we cannot search the pin */
326 seq_printf(s
, "pin %d (%s):", pin
,
327 desc
->name
? desc
->name
: "unnamed");
329 pinconf_dump_pin(pctldev
, s
, pin
);
334 mutex_unlock(&pctldev
->mutex
);
339 static void pinconf_dump_group(struct pinctrl_dev
*pctldev
,
340 struct seq_file
*s
, unsigned selector
,
343 const struct pinconf_ops
*ops
= pctldev
->desc
->confops
;
345 /* no-op when not using generic pin config */
346 pinconf_generic_dump_group(pctldev
, s
, gname
);
347 if (ops
&& ops
->pin_config_group_dbg_show
)
348 ops
->pin_config_group_dbg_show(pctldev
, s
, selector
);
351 static int pinconf_groups_show(struct seq_file
*s
, void *what
)
353 struct pinctrl_dev
*pctldev
= s
->private;
354 const struct pinctrl_ops
*pctlops
= pctldev
->desc
->pctlops
;
355 const struct pinconf_ops
*ops
= pctldev
->desc
->confops
;
356 unsigned ngroups
= pctlops
->get_groups_count(pctldev
);
357 unsigned selector
= 0;
359 if (!ops
|| !ops
->pin_config_group_get
)
362 seq_puts(s
, "Pin config settings per pin group\n");
363 seq_puts(s
, "Format: group (name): configs\n");
365 while (selector
< ngroups
) {
366 const char *gname
= pctlops
->get_group_name(pctldev
, selector
);
368 seq_printf(s
, "%u (%s):", selector
, gname
);
369 pinconf_dump_group(pctldev
, s
, selector
, gname
);
378 static int pinconf_pins_open(struct inode
*inode
, struct file
*file
)
380 return single_open(file
, pinconf_pins_show
, inode
->i_private
);
383 static int pinconf_groups_open(struct inode
*inode
, struct file
*file
)
385 return single_open(file
, pinconf_groups_show
, inode
->i_private
);
388 static const struct file_operations pinconf_pins_ops
= {
389 .open
= pinconf_pins_open
,
392 .release
= single_release
,
395 static const struct file_operations pinconf_groups_ops
= {
396 .open
= pinconf_groups_open
,
399 .release
= single_release
,
402 #define MAX_NAME_LEN 15
405 enum pinctrl_map_type map_type
;
406 char dev_name
[MAX_NAME_LEN
+1];
407 char state_name
[MAX_NAME_LEN
+1];
408 char pin_name
[MAX_NAME_LEN
+1];
412 * Goal is to keep this structure as global in order to simply read the
413 * pinconf-config file after a write to check config is as expected
415 static struct dbg_cfg pinconf_dbg_conf
;
418 * pinconf_dbg_config_print() - display the pinctrl config from the pinctrl
419 * map, of the dev/pin/state that was last written to pinconf-config file.
420 * @s: string filled in with config description
423 static int pinconf_dbg_config_print(struct seq_file
*s
, void *d
)
425 struct pinctrl_maps
*maps_node
;
426 const struct pinctrl_map
*map
;
427 const struct pinctrl_map
*found
= NULL
;
428 struct pinctrl_dev
*pctldev
;
429 const struct pinconf_ops
*confops
= NULL
;
430 struct dbg_cfg
*dbg
= &pinconf_dbg_conf
;
432 unsigned long config
;
434 mutex_lock(&pinctrl_maps_mutex
);
436 /* Parse the pinctrl map and look for the elected pin/state */
437 for_each_maps(maps_node
, i
, map
) {
438 if (map
->type
!= dbg
->map_type
)
440 if (strcmp(map
->dev_name
, dbg
->dev_name
))
442 if (strcmp(map
->name
, dbg
->state_name
))
445 for (j
= 0; j
< map
->data
.configs
.num_configs
; j
++) {
446 if (!strcmp(map
->data
.configs
.group_or_pin
,
448 /* We found the right pin / state */
456 seq_printf(s
, "No config found for dev/state/pin, expected:\n");
457 seq_printf(s
, "Searched dev:%s\n", dbg
->dev_name
);
458 seq_printf(s
, "Searched state:%s\n", dbg
->state_name
);
459 seq_printf(s
, "Searched pin:%s\n", dbg
->pin_name
);
460 seq_printf(s
, "Use: modify config_pin <devname> "\
461 "<state> <pinname> <value>\n");
465 pctldev
= get_pinctrl_dev_from_devname(found
->ctrl_dev_name
);
466 config
= *found
->data
.configs
.configs
;
467 seq_printf(s
, "Dev %s has config of %s in state %s: 0x%08lX\n",
468 dbg
->dev_name
, dbg
->pin_name
,
469 dbg
->state_name
, config
);
472 confops
= pctldev
->desc
->confops
;
474 if (confops
&& confops
->pin_config_config_dbg_show
)
475 confops
->pin_config_config_dbg_show(pctldev
, s
, config
);
478 mutex_unlock(&pinctrl_maps_mutex
);
484 * pinconf_dbg_config_write() - modify the pinctrl config in the pinctrl
485 * map, of a dev/pin/state entry based on user entries to pinconf-config
486 * @user_buf: contains the modification request with expected format:
487 * modify config_pin <devicename> <state> <pinname> <newvalue>
488 * modify is literal string, alternatives like add/delete not supported yet
489 * config_pin is literal, alternatives like config_mux not supported yet
490 * <devicename> <state> <pinname> are values that should match the pinctrl-maps
491 * <newvalue> reflects the new config and is driver dependant
493 static ssize_t
pinconf_dbg_config_write(struct file
*file
,
494 const char __user
*user_buf
, size_t count
, loff_t
*ppos
)
496 struct pinctrl_maps
*maps_node
;
497 const struct pinctrl_map
*map
;
498 const struct pinctrl_map
*found
= NULL
;
499 struct pinctrl_dev
*pctldev
;
500 const struct pinconf_ops
*confops
= NULL
;
501 struct dbg_cfg
*dbg
= &pinconf_dbg_conf
;
502 const struct pinctrl_map_configs
*configs
;
503 char config
[MAX_NAME_LEN
+1];
510 /* Get userspace string and assure termination */
511 buf_size
= min(count
, sizeof(buf
) - 1);
512 if (copy_from_user(buf
, user_buf
, buf_size
))
517 * need to parse entry and extract parameters:
518 * modify configs_pin devicename state pinname newvalue
521 /* Get arg: 'modify' */
522 token
= strsep(&b
, " ");
525 if (strcmp(token
, "modify"))
528 /* Get arg type: "config_pin" type supported so far */
529 token
= strsep(&b
, " ");
532 if (strcmp(token
, "config_pin"))
534 dbg
->map_type
= PIN_MAP_TYPE_CONFIGS_PIN
;
536 /* get arg 'device_name' */
537 token
= strsep(&b
, " ");
540 if (strlen(token
) >= MAX_NAME_LEN
)
542 strncpy(dbg
->dev_name
, token
, MAX_NAME_LEN
);
544 /* get arg 'state_name' */
545 token
= strsep(&b
, " ");
548 if (strlen(token
) >= MAX_NAME_LEN
)
550 strncpy(dbg
->state_name
, token
, MAX_NAME_LEN
);
552 /* get arg 'pin_name' */
553 token
= strsep(&b
, " ");
556 if (strlen(token
) >= MAX_NAME_LEN
)
558 strncpy(dbg
->pin_name
, token
, MAX_NAME_LEN
);
560 /* get new_value of config' */
561 token
= strsep(&b
, " ");
564 if (strlen(token
) >= MAX_NAME_LEN
)
566 strncpy(config
, token
, MAX_NAME_LEN
);
568 mutex_lock(&pinctrl_maps_mutex
);
570 /* Parse the pinctrl map and look for the selected dev/state/pin */
571 for_each_maps(maps_node
, i
, map
) {
572 if (strcmp(map
->dev_name
, dbg
->dev_name
))
574 if (map
->type
!= dbg
->map_type
)
576 if (strcmp(map
->name
, dbg
->state_name
))
579 /* we found the right pin / state, so overwrite config */
580 if (!strcmp(map
->data
.configs
.group_or_pin
, dbg
->pin_name
)) {
591 pctldev
= get_pinctrl_dev_from_devname(found
->ctrl_dev_name
);
593 confops
= pctldev
->desc
->confops
;
595 if (confops
&& confops
->pin_config_dbg_parse_modify
) {
596 configs
= &found
->data
.configs
;
597 for (i
= 0; i
< configs
->num_configs
; i
++) {
598 confops
->pin_config_dbg_parse_modify(pctldev
,
600 &configs
->configs
[i
]);
605 mutex_unlock(&pinctrl_maps_mutex
);
610 static int pinconf_dbg_config_open(struct inode
*inode
, struct file
*file
)
612 return single_open(file
, pinconf_dbg_config_print
, inode
->i_private
);
615 static const struct file_operations pinconf_dbg_pinconfig_fops
= {
616 .open
= pinconf_dbg_config_open
,
617 .write
= pinconf_dbg_config_write
,
620 .release
= single_release
,
621 .owner
= THIS_MODULE
,
624 void pinconf_init_device_debugfs(struct dentry
*devroot
,
625 struct pinctrl_dev
*pctldev
)
627 debugfs_create_file("pinconf-pins", S_IFREG
| S_IRUGO
,
628 devroot
, pctldev
, &pinconf_pins_ops
);
629 debugfs_create_file("pinconf-groups", S_IFREG
| S_IRUGO
,
630 devroot
, pctldev
, &pinconf_groups_ops
);
631 debugfs_create_file("pinconf-config", (S_IRUGO
| S_IWUSR
| S_IWGRP
),
632 devroot
, pctldev
, &pinconf_dbg_pinconfig_fops
);