drivers/pinctrl/pinctrl-abx500.c

   1 /*
   2  * Copyright (C) ST-Ericsson SA 2013
   3  *
   4  * Author: Patrice Chotard <patrice.chotard@st.com>
   5  * License terms: GNU General Public License (GPL) version 2
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  */
  11 #include <linux/kernel.h>
  12 #include <linux/types.h>
  13 #include <linux/slab.h>
  14 #include <linux/init.h>
  15 #include <linux/module.h>
  16 #include <linux/err.h>
  17 #include <linux/of.h>
  18 #include <linux/of_device.h>
  19 #include <linux/platform_device.h>
  20 #include <linux/gpio.h>
  21 #include <linux/irq.h>
  22 #include <linux/irqdomain.h>
  23 #include <linux/interrupt.h>
  24 #include <linux/bitops.h>
  25 #include <linux/mfd/abx500.h>
  26 #include <linux/mfd/abx500/ab8500.h>
  27 #include <linux/mfd/abx500/ab8500-gpio.h>
  28 #include <linux/pinctrl/pinctrl.h>
  29 #include <linux/pinctrl/consumer.h>
  30 #include <linux/pinctrl/pinmux.h>
  31 #include <linux/pinctrl/pinconf.h>
  32 #include <linux/pinctrl/pinconf-generic.h>
  33
  34 #include "pinctrl-abx500.h"
  35
  36 /*
  37  * The AB9540 and AB8540 GPIO support are extended versions
  38  * of the AB8500 GPIO support.
  39  * The AB9540 supports an additional (7th) register so that
  40  * more GPIO may be configured and used.
  41  * The AB8540 supports 4 new gpios (GPIOx_VBAT) that have
  42  * internal pull-up and pull-down capabilities.
  43  */
  44
  45 /*
  46  * GPIO registers offset
  47  * Bank: 0x10
  48  */
  49 #define AB8500_GPIO_SEL1_REG    0x00
  50 #define AB8500_GPIO_SEL2_REG    0x01
  51 #define AB8500_GPIO_SEL3_REG    0x02
  52 #define AB8500_GPIO_SEL4_REG    0x03
  53 #define AB8500_GPIO_SEL5_REG    0x04
  54 #define AB8500_GPIO_SEL6_REG    0x05
  55 #define AB9540_GPIO_SEL7_REG    0x06
  56
  57 #define AB8500_GPIO_DIR1_REG    0x10
  58 #define AB8500_GPIO_DIR2_REG    0x11
  59 #define AB8500_GPIO_DIR3_REG    0x12
  60 #define AB8500_GPIO_DIR4_REG    0x13
  61 #define AB8500_GPIO_DIR5_REG    0x14
  62 #define AB8500_GPIO_DIR6_REG    0x15
  63 #define AB9540_GPIO_DIR7_REG    0x16
  64
  65 #define AB8500_GPIO_OUT1_REG    0x20
  66 #define AB8500_GPIO_OUT2_REG    0x21
  67 #define AB8500_GPIO_OUT3_REG    0x22
  68 #define AB8500_GPIO_OUT4_REG    0x23
  69 #define AB8500_GPIO_OUT5_REG    0x24
  70 #define AB8500_GPIO_OUT6_REG    0x25
  71 #define AB9540_GPIO_OUT7_REG    0x26
  72
  73 #define AB8500_GPIO_PUD1_REG    0x30
  74 #define AB8500_GPIO_PUD2_REG    0x31
  75 #define AB8500_GPIO_PUD3_REG    0x32
  76 #define AB8500_GPIO_PUD4_REG    0x33
  77 #define AB8500_GPIO_PUD5_REG    0x34
  78 #define AB8500_GPIO_PUD6_REG    0x35
  79 #define AB9540_GPIO_PUD7_REG    0x36
  80
  81 #define AB8500_GPIO_IN1_REG     0x40
  82 #define AB8500_GPIO_IN2_REG     0x41
  83 #define AB8500_GPIO_IN3_REG     0x42
  84 #define AB8500_GPIO_IN4_REG     0x43
  85 #define AB8500_GPIO_IN5_REG     0x44
  86 #define AB8500_GPIO_IN6_REG     0x45
  87 #define AB9540_GPIO_IN7_REG     0x46
  88 #define AB8540_GPIO_VINSEL_REG  0x47
  89 #define AB8540_GPIO_PULL_UPDOWN_REG     0x48
  90 #define AB8500_GPIO_ALTFUN_REG  0x50
  91 #define AB8540_GPIO_PULL_UPDOWN_MASK    0x03
  92 #define AB8540_GPIO_VINSEL_MASK 0x03
  93 #define AB8540_GPIOX_VBAT_START 51
  94 #define AB8540_GPIOX_VBAT_END   54
  95
  96 struct abx500_pinctrl {
  97         struct device *dev;
  98         struct pinctrl_dev *pctldev;
  99         struct abx500_pinctrl_soc_data *soc;
 100         struct gpio_chip chip;
 101         struct ab8500 *parent;
 102         struct abx500_gpio_irq_cluster *irq_cluster;
 103         int irq_cluster_size;
 104 };
 105
 106 /**
 107  * to_abx500_pinctrl() - get the pointer to abx500_pinctrl
 108  * @chip:       Member of the structure abx500_pinctrl
 109  */
 110 static inline struct abx500_pinctrl *to_abx500_pinctrl(struct gpio_chip *chip)
 111 {
 112         return container_of(chip, struct abx500_pinctrl, chip);
 113 }
 114
 115 static int abx500_gpio_get_bit(struct gpio_chip *chip, u8 reg,
 116                                unsigned offset, bool *bit)
 117 {
 118         struct abx500_pinctrl *pct = to_abx500_pinctrl(chip);
 119         u8 pos = offset % 8;
 120         u8 val;
 121         int ret;
 122
 123         reg += offset / 8;
 124         ret = abx500_get_register_interruptible(pct->dev,
 125                                                 AB8500_MISC, reg, &val);
 126
 127         *bit = !!(val & BIT(pos));
 128
 129         if (ret < 0)
 130                 dev_err(pct->dev,
 131                         "%s read reg =%x, offset=%x failed\n",
 132                         __func__, reg, offset);
 133
 134         return ret;
 135 }
 136
 137 static int abx500_gpio_set_bits(struct gpio_chip *chip, u8 reg,
 138                                 unsigned offset, int val)
 139 {
 140         struct abx500_pinctrl *pct = to_abx500_pinctrl(chip);
 141         u8 pos = offset % 8;
 142         int ret;
 143
 144         reg += offset / 8;
 145         ret = abx500_mask_and_set_register_interruptible(pct->dev,
 146                                 AB8500_MISC, reg, BIT(pos), val << pos);
 147         if (ret < 0)
 148                 dev_err(pct->dev, "%s write failed\n", __func__);
 149
 150         return ret;
 151 }
 152
 153 /**
 154  * abx500_gpio_get() - Get the particular GPIO value
 155  * @chip:       Gpio device
 156  * @offset:     GPIO number to read
 157  */
 158 static int abx500_gpio_get(struct gpio_chip *chip, unsigned offset)
 159 {
 160         struct abx500_pinctrl *pct = to_abx500_pinctrl(chip);
 161         bool bit;
 162         int ret;
 163
 164         ret = abx500_gpio_get_bit(chip, AB8500_GPIO_IN1_REG,
 165                                   offset, &bit);
 166         if (ret < 0) {
 167                 dev_err(pct->dev, "%s failed\n", __func__);
 168                 return ret;
 169         }
 170
 171         return bit;
 172 }
 173
 174 static void abx500_gpio_set(struct gpio_chip *chip, unsigned offset, int val)
 175 {
 176         struct abx500_pinctrl *pct = to_abx500_pinctrl(chip);
 177         int ret;
 178
 179         ret = abx500_gpio_set_bits(chip, AB8500_GPIO_OUT1_REG, offset, val);
 180         if (ret < 0)
 181                 dev_err(pct->dev, "%s write failed\n", __func__);
 182 }
 183
 184 static int abx500_config_pull_updown(struct abx500_pinctrl *pct,
 185                                      int offset, enum abx500_gpio_pull_updown val)
 186 {
 187         u8 pos;
 188         int ret;
 189         struct pullud *pullud;
 190
 191         if (!pct->soc->pullud) {
 192                 dev_err(pct->dev, "%s AB chip doesn't support pull up/down feature",
 193                                 __func__);
 194                 ret = -EPERM;
 195                 goto out;
 196         }
 197
 198         pullud = pct->soc->pullud;
 199
 200         if ((offset < pullud->first_pin)
 201                 || (offset > pullud->last_pin)) {
 202                 ret = -EINVAL;
 203                 goto out;
 204         }
 205
 206         pos = (offset - pullud->first_pin) << 1;
 207
 208         ret = abx500_mask_and_set_register_interruptible(pct->dev,
 209                         AB8500_MISC, AB8540_GPIO_PULL_UPDOWN_REG,
 210                         AB8540_GPIO_PULL_UPDOWN_MASK << pos, val << pos);
 211
 212 out:
 213         if (ret < 0)
 214                 dev_err(pct->dev, "%s failed (%d)\n", __func__, ret);
 215
 216         return ret;
 217 }
 218
 219 static int abx500_gpio_direction_output(struct gpio_chip *chip,
 220                                         unsigned offset,
 221                                         int val)
 222 {
 223         struct abx500_pinctrl *pct = to_abx500_pinctrl(chip);
 224         struct pullud *pullud = pct->soc->pullud;
 225         unsigned gpio;
 226         int ret;
 227
 228         /* set direction as output */
 229         ret = abx500_gpio_set_bits(chip, AB8500_GPIO_DIR1_REG, offset, 1);
 230         if (ret < 0)
 231                 return ret;
 232
 233         /* disable pull down */
 234         ret = abx500_gpio_set_bits(chip, AB8500_GPIO_PUD1_REG, offset, 1);
 235         if (ret < 0)
 236                 return ret;
 237
 238         /* if supported, disable both pull down and pull up */
 239         gpio = offset + 1;
 240         if (pullud && gpio >= pullud->first_pin && gpio <= pullud->last_pin) {
 241                 ret = abx500_config_pull_updown(pct,
 242                                 gpio,
 243                                 ABX500_GPIO_PULL_NONE);
 244                 if (ret < 0)
 245                         return ret;
 246         }
 247
 248         /* set the output as 1 or 0 */
 249         return abx500_gpio_set_bits(chip, AB8500_GPIO_OUT1_REG, offset, val);
 250 }
 251
 252 static int abx500_gpio_direction_input(struct gpio_chip *chip, unsigned offset)
 253 {
 254         /* set the register as input */
 255         return abx500_gpio_set_bits(chip, AB8500_GPIO_DIR1_REG, offset, 0);
 256 }
 257
 258 static int abx500_gpio_to_irq(struct gpio_chip *chip, unsigned offset)
 259 {
 260         struct abx500_pinctrl *pct = to_abx500_pinctrl(chip);
 261         /* The AB8500 GPIO numbers are off by one */
 262         int gpio = offset + 1;
 263         int hwirq;
 264         int i;
 265
 266         for (i = 0; i < pct->irq_cluster_size; i++) {
 267                 struct abx500_gpio_irq_cluster *cluster =
 268                         &pct->irq_cluster[i];
 269
 270                 if (gpio >= cluster->start && gpio <= cluster->end) {
 271                         /*
 272                          * The ABx500 GPIO's associated IRQs are clustered together
 273                          * throughout the interrupt numbers at irregular intervals.
 274                          * To solve this quandry, we have placed the read-in values
 275                          * into the cluster information table.
 276                          */
 277                         hwirq = gpio - cluster->start + cluster->to_irq;
 278                         return irq_create_mapping(pct->parent->domain, hwirq);
 279                 }
 280         }
 281
 282         return -EINVAL;
 283 }
 284
 285 static int abx500_set_mode(struct pinctrl_dev *pctldev, struct gpio_chip *chip,
 286                            unsigned gpio, int alt_setting)
 287 {
 288         struct abx500_pinctrl *pct = pinctrl_dev_get_drvdata(pctldev);
 289         struct alternate_functions af = pct->soc->alternate_functions[gpio];
 290         int ret;
 291         int val;
 292         unsigned offset;
 293
 294         const char *modes[] = {
 295                 [ABX500_DEFAULT]        = "default",
 296                 [ABX500_ALT_A]          = "altA",
 297                 [ABX500_ALT_B]          = "altB",
 298                 [ABX500_ALT_C]          = "altC",
 299         };
 300
 301         /* sanity check */
 302         if (((alt_setting == ABX500_ALT_A) && (af.gpiosel_bit == UNUSED)) ||
 303             ((alt_setting == ABX500_ALT_B) && (af.alt_bit1 == UNUSED)) ||
 304             ((alt_setting == ABX500_ALT_C) && (af.alt_bit2 == UNUSED))) {
 305                 dev_dbg(pct->dev, "pin %d doesn't support %s mode\n", gpio,
 306                                 modes[alt_setting]);
 307                 return -EINVAL;
 308         }
 309
 310         /* on ABx5xx, there is no GPIO0, so adjust the offset */
 311         offset = gpio - 1;
 312
 313         switch (alt_setting) {
 314         case ABX500_DEFAULT:
 315                 /*
 316                  * for ABx5xx family, default mode is always selected by
 317                  * writing 0 to GPIOSELx register, except for pins which
 318                  * support at least ALT_B mode, default mode is selected
 319                  * by writing 1 to GPIOSELx register
 320                  */
 321                 val = 0;
 322                 if (af.alt_bit1 != UNUSED)
 323                         val++;
 324
 325                 ret = abx500_gpio_set_bits(chip, AB8500_GPIO_SEL1_REG,
 326                                            offset, val);
 327                 break;
 328
 329         case ABX500_ALT_A:
 330                 /*
 331                  * for ABx5xx family, alt_a mode is always selected by
 332                  * writing 1 to GPIOSELx register, except for pins which
 333                  * support at least ALT_B mode, alt_a mode is selected
 334                  * by writing 0 to GPIOSELx register and 0 in ALTFUNC
 335                  * register
 336                  */
 337                 if (af.alt_bit1 != UNUSED) {
 338                         ret = abx500_gpio_set_bits(chip, AB8500_GPIO_SEL1_REG,
 339                                         offset, 0);
 340                         ret = abx500_gpio_set_bits(chip,
 341                                         AB8500_GPIO_ALTFUN_REG,
 342                                         af.alt_bit1,
 343                                         !!(af.alta_val && BIT(0)));
 344                         if (af.alt_bit2 != UNUSED)
 345                                 ret = abx500_gpio_set_bits(chip,
 346                                         AB8500_GPIO_ALTFUN_REG,
 347                                         af.alt_bit2,
 348                                         !!(af.alta_val && BIT(1)));
 349                 } else
 350                         ret = abx500_gpio_set_bits(chip, AB8500_GPIO_SEL1_REG,
 351                                         offset, 1);
 352                 break;
 353
 354         case ABX500_ALT_B:
 355                 ret = abx500_gpio_set_bits(chip, AB8500_GPIO_SEL1_REG,
 356                                 offset, 0);
 357                 ret = abx500_gpio_set_bits(chip, AB8500_GPIO_ALTFUN_REG,
 358                                 af.alt_bit1, !!(af.altb_val && BIT(0)));
 359                 if (af.alt_bit2 != UNUSED)
 360                         ret = abx500_gpio_set_bits(chip,
 361                                         AB8500_GPIO_ALTFUN_REG,
 362                                         af.alt_bit2,
 363                                         !!(af.altb_val && BIT(1)));
 364                 break;
 365
 366         case ABX500_ALT_C:
 367                 ret = abx500_gpio_set_bits(chip, AB8500_GPIO_SEL1_REG,
 368                                 offset, 0);
 369                 ret = abx500_gpio_set_bits(chip, AB8500_GPIO_ALTFUN_REG,
 370                                 af.alt_bit2, !!(af.altc_val && BIT(0)));
 371                 ret = abx500_gpio_set_bits(chip, AB8500_GPIO_ALTFUN_REG,
 372                                 af.alt_bit2, !!(af.altc_val && BIT(1)));
 373                 break;
 374
 375         default:
 376                 dev_dbg(pct->dev, "unknow alt_setting %d\n", alt_setting);
 377
 378                 return -EINVAL;
 379         }
 380
 381         return ret;
 382 }
 383
 384 static u8 abx500_get_mode(struct pinctrl_dev *pctldev, struct gpio_chip *chip,
 385                           unsigned gpio)
 386 {
 387         u8 mode;
 388         bool bit_mode;
 389         bool alt_bit1;
 390         bool alt_bit2;
 391         struct abx500_pinctrl *pct = pinctrl_dev_get_drvdata(pctldev);
 392         struct alternate_functions af = pct->soc->alternate_functions[gpio];
 393         /* on ABx5xx, there is no GPIO0, so adjust the offset */
 394         unsigned offset = gpio - 1;
 395
 396         /*
 397          * if gpiosel_bit is set to unused,
 398          * it means no GPIO or special case
 399          */
 400         if (af.gpiosel_bit == UNUSED)
 401                 return ABX500_DEFAULT;
 402
 403         /* read GpioSelx register */
 404         abx500_gpio_get_bit(chip, AB8500_GPIO_SEL1_REG + (offset / 8),
 405                         af.gpiosel_bit, &bit_mode);
 406         mode = bit_mode;
 407
 408         /* sanity check */
 409         if ((af.alt_bit1 < UNUSED) || (af.alt_bit1 > 7) ||
 410             (af.alt_bit2 < UNUSED) || (af.alt_bit2 > 7)) {
 411                 dev_err(pct->dev,
 412                         "alt_bitX value not in correct range (-1 to 7)\n");
 413                 return -EINVAL;
 414         }
 415
 416         /* if alt_bit2 is used, alt_bit1 must be used too */
 417         if ((af.alt_bit2 != UNUSED) && (af.alt_bit1 == UNUSED)) {
 418                 dev_err(pct->dev,
 419                         "if alt_bit2 is used, alt_bit1 can't be unused\n");
 420                 return -EINVAL;
 421         }
 422
 423         /* check if pin use AlternateFunction register */
 424         if ((af.alt_bit1 == UNUSED) && (af.alt_bit2 == UNUSED))
 425                 return mode;
 426         /*
 427          * if pin GPIOSEL bit is set and pin supports alternate function,
 428          * it means DEFAULT mode
 429          */
 430         if (mode)
 431                 return ABX500_DEFAULT;
 432
 433         /*
 434          * pin use the AlternatFunction register
 435          * read alt_bit1 value
 436          */
 437         abx500_gpio_get_bit(chip, AB8500_GPIO_ALTFUN_REG,
 438                             af.alt_bit1, &alt_bit1);
 439
 440         if (af.alt_bit2 != UNUSED)
 441                 /* read alt_bit2 value */
 442                 abx500_gpio_get_bit(chip, AB8500_GPIO_ALTFUN_REG, af.alt_bit2,
 443                                 &alt_bit2);
 444         else
 445                 alt_bit2 = 0;
 446
 447         mode = (alt_bit2 << 1) + alt_bit1;
 448         if (mode == af.alta_val)
 449                 return ABX500_ALT_A;
 450         else if (mode == af.altb_val)
 451                 return ABX500_ALT_B;
 452         else
 453                 return ABX500_ALT_C;
 454 }
 455
 456 #ifdef CONFIG_DEBUG_FS
 457
 458 #include <linux/seq_file.h>
 459
 460 static void abx500_gpio_dbg_show_one(struct seq_file *s,
 461                                      struct pinctrl_dev *pctldev,
 462                                      struct gpio_chip *chip,
 463                                      unsigned offset, unsigned gpio)
 464 {
 465         const char *label = gpiochip_is_requested(chip, offset - 1);
 466         u8 gpio_offset = offset - 1;
 467         int mode = -1;
 468         bool is_out;
 469         bool pull;
 470
 471         const char *modes[] = {
 472                 [ABX500_DEFAULT]        = "default",
 473                 [ABX500_ALT_A]          = "altA",
 474                 [ABX500_ALT_B]          = "altB",
 475                 [ABX500_ALT_C]          = "altC",
 476         };
 477
 478         abx500_gpio_get_bit(chip, AB8500_GPIO_DIR1_REG, gpio_offset, &is_out);
 479         abx500_gpio_get_bit(chip, AB8500_GPIO_PUD1_REG, gpio_offset, &pull);
 480
 481         if (pctldev)
 482                 mode = abx500_get_mode(pctldev, chip, offset);
 483
 484         seq_printf(s, " gpio-%-3d (%-20.20s) %-3s %-9s %s",
 485                    gpio, label ?: "(none)",
 486                    is_out ? "out" : "in ",
 487                    is_out ?
 488                    (chip->get
 489                    ? (chip->get(chip, offset) ? "hi" : "lo")
 490                    : "?  ")
 491                    : (pull ? "pull up" : "pull down"),
 492                    (mode < 0) ? "unknown" : modes[mode]);
 493 }
 494
 495 static void abx500_gpio_dbg_show(struct seq_file *s, struct gpio_chip *chip)
 496 {
 497         unsigned i;
 498         unsigned gpio = chip->base;
 499         struct abx500_pinctrl *pct = to_abx500_pinctrl(chip);
 500         struct pinctrl_dev *pctldev = pct->pctldev;
 501
 502         for (i = 0; i < chip->ngpio; i++, gpio++) {
 503                 /* On AB8500, there is no GPIO0, the first is the GPIO 1 */
 504                 abx500_gpio_dbg_show_one(s, pctldev, chip, i + 1, gpio);
 505                 seq_printf(s, "\n");
 506         }
 507 }
 508
 509 #else
 510 static inline void abx500_gpio_dbg_show_one(struct seq_file *s,
 511                                             struct pinctrl_dev *pctldev,
 512                                             struct gpio_chip *chip,
 513                                             unsigned offset, unsigned gpio)
 514 {
 515 }
 516 #define abx500_gpio_dbg_show    NULL
 517 #endif
 518
 519 static int abx500_gpio_request(struct gpio_chip *chip, unsigned offset)
 520 {
 521         int gpio = chip->base + offset;
 522
 523         return pinctrl_request_gpio(gpio);
 524 }
 525
 526 static void abx500_gpio_free(struct gpio_chip *chip, unsigned offset)
 527 {
 528         int gpio = chip->base + offset;
 529
 530         pinctrl_free_gpio(gpio);
 531 }
 532
 533 static struct gpio_chip abx500gpio_chip = {
 534         .label                  = "abx500-gpio",
 535         .owner                  = THIS_MODULE,
 536         .request                = abx500_gpio_request,
 537         .free                   = abx500_gpio_free,
 538         .direction_input        = abx500_gpio_direction_input,
 539         .get                    = abx500_gpio_get,
 540         .direction_output       = abx500_gpio_direction_output,
 541         .set                    = abx500_gpio_set,
 542         .to_irq                 = abx500_gpio_to_irq,
 543         .dbg_show               = abx500_gpio_dbg_show,
 544 };
 545
 546 static int abx500_pmx_get_funcs_cnt(struct pinctrl_dev *pctldev)
 547 {
 548         struct abx500_pinctrl *pct = pinctrl_dev_get_drvdata(pctldev);
 549
 550         return pct->soc->nfunctions;
 551 }
 552
 553 static const char *abx500_pmx_get_func_name(struct pinctrl_dev *pctldev,
 554                                          unsigned function)
 555 {
 556         struct abx500_pinctrl *pct = pinctrl_dev_get_drvdata(pctldev);
 557
 558         return pct->soc->functions[function].name;
 559 }
 560
 561 static int abx500_pmx_get_func_groups(struct pinctrl_dev *pctldev,
 562                                       unsigned function,
 563                                       const char * const **groups,
 564                                       unsigned * const num_groups)
 565 {
 566         struct abx500_pinctrl *pct = pinctrl_dev_get_drvdata(pctldev);
 567
 568         *groups = pct->soc->functions[function].groups;
 569         *num_groups = pct->soc->functions[function].ngroups;
 570
 571         return 0;
 572 }
 573
 574 static int abx500_pmx_enable(struct pinctrl_dev *pctldev, unsigned function,
 575                              unsigned group)
 576 {
 577         struct abx500_pinctrl *pct = pinctrl_dev_get_drvdata(pctldev);
 578         struct gpio_chip *chip = &pct->chip;
 579         const struct abx500_pingroup *g;
 580         int i;
 581         int ret = 0;
 582
 583         g = &pct->soc->groups[group];
 584         if (g->altsetting < 0)
 585                 return -EINVAL;
 586
 587         dev_dbg(pct->dev, "enable group %s, %u pins\n", g->name, g->npins);
 588
 589         for (i = 0; i < g->npins; i++) {
 590                 dev_dbg(pct->dev, "setting pin %d to altsetting %d\n",
 591                         g->pins[i], g->altsetting);
 592
 593                 ret = abx500_set_mode(pctldev, chip, g->pins[i], g->altsetting);
 594         }
 595
 596         return ret;
 597 }
 598
 599 static void abx500_pmx_disable(struct pinctrl_dev *pctldev,
 600                                unsigned function, unsigned group)
 601 {
 602         struct abx500_pinctrl *pct = pinctrl_dev_get_drvdata(pctldev);
 603         const struct abx500_pingroup *g;
 604
 605         g = &pct->soc->groups[group];
 606         if (g->altsetting < 0)
 607                 return;
 608
 609         /* FIXME: poke out the mux, set the pin to some default state? */
 610         dev_dbg(pct->dev, "disable group %s, %u pins\n", g->name, g->npins);
 611 }
 612
 613 static int abx500_gpio_request_enable(struct pinctrl_dev *pctldev,
 614                                struct pinctrl_gpio_range *range,
 615                                unsigned offset)
 616 {
 617         struct abx500_pinctrl *pct = pinctrl_dev_get_drvdata(pctldev);
 618         const struct abx500_pinrange *p;
 619         int ret;
 620         int i;
 621
 622         /*
 623          * Different ranges have different ways to enable GPIO function on a
 624          * pin, so refer back to our local range type, where we handily define
 625          * what altfunc enables GPIO for a certain pin.
 626          */
 627         for (i = 0; i < pct->soc->gpio_num_ranges; i++) {
 628                 p = &pct->soc->gpio_ranges[i];
 629                 if ((offset >= p->offset) &&
 630                     (offset < (p->offset + p->npins)))
 631                   break;
 632         }
 633
 634         if (i == pct->soc->gpio_num_ranges) {
 635                 dev_err(pct->dev, "%s failed to locate range\n", __func__);
 636                 return -ENODEV;
 637         }
 638
 639         dev_dbg(pct->dev, "enable GPIO by altfunc %d at gpio %d\n",
 640                 p->altfunc, offset);
 641
 642         ret = abx500_set_mode(pct->pctldev, &pct->chip,
 643                               offset, p->altfunc);
 644         if (ret < 0) {
 645                 dev_err(pct->dev, "%s setting altfunc failed\n", __func__);
 646                 return ret;
 647         }
 648
 649         return ret;
 650 }
 651
 652 static void abx500_gpio_disable_free(struct pinctrl_dev *pctldev,
 653                                      struct pinctrl_gpio_range *range,
 654                                      unsigned offset)
 655 {
 656 }
 657
 658 static const struct pinmux_ops abx500_pinmux_ops = {
 659         .get_functions_count = abx500_pmx_get_funcs_cnt,
 660         .get_function_name = abx500_pmx_get_func_name,
 661         .get_function_groups = abx500_pmx_get_func_groups,
 662         .enable = abx500_pmx_enable,
 663         .disable = abx500_pmx_disable,
 664         .gpio_request_enable = abx500_gpio_request_enable,
 665         .gpio_disable_free = abx500_gpio_disable_free,
 666 };
 667
 668 static int abx500_get_groups_cnt(struct pinctrl_dev *pctldev)
 669 {
 670         struct abx500_pinctrl *pct = pinctrl_dev_get_drvdata(pctldev);
 671
 672         return pct->soc->ngroups;
 673 }
 674
 675 static const char *abx500_get_group_name(struct pinctrl_dev *pctldev,
 676                                          unsigned selector)
 677 {
 678         struct abx500_pinctrl *pct = pinctrl_dev_get_drvdata(pctldev);
 679
 680         return pct->soc->groups[selector].name;
 681 }
 682
 683 static int abx500_get_group_pins(struct pinctrl_dev *pctldev,
 684                                  unsigned selector,
 685                                  const unsigned **pins,
 686                                  unsigned *num_pins)
 687 {
 688         struct abx500_pinctrl *pct = pinctrl_dev_get_drvdata(pctldev);
 689
 690         *pins = pct->soc->groups[selector].pins;
 691         *num_pins = pct->soc->groups[selector].npins;
 692
 693         return 0;
 694 }
 695
 696 static void abx500_pin_dbg_show(struct pinctrl_dev *pctldev,
 697                                 struct seq_file *s, unsigned offset)
 698 {
 699         struct abx500_pinctrl *pct = pinctrl_dev_get_drvdata(pctldev);
 700         struct gpio_chip *chip = &pct->chip;
 701
 702         abx500_gpio_dbg_show_one(s, pctldev, chip, offset,
 703                                  chip->base + offset - 1);
 704 }
 705
 706 static const struct pinctrl_ops abx500_pinctrl_ops = {
 707         .get_groups_count = abx500_get_groups_cnt,
 708         .get_group_name = abx500_get_group_name,
 709         .get_group_pins = abx500_get_group_pins,
 710         .pin_dbg_show = abx500_pin_dbg_show,
 711 };
 712
 713 static int abx500_pin_config_get(struct pinctrl_dev *pctldev,
 714                           unsigned pin,
 715                           unsigned long *config)
 716 {
 717         return -ENOSYS;
 718 }
 719
 720 static int abx500_pin_config_set(struct pinctrl_dev *pctldev,
 721                           unsigned pin,
 722                           unsigned long config)
 723 {
 724         struct abx500_pinctrl *pct = pinctrl_dev_get_drvdata(pctldev);
 725         struct pullud *pullud = pct->soc->pullud;
 726         struct gpio_chip *chip = &pct->chip;
 727         unsigned offset;
 728         int ret;
 729         enum pin_config_param param = pinconf_to_config_param(config);
 730         enum pin_config_param argument = pinconf_to_config_argument(config);
 731
 732         dev_dbg(chip->dev, "pin %d [%#lx]: %s %s\n",
 733                 pin, config, (param == PIN_CONFIG_OUTPUT) ? "output " : "input",
 734                 (param == PIN_CONFIG_OUTPUT) ? (argument ? "high" : "low") :
 735                 (argument ? "pull up" : "pull down"));
 736
 737         /* on ABx500, there is no GPIO0, so adjust the offset */
 738         offset = pin - 1;
 739
 740         switch (param) {
 741         case PIN_CONFIG_BIAS_PULL_DOWN:
 742                 /*
 743                  * if argument = 1 set the pull down
 744                  * else clear the pull down
 745                  */
 746                 ret = abx500_gpio_direction_input(chip, offset);
 747                 /*
 748                  * Some chips only support pull down, while some actually
 749                  * support both pull up and pull down. Such chips have
 750                  * a "pullud" range specified for the pins that support
 751                  * both features. If the pin is not within that range, we
 752                  * fall back to the old bit set that only support pull down.
 753                  */
 754                 if (pullud &&
 755                     pin >= pullud->first_pin &&
 756                     pin <= pullud->last_pin)
 757                         ret = abx500_config_pull_updown(pct,
 758                                 pin,
 759                                 argument ? ABX500_GPIO_PULL_DOWN : ABX500_GPIO_PULL_NONE);
 760                 else
 761                         /* Chip only supports pull down */
 762                         ret = abx500_gpio_set_bits(chip, AB8500_GPIO_PUD1_REG,
 763                                 offset, argument ? 0 : 1);
 764                 break;
 765
 766         case PIN_CONFIG_OUTPUT:
 767                 ret = abx500_gpio_direction_output(chip, offset, argument);
 768
 769                 break;
 770
 771         default:
 772                 dev_err(chip->dev, "illegal configuration requested\n");
 773
 774                 return -EINVAL;
 775         }
 776
 777         return ret;
 778 }
 779
 780 static const struct pinconf_ops abx500_pinconf_ops = {
 781         .pin_config_get = abx500_pin_config_get,
 782         .pin_config_set = abx500_pin_config_set,
 783 };
 784
 785 static struct pinctrl_desc abx500_pinctrl_desc = {
 786         .name = "pinctrl-abx500",
 787         .pctlops = &abx500_pinctrl_ops,
 788         .pmxops = &abx500_pinmux_ops,
 789         .confops = &abx500_pinconf_ops,
 790         .owner = THIS_MODULE,
 791 };
 792
 793 static int abx500_get_gpio_num(struct abx500_pinctrl_soc_data *soc)
 794 {
 795         unsigned int lowest = 0;
 796         unsigned int highest = 0;
 797         unsigned int npins = 0;
 798         int i;
 799
 800         /*
 801          * Compute number of GPIOs from the last SoC gpio range descriptors
 802          * These ranges may include "holes" but the GPIO number space shall
 803          * still be homogeneous, so we need to detect and account for any
 804          * such holes so that these are included in the number of GPIO pins.
 805          */
 806         for (i = 0; i < soc->gpio_num_ranges; i++) {
 807                 unsigned gstart;
 808                 unsigned gend;
 809                 const struct abx500_pinrange *p;
 810
 811                 p = &soc->gpio_ranges[i];
 812                 gstart = p->offset;
 813                 gend = p->offset + p->npins - 1;
 814
 815                 if (i == 0) {
 816                         /* First iteration, set start values */
 817                         lowest = gstart;
 818                         highest = gend;
 819                 } else {
 820                         if (gstart < lowest)
 821                                 lowest = gstart;
 822                         if (gend > highest)
 823                                 highest = gend;
 824                 }
 825         }
 826         /* this gives the absolute number of pins */
 827         npins = highest - lowest + 1;
 828         return npins;
 829 }
 830
 831 static const struct of_device_id abx500_gpio_match[] = {
 832         { .compatible = "stericsson,ab8500-gpio", .data = (void *)PINCTRL_AB8500, },
 833         { .compatible = "stericsson,ab8505-gpio", .data = (void *)PINCTRL_AB8505, },
 834         { .compatible = "stericsson,ab8540-gpio", .data = (void *)PINCTRL_AB8540, },
 835         { .compatible = "stericsson,ab9540-gpio", .data = (void *)PINCTRL_AB9540, },
 836         { }
 837 };
 838
 839 static int abx500_gpio_probe(struct platform_device *pdev)
 840 {
 841         struct ab8500_platform_data *abx500_pdata =
 842                                 dev_get_platdata(pdev->dev.parent);
 843         struct abx500_gpio_platform_data *pdata = NULL;
 844         struct device_node *np = pdev->dev.of_node;
 845         struct abx500_pinctrl *pct;
 846         const struct platform_device_id *platid = platform_get_device_id(pdev);
 847         unsigned int id = -1;
 848         int ret, err;
 849         int i;
 850
 851         if (abx500_pdata)
 852                 pdata = abx500_pdata->gpio;
 853
 854         if (!(pdata || np)) {
 855                 dev_err(&pdev->dev, "gpio dt and platform data missing\n");
 856                 return -ENODEV;
 857         }
 858
 859         pct = devm_kzalloc(&pdev->dev, sizeof(struct abx500_pinctrl),
 860                                    GFP_KERNEL);
 861         if (pct == NULL) {
 862                 dev_err(&pdev->dev,
 863                         "failed to allocate memory for pct\n");
 864                 return -ENOMEM;
 865         }
 866
 867         pct->dev = &pdev->dev;
 868         pct->parent = dev_get_drvdata(pdev->dev.parent);
 869         pct->chip = abx500gpio_chip;
 870         pct->chip.dev = &pdev->dev;
 871         pct->chip.base = (np) ? -1 : pdata->gpio_base;
 872
 873         if (platid)
 874                 id = platid->driver_data;
 875         else if (np) {
 876                 const struct of_device_id *match;
 877
 878                 match = of_match_device(abx500_gpio_match, &pdev->dev);
 879                 if (match)
 880                         id = (unsigned long)match->data;
 881         }
 882
 883         /* Poke in other ASIC variants here */
 884         switch (id) {
 885         case PINCTRL_AB8500:
 886                 abx500_pinctrl_ab8500_init(&pct->soc);
 887                 break;
 888         case PINCTRL_AB8540:
 889                 abx500_pinctrl_ab8540_init(&pct->soc);
 890                 break;
 891         case PINCTRL_AB9540:
 892                 abx500_pinctrl_ab9540_init(&pct->soc);
 893                 break;
 894         case PINCTRL_AB8505:
 895                 abx500_pinctrl_ab8505_init(&pct->soc);
 896                 break;
 897         default:
 898                 dev_err(&pdev->dev, "Unsupported pinctrl sub driver (%d)\n", id);
 899                 return -EINVAL;
 900         }
 901
 902         if (!pct->soc) {
 903                 dev_err(&pdev->dev, "Invalid SOC data\n");
 904                 return -EINVAL;
 905         }
 906
 907         pct->chip.ngpio = abx500_get_gpio_num(pct->soc);
 908         pct->irq_cluster = pct->soc->gpio_irq_cluster;
 909         pct->irq_cluster_size = pct->soc->ngpio_irq_cluster;
 910
 911         ret = gpiochip_add(&pct->chip);
 912         if (ret) {
 913                 dev_err(&pdev->dev, "unable to add gpiochip: %d\n", ret);
 914                 return ret;
 915         }
 916         dev_info(&pdev->dev, "added gpiochip\n");
 917
 918         abx500_pinctrl_desc.pins = pct->soc->pins;
 919         abx500_pinctrl_desc.npins = pct->soc->npins;
 920         pct->pctldev = pinctrl_register(&abx500_pinctrl_desc, &pdev->dev, pct);
 921         if (!pct->pctldev) {
 922                 dev_err(&pdev->dev,
 923                         "could not register abx500 pinctrl driver\n");
 924                 ret = -EINVAL;
 925                 goto out_rem_chip;
 926         }
 927         dev_info(&pdev->dev, "registered pin controller\n");
 928
 929         /* We will handle a range of GPIO pins */
 930         for (i = 0; i < pct->soc->gpio_num_ranges; i++) {
 931                 const struct abx500_pinrange *p = &pct->soc->gpio_ranges[i];
 932
 933                 ret = gpiochip_add_pin_range(&pct->chip,
 934                                         dev_name(&pdev->dev),
 935                                         p->offset - 1, p->offset, p->npins);
 936                 if (ret < 0)
 937                         goto out_rem_chip;
 938         }
 939
 940         platform_set_drvdata(pdev, pct);
 941         dev_info(&pdev->dev, "initialized abx500 pinctrl driver\n");
 942
 943         return 0;
 944
 945 out_rem_chip:
 946         err = gpiochip_remove(&pct->chip);
 947         if (err)
 948                 dev_info(&pdev->dev, "failed to remove gpiochip\n");
 949
 950         return ret;
 951 }
 952
 953 /**
 954  * abx500_gpio_remove() - remove Ab8500-gpio driver
 955  * @pdev:       Platform device registered
 956  */
 957 static int abx500_gpio_remove(struct platform_device *pdev)
 958 {
 959         struct abx500_pinctrl *pct = platform_get_drvdata(pdev);
 960         int ret;
 961
 962         ret = gpiochip_remove(&pct->chip);
 963         if (ret < 0) {
 964                 dev_err(pct->dev, "unable to remove gpiochip: %d\n",
 965                         ret);
 966                 return ret;
 967         }
 968
 969         return 0;
 970 }
 971
 972 static const struct platform_device_id abx500_pinctrl_id[] = {
 973         { "pinctrl-ab8500", PINCTRL_AB8500 },
 974         { "pinctrl-ab8540", PINCTRL_AB8540 },
 975         { "pinctrl-ab9540", PINCTRL_AB9540 },
 976         { "pinctrl-ab8505", PINCTRL_AB8505 },
 977         { },
 978 };
 979
 980 static struct platform_driver abx500_gpio_driver = {
 981         .driver = {
 982                 .name = "abx500-gpio",
 983                 .owner = THIS_MODULE,
 984                 .of_match_table = abx500_gpio_match,
 985         },
 986         .probe = abx500_gpio_probe,
 987         .remove = abx500_gpio_remove,
 988         .id_table = abx500_pinctrl_id,
 989 };
 990
 991 static int __init abx500_gpio_init(void)
 992 {
 993         return platform_driver_register(&abx500_gpio_driver);
 994 }
 995 core_initcall(abx500_gpio_init);
 996
 997 MODULE_AUTHOR("Patrice Chotard <patrice.chotard@st.com>");
 998 MODULE_DESCRIPTION("Driver allows to use AxB5xx unused pins to be used as GPIO");
 999 MODULE_ALIAS("platform:abx500-gpio");
1000 MODULE_LICENSE("GPL v2");