1 // SPDX-License-Identifier: GPL-2.0+
3 // Core driver for the imx pin controller
5 // Copyright (C) 2012 Freescale Semiconductor, Inc.
6 // Copyright (C) 2012 Linaro Ltd.
8 // Author: Dong Aisheng <dong.aisheng@linaro.org>
10 #include <linux/err.h>
11 #include <linux/init.h>
13 #include <linux/mfd/syscon.h>
15 #include <linux/of_device.h>
16 #include <linux/of_address.h>
17 #include <linux/pinctrl/machine.h>
18 #include <linux/pinctrl/pinconf.h>
19 #include <linux/pinctrl/pinctrl.h>
20 #include <linux/pinctrl/pinmux.h>
21 #include <linux/slab.h>
22 #include <linux/regmap.h>
25 #include "../pinconf.h"
26 #include "../pinmux.h"
27 #include "pinctrl-imx.h"
29 /* The bits in CONFIG cell defined in binding doc*/
30 #define IMX_NO_PAD_CTL 0x80000000 /* no pin config need */
31 #define IMX_PAD_SION 0x40000000 /* set SION */
33 static inline const struct group_desc *imx_pinctrl_find_group_by_name(
34 struct pinctrl_dev *pctldev,
37 const struct group_desc *grp = NULL;
40 for (i = 0; i < pctldev->num_groups; i++) {
41 grp = pinctrl_generic_get_group(pctldev, i);
42 if (grp && !strcmp(grp->name, name))
49 static void imx_pin_dbg_show(struct pinctrl_dev *pctldev, struct seq_file *s,
52 seq_printf(s, "%s", dev_name(pctldev->dev));
55 static int imx_dt_node_to_map(struct pinctrl_dev *pctldev,
56 struct device_node *np,
57 struct pinctrl_map **map, unsigned *num_maps)
59 struct imx_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
60 const struct group_desc *grp;
61 struct pinctrl_map *new_map;
62 struct device_node *parent;
67 * first find the group of this node and check if we need create
68 * config maps for pins
70 grp = imx_pinctrl_find_group_by_name(pctldev, np->name);
72 dev_err(ipctl->dev, "unable to find group for node %s\n",
77 for (i = 0; i < grp->num_pins; i++) {
78 struct imx_pin *pin = &((struct imx_pin *)(grp->data))[i];
80 if (!(pin->config & IMX_NO_PAD_CTL))
84 new_map = kmalloc_array(map_num, sizeof(struct pinctrl_map),
93 parent = of_get_parent(np);
98 new_map[0].type = PIN_MAP_TYPE_MUX_GROUP;
99 new_map[0].data.mux.function = parent->name;
100 new_map[0].data.mux.group = np->name;
103 /* create config map */
105 for (i = j = 0; i < grp->num_pins; i++) {
106 struct imx_pin *pin = &((struct imx_pin *)(grp->data))[i];
108 if (!(pin->config & IMX_NO_PAD_CTL)) {
109 new_map[j].type = PIN_MAP_TYPE_CONFIGS_PIN;
110 new_map[j].data.configs.group_or_pin =
111 pin_get_name(pctldev, pin->pin);
112 new_map[j].data.configs.configs = &pin->config;
113 new_map[j].data.configs.num_configs = 1;
118 dev_dbg(pctldev->dev, "maps: function %s group %s num %d\n",
119 (*map)->data.mux.function, (*map)->data.mux.group, map_num);
124 static void imx_dt_free_map(struct pinctrl_dev *pctldev,
125 struct pinctrl_map *map, unsigned num_maps)
130 static const struct pinctrl_ops imx_pctrl_ops = {
131 .get_groups_count = pinctrl_generic_get_group_count,
132 .get_group_name = pinctrl_generic_get_group_name,
133 .get_group_pins = pinctrl_generic_get_group_pins,
134 .pin_dbg_show = imx_pin_dbg_show,
135 .dt_node_to_map = imx_dt_node_to_map,
136 .dt_free_map = imx_dt_free_map,
140 static int imx_pmx_set(struct pinctrl_dev *pctldev, unsigned selector,
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_reg *pin_reg;
146 unsigned int npins, pin_id;
148 struct group_desc *grp = NULL;
149 struct function_desc *func = NULL;
152 * Configure the mux mode for each pin in the group for a specific
155 grp = pinctrl_generic_get_group(pctldev, group);
159 func = pinmux_generic_get_function(pctldev, selector);
163 npins = grp->num_pins;
165 dev_dbg(ipctl->dev, "enable function %s group %s\n",
166 func->name, grp->name);
168 for (i = 0; i < npins; i++) {
169 struct imx_pin *pin = &((struct imx_pin *)(grp->data))[i];
172 pin_reg = &ipctl->pin_regs[pin_id];
174 if (pin_reg->mux_reg == -1) {
175 dev_dbg(ipctl->dev, "Pin(%s) does not support mux function\n",
176 info->pins[pin_id].name);
180 if (info->flags & SHARE_MUX_CONF_REG) {
182 reg = readl(ipctl->base + pin_reg->mux_reg);
183 reg &= ~info->mux_mask;
184 reg |= (pin->mux_mode << info->mux_shift);
185 writel(reg, ipctl->base + pin_reg->mux_reg);
186 dev_dbg(ipctl->dev, "write: offset 0x%x val 0x%x\n",
187 pin_reg->mux_reg, reg);
189 writel(pin->mux_mode, ipctl->base + pin_reg->mux_reg);
190 dev_dbg(ipctl->dev, "write: offset 0x%x val 0x%x\n",
191 pin_reg->mux_reg, pin->mux_mode);
195 * If the select input value begins with 0xff, it's a quirky
196 * select input and the value should be interpreted as below.
198 * | 0xff | shift | width | select |
199 * It's used to work around the problem that the select
200 * input for some pin is not implemented in the select
201 * input register but in some general purpose register.
202 * We encode the select input value, width and shift of
203 * the bit field into input_val cell of pin function ID
204 * in device tree, and then decode them here for setting
205 * up the select input bits in general purpose register.
207 if (pin->input_val >> 24 == 0xff) {
208 u32 val = pin->input_val;
209 u8 select = val & 0xff;
210 u8 width = (val >> 8) & 0xff;
211 u8 shift = (val >> 16) & 0xff;
212 u32 mask = ((1 << width) - 1) << shift;
214 * The input_reg[i] here is actually some IOMUXC general
215 * purpose register, not regular select input register.
217 val = readl(ipctl->base + pin->input_reg);
219 val |= select << shift;
220 writel(val, ipctl->base + pin->input_reg);
221 } else if (pin->input_reg) {
223 * Regular select input register can never be at offset
224 * 0, and we only print register value for regular case.
226 if (ipctl->input_sel_base)
227 writel(pin->input_val, ipctl->input_sel_base +
230 writel(pin->input_val, ipctl->base +
233 "==>select_input: offset 0x%x val 0x%x\n",
234 pin->input_reg, pin->input_val);
241 struct pinmux_ops imx_pmx_ops = {
242 .get_functions_count = pinmux_generic_get_function_count,
243 .get_function_name = pinmux_generic_get_function_name,
244 .get_function_groups = pinmux_generic_get_function_groups,
245 .set_mux = imx_pmx_set,
248 /* decode generic config into raw register values */
249 static u32 imx_pinconf_decode_generic_config(struct imx_pinctrl *ipctl,
250 unsigned long *configs,
251 unsigned int num_configs)
253 const struct imx_pinctrl_soc_info *info = ipctl->info;
254 const struct imx_cfg_params_decode *decode;
255 enum pin_config_param param;
260 WARN_ON(num_configs > info->num_decodes);
262 for (i = 0; i < num_configs; i++) {
263 param = pinconf_to_config_param(configs[i]);
264 param_val = pinconf_to_config_argument(configs[i]);
265 decode = info->decodes;
266 for (j = 0; j < info->num_decodes; j++) {
267 if (param == decode->param) {
269 param_val = !param_val;
270 raw_config |= (param_val << decode->shift)
279 info->fixup(configs, num_configs, &raw_config);
284 static u32 imx_pinconf_parse_generic_config(struct device_node *np,
285 struct imx_pinctrl *ipctl)
287 const struct imx_pinctrl_soc_info *info = ipctl->info;
288 struct pinctrl_dev *pctl = ipctl->pctl;
289 unsigned int num_configs;
290 unsigned long *configs;
293 if (!info->generic_pinconf)
296 ret = pinconf_generic_parse_dt_config(np, pctl, &configs,
301 return imx_pinconf_decode_generic_config(ipctl, configs, num_configs);
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 = &ipctl->pin_regs[pin_id];
311 if (pin_reg->conf_reg == -1) {
312 dev_err(ipctl->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)
320 *config &= ~info->mux_mask;
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 = &ipctl->pin_regs[pin_id];
334 if (pin_reg->conf_reg == -1) {
335 dev_err(ipctl->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);
347 reg &= info->mux_mask;
349 writel(reg, ipctl->base + pin_reg->conf_reg);
350 dev_dbg(ipctl->dev, "write: offset 0x%x val 0x%x\n",
351 pin_reg->conf_reg, reg);
353 writel(configs[i], ipctl->base + pin_reg->conf_reg);
354 dev_dbg(ipctl->dev, "write: offset 0x%x val 0x%lx\n",
355 pin_reg->conf_reg, configs[i]);
357 } /* for each config */
362 static void imx_pinconf_dbg_show(struct pinctrl_dev *pctldev,
363 struct seq_file *s, unsigned pin_id)
365 struct imx_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
366 const struct imx_pin_reg *pin_reg = &ipctl->pin_regs[pin_id];
367 unsigned long config;
369 if (!pin_reg || pin_reg->conf_reg == -1) {
374 config = readl(ipctl->base + pin_reg->conf_reg);
375 seq_printf(s, "0x%lx", config);
378 static void imx_pinconf_group_dbg_show(struct pinctrl_dev *pctldev,
379 struct seq_file *s, unsigned group)
381 struct group_desc *grp;
382 unsigned long config;
386 if (group > pctldev->num_groups)
390 grp = pinctrl_generic_get_group(pctldev, group);
394 for (i = 0; i < grp->num_pins; i++) {
395 struct imx_pin *pin = &((struct imx_pin *)(grp->data))[i];
397 name = pin_get_name(pctldev, pin->pin);
398 ret = imx_pinconf_get(pctldev, pin->pin, &config);
401 seq_printf(s, " %s: 0x%lx\n", name, config);
405 static const struct pinconf_ops imx_pinconf_ops = {
406 .pin_config_get = imx_pinconf_get,
407 .pin_config_set = imx_pinconf_set,
408 .pin_config_dbg_show = imx_pinconf_dbg_show,
409 .pin_config_group_dbg_show = imx_pinconf_group_dbg_show,
413 * Each pin represented in fsl,pins consists of a number of u32 PIN_FUNC_ID
414 * and 1 u32 CONFIG, the total size is PIN_FUNC_ID + CONFIG for each pin.
415 * For generic_pinconf case, there's no extra u32 CONFIG.
417 * PIN_FUNC_ID format:
419 * <mux_reg conf_reg input_reg mux_mode input_val>
420 * SHARE_MUX_CONF_REG:
421 * <mux_conf_reg input_reg mux_mode input_val>
423 #define FSL_PIN_SIZE 24
424 #define FSL_PIN_SHARE_SIZE 20
426 static int imx_pinctrl_parse_groups(struct device_node *np,
427 struct group_desc *grp,
428 struct imx_pinctrl *ipctl,
431 const struct imx_pinctrl_soc_info *info = ipctl->info;
437 dev_dbg(ipctl->dev, "group(%d): %s\n", index, np->name);
439 if (info->flags & SHARE_MUX_CONF_REG)
440 pin_size = FSL_PIN_SHARE_SIZE;
442 pin_size = FSL_PIN_SIZE;
444 if (info->generic_pinconf)
447 /* Initialise group */
448 grp->name = np->name;
451 * the binding format is fsl,pins = <PIN_FUNC_ID CONFIG ...>,
452 * do sanity check and calculate pins number
454 * First try legacy 'fsl,pins' property, then fall back to the
457 * Note: for generic 'pinmux' case, there's no CONFIG part in
458 * the binding format.
460 list = of_get_property(np, "fsl,pins", &size);
462 list = of_get_property(np, "pinmux", &size);
465 "no fsl,pins and pins property in node %pOF\n", np);
470 /* we do not check return since it's safe node passed down */
471 if (!size || size % pin_size) {
472 dev_err(ipctl->dev, "Invalid fsl,pins or pins property in node %pOF\n", np);
476 /* first try to parse the generic pin config */
477 config = imx_pinconf_parse_generic_config(np, ipctl);
479 grp->num_pins = size / pin_size;
480 grp->data = devm_kzalloc(ipctl->dev, grp->num_pins *
481 sizeof(struct imx_pin), GFP_KERNEL);
482 grp->pins = devm_kzalloc(ipctl->dev, grp->num_pins *
483 sizeof(unsigned int), GFP_KERNEL);
484 if (!grp->pins || !grp->data)
487 for (i = 0; i < grp->num_pins; i++) {
488 u32 mux_reg = be32_to_cpu(*list++);
491 struct imx_pin_reg *pin_reg;
492 struct imx_pin *pin = &((struct imx_pin *)(grp->data))[i];
494 if (!(info->flags & ZERO_OFFSET_VALID) && !mux_reg)
497 if (info->flags & SHARE_MUX_CONF_REG) {
500 conf_reg = be32_to_cpu(*list++);
505 pin_id = (mux_reg != -1) ? mux_reg / 4 : conf_reg / 4;
506 pin_reg = &ipctl->pin_regs[pin_id];
508 grp->pins[i] = pin_id;
509 pin_reg->mux_reg = mux_reg;
510 pin_reg->conf_reg = conf_reg;
511 pin->input_reg = be32_to_cpu(*list++);
512 pin->mux_mode = be32_to_cpu(*list++);
513 pin->input_val = be32_to_cpu(*list++);
515 if (info->generic_pinconf) {
516 /* generic pin config decoded */
517 pin->config = config;
519 /* legacy pin config read from devicetree */
520 config = be32_to_cpu(*list++);
522 /* SION bit is in mux register */
523 if (config & IMX_PAD_SION)
524 pin->mux_mode |= IOMUXC_CONFIG_SION;
525 pin->config = config & ~IMX_PAD_SION;
528 dev_dbg(ipctl->dev, "%s: 0x%x 0x%08lx", info->pins[pin_id].name,
529 pin->mux_mode, pin->config);
535 static int imx_pinctrl_parse_functions(struct device_node *np,
536 struct imx_pinctrl *ipctl,
539 struct pinctrl_dev *pctl = ipctl->pctl;
540 struct device_node *child;
541 struct function_desc *func;
542 struct group_desc *grp;
545 dev_dbg(pctl->dev, "parse function(%d): %s\n", index, np->name);
547 func = pinmux_generic_get_function(pctl, index);
551 /* Initialise function */
552 func->name = np->name;
553 func->num_group_names = of_get_child_count(np);
554 if (func->num_group_names == 0) {
555 dev_err(ipctl->dev, "no groups defined in %pOF\n", np);
558 func->group_names = devm_kcalloc(ipctl->dev, func->num_group_names,
559 sizeof(char *), GFP_KERNEL);
560 if (!func->group_names)
563 for_each_child_of_node(np, child) {
564 func->group_names[i] = child->name;
566 grp = devm_kzalloc(ipctl->dev, sizeof(struct group_desc),
571 mutex_lock(&ipctl->mutex);
572 radix_tree_insert(&pctl->pin_group_tree,
573 ipctl->group_index++, grp);
574 mutex_unlock(&ipctl->mutex);
576 imx_pinctrl_parse_groups(child, grp, ipctl, i++);
583 * Check if the DT contains pins in the direct child nodes. This indicates the
584 * newer DT format to store pins. This function returns true if the first found
585 * fsl,pins property is in a child of np. Otherwise false is returned.
587 static bool imx_pinctrl_dt_is_flat_functions(struct device_node *np)
589 struct device_node *function_np;
590 struct device_node *pinctrl_np;
592 for_each_child_of_node(np, function_np) {
593 if (of_property_read_bool(function_np, "fsl,pins"))
596 for_each_child_of_node(function_np, pinctrl_np) {
597 if (of_property_read_bool(pinctrl_np, "fsl,pins"))
605 static int imx_pinctrl_probe_dt(struct platform_device *pdev,
606 struct imx_pinctrl *ipctl)
608 struct device_node *np = pdev->dev.of_node;
609 struct device_node *child;
610 struct pinctrl_dev *pctl = ipctl->pctl;
618 flat_funcs = imx_pinctrl_dt_is_flat_functions(np);
622 nfuncs = of_get_child_count(np);
624 dev_err(&pdev->dev, "no functions defined\n");
629 for (i = 0; i < nfuncs; i++) {
630 struct function_desc *function;
632 function = devm_kzalloc(&pdev->dev, sizeof(*function),
637 mutex_lock(&ipctl->mutex);
638 radix_tree_insert(&pctl->pin_function_tree, i, function);
639 mutex_unlock(&ipctl->mutex);
641 pctl->num_functions = nfuncs;
643 ipctl->group_index = 0;
645 pctl->num_groups = of_get_child_count(np);
647 pctl->num_groups = 0;
648 for_each_child_of_node(np, child)
649 pctl->num_groups += of_get_child_count(child);
653 imx_pinctrl_parse_functions(np, ipctl, 0);
656 for_each_child_of_node(np, child)
657 imx_pinctrl_parse_functions(child, ipctl, i++);
664 * imx_free_resources() - free memory used by this driver
665 * @info: info driver instance
667 static void imx_free_resources(struct imx_pinctrl *ipctl)
670 pinctrl_unregister(ipctl->pctl);
673 int imx_pinctrl_probe(struct platform_device *pdev,
674 const struct imx_pinctrl_soc_info *info)
676 struct regmap_config config = { .name = "gpr" };
677 struct device_node *dev_np = pdev->dev.of_node;
678 struct pinctrl_desc *imx_pinctrl_desc;
679 struct device_node *np;
680 struct imx_pinctrl *ipctl;
681 struct resource *res;
685 if (!info || !info->pins || !info->npins) {
686 dev_err(&pdev->dev, "wrong pinctrl info\n");
690 if (info->gpr_compatible) {
691 gpr = syscon_regmap_lookup_by_compatible(info->gpr_compatible);
693 regmap_attach_dev(&pdev->dev, gpr, &config);
696 /* Create state holders etc for this driver */
697 ipctl = devm_kzalloc(&pdev->dev, sizeof(*ipctl), GFP_KERNEL);
701 ipctl->pin_regs = devm_kmalloc(&pdev->dev, sizeof(*ipctl->pin_regs) *
702 info->npins, GFP_KERNEL);
703 if (!ipctl->pin_regs)
706 for (i = 0; i < info->npins; i++) {
707 ipctl->pin_regs[i].mux_reg = -1;
708 ipctl->pin_regs[i].conf_reg = -1;
711 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
712 ipctl->base = devm_ioremap_resource(&pdev->dev, res);
713 if (IS_ERR(ipctl->base))
714 return PTR_ERR(ipctl->base);
716 if (of_property_read_bool(dev_np, "fsl,input-sel")) {
717 np = of_parse_phandle(dev_np, "fsl,input-sel", 0);
719 dev_err(&pdev->dev, "iomuxc fsl,input-sel property not found\n");
723 ipctl->input_sel_base = of_iomap(np, 0);
725 if (!ipctl->input_sel_base) {
727 "iomuxc input select base address not found\n");
732 imx_pinctrl_desc = devm_kzalloc(&pdev->dev, sizeof(*imx_pinctrl_desc),
734 if (!imx_pinctrl_desc)
737 imx_pinctrl_desc->name = dev_name(&pdev->dev);
738 imx_pinctrl_desc->pins = info->pins;
739 imx_pinctrl_desc->npins = info->npins;
740 imx_pinctrl_desc->pctlops = &imx_pctrl_ops;
741 imx_pinctrl_desc->pmxops = &imx_pmx_ops;
742 imx_pinctrl_desc->confops = &imx_pinconf_ops;
743 imx_pinctrl_desc->owner = THIS_MODULE;
745 /* for generic pinconf */
746 imx_pinctrl_desc->custom_params = info->custom_params;
747 imx_pinctrl_desc->num_custom_params = info->num_custom_params;
749 /* platform specific callback */
750 imx_pmx_ops.gpio_set_direction = info->gpio_set_direction;
752 mutex_init(&ipctl->mutex);
755 ipctl->dev = &pdev->dev;
756 platform_set_drvdata(pdev, ipctl);
757 ret = devm_pinctrl_register_and_init(&pdev->dev,
758 imx_pinctrl_desc, ipctl,
761 dev_err(&pdev->dev, "could not register IMX pinctrl driver\n");
765 ret = imx_pinctrl_probe_dt(pdev, ipctl);
767 dev_err(&pdev->dev, "fail to probe dt properties\n");
771 dev_info(&pdev->dev, "initialized IMX pinctrl driver\n");
773 return pinctrl_enable(ipctl->pctl);
776 imx_free_resources(ipctl);