1 // SPDX-License-Identifier: GPL-2.0+
3 // Core driver for the imx pin controller in imx1/21/27
5 // Copyright (C) 2013 Pengutronix
8 // Based on pinctrl-imx.c:
10 // Copyright (C) 2012 Freescale Semiconductor, Inc.
11 // Copyright (C) 2012 Linaro Ltd.
13 #include <linux/bitops.h>
14 #include <linux/err.h>
15 #include <linux/init.h>
18 #include <linux/of_device.h>
19 #include <linux/seq_file.h>
20 #include <linux/slab.h>
22 #include <linux/pinctrl/machine.h>
23 #include <linux/pinctrl/pinconf.h>
24 #include <linux/pinctrl/pinctrl.h>
25 #include <linux/pinctrl/pinmux.h>
28 #include "pinctrl-imx1.h"
32 struct pinctrl_dev *pctl;
34 const struct imx1_pinctrl_soc_info *info;
38 * MX1 register offsets
43 #define MX1_ICONFA 0x0c
44 #define MX1_ICONFB 0x14
49 #define MX1_PORT_STRIDE 0x100
53 * MUX_ID format defines
55 #define MX1_MUX_FUNCTION(val) (BIT(0) & val)
56 #define MX1_MUX_GPIO(val) ((BIT(1) & val) >> 1)
57 #define MX1_MUX_DIR(val) ((BIT(2) & val) >> 2)
58 #define MX1_MUX_OCONF(val) (((BIT(4) | BIT(5)) & val) >> 4)
59 #define MX1_MUX_ICONFA(val) (((BIT(8) | BIT(9)) & val) >> 8)
60 #define MX1_MUX_ICONFB(val) (((BIT(10) | BIT(11)) & val) >> 10)
64 * IMX1 IOMUXC manages the pins based on ports. Each port has 32 pins. IOMUX
65 * control registers are separated into function, output configuration, input
66 * configuration A, input configuration B, GPIO in use and data direction.
68 * Those controls that are represented by 1 bit have a direct mapping between
69 * bit position and pin id. If they are represented by 2 bit, the lower 16 pins
70 * are in the first register and the upper 16 pins in the second (next)
71 * register. pin_id is stored in bit (pin_id%16)*2 and the bit above.
75 * Calculates the register offset from a pin_id
77 static void __iomem *imx1_mem(struct imx1_pinctrl *ipctl, unsigned int pin_id)
79 unsigned int port = pin_id / 32;
80 return ipctl->base + port * MX1_PORT_STRIDE;
84 * Write to a register with 2 bits per pin. The function will automatically
85 * use the next register if the pin is managed in the second register.
87 static void imx1_write_2bit(struct imx1_pinctrl *ipctl, unsigned int pin_id,
88 u32 value, u32 reg_offset)
90 void __iomem *reg = imx1_mem(ipctl, pin_id) + reg_offset;
91 int offset = (pin_id % 16) * 2; /* offset, regardless of register used */
92 int mask = ~(0x3 << offset); /* Mask for 2 bits at offset */
96 /* Use the next register if the pin's port pin number is >=16 */
97 if (pin_id % 32 >= 16)
100 dev_dbg(ipctl->dev, "write: register 0x%p offset %d value 0x%x\n",
103 /* Get current state of pins */
104 old_val = readl(reg);
107 new_val = value & 0x3; /* Make sure value is really 2 bit */
109 new_val |= old_val;/* Set new state for pin_id */
111 writel(new_val, reg);
114 static void imx1_write_bit(struct imx1_pinctrl *ipctl, unsigned int pin_id,
115 u32 value, u32 reg_offset)
117 void __iomem *reg = imx1_mem(ipctl, pin_id) + reg_offset;
118 int offset = pin_id % 32;
119 int mask = ~BIT_MASK(offset);
123 /* Get current state of pins */
124 old_val = readl(reg);
127 new_val = value & 0x1; /* Make sure value is really 1 bit */
129 new_val |= old_val;/* Set new state for pin_id */
131 writel(new_val, reg);
134 static int imx1_read_2bit(struct imx1_pinctrl *ipctl, unsigned int pin_id,
137 void __iomem *reg = imx1_mem(ipctl, pin_id) + reg_offset;
138 int offset = (pin_id % 16) * 2;
140 /* Use the next register if the pin's port pin number is >=16 */
141 if (pin_id % 32 >= 16)
144 return (readl(reg) & (BIT(offset) | BIT(offset+1))) >> offset;
147 static int imx1_read_bit(struct imx1_pinctrl *ipctl, unsigned int pin_id,
150 void __iomem *reg = imx1_mem(ipctl, pin_id) + reg_offset;
151 int offset = pin_id % 32;
153 return !!(readl(reg) & BIT(offset));
156 static inline const struct imx1_pin_group *imx1_pinctrl_find_group_by_name(
157 const struct imx1_pinctrl_soc_info *info,
160 const struct imx1_pin_group *grp = NULL;
163 for (i = 0; i < info->ngroups; i++) {
164 if (!strcmp(info->groups[i].name, name)) {
165 grp = &info->groups[i];
173 static int imx1_get_groups_count(struct pinctrl_dev *pctldev)
175 struct imx1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
176 const struct imx1_pinctrl_soc_info *info = ipctl->info;
178 return info->ngroups;
181 static const char *imx1_get_group_name(struct pinctrl_dev *pctldev,
184 struct imx1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
185 const struct imx1_pinctrl_soc_info *info = ipctl->info;
187 return info->groups[selector].name;
190 static int imx1_get_group_pins(struct pinctrl_dev *pctldev, unsigned selector,
191 const unsigned int **pins,
194 struct imx1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
195 const struct imx1_pinctrl_soc_info *info = ipctl->info;
197 if (selector >= info->ngroups)
200 *pins = info->groups[selector].pin_ids;
201 *npins = info->groups[selector].npins;
206 static void imx1_pin_dbg_show(struct pinctrl_dev *pctldev, struct seq_file *s,
209 struct imx1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
211 seq_printf(s, "GPIO %d, function %d, direction %d, oconf %d, iconfa %d, iconfb %d",
212 imx1_read_bit(ipctl, offset, MX1_GIUS),
213 imx1_read_bit(ipctl, offset, MX1_GPR),
214 imx1_read_bit(ipctl, offset, MX1_DDIR),
215 imx1_read_2bit(ipctl, offset, MX1_OCR),
216 imx1_read_2bit(ipctl, offset, MX1_ICONFA),
217 imx1_read_2bit(ipctl, offset, MX1_ICONFB));
220 static int imx1_dt_node_to_map(struct pinctrl_dev *pctldev,
221 struct device_node *np,
222 struct pinctrl_map **map, unsigned *num_maps)
224 struct imx1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
225 const struct imx1_pinctrl_soc_info *info = ipctl->info;
226 const struct imx1_pin_group *grp;
227 struct pinctrl_map *new_map;
228 struct device_node *parent;
233 * first find the group of this node and check if we need create
234 * config maps for pins
236 grp = imx1_pinctrl_find_group_by_name(info, np->name);
238 dev_err(info->dev, "unable to find group for node %pOFn\n",
243 for (i = 0; i < grp->npins; i++)
246 new_map = kmalloc_array(map_num, sizeof(struct pinctrl_map),
255 parent = of_get_parent(np);
260 new_map[0].type = PIN_MAP_TYPE_MUX_GROUP;
261 new_map[0].data.mux.function = parent->name;
262 new_map[0].data.mux.group = np->name;
265 /* create config map */
267 for (i = j = 0; i < grp->npins; i++) {
268 new_map[j].type = PIN_MAP_TYPE_CONFIGS_PIN;
269 new_map[j].data.configs.group_or_pin =
270 pin_get_name(pctldev, grp->pins[i].pin_id);
271 new_map[j].data.configs.configs = &grp->pins[i].config;
272 new_map[j].data.configs.num_configs = 1;
276 dev_dbg(pctldev->dev, "maps: function %s group %s num %d\n",
277 (*map)->data.mux.function, (*map)->data.mux.group, map_num);
282 static void imx1_dt_free_map(struct pinctrl_dev *pctldev,
283 struct pinctrl_map *map, unsigned num_maps)
288 static const struct pinctrl_ops imx1_pctrl_ops = {
289 .get_groups_count = imx1_get_groups_count,
290 .get_group_name = imx1_get_group_name,
291 .get_group_pins = imx1_get_group_pins,
292 .pin_dbg_show = imx1_pin_dbg_show,
293 .dt_node_to_map = imx1_dt_node_to_map,
294 .dt_free_map = imx1_dt_free_map,
297 static int imx1_pmx_set(struct pinctrl_dev *pctldev, unsigned selector,
300 struct imx1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
301 const struct imx1_pinctrl_soc_info *info = ipctl->info;
302 const struct imx1_pin *pins;
307 * Configure the mux mode for each pin in the group for a specific
310 pins = info->groups[group].pins;
311 npins = info->groups[group].npins;
313 WARN_ON(!pins || !npins);
315 dev_dbg(ipctl->dev, "enable function %s group %s\n",
316 info->functions[selector].name, info->groups[group].name);
318 for (i = 0; i < npins; i++) {
319 unsigned int mux = pins[i].mux_id;
320 unsigned int pin_id = pins[i].pin_id;
321 unsigned int afunction = MX1_MUX_FUNCTION(mux);
322 unsigned int gpio_in_use = MX1_MUX_GPIO(mux);
323 unsigned int direction = MX1_MUX_DIR(mux);
324 unsigned int gpio_oconf = MX1_MUX_OCONF(mux);
325 unsigned int gpio_iconfa = MX1_MUX_ICONFA(mux);
326 unsigned int gpio_iconfb = MX1_MUX_ICONFB(mux);
328 dev_dbg(pctldev->dev, "%s, pin 0x%x, function %d, gpio %d, direction %d, oconf %d, iconfa %d, iconfb %d\n",
329 __func__, pin_id, afunction, gpio_in_use,
330 direction, gpio_oconf, gpio_iconfa,
333 imx1_write_bit(ipctl, pin_id, gpio_in_use, MX1_GIUS);
334 imx1_write_bit(ipctl, pin_id, direction, MX1_DDIR);
337 imx1_write_2bit(ipctl, pin_id, gpio_oconf, MX1_OCR);
338 imx1_write_2bit(ipctl, pin_id, gpio_iconfa,
340 imx1_write_2bit(ipctl, pin_id, gpio_iconfb,
343 imx1_write_bit(ipctl, pin_id, afunction, MX1_GPR);
350 static int imx1_pmx_get_funcs_count(struct pinctrl_dev *pctldev)
352 struct imx1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
353 const struct imx1_pinctrl_soc_info *info = ipctl->info;
355 return info->nfunctions;
358 static const char *imx1_pmx_get_func_name(struct pinctrl_dev *pctldev,
361 struct imx1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
362 const struct imx1_pinctrl_soc_info *info = ipctl->info;
364 return info->functions[selector].name;
367 static int imx1_pmx_get_groups(struct pinctrl_dev *pctldev, unsigned selector,
368 const char * const **groups,
369 unsigned * const num_groups)
371 struct imx1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
372 const struct imx1_pinctrl_soc_info *info = ipctl->info;
374 *groups = info->functions[selector].groups;
375 *num_groups = info->functions[selector].num_groups;
380 static const struct pinmux_ops imx1_pmx_ops = {
381 .get_functions_count = imx1_pmx_get_funcs_count,
382 .get_function_name = imx1_pmx_get_func_name,
383 .get_function_groups = imx1_pmx_get_groups,
384 .set_mux = imx1_pmx_set,
387 static int imx1_pinconf_get(struct pinctrl_dev *pctldev,
388 unsigned pin_id, unsigned long *config)
390 struct imx1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
392 *config = imx1_read_bit(ipctl, pin_id, MX1_PUEN);
397 static int imx1_pinconf_set(struct pinctrl_dev *pctldev,
398 unsigned pin_id, unsigned long *configs,
399 unsigned num_configs)
401 struct imx1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
404 for (i = 0; i != num_configs; ++i) {
405 imx1_write_bit(ipctl, pin_id, configs[i] & 0x01, MX1_PUEN);
407 dev_dbg(ipctl->dev, "pinconf set pullup pin %s\n",
408 pin_desc_get(pctldev, pin_id)->name);
414 static void imx1_pinconf_dbg_show(struct pinctrl_dev *pctldev,
415 struct seq_file *s, unsigned pin_id)
417 unsigned long config;
419 imx1_pinconf_get(pctldev, pin_id, &config);
420 seq_printf(s, "0x%lx", config);
423 static void imx1_pinconf_group_dbg_show(struct pinctrl_dev *pctldev,
424 struct seq_file *s, unsigned group)
426 struct imx1_pinctrl *ipctl = pinctrl_dev_get_drvdata(pctldev);
427 const struct imx1_pinctrl_soc_info *info = ipctl->info;
428 struct imx1_pin_group *grp;
429 unsigned long config;
433 if (group >= info->ngroups)
437 grp = &info->groups[group];
438 for (i = 0; i < grp->npins; i++) {
439 name = pin_get_name(pctldev, grp->pins[i].pin_id);
440 ret = imx1_pinconf_get(pctldev, grp->pins[i].pin_id, &config);
443 seq_printf(s, "%s: 0x%lx", name, config);
447 static const struct pinconf_ops imx1_pinconf_ops = {
448 .pin_config_get = imx1_pinconf_get,
449 .pin_config_set = imx1_pinconf_set,
450 .pin_config_dbg_show = imx1_pinconf_dbg_show,
451 .pin_config_group_dbg_show = imx1_pinconf_group_dbg_show,
454 static struct pinctrl_desc imx1_pinctrl_desc = {
455 .pctlops = &imx1_pctrl_ops,
456 .pmxops = &imx1_pmx_ops,
457 .confops = &imx1_pinconf_ops,
458 .owner = THIS_MODULE,
461 static int imx1_pinctrl_parse_groups(struct device_node *np,
462 struct imx1_pin_group *grp,
463 struct imx1_pinctrl_soc_info *info,
470 dev_dbg(info->dev, "group(%d): %pOFn\n", index, np);
472 /* Initialise group */
473 grp->name = np->name;
476 * the binding format is fsl,pins = <PIN MUX_ID CONFIG>
478 list = of_get_property(np, "fsl,pins", &size);
479 /* we do not check return since it's safe node passed down */
480 if (!size || size % 12) {
481 dev_notice(info->dev, "Not a valid fsl,pins property (%pOFn)\n",
486 grp->npins = size / 12;
487 grp->pins = devm_kcalloc(info->dev,
488 grp->npins, sizeof(struct imx1_pin), GFP_KERNEL);
489 grp->pin_ids = devm_kcalloc(info->dev,
490 grp->npins, sizeof(unsigned int), GFP_KERNEL);
492 if (!grp->pins || !grp->pin_ids)
495 for (i = 0; i < grp->npins; i++) {
496 grp->pins[i].pin_id = be32_to_cpu(*list++);
497 grp->pins[i].mux_id = be32_to_cpu(*list++);
498 grp->pins[i].config = be32_to_cpu(*list++);
500 grp->pin_ids[i] = grp->pins[i].pin_id;
506 static int imx1_pinctrl_parse_functions(struct device_node *np,
507 struct imx1_pinctrl_soc_info *info,
510 struct device_node *child;
511 struct imx1_pmx_func *func;
512 struct imx1_pin_group *grp;
514 static u32 grp_index;
517 dev_dbg(info->dev, "parse function(%d): %pOFn\n", index, np);
519 func = &info->functions[index];
521 /* Initialise function */
522 func->name = np->name;
523 func->num_groups = of_get_child_count(np);
524 if (func->num_groups == 0)
527 func->groups = devm_kcalloc(info->dev,
528 func->num_groups, sizeof(char *), GFP_KERNEL);
533 for_each_child_of_node(np, child) {
534 func->groups[i] = child->name;
535 grp = &info->groups[grp_index++];
536 ret = imx1_pinctrl_parse_groups(child, grp, info, i++);
537 if (ret == -ENOMEM) {
546 static int imx1_pinctrl_parse_dt(struct platform_device *pdev,
547 struct imx1_pinctrl *pctl, struct imx1_pinctrl_soc_info *info)
549 struct device_node *np = pdev->dev.of_node;
550 struct device_node *child;
559 for_each_child_of_node(np, child) {
561 ngroups += of_get_child_count(child);
565 dev_err(&pdev->dev, "No pin functions defined\n");
569 info->nfunctions = nfuncs;
570 info->functions = devm_kcalloc(&pdev->dev,
571 nfuncs, sizeof(struct imx1_pmx_func), GFP_KERNEL);
573 info->ngroups = ngroups;
574 info->groups = devm_kcalloc(&pdev->dev,
575 ngroups, sizeof(struct imx1_pin_group), GFP_KERNEL);
578 if (!info->functions || !info->groups)
581 for_each_child_of_node(np, child) {
582 ret = imx1_pinctrl_parse_functions(child, info, ifunc++);
583 if (ret == -ENOMEM) {
592 int imx1_pinctrl_core_probe(struct platform_device *pdev,
593 struct imx1_pinctrl_soc_info *info)
595 struct imx1_pinctrl *ipctl;
596 struct resource *res;
597 struct pinctrl_desc *pctl_desc;
600 if (!info || !info->pins || !info->npins) {
601 dev_err(&pdev->dev, "wrong pinctrl info\n");
604 info->dev = &pdev->dev;
606 /* Create state holders etc for this driver */
607 ipctl = devm_kzalloc(&pdev->dev, sizeof(*ipctl), GFP_KERNEL);
611 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
615 ipctl->base = devm_ioremap(&pdev->dev, res->start,
620 pctl_desc = &imx1_pinctrl_desc;
621 pctl_desc->name = dev_name(&pdev->dev);
622 pctl_desc->pins = info->pins;
623 pctl_desc->npins = info->npins;
625 ret = imx1_pinctrl_parse_dt(pdev, ipctl, info);
627 dev_err(&pdev->dev, "fail to probe dt properties\n");
632 ipctl->dev = info->dev;
633 platform_set_drvdata(pdev, ipctl);
634 ipctl->pctl = devm_pinctrl_register(&pdev->dev, pctl_desc, ipctl);
635 if (IS_ERR(ipctl->pctl)) {
636 dev_err(&pdev->dev, "could not register IMX pinctrl driver\n");
637 return PTR_ERR(ipctl->pctl);
640 ret = of_platform_populate(pdev->dev.of_node, NULL, NULL, &pdev->dev);
642 dev_err(&pdev->dev, "Failed to populate subdevices\n");
646 dev_info(&pdev->dev, "initialized IMX pinctrl driver\n");