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 /* The bits in CONFIG cell defined in binding doc*/
31 #define IMX_NO_PAD_CTL 0x80000000 /* no pin config need */
32 #define IMX_PAD_SION 0x40000000 /* set SION */
35 * @dev: a pointer back to containing device
36 * @base: the offset to the controller in virtual memory
40 struct pinctrl_dev
*pctl
;
42 const struct imx_pinctrl_soc_info
*info
;
45 static const inline struct imx_pin_group
*imx_pinctrl_find_group_by_name(
46 const struct imx_pinctrl_soc_info
*info
,
49 const struct imx_pin_group
*grp
= NULL
;
52 for (i
= 0; i
< info
->ngroups
; i
++) {
53 if (!strcmp(info
->groups
[i
].name
, name
)) {
54 grp
= &info
->groups
[i
];
62 static int imx_get_groups_count(struct pinctrl_dev
*pctldev
)
64 struct imx_pinctrl
*ipctl
= pinctrl_dev_get_drvdata(pctldev
);
65 const struct imx_pinctrl_soc_info
*info
= ipctl
->info
;
70 static const char *imx_get_group_name(struct pinctrl_dev
*pctldev
,
73 struct imx_pinctrl
*ipctl
= pinctrl_dev_get_drvdata(pctldev
);
74 const struct imx_pinctrl_soc_info
*info
= ipctl
->info
;
76 return info
->groups
[selector
].name
;
79 static int imx_get_group_pins(struct pinctrl_dev
*pctldev
, unsigned selector
,
80 const unsigned **pins
,
83 struct imx_pinctrl
*ipctl
= pinctrl_dev_get_drvdata(pctldev
);
84 const struct imx_pinctrl_soc_info
*info
= ipctl
->info
;
86 if (selector
>= info
->ngroups
)
89 *pins
= info
->groups
[selector
].pin_ids
;
90 *npins
= info
->groups
[selector
].npins
;
95 static void imx_pin_dbg_show(struct pinctrl_dev
*pctldev
, struct seq_file
*s
,
98 seq_printf(s
, "%s", dev_name(pctldev
->dev
));
101 static int imx_dt_node_to_map(struct pinctrl_dev
*pctldev
,
102 struct device_node
*np
,
103 struct pinctrl_map
**map
, unsigned *num_maps
)
105 struct imx_pinctrl
*ipctl
= pinctrl_dev_get_drvdata(pctldev
);
106 const struct imx_pinctrl_soc_info
*info
= ipctl
->info
;
107 const struct imx_pin_group
*grp
;
108 struct pinctrl_map
*new_map
;
109 struct device_node
*parent
;
114 * first find the group of this node and check if we need create
115 * config maps for pins
117 grp
= imx_pinctrl_find_group_by_name(info
, np
->name
);
119 dev_err(info
->dev
, "unable to find group for node %s\n",
124 for (i
= 0; i
< grp
->npins
; i
++) {
125 if (!(grp
->pins
[i
].config
& IMX_NO_PAD_CTL
))
129 new_map
= kmalloc(sizeof(struct pinctrl_map
) * map_num
, GFP_KERNEL
);
137 parent
= of_get_parent(np
);
142 new_map
[0].type
= PIN_MAP_TYPE_MUX_GROUP
;
143 new_map
[0].data
.mux
.function
= parent
->name
;
144 new_map
[0].data
.mux
.group
= np
->name
;
147 /* create config map */
149 for (i
= j
= 0; i
< grp
->npins
; i
++) {
150 if (!(grp
->pins
[i
].config
& IMX_NO_PAD_CTL
)) {
151 new_map
[j
].type
= PIN_MAP_TYPE_CONFIGS_PIN
;
152 new_map
[j
].data
.configs
.group_or_pin
=
153 pin_get_name(pctldev
, grp
->pins
[i
].pin
);
154 new_map
[j
].data
.configs
.configs
= &grp
->pins
[i
].config
;
155 new_map
[j
].data
.configs
.num_configs
= 1;
160 dev_dbg(pctldev
->dev
, "maps: function %s group %s num %d\n",
161 (*map
)->data
.mux
.function
, (*map
)->data
.mux
.group
, map_num
);
166 static void imx_dt_free_map(struct pinctrl_dev
*pctldev
,
167 struct pinctrl_map
*map
, unsigned num_maps
)
172 static const struct pinctrl_ops imx_pctrl_ops
= {
173 .get_groups_count
= imx_get_groups_count
,
174 .get_group_name
= imx_get_group_name
,
175 .get_group_pins
= imx_get_group_pins
,
176 .pin_dbg_show
= imx_pin_dbg_show
,
177 .dt_node_to_map
= imx_dt_node_to_map
,
178 .dt_free_map
= imx_dt_free_map
,
182 static int imx_pmx_enable(struct pinctrl_dev
*pctldev
, unsigned selector
,
185 struct imx_pinctrl
*ipctl
= pinctrl_dev_get_drvdata(pctldev
);
186 const struct imx_pinctrl_soc_info
*info
= ipctl
->info
;
187 const struct imx_pin_reg
*pin_reg
;
188 unsigned int npins
, pin_id
;
190 struct imx_pin_group
*grp
;
193 * Configure the mux mode for each pin in the group for a specific
196 grp
= &info
->groups
[group
];
199 dev_dbg(ipctl
->dev
, "enable function %s group %s\n",
200 info
->functions
[selector
].name
, grp
->name
);
202 for (i
= 0; i
< npins
; i
++) {
203 struct imx_pin
*pin
= &grp
->pins
[i
];
205 pin_reg
= &info
->pin_regs
[pin_id
];
207 if (!(info
->flags
& ZERO_OFFSET_VALID
) && !pin_reg
->mux_reg
) {
208 dev_err(ipctl
->dev
, "Pin(%s) does not support mux function\n",
209 info
->pins
[pin_id
].name
);
213 if (info
->flags
& SHARE_MUX_CONF_REG
) {
215 reg
= readl(ipctl
->base
+ pin_reg
->mux_reg
);
217 reg
|= (pin
->mux_mode
<< 20);
218 writel(reg
, ipctl
->base
+ pin_reg
->mux_reg
);
220 writel(pin
->mux_mode
, ipctl
->base
+ pin_reg
->mux_reg
);
222 dev_dbg(ipctl
->dev
, "write: offset 0x%x val 0x%x\n",
223 pin_reg
->mux_reg
, pin
->mux_mode
);
226 * If the select input value begins with 0xff, it's a quirky
227 * select input and the value should be interpreted as below.
229 * | 0xff | shift | width | select |
230 * It's used to work around the problem that the select
231 * input for some pin is not implemented in the select
232 * input register but in some general purpose register.
233 * We encode the select input value, width and shift of
234 * the bit field into input_val cell of pin function ID
235 * in device tree, and then decode them here for setting
236 * up the select input bits in general purpose register.
238 if (pin
->input_val
>> 24 == 0xff) {
239 u32 val
= pin
->input_val
;
240 u8 select
= val
& 0xff;
241 u8 width
= (val
>> 8) & 0xff;
242 u8 shift
= (val
>> 16) & 0xff;
243 u32 mask
= ((1 << width
) - 1) << shift
;
245 * The input_reg[i] here is actually some IOMUXC general
246 * purpose register, not regular select input register.
248 val
= readl(ipctl
->base
+ pin
->input_reg
);
250 val
|= select
<< shift
;
251 writel(val
, ipctl
->base
+ pin
->input_reg
);
252 } else if (pin
->input_reg
) {
254 * Regular select input register can never be at offset
255 * 0, and we only print register value for regular case.
257 writel(pin
->input_val
, ipctl
->base
+ pin
->input_reg
);
259 "==>select_input: offset 0x%x val 0x%x\n",
260 pin
->input_reg
, pin
->input_val
);
267 static int imx_pmx_get_funcs_count(struct pinctrl_dev
*pctldev
)
269 struct imx_pinctrl
*ipctl
= pinctrl_dev_get_drvdata(pctldev
);
270 const struct imx_pinctrl_soc_info
*info
= ipctl
->info
;
272 return info
->nfunctions
;
275 static const char *imx_pmx_get_func_name(struct pinctrl_dev
*pctldev
,
278 struct imx_pinctrl
*ipctl
= pinctrl_dev_get_drvdata(pctldev
);
279 const struct imx_pinctrl_soc_info
*info
= ipctl
->info
;
281 return info
->functions
[selector
].name
;
284 static int imx_pmx_get_groups(struct pinctrl_dev
*pctldev
, unsigned selector
,
285 const char * const **groups
,
286 unsigned * const num_groups
)
288 struct imx_pinctrl
*ipctl
= pinctrl_dev_get_drvdata(pctldev
);
289 const struct imx_pinctrl_soc_info
*info
= ipctl
->info
;
291 *groups
= info
->functions
[selector
].groups
;
292 *num_groups
= info
->functions
[selector
].num_groups
;
297 static const struct pinmux_ops imx_pmx_ops
= {
298 .get_functions_count
= imx_pmx_get_funcs_count
,
299 .get_function_name
= imx_pmx_get_func_name
,
300 .get_function_groups
= imx_pmx_get_groups
,
301 .enable
= imx_pmx_enable
,
304 static int imx_pinconf_get(struct pinctrl_dev
*pctldev
,
305 unsigned pin_id
, unsigned long *config
)
307 struct imx_pinctrl
*ipctl
= pinctrl_dev_get_drvdata(pctldev
);
308 const struct imx_pinctrl_soc_info
*info
= ipctl
->info
;
309 const struct imx_pin_reg
*pin_reg
= &info
->pin_regs
[pin_id
];
311 if (!(info
->flags
& ZERO_OFFSET_VALID
) && !pin_reg
->conf_reg
) {
312 dev_err(info
->dev
, "Pin(%s) does not support config function\n",
313 info
->pins
[pin_id
].name
);
317 *config
= readl(ipctl
->base
+ pin_reg
->conf_reg
);
319 if (info
->flags
& SHARE_MUX_CONF_REG
)
325 static int imx_pinconf_set(struct pinctrl_dev
*pctldev
,
326 unsigned pin_id
, unsigned long *configs
,
327 unsigned num_configs
)
329 struct imx_pinctrl
*ipctl
= pinctrl_dev_get_drvdata(pctldev
);
330 const struct imx_pinctrl_soc_info
*info
= ipctl
->info
;
331 const struct imx_pin_reg
*pin_reg
= &info
->pin_regs
[pin_id
];
334 if (!(info
->flags
& ZERO_OFFSET_VALID
) && !pin_reg
->conf_reg
) {
335 dev_err(info
->dev
, "Pin(%s) does not support config function\n",
336 info
->pins
[pin_id
].name
);
340 dev_dbg(ipctl
->dev
, "pinconf set pin %s\n",
341 info
->pins
[pin_id
].name
);
343 for (i
= 0; i
< num_configs
; i
++) {
344 if (info
->flags
& SHARE_MUX_CONF_REG
) {
346 reg
= readl(ipctl
->base
+ pin_reg
->conf_reg
);
349 writel(reg
, ipctl
->base
+ pin_reg
->conf_reg
);
351 writel(configs
[i
], ipctl
->base
+ pin_reg
->conf_reg
);
353 dev_dbg(ipctl
->dev
, "write: offset 0x%x val 0x%lx\n",
354 pin_reg
->conf_reg
, configs
[i
]);
355 } /* for each config */
360 static void imx_pinconf_dbg_show(struct pinctrl_dev
*pctldev
,
361 struct seq_file
*s
, unsigned pin_id
)
363 struct imx_pinctrl
*ipctl
= pinctrl_dev_get_drvdata(pctldev
);
364 const struct imx_pinctrl_soc_info
*info
= ipctl
->info
;
365 const struct imx_pin_reg
*pin_reg
= &info
->pin_regs
[pin_id
];
366 unsigned long config
;
368 if (!pin_reg
|| !pin_reg
->conf_reg
) {
369 seq_printf(s
, "N/A");
373 config
= readl(ipctl
->base
+ pin_reg
->conf_reg
);
374 seq_printf(s
, "0x%lx", config
);
377 static void imx_pinconf_group_dbg_show(struct pinctrl_dev
*pctldev
,
378 struct seq_file
*s
, unsigned group
)
380 struct imx_pinctrl
*ipctl
= pinctrl_dev_get_drvdata(pctldev
);
381 const struct imx_pinctrl_soc_info
*info
= ipctl
->info
;
382 struct imx_pin_group
*grp
;
383 unsigned long config
;
387 if (group
> info
->ngroups
)
391 grp
= &info
->groups
[group
];
392 for (i
= 0; i
< grp
->npins
; i
++) {
393 struct imx_pin
*pin
= &grp
->pins
[i
];
394 name
= pin_get_name(pctldev
, pin
->pin
);
395 ret
= imx_pinconf_get(pctldev
, pin
->pin
, &config
);
398 seq_printf(s
, "%s: 0x%lx", name
, config
);
402 static const struct pinconf_ops imx_pinconf_ops
= {
403 .pin_config_get
= imx_pinconf_get
,
404 .pin_config_set
= imx_pinconf_set
,
405 .pin_config_dbg_show
= imx_pinconf_dbg_show
,
406 .pin_config_group_dbg_show
= imx_pinconf_group_dbg_show
,
409 static struct pinctrl_desc imx_pinctrl_desc
= {
410 .pctlops
= &imx_pctrl_ops
,
411 .pmxops
= &imx_pmx_ops
,
412 .confops
= &imx_pinconf_ops
,
413 .owner
= THIS_MODULE
,
417 * Each pin represented in fsl,pins consists of 5 u32 PIN_FUNC_ID and
418 * 1 u32 CONFIG, so 24 types in total for each pin.
420 #define FSL_PIN_SIZE 24
421 #define SHARE_FSL_PIN_SIZE 20
423 static int imx_pinctrl_parse_groups(struct device_node
*np
,
424 struct imx_pin_group
*grp
,
425 struct imx_pinctrl_soc_info
*info
,
433 dev_dbg(info
->dev
, "group(%d): %s\n", index
, np
->name
);
435 if (info
->flags
& SHARE_MUX_CONF_REG
)
436 pin_size
= SHARE_FSL_PIN_SIZE
;
438 pin_size
= FSL_PIN_SIZE
;
439 /* Initialise group */
440 grp
->name
= np
->name
;
443 * the binding format is fsl,pins = <PIN_FUNC_ID CONFIG ...>,
444 * do sanity check and calculate pins number
446 list
= of_get_property(np
, "fsl,pins", &size
);
448 dev_err(info
->dev
, "no fsl,pins property in node %s\n", np
->full_name
);
452 /* we do not check return since it's safe node passed down */
453 if (!size
|| size
% pin_size
) {
454 dev_err(info
->dev
, "Invalid fsl,pins property in node %s\n", np
->full_name
);
458 grp
->npins
= size
/ pin_size
;
459 grp
->pins
= devm_kzalloc(info
->dev
, grp
->npins
* sizeof(struct imx_pin
),
461 grp
->pin_ids
= devm_kzalloc(info
->dev
, grp
->npins
* sizeof(unsigned int),
463 if (!grp
->pins
|| ! grp
->pin_ids
)
466 for (i
= 0; i
< grp
->npins
; i
++) {
467 u32 mux_reg
= be32_to_cpu(*list
++);
470 struct imx_pin_reg
*pin_reg
;
471 struct imx_pin
*pin
= &grp
->pins
[i
];
473 if (info
->flags
& SHARE_MUX_CONF_REG
)
476 conf_reg
= be32_to_cpu(*list
++);
478 pin_id
= mux_reg
? mux_reg
/ 4 : conf_reg
/ 4;
479 pin_reg
= &info
->pin_regs
[pin_id
];
481 grp
->pin_ids
[i
] = pin_id
;
482 pin_reg
->mux_reg
= mux_reg
;
483 pin_reg
->conf_reg
= conf_reg
;
484 pin
->input_reg
= be32_to_cpu(*list
++);
485 pin
->mux_mode
= be32_to_cpu(*list
++);
486 pin
->input_val
= be32_to_cpu(*list
++);
488 /* SION bit is in mux register */
489 config
= be32_to_cpu(*list
++);
490 if (config
& IMX_PAD_SION
)
491 pin
->mux_mode
|= IOMUXC_CONFIG_SION
;
492 pin
->config
= config
& ~IMX_PAD_SION
;
494 dev_dbg(info
->dev
, "%s: %d 0x%08lx", info
->pins
[i
].name
,
495 pin
->mux_mode
, pin
->config
);
501 static int imx_pinctrl_parse_functions(struct device_node
*np
,
502 struct imx_pinctrl_soc_info
*info
,
505 struct device_node
*child
;
506 struct imx_pmx_func
*func
;
507 struct imx_pin_group
*grp
;
508 static u32 grp_index
;
511 dev_dbg(info
->dev
, "parse function(%d): %s\n", index
, np
->name
);
513 func
= &info
->functions
[index
];
515 /* Initialise function */
516 func
->name
= np
->name
;
517 func
->num_groups
= of_get_child_count(np
);
518 if (func
->num_groups
<= 0) {
519 dev_err(info
->dev
, "no groups defined in %s\n", np
->full_name
);
522 func
->groups
= devm_kzalloc(info
->dev
,
523 func
->num_groups
* sizeof(char *), GFP_KERNEL
);
525 for_each_child_of_node(np
, child
) {
526 func
->groups
[i
] = child
->name
;
527 grp
= &info
->groups
[grp_index
++];
528 imx_pinctrl_parse_groups(child
, grp
, info
, i
++);
534 static int imx_pinctrl_probe_dt(struct platform_device
*pdev
,
535 struct imx_pinctrl_soc_info
*info
)
537 struct device_node
*np
= pdev
->dev
.of_node
;
538 struct device_node
*child
;
545 nfuncs
= of_get_child_count(np
);
547 dev_err(&pdev
->dev
, "no functions defined\n");
551 info
->nfunctions
= nfuncs
;
552 info
->functions
= devm_kzalloc(&pdev
->dev
, nfuncs
* sizeof(struct imx_pmx_func
),
554 if (!info
->functions
)
558 for_each_child_of_node(np
, child
)
559 info
->ngroups
+= of_get_child_count(child
);
560 info
->groups
= devm_kzalloc(&pdev
->dev
, info
->ngroups
* sizeof(struct imx_pin_group
),
565 for_each_child_of_node(np
, child
)
566 imx_pinctrl_parse_functions(child
, info
, i
++);
571 int imx_pinctrl_probe(struct platform_device
*pdev
,
572 struct imx_pinctrl_soc_info
*info
)
574 struct imx_pinctrl
*ipctl
;
575 struct resource
*res
;
578 if (!info
|| !info
->pins
|| !info
->npins
) {
579 dev_err(&pdev
->dev
, "wrong pinctrl info\n");
582 info
->dev
= &pdev
->dev
;
584 /* Create state holders etc for this driver */
585 ipctl
= devm_kzalloc(&pdev
->dev
, sizeof(*ipctl
), GFP_KERNEL
);
589 info
->pin_regs
= devm_kzalloc(&pdev
->dev
, sizeof(*info
->pin_regs
) *
590 info
->npins
, GFP_KERNEL
);
594 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
595 ipctl
->base
= devm_ioremap_resource(&pdev
->dev
, res
);
596 if (IS_ERR(ipctl
->base
))
597 return PTR_ERR(ipctl
->base
);
599 imx_pinctrl_desc
.name
= dev_name(&pdev
->dev
);
600 imx_pinctrl_desc
.pins
= info
->pins
;
601 imx_pinctrl_desc
.npins
= info
->npins
;
603 ret
= imx_pinctrl_probe_dt(pdev
, info
);
605 dev_err(&pdev
->dev
, "fail to probe dt properties\n");
610 ipctl
->dev
= info
->dev
;
611 platform_set_drvdata(pdev
, ipctl
);
612 ipctl
->pctl
= pinctrl_register(&imx_pinctrl_desc
, &pdev
->dev
, ipctl
);
614 dev_err(&pdev
->dev
, "could not register IMX pinctrl driver\n");
618 dev_info(&pdev
->dev
, "initialized IMX pinctrl driver\n");
623 int imx_pinctrl_remove(struct platform_device
*pdev
)
625 struct imx_pinctrl
*ipctl
= platform_get_drvdata(pdev
);
627 pinctrl_unregister(ipctl
->pctl
);