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