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