1 /* MCP23S08 SPI/I2C GPIO driver */ 2 3 #include <linux/kernel.h> 4 #include <linux/device.h> 5 #include <linux/mutex.h> 6 #include <linux/module.h> 7 #include <linux/gpio/driver.h> 8 #include <linux/i2c.h> 9 #include <linux/spi/spi.h> 10 #include <linux/spi/mcp23s08.h> 11 #include <linux/slab.h> 12 #include <asm/byteorder.h> 13 #include <linux/interrupt.h> 14 #include <linux/of_device.h> 15 #include <linux/regmap.h> 16 #include <linux/pinctrl/pinctrl.h> 17 #include <linux/pinctrl/pinconf.h> 18 #include <linux/pinctrl/pinconf-generic.h> 19 20 /* 21 * MCP types supported by driver 22 */ 23 #define MCP_TYPE_S08 0 24 #define MCP_TYPE_S17 1 25 #define MCP_TYPE_008 2 26 #define MCP_TYPE_017 3 27 #define MCP_TYPE_S18 4 28 #define MCP_TYPE_018 5 29 30 #define MCP_MAX_DEV_PER_CS 8 31 32 /* Registers are all 8 bits wide. 33 * 34 * The mcp23s17 has twice as many bits, and can be configured to work 35 * with either 16 bit registers or with two adjacent 8 bit banks. 36 */ 37 #define MCP_IODIR 0x00 /* init/reset: all ones */ 38 #define MCP_IPOL 0x01 39 #define MCP_GPINTEN 0x02 40 #define MCP_DEFVAL 0x03 41 #define MCP_INTCON 0x04 42 #define MCP_IOCON 0x05 43 # define IOCON_MIRROR (1 << 6) 44 # define IOCON_SEQOP (1 << 5) 45 # define IOCON_HAEN (1 << 3) 46 # define IOCON_ODR (1 << 2) 47 # define IOCON_INTPOL (1 << 1) 48 # define IOCON_INTCC (1) 49 #define MCP_GPPU 0x06 50 #define MCP_INTF 0x07 51 #define MCP_INTCAP 0x08 52 #define MCP_GPIO 0x09 53 #define MCP_OLAT 0x0a 54 55 struct mcp23s08; 56 57 struct mcp23s08 { 58 u8 addr; 59 bool irq_active_high; 60 bool reg_shift; 61 62 u16 irq_rise; 63 u16 irq_fall; 64 int irq; 65 bool irq_controller; 66 int cached_gpio; 67 /* lock protects regmap access with bypass/cache flags */ 68 struct mutex lock; 69 70 struct gpio_chip chip; 71 72 struct regmap *regmap; 73 struct device *dev; 74 75 struct pinctrl_dev *pctldev; 76 struct pinctrl_desc pinctrl_desc; 77 }; 78 79 static const struct reg_default mcp23x08_defaults[] = { 80 {.reg = MCP_IODIR, .def = 0xff}, 81 {.reg = MCP_IPOL, .def = 0x00}, 82 {.reg = MCP_GPINTEN, .def = 0x00}, 83 {.reg = MCP_DEFVAL, .def = 0x00}, 84 {.reg = MCP_INTCON, .def = 0x00}, 85 {.reg = MCP_IOCON, .def = 0x00}, 86 {.reg = MCP_GPPU, .def = 0x00}, 87 {.reg = MCP_OLAT, .def = 0x00}, 88 }; 89 90 static const struct regmap_range mcp23x08_volatile_range = { 91 .range_min = MCP_INTF, 92 .range_max = MCP_GPIO, 93 }; 94 95 static const struct regmap_access_table mcp23x08_volatile_table = { 96 .yes_ranges = &mcp23x08_volatile_range, 97 .n_yes_ranges = 1, 98 }; 99 100 static const struct regmap_range mcp23x08_precious_range = { 101 .range_min = MCP_GPIO, 102 .range_max = MCP_GPIO, 103 }; 104 105 static const struct regmap_access_table mcp23x08_precious_table = { 106 .yes_ranges = &mcp23x08_precious_range, 107 .n_yes_ranges = 1, 108 }; 109 110 static const struct regmap_config mcp23x08_regmap = { 111 .reg_bits = 8, 112 .val_bits = 8, 113 114 .reg_stride = 1, 115 .volatile_table = &mcp23x08_volatile_table, 116 .precious_table = &mcp23x08_precious_table, 117 .reg_defaults = mcp23x08_defaults, 118 .num_reg_defaults = ARRAY_SIZE(mcp23x08_defaults), 119 .cache_type = REGCACHE_FLAT, 120 .max_register = MCP_OLAT, 121 }; 122 123 static const struct reg_default mcp23x16_defaults[] = { 124 {.reg = MCP_IODIR << 1, .def = 0xffff}, 125 {.reg = MCP_IPOL << 1, .def = 0x0000}, 126 {.reg = MCP_GPINTEN << 1, .def = 0x0000}, 127 {.reg = MCP_DEFVAL << 1, .def = 0x0000}, 128 {.reg = MCP_INTCON << 1, .def = 0x0000}, 129 {.reg = MCP_IOCON << 1, .def = 0x0000}, 130 {.reg = MCP_GPPU << 1, .def = 0x0000}, 131 {.reg = MCP_OLAT << 1, .def = 0x0000}, 132 }; 133 134 static const struct regmap_range mcp23x16_volatile_range = { 135 .range_min = MCP_INTF << 1, 136 .range_max = MCP_GPIO << 1, 137 }; 138 139 static const struct regmap_access_table mcp23x16_volatile_table = { 140 .yes_ranges = &mcp23x16_volatile_range, 141 .n_yes_ranges = 1, 142 }; 143 144 static const struct regmap_range mcp23x16_precious_range = { 145 .range_min = MCP_GPIO << 1, 146 .range_max = MCP_GPIO << 1, 147 }; 148 149 static const struct regmap_access_table mcp23x16_precious_table = { 150 .yes_ranges = &mcp23x16_precious_range, 151 .n_yes_ranges = 1, 152 }; 153 154 static const struct regmap_config mcp23x17_regmap = { 155 .reg_bits = 8, 156 .val_bits = 16, 157 158 .reg_stride = 2, 159 .max_register = MCP_OLAT << 1, 160 .volatile_table = &mcp23x16_volatile_table, 161 .precious_table = &mcp23x16_precious_table, 162 .reg_defaults = mcp23x16_defaults, 163 .num_reg_defaults = ARRAY_SIZE(mcp23x16_defaults), 164 .cache_type = REGCACHE_FLAT, 165 .val_format_endian = REGMAP_ENDIAN_LITTLE, 166 }; 167 168 static int mcp_read(struct mcp23s08 *mcp, unsigned int reg, unsigned int *val) 169 { 170 return regmap_read(mcp->regmap, reg << mcp->reg_shift, val); 171 } 172 173 static int mcp_write(struct mcp23s08 *mcp, unsigned int reg, unsigned int val) 174 { 175 return regmap_write(mcp->regmap, reg << mcp->reg_shift, val); 176 } 177 178 static int mcp_set_mask(struct mcp23s08 *mcp, unsigned int reg, 179 unsigned int mask, bool enabled) 180 { 181 u16 val = enabled ? 0xffff : 0x0000; 182 return regmap_update_bits(mcp->regmap, reg << mcp->reg_shift, 183 mask, val); 184 } 185 186 static int mcp_set_bit(struct mcp23s08 *mcp, unsigned int reg, 187 unsigned int pin, bool enabled) 188 { 189 u16 mask = BIT(pin); 190 return mcp_set_mask(mcp, reg, mask, enabled); 191 } 192 193 static const struct pinctrl_pin_desc mcp23x08_pins[] = { 194 PINCTRL_PIN(0, "gpio0"), 195 PINCTRL_PIN(1, "gpio1"), 196 PINCTRL_PIN(2, "gpio2"), 197 PINCTRL_PIN(3, "gpio3"), 198 PINCTRL_PIN(4, "gpio4"), 199 PINCTRL_PIN(5, "gpio5"), 200 PINCTRL_PIN(6, "gpio6"), 201 PINCTRL_PIN(7, "gpio7"), 202 }; 203 204 static const struct pinctrl_pin_desc mcp23x17_pins[] = { 205 PINCTRL_PIN(0, "gpio0"), 206 PINCTRL_PIN(1, "gpio1"), 207 PINCTRL_PIN(2, "gpio2"), 208 PINCTRL_PIN(3, "gpio3"), 209 PINCTRL_PIN(4, "gpio4"), 210 PINCTRL_PIN(5, "gpio5"), 211 PINCTRL_PIN(6, "gpio6"), 212 PINCTRL_PIN(7, "gpio7"), 213 PINCTRL_PIN(8, "gpio8"), 214 PINCTRL_PIN(9, "gpio9"), 215 PINCTRL_PIN(10, "gpio10"), 216 PINCTRL_PIN(11, "gpio11"), 217 PINCTRL_PIN(12, "gpio12"), 218 PINCTRL_PIN(13, "gpio13"), 219 PINCTRL_PIN(14, "gpio14"), 220 PINCTRL_PIN(15, "gpio15"), 221 }; 222 223 static int mcp_pinctrl_get_groups_count(struct pinctrl_dev *pctldev) 224 { 225 return 0; 226 } 227 228 static const char *mcp_pinctrl_get_group_name(struct pinctrl_dev *pctldev, 229 unsigned int group) 230 { 231 return NULL; 232 } 233 234 static int mcp_pinctrl_get_group_pins(struct pinctrl_dev *pctldev, 235 unsigned int group, 236 const unsigned int **pins, 237 unsigned int *num_pins) 238 { 239 return -ENOTSUPP; 240 } 241 242 static const struct pinctrl_ops mcp_pinctrl_ops = { 243 .get_groups_count = mcp_pinctrl_get_groups_count, 244 .get_group_name = mcp_pinctrl_get_group_name, 245 .get_group_pins = mcp_pinctrl_get_group_pins, 246 #ifdef CONFIG_OF 247 .dt_node_to_map = pinconf_generic_dt_node_to_map_pin, 248 .dt_free_map = pinconf_generic_dt_free_map, 249 #endif 250 }; 251 252 static int mcp_pinconf_get(struct pinctrl_dev *pctldev, unsigned int pin, 253 unsigned long *config) 254 { 255 struct mcp23s08 *mcp = pinctrl_dev_get_drvdata(pctldev); 256 enum pin_config_param param = pinconf_to_config_param(*config); 257 unsigned int data, status; 258 int ret; 259 260 switch (param) { 261 case PIN_CONFIG_BIAS_PULL_UP: 262 ret = mcp_read(mcp, MCP_GPPU, &data); 263 if (ret < 0) 264 return ret; 265 status = (data & BIT(pin)) ? 1 : 0; 266 break; 267 default: 268 dev_err(mcp->dev, "Invalid config param %04x\n", param); 269 return -ENOTSUPP; 270 } 271 272 *config = 0; 273 274 return status ? 0 : -EINVAL; 275 } 276 277 static int mcp_pinconf_set(struct pinctrl_dev *pctldev, unsigned int pin, 278 unsigned long *configs, unsigned int num_configs) 279 { 280 struct mcp23s08 *mcp = pinctrl_dev_get_drvdata(pctldev); 281 enum pin_config_param param; 282 u32 arg; 283 int ret = 0; 284 int i; 285 286 for (i = 0; i < num_configs; i++) { 287 param = pinconf_to_config_param(configs[i]); 288 arg = pinconf_to_config_argument(configs[i]); 289 290 switch (param) { 291 case PIN_CONFIG_BIAS_PULL_UP: 292 ret = mcp_set_bit(mcp, MCP_GPPU, pin, arg); 293 break; 294 default: 295 dev_err(mcp->dev, "Invalid config param %04x\n", param); 296 return -ENOTSUPP; 297 } 298 } 299 300 return ret; 301 } 302 303 static const struct pinconf_ops mcp_pinconf_ops = { 304 .pin_config_get = mcp_pinconf_get, 305 .pin_config_set = mcp_pinconf_set, 306 .is_generic = true, 307 }; 308 309 /*----------------------------------------------------------------------*/ 310 311 #ifdef CONFIG_SPI_MASTER 312 313 static int mcp23sxx_spi_write(void *context, const void *data, size_t count) 314 { 315 struct mcp23s08 *mcp = context; 316 struct spi_device *spi = to_spi_device(mcp->dev); 317 struct spi_message m; 318 struct spi_transfer t[2] = { { .tx_buf = &mcp->addr, .len = 1, }, 319 { .tx_buf = data, .len = count, }, }; 320 321 spi_message_init(&m); 322 spi_message_add_tail(&t[0], &m); 323 spi_message_add_tail(&t[1], &m); 324 325 return spi_sync(spi, &m); 326 } 327 328 static int mcp23sxx_spi_gather_write(void *context, 329 const void *reg, size_t reg_size, 330 const void *val, size_t val_size) 331 { 332 struct mcp23s08 *mcp = context; 333 struct spi_device *spi = to_spi_device(mcp->dev); 334 struct spi_message m; 335 struct spi_transfer t[3] = { { .tx_buf = &mcp->addr, .len = 1, }, 336 { .tx_buf = reg, .len = reg_size, }, 337 { .tx_buf = val, .len = val_size, }, }; 338 339 spi_message_init(&m); 340 spi_message_add_tail(&t[0], &m); 341 spi_message_add_tail(&t[1], &m); 342 spi_message_add_tail(&t[2], &m); 343 344 return spi_sync(spi, &m); 345 } 346 347 static int mcp23sxx_spi_read(void *context, const void *reg, size_t reg_size, 348 void *val, size_t val_size) 349 { 350 struct mcp23s08 *mcp = context; 351 struct spi_device *spi = to_spi_device(mcp->dev); 352 u8 tx[2]; 353 354 if (reg_size != 1) 355 return -EINVAL; 356 357 tx[0] = mcp->addr | 0x01; 358 tx[1] = *((u8 *) reg); 359 360 return spi_write_then_read(spi, tx, sizeof(tx), val, val_size); 361 } 362 363 static const struct regmap_bus mcp23sxx_spi_regmap = { 364 .write = mcp23sxx_spi_write, 365 .gather_write = mcp23sxx_spi_gather_write, 366 .read = mcp23sxx_spi_read, 367 }; 368 369 #endif /* CONFIG_SPI_MASTER */ 370 371 /*----------------------------------------------------------------------*/ 372 373 /* A given spi_device can represent up to eight mcp23sxx chips 374 * sharing the same chipselect but using different addresses 375 * (e.g. chips #0 and #3 might be populated, but not #1 or $2). 376 * Driver data holds all the per-chip data. 377 */ 378 struct mcp23s08_driver_data { 379 unsigned ngpio; 380 struct mcp23s08 *mcp[8]; 381 struct mcp23s08 chip[]; 382 }; 383 384 385 static int mcp23s08_direction_input(struct gpio_chip *chip, unsigned offset) 386 { 387 struct mcp23s08 *mcp = gpiochip_get_data(chip); 388 int status; 389 390 mutex_lock(&mcp->lock); 391 status = mcp_set_bit(mcp, MCP_IODIR, offset, true); 392 mutex_unlock(&mcp->lock); 393 394 return status; 395 } 396 397 static int mcp23s08_get(struct gpio_chip *chip, unsigned offset) 398 { 399 struct mcp23s08 *mcp = gpiochip_get_data(chip); 400 int status, ret; 401 402 mutex_lock(&mcp->lock); 403 404 /* REVISIT reading this clears any IRQ ... */ 405 ret = mcp_read(mcp, MCP_GPIO, &status); 406 if (ret < 0) 407 status = 0; 408 else { 409 mcp->cached_gpio = status; 410 status = !!(status & (1 << offset)); 411 } 412 413 mutex_unlock(&mcp->lock); 414 return status; 415 } 416 417 static int __mcp23s08_set(struct mcp23s08 *mcp, unsigned mask, bool value) 418 { 419 return mcp_set_mask(mcp, MCP_OLAT, mask, value); 420 } 421 422 static void mcp23s08_set(struct gpio_chip *chip, unsigned offset, int value) 423 { 424 struct mcp23s08 *mcp = gpiochip_get_data(chip); 425 unsigned mask = BIT(offset); 426 427 mutex_lock(&mcp->lock); 428 __mcp23s08_set(mcp, mask, !!value); 429 mutex_unlock(&mcp->lock); 430 } 431 432 static int 433 mcp23s08_direction_output(struct gpio_chip *chip, unsigned offset, int value) 434 { 435 struct mcp23s08 *mcp = gpiochip_get_data(chip); 436 unsigned mask = BIT(offset); 437 int status; 438 439 mutex_lock(&mcp->lock); 440 status = __mcp23s08_set(mcp, mask, value); 441 if (status == 0) { 442 status = mcp_set_mask(mcp, MCP_IODIR, mask, false); 443 } 444 mutex_unlock(&mcp->lock); 445 return status; 446 } 447 448 /*----------------------------------------------------------------------*/ 449 static irqreturn_t mcp23s08_irq(int irq, void *data) 450 { 451 struct mcp23s08 *mcp = data; 452 int intcap, intcon, intf, i, gpio, gpio_orig, intcap_mask, defval; 453 unsigned int child_irq; 454 bool intf_set, intcap_changed, gpio_bit_changed, 455 defval_changed, gpio_set; 456 457 mutex_lock(&mcp->lock); 458 if (mcp_read(mcp, MCP_INTF, &intf)) 459 goto unlock; 460 461 if (mcp_read(mcp, MCP_INTCAP, &intcap)) 462 goto unlock; 463 464 if (mcp_read(mcp, MCP_INTCON, &intcon)) 465 goto unlock; 466 467 if (mcp_read(mcp, MCP_DEFVAL, &defval)) 468 goto unlock; 469 470 /* This clears the interrupt(configurable on S18) */ 471 if (mcp_read(mcp, MCP_GPIO, &gpio)) 472 goto unlock; 473 474 gpio_orig = mcp->cached_gpio; 475 mcp->cached_gpio = gpio; 476 mutex_unlock(&mcp->lock); 477 478 if (intf == 0) { 479 /* There is no interrupt pending */ 480 return IRQ_HANDLED; 481 } 482 483 dev_dbg(mcp->chip.parent, 484 "intcap 0x%04X intf 0x%04X gpio_orig 0x%04X gpio 0x%04X\n", 485 intcap, intf, gpio_orig, gpio); 486 487 for (i = 0; i < mcp->chip.ngpio; i++) { 488 /* We must check all of the inputs on the chip, 489 * otherwise we may not notice a change on >=2 pins. 490 * 491 * On at least the mcp23s17, INTCAP is only updated 492 * one byte at a time(INTCAPA and INTCAPB are 493 * not written to at the same time - only on a per-bank 494 * basis). 495 * 496 * INTF only contains the single bit that caused the 497 * interrupt per-bank. On the mcp23s17, there is 498 * INTFA and INTFB. If two pins are changed on the A 499 * side at the same time, INTF will only have one bit 500 * set. If one pin on the A side and one pin on the B 501 * side are changed at the same time, INTF will have 502 * two bits set. Thus, INTF can't be the only check 503 * to see if the input has changed. 504 */ 505 506 intf_set = intf & BIT(i); 507 if (i < 8 && intf_set) 508 intcap_mask = 0x00FF; 509 else if (i >= 8 && intf_set) 510 intcap_mask = 0xFF00; 511 else 512 intcap_mask = 0x00; 513 514 intcap_changed = (intcap_mask & 515 (intcap & BIT(i))) != 516 (intcap_mask & (BIT(i) & gpio_orig)); 517 gpio_set = BIT(i) & gpio; 518 gpio_bit_changed = (BIT(i) & gpio_orig) != 519 (BIT(i) & gpio); 520 defval_changed = (BIT(i) & intcon) && 521 ((BIT(i) & gpio) != 522 (BIT(i) & defval)); 523 524 if (((gpio_bit_changed || intcap_changed) && 525 (BIT(i) & mcp->irq_rise) && gpio_set) || 526 ((gpio_bit_changed || intcap_changed) && 527 (BIT(i) & mcp->irq_fall) && !gpio_set) || 528 defval_changed) { 529 child_irq = irq_find_mapping(mcp->chip.irq.domain, i); 530 handle_nested_irq(child_irq); 531 } 532 } 533 534 return IRQ_HANDLED; 535 536 unlock: 537 mutex_unlock(&mcp->lock); 538 return IRQ_HANDLED; 539 } 540 541 static void mcp23s08_irq_mask(struct irq_data *data) 542 { 543 struct gpio_chip *gc = irq_data_get_irq_chip_data(data); 544 struct mcp23s08 *mcp = gpiochip_get_data(gc); 545 unsigned int pos = data->hwirq; 546 547 mcp_set_bit(mcp, MCP_GPINTEN, pos, false); 548 } 549 550 static void mcp23s08_irq_unmask(struct irq_data *data) 551 { 552 struct gpio_chip *gc = irq_data_get_irq_chip_data(data); 553 struct mcp23s08 *mcp = gpiochip_get_data(gc); 554 unsigned int pos = data->hwirq; 555 556 mcp_set_bit(mcp, MCP_GPINTEN, pos, true); 557 } 558 559 static int mcp23s08_irq_set_type(struct irq_data *data, unsigned int type) 560 { 561 struct gpio_chip *gc = irq_data_get_irq_chip_data(data); 562 struct mcp23s08 *mcp = gpiochip_get_data(gc); 563 unsigned int pos = data->hwirq; 564 int status = 0; 565 566 if ((type & IRQ_TYPE_EDGE_BOTH) == IRQ_TYPE_EDGE_BOTH) { 567 mcp_set_bit(mcp, MCP_INTCON, pos, false); 568 mcp->irq_rise |= BIT(pos); 569 mcp->irq_fall |= BIT(pos); 570 } else if (type & IRQ_TYPE_EDGE_RISING) { 571 mcp_set_bit(mcp, MCP_INTCON, pos, false); 572 mcp->irq_rise |= BIT(pos); 573 mcp->irq_fall &= ~BIT(pos); 574 } else if (type & IRQ_TYPE_EDGE_FALLING) { 575 mcp_set_bit(mcp, MCP_INTCON, pos, false); 576 mcp->irq_rise &= ~BIT(pos); 577 mcp->irq_fall |= BIT(pos); 578 } else if (type & IRQ_TYPE_LEVEL_HIGH) { 579 mcp_set_bit(mcp, MCP_INTCON, pos, true); 580 mcp_set_bit(mcp, MCP_DEFVAL, pos, false); 581 } else if (type & IRQ_TYPE_LEVEL_LOW) { 582 mcp_set_bit(mcp, MCP_INTCON, pos, true); 583 mcp_set_bit(mcp, MCP_DEFVAL, pos, true); 584 } else 585 return -EINVAL; 586 587 return status; 588 } 589 590 static void mcp23s08_irq_bus_lock(struct irq_data *data) 591 { 592 struct gpio_chip *gc = irq_data_get_irq_chip_data(data); 593 struct mcp23s08 *mcp = gpiochip_get_data(gc); 594 595 mutex_lock(&mcp->lock); 596 regcache_cache_only(mcp->regmap, true); 597 } 598 599 static void mcp23s08_irq_bus_unlock(struct irq_data *data) 600 { 601 struct gpio_chip *gc = irq_data_get_irq_chip_data(data); 602 struct mcp23s08 *mcp = gpiochip_get_data(gc); 603 604 regcache_cache_only(mcp->regmap, false); 605 regcache_sync(mcp->regmap); 606 607 mutex_unlock(&mcp->lock); 608 } 609 610 static struct irq_chip mcp23s08_irq_chip = { 611 .name = "gpio-mcp23xxx", 612 .irq_mask = mcp23s08_irq_mask, 613 .irq_unmask = mcp23s08_irq_unmask, 614 .irq_set_type = mcp23s08_irq_set_type, 615 .irq_bus_lock = mcp23s08_irq_bus_lock, 616 .irq_bus_sync_unlock = mcp23s08_irq_bus_unlock, 617 }; 618 619 static int mcp23s08_irq_setup(struct mcp23s08 *mcp) 620 { 621 struct gpio_chip *chip = &mcp->chip; 622 int err; 623 unsigned long irqflags = IRQF_ONESHOT | IRQF_SHARED; 624 625 if (mcp->irq_active_high) 626 irqflags |= IRQF_TRIGGER_HIGH; 627 else 628 irqflags |= IRQF_TRIGGER_LOW; 629 630 err = devm_request_threaded_irq(chip->parent, mcp->irq, NULL, 631 mcp23s08_irq, 632 irqflags, dev_name(chip->parent), mcp); 633 if (err != 0) { 634 dev_err(chip->parent, "unable to request IRQ#%d: %d\n", 635 mcp->irq, err); 636 return err; 637 } 638 639 return 0; 640 } 641 642 static int mcp23s08_irqchip_setup(struct mcp23s08 *mcp) 643 { 644 struct gpio_chip *chip = &mcp->chip; 645 int err; 646 647 err = gpiochip_irqchip_add_nested(chip, 648 &mcp23s08_irq_chip, 649 0, 650 handle_simple_irq, 651 IRQ_TYPE_NONE); 652 if (err) { 653 dev_err(chip->parent, 654 "could not connect irqchip to gpiochip: %d\n", err); 655 return err; 656 } 657 658 gpiochip_set_nested_irqchip(chip, 659 &mcp23s08_irq_chip, 660 mcp->irq); 661 662 return 0; 663 } 664 665 /*----------------------------------------------------------------------*/ 666 667 #ifdef CONFIG_DEBUG_FS 668 669 #include <linux/seq_file.h> 670 671 /* 672 * This compares the chip's registers with the register 673 * cache and corrects any incorrectly set register. This 674 * can be used to fix state for MCP23xxx, that temporary 675 * lost its power supply. 676 */ 677 #define MCP23S08_CONFIG_REGS 7 678 static int __check_mcp23s08_reg_cache(struct mcp23s08 *mcp) 679 { 680 int cached[MCP23S08_CONFIG_REGS]; 681 int err = 0, i; 682 683 /* read cached config registers */ 684 for (i = 0; i < MCP23S08_CONFIG_REGS; i++) { 685 err = mcp_read(mcp, i, &cached[i]); 686 if (err) 687 goto out; 688 } 689 690 regcache_cache_bypass(mcp->regmap, true); 691 692 for (i = 0; i < MCP23S08_CONFIG_REGS; i++) { 693 int uncached; 694 err = mcp_read(mcp, i, &uncached); 695 if (err) 696 goto out; 697 698 if (uncached != cached[i]) { 699 dev_err(mcp->dev, "restoring reg 0x%02x from 0x%04x to 0x%04x (power-loss?)\n", 700 i, uncached, cached[i]); 701 mcp_write(mcp, i, cached[i]); 702 } 703 } 704 705 out: 706 if (err) 707 dev_err(mcp->dev, "read error: reg=%02x, err=%d", i, err); 708 regcache_cache_bypass(mcp->regmap, false); 709 return err; 710 } 711 712 /* 713 * This shows more info than the generic gpio dump code: 714 * pullups, deglitching, open drain drive. 715 */ 716 static void mcp23s08_dbg_show(struct seq_file *s, struct gpio_chip *chip) 717 { 718 struct mcp23s08 *mcp; 719 char bank; 720 int t; 721 unsigned mask; 722 int iodir, gpio, gppu; 723 724 mcp = gpiochip_get_data(chip); 725 726 /* NOTE: we only handle one bank for now ... */ 727 bank = '0' + ((mcp->addr >> 1) & 0x7); 728 729 mutex_lock(&mcp->lock); 730 731 t = __check_mcp23s08_reg_cache(mcp); 732 if (t) { 733 seq_printf(s, " I/O Error\n"); 734 goto done; 735 } 736 t = mcp_read(mcp, MCP_IODIR, &iodir); 737 if (t) { 738 seq_printf(s, " I/O Error\n"); 739 goto done; 740 } 741 t = mcp_read(mcp, MCP_GPIO, &gpio); 742 if (t) { 743 seq_printf(s, " I/O Error\n"); 744 goto done; 745 } 746 t = mcp_read(mcp, MCP_GPPU, &gppu); 747 if (t) { 748 seq_printf(s, " I/O Error\n"); 749 goto done; 750 } 751 752 for (t = 0, mask = BIT(0); t < chip->ngpio; t++, mask <<= 1) { 753 const char *label; 754 755 label = gpiochip_is_requested(chip, t); 756 if (!label) 757 continue; 758 759 seq_printf(s, " gpio-%-3d P%c.%d (%-12s) %s %s %s\n", 760 chip->base + t, bank, t, label, 761 (iodir & mask) ? "in " : "out", 762 (gpio & mask) ? "hi" : "lo", 763 (gppu & mask) ? "up" : " "); 764 /* NOTE: ignoring the irq-related registers */ 765 } 766 done: 767 mutex_unlock(&mcp->lock); 768 } 769 770 #else 771 #define mcp23s08_dbg_show NULL 772 #endif 773 774 /*----------------------------------------------------------------------*/ 775 776 static int mcp23s08_probe_one(struct mcp23s08 *mcp, struct device *dev, 777 void *data, unsigned addr, unsigned type, 778 unsigned int base, int cs) 779 { 780 int status, ret; 781 bool mirror = false; 782 bool open_drain = false; 783 struct regmap_config *one_regmap_config = NULL; 784 int raw_chip_address = (addr & ~0x40) >> 1; 785 786 mutex_init(&mcp->lock); 787 788 mcp->dev = dev; 789 mcp->addr = addr; 790 mcp->irq_active_high = false; 791 792 mcp->chip.direction_input = mcp23s08_direction_input; 793 mcp->chip.get = mcp23s08_get; 794 mcp->chip.direction_output = mcp23s08_direction_output; 795 mcp->chip.set = mcp23s08_set; 796 mcp->chip.dbg_show = mcp23s08_dbg_show; 797 #ifdef CONFIG_OF_GPIO 798 mcp->chip.of_gpio_n_cells = 2; 799 mcp->chip.of_node = dev->of_node; 800 #endif 801 802 switch (type) { 803 #ifdef CONFIG_SPI_MASTER 804 case MCP_TYPE_S08: 805 case MCP_TYPE_S17: 806 switch (type) { 807 case MCP_TYPE_S08: 808 one_regmap_config = 809 devm_kmemdup(dev, &mcp23x08_regmap, 810 sizeof(struct regmap_config), GFP_KERNEL); 811 mcp->reg_shift = 0; 812 mcp->chip.ngpio = 8; 813 mcp->chip.label = devm_kasprintf(dev, GFP_KERNEL, 814 "mcp23s08.%d", raw_chip_address); 815 break; 816 case MCP_TYPE_S17: 817 one_regmap_config = 818 devm_kmemdup(dev, &mcp23x17_regmap, 819 sizeof(struct regmap_config), GFP_KERNEL); 820 mcp->reg_shift = 1; 821 mcp->chip.ngpio = 16; 822 mcp->chip.label = devm_kasprintf(dev, GFP_KERNEL, 823 "mcp23s17.%d", raw_chip_address); 824 break; 825 } 826 if (!one_regmap_config) 827 return -ENOMEM; 828 829 one_regmap_config->name = devm_kasprintf(dev, GFP_KERNEL, "%d", raw_chip_address); 830 mcp->regmap = devm_regmap_init(dev, &mcp23sxx_spi_regmap, mcp, 831 one_regmap_config); 832 break; 833 834 case MCP_TYPE_S18: 835 mcp->regmap = devm_regmap_init(dev, &mcp23sxx_spi_regmap, mcp, 836 &mcp23x17_regmap); 837 mcp->reg_shift = 1; 838 mcp->chip.ngpio = 16; 839 mcp->chip.label = "mcp23s18"; 840 break; 841 #endif /* CONFIG_SPI_MASTER */ 842 843 #if IS_ENABLED(CONFIG_I2C) 844 case MCP_TYPE_008: 845 mcp->regmap = devm_regmap_init_i2c(data, &mcp23x08_regmap); 846 mcp->reg_shift = 0; 847 mcp->chip.ngpio = 8; 848 mcp->chip.label = "mcp23008"; 849 break; 850 851 case MCP_TYPE_017: 852 mcp->regmap = devm_regmap_init_i2c(data, &mcp23x17_regmap); 853 mcp->reg_shift = 1; 854 mcp->chip.ngpio = 16; 855 mcp->chip.label = "mcp23017"; 856 break; 857 858 case MCP_TYPE_018: 859 mcp->regmap = devm_regmap_init_i2c(data, &mcp23x17_regmap); 860 mcp->reg_shift = 1; 861 mcp->chip.ngpio = 16; 862 mcp->chip.label = "mcp23018"; 863 break; 864 #endif /* CONFIG_I2C */ 865 866 default: 867 dev_err(dev, "invalid device type (%d)\n", type); 868 return -EINVAL; 869 } 870 871 if (IS_ERR(mcp->regmap)) 872 return PTR_ERR(mcp->regmap); 873 874 mcp->chip.base = base; 875 mcp->chip.can_sleep = true; 876 mcp->chip.parent = dev; 877 mcp->chip.owner = THIS_MODULE; 878 879 /* verify MCP_IOCON.SEQOP = 0, so sequential reads work, 880 * and MCP_IOCON.HAEN = 1, so we work with all chips. 881 */ 882 883 ret = mcp_read(mcp, MCP_IOCON, &status); 884 if (ret < 0) 885 goto fail; 886 887 mcp->irq_controller = 888 device_property_read_bool(dev, "interrupt-controller"); 889 if (mcp->irq && mcp->irq_controller) { 890 mcp->irq_active_high = 891 device_property_read_bool(dev, 892 "microchip,irq-active-high"); 893 894 mirror = device_property_read_bool(dev, "microchip,irq-mirror"); 895 open_drain = device_property_read_bool(dev, "drive-open-drain"); 896 } 897 898 if ((status & IOCON_SEQOP) || !(status & IOCON_HAEN) || mirror || 899 mcp->irq_active_high || open_drain) { 900 /* mcp23s17 has IOCON twice, make sure they are in sync */ 901 status &= ~(IOCON_SEQOP | (IOCON_SEQOP << 8)); 902 status |= IOCON_HAEN | (IOCON_HAEN << 8); 903 if (mcp->irq_active_high) 904 status |= IOCON_INTPOL | (IOCON_INTPOL << 8); 905 else 906 status &= ~(IOCON_INTPOL | (IOCON_INTPOL << 8)); 907 908 if (mirror) 909 status |= IOCON_MIRROR | (IOCON_MIRROR << 8); 910 911 if (open_drain) 912 status |= IOCON_ODR | (IOCON_ODR << 8); 913 914 if (type == MCP_TYPE_S18 || type == MCP_TYPE_018) 915 status |= IOCON_INTCC | (IOCON_INTCC << 8); 916 917 ret = mcp_write(mcp, MCP_IOCON, status); 918 if (ret < 0) 919 goto fail; 920 } 921 922 if (mcp->irq && mcp->irq_controller) { 923 ret = mcp23s08_irqchip_setup(mcp); 924 if (ret) 925 goto fail; 926 } 927 928 ret = devm_gpiochip_add_data(dev, &mcp->chip, mcp); 929 if (ret < 0) 930 goto fail; 931 932 if (one_regmap_config) { 933 mcp->pinctrl_desc.name = devm_kasprintf(dev, GFP_KERNEL, 934 "mcp23xxx-pinctrl.%d", raw_chip_address); 935 if (!mcp->pinctrl_desc.name) 936 return -ENOMEM; 937 } else { 938 mcp->pinctrl_desc.name = "mcp23xxx-pinctrl"; 939 } 940 mcp->pinctrl_desc.pctlops = &mcp_pinctrl_ops; 941 mcp->pinctrl_desc.confops = &mcp_pinconf_ops; 942 mcp->pinctrl_desc.npins = mcp->chip.ngpio; 943 if (mcp->pinctrl_desc.npins == 8) 944 mcp->pinctrl_desc.pins = mcp23x08_pins; 945 else if (mcp->pinctrl_desc.npins == 16) 946 mcp->pinctrl_desc.pins = mcp23x17_pins; 947 mcp->pinctrl_desc.owner = THIS_MODULE; 948 949 mcp->pctldev = devm_pinctrl_register(dev, &mcp->pinctrl_desc, mcp); 950 if (IS_ERR(mcp->pctldev)) { 951 ret = PTR_ERR(mcp->pctldev); 952 goto fail; 953 } 954 955 if (mcp->irq) 956 ret = mcp23s08_irq_setup(mcp); 957 958 fail: 959 if (ret < 0) 960 dev_dbg(dev, "can't setup chip %d, --> %d\n", addr, ret); 961 return ret; 962 } 963 964 /*----------------------------------------------------------------------*/ 965 966 #ifdef CONFIG_OF 967 #ifdef CONFIG_SPI_MASTER 968 static const struct of_device_id mcp23s08_spi_of_match[] = { 969 { 970 .compatible = "microchip,mcp23s08", 971 .data = (void *) MCP_TYPE_S08, 972 }, 973 { 974 .compatible = "microchip,mcp23s17", 975 .data = (void *) MCP_TYPE_S17, 976 }, 977 { 978 .compatible = "microchip,mcp23s18", 979 .data = (void *) MCP_TYPE_S18, 980 }, 981 /* NOTE: The use of the mcp prefix is deprecated and will be removed. */ 982 { 983 .compatible = "mcp,mcp23s08", 984 .data = (void *) MCP_TYPE_S08, 985 }, 986 { 987 .compatible = "mcp,mcp23s17", 988 .data = (void *) MCP_TYPE_S17, 989 }, 990 { }, 991 }; 992 MODULE_DEVICE_TABLE(of, mcp23s08_spi_of_match); 993 #endif 994 995 #if IS_ENABLED(CONFIG_I2C) 996 static const struct of_device_id mcp23s08_i2c_of_match[] = { 997 { 998 .compatible = "microchip,mcp23008", 999 .data = (void *) MCP_TYPE_008, 1000 }, 1001 { 1002 .compatible = "microchip,mcp23017", 1003 .data = (void *) MCP_TYPE_017, 1004 }, 1005 { 1006 .compatible = "microchip,mcp23018", 1007 .data = (void *) MCP_TYPE_018, 1008 }, 1009 /* NOTE: The use of the mcp prefix is deprecated and will be removed. */ 1010 { 1011 .compatible = "mcp,mcp23008", 1012 .data = (void *) MCP_TYPE_008, 1013 }, 1014 { 1015 .compatible = "mcp,mcp23017", 1016 .data = (void *) MCP_TYPE_017, 1017 }, 1018 { }, 1019 }; 1020 MODULE_DEVICE_TABLE(of, mcp23s08_i2c_of_match); 1021 #endif 1022 #endif /* CONFIG_OF */ 1023 1024 1025 #if IS_ENABLED(CONFIG_I2C) 1026 1027 static int mcp230xx_probe(struct i2c_client *client, 1028 const struct i2c_device_id *id) 1029 { 1030 struct mcp23s08_platform_data *pdata, local_pdata; 1031 struct mcp23s08 *mcp; 1032 int status; 1033 1034 pdata = dev_get_platdata(&client->dev); 1035 if (!pdata) { 1036 pdata = &local_pdata; 1037 pdata->base = -1; 1038 } 1039 1040 mcp = devm_kzalloc(&client->dev, sizeof(*mcp), GFP_KERNEL); 1041 if (!mcp) 1042 return -ENOMEM; 1043 1044 mcp->irq = client->irq; 1045 status = mcp23s08_probe_one(mcp, &client->dev, client, client->addr, 1046 id->driver_data, pdata->base, 0); 1047 if (status) 1048 return status; 1049 1050 i2c_set_clientdata(client, mcp); 1051 1052 return 0; 1053 } 1054 1055 static const struct i2c_device_id mcp230xx_id[] = { 1056 { "mcp23008", MCP_TYPE_008 }, 1057 { "mcp23017", MCP_TYPE_017 }, 1058 { "mcp23018", MCP_TYPE_018 }, 1059 { }, 1060 }; 1061 MODULE_DEVICE_TABLE(i2c, mcp230xx_id); 1062 1063 static struct i2c_driver mcp230xx_driver = { 1064 .driver = { 1065 .name = "mcp230xx", 1066 .of_match_table = of_match_ptr(mcp23s08_i2c_of_match), 1067 }, 1068 .probe = mcp230xx_probe, 1069 .id_table = mcp230xx_id, 1070 }; 1071 1072 static int __init mcp23s08_i2c_init(void) 1073 { 1074 return i2c_add_driver(&mcp230xx_driver); 1075 } 1076 1077 static void mcp23s08_i2c_exit(void) 1078 { 1079 i2c_del_driver(&mcp230xx_driver); 1080 } 1081 1082 #else 1083 1084 static int __init mcp23s08_i2c_init(void) { return 0; } 1085 static void mcp23s08_i2c_exit(void) { } 1086 1087 #endif /* CONFIG_I2C */ 1088 1089 /*----------------------------------------------------------------------*/ 1090 1091 #ifdef CONFIG_SPI_MASTER 1092 1093 static int mcp23s08_probe(struct spi_device *spi) 1094 { 1095 struct mcp23s08_platform_data *pdata, local_pdata; 1096 unsigned addr; 1097 int chips = 0; 1098 struct mcp23s08_driver_data *data; 1099 int status, type; 1100 unsigned ngpio = 0; 1101 const struct of_device_id *match; 1102 1103 match = of_match_device(of_match_ptr(mcp23s08_spi_of_match), &spi->dev); 1104 if (match) 1105 type = (int)(uintptr_t)match->data; 1106 else 1107 type = spi_get_device_id(spi)->driver_data; 1108 1109 pdata = dev_get_platdata(&spi->dev); 1110 if (!pdata) { 1111 pdata = &local_pdata; 1112 pdata->base = -1; 1113 1114 status = device_property_read_u32(&spi->dev, 1115 "microchip,spi-present-mask", &pdata->spi_present_mask); 1116 if (status) { 1117 status = device_property_read_u32(&spi->dev, 1118 "mcp,spi-present-mask", 1119 &pdata->spi_present_mask); 1120 1121 if (status) { 1122 dev_err(&spi->dev, "missing spi-present-mask"); 1123 return -ENODEV; 1124 } 1125 } 1126 } 1127 1128 if (!pdata->spi_present_mask || pdata->spi_present_mask > 0xff) { 1129 dev_err(&spi->dev, "invalid spi-present-mask"); 1130 return -ENODEV; 1131 } 1132 1133 for (addr = 0; addr < MCP_MAX_DEV_PER_CS; addr++) { 1134 if (pdata->spi_present_mask & BIT(addr)) 1135 chips++; 1136 } 1137 1138 if (!chips) 1139 return -ENODEV; 1140 1141 data = devm_kzalloc(&spi->dev, 1142 sizeof(*data) + chips * sizeof(struct mcp23s08), 1143 GFP_KERNEL); 1144 if (!data) 1145 return -ENOMEM; 1146 1147 spi_set_drvdata(spi, data); 1148 1149 for (addr = 0; addr < MCP_MAX_DEV_PER_CS; addr++) { 1150 if (!(pdata->spi_present_mask & BIT(addr))) 1151 continue; 1152 chips--; 1153 data->mcp[addr] = &data->chip[chips]; 1154 data->mcp[addr]->irq = spi->irq; 1155 status = mcp23s08_probe_one(data->mcp[addr], &spi->dev, spi, 1156 0x40 | (addr << 1), type, 1157 pdata->base, addr); 1158 if (status < 0) 1159 return status; 1160 1161 if (pdata->base != -1) 1162 pdata->base += data->mcp[addr]->chip.ngpio; 1163 ngpio += data->mcp[addr]->chip.ngpio; 1164 } 1165 data->ngpio = ngpio; 1166 1167 return 0; 1168 } 1169 1170 static const struct spi_device_id mcp23s08_ids[] = { 1171 { "mcp23s08", MCP_TYPE_S08 }, 1172 { "mcp23s17", MCP_TYPE_S17 }, 1173 { "mcp23s18", MCP_TYPE_S18 }, 1174 { }, 1175 }; 1176 MODULE_DEVICE_TABLE(spi, mcp23s08_ids); 1177 1178 static struct spi_driver mcp23s08_driver = { 1179 .probe = mcp23s08_probe, 1180 .id_table = mcp23s08_ids, 1181 .driver = { 1182 .name = "mcp23s08", 1183 .of_match_table = of_match_ptr(mcp23s08_spi_of_match), 1184 }, 1185 }; 1186 1187 static int __init mcp23s08_spi_init(void) 1188 { 1189 return spi_register_driver(&mcp23s08_driver); 1190 } 1191 1192 static void mcp23s08_spi_exit(void) 1193 { 1194 spi_unregister_driver(&mcp23s08_driver); 1195 } 1196 1197 #else 1198 1199 static int __init mcp23s08_spi_init(void) { return 0; } 1200 static void mcp23s08_spi_exit(void) { } 1201 1202 #endif /* CONFIG_SPI_MASTER */ 1203 1204 /*----------------------------------------------------------------------*/ 1205 1206 static int __init mcp23s08_init(void) 1207 { 1208 int ret; 1209 1210 ret = mcp23s08_spi_init(); 1211 if (ret) 1212 goto spi_fail; 1213 1214 ret = mcp23s08_i2c_init(); 1215 if (ret) 1216 goto i2c_fail; 1217 1218 return 0; 1219 1220 i2c_fail: 1221 mcp23s08_spi_exit(); 1222 spi_fail: 1223 return ret; 1224 } 1225 /* register after spi/i2c postcore initcall and before 1226 * subsys initcalls that may rely on these GPIOs 1227 */ 1228 subsys_initcall(mcp23s08_init); 1229 1230 static void __exit mcp23s08_exit(void) 1231 { 1232 mcp23s08_spi_exit(); 1233 mcp23s08_i2c_exit(); 1234 } 1235 module_exit(mcp23s08_exit); 1236 1237 MODULE_LICENSE("GPL"); 1238