drivers/gpio/gpio-pca953x.c

   1 /*
   2  *  PCA953x 4/8/16/24/40 bit I/O ports
   3  *
   4  *  Copyright (C) 2005 Ben Gardner <bgardner@wabtec.com>
   5  *  Copyright (C) 2007 Marvell International Ltd.
   6  *
   7  *  Derived from drivers/i2c/chips/pca9539.c
   8  *
   9  *  This program is free software; you can redistribute it and/or modify
  10  *  it under the terms of the GNU General Public License as published by
  11  *  the Free Software Foundation; version 2 of the License.
  12  */
  13
  14 #include <linux/acpi.h>
  15 #include <linux/gpio/driver.h>
  16 #include <linux/gpio/consumer.h>
  17 #include <linux/i2c.h>
  18 #include <linux/init.h>
  19 #include <linux/interrupt.h>
  20 #include <linux/module.h>
  21 #include <linux/of_platform.h>
  22 #include <linux/platform_data/pca953x.h>
  23 #include <linux/regulator/consumer.h>
  24 #include <linux/slab.h>
  25
  26 #include <asm/unaligned.h>
  27
  28 #define PCA953X_INPUT           0x00
  29 #define PCA953X_OUTPUT          0x01
  30 #define PCA953X_INVERT          0x02
  31 #define PCA953X_DIRECTION       0x03
  32
  33 #define REG_ADDR_AI             0x80
  34
  35 #define PCA957X_IN              0x00
  36 #define PCA957X_INVRT           0x01
  37 #define PCA957X_BKEN            0x02
  38 #define PCA957X_PUPD            0x03
  39 #define PCA957X_CFG             0x04
  40 #define PCA957X_OUT             0x05
  41 #define PCA957X_MSK             0x06
  42 #define PCA957X_INTS            0x07
  43
  44 #define PCAL953X_OUT_STRENGTH   0x20
  45 #define PCAL953X_IN_LATCH       0x22
  46 #define PCAL953X_PULL_EN        0x23
  47 #define PCAL953X_PULL_SEL       0x24
  48 #define PCAL953X_INT_MASK       0x25
  49 #define PCAL953X_INT_STAT       0x26
  50 #define PCAL953X_OUT_CONF       0x27
  51
  52 #define PCAL6524_INT_EDGE       0x28
  53 #define PCAL6524_INT_CLR        0x2a
  54 #define PCAL6524_IN_STATUS      0x2b
  55 #define PCAL6524_OUT_INDCONF    0x2c
  56 #define PCAL6524_DEBOUNCE       0x2d
  57
  58 #define PCA_GPIO_MASK           0x00FF
  59
  60 #define PCAL_GPIO_MASK          0x1f
  61 #define PCAL_PINCTRL_MASK       0x60
  62
  63 #define PCA_INT                 0x0100
  64 #define PCA_PCAL                0x0200
  65 #define PCA_LATCH_INT (PCA_PCAL | PCA_INT)
  66 #define PCA953X_TYPE            0x1000
  67 #define PCA957X_TYPE            0x2000
  68 #define PCA_TYPE_MASK           0xF000
  69
  70 #define PCA_CHIP_TYPE(x)        ((x) & PCA_TYPE_MASK)
  71
  72 static const struct i2c_device_id pca953x_id[] = {
  73         { "pca9505", 40 | PCA953X_TYPE | PCA_INT, },
  74         { "pca9534", 8  | PCA953X_TYPE | PCA_INT, },
  75         { "pca9535", 16 | PCA953X_TYPE | PCA_INT, },
  76         { "pca9536", 4  | PCA953X_TYPE, },
  77         { "pca9537", 4  | PCA953X_TYPE | PCA_INT, },
  78         { "pca9538", 8  | PCA953X_TYPE | PCA_INT, },
  79         { "pca9539", 16 | PCA953X_TYPE | PCA_INT, },
  80         { "pca9554", 8  | PCA953X_TYPE | PCA_INT, },
  81         { "pca9555", 16 | PCA953X_TYPE | PCA_INT, },
  82         { "pca9556", 8  | PCA953X_TYPE, },
  83         { "pca9557", 8  | PCA953X_TYPE, },
  84         { "pca9574", 8  | PCA957X_TYPE | PCA_INT, },
  85         { "pca9575", 16 | PCA957X_TYPE | PCA_INT, },
  86         { "pca9698", 40 | PCA953X_TYPE, },
  87
  88         { "pcal6524", 24 | PCA953X_TYPE | PCA_INT | PCA_PCAL, },
  89         { "pcal9555a", 16 | PCA953X_TYPE | PCA_INT | PCA_PCAL, },
  90
  91         { "max7310", 8  | PCA953X_TYPE, },
  92         { "max7312", 16 | PCA953X_TYPE | PCA_INT, },
  93         { "max7313", 16 | PCA953X_TYPE | PCA_INT, },
  94         { "max7315", 8  | PCA953X_TYPE | PCA_INT, },
  95         { "max7318", 16 | PCA953X_TYPE | PCA_INT, },
  96         { "pca6107", 8  | PCA953X_TYPE | PCA_INT, },
  97         { "tca6408", 8  | PCA953X_TYPE | PCA_INT, },
  98         { "tca6416", 16 | PCA953X_TYPE | PCA_INT, },
  99         { "tca6424", 24 | PCA953X_TYPE | PCA_INT, },
 100         { "tca9539", 16 | PCA953X_TYPE | PCA_INT, },
 101         { "tca9554", 8  | PCA953X_TYPE | PCA_INT, },
 102         { "xra1202", 8  | PCA953X_TYPE },
 103         { }
 104 };
 105 MODULE_DEVICE_TABLE(i2c, pca953x_id);
 106
 107 static const struct acpi_device_id pca953x_acpi_ids[] = {
 108         { "INT3491", 16 | PCA953X_TYPE | PCA_INT | PCA_PCAL, },
 109         { }
 110 };
 111 MODULE_DEVICE_TABLE(acpi, pca953x_acpi_ids);
 112
 113 #define MAX_BANK 5
 114 #define BANK_SZ 8
 115
 116 #define NBANK(chip) DIV_ROUND_UP(chip->gpio_chip.ngpio, BANK_SZ)
 117
 118 struct pca953x_reg_config {
 119         int direction;
 120         int output;
 121         int input;
 122 };
 123
 124 static const struct pca953x_reg_config pca953x_regs = {
 125         .direction = PCA953X_DIRECTION,
 126         .output = PCA953X_OUTPUT,
 127         .input = PCA953X_INPUT,
 128 };
 129
 130 static const struct pca953x_reg_config pca957x_regs = {
 131         .direction = PCA957X_CFG,
 132         .output = PCA957X_OUT,
 133         .input = PCA957X_IN,
 134 };
 135
 136 struct pca953x_chip {
 137         unsigned gpio_start;
 138         u8 reg_output[MAX_BANK];
 139         u8 reg_direction[MAX_BANK];
 140         struct mutex i2c_lock;
 141
 142 #ifdef CONFIG_GPIO_PCA953X_IRQ
 143         struct mutex irq_lock;
 144         u8 irq_mask[MAX_BANK];
 145         u8 irq_stat[MAX_BANK];
 146         u8 irq_trig_raise[MAX_BANK];
 147         u8 irq_trig_fall[MAX_BANK];
 148 #endif
 149
 150         struct i2c_client *client;
 151         struct gpio_chip gpio_chip;
 152         const char *const *names;
 153         unsigned long driver_data;
 154         struct regulator *regulator;
 155
 156         const struct pca953x_reg_config *regs;
 157
 158         int (*write_regs)(struct pca953x_chip *, int, u8 *);
 159         int (*read_regs)(struct pca953x_chip *, int, u8 *);
 160 };
 161
 162 static int pca953x_bank_shift(struct pca953x_chip *chip)
 163 {
 164         return fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
 165 }
 166
 167 static int pca953x_read_single(struct pca953x_chip *chip, int reg, u32 *val,
 168                                 int off)
 169 {
 170         int ret;
 171         int bank_shift = pca953x_bank_shift(chip);
 172         int offset = off / BANK_SZ;
 173
 174         ret = i2c_smbus_read_byte_data(chip->client,
 175                                 (reg << bank_shift) + offset);
 176         *val = ret;
 177
 178         if (ret < 0) {
 179                 dev_err(&chip->client->dev, "failed reading register\n");
 180                 return ret;
 181         }
 182
 183         return 0;
 184 }
 185
 186 static int pca953x_write_single(struct pca953x_chip *chip, int reg, u32 val,
 187                                 int off)
 188 {
 189         int ret;
 190         int bank_shift = pca953x_bank_shift(chip);
 191         int offset = off / BANK_SZ;
 192
 193         ret = i2c_smbus_write_byte_data(chip->client,
 194                                         (reg << bank_shift) + offset, val);
 195
 196         if (ret < 0) {
 197                 dev_err(&chip->client->dev, "failed writing register\n");
 198                 return ret;
 199         }
 200
 201         return 0;
 202 }
 203
 204 static int pca953x_write_regs_8(struct pca953x_chip *chip, int reg, u8 *val)
 205 {
 206         return i2c_smbus_write_byte_data(chip->client, reg, *val);
 207 }
 208
 209 static int pca953x_write_regs_16(struct pca953x_chip *chip, int reg, u8 *val)
 210 {
 211         u32 regaddr = (reg << 1);
 212
 213         /* PCA9575 needs address-increment on multi-byte writes */
 214         if (PCA_CHIP_TYPE(chip->driver_data) == PCA957X_TYPE)
 215                 regaddr |= REG_ADDR_AI;
 216
 217         return i2c_smbus_write_i2c_block_data(chip->client, regaddr,
 218                                               NBANK(chip), val);
 219 }
 220
 221 static int pca953x_write_regs_24(struct pca953x_chip *chip, int reg, u8 *val)
 222 {
 223         int bank_shift = pca953x_bank_shift(chip);
 224         int addr = (reg & PCAL_GPIO_MASK) << bank_shift;
 225         int pinctrl = (reg & PCAL_PINCTRL_MASK) << 1;
 226
 227         return i2c_smbus_write_i2c_block_data(chip->client,
 228                                               pinctrl | addr | REG_ADDR_AI,
 229                                               NBANK(chip), val);
 230 }
 231
 232 static int pca953x_write_regs(struct pca953x_chip *chip, int reg, u8 *val)
 233 {
 234         int ret = 0;
 235
 236         ret = chip->write_regs(chip, reg, val);
 237         if (ret < 0) {
 238                 dev_err(&chip->client->dev, "failed writing register\n");
 239                 return ret;
 240         }
 241
 242         return 0;
 243 }
 244
 245 static int pca953x_read_regs_8(struct pca953x_chip *chip, int reg, u8 *val)
 246 {
 247         int ret;
 248
 249         ret = i2c_smbus_read_byte_data(chip->client, reg);
 250         *val = ret;
 251
 252         return ret;
 253 }
 254
 255 static int pca953x_read_regs_16(struct pca953x_chip *chip, int reg, u8 *val)
 256 {
 257         int ret;
 258
 259         ret = i2c_smbus_read_word_data(chip->client, reg << 1);
 260         put_unaligned(ret, (u16 *)val);
 261
 262         return ret;
 263 }
 264
 265 static int pca953x_read_regs_24(struct pca953x_chip *chip, int reg, u8 *val)
 266 {
 267         int bank_shift = pca953x_bank_shift(chip);
 268         int addr = (reg & PCAL_GPIO_MASK) << bank_shift;
 269         int pinctrl = (reg & PCAL_PINCTRL_MASK) << 1;
 270
 271         return i2c_smbus_read_i2c_block_data(chip->client,
 272                                              pinctrl | addr | REG_ADDR_AI,
 273                                              NBANK(chip), val);
 274 }
 275
 276 static int pca953x_read_regs(struct pca953x_chip *chip, int reg, u8 *val)
 277 {
 278         int ret;
 279
 280         ret = chip->read_regs(chip, reg, val);
 281         if (ret < 0) {
 282                 dev_err(&chip->client->dev, "failed reading register\n");
 283                 return ret;
 284         }
 285
 286         return 0;
 287 }
 288
 289 static int pca953x_gpio_direction_input(struct gpio_chip *gc, unsigned off)
 290 {
 291         struct pca953x_chip *chip = gpiochip_get_data(gc);
 292         u8 reg_val;
 293         int ret;
 294
 295         mutex_lock(&chip->i2c_lock);
 296         reg_val = chip->reg_direction[off / BANK_SZ] | (1u << (off % BANK_SZ));
 297
 298         ret = pca953x_write_single(chip, chip->regs->direction, reg_val, off);
 299         if (ret)
 300                 goto exit;
 301
 302         chip->reg_direction[off / BANK_SZ] = reg_val;
 303 exit:
 304         mutex_unlock(&chip->i2c_lock);
 305         return ret;
 306 }
 307
 308 static int pca953x_gpio_direction_output(struct gpio_chip *gc,
 309                 unsigned off, int val)
 310 {
 311         struct pca953x_chip *chip = gpiochip_get_data(gc);
 312         u8 reg_val;
 313         int ret;
 314
 315         mutex_lock(&chip->i2c_lock);
 316         /* set output level */
 317         if (val)
 318                 reg_val = chip->reg_output[off / BANK_SZ]
 319                         | (1u << (off % BANK_SZ));
 320         else
 321                 reg_val = chip->reg_output[off / BANK_SZ]
 322                         & ~(1u << (off % BANK_SZ));
 323
 324         ret = pca953x_write_single(chip, chip->regs->output, reg_val, off);
 325         if (ret)
 326                 goto exit;
 327
 328         chip->reg_output[off / BANK_SZ] = reg_val;
 329
 330         /* then direction */
 331         reg_val = chip->reg_direction[off / BANK_SZ] & ~(1u << (off % BANK_SZ));
 332         ret = pca953x_write_single(chip, chip->regs->direction, reg_val, off);
 333         if (ret)
 334                 goto exit;
 335
 336         chip->reg_direction[off / BANK_SZ] = reg_val;
 337 exit:
 338         mutex_unlock(&chip->i2c_lock);
 339         return ret;
 340 }
 341
 342 static int pca953x_gpio_get_value(struct gpio_chip *gc, unsigned off)
 343 {
 344         struct pca953x_chip *chip = gpiochip_get_data(gc);
 345         u32 reg_val;
 346         int ret;
 347
 348         mutex_lock(&chip->i2c_lock);
 349         ret = pca953x_read_single(chip, chip->regs->input, &reg_val, off);
 350         mutex_unlock(&chip->i2c_lock);
 351         if (ret < 0) {
 352                 /* NOTE:  diagnostic already emitted; that's all we should
 353                  * do unless gpio_*_value_cansleep() calls become different
 354                  * from their nonsleeping siblings (and report faults).
 355                  */
 356                 return 0;
 357         }
 358
 359         return (reg_val & (1u << (off % BANK_SZ))) ? 1 : 0;
 360 }
 361
 362 static void pca953x_gpio_set_value(struct gpio_chip *gc, unsigned off, int val)
 363 {
 364         struct pca953x_chip *chip = gpiochip_get_data(gc);
 365         u8 reg_val;
 366         int ret;
 367
 368         mutex_lock(&chip->i2c_lock);
 369         if (val)
 370                 reg_val = chip->reg_output[off / BANK_SZ]
 371                         | (1u << (off % BANK_SZ));
 372         else
 373                 reg_val = chip->reg_output[off / BANK_SZ]
 374                         & ~(1u << (off % BANK_SZ));
 375
 376         ret = pca953x_write_single(chip, chip->regs->output, reg_val, off);
 377         if (ret)
 378                 goto exit;
 379
 380         chip->reg_output[off / BANK_SZ] = reg_val;
 381 exit:
 382         mutex_unlock(&chip->i2c_lock);
 383 }
 384
 385 static int pca953x_gpio_get_direction(struct gpio_chip *gc, unsigned off)
 386 {
 387         struct pca953x_chip *chip = gpiochip_get_data(gc);
 388         u32 reg_val;
 389         int ret;
 390
 391         mutex_lock(&chip->i2c_lock);
 392         ret = pca953x_read_single(chip, chip->regs->direction, &reg_val, off);
 393         mutex_unlock(&chip->i2c_lock);
 394         if (ret < 0)
 395                 return ret;
 396
 397         return !!(reg_val & (1u << (off % BANK_SZ)));
 398 }
 399
 400 static void pca953x_gpio_set_multiple(struct gpio_chip *gc,
 401                                       unsigned long *mask, unsigned long *bits)
 402 {
 403         struct pca953x_chip *chip = gpiochip_get_data(gc);
 404         int bank_shift = pca953x_bank_shift(chip);
 405         u32 regaddr = chip->regs->output << bank_shift;
 406         unsigned int bank_mask, bank_val;
 407         int bank;
 408         u8 reg_val[MAX_BANK];
 409         int ret;
 410
 411         mutex_lock(&chip->i2c_lock);
 412         memcpy(reg_val, chip->reg_output, NBANK(chip));
 413         for (bank = 0; bank < NBANK(chip); bank++) {
 414                 bank_mask = mask[bank / sizeof(*mask)] >>
 415                            ((bank % sizeof(*mask)) * 8);
 416                 if (bank_mask) {
 417                         bank_val = bits[bank / sizeof(*bits)] >>
 418                                   ((bank % sizeof(*bits)) * 8);
 419                         bank_val &= bank_mask;
 420                         reg_val[bank] = (reg_val[bank] & ~bank_mask) | bank_val;
 421                 }
 422         }
 423
 424         /* PCA9575 needs address-increment on multi-byte writes */
 425         if ((PCA_CHIP_TYPE(chip->driver_data) == PCA957X_TYPE) &&
 426             (NBANK(chip) > 1)) {
 427                 regaddr |= REG_ADDR_AI;
 428         }
 429
 430         ret = i2c_smbus_write_i2c_block_data(chip->client, regaddr,
 431                                              NBANK(chip), reg_val);
 432         if (ret)
 433                 goto exit;
 434
 435         memcpy(chip->reg_output, reg_val, NBANK(chip));
 436 exit:
 437         mutex_unlock(&chip->i2c_lock);
 438 }
 439
 440 static void pca953x_setup_gpio(struct pca953x_chip *chip, int gpios)
 441 {
 442         struct gpio_chip *gc;
 443
 444         gc = &chip->gpio_chip;
 445
 446         gc->direction_input  = pca953x_gpio_direction_input;
 447         gc->direction_output = pca953x_gpio_direction_output;
 448         gc->get = pca953x_gpio_get_value;
 449         gc->set = pca953x_gpio_set_value;
 450         gc->get_direction = pca953x_gpio_get_direction;
 451         gc->set_multiple = pca953x_gpio_set_multiple;
 452         gc->can_sleep = true;
 453
 454         gc->base = chip->gpio_start;
 455         gc->ngpio = gpios;
 456         gc->label = chip->client->name;
 457         gc->parent = &chip->client->dev;
 458         gc->owner = THIS_MODULE;
 459         gc->names = chip->names;
 460 }
 461
 462 #ifdef CONFIG_GPIO_PCA953X_IRQ
 463 static void pca953x_irq_mask(struct irq_data *d)
 464 {
 465         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 466         struct pca953x_chip *chip = gpiochip_get_data(gc);
 467
 468         chip->irq_mask[d->hwirq / BANK_SZ] &= ~(1 << (d->hwirq % BANK_SZ));
 469 }
 470
 471 static void pca953x_irq_unmask(struct irq_data *d)
 472 {
 473         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 474         struct pca953x_chip *chip = gpiochip_get_data(gc);
 475
 476         chip->irq_mask[d->hwirq / BANK_SZ] |= 1 << (d->hwirq % BANK_SZ);
 477 }
 478
 479 static void pca953x_irq_bus_lock(struct irq_data *d)
 480 {
 481         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 482         struct pca953x_chip *chip = gpiochip_get_data(gc);
 483
 484         mutex_lock(&chip->irq_lock);
 485 }
 486
 487 static void pca953x_irq_bus_sync_unlock(struct irq_data *d)
 488 {
 489         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 490         struct pca953x_chip *chip = gpiochip_get_data(gc);
 491         u8 new_irqs;
 492         int level, i;
 493         u8 invert_irq_mask[MAX_BANK];
 494
 495         if (chip->driver_data & PCA_PCAL) {
 496                 /* Enable latch on interrupt-enabled inputs */
 497                 pca953x_write_regs(chip, PCAL953X_IN_LATCH, chip->irq_mask);
 498
 499                 for (i = 0; i < NBANK(chip); i++)
 500                         invert_irq_mask[i] = ~chip->irq_mask[i];
 501
 502                 /* Unmask enabled interrupts */
 503                 pca953x_write_regs(chip, PCAL953X_INT_MASK, invert_irq_mask);
 504         }
 505
 506         /* Look for any newly setup interrupt */
 507         for (i = 0; i < NBANK(chip); i++) {
 508                 new_irqs = chip->irq_trig_fall[i] | chip->irq_trig_raise[i];
 509                 new_irqs &= ~chip->reg_direction[i];
 510
 511                 while (new_irqs) {
 512                         level = __ffs(new_irqs);
 513                         pca953x_gpio_direction_input(&chip->gpio_chip,
 514                                                         level + (BANK_SZ * i));
 515                         new_irqs &= ~(1 << level);
 516                 }
 517         }
 518
 519         mutex_unlock(&chip->irq_lock);
 520 }
 521
 522 static int pca953x_irq_set_type(struct irq_data *d, unsigned int type)
 523 {
 524         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 525         struct pca953x_chip *chip = gpiochip_get_data(gc);
 526         int bank_nb = d->hwirq / BANK_SZ;
 527         u8 mask = 1 << (d->hwirq % BANK_SZ);
 528
 529         if (!(type & IRQ_TYPE_EDGE_BOTH)) {
 530                 dev_err(&chip->client->dev, "irq %d: unsupported type %d\n",
 531                         d->irq, type);
 532                 return -EINVAL;
 533         }
 534
 535         if (type & IRQ_TYPE_EDGE_FALLING)
 536                 chip->irq_trig_fall[bank_nb] |= mask;
 537         else
 538                 chip->irq_trig_fall[bank_nb] &= ~mask;
 539
 540         if (type & IRQ_TYPE_EDGE_RISING)
 541                 chip->irq_trig_raise[bank_nb] |= mask;
 542         else
 543                 chip->irq_trig_raise[bank_nb] &= ~mask;
 544
 545         return 0;
 546 }
 547
 548 static void pca953x_irq_shutdown(struct irq_data *d)
 549 {
 550         struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
 551         u8 mask = 1 << (d->hwirq % BANK_SZ);
 552
 553         chip->irq_trig_raise[d->hwirq / BANK_SZ] &= ~mask;
 554         chip->irq_trig_fall[d->hwirq / BANK_SZ] &= ~mask;
 555 }
 556
 557 static struct irq_chip pca953x_irq_chip = {
 558         .name                   = "pca953x",
 559         .irq_mask               = pca953x_irq_mask,
 560         .irq_unmask             = pca953x_irq_unmask,
 561         .irq_bus_lock           = pca953x_irq_bus_lock,
 562         .irq_bus_sync_unlock    = pca953x_irq_bus_sync_unlock,
 563         .irq_set_type           = pca953x_irq_set_type,
 564         .irq_shutdown           = pca953x_irq_shutdown,
 565 };
 566
 567 static bool pca953x_irq_pending(struct pca953x_chip *chip, u8 *pending)
 568 {
 569         u8 cur_stat[MAX_BANK];
 570         u8 old_stat[MAX_BANK];
 571         bool pending_seen = false;
 572         bool trigger_seen = false;
 573         u8 trigger[MAX_BANK];
 574         int ret, i;
 575
 576         if (chip->driver_data & PCA_PCAL) {
 577                 /* Read the current interrupt status from the device */
 578                 ret = pca953x_read_regs(chip, PCAL953X_INT_STAT, trigger);
 579                 if (ret)
 580                         return false;
 581
 582                 /* Check latched inputs and clear interrupt status */
 583                 ret = pca953x_read_regs(chip, PCA953X_INPUT, cur_stat);
 584                 if (ret)
 585                         return false;
 586
 587                 for (i = 0; i < NBANK(chip); i++) {
 588                         /* Apply filter for rising/falling edge selection */
 589                         pending[i] = (~cur_stat[i] & chip->irq_trig_fall[i]) |
 590                                 (cur_stat[i] & chip->irq_trig_raise[i]);
 591                         pending[i] &= trigger[i];
 592                         if (pending[i])
 593                                 pending_seen = true;
 594                 }
 595
 596                 return pending_seen;
 597         }
 598
 599         ret = pca953x_read_regs(chip, chip->regs->input, cur_stat);
 600         if (ret)
 601                 return false;
 602
 603         /* Remove output pins from the equation */
 604         for (i = 0; i < NBANK(chip); i++)
 605                 cur_stat[i] &= chip->reg_direction[i];
 606
 607         memcpy(old_stat, chip->irq_stat, NBANK(chip));
 608
 609         for (i = 0; i < NBANK(chip); i++) {
 610                 trigger[i] = (cur_stat[i] ^ old_stat[i]) & chip->irq_mask[i];
 611                 if (trigger[i])
 612                         trigger_seen = true;
 613         }
 614
 615         if (!trigger_seen)
 616                 return false;
 617
 618         memcpy(chip->irq_stat, cur_stat, NBANK(chip));
 619
 620         for (i = 0; i < NBANK(chip); i++) {
 621                 pending[i] = (old_stat[i] & chip->irq_trig_fall[i]) |
 622                         (cur_stat[i] & chip->irq_trig_raise[i]);
 623                 pending[i] &= trigger[i];
 624                 if (pending[i])
 625                         pending_seen = true;
 626         }
 627
 628         return pending_seen;
 629 }
 630
 631 static irqreturn_t pca953x_irq_handler(int irq, void *devid)
 632 {
 633         struct pca953x_chip *chip = devid;
 634         u8 pending[MAX_BANK];
 635         u8 level;
 636         unsigned nhandled = 0;
 637         int i;
 638
 639         if (!pca953x_irq_pending(chip, pending))
 640                 return IRQ_NONE;
 641
 642         for (i = 0; i < NBANK(chip); i++) {
 643                 while (pending[i]) {
 644                         level = __ffs(pending[i]);
 645                         handle_nested_irq(irq_find_mapping(chip->gpio_chip.irq.domain,
 646                                                         level + (BANK_SZ * i)));
 647                         pending[i] &= ~(1 << level);
 648                         nhandled++;
 649                 }
 650         }
 651
 652         return (nhandled > 0) ? IRQ_HANDLED : IRQ_NONE;
 653 }
 654
 655 static int pca953x_irq_setup(struct pca953x_chip *chip,
 656                              int irq_base)
 657 {
 658         struct i2c_client *client = chip->client;
 659         int ret, i;
 660
 661         if (client->irq && irq_base != -1
 662                         && (chip->driver_data & PCA_INT)) {
 663                 ret = pca953x_read_regs(chip,
 664                                         chip->regs->input, chip->irq_stat);
 665                 if (ret)
 666                         return ret;
 667
 668                 /*
 669                  * There is no way to know which GPIO line generated the
 670                  * interrupt.  We have to rely on the previous read for
 671                  * this purpose.
 672                  */
 673                 for (i = 0; i < NBANK(chip); i++)
 674                         chip->irq_stat[i] &= chip->reg_direction[i];
 675                 mutex_init(&chip->irq_lock);
 676
 677                 ret = devm_request_threaded_irq(&client->dev,
 678                                         client->irq,
 679                                            NULL,
 680                                            pca953x_irq_handler,
 681                                            IRQF_TRIGGER_LOW | IRQF_ONESHOT |
 682                                                    IRQF_SHARED,
 683                                            dev_name(&client->dev), chip);
 684                 if (ret) {
 685                         dev_err(&client->dev, "failed to request irq %d\n",
 686                                 client->irq);
 687                         return ret;
 688                 }
 689
 690                 ret =  gpiochip_irqchip_add_nested(&chip->gpio_chip,
 691                                                    &pca953x_irq_chip,
 692                                                    irq_base,
 693                                                    handle_simple_irq,
 694                                                    IRQ_TYPE_NONE);
 695                 if (ret) {
 696                         dev_err(&client->dev,
 697                                 "could not connect irqchip to gpiochip\n");
 698                         return ret;
 699                 }
 700
 701                 gpiochip_set_nested_irqchip(&chip->gpio_chip,
 702                                             &pca953x_irq_chip,
 703                                             client->irq);
 704         }
 705
 706         return 0;
 707 }
 708
 709 #else /* CONFIG_GPIO_PCA953X_IRQ */
 710 static int pca953x_irq_setup(struct pca953x_chip *chip,
 711                              int irq_base)
 712 {
 713         struct i2c_client *client = chip->client;
 714
 715         if (client->irq && irq_base != -1 && (chip->driver_data & PCA_INT))
 716                 dev_warn(&client->dev, "interrupt support not compiled in\n");
 717
 718         return 0;
 719 }
 720 #endif
 721
 722 static int device_pca953x_init(struct pca953x_chip *chip, u32 invert)
 723 {
 724         int ret;
 725         u8 val[MAX_BANK];
 726
 727         chip->regs = &pca953x_regs;
 728
 729         ret = pca953x_read_regs(chip, chip->regs->output, chip->reg_output);
 730         if (ret)
 731                 goto out;
 732
 733         ret = pca953x_read_regs(chip, chip->regs->direction,
 734                                 chip->reg_direction);
 735         if (ret)
 736                 goto out;
 737
 738         /* set platform specific polarity inversion */
 739         if (invert)
 740                 memset(val, 0xFF, NBANK(chip));
 741         else
 742                 memset(val, 0, NBANK(chip));
 743
 744         ret = pca953x_write_regs(chip, PCA953X_INVERT, val);
 745 out:
 746         return ret;
 747 }
 748
 749 static int device_pca957x_init(struct pca953x_chip *chip, u32 invert)
 750 {
 751         int ret;
 752         u8 val[MAX_BANK];
 753
 754         chip->regs = &pca957x_regs;
 755
 756         ret = pca953x_read_regs(chip, chip->regs->output, chip->reg_output);
 757         if (ret)
 758                 goto out;
 759         ret = pca953x_read_regs(chip, chip->regs->direction,
 760                                 chip->reg_direction);
 761         if (ret)
 762                 goto out;
 763
 764         /* set platform specific polarity inversion */
 765         if (invert)
 766                 memset(val, 0xFF, NBANK(chip));
 767         else
 768                 memset(val, 0, NBANK(chip));
 769         ret = pca953x_write_regs(chip, PCA957X_INVRT, val);
 770         if (ret)
 771                 goto out;
 772
 773         /* To enable register 6, 7 to control pull up and pull down */
 774         memset(val, 0x02, NBANK(chip));
 775         ret = pca953x_write_regs(chip, PCA957X_BKEN, val);
 776         if (ret)
 777                 goto out;
 778
 779         return 0;
 780 out:
 781         return ret;
 782 }
 783
 784 static const struct of_device_id pca953x_dt_ids[];
 785
 786 static int pca953x_probe(struct i2c_client *client,
 787                                    const struct i2c_device_id *i2c_id)
 788 {
 789         struct pca953x_platform_data *pdata;
 790         struct pca953x_chip *chip;
 791         int irq_base = 0;
 792         int ret;
 793         u32 invert = 0;
 794         struct regulator *reg;
 795
 796         chip = devm_kzalloc(&client->dev,
 797                         sizeof(struct pca953x_chip), GFP_KERNEL);
 798         if (chip == NULL)
 799                 return -ENOMEM;
 800
 801         pdata = dev_get_platdata(&client->dev);
 802         if (pdata) {
 803                 irq_base = pdata->irq_base;
 804                 chip->gpio_start = pdata->gpio_base;
 805                 invert = pdata->invert;
 806                 chip->names = pdata->names;
 807         } else {
 808                 struct gpio_desc *reset_gpio;
 809
 810                 chip->gpio_start = -1;
 811                 irq_base = 0;
 812
 813                 /*
 814                  * See if we need to de-assert a reset pin.
 815                  *
 816                  * There is no known ACPI-enabled platforms that are
 817                  * using "reset" GPIO. Otherwise any of those platform
 818                  * must use _DSD method with corresponding property.
 819                  */
 820                 reset_gpio = devm_gpiod_get_optional(&client->dev, "reset",
 821                                                      GPIOD_OUT_LOW);
 822                 if (IS_ERR(reset_gpio))
 823                         return PTR_ERR(reset_gpio);
 824         }
 825
 826         chip->client = client;
 827
 828         reg = devm_regulator_get(&client->dev, "vcc");
 829         if (IS_ERR(reg)) {
 830                 ret = PTR_ERR(reg);
 831                 if (ret != -EPROBE_DEFER)
 832                         dev_err(&client->dev, "reg get err: %d\n", ret);
 833                 return ret;
 834         }
 835         ret = regulator_enable(reg);
 836         if (ret) {
 837                 dev_err(&client->dev, "reg en err: %d\n", ret);
 838                 return ret;
 839         }
 840         chip->regulator = reg;
 841
 842         if (i2c_id) {
 843                 chip->driver_data = i2c_id->driver_data;
 844         } else {
 845                 const struct acpi_device_id *acpi_id;
 846                 struct device *dev = &client->dev;
 847
 848                 chip->driver_data = (uintptr_t)of_device_get_match_data(dev);
 849                 if (!chip->driver_data) {
 850                         acpi_id = acpi_match_device(pca953x_acpi_ids, dev);
 851                         if (!acpi_id) {
 852                                 ret = -ENODEV;
 853                                 goto err_exit;
 854                         }
 855
 856                         chip->driver_data = acpi_id->driver_data;
 857                 }
 858         }
 859
 860         mutex_init(&chip->i2c_lock);
 861         /*
 862          * In case we have an i2c-mux controlled by a GPIO provided by an
 863          * expander using the same driver higher on the device tree, read the
 864          * i2c adapter nesting depth and use the retrieved value as lockdep
 865          * subclass for chip->i2c_lock.
 866          *
 867          * REVISIT: This solution is not complete. It protects us from lockdep
 868          * false positives when the expander controlling the i2c-mux is on
 869          * a different level on the device tree, but not when it's on the same
 870          * level on a different branch (in which case the subclass number
 871          * would be the same).
 872          *
 873          * TODO: Once a correct solution is developed, a similar fix should be
 874          * applied to all other i2c-controlled GPIO expanders (and potentially
 875          * regmap-i2c).
 876          */
 877         lockdep_set_subclass(&chip->i2c_lock,
 878                              i2c_adapter_depth(client->adapter));
 879
 880         /* initialize cached registers from their original values.
 881          * we can't share this chip with another i2c master.
 882          */
 883         pca953x_setup_gpio(chip, chip->driver_data & PCA_GPIO_MASK);
 884
 885         if (chip->gpio_chip.ngpio <= 8) {
 886                 chip->write_regs = pca953x_write_regs_8;
 887                 chip->read_regs = pca953x_read_regs_8;
 888         } else if (chip->gpio_chip.ngpio >= 24) {
 889                 chip->write_regs = pca953x_write_regs_24;
 890                 chip->read_regs = pca953x_read_regs_24;
 891         } else {
 892                 chip->write_regs = pca953x_write_regs_16;
 893                 chip->read_regs = pca953x_read_regs_16;
 894         }
 895
 896         if (PCA_CHIP_TYPE(chip->driver_data) == PCA953X_TYPE)
 897                 ret = device_pca953x_init(chip, invert);
 898         else
 899                 ret = device_pca957x_init(chip, invert);
 900         if (ret)
 901                 goto err_exit;
 902
 903         ret = devm_gpiochip_add_data(&client->dev, &chip->gpio_chip, chip);
 904         if (ret)
 905                 goto err_exit;
 906
 907         ret = pca953x_irq_setup(chip, irq_base);
 908         if (ret)
 909                 goto err_exit;
 910
 911         if (pdata && pdata->setup) {
 912                 ret = pdata->setup(client, chip->gpio_chip.base,
 913                                 chip->gpio_chip.ngpio, pdata->context);
 914                 if (ret < 0)
 915                         dev_warn(&client->dev, "setup failed, %d\n", ret);
 916         }
 917
 918         i2c_set_clientdata(client, chip);
 919         return 0;
 920
 921 err_exit:
 922         regulator_disable(chip->regulator);
 923         return ret;
 924 }
 925
 926 static int pca953x_remove(struct i2c_client *client)
 927 {
 928         struct pca953x_platform_data *pdata = dev_get_platdata(&client->dev);
 929         struct pca953x_chip *chip = i2c_get_clientdata(client);
 930         int ret;
 931
 932         if (pdata && pdata->teardown) {
 933                 ret = pdata->teardown(client, chip->gpio_chip.base,
 934                                 chip->gpio_chip.ngpio, pdata->context);
 935                 if (ret < 0)
 936                         dev_err(&client->dev, "%s failed, %d\n",
 937                                         "teardown", ret);
 938         } else {
 939                 ret = 0;
 940         }
 941
 942         regulator_disable(chip->regulator);
 943
 944         return ret;
 945 }
 946
 947 /* convenience to stop overlong match-table lines */
 948 #define OF_953X(__nrgpio, __int) (void *)(__nrgpio | PCA953X_TYPE | __int)
 949 #define OF_957X(__nrgpio, __int) (void *)(__nrgpio | PCA957X_TYPE | __int)
 950
 951 static const struct of_device_id pca953x_dt_ids[] = {
 952         { .compatible = "nxp,pca9505", .data = OF_953X(40, PCA_INT), },
 953         { .compatible = "nxp,pca9534", .data = OF_953X( 8, PCA_INT), },
 954         { .compatible = "nxp,pca9535", .data = OF_953X(16, PCA_INT), },
 955         { .compatible = "nxp,pca9536", .data = OF_953X( 4, 0), },
 956         { .compatible = "nxp,pca9537", .data = OF_953X( 4, PCA_INT), },
 957         { .compatible = "nxp,pca9538", .data = OF_953X( 8, PCA_INT), },
 958         { .compatible = "nxp,pca9539", .data = OF_953X(16, PCA_INT), },
 959         { .compatible = "nxp,pca9554", .data = OF_953X( 8, PCA_INT), },
 960         { .compatible = "nxp,pca9555", .data = OF_953X(16, PCA_INT), },
 961         { .compatible = "nxp,pca9556", .data = OF_953X( 8, 0), },
 962         { .compatible = "nxp,pca9557", .data = OF_953X( 8, 0), },
 963         { .compatible = "nxp,pca9574", .data = OF_957X( 8, PCA_INT), },
 964         { .compatible = "nxp,pca9575", .data = OF_957X(16, PCA_INT), },
 965         { .compatible = "nxp,pca9698", .data = OF_953X(40, 0), },
 966
 967         { .compatible = "nxp,pcal6524", .data = OF_953X(24, PCA_LATCH_INT), },
 968         { .compatible = "nxp,pcal9555a", .data = OF_953X(16, PCA_LATCH_INT), },
 969
 970         { .compatible = "maxim,max7310", .data = OF_953X( 8, 0), },
 971         { .compatible = "maxim,max7312", .data = OF_953X(16, PCA_INT), },
 972         { .compatible = "maxim,max7313", .data = OF_953X(16, PCA_INT), },
 973         { .compatible = "maxim,max7315", .data = OF_953X( 8, PCA_INT), },
 974         { .compatible = "maxim,max7318", .data = OF_953X(16, PCA_INT), },
 975
 976         { .compatible = "ti,pca6107", .data = OF_953X( 8, PCA_INT), },
 977         { .compatible = "ti,pca9536", .data = OF_953X( 4, 0), },
 978         { .compatible = "ti,tca6408", .data = OF_953X( 8, PCA_INT), },
 979         { .compatible = "ti,tca6416", .data = OF_953X(16, PCA_INT), },
 980         { .compatible = "ti,tca6424", .data = OF_953X(24, PCA_INT), },
 981
 982         { .compatible = "onnn,pca9654", .data = OF_953X( 8, PCA_INT), },
 983
 984         { .compatible = "exar,xra1202", .data = OF_953X( 8, 0), },
 985         { }
 986 };
 987
 988 MODULE_DEVICE_TABLE(of, pca953x_dt_ids);
 989
 990 static struct i2c_driver pca953x_driver = {
 991         .driver = {
 992                 .name   = "pca953x",
 993                 .of_match_table = pca953x_dt_ids,
 994                 .acpi_match_table = ACPI_PTR(pca953x_acpi_ids),
 995         },
 996         .probe          = pca953x_probe,
 997         .remove         = pca953x_remove,
 998         .id_table       = pca953x_id,
 999 };
1000
1001 static int __init pca953x_init(void)
1002 {
1003         return i2c_add_driver(&pca953x_driver);
1004 }
1005 /* register after i2c postcore initcall and before
1006  * subsys initcalls that may rely on these GPIOs
1007  */
1008 subsys_initcall(pca953x_init);
1009
1010 static void __exit pca953x_exit(void)
1011 {
1012         i2c_del_driver(&pca953x_driver);
1013 }
1014 module_exit(pca953x_exit);
1015
1016 MODULE_AUTHOR("eric miao <eric.miao@marvell.com>");
1017 MODULE_DESCRIPTION("GPIO expander driver for PCA953x");
1018 MODULE_LICENSE("GPL");