2 * Core driver for the imx pin controller
4 * Copyright (C) 2012 Freescale Semiconductor, Inc.
5 * Copyright (C) 2012 Linaro Ltd.
7 * Author: Dong Aisheng <dong.aisheng@linaro.org>
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
15 #include <linux/err.h>
16 #include <linux/init.h>
18 #include <linux/module.h>
20 #include <linux/of_device.h>
21 #include <linux/pinctrl/machine.h>
22 #include <linux/pinctrl/pinconf.h>
23 #include <linux/pinctrl/pinctrl.h>
24 #include <linux/pinctrl/pinmux.h>
25 #include <linux/slab.h>
28 #include "pinctrl-imx.h"
30 #define IMX_PMX_DUMP(info, p, m, c, n) \
33 printk(KERN_DEBUG "Format: Pin Mux Config\n"); \
34 for (i = 0; i < n; i++) { \
36 printk(KERN_DEBUG "%s %d 0x%lx\n", \
42 /* The bits in CONFIG cell defined in binding doc*/
43 #define IMX_NO_PAD_CTL 0x80000000 /* no pin config need */
44 #define IMX_PAD_SION 0x40000000 /* set SION */
47 * @dev: a pointer back to containing device
48 * @base: the offset to the controller in virtual memory
52 struct pinctrl_dev *pctl;
54 const struct imx_pinctrl_soc_info *info;
57 static const struct imx_pin_reg *imx_find_pin_reg(
58 const struct imx_pinctrl_soc_info *info,
59 unsigned pin, bool is_mux, unsigned mux)
61 const struct imx_pin_reg *pin_reg = NULL;
64 for (i = 0; i < info->npin_regs; i++) {
65 pin_reg = &info->pin_regs[i];
66 if (pin_reg->pid != pin)
70 else if (pin_reg->mux_mode == (mux & IMX_MUX_MASK))
75 dev_err(info->dev, "Pin(%s): unable to find pin reg map\n",
76 info->pins[pin].name);
83 static const inline struct imx_pin_group *imx_pinctrl_find_group_by_name(
84 const struct imx_pinctrl_soc_info *info,
87 const struct imx_pin_group *grp = NULL;
90 for (i = 0; i < info->ngroups; i++) {
91 if (!strcmp(info->groups[i].name, name)) {
92 grp = &info->groups[i];
100 static int imx_get_groups_count(struct pinctrl_dev *pctldev)
102 struct imx_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
103 const struct imx_pinctrl_soc_info *info = ipctl->info;
105 return info->ngroups;
108 static const char *imx_get_group_name(struct pinctrl_dev *pctldev,
111 struct imx_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
112 const struct imx_pinctrl_soc_info *info = ipctl->info;
114 return info->groups[selector].name;
117 static int imx_get_group_pins(struct pinctrl_dev *pctldev, unsigned selector,
118 const unsigned **pins,
121 struct imx_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
122 const struct imx_pinctrl_soc_info *info = ipctl->info;
124 if (selector >= info->ngroups)
127 *pins = info->groups[selector].pins;
128 *npins = info->groups[selector].npins;
133 static void imx_pin_dbg_show(struct pinctrl_dev *pctldev, struct seq_file *s,
136 seq_printf(s, "%s", dev_name(pctldev->dev));
139 static int imx_dt_node_to_map(struct pinctrl_dev *pctldev,
140 struct device_node *np,
141 struct pinctrl_map **map, unsigned *num_maps)
143 struct imx_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
144 const struct imx_pinctrl_soc_info *info = ipctl->info;
145 const struct imx_pin_group *grp;
146 struct pinctrl_map *new_map;
147 struct device_node *parent;
152 * first find the group of this node and check if we need create
153 * config maps for pins
155 grp = imx_pinctrl_find_group_by_name(info, np->name);
157 dev_err(info->dev, "unable to find group for node %s\n",
162 for (i = 0; i < grp->npins; i++) {
163 if (!(grp->configs[i] & IMX_NO_PAD_CTL))
167 new_map = kmalloc(sizeof(struct pinctrl_map) * map_num, GFP_KERNEL);
175 parent = of_get_parent(np);
180 new_map[0].type = PIN_MAP_TYPE_MUX_GROUP;
181 new_map[0].data.mux.function = parent->name;
182 new_map[0].data.mux.group = np->name;
185 /* create config map */
187 for (i = 0; i < grp->npins; i++) {
188 if (!(grp->configs[i] & IMX_NO_PAD_CTL)) {
189 new_map[i].type = PIN_MAP_TYPE_CONFIGS_PIN;
190 new_map[i].data.configs.group_or_pin =
191 pin_get_name(pctldev, grp->pins[i]);
192 new_map[i].data.configs.configs = &grp->configs[i];
193 new_map[i].data.configs.num_configs = 1;
197 dev_dbg(pctldev->dev, "maps: function %s group %s num %d\n",
198 (*map)->data.mux.function, (*map)->data.mux.group, map_num);
203 static void imx_dt_free_map(struct pinctrl_dev *pctldev,
204 struct pinctrl_map *map, unsigned num_maps)
209 static struct pinctrl_ops imx_pctrl_ops = {
210 .get_groups_count = imx_get_groups_count,
211 .get_group_name = imx_get_group_name,
212 .get_group_pins = imx_get_group_pins,
213 .pin_dbg_show = imx_pin_dbg_show,
214 .dt_node_to_map = imx_dt_node_to_map,
215 .dt_free_map = imx_dt_free_map,
219 static int imx_pmx_enable(struct pinctrl_dev *pctldev, unsigned selector,
222 struct imx_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
223 const struct imx_pinctrl_soc_info *info = ipctl->info;
224 const struct imx_pin_reg *pin_reg;
225 const unsigned *pins, *mux;
226 unsigned int npins, pin_id;
230 * Configure the mux mode for each pin in the group for a specific
233 pins = info->groups[group].pins;
234 npins = info->groups[group].npins;
235 mux = info->groups[group].mux_mode;
237 WARN_ON(!pins || !npins || !mux);
239 dev_dbg(ipctl->dev, "enable function %s group %s\n",
240 info->functions[selector].name, info->groups[group].name);
242 for (i = 0; i < npins; i++) {
245 pin_reg = imx_find_pin_reg(info, pin_id, 1, mux[i]);
249 if (!pin_reg->mux_reg) {
250 dev_err(ipctl->dev, "Pin(%s) does not support mux function\n",
251 info->pins[pin_id].name);
255 writel(mux[i], ipctl->base + pin_reg->mux_reg);
256 dev_dbg(ipctl->dev, "write: offset 0x%x val 0x%x\n",
257 pin_reg->mux_reg, mux[i]);
259 /* some pins also need select input setting, set it if found */
260 if (pin_reg->input_reg) {
261 writel(pin_reg->input_val, ipctl->base + pin_reg->input_reg);
263 "==>select_input: offset 0x%x val 0x%x\n",
264 pin_reg->input_reg, pin_reg->input_val);
271 static int imx_pmx_get_funcs_count(struct pinctrl_dev *pctldev)
273 struct imx_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
274 const struct imx_pinctrl_soc_info *info = ipctl->info;
276 return info->nfunctions;
279 static const char *imx_pmx_get_func_name(struct pinctrl_dev *pctldev,
282 struct imx_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
283 const struct imx_pinctrl_soc_info *info = ipctl->info;
285 return info->functions[selector].name;
288 static int imx_pmx_get_groups(struct pinctrl_dev *pctldev, unsigned selector,
289 const char * const **groups,
290 unsigned * const num_groups)
292 struct imx_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
293 const struct imx_pinctrl_soc_info *info = ipctl->info;
295 *groups = info->functions[selector].groups;
296 *num_groups = info->functions[selector].num_groups;
301 static struct pinmux_ops imx_pmx_ops = {
302 .get_functions_count = imx_pmx_get_funcs_count,
303 .get_function_name = imx_pmx_get_func_name,
304 .get_function_groups = imx_pmx_get_groups,
305 .enable = imx_pmx_enable,
308 static int imx_pinconf_get(struct pinctrl_dev *pctldev,
309 unsigned pin_id, unsigned long *config)
311 struct imx_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
312 const struct imx_pinctrl_soc_info *info = ipctl->info;
313 const struct imx_pin_reg *pin_reg;
315 pin_reg = imx_find_pin_reg(info, pin_id, 0, 0);
319 if (!pin_reg->conf_reg) {
320 dev_err(info->dev, "Pin(%s) does not support config function\n",
321 info->pins[pin_id].name);
325 *config = readl(ipctl->base + pin_reg->conf_reg);
330 static int imx_pinconf_set(struct pinctrl_dev *pctldev,
331 unsigned pin_id, unsigned long config)
333 struct imx_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
334 const struct imx_pinctrl_soc_info *info = ipctl->info;
335 const struct imx_pin_reg *pin_reg;
337 pin_reg = imx_find_pin_reg(info, pin_id, 0, 0);
341 if (!pin_reg->conf_reg) {
342 dev_err(info->dev, "Pin(%s) does not support config function\n",
343 info->pins[pin_id].name);
347 dev_dbg(ipctl->dev, "pinconf set pin %s\n",
348 info->pins[pin_id].name);
350 writel(config, ipctl->base + pin_reg->conf_reg);
351 dev_dbg(ipctl->dev, "write: offset 0x%x val 0x%lx\n",
352 pin_reg->conf_reg, config);
357 static void imx_pinconf_dbg_show(struct pinctrl_dev *pctldev,
358 struct seq_file *s, unsigned pin_id)
360 struct imx_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
361 const struct imx_pinctrl_soc_info *info = ipctl->info;
362 const struct imx_pin_reg *pin_reg;
363 unsigned long config;
365 pin_reg = imx_find_pin_reg(info, pin_id, 0, 0);
366 if (!pin_reg || !pin_reg->conf_reg) {
367 seq_printf(s, "N/A");
371 config = readl(ipctl->base + pin_reg->conf_reg);
372 seq_printf(s, "0x%lx", config);
375 static void imx_pinconf_group_dbg_show(struct pinctrl_dev *pctldev,
376 struct seq_file *s, unsigned group)
378 struct imx_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
379 const struct imx_pinctrl_soc_info *info = ipctl->info;
380 struct imx_pin_group *grp;
381 unsigned long config;
385 if (group > info->ngroups)
389 grp = &info->groups[group];
390 for (i = 0; i < grp->npins; i++) {
391 name = pin_get_name(pctldev, grp->pins[i]);
392 ret = imx_pinconf_get(pctldev, grp->pins[i], &config);
395 seq_printf(s, "%s: 0x%lx", name, config);
399 struct pinconf_ops imx_pinconf_ops = {
400 .pin_config_get = imx_pinconf_get,
401 .pin_config_set = imx_pinconf_set,
402 .pin_config_dbg_show = imx_pinconf_dbg_show,
403 .pin_config_group_dbg_show = imx_pinconf_group_dbg_show,
406 static struct pinctrl_desc imx_pinctrl_desc = {
407 .pctlops = &imx_pctrl_ops,
408 .pmxops = &imx_pmx_ops,
409 .confops = &imx_pinconf_ops,
410 .owner = THIS_MODULE,
413 /* decode pin id and mux from pin function id got from device tree*/
414 static int imx_pinctrl_get_pin_id_and_mux(const struct imx_pinctrl_soc_info *info,
415 unsigned int pin_func_id, unsigned int *pin_id,
418 if (pin_func_id > info->npin_regs)
421 *pin_id = info->pin_regs[pin_func_id].pid;
422 *mux = info->pin_regs[pin_func_id].mux_mode;
427 static int __devinit imx_pinctrl_parse_groups(struct device_node *np,
428 struct imx_pin_group *grp,
429 struct imx_pinctrl_soc_info *info,
432 unsigned int pin_func_id;
434 const const __be32 *list;
438 dev_dbg(info->dev, "group(%d): %s\n", index, np->name);
440 /* Initialise group */
441 grp->name = np->name;
444 * the binding format is fsl,pins = <PIN_FUNC_ID CONFIG ...>,
445 * do sanity check and calculate pins number
447 list = of_get_property(np, "fsl,pins", &size);
448 /* we do not check return since it's safe node passed down */
449 size /= sizeof(*list);
450 if (!size || size % 2) {
451 dev_err(info->dev, "wrong pins number or pins and configs should be pairs\n");
455 grp->npins = size / 2;
456 grp->pins = devm_kzalloc(info->dev, grp->npins * sizeof(unsigned int),
458 grp->mux_mode = devm_kzalloc(info->dev, grp->npins * sizeof(unsigned int),
460 grp->configs = devm_kzalloc(info->dev, grp->npins * sizeof(unsigned long),
462 for (i = 0, j = 0; i < size; i += 2, j++) {
463 pin_func_id = be32_to_cpu(*list++);
464 ret = imx_pinctrl_get_pin_id_and_mux(info, pin_func_id,
465 &grp->pins[j], &grp->mux_mode[j]);
467 dev_err(info->dev, "get invalid pin function id\n");
470 /* SION bit is in mux register */
471 config = be32_to_cpu(*list++);
472 if (config & IMX_PAD_SION)
473 grp->mux_mode[j] |= IOMUXC_CONFIG_SION;
474 grp->configs[j] = config & ~IMX_PAD_SION;
477 IMX_PMX_DUMP(info, grp->pins, grp->mux_mode, grp->configs, grp->npins);
482 static int __devinit imx_pinctrl_parse_functions(struct device_node *np,
483 struct imx_pinctrl_soc_info *info, u32 index)
485 struct device_node *child;
486 struct imx_pmx_func *func;
487 struct imx_pin_group *grp;
489 static u32 grp_index;
492 dev_dbg(info->dev, "parse function(%d): %s\n", index, np->name);
494 func = &info->functions[index];
496 /* Initialise function */
497 func->name = np->name;
498 func->num_groups = of_get_child_count(np);
499 if (func->num_groups <= 0) {
500 dev_err(info->dev, "no groups defined\n");
503 func->groups = devm_kzalloc(info->dev,
504 func->num_groups * sizeof(char *), GFP_KERNEL);
506 for_each_child_of_node(np, child) {
507 func->groups[i] = child->name;
508 grp = &info->groups[grp_index++];
509 ret = imx_pinctrl_parse_groups(child, grp, info, i++);
517 static int __devinit imx_pinctrl_probe_dt(struct platform_device *pdev,
518 struct imx_pinctrl_soc_info *info)
520 struct device_node *np = pdev->dev.of_node;
521 struct device_node *child;
529 nfuncs = of_get_child_count(np);
531 dev_err(&pdev->dev, "no functions defined\n");
535 info->nfunctions = nfuncs;
536 info->functions = devm_kzalloc(&pdev->dev, nfuncs * sizeof(struct imx_pmx_func),
538 if (!info->functions)
542 for_each_child_of_node(np, child)
543 info->ngroups += of_get_child_count(child);
544 info->groups = devm_kzalloc(&pdev->dev, info->ngroups * sizeof(struct imx_pin_group),
549 for_each_child_of_node(np, child) {
550 ret = imx_pinctrl_parse_functions(child, info, i++);
552 dev_err(&pdev->dev, "failed to parse function\n");
560 int __devinit imx_pinctrl_probe(struct platform_device *pdev,
561 struct imx_pinctrl_soc_info *info)
563 struct imx_pinctrl *ipctl;
564 struct resource *res;
567 if (!info || !info->pins || !info->npins
568 || !info->pin_regs || !info->npin_regs) {
569 dev_err(&pdev->dev, "wrong pinctrl info\n");
572 info->dev = &pdev->dev;
574 /* Create state holders etc for this driver */
575 ipctl = devm_kzalloc(&pdev->dev, sizeof(*ipctl), GFP_KERNEL);
579 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
583 ipctl->base = devm_request_and_ioremap(&pdev->dev, res);
587 imx_pinctrl_desc.name = dev_name(&pdev->dev);
588 imx_pinctrl_desc.pins = info->pins;
589 imx_pinctrl_desc.npins = info->npins;
591 ret = imx_pinctrl_probe_dt(pdev, info);
593 dev_err(&pdev->dev, "fail to probe dt properties\n");
598 ipctl->dev = info->dev;
599 platform_set_drvdata(pdev, ipctl);
600 ipctl->pctl = pinctrl_register(&imx_pinctrl_desc, &pdev->dev, ipctl);
602 dev_err(&pdev->dev, "could not register IMX pinctrl driver\n");
606 dev_info(&pdev->dev, "initialized IMX pinctrl driver\n");
611 int __devexit imx_pinctrl_remove(struct platform_device *pdev)
613 struct imx_pinctrl *ipctl = platform_get_drvdata(pdev);
615 pinctrl_unregister(ipctl->pctl);