hwmon: (adt7475) fan stall prevention
[linux/fpc-iii.git] / drivers / gpio / gpio-mcp23s08.c
blob2a57d024481db8c354badd976843f83a365c72a9
1 /*
2 * MCP23S08 SPI/I2C GPIO gpio expander driver
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.
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 #include <linux/regmap.h>
28 /**
29 * MCP types supported by driver
31 #define MCP_TYPE_S08 0
32 #define MCP_TYPE_S17 1
33 #define MCP_TYPE_008 2
34 #define MCP_TYPE_017 3
35 #define MCP_TYPE_S18 4
37 /* Registers are all 8 bits wide.
39 * The mcp23s17 has twice as many bits, and can be configured to work
40 * with either 16 bit registers or with two adjacent 8 bit banks.
42 #define MCP_IODIR 0x00 /* init/reset: all ones */
43 #define MCP_IPOL 0x01
44 #define MCP_GPINTEN 0x02
45 #define MCP_DEFVAL 0x03
46 #define MCP_INTCON 0x04
47 #define MCP_IOCON 0x05
48 # define IOCON_MIRROR (1 << 6)
49 # define IOCON_SEQOP (1 << 5)
50 # define IOCON_HAEN (1 << 3)
51 # define IOCON_ODR (1 << 2)
52 # define IOCON_INTPOL (1 << 1)
53 # define IOCON_INTCC (1)
54 #define MCP_GPPU 0x06
55 #define MCP_INTF 0x07
56 #define MCP_INTCAP 0x08
57 #define MCP_GPIO 0x09
58 #define MCP_OLAT 0x0a
60 struct mcp23s08;
62 struct mcp23s08 {
63 u8 addr;
64 bool irq_active_high;
65 bool reg_shift;
67 u16 cache[11];
68 u16 irq_rise;
69 u16 irq_fall;
70 int irq;
71 bool irq_controller;
72 /* lock protects the cached values */
73 struct mutex lock;
74 struct mutex irq_lock;
76 struct gpio_chip chip;
78 struct regmap *regmap;
79 struct device *dev;
82 static const struct regmap_config mcp23x08_regmap = {
83 .reg_bits = 8,
84 .val_bits = 8,
86 .reg_stride = 1,
87 .max_register = MCP_OLAT,
90 static const struct regmap_config mcp23x17_regmap = {
91 .reg_bits = 8,
92 .val_bits = 16,
94 .reg_stride = 2,
95 .max_register = MCP_OLAT << 1,
96 .val_format_endian = REGMAP_ENDIAN_LITTLE,
99 /*----------------------------------------------------------------------*/
101 #ifdef CONFIG_SPI_MASTER
103 static int mcp23sxx_spi_write(void *context, const void *data, size_t count)
105 struct mcp23s08 *mcp = context;
106 struct spi_device *spi = to_spi_device(mcp->dev);
107 struct spi_message m;
108 struct spi_transfer t[2] = { { .tx_buf = &mcp->addr, .len = 1, },
109 { .tx_buf = data, .len = count, }, };
111 spi_message_init(&m);
112 spi_message_add_tail(&t[0], &m);
113 spi_message_add_tail(&t[1], &m);
115 return spi_sync(spi, &m);
118 static int mcp23sxx_spi_gather_write(void *context,
119 const void *reg, size_t reg_size,
120 const void *val, size_t val_size)
122 struct mcp23s08 *mcp = context;
123 struct spi_device *spi = to_spi_device(mcp->dev);
124 struct spi_message m;
125 struct spi_transfer t[3] = { { .tx_buf = &mcp->addr, .len = 1, },
126 { .tx_buf = reg, .len = reg_size, },
127 { .tx_buf = val, .len = val_size, }, };
129 spi_message_init(&m);
130 spi_message_add_tail(&t[0], &m);
131 spi_message_add_tail(&t[1], &m);
132 spi_message_add_tail(&t[2], &m);
134 return spi_sync(spi, &m);
137 static int mcp23sxx_spi_read(void *context, const void *reg, size_t reg_size,
138 void *val, size_t val_size)
140 struct mcp23s08 *mcp = context;
141 struct spi_device *spi = to_spi_device(mcp->dev);
142 u8 tx[2];
144 if (reg_size != 1)
145 return -EINVAL;
147 tx[0] = mcp->addr | 0x01;
148 tx[1] = *((u8 *) reg);
150 return spi_write_then_read(spi, tx, sizeof(tx), val, val_size);
153 static const struct regmap_bus mcp23sxx_spi_regmap = {
154 .write = mcp23sxx_spi_write,
155 .gather_write = mcp23sxx_spi_gather_write,
156 .read = mcp23sxx_spi_read,
159 #endif /* CONFIG_SPI_MASTER */
161 static int mcp_read(struct mcp23s08 *mcp, unsigned int reg, unsigned int *val)
163 return regmap_read(mcp->regmap, reg << mcp->reg_shift, val);
166 static int mcp_write(struct mcp23s08 *mcp, unsigned int reg, unsigned int val)
168 return regmap_write(mcp->regmap, reg << mcp->reg_shift, val);
171 static int mcp_update_cache(struct mcp23s08 *mcp)
173 int ret, reg, i;
175 for (i = 0; i < ARRAY_SIZE(mcp->cache); i++) {
176 ret = mcp_read(mcp, i, &reg);
177 if (ret < 0)
178 return ret;
179 mcp->cache[i] = reg;
182 return 0;
185 /*----------------------------------------------------------------------*/
187 /* A given spi_device can represent up to eight mcp23sxx chips
188 * sharing the same chipselect but using different addresses
189 * (e.g. chips #0 and #3 might be populated, but not #1 or $2).
190 * Driver data holds all the per-chip data.
192 struct mcp23s08_driver_data {
193 unsigned ngpio;
194 struct mcp23s08 *mcp[8];
195 struct mcp23s08 chip[];
199 static int mcp23s08_direction_input(struct gpio_chip *chip, unsigned offset)
201 struct mcp23s08 *mcp = gpiochip_get_data(chip);
202 int status;
204 mutex_lock(&mcp->lock);
205 mcp->cache[MCP_IODIR] |= (1 << offset);
206 status = mcp_write(mcp, MCP_IODIR, mcp->cache[MCP_IODIR]);
207 mutex_unlock(&mcp->lock);
208 return status;
211 static int mcp23s08_get(struct gpio_chip *chip, unsigned offset)
213 struct mcp23s08 *mcp = gpiochip_get_data(chip);
214 int status, ret;
216 mutex_lock(&mcp->lock);
218 /* REVISIT reading this clears any IRQ ... */
219 ret = mcp_read(mcp, MCP_GPIO, &status);
220 if (ret < 0)
221 status = 0;
222 else {
223 mcp->cache[MCP_GPIO] = status;
224 status = !!(status & (1 << offset));
226 mutex_unlock(&mcp->lock);
227 return status;
230 static int __mcp23s08_set(struct mcp23s08 *mcp, unsigned mask, int value)
232 unsigned olat = mcp->cache[MCP_OLAT];
234 if (value)
235 olat |= mask;
236 else
237 olat &= ~mask;
238 mcp->cache[MCP_OLAT] = olat;
239 return mcp_write(mcp, MCP_OLAT, olat);
242 static void mcp23s08_set(struct gpio_chip *chip, unsigned offset, int value)
244 struct mcp23s08 *mcp = gpiochip_get_data(chip);
245 unsigned mask = 1 << offset;
247 mutex_lock(&mcp->lock);
248 __mcp23s08_set(mcp, mask, value);
249 mutex_unlock(&mcp->lock);
252 static int
253 mcp23s08_direction_output(struct gpio_chip *chip, unsigned offset, int value)
255 struct mcp23s08 *mcp = gpiochip_get_data(chip);
256 unsigned mask = 1 << offset;
257 int status;
259 mutex_lock(&mcp->lock);
260 status = __mcp23s08_set(mcp, mask, value);
261 if (status == 0) {
262 mcp->cache[MCP_IODIR] &= ~mask;
263 status = mcp_write(mcp, MCP_IODIR, mcp->cache[MCP_IODIR]);
265 mutex_unlock(&mcp->lock);
266 return status;
269 /*----------------------------------------------------------------------*/
270 static irqreturn_t mcp23s08_irq(int irq, void *data)
272 struct mcp23s08 *mcp = data;
273 int intcap, intf, i, gpio, gpio_orig, intcap_mask;
274 unsigned int child_irq;
275 bool intf_set, intcap_changed, gpio_bit_changed,
276 defval_changed, gpio_set;
278 mutex_lock(&mcp->lock);
279 if (mcp_read(mcp, MCP_INTF, &intf) < 0) {
280 mutex_unlock(&mcp->lock);
281 return IRQ_HANDLED;
284 mcp->cache[MCP_INTF] = intf;
286 if (mcp_read(mcp, MCP_INTCAP, &intcap) < 0) {
287 mutex_unlock(&mcp->lock);
288 return IRQ_HANDLED;
291 mcp->cache[MCP_INTCAP] = intcap;
293 /* This clears the interrupt(configurable on S18) */
294 if (mcp_read(mcp, MCP_GPIO, &gpio) < 0) {
295 mutex_unlock(&mcp->lock);
296 return IRQ_HANDLED;
298 gpio_orig = mcp->cache[MCP_GPIO];
299 mcp->cache[MCP_GPIO] = gpio;
300 mutex_unlock(&mcp->lock);
302 if (mcp->cache[MCP_INTF] == 0) {
303 /* There is no interrupt pending */
304 return IRQ_HANDLED;
307 dev_dbg(mcp->chip.parent,
308 "intcap 0x%04X intf 0x%04X gpio_orig 0x%04X gpio 0x%04X\n",
309 intcap, intf, gpio_orig, gpio);
311 for (i = 0; i < mcp->chip.ngpio; i++) {
312 /* We must check all of the inputs on the chip,
313 * otherwise we may not notice a change on >=2 pins.
315 * On at least the mcp23s17, INTCAP is only updated
316 * one byte at a time(INTCAPA and INTCAPB are
317 * not written to at the same time - only on a per-bank
318 * basis).
320 * INTF only contains the single bit that caused the
321 * interrupt per-bank. On the mcp23s17, there is
322 * INTFA and INTFB. If two pins are changed on the A
323 * side at the same time, INTF will only have one bit
324 * set. If one pin on the A side and one pin on the B
325 * side are changed at the same time, INTF will have
326 * two bits set. Thus, INTF can't be the only check
327 * to see if the input has changed.
330 intf_set = BIT(i) & mcp->cache[MCP_INTF];
331 if (i < 8 && intf_set)
332 intcap_mask = 0x00FF;
333 else if (i >= 8 && intf_set)
334 intcap_mask = 0xFF00;
335 else
336 intcap_mask = 0x00;
338 intcap_changed = (intcap_mask &
339 (BIT(i) & mcp->cache[MCP_INTCAP])) !=
340 (intcap_mask & (BIT(i) & gpio_orig));
341 gpio_set = BIT(i) & mcp->cache[MCP_GPIO];
342 gpio_bit_changed = (BIT(i) & gpio_orig) !=
343 (BIT(i) & mcp->cache[MCP_GPIO]);
344 defval_changed = (BIT(i) & mcp->cache[MCP_INTCON]) &&
345 ((BIT(i) & mcp->cache[MCP_GPIO]) !=
346 (BIT(i) & mcp->cache[MCP_DEFVAL]));
348 if (((gpio_bit_changed || intcap_changed) &&
349 (BIT(i) & mcp->irq_rise) && gpio_set) ||
350 ((gpio_bit_changed || intcap_changed) &&
351 (BIT(i) & mcp->irq_fall) && !gpio_set) ||
352 defval_changed) {
353 child_irq = irq_find_mapping(mcp->chip.irqdomain, i);
354 handle_nested_irq(child_irq);
358 return IRQ_HANDLED;
361 static void mcp23s08_irq_mask(struct irq_data *data)
363 struct gpio_chip *gc = irq_data_get_irq_chip_data(data);
364 struct mcp23s08 *mcp = gpiochip_get_data(gc);
365 unsigned int pos = data->hwirq;
367 mcp->cache[MCP_GPINTEN] &= ~BIT(pos);
370 static void mcp23s08_irq_unmask(struct irq_data *data)
372 struct gpio_chip *gc = irq_data_get_irq_chip_data(data);
373 struct mcp23s08 *mcp = gpiochip_get_data(gc);
374 unsigned int pos = data->hwirq;
376 mcp->cache[MCP_GPINTEN] |= BIT(pos);
379 static int mcp23s08_irq_set_type(struct irq_data *data, unsigned int type)
381 struct gpio_chip *gc = irq_data_get_irq_chip_data(data);
382 struct mcp23s08 *mcp = gpiochip_get_data(gc);
383 unsigned int pos = data->hwirq;
384 int status = 0;
386 if ((type & IRQ_TYPE_EDGE_BOTH) == IRQ_TYPE_EDGE_BOTH) {
387 mcp->cache[MCP_INTCON] &= ~BIT(pos);
388 mcp->irq_rise |= BIT(pos);
389 mcp->irq_fall |= BIT(pos);
390 } else if (type & IRQ_TYPE_EDGE_RISING) {
391 mcp->cache[MCP_INTCON] &= ~BIT(pos);
392 mcp->irq_rise |= BIT(pos);
393 mcp->irq_fall &= ~BIT(pos);
394 } else if (type & IRQ_TYPE_EDGE_FALLING) {
395 mcp->cache[MCP_INTCON] &= ~BIT(pos);
396 mcp->irq_rise &= ~BIT(pos);
397 mcp->irq_fall |= BIT(pos);
398 } else if (type & IRQ_TYPE_LEVEL_HIGH) {
399 mcp->cache[MCP_INTCON] |= BIT(pos);
400 mcp->cache[MCP_DEFVAL] &= ~BIT(pos);
401 } else if (type & IRQ_TYPE_LEVEL_LOW) {
402 mcp->cache[MCP_INTCON] |= BIT(pos);
403 mcp->cache[MCP_DEFVAL] |= BIT(pos);
404 } else
405 return -EINVAL;
407 return status;
410 static void mcp23s08_irq_bus_lock(struct irq_data *data)
412 struct gpio_chip *gc = irq_data_get_irq_chip_data(data);
413 struct mcp23s08 *mcp = gpiochip_get_data(gc);
415 mutex_lock(&mcp->irq_lock);
418 static void mcp23s08_irq_bus_unlock(struct irq_data *data)
420 struct gpio_chip *gc = irq_data_get_irq_chip_data(data);
421 struct mcp23s08 *mcp = gpiochip_get_data(gc);
423 mutex_lock(&mcp->lock);
424 mcp_write(mcp, MCP_GPINTEN, mcp->cache[MCP_GPINTEN]);
425 mcp_write(mcp, MCP_DEFVAL, mcp->cache[MCP_DEFVAL]);
426 mcp_write(mcp, MCP_INTCON, mcp->cache[MCP_INTCON]);
427 mutex_unlock(&mcp->lock);
428 mutex_unlock(&mcp->irq_lock);
431 static struct irq_chip mcp23s08_irq_chip = {
432 .name = "gpio-mcp23xxx",
433 .irq_mask = mcp23s08_irq_mask,
434 .irq_unmask = mcp23s08_irq_unmask,
435 .irq_set_type = mcp23s08_irq_set_type,
436 .irq_bus_lock = mcp23s08_irq_bus_lock,
437 .irq_bus_sync_unlock = mcp23s08_irq_bus_unlock,
440 static int mcp23s08_irq_setup(struct mcp23s08 *mcp)
442 struct gpio_chip *chip = &mcp->chip;
443 int err;
444 unsigned long irqflags = IRQF_ONESHOT | IRQF_SHARED;
446 mutex_init(&mcp->irq_lock);
448 if (mcp->irq_active_high)
449 irqflags |= IRQF_TRIGGER_HIGH;
450 else
451 irqflags |= IRQF_TRIGGER_LOW;
453 err = devm_request_threaded_irq(chip->parent, mcp->irq, NULL,
454 mcp23s08_irq,
455 irqflags, dev_name(chip->parent), mcp);
456 if (err != 0) {
457 dev_err(chip->parent, "unable to request IRQ#%d: %d\n",
458 mcp->irq, err);
459 return err;
462 err = gpiochip_irqchip_add_nested(chip,
463 &mcp23s08_irq_chip,
465 handle_simple_irq,
466 IRQ_TYPE_NONE);
467 if (err) {
468 dev_err(chip->parent,
469 "could not connect irqchip to gpiochip: %d\n", err);
470 return err;
473 gpiochip_set_nested_irqchip(chip,
474 &mcp23s08_irq_chip,
475 mcp->irq);
477 return 0;
480 /*----------------------------------------------------------------------*/
482 #ifdef CONFIG_DEBUG_FS
484 #include <linux/seq_file.h>
487 * This shows more info than the generic gpio dump code:
488 * pullups, deglitching, open drain drive.
490 static void mcp23s08_dbg_show(struct seq_file *s, struct gpio_chip *chip)
492 struct mcp23s08 *mcp;
493 char bank;
494 int t;
495 unsigned mask;
497 mcp = gpiochip_get_data(chip);
499 /* NOTE: we only handle one bank for now ... */
500 bank = '0' + ((mcp->addr >> 1) & 0x7);
502 mutex_lock(&mcp->lock);
503 t = mcp_update_cache(mcp);
504 if (t < 0) {
505 seq_printf(s, " I/O ERROR %d\n", t);
506 goto done;
509 for (t = 0, mask = 1; t < chip->ngpio; t++, mask <<= 1) {
510 const char *label;
512 label = gpiochip_is_requested(chip, t);
513 if (!label)
514 continue;
516 seq_printf(s, " gpio-%-3d P%c.%d (%-12s) %s %s %s",
517 chip->base + t, bank, t, label,
518 (mcp->cache[MCP_IODIR] & mask) ? "in " : "out",
519 (mcp->cache[MCP_GPIO] & mask) ? "hi" : "lo",
520 (mcp->cache[MCP_GPPU] & mask) ? "up" : " ");
521 /* NOTE: ignoring the irq-related registers */
522 seq_puts(s, "\n");
524 done:
525 mutex_unlock(&mcp->lock);
528 #else
529 #define mcp23s08_dbg_show NULL
530 #endif
532 /*----------------------------------------------------------------------*/
534 static int mcp23s08_probe_one(struct mcp23s08 *mcp, struct device *dev,
535 void *data, unsigned addr, unsigned type,
536 struct mcp23s08_platform_data *pdata, int cs)
538 int status, ret;
539 bool mirror = false;
541 mutex_init(&mcp->lock);
543 mcp->dev = dev;
544 mcp->addr = addr;
545 mcp->irq_active_high = false;
547 mcp->chip.direction_input = mcp23s08_direction_input;
548 mcp->chip.get = mcp23s08_get;
549 mcp->chip.direction_output = mcp23s08_direction_output;
550 mcp->chip.set = mcp23s08_set;
551 mcp->chip.dbg_show = mcp23s08_dbg_show;
552 #ifdef CONFIG_OF_GPIO
553 mcp->chip.of_gpio_n_cells = 2;
554 mcp->chip.of_node = dev->of_node;
555 #endif
557 switch (type) {
558 #ifdef CONFIG_SPI_MASTER
559 case MCP_TYPE_S08:
560 mcp->regmap = devm_regmap_init(dev, &mcp23sxx_spi_regmap, mcp,
561 &mcp23x08_regmap);
562 mcp->reg_shift = 0;
563 mcp->chip.ngpio = 8;
564 mcp->chip.label = "mcp23s08";
565 break;
567 case MCP_TYPE_S17:
568 mcp->regmap = devm_regmap_init(dev, &mcp23sxx_spi_regmap, mcp,
569 &mcp23x17_regmap);
570 mcp->reg_shift = 1;
571 mcp->chip.ngpio = 16;
572 mcp->chip.label = "mcp23s17";
573 break;
575 case MCP_TYPE_S18:
576 mcp->regmap = devm_regmap_init(dev, &mcp23sxx_spi_regmap, mcp,
577 &mcp23x17_regmap);
578 mcp->reg_shift = 1;
579 mcp->chip.ngpio = 16;
580 mcp->chip.label = "mcp23s18";
581 break;
582 #endif /* CONFIG_SPI_MASTER */
584 #if IS_ENABLED(CONFIG_I2C)
585 case MCP_TYPE_008:
586 mcp->regmap = devm_regmap_init_i2c(data, &mcp23x08_regmap);
587 mcp->reg_shift = 0;
588 mcp->chip.ngpio = 8;
589 mcp->chip.label = "mcp23008";
590 break;
592 case MCP_TYPE_017:
593 mcp->regmap = devm_regmap_init_i2c(data, &mcp23x17_regmap);
594 mcp->reg_shift = 1;
595 mcp->chip.ngpio = 16;
596 mcp->chip.label = "mcp23017";
597 break;
598 #endif /* CONFIG_I2C */
600 default:
601 dev_err(dev, "invalid device type (%d)\n", type);
602 return -EINVAL;
605 if (IS_ERR(mcp->regmap))
606 return PTR_ERR(mcp->regmap);
608 mcp->chip.base = pdata->base;
609 mcp->chip.can_sleep = true;
610 mcp->chip.parent = dev;
611 mcp->chip.owner = THIS_MODULE;
613 /* verify MCP_IOCON.SEQOP = 0, so sequential reads work,
614 * and MCP_IOCON.HAEN = 1, so we work with all chips.
617 ret = mcp_read(mcp, MCP_IOCON, &status);
618 if (ret < 0)
619 goto fail;
621 mcp->irq_controller = pdata->irq_controller;
622 if (mcp->irq && mcp->irq_controller) {
623 mcp->irq_active_high =
624 of_property_read_bool(mcp->chip.parent->of_node,
625 "microchip,irq-active-high");
627 mirror = pdata->mirror;
630 if ((status & IOCON_SEQOP) || !(status & IOCON_HAEN) || mirror ||
631 mcp->irq_active_high) {
632 /* mcp23s17 has IOCON twice, make sure they are in sync */
633 status &= ~(IOCON_SEQOP | (IOCON_SEQOP << 8));
634 status |= IOCON_HAEN | (IOCON_HAEN << 8);
635 if (mcp->irq_active_high)
636 status |= IOCON_INTPOL | (IOCON_INTPOL << 8);
637 else
638 status &= ~(IOCON_INTPOL | (IOCON_INTPOL << 8));
640 if (mirror)
641 status |= IOCON_MIRROR | (IOCON_MIRROR << 8);
643 if (type == MCP_TYPE_S18)
644 status |= IOCON_INTCC | (IOCON_INTCC << 8);
646 ret = mcp_write(mcp, MCP_IOCON, status);
647 if (ret < 0)
648 goto fail;
651 /* configure ~100K pullups */
652 ret = mcp_write(mcp, MCP_GPPU, pdata->chip[cs].pullups);
653 if (ret < 0)
654 goto fail;
656 ret = mcp_update_cache(mcp);
657 if (ret < 0)
658 goto fail;
660 /* disable inverter on input */
661 if (mcp->cache[MCP_IPOL] != 0) {
662 mcp->cache[MCP_IPOL] = 0;
663 ret = mcp_write(mcp, MCP_IPOL, 0);
664 if (ret < 0)
665 goto fail;
668 /* disable irqs */
669 if (mcp->cache[MCP_GPINTEN] != 0) {
670 mcp->cache[MCP_GPINTEN] = 0;
671 ret = mcp_write(mcp, MCP_GPINTEN, 0);
672 if (ret < 0)
673 goto fail;
676 ret = gpiochip_add_data(&mcp->chip, mcp);
677 if (ret < 0)
678 goto fail;
680 if (mcp->irq && mcp->irq_controller) {
681 ret = mcp23s08_irq_setup(mcp);
682 if (ret)
683 goto fail;
685 fail:
686 if (ret < 0)
687 dev_dbg(dev, "can't setup chip %d, --> %d\n", addr, ret);
688 return ret;
691 /*----------------------------------------------------------------------*/
693 #ifdef CONFIG_OF
694 #ifdef CONFIG_SPI_MASTER
695 static const struct of_device_id mcp23s08_spi_of_match[] = {
697 .compatible = "microchip,mcp23s08",
698 .data = (void *) MCP_TYPE_S08,
701 .compatible = "microchip,mcp23s17",
702 .data = (void *) MCP_TYPE_S17,
705 .compatible = "microchip,mcp23s18",
706 .data = (void *) MCP_TYPE_S18,
708 /* NOTE: The use of the mcp prefix is deprecated and will be removed. */
710 .compatible = "mcp,mcp23s08",
711 .data = (void *) MCP_TYPE_S08,
714 .compatible = "mcp,mcp23s17",
715 .data = (void *) MCP_TYPE_S17,
717 { },
719 MODULE_DEVICE_TABLE(of, mcp23s08_spi_of_match);
720 #endif
722 #if IS_ENABLED(CONFIG_I2C)
723 static const struct of_device_id mcp23s08_i2c_of_match[] = {
725 .compatible = "microchip,mcp23008",
726 .data = (void *) MCP_TYPE_008,
729 .compatible = "microchip,mcp23017",
730 .data = (void *) MCP_TYPE_017,
732 /* NOTE: The use of the mcp prefix is deprecated and will be removed. */
734 .compatible = "mcp,mcp23008",
735 .data = (void *) MCP_TYPE_008,
738 .compatible = "mcp,mcp23017",
739 .data = (void *) MCP_TYPE_017,
741 { },
743 MODULE_DEVICE_TABLE(of, mcp23s08_i2c_of_match);
744 #endif
745 #endif /* CONFIG_OF */
748 #if IS_ENABLED(CONFIG_I2C)
750 static int mcp230xx_probe(struct i2c_client *client,
751 const struct i2c_device_id *id)
753 struct mcp23s08_platform_data *pdata, local_pdata;
754 struct mcp23s08 *mcp;
755 int status;
756 const struct of_device_id *match;
758 match = of_match_device(of_match_ptr(mcp23s08_i2c_of_match),
759 &client->dev);
760 if (match) {
761 pdata = &local_pdata;
762 pdata->base = -1;
763 pdata->chip[0].pullups = 0;
764 pdata->irq_controller = of_property_read_bool(
765 client->dev.of_node,
766 "interrupt-controller");
767 pdata->mirror = of_property_read_bool(client->dev.of_node,
768 "microchip,irq-mirror");
769 client->irq = irq_of_parse_and_map(client->dev.of_node, 0);
770 } else {
771 pdata = dev_get_platdata(&client->dev);
772 if (!pdata) {
773 pdata = devm_kzalloc(&client->dev,
774 sizeof(struct mcp23s08_platform_data),
775 GFP_KERNEL);
776 if (!pdata)
777 return -ENOMEM;
778 pdata->base = -1;
782 mcp = kzalloc(sizeof(*mcp), GFP_KERNEL);
783 if (!mcp)
784 return -ENOMEM;
786 mcp->irq = client->irq;
787 status = mcp23s08_probe_one(mcp, &client->dev, client, client->addr,
788 id->driver_data, pdata, 0);
789 if (status)
790 goto fail;
792 i2c_set_clientdata(client, mcp);
794 return 0;
796 fail:
797 kfree(mcp);
799 return status;
802 static int mcp230xx_remove(struct i2c_client *client)
804 struct mcp23s08 *mcp = i2c_get_clientdata(client);
806 gpiochip_remove(&mcp->chip);
807 kfree(mcp);
809 return 0;
812 static const struct i2c_device_id mcp230xx_id[] = {
813 { "mcp23008", MCP_TYPE_008 },
814 { "mcp23017", MCP_TYPE_017 },
815 { },
817 MODULE_DEVICE_TABLE(i2c, mcp230xx_id);
819 static struct i2c_driver mcp230xx_driver = {
820 .driver = {
821 .name = "mcp230xx",
822 .of_match_table = of_match_ptr(mcp23s08_i2c_of_match),
824 .probe = mcp230xx_probe,
825 .remove = mcp230xx_remove,
826 .id_table = mcp230xx_id,
829 static int __init mcp23s08_i2c_init(void)
831 return i2c_add_driver(&mcp230xx_driver);
834 static void mcp23s08_i2c_exit(void)
836 i2c_del_driver(&mcp230xx_driver);
839 #else
841 static int __init mcp23s08_i2c_init(void) { return 0; }
842 static void mcp23s08_i2c_exit(void) { }
844 #endif /* CONFIG_I2C */
846 /*----------------------------------------------------------------------*/
848 #ifdef CONFIG_SPI_MASTER
850 static int mcp23s08_probe(struct spi_device *spi)
852 struct mcp23s08_platform_data *pdata, local_pdata;
853 unsigned addr;
854 int chips = 0;
855 struct mcp23s08_driver_data *data;
856 int status, type;
857 unsigned ngpio = 0;
858 const struct of_device_id *match;
859 u32 spi_present_mask = 0;
861 match = of_match_device(of_match_ptr(mcp23s08_spi_of_match), &spi->dev);
862 if (match) {
863 type = (int)(uintptr_t)match->data;
864 status = of_property_read_u32(spi->dev.of_node,
865 "microchip,spi-present-mask", &spi_present_mask);
866 if (status) {
867 status = of_property_read_u32(spi->dev.of_node,
868 "mcp,spi-present-mask", &spi_present_mask);
869 if (status) {
870 dev_err(&spi->dev,
871 "DT has no spi-present-mask\n");
872 return -ENODEV;
875 if ((spi_present_mask <= 0) || (spi_present_mask >= 256)) {
876 dev_err(&spi->dev, "invalid spi-present-mask\n");
877 return -ENODEV;
880 pdata = &local_pdata;
881 pdata->base = -1;
882 for (addr = 0; addr < ARRAY_SIZE(pdata->chip); addr++) {
883 pdata->chip[addr].pullups = 0;
884 if (spi_present_mask & (1 << addr))
885 chips++;
887 pdata->irq_controller = of_property_read_bool(
888 spi->dev.of_node,
889 "interrupt-controller");
890 pdata->mirror = of_property_read_bool(spi->dev.of_node,
891 "microchip,irq-mirror");
892 } else {
893 type = spi_get_device_id(spi)->driver_data;
894 pdata = dev_get_platdata(&spi->dev);
895 if (!pdata) {
896 pdata = devm_kzalloc(&spi->dev,
897 sizeof(struct mcp23s08_platform_data),
898 GFP_KERNEL);
899 pdata->base = -1;
902 for (addr = 0; addr < ARRAY_SIZE(pdata->chip); addr++) {
903 if (!pdata->chip[addr].is_present)
904 continue;
905 chips++;
906 if ((type == MCP_TYPE_S08) && (addr > 3)) {
907 dev_err(&spi->dev,
908 "mcp23s08 only supports address 0..3\n");
909 return -EINVAL;
911 spi_present_mask |= 1 << addr;
915 if (!chips)
916 return -ENODEV;
918 data = devm_kzalloc(&spi->dev,
919 sizeof(*data) + chips * sizeof(struct mcp23s08),
920 GFP_KERNEL);
921 if (!data)
922 return -ENOMEM;
924 spi_set_drvdata(spi, data);
926 spi->irq = irq_of_parse_and_map(spi->dev.of_node, 0);
928 for (addr = 0; addr < ARRAY_SIZE(pdata->chip); addr++) {
929 if (!(spi_present_mask & (1 << addr)))
930 continue;
931 chips--;
932 data->mcp[addr] = &data->chip[chips];
933 data->mcp[addr]->irq = spi->irq;
934 status = mcp23s08_probe_one(data->mcp[addr], &spi->dev, spi,
935 0x40 | (addr << 1), type, pdata,
936 addr);
937 if (status < 0)
938 goto fail;
940 if (pdata->base != -1)
941 pdata->base += data->mcp[addr]->chip.ngpio;
942 ngpio += data->mcp[addr]->chip.ngpio;
944 data->ngpio = ngpio;
946 /* NOTE: these chips have a relatively sane IRQ framework, with
947 * per-signal masking and level/edge triggering. It's not yet
948 * handled here...
951 return 0;
953 fail:
954 for (addr = 0; addr < ARRAY_SIZE(data->mcp); addr++) {
956 if (!data->mcp[addr])
957 continue;
958 gpiochip_remove(&data->mcp[addr]->chip);
960 return status;
963 static int mcp23s08_remove(struct spi_device *spi)
965 struct mcp23s08_driver_data *data = spi_get_drvdata(spi);
966 unsigned addr;
968 for (addr = 0; addr < ARRAY_SIZE(data->mcp); addr++) {
970 if (!data->mcp[addr])
971 continue;
973 gpiochip_remove(&data->mcp[addr]->chip);
976 return 0;
979 static const struct spi_device_id mcp23s08_ids[] = {
980 { "mcp23s08", MCP_TYPE_S08 },
981 { "mcp23s17", MCP_TYPE_S17 },
982 { "mcp23s18", MCP_TYPE_S18 },
983 { },
985 MODULE_DEVICE_TABLE(spi, mcp23s08_ids);
987 static struct spi_driver mcp23s08_driver = {
988 .probe = mcp23s08_probe,
989 .remove = mcp23s08_remove,
990 .id_table = mcp23s08_ids,
991 .driver = {
992 .name = "mcp23s08",
993 .of_match_table = of_match_ptr(mcp23s08_spi_of_match),
997 static int __init mcp23s08_spi_init(void)
999 return spi_register_driver(&mcp23s08_driver);
1002 static void mcp23s08_spi_exit(void)
1004 spi_unregister_driver(&mcp23s08_driver);
1007 #else
1009 static int __init mcp23s08_spi_init(void) { return 0; }
1010 static void mcp23s08_spi_exit(void) { }
1012 #endif /* CONFIG_SPI_MASTER */
1014 /*----------------------------------------------------------------------*/
1016 static int __init mcp23s08_init(void)
1018 int ret;
1020 ret = mcp23s08_spi_init();
1021 if (ret)
1022 goto spi_fail;
1024 ret = mcp23s08_i2c_init();
1025 if (ret)
1026 goto i2c_fail;
1028 return 0;
1030 i2c_fail:
1031 mcp23s08_spi_exit();
1032 spi_fail:
1033 return ret;
1035 /* register after spi/i2c postcore initcall and before
1036 * subsys initcalls that may rely on these GPIOs
1038 subsys_initcall(mcp23s08_init);
1040 static void __exit mcp23s08_exit(void)
1042 mcp23s08_spi_exit();
1043 mcp23s08_i2c_exit();
1045 module_exit(mcp23s08_exit);
1047 MODULE_LICENSE("GPL");