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