// SPDX-License-Identifier: GPL-2.0+ /* * U-Boot Marvell 37xx SoC pinctrl driver * * Copyright (C) 2017 Stefan Roese * * This driver is based on the Linux driver version, which is: * Copyright (C) 2017 Marvell * Gregory CLEMENT * * Additionally parts are derived from the Meson U-Boot pinctrl driver, * which is: * (C) Copyright 2016 - Beniamino Galvani * Based on code from Linux kernel: * Copyright (C) 2016 Endless Mobile, Inc. * https://spdx.org/licenses */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include DECLARE_GLOBAL_DATA_PTR; #define OUTPUT_EN 0x0 #define INPUT_VAL 0x10 #define OUTPUT_VAL 0x18 #define OUTPUT_CTL 0x20 #define SELECTION 0x30 #define IRQ_EN 0x0 #define IRQ_POL 0x08 #define IRQ_STATUS 0x10 #define IRQ_WKUP 0x18 #define NB_FUNCS 3 #define GPIO_PER_REG 32 /** * struct armada_37xx_pin_group: represents group of pins of a pinmux function. * The pins of a pinmux groups are composed of one or two groups of contiguous * pins. * @name: Name of the pin group, used to lookup the group. * @start_pins: Index of the first pin of the main range of pins belonging to * the group * @npins: Number of pins included in the first range * @reg_mask: Bit mask matching the group in the selection register * @extra_pins: Index of the first pin of the optional second range of pins * belonging to the group * @npins: Number of pins included in the second optional range * @funcs: A list of pinmux functions that can be selected for this group. */ struct armada_37xx_pin_group { const char *name; unsigned int start_pin; unsigned int npins; u32 reg_mask; u32 val[NB_FUNCS]; unsigned int extra_pin; unsigned int extra_npins; const char *funcs[NB_FUNCS]; }; struct armada_37xx_pin_data { u8 nr_pins; char *name; struct armada_37xx_pin_group *groups; int ngroups; }; struct armada_37xx_pmx_func { const char *name; const char **groups; unsigned int ngroups; }; struct armada_37xx_pinctrl { void __iomem *base; const struct armada_37xx_pin_data *data; struct udevice *dev; struct pinctrl_dev *pctl_dev; struct armada_37xx_pmx_func *funcs; unsigned int nfuncs; }; #define PIN_GRP_GPIO_0(_name, _start, _nr) \ { \ .name = _name, \ .start_pin = _start, \ .npins = _nr, \ .reg_mask = 0, \ .val = {0}, \ .funcs = {"gpio"} \ } #define PIN_GRP_GPIO(_name, _start, _nr, _mask, _func1) \ { \ .name = _name, \ .start_pin = _start, \ .npins = _nr, \ .reg_mask = _mask, \ .val = {0, _mask}, \ .funcs = {_func1, "gpio"} \ } #define PIN_GRP_GPIO_2(_name, _start, _nr, _mask, _val1, _val2, _func1) \ { \ .name = _name, \ .start_pin = _start, \ .npins = _nr, \ .reg_mask = _mask, \ .val = {_val1, _val2}, \ .funcs = {_func1, "gpio"} \ } #define PIN_GRP_GPIO_3(_name, _start, _nr, _mask, _v1, _v2, _v3, _f1, _f2) \ { \ .name = _name, \ .start_pin = _start, \ .npins = _nr, \ .reg_mask = _mask, \ .val = {_v1, _v2, _v3}, \ .funcs = {_f1, _f2, "gpio"} \ } #define PIN_GRP_EXTRA(_name, _start, _nr, _mask, _v1, _v2, _start2, _nr2, \ _f1, _f2) \ { \ .name = _name, \ .start_pin = _start, \ .npins = _nr, \ .reg_mask = _mask, \ .val = {_v1, _v2}, \ .extra_pin = _start2, \ .extra_npins = _nr2, \ .funcs = {_f1, _f2} \ } static struct armada_37xx_pin_group armada_37xx_nb_groups[] = { PIN_GRP_GPIO("jtag", 20, 5, BIT(0), "jtag"), PIN_GRP_GPIO("sdio0", 8, 3, BIT(1), "sdio"), PIN_GRP_GPIO("emmc_nb", 27, 9, BIT(2), "emmc"), PIN_GRP_GPIO_3("pwm0", 11, 1, BIT(3) | BIT(20), 0, BIT(20), BIT(3), "pwm", "led"), PIN_GRP_GPIO_3("pwm1", 12, 1, BIT(4) | BIT(21), 0, BIT(21), BIT(4), "pwm", "led"), PIN_GRP_GPIO_3("pwm2", 13, 1, BIT(5) | BIT(22), 0, BIT(22), BIT(5), "pwm", "led"), PIN_GRP_GPIO_3("pwm3", 14, 1, BIT(6) | BIT(23), 0, BIT(23), BIT(6), "pwm", "led"), PIN_GRP_GPIO("pmic1", 7, 1, BIT(7), "pmic"), PIN_GRP_GPIO("pmic0", 6, 1, BIT(8), "pmic"), PIN_GRP_GPIO_0("gpio1_5", 5, 1), PIN_GRP_GPIO("i2c2", 2, 2, BIT(9), "i2c"), PIN_GRP_GPIO("i2c1", 0, 2, BIT(10), "i2c"), PIN_GRP_GPIO("spi_cs1", 17, 1, BIT(12), "spi"), PIN_GRP_GPIO_2("spi_cs2", 18, 1, BIT(13) | BIT(19), 0, BIT(13), "spi"), PIN_GRP_GPIO_2("spi_cs3", 19, 1, BIT(14) | BIT(19), 0, BIT(14), "spi"), PIN_GRP_GPIO("onewire", 4, 1, BIT(16), "onewire"), PIN_GRP_GPIO("uart1", 25, 2, BIT(17), "uart"), PIN_GRP_GPIO("spi_quad", 15, 2, BIT(18), "spi"), PIN_GRP_EXTRA("uart2", 9, 2, BIT(1) | BIT(13) | BIT(14) | BIT(19), BIT(1) | BIT(13) | BIT(14), BIT(1) | BIT(19), 18, 2, "gpio", "uart"), }; static struct armada_37xx_pin_group armada_37xx_sb_groups[] = { PIN_GRP_GPIO("usb32_drvvbus0", 0, 1, BIT(0), "drvbus"), PIN_GRP_GPIO("usb2_drvvbus1", 1, 1, BIT(1), "drvbus"), PIN_GRP_GPIO_0("gpio2_2", 2, 1), PIN_GRP_GPIO("sdio_sb", 24, 6, BIT(2), "sdio"), PIN_GRP_GPIO("rgmii", 6, 12, BIT(3), "mii"), PIN_GRP_GPIO("smi", 18, 2, BIT(4), "smi"), PIN_GRP_GPIO("pcie1", 3, 1, BIT(5), "pcie"), /* this actually controls "pcie1_reset" */ PIN_GRP_GPIO("pcie1_clkreq", 4, 1, BIT(9), "pcie"), PIN_GRP_GPIO("pcie1_wakeup", 5, 1, BIT(10), "pcie"), PIN_GRP_GPIO("ptp", 20, 1, BIT(11), "ptp"), PIN_GRP_GPIO_3("ptp_clk", 21, 1, BIT(6) | BIT(12), 0, BIT(6), BIT(12), "ptp", "mii"), PIN_GRP_GPIO_3("ptp_trig", 22, 1, BIT(7) | BIT(13), 0, BIT(7), BIT(13), "ptp", "mii"), PIN_GRP_GPIO_3("mii_col", 23, 1, BIT(8) | BIT(14), 0, BIT(8), BIT(14), "mii", "mii_err"), }; static const struct armada_37xx_pin_data armada_37xx_pin_nb = { .nr_pins = 36, .name = "GPIO1", .groups = armada_37xx_nb_groups, .ngroups = ARRAY_SIZE(armada_37xx_nb_groups), }; static const struct armada_37xx_pin_data armada_37xx_pin_sb = { .nr_pins = 30, .name = "GPIO2", .groups = armada_37xx_sb_groups, .ngroups = ARRAY_SIZE(armada_37xx_sb_groups), }; static inline void armada_37xx_update_reg(unsigned int *reg, unsigned int *offset) { /* We never have more than 2 registers */ if (*offset >= GPIO_PER_REG) { *offset -= GPIO_PER_REG; *reg += sizeof(u32); } } static int armada_37xx_get_func_reg(struct armada_37xx_pin_group *grp, const char *func) { int f; for (f = 0; (f < NB_FUNCS) && grp->funcs[f]; f++) if (!strcmp(grp->funcs[f], func)) return f; return -ENOTSUPP; } static int armada_37xx_pmx_get_groups_count(struct udevice *dev) { struct armada_37xx_pinctrl *info = dev_get_priv(dev); return info->data->ngroups; } static const char *armada_37xx_pmx_dummy_name = "_dummy"; static const char *armada_37xx_pmx_get_group_name(struct udevice *dev, unsigned selector) { struct armada_37xx_pinctrl *info = dev_get_priv(dev); if (!info->data->groups[selector].name) return armada_37xx_pmx_dummy_name; return info->data->groups[selector].name; } static int armada_37xx_pmx_get_funcs_count(struct udevice *dev) { struct armada_37xx_pinctrl *info = dev_get_priv(dev); return info->nfuncs; } static const char *armada_37xx_pmx_get_func_name(struct udevice *dev, unsigned selector) { struct armada_37xx_pinctrl *info = dev_get_priv(dev); return info->funcs[selector].name; } static int armada_37xx_pmx_set_by_name(struct udevice *dev, const char *name, struct armada_37xx_pin_group *grp, bool warn_on_change) { struct armada_37xx_pinctrl *info = dev_get_priv(dev); unsigned int reg = SELECTION; unsigned int mask = grp->reg_mask; int func, val, old_func; dev_dbg(info->dev, "enable function %s group %s\n", name, grp->name); func = armada_37xx_get_func_reg(grp, name); if (func < 0) return func; val = grp->val[func]; if (warn_on_change && val != (readl(info->base + reg) & mask)) { for (old_func = 0; (old_func < NB_FUNCS) && grp->funcs[old_func]; old_func++) { if (grp->val[old_func] == val) break; } dev_warn(info->dev, "Warning: Changing MPPs %u-%u function from %s to %s...\n", grp->start_pin, grp->start_pin + grp->npins - 1, ((old_func < NB_FUNCS && grp->funcs[old_func]) ? grp->funcs[old_func] : "unknown"), name); } clrsetbits_le32(info->base + reg, mask, val); return 0; } static int armada_37xx_pmx_group_set(struct udevice *dev, unsigned group_selector, unsigned func_selector) { struct armada_37xx_pinctrl *info = dev_get_priv(dev); struct armada_37xx_pin_group *grp = &info->data->groups[group_selector]; const char *name = info->funcs[func_selector].name; return armada_37xx_pmx_set_by_name(dev, name, grp, false); } static int armada_37xx_pmx_gpio_request_enable(struct udevice *dev, unsigned int selector) { struct armada_37xx_pinctrl *info = dev_get_priv(dev); int ret = -ENOTSUPP; int n; /* Find all groups where is requested selector pin and set each group to gpio function */ for (n = 0; n < info->data->ngroups; n++) { struct armada_37xx_pin_group *grp = &info->data->groups[n]; if ((selector >= grp->start_pin && selector < grp->start_pin + grp->npins) || (selector >= grp->extra_pin && selector < grp->extra_pin + grp->extra_npins)) { ret = armada_37xx_pmx_set_by_name(dev, "gpio", grp, true); if (ret) return ret; } } return ret; } static int armada_37xx_pmx_gpio_disable_free(struct udevice *dev, unsigned int selector) { /* nothing to do */ return 0; } static int armada_37xx_pmx_get_pins_count(struct udevice *dev) { struct armada_37xx_pinctrl *info = dev_get_priv(dev); return info->data->nr_pins; } static const char *armada_37xx_pmx_get_pin_name(struct udevice *dev, unsigned int selector) { struct armada_37xx_pinctrl *info = dev_get_priv(dev); static char buf[sizeof("MPPx_XX")]; sprintf(buf, "MPP%c_%u", info->data->name[4], selector); return buf; } static int armada_37xx_pmx_get_pin_muxing(struct udevice *dev, unsigned int selector, char *buf, int size) { struct armada_37xx_pinctrl *info = dev_get_priv(dev); int n; /* * First check if selected pin is in some extra pin group. * Function in extra pin group is active only when it is not gpio. */ for (n = 0; n < info->data->ngroups; n++) { struct armada_37xx_pin_group *grp = &info->data->groups[n]; if (selector >= grp->extra_pin && selector < grp->extra_pin + grp->extra_npins) { unsigned int reg = SELECTION; unsigned int mask = grp->reg_mask; int f, val; val = (readl(info->base + reg) & mask); for (f = 0; f < NB_FUNCS && grp->funcs[f]; f++) { if (grp->val[f] == val) { if (strcmp(grp->funcs[f], "gpio") != 0) { strlcpy(buf, grp->funcs[f], size); return 0; } break; } } } } /* If pin is not active in some extra pin group then check regular groups. */ for (n = 0; n < info->data->ngroups; n++) { struct armada_37xx_pin_group *grp = &info->data->groups[n]; if (selector >= grp->start_pin && selector < grp->start_pin + grp->npins) { unsigned int reg = SELECTION; unsigned int mask = grp->reg_mask; int f, val; val = (readl(info->base + reg) & mask); for (f = 0; f < NB_FUNCS && grp->funcs[f]; f++) { if (grp->val[f] == val) { /* * In more cases group name consist of * function name followed by function * number. So if function name is just * prefix of group name, show group name. */ if (strncmp(grp->name, grp->funcs[f], strlen(grp->funcs[f])) == 0) strlcpy(buf, grp->name, size); else strlcpy(buf, grp->funcs[f], size); return 0; } } strlcpy(buf, "unknown", size); return 0; } } strlcpy(buf, "unknown", size); return 0; } /** * armada_37xx_add_function() - Add a new function to the list * @funcs: array of function to add the new one * @funcsize: size of the remaining space for the function * @name: name of the function to add * * If it is a new function then create it by adding its name else * increment the number of group associated to this function. */ static int armada_37xx_add_function(struct armada_37xx_pmx_func *funcs, int *funcsize, const char *name) { int i = 0; if (*funcsize <= 0) return -EOVERFLOW; while (funcs->ngroups) { /* function already there */ if (strcmp(funcs->name, name) == 0) { funcs->ngroups++; return -EEXIST; } funcs++; i++; } /* append new unique function */ funcs->name = name; funcs->ngroups = 1; (*funcsize)--; return 0; } /** * armada_37xx_fill_group() - complete the group array * @info: info driver instance * * Based on the data available from the armada_37xx_pin_group array * completes the last member of the struct for each function: the list * of the groups associated to this function. * */ static int armada_37xx_fill_group(struct armada_37xx_pinctrl *info) { int n, num = 0, funcsize = info->data->nr_pins; for (n = 0; n < info->data->ngroups; n++) { struct armada_37xx_pin_group *grp = &info->data->groups[n]; int f; for (f = 0; (f < NB_FUNCS) && grp->funcs[f]; f++) { int ret; /* check for unique functions and count groups */ ret = armada_37xx_add_function(info->funcs, &funcsize, grp->funcs[f]); if (ret == -EOVERFLOW) dev_err(info->dev, "More functions than pins(%d)\n", info->data->nr_pins); if (ret < 0) continue; num++; } } info->nfuncs = num; return 0; } /** * armada_37xx_fill_funcs() - complete the funcs array * @info: info driver instance * * Based on the data available from the armada_37xx_pin_group array * completes the last two member of the struct for each group: * - the list of the pins included in the group * - the list of pinmux functions that can be selected for this group * */ static int armada_37xx_fill_func(struct armada_37xx_pinctrl *info) { struct armada_37xx_pmx_func *funcs = info->funcs; int n; for (n = 0; n < info->nfuncs; n++) { const char *name = funcs[n].name; const char **groups; int g; funcs[n].groups = devm_kzalloc(info->dev, funcs[n].ngroups * sizeof(*(funcs[n].groups)), GFP_KERNEL); if (!funcs[n].groups) return -ENOMEM; groups = funcs[n].groups; for (g = 0; g < info->data->ngroups; g++) { struct armada_37xx_pin_group *gp = &info->data->groups[g]; int f; for (f = 0; (f < NB_FUNCS) && gp->funcs[f]; f++) { if (strcmp(gp->funcs[f], name) == 0) { *groups = gp->name; groups++; } } } } return 0; } static int armada_37xx_gpio_get(struct udevice *dev, unsigned int offset) { struct armada_37xx_pinctrl *info = dev_get_priv(dev->parent); unsigned int reg = INPUT_VAL; unsigned int val, mask; armada_37xx_update_reg(®, &offset); mask = BIT(offset); val = readl(info->base + reg); return (val & mask) != 0; } static int armada_37xx_gpio_set(struct udevice *dev, unsigned int offset, int value) { struct armada_37xx_pinctrl *info = dev_get_priv(dev->parent); unsigned int reg = OUTPUT_VAL; unsigned int mask, val; armada_37xx_update_reg(®, &offset); mask = BIT(offset); val = value ? mask : 0; clrsetbits_le32(info->base + reg, mask, val); return 0; } static int armada_37xx_gpio_get_direction(struct udevice *dev, unsigned int offset) { struct armada_37xx_pinctrl *info = dev_get_priv(dev->parent); unsigned int reg = OUTPUT_EN; unsigned int val, mask; armada_37xx_update_reg(®, &offset); mask = BIT(offset); val = readl(info->base + reg); if (val & mask) return GPIOF_OUTPUT; else return GPIOF_INPUT; } static int armada_37xx_gpio_direction_input(struct udevice *dev, unsigned int offset) { struct armada_37xx_pinctrl *info = dev_get_priv(dev->parent); unsigned int reg = OUTPUT_EN; unsigned int mask; armada_37xx_update_reg(®, &offset); mask = BIT(offset); clrbits_le32(info->base + reg, mask); return 0; } static int armada_37xx_gpio_direction_output(struct udevice *dev, unsigned int offset, int value) { struct armada_37xx_pinctrl *info = dev_get_priv(dev->parent); unsigned int reg = OUTPUT_EN; unsigned int mask; armada_37xx_update_reg(®, &offset); mask = BIT(offset); setbits_le32(info->base + reg, mask); /* And set the requested value */ return armada_37xx_gpio_set(dev, offset, value); } static int armada_37xx_gpio_probe(struct udevice *dev) { struct armada_37xx_pinctrl *info = dev_get_priv(dev->parent); struct gpio_dev_priv *uc_priv; uc_priv = dev_get_uclass_priv(dev); uc_priv->bank_name = info->data->name; uc_priv->gpio_count = info->data->nr_pins; return 0; } static const struct dm_gpio_ops armada_37xx_gpio_ops = { .request = pinctrl_gpio_request, .rfree = pinctrl_gpio_free, .set_value = armada_37xx_gpio_set, .get_value = armada_37xx_gpio_get, .get_function = armada_37xx_gpio_get_direction, .direction_input = armada_37xx_gpio_direction_input, .direction_output = armada_37xx_gpio_direction_output, }; static struct driver armada_37xx_gpio_driver = { .name = "armada-37xx-gpio", .id = UCLASS_GPIO, .probe = armada_37xx_gpio_probe, .ops = &armada_37xx_gpio_ops, }; static int armada_37xx_gpiochip_register(struct udevice *parent, struct armada_37xx_pinctrl *info) { const void *blob = gd->fdt_blob; int node = dev_of_offset(parent); struct uclass_driver *drv; struct udevice *dev; int ret = -ENODEV; int subnode; char *name; /* FIXME: Should not need to lookup GPIO uclass */ drv = lists_uclass_lookup(UCLASS_GPIO); if (!drv) { puts("Cannot find GPIO driver\n"); return -ENOENT; } /* FIXME: Use livtree and check the result of device_bind() below */ fdt_for_each_subnode(subnode, blob, node) { if (fdtdec_get_bool(blob, subnode, "gpio-controller")) { ret = 0; break; } }; if (ret) return ret; name = calloc(1, 32); sprintf(name, "armada-37xx-gpio"); /* Create child device UCLASS_GPIO and bind it */ device_bind(parent, &armada_37xx_gpio_driver, name, NULL, offset_to_ofnode(subnode), &dev); return 0; } static const struct pinctrl_ops armada_37xx_pinctrl_ops = { .get_pins_count = armada_37xx_pmx_get_pins_count, .get_pin_name = armada_37xx_pmx_get_pin_name, .get_pin_muxing = armada_37xx_pmx_get_pin_muxing, .get_groups_count = armada_37xx_pmx_get_groups_count, .get_group_name = armada_37xx_pmx_get_group_name, .get_functions_count = armada_37xx_pmx_get_funcs_count, .get_function_name = armada_37xx_pmx_get_func_name, .pinmux_group_set = armada_37xx_pmx_group_set, .gpio_request_enable = armada_37xx_pmx_gpio_request_enable, .gpio_disable_free = armada_37xx_pmx_gpio_disable_free, .set_state = pinctrl_generic_set_state, }; static int armada_37xx_pinctrl_probe(struct udevice *dev) { struct armada_37xx_pinctrl *info = dev_get_priv(dev); const struct armada_37xx_pin_data *pin_data; int ret; info->data = (struct armada_37xx_pin_data *)dev_get_driver_data(dev); pin_data = info->data; info->base = dev_read_addr_ptr(dev); if (!info->base) { pr_err("unable to find regmap\n"); return -ENODEV; } /* * we allocate functions for number of pins and hope there are * fewer unique functions than pins available */ info->funcs = devm_kzalloc(info->dev, pin_data->nr_pins * sizeof(struct armada_37xx_pmx_func), GFP_KERNEL); if (!info->funcs) return -ENOMEM; ret = armada_37xx_fill_group(info); if (ret) return ret; ret = armada_37xx_fill_func(info); if (ret) return ret; ret = armada_37xx_gpiochip_register(dev, info); if (ret) return ret; return 0; } static int armada_37xx_pinctrl_bind(struct udevice *dev) { /* * Make sure that the pinctrl driver gets probed after binding * as on A37XX the pinctrl driver is the one that is also * registering the GPIO one during probe, so if its not probed * GPIO-s are not registered as well. */ dev_or_flags(dev, DM_FLAG_PROBE_AFTER_BIND); return 0; } static const struct udevice_id armada_37xx_pinctrl_of_match[] = { { .compatible = "marvell,armada3710-sb-pinctrl", .data = (ulong)&armada_37xx_pin_sb, }, { .compatible = "marvell,armada3710-nb-pinctrl", .data = (ulong)&armada_37xx_pin_nb, }, { /* sentinel */ } }; U_BOOT_DRIVER(armada_37xx_pinctrl) = { .name = "armada-37xx-pinctrl", .id = UCLASS_PINCTRL, .of_match = of_match_ptr(armada_37xx_pinctrl_of_match), .probe = armada_37xx_pinctrl_probe, .bind = armada_37xx_pinctrl_bind, .priv_auto = sizeof(struct armada_37xx_pinctrl), .ops = &armada_37xx_pinctrl_ops, };