1 // SPDX-License-Identifier: GPL-2.0+
3 * U-Boot Marvell 37xx SoC pinctrl driver
5 * Copyright (C) 2017 Stefan Roese <sr@denx.de>
7 * This driver is based on the Linux driver version, which is:
8 * Copyright (C) 2017 Marvell
9 * Gregory CLEMENT <gregory.clement@free-electrons.com>
11 * Additionally parts are derived from the Meson U-Boot pinctrl driver,
13 * (C) Copyright 2016 - Beniamino Galvani <b.galvani@gmail.com>
14 * Based on code from Linux kernel:
15 * Copyright (C) 2016 Endless Mobile, Inc.
16 * https://spdx.org/licenses
23 #include <asm/global_data.h>
24 #include <dm/device-internal.h>
25 #include <dm/device_compat.h>
26 #include <dm/devres.h>
28 #include <dm/pinctrl.h>
34 #include <asm/system.h>
36 #include <linux/bitops.h>
37 #include <linux/libfdt.h>
39 DECLARE_GLOBAL_DATA_PTR;
42 #define INPUT_VAL 0x10
43 #define OUTPUT_VAL 0x18
44 #define OUTPUT_CTL 0x20
45 #define SELECTION 0x30
49 #define IRQ_STATUS 0x10
53 #define GPIO_PER_REG 32
56 * struct armada_37xx_pin_group: represents group of pins of a pinmux function.
57 * The pins of a pinmux groups are composed of one or two groups of contiguous
59 * @name: Name of the pin group, used to lookup the group.
60 * @start_pins: Index of the first pin of the main range of pins belonging to
62 * @npins: Number of pins included in the first range
63 * @reg_mask: Bit mask matching the group in the selection register
64 * @extra_pins: Index of the first pin of the optional second range of pins
65 * belonging to the group
66 * @npins: Number of pins included in the second optional range
67 * @funcs: A list of pinmux functions that can be selected for this group.
69 struct armada_37xx_pin_group {
71 unsigned int start_pin;
75 unsigned int extra_pin;
76 unsigned int extra_npins;
77 const char *funcs[NB_FUNCS];
80 struct armada_37xx_pin_data {
83 struct armada_37xx_pin_group *groups;
87 struct armada_37xx_pmx_func {
93 struct armada_37xx_pinctrl {
95 const struct armada_37xx_pin_data *data;
97 struct pinctrl_dev *pctl_dev;
98 struct armada_37xx_pmx_func *funcs;
102 #define PIN_GRP(_name, _start, _nr, _mask, _func1, _func2) \
105 .start_pin = _start, \
109 .funcs = {_func1, _func2} \
112 #define PIN_GRP_GPIO_0(_name, _start, _nr) \
115 .start_pin = _start, \
122 #define PIN_GRP_GPIO(_name, _start, _nr, _mask, _func1) \
125 .start_pin = _start, \
129 .funcs = {_func1, "gpio"} \
132 #define PIN_GRP_GPIO_2(_name, _start, _nr, _mask, _val1, _val2, _func1) \
135 .start_pin = _start, \
138 .val = {_val1, _val2}, \
139 .funcs = {_func1, "gpio"} \
142 #define PIN_GRP_GPIO_3(_name, _start, _nr, _mask, _v1, _v2, _v3, _f1, _f2) \
145 .start_pin = _start, \
148 .val = {_v1, _v2, _v3}, \
149 .funcs = {_f1, _f2, "gpio"} \
152 #define PIN_GRP_EXTRA(_name, _start, _nr, _mask, _v1, _v2, _start2, _nr2, \
156 .start_pin = _start, \
160 .extra_pin = _start2, \
161 .extra_npins = _nr2, \
162 .funcs = {_f1, _f2} \
165 static struct armada_37xx_pin_group armada_37xx_nb_groups[] = {
166 PIN_GRP_GPIO("jtag", 20, 5, BIT(0), "jtag"),
167 PIN_GRP_GPIO("sdio0", 8, 3, BIT(1), "sdio"),
168 PIN_GRP_GPIO("emmc_nb", 27, 9, BIT(2), "emmc"),
169 PIN_GRP_GPIO_3("pwm0", 11, 1, BIT(3) | BIT(20), 0, BIT(20), BIT(3),
171 PIN_GRP_GPIO_3("pwm1", 12, 1, BIT(4) | BIT(21), 0, BIT(21), BIT(4),
173 PIN_GRP_GPIO_3("pwm2", 13, 1, BIT(5) | BIT(22), 0, BIT(22), BIT(5),
175 PIN_GRP_GPIO_3("pwm3", 14, 1, BIT(6) | BIT(23), 0, BIT(23), BIT(6),
177 PIN_GRP_GPIO("pmic1", 7, 1, BIT(7), "pmic"),
178 PIN_GRP_GPIO("pmic0", 6, 1, BIT(8), "pmic"),
179 PIN_GRP_GPIO_0("gpio1_5", 5, 1),
180 PIN_GRP_GPIO("i2c2", 2, 2, BIT(9), "i2c"),
181 PIN_GRP_GPIO("i2c1", 0, 2, BIT(10), "i2c"),
182 PIN_GRP_GPIO("spi_cs1", 17, 1, BIT(12), "spi"),
183 PIN_GRP_GPIO_2("spi_cs2", 18, 1, BIT(13) | BIT(19), 0, BIT(13), "spi"),
184 PIN_GRP_GPIO_2("spi_cs3", 19, 1, BIT(14) | BIT(19), 0, BIT(14), "spi"),
185 PIN_GRP_GPIO("onewire", 4, 1, BIT(16), "onewire"),
186 PIN_GRP_GPIO("uart1", 25, 2, BIT(17), "uart"),
187 PIN_GRP_GPIO("spi_quad", 15, 2, BIT(18), "spi"),
188 PIN_GRP_EXTRA("uart2", 9, 2, BIT(1) | BIT(13) | BIT(14) | BIT(19),
189 BIT(1) | BIT(13) | BIT(14), BIT(1) | BIT(19),
190 18, 2, "gpio", "uart"),
193 static struct armada_37xx_pin_group armada_37xx_sb_groups[] = {
194 PIN_GRP_GPIO("usb32_drvvbus0", 0, 1, BIT(0), "drvbus"),
195 PIN_GRP_GPIO("usb2_drvvbus1", 1, 1, BIT(1), "drvbus"),
196 PIN_GRP_GPIO_0("gpio2_2", 2, 1),
197 PIN_GRP_GPIO("sdio_sb", 24, 6, BIT(2), "sdio"),
198 PIN_GRP_GPIO("rgmii", 6, 12, BIT(3), "mii"),
199 PIN_GRP_GPIO("smi", 18, 2, BIT(4), "smi"),
200 PIN_GRP_GPIO("pcie1", 3, 1, BIT(5), "pcie"), /* this actually controls "pcie1_reset" */
201 PIN_GRP_GPIO("pcie1_clkreq", 4, 1, BIT(9), "pcie"),
202 PIN_GRP_GPIO("pcie1_wakeup", 5, 1, BIT(10), "pcie"),
203 PIN_GRP_GPIO("ptp", 20, 3, BIT(11) | BIT(12) | BIT(13), "ptp"),
204 PIN_GRP("ptp_clk", 21, 1, BIT(6), "ptp", "mii"),
205 PIN_GRP("ptp_trig", 22, 1, BIT(7), "ptp", "mii"),
206 PIN_GRP_GPIO_3("mii_col", 23, 1, BIT(8) | BIT(14), 0, BIT(8), BIT(14),
210 static const struct armada_37xx_pin_data armada_37xx_pin_nb = {
213 .groups = armada_37xx_nb_groups,
214 .ngroups = ARRAY_SIZE(armada_37xx_nb_groups),
217 static const struct armada_37xx_pin_data armada_37xx_pin_sb = {
220 .groups = armada_37xx_sb_groups,
221 .ngroups = ARRAY_SIZE(armada_37xx_sb_groups),
224 static inline void armada_37xx_update_reg(unsigned int *reg,
225 unsigned int *offset)
227 /* We never have more than 2 registers */
228 if (*offset >= GPIO_PER_REG) {
229 *offset -= GPIO_PER_REG;
234 static int armada_37xx_get_func_reg(struct armada_37xx_pin_group *grp,
239 for (f = 0; (f < NB_FUNCS) && grp->funcs[f]; f++)
240 if (!strcmp(grp->funcs[f], func))
246 static int armada_37xx_pmx_get_groups_count(struct udevice *dev)
248 struct armada_37xx_pinctrl *info = dev_get_priv(dev);
250 return info->data->ngroups;
253 static const char *armada_37xx_pmx_dummy_name = "_dummy";
255 static const char *armada_37xx_pmx_get_group_name(struct udevice *dev,
258 struct armada_37xx_pinctrl *info = dev_get_priv(dev);
260 if (!info->data->groups[selector].name)
261 return armada_37xx_pmx_dummy_name;
263 return info->data->groups[selector].name;
266 static int armada_37xx_pmx_get_funcs_count(struct udevice *dev)
268 struct armada_37xx_pinctrl *info = dev_get_priv(dev);
273 static const char *armada_37xx_pmx_get_func_name(struct udevice *dev,
276 struct armada_37xx_pinctrl *info = dev_get_priv(dev);
278 return info->funcs[selector].name;
281 static int armada_37xx_pmx_set_by_name(struct udevice *dev,
283 struct armada_37xx_pin_group *grp,
286 struct armada_37xx_pinctrl *info = dev_get_priv(dev);
287 unsigned int reg = SELECTION;
288 unsigned int mask = grp->reg_mask;
289 int func, val, old_func;
291 dev_dbg(info->dev, "enable function %s group %s\n",
294 func = armada_37xx_get_func_reg(grp, name);
299 val = grp->val[func];
301 if (warn_on_change && val != (readl(info->base + reg) & mask)) {
302 for (old_func = 0; (old_func < NB_FUNCS) && grp->funcs[old_func]; old_func++) {
303 if (grp->val[old_func] == val)
306 dev_warn(info->dev, "Warning: Changing MPPs %u-%u function from %s to %s...\n",
307 grp->start_pin, grp->start_pin + grp->npins - 1,
308 ((old_func < NB_FUNCS && grp->funcs[old_func]) ?
309 grp->funcs[old_func] : "unknown"),
313 clrsetbits_le32(info->base + reg, mask, val);
318 static int armada_37xx_pmx_group_set(struct udevice *dev,
319 unsigned group_selector,
320 unsigned func_selector)
322 struct armada_37xx_pinctrl *info = dev_get_priv(dev);
323 struct armada_37xx_pin_group *grp = &info->data->groups[group_selector];
324 const char *name = info->funcs[func_selector].name;
326 return armada_37xx_pmx_set_by_name(dev, name, grp, false);
329 static int armada_37xx_pmx_gpio_request_enable(struct udevice *dev, unsigned int selector)
331 struct armada_37xx_pinctrl *info = dev_get_priv(dev);
335 /* Find all groups where is requested selector pin and set each group to gpio function */
336 for (n = 0; n < info->data->ngroups; n++) {
337 struct armada_37xx_pin_group *grp = &info->data->groups[n];
339 if ((selector >= grp->start_pin && selector < grp->start_pin + grp->npins) ||
340 (selector >= grp->extra_pin && selector < grp->extra_pin + grp->extra_npins)) {
341 ret = armada_37xx_pmx_set_by_name(dev, "gpio", grp, true);
350 static int armada_37xx_pmx_gpio_disable_free(struct udevice *dev, unsigned int selector)
357 * armada_37xx_add_function() - Add a new function to the list
358 * @funcs: array of function to add the new one
359 * @funcsize: size of the remaining space for the function
360 * @name: name of the function to add
362 * If it is a new function then create it by adding its name else
363 * increment the number of group associated to this function.
365 static int armada_37xx_add_function(struct armada_37xx_pmx_func *funcs,
366 int *funcsize, const char *name)
373 while (funcs->ngroups) {
374 /* function already there */
375 if (strcmp(funcs->name, name) == 0) {
384 /* append new unique function */
393 * armada_37xx_fill_group() - complete the group array
394 * @info: info driver instance
396 * Based on the data available from the armada_37xx_pin_group array
397 * completes the last member of the struct for each function: the list
398 * of the groups associated to this function.
401 static int armada_37xx_fill_group(struct armada_37xx_pinctrl *info)
403 int n, num = 0, funcsize = info->data->nr_pins;
405 for (n = 0; n < info->data->ngroups; n++) {
406 struct armada_37xx_pin_group *grp = &info->data->groups[n];
409 for (f = 0; (f < NB_FUNCS) && grp->funcs[f]; f++) {
411 /* check for unique functions and count groups */
412 ret = armada_37xx_add_function(info->funcs, &funcsize,
414 if (ret == -EOVERFLOW)
416 "More functions than pins(%d)\n",
417 info->data->nr_pins);
430 * armada_37xx_fill_funcs() - complete the funcs array
431 * @info: info driver instance
433 * Based on the data available from the armada_37xx_pin_group array
434 * completes the last two member of the struct for each group:
435 * - the list of the pins included in the group
436 * - the list of pinmux functions that can be selected for this group
439 static int armada_37xx_fill_func(struct armada_37xx_pinctrl *info)
441 struct armada_37xx_pmx_func *funcs = info->funcs;
444 for (n = 0; n < info->nfuncs; n++) {
445 const char *name = funcs[n].name;
449 funcs[n].groups = devm_kzalloc(info->dev, funcs[n].ngroups *
450 sizeof(*(funcs[n].groups)),
452 if (!funcs[n].groups)
455 groups = funcs[n].groups;
457 for (g = 0; g < info->data->ngroups; g++) {
458 struct armada_37xx_pin_group *gp = &info->data->groups[g];
461 for (f = 0; (f < NB_FUNCS) && gp->funcs[f]; f++) {
462 if (strcmp(gp->funcs[f], name) == 0) {
472 static int armada_37xx_gpio_get(struct udevice *dev, unsigned int offset)
474 struct armada_37xx_pinctrl *info = dev_get_priv(dev->parent);
475 unsigned int reg = INPUT_VAL;
476 unsigned int val, mask;
478 armada_37xx_update_reg(®, &offset);
481 val = readl(info->base + reg);
483 return (val & mask) != 0;
486 static int armada_37xx_gpio_set(struct udevice *dev, unsigned int offset,
489 struct armada_37xx_pinctrl *info = dev_get_priv(dev->parent);
490 unsigned int reg = OUTPUT_VAL;
491 unsigned int mask, val;
493 armada_37xx_update_reg(®, &offset);
495 val = value ? mask : 0;
497 clrsetbits_le32(info->base + reg, mask, val);
502 static int armada_37xx_gpio_get_direction(struct udevice *dev,
505 struct armada_37xx_pinctrl *info = dev_get_priv(dev->parent);
506 unsigned int reg = OUTPUT_EN;
507 unsigned int val, mask;
509 armada_37xx_update_reg(®, &offset);
511 val = readl(info->base + reg);
519 static int armada_37xx_gpio_direction_input(struct udevice *dev,
522 struct armada_37xx_pinctrl *info = dev_get_priv(dev->parent);
523 unsigned int reg = OUTPUT_EN;
526 armada_37xx_update_reg(®, &offset);
529 clrbits_le32(info->base + reg, mask);
534 static int armada_37xx_gpio_direction_output(struct udevice *dev,
535 unsigned int offset, int value)
537 struct armada_37xx_pinctrl *info = dev_get_priv(dev->parent);
538 unsigned int reg = OUTPUT_EN;
541 armada_37xx_update_reg(®, &offset);
544 setbits_le32(info->base + reg, mask);
546 /* And set the requested value */
547 return armada_37xx_gpio_set(dev, offset, value);
550 static int armada_37xx_gpio_probe(struct udevice *dev)
552 struct armada_37xx_pinctrl *info = dev_get_priv(dev->parent);
553 struct gpio_dev_priv *uc_priv;
555 uc_priv = dev_get_uclass_priv(dev);
556 uc_priv->bank_name = info->data->name;
557 uc_priv->gpio_count = info->data->nr_pins;
562 static const struct dm_gpio_ops armada_37xx_gpio_ops = {
563 .request = pinctrl_gpio_request,
564 .rfree = pinctrl_gpio_free,
565 .set_value = armada_37xx_gpio_set,
566 .get_value = armada_37xx_gpio_get,
567 .get_function = armada_37xx_gpio_get_direction,
568 .direction_input = armada_37xx_gpio_direction_input,
569 .direction_output = armada_37xx_gpio_direction_output,
572 static struct driver armada_37xx_gpio_driver = {
573 .name = "armada-37xx-gpio",
575 .probe = armada_37xx_gpio_probe,
576 .ops = &armada_37xx_gpio_ops,
579 static int armada_37xx_gpiochip_register(struct udevice *parent,
580 struct armada_37xx_pinctrl *info)
582 const void *blob = gd->fdt_blob;
583 int node = dev_of_offset(parent);
584 struct uclass_driver *drv;
590 /* FIXME: Should not need to lookup GPIO uclass */
591 drv = lists_uclass_lookup(UCLASS_GPIO);
593 puts("Cannot find GPIO driver\n");
597 /* FIXME: Use livtree and check the result of device_bind() below */
598 fdt_for_each_subnode(subnode, blob, node) {
599 if (fdtdec_get_bool(blob, subnode, "gpio-controller")) {
607 name = calloc(1, 32);
608 sprintf(name, "armada-37xx-gpio");
610 /* Create child device UCLASS_GPIO and bind it */
611 device_bind(parent, &armada_37xx_gpio_driver, name, NULL,
612 offset_to_ofnode(subnode), &dev);
617 static const struct pinctrl_ops armada_37xx_pinctrl_ops = {
618 .get_groups_count = armada_37xx_pmx_get_groups_count,
619 .get_group_name = armada_37xx_pmx_get_group_name,
620 .get_functions_count = armada_37xx_pmx_get_funcs_count,
621 .get_function_name = armada_37xx_pmx_get_func_name,
622 .pinmux_group_set = armada_37xx_pmx_group_set,
623 .gpio_request_enable = armada_37xx_pmx_gpio_request_enable,
624 .gpio_disable_free = armada_37xx_pmx_gpio_disable_free,
625 .set_state = pinctrl_generic_set_state,
628 static int armada_37xx_pinctrl_probe(struct udevice *dev)
630 struct armada_37xx_pinctrl *info = dev_get_priv(dev);
631 const struct armada_37xx_pin_data *pin_data;
634 info->data = (struct armada_37xx_pin_data *)dev_get_driver_data(dev);
635 pin_data = info->data;
637 info->base = dev_read_addr_ptr(dev);
639 pr_err("unable to find regmap\n");
644 * we allocate functions for number of pins and hope there are
645 * fewer unique functions than pins available
647 info->funcs = devm_kzalloc(info->dev, pin_data->nr_pins *
648 sizeof(struct armada_37xx_pmx_func), GFP_KERNEL);
653 ret = armada_37xx_fill_group(info);
657 ret = armada_37xx_fill_func(info);
661 ret = armada_37xx_gpiochip_register(dev, info);
668 static const struct udevice_id armada_37xx_pinctrl_of_match[] = {
670 .compatible = "marvell,armada3710-sb-pinctrl",
671 .data = (ulong)&armada_37xx_pin_sb,
674 .compatible = "marvell,armada3710-nb-pinctrl",
675 .data = (ulong)&armada_37xx_pin_nb,
680 U_BOOT_DRIVER(armada_37xx_pinctrl) = {
681 .name = "armada-37xx-pinctrl",
682 .id = UCLASS_PINCTRL,
683 .of_match = of_match_ptr(armada_37xx_pinctrl_of_match),
684 .probe = armada_37xx_pinctrl_probe,
685 .priv_auto = sizeof(struct armada_37xx_pinctrl),
686 .ops = &armada_37xx_pinctrl_ops,