drivers/gpio/gpio-mcp23s08.c

   1 /*
   2  * MCP23S08 SPI/I2C GPIO gpio expander driver
   3  *
   4  * The inputs and outputs of the mcp23s08, mcp23s17, mcp23008 and mcp23017 are
   5  * supported.
   6  * For the I2C versions of the chips (mcp23008 and mcp23017) generation of
   7  * interrupts is also supported.
   8  * The hardware of the SPI versions of the chips (mcp23s08 and mcp23s17) is
   9  * also capable of generating interrupts, but the linux driver does not
  10  * support that yet.
  11  */
  12
  13 #include <linux/kernel.h>
  14 #include <linux/device.h>
  15 #include <linux/mutex.h>
  16 #include <linux/module.h>
  17 #include <linux/gpio.h>
  18 #include <linux/i2c.h>
  19 #include <linux/spi/spi.h>
  20 #include <linux/spi/mcp23s08.h>
  21 #include <linux/slab.h>
  22 #include <asm/byteorder.h>
  23 #include <linux/interrupt.h>
  24 #include <linux/of_irq.h>
  25 #include <linux/of_device.h>
  26
  27 /**
  28  * MCP types supported by driver
  29  */
  30 #define MCP_TYPE_S08    0
  31 #define MCP_TYPE_S17    1
  32 #define MCP_TYPE_008    2
  33 #define MCP_TYPE_017    3
  34
  35 /* Registers are all 8 bits wide.
  36  *
  37  * The mcp23s17 has twice as many bits, and can be configured to work
  38  * with either 16 bit registers or with two adjacent 8 bit banks.
  39  */
  40 #define MCP_IODIR       0x00            /* init/reset:  all ones */
  41 #define MCP_IPOL        0x01
  42 #define MCP_GPINTEN     0x02
  43 #define MCP_DEFVAL      0x03
  44 #define MCP_INTCON      0x04
  45 #define MCP_IOCON       0x05
  46 #       define IOCON_MIRROR     (1 << 6)
  47 #       define IOCON_SEQOP      (1 << 5)
  48 #       define IOCON_HAEN       (1 << 3)
  49 #       define IOCON_ODR        (1 << 2)
  50 #       define IOCON_INTPOL     (1 << 1)
  51 #define MCP_GPPU        0x06
  52 #define MCP_INTF        0x07
  53 #define MCP_INTCAP      0x08
  54 #define MCP_GPIO        0x09
  55 #define MCP_OLAT        0x0a
  56
  57 struct mcp23s08;
  58
  59 struct mcp23s08_ops {
  60         int     (*read)(struct mcp23s08 *mcp, unsigned reg);
  61         int     (*write)(struct mcp23s08 *mcp, unsigned reg, unsigned val);
  62         int     (*read_regs)(struct mcp23s08 *mcp, unsigned reg,
  63                              u16 *vals, unsigned n);
  64 };
  65
  66 struct mcp23s08 {
  67         u8                      addr;
  68
  69         u16                     cache[11];
  70         u16                     irq_rise;
  71         u16                     irq_fall;
  72         int                     irq;
  73         bool                    irq_controller;
  74         /* lock protects the cached values */
  75         struct mutex            lock;
  76         struct mutex            irq_lock;
  77         struct irq_domain       *irq_domain;
  78
  79         struct gpio_chip        chip;
  80
  81         const struct mcp23s08_ops       *ops;
  82         void                    *data; /* ops specific data */
  83 };
  84
  85 /* A given spi_device can represent up to eight mcp23sxx chips
  86  * sharing the same chipselect but using different addresses
  87  * (e.g. chips #0 and #3 might be populated, but not #1 or $2).
  88  * Driver data holds all the per-chip data.
  89  */
  90 struct mcp23s08_driver_data {
  91         unsigned                ngpio;
  92         struct mcp23s08         *mcp[8];
  93         struct mcp23s08         chip[];
  94 };
  95
  96 /* This lock class tells lockdep that GPIO irqs are in a different
  97  * category than their parents, so it won't report false recursion.
  98  */
  99 static struct lock_class_key gpio_lock_class;
 100
 101 /*----------------------------------------------------------------------*/
 102
 103 #if IS_ENABLED(CONFIG_I2C)
 104
 105 static int mcp23008_read(struct mcp23s08 *mcp, unsigned reg)
 106 {
 107         return i2c_smbus_read_byte_data(mcp->data, reg);
 108 }
 109
 110 static int mcp23008_write(struct mcp23s08 *mcp, unsigned reg, unsigned val)
 111 {
 112         return i2c_smbus_write_byte_data(mcp->data, reg, val);
 113 }
 114
 115 static int
 116 mcp23008_read_regs(struct mcp23s08 *mcp, unsigned reg, u16 *vals, unsigned n)
 117 {
 118         while (n--) {
 119                 int ret = mcp23008_read(mcp, reg++);
 120                 if (ret < 0)
 121                         return ret;
 122                 *vals++ = ret;
 123         }
 124
 125         return 0;
 126 }
 127
 128 static int mcp23017_read(struct mcp23s08 *mcp, unsigned reg)
 129 {
 130         return i2c_smbus_read_word_data(mcp->data, reg << 1);
 131 }
 132
 133 static int mcp23017_write(struct mcp23s08 *mcp, unsigned reg, unsigned val)
 134 {
 135         return i2c_smbus_write_word_data(mcp->data, reg << 1, val);
 136 }
 137
 138 static int
 139 mcp23017_read_regs(struct mcp23s08 *mcp, unsigned reg, u16 *vals, unsigned n)
 140 {
 141         while (n--) {
 142                 int ret = mcp23017_read(mcp, reg++);
 143                 if (ret < 0)
 144                         return ret;
 145                 *vals++ = ret;
 146         }
 147
 148         return 0;
 149 }
 150
 151 static const struct mcp23s08_ops mcp23008_ops = {
 152         .read           = mcp23008_read,
 153         .write          = mcp23008_write,
 154         .read_regs      = mcp23008_read_regs,
 155 };
 156
 157 static const struct mcp23s08_ops mcp23017_ops = {
 158         .read           = mcp23017_read,
 159         .write          = mcp23017_write,
 160         .read_regs      = mcp23017_read_regs,
 161 };
 162
 163 #endif /* CONFIG_I2C */
 164
 165 /*----------------------------------------------------------------------*/
 166
 167 #ifdef CONFIG_SPI_MASTER
 168
 169 static int mcp23s08_read(struct mcp23s08 *mcp, unsigned reg)
 170 {
 171         u8      tx[2], rx[1];
 172         int     status;
 173
 174         tx[0] = mcp->addr | 0x01;
 175         tx[1] = reg;
 176         status = spi_write_then_read(mcp->data, tx, sizeof(tx), rx, sizeof(rx));
 177         return (status < 0) ? status : rx[0];
 178 }
 179
 180 static int mcp23s08_write(struct mcp23s08 *mcp, unsigned reg, unsigned val)
 181 {
 182         u8      tx[3];
 183
 184         tx[0] = mcp->addr;
 185         tx[1] = reg;
 186         tx[2] = val;
 187         return spi_write_then_read(mcp->data, tx, sizeof(tx), NULL, 0);
 188 }
 189
 190 static int
 191 mcp23s08_read_regs(struct mcp23s08 *mcp, unsigned reg, u16 *vals, unsigned n)
 192 {
 193         u8      tx[2], *tmp;
 194         int     status;
 195
 196         if ((n + reg) > sizeof(mcp->cache))
 197                 return -EINVAL;
 198         tx[0] = mcp->addr | 0x01;
 199         tx[1] = reg;
 200
 201         tmp = (u8 *)vals;
 202         status = spi_write_then_read(mcp->data, tx, sizeof(tx), tmp, n);
 203         if (status >= 0) {
 204                 while (n--)
 205                         vals[n] = tmp[n]; /* expand to 16bit */
 206         }
 207         return status;
 208 }
 209
 210 static int mcp23s17_read(struct mcp23s08 *mcp, unsigned reg)
 211 {
 212         u8      tx[2], rx[2];
 213         int     status;
 214
 215         tx[0] = mcp->addr | 0x01;
 216         tx[1] = reg << 1;
 217         status = spi_write_then_read(mcp->data, tx, sizeof(tx), rx, sizeof(rx));
 218         return (status < 0) ? status : (rx[0] | (rx[1] << 8));
 219 }
 220
 221 static int mcp23s17_write(struct mcp23s08 *mcp, unsigned reg, unsigned val)
 222 {
 223         u8      tx[4];
 224
 225         tx[0] = mcp->addr;
 226         tx[1] = reg << 1;
 227         tx[2] = val;
 228         tx[3] = val >> 8;
 229         return spi_write_then_read(mcp->data, tx, sizeof(tx), NULL, 0);
 230 }
 231
 232 static int
 233 mcp23s17_read_regs(struct mcp23s08 *mcp, unsigned reg, u16 *vals, unsigned n)
 234 {
 235         u8      tx[2];
 236         int     status;
 237
 238         if ((n + reg) > sizeof(mcp->cache))
 239                 return -EINVAL;
 240         tx[0] = mcp->addr | 0x01;
 241         tx[1] = reg << 1;
 242
 243         status = spi_write_then_read(mcp->data, tx, sizeof(tx),
 244                                      (u8 *)vals, n * 2);
 245         if (status >= 0) {
 246                 while (n--)
 247                         vals[n] = __le16_to_cpu((__le16)vals[n]);
 248         }
 249
 250         return status;
 251 }
 252
 253 static const struct mcp23s08_ops mcp23s08_ops = {
 254         .read           = mcp23s08_read,
 255         .write          = mcp23s08_write,
 256         .read_regs      = mcp23s08_read_regs,
 257 };
 258
 259 static const struct mcp23s08_ops mcp23s17_ops = {
 260         .read           = mcp23s17_read,
 261         .write          = mcp23s17_write,
 262         .read_regs      = mcp23s17_read_regs,
 263 };
 264
 265 #endif /* CONFIG_SPI_MASTER */
 266
 267 /*----------------------------------------------------------------------*/
 268
 269 static int mcp23s08_direction_input(struct gpio_chip *chip, unsigned offset)
 270 {
 271         struct mcp23s08 *mcp = container_of(chip, struct mcp23s08, chip);
 272         int status;
 273
 274         mutex_lock(&mcp->lock);
 275         mcp->cache[MCP_IODIR] |= (1 << offset);
 276         status = mcp->ops->write(mcp, MCP_IODIR, mcp->cache[MCP_IODIR]);
 277         mutex_unlock(&mcp->lock);
 278         return status;
 279 }
 280
 281 static int mcp23s08_get(struct gpio_chip *chip, unsigned offset)
 282 {
 283         struct mcp23s08 *mcp = container_of(chip, struct mcp23s08, chip);
 284         int status;
 285
 286         mutex_lock(&mcp->lock);
 287
 288         /* REVISIT reading this clears any IRQ ... */
 289         status = mcp->ops->read(mcp, MCP_GPIO);
 290         if (status < 0)
 291                 status = 0;
 292         else {
 293                 mcp->cache[MCP_GPIO] = status;
 294                 status = !!(status & (1 << offset));
 295         }
 296         mutex_unlock(&mcp->lock);
 297         return status;
 298 }
 299
 300 static int __mcp23s08_set(struct mcp23s08 *mcp, unsigned mask, int value)
 301 {
 302         unsigned olat = mcp->cache[MCP_OLAT];
 303
 304         if (value)
 305                 olat |= mask;
 306         else
 307                 olat &= ~mask;
 308         mcp->cache[MCP_OLAT] = olat;
 309         return mcp->ops->write(mcp, MCP_OLAT, olat);
 310 }
 311
 312 static void mcp23s08_set(struct gpio_chip *chip, unsigned offset, int value)
 313 {
 314         struct mcp23s08 *mcp = container_of(chip, struct mcp23s08, chip);
 315         unsigned mask = 1 << offset;
 316
 317         mutex_lock(&mcp->lock);
 318         __mcp23s08_set(mcp, mask, value);
 319         mutex_unlock(&mcp->lock);
 320 }
 321
 322 static int
 323 mcp23s08_direction_output(struct gpio_chip *chip, unsigned offset, int value)
 324 {
 325         struct mcp23s08 *mcp = container_of(chip, struct mcp23s08, chip);
 326         unsigned mask = 1 << offset;
 327         int status;
 328
 329         mutex_lock(&mcp->lock);
 330         status = __mcp23s08_set(mcp, mask, value);
 331         if (status == 0) {
 332                 mcp->cache[MCP_IODIR] &= ~mask;
 333                 status = mcp->ops->write(mcp, MCP_IODIR, mcp->cache[MCP_IODIR]);
 334         }
 335         mutex_unlock(&mcp->lock);
 336         return status;
 337 }
 338
 339 /*----------------------------------------------------------------------*/
 340 static irqreturn_t mcp23s08_irq(int irq, void *data)
 341 {
 342         struct mcp23s08 *mcp = data;
 343         int intcap, intf, i, gpio, gpio_orig, intcap_mask;
 344         unsigned int child_irq;
 345         bool intf_set, intcap_changed, gpio_bit_changed,
 346                 gpio_set;
 347
 348         mutex_lock(&mcp->lock);
 349         intf = mcp->ops->read(mcp, MCP_INTF);
 350         if (intf < 0) {
 351                 mutex_unlock(&mcp->lock);
 352                 return IRQ_HANDLED;
 353         }
 354
 355         mcp->cache[MCP_INTF] = intf;
 356
 357         intcap = mcp->ops->read(mcp, MCP_INTCAP);
 358         if (intcap < 0) {
 359                 mutex_unlock(&mcp->lock);
 360                 return IRQ_HANDLED;
 361         }
 362
 363         mcp->cache[MCP_INTCAP] = intcap;
 364
 365         /* This clears the interrupt(configurable on S18) */
 366         if ((gpio = mcp->ops->read(mcp, MCP_GPIO)) < 0) {
 367                 mutex_unlock(&mcp->lock);
 368                 return IRQ_HANDLED;
 369         }
 370         gpio_orig = mcp->cache[MCP_GPIO];
 371         mcp->cache[MCP_GPIO] = gpio;
 372         mutex_unlock(&mcp->lock);
 373
 374         if (mcp->cache[MCP_INTF] == 0) {
 375                 /* There is no interrupt pending */
 376                 return IRQ_HANDLED;
 377         }
 378
 379         dev_dbg(mcp->chip.dev,
 380                 "intcap 0x%04X intf 0x%04X gpio_orig 0x%04X gpio 0x%04X\n",
 381                 intcap, intf, gpio_orig, gpio);
 382
 383         for (i = 0; i < mcp->chip.ngpio; i++) {
 384                 /* We must check all of the inputs on the chip,
 385                  * otherwise we may not notice a change on >=2 pins.
 386                  *
 387                  * On at least the mcp23s17, INTCAP is only updated
 388                  * one byte at a time(INTCAPA and INTCAPB are
 389                  * not written to at the same time - only on a per-bank
 390                  * basis).
 391                  *
 392                  * INTF only contains the single bit that caused the
 393                  * interrupt per-bank.  On the mcp23s17, there is
 394                  * INTFA and INTFB.  If two pins are changed on the A
 395                  * side at the same time, INTF will only have one bit
 396                  * set.  If one pin on the A side and one pin on the B
 397                  * side are changed at the same time, INTF will have
 398                  * two bits set.  Thus, INTF can't be the only check
 399                  * to see if the input has changed.
 400                  */
 401
 402                 intf_set = BIT(i) & mcp->cache[MCP_INTF];
 403                 if (i < 8 && intf_set)
 404                         intcap_mask = 0x00FF;
 405                 else if (i >= 8 && intf_set)
 406                         intcap_mask = 0xFF00;
 407                 else
 408                         intcap_mask = 0x00;
 409
 410                 intcap_changed = (intcap_mask &
 411                         (BIT(i) & mcp->cache[MCP_INTCAP])) !=
 412                         (intcap_mask & (BIT(i) & gpio_orig));
 413                 gpio_set = BIT(i) & mcp->cache[MCP_GPIO];
 414                 gpio_bit_changed = (BIT(i) & gpio_orig) !=
 415                         (BIT(i) & mcp->cache[MCP_GPIO]);
 416
 417                 if (((gpio_bit_changed || intcap_changed) &&
 418                         (BIT(i) & mcp->irq_rise) && gpio_set) ||
 419                     ((gpio_bit_changed || intcap_changed) &&
 420                         (BIT(i) & mcp->irq_fall) && !gpio_set)) {
 421                         child_irq = irq_find_mapping(mcp->irq_domain, i);
 422                         handle_nested_irq(child_irq);
 423                 }
 424         }
 425
 426         return IRQ_HANDLED;
 427 }
 428
 429 static int mcp23s08_gpio_to_irq(struct gpio_chip *chip, unsigned offset)
 430 {
 431         struct mcp23s08 *mcp = container_of(chip, struct mcp23s08, chip);
 432
 433         return irq_find_mapping(mcp->irq_domain, offset);
 434 }
 435
 436 static void mcp23s08_irq_mask(struct irq_data *data)
 437 {
 438         struct mcp23s08 *mcp = irq_data_get_irq_chip_data(data);
 439         unsigned int pos = data->hwirq;
 440
 441         mcp->cache[MCP_GPINTEN] &= ~BIT(pos);
 442 }
 443
 444 static void mcp23s08_irq_unmask(struct irq_data *data)
 445 {
 446         struct mcp23s08 *mcp = irq_data_get_irq_chip_data(data);
 447         unsigned int pos = data->hwirq;
 448
 449         mcp->cache[MCP_GPINTEN] |= BIT(pos);
 450 }
 451
 452 static int mcp23s08_irq_set_type(struct irq_data *data, unsigned int type)
 453 {
 454         struct mcp23s08 *mcp = irq_data_get_irq_chip_data(data);
 455         unsigned int pos = data->hwirq;
 456         int status = 0;
 457
 458         if ((type & IRQ_TYPE_EDGE_BOTH) == IRQ_TYPE_EDGE_BOTH) {
 459                 mcp->cache[MCP_INTCON] &= ~BIT(pos);
 460                 mcp->irq_rise |= BIT(pos);
 461                 mcp->irq_fall |= BIT(pos);
 462         } else if (type & IRQ_TYPE_EDGE_RISING) {
 463                 mcp->cache[MCP_INTCON] &= ~BIT(pos);
 464                 mcp->irq_rise |= BIT(pos);
 465                 mcp->irq_fall &= ~BIT(pos);
 466         } else if (type & IRQ_TYPE_EDGE_FALLING) {
 467                 mcp->cache[MCP_INTCON] &= ~BIT(pos);
 468                 mcp->irq_rise &= ~BIT(pos);
 469                 mcp->irq_fall |= BIT(pos);
 470         } else
 471                 return -EINVAL;
 472
 473         return status;
 474 }
 475
 476 static void mcp23s08_irq_bus_lock(struct irq_data *data)
 477 {
 478         struct mcp23s08 *mcp = irq_data_get_irq_chip_data(data);
 479
 480         mutex_lock(&mcp->irq_lock);
 481 }
 482
 483 static void mcp23s08_irq_bus_unlock(struct irq_data *data)
 484 {
 485         struct mcp23s08 *mcp = irq_data_get_irq_chip_data(data);
 486
 487         mutex_lock(&mcp->lock);
 488         mcp->ops->write(mcp, MCP_GPINTEN, mcp->cache[MCP_GPINTEN]);
 489         mcp->ops->write(mcp, MCP_DEFVAL, mcp->cache[MCP_DEFVAL]);
 490         mcp->ops->write(mcp, MCP_INTCON, mcp->cache[MCP_INTCON]);
 491         mutex_unlock(&mcp->lock);
 492         mutex_unlock(&mcp->irq_lock);
 493 }
 494
 495 static int mcp23s08_irq_reqres(struct irq_data *data)
 496 {
 497         struct mcp23s08 *mcp = irq_data_get_irq_chip_data(data);
 498
 499         if (gpio_lock_as_irq(&mcp->chip, data->hwirq)) {
 500                 dev_err(mcp->chip.dev,
 501                         "unable to lock HW IRQ %lu for IRQ usage\n",
 502                         data->hwirq);
 503                 return -EINVAL;
 504         }
 505
 506         return 0;
 507 }
 508
 509 static void mcp23s08_irq_relres(struct irq_data *data)
 510 {
 511         struct mcp23s08 *mcp = irq_data_get_irq_chip_data(data);
 512
 513         gpio_unlock_as_irq(&mcp->chip, data->hwirq);
 514 }
 515
 516 static struct irq_chip mcp23s08_irq_chip = {
 517         .name = "gpio-mcp23xxx",
 518         .irq_mask = mcp23s08_irq_mask,
 519         .irq_unmask = mcp23s08_irq_unmask,
 520         .irq_set_type = mcp23s08_irq_set_type,
 521         .irq_bus_lock = mcp23s08_irq_bus_lock,
 522         .irq_bus_sync_unlock = mcp23s08_irq_bus_unlock,
 523         .irq_request_resources = mcp23s08_irq_reqres,
 524         .irq_release_resources = mcp23s08_irq_relres,
 525 };
 526
 527 static int mcp23s08_irq_setup(struct mcp23s08 *mcp)
 528 {
 529         struct gpio_chip *chip = &mcp->chip;
 530         int err, irq, j;
 531
 532         mutex_init(&mcp->irq_lock);
 533
 534         mcp->irq_domain = irq_domain_add_linear(chip->of_node, chip->ngpio,
 535                                                 &irq_domain_simple_ops, mcp);
 536         if (!mcp->irq_domain)
 537                 return -ENODEV;
 538
 539         err = devm_request_threaded_irq(chip->dev, mcp->irq, NULL, mcp23s08_irq,
 540                                         IRQF_TRIGGER_LOW | IRQF_ONESHOT,
 541                                         dev_name(chip->dev), mcp);
 542         if (err != 0) {
 543                 dev_err(chip->dev, "unable to request IRQ#%d: %d\n",
 544                         mcp->irq, err);
 545                 return err;
 546         }
 547
 548         chip->to_irq = mcp23s08_gpio_to_irq;
 549
 550         for (j = 0; j < mcp->chip.ngpio; j++) {
 551                 irq = irq_create_mapping(mcp->irq_domain, j);
 552                 irq_set_lockdep_class(irq, &gpio_lock_class);
 553                 irq_set_chip_data(irq, mcp);
 554                 irq_set_chip(irq, &mcp23s08_irq_chip);
 555                 irq_set_nested_thread(irq, true);
 556 #ifdef CONFIG_ARM
 557                 set_irq_flags(irq, IRQF_VALID);
 558 #else
 559                 irq_set_noprobe(irq);
 560 #endif
 561         }
 562         return 0;
 563 }
 564
 565 static void mcp23s08_irq_teardown(struct mcp23s08 *mcp)
 566 {
 567         unsigned int irq, i;
 568
 569         free_irq(mcp->irq, mcp);
 570
 571         for (i = 0; i < mcp->chip.ngpio; i++) {
 572                 irq = irq_find_mapping(mcp->irq_domain, i);
 573                 if (irq > 0)
 574                         irq_dispose_mapping(irq);
 575         }
 576
 577         irq_domain_remove(mcp->irq_domain);
 578 }
 579
 580 /*----------------------------------------------------------------------*/
 581
 582 #ifdef CONFIG_DEBUG_FS
 583
 584 #include <linux/seq_file.h>
 585
 586 /*
 587  * This shows more info than the generic gpio dump code:
 588  * pullups, deglitching, open drain drive.
 589  */
 590 static void mcp23s08_dbg_show(struct seq_file *s, struct gpio_chip *chip)
 591 {
 592         struct mcp23s08 *mcp;
 593         char            bank;
 594         int             t;
 595         unsigned        mask;
 596
 597         mcp = container_of(chip, struct mcp23s08, chip);
 598
 599         /* NOTE: we only handle one bank for now ... */
 600         bank = '0' + ((mcp->addr >> 1) & 0x7);
 601
 602         mutex_lock(&mcp->lock);
 603         t = mcp->ops->read_regs(mcp, 0, mcp->cache, ARRAY_SIZE(mcp->cache));
 604         if (t < 0) {
 605                 seq_printf(s, " I/O ERROR %d\n", t);
 606                 goto done;
 607         }
 608
 609         for (t = 0, mask = 1; t < chip->ngpio; t++, mask <<= 1) {
 610                 const char      *label;
 611
 612                 label = gpiochip_is_requested(chip, t);
 613                 if (!label)
 614                         continue;
 615
 616                 seq_printf(s, " gpio-%-3d P%c.%d (%-12s) %s %s %s",
 617                         chip->base + t, bank, t, label,
 618                         (mcp->cache[MCP_IODIR] & mask) ? "in " : "out",
 619                         (mcp->cache[MCP_GPIO] & mask) ? "hi" : "lo",
 620                         (mcp->cache[MCP_GPPU] & mask) ? "up" : "  ");
 621                 /* NOTE:  ignoring the irq-related registers */
 622                 seq_puts(s, "\n");
 623         }
 624 done:
 625         mutex_unlock(&mcp->lock);
 626 }
 627
 628 #else
 629 #define mcp23s08_dbg_show       NULL
 630 #endif
 631
 632 /*----------------------------------------------------------------------*/
 633
 634 static int mcp23s08_probe_one(struct mcp23s08 *mcp, struct device *dev,
 635                               void *data, unsigned addr, unsigned type,
 636                               unsigned base, unsigned pullups)
 637 {
 638         int status;
 639         bool mirror = false;
 640
 641         mutex_init(&mcp->lock);
 642
 643         mcp->data = data;
 644         mcp->addr = addr;
 645
 646         mcp->chip.direction_input = mcp23s08_direction_input;
 647         mcp->chip.get = mcp23s08_get;
 648         mcp->chip.direction_output = mcp23s08_direction_output;
 649         mcp->chip.set = mcp23s08_set;
 650         mcp->chip.dbg_show = mcp23s08_dbg_show;
 651 #ifdef CONFIG_OF
 652         mcp->chip.of_gpio_n_cells = 2;
 653         mcp->chip.of_node = dev->of_node;
 654 #endif
 655
 656         switch (type) {
 657 #ifdef CONFIG_SPI_MASTER
 658         case MCP_TYPE_S08:
 659                 mcp->ops = &mcp23s08_ops;
 660                 mcp->chip.ngpio = 8;
 661                 mcp->chip.label = "mcp23s08";
 662                 break;
 663
 664         case MCP_TYPE_S17:
 665                 mcp->ops = &mcp23s17_ops;
 666                 mcp->chip.ngpio = 16;
 667                 mcp->chip.label = "mcp23s17";
 668                 break;
 669 #endif /* CONFIG_SPI_MASTER */
 670
 671 #if IS_ENABLED(CONFIG_I2C)
 672         case MCP_TYPE_008:
 673                 mcp->ops = &mcp23008_ops;
 674                 mcp->chip.ngpio = 8;
 675                 mcp->chip.label = "mcp23008";
 676                 break;
 677
 678         case MCP_TYPE_017:
 679                 mcp->ops = &mcp23017_ops;
 680                 mcp->chip.ngpio = 16;
 681                 mcp->chip.label = "mcp23017";
 682                 break;
 683 #endif /* CONFIG_I2C */
 684
 685         default:
 686                 dev_err(dev, "invalid device type (%d)\n", type);
 687                 return -EINVAL;
 688         }
 689
 690         mcp->chip.base = base;
 691         mcp->chip.can_sleep = true;
 692         mcp->chip.dev = dev;
 693         mcp->chip.owner = THIS_MODULE;
 694
 695         /* verify MCP_IOCON.SEQOP = 0, so sequential reads work,
 696          * and MCP_IOCON.HAEN = 1, so we work with all chips.
 697          */
 698
 699         status = mcp->ops->read(mcp, MCP_IOCON);
 700         if (status < 0)
 701                 goto fail;
 702
 703         mcp->irq_controller = of_property_read_bool(mcp->chip.of_node,
 704                                                 "interrupt-controller");
 705         if (mcp->irq && mcp->irq_controller && (type == MCP_TYPE_017))
 706                 mirror = of_property_read_bool(mcp->chip.of_node,
 707                                                 "microchip,irq-mirror");
 708
 709         if ((status & IOCON_SEQOP) || !(status & IOCON_HAEN) || mirror) {
 710                 /* mcp23s17 has IOCON twice, make sure they are in sync */
 711                 status &= ~(IOCON_SEQOP | (IOCON_SEQOP << 8));
 712                 status |= IOCON_HAEN | (IOCON_HAEN << 8);
 713                 status &= ~(IOCON_INTPOL | (IOCON_INTPOL << 8));
 714                 if (mirror)
 715                         status |= IOCON_MIRROR | (IOCON_MIRROR << 8);
 716
 717                 status = mcp->ops->write(mcp, MCP_IOCON, status);
 718                 if (status < 0)
 719                         goto fail;
 720         }
 721
 722         /* configure ~100K pullups */
 723         status = mcp->ops->write(mcp, MCP_GPPU, pullups);
 724         if (status < 0)
 725                 goto fail;
 726
 727         status = mcp->ops->read_regs(mcp, 0, mcp->cache, ARRAY_SIZE(mcp->cache));
 728         if (status < 0)
 729                 goto fail;
 730
 731         /* disable inverter on input */
 732         if (mcp->cache[MCP_IPOL] != 0) {
 733                 mcp->cache[MCP_IPOL] = 0;
 734                 status = mcp->ops->write(mcp, MCP_IPOL, 0);
 735                 if (status < 0)
 736                         goto fail;
 737         }
 738
 739         /* disable irqs */
 740         if (mcp->cache[MCP_GPINTEN] != 0) {
 741                 mcp->cache[MCP_GPINTEN] = 0;
 742                 status = mcp->ops->write(mcp, MCP_GPINTEN, 0);
 743                 if (status < 0)
 744                         goto fail;
 745         }
 746
 747         status = gpiochip_add(&mcp->chip);
 748         if (status < 0)
 749                 goto fail;
 750
 751         if (mcp->irq && mcp->irq_controller) {
 752                 status = mcp23s08_irq_setup(mcp);
 753                 if (status) {
 754                         mcp23s08_irq_teardown(mcp);
 755                         goto fail;
 756                 }
 757         }
 758 fail:
 759         if (status < 0)
 760                 dev_dbg(dev, "can't setup chip %d, --> %d\n",
 761                         addr, status);
 762         return status;
 763 }
 764
 765 /*----------------------------------------------------------------------*/
 766
 767 #ifdef CONFIG_OF
 768 #ifdef CONFIG_SPI_MASTER
 769 static const struct of_device_id mcp23s08_spi_of_match[] = {
 770         {
 771                 .compatible = "microchip,mcp23s08",
 772                 .data = (void *) MCP_TYPE_S08,
 773         },
 774         {
 775                 .compatible = "microchip,mcp23s17",
 776                 .data = (void *) MCP_TYPE_S17,
 777         },
 778 /* NOTE: The use of the mcp prefix is deprecated and will be removed. */
 779         {
 780                 .compatible = "mcp,mcp23s08",
 781                 .data = (void *) MCP_TYPE_S08,
 782         },
 783         {
 784                 .compatible = "mcp,mcp23s17",
 785                 .data = (void *) MCP_TYPE_S17,
 786         },
 787         { },
 788 };
 789 MODULE_DEVICE_TABLE(of, mcp23s08_spi_of_match);
 790 #endif
 791
 792 #if IS_ENABLED(CONFIG_I2C)
 793 static const struct of_device_id mcp23s08_i2c_of_match[] = {
 794         {
 795                 .compatible = "microchip,mcp23008",
 796                 .data = (void *) MCP_TYPE_008,
 797         },
 798         {
 799                 .compatible = "microchip,mcp23017",
 800                 .data = (void *) MCP_TYPE_017,
 801         },
 802 /* NOTE: The use of the mcp prefix is deprecated and will be removed. */
 803         {
 804                 .compatible = "mcp,mcp23008",
 805                 .data = (void *) MCP_TYPE_008,
 806         },
 807         {
 808                 .compatible = "mcp,mcp23017",
 809                 .data = (void *) MCP_TYPE_017,
 810         },
 811         { },
 812 };
 813 MODULE_DEVICE_TABLE(of, mcp23s08_i2c_of_match);
 814 #endif
 815 #endif /* CONFIG_OF */
 816
 817
 818 #if IS_ENABLED(CONFIG_I2C)
 819
 820 static int mcp230xx_probe(struct i2c_client *client,
 821                                     const struct i2c_device_id *id)
 822 {
 823         struct mcp23s08_platform_data *pdata;
 824         struct mcp23s08 *mcp;
 825         int status, base, pullups;
 826         const struct of_device_id *match;
 827
 828         match = of_match_device(of_match_ptr(mcp23s08_i2c_of_match),
 829                                         &client->dev);
 830         pdata = dev_get_platdata(&client->dev);
 831         if (match || !pdata) {
 832                 base = -1;
 833                 pullups = 0;
 834                 client->irq = irq_of_parse_and_map(client->dev.of_node, 0);
 835         } else {
 836                 if (!gpio_is_valid(pdata->base)) {
 837                         dev_dbg(&client->dev, "invalid platform data\n");
 838                         return -EINVAL;
 839                 }
 840                 base = pdata->base;
 841                 pullups = pdata->chip[0].pullups;
 842         }
 843
 844         mcp = kzalloc(sizeof(*mcp), GFP_KERNEL);
 845         if (!mcp)
 846                 return -ENOMEM;
 847
 848         mcp->irq = client->irq;
 849         status = mcp23s08_probe_one(mcp, &client->dev, client, client->addr,
 850                                     id->driver_data, base, pullups);
 851         if (status)
 852                 goto fail;
 853
 854         i2c_set_clientdata(client, mcp);
 855
 856         return 0;
 857
 858 fail:
 859         kfree(mcp);
 860
 861         return status;
 862 }
 863
 864 static int mcp230xx_remove(struct i2c_client *client)
 865 {
 866         struct mcp23s08 *mcp = i2c_get_clientdata(client);
 867         int status;
 868
 869         if (client->irq && mcp->irq_controller)
 870                 mcp23s08_irq_teardown(mcp);
 871
 872         status = gpiochip_remove(&mcp->chip);
 873         if (status == 0)
 874                 kfree(mcp);
 875
 876         return status;
 877 }
 878
 879 static const struct i2c_device_id mcp230xx_id[] = {
 880         { "mcp23008", MCP_TYPE_008 },
 881         { "mcp23017", MCP_TYPE_017 },
 882         { },
 883 };
 884 MODULE_DEVICE_TABLE(i2c, mcp230xx_id);
 885
 886 static struct i2c_driver mcp230xx_driver = {
 887         .driver = {
 888                 .name   = "mcp230xx",
 889                 .owner  = THIS_MODULE,
 890                 .of_match_table = of_match_ptr(mcp23s08_i2c_of_match),
 891         },
 892         .probe          = mcp230xx_probe,
 893         .remove         = mcp230xx_remove,
 894         .id_table       = mcp230xx_id,
 895 };
 896
 897 static int __init mcp23s08_i2c_init(void)
 898 {
 899         return i2c_add_driver(&mcp230xx_driver);
 900 }
 901
 902 static void mcp23s08_i2c_exit(void)
 903 {
 904         i2c_del_driver(&mcp230xx_driver);
 905 }
 906
 907 #else
 908
 909 static int __init mcp23s08_i2c_init(void) { return 0; }
 910 static void mcp23s08_i2c_exit(void) { }
 911
 912 #endif /* CONFIG_I2C */
 913
 914 /*----------------------------------------------------------------------*/
 915
 916 #ifdef CONFIG_SPI_MASTER
 917
 918 static int mcp23s08_probe(struct spi_device *spi)
 919 {
 920         struct mcp23s08_platform_data   *pdata;
 921         unsigned                        addr;
 922         int                             chips = 0;
 923         struct mcp23s08_driver_data     *data;
 924         int                             status, type;
 925         unsigned                        base = -1,
 926                                         ngpio = 0,
 927                                         pullups[ARRAY_SIZE(pdata->chip)];
 928         const struct                    of_device_id *match;
 929         u32                             spi_present_mask = 0;
 930
 931         match = of_match_device(of_match_ptr(mcp23s08_spi_of_match), &spi->dev);
 932         if (match) {
 933                 type = (int)(uintptr_t)match->data;
 934                 status = of_property_read_u32(spi->dev.of_node,
 935                             "microchip,spi-present-mask", &spi_present_mask);
 936                 if (status) {
 937                         status = of_property_read_u32(spi->dev.of_node,
 938                                     "mcp,spi-present-mask", &spi_present_mask);
 939                         if (status) {
 940                                 dev_err(&spi->dev,
 941                                         "DT has no spi-present-mask\n");
 942                                 return -ENODEV;
 943                         }
 944                 }
 945                 if ((spi_present_mask <= 0) || (spi_present_mask >= 256)) {
 946                         dev_err(&spi->dev, "invalid spi-present-mask\n");
 947                         return -ENODEV;
 948                 }
 949
 950                 for (addr = 0; addr < ARRAY_SIZE(pdata->chip); addr++) {
 951                         pullups[addr] = 0;
 952                         if (spi_present_mask & (1 << addr))
 953                                 chips++;
 954                 }
 955         } else {
 956                 type = spi_get_device_id(spi)->driver_data;
 957                 pdata = dev_get_platdata(&spi->dev);
 958                 if (!pdata || !gpio_is_valid(pdata->base)) {
 959                         dev_dbg(&spi->dev,
 960                                         "invalid or missing platform data\n");
 961                         return -EINVAL;
 962                 }
 963
 964                 for (addr = 0; addr < ARRAY_SIZE(pdata->chip); addr++) {
 965                         if (!pdata->chip[addr].is_present)
 966                                 continue;
 967                         chips++;
 968                         if ((type == MCP_TYPE_S08) && (addr > 3)) {
 969                                 dev_err(&spi->dev,
 970                                         "mcp23s08 only supports address 0..3\n");
 971                                 return -EINVAL;
 972                         }
 973                         spi_present_mask |= 1 << addr;
 974                         pullups[addr] = pdata->chip[addr].pullups;
 975                 }
 976
 977                 base = pdata->base;
 978         }
 979
 980         if (!chips)
 981                 return -ENODEV;
 982
 983         data = kzalloc(sizeof(*data) + chips * sizeof(struct mcp23s08),
 984                         GFP_KERNEL);
 985         if (!data)
 986                 return -ENOMEM;
 987         spi_set_drvdata(spi, data);
 988
 989         for (addr = 0; addr < ARRAY_SIZE(pdata->chip); addr++) {
 990                 if (!(spi_present_mask & (1 << addr)))
 991                         continue;
 992                 chips--;
 993                 data->mcp[addr] = &data->chip[chips];
 994                 status = mcp23s08_probe_one(data->mcp[addr], &spi->dev, spi,
 995                                             0x40 | (addr << 1), type, base,
 996                                             pullups[addr]);
 997                 if (status < 0)
 998                         goto fail;
 999
1000                 if (base != -1)
1001                         base += (type == MCP_TYPE_S17) ? 16 : 8;
1002                 ngpio += (type == MCP_TYPE_S17) ? 16 : 8;
1003         }
1004         data->ngpio = ngpio;
1005
1006         /* NOTE:  these chips have a relatively sane IRQ framework, with
1007          * per-signal masking and level/edge triggering.  It's not yet
1008          * handled here...
1009          */
1010
1011         return 0;
1012
1013 fail:
1014         for (addr = 0; addr < ARRAY_SIZE(data->mcp); addr++) {
1015                 int tmp;
1016
1017                 if (!data->mcp[addr])
1018                         continue;
1019                 tmp = gpiochip_remove(&data->mcp[addr]->chip);
1020                 if (tmp < 0)
1021                         dev_err(&spi->dev, "%s --> %d\n", "remove", tmp);
1022         }
1023         kfree(data);
1024         return status;
1025 }
1026
1027 static int mcp23s08_remove(struct spi_device *spi)
1028 {
1029         struct mcp23s08_driver_data     *data = spi_get_drvdata(spi);
1030         unsigned                        addr;
1031         int                             status = 0;
1032
1033         for (addr = 0; addr < ARRAY_SIZE(data->mcp); addr++) {
1034                 int tmp;
1035
1036                 if (!data->mcp[addr])
1037                         continue;
1038
1039                 tmp = gpiochip_remove(&data->mcp[addr]->chip);
1040                 if (tmp < 0) {
1041                         dev_err(&spi->dev, "%s --> %d\n", "remove", tmp);
1042                         status = tmp;
1043                 }
1044         }
1045         if (status == 0)
1046                 kfree(data);
1047         return status;
1048 }
1049
1050 static const struct spi_device_id mcp23s08_ids[] = {
1051         { "mcp23s08", MCP_TYPE_S08 },
1052         { "mcp23s17", MCP_TYPE_S17 },
1053         { },
1054 };
1055 MODULE_DEVICE_TABLE(spi, mcp23s08_ids);
1056
1057 static struct spi_driver mcp23s08_driver = {
1058         .probe          = mcp23s08_probe,
1059         .remove         = mcp23s08_remove,
1060         .id_table       = mcp23s08_ids,
1061         .driver = {
1062                 .name   = "mcp23s08",
1063                 .owner  = THIS_MODULE,
1064                 .of_match_table = of_match_ptr(mcp23s08_spi_of_match),
1065         },
1066 };
1067
1068 static int __init mcp23s08_spi_init(void)
1069 {
1070         return spi_register_driver(&mcp23s08_driver);
1071 }
1072
1073 static void mcp23s08_spi_exit(void)
1074 {
1075         spi_unregister_driver(&mcp23s08_driver);
1076 }
1077
1078 #else
1079
1080 static int __init mcp23s08_spi_init(void) { return 0; }
1081 static void mcp23s08_spi_exit(void) { }
1082
1083 #endif /* CONFIG_SPI_MASTER */
1084
1085 /*----------------------------------------------------------------------*/
1086
1087 static int __init mcp23s08_init(void)
1088 {
1089         int ret;
1090
1091         ret = mcp23s08_spi_init();
1092         if (ret)
1093                 goto spi_fail;
1094
1095         ret = mcp23s08_i2c_init();
1096         if (ret)
1097                 goto i2c_fail;
1098
1099         return 0;
1100
1101  i2c_fail:
1102         mcp23s08_spi_exit();
1103  spi_fail:
1104         return ret;
1105 }
1106 /* register after spi/i2c postcore initcall and before
1107  * subsys initcalls that may rely on these GPIOs
1108  */
1109 subsys_initcall(mcp23s08_init);
1110
1111 static void __exit mcp23s08_exit(void)
1112 {
1113         mcp23s08_spi_exit();
1114         mcp23s08_i2c_exit();
1115 }
1116 module_exit(mcp23s08_exit);
1117
1118 MODULE_LICENSE("GPL");