drivers/pinctrl/mvebu/pinctrl-armada-37xx.c

   1 /*
   2  * Marvell 37xx SoC pinctrl driver
   3  *
   4  * Copyright (C) 2017 Marvell
   5  *
   6  * Gregory CLEMENT <gregory.clement@free-electrons.com>
   7  *
   8  * This file is licensed under the terms of the GNU General Public
   9  * License version 2 or later. This program is licensed "as is"
  10  * without any warranty of any kind, whether express or implied.
  11  */
  12
  13 #include <linux/gpio/driver.h>
  14 #include <linux/mfd/syscon.h>
  15 #include <linux/of.h>
  16 #include <linux/of_address.h>
  17 #include <linux/of_device.h>
  18 #include <linux/of_irq.h>
  19 #include <linux/pinctrl/pinconf-generic.h>
  20 #include <linux/pinctrl/pinconf.h>
  21 #include <linux/pinctrl/pinctrl.h>
  22 #include <linux/pinctrl/pinmux.h>
  23 #include <linux/platform_device.h>
  24 #include <linux/regmap.h>
  25 #include <linux/slab.h>
  26
  27 #include "../pinctrl-utils.h"
  28
  29 #define OUTPUT_EN       0x0
  30 #define INPUT_VAL       0x10
  31 #define OUTPUT_VAL      0x18
  32 #define OUTPUT_CTL      0x20
  33 #define SELECTION       0x30
  34
  35 #define IRQ_EN          0x0
  36 #define IRQ_POL         0x08
  37 #define IRQ_STATUS      0x10
  38 #define IRQ_WKUP        0x18
  39
  40 #define NB_FUNCS 3
  41 #define GPIO_PER_REG    32
  42
  43 /**
  44  * struct armada_37xx_pin_group: represents group of pins of a pinmux function.
  45  * The pins of a pinmux groups are composed of one or two groups of contiguous
  46  * pins.
  47  * @name:       Name of the pin group, used to lookup the group.
  48  * @start_pin:  Index of the first pin of the main range of pins belonging to
  49  *              the group
  50  * @npins:      Number of pins included in the first range
  51  * @reg_mask:   Bit mask matching the group in the selection register
  52  * @val:        Value to write to the registers for a given function
  53  * @extra_pin:  Index of the first pin of the optional second range of pins
  54  *              belonging to the group
  55  * @extra_npins:Number of pins included in the second optional range
  56  * @funcs:      A list of pinmux functions that can be selected for this group.
  57  * @pins:       List of the pins included in the group
  58  */
  59 struct armada_37xx_pin_group {
  60         const char      *name;
  61         unsigned int    start_pin;
  62         unsigned int    npins;
  63         u32             reg_mask;
  64         u32             val[NB_FUNCS];
  65         unsigned int    extra_pin;
  66         unsigned int    extra_npins;
  67         const char      *funcs[NB_FUNCS];
  68         unsigned int    *pins;
  69 };
  70
  71 struct armada_37xx_pin_data {
  72         u8                              nr_pins;
  73         char                            *name;
  74         struct armada_37xx_pin_group    *groups;
  75         int                             ngroups;
  76 };
  77
  78 struct armada_37xx_pmx_func {
  79         const char              *name;
  80         const char              **groups;
  81         unsigned int            ngroups;
  82 };
  83
  84 struct armada_37xx_pm_state {
  85         u32 out_en_l;
  86         u32 out_en_h;
  87         u32 out_val_l;
  88         u32 out_val_h;
  89         u32 irq_en_l;
  90         u32 irq_en_h;
  91         u32 irq_pol_l;
  92         u32 irq_pol_h;
  93         u32 selection;
  94 };
  95
  96 struct armada_37xx_pinctrl {
  97         struct regmap                   *regmap;
  98         void __iomem                    *base;
  99         const struct armada_37xx_pin_data       *data;
 100         struct device                   *dev;
 101         struct gpio_chip                gpio_chip;
 102         struct irq_chip                 irq_chip;
 103         spinlock_t                      irq_lock;
 104         struct pinctrl_desc             pctl;
 105         struct pinctrl_dev              *pctl_dev;
 106         struct armada_37xx_pin_group    *groups;
 107         unsigned int                    ngroups;
 108         struct armada_37xx_pmx_func     *funcs;
 109         unsigned int                    nfuncs;
 110         struct armada_37xx_pm_state     pm;
 111 };
 112
 113 #define PIN_GRP(_name, _start, _nr, _mask, _func1, _func2)      \
 114         {                                       \
 115                 .name = _name,                  \
 116                 .start_pin = _start,            \
 117                 .npins = _nr,                   \
 118                 .reg_mask = _mask,              \
 119                 .val = {0, _mask},              \
 120                 .funcs = {_func1, _func2}       \
 121         }
 122
 123 #define PIN_GRP_GPIO(_name, _start, _nr, _mask, _func1) \
 124         {                                       \
 125                 .name = _name,                  \
 126                 .start_pin = _start,            \
 127                 .npins = _nr,                   \
 128                 .reg_mask = _mask,              \
 129                 .val = {0, _mask},              \
 130                 .funcs = {_func1, "gpio"}       \
 131         }
 132
 133 #define PIN_GRP_GPIO_2(_name, _start, _nr, _mask, _val1, _val2, _func1)   \
 134         {                                       \
 135                 .name = _name,                  \
 136                 .start_pin = _start,            \
 137                 .npins = _nr,                   \
 138                 .reg_mask = _mask,              \
 139                 .val = {_val1, _val2},          \
 140                 .funcs = {_func1, "gpio"}       \
 141         }
 142
 143 #define PIN_GRP_GPIO_3(_name, _start, _nr, _mask, _v1, _v2, _v3, _f1, _f2) \
 144         {                                       \
 145                 .name = _name,                  \
 146                 .start_pin = _start,            \
 147                 .npins = _nr,                   \
 148                 .reg_mask = _mask,              \
 149                 .val = {_v1, _v2, _v3}, \
 150                 .funcs = {_f1, _f2, "gpio"}     \
 151         }
 152
 153 #define PIN_GRP_EXTRA(_name, _start, _nr, _mask, _v1, _v2, _start2, _nr2, \
 154                       _f1, _f2)                         \
 155         {                                               \
 156                 .name = _name,                          \
 157                 .start_pin = _start,                    \
 158                 .npins = _nr,                           \
 159                 .reg_mask = _mask,                      \
 160                 .val = {_v1, _v2},                      \
 161                 .extra_pin = _start2,                   \
 162                 .extra_npins = _nr2,                    \
 163                 .funcs = {_f1, _f2}                     \
 164         }
 165
 166 static struct armada_37xx_pin_group armada_37xx_nb_groups[] = {
 167         PIN_GRP_GPIO("jtag", 20, 5, BIT(0), "jtag"),
 168         PIN_GRP_GPIO("sdio0", 8, 3, BIT(1), "sdio"),
 169         PIN_GRP_GPIO("emmc_nb", 27, 9, BIT(2), "emmc"),
 170         PIN_GRP_GPIO_3("pwm0", 11, 1, BIT(3) | BIT(20), 0, BIT(20), BIT(3),
 171                        "pwm", "led"),
 172         PIN_GRP_GPIO_3("pwm1", 12, 1, BIT(4) | BIT(21), 0, BIT(21), BIT(4),
 173                        "pwm", "led"),
 174         PIN_GRP_GPIO_3("pwm2", 13, 1, BIT(5) | BIT(22), 0, BIT(22), BIT(5),
 175                        "pwm", "led"),
 176         PIN_GRP_GPIO_3("pwm3", 14, 1, BIT(6) | BIT(23), 0, BIT(23), BIT(6),
 177                        "pwm", "led"),
 178         PIN_GRP_GPIO("pmic1", 7, 1, BIT(7), "pmic"),
 179         PIN_GRP_GPIO("pmic0", 6, 1, BIT(8), "pmic"),
 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"),
 191 };
 192
 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("sdio_sb", 24, 6, BIT(2), "sdio"),
 197         PIN_GRP_GPIO("rgmii", 6, 12, BIT(3), "mii"),
 198         PIN_GRP_GPIO("smi", 18, 2, BIT(4), "smi"),
 199         PIN_GRP_GPIO("pcie1", 3, 1, BIT(5), "pcie"), /* this actually controls "pcie1_reset" */
 200         PIN_GRP_GPIO("pcie1_clkreq", 4, 1, BIT(9), "pcie"),
 201         PIN_GRP_GPIO("pcie1_wakeup", 5, 1, BIT(10), "pcie"),
 202         PIN_GRP_GPIO("ptp", 20, 3, BIT(11) | BIT(12) | BIT(13), "ptp"),
 203         PIN_GRP("ptp_clk", 21, 1, BIT(6), "ptp", "mii"),
 204         PIN_GRP("ptp_trig", 22, 1, BIT(7), "ptp", "mii"),
 205         PIN_GRP_GPIO_3("mii_col", 23, 1, BIT(8) | BIT(14), 0, BIT(8), BIT(14),
 206                        "mii", "mii_err"),
 207 };
 208
 209 static const struct armada_37xx_pin_data armada_37xx_pin_nb = {
 210         .nr_pins = 36,
 211         .name = "GPIO1",
 212         .groups = armada_37xx_nb_groups,
 213         .ngroups = ARRAY_SIZE(armada_37xx_nb_groups),
 214 };
 215
 216 static const struct armada_37xx_pin_data armada_37xx_pin_sb = {
 217         .nr_pins = 30,
 218         .name = "GPIO2",
 219         .groups = armada_37xx_sb_groups,
 220         .ngroups = ARRAY_SIZE(armada_37xx_sb_groups),
 221 };
 222
 223 static inline void armada_37xx_update_reg(unsigned int *reg,
 224                                           unsigned int *offset)
 225 {
 226         /* We never have more than 2 registers */
 227         if (*offset >= GPIO_PER_REG) {
 228                 *offset -= GPIO_PER_REG;
 229                 *reg += sizeof(u32);
 230         }
 231 }
 232
 233 static struct armada_37xx_pin_group *armada_37xx_find_next_grp_by_pin(
 234         struct armada_37xx_pinctrl *info, int pin, int *grp)
 235 {
 236         while (*grp < info->ngroups) {
 237                 struct armada_37xx_pin_group *group = &info->groups[*grp];
 238                 int j;
 239
 240                 *grp = *grp + 1;
 241                 for (j = 0; j < (group->npins + group->extra_npins); j++)
 242                         if (group->pins[j] == pin)
 243                                 return group;
 244         }
 245         return NULL;
 246 }
 247
 248 static int armada_37xx_pin_config_group_get(struct pinctrl_dev *pctldev,
 249                             unsigned int selector, unsigned long *config)
 250 {
 251         return -ENOTSUPP;
 252 }
 253
 254 static int armada_37xx_pin_config_group_set(struct pinctrl_dev *pctldev,
 255                             unsigned int selector, unsigned long *configs,
 256                             unsigned int num_configs)
 257 {
 258         return -ENOTSUPP;
 259 }
 260
 261 static const struct pinconf_ops armada_37xx_pinconf_ops = {
 262         .is_generic = true,
 263         .pin_config_group_get = armada_37xx_pin_config_group_get,
 264         .pin_config_group_set = armada_37xx_pin_config_group_set,
 265 };
 266
 267 static int armada_37xx_get_groups_count(struct pinctrl_dev *pctldev)
 268 {
 269         struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
 270
 271         return info->ngroups;
 272 }
 273
 274 static const char *armada_37xx_get_group_name(struct pinctrl_dev *pctldev,
 275                                               unsigned int group)
 276 {
 277         struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
 278
 279         return info->groups[group].name;
 280 }
 281
 282 static int armada_37xx_get_group_pins(struct pinctrl_dev *pctldev,
 283                                       unsigned int selector,
 284                                       const unsigned int **pins,
 285                                       unsigned int *npins)
 286 {
 287         struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
 288
 289         if (selector >= info->ngroups)
 290                 return -EINVAL;
 291
 292         *pins = info->groups[selector].pins;
 293         *npins = info->groups[selector].npins +
 294                 info->groups[selector].extra_npins;
 295
 296         return 0;
 297 }
 298
 299 static const struct pinctrl_ops armada_37xx_pctrl_ops = {
 300         .get_groups_count       = armada_37xx_get_groups_count,
 301         .get_group_name         = armada_37xx_get_group_name,
 302         .get_group_pins         = armada_37xx_get_group_pins,
 303         .dt_node_to_map         = pinconf_generic_dt_node_to_map_group,
 304         .dt_free_map            = pinctrl_utils_free_map,
 305 };
 306
 307 /*
 308  * Pinmux_ops handling
 309  */
 310
 311 static int armada_37xx_pmx_get_funcs_count(struct pinctrl_dev *pctldev)
 312 {
 313         struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
 314
 315         return info->nfuncs;
 316 }
 317
 318 static const char *armada_37xx_pmx_get_func_name(struct pinctrl_dev *pctldev,
 319                                                  unsigned int selector)
 320 {
 321         struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
 322
 323         return info->funcs[selector].name;
 324 }
 325
 326 static int armada_37xx_pmx_get_groups(struct pinctrl_dev *pctldev,
 327                                       unsigned int selector,
 328                                       const char * const **groups,
 329                                       unsigned int * const num_groups)
 330 {
 331         struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
 332
 333         *groups = info->funcs[selector].groups;
 334         *num_groups = info->funcs[selector].ngroups;
 335
 336         return 0;
 337 }
 338
 339 static int armada_37xx_pmx_set_by_name(struct pinctrl_dev *pctldev,
 340                                        const char *name,
 341                                        struct armada_37xx_pin_group *grp)
 342 {
 343         struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
 344         struct device *dev = info->dev;
 345         unsigned int reg = SELECTION;
 346         unsigned int mask = grp->reg_mask;
 347         int func, val;
 348
 349         dev_dbg(dev, "enable function %s group %s\n", name, grp->name);
 350
 351         func = match_string(grp->funcs, NB_FUNCS, name);
 352         if (func < 0)
 353                 return -ENOTSUPP;
 354
 355         val = grp->val[func];
 356
 357         regmap_update_bits(info->regmap, reg, mask, val);
 358
 359         return 0;
 360 }
 361
 362 static int armada_37xx_pmx_set(struct pinctrl_dev *pctldev,
 363                                unsigned int selector,
 364                                unsigned int group)
 365 {
 366
 367         struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
 368         struct armada_37xx_pin_group *grp = &info->groups[group];
 369         const char *name = info->funcs[selector].name;
 370
 371         return armada_37xx_pmx_set_by_name(pctldev, name, grp);
 372 }
 373
 374 static inline void armada_37xx_irq_update_reg(unsigned int *reg,
 375                                           struct irq_data *d)
 376 {
 377         int offset = irqd_to_hwirq(d);
 378
 379         armada_37xx_update_reg(reg, &offset);
 380 }
 381
 382 static int armada_37xx_gpio_direction_input(struct gpio_chip *chip,
 383                                             unsigned int offset)
 384 {
 385         struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
 386         unsigned int reg = OUTPUT_EN;
 387         unsigned int mask;
 388
 389         armada_37xx_update_reg(&reg, &offset);
 390         mask = BIT(offset);
 391
 392         return regmap_update_bits(info->regmap, reg, mask, 0);
 393 }
 394
 395 static int armada_37xx_gpio_get_direction(struct gpio_chip *chip,
 396                                           unsigned int offset)
 397 {
 398         struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
 399         unsigned int reg = OUTPUT_EN;
 400         unsigned int val, mask;
 401
 402         armada_37xx_update_reg(&reg, &offset);
 403         mask = BIT(offset);
 404         regmap_read(info->regmap, reg, &val);
 405
 406         if (val & mask)
 407                 return GPIO_LINE_DIRECTION_OUT;
 408
 409         return GPIO_LINE_DIRECTION_IN;
 410 }
 411
 412 static int armada_37xx_gpio_direction_output(struct gpio_chip *chip,
 413                                              unsigned int offset, int value)
 414 {
 415         struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
 416         unsigned int reg = OUTPUT_EN;
 417         unsigned int mask, val, ret;
 418
 419         armada_37xx_update_reg(&reg, &offset);
 420         mask = BIT(offset);
 421
 422         ret = regmap_update_bits(info->regmap, reg, mask, mask);
 423
 424         if (ret)
 425                 return ret;
 426
 427         reg = OUTPUT_VAL;
 428         val = value ? mask : 0;
 429         regmap_update_bits(info->regmap, reg, mask, val);
 430
 431         return 0;
 432 }
 433
 434 static int armada_37xx_gpio_get(struct gpio_chip *chip, unsigned int offset)
 435 {
 436         struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
 437         unsigned int reg = INPUT_VAL;
 438         unsigned int val, mask;
 439
 440         armada_37xx_update_reg(&reg, &offset);
 441         mask = BIT(offset);
 442
 443         regmap_read(info->regmap, reg, &val);
 444
 445         return (val & mask) != 0;
 446 }
 447
 448 static void armada_37xx_gpio_set(struct gpio_chip *chip, unsigned int offset,
 449                                  int value)
 450 {
 451         struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
 452         unsigned int reg = OUTPUT_VAL;
 453         unsigned int mask, val;
 454
 455         armada_37xx_update_reg(&reg, &offset);
 456         mask = BIT(offset);
 457         val = value ? mask : 0;
 458
 459         regmap_update_bits(info->regmap, reg, mask, val);
 460 }
 461
 462 static int armada_37xx_pmx_gpio_set_direction(struct pinctrl_dev *pctldev,
 463                                               struct pinctrl_gpio_range *range,
 464                                               unsigned int offset, bool input)
 465 {
 466         struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
 467         struct gpio_chip *chip = range->gc;
 468
 469         dev_dbg(info->dev, "gpio_direction for pin %u as %s-%d to %s\n",
 470                 offset, range->name, offset, input ? "input" : "output");
 471
 472         if (input)
 473                 armada_37xx_gpio_direction_input(chip, offset);
 474         else
 475                 armada_37xx_gpio_direction_output(chip, offset, 0);
 476
 477         return 0;
 478 }
 479
 480 static int armada_37xx_gpio_request_enable(struct pinctrl_dev *pctldev,
 481                                            struct pinctrl_gpio_range *range,
 482                                            unsigned int offset)
 483 {
 484         struct armada_37xx_pinctrl *info = pinctrl_dev_get_drvdata(pctldev);
 485         struct armada_37xx_pin_group *group;
 486         int grp = 0;
 487
 488         dev_dbg(info->dev, "requesting gpio %d\n", offset);
 489
 490         while ((group = armada_37xx_find_next_grp_by_pin(info, offset, &grp)))
 491                 armada_37xx_pmx_set_by_name(pctldev, "gpio", group);
 492
 493         return 0;
 494 }
 495
 496 static const struct pinmux_ops armada_37xx_pmx_ops = {
 497         .get_functions_count    = armada_37xx_pmx_get_funcs_count,
 498         .get_function_name      = armada_37xx_pmx_get_func_name,
 499         .get_function_groups    = armada_37xx_pmx_get_groups,
 500         .set_mux                = armada_37xx_pmx_set,
 501         .gpio_request_enable    = armada_37xx_gpio_request_enable,
 502         .gpio_set_direction     = armada_37xx_pmx_gpio_set_direction,
 503 };
 504
 505 static const struct gpio_chip armada_37xx_gpiolib_chip = {
 506         .request = gpiochip_generic_request,
 507         .free = gpiochip_generic_free,
 508         .set = armada_37xx_gpio_set,
 509         .get = armada_37xx_gpio_get,
 510         .get_direction  = armada_37xx_gpio_get_direction,
 511         .direction_input = armada_37xx_gpio_direction_input,
 512         .direction_output = armada_37xx_gpio_direction_output,
 513         .owner = THIS_MODULE,
 514 };
 515
 516 static void armada_37xx_irq_ack(struct irq_data *d)
 517 {
 518         struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
 519         struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
 520         u32 reg = IRQ_STATUS;
 521         unsigned long flags;
 522
 523         armada_37xx_irq_update_reg(&reg, d);
 524         spin_lock_irqsave(&info->irq_lock, flags);
 525         writel(d->mask, info->base + reg);
 526         spin_unlock_irqrestore(&info->irq_lock, flags);
 527 }
 528
 529 static void armada_37xx_irq_mask(struct irq_data *d)
 530 {
 531         struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
 532         struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
 533         u32 val, reg = IRQ_EN;
 534         unsigned long flags;
 535
 536         armada_37xx_irq_update_reg(&reg, d);
 537         spin_lock_irqsave(&info->irq_lock, flags);
 538         val = readl(info->base + reg);
 539         writel(val & ~d->mask, info->base + reg);
 540         spin_unlock_irqrestore(&info->irq_lock, flags);
 541 }
 542
 543 static void armada_37xx_irq_unmask(struct irq_data *d)
 544 {
 545         struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
 546         struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
 547         u32 val, reg = IRQ_EN;
 548         unsigned long flags;
 549
 550         armada_37xx_irq_update_reg(&reg, d);
 551         spin_lock_irqsave(&info->irq_lock, flags);
 552         val = readl(info->base + reg);
 553         writel(val | d->mask, info->base + reg);
 554         spin_unlock_irqrestore(&info->irq_lock, flags);
 555 }
 556
 557 static int armada_37xx_irq_set_wake(struct irq_data *d, unsigned int on)
 558 {
 559         struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
 560         struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
 561         u32 val, reg = IRQ_WKUP;
 562         unsigned long flags;
 563
 564         armada_37xx_irq_update_reg(&reg, d);
 565         spin_lock_irqsave(&info->irq_lock, flags);
 566         val = readl(info->base + reg);
 567         if (on)
 568                 val |= (BIT(d->hwirq % GPIO_PER_REG));
 569         else
 570                 val &= ~(BIT(d->hwirq % GPIO_PER_REG));
 571         writel(val, info->base + reg);
 572         spin_unlock_irqrestore(&info->irq_lock, flags);
 573
 574         return 0;
 575 }
 576
 577 static int armada_37xx_irq_set_type(struct irq_data *d, unsigned int type)
 578 {
 579         struct gpio_chip *chip = irq_data_get_irq_chip_data(d);
 580         struct armada_37xx_pinctrl *info = gpiochip_get_data(chip);
 581         u32 val, reg = IRQ_POL;
 582         unsigned long flags;
 583
 584         spin_lock_irqsave(&info->irq_lock, flags);
 585         armada_37xx_irq_update_reg(&reg, d);
 586         val = readl(info->base + reg);
 587         switch (type) {
 588         case IRQ_TYPE_EDGE_RISING:
 589                 val &= ~(BIT(d->hwirq % GPIO_PER_REG));
 590                 break;
 591         case IRQ_TYPE_EDGE_FALLING:
 592                 val |= (BIT(d->hwirq % GPIO_PER_REG));
 593                 break;
 594         case IRQ_TYPE_EDGE_BOTH: {
 595                 u32 in_val, in_reg = INPUT_VAL;
 596
 597                 armada_37xx_irq_update_reg(&in_reg, d);
 598                 regmap_read(info->regmap, in_reg, &in_val);
 599
 600                 /* Set initial polarity based on current input level. */
 601                 if (in_val & BIT(d->hwirq % GPIO_PER_REG))
 602                         val |= BIT(d->hwirq % GPIO_PER_REG);    /* falling */
 603                 else
 604                         val &= ~(BIT(d->hwirq % GPIO_PER_REG)); /* rising */
 605                 break;
 606         }
 607         default:
 608                 spin_unlock_irqrestore(&info->irq_lock, flags);
 609                 return -EINVAL;
 610         }
 611         writel(val, info->base + reg);
 612         spin_unlock_irqrestore(&info->irq_lock, flags);
 613
 614         return 0;
 615 }
 616
 617 static int armada_37xx_edge_both_irq_swap_pol(struct armada_37xx_pinctrl *info,
 618                                              u32 pin_idx)
 619 {
 620         u32 reg_idx = pin_idx / GPIO_PER_REG;
 621         u32 bit_num = pin_idx % GPIO_PER_REG;
 622         u32 p, l, ret;
 623         unsigned long flags;
 624
 625         regmap_read(info->regmap, INPUT_VAL + 4*reg_idx, &l);
 626
 627         spin_lock_irqsave(&info->irq_lock, flags);
 628         p = readl(info->base + IRQ_POL + 4 * reg_idx);
 629         if ((p ^ l) & (1 << bit_num)) {
 630                 /*
 631                  * For the gpios which are used for both-edge irqs, when their
 632                  * interrupts happen, their input levels are changed,
 633                  * yet their interrupt polarities are kept in old values, we
 634                  * should synchronize their interrupt polarities; for example,
 635                  * at first a gpio's input level is low and its interrupt
 636                  * polarity control is "Detect rising edge", then the gpio has
 637                  * a interrupt , its level turns to high, we should change its
 638                  * polarity control to "Detect falling edge" correspondingly.
 639                  */
 640                 p ^= 1 << bit_num;
 641                 writel(p, info->base + IRQ_POL + 4 * reg_idx);
 642                 ret = 0;
 643         } else {
 644                 /* Spurious irq */
 645                 ret = -1;
 646         }
 647
 648         spin_unlock_irqrestore(&info->irq_lock, flags);
 649         return ret;
 650 }
 651
 652 static void armada_37xx_irq_handler(struct irq_desc *desc)
 653 {
 654         struct gpio_chip *gc = irq_desc_get_handler_data(desc);
 655         struct irq_chip *chip = irq_desc_get_chip(desc);
 656         struct armada_37xx_pinctrl *info = gpiochip_get_data(gc);
 657         struct irq_domain *d = gc->irq.domain;
 658         int i;
 659
 660         chained_irq_enter(chip, desc);
 661         for (i = 0; i <= d->revmap_size / GPIO_PER_REG; i++) {
 662                 u32 status;
 663                 unsigned long flags;
 664
 665                 spin_lock_irqsave(&info->irq_lock, flags);
 666                 status = readl_relaxed(info->base + IRQ_STATUS + 4 * i);
 667                 /* Manage only the interrupt that was enabled */
 668                 status &= readl_relaxed(info->base + IRQ_EN + 4 * i);
 669                 spin_unlock_irqrestore(&info->irq_lock, flags);
 670                 while (status) {
 671                         u32 hwirq = ffs(status) - 1;
 672                         u32 virq = irq_find_mapping(d, hwirq +
 673                                                      i * GPIO_PER_REG);
 674                         u32 t = irq_get_trigger_type(virq);
 675
 676                         if ((t & IRQ_TYPE_SENSE_MASK) == IRQ_TYPE_EDGE_BOTH) {
 677                                 /* Swap polarity (race with GPIO line) */
 678                                 if (armada_37xx_edge_both_irq_swap_pol(info,
 679                                         hwirq + i * GPIO_PER_REG)) {
 680                                         /*
 681                                          * For spurious irq, which gpio level
 682                                          * is not as expected after incoming
 683                                          * edge, just ack the gpio irq.
 684                                          */
 685                                         writel(1 << hwirq,
 686                                                info->base +
 687                                                IRQ_STATUS + 4 * i);
 688                                         goto update_status;
 689                                 }
 690                         }
 691
 692                         generic_handle_irq(virq);
 693
 694 update_status:
 695                         /* Update status in case a new IRQ appears */
 696                         spin_lock_irqsave(&info->irq_lock, flags);
 697                         status = readl_relaxed(info->base +
 698                                                IRQ_STATUS + 4 * i);
 699                         /* Manage only the interrupt that was enabled */
 700                         status &= readl_relaxed(info->base + IRQ_EN + 4 * i);
 701                         spin_unlock_irqrestore(&info->irq_lock, flags);
 702                 }
 703         }
 704         chained_irq_exit(chip, desc);
 705 }
 706
 707 static unsigned int armada_37xx_irq_startup(struct irq_data *d)
 708 {
 709         /*
 710          * The mask field is a "precomputed bitmask for accessing the
 711          * chip registers" which was introduced for the generic
 712          * irqchip framework. As we don't use this framework, we can
 713          * reuse this field for our own usage.
 714          */
 715         d->mask = BIT(d->hwirq % GPIO_PER_REG);
 716
 717         armada_37xx_irq_unmask(d);
 718
 719         return 0;
 720 }
 721
 722 static int armada_37xx_irqchip_register(struct platform_device *pdev,
 723                                         struct armada_37xx_pinctrl *info)
 724 {
 725         struct gpio_chip *gc = &info->gpio_chip;
 726         struct irq_chip *irqchip = &info->irq_chip;
 727         struct gpio_irq_chip *girq = &gc->irq;
 728         struct device *dev = &pdev->dev;
 729         struct device_node *np;
 730         int ret = -ENODEV, i, nr_irq_parent;
 731
 732         /* Check if we have at least one gpio-controller child node */
 733         for_each_child_of_node(dev->of_node, np) {
 734                 if (of_property_read_bool(np, "gpio-controller")) {
 735                         ret = 0;
 736                         break;
 737                 }
 738         }
 739         if (ret)
 740                 return dev_err_probe(dev, ret, "no gpio-controller child node\n");
 741
 742         nr_irq_parent = of_irq_count(np);
 743         spin_lock_init(&info->irq_lock);
 744
 745         if (!nr_irq_parent) {
 746                 dev_err(dev, "invalid or no IRQ\n");
 747                 return 0;
 748         }
 749
 750         info->base = devm_platform_ioremap_resource(pdev, 1);
 751         if (IS_ERR(info->base))
 752                 return PTR_ERR(info->base);
 753
 754         irqchip->irq_ack = armada_37xx_irq_ack;
 755         irqchip->irq_mask = armada_37xx_irq_mask;
 756         irqchip->irq_unmask = armada_37xx_irq_unmask;
 757         irqchip->irq_set_wake = armada_37xx_irq_set_wake;
 758         irqchip->irq_set_type = armada_37xx_irq_set_type;
 759         irqchip->irq_startup = armada_37xx_irq_startup;
 760         irqchip->name = info->data->name;
 761         girq->chip = irqchip;
 762         girq->parent_handler = armada_37xx_irq_handler;
 763         /*
 764          * Many interrupts are connected to the parent interrupt
 765          * controller. But we do not take advantage of this and use
 766          * the chained irq with all of them.
 767          */
 768         girq->num_parents = nr_irq_parent;
 769         girq->parents = devm_kcalloc(dev, nr_irq_parent, sizeof(*girq->parents), GFP_KERNEL);
 770         if (!girq->parents)
 771                 return -ENOMEM;
 772         for (i = 0; i < nr_irq_parent; i++) {
 773                 int irq = irq_of_parse_and_map(np, i);
 774
 775                 if (!irq)
 776                         continue;
 777                 girq->parents[i] = irq;
 778         }
 779         girq->default_type = IRQ_TYPE_NONE;
 780         girq->handler = handle_edge_irq;
 781
 782         return 0;
 783 }
 784
 785 static int armada_37xx_gpiochip_register(struct platform_device *pdev,
 786                                         struct armada_37xx_pinctrl *info)
 787 {
 788         struct device *dev = &pdev->dev;
 789         struct device_node *np;
 790         struct gpio_chip *gc;
 791         int ret = -ENODEV;
 792
 793         for_each_child_of_node(dev->of_node, np) {
 794                 if (of_find_property(np, "gpio-controller", NULL)) {
 795                         ret = 0;
 796                         break;
 797                 }
 798         }
 799         if (ret)
 800                 return ret;
 801
 802         info->gpio_chip = armada_37xx_gpiolib_chip;
 803
 804         gc = &info->gpio_chip;
 805         gc->ngpio = info->data->nr_pins;
 806         gc->parent = dev;
 807         gc->base = -1;
 808         gc->of_node = np;
 809         gc->label = info->data->name;
 810
 811         ret = armada_37xx_irqchip_register(pdev, info);
 812         if (ret)
 813                 return ret;
 814
 815         return devm_gpiochip_add_data(dev, gc, info);
 816 }
 817
 818 /**
 819  * armada_37xx_add_function() - Add a new function to the list
 820  * @funcs: array of function to add the new one
 821  * @funcsize: size of the remaining space for the function
 822  * @name: name of the function to add
 823  *
 824  * If it is a new function then create it by adding its name else
 825  * increment the number of group associated to this function.
 826  */
 827 static int armada_37xx_add_function(struct armada_37xx_pmx_func *funcs,
 828                                     int *funcsize, const char *name)
 829 {
 830         int i = 0;
 831
 832         if (*funcsize <= 0)
 833                 return -EOVERFLOW;
 834
 835         while (funcs->ngroups) {
 836                 /* function already there */
 837                 if (strcmp(funcs->name, name) == 0) {
 838                         funcs->ngroups++;
 839
 840                         return -EEXIST;
 841                 }
 842                 funcs++;
 843                 i++;
 844         }
 845
 846         /* append new unique function */
 847         funcs->name = name;
 848         funcs->ngroups = 1;
 849         (*funcsize)--;
 850
 851         return 0;
 852 }
 853
 854 /**
 855  * armada_37xx_fill_group() - complete the group array
 856  * @info: info driver instance
 857  *
 858  * Based on the data available from the armada_37xx_pin_group array
 859  * completes the last member of the struct for each function: the list
 860  * of the groups associated to this function.
 861  *
 862  */
 863 static int armada_37xx_fill_group(struct armada_37xx_pinctrl *info)
 864 {
 865         int n, num = 0, funcsize = info->data->nr_pins;
 866         struct device *dev = info->dev;
 867
 868         for (n = 0; n < info->ngroups; n++) {
 869                 struct armada_37xx_pin_group *grp = &info->groups[n];
 870                 int i, j, f;
 871
 872                 grp->pins = devm_kcalloc(dev, grp->npins + grp->extra_npins,
 873                                          sizeof(*grp->pins),
 874                                          GFP_KERNEL);
 875                 if (!grp->pins)
 876                         return -ENOMEM;
 877
 878                 for (i = 0; i < grp->npins; i++)
 879                         grp->pins[i] = grp->start_pin + i;
 880
 881                 for (j = 0; j < grp->extra_npins; j++)
 882                         grp->pins[i+j] = grp->extra_pin + j;
 883
 884                 for (f = 0; (f < NB_FUNCS) && grp->funcs[f]; f++) {
 885                         int ret;
 886                         /* check for unique functions and count groups */
 887                         ret = armada_37xx_add_function(info->funcs, &funcsize,
 888                                             grp->funcs[f]);
 889                         if (ret == -EOVERFLOW)
 890                                 dev_err(dev, "More functions than pins(%d)\n",
 891                                         info->data->nr_pins);
 892                         if (ret < 0)
 893                                 continue;
 894                         num++;
 895                 }
 896         }
 897
 898         info->nfuncs = num;
 899
 900         return 0;
 901 }
 902
 903 /**
 904  * armada_37xx_fill_funcs() - complete the funcs array
 905  * @info: info driver instance
 906  *
 907  * Based on the data available from the armada_37xx_pin_group array
 908  * completes the last two member of the struct for each group:
 909  * - the list of the pins included in the group
 910  * - the list of pinmux functions that can be selected for this group
 911  *
 912  */
 913 static int armada_37xx_fill_func(struct armada_37xx_pinctrl *info)
 914 {
 915         struct armada_37xx_pmx_func *funcs = info->funcs;
 916         struct device *dev = info->dev;
 917         int n;
 918
 919         for (n = 0; n < info->nfuncs; n++) {
 920                 const char *name = funcs[n].name;
 921                 const char **groups;
 922                 int g;
 923
 924                 funcs[n].groups = devm_kcalloc(dev, funcs[n].ngroups,
 925                                                sizeof(*(funcs[n].groups)),
 926                                                GFP_KERNEL);
 927                 if (!funcs[n].groups)
 928                         return -ENOMEM;
 929
 930                 groups = funcs[n].groups;
 931
 932                 for (g = 0; g < info->ngroups; g++) {
 933                         struct armada_37xx_pin_group *gp = &info->groups[g];
 934                         int f;
 935
 936                         f = match_string(gp->funcs, NB_FUNCS, name);
 937                         if (f < 0)
 938                                 continue;
 939
 940                         *groups = gp->name;
 941                         groups++;
 942                 }
 943         }
 944         return 0;
 945 }
 946
 947 static int armada_37xx_pinctrl_register(struct platform_device *pdev,
 948                                         struct armada_37xx_pinctrl *info)
 949 {
 950         const struct armada_37xx_pin_data *pin_data = info->data;
 951         struct pinctrl_desc *ctrldesc = &info->pctl;
 952         struct pinctrl_pin_desc *pindesc, *pdesc;
 953         struct device *dev = &pdev->dev;
 954         int pin, ret;
 955
 956         info->groups = pin_data->groups;
 957         info->ngroups = pin_data->ngroups;
 958
 959         ctrldesc->name = "armada_37xx-pinctrl";
 960         ctrldesc->owner = THIS_MODULE;
 961         ctrldesc->pctlops = &armada_37xx_pctrl_ops;
 962         ctrldesc->pmxops = &armada_37xx_pmx_ops;
 963         ctrldesc->confops = &armada_37xx_pinconf_ops;
 964
 965         pindesc = devm_kcalloc(dev, pin_data->nr_pins, sizeof(*pindesc), GFP_KERNEL);
 966         if (!pindesc)
 967                 return -ENOMEM;
 968
 969         ctrldesc->pins = pindesc;
 970         ctrldesc->npins = pin_data->nr_pins;
 971
 972         pdesc = pindesc;
 973         for (pin = 0; pin < pin_data->nr_pins; pin++) {
 974                 pdesc->number = pin;
 975                 pdesc->name = kasprintf(GFP_KERNEL, "%s-%d",
 976                                         pin_data->name, pin);
 977                 pdesc++;
 978         }
 979
 980         /*
 981          * we allocate functions for number of pins and hope there are
 982          * fewer unique functions than pins available
 983          */
 984         info->funcs = devm_kcalloc(dev, pin_data->nr_pins, sizeof(*info->funcs), GFP_KERNEL);
 985         if (!info->funcs)
 986                 return -ENOMEM;
 987
 988         ret = armada_37xx_fill_group(info);
 989         if (ret)
 990                 return ret;
 991
 992         ret = armada_37xx_fill_func(info);
 993         if (ret)
 994                 return ret;
 995
 996         info->pctl_dev = devm_pinctrl_register(dev, ctrldesc, info);
 997         if (IS_ERR(info->pctl_dev))
 998                 return dev_err_probe(dev, PTR_ERR(info->pctl_dev), "could not register pinctrl driver\n");
 999
1000         return 0;
1001 }
1002
1003 #if defined(CONFIG_PM)
1004 static int armada_3700_pinctrl_suspend(struct device *dev)
1005 {
1006         struct armada_37xx_pinctrl *info = dev_get_drvdata(dev);
1007
1008         /* Save GPIO state */
1009         regmap_read(info->regmap, OUTPUT_EN, &info->pm.out_en_l);
1010         regmap_read(info->regmap, OUTPUT_EN + sizeof(u32), &info->pm.out_en_h);
1011         regmap_read(info->regmap, OUTPUT_VAL, &info->pm.out_val_l);
1012         regmap_read(info->regmap, OUTPUT_VAL + sizeof(u32),
1013                     &info->pm.out_val_h);
1014
1015         info->pm.irq_en_l = readl(info->base + IRQ_EN);
1016         info->pm.irq_en_h = readl(info->base + IRQ_EN + sizeof(u32));
1017         info->pm.irq_pol_l = readl(info->base + IRQ_POL);
1018         info->pm.irq_pol_h = readl(info->base + IRQ_POL + sizeof(u32));
1019
1020         /* Save pinctrl state */
1021         regmap_read(info->regmap, SELECTION, &info->pm.selection);
1022
1023         return 0;
1024 }
1025
1026 static int armada_3700_pinctrl_resume(struct device *dev)
1027 {
1028         struct armada_37xx_pinctrl *info = dev_get_drvdata(dev);
1029         struct gpio_chip *gc;
1030         struct irq_domain *d;
1031         int i;
1032
1033         /* Restore GPIO state */
1034         regmap_write(info->regmap, OUTPUT_EN, info->pm.out_en_l);
1035         regmap_write(info->regmap, OUTPUT_EN + sizeof(u32),
1036                      info->pm.out_en_h);
1037         regmap_write(info->regmap, OUTPUT_VAL, info->pm.out_val_l);
1038         regmap_write(info->regmap, OUTPUT_VAL + sizeof(u32),
1039                      info->pm.out_val_h);
1040
1041         /*
1042          * Input levels may change during suspend, which is not monitored at
1043          * that time. GPIOs used for both-edge IRQs may not be synchronized
1044          * anymore with their polarities (rising/falling edge) and must be
1045          * re-configured manually.
1046          */
1047         gc = &info->gpio_chip;
1048         d = gc->irq.domain;
1049         for (i = 0; i < gc->ngpio; i++) {
1050                 u32 irq_bit = BIT(i % GPIO_PER_REG);
1051                 u32 mask, *irq_pol, input_reg, virq, type, level;
1052
1053                 if (i < GPIO_PER_REG) {
1054                         mask = info->pm.irq_en_l;
1055                         irq_pol = &info->pm.irq_pol_l;
1056                         input_reg = INPUT_VAL;
1057                 } else {
1058                         mask = info->pm.irq_en_h;
1059                         irq_pol = &info->pm.irq_pol_h;
1060                         input_reg = INPUT_VAL + sizeof(u32);
1061                 }
1062
1063                 if (!(mask & irq_bit))
1064                         continue;
1065
1066                 virq = irq_find_mapping(d, i);
1067                 type = irq_get_trigger_type(virq);
1068
1069                 /*
1070                  * Synchronize level and polarity for both-edge irqs:
1071                  *     - a high input level expects a falling edge,
1072                  *     - a low input level exepects a rising edge.
1073                  */
1074                 if ((type & IRQ_TYPE_SENSE_MASK) ==
1075                     IRQ_TYPE_EDGE_BOTH) {
1076                         regmap_read(info->regmap, input_reg, &level);
1077                         if ((*irq_pol ^ level) & irq_bit)
1078                                 *irq_pol ^= irq_bit;
1079                 }
1080         }
1081
1082         writel(info->pm.irq_en_l, info->base + IRQ_EN);
1083         writel(info->pm.irq_en_h, info->base + IRQ_EN + sizeof(u32));
1084         writel(info->pm.irq_pol_l, info->base + IRQ_POL);
1085         writel(info->pm.irq_pol_h, info->base + IRQ_POL + sizeof(u32));
1086
1087         /* Restore pinctrl state */
1088         regmap_write(info->regmap, SELECTION, info->pm.selection);
1089
1090         return 0;
1091 }
1092
1093 /*
1094  * Since pinctrl is an infrastructure module, its resume should be issued prior
1095  * to other IO drivers.
1096  */
1097 static const struct dev_pm_ops armada_3700_pinctrl_pm_ops = {
1098         .suspend_noirq = armada_3700_pinctrl_suspend,
1099         .resume_noirq = armada_3700_pinctrl_resume,
1100 };
1101
1102 #define PINCTRL_ARMADA_37XX_DEV_PM_OPS (&armada_3700_pinctrl_pm_ops)
1103 #else
1104 #define PINCTRL_ARMADA_37XX_DEV_PM_OPS NULL
1105 #endif /* CONFIG_PM */
1106
1107 static const struct of_device_id armada_37xx_pinctrl_of_match[] = {
1108         {
1109                 .compatible = "marvell,armada3710-sb-pinctrl",
1110                 .data = &armada_37xx_pin_sb,
1111         },
1112         {
1113                 .compatible = "marvell,armada3710-nb-pinctrl",
1114                 .data = &armada_37xx_pin_nb,
1115         },
1116         { },
1117 };
1118
1119 static const struct regmap_config armada_37xx_pinctrl_regmap_config = {
1120         .reg_bits = 32,
1121         .val_bits = 32,
1122         .reg_stride = 4,
1123         .use_raw_spinlock = true,
1124 };
1125
1126 static int __init armada_37xx_pinctrl_probe(struct platform_device *pdev)
1127 {
1128         struct armada_37xx_pinctrl *info;
1129         struct device *dev = &pdev->dev;
1130         struct regmap *regmap;
1131         void __iomem *base;
1132         int ret;
1133
1134         base = devm_platform_get_and_ioremap_resource(pdev, 0, NULL);
1135         if (IS_ERR(base)) {
1136                 dev_err(dev, "failed to ioremap base address: %pe\n", base);
1137                 return PTR_ERR(base);
1138         }
1139
1140         regmap = devm_regmap_init_mmio(dev, base,
1141                                        &armada_37xx_pinctrl_regmap_config);
1142         if (IS_ERR(regmap)) {
1143                 dev_err(dev, "failed to create regmap: %pe\n", regmap);
1144                 return PTR_ERR(regmap);
1145         }
1146
1147         info = devm_kzalloc(dev, sizeof(*info), GFP_KERNEL);
1148         if (!info)
1149                 return -ENOMEM;
1150
1151         info->dev = dev;
1152         info->regmap = regmap;
1153         info->data = of_device_get_match_data(dev);
1154
1155         ret = armada_37xx_pinctrl_register(pdev, info);
1156         if (ret)
1157                 return ret;
1158
1159         ret = armada_37xx_gpiochip_register(pdev, info);
1160         if (ret)
1161                 return ret;
1162
1163         platform_set_drvdata(pdev, info);
1164
1165         return 0;
1166 }
1167
1168 static struct platform_driver armada_37xx_pinctrl_driver = {
1169         .driver = {
1170                 .name = "armada-37xx-pinctrl",
1171                 .of_match_table = armada_37xx_pinctrl_of_match,
1172                 .pm = PINCTRL_ARMADA_37XX_DEV_PM_OPS,
1173         },
1174 };
1175
1176 builtin_platform_driver_probe(armada_37xx_pinctrl_driver,
1177                               armada_37xx_pinctrl_probe);