Loading...
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/irq.h>
19#include <linux/irqdomain.h>
20#include <linux/i2c.h>
21#include <linux/platform_data/pca953x.h>
22#include <linux/slab.h>
23#ifdef CONFIG_OF_GPIO
24#include <linux/of_platform.h>
25#endif
26
27#define PCA953X_INPUT 0
28#define PCA953X_OUTPUT 1
29#define PCA953X_INVERT 2
30#define PCA953X_DIRECTION 3
31
32#define REG_ADDR_AI 0x80
33
34#define PCA957X_IN 0
35#define PCA957X_INVRT 1
36#define PCA957X_BKEN 2
37#define PCA957X_PUPD 3
38#define PCA957X_CFG 4
39#define PCA957X_OUT 5
40#define PCA957X_MSK 6
41#define PCA957X_INTS 7
42
43#define PCA_GPIO_MASK 0x00FF
44#define PCA_INT 0x0100
45#define PCA953X_TYPE 0x1000
46#define PCA957X_TYPE 0x2000
47
48static const struct i2c_device_id pca953x_id[] = {
49 { "pca9505", 40 | PCA953X_TYPE | PCA_INT, },
50 { "pca9534", 8 | PCA953X_TYPE | PCA_INT, },
51 { "pca9535", 16 | PCA953X_TYPE | PCA_INT, },
52 { "pca9536", 4 | PCA953X_TYPE, },
53 { "pca9537", 4 | PCA953X_TYPE | PCA_INT, },
54 { "pca9538", 8 | PCA953X_TYPE | PCA_INT, },
55 { "pca9539", 16 | PCA953X_TYPE | PCA_INT, },
56 { "pca9554", 8 | PCA953X_TYPE | PCA_INT, },
57 { "pca9555", 16 | PCA953X_TYPE | PCA_INT, },
58 { "pca9556", 8 | PCA953X_TYPE, },
59 { "pca9557", 8 | PCA953X_TYPE, },
60 { "pca9574", 8 | PCA957X_TYPE | PCA_INT, },
61 { "pca9575", 16 | PCA957X_TYPE | PCA_INT, },
62 { "pca9698", 40 | PCA953X_TYPE, },
63
64 { "max7310", 8 | PCA953X_TYPE, },
65 { "max7312", 16 | PCA953X_TYPE | PCA_INT, },
66 { "max7313", 16 | PCA953X_TYPE | PCA_INT, },
67 { "max7315", 8 | PCA953X_TYPE | PCA_INT, },
68 { "pca6107", 8 | PCA953X_TYPE | PCA_INT, },
69 { "tca6408", 8 | PCA953X_TYPE | PCA_INT, },
70 { "tca6416", 16 | PCA953X_TYPE | PCA_INT, },
71 { "tca6424", 24 | PCA953X_TYPE | PCA_INT, },
72 { "xra1202", 8 | PCA953X_TYPE },
73 { }
74};
75MODULE_DEVICE_TABLE(i2c, pca953x_id);
76
77#define MAX_BANK 5
78#define BANK_SZ 8
79
80#define NBANK(chip) (chip->gpio_chip.ngpio / BANK_SZ)
81
82struct pca953x_chip {
83 unsigned gpio_start;
84 u8 reg_output[MAX_BANK];
85 u8 reg_direction[MAX_BANK];
86 struct mutex i2c_lock;
87
88#ifdef CONFIG_GPIO_PCA953X_IRQ
89 struct mutex irq_lock;
90 u8 irq_mask[MAX_BANK];
91 u8 irq_stat[MAX_BANK];
92 u8 irq_trig_raise[MAX_BANK];
93 u8 irq_trig_fall[MAX_BANK];
94 struct irq_domain *domain;
95#endif
96
97 struct i2c_client *client;
98 struct gpio_chip gpio_chip;
99 const char *const *names;
100 int chip_type;
101};
102
103static int pca953x_read_single(struct pca953x_chip *chip, int reg, u32 *val,
104 int off)
105{
106 int ret;
107 int bank_shift = fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
108 int offset = off / BANK_SZ;
109
110 ret = i2c_smbus_read_byte_data(chip->client,
111 (reg << bank_shift) + offset);
112 *val = ret;
113
114 if (ret < 0) {
115 dev_err(&chip->client->dev, "failed reading register\n");
116 return ret;
117 }
118
119 return 0;
120}
121
122static int pca953x_write_single(struct pca953x_chip *chip, int reg, u32 val,
123 int off)
124{
125 int ret = 0;
126 int bank_shift = fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
127 int offset = off / BANK_SZ;
128
129 ret = i2c_smbus_write_byte_data(chip->client,
130 (reg << bank_shift) + offset, val);
131
132 if (ret < 0) {
133 dev_err(&chip->client->dev, "failed writing register\n");
134 return ret;
135 }
136
137 return 0;
138}
139
140static int pca953x_write_regs(struct pca953x_chip *chip, int reg, u8 *val)
141{
142 int ret = 0;
143
144 if (chip->gpio_chip.ngpio <= 8)
145 ret = i2c_smbus_write_byte_data(chip->client, reg, *val);
146 else if (chip->gpio_chip.ngpio >= 24) {
147 int bank_shift = fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
148 ret = i2c_smbus_write_i2c_block_data(chip->client,
149 (reg << bank_shift) | REG_ADDR_AI,
150 NBANK(chip), val);
151 } else {
152 switch (chip->chip_type) {
153 case PCA953X_TYPE:
154 ret = i2c_smbus_write_word_data(chip->client,
155 reg << 1, (u16) *val);
156 break;
157 case PCA957X_TYPE:
158 ret = i2c_smbus_write_byte_data(chip->client, reg << 1,
159 val[0]);
160 if (ret < 0)
161 break;
162 ret = i2c_smbus_write_byte_data(chip->client,
163 (reg << 1) + 1,
164 val[1]);
165 break;
166 }
167 }
168
169 if (ret < 0) {
170 dev_err(&chip->client->dev, "failed writing register\n");
171 return ret;
172 }
173
174 return 0;
175}
176
177static int pca953x_read_regs(struct pca953x_chip *chip, int reg, u8 *val)
178{
179 int ret;
180
181 if (chip->gpio_chip.ngpio <= 8) {
182 ret = i2c_smbus_read_byte_data(chip->client, reg);
183 *val = ret;
184 } else if (chip->gpio_chip.ngpio >= 24) {
185 int bank_shift = fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
186
187 ret = i2c_smbus_read_i2c_block_data(chip->client,
188 (reg << bank_shift) | REG_ADDR_AI,
189 NBANK(chip), val);
190 } else {
191 ret = i2c_smbus_read_word_data(chip->client, reg << 1);
192 val[0] = (u16)ret & 0xFF;
193 val[1] = (u16)ret >> 8;
194 }
195 if (ret < 0) {
196 dev_err(&chip->client->dev, "failed reading register\n");
197 return ret;
198 }
199
200 return 0;
201}
202
203static int pca953x_gpio_direction_input(struct gpio_chip *gc, unsigned off)
204{
205 struct pca953x_chip *chip;
206 u8 reg_val;
207 int ret, offset = 0;
208
209 chip = container_of(gc, struct pca953x_chip, gpio_chip);
210
211 mutex_lock(&chip->i2c_lock);
212 reg_val = chip->reg_direction[off / BANK_SZ] | (1u << (off % BANK_SZ));
213
214 switch (chip->chip_type) {
215 case PCA953X_TYPE:
216 offset = PCA953X_DIRECTION;
217 break;
218 case PCA957X_TYPE:
219 offset = PCA957X_CFG;
220 break;
221 }
222 ret = pca953x_write_single(chip, offset, reg_val, off);
223 if (ret)
224 goto exit;
225
226 chip->reg_direction[off / BANK_SZ] = reg_val;
227 ret = 0;
228exit:
229 mutex_unlock(&chip->i2c_lock);
230 return ret;
231}
232
233static int pca953x_gpio_direction_output(struct gpio_chip *gc,
234 unsigned off, int val)
235{
236 struct pca953x_chip *chip;
237 u8 reg_val;
238 int ret, offset = 0;
239
240 chip = container_of(gc, struct pca953x_chip, gpio_chip);
241
242 mutex_lock(&chip->i2c_lock);
243 /* set output level */
244 if (val)
245 reg_val = chip->reg_output[off / BANK_SZ]
246 | (1u << (off % BANK_SZ));
247 else
248 reg_val = chip->reg_output[off / BANK_SZ]
249 & ~(1u << (off % BANK_SZ));
250
251 switch (chip->chip_type) {
252 case PCA953X_TYPE:
253 offset = PCA953X_OUTPUT;
254 break;
255 case PCA957X_TYPE:
256 offset = PCA957X_OUT;
257 break;
258 }
259 ret = pca953x_write_single(chip, offset, reg_val, off);
260 if (ret)
261 goto exit;
262
263 chip->reg_output[off / BANK_SZ] = reg_val;
264
265 /* then direction */
266 reg_val = chip->reg_direction[off / BANK_SZ] & ~(1u << (off % BANK_SZ));
267 switch (chip->chip_type) {
268 case PCA953X_TYPE:
269 offset = PCA953X_DIRECTION;
270 break;
271 case PCA957X_TYPE:
272 offset = PCA957X_CFG;
273 break;
274 }
275 ret = pca953x_write_single(chip, offset, reg_val, off);
276 if (ret)
277 goto exit;
278
279 chip->reg_direction[off / BANK_SZ] = reg_val;
280 ret = 0;
281exit:
282 mutex_unlock(&chip->i2c_lock);
283 return ret;
284}
285
286static int pca953x_gpio_get_value(struct gpio_chip *gc, unsigned off)
287{
288 struct pca953x_chip *chip;
289 u32 reg_val;
290 int ret, offset = 0;
291
292 chip = container_of(gc, struct pca953x_chip, gpio_chip);
293
294 mutex_lock(&chip->i2c_lock);
295 switch (chip->chip_type) {
296 case PCA953X_TYPE:
297 offset = PCA953X_INPUT;
298 break;
299 case PCA957X_TYPE:
300 offset = PCA957X_IN;
301 break;
302 }
303 ret = pca953x_read_single(chip, offset, ®_val, off);
304 mutex_unlock(&chip->i2c_lock);
305 if (ret < 0) {
306 /* NOTE: diagnostic already emitted; that's all we should
307 * do unless gpio_*_value_cansleep() calls become different
308 * from their nonsleeping siblings (and report faults).
309 */
310 return 0;
311 }
312
313 return (reg_val & (1u << (off % BANK_SZ))) ? 1 : 0;
314}
315
316static void pca953x_gpio_set_value(struct gpio_chip *gc, unsigned off, int val)
317{
318 struct pca953x_chip *chip;
319 u8 reg_val;
320 int ret, offset = 0;
321
322 chip = container_of(gc, struct pca953x_chip, gpio_chip);
323
324 mutex_lock(&chip->i2c_lock);
325 if (val)
326 reg_val = chip->reg_output[off / BANK_SZ]
327 | (1u << (off % BANK_SZ));
328 else
329 reg_val = chip->reg_output[off / BANK_SZ]
330 & ~(1u << (off % BANK_SZ));
331
332 switch (chip->chip_type) {
333 case PCA953X_TYPE:
334 offset = PCA953X_OUTPUT;
335 break;
336 case PCA957X_TYPE:
337 offset = PCA957X_OUT;
338 break;
339 }
340 ret = pca953x_write_single(chip, offset, reg_val, off);
341 if (ret)
342 goto exit;
343
344 chip->reg_output[off / BANK_SZ] = reg_val;
345exit:
346 mutex_unlock(&chip->i2c_lock);
347}
348
349static void pca953x_setup_gpio(struct pca953x_chip *chip, int gpios)
350{
351 struct gpio_chip *gc;
352
353 gc = &chip->gpio_chip;
354
355 gc->direction_input = pca953x_gpio_direction_input;
356 gc->direction_output = pca953x_gpio_direction_output;
357 gc->get = pca953x_gpio_get_value;
358 gc->set = pca953x_gpio_set_value;
359 gc->can_sleep = true;
360
361 gc->base = chip->gpio_start;
362 gc->ngpio = gpios;
363 gc->label = chip->client->name;
364 gc->dev = &chip->client->dev;
365 gc->owner = THIS_MODULE;
366 gc->names = chip->names;
367}
368
369#ifdef CONFIG_GPIO_PCA953X_IRQ
370static int pca953x_gpio_to_irq(struct gpio_chip *gc, unsigned off)
371{
372 struct pca953x_chip *chip;
373
374 chip = container_of(gc, struct pca953x_chip, gpio_chip);
375 return irq_create_mapping(chip->domain, off);
376}
377
378static void pca953x_irq_mask(struct irq_data *d)
379{
380 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
381
382 chip->irq_mask[d->hwirq / BANK_SZ] &= ~(1 << (d->hwirq % BANK_SZ));
383}
384
385static void pca953x_irq_unmask(struct irq_data *d)
386{
387 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
388
389 chip->irq_mask[d->hwirq / BANK_SZ] |= 1 << (d->hwirq % BANK_SZ);
390}
391
392static void pca953x_irq_bus_lock(struct irq_data *d)
393{
394 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
395
396 mutex_lock(&chip->irq_lock);
397}
398
399static void pca953x_irq_bus_sync_unlock(struct irq_data *d)
400{
401 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
402 u8 new_irqs;
403 int level, i;
404
405 /* Look for any newly setup interrupt */
406 for (i = 0; i < NBANK(chip); i++) {
407 new_irqs = chip->irq_trig_fall[i] | chip->irq_trig_raise[i];
408 new_irqs &= ~chip->reg_direction[i];
409
410 while (new_irqs) {
411 level = __ffs(new_irqs);
412 pca953x_gpio_direction_input(&chip->gpio_chip,
413 level + (BANK_SZ * i));
414 new_irqs &= ~(1 << level);
415 }
416 }
417
418 mutex_unlock(&chip->irq_lock);
419}
420
421static int pca953x_irq_set_type(struct irq_data *d, unsigned int type)
422{
423 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
424 int bank_nb = d->hwirq / BANK_SZ;
425 u8 mask = 1 << (d->hwirq % BANK_SZ);
426
427 if (!(type & IRQ_TYPE_EDGE_BOTH)) {
428 dev_err(&chip->client->dev, "irq %d: unsupported type %d\n",
429 d->irq, type);
430 return -EINVAL;
431 }
432
433 if (type & IRQ_TYPE_EDGE_FALLING)
434 chip->irq_trig_fall[bank_nb] |= mask;
435 else
436 chip->irq_trig_fall[bank_nb] &= ~mask;
437
438 if (type & IRQ_TYPE_EDGE_RISING)
439 chip->irq_trig_raise[bank_nb] |= mask;
440 else
441 chip->irq_trig_raise[bank_nb] &= ~mask;
442
443 return 0;
444}
445
446static struct irq_chip pca953x_irq_chip = {
447 .name = "pca953x",
448 .irq_mask = pca953x_irq_mask,
449 .irq_unmask = pca953x_irq_unmask,
450 .irq_bus_lock = pca953x_irq_bus_lock,
451 .irq_bus_sync_unlock = pca953x_irq_bus_sync_unlock,
452 .irq_set_type = pca953x_irq_set_type,
453};
454
455static u8 pca953x_irq_pending(struct pca953x_chip *chip, u8 *pending)
456{
457 u8 cur_stat[MAX_BANK];
458 u8 old_stat[MAX_BANK];
459 u8 pendings = 0;
460 u8 trigger[MAX_BANK], triggers = 0;
461 int ret, i, offset = 0;
462
463 switch (chip->chip_type) {
464 case PCA953X_TYPE:
465 offset = PCA953X_INPUT;
466 break;
467 case PCA957X_TYPE:
468 offset = PCA957X_IN;
469 break;
470 }
471 ret = pca953x_read_regs(chip, offset, cur_stat);
472 if (ret)
473 return 0;
474
475 /* Remove output pins from the equation */
476 for (i = 0; i < NBANK(chip); i++)
477 cur_stat[i] &= chip->reg_direction[i];
478
479 memcpy(old_stat, chip->irq_stat, NBANK(chip));
480
481 for (i = 0; i < NBANK(chip); i++) {
482 trigger[i] = (cur_stat[i] ^ old_stat[i]) & chip->irq_mask[i];
483 triggers += trigger[i];
484 }
485
486 if (!triggers)
487 return 0;
488
489 memcpy(chip->irq_stat, cur_stat, NBANK(chip));
490
491 for (i = 0; i < NBANK(chip); i++) {
492 pending[i] = (old_stat[i] & chip->irq_trig_fall[i]) |
493 (cur_stat[i] & chip->irq_trig_raise[i]);
494 pending[i] &= trigger[i];
495 pendings += pending[i];
496 }
497
498 return pendings;
499}
500
501static irqreturn_t pca953x_irq_handler(int irq, void *devid)
502{
503 struct pca953x_chip *chip = devid;
504 u8 pending[MAX_BANK];
505 u8 level;
506 int i;
507
508 if (!pca953x_irq_pending(chip, pending))
509 return IRQ_HANDLED;
510
511 for (i = 0; i < NBANK(chip); i++) {
512 while (pending[i]) {
513 level = __ffs(pending[i]);
514 handle_nested_irq(irq_find_mapping(chip->domain,
515 level + (BANK_SZ * i)));
516 pending[i] &= ~(1 << level);
517 }
518 }
519
520 return IRQ_HANDLED;
521}
522
523static int pca953x_gpio_irq_map(struct irq_domain *d, unsigned int irq,
524 irq_hw_number_t hwirq)
525{
526 irq_clear_status_flags(irq, IRQ_NOREQUEST);
527 irq_set_chip_data(irq, d->host_data);
528 irq_set_chip(irq, &pca953x_irq_chip);
529 irq_set_nested_thread(irq, true);
530#ifdef CONFIG_ARM
531 set_irq_flags(irq, IRQF_VALID);
532#else
533 irq_set_noprobe(irq);
534#endif
535
536 return 0;
537}
538
539static const struct irq_domain_ops pca953x_irq_simple_ops = {
540 .map = pca953x_gpio_irq_map,
541 .xlate = irq_domain_xlate_twocell,
542};
543
544static int pca953x_irq_setup(struct pca953x_chip *chip,
545 const struct i2c_device_id *id,
546 int irq_base)
547{
548 struct i2c_client *client = chip->client;
549 int ret, i, offset = 0;
550
551 if (irq_base != -1
552 && (id->driver_data & PCA_INT)) {
553
554 switch (chip->chip_type) {
555 case PCA953X_TYPE:
556 offset = PCA953X_INPUT;
557 break;
558 case PCA957X_TYPE:
559 offset = PCA957X_IN;
560 break;
561 }
562 ret = pca953x_read_regs(chip, offset, chip->irq_stat);
563 if (ret)
564 return ret;
565
566 /*
567 * There is no way to know which GPIO line generated the
568 * interrupt. We have to rely on the previous read for
569 * this purpose.
570 */
571 for (i = 0; i < NBANK(chip); i++)
572 chip->irq_stat[i] &= chip->reg_direction[i];
573 mutex_init(&chip->irq_lock);
574
575 chip->domain = irq_domain_add_simple(client->dev.of_node,
576 chip->gpio_chip.ngpio,
577 irq_base,
578 &pca953x_irq_simple_ops,
579 chip);
580 if (!chip->domain)
581 return -ENODEV;
582
583 ret = devm_request_threaded_irq(&client->dev,
584 client->irq,
585 NULL,
586 pca953x_irq_handler,
587 IRQF_TRIGGER_LOW | IRQF_ONESHOT,
588 dev_name(&client->dev), chip);
589 if (ret) {
590 dev_err(&client->dev, "failed to request irq %d\n",
591 client->irq);
592 return ret;
593 }
594
595 chip->gpio_chip.to_irq = pca953x_gpio_to_irq;
596 }
597
598 return 0;
599}
600
601#else /* CONFIG_GPIO_PCA953X_IRQ */
602static int pca953x_irq_setup(struct pca953x_chip *chip,
603 const struct i2c_device_id *id,
604 int irq_base)
605{
606 struct i2c_client *client = chip->client;
607
608 if (irq_base != -1 && (id->driver_data & PCA_INT))
609 dev_warn(&client->dev, "interrupt support not compiled in\n");
610
611 return 0;
612}
613#endif
614
615/*
616 * Handlers for alternative sources of platform_data
617 */
618#ifdef CONFIG_OF_GPIO
619/*
620 * Translate OpenFirmware node properties into platform_data
621 * WARNING: This is DEPRECATED and will be removed eventually!
622 */
623static void
624pca953x_get_alt_pdata(struct i2c_client *client, int *gpio_base, u32 *invert)
625{
626 struct device_node *node;
627 const __be32 *val;
628 int size;
629
630 *gpio_base = -1;
631
632 node = client->dev.of_node;
633 if (node == NULL)
634 return;
635
636 val = of_get_property(node, "linux,gpio-base", &size);
637 WARN(val, "%s: device-tree property 'linux,gpio-base' is deprecated!", __func__);
638 if (val) {
639 if (size != sizeof(*val))
640 dev_warn(&client->dev, "%s: wrong linux,gpio-base\n",
641 node->full_name);
642 else
643 *gpio_base = be32_to_cpup(val);
644 }
645
646 val = of_get_property(node, "polarity", NULL);
647 WARN(val, "%s: device-tree property 'polarity' is deprecated!", __func__);
648 if (val)
649 *invert = *val;
650}
651#else
652static void
653pca953x_get_alt_pdata(struct i2c_client *client, int *gpio_base, u32 *invert)
654{
655 *gpio_base = -1;
656}
657#endif
658
659static int device_pca953x_init(struct pca953x_chip *chip, u32 invert)
660{
661 int ret;
662 u8 val[MAX_BANK];
663
664 ret = pca953x_read_regs(chip, PCA953X_OUTPUT, chip->reg_output);
665 if (ret)
666 goto out;
667
668 ret = pca953x_read_regs(chip, PCA953X_DIRECTION,
669 chip->reg_direction);
670 if (ret)
671 goto out;
672
673 /* set platform specific polarity inversion */
674 if (invert)
675 memset(val, 0xFF, NBANK(chip));
676 else
677 memset(val, 0, NBANK(chip));
678
679 ret = pca953x_write_regs(chip, PCA953X_INVERT, val);
680out:
681 return ret;
682}
683
684static int device_pca957x_init(struct pca953x_chip *chip, u32 invert)
685{
686 int ret;
687 u8 val[MAX_BANK];
688
689 ret = pca953x_read_regs(chip, PCA957X_OUT, chip->reg_output);
690 if (ret)
691 goto out;
692 ret = pca953x_read_regs(chip, PCA957X_CFG, chip->reg_direction);
693 if (ret)
694 goto out;
695
696 /* set platform specific polarity inversion */
697 if (invert)
698 memset(val, 0xFF, NBANK(chip));
699 else
700 memset(val, 0, NBANK(chip));
701 pca953x_write_regs(chip, PCA957X_INVRT, val);
702
703 /* To enable register 6, 7 to controll pull up and pull down */
704 memset(val, 0x02, NBANK(chip));
705 pca953x_write_regs(chip, PCA957X_BKEN, val);
706
707 return 0;
708out:
709 return ret;
710}
711
712static int pca953x_probe(struct i2c_client *client,
713 const struct i2c_device_id *id)
714{
715 struct pca953x_platform_data *pdata;
716 struct pca953x_chip *chip;
717 int irq_base = 0;
718 int ret;
719 u32 invert = 0;
720
721 chip = devm_kzalloc(&client->dev,
722 sizeof(struct pca953x_chip), GFP_KERNEL);
723 if (chip == NULL)
724 return -ENOMEM;
725
726 pdata = dev_get_platdata(&client->dev);
727 if (pdata) {
728 irq_base = pdata->irq_base;
729 chip->gpio_start = pdata->gpio_base;
730 invert = pdata->invert;
731 chip->names = pdata->names;
732 } else {
733 pca953x_get_alt_pdata(client, &chip->gpio_start, &invert);
734#ifdef CONFIG_OF_GPIO
735 /* If I2C node has no interrupts property, disable GPIO interrupts */
736 if (of_find_property(client->dev.of_node, "interrupts", NULL) == NULL)
737 irq_base = -1;
738#endif
739 }
740
741 chip->client = client;
742
743 chip->chip_type = id->driver_data & (PCA953X_TYPE | PCA957X_TYPE);
744
745 mutex_init(&chip->i2c_lock);
746
747 /* initialize cached registers from their original values.
748 * we can't share this chip with another i2c master.
749 */
750 pca953x_setup_gpio(chip, id->driver_data & PCA_GPIO_MASK);
751
752 if (chip->chip_type == PCA953X_TYPE)
753 ret = device_pca953x_init(chip, invert);
754 else
755 ret = device_pca957x_init(chip, invert);
756 if (ret)
757 return ret;
758
759 ret = pca953x_irq_setup(chip, id, irq_base);
760 if (ret)
761 return ret;
762
763 ret = gpiochip_add(&chip->gpio_chip);
764 if (ret)
765 return ret;
766
767 if (pdata && pdata->setup) {
768 ret = pdata->setup(client, chip->gpio_chip.base,
769 chip->gpio_chip.ngpio, pdata->context);
770 if (ret < 0)
771 dev_warn(&client->dev, "setup failed, %d\n", ret);
772 }
773
774 i2c_set_clientdata(client, chip);
775 return 0;
776}
777
778static int pca953x_remove(struct i2c_client *client)
779{
780 struct pca953x_platform_data *pdata = dev_get_platdata(&client->dev);
781 struct pca953x_chip *chip = i2c_get_clientdata(client);
782 int ret = 0;
783
784 if (pdata && pdata->teardown) {
785 ret = pdata->teardown(client, chip->gpio_chip.base,
786 chip->gpio_chip.ngpio, pdata->context);
787 if (ret < 0) {
788 dev_err(&client->dev, "%s failed, %d\n",
789 "teardown", ret);
790 return ret;
791 }
792 }
793
794 ret = gpiochip_remove(&chip->gpio_chip);
795 if (ret) {
796 dev_err(&client->dev, "%s failed, %d\n",
797 "gpiochip_remove()", ret);
798 return ret;
799 }
800
801 return 0;
802}
803
804static const struct of_device_id pca953x_dt_ids[] = {
805 { .compatible = "nxp,pca9505", },
806 { .compatible = "nxp,pca9534", },
807 { .compatible = "nxp,pca9535", },
808 { .compatible = "nxp,pca9536", },
809 { .compatible = "nxp,pca9537", },
810 { .compatible = "nxp,pca9538", },
811 { .compatible = "nxp,pca9539", },
812 { .compatible = "nxp,pca9554", },
813 { .compatible = "nxp,pca9555", },
814 { .compatible = "nxp,pca9556", },
815 { .compatible = "nxp,pca9557", },
816 { .compatible = "nxp,pca9574", },
817 { .compatible = "nxp,pca9575", },
818 { .compatible = "nxp,pca9698", },
819
820 { .compatible = "maxim,max7310", },
821 { .compatible = "maxim,max7312", },
822 { .compatible = "maxim,max7313", },
823 { .compatible = "maxim,max7315", },
824
825 { .compatible = "ti,pca6107", },
826 { .compatible = "ti,tca6408", },
827 { .compatible = "ti,tca6416", },
828 { .compatible = "ti,tca6424", },
829
830 { .compatible = "exar,xra1202", },
831 { }
832};
833
834MODULE_DEVICE_TABLE(of, pca953x_dt_ids);
835
836static struct i2c_driver pca953x_driver = {
837 .driver = {
838 .name = "pca953x",
839 .of_match_table = pca953x_dt_ids,
840 },
841 .probe = pca953x_probe,
842 .remove = pca953x_remove,
843 .id_table = pca953x_id,
844};
845
846static int __init pca953x_init(void)
847{
848 return i2c_add_driver(&pca953x_driver);
849}
850/* register after i2c postcore initcall and before
851 * subsys initcalls that may rely on these GPIOs
852 */
853subsys_initcall(pca953x_init);
854
855static void __exit pca953x_exit(void)
856{
857 i2c_del_driver(&pca953x_driver);
858}
859module_exit(pca953x_exit);
860
861MODULE_AUTHOR("eric miao <eric.miao@marvell.com>");
862MODULE_DESCRIPTION("GPIO expander driver for PCA953x");
863MODULE_LICENSE("GPL");
1// SPDX-License-Identifier: GPL-2.0-only
2/*
3 * PCA953x 4/8/16/24/40 bit I/O ports
4 *
5 * Copyright (C) 2005 Ben Gardner <bgardner@wabtec.com>
6 * Copyright (C) 2007 Marvell International Ltd.
7 *
8 * Derived from drivers/i2c/chips/pca9539.c
9 */
10
11#include <linux/acpi.h>
12#include <linux/bitmap.h>
13#include <linux/gpio/consumer.h>
14#include <linux/gpio/driver.h>
15#include <linux/i2c.h>
16#include <linux/init.h>
17#include <linux/interrupt.h>
18#include <linux/module.h>
19#include <linux/of_platform.h>
20#include <linux/platform_data/pca953x.h>
21#include <linux/regmap.h>
22#include <linux/regulator/consumer.h>
23#include <linux/seq_file.h>
24#include <linux/slab.h>
25
26#include <asm/unaligned.h>
27
28#define PCA953X_INPUT 0x00
29#define PCA953X_OUTPUT 0x01
30#define PCA953X_INVERT 0x02
31#define PCA953X_DIRECTION 0x03
32
33#define REG_ADDR_MASK GENMASK(5, 0)
34#define REG_ADDR_EXT BIT(6)
35#define REG_ADDR_AI BIT(7)
36
37#define PCA957X_IN 0x00
38#define PCA957X_INVRT 0x01
39#define PCA957X_BKEN 0x02
40#define PCA957X_PUPD 0x03
41#define PCA957X_CFG 0x04
42#define PCA957X_OUT 0x05
43#define PCA957X_MSK 0x06
44#define PCA957X_INTS 0x07
45
46#define PCAL953X_OUT_STRENGTH 0x20
47#define PCAL953X_IN_LATCH 0x22
48#define PCAL953X_PULL_EN 0x23
49#define PCAL953X_PULL_SEL 0x24
50#define PCAL953X_INT_MASK 0x25
51#define PCAL953X_INT_STAT 0x26
52#define PCAL953X_OUT_CONF 0x27
53
54#define PCAL6524_INT_EDGE 0x28
55#define PCAL6524_INT_CLR 0x2a
56#define PCAL6524_IN_STATUS 0x2b
57#define PCAL6524_OUT_INDCONF 0x2c
58#define PCAL6524_DEBOUNCE 0x2d
59
60#define PCA_GPIO_MASK GENMASK(7, 0)
61
62#define PCAL_GPIO_MASK GENMASK(4, 0)
63#define PCAL_PINCTRL_MASK GENMASK(6, 5)
64
65#define PCA_INT BIT(8)
66#define PCA_PCAL BIT(9)
67#define PCA_LATCH_INT (PCA_PCAL | PCA_INT)
68#define PCA953X_TYPE BIT(12)
69#define PCA957X_TYPE BIT(13)
70#define PCAL653X_TYPE BIT(14)
71#define PCA_TYPE_MASK GENMASK(15, 12)
72
73#define PCA_CHIP_TYPE(x) ((x) & PCA_TYPE_MASK)
74
75static const struct i2c_device_id pca953x_id[] = {
76 { "pca6408", 8 | PCA953X_TYPE | PCA_INT, },
77 { "pca6416", 16 | PCA953X_TYPE | PCA_INT, },
78 { "pca9505", 40 | PCA953X_TYPE | PCA_INT, },
79 { "pca9506", 40 | PCA953X_TYPE | PCA_INT, },
80 { "pca9534", 8 | PCA953X_TYPE | PCA_INT, },
81 { "pca9535", 16 | PCA953X_TYPE | PCA_INT, },
82 { "pca9536", 4 | PCA953X_TYPE, },
83 { "pca9537", 4 | PCA953X_TYPE | PCA_INT, },
84 { "pca9538", 8 | PCA953X_TYPE | PCA_INT, },
85 { "pca9539", 16 | PCA953X_TYPE | PCA_INT, },
86 { "pca9554", 8 | PCA953X_TYPE | PCA_INT, },
87 { "pca9555", 16 | PCA953X_TYPE | PCA_INT, },
88 { "pca9556", 8 | PCA953X_TYPE, },
89 { "pca9557", 8 | PCA953X_TYPE, },
90 { "pca9574", 8 | PCA957X_TYPE | PCA_INT, },
91 { "pca9575", 16 | PCA957X_TYPE | PCA_INT, },
92 { "pca9698", 40 | PCA953X_TYPE, },
93
94 { "pcal6408", 8 | PCA953X_TYPE | PCA_LATCH_INT, },
95 { "pcal6416", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
96 { "pcal6524", 24 | PCA953X_TYPE | PCA_LATCH_INT, },
97 { "pcal6534", 34 | PCAL653X_TYPE | PCA_LATCH_INT, },
98 { "pcal9535", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
99 { "pcal9554b", 8 | PCA953X_TYPE | PCA_LATCH_INT, },
100 { "pcal9555a", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
101
102 { "max7310", 8 | PCA953X_TYPE, },
103 { "max7312", 16 | PCA953X_TYPE | PCA_INT, },
104 { "max7313", 16 | PCA953X_TYPE | PCA_INT, },
105 { "max7315", 8 | PCA953X_TYPE | PCA_INT, },
106 { "max7318", 16 | PCA953X_TYPE | PCA_INT, },
107 { "pca6107", 8 | PCA953X_TYPE | PCA_INT, },
108 { "tca6408", 8 | PCA953X_TYPE | PCA_INT, },
109 { "tca6416", 16 | PCA953X_TYPE | PCA_INT, },
110 { "tca6424", 24 | PCA953X_TYPE | PCA_INT, },
111 { "tca9539", 16 | PCA953X_TYPE | PCA_INT, },
112 { "tca9554", 8 | PCA953X_TYPE | PCA_INT, },
113 { "xra1202", 8 | PCA953X_TYPE },
114 { }
115};
116MODULE_DEVICE_TABLE(i2c, pca953x_id);
117
118#ifdef CONFIG_GPIO_PCA953X_IRQ
119
120#include <linux/dmi.h>
121
122static const struct acpi_gpio_params pca953x_irq_gpios = { 0, 0, true };
123
124static const struct acpi_gpio_mapping pca953x_acpi_irq_gpios[] = {
125 { "irq-gpios", &pca953x_irq_gpios, 1, ACPI_GPIO_QUIRK_ABSOLUTE_NUMBER },
126 { }
127};
128
129static int pca953x_acpi_get_irq(struct device *dev)
130{
131 int ret;
132
133 ret = devm_acpi_dev_add_driver_gpios(dev, pca953x_acpi_irq_gpios);
134 if (ret)
135 dev_warn(dev, "can't add GPIO ACPI mapping\n");
136
137 ret = acpi_dev_gpio_irq_get_by(ACPI_COMPANION(dev), "irq-gpios", 0);
138 if (ret < 0)
139 return ret;
140
141 dev_info(dev, "ACPI interrupt quirk (IRQ %d)\n", ret);
142 return ret;
143}
144
145static const struct dmi_system_id pca953x_dmi_acpi_irq_info[] = {
146 {
147 /*
148 * On Intel Galileo Gen 2 board the IRQ pin of one of
149 * the I²C GPIO expanders, which has GpioInt() resource,
150 * is provided as an absolute number instead of being
151 * relative. Since first controller (gpio-sch.c) and
152 * second (gpio-dwapb.c) are at the fixed bases, we may
153 * safely refer to the number in the global space to get
154 * an IRQ out of it.
155 */
156 .matches = {
157 DMI_EXACT_MATCH(DMI_BOARD_NAME, "GalileoGen2"),
158 },
159 },
160 {}
161};
162#endif
163
164static const struct acpi_device_id pca953x_acpi_ids[] = {
165 { "INT3491", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
166 { }
167};
168MODULE_DEVICE_TABLE(acpi, pca953x_acpi_ids);
169
170#define MAX_BANK 5
171#define BANK_SZ 8
172#define MAX_LINE (MAX_BANK * BANK_SZ)
173
174#define NBANK(chip) DIV_ROUND_UP(chip->gpio_chip.ngpio, BANK_SZ)
175
176struct pca953x_reg_config {
177 int direction;
178 int output;
179 int input;
180 int invert;
181};
182
183static const struct pca953x_reg_config pca953x_regs = {
184 .direction = PCA953X_DIRECTION,
185 .output = PCA953X_OUTPUT,
186 .input = PCA953X_INPUT,
187 .invert = PCA953X_INVERT,
188};
189
190static const struct pca953x_reg_config pca957x_regs = {
191 .direction = PCA957X_CFG,
192 .output = PCA957X_OUT,
193 .input = PCA957X_IN,
194 .invert = PCA957X_INVRT,
195};
196
197struct pca953x_chip {
198 unsigned gpio_start;
199 struct mutex i2c_lock;
200 struct regmap *regmap;
201
202#ifdef CONFIG_GPIO_PCA953X_IRQ
203 struct mutex irq_lock;
204 DECLARE_BITMAP(irq_mask, MAX_LINE);
205 DECLARE_BITMAP(irq_stat, MAX_LINE);
206 DECLARE_BITMAP(irq_trig_raise, MAX_LINE);
207 DECLARE_BITMAP(irq_trig_fall, MAX_LINE);
208#endif
209 atomic_t wakeup_path;
210
211 struct i2c_client *client;
212 struct gpio_chip gpio_chip;
213 const char *const *names;
214 unsigned long driver_data;
215 struct regulator *regulator;
216
217 const struct pca953x_reg_config *regs;
218
219 u8 (*recalc_addr)(struct pca953x_chip *chip, int reg, int off);
220 bool (*check_reg)(struct pca953x_chip *chip, unsigned int reg,
221 u32 checkbank);
222};
223
224static int pca953x_bank_shift(struct pca953x_chip *chip)
225{
226 return fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
227}
228
229#define PCA953x_BANK_INPUT BIT(0)
230#define PCA953x_BANK_OUTPUT BIT(1)
231#define PCA953x_BANK_POLARITY BIT(2)
232#define PCA953x_BANK_CONFIG BIT(3)
233
234#define PCA957x_BANK_INPUT BIT(0)
235#define PCA957x_BANK_POLARITY BIT(1)
236#define PCA957x_BANK_BUSHOLD BIT(2)
237#define PCA957x_BANK_CONFIG BIT(4)
238#define PCA957x_BANK_OUTPUT BIT(5)
239
240#define PCAL9xxx_BANK_IN_LATCH BIT(8 + 2)
241#define PCAL9xxx_BANK_PULL_EN BIT(8 + 3)
242#define PCAL9xxx_BANK_PULL_SEL BIT(8 + 4)
243#define PCAL9xxx_BANK_IRQ_MASK BIT(8 + 5)
244#define PCAL9xxx_BANK_IRQ_STAT BIT(8 + 6)
245
246/*
247 * We care about the following registers:
248 * - Standard set, below 0x40, each port can be replicated up to 8 times
249 * - PCA953x standard
250 * Input port 0x00 + 0 * bank_size R
251 * Output port 0x00 + 1 * bank_size RW
252 * Polarity Inversion port 0x00 + 2 * bank_size RW
253 * Configuration port 0x00 + 3 * bank_size RW
254 * - PCA957x with mixed up registers
255 * Input port 0x00 + 0 * bank_size R
256 * Polarity Inversion port 0x00 + 1 * bank_size RW
257 * Bus hold port 0x00 + 2 * bank_size RW
258 * Configuration port 0x00 + 4 * bank_size RW
259 * Output port 0x00 + 5 * bank_size RW
260 *
261 * - Extended set, above 0x40, often chip specific.
262 * - PCAL6524/PCAL9555A with custom PCAL IRQ handling:
263 * Input latch register 0x40 + 2 * bank_size RW
264 * Pull-up/pull-down enable reg 0x40 + 3 * bank_size RW
265 * Pull-up/pull-down select reg 0x40 + 4 * bank_size RW
266 * Interrupt mask register 0x40 + 5 * bank_size RW
267 * Interrupt status register 0x40 + 6 * bank_size R
268 *
269 * - Registers with bit 0x80 set, the AI bit
270 * The bit is cleared and the registers fall into one of the
271 * categories above.
272 */
273
274static bool pca953x_check_register(struct pca953x_chip *chip, unsigned int reg,
275 u32 checkbank)
276{
277 int bank_shift = pca953x_bank_shift(chip);
278 int bank = (reg & REG_ADDR_MASK) >> bank_shift;
279 int offset = reg & (BIT(bank_shift) - 1);
280
281 /* Special PCAL extended register check. */
282 if (reg & REG_ADDR_EXT) {
283 if (!(chip->driver_data & PCA_PCAL))
284 return false;
285 bank += 8;
286 }
287
288 /* Register is not in the matching bank. */
289 if (!(BIT(bank) & checkbank))
290 return false;
291
292 /* Register is not within allowed range of bank. */
293 if (offset >= NBANK(chip))
294 return false;
295
296 return true;
297}
298
299/*
300 * Unfortunately, whilst the PCAL6534 chip (and compatibles) broadly follow the
301 * same register layout as the PCAL6524, the spacing of the registers has been
302 * fundamentally altered by compacting them and thus does not obey the same
303 * rules, including being able to use bit shifting to determine bank. These
304 * chips hence need special handling here.
305 */
306static bool pcal6534_check_register(struct pca953x_chip *chip, unsigned int reg,
307 u32 checkbank)
308{
309 int bank;
310 int offset;
311
312 if (reg >= 0x30) {
313 /*
314 * Reserved block between 14h and 2Fh does not align on
315 * expected bank boundaries like other devices.
316 */
317 int temp = reg - 0x30;
318
319 bank = temp / NBANK(chip);
320 offset = temp - (bank * NBANK(chip));
321 bank += 8;
322 } else if (reg >= 0x54) {
323 /*
324 * Handle lack of reserved registers after output port
325 * configuration register to form a bank.
326 */
327 int temp = reg - 0x54;
328
329 bank = temp / NBANK(chip);
330 offset = temp - (bank * NBANK(chip));
331 bank += 16;
332 } else {
333 bank = reg / NBANK(chip);
334 offset = reg - (bank * NBANK(chip));
335 }
336
337 /* Register is not in the matching bank. */
338 if (!(BIT(bank) & checkbank))
339 return false;
340
341 /* Register is not within allowed range of bank. */
342 if (offset >= NBANK(chip))
343 return false;
344
345 return true;
346}
347
348static bool pca953x_readable_register(struct device *dev, unsigned int reg)
349{
350 struct pca953x_chip *chip = dev_get_drvdata(dev);
351 u32 bank;
352
353 if (PCA_CHIP_TYPE(chip->driver_data) == PCA957X_TYPE) {
354 bank = PCA957x_BANK_INPUT | PCA957x_BANK_OUTPUT |
355 PCA957x_BANK_POLARITY | PCA957x_BANK_CONFIG |
356 PCA957x_BANK_BUSHOLD;
357 } else {
358 bank = PCA953x_BANK_INPUT | PCA953x_BANK_OUTPUT |
359 PCA953x_BANK_POLARITY | PCA953x_BANK_CONFIG;
360 }
361
362 if (chip->driver_data & PCA_PCAL) {
363 bank |= PCAL9xxx_BANK_IN_LATCH | PCAL9xxx_BANK_PULL_EN |
364 PCAL9xxx_BANK_PULL_SEL | PCAL9xxx_BANK_IRQ_MASK |
365 PCAL9xxx_BANK_IRQ_STAT;
366 }
367
368 return chip->check_reg(chip, reg, bank);
369}
370
371static bool pca953x_writeable_register(struct device *dev, unsigned int reg)
372{
373 struct pca953x_chip *chip = dev_get_drvdata(dev);
374 u32 bank;
375
376 if (PCA_CHIP_TYPE(chip->driver_data) == PCA957X_TYPE) {
377 bank = PCA957x_BANK_OUTPUT | PCA957x_BANK_POLARITY |
378 PCA957x_BANK_CONFIG | PCA957x_BANK_BUSHOLD;
379 } else {
380 bank = PCA953x_BANK_OUTPUT | PCA953x_BANK_POLARITY |
381 PCA953x_BANK_CONFIG;
382 }
383
384 if (chip->driver_data & PCA_PCAL)
385 bank |= PCAL9xxx_BANK_IN_LATCH | PCAL9xxx_BANK_PULL_EN |
386 PCAL9xxx_BANK_PULL_SEL | PCAL9xxx_BANK_IRQ_MASK;
387
388 return chip->check_reg(chip, reg, bank);
389}
390
391static bool pca953x_volatile_register(struct device *dev, unsigned int reg)
392{
393 struct pca953x_chip *chip = dev_get_drvdata(dev);
394 u32 bank;
395
396 if (PCA_CHIP_TYPE(chip->driver_data) == PCA957X_TYPE)
397 bank = PCA957x_BANK_INPUT;
398 else
399 bank = PCA953x_BANK_INPUT;
400
401 if (chip->driver_data & PCA_PCAL)
402 bank |= PCAL9xxx_BANK_IRQ_STAT;
403
404 return chip->check_reg(chip, reg, bank);
405}
406
407static const struct regmap_config pca953x_i2c_regmap = {
408 .reg_bits = 8,
409 .val_bits = 8,
410
411 .use_single_read = true,
412 .use_single_write = true,
413
414 .readable_reg = pca953x_readable_register,
415 .writeable_reg = pca953x_writeable_register,
416 .volatile_reg = pca953x_volatile_register,
417
418 .disable_locking = true,
419 .cache_type = REGCACHE_RBTREE,
420 .max_register = 0x7f,
421};
422
423static const struct regmap_config pca953x_ai_i2c_regmap = {
424 .reg_bits = 8,
425 .val_bits = 8,
426
427 .read_flag_mask = REG_ADDR_AI,
428 .write_flag_mask = REG_ADDR_AI,
429
430 .readable_reg = pca953x_readable_register,
431 .writeable_reg = pca953x_writeable_register,
432 .volatile_reg = pca953x_volatile_register,
433
434 .disable_locking = true,
435 .cache_type = REGCACHE_RBTREE,
436 .max_register = 0x7f,
437};
438
439static u8 pca953x_recalc_addr(struct pca953x_chip *chip, int reg, int off)
440{
441 int bank_shift = pca953x_bank_shift(chip);
442 int addr = (reg & PCAL_GPIO_MASK) << bank_shift;
443 int pinctrl = (reg & PCAL_PINCTRL_MASK) << 1;
444 u8 regaddr = pinctrl | addr | (off / BANK_SZ);
445
446 return regaddr;
447}
448
449/*
450 * The PCAL6534 and compatible chips have altered bank alignment that doesn't
451 * fit within the bit shifting scheme used for other devices.
452 */
453static u8 pcal6534_recalc_addr(struct pca953x_chip *chip, int reg, int off)
454{
455 int addr;
456 int pinctrl;
457
458 addr = (reg & PCAL_GPIO_MASK) * NBANK(chip);
459
460 switch (reg) {
461 case PCAL953X_OUT_STRENGTH:
462 case PCAL953X_IN_LATCH:
463 case PCAL953X_PULL_EN:
464 case PCAL953X_PULL_SEL:
465 case PCAL953X_INT_MASK:
466 case PCAL953X_INT_STAT:
467 case PCAL953X_OUT_CONF:
468 pinctrl = ((reg & PCAL_PINCTRL_MASK) >> 1) + 0x20;
469 break;
470 case PCAL6524_INT_EDGE:
471 case PCAL6524_INT_CLR:
472 case PCAL6524_IN_STATUS:
473 case PCAL6524_OUT_INDCONF:
474 case PCAL6524_DEBOUNCE:
475 pinctrl = ((reg & PCAL_PINCTRL_MASK) >> 1) + 0x1c;
476 break;
477 default:
478 pinctrl = 0;
479 break;
480 }
481
482 return pinctrl + addr + (off / BANK_SZ);
483}
484
485static int pca953x_write_regs(struct pca953x_chip *chip, int reg, unsigned long *val)
486{
487 u8 regaddr = chip->recalc_addr(chip, reg, 0);
488 u8 value[MAX_BANK];
489 int i, ret;
490
491 for (i = 0; i < NBANK(chip); i++)
492 value[i] = bitmap_get_value8(val, i * BANK_SZ);
493
494 ret = regmap_bulk_write(chip->regmap, regaddr, value, NBANK(chip));
495 if (ret < 0) {
496 dev_err(&chip->client->dev, "failed writing register\n");
497 return ret;
498 }
499
500 return 0;
501}
502
503static int pca953x_read_regs(struct pca953x_chip *chip, int reg, unsigned long *val)
504{
505 u8 regaddr = chip->recalc_addr(chip, reg, 0);
506 u8 value[MAX_BANK];
507 int i, ret;
508
509 ret = regmap_bulk_read(chip->regmap, regaddr, value, NBANK(chip));
510 if (ret < 0) {
511 dev_err(&chip->client->dev, "failed reading register\n");
512 return ret;
513 }
514
515 for (i = 0; i < NBANK(chip); i++)
516 bitmap_set_value8(val, value[i], i * BANK_SZ);
517
518 return 0;
519}
520
521static int pca953x_gpio_direction_input(struct gpio_chip *gc, unsigned off)
522{
523 struct pca953x_chip *chip = gpiochip_get_data(gc);
524 u8 dirreg = chip->recalc_addr(chip, chip->regs->direction, off);
525 u8 bit = BIT(off % BANK_SZ);
526 int ret;
527
528 mutex_lock(&chip->i2c_lock);
529 ret = regmap_write_bits(chip->regmap, dirreg, bit, bit);
530 mutex_unlock(&chip->i2c_lock);
531 return ret;
532}
533
534static int pca953x_gpio_direction_output(struct gpio_chip *gc,
535 unsigned off, int val)
536{
537 struct pca953x_chip *chip = gpiochip_get_data(gc);
538 u8 dirreg = chip->recalc_addr(chip, chip->regs->direction, off);
539 u8 outreg = chip->recalc_addr(chip, chip->regs->output, off);
540 u8 bit = BIT(off % BANK_SZ);
541 int ret;
542
543 mutex_lock(&chip->i2c_lock);
544 /* set output level */
545 ret = regmap_write_bits(chip->regmap, outreg, bit, val ? bit : 0);
546 if (ret)
547 goto exit;
548
549 /* then direction */
550 ret = regmap_write_bits(chip->regmap, dirreg, bit, 0);
551exit:
552 mutex_unlock(&chip->i2c_lock);
553 return ret;
554}
555
556static int pca953x_gpio_get_value(struct gpio_chip *gc, unsigned off)
557{
558 struct pca953x_chip *chip = gpiochip_get_data(gc);
559 u8 inreg = chip->recalc_addr(chip, chip->regs->input, off);
560 u8 bit = BIT(off % BANK_SZ);
561 u32 reg_val;
562 int ret;
563
564 mutex_lock(&chip->i2c_lock);
565 ret = regmap_read(chip->regmap, inreg, ®_val);
566 mutex_unlock(&chip->i2c_lock);
567 if (ret < 0)
568 return ret;
569
570 return !!(reg_val & bit);
571}
572
573static void pca953x_gpio_set_value(struct gpio_chip *gc, unsigned off, int val)
574{
575 struct pca953x_chip *chip = gpiochip_get_data(gc);
576 u8 outreg = chip->recalc_addr(chip, chip->regs->output, off);
577 u8 bit = BIT(off % BANK_SZ);
578
579 mutex_lock(&chip->i2c_lock);
580 regmap_write_bits(chip->regmap, outreg, bit, val ? bit : 0);
581 mutex_unlock(&chip->i2c_lock);
582}
583
584static int pca953x_gpio_get_direction(struct gpio_chip *gc, unsigned off)
585{
586 struct pca953x_chip *chip = gpiochip_get_data(gc);
587 u8 dirreg = chip->recalc_addr(chip, chip->regs->direction, off);
588 u8 bit = BIT(off % BANK_SZ);
589 u32 reg_val;
590 int ret;
591
592 mutex_lock(&chip->i2c_lock);
593 ret = regmap_read(chip->regmap, dirreg, ®_val);
594 mutex_unlock(&chip->i2c_lock);
595 if (ret < 0)
596 return ret;
597
598 if (reg_val & bit)
599 return GPIO_LINE_DIRECTION_IN;
600
601 return GPIO_LINE_DIRECTION_OUT;
602}
603
604static int pca953x_gpio_get_multiple(struct gpio_chip *gc,
605 unsigned long *mask, unsigned long *bits)
606{
607 struct pca953x_chip *chip = gpiochip_get_data(gc);
608 DECLARE_BITMAP(reg_val, MAX_LINE);
609 int ret;
610
611 mutex_lock(&chip->i2c_lock);
612 ret = pca953x_read_regs(chip, chip->regs->input, reg_val);
613 mutex_unlock(&chip->i2c_lock);
614 if (ret)
615 return ret;
616
617 bitmap_replace(bits, bits, reg_val, mask, gc->ngpio);
618 return 0;
619}
620
621static void pca953x_gpio_set_multiple(struct gpio_chip *gc,
622 unsigned long *mask, unsigned long *bits)
623{
624 struct pca953x_chip *chip = gpiochip_get_data(gc);
625 DECLARE_BITMAP(reg_val, MAX_LINE);
626 int ret;
627
628 mutex_lock(&chip->i2c_lock);
629 ret = pca953x_read_regs(chip, chip->regs->output, reg_val);
630 if (ret)
631 goto exit;
632
633 bitmap_replace(reg_val, reg_val, bits, mask, gc->ngpio);
634
635 pca953x_write_regs(chip, chip->regs->output, reg_val);
636exit:
637 mutex_unlock(&chip->i2c_lock);
638}
639
640static int pca953x_gpio_set_pull_up_down(struct pca953x_chip *chip,
641 unsigned int offset,
642 unsigned long config)
643{
644 enum pin_config_param param = pinconf_to_config_param(config);
645
646 u8 pull_en_reg = chip->recalc_addr(chip, PCAL953X_PULL_EN, offset);
647 u8 pull_sel_reg = chip->recalc_addr(chip, PCAL953X_PULL_SEL, offset);
648 u8 bit = BIT(offset % BANK_SZ);
649 int ret;
650
651 /*
652 * pull-up/pull-down configuration requires PCAL extended
653 * registers
654 */
655 if (!(chip->driver_data & PCA_PCAL))
656 return -ENOTSUPP;
657
658 mutex_lock(&chip->i2c_lock);
659
660 /* Configure pull-up/pull-down */
661 if (param == PIN_CONFIG_BIAS_PULL_UP)
662 ret = regmap_write_bits(chip->regmap, pull_sel_reg, bit, bit);
663 else if (param == PIN_CONFIG_BIAS_PULL_DOWN)
664 ret = regmap_write_bits(chip->regmap, pull_sel_reg, bit, 0);
665 else
666 ret = 0;
667 if (ret)
668 goto exit;
669
670 /* Disable/Enable pull-up/pull-down */
671 if (param == PIN_CONFIG_BIAS_DISABLE)
672 ret = regmap_write_bits(chip->regmap, pull_en_reg, bit, 0);
673 else
674 ret = regmap_write_bits(chip->regmap, pull_en_reg, bit, bit);
675
676exit:
677 mutex_unlock(&chip->i2c_lock);
678 return ret;
679}
680
681static int pca953x_gpio_set_config(struct gpio_chip *gc, unsigned int offset,
682 unsigned long config)
683{
684 struct pca953x_chip *chip = gpiochip_get_data(gc);
685
686 switch (pinconf_to_config_param(config)) {
687 case PIN_CONFIG_BIAS_PULL_UP:
688 case PIN_CONFIG_BIAS_PULL_PIN_DEFAULT:
689 case PIN_CONFIG_BIAS_PULL_DOWN:
690 case PIN_CONFIG_BIAS_DISABLE:
691 return pca953x_gpio_set_pull_up_down(chip, offset, config);
692 default:
693 return -ENOTSUPP;
694 }
695}
696
697static void pca953x_setup_gpio(struct pca953x_chip *chip, int gpios)
698{
699 struct gpio_chip *gc;
700
701 gc = &chip->gpio_chip;
702
703 gc->direction_input = pca953x_gpio_direction_input;
704 gc->direction_output = pca953x_gpio_direction_output;
705 gc->get = pca953x_gpio_get_value;
706 gc->set = pca953x_gpio_set_value;
707 gc->get_direction = pca953x_gpio_get_direction;
708 gc->get_multiple = pca953x_gpio_get_multiple;
709 gc->set_multiple = pca953x_gpio_set_multiple;
710 gc->set_config = pca953x_gpio_set_config;
711 gc->can_sleep = true;
712
713 gc->base = chip->gpio_start;
714 gc->ngpio = gpios;
715 gc->label = dev_name(&chip->client->dev);
716 gc->parent = &chip->client->dev;
717 gc->owner = THIS_MODULE;
718 gc->names = chip->names;
719}
720
721#ifdef CONFIG_GPIO_PCA953X_IRQ
722static void pca953x_irq_mask(struct irq_data *d)
723{
724 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
725 struct pca953x_chip *chip = gpiochip_get_data(gc);
726 irq_hw_number_t hwirq = irqd_to_hwirq(d);
727
728 clear_bit(hwirq, chip->irq_mask);
729 gpiochip_disable_irq(gc, hwirq);
730}
731
732static void pca953x_irq_unmask(struct irq_data *d)
733{
734 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
735 struct pca953x_chip *chip = gpiochip_get_data(gc);
736 irq_hw_number_t hwirq = irqd_to_hwirq(d);
737
738 gpiochip_enable_irq(gc, hwirq);
739 set_bit(hwirq, chip->irq_mask);
740}
741
742static int pca953x_irq_set_wake(struct irq_data *d, unsigned int on)
743{
744 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
745 struct pca953x_chip *chip = gpiochip_get_data(gc);
746
747 if (on)
748 atomic_inc(&chip->wakeup_path);
749 else
750 atomic_dec(&chip->wakeup_path);
751
752 return irq_set_irq_wake(chip->client->irq, on);
753}
754
755static void pca953x_irq_bus_lock(struct irq_data *d)
756{
757 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
758 struct pca953x_chip *chip = gpiochip_get_data(gc);
759
760 mutex_lock(&chip->irq_lock);
761}
762
763static void pca953x_irq_bus_sync_unlock(struct irq_data *d)
764{
765 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
766 struct pca953x_chip *chip = gpiochip_get_data(gc);
767 DECLARE_BITMAP(irq_mask, MAX_LINE);
768 DECLARE_BITMAP(reg_direction, MAX_LINE);
769 int level;
770
771 if (chip->driver_data & PCA_PCAL) {
772 /* Enable latch on interrupt-enabled inputs */
773 pca953x_write_regs(chip, PCAL953X_IN_LATCH, chip->irq_mask);
774
775 bitmap_complement(irq_mask, chip->irq_mask, gc->ngpio);
776
777 /* Unmask enabled interrupts */
778 pca953x_write_regs(chip, PCAL953X_INT_MASK, irq_mask);
779 }
780
781 /* Switch direction to input if needed */
782 pca953x_read_regs(chip, chip->regs->direction, reg_direction);
783
784 bitmap_or(irq_mask, chip->irq_trig_fall, chip->irq_trig_raise, gc->ngpio);
785 bitmap_complement(reg_direction, reg_direction, gc->ngpio);
786 bitmap_and(irq_mask, irq_mask, reg_direction, gc->ngpio);
787
788 /* Look for any newly setup interrupt */
789 for_each_set_bit(level, irq_mask, gc->ngpio)
790 pca953x_gpio_direction_input(&chip->gpio_chip, level);
791
792 mutex_unlock(&chip->irq_lock);
793}
794
795static int pca953x_irq_set_type(struct irq_data *d, unsigned int type)
796{
797 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
798 struct pca953x_chip *chip = gpiochip_get_data(gc);
799 irq_hw_number_t hwirq = irqd_to_hwirq(d);
800
801 if (!(type & IRQ_TYPE_EDGE_BOTH)) {
802 dev_err(&chip->client->dev, "irq %d: unsupported type %d\n",
803 d->irq, type);
804 return -EINVAL;
805 }
806
807 assign_bit(hwirq, chip->irq_trig_fall, type & IRQ_TYPE_EDGE_FALLING);
808 assign_bit(hwirq, chip->irq_trig_raise, type & IRQ_TYPE_EDGE_RISING);
809
810 return 0;
811}
812
813static void pca953x_irq_shutdown(struct irq_data *d)
814{
815 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
816 struct pca953x_chip *chip = gpiochip_get_data(gc);
817 irq_hw_number_t hwirq = irqd_to_hwirq(d);
818
819 clear_bit(hwirq, chip->irq_trig_raise);
820 clear_bit(hwirq, chip->irq_trig_fall);
821}
822
823static void pca953x_irq_print_chip(struct irq_data *data, struct seq_file *p)
824{
825 struct gpio_chip *gc = irq_data_get_irq_chip_data(data);
826
827 seq_printf(p, dev_name(gc->parent));
828}
829
830static const struct irq_chip pca953x_irq_chip = {
831 .irq_mask = pca953x_irq_mask,
832 .irq_unmask = pca953x_irq_unmask,
833 .irq_set_wake = pca953x_irq_set_wake,
834 .irq_bus_lock = pca953x_irq_bus_lock,
835 .irq_bus_sync_unlock = pca953x_irq_bus_sync_unlock,
836 .irq_set_type = pca953x_irq_set_type,
837 .irq_shutdown = pca953x_irq_shutdown,
838 .irq_print_chip = pca953x_irq_print_chip,
839 .flags = IRQCHIP_IMMUTABLE,
840 GPIOCHIP_IRQ_RESOURCE_HELPERS,
841};
842
843static bool pca953x_irq_pending(struct pca953x_chip *chip, unsigned long *pending)
844{
845 struct gpio_chip *gc = &chip->gpio_chip;
846 DECLARE_BITMAP(reg_direction, MAX_LINE);
847 DECLARE_BITMAP(old_stat, MAX_LINE);
848 DECLARE_BITMAP(cur_stat, MAX_LINE);
849 DECLARE_BITMAP(new_stat, MAX_LINE);
850 DECLARE_BITMAP(trigger, MAX_LINE);
851 int ret;
852
853 if (chip->driver_data & PCA_PCAL) {
854 /* Read the current interrupt status from the device */
855 ret = pca953x_read_regs(chip, PCAL953X_INT_STAT, trigger);
856 if (ret)
857 return false;
858
859 /* Check latched inputs and clear interrupt status */
860 ret = pca953x_read_regs(chip, chip->regs->input, cur_stat);
861 if (ret)
862 return false;
863
864 /* Apply filter for rising/falling edge selection */
865 bitmap_replace(new_stat, chip->irq_trig_fall, chip->irq_trig_raise, cur_stat, gc->ngpio);
866
867 bitmap_and(pending, new_stat, trigger, gc->ngpio);
868
869 return !bitmap_empty(pending, gc->ngpio);
870 }
871
872 ret = pca953x_read_regs(chip, chip->regs->input, cur_stat);
873 if (ret)
874 return false;
875
876 /* Remove output pins from the equation */
877 pca953x_read_regs(chip, chip->regs->direction, reg_direction);
878
879 bitmap_copy(old_stat, chip->irq_stat, gc->ngpio);
880
881 bitmap_and(new_stat, cur_stat, reg_direction, gc->ngpio);
882 bitmap_xor(cur_stat, new_stat, old_stat, gc->ngpio);
883 bitmap_and(trigger, cur_stat, chip->irq_mask, gc->ngpio);
884
885 bitmap_copy(chip->irq_stat, new_stat, gc->ngpio);
886
887 if (bitmap_empty(trigger, gc->ngpio))
888 return false;
889
890 bitmap_and(cur_stat, chip->irq_trig_fall, old_stat, gc->ngpio);
891 bitmap_and(old_stat, chip->irq_trig_raise, new_stat, gc->ngpio);
892 bitmap_or(new_stat, old_stat, cur_stat, gc->ngpio);
893 bitmap_and(pending, new_stat, trigger, gc->ngpio);
894
895 return !bitmap_empty(pending, gc->ngpio);
896}
897
898static irqreturn_t pca953x_irq_handler(int irq, void *devid)
899{
900 struct pca953x_chip *chip = devid;
901 struct gpio_chip *gc = &chip->gpio_chip;
902 DECLARE_BITMAP(pending, MAX_LINE);
903 int level;
904 bool ret;
905
906 bitmap_zero(pending, MAX_LINE);
907
908 mutex_lock(&chip->i2c_lock);
909 ret = pca953x_irq_pending(chip, pending);
910 mutex_unlock(&chip->i2c_lock);
911
912 if (ret) {
913 ret = 0;
914
915 for_each_set_bit(level, pending, gc->ngpio) {
916 int nested_irq = irq_find_mapping(gc->irq.domain, level);
917
918 if (unlikely(nested_irq <= 0)) {
919 dev_warn_ratelimited(gc->parent, "unmapped interrupt %d\n", level);
920 continue;
921 }
922
923 handle_nested_irq(nested_irq);
924 ret = 1;
925 }
926 }
927
928 return IRQ_RETVAL(ret);
929}
930
931static int pca953x_irq_setup(struct pca953x_chip *chip, int irq_base)
932{
933 struct i2c_client *client = chip->client;
934 DECLARE_BITMAP(reg_direction, MAX_LINE);
935 DECLARE_BITMAP(irq_stat, MAX_LINE);
936 struct gpio_irq_chip *girq;
937 int ret;
938
939 if (dmi_first_match(pca953x_dmi_acpi_irq_info)) {
940 ret = pca953x_acpi_get_irq(&client->dev);
941 if (ret > 0)
942 client->irq = ret;
943 }
944
945 if (!client->irq)
946 return 0;
947
948 if (irq_base == -1)
949 return 0;
950
951 if (!(chip->driver_data & PCA_INT))
952 return 0;
953
954 ret = pca953x_read_regs(chip, chip->regs->input, irq_stat);
955 if (ret)
956 return ret;
957
958 /*
959 * There is no way to know which GPIO line generated the
960 * interrupt. We have to rely on the previous read for
961 * this purpose.
962 */
963 pca953x_read_regs(chip, chip->regs->direction, reg_direction);
964 bitmap_and(chip->irq_stat, irq_stat, reg_direction, chip->gpio_chip.ngpio);
965 mutex_init(&chip->irq_lock);
966
967 girq = &chip->gpio_chip.irq;
968 gpio_irq_chip_set_chip(girq, &pca953x_irq_chip);
969 /* This will let us handle the parent IRQ in the driver */
970 girq->parent_handler = NULL;
971 girq->num_parents = 0;
972 girq->parents = NULL;
973 girq->default_type = IRQ_TYPE_NONE;
974 girq->handler = handle_simple_irq;
975 girq->threaded = true;
976 girq->first = irq_base; /* FIXME: get rid of this */
977
978 ret = devm_request_threaded_irq(&client->dev, client->irq,
979 NULL, pca953x_irq_handler,
980 IRQF_ONESHOT | IRQF_SHARED,
981 dev_name(&client->dev), chip);
982 if (ret) {
983 dev_err(&client->dev, "failed to request irq %d\n",
984 client->irq);
985 return ret;
986 }
987
988 return 0;
989}
990
991#else /* CONFIG_GPIO_PCA953X_IRQ */
992static int pca953x_irq_setup(struct pca953x_chip *chip,
993 int irq_base)
994{
995 struct i2c_client *client = chip->client;
996
997 if (client->irq && irq_base != -1 && (chip->driver_data & PCA_INT))
998 dev_warn(&client->dev, "interrupt support not compiled in\n");
999
1000 return 0;
1001}
1002#endif
1003
1004static int device_pca95xx_init(struct pca953x_chip *chip, u32 invert)
1005{
1006 DECLARE_BITMAP(val, MAX_LINE);
1007 u8 regaddr;
1008 int ret;
1009
1010 regaddr = chip->recalc_addr(chip, chip->regs->output, 0);
1011 ret = regcache_sync_region(chip->regmap, regaddr,
1012 regaddr + NBANK(chip) - 1);
1013 if (ret)
1014 goto out;
1015
1016 regaddr = chip->recalc_addr(chip, chip->regs->direction, 0);
1017 ret = regcache_sync_region(chip->regmap, regaddr,
1018 regaddr + NBANK(chip) - 1);
1019 if (ret)
1020 goto out;
1021
1022 /* set platform specific polarity inversion */
1023 if (invert)
1024 bitmap_fill(val, MAX_LINE);
1025 else
1026 bitmap_zero(val, MAX_LINE);
1027
1028 ret = pca953x_write_regs(chip, chip->regs->invert, val);
1029out:
1030 return ret;
1031}
1032
1033static int device_pca957x_init(struct pca953x_chip *chip, u32 invert)
1034{
1035 DECLARE_BITMAP(val, MAX_LINE);
1036 unsigned int i;
1037 int ret;
1038
1039 ret = device_pca95xx_init(chip, invert);
1040 if (ret)
1041 goto out;
1042
1043 /* To enable register 6, 7 to control pull up and pull down */
1044 for (i = 0; i < NBANK(chip); i++)
1045 bitmap_set_value8(val, 0x02, i * BANK_SZ);
1046
1047 ret = pca953x_write_regs(chip, PCA957X_BKEN, val);
1048 if (ret)
1049 goto out;
1050
1051 return 0;
1052out:
1053 return ret;
1054}
1055
1056static int pca953x_probe(struct i2c_client *client)
1057{
1058 const struct i2c_device_id *i2c_id = i2c_client_get_device_id(client);
1059 struct pca953x_platform_data *pdata;
1060 struct pca953x_chip *chip;
1061 int irq_base = 0;
1062 int ret;
1063 u32 invert = 0;
1064 struct regulator *reg;
1065 const struct regmap_config *regmap_config;
1066
1067 chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
1068 if (chip == NULL)
1069 return -ENOMEM;
1070
1071 pdata = dev_get_platdata(&client->dev);
1072 if (pdata) {
1073 irq_base = pdata->irq_base;
1074 chip->gpio_start = pdata->gpio_base;
1075 invert = pdata->invert;
1076 chip->names = pdata->names;
1077 } else {
1078 struct gpio_desc *reset_gpio;
1079
1080 chip->gpio_start = -1;
1081 irq_base = 0;
1082
1083 /*
1084 * See if we need to de-assert a reset pin.
1085 *
1086 * There is no known ACPI-enabled platforms that are
1087 * using "reset" GPIO. Otherwise any of those platform
1088 * must use _DSD method with corresponding property.
1089 */
1090 reset_gpio = devm_gpiod_get_optional(&client->dev, "reset",
1091 GPIOD_OUT_LOW);
1092 if (IS_ERR(reset_gpio))
1093 return PTR_ERR(reset_gpio);
1094 }
1095
1096 chip->client = client;
1097
1098 reg = devm_regulator_get(&client->dev, "vcc");
1099 if (IS_ERR(reg))
1100 return dev_err_probe(&client->dev, PTR_ERR(reg), "reg get err\n");
1101
1102 ret = regulator_enable(reg);
1103 if (ret) {
1104 dev_err(&client->dev, "reg en err: %d\n", ret);
1105 return ret;
1106 }
1107 chip->regulator = reg;
1108
1109 if (i2c_id) {
1110 chip->driver_data = i2c_id->driver_data;
1111 } else {
1112 const void *match;
1113
1114 match = device_get_match_data(&client->dev);
1115 if (!match) {
1116 ret = -ENODEV;
1117 goto err_exit;
1118 }
1119
1120 chip->driver_data = (uintptr_t)match;
1121 }
1122
1123 i2c_set_clientdata(client, chip);
1124
1125 pca953x_setup_gpio(chip, chip->driver_data & PCA_GPIO_MASK);
1126
1127 if (NBANK(chip) > 2 || PCA_CHIP_TYPE(chip->driver_data) == PCA957X_TYPE) {
1128 dev_info(&client->dev, "using AI\n");
1129 regmap_config = &pca953x_ai_i2c_regmap;
1130 } else {
1131 dev_info(&client->dev, "using no AI\n");
1132 regmap_config = &pca953x_i2c_regmap;
1133 }
1134
1135 if (PCA_CHIP_TYPE(chip->driver_data) == PCAL653X_TYPE) {
1136 chip->recalc_addr = pcal6534_recalc_addr;
1137 chip->check_reg = pcal6534_check_register;
1138 } else {
1139 chip->recalc_addr = pca953x_recalc_addr;
1140 chip->check_reg = pca953x_check_register;
1141 }
1142
1143 chip->regmap = devm_regmap_init_i2c(client, regmap_config);
1144 if (IS_ERR(chip->regmap)) {
1145 ret = PTR_ERR(chip->regmap);
1146 goto err_exit;
1147 }
1148
1149 regcache_mark_dirty(chip->regmap);
1150
1151 mutex_init(&chip->i2c_lock);
1152 /*
1153 * In case we have an i2c-mux controlled by a GPIO provided by an
1154 * expander using the same driver higher on the device tree, read the
1155 * i2c adapter nesting depth and use the retrieved value as lockdep
1156 * subclass for chip->i2c_lock.
1157 *
1158 * REVISIT: This solution is not complete. It protects us from lockdep
1159 * false positives when the expander controlling the i2c-mux is on
1160 * a different level on the device tree, but not when it's on the same
1161 * level on a different branch (in which case the subclass number
1162 * would be the same).
1163 *
1164 * TODO: Once a correct solution is developed, a similar fix should be
1165 * applied to all other i2c-controlled GPIO expanders (and potentially
1166 * regmap-i2c).
1167 */
1168 lockdep_set_subclass(&chip->i2c_lock,
1169 i2c_adapter_depth(client->adapter));
1170
1171 /* initialize cached registers from their original values.
1172 * we can't share this chip with another i2c master.
1173 */
1174 if (PCA_CHIP_TYPE(chip->driver_data) == PCA957X_TYPE) {
1175 chip->regs = &pca957x_regs;
1176 ret = device_pca957x_init(chip, invert);
1177 } else {
1178 chip->regs = &pca953x_regs;
1179 ret = device_pca95xx_init(chip, invert);
1180 }
1181 if (ret)
1182 goto err_exit;
1183
1184 ret = pca953x_irq_setup(chip, irq_base);
1185 if (ret)
1186 goto err_exit;
1187
1188 ret = devm_gpiochip_add_data(&client->dev, &chip->gpio_chip, chip);
1189 if (ret)
1190 goto err_exit;
1191
1192 if (pdata && pdata->setup) {
1193 ret = pdata->setup(client, chip->gpio_chip.base,
1194 chip->gpio_chip.ngpio, pdata->context);
1195 if (ret < 0)
1196 dev_warn(&client->dev, "setup failed, %d\n", ret);
1197 }
1198
1199 return 0;
1200
1201err_exit:
1202 regulator_disable(chip->regulator);
1203 return ret;
1204}
1205
1206static void pca953x_remove(struct i2c_client *client)
1207{
1208 struct pca953x_platform_data *pdata = dev_get_platdata(&client->dev);
1209 struct pca953x_chip *chip = i2c_get_clientdata(client);
1210
1211 if (pdata && pdata->teardown) {
1212 pdata->teardown(client, chip->gpio_chip.base,
1213 chip->gpio_chip.ngpio, pdata->context);
1214 }
1215
1216 regulator_disable(chip->regulator);
1217}
1218
1219#ifdef CONFIG_PM_SLEEP
1220static int pca953x_regcache_sync(struct device *dev)
1221{
1222 struct pca953x_chip *chip = dev_get_drvdata(dev);
1223 int ret;
1224 u8 regaddr;
1225
1226 /*
1227 * The ordering between direction and output is important,
1228 * sync these registers first and only then sync the rest.
1229 */
1230 regaddr = chip->recalc_addr(chip, chip->regs->direction, 0);
1231 ret = regcache_sync_region(chip->regmap, regaddr, regaddr + NBANK(chip) - 1);
1232 if (ret) {
1233 dev_err(dev, "Failed to sync GPIO dir registers: %d\n", ret);
1234 return ret;
1235 }
1236
1237 regaddr = chip->recalc_addr(chip, chip->regs->output, 0);
1238 ret = regcache_sync_region(chip->regmap, regaddr, regaddr + NBANK(chip) - 1);
1239 if (ret) {
1240 dev_err(dev, "Failed to sync GPIO out registers: %d\n", ret);
1241 return ret;
1242 }
1243
1244#ifdef CONFIG_GPIO_PCA953X_IRQ
1245 if (chip->driver_data & PCA_PCAL) {
1246 regaddr = chip->recalc_addr(chip, PCAL953X_IN_LATCH, 0);
1247 ret = regcache_sync_region(chip->regmap, regaddr,
1248 regaddr + NBANK(chip) - 1);
1249 if (ret) {
1250 dev_err(dev, "Failed to sync INT latch registers: %d\n",
1251 ret);
1252 return ret;
1253 }
1254
1255 regaddr = chip->recalc_addr(chip, PCAL953X_INT_MASK, 0);
1256 ret = regcache_sync_region(chip->regmap, regaddr,
1257 regaddr + NBANK(chip) - 1);
1258 if (ret) {
1259 dev_err(dev, "Failed to sync INT mask registers: %d\n",
1260 ret);
1261 return ret;
1262 }
1263 }
1264#endif
1265
1266 return 0;
1267}
1268
1269static int pca953x_suspend(struct device *dev)
1270{
1271 struct pca953x_chip *chip = dev_get_drvdata(dev);
1272
1273 mutex_lock(&chip->i2c_lock);
1274 regcache_cache_only(chip->regmap, true);
1275 mutex_unlock(&chip->i2c_lock);
1276
1277 if (atomic_read(&chip->wakeup_path))
1278 device_set_wakeup_path(dev);
1279 else
1280 regulator_disable(chip->regulator);
1281
1282 return 0;
1283}
1284
1285static int pca953x_resume(struct device *dev)
1286{
1287 struct pca953x_chip *chip = dev_get_drvdata(dev);
1288 int ret;
1289
1290 if (!atomic_read(&chip->wakeup_path)) {
1291 ret = regulator_enable(chip->regulator);
1292 if (ret) {
1293 dev_err(dev, "Failed to enable regulator: %d\n", ret);
1294 return 0;
1295 }
1296 }
1297
1298 mutex_lock(&chip->i2c_lock);
1299 regcache_cache_only(chip->regmap, false);
1300 regcache_mark_dirty(chip->regmap);
1301 ret = pca953x_regcache_sync(dev);
1302 if (ret) {
1303 mutex_unlock(&chip->i2c_lock);
1304 return ret;
1305 }
1306
1307 ret = regcache_sync(chip->regmap);
1308 mutex_unlock(&chip->i2c_lock);
1309 if (ret) {
1310 dev_err(dev, "Failed to restore register map: %d\n", ret);
1311 return ret;
1312 }
1313
1314 return 0;
1315}
1316#endif
1317
1318/* convenience to stop overlong match-table lines */
1319#define OF_653X(__nrgpio, __int) ((void *)(__nrgpio | PCAL653X_TYPE | __int))
1320#define OF_953X(__nrgpio, __int) (void *)(__nrgpio | PCA953X_TYPE | __int)
1321#define OF_957X(__nrgpio, __int) (void *)(__nrgpio | PCA957X_TYPE | __int)
1322
1323static const struct of_device_id pca953x_dt_ids[] = {
1324 { .compatible = "nxp,pca6408", .data = OF_953X(8, PCA_INT), },
1325 { .compatible = "nxp,pca6416", .data = OF_953X(16, PCA_INT), },
1326 { .compatible = "nxp,pca9505", .data = OF_953X(40, PCA_INT), },
1327 { .compatible = "nxp,pca9506", .data = OF_953X(40, PCA_INT), },
1328 { .compatible = "nxp,pca9534", .data = OF_953X( 8, PCA_INT), },
1329 { .compatible = "nxp,pca9535", .data = OF_953X(16, PCA_INT), },
1330 { .compatible = "nxp,pca9536", .data = OF_953X( 4, 0), },
1331 { .compatible = "nxp,pca9537", .data = OF_953X( 4, PCA_INT), },
1332 { .compatible = "nxp,pca9538", .data = OF_953X( 8, PCA_INT), },
1333 { .compatible = "nxp,pca9539", .data = OF_953X(16, PCA_INT), },
1334 { .compatible = "nxp,pca9554", .data = OF_953X( 8, PCA_INT), },
1335 { .compatible = "nxp,pca9555", .data = OF_953X(16, PCA_INT), },
1336 { .compatible = "nxp,pca9556", .data = OF_953X( 8, 0), },
1337 { .compatible = "nxp,pca9557", .data = OF_953X( 8, 0), },
1338 { .compatible = "nxp,pca9574", .data = OF_957X( 8, PCA_INT), },
1339 { .compatible = "nxp,pca9575", .data = OF_957X(16, PCA_INT), },
1340 { .compatible = "nxp,pca9698", .data = OF_953X(40, 0), },
1341
1342 { .compatible = "nxp,pcal6408", .data = OF_953X(8, PCA_LATCH_INT), },
1343 { .compatible = "nxp,pcal6416", .data = OF_953X(16, PCA_LATCH_INT), },
1344 { .compatible = "nxp,pcal6524", .data = OF_953X(24, PCA_LATCH_INT), },
1345 { .compatible = "nxp,pcal6534", .data = OF_653X(34, PCA_LATCH_INT), },
1346 { .compatible = "nxp,pcal9535", .data = OF_953X(16, PCA_LATCH_INT), },
1347 { .compatible = "nxp,pcal9554b", .data = OF_953X( 8, PCA_LATCH_INT), },
1348 { .compatible = "nxp,pcal9555a", .data = OF_953X(16, PCA_LATCH_INT), },
1349
1350 { .compatible = "maxim,max7310", .data = OF_953X( 8, 0), },
1351 { .compatible = "maxim,max7312", .data = OF_953X(16, PCA_INT), },
1352 { .compatible = "maxim,max7313", .data = OF_953X(16, PCA_INT), },
1353 { .compatible = "maxim,max7315", .data = OF_953X( 8, PCA_INT), },
1354 { .compatible = "maxim,max7318", .data = OF_953X(16, PCA_INT), },
1355
1356 { .compatible = "ti,pca6107", .data = OF_953X( 8, PCA_INT), },
1357 { .compatible = "ti,pca9536", .data = OF_953X( 4, 0), },
1358 { .compatible = "ti,tca6408", .data = OF_953X( 8, PCA_INT), },
1359 { .compatible = "ti,tca6416", .data = OF_953X(16, PCA_INT), },
1360 { .compatible = "ti,tca6424", .data = OF_953X(24, PCA_INT), },
1361 { .compatible = "ti,tca9539", .data = OF_953X(16, PCA_INT), },
1362
1363 { .compatible = "onnn,cat9554", .data = OF_953X( 8, PCA_INT), },
1364 { .compatible = "onnn,pca9654", .data = OF_953X( 8, PCA_INT), },
1365 { .compatible = "onnn,pca9655", .data = OF_953X(16, PCA_INT), },
1366
1367 { .compatible = "exar,xra1202", .data = OF_953X( 8, 0), },
1368 { }
1369};
1370
1371MODULE_DEVICE_TABLE(of, pca953x_dt_ids);
1372
1373static SIMPLE_DEV_PM_OPS(pca953x_pm_ops, pca953x_suspend, pca953x_resume);
1374
1375static struct i2c_driver pca953x_driver = {
1376 .driver = {
1377 .name = "pca953x",
1378 .pm = &pca953x_pm_ops,
1379 .of_match_table = pca953x_dt_ids,
1380 .acpi_match_table = pca953x_acpi_ids,
1381 },
1382 .probe_new = pca953x_probe,
1383 .remove = pca953x_remove,
1384 .id_table = pca953x_id,
1385};
1386
1387static int __init pca953x_init(void)
1388{
1389 return i2c_add_driver(&pca953x_driver);
1390}
1391/* register after i2c postcore initcall and before
1392 * subsys initcalls that may rely on these GPIOs
1393 */
1394subsys_initcall(pca953x_init);
1395
1396static void __exit pca953x_exit(void)
1397{
1398 i2c_del_driver(&pca953x_driver);
1399}
1400module_exit(pca953x_exit);
1401
1402MODULE_AUTHOR("eric miao <eric.miao@marvell.com>");
1403MODULE_DESCRIPTION("GPIO expander driver for PCA953x");
1404MODULE_LICENSE("GPL");