1 // SPDX-License-Identifier: GPL-2.0-only
3 * PCA953x 4/8/16/24/40 bit I/O ports
5 * Copyright (C) 2005 Ben Gardner <bgardner@wabtec.com>
6 * Copyright (C) 2007 Marvell International Ltd.
8 * Derived from drivers/i2c/chips/pca9539.c
11 #include <linux/acpi.h>
12 #include <linux/bitmap.h>
13 #include <linux/gpio/driver.h>
14 #include <linux/gpio/consumer.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/slab.h>
25 #include <asm/unaligned.h>
27 #define PCA953X_INPUT 0x00
28 #define PCA953X_OUTPUT 0x01
29 #define PCA953X_INVERT 0x02
30 #define PCA953X_DIRECTION 0x03
32 #define REG_ADDR_MASK GENMASK(5, 0)
33 #define REG_ADDR_EXT BIT(6)
34 #define REG_ADDR_AI BIT(7)
36 #define PCA957X_IN 0x00
37 #define PCA957X_INVRT 0x01
38 #define PCA957X_BKEN 0x02
39 #define PCA957X_PUPD 0x03
40 #define PCA957X_CFG 0x04
41 #define PCA957X_OUT 0x05
42 #define PCA957X_MSK 0x06
43 #define PCA957X_INTS 0x07
45 #define PCAL953X_OUT_STRENGTH 0x20
46 #define PCAL953X_IN_LATCH 0x22
47 #define PCAL953X_PULL_EN 0x23
48 #define PCAL953X_PULL_SEL 0x24
49 #define PCAL953X_INT_MASK 0x25
50 #define PCAL953X_INT_STAT 0x26
51 #define PCAL953X_OUT_CONF 0x27
53 #define PCAL6524_INT_EDGE 0x28
54 #define PCAL6524_INT_CLR 0x2a
55 #define PCAL6524_IN_STATUS 0x2b
56 #define PCAL6524_OUT_INDCONF 0x2c
57 #define PCAL6524_DEBOUNCE 0x2d
59 #define PCA_GPIO_MASK GENMASK(7, 0)
61 #define PCAL_GPIO_MASK GENMASK(4, 0)
62 #define PCAL_PINCTRL_MASK GENMASK(6, 5)
64 #define PCA_INT BIT(8)
65 #define PCA_PCAL BIT(9)
66 #define PCA_LATCH_INT (PCA_PCAL | PCA_INT)
67 #define PCA953X_TYPE BIT(12)
68 #define PCA957X_TYPE BIT(13)
69 #define PCA_TYPE_MASK GENMASK(15, 12)
71 #define PCA_CHIP_TYPE(x) ((x) & PCA_TYPE_MASK)
73 static const struct i2c_device_id pca953x_id[] = {
74 { "pca6408", 8 | PCA953X_TYPE | PCA_INT, },
75 { "pca6416", 16 | PCA953X_TYPE | PCA_INT, },
76 { "pca9505", 40 | PCA953X_TYPE | PCA_INT, },
77 { "pca9506", 40 | PCA953X_TYPE | PCA_INT, },
78 { "pca9534", 8 | PCA953X_TYPE | PCA_INT, },
79 { "pca9535", 16 | PCA953X_TYPE | PCA_INT, },
80 { "pca9536", 4 | PCA953X_TYPE, },
81 { "pca9537", 4 | PCA953X_TYPE | PCA_INT, },
82 { "pca9538", 8 | PCA953X_TYPE | PCA_INT, },
83 { "pca9539", 16 | PCA953X_TYPE | PCA_INT, },
84 { "pca9554", 8 | PCA953X_TYPE | PCA_INT, },
85 { "pca9555", 16 | PCA953X_TYPE | PCA_INT, },
86 { "pca9556", 8 | PCA953X_TYPE, },
87 { "pca9557", 8 | PCA953X_TYPE, },
88 { "pca9574", 8 | PCA957X_TYPE | PCA_INT, },
89 { "pca9575", 16 | PCA957X_TYPE | PCA_INT, },
90 { "pca9698", 40 | PCA953X_TYPE, },
92 { "pcal6416", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
93 { "pcal6524", 24 | PCA953X_TYPE | PCA_LATCH_INT, },
94 { "pcal9535", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
95 { "pcal9554b", 8 | PCA953X_TYPE | PCA_LATCH_INT, },
96 { "pcal9555a", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
98 { "max7310", 8 | PCA953X_TYPE, },
99 { "max7312", 16 | PCA953X_TYPE | PCA_INT, },
100 { "max7313", 16 | PCA953X_TYPE | PCA_INT, },
101 { "max7315", 8 | PCA953X_TYPE | PCA_INT, },
102 { "max7318", 16 | PCA953X_TYPE | PCA_INT, },
103 { "pca6107", 8 | PCA953X_TYPE | PCA_INT, },
104 { "tca6408", 8 | PCA953X_TYPE | PCA_INT, },
105 { "tca6416", 16 | PCA953X_TYPE | PCA_INT, },
106 { "tca6424", 24 | PCA953X_TYPE | PCA_INT, },
107 { "tca9539", 16 | PCA953X_TYPE | PCA_INT, },
108 { "tca9554", 8 | PCA953X_TYPE | PCA_INT, },
109 { "xra1202", 8 | PCA953X_TYPE },
112 MODULE_DEVICE_TABLE(i2c, pca953x_id);
114 #ifdef CONFIG_GPIO_PCA953X_IRQ
116 #include <linux/dmi.h>
118 static const struct acpi_gpio_params pca953x_irq_gpios = { 0, 0, true };
120 static const struct acpi_gpio_mapping pca953x_acpi_irq_gpios[] = {
121 { "irq-gpios", &pca953x_irq_gpios, 1, ACPI_GPIO_QUIRK_ABSOLUTE_NUMBER },
125 static int pca953x_acpi_get_irq(struct device *dev)
129 ret = devm_acpi_dev_add_driver_gpios(dev, pca953x_acpi_irq_gpios);
131 dev_warn(dev, "can't add GPIO ACPI mapping\n");
133 ret = acpi_dev_gpio_irq_get_by(ACPI_COMPANION(dev), "irq-gpios", 0);
137 dev_info(dev, "ACPI interrupt quirk (IRQ %d)\n", ret);
141 static const struct dmi_system_id pca953x_dmi_acpi_irq_info[] = {
144 * On Intel Galileo Gen 2 board the IRQ pin of one of
145 * the I²C GPIO expanders, which has GpioInt() resource,
146 * is provided as an absolute number instead of being
147 * relative. Since first controller (gpio-sch.c) and
148 * second (gpio-dwapb.c) are at the fixed bases, we may
149 * safely refer to the number in the global space to get
153 DMI_EXACT_MATCH(DMI_BOARD_NAME, "GalileoGen2"),
160 static const struct acpi_device_id pca953x_acpi_ids[] = {
161 { "INT3491", 16 | PCA953X_TYPE | PCA_LATCH_INT, },
164 MODULE_DEVICE_TABLE(acpi, pca953x_acpi_ids);
168 #define MAX_LINE (MAX_BANK * BANK_SZ)
170 #define NBANK(chip) DIV_ROUND_UP(chip->gpio_chip.ngpio, BANK_SZ)
172 struct pca953x_reg_config {
179 static const struct pca953x_reg_config pca953x_regs = {
180 .direction = PCA953X_DIRECTION,
181 .output = PCA953X_OUTPUT,
182 .input = PCA953X_INPUT,
183 .invert = PCA953X_INVERT,
186 static const struct pca953x_reg_config pca957x_regs = {
187 .direction = PCA957X_CFG,
188 .output = PCA957X_OUT,
190 .invert = PCA957X_INVRT,
193 struct pca953x_chip {
195 struct mutex i2c_lock;
196 struct regmap *regmap;
198 #ifdef CONFIG_GPIO_PCA953X_IRQ
199 struct mutex irq_lock;
200 DECLARE_BITMAP(irq_mask, MAX_LINE);
201 DECLARE_BITMAP(irq_stat, MAX_LINE);
202 DECLARE_BITMAP(irq_trig_raise, MAX_LINE);
203 DECLARE_BITMAP(irq_trig_fall, MAX_LINE);
205 atomic_t wakeup_path;
207 struct i2c_client *client;
208 struct gpio_chip gpio_chip;
209 const char *const *names;
210 unsigned long driver_data;
211 struct regulator *regulator;
213 const struct pca953x_reg_config *regs;
216 static int pca953x_bank_shift(struct pca953x_chip *chip)
218 return fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
221 #define PCA953x_BANK_INPUT BIT(0)
222 #define PCA953x_BANK_OUTPUT BIT(1)
223 #define PCA953x_BANK_POLARITY BIT(2)
224 #define PCA953x_BANK_CONFIG BIT(3)
226 #define PCA957x_BANK_INPUT BIT(0)
227 #define PCA957x_BANK_POLARITY BIT(1)
228 #define PCA957x_BANK_BUSHOLD BIT(2)
229 #define PCA957x_BANK_CONFIG BIT(4)
230 #define PCA957x_BANK_OUTPUT BIT(5)
232 #define PCAL9xxx_BANK_IN_LATCH BIT(8 + 2)
233 #define PCAL9xxx_BANK_PULL_EN BIT(8 + 3)
234 #define PCAL9xxx_BANK_PULL_SEL BIT(8 + 4)
235 #define PCAL9xxx_BANK_IRQ_MASK BIT(8 + 5)
236 #define PCAL9xxx_BANK_IRQ_STAT BIT(8 + 6)
239 * We care about the following registers:
240 * - Standard set, below 0x40, each port can be replicated up to 8 times
242 * Input port 0x00 + 0 * bank_size R
243 * Output port 0x00 + 1 * bank_size RW
244 * Polarity Inversion port 0x00 + 2 * bank_size RW
245 * Configuration port 0x00 + 3 * bank_size RW
246 * - PCA957x with mixed up registers
247 * Input port 0x00 + 0 * bank_size R
248 * Polarity Inversion port 0x00 + 1 * bank_size RW
249 * Bus hold port 0x00 + 2 * bank_size RW
250 * Configuration port 0x00 + 4 * bank_size RW
251 * Output port 0x00 + 5 * bank_size RW
253 * - Extended set, above 0x40, often chip specific.
254 * - PCAL6524/PCAL9555A with custom PCAL IRQ handling:
255 * Input latch register 0x40 + 2 * bank_size RW
256 * Pull-up/pull-down enable reg 0x40 + 3 * bank_size RW
257 * Pull-up/pull-down select reg 0x40 + 4 * bank_size RW
258 * Interrupt mask register 0x40 + 5 * bank_size RW
259 * Interrupt status register 0x40 + 6 * bank_size R
261 * - Registers with bit 0x80 set, the AI bit
262 * The bit is cleared and the registers fall into one of the
266 static bool pca953x_check_register(struct pca953x_chip *chip, unsigned int reg,
269 int bank_shift = pca953x_bank_shift(chip);
270 int bank = (reg & REG_ADDR_MASK) >> bank_shift;
271 int offset = reg & (BIT(bank_shift) - 1);
273 /* Special PCAL extended register check. */
274 if (reg & REG_ADDR_EXT) {
275 if (!(chip->driver_data & PCA_PCAL))
280 /* Register is not in the matching bank. */
281 if (!(BIT(bank) & checkbank))
284 /* Register is not within allowed range of bank. */
285 if (offset >= NBANK(chip))
291 static bool pca953x_readable_register(struct device *dev, unsigned int reg)
293 struct pca953x_chip *chip = dev_get_drvdata(dev);
296 if (PCA_CHIP_TYPE(chip->driver_data) == PCA953X_TYPE) {
297 bank = PCA953x_BANK_INPUT | PCA953x_BANK_OUTPUT |
298 PCA953x_BANK_POLARITY | PCA953x_BANK_CONFIG;
300 bank = PCA957x_BANK_INPUT | PCA957x_BANK_OUTPUT |
301 PCA957x_BANK_POLARITY | PCA957x_BANK_CONFIG |
302 PCA957x_BANK_BUSHOLD;
305 if (chip->driver_data & PCA_PCAL) {
306 bank |= PCAL9xxx_BANK_IN_LATCH | PCAL9xxx_BANK_PULL_EN |
307 PCAL9xxx_BANK_PULL_SEL | PCAL9xxx_BANK_IRQ_MASK |
308 PCAL9xxx_BANK_IRQ_STAT;
311 return pca953x_check_register(chip, reg, bank);
314 static bool pca953x_writeable_register(struct device *dev, unsigned int reg)
316 struct pca953x_chip *chip = dev_get_drvdata(dev);
319 if (PCA_CHIP_TYPE(chip->driver_data) == PCA953X_TYPE) {
320 bank = PCA953x_BANK_OUTPUT | PCA953x_BANK_POLARITY |
323 bank = PCA957x_BANK_OUTPUT | PCA957x_BANK_POLARITY |
324 PCA957x_BANK_CONFIG | PCA957x_BANK_BUSHOLD;
327 if (chip->driver_data & PCA_PCAL)
328 bank |= PCAL9xxx_BANK_IN_LATCH | PCAL9xxx_BANK_PULL_EN |
329 PCAL9xxx_BANK_PULL_SEL | PCAL9xxx_BANK_IRQ_MASK;
331 return pca953x_check_register(chip, reg, bank);
334 static bool pca953x_volatile_register(struct device *dev, unsigned int reg)
336 struct pca953x_chip *chip = dev_get_drvdata(dev);
339 if (PCA_CHIP_TYPE(chip->driver_data) == PCA953X_TYPE)
340 bank = PCA953x_BANK_INPUT;
342 bank = PCA957x_BANK_INPUT;
344 if (chip->driver_data & PCA_PCAL)
345 bank |= PCAL9xxx_BANK_IRQ_STAT;
347 return pca953x_check_register(chip, reg, bank);
350 static const struct regmap_config pca953x_i2c_regmap = {
354 .readable_reg = pca953x_readable_register,
355 .writeable_reg = pca953x_writeable_register,
356 .volatile_reg = pca953x_volatile_register,
358 .disable_locking = true,
359 .cache_type = REGCACHE_RBTREE,
360 .max_register = 0x7f,
363 static const struct regmap_config pca953x_ai_i2c_regmap = {
367 .read_flag_mask = REG_ADDR_AI,
368 .write_flag_mask = REG_ADDR_AI,
370 .readable_reg = pca953x_readable_register,
371 .writeable_reg = pca953x_writeable_register,
372 .volatile_reg = pca953x_volatile_register,
374 .disable_locking = true,
375 .cache_type = REGCACHE_RBTREE,
376 .max_register = 0x7f,
379 static u8 pca953x_recalc_addr(struct pca953x_chip *chip, int reg, int off)
381 int bank_shift = pca953x_bank_shift(chip);
382 int addr = (reg & PCAL_GPIO_MASK) << bank_shift;
383 int pinctrl = (reg & PCAL_PINCTRL_MASK) << 1;
384 u8 regaddr = pinctrl | addr | (off / BANK_SZ);
389 static int pca953x_write_regs(struct pca953x_chip *chip, int reg, unsigned long *val)
391 u8 regaddr = pca953x_recalc_addr(chip, reg, 0);
395 for (i = 0; i < NBANK(chip); i++)
396 value[i] = bitmap_get_value8(val, i * BANK_SZ);
398 ret = regmap_bulk_write(chip->regmap, regaddr, value, NBANK(chip));
400 dev_err(&chip->client->dev, "failed writing register\n");
407 static int pca953x_read_regs(struct pca953x_chip *chip, int reg, unsigned long *val)
409 u8 regaddr = pca953x_recalc_addr(chip, reg, 0);
413 ret = regmap_bulk_read(chip->regmap, regaddr, value, NBANK(chip));
415 dev_err(&chip->client->dev, "failed reading register\n");
419 for (i = 0; i < NBANK(chip); i++)
420 bitmap_set_value8(val, value[i], i * BANK_SZ);
425 static int pca953x_gpio_direction_input(struct gpio_chip *gc, unsigned off)
427 struct pca953x_chip *chip = gpiochip_get_data(gc);
428 u8 dirreg = pca953x_recalc_addr(chip, chip->regs->direction, off);
429 u8 bit = BIT(off % BANK_SZ);
432 mutex_lock(&chip->i2c_lock);
433 ret = regmap_write_bits(chip->regmap, dirreg, bit, bit);
434 mutex_unlock(&chip->i2c_lock);
438 static int pca953x_gpio_direction_output(struct gpio_chip *gc,
439 unsigned off, int val)
441 struct pca953x_chip *chip = gpiochip_get_data(gc);
442 u8 dirreg = pca953x_recalc_addr(chip, chip->regs->direction, off);
443 u8 outreg = pca953x_recalc_addr(chip, chip->regs->output, off);
444 u8 bit = BIT(off % BANK_SZ);
447 mutex_lock(&chip->i2c_lock);
448 /* set output level */
449 ret = regmap_write_bits(chip->regmap, outreg, bit, val ? bit : 0);
454 ret = regmap_write_bits(chip->regmap, dirreg, bit, 0);
456 mutex_unlock(&chip->i2c_lock);
460 static int pca953x_gpio_get_value(struct gpio_chip *gc, unsigned off)
462 struct pca953x_chip *chip = gpiochip_get_data(gc);
463 u8 inreg = pca953x_recalc_addr(chip, chip->regs->input, off);
464 u8 bit = BIT(off % BANK_SZ);
468 mutex_lock(&chip->i2c_lock);
469 ret = regmap_read(chip->regmap, inreg, ®_val);
470 mutex_unlock(&chip->i2c_lock);
474 return !!(reg_val & bit);
477 static void pca953x_gpio_set_value(struct gpio_chip *gc, unsigned off, int val)
479 struct pca953x_chip *chip = gpiochip_get_data(gc);
480 u8 outreg = pca953x_recalc_addr(chip, chip->regs->output, off);
481 u8 bit = BIT(off % BANK_SZ);
483 mutex_lock(&chip->i2c_lock);
484 regmap_write_bits(chip->regmap, outreg, bit, val ? bit : 0);
485 mutex_unlock(&chip->i2c_lock);
488 static int pca953x_gpio_get_direction(struct gpio_chip *gc, unsigned off)
490 struct pca953x_chip *chip = gpiochip_get_data(gc);
491 u8 dirreg = pca953x_recalc_addr(chip, chip->regs->direction, off);
492 u8 bit = BIT(off % BANK_SZ);
496 mutex_lock(&chip->i2c_lock);
497 ret = regmap_read(chip->regmap, dirreg, ®_val);
498 mutex_unlock(&chip->i2c_lock);
503 return GPIO_LINE_DIRECTION_IN;
505 return GPIO_LINE_DIRECTION_OUT;
508 static int pca953x_gpio_get_multiple(struct gpio_chip *gc,
509 unsigned long *mask, unsigned long *bits)
511 struct pca953x_chip *chip = gpiochip_get_data(gc);
512 DECLARE_BITMAP(reg_val, MAX_LINE);
515 mutex_lock(&chip->i2c_lock);
516 ret = pca953x_read_regs(chip, chip->regs->input, reg_val);
517 mutex_unlock(&chip->i2c_lock);
521 bitmap_replace(bits, bits, reg_val, mask, gc->ngpio);
525 static void pca953x_gpio_set_multiple(struct gpio_chip *gc,
526 unsigned long *mask, unsigned long *bits)
528 struct pca953x_chip *chip = gpiochip_get_data(gc);
529 DECLARE_BITMAP(reg_val, MAX_LINE);
532 mutex_lock(&chip->i2c_lock);
533 ret = pca953x_read_regs(chip, chip->regs->output, reg_val);
537 bitmap_replace(reg_val, reg_val, bits, mask, gc->ngpio);
539 pca953x_write_regs(chip, chip->regs->output, reg_val);
541 mutex_unlock(&chip->i2c_lock);
544 static int pca953x_gpio_set_pull_up_down(struct pca953x_chip *chip,
546 unsigned long config)
548 u8 pull_en_reg = pca953x_recalc_addr(chip, PCAL953X_PULL_EN, offset);
549 u8 pull_sel_reg = pca953x_recalc_addr(chip, PCAL953X_PULL_SEL, offset);
550 u8 bit = BIT(offset % BANK_SZ);
554 * pull-up/pull-down configuration requires PCAL extended
557 if (!(chip->driver_data & PCA_PCAL))
560 mutex_lock(&chip->i2c_lock);
562 /* Configure pull-up/pull-down */
563 if (config == PIN_CONFIG_BIAS_PULL_UP)
564 ret = regmap_write_bits(chip->regmap, pull_sel_reg, bit, bit);
565 else if (config == PIN_CONFIG_BIAS_PULL_DOWN)
566 ret = regmap_write_bits(chip->regmap, pull_sel_reg, bit, 0);
572 /* Disable/Enable pull-up/pull-down */
573 if (config == PIN_CONFIG_BIAS_DISABLE)
574 ret = regmap_write_bits(chip->regmap, pull_en_reg, bit, 0);
576 ret = regmap_write_bits(chip->regmap, pull_en_reg, bit, bit);
579 mutex_unlock(&chip->i2c_lock);
583 static int pca953x_gpio_set_config(struct gpio_chip *gc, unsigned int offset,
584 unsigned long config)
586 struct pca953x_chip *chip = gpiochip_get_data(gc);
588 switch (pinconf_to_config_param(config)) {
589 case PIN_CONFIG_BIAS_PULL_UP:
590 case PIN_CONFIG_BIAS_PULL_PIN_DEFAULT:
591 case PIN_CONFIG_BIAS_PULL_DOWN:
592 case PIN_CONFIG_BIAS_DISABLE:
593 return pca953x_gpio_set_pull_up_down(chip, offset, config);
599 static void pca953x_setup_gpio(struct pca953x_chip *chip, int gpios)
601 struct gpio_chip *gc;
603 gc = &chip->gpio_chip;
605 gc->direction_input = pca953x_gpio_direction_input;
606 gc->direction_output = pca953x_gpio_direction_output;
607 gc->get = pca953x_gpio_get_value;
608 gc->set = pca953x_gpio_set_value;
609 gc->get_direction = pca953x_gpio_get_direction;
610 gc->get_multiple = pca953x_gpio_get_multiple;
611 gc->set_multiple = pca953x_gpio_set_multiple;
612 gc->set_config = pca953x_gpio_set_config;
613 gc->can_sleep = true;
615 gc->base = chip->gpio_start;
617 gc->label = dev_name(&chip->client->dev);
618 gc->parent = &chip->client->dev;
619 gc->owner = THIS_MODULE;
620 gc->names = chip->names;
623 #ifdef CONFIG_GPIO_PCA953X_IRQ
624 static void pca953x_irq_mask(struct irq_data *d)
626 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
627 struct pca953x_chip *chip = gpiochip_get_data(gc);
628 irq_hw_number_t hwirq = irqd_to_hwirq(d);
630 clear_bit(hwirq, chip->irq_mask);
631 gpiochip_disable_irq(gc, hwirq);
634 static void pca953x_irq_unmask(struct irq_data *d)
636 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
637 struct pca953x_chip *chip = gpiochip_get_data(gc);
638 irq_hw_number_t hwirq = irqd_to_hwirq(d);
640 gpiochip_enable_irq(gc, hwirq);
641 set_bit(hwirq, chip->irq_mask);
644 static int pca953x_irq_set_wake(struct irq_data *d, unsigned int on)
646 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
647 struct pca953x_chip *chip = gpiochip_get_data(gc);
650 atomic_inc(&chip->wakeup_path);
652 atomic_dec(&chip->wakeup_path);
654 return irq_set_irq_wake(chip->client->irq, on);
657 static void pca953x_irq_bus_lock(struct irq_data *d)
659 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
660 struct pca953x_chip *chip = gpiochip_get_data(gc);
662 mutex_lock(&chip->irq_lock);
665 static void pca953x_irq_bus_sync_unlock(struct irq_data *d)
667 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
668 struct pca953x_chip *chip = gpiochip_get_data(gc);
669 DECLARE_BITMAP(irq_mask, MAX_LINE);
670 DECLARE_BITMAP(reg_direction, MAX_LINE);
673 if (chip->driver_data & PCA_PCAL) {
674 /* Enable latch on interrupt-enabled inputs */
675 pca953x_write_regs(chip, PCAL953X_IN_LATCH, chip->irq_mask);
677 bitmap_complement(irq_mask, chip->irq_mask, gc->ngpio);
679 /* Unmask enabled interrupts */
680 pca953x_write_regs(chip, PCAL953X_INT_MASK, irq_mask);
683 /* Switch direction to input if needed */
684 pca953x_read_regs(chip, chip->regs->direction, reg_direction);
686 bitmap_or(irq_mask, chip->irq_trig_fall, chip->irq_trig_raise, gc->ngpio);
687 bitmap_complement(reg_direction, reg_direction, gc->ngpio);
688 bitmap_and(irq_mask, irq_mask, reg_direction, gc->ngpio);
690 /* Look for any newly setup interrupt */
691 for_each_set_bit(level, irq_mask, gc->ngpio)
692 pca953x_gpio_direction_input(&chip->gpio_chip, level);
694 mutex_unlock(&chip->irq_lock);
697 static int pca953x_irq_set_type(struct irq_data *d, unsigned int type)
699 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
700 struct pca953x_chip *chip = gpiochip_get_data(gc);
701 irq_hw_number_t hwirq = irqd_to_hwirq(d);
703 if (!(type & IRQ_TYPE_EDGE_BOTH)) {
704 dev_err(&chip->client->dev, "irq %d: unsupported type %d\n",
709 assign_bit(hwirq, chip->irq_trig_fall, type & IRQ_TYPE_EDGE_FALLING);
710 assign_bit(hwirq, chip->irq_trig_raise, type & IRQ_TYPE_EDGE_RISING);
715 static void pca953x_irq_shutdown(struct irq_data *d)
717 struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
718 struct pca953x_chip *chip = gpiochip_get_data(gc);
719 irq_hw_number_t hwirq = irqd_to_hwirq(d);
721 clear_bit(hwirq, chip->irq_trig_raise);
722 clear_bit(hwirq, chip->irq_trig_fall);
725 static void pca953x_irq_print_chip(struct irq_data *data, struct seq_file *p)
727 struct gpio_chip *gc = irq_data_get_irq_chip_data(data);
729 seq_printf(p, dev_name(gc->parent));
732 static const struct irq_chip pca953x_irq_chip = {
733 .irq_mask = pca953x_irq_mask,
734 .irq_unmask = pca953x_irq_unmask,
735 .irq_set_wake = pca953x_irq_set_wake,
736 .irq_bus_lock = pca953x_irq_bus_lock,
737 .irq_bus_sync_unlock = pca953x_irq_bus_sync_unlock,
738 .irq_set_type = pca953x_irq_set_type,
739 .irq_shutdown = pca953x_irq_shutdown,
740 .irq_print_chip = pca953x_irq_print_chip,
741 .flags = IRQCHIP_IMMUTABLE,
742 GPIOCHIP_IRQ_RESOURCE_HELPERS,
745 static bool pca953x_irq_pending(struct pca953x_chip *chip, unsigned long *pending)
747 struct gpio_chip *gc = &chip->gpio_chip;
748 DECLARE_BITMAP(reg_direction, MAX_LINE);
749 DECLARE_BITMAP(old_stat, MAX_LINE);
750 DECLARE_BITMAP(cur_stat, MAX_LINE);
751 DECLARE_BITMAP(new_stat, MAX_LINE);
752 DECLARE_BITMAP(trigger, MAX_LINE);
755 if (chip->driver_data & PCA_PCAL) {
756 /* Read the current interrupt status from the device */
757 ret = pca953x_read_regs(chip, PCAL953X_INT_STAT, trigger);
761 /* Check latched inputs and clear interrupt status */
762 ret = pca953x_read_regs(chip, chip->regs->input, cur_stat);
766 /* Apply filter for rising/falling edge selection */
767 bitmap_replace(new_stat, chip->irq_trig_fall, chip->irq_trig_raise, cur_stat, gc->ngpio);
769 bitmap_and(pending, new_stat, trigger, gc->ngpio);
771 return !bitmap_empty(pending, gc->ngpio);
774 ret = pca953x_read_regs(chip, chip->regs->input, cur_stat);
778 /* Remove output pins from the equation */
779 pca953x_read_regs(chip, chip->regs->direction, reg_direction);
781 bitmap_copy(old_stat, chip->irq_stat, gc->ngpio);
783 bitmap_and(new_stat, cur_stat, reg_direction, gc->ngpio);
784 bitmap_xor(cur_stat, new_stat, old_stat, gc->ngpio);
785 bitmap_and(trigger, cur_stat, chip->irq_mask, gc->ngpio);
787 bitmap_copy(chip->irq_stat, new_stat, gc->ngpio);
789 if (bitmap_empty(trigger, gc->ngpio))
792 bitmap_and(cur_stat, chip->irq_trig_fall, old_stat, gc->ngpio);
793 bitmap_and(old_stat, chip->irq_trig_raise, new_stat, gc->ngpio);
794 bitmap_or(new_stat, old_stat, cur_stat, gc->ngpio);
795 bitmap_and(pending, new_stat, trigger, gc->ngpio);
797 return !bitmap_empty(pending, gc->ngpio);
800 static irqreturn_t pca953x_irq_handler(int irq, void *devid)
802 struct pca953x_chip *chip = devid;
803 struct gpio_chip *gc = &chip->gpio_chip;
804 DECLARE_BITMAP(pending, MAX_LINE);
808 bitmap_zero(pending, MAX_LINE);
810 mutex_lock(&chip->i2c_lock);
811 ret = pca953x_irq_pending(chip, pending);
812 mutex_unlock(&chip->i2c_lock);
817 for_each_set_bit(level, pending, gc->ngpio) {
818 int nested_irq = irq_find_mapping(gc->irq.domain, level);
820 if (unlikely(nested_irq <= 0)) {
821 dev_warn_ratelimited(gc->parent, "unmapped interrupt %d\n", level);
825 handle_nested_irq(nested_irq);
830 return IRQ_RETVAL(ret);
833 static int pca953x_irq_setup(struct pca953x_chip *chip, int irq_base)
835 struct i2c_client *client = chip->client;
836 DECLARE_BITMAP(reg_direction, MAX_LINE);
837 DECLARE_BITMAP(irq_stat, MAX_LINE);
838 struct gpio_irq_chip *girq;
841 if (dmi_first_match(pca953x_dmi_acpi_irq_info)) {
842 ret = pca953x_acpi_get_irq(&client->dev);
853 if (!(chip->driver_data & PCA_INT))
856 ret = pca953x_read_regs(chip, chip->regs->input, irq_stat);
861 * There is no way to know which GPIO line generated the
862 * interrupt. We have to rely on the previous read for
865 pca953x_read_regs(chip, chip->regs->direction, reg_direction);
866 bitmap_and(chip->irq_stat, irq_stat, reg_direction, chip->gpio_chip.ngpio);
867 mutex_init(&chip->irq_lock);
869 girq = &chip->gpio_chip.irq;
870 gpio_irq_chip_set_chip(girq, &pca953x_irq_chip);
871 /* This will let us handle the parent IRQ in the driver */
872 girq->parent_handler = NULL;
873 girq->num_parents = 0;
874 girq->parents = NULL;
875 girq->default_type = IRQ_TYPE_NONE;
876 girq->handler = handle_simple_irq;
877 girq->threaded = true;
878 girq->first = irq_base; /* FIXME: get rid of this */
880 ret = devm_request_threaded_irq(&client->dev, client->irq,
881 NULL, pca953x_irq_handler,
882 IRQF_ONESHOT | IRQF_SHARED,
883 dev_name(&client->dev), chip);
885 dev_err(&client->dev, "failed to request irq %d\n",
893 #else /* CONFIG_GPIO_PCA953X_IRQ */
894 static int pca953x_irq_setup(struct pca953x_chip *chip,
897 struct i2c_client *client = chip->client;
899 if (client->irq && irq_base != -1 && (chip->driver_data & PCA_INT))
900 dev_warn(&client->dev, "interrupt support not compiled in\n");
906 static int device_pca95xx_init(struct pca953x_chip *chip, u32 invert)
908 DECLARE_BITMAP(val, MAX_LINE);
911 ret = regcache_sync_region(chip->regmap, chip->regs->output,
912 chip->regs->output + NBANK(chip));
916 ret = regcache_sync_region(chip->regmap, chip->regs->direction,
917 chip->regs->direction + NBANK(chip));
921 /* set platform specific polarity inversion */
923 bitmap_fill(val, MAX_LINE);
925 bitmap_zero(val, MAX_LINE);
927 ret = pca953x_write_regs(chip, chip->regs->invert, val);
932 static int device_pca957x_init(struct pca953x_chip *chip, u32 invert)
934 DECLARE_BITMAP(val, MAX_LINE);
938 ret = device_pca95xx_init(chip, invert);
942 /* To enable register 6, 7 to control pull up and pull down */
943 for (i = 0; i < NBANK(chip); i++)
944 bitmap_set_value8(val, 0x02, i * BANK_SZ);
946 ret = pca953x_write_regs(chip, PCA957X_BKEN, val);
955 static int pca953x_probe(struct i2c_client *client,
956 const struct i2c_device_id *i2c_id)
958 struct pca953x_platform_data *pdata;
959 struct pca953x_chip *chip;
963 struct regulator *reg;
964 const struct regmap_config *regmap_config;
966 chip = devm_kzalloc(&client->dev, sizeof(*chip), GFP_KERNEL);
970 pdata = dev_get_platdata(&client->dev);
972 irq_base = pdata->irq_base;
973 chip->gpio_start = pdata->gpio_base;
974 invert = pdata->invert;
975 chip->names = pdata->names;
977 struct gpio_desc *reset_gpio;
979 chip->gpio_start = -1;
983 * See if we need to de-assert a reset pin.
985 * There is no known ACPI-enabled platforms that are
986 * using "reset" GPIO. Otherwise any of those platform
987 * must use _DSD method with corresponding property.
989 reset_gpio = devm_gpiod_get_optional(&client->dev, "reset",
991 if (IS_ERR(reset_gpio))
992 return PTR_ERR(reset_gpio);
995 chip->client = client;
997 reg = devm_regulator_get(&client->dev, "vcc");
999 return dev_err_probe(&client->dev, PTR_ERR(reg), "reg get err\n");
1001 ret = regulator_enable(reg);
1003 dev_err(&client->dev, "reg en err: %d\n", ret);
1006 chip->regulator = reg;
1009 chip->driver_data = i2c_id->driver_data;
1013 match = device_get_match_data(&client->dev);
1019 chip->driver_data = (uintptr_t)match;
1022 i2c_set_clientdata(client, chip);
1024 pca953x_setup_gpio(chip, chip->driver_data & PCA_GPIO_MASK);
1026 if (NBANK(chip) > 2 || PCA_CHIP_TYPE(chip->driver_data) == PCA957X_TYPE) {
1027 dev_info(&client->dev, "using AI\n");
1028 regmap_config = &pca953x_ai_i2c_regmap;
1030 dev_info(&client->dev, "using no AI\n");
1031 regmap_config = &pca953x_i2c_regmap;
1034 chip->regmap = devm_regmap_init_i2c(client, regmap_config);
1035 if (IS_ERR(chip->regmap)) {
1036 ret = PTR_ERR(chip->regmap);
1040 regcache_mark_dirty(chip->regmap);
1042 mutex_init(&chip->i2c_lock);
1044 * In case we have an i2c-mux controlled by a GPIO provided by an
1045 * expander using the same driver higher on the device tree, read the
1046 * i2c adapter nesting depth and use the retrieved value as lockdep
1047 * subclass for chip->i2c_lock.
1049 * REVISIT: This solution is not complete. It protects us from lockdep
1050 * false positives when the expander controlling the i2c-mux is on
1051 * a different level on the device tree, but not when it's on the same
1052 * level on a different branch (in which case the subclass number
1053 * would be the same).
1055 * TODO: Once a correct solution is developed, a similar fix should be
1056 * applied to all other i2c-controlled GPIO expanders (and potentially
1059 lockdep_set_subclass(&chip->i2c_lock,
1060 i2c_adapter_depth(client->adapter));
1062 /* initialize cached registers from their original values.
1063 * we can't share this chip with another i2c master.
1066 if (PCA_CHIP_TYPE(chip->driver_data) == PCA953X_TYPE) {
1067 chip->regs = &pca953x_regs;
1068 ret = device_pca95xx_init(chip, invert);
1070 chip->regs = &pca957x_regs;
1071 ret = device_pca957x_init(chip, invert);
1076 ret = pca953x_irq_setup(chip, irq_base);
1080 ret = devm_gpiochip_add_data(&client->dev, &chip->gpio_chip, chip);
1084 if (pdata && pdata->setup) {
1085 ret = pdata->setup(client, chip->gpio_chip.base,
1086 chip->gpio_chip.ngpio, pdata->context);
1088 dev_warn(&client->dev, "setup failed, %d\n", ret);
1094 regulator_disable(chip->regulator);
1098 static int pca953x_remove(struct i2c_client *client)
1100 struct pca953x_platform_data *pdata = dev_get_platdata(&client->dev);
1101 struct pca953x_chip *chip = i2c_get_clientdata(client);
1104 if (pdata && pdata->teardown) {
1105 ret = pdata->teardown(client, chip->gpio_chip.base,
1106 chip->gpio_chip.ngpio, pdata->context);
1108 dev_err(&client->dev, "teardown failed, %d\n", ret);
1113 regulator_disable(chip->regulator);
1118 #ifdef CONFIG_PM_SLEEP
1119 static int pca953x_regcache_sync(struct device *dev)
1121 struct pca953x_chip *chip = dev_get_drvdata(dev);
1126 * The ordering between direction and output is important,
1127 * sync these registers first and only then sync the rest.
1129 regaddr = pca953x_recalc_addr(chip, chip->regs->direction, 0);
1130 ret = regcache_sync_region(chip->regmap, regaddr, regaddr + NBANK(chip));
1132 dev_err(dev, "Failed to sync GPIO dir registers: %d\n", ret);
1136 regaddr = pca953x_recalc_addr(chip, chip->regs->output, 0);
1137 ret = regcache_sync_region(chip->regmap, regaddr, regaddr + NBANK(chip));
1139 dev_err(dev, "Failed to sync GPIO out registers: %d\n", ret);
1143 #ifdef CONFIG_GPIO_PCA953X_IRQ
1144 if (chip->driver_data & PCA_PCAL) {
1145 regaddr = pca953x_recalc_addr(chip, PCAL953X_IN_LATCH, 0);
1146 ret = regcache_sync_region(chip->regmap, regaddr,
1147 regaddr + NBANK(chip));
1149 dev_err(dev, "Failed to sync INT latch registers: %d\n",
1154 regaddr = pca953x_recalc_addr(chip, PCAL953X_INT_MASK, 0);
1155 ret = regcache_sync_region(chip->regmap, regaddr,
1156 regaddr + NBANK(chip));
1158 dev_err(dev, "Failed to sync INT mask registers: %d\n",
1168 static int pca953x_suspend(struct device *dev)
1170 struct pca953x_chip *chip = dev_get_drvdata(dev);
1172 regcache_cache_only(chip->regmap, true);
1174 if (atomic_read(&chip->wakeup_path))
1175 device_set_wakeup_path(dev);
1177 regulator_disable(chip->regulator);
1182 static int pca953x_resume(struct device *dev)
1184 struct pca953x_chip *chip = dev_get_drvdata(dev);
1187 if (!atomic_read(&chip->wakeup_path)) {
1188 ret = regulator_enable(chip->regulator);
1190 dev_err(dev, "Failed to enable regulator: %d\n", ret);
1195 regcache_cache_only(chip->regmap, false);
1196 regcache_mark_dirty(chip->regmap);
1197 ret = pca953x_regcache_sync(dev);
1201 ret = regcache_sync(chip->regmap);
1203 dev_err(dev, "Failed to restore register map: %d\n", ret);
1211 /* convenience to stop overlong match-table lines */
1212 #define OF_953X(__nrgpio, __int) (void *)(__nrgpio | PCA953X_TYPE | __int)
1213 #define OF_957X(__nrgpio, __int) (void *)(__nrgpio | PCA957X_TYPE | __int)
1215 static const struct of_device_id pca953x_dt_ids[] = {
1216 { .compatible = "nxp,pca6408", .data = OF_953X(8, PCA_INT), },
1217 { .compatible = "nxp,pca6416", .data = OF_953X(16, PCA_INT), },
1218 { .compatible = "nxp,pca9505", .data = OF_953X(40, PCA_INT), },
1219 { .compatible = "nxp,pca9506", .data = OF_953X(40, PCA_INT), },
1220 { .compatible = "nxp,pca9534", .data = OF_953X( 8, PCA_INT), },
1221 { .compatible = "nxp,pca9535", .data = OF_953X(16, PCA_INT), },
1222 { .compatible = "nxp,pca9536", .data = OF_953X( 4, 0), },
1223 { .compatible = "nxp,pca9537", .data = OF_953X( 4, PCA_INT), },
1224 { .compatible = "nxp,pca9538", .data = OF_953X( 8, PCA_INT), },
1225 { .compatible = "nxp,pca9539", .data = OF_953X(16, PCA_INT), },
1226 { .compatible = "nxp,pca9554", .data = OF_953X( 8, PCA_INT), },
1227 { .compatible = "nxp,pca9555", .data = OF_953X(16, PCA_INT), },
1228 { .compatible = "nxp,pca9556", .data = OF_953X( 8, 0), },
1229 { .compatible = "nxp,pca9557", .data = OF_953X( 8, 0), },
1230 { .compatible = "nxp,pca9574", .data = OF_957X( 8, PCA_INT), },
1231 { .compatible = "nxp,pca9575", .data = OF_957X(16, PCA_INT), },
1232 { .compatible = "nxp,pca9698", .data = OF_953X(40, 0), },
1234 { .compatible = "nxp,pcal6416", .data = OF_953X(16, PCA_LATCH_INT), },
1235 { .compatible = "nxp,pcal6524", .data = OF_953X(24, PCA_LATCH_INT), },
1236 { .compatible = "nxp,pcal9535", .data = OF_953X(16, PCA_LATCH_INT), },
1237 { .compatible = "nxp,pcal9554b", .data = OF_953X( 8, PCA_LATCH_INT), },
1238 { .compatible = "nxp,pcal9555a", .data = OF_953X(16, PCA_LATCH_INT), },
1240 { .compatible = "maxim,max7310", .data = OF_953X( 8, 0), },
1241 { .compatible = "maxim,max7312", .data = OF_953X(16, PCA_INT), },
1242 { .compatible = "maxim,max7313", .data = OF_953X(16, PCA_INT), },
1243 { .compatible = "maxim,max7315", .data = OF_953X( 8, PCA_INT), },
1244 { .compatible = "maxim,max7318", .data = OF_953X(16, PCA_INT), },
1246 { .compatible = "ti,pca6107", .data = OF_953X( 8, PCA_INT), },
1247 { .compatible = "ti,pca9536", .data = OF_953X( 4, 0), },
1248 { .compatible = "ti,tca6408", .data = OF_953X( 8, PCA_INT), },
1249 { .compatible = "ti,tca6416", .data = OF_953X(16, PCA_INT), },
1250 { .compatible = "ti,tca6424", .data = OF_953X(24, PCA_INT), },
1251 { .compatible = "ti,tca9539", .data = OF_953X(16, PCA_INT), },
1253 { .compatible = "onnn,cat9554", .data = OF_953X( 8, PCA_INT), },
1254 { .compatible = "onnn,pca9654", .data = OF_953X( 8, PCA_INT), },
1255 { .compatible = "onnn,pca9655", .data = OF_953X(16, PCA_INT), },
1257 { .compatible = "exar,xra1202", .data = OF_953X( 8, 0), },
1261 MODULE_DEVICE_TABLE(of, pca953x_dt_ids);
1263 static SIMPLE_DEV_PM_OPS(pca953x_pm_ops, pca953x_suspend, pca953x_resume);
1265 static struct i2c_driver pca953x_driver = {
1268 .pm = &pca953x_pm_ops,
1269 .of_match_table = pca953x_dt_ids,
1270 .acpi_match_table = pca953x_acpi_ids,
1272 .probe = pca953x_probe,
1273 .remove = pca953x_remove,
1274 .id_table = pca953x_id,
1277 static int __init pca953x_init(void)
1279 return i2c_add_driver(&pca953x_driver);
1281 /* register after i2c postcore initcall and before
1282 * subsys initcalls that may rely on these GPIOs
1284 subsys_initcall(pca953x_init);
1286 static void __exit pca953x_exit(void)
1288 i2c_del_driver(&pca953x_driver);
1290 module_exit(pca953x_exit);
1292 MODULE_AUTHOR("eric miao <eric.miao@marvell.com>");
1293 MODULE_DESCRIPTION("GPIO expander driver for PCA953x");
1294 MODULE_LICENSE("GPL");