2 * PCA953x 4/8/16/24/40 bit I/O ports
4 * Copyright (C) 2005 Ben Gardner <bgardner@wabtec.com>
5 * Copyright (C) 2007 Marvell International Ltd.
7 * Derived from drivers/i2c/chips/pca9539.c
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.
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>
24 #include <linux/of_platform.h>
27 #define PCA953X_INPUT 0
28 #define PCA953X_OUTPUT 1
29 #define PCA953X_INVERT 2
30 #define PCA953X_DIRECTION 3
32 #define REG_ADDR_AI 0x80
35 #define PCA957X_INVRT 1
36 #define PCA957X_BKEN 2
37 #define PCA957X_PUPD 3
41 #define PCA957X_INTS 7
43 #define PCA_GPIO_MASK 0x00FF
44 #define PCA_INT 0x0100
45 #define PCA953X_TYPE 0x1000
46 #define PCA957X_TYPE 0x2000
48 static 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, },
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 },
75 MODULE_DEVICE_TABLE(i2c, pca953x_id);
80 #define NBANK(chip) (chip->gpio_chip.ngpio / BANK_SZ)
84 u8 reg_output[MAX_BANK];
85 u8 reg_direction[MAX_BANK];
86 struct mutex i2c_lock;
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;
97 struct i2c_client *client;
98 struct gpio_chip gpio_chip;
99 const char *const *names;
103 static int pca953x_read_single(struct pca953x_chip *chip, int reg, u32 *val,
107 int bank_shift = fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
108 int offset = off / BANK_SZ;
110 ret = i2c_smbus_read_byte_data(chip->client,
111 (reg << bank_shift) + offset);
115 dev_err(&chip->client->dev, "failed reading register\n");
122 static int pca953x_write_single(struct pca953x_chip *chip, int reg, u32 val,
126 int bank_shift = fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
127 int offset = off / BANK_SZ;
129 ret = i2c_smbus_write_byte_data(chip->client,
130 (reg << bank_shift) + offset, val);
133 dev_err(&chip->client->dev, "failed writing register\n");
140 static int pca953x_write_regs(struct pca953x_chip *chip, int reg, u8 *val)
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,
152 switch (chip->chip_type) {
154 ret = i2c_smbus_write_word_data(chip->client,
155 reg << 1, (u16) *val);
158 ret = i2c_smbus_write_byte_data(chip->client, reg << 1,
162 ret = i2c_smbus_write_byte_data(chip->client,
170 dev_err(&chip->client->dev, "failed writing register\n");
177 static int pca953x_read_regs(struct pca953x_chip *chip, int reg, u8 *val)
181 if (chip->gpio_chip.ngpio <= 8) {
182 ret = i2c_smbus_read_byte_data(chip->client, reg);
184 } else if (chip->gpio_chip.ngpio >= 24) {
185 int bank_shift = fls((chip->gpio_chip.ngpio - 1) / BANK_SZ);
187 ret = i2c_smbus_read_i2c_block_data(chip->client,
188 (reg << bank_shift) | REG_ADDR_AI,
191 ret = i2c_smbus_read_word_data(chip->client, reg << 1);
192 val[0] = (u16)ret & 0xFF;
193 val[1] = (u16)ret >> 8;
196 dev_err(&chip->client->dev, "failed reading register\n");
203 static int pca953x_gpio_direction_input(struct gpio_chip *gc, unsigned off)
205 struct pca953x_chip *chip;
209 chip = container_of(gc, struct pca953x_chip, gpio_chip);
211 mutex_lock(&chip->i2c_lock);
212 reg_val = chip->reg_direction[off / BANK_SZ] | (1u << (off % BANK_SZ));
214 switch (chip->chip_type) {
216 offset = PCA953X_DIRECTION;
219 offset = PCA957X_CFG;
222 ret = pca953x_write_single(chip, offset, reg_val, off);
226 chip->reg_direction[off / BANK_SZ] = reg_val;
229 mutex_unlock(&chip->i2c_lock);
233 static int pca953x_gpio_direction_output(struct gpio_chip *gc,
234 unsigned off, int val)
236 struct pca953x_chip *chip;
240 chip = container_of(gc, struct pca953x_chip, gpio_chip);
242 mutex_lock(&chip->i2c_lock);
243 /* set output level */
245 reg_val = chip->reg_output[off / BANK_SZ]
246 | (1u << (off % BANK_SZ));
248 reg_val = chip->reg_output[off / BANK_SZ]
249 & ~(1u << (off % BANK_SZ));
251 switch (chip->chip_type) {
253 offset = PCA953X_OUTPUT;
256 offset = PCA957X_OUT;
259 ret = pca953x_write_single(chip, offset, reg_val, off);
263 chip->reg_output[off / BANK_SZ] = reg_val;
266 reg_val = chip->reg_direction[off / BANK_SZ] & ~(1u << (off % BANK_SZ));
267 switch (chip->chip_type) {
269 offset = PCA953X_DIRECTION;
272 offset = PCA957X_CFG;
275 ret = pca953x_write_single(chip, offset, reg_val, off);
279 chip->reg_direction[off / BANK_SZ] = reg_val;
282 mutex_unlock(&chip->i2c_lock);
286 static int pca953x_gpio_get_value(struct gpio_chip *gc, unsigned off)
288 struct pca953x_chip *chip;
292 chip = container_of(gc, struct pca953x_chip, gpio_chip);
294 mutex_lock(&chip->i2c_lock);
295 switch (chip->chip_type) {
297 offset = PCA953X_INPUT;
303 ret = pca953x_read_single(chip, offset, ®_val, off);
304 mutex_unlock(&chip->i2c_lock);
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).
313 return (reg_val & (1u << (off % BANK_SZ))) ? 1 : 0;
316 static void pca953x_gpio_set_value(struct gpio_chip *gc, unsigned off, int val)
318 struct pca953x_chip *chip;
322 chip = container_of(gc, struct pca953x_chip, gpio_chip);
324 mutex_lock(&chip->i2c_lock);
326 reg_val = chip->reg_output[off / BANK_SZ]
327 | (1u << (off % BANK_SZ));
329 reg_val = chip->reg_output[off / BANK_SZ]
330 & ~(1u << (off % BANK_SZ));
332 switch (chip->chip_type) {
334 offset = PCA953X_OUTPUT;
337 offset = PCA957X_OUT;
340 ret = pca953x_write_single(chip, offset, reg_val, off);
344 chip->reg_output[off / BANK_SZ] = reg_val;
346 mutex_unlock(&chip->i2c_lock);
349 static void pca953x_setup_gpio(struct pca953x_chip *chip, int gpios)
351 struct gpio_chip *gc;
353 gc = &chip->gpio_chip;
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;
361 gc->base = chip->gpio_start;
363 gc->label = chip->client->name;
364 gc->dev = &chip->client->dev;
365 gc->owner = THIS_MODULE;
366 gc->names = chip->names;
369 #ifdef CONFIG_GPIO_PCA953X_IRQ
370 static int pca953x_gpio_to_irq(struct gpio_chip *gc, unsigned off)
372 struct pca953x_chip *chip;
374 chip = container_of(gc, struct pca953x_chip, gpio_chip);
375 return irq_create_mapping(chip->domain, off);
378 static void pca953x_irq_mask(struct irq_data *d)
380 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
382 chip->irq_mask[d->hwirq / BANK_SZ] &= ~(1 << (d->hwirq % BANK_SZ));
385 static void pca953x_irq_unmask(struct irq_data *d)
387 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
389 chip->irq_mask[d->hwirq / BANK_SZ] |= 1 << (d->hwirq % BANK_SZ);
392 static void pca953x_irq_bus_lock(struct irq_data *d)
394 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
396 mutex_lock(&chip->irq_lock);
399 static void pca953x_irq_bus_sync_unlock(struct irq_data *d)
401 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
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];
411 level = __ffs(new_irqs);
412 pca953x_gpio_direction_input(&chip->gpio_chip,
413 level + (BANK_SZ * i));
414 new_irqs &= ~(1 << level);
418 mutex_unlock(&chip->irq_lock);
421 static int pca953x_irq_set_type(struct irq_data *d, unsigned int type)
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);
427 if (!(type & IRQ_TYPE_EDGE_BOTH)) {
428 dev_err(&chip->client->dev, "irq %d: unsupported type %d\n",
433 if (type & IRQ_TYPE_EDGE_FALLING)
434 chip->irq_trig_fall[bank_nb] |= mask;
436 chip->irq_trig_fall[bank_nb] &= ~mask;
438 if (type & IRQ_TYPE_EDGE_RISING)
439 chip->irq_trig_raise[bank_nb] |= mask;
441 chip->irq_trig_raise[bank_nb] &= ~mask;
446 static struct irq_chip pca953x_irq_chip = {
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,
455 static u8 pca953x_irq_pending(struct pca953x_chip *chip, u8 *pending)
457 u8 cur_stat[MAX_BANK];
458 u8 old_stat[MAX_BANK];
460 u8 trigger[MAX_BANK], triggers = 0;
461 int ret, i, offset = 0;
463 switch (chip->chip_type) {
465 offset = PCA953X_INPUT;
471 ret = pca953x_read_regs(chip, offset, cur_stat);
475 /* Remove output pins from the equation */
476 for (i = 0; i < NBANK(chip); i++)
477 cur_stat[i] &= chip->reg_direction[i];
479 memcpy(old_stat, chip->irq_stat, NBANK(chip));
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];
489 memcpy(chip->irq_stat, cur_stat, NBANK(chip));
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];
501 static irqreturn_t pca953x_irq_handler(int irq, void *devid)
503 struct pca953x_chip *chip = devid;
504 u8 pending[MAX_BANK];
506 unsigned nhandled = 0;
509 if (!pca953x_irq_pending(chip, pending))
512 for (i = 0; i < NBANK(chip); i++) {
514 level = __ffs(pending[i]);
515 handle_nested_irq(irq_find_mapping(chip->domain,
516 level + (BANK_SZ * i)));
517 pending[i] &= ~(1 << level);
522 return (nhandled > 0) ? IRQ_HANDLED : IRQ_NONE;
525 static int pca953x_gpio_irq_map(struct irq_domain *d, unsigned int irq,
526 irq_hw_number_t hwirq)
528 irq_clear_status_flags(irq, IRQ_NOREQUEST);
529 irq_set_chip_data(irq, d->host_data);
530 irq_set_chip(irq, &pca953x_irq_chip);
531 irq_set_nested_thread(irq, true);
533 set_irq_flags(irq, IRQF_VALID);
535 irq_set_noprobe(irq);
541 static const struct irq_domain_ops pca953x_irq_simple_ops = {
542 .map = pca953x_gpio_irq_map,
543 .xlate = irq_domain_xlate_twocell,
546 static int pca953x_irq_setup(struct pca953x_chip *chip,
547 const struct i2c_device_id *id,
550 struct i2c_client *client = chip->client;
551 int ret, i, offset = 0;
554 && (id->driver_data & PCA_INT)) {
556 switch (chip->chip_type) {
558 offset = PCA953X_INPUT;
564 ret = pca953x_read_regs(chip, offset, chip->irq_stat);
569 * There is no way to know which GPIO line generated the
570 * interrupt. We have to rely on the previous read for
573 for (i = 0; i < NBANK(chip); i++)
574 chip->irq_stat[i] &= chip->reg_direction[i];
575 mutex_init(&chip->irq_lock);
577 chip->domain = irq_domain_add_simple(client->dev.of_node,
578 chip->gpio_chip.ngpio,
580 &pca953x_irq_simple_ops,
585 ret = devm_request_threaded_irq(&client->dev,
589 IRQF_TRIGGER_LOW | IRQF_ONESHOT |
591 dev_name(&client->dev), chip);
593 dev_err(&client->dev, "failed to request irq %d\n",
598 chip->gpio_chip.to_irq = pca953x_gpio_to_irq;
604 #else /* CONFIG_GPIO_PCA953X_IRQ */
605 static int pca953x_irq_setup(struct pca953x_chip *chip,
606 const struct i2c_device_id *id,
609 struct i2c_client *client = chip->client;
611 if (irq_base != -1 && (id->driver_data & PCA_INT))
612 dev_warn(&client->dev, "interrupt support not compiled in\n");
619 * Handlers for alternative sources of platform_data
621 #ifdef CONFIG_OF_GPIO
623 * Translate OpenFirmware node properties into platform_data
624 * WARNING: This is DEPRECATED and will be removed eventually!
627 pca953x_get_alt_pdata(struct i2c_client *client, int *gpio_base, u32 *invert)
629 struct device_node *node;
635 node = client->dev.of_node;
639 val = of_get_property(node, "linux,gpio-base", &size);
640 WARN(val, "%s: device-tree property 'linux,gpio-base' is deprecated!", __func__);
642 if (size != sizeof(*val))
643 dev_warn(&client->dev, "%s: wrong linux,gpio-base\n",
646 *gpio_base = be32_to_cpup(val);
649 val = of_get_property(node, "polarity", NULL);
650 WARN(val, "%s: device-tree property 'polarity' is deprecated!", __func__);
656 pca953x_get_alt_pdata(struct i2c_client *client, int *gpio_base, u32 *invert)
662 static int device_pca953x_init(struct pca953x_chip *chip, u32 invert)
667 ret = pca953x_read_regs(chip, PCA953X_OUTPUT, chip->reg_output);
671 ret = pca953x_read_regs(chip, PCA953X_DIRECTION,
672 chip->reg_direction);
676 /* set platform specific polarity inversion */
678 memset(val, 0xFF, NBANK(chip));
680 memset(val, 0, NBANK(chip));
682 ret = pca953x_write_regs(chip, PCA953X_INVERT, val);
687 static int device_pca957x_init(struct pca953x_chip *chip, u32 invert)
692 ret = pca953x_read_regs(chip, PCA957X_OUT, chip->reg_output);
695 ret = pca953x_read_regs(chip, PCA957X_CFG, chip->reg_direction);
699 /* set platform specific polarity inversion */
701 memset(val, 0xFF, NBANK(chip));
703 memset(val, 0, NBANK(chip));
704 pca953x_write_regs(chip, PCA957X_INVRT, val);
706 /* To enable register 6, 7 to controll pull up and pull down */
707 memset(val, 0x02, NBANK(chip));
708 pca953x_write_regs(chip, PCA957X_BKEN, val);
715 static int pca953x_probe(struct i2c_client *client,
716 const struct i2c_device_id *id)
718 struct pca953x_platform_data *pdata;
719 struct pca953x_chip *chip;
724 chip = devm_kzalloc(&client->dev,
725 sizeof(struct pca953x_chip), GFP_KERNEL);
729 pdata = dev_get_platdata(&client->dev);
731 irq_base = pdata->irq_base;
732 chip->gpio_start = pdata->gpio_base;
733 invert = pdata->invert;
734 chip->names = pdata->names;
736 pca953x_get_alt_pdata(client, &chip->gpio_start, &invert);
737 #ifdef CONFIG_OF_GPIO
738 /* If I2C node has no interrupts property, disable GPIO interrupts */
739 if (of_find_property(client->dev.of_node, "interrupts", NULL) == NULL)
744 chip->client = client;
746 chip->chip_type = id->driver_data & (PCA953X_TYPE | PCA957X_TYPE);
748 mutex_init(&chip->i2c_lock);
750 /* initialize cached registers from their original values.
751 * we can't share this chip with another i2c master.
753 pca953x_setup_gpio(chip, id->driver_data & PCA_GPIO_MASK);
755 if (chip->chip_type == PCA953X_TYPE)
756 ret = device_pca953x_init(chip, invert);
758 ret = device_pca957x_init(chip, invert);
762 ret = pca953x_irq_setup(chip, id, irq_base);
766 ret = gpiochip_add(&chip->gpio_chip);
770 if (pdata && pdata->setup) {
771 ret = pdata->setup(client, chip->gpio_chip.base,
772 chip->gpio_chip.ngpio, pdata->context);
774 dev_warn(&client->dev, "setup failed, %d\n", ret);
777 i2c_set_clientdata(client, chip);
781 static int pca953x_remove(struct i2c_client *client)
783 struct pca953x_platform_data *pdata = dev_get_platdata(&client->dev);
784 struct pca953x_chip *chip = i2c_get_clientdata(client);
787 if (pdata && pdata->teardown) {
788 ret = pdata->teardown(client, chip->gpio_chip.base,
789 chip->gpio_chip.ngpio, pdata->context);
791 dev_err(&client->dev, "%s failed, %d\n",
797 ret = gpiochip_remove(&chip->gpio_chip);
799 dev_err(&client->dev, "%s failed, %d\n",
800 "gpiochip_remove()", ret);
807 static const struct of_device_id pca953x_dt_ids[] = {
808 { .compatible = "nxp,pca9505", },
809 { .compatible = "nxp,pca9534", },
810 { .compatible = "nxp,pca9535", },
811 { .compatible = "nxp,pca9536", },
812 { .compatible = "nxp,pca9537", },
813 { .compatible = "nxp,pca9538", },
814 { .compatible = "nxp,pca9539", },
815 { .compatible = "nxp,pca9554", },
816 { .compatible = "nxp,pca9555", },
817 { .compatible = "nxp,pca9556", },
818 { .compatible = "nxp,pca9557", },
819 { .compatible = "nxp,pca9574", },
820 { .compatible = "nxp,pca9575", },
821 { .compatible = "nxp,pca9698", },
823 { .compatible = "maxim,max7310", },
824 { .compatible = "maxim,max7312", },
825 { .compatible = "maxim,max7313", },
826 { .compatible = "maxim,max7315", },
828 { .compatible = "ti,pca6107", },
829 { .compatible = "ti,tca6408", },
830 { .compatible = "ti,tca6416", },
831 { .compatible = "ti,tca6424", },
833 { .compatible = "exar,xra1202", },
837 MODULE_DEVICE_TABLE(of, pca953x_dt_ids);
839 static struct i2c_driver pca953x_driver = {
842 .of_match_table = pca953x_dt_ids,
844 .probe = pca953x_probe,
845 .remove = pca953x_remove,
846 .id_table = pca953x_id,
849 static int __init pca953x_init(void)
851 return i2c_add_driver(&pca953x_driver);
853 /* register after i2c postcore initcall and before
854 * subsys initcalls that may rely on these GPIOs
856 subsys_initcall(pca953x_init);
858 static void __exit pca953x_exit(void)
860 i2c_del_driver(&pca953x_driver);
862 module_exit(pca953x_exit);
864 MODULE_AUTHOR("eric miao <eric.miao@marvell.com>");
865 MODULE_DESCRIPTION("GPIO expander driver for PCA953x");
866 MODULE_LICENSE("GPL");