2 * Allwinner A1X SoCs pinctrl driver.
4 * Copyright (C) 2012 Maxime Ripard
6 * Maxime Ripard <maxime.ripard@free-electrons.com>
8 * This file is licensed under the terms of the GNU General Public
9 * License version 2. This program is licensed "as is" without any
10 * warranty of any kind, whether express or implied.
13 #include <linux/clk.h>
14 #include <linux/export.h>
15 #include <linux/gpio/driver.h>
16 #include <linux/interrupt.h>
18 #include <linux/irqchip/chained_irq.h>
19 #include <linux/irqdomain.h>
21 #include <linux/of_clk.h>
22 #include <linux/platform_device.h>
23 #include <linux/regulator/consumer.h>
24 #include <linux/slab.h>
26 #include <linux/pinctrl/consumer.h>
27 #include <linux/pinctrl/machine.h>
28 #include <linux/pinctrl/pinconf-generic.h>
29 #include <linux/pinctrl/pinconf.h>
30 #include <linux/pinctrl/pinctrl.h>
31 #include <linux/pinctrl/pinmux.h>
33 #include <dt-bindings/pinctrl/sun4i-a10.h>
36 #include "pinctrl-sunxi.h"
39 * These lock classes tell lockdep that GPIO IRQs are in a different
40 * category than their parents, so it won't report false recursion.
42 static struct lock_class_key sunxi_pinctrl_irq_lock_class;
43 static struct lock_class_key sunxi_pinctrl_irq_request_class;
45 static struct irq_chip sunxi_pinctrl_edge_irq_chip;
46 static struct irq_chip sunxi_pinctrl_level_irq_chip;
49 * The sunXi PIO registers are organized as a series of banks, with registers
50 * for each bank in the following order:
56 * Multiple consecutive registers are used for fields wider than one bit.
58 * The following functions calculate the register and the bit offset to access.
59 * They take a pin number which is relative to the start of the current device.
61 static void sunxi_mux_reg(const struct sunxi_pinctrl *pctl,
62 u32 pin, u32 *reg, u32 *shift, u32 *mask)
64 u32 bank = pin / PINS_PER_BANK;
65 u32 offset = pin % PINS_PER_BANK * MUX_FIELD_WIDTH;
67 *reg = bank * pctl->bank_mem_size + MUX_REGS_OFFSET +
68 offset / BITS_PER_TYPE(u32) * sizeof(u32);
69 *shift = offset % BITS_PER_TYPE(u32);
70 *mask = (BIT(MUX_FIELD_WIDTH) - 1) << *shift;
73 static void sunxi_data_reg(const struct sunxi_pinctrl *pctl,
74 u32 pin, u32 *reg, u32 *shift, u32 *mask)
76 u32 bank = pin / PINS_PER_BANK;
77 u32 offset = pin % PINS_PER_BANK * DATA_FIELD_WIDTH;
79 *reg = bank * pctl->bank_mem_size + DATA_REGS_OFFSET +
80 offset / BITS_PER_TYPE(u32) * sizeof(u32);
81 *shift = offset % BITS_PER_TYPE(u32);
82 *mask = (BIT(DATA_FIELD_WIDTH) - 1) << *shift;
85 static void sunxi_dlevel_reg(const struct sunxi_pinctrl *pctl,
86 u32 pin, u32 *reg, u32 *shift, u32 *mask)
88 u32 bank = pin / PINS_PER_BANK;
89 u32 offset = pin % PINS_PER_BANK * pctl->dlevel_field_width;
91 *reg = bank * pctl->bank_mem_size + DLEVEL_REGS_OFFSET +
92 offset / BITS_PER_TYPE(u32) * sizeof(u32);
93 *shift = offset % BITS_PER_TYPE(u32);
94 *mask = (BIT(pctl->dlevel_field_width) - 1) << *shift;
97 static void sunxi_pull_reg(const struct sunxi_pinctrl *pctl,
98 u32 pin, u32 *reg, u32 *shift, u32 *mask)
100 u32 bank = pin / PINS_PER_BANK;
101 u32 offset = pin % PINS_PER_BANK * PULL_FIELD_WIDTH;
103 *reg = bank * pctl->bank_mem_size + pctl->pull_regs_offset +
104 offset / BITS_PER_TYPE(u32) * sizeof(u32);
105 *shift = offset % BITS_PER_TYPE(u32);
106 *mask = (BIT(PULL_FIELD_WIDTH) - 1) << *shift;
109 static struct sunxi_pinctrl_group *
110 sunxi_pinctrl_find_group_by_name(struct sunxi_pinctrl *pctl, const char *group)
114 for (i = 0; i < pctl->ngroups; i++) {
115 struct sunxi_pinctrl_group *grp = pctl->groups + i;
117 if (!strcmp(grp->name, group))
124 static struct sunxi_pinctrl_function *
125 sunxi_pinctrl_find_function_by_name(struct sunxi_pinctrl *pctl,
128 struct sunxi_pinctrl_function *func = pctl->functions;
131 for (i = 0; i < pctl->nfunctions; i++) {
135 if (!strcmp(func[i].name, name))
142 static struct sunxi_desc_function *
143 sunxi_pinctrl_desc_find_function_by_name(struct sunxi_pinctrl *pctl,
144 const char *pin_name,
145 const char *func_name)
149 for (i = 0; i < pctl->desc->npins; i++) {
150 const struct sunxi_desc_pin *pin = pctl->desc->pins + i;
152 if (!strcmp(pin->pin.name, pin_name)) {
153 struct sunxi_desc_function *func = pin->functions;
156 if (!strcmp(func->name, func_name) &&
158 func->variant & pctl->variant))
169 static struct sunxi_desc_function *
170 sunxi_pinctrl_desc_find_function_by_pin(struct sunxi_pinctrl *pctl,
172 const char *func_name)
176 for (i = 0; i < pctl->desc->npins; i++) {
177 const struct sunxi_desc_pin *pin = pctl->desc->pins + i;
179 if (pin->pin.number == pin_num) {
180 struct sunxi_desc_function *func = pin->functions;
183 if (!strcmp(func->name, func_name))
194 static int sunxi_pctrl_get_groups_count(struct pinctrl_dev *pctldev)
196 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
198 return pctl->ngroups;
201 static const char *sunxi_pctrl_get_group_name(struct pinctrl_dev *pctldev,
204 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
206 return pctl->groups[group].name;
209 static int sunxi_pctrl_get_group_pins(struct pinctrl_dev *pctldev,
211 const unsigned **pins,
214 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
216 *pins = (unsigned *)&pctl->groups[group].pin;
222 static bool sunxi_pctrl_has_bias_prop(struct device_node *node)
224 return of_property_present(node, "bias-pull-up") ||
225 of_property_present(node, "bias-pull-down") ||
226 of_property_present(node, "bias-disable") ||
227 of_property_present(node, "allwinner,pull");
230 static bool sunxi_pctrl_has_drive_prop(struct device_node *node)
232 return of_property_present(node, "drive-strength") ||
233 of_property_present(node, "allwinner,drive");
236 static int sunxi_pctrl_parse_bias_prop(struct device_node *node)
240 /* Try the new style binding */
241 if (of_property_present(node, "bias-pull-up"))
242 return PIN_CONFIG_BIAS_PULL_UP;
244 if (of_property_present(node, "bias-pull-down"))
245 return PIN_CONFIG_BIAS_PULL_DOWN;
247 if (of_property_present(node, "bias-disable"))
248 return PIN_CONFIG_BIAS_DISABLE;
250 /* And fall back to the old binding */
251 if (of_property_read_u32(node, "allwinner,pull", &val))
255 case SUN4I_PINCTRL_NO_PULL:
256 return PIN_CONFIG_BIAS_DISABLE;
257 case SUN4I_PINCTRL_PULL_UP:
258 return PIN_CONFIG_BIAS_PULL_UP;
259 case SUN4I_PINCTRL_PULL_DOWN:
260 return PIN_CONFIG_BIAS_PULL_DOWN;
266 static int sunxi_pctrl_parse_drive_prop(struct device_node *node)
270 /* Try the new style binding */
271 if (!of_property_read_u32(node, "drive-strength", &val)) {
272 /* We can't go below 10mA ... */
276 /* ... and only up to 40 mA ... */
280 /* by steps of 10 mA */
281 return rounddown(val, 10);
284 /* And then fall back to the old binding */
285 if (of_property_read_u32(node, "allwinner,drive", &val))
288 return (val + 1) * 10;
291 static const char *sunxi_pctrl_parse_function_prop(struct device_node *node)
293 const char *function;
296 /* Try the generic binding */
297 ret = of_property_read_string(node, "function", &function);
301 /* And fall back to our legacy one */
302 ret = of_property_read_string(node, "allwinner,function", &function);
309 static const char *sunxi_pctrl_find_pins_prop(struct device_node *node,
314 /* Try the generic binding */
315 count = of_property_count_strings(node, "pins");
321 /* And fall back to our legacy one */
322 count = of_property_count_strings(node, "allwinner,pins");
325 return "allwinner,pins";
331 static unsigned long *sunxi_pctrl_build_pin_config(struct device_node *node,
334 unsigned long *pinconfig;
335 unsigned int configlen = 0, idx = 0;
338 if (sunxi_pctrl_has_drive_prop(node))
340 if (sunxi_pctrl_has_bias_prop(node))
344 * If we don't have any configuration, bail out
349 pinconfig = kcalloc(configlen, sizeof(*pinconfig), GFP_KERNEL);
351 return ERR_PTR(-ENOMEM);
353 if (sunxi_pctrl_has_drive_prop(node)) {
354 int drive = sunxi_pctrl_parse_drive_prop(node);
360 pinconfig[idx++] = pinconf_to_config_packed(PIN_CONFIG_DRIVE_STRENGTH,
364 if (sunxi_pctrl_has_bias_prop(node)) {
365 int pull = sunxi_pctrl_parse_bias_prop(node);
372 if (pull != PIN_CONFIG_BIAS_DISABLE)
373 arg = 1; /* hardware uses weak pull resistors */
375 pinconfig[idx++] = pinconf_to_config_packed(pull, arg);
387 static int sunxi_pctrl_dt_node_to_map(struct pinctrl_dev *pctldev,
388 struct device_node *node,
389 struct pinctrl_map **map,
392 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
393 unsigned long *pinconfig;
394 struct property *prop;
395 const char *function, *pin_prop;
397 int ret, npins, nmaps, configlen = 0, i = 0;
402 function = sunxi_pctrl_parse_function_prop(node);
404 dev_err(pctl->dev, "missing function property in node %pOFn\n",
409 pin_prop = sunxi_pctrl_find_pins_prop(node, &npins);
411 dev_err(pctl->dev, "missing pins property in node %pOFn\n",
417 * We have two maps for each pin: one for the function, one
418 * for the configuration (bias, strength, etc).
420 * We might be slightly overshooting, since we might not have
424 *map = kmalloc_array(nmaps, sizeof(struct pinctrl_map), GFP_KERNEL);
428 pinconfig = sunxi_pctrl_build_pin_config(node, &configlen);
429 if (IS_ERR(pinconfig)) {
430 ret = PTR_ERR(pinconfig);
434 of_property_for_each_string(node, pin_prop, prop, group) {
435 struct sunxi_pinctrl_group *grp =
436 sunxi_pinctrl_find_group_by_name(pctl, group);
439 dev_err(pctl->dev, "unknown pin %s", group);
443 if (!sunxi_pinctrl_desc_find_function_by_name(pctl,
446 dev_err(pctl->dev, "unsupported function %s on pin %s",
451 (*map)[i].type = PIN_MAP_TYPE_MUX_GROUP;
452 (*map)[i].data.mux.group = group;
453 (*map)[i].data.mux.function = function;
458 (*map)[i].type = PIN_MAP_TYPE_CONFIGS_GROUP;
459 (*map)[i].data.configs.group_or_pin = group;
460 (*map)[i].data.configs.configs = pinconfig;
461 (*map)[i].data.configs.num_configs = configlen;
469 * We know have the number of maps we need, we can resize our
472 *map = krealloc(*map, i * sizeof(struct pinctrl_map), GFP_KERNEL);
484 static void sunxi_pctrl_dt_free_map(struct pinctrl_dev *pctldev,
485 struct pinctrl_map *map,
490 /* pin config is never in the first map */
491 for (i = 1; i < num_maps; i++) {
492 if (map[i].type != PIN_MAP_TYPE_CONFIGS_GROUP)
496 * All the maps share the same pin config,
497 * free only the first one we find.
499 kfree(map[i].data.configs.configs);
506 static const struct pinctrl_ops sunxi_pctrl_ops = {
507 .dt_node_to_map = sunxi_pctrl_dt_node_to_map,
508 .dt_free_map = sunxi_pctrl_dt_free_map,
509 .get_groups_count = sunxi_pctrl_get_groups_count,
510 .get_group_name = sunxi_pctrl_get_group_name,
511 .get_group_pins = sunxi_pctrl_get_group_pins,
514 static int sunxi_pconf_reg(const struct sunxi_pinctrl *pctl,
515 u32 pin, enum pin_config_param param,
516 u32 *reg, u32 *shift, u32 *mask)
519 case PIN_CONFIG_DRIVE_STRENGTH:
520 sunxi_dlevel_reg(pctl, pin, reg, shift, mask);
523 case PIN_CONFIG_BIAS_PULL_UP:
524 case PIN_CONFIG_BIAS_PULL_DOWN:
525 case PIN_CONFIG_BIAS_DISABLE:
526 sunxi_pull_reg(pctl, pin, reg, shift, mask);
536 static int sunxi_pconf_get(struct pinctrl_dev *pctldev, unsigned pin,
537 unsigned long *config)
539 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
540 enum pin_config_param param = pinconf_to_config_param(*config);
541 u32 reg, shift, mask, val;
545 pin -= pctl->desc->pin_base;
547 ret = sunxi_pconf_reg(pctl, pin, param, ®, &shift, &mask);
551 val = (readl(pctl->membase + reg) & mask) >> shift;
553 switch (pinconf_to_config_param(*config)) {
554 case PIN_CONFIG_DRIVE_STRENGTH:
555 arg = (val + 1) * 10;
558 case PIN_CONFIG_BIAS_PULL_UP:
559 if (val != SUN4I_PINCTRL_PULL_UP)
561 arg = 1; /* hardware is weak pull-up */
564 case PIN_CONFIG_BIAS_PULL_DOWN:
565 if (val != SUN4I_PINCTRL_PULL_DOWN)
567 arg = 1; /* hardware is weak pull-down */
570 case PIN_CONFIG_BIAS_DISABLE:
571 if (val != SUN4I_PINCTRL_NO_PULL)
577 /* sunxi_pconf_reg should catch anything unsupported */
582 *config = pinconf_to_config_packed(param, arg);
587 static int sunxi_pconf_group_get(struct pinctrl_dev *pctldev,
589 unsigned long *config)
591 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
592 struct sunxi_pinctrl_group *g = &pctl->groups[group];
594 /* We only support 1 pin per group. Chain it to the pin callback */
595 return sunxi_pconf_get(pctldev, g->pin, config);
598 static int sunxi_pconf_set(struct pinctrl_dev *pctldev, unsigned pin,
599 unsigned long *configs, unsigned num_configs)
601 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
604 pin -= pctl->desc->pin_base;
606 for (i = 0; i < num_configs; i++) {
607 u32 arg, reg, shift, mask, val;
608 enum pin_config_param param;
612 param = pinconf_to_config_param(configs[i]);
613 arg = pinconf_to_config_argument(configs[i]);
615 ret = sunxi_pconf_reg(pctl, pin, param, ®, &shift, &mask);
620 case PIN_CONFIG_DRIVE_STRENGTH:
621 if (arg < 10 || arg > 40)
624 * We convert from mA to what the register expects:
632 case PIN_CONFIG_BIAS_DISABLE:
635 case PIN_CONFIG_BIAS_PULL_UP:
640 case PIN_CONFIG_BIAS_PULL_DOWN:
646 /* sunxi_pconf_reg should catch anything unsupported */
651 raw_spin_lock_irqsave(&pctl->lock, flags);
652 writel((readl(pctl->membase + reg) & ~mask) | val << shift,
653 pctl->membase + reg);
654 raw_spin_unlock_irqrestore(&pctl->lock, flags);
655 } /* for each config */
660 static int sunxi_pconf_group_set(struct pinctrl_dev *pctldev, unsigned group,
661 unsigned long *configs, unsigned num_configs)
663 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
664 struct sunxi_pinctrl_group *g = &pctl->groups[group];
666 /* We only support 1 pin per group. Chain it to the pin callback */
667 return sunxi_pconf_set(pctldev, g->pin, configs, num_configs);
670 static const struct pinconf_ops sunxi_pconf_ops = {
672 .pin_config_get = sunxi_pconf_get,
673 .pin_config_set = sunxi_pconf_set,
674 .pin_config_group_get = sunxi_pconf_group_get,
675 .pin_config_group_set = sunxi_pconf_group_set,
678 static int sunxi_pinctrl_set_io_bias_cfg(struct sunxi_pinctrl *pctl,
680 struct regulator *supply)
687 if (!pctl->desc->io_bias_cfg_variant)
690 uV = regulator_get_voltage(supply);
694 /* Might be dummy regulator with no voltage set */
698 pin -= pctl->desc->pin_base;
699 bank = pin / PINS_PER_BANK;
701 switch (pctl->desc->io_bias_cfg_variant) {
702 case BIAS_VOLTAGE_GRP_CONFIG:
704 * Configured value must be equal or greater to actual
708 val = 0x0; /* 1.8V */
709 else if (uV <= 2500000)
710 val = 0x6; /* 2.5V */
711 else if (uV <= 2800000)
712 val = 0x9; /* 2.8V */
713 else if (uV <= 3000000)
714 val = 0xA; /* 3.0V */
716 val = 0xD; /* 3.3V */
718 reg = readl(pctl->membase + sunxi_grp_config_reg(pin));
719 reg &= ~IO_BIAS_MASK;
720 writel(reg | val, pctl->membase + sunxi_grp_config_reg(pin));
722 case BIAS_VOLTAGE_PIO_POW_MODE_CTL:
723 val = uV > 1800000 && uV <= 2500000 ? BIT(bank) : 0;
725 raw_spin_lock_irqsave(&pctl->lock, flags);
726 reg = readl(pctl->membase + PIO_POW_MOD_CTL_REG);
728 writel(reg | val, pctl->membase + PIO_POW_MOD_CTL_REG);
729 raw_spin_unlock_irqrestore(&pctl->lock, flags);
732 case BIAS_VOLTAGE_PIO_POW_MODE_SEL:
733 val = uV <= 1800000 ? 1 : 0;
735 raw_spin_lock_irqsave(&pctl->lock, flags);
736 reg = readl(pctl->membase + PIO_POW_MOD_SEL_REG);
738 writel(reg | val << bank, pctl->membase + PIO_POW_MOD_SEL_REG);
739 raw_spin_unlock_irqrestore(&pctl->lock, flags);
746 static int sunxi_pmx_get_funcs_cnt(struct pinctrl_dev *pctldev)
748 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
750 return pctl->nfunctions;
753 static const char *sunxi_pmx_get_func_name(struct pinctrl_dev *pctldev,
756 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
758 return pctl->functions[function].name;
761 static int sunxi_pmx_get_func_groups(struct pinctrl_dev *pctldev,
763 const char * const **groups,
764 unsigned * const num_groups)
766 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
768 *groups = pctl->functions[function].groups;
769 *num_groups = pctl->functions[function].ngroups;
774 static void sunxi_pmx_set(struct pinctrl_dev *pctldev,
778 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
779 u32 reg, shift, mask;
782 pin -= pctl->desc->pin_base;
783 sunxi_mux_reg(pctl, pin, ®, &shift, &mask);
785 raw_spin_lock_irqsave(&pctl->lock, flags);
787 writel((readl(pctl->membase + reg) & ~mask) | config << shift,
788 pctl->membase + reg);
790 raw_spin_unlock_irqrestore(&pctl->lock, flags);
793 static int sunxi_pmx_set_mux(struct pinctrl_dev *pctldev,
797 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
798 struct sunxi_pinctrl_group *g = pctl->groups + group;
799 struct sunxi_pinctrl_function *func = pctl->functions + function;
800 struct sunxi_desc_function *desc =
801 sunxi_pinctrl_desc_find_function_by_name(pctl,
808 sunxi_pmx_set(pctldev, g->pin, desc->muxval);
814 sunxi_pmx_gpio_set_direction(struct pinctrl_dev *pctldev,
815 struct pinctrl_gpio_range *range,
819 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
820 struct sunxi_desc_function *desc;
828 desc = sunxi_pinctrl_desc_find_function_by_pin(pctl, offset, func);
832 sunxi_pmx_set(pctldev, offset, desc->muxval);
837 static int sunxi_pmx_request(struct pinctrl_dev *pctldev, unsigned offset)
839 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
840 unsigned short bank = offset / PINS_PER_BANK;
841 unsigned short bank_offset = bank - pctl->desc->pin_base /
843 struct sunxi_pinctrl_regulator *s_reg = &pctl->regulators[bank_offset];
844 struct regulator *reg = s_reg->regulator;
848 if (WARN_ON_ONCE(bank_offset >= ARRAY_SIZE(pctl->regulators)))
852 refcount_inc(&s_reg->refcount);
856 snprintf(supply, sizeof(supply), "vcc-p%c", 'a' + bank);
857 reg = regulator_get(pctl->dev, supply);
859 return dev_err_probe(pctl->dev, PTR_ERR(reg),
860 "Couldn't get bank P%c regulator\n",
863 ret = regulator_enable(reg);
866 "Couldn't enable bank P%c regulator\n", 'A' + bank);
870 sunxi_pinctrl_set_io_bias_cfg(pctl, offset, reg);
872 s_reg->regulator = reg;
873 refcount_set(&s_reg->refcount, 1);
878 regulator_put(s_reg->regulator);
883 static int sunxi_pmx_free(struct pinctrl_dev *pctldev, unsigned offset)
885 struct sunxi_pinctrl *pctl = pinctrl_dev_get_drvdata(pctldev);
886 unsigned short bank = offset / PINS_PER_BANK;
887 unsigned short bank_offset = bank - pctl->desc->pin_base /
889 struct sunxi_pinctrl_regulator *s_reg = &pctl->regulators[bank_offset];
891 if (!refcount_dec_and_test(&s_reg->refcount))
894 regulator_disable(s_reg->regulator);
895 regulator_put(s_reg->regulator);
896 s_reg->regulator = NULL;
901 static const struct pinmux_ops sunxi_pmx_ops = {
902 .get_functions_count = sunxi_pmx_get_funcs_cnt,
903 .get_function_name = sunxi_pmx_get_func_name,
904 .get_function_groups = sunxi_pmx_get_func_groups,
905 .set_mux = sunxi_pmx_set_mux,
906 .gpio_set_direction = sunxi_pmx_gpio_set_direction,
907 .request = sunxi_pmx_request,
908 .free = sunxi_pmx_free,
912 static int sunxi_pinctrl_gpio_direction_input(struct gpio_chip *chip,
915 struct sunxi_pinctrl *pctl = gpiochip_get_data(chip);
917 return sunxi_pmx_gpio_set_direction(pctl->pctl_dev, NULL,
918 chip->base + offset, true);
921 static int sunxi_pinctrl_gpio_get(struct gpio_chip *chip, unsigned offset)
923 struct sunxi_pinctrl *pctl = gpiochip_get_data(chip);
924 bool set_mux = pctl->desc->irq_read_needs_mux &&
925 gpiochip_line_is_irq(chip, offset);
926 u32 pin = offset + chip->base;
927 u32 reg, shift, mask, val;
929 sunxi_data_reg(pctl, offset, ®, &shift, &mask);
932 sunxi_pmx_set(pctl->pctl_dev, pin, SUN4I_FUNC_INPUT);
934 val = (readl(pctl->membase + reg) & mask) >> shift;
937 sunxi_pmx_set(pctl->pctl_dev, pin, SUN4I_FUNC_IRQ);
942 static void sunxi_pinctrl_gpio_set(struct gpio_chip *chip,
943 unsigned offset, int value)
945 struct sunxi_pinctrl *pctl = gpiochip_get_data(chip);
946 u32 reg, shift, mask, val;
949 sunxi_data_reg(pctl, offset, ®, &shift, &mask);
951 raw_spin_lock_irqsave(&pctl->lock, flags);
953 val = readl(pctl->membase + reg);
960 writel(val, pctl->membase + reg);
962 raw_spin_unlock_irqrestore(&pctl->lock, flags);
965 static int sunxi_pinctrl_gpio_direction_output(struct gpio_chip *chip,
966 unsigned offset, int value)
968 struct sunxi_pinctrl *pctl = gpiochip_get_data(chip);
970 sunxi_pinctrl_gpio_set(chip, offset, value);
971 return sunxi_pmx_gpio_set_direction(pctl->pctl_dev, NULL,
972 chip->base + offset, false);
975 static int sunxi_pinctrl_gpio_of_xlate(struct gpio_chip *gc,
976 const struct of_phandle_args *gpiospec,
981 base = PINS_PER_BANK * gpiospec->args[0];
982 pin = base + gpiospec->args[1];
988 *flags = gpiospec->args[2];
993 static int sunxi_pinctrl_gpio_to_irq(struct gpio_chip *chip, unsigned offset)
995 struct sunxi_pinctrl *pctl = gpiochip_get_data(chip);
996 struct sunxi_desc_function *desc;
997 unsigned pinnum = pctl->desc->pin_base + offset;
1000 if (offset >= chip->ngpio)
1003 desc = sunxi_pinctrl_desc_find_function_by_pin(pctl, pinnum, "irq");
1007 irqnum = desc->irqbank * IRQ_PER_BANK + desc->irqnum;
1009 dev_dbg(chip->parent, "%s: request IRQ for GPIO %d, return %d\n",
1010 chip->label, offset + chip->base, irqnum);
1012 return irq_find_mapping(pctl->domain, irqnum);
1015 static int sunxi_pinctrl_irq_request_resources(struct irq_data *d)
1017 struct sunxi_pinctrl *pctl = irq_data_get_irq_chip_data(d);
1018 struct sunxi_desc_function *func;
1021 func = sunxi_pinctrl_desc_find_function_by_pin(pctl,
1022 pctl->irq_array[d->hwirq], "irq");
1026 ret = gpiochip_lock_as_irq(pctl->chip,
1027 pctl->irq_array[d->hwirq] - pctl->desc->pin_base);
1029 dev_err(pctl->dev, "unable to lock HW IRQ %lu for IRQ\n",
1034 /* Change muxing to INT mode */
1035 sunxi_pmx_set(pctl->pctl_dev, pctl->irq_array[d->hwirq], func->muxval);
1040 static void sunxi_pinctrl_irq_release_resources(struct irq_data *d)
1042 struct sunxi_pinctrl *pctl = irq_data_get_irq_chip_data(d);
1044 gpiochip_unlock_as_irq(pctl->chip,
1045 pctl->irq_array[d->hwirq] - pctl->desc->pin_base);
1048 static int sunxi_pinctrl_irq_set_type(struct irq_data *d, unsigned int type)
1050 struct sunxi_pinctrl *pctl = irq_data_get_irq_chip_data(d);
1051 u32 reg = sunxi_irq_cfg_reg(pctl->desc, d->hwirq);
1052 u8 index = sunxi_irq_cfg_offset(d->hwirq);
1053 unsigned long flags;
1058 case IRQ_TYPE_EDGE_RISING:
1059 mode = IRQ_EDGE_RISING;
1061 case IRQ_TYPE_EDGE_FALLING:
1062 mode = IRQ_EDGE_FALLING;
1064 case IRQ_TYPE_EDGE_BOTH:
1065 mode = IRQ_EDGE_BOTH;
1067 case IRQ_TYPE_LEVEL_HIGH:
1068 mode = IRQ_LEVEL_HIGH;
1070 case IRQ_TYPE_LEVEL_LOW:
1071 mode = IRQ_LEVEL_LOW;
1077 raw_spin_lock_irqsave(&pctl->lock, flags);
1079 if (type & IRQ_TYPE_LEVEL_MASK)
1080 irq_set_chip_handler_name_locked(d, &sunxi_pinctrl_level_irq_chip,
1081 handle_fasteoi_irq, NULL);
1083 irq_set_chip_handler_name_locked(d, &sunxi_pinctrl_edge_irq_chip,
1084 handle_edge_irq, NULL);
1086 regval = readl(pctl->membase + reg);
1087 regval &= ~(IRQ_CFG_IRQ_MASK << index);
1088 writel(regval | (mode << index), pctl->membase + reg);
1090 raw_spin_unlock_irqrestore(&pctl->lock, flags);
1095 static void sunxi_pinctrl_irq_ack(struct irq_data *d)
1097 struct sunxi_pinctrl *pctl = irq_data_get_irq_chip_data(d);
1098 u32 status_reg = sunxi_irq_status_reg(pctl->desc, d->hwirq);
1099 u8 status_idx = sunxi_irq_status_offset(d->hwirq);
1102 writel(1 << status_idx, pctl->membase + status_reg);
1105 static void sunxi_pinctrl_irq_mask(struct irq_data *d)
1107 struct sunxi_pinctrl *pctl = irq_data_get_irq_chip_data(d);
1108 u32 reg = sunxi_irq_ctrl_reg(pctl->desc, d->hwirq);
1109 u8 idx = sunxi_irq_ctrl_offset(d->hwirq);
1110 unsigned long flags;
1113 raw_spin_lock_irqsave(&pctl->lock, flags);
1116 val = readl(pctl->membase + reg);
1117 writel(val & ~(1 << idx), pctl->membase + reg);
1119 raw_spin_unlock_irqrestore(&pctl->lock, flags);
1122 static void sunxi_pinctrl_irq_unmask(struct irq_data *d)
1124 struct sunxi_pinctrl *pctl = irq_data_get_irq_chip_data(d);
1125 u32 reg = sunxi_irq_ctrl_reg(pctl->desc, d->hwirq);
1126 u8 idx = sunxi_irq_ctrl_offset(d->hwirq);
1127 unsigned long flags;
1130 raw_spin_lock_irqsave(&pctl->lock, flags);
1132 /* Unmask the IRQ */
1133 val = readl(pctl->membase + reg);
1134 writel(val | (1 << idx), pctl->membase + reg);
1136 raw_spin_unlock_irqrestore(&pctl->lock, flags);
1139 static void sunxi_pinctrl_irq_ack_unmask(struct irq_data *d)
1141 sunxi_pinctrl_irq_ack(d);
1142 sunxi_pinctrl_irq_unmask(d);
1145 static int sunxi_pinctrl_irq_set_wake(struct irq_data *d, unsigned int on)
1147 struct sunxi_pinctrl *pctl = irq_data_get_irq_chip_data(d);
1148 u8 bank = d->hwirq / IRQ_PER_BANK;
1150 return irq_set_irq_wake(pctl->irq[bank], on);
1153 static struct irq_chip sunxi_pinctrl_edge_irq_chip = {
1154 .name = "sunxi_pio_edge",
1155 .irq_ack = sunxi_pinctrl_irq_ack,
1156 .irq_mask = sunxi_pinctrl_irq_mask,
1157 .irq_unmask = sunxi_pinctrl_irq_unmask,
1158 .irq_request_resources = sunxi_pinctrl_irq_request_resources,
1159 .irq_release_resources = sunxi_pinctrl_irq_release_resources,
1160 .irq_set_type = sunxi_pinctrl_irq_set_type,
1161 .irq_set_wake = sunxi_pinctrl_irq_set_wake,
1162 .flags = IRQCHIP_MASK_ON_SUSPEND,
1165 static struct irq_chip sunxi_pinctrl_level_irq_chip = {
1166 .name = "sunxi_pio_level",
1167 .irq_eoi = sunxi_pinctrl_irq_ack,
1168 .irq_mask = sunxi_pinctrl_irq_mask,
1169 .irq_unmask = sunxi_pinctrl_irq_unmask,
1170 /* Define irq_enable / disable to avoid spurious irqs for drivers
1171 * using these to suppress irqs while they clear the irq source */
1172 .irq_enable = sunxi_pinctrl_irq_ack_unmask,
1173 .irq_disable = sunxi_pinctrl_irq_mask,
1174 .irq_request_resources = sunxi_pinctrl_irq_request_resources,
1175 .irq_release_resources = sunxi_pinctrl_irq_release_resources,
1176 .irq_set_type = sunxi_pinctrl_irq_set_type,
1177 .irq_set_wake = sunxi_pinctrl_irq_set_wake,
1178 .flags = IRQCHIP_EOI_THREADED |
1179 IRQCHIP_MASK_ON_SUSPEND |
1180 IRQCHIP_EOI_IF_HANDLED,
1183 static int sunxi_pinctrl_irq_of_xlate(struct irq_domain *d,
1184 struct device_node *node,
1186 unsigned int intsize,
1187 unsigned long *out_hwirq,
1188 unsigned int *out_type)
1190 struct sunxi_pinctrl *pctl = d->host_data;
1191 struct sunxi_desc_function *desc;
1197 base = PINS_PER_BANK * intspec[0];
1198 pin = pctl->desc->pin_base + base + intspec[1];
1200 desc = sunxi_pinctrl_desc_find_function_by_pin(pctl, pin, "irq");
1204 *out_hwirq = desc->irqbank * PINS_PER_BANK + desc->irqnum;
1205 *out_type = intspec[2];
1210 static const struct irq_domain_ops sunxi_pinctrl_irq_domain_ops = {
1211 .xlate = sunxi_pinctrl_irq_of_xlate,
1214 static void sunxi_pinctrl_irq_handler(struct irq_desc *desc)
1216 unsigned int irq = irq_desc_get_irq(desc);
1217 struct irq_chip *chip = irq_desc_get_chip(desc);
1218 struct sunxi_pinctrl *pctl = irq_desc_get_handler_data(desc);
1219 unsigned long bank, reg, val;
1221 for (bank = 0; bank < pctl->desc->irq_banks; bank++)
1222 if (irq == pctl->irq[bank])
1225 WARN_ON(bank == pctl->desc->irq_banks);
1227 chained_irq_enter(chip, desc);
1229 reg = sunxi_irq_status_reg_from_bank(pctl->desc, bank);
1230 val = readl(pctl->membase + reg);
1235 for_each_set_bit(irqoffset, &val, IRQ_PER_BANK)
1236 generic_handle_domain_irq(pctl->domain,
1237 bank * IRQ_PER_BANK + irqoffset);
1240 chained_irq_exit(chip, desc);
1243 static int sunxi_pinctrl_add_function(struct sunxi_pinctrl *pctl,
1246 struct sunxi_pinctrl_function *func = pctl->functions;
1248 while (func->name) {
1249 /* function already there */
1250 if (strcmp(func->name, name) == 0) {
1265 static int sunxi_pinctrl_build_state(struct platform_device *pdev)
1267 struct sunxi_pinctrl *pctl = platform_get_drvdata(pdev);
1274 * We assume that the number of groups is the number of pins
1275 * given in the data array.
1277 * This will not always be true, since some pins might not be
1278 * available in the current variant, but fortunately for us,
1279 * this means that the number of pins is the maximum group
1280 * number we will ever see.
1282 pctl->groups = devm_kcalloc(&pdev->dev,
1283 pctl->desc->npins, sizeof(*pctl->groups),
1288 for (i = 0; i < pctl->desc->npins; i++) {
1289 const struct sunxi_desc_pin *pin = pctl->desc->pins + i;
1290 struct sunxi_pinctrl_group *group = pctl->groups + pctl->ngroups;
1292 if (pin->variant && !(pctl->variant & pin->variant))
1295 group->name = pin->pin.name;
1296 group->pin = pin->pin.number;
1298 /* And now we count the actual number of pins / groups */
1303 * Find an upper bound for the maximum number of functions: in
1304 * the worst case we have gpio_in, gpio_out, irq and up to seven
1305 * special functions per pin, plus one entry for the sentinel.
1306 * We'll reallocate that later anyway.
1308 pctl->functions = kcalloc(7 * pctl->ngroups + 4,
1309 sizeof(*pctl->functions),
1311 if (!pctl->functions)
1314 /* Count functions and their associated groups */
1315 for (i = 0; i < pctl->desc->npins; i++) {
1316 const struct sunxi_desc_pin *pin = pctl->desc->pins + i;
1317 struct sunxi_desc_function *func;
1319 if (pin->variant && !(pctl->variant & pin->variant))
1322 for (func = pin->functions; func->name; func++) {
1323 if (func->variant && !(pctl->variant & func->variant))
1326 /* Create interrupt mapping while we're at it */
1327 if (!strcmp(func->name, "irq")) {
1328 int irqnum = func->irqnum + func->irqbank * IRQ_PER_BANK;
1329 pctl->irq_array[irqnum] = pin->pin.number;
1332 sunxi_pinctrl_add_function(pctl, func->name);
1336 /* And now allocated and fill the array for real */
1337 ptr = krealloc(pctl->functions,
1338 pctl->nfunctions * sizeof(*pctl->functions),
1341 kfree(pctl->functions);
1342 pctl->functions = NULL;
1345 pctl->functions = ptr;
1347 for (i = 0; i < pctl->desc->npins; i++) {
1348 const struct sunxi_desc_pin *pin = pctl->desc->pins + i;
1349 struct sunxi_desc_function *func;
1351 if (pin->variant && !(pctl->variant & pin->variant))
1354 for (func = pin->functions; func->name; func++) {
1355 struct sunxi_pinctrl_function *func_item;
1356 const char **func_grp;
1358 if (func->variant && !(pctl->variant & func->variant))
1361 func_item = sunxi_pinctrl_find_function_by_name(pctl,
1364 kfree(pctl->functions);
1368 if (!func_item->groups) {
1370 devm_kcalloc(&pdev->dev,
1372 sizeof(*func_item->groups),
1374 if (!func_item->groups) {
1375 kfree(pctl->functions);
1380 func_grp = func_item->groups;
1384 *func_grp = pin->pin.name;
1391 static int sunxi_pinctrl_get_debounce_div(struct clk *clk, int freq, int *diff)
1393 unsigned long clock = clk_get_rate(clk);
1394 unsigned int best_diff, best_div;
1397 best_diff = abs(freq - clock);
1400 for (i = 1; i < 8; i++) {
1401 int cur_diff = abs(freq - (clock >> i));
1403 if (cur_diff < best_diff) {
1404 best_diff = cur_diff;
1413 static int sunxi_pinctrl_setup_debounce(struct sunxi_pinctrl *pctl,
1414 struct device_node *node)
1416 unsigned int hosc_diff, losc_diff;
1417 unsigned int hosc_div, losc_div;
1418 struct clk *hosc, *losc;
1422 /* Deal with old DTs that didn't have the oscillators */
1423 if (of_clk_get_parent_count(node) != 3)
1426 /* If we don't have any setup, bail out */
1427 if (!of_property_present(node, "input-debounce"))
1430 losc = devm_clk_get(pctl->dev, "losc");
1432 return PTR_ERR(losc);
1434 hosc = devm_clk_get(pctl->dev, "hosc");
1436 return PTR_ERR(hosc);
1438 for (i = 0; i < pctl->desc->irq_banks; i++) {
1439 unsigned long debounce_freq;
1442 ret = of_property_read_u32_index(node, "input-debounce",
1450 debounce_freq = DIV_ROUND_CLOSEST(USEC_PER_SEC, debounce);
1451 losc_div = sunxi_pinctrl_get_debounce_div(losc,
1455 hosc_div = sunxi_pinctrl_get_debounce_div(hosc,
1459 if (hosc_diff < losc_diff) {
1467 writel(src | div << 4,
1469 sunxi_irq_debounce_reg_from_bank(pctl->desc, i));
1475 int sunxi_pinctrl_init_with_variant(struct platform_device *pdev,
1476 const struct sunxi_pinctrl_desc *desc,
1477 unsigned long variant)
1479 struct device_node *node = pdev->dev.of_node;
1480 struct pinctrl_desc *pctrl_desc;
1481 struct pinctrl_pin_desc *pins;
1482 struct sunxi_pinctrl *pctl;
1483 struct pinmux_ops *pmxops;
1484 int i, ret, last_pin, pin_idx;
1487 pctl = devm_kzalloc(&pdev->dev, sizeof(*pctl), GFP_KERNEL);
1490 platform_set_drvdata(pdev, pctl);
1492 raw_spin_lock_init(&pctl->lock);
1494 pctl->membase = devm_platform_ioremap_resource(pdev, 0);
1495 if (IS_ERR(pctl->membase))
1496 return PTR_ERR(pctl->membase);
1498 pctl->dev = &pdev->dev;
1500 pctl->variant = variant;
1501 if (pctl->variant >= PINCTRL_SUN20I_D1) {
1502 pctl->bank_mem_size = D1_BANK_MEM_SIZE;
1503 pctl->pull_regs_offset = D1_PULL_REGS_OFFSET;
1504 pctl->dlevel_field_width = D1_DLEVEL_FIELD_WIDTH;
1506 pctl->bank_mem_size = BANK_MEM_SIZE;
1507 pctl->pull_regs_offset = PULL_REGS_OFFSET;
1508 pctl->dlevel_field_width = DLEVEL_FIELD_WIDTH;
1511 pctl->irq_array = devm_kcalloc(&pdev->dev,
1512 IRQ_PER_BANK * pctl->desc->irq_banks,
1513 sizeof(*pctl->irq_array),
1515 if (!pctl->irq_array)
1518 ret = sunxi_pinctrl_build_state(pdev);
1520 dev_err(&pdev->dev, "dt probe failed: %d\n", ret);
1524 pins = devm_kcalloc(&pdev->dev,
1525 pctl->desc->npins, sizeof(*pins),
1530 for (i = 0, pin_idx = 0; i < pctl->desc->npins; i++) {
1531 const struct sunxi_desc_pin *pin = pctl->desc->pins + i;
1533 if (pin->variant && !(pctl->variant & pin->variant))
1536 pins[pin_idx++] = pin->pin;
1539 pctrl_desc = devm_kzalloc(&pdev->dev,
1540 sizeof(*pctrl_desc),
1545 pctrl_desc->name = dev_name(&pdev->dev);
1546 pctrl_desc->owner = THIS_MODULE;
1547 pctrl_desc->pins = pins;
1548 pctrl_desc->npins = pctl->ngroups;
1549 pctrl_desc->confops = &sunxi_pconf_ops;
1550 pctrl_desc->pctlops = &sunxi_pctrl_ops;
1552 pmxops = devm_kmemdup(&pdev->dev, &sunxi_pmx_ops, sizeof(sunxi_pmx_ops),
1557 if (desc->disable_strict_mode)
1558 pmxops->strict = false;
1560 pctrl_desc->pmxops = pmxops;
1562 pctl->pctl_dev = devm_pinctrl_register(&pdev->dev, pctrl_desc, pctl);
1563 if (IS_ERR(pctl->pctl_dev)) {
1564 dev_err(&pdev->dev, "couldn't register pinctrl driver\n");
1565 return PTR_ERR(pctl->pctl_dev);
1568 pctl->chip = devm_kzalloc(&pdev->dev, sizeof(*pctl->chip), GFP_KERNEL);
1572 last_pin = pctl->desc->pins[pctl->desc->npins - 1].pin.number;
1573 pctl->chip->owner = THIS_MODULE;
1574 pctl->chip->request = gpiochip_generic_request;
1575 pctl->chip->free = gpiochip_generic_free;
1576 pctl->chip->set_config = gpiochip_generic_config;
1577 pctl->chip->direction_input = sunxi_pinctrl_gpio_direction_input;
1578 pctl->chip->direction_output = sunxi_pinctrl_gpio_direction_output;
1579 pctl->chip->get = sunxi_pinctrl_gpio_get;
1580 pctl->chip->set = sunxi_pinctrl_gpio_set;
1581 pctl->chip->of_xlate = sunxi_pinctrl_gpio_of_xlate;
1582 pctl->chip->to_irq = sunxi_pinctrl_gpio_to_irq;
1583 pctl->chip->of_gpio_n_cells = 3;
1584 pctl->chip->can_sleep = false;
1585 pctl->chip->ngpio = round_up(last_pin, PINS_PER_BANK) -
1586 pctl->desc->pin_base;
1587 pctl->chip->label = dev_name(&pdev->dev);
1588 pctl->chip->parent = &pdev->dev;
1589 pctl->chip->base = pctl->desc->pin_base;
1591 ret = gpiochip_add_data(pctl->chip, pctl);
1595 for (i = 0; i < pctl->desc->npins; i++) {
1596 const struct sunxi_desc_pin *pin = pctl->desc->pins + i;
1598 ret = gpiochip_add_pin_range(pctl->chip, dev_name(&pdev->dev),
1599 pin->pin.number - pctl->desc->pin_base,
1600 pin->pin.number, 1);
1602 goto gpiochip_error;
1605 ret = of_clk_get_parent_count(node);
1606 clk = devm_clk_get(&pdev->dev, ret == 1 ? NULL : "apb");
1609 goto gpiochip_error;
1612 ret = clk_prepare_enable(clk);
1614 goto gpiochip_error;
1616 pctl->irq = devm_kcalloc(&pdev->dev,
1617 pctl->desc->irq_banks,
1625 for (i = 0; i < pctl->desc->irq_banks; i++) {
1626 pctl->irq[i] = platform_get_irq(pdev, i);
1627 if (pctl->irq[i] < 0) {
1633 pctl->domain = irq_domain_add_linear(node,
1634 pctl->desc->irq_banks * IRQ_PER_BANK,
1635 &sunxi_pinctrl_irq_domain_ops,
1637 if (!pctl->domain) {
1638 dev_err(&pdev->dev, "Couldn't register IRQ domain\n");
1643 for (i = 0; i < (pctl->desc->irq_banks * IRQ_PER_BANK); i++) {
1644 int irqno = irq_create_mapping(pctl->domain, i);
1646 irq_set_lockdep_class(irqno, &sunxi_pinctrl_irq_lock_class,
1647 &sunxi_pinctrl_irq_request_class);
1648 irq_set_chip_and_handler(irqno, &sunxi_pinctrl_edge_irq_chip,
1650 irq_set_chip_data(irqno, pctl);
1653 for (i = 0; i < pctl->desc->irq_banks; i++) {
1654 /* Mask and clear all IRQs before registering a handler */
1655 writel(0, pctl->membase +
1656 sunxi_irq_ctrl_reg_from_bank(pctl->desc, i));
1659 sunxi_irq_status_reg_from_bank(pctl->desc, i));
1661 irq_set_chained_handler_and_data(pctl->irq[i],
1662 sunxi_pinctrl_irq_handler,
1666 sunxi_pinctrl_setup_debounce(pctl, node);
1668 dev_info(&pdev->dev, "initialized sunXi PIO driver\n");
1673 clk_disable_unprepare(clk);
1675 gpiochip_remove(pctl->chip);