drivers/gpio/gpio-pca953x.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  *  PCA953x 4/8/16/24/40 bit I/O ports
   4  *
   5  *  Copyright (C) 2005 Ben Gardner <bgardner@wabtec.com>
   6  *  Copyright (C) 2007 Marvell International Ltd.
   7  *
   8  *  Derived from drivers/i2c/chips/pca9539.c
   9  */
  10
  11 #include <linux/acpi.h>
  12 #include <linux/bitmap.h>
  13 #include <linux/gpio/driver.h>
  14 #include <linux/gpio/consumer.h>
  15 #include <linux/i2c.h>
  16 #include <linux/init.h>
  17 #include <linux/interrupt.h>
  18 #include <linux/module.h>
  19 #include <linux/of_platform.h>
  20 #include <linux/platform_data/pca953x.h>
  21 #include <linux/regmap.h>
  22 #include <linux/regulator/consumer.h>
  23 #include <linux/slab.h>
  24
  25 #include <asm/unaligned.h>
  26
  27 #define PCA953X_INPUT           0x00
  28 #define PCA953X_OUTPUT          0x01
  29 #define PCA953X_INVERT          0x02
  30 #define PCA953X_DIRECTION       0x03
  31
  32 #define REG_ADDR_MASK           GENMASK(5, 0)
  33 #define REG_ADDR_EXT            BIT(6)
  34 #define REG_ADDR_AI             BIT(7)
  35
  36 #define PCA957X_IN              0x00
  37 #define PCA957X_INVRT           0x01
  38 #define PCA957X_BKEN            0x02
  39 #define PCA957X_PUPD            0x03
  40 #define PCA957X_CFG             0x04
  41 #define PCA957X_OUT             0x05
  42 #define PCA957X_MSK             0x06
  43 #define PCA957X_INTS            0x07
  44
  45 #define PCAL953X_OUT_STRENGTH   0x20
  46 #define PCAL953X_IN_LATCH       0x22
  47 #define PCAL953X_PULL_EN        0x23
  48 #define PCAL953X_PULL_SEL       0x24
  49 #define PCAL953X_INT_MASK       0x25
  50 #define PCAL953X_INT_STAT       0x26
  51 #define PCAL953X_OUT_CONF       0x27
  52
  53 #define PCAL6524_INT_EDGE       0x28
  54 #define PCAL6524_INT_CLR        0x2a
  55 #define PCAL6524_IN_STATUS      0x2b
  56 #define PCAL6524_OUT_INDCONF    0x2c
  57 #define PCAL6524_DEBOUNCE       0x2d
  58
  59 #define PCA_GPIO_MASK           GENMASK(7, 0)
  60
  61 #define PCAL_GPIO_MASK          GENMASK(4, 0)
  62 #define PCAL_PINCTRL_MASK       GENMASK(6, 5)
  63
  64 #define PCA_INT                 BIT(8)
  65 #define PCA_PCAL                BIT(9)
  66 #define PCA_LATCH_INT           (PCA_PCAL | PCA_INT)
  67 #define PCA953X_TYPE            BIT(12)
  68 #define PCA957X_TYPE            BIT(13)
  69 #define PCAL653X_TYPE           BIT(14)
  70 #define PCA_TYPE_MASK           GENMASK(15, 12)
  71
  72 #define PCA_CHIP_TYPE(x)        ((x) & PCA_TYPE_MASK)
  73
  74 static const struct i2c_device_id pca953x_id[] = {
  75         { "pca6408", 8  | PCA953X_TYPE | PCA_INT, },
  76         { "pca6416", 16 | PCA953X_TYPE | PCA_INT, },
  77         { "pca9505", 40 | PCA953X_TYPE | PCA_INT, },
  78         { "pca9506", 40 | PCA953X_TYPE | PCA_INT, },
  79         { "pca9534", 8  | PCA953X_TYPE | PCA_INT, },
  80         { "pca9535", 16 | PCA953X_TYPE | PCA_INT, },
  81         { "pca9536", 4  | PCA953X_TYPE, },
  82         { "pca9537", 4  | PCA953X_TYPE | PCA_INT, },
  83         { "pca9538", 8  | PCA953X_TYPE | PCA_INT, },
  84         { "pca9539", 16 | PCA953X_TYPE | PCA_INT, },
  85         { "pca9554", 8  | PCA953X_TYPE | PCA_INT, },
  86         { "pca9555", 16 | PCA953X_TYPE | PCA_INT, },
  87         { "pca9556", 8  | PCA953X_TYPE, },
  88         { "pca9557", 8  | PCA953X_TYPE, },
  89         { "pca9574", 8  | PCA957X_TYPE | PCA_INT, },
  90         { "pca9575", 16 | PCA957X_TYPE | PCA_INT, },
  91         { "pca9698", 40 | PCA953X_TYPE, },
  92
  93         { "pcal6408", 8 | PCA953X_TYPE | PCA_LATCH_INT, },
  94         { "pcal6416", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
  95         { "pcal6524", 24 | PCA953X_TYPE | PCA_LATCH_INT, },
  96         { "pcal6534", 34 | PCAL653X_TYPE | PCA_LATCH_INT, },
  97         { "pcal9535", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
  98         { "pcal9554b", 8  | PCA953X_TYPE | PCA_LATCH_INT, },
  99         { "pcal9555a", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
 100
 101         { "max7310", 8  | PCA953X_TYPE, },
 102         { "max7312", 16 | PCA953X_TYPE | PCA_INT, },
 103         { "max7313", 16 | PCA953X_TYPE | PCA_INT, },
 104         { "max7315", 8  | PCA953X_TYPE | PCA_INT, },
 105         { "max7318", 16 | PCA953X_TYPE | PCA_INT, },
 106         { "pca6107", 8  | PCA953X_TYPE | PCA_INT, },
 107         { "tca6408", 8  | PCA953X_TYPE | PCA_INT, },
 108         { "tca6416", 16 | PCA953X_TYPE | PCA_INT, },
 109         { "tca6424", 24 | PCA953X_TYPE | PCA_INT, },
 110         { "tca9539", 16 | PCA953X_TYPE | PCA_INT, },
 111         { "tca9554", 8  | PCA953X_TYPE | PCA_INT, },
 112         { "xra1202", 8  | PCA953X_TYPE },
 113         { }
 114 };
 115 MODULE_DEVICE_TABLE(i2c, pca953x_id);
 116
 117 #ifdef CONFIG_GPIO_PCA953X_IRQ
 118
 119 #include <linux/dmi.h>
 120
 121 static const struct acpi_gpio_params pca953x_irq_gpios = { 0, 0, true };
 122
 123 static const struct acpi_gpio_mapping pca953x_acpi_irq_gpios[] = {
 124         { "irq-gpios", &pca953x_irq_gpios, 1, ACPI_GPIO_QUIRK_ABSOLUTE_NUMBER },
 125         { }
 126 };
 127
 128 static int pca953x_acpi_get_irq(struct device *dev)
 129 {
 130         int ret;
 131
 132         ret = devm_acpi_dev_add_driver_gpios(dev, pca953x_acpi_irq_gpios);
 133         if (ret)
 134                 dev_warn(dev, "can't add GPIO ACPI mapping\n");
 135
 136         ret = acpi_dev_gpio_irq_get_by(ACPI_COMPANION(dev), "irq-gpios", 0);
 137         if (ret < 0)
 138                 return ret;
 139
 140         dev_info(dev, "ACPI interrupt quirk (IRQ %d)\n", ret);
 141         return ret;
 142 }
 143
 144 static const struct dmi_system_id pca953x_dmi_acpi_irq_info[] = {
 145         {
 146                 /*
 147                  * On Intel Galileo Gen 2 board the IRQ pin of one of
 148                  * the I²C GPIO expanders, which has GpioInt() resource,
 149                  * is provided as an absolute number instead of being
 150                  * relative. Since first controller (gpio-sch.c) and
 151                  * second (gpio-dwapb.c) are at the fixed bases, we may
 152                  * safely refer to the number in the global space to get
 153                  * an IRQ out of it.
 154                  */
 155                 .matches = {
 156                         DMI_EXACT_MATCH(DMI_BOARD_NAME, "GalileoGen2"),
 157                 },
 158         },
 159         {}
 160 };
 161 #endif
 162
 163 static const struct acpi_device_id pca953x_acpi_ids[] = {
 164         { "INT3491", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
 165         { }
 166 };
 167 MODULE_DEVICE_TABLE(acpi, pca953x_acpi_ids);
 168
 169 #define MAX_BANK 5
 170 #define BANK_SZ 8
 171 #define MAX_LINE        (MAX_BANK * BANK_SZ)
 172
 173 #define NBANK(chip) DIV_ROUND_UP(chip->gpio_chip.ngpio, BANK_SZ)
 174
 175 struct pca953x_reg_config {
 176         int direction;
 177         int output;
 178         int input;
 179         int invert;
 180 };
 181
 182 static const struct pca953x_reg_config pca953x_regs = {
 183         .direction = PCA953X_DIRECTION,
 184         .output = PCA953X_OUTPUT,
 185         .input = PCA953X_INPUT,
 186         .invert = PCA953X_INVERT,
 187 };
 188
 189 static const struct pca953x_reg_config pca957x_regs = {
 190         .direction = PCA957X_CFG,
 191         .output = PCA957X_OUT,
 192         .input = PCA957X_IN,
 193         .invert = PCA957X_INVRT,
 194 };
 195
 196 struct pca953x_chip {
 197         unsigned gpio_start;
 198         struct mutex i2c_lock;
 199         struct regmap *regmap;
 200
 201 #ifdef CONFIG_GPIO_PCA953X_IRQ
 202         struct mutex irq_lock;
 203         DECLARE_BITMAP(irq_mask, MAX_LINE);
 204         DECLARE_BITMAP(irq_stat, MAX_LINE);
 205         DECLARE_BITMAP(irq_trig_raise, MAX_LINE);
 206         DECLARE_BITMAP(irq_trig_fall, MAX_LINE);
 207 #endif
 208         atomic_t wakeup_path;
 209
 210         struct i2c_client *client;
 211         struct gpio_chip gpio_chip;
 212         const char *const *names;
 213         unsigned long driver_data;
 214         struct regulator *regulator;
 215
 216         const struct pca953x_reg_config *regs;
 217
 218         u8 (*recalc_addr)(struct pca953x_chip *chip, int reg, int off);
 219         bool (*check_reg)(struct pca953x_chip *chip, unsigned int reg,
 220                           u32 checkbank);
 221 };
 222
 223 static int pca953x_bank_shift(struct pca953x_chip *chip)
 224 {
 225         return fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
 226 }
 227
 228 #define PCA953x_BANK_INPUT      BIT(0)
 229 #define PCA953x_BANK_OUTPUT     BIT(1)
 230 #define PCA953x_BANK_POLARITY   BIT(2)
 231 #define PCA953x_BANK_CONFIG     BIT(3)
 232
 233 #define PCA957x_BANK_INPUT      BIT(0)
 234 #define PCA957x_BANK_POLARITY   BIT(1)
 235 #define PCA957x_BANK_BUSHOLD    BIT(2)
 236 #define PCA957x_BANK_CONFIG     BIT(4)
 237 #define PCA957x_BANK_OUTPUT     BIT(5)
 238
 239 #define PCAL9xxx_BANK_IN_LATCH  BIT(8 + 2)
 240 #define PCAL9xxx_BANK_PULL_EN   BIT(8 + 3)
 241 #define PCAL9xxx_BANK_PULL_SEL  BIT(8 + 4)
 242 #define PCAL9xxx_BANK_IRQ_MASK  BIT(8 + 5)
 243 #define PCAL9xxx_BANK_IRQ_STAT  BIT(8 + 6)
 244
 245 /*
 246  * We care about the following registers:
 247  * - Standard set, below 0x40, each port can be replicated up to 8 times
 248  *   - PCA953x standard
 249  *     Input port                       0x00 + 0 * bank_size    R
 250  *     Output port                      0x00 + 1 * bank_size    RW
 251  *     Polarity Inversion port          0x00 + 2 * bank_size    RW
 252  *     Configuration port               0x00 + 3 * bank_size    RW
 253  *   - PCA957x with mixed up registers
 254  *     Input port                       0x00 + 0 * bank_size    R
 255  *     Polarity Inversion port          0x00 + 1 * bank_size    RW
 256  *     Bus hold port                    0x00 + 2 * bank_size    RW
 257  *     Configuration port               0x00 + 4 * bank_size    RW
 258  *     Output port                      0x00 + 5 * bank_size    RW
 259  *
 260  * - Extended set, above 0x40, often chip specific.
 261  *   - PCAL6524/PCAL9555A with custom PCAL IRQ handling:
 262  *     Input latch register             0x40 + 2 * bank_size    RW
 263  *     Pull-up/pull-down enable reg     0x40 + 3 * bank_size    RW
 264  *     Pull-up/pull-down select reg     0x40 + 4 * bank_size    RW
 265  *     Interrupt mask register          0x40 + 5 * bank_size    RW
 266  *     Interrupt status register        0x40 + 6 * bank_size    R
 267  *
 268  * - Registers with bit 0x80 set, the AI bit
 269  *   The bit is cleared and the registers fall into one of the
 270  *   categories above.
 271  */
 272
 273 static bool pca953x_check_register(struct pca953x_chip *chip, unsigned int reg,
 274                                    u32 checkbank)
 275 {
 276         int bank_shift = pca953x_bank_shift(chip);
 277         int bank = (reg & REG_ADDR_MASK) >> bank_shift;
 278         int offset = reg & (BIT(bank_shift) - 1);
 279
 280         /* Special PCAL extended register check. */
 281         if (reg & REG_ADDR_EXT) {
 282                 if (!(chip->driver_data & PCA_PCAL))
 283                         return false;
 284                 bank += 8;
 285         }
 286
 287         /* Register is not in the matching bank. */
 288         if (!(BIT(bank) & checkbank))
 289                 return false;
 290
 291         /* Register is not within allowed range of bank. */
 292         if (offset >= NBANK(chip))
 293                 return false;
 294
 295         return true;
 296 }
 297
 298 /*
 299  * Unfortunately, whilst the PCAL6534 chip (and compatibles) broadly follow the
 300  * same register layout as the PCAL6524, the spacing of the registers has been
 301  * fundamentally altered by compacting them and thus does not obey the same
 302  * rules, including being able to use bit shifting to determine bank. These
 303  * chips hence need special handling here.
 304  */
 305 static bool pcal6534_check_register(struct pca953x_chip *chip, unsigned int reg,
 306                                     u32 checkbank)
 307 {
 308         int bank;
 309         int offset;
 310
 311         if (reg >= 0x30) {
 312                 /*
 313                  * Reserved block between 14h and 2Fh does not align on
 314                  * expected bank boundaries like other devices.
 315                  */
 316                 int temp = reg - 0x30;
 317
 318                 bank = temp / NBANK(chip);
 319                 offset = temp - (bank * NBANK(chip));
 320                 bank += 8;
 321         } else if (reg >= 0x54) {
 322                 /*
 323                  * Handle lack of reserved registers after output port
 324                  * configuration register to form a bank.
 325                  */
 326                 int temp = reg - 0x54;
 327
 328                 bank = temp / NBANK(chip);
 329                 offset = temp - (bank * NBANK(chip));
 330                 bank += 16;
 331         } else {
 332                 bank = reg / NBANK(chip);
 333                 offset = reg - (bank * NBANK(chip));
 334         }
 335
 336         /* Register is not in the matching bank. */
 337         if (!(BIT(bank) & checkbank))
 338                 return false;
 339
 340         /* Register is not within allowed range of bank. */
 341         if (offset >= NBANK(chip))
 342                 return false;
 343
 344         return true;
 345 }
 346
 347 static bool pca953x_readable_register(struct device *dev, unsigned int reg)
 348 {
 349         struct pca953x_chip *chip = dev_get_drvdata(dev);
 350         u32 bank;
 351
 352         if (PCA_CHIP_TYPE(chip->driver_data) == PCA957X_TYPE) {
 353                 bank = PCA957x_BANK_INPUT | PCA957x_BANK_OUTPUT |
 354                        PCA957x_BANK_POLARITY | PCA957x_BANK_CONFIG |
 355                        PCA957x_BANK_BUSHOLD;
 356         } else {
 357                 bank = PCA953x_BANK_INPUT | PCA953x_BANK_OUTPUT |
 358                        PCA953x_BANK_POLARITY | PCA953x_BANK_CONFIG;
 359         }
 360
 361         if (chip->driver_data & PCA_PCAL) {
 362                 bank |= PCAL9xxx_BANK_IN_LATCH | PCAL9xxx_BANK_PULL_EN |
 363                         PCAL9xxx_BANK_PULL_SEL | PCAL9xxx_BANK_IRQ_MASK |
 364                         PCAL9xxx_BANK_IRQ_STAT;
 365         }
 366
 367         return chip->check_reg(chip, reg, bank);
 368 }
 369
 370 static bool pca953x_writeable_register(struct device *dev, unsigned int reg)
 371 {
 372         struct pca953x_chip *chip = dev_get_drvdata(dev);
 373         u32 bank;
 374
 375         if (PCA_CHIP_TYPE(chip->driver_data) == PCA957X_TYPE) {
 376                 bank = PCA957x_BANK_OUTPUT | PCA957x_BANK_POLARITY |
 377                         PCA957x_BANK_CONFIG | PCA957x_BANK_BUSHOLD;
 378         } else {
 379                 bank = PCA953x_BANK_OUTPUT | PCA953x_BANK_POLARITY |
 380                         PCA953x_BANK_CONFIG;
 381         }
 382
 383         if (chip->driver_data & PCA_PCAL)
 384                 bank |= PCAL9xxx_BANK_IN_LATCH | PCAL9xxx_BANK_PULL_EN |
 385                         PCAL9xxx_BANK_PULL_SEL | PCAL9xxx_BANK_IRQ_MASK;
 386
 387         return chip->check_reg(chip, reg, bank);
 388 }
 389
 390 static bool pca953x_volatile_register(struct device *dev, unsigned int reg)
 391 {
 392         struct pca953x_chip *chip = dev_get_drvdata(dev);
 393         u32 bank;
 394
 395         if (PCA_CHIP_TYPE(chip->driver_data) == PCA957X_TYPE)
 396                 bank = PCA957x_BANK_INPUT;
 397         else
 398                 bank = PCA953x_BANK_INPUT;
 399
 400         if (chip->driver_data & PCA_PCAL)
 401                 bank |= PCAL9xxx_BANK_IRQ_STAT;
 402
 403         return chip->check_reg(chip, reg, bank);
 404 }
 405
 406 static const struct regmap_config pca953x_i2c_regmap = {
 407         .reg_bits = 8,
 408         .val_bits = 8,
 409
 410         .use_single_read = true,
 411         .use_single_write = true,
 412
 413         .readable_reg = pca953x_readable_register,
 414         .writeable_reg = pca953x_writeable_register,
 415         .volatile_reg = pca953x_volatile_register,
 416
 417         .disable_locking = true,
 418         .cache_type = REGCACHE_RBTREE,
 419         .max_register = 0x7f,
 420 };
 421
 422 static const struct regmap_config pca953x_ai_i2c_regmap = {
 423         .reg_bits = 8,
 424         .val_bits = 8,
 425
 426         .read_flag_mask = REG_ADDR_AI,
 427         .write_flag_mask = REG_ADDR_AI,
 428
 429         .readable_reg = pca953x_readable_register,
 430         .writeable_reg = pca953x_writeable_register,
 431         .volatile_reg = pca953x_volatile_register,
 432
 433         .disable_locking = true,
 434         .cache_type = REGCACHE_RBTREE,
 435         .max_register = 0x7f,
 436 };
 437
 438 static u8 pca953x_recalc_addr(struct pca953x_chip *chip, int reg, int off)
 439 {
 440         int bank_shift = pca953x_bank_shift(chip);
 441         int addr = (reg & PCAL_GPIO_MASK) << bank_shift;
 442         int pinctrl = (reg & PCAL_PINCTRL_MASK) << 1;
 443         u8 regaddr = pinctrl | addr | (off / BANK_SZ);
 444
 445         return regaddr;
 446 }
 447
 448 /*
 449  * The PCAL6534 and compatible chips have altered bank alignment that doesn't
 450  * fit within the bit shifting scheme used for other devices.
 451  */
 452 static u8 pcal6534_recalc_addr(struct pca953x_chip *chip, int reg, int off)
 453 {
 454         int addr;
 455         int pinctrl;
 456
 457         addr = (reg & PCAL_GPIO_MASK) * NBANK(chip);
 458
 459         switch (reg) {
 460         case PCAL953X_OUT_STRENGTH:
 461         case PCAL953X_IN_LATCH:
 462         case PCAL953X_PULL_EN:
 463         case PCAL953X_PULL_SEL:
 464         case PCAL953X_INT_MASK:
 465         case PCAL953X_INT_STAT:
 466         case PCAL953X_OUT_CONF:
 467                 pinctrl = ((reg & PCAL_PINCTRL_MASK) >> 1) + 0x20;
 468                 break;
 469         case PCAL6524_INT_EDGE:
 470         case PCAL6524_INT_CLR:
 471         case PCAL6524_IN_STATUS:
 472         case PCAL6524_OUT_INDCONF:
 473         case PCAL6524_DEBOUNCE:
 474                 pinctrl = ((reg & PCAL_PINCTRL_MASK) >> 1) + 0x1c;
 475                 break;
 476         default:
 477                 pinctrl = 0;
 478                 break;
 479         }
 480
 481         return pinctrl + addr + (off / BANK_SZ);
 482 }
 483
 484 static int pca953x_write_regs(struct pca953x_chip *chip, int reg, unsigned long *val)
 485 {
 486         u8 regaddr = chip->recalc_addr(chip, reg, 0);
 487         u8 value[MAX_BANK];
 488         int i, ret;
 489
 490         for (i = 0; i < NBANK(chip); i++)
 491                 value[i] = bitmap_get_value8(val, i * BANK_SZ);
 492
 493         ret = regmap_bulk_write(chip->regmap, regaddr, value, NBANK(chip));
 494         if (ret < 0) {
 495                 dev_err(&chip->client->dev, "failed writing register\n");
 496                 return ret;
 497         }
 498
 499         return 0;
 500 }
 501
 502 static int pca953x_read_regs(struct pca953x_chip *chip, int reg, unsigned long *val)
 503 {
 504         u8 regaddr = chip->recalc_addr(chip, reg, 0);
 505         u8 value[MAX_BANK];
 506         int i, ret;
 507
 508         ret = regmap_bulk_read(chip->regmap, regaddr, value, NBANK(chip));
 509         if (ret < 0) {
 510                 dev_err(&chip->client->dev, "failed reading register\n");
 511                 return ret;
 512         }
 513
 514         for (i = 0; i < NBANK(chip); i++)
 515                 bitmap_set_value8(val, value[i], i * BANK_SZ);
 516
 517         return 0;
 518 }
 519
 520 static int pca953x_gpio_direction_input(struct gpio_chip *gc, unsigned off)
 521 {
 522         struct pca953x_chip *chip = gpiochip_get_data(gc);
 523         u8 dirreg = chip->recalc_addr(chip, chip->regs->direction, off);
 524         u8 bit = BIT(off % BANK_SZ);
 525         int ret;
 526
 527         mutex_lock(&chip->i2c_lock);
 528         ret = regmap_write_bits(chip->regmap, dirreg, bit, bit);
 529         mutex_unlock(&chip->i2c_lock);
 530         return ret;
 531 }
 532
 533 static int pca953x_gpio_direction_output(struct gpio_chip *gc,
 534                 unsigned off, int val)
 535 {
 536         struct pca953x_chip *chip = gpiochip_get_data(gc);
 537         u8 dirreg = chip->recalc_addr(chip, chip->regs->direction, off);
 538         u8 outreg = chip->recalc_addr(chip, chip->regs->output, off);
 539         u8 bit = BIT(off % BANK_SZ);
 540         int ret;
 541
 542         mutex_lock(&chip->i2c_lock);
 543         /* set output level */
 544         ret = regmap_write_bits(chip->regmap, outreg, bit, val ? bit : 0);
 545         if (ret)
 546                 goto exit;
 547
 548         /* then direction */
 549         ret = regmap_write_bits(chip->regmap, dirreg, bit, 0);
 550 exit:
 551         mutex_unlock(&chip->i2c_lock);
 552         return ret;
 553 }
 554
 555 static int pca953x_gpio_get_value(struct gpio_chip *gc, unsigned off)
 556 {
 557         struct pca953x_chip *chip = gpiochip_get_data(gc);
 558         u8 inreg = chip->recalc_addr(chip, chip->regs->input, off);
 559         u8 bit = BIT(off % BANK_SZ);
 560         u32 reg_val;
 561         int ret;
 562
 563         mutex_lock(&chip->i2c_lock);
 564         ret = regmap_read(chip->regmap, inreg, &reg_val);
 565         mutex_unlock(&chip->i2c_lock);
 566         if (ret < 0)
 567                 return ret;
 568
 569         return !!(reg_val & bit);
 570 }
 571
 572 static void pca953x_gpio_set_value(struct gpio_chip *gc, unsigned off, int val)
 573 {
 574         struct pca953x_chip *chip = gpiochip_get_data(gc);
 575         u8 outreg = chip->recalc_addr(chip, chip->regs->output, off);
 576         u8 bit = BIT(off % BANK_SZ);
 577
 578         mutex_lock(&chip->i2c_lock);
 579         regmap_write_bits(chip->regmap, outreg, bit, val ? bit : 0);
 580         mutex_unlock(&chip->i2c_lock);
 581 }
 582
 583 static int pca953x_gpio_get_direction(struct gpio_chip *gc, unsigned off)
 584 {
 585         struct pca953x_chip *chip = gpiochip_get_data(gc);
 586         u8 dirreg = chip->recalc_addr(chip, chip->regs->direction, off);
 587         u8 bit = BIT(off % BANK_SZ);
 588         u32 reg_val;
 589         int ret;
 590
 591         mutex_lock(&chip->i2c_lock);
 592         ret = regmap_read(chip->regmap, dirreg, &reg_val);
 593         mutex_unlock(&chip->i2c_lock);
 594         if (ret < 0)
 595                 return ret;
 596
 597         if (reg_val & bit)
 598                 return GPIO_LINE_DIRECTION_IN;
 599
 600         return GPIO_LINE_DIRECTION_OUT;
 601 }
 602
 603 static int pca953x_gpio_get_multiple(struct gpio_chip *gc,
 604                                      unsigned long *mask, unsigned long *bits)
 605 {
 606         struct pca953x_chip *chip = gpiochip_get_data(gc);
 607         DECLARE_BITMAP(reg_val, MAX_LINE);
 608         int ret;
 609
 610         mutex_lock(&chip->i2c_lock);
 611         ret = pca953x_read_regs(chip, chip->regs->input, reg_val);
 612         mutex_unlock(&chip->i2c_lock);
 613         if (ret)
 614                 return ret;
 615
 616         bitmap_replace(bits, bits, reg_val, mask, gc->ngpio);
 617         return 0;
 618 }
 619
 620 static void pca953x_gpio_set_multiple(struct gpio_chip *gc,
 621                                       unsigned long *mask, unsigned long *bits)
 622 {
 623         struct pca953x_chip *chip = gpiochip_get_data(gc);
 624         DECLARE_BITMAP(reg_val, MAX_LINE);
 625         int ret;
 626
 627         mutex_lock(&chip->i2c_lock);
 628         ret = pca953x_read_regs(chip, chip->regs->output, reg_val);
 629         if (ret)
 630                 goto exit;
 631
 632         bitmap_replace(reg_val, reg_val, bits, mask, gc->ngpio);
 633
 634         pca953x_write_regs(chip, chip->regs->output, reg_val);
 635 exit:
 636         mutex_unlock(&chip->i2c_lock);
 637 }
 638
 639 static int pca953x_gpio_set_pull_up_down(struct pca953x_chip *chip,
 640                                          unsigned int offset,
 641                                          unsigned long config)
 642 {
 643         enum pin_config_param param = pinconf_to_config_param(config);
 644
 645         u8 pull_en_reg = chip->recalc_addr(chip, PCAL953X_PULL_EN, offset);
 646         u8 pull_sel_reg = chip->recalc_addr(chip, PCAL953X_PULL_SEL, offset);
 647         u8 bit = BIT(offset % BANK_SZ);
 648         int ret;
 649
 650         /*
 651          * pull-up/pull-down configuration requires PCAL extended
 652          * registers
 653          */
 654         if (!(chip->driver_data & PCA_PCAL))
 655                 return -ENOTSUPP;
 656
 657         mutex_lock(&chip->i2c_lock);
 658
 659         /* Configure pull-up/pull-down */
 660         if (param == PIN_CONFIG_BIAS_PULL_UP)
 661                 ret = regmap_write_bits(chip->regmap, pull_sel_reg, bit, bit);
 662         else if (param == PIN_CONFIG_BIAS_PULL_DOWN)
 663                 ret = regmap_write_bits(chip->regmap, pull_sel_reg, bit, 0);
 664         else
 665                 ret = 0;
 666         if (ret)
 667                 goto exit;
 668
 669         /* Disable/Enable pull-up/pull-down */
 670         if (param == PIN_CONFIG_BIAS_DISABLE)
 671                 ret = regmap_write_bits(chip->regmap, pull_en_reg, bit, 0);
 672         else
 673                 ret = regmap_write_bits(chip->regmap, pull_en_reg, bit, bit);
 674
 675 exit:
 676         mutex_unlock(&chip->i2c_lock);
 677         return ret;
 678 }
 679
 680 static int pca953x_gpio_set_config(struct gpio_chip *gc, unsigned int offset,
 681                                    unsigned long config)
 682 {
 683         struct pca953x_chip *chip = gpiochip_get_data(gc);
 684
 685         switch (pinconf_to_config_param(config)) {
 686         case PIN_CONFIG_BIAS_PULL_UP:
 687         case PIN_CONFIG_BIAS_PULL_PIN_DEFAULT:
 688         case PIN_CONFIG_BIAS_PULL_DOWN:
 689         case PIN_CONFIG_BIAS_DISABLE:
 690                 return pca953x_gpio_set_pull_up_down(chip, offset, config);
 691         default:
 692                 return -ENOTSUPP;
 693         }
 694 }
 695
 696 static void pca953x_setup_gpio(struct pca953x_chip *chip, int gpios)
 697 {
 698         struct gpio_chip *gc;
 699
 700         gc = &chip->gpio_chip;
 701
 702         gc->direction_input  = pca953x_gpio_direction_input;
 703         gc->direction_output = pca953x_gpio_direction_output;
 704         gc->get = pca953x_gpio_get_value;
 705         gc->set = pca953x_gpio_set_value;
 706         gc->get_direction = pca953x_gpio_get_direction;
 707         gc->get_multiple = pca953x_gpio_get_multiple;
 708         gc->set_multiple = pca953x_gpio_set_multiple;
 709         gc->set_config = pca953x_gpio_set_config;
 710         gc->can_sleep = true;
 711
 712         gc->base = chip->gpio_start;
 713         gc->ngpio = gpios;
 714         gc->label = dev_name(&chip->client->dev);
 715         gc->parent = &chip->client->dev;
 716         gc->owner = THIS_MODULE;
 717         gc->names = chip->names;
 718 }
 719
 720 #ifdef CONFIG_GPIO_PCA953X_IRQ
 721 static void pca953x_irq_mask(struct irq_data *d)
 722 {
 723         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 724         struct pca953x_chip *chip = gpiochip_get_data(gc);
 725         irq_hw_number_t hwirq = irqd_to_hwirq(d);
 726
 727         clear_bit(hwirq, chip->irq_mask);
 728         gpiochip_disable_irq(gc, hwirq);
 729 }
 730
 731 static void pca953x_irq_unmask(struct irq_data *d)
 732 {
 733         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 734         struct pca953x_chip *chip = gpiochip_get_data(gc);
 735         irq_hw_number_t hwirq = irqd_to_hwirq(d);
 736
 737         gpiochip_enable_irq(gc, hwirq);
 738         set_bit(hwirq, chip->irq_mask);
 739 }
 740
 741 static int pca953x_irq_set_wake(struct irq_data *d, unsigned int on)
 742 {
 743         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 744         struct pca953x_chip *chip = gpiochip_get_data(gc);
 745
 746         if (on)
 747                 atomic_inc(&chip->wakeup_path);
 748         else
 749                 atomic_dec(&chip->wakeup_path);
 750
 751         return irq_set_irq_wake(chip->client->irq, on);
 752 }
 753
 754 static void pca953x_irq_bus_lock(struct irq_data *d)
 755 {
 756         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 757         struct pca953x_chip *chip = gpiochip_get_data(gc);
 758
 759         mutex_lock(&chip->irq_lock);
 760 }
 761
 762 static void pca953x_irq_bus_sync_unlock(struct irq_data *d)
 763 {
 764         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 765         struct pca953x_chip *chip = gpiochip_get_data(gc);
 766         DECLARE_BITMAP(irq_mask, MAX_LINE);
 767         DECLARE_BITMAP(reg_direction, MAX_LINE);
 768         int level;
 769
 770         if (chip->driver_data & PCA_PCAL) {
 771                 /* Enable latch on interrupt-enabled inputs */
 772                 pca953x_write_regs(chip, PCAL953X_IN_LATCH, chip->irq_mask);
 773
 774                 bitmap_complement(irq_mask, chip->irq_mask, gc->ngpio);
 775
 776                 /* Unmask enabled interrupts */
 777                 pca953x_write_regs(chip, PCAL953X_INT_MASK, irq_mask);
 778         }
 779
 780         /* Switch direction to input if needed */
 781         pca953x_read_regs(chip, chip->regs->direction, reg_direction);
 782
 783         bitmap_or(irq_mask, chip->irq_trig_fall, chip->irq_trig_raise, gc->ngpio);
 784         bitmap_complement(reg_direction, reg_direction, gc->ngpio);
 785         bitmap_and(irq_mask, irq_mask, reg_direction, gc->ngpio);
 786
 787         /* Look for any newly setup interrupt */
 788         for_each_set_bit(level, irq_mask, gc->ngpio)
 789                 pca953x_gpio_direction_input(&chip->gpio_chip, level);
 790
 791         mutex_unlock(&chip->irq_lock);
 792 }
 793
 794 static int pca953x_irq_set_type(struct irq_data *d, unsigned int type)
 795 {
 796         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 797         struct pca953x_chip *chip = gpiochip_get_data(gc);
 798         irq_hw_number_t hwirq = irqd_to_hwirq(d);
 799
 800         if (!(type & IRQ_TYPE_EDGE_BOTH)) {
 801                 dev_err(&chip->client->dev, "irq %d: unsupported type %d\n",
 802                         d->irq, type);
 803                 return -EINVAL;
 804         }
 805
 806         assign_bit(hwirq, chip->irq_trig_fall, type & IRQ_TYPE_EDGE_FALLING);
 807         assign_bit(hwirq, chip->irq_trig_raise, type & IRQ_TYPE_EDGE_RISING);
 808
 809         return 0;
 810 }
 811
 812 static void pca953x_irq_shutdown(struct irq_data *d)
 813 {
 814         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 815         struct pca953x_chip *chip = gpiochip_get_data(gc);
 816         irq_hw_number_t hwirq = irqd_to_hwirq(d);
 817
 818         clear_bit(hwirq, chip->irq_trig_raise);
 819         clear_bit(hwirq, chip->irq_trig_fall);
 820 }
 821
 822 static void pca953x_irq_print_chip(struct irq_data *data, struct seq_file *p)
 823 {
 824         struct gpio_chip *gc = irq_data_get_irq_chip_data(data);
 825
 826         seq_printf(p, dev_name(gc->parent));
 827 }
 828
 829 static const struct irq_chip pca953x_irq_chip = {
 830         .irq_mask               = pca953x_irq_mask,
 831         .irq_unmask             = pca953x_irq_unmask,
 832         .irq_set_wake           = pca953x_irq_set_wake,
 833         .irq_bus_lock           = pca953x_irq_bus_lock,
 834         .irq_bus_sync_unlock    = pca953x_irq_bus_sync_unlock,
 835         .irq_set_type           = pca953x_irq_set_type,
 836         .irq_shutdown           = pca953x_irq_shutdown,
 837         .irq_print_chip         = pca953x_irq_print_chip,
 838         .flags                  = IRQCHIP_IMMUTABLE,
 839         GPIOCHIP_IRQ_RESOURCE_HELPERS,
 840 };
 841
 842 static bool pca953x_irq_pending(struct pca953x_chip *chip, unsigned long *pending)
 843 {
 844         struct gpio_chip *gc = &chip->gpio_chip;
 845         DECLARE_BITMAP(reg_direction, MAX_LINE);
 846         DECLARE_BITMAP(old_stat, MAX_LINE);
 847         DECLARE_BITMAP(cur_stat, MAX_LINE);
 848         DECLARE_BITMAP(new_stat, MAX_LINE);
 849         DECLARE_BITMAP(trigger, MAX_LINE);
 850         int ret;
 851
 852         if (chip->driver_data & PCA_PCAL) {
 853                 /* Read the current interrupt status from the device */
 854                 ret = pca953x_read_regs(chip, PCAL953X_INT_STAT, trigger);
 855                 if (ret)
 856                         return false;
 857
 858                 /* Check latched inputs and clear interrupt status */
 859                 ret = pca953x_read_regs(chip, chip->regs->input, cur_stat);
 860                 if (ret)
 861                         return false;
 862
 863                 /* Apply filter for rising/falling edge selection */
 864                 bitmap_replace(new_stat, chip->irq_trig_fall, chip->irq_trig_raise, cur_stat, gc->ngpio);
 865
 866                 bitmap_and(pending, new_stat, trigger, gc->ngpio);
 867
 868                 return !bitmap_empty(pending, gc->ngpio);
 869         }
 870
 871         ret = pca953x_read_regs(chip, chip->regs->input, cur_stat);
 872         if (ret)
 873                 return false;
 874
 875         /* Remove output pins from the equation */
 876         pca953x_read_regs(chip, chip->regs->direction, reg_direction);
 877
 878         bitmap_copy(old_stat, chip->irq_stat, gc->ngpio);
 879
 880         bitmap_and(new_stat, cur_stat, reg_direction, gc->ngpio);
 881         bitmap_xor(cur_stat, new_stat, old_stat, gc->ngpio);
 882         bitmap_and(trigger, cur_stat, chip->irq_mask, gc->ngpio);
 883
 884         bitmap_copy(chip->irq_stat, new_stat, gc->ngpio);
 885
 886         if (bitmap_empty(trigger, gc->ngpio))
 887                 return false;
 888
 889         bitmap_and(cur_stat, chip->irq_trig_fall, old_stat, gc->ngpio);
 890         bitmap_and(old_stat, chip->irq_trig_raise, new_stat, gc->ngpio);
 891         bitmap_or(new_stat, old_stat, cur_stat, gc->ngpio);
 892         bitmap_and(pending, new_stat, trigger, gc->ngpio);
 893
 894         return !bitmap_empty(pending, gc->ngpio);
 895 }
 896
 897 static irqreturn_t pca953x_irq_handler(int irq, void *devid)
 898 {
 899         struct pca953x_chip *chip = devid;
 900         struct gpio_chip *gc = &chip->gpio_chip;
 901         DECLARE_BITMAP(pending, MAX_LINE);
 902         int level;
 903         bool ret;
 904
 905         bitmap_zero(pending, MAX_LINE);
 906
 907         mutex_lock(&chip->i2c_lock);
 908         ret = pca953x_irq_pending(chip, pending);
 909         mutex_unlock(&chip->i2c_lock);
 910
 911         if (ret) {
 912                 ret = 0;
 913
 914                 for_each_set_bit(level, pending, gc->ngpio) {
 915                         int nested_irq = irq_find_mapping(gc->irq.domain, level);
 916
 917                         if (unlikely(nested_irq <= 0)) {
 918                                 dev_warn_ratelimited(gc->parent, "unmapped interrupt %d\n", level);
 919                                 continue;
 920                         }
 921
 922                         handle_nested_irq(nested_irq);
 923                         ret = 1;
 924                 }
 925         }
 926
 927         return IRQ_RETVAL(ret);
 928 }
 929
 930 static int pca953x_irq_setup(struct pca953x_chip *chip, int irq_base)
 931 {
 932         struct i2c_client *client = chip->client;
 933         DECLARE_BITMAP(reg_direction, MAX_LINE);
 934         DECLARE_BITMAP(irq_stat, MAX_LINE);
 935         struct gpio_irq_chip *girq;
 936         int ret;
 937
 938         if (dmi_first_match(pca953x_dmi_acpi_irq_info)) {
 939                 ret = pca953x_acpi_get_irq(&client->dev);
 940                 if (ret > 0)
 941                         client->irq = ret;
 942         }
 943
 944         if (!client->irq)
 945                 return 0;
 946
 947         if (irq_base == -1)
 948                 return 0;
 949
 950         if (!(chip->driver_data & PCA_INT))
 951                 return 0;
 952
 953         ret = pca953x_read_regs(chip, chip->regs->input, irq_stat);
 954         if (ret)
 955                 return ret;
 956
 957         /*
 958          * There is no way to know which GPIO line generated the
 959          * interrupt.  We have to rely on the previous read for
 960          * this purpose.
 961          */
 962         pca953x_read_regs(chip, chip->regs->direction, reg_direction);
 963         bitmap_and(chip->irq_stat, irq_stat, reg_direction, chip->gpio_chip.ngpio);
 964         mutex_init(&chip->irq_lock);
 965
 966         girq = &chip->gpio_chip.irq;
 967         gpio_irq_chip_set_chip(girq, &pca953x_irq_chip);
 968         /* This will let us handle the parent IRQ in the driver */
 969         girq->parent_handler = NULL;
 970         girq->num_parents = 0;
 971         girq->parents = NULL;
 972         girq->default_type = IRQ_TYPE_NONE;
 973         girq->handler = handle_simple_irq;
 974         girq->threaded = true;
 975         girq->first = irq_base; /* FIXME: get rid of this */
 976
 977         ret = devm_request_threaded_irq(&client->dev, client->irq,
 978                                         NULL, pca953x_irq_handler,
 979                                         IRQF_ONESHOT | IRQF_SHARED,
 980                                         dev_name(&client->dev), chip);
 981         if (ret) {
 982                 dev_err(&client->dev, "failed to request irq %d\n",
 983                         client->irq);
 984                 return ret;
 985         }
 986
 987         return 0;
 988 }
 989
 990 #else /* CONFIG_GPIO_PCA953X_IRQ */
 991 static int pca953x_irq_setup(struct pca953x_chip *chip,
 992                              int irq_base)
 993 {
 994         struct i2c_client *client = chip->client;
 995
 996         if (client->irq && irq_base != -1 && (chip->driver_data & PCA_INT))
 997                 dev_warn(&client->dev, "interrupt support not compiled in\n");
 998
 999         return 0;
1000 }
1001 #endif
1002
1003 static int device_pca95xx_init(struct pca953x_chip *chip, u32 invert)
1004 {
1005         DECLARE_BITMAP(val, MAX_LINE);
1006         u8 regaddr;
1007         int ret;
1008
1009         regaddr = chip->recalc_addr(chip, chip->regs->output, 0);
1010         ret = regcache_sync_region(chip->regmap, regaddr,
1011                                    regaddr + NBANK(chip) - 1);
1012         if (ret)
1013                 goto out;
1014
1015         regaddr = chip->recalc_addr(chip, chip->regs->direction, 0);
1016         ret = regcache_sync_region(chip->regmap, regaddr,
1017                                    regaddr + NBANK(chip) - 1);
1018         if (ret)
1019                 goto out;
1020
1021         /* set platform specific polarity inversion */
1022         if (invert)
1023                 bitmap_fill(val, MAX_LINE);
1024         else
1025                 bitmap_zero(val, MAX_LINE);
1026
1027         ret = pca953x_write_regs(chip, chip->regs->invert, val);
1028 out:
1029         return ret;
1030 }
1031
1032 static int device_pca957x_init(struct pca953x_chip *chip, u32 invert)
1033 {
1034         DECLARE_BITMAP(val, MAX_LINE);
1035         unsigned int i;
1036         int ret;
1037
1038         ret = device_pca95xx_init(chip, invert);
1039         if (ret)
1040                 goto out;
1041
1042         /* To enable register 6, 7 to control pull up and pull down */
1043         for (i = 0; i < NBANK(chip); i++)
1044                 bitmap_set_value8(val, 0x02, i * BANK_SZ);
1045
1046         ret = pca953x_write_regs(chip, PCA957X_BKEN, val);
1047         if (ret)
1048                 goto out;
1049
1050         return 0;
1051 out:
1052         return ret;
1053 }
1054
1055 static int pca953x_probe(struct i2c_client *client,
1056                          const struct i2c_device_id *i2c_id)
1057 {
1058         struct pca953x_platform_data *pdata;
1059         struct pca953x_chip *chip;
1060         int irq_base = 0;
1061         int ret;
1062         u32 invert = 0;
1063         struct regulator *reg;
1064         const struct regmap_config *regmap_config;
1065
1066         chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
1067         if (chip == NULL)
1068                 return -ENOMEM;
1069
1070         pdata = dev_get_platdata(&client->dev);
1071         if (pdata) {
1072                 irq_base = pdata->irq_base;
1073                 chip->gpio_start = pdata->gpio_base;
1074                 invert = pdata->invert;
1075                 chip->names = pdata->names;
1076         } else {
1077                 struct gpio_desc *reset_gpio;
1078
1079                 chip->gpio_start = -1;
1080                 irq_base = 0;
1081
1082                 /*
1083                  * See if we need to de-assert a reset pin.
1084                  *
1085                  * There is no known ACPI-enabled platforms that are
1086                  * using "reset" GPIO. Otherwise any of those platform
1087                  * must use _DSD method with corresponding property.
1088                  */
1089                 reset_gpio = devm_gpiod_get_optional(&client->dev, "reset",
1090                                                      GPIOD_OUT_LOW);
1091                 if (IS_ERR(reset_gpio))
1092                         return PTR_ERR(reset_gpio);
1093         }
1094
1095         chip->client = client;
1096
1097         reg = devm_regulator_get(&client->dev, "vcc");
1098         if (IS_ERR(reg))
1099                 return dev_err_probe(&client->dev, PTR_ERR(reg), "reg get err\n");
1100
1101         ret = regulator_enable(reg);
1102         if (ret) {
1103                 dev_err(&client->dev, "reg en err: %d\n", ret);
1104                 return ret;
1105         }
1106         chip->regulator = reg;
1107
1108         if (i2c_id) {
1109                 chip->driver_data = i2c_id->driver_data;
1110         } else {
1111                 const void *match;
1112
1113                 match = device_get_match_data(&client->dev);
1114                 if (!match) {
1115                         ret = -ENODEV;
1116                         goto err_exit;
1117                 }
1118
1119                 chip->driver_data = (uintptr_t)match;
1120         }
1121
1122         i2c_set_clientdata(client, chip);
1123
1124         pca953x_setup_gpio(chip, chip->driver_data & PCA_GPIO_MASK);
1125
1126         if (NBANK(chip) > 2 || PCA_CHIP_TYPE(chip->driver_data) == PCA957X_TYPE) {
1127                 dev_info(&client->dev, "using AI\n");
1128                 regmap_config = &pca953x_ai_i2c_regmap;
1129         } else {
1130                 dev_info(&client->dev, "using no AI\n");
1131                 regmap_config = &pca953x_i2c_regmap;
1132         }
1133
1134         if (PCA_CHIP_TYPE(chip->driver_data) == PCAL653X_TYPE) {
1135                 chip->recalc_addr = pcal6534_recalc_addr;
1136                 chip->check_reg = pcal6534_check_register;
1137         } else {
1138                 chip->recalc_addr = pca953x_recalc_addr;
1139                 chip->check_reg = pca953x_check_register;
1140         }
1141
1142         chip->regmap = devm_regmap_init_i2c(client, regmap_config);
1143         if (IS_ERR(chip->regmap)) {
1144                 ret = PTR_ERR(chip->regmap);
1145                 goto err_exit;
1146         }
1147
1148         regcache_mark_dirty(chip->regmap);
1149
1150         mutex_init(&chip->i2c_lock);
1151         /*
1152          * In case we have an i2c-mux controlled by a GPIO provided by an
1153          * expander using the same driver higher on the device tree, read the
1154          * i2c adapter nesting depth and use the retrieved value as lockdep
1155          * subclass for chip->i2c_lock.
1156          *
1157          * REVISIT: This solution is not complete. It protects us from lockdep
1158          * false positives when the expander controlling the i2c-mux is on
1159          * a different level on the device tree, but not when it's on the same
1160          * level on a different branch (in which case the subclass number
1161          * would be the same).
1162          *
1163          * TODO: Once a correct solution is developed, a similar fix should be
1164          * applied to all other i2c-controlled GPIO expanders (and potentially
1165          * regmap-i2c).
1166          */
1167         lockdep_set_subclass(&chip->i2c_lock,
1168                              i2c_adapter_depth(client->adapter));
1169
1170         /* initialize cached registers from their original values.
1171          * we can't share this chip with another i2c master.
1172          */
1173         if (PCA_CHIP_TYPE(chip->driver_data) == PCA957X_TYPE) {
1174                 chip->regs = &pca957x_regs;
1175                 ret = device_pca957x_init(chip, invert);
1176         } else {
1177                 chip->regs = &pca953x_regs;
1178                 ret = device_pca95xx_init(chip, invert);
1179         }
1180         if (ret)
1181                 goto err_exit;
1182
1183         ret = pca953x_irq_setup(chip, irq_base);
1184         if (ret)
1185                 goto err_exit;
1186
1187         ret = devm_gpiochip_add_data(&client->dev, &chip->gpio_chip, chip);
1188         if (ret)
1189                 goto err_exit;
1190
1191         if (pdata && pdata->setup) {
1192                 ret = pdata->setup(client, chip->gpio_chip.base,
1193                                    chip->gpio_chip.ngpio, pdata->context);
1194                 if (ret < 0)
1195                         dev_warn(&client->dev, "setup failed, %d\n", ret);
1196         }
1197
1198         return 0;
1199
1200 err_exit:
1201         regulator_disable(chip->regulator);
1202         return ret;
1203 }
1204
1205 static void pca953x_remove(struct i2c_client *client)
1206 {
1207         struct pca953x_platform_data *pdata = dev_get_platdata(&client->dev);
1208         struct pca953x_chip *chip = i2c_get_clientdata(client);
1209
1210         if (pdata && pdata->teardown) {
1211                 pdata->teardown(client, chip->gpio_chip.base,
1212                                 chip->gpio_chip.ngpio, pdata->context);
1213         }
1214
1215         regulator_disable(chip->regulator);
1216 }
1217
1218 #ifdef CONFIG_PM_SLEEP
1219 static int pca953x_regcache_sync(struct device *dev)
1220 {
1221         struct pca953x_chip *chip = dev_get_drvdata(dev);
1222         int ret;
1223         u8 regaddr;
1224
1225         /*
1226          * The ordering between direction and output is important,
1227          * sync these registers first and only then sync the rest.
1228          */
1229         regaddr = chip->recalc_addr(chip, chip->regs->direction, 0);
1230         ret = regcache_sync_region(chip->regmap, regaddr, regaddr + NBANK(chip) - 1);
1231         if (ret) {
1232                 dev_err(dev, "Failed to sync GPIO dir registers: %d\n", ret);
1233                 return ret;
1234         }
1235
1236         regaddr = chip->recalc_addr(chip, chip->regs->output, 0);
1237         ret = regcache_sync_region(chip->regmap, regaddr, regaddr + NBANK(chip) - 1);
1238         if (ret) {
1239                 dev_err(dev, "Failed to sync GPIO out registers: %d\n", ret);
1240                 return ret;
1241         }
1242
1243 #ifdef CONFIG_GPIO_PCA953X_IRQ
1244         if (chip->driver_data & PCA_PCAL) {
1245                 regaddr = chip->recalc_addr(chip, PCAL953X_IN_LATCH, 0);
1246                 ret = regcache_sync_region(chip->regmap, regaddr,
1247                                            regaddr + NBANK(chip) - 1);
1248                 if (ret) {
1249                         dev_err(dev, "Failed to sync INT latch registers: %d\n",
1250                                 ret);
1251                         return ret;
1252                 }
1253
1254                 regaddr = chip->recalc_addr(chip, PCAL953X_INT_MASK, 0);
1255                 ret = regcache_sync_region(chip->regmap, regaddr,
1256                                            regaddr + NBANK(chip) - 1);
1257                 if (ret) {
1258                         dev_err(dev, "Failed to sync INT mask registers: %d\n",
1259                                 ret);
1260                         return ret;
1261                 }
1262         }
1263 #endif
1264
1265         return 0;
1266 }
1267
1268 static int pca953x_suspend(struct device *dev)
1269 {
1270         struct pca953x_chip *chip = dev_get_drvdata(dev);
1271
1272         mutex_lock(&chip->i2c_lock);
1273         regcache_cache_only(chip->regmap, true);
1274         mutex_unlock(&chip->i2c_lock);
1275
1276         if (atomic_read(&chip->wakeup_path))
1277                 device_set_wakeup_path(dev);
1278         else
1279                 regulator_disable(chip->regulator);
1280
1281         return 0;
1282 }
1283
1284 static int pca953x_resume(struct device *dev)
1285 {
1286         struct pca953x_chip *chip = dev_get_drvdata(dev);
1287         int ret;
1288
1289         if (!atomic_read(&chip->wakeup_path)) {
1290                 ret = regulator_enable(chip->regulator);
1291                 if (ret) {
1292                         dev_err(dev, "Failed to enable regulator: %d\n", ret);
1293                         return 0;
1294                 }
1295         }
1296
1297         mutex_lock(&chip->i2c_lock);
1298         regcache_cache_only(chip->regmap, false);
1299         regcache_mark_dirty(chip->regmap);
1300         ret = pca953x_regcache_sync(dev);
1301         if (ret) {
1302                 mutex_unlock(&chip->i2c_lock);
1303                 return ret;
1304         }
1305
1306         ret = regcache_sync(chip->regmap);
1307         mutex_unlock(&chip->i2c_lock);
1308         if (ret) {
1309                 dev_err(dev, "Failed to restore register map: %d\n", ret);
1310                 return ret;
1311         }
1312
1313         return 0;
1314 }
1315 #endif
1316
1317 /* convenience to stop overlong match-table lines */
1318 #define OF_653X(__nrgpio, __int) ((void *)(__nrgpio | PCAL653X_TYPE | __int))
1319 #define OF_953X(__nrgpio, __int) (void *)(__nrgpio | PCA953X_TYPE | __int)
1320 #define OF_957X(__nrgpio, __int) (void *)(__nrgpio | PCA957X_TYPE | __int)
1321
1322 static const struct of_device_id pca953x_dt_ids[] = {
1323         { .compatible = "nxp,pca6408", .data = OF_953X(8, PCA_INT), },
1324         { .compatible = "nxp,pca6416", .data = OF_953X(16, PCA_INT), },
1325         { .compatible = "nxp,pca9505", .data = OF_953X(40, PCA_INT), },
1326         { .compatible = "nxp,pca9506", .data = OF_953X(40, PCA_INT), },
1327         { .compatible = "nxp,pca9534", .data = OF_953X( 8, PCA_INT), },
1328         { .compatible = "nxp,pca9535", .data = OF_953X(16, PCA_INT), },
1329         { .compatible = "nxp,pca9536", .data = OF_953X( 4, 0), },
1330         { .compatible = "nxp,pca9537", .data = OF_953X( 4, PCA_INT), },
1331         { .compatible = "nxp,pca9538", .data = OF_953X( 8, PCA_INT), },
1332         { .compatible = "nxp,pca9539", .data = OF_953X(16, PCA_INT), },
1333         { .compatible = "nxp,pca9554", .data = OF_953X( 8, PCA_INT), },
1334         { .compatible = "nxp,pca9555", .data = OF_953X(16, PCA_INT), },
1335         { .compatible = "nxp,pca9556", .data = OF_953X( 8, 0), },
1336         { .compatible = "nxp,pca9557", .data = OF_953X( 8, 0), },
1337         { .compatible = "nxp,pca9574", .data = OF_957X( 8, PCA_INT), },
1338         { .compatible = "nxp,pca9575", .data = OF_957X(16, PCA_INT), },
1339         { .compatible = "nxp,pca9698", .data = OF_953X(40, 0), },
1340
1341         { .compatible = "nxp,pcal6408", .data = OF_953X(8, PCA_LATCH_INT), },
1342         { .compatible = "nxp,pcal6416", .data = OF_953X(16, PCA_LATCH_INT), },
1343         { .compatible = "nxp,pcal6524", .data = OF_953X(24, PCA_LATCH_INT), },
1344         { .compatible = "nxp,pcal6534", .data = OF_653X(34, PCA_LATCH_INT), },
1345         { .compatible = "nxp,pcal9535", .data = OF_953X(16, PCA_LATCH_INT), },
1346         { .compatible = "nxp,pcal9554b", .data = OF_953X( 8, PCA_LATCH_INT), },
1347         { .compatible = "nxp,pcal9555a", .data = OF_953X(16, PCA_LATCH_INT), },
1348
1349         { .compatible = "maxim,max7310", .data = OF_953X( 8, 0), },
1350         { .compatible = "maxim,max7312", .data = OF_953X(16, PCA_INT), },
1351         { .compatible = "maxim,max7313", .data = OF_953X(16, PCA_INT), },
1352         { .compatible = "maxim,max7315", .data = OF_953X( 8, PCA_INT), },
1353         { .compatible = "maxim,max7318", .data = OF_953X(16, PCA_INT), },
1354
1355         { .compatible = "ti,pca6107", .data = OF_953X( 8, PCA_INT), },
1356         { .compatible = "ti,pca9536", .data = OF_953X( 4, 0), },
1357         { .compatible = "ti,tca6408", .data = OF_953X( 8, PCA_INT), },
1358         { .compatible = "ti,tca6416", .data = OF_953X(16, PCA_INT), },
1359         { .compatible = "ti,tca6424", .data = OF_953X(24, PCA_INT), },
1360         { .compatible = "ti,tca9539", .data = OF_953X(16, PCA_INT), },
1361
1362         { .compatible = "onnn,cat9554", .data = OF_953X( 8, PCA_INT), },
1363         { .compatible = "onnn,pca9654", .data = OF_953X( 8, PCA_INT), },
1364         { .compatible = "onnn,pca9655", .data = OF_953X(16, PCA_INT), },
1365
1366         { .compatible = "exar,xra1202", .data = OF_953X( 8, 0), },
1367         { }
1368 };
1369
1370 MODULE_DEVICE_TABLE(of, pca953x_dt_ids);
1371
1372 static SIMPLE_DEV_PM_OPS(pca953x_pm_ops, pca953x_suspend, pca953x_resume);
1373
1374 static struct i2c_driver pca953x_driver = {
1375         .driver = {
1376                 .name   = "pca953x",
1377                 .pm     = &pca953x_pm_ops,
1378                 .of_match_table = pca953x_dt_ids,
1379                 .acpi_match_table = pca953x_acpi_ids,
1380         },
1381         .probe          = pca953x_probe,
1382         .remove         = pca953x_remove,
1383         .id_table       = pca953x_id,
1384 };
1385
1386 static int __init pca953x_init(void)
1387 {
1388         return i2c_add_driver(&pca953x_driver);
1389 }
1390 /* register after i2c postcore initcall and before
1391  * subsys initcalls that may rely on these GPIOs
1392  */
1393 subsys_initcall(pca953x_init);
1394
1395 static void __exit pca953x_exit(void)
1396 {
1397         i2c_del_driver(&pca953x_driver);
1398 }
1399 module_exit(pca953x_exit);
1400
1401 MODULE_AUTHOR("eric miao <eric.miao@marvell.com>");
1402 MODULE_DESCRIPTION("GPIO expander driver for PCA953x");
1403 MODULE_LICENSE("GPL");