2 * PCA953x 4/8/16 bit I/O ports
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/i2c.h>
20 #include <linux/i2c/pca953x.h>
21 #include <linux/slab.h>
23 #include <linux/of_platform.h>
26 #define PCA953X_INPUT 0
27 #define PCA953X_OUTPUT 1
28 #define PCA953X_INVERT 2
29 #define PCA953X_DIRECTION 3
31 #define REG_ADDR_AI 0x80
34 #define PCA957X_INVRT 1
35 #define PCA957X_BKEN 2
36 #define PCA957X_PUPD 3
40 #define PCA957X_INTS 7
42 #define PCA_GPIO_MASK 0x00FF
43 #define PCA_INT 0x0100
44 #define PCA953X_TYPE 0x1000
45 #define PCA957X_TYPE 0x2000
47 static const struct i2c_device_id pca953x_id[] = {
48 { "pca9534", 8 | PCA953X_TYPE | PCA_INT, },
49 { "pca9535", 16 | PCA953X_TYPE | PCA_INT, },
50 { "pca9536", 4 | PCA953X_TYPE, },
51 { "pca9537", 4 | PCA953X_TYPE | PCA_INT, },
52 { "pca9538", 8 | PCA953X_TYPE | PCA_INT, },
53 { "pca9539", 16 | PCA953X_TYPE | PCA_INT, },
54 { "pca9554", 8 | PCA953X_TYPE | PCA_INT, },
55 { "pca9555", 16 | PCA953X_TYPE | PCA_INT, },
56 { "pca9556", 8 | PCA953X_TYPE, },
57 { "pca9557", 8 | PCA953X_TYPE, },
58 { "pca9574", 8 | PCA957X_TYPE | PCA_INT, },
59 { "pca9575", 16 | PCA957X_TYPE | PCA_INT, },
61 { "max7310", 8 | PCA953X_TYPE, },
62 { "max7312", 16 | PCA953X_TYPE | PCA_INT, },
63 { "max7313", 16 | PCA953X_TYPE | PCA_INT, },
64 { "max7315", 8 | PCA953X_TYPE | PCA_INT, },
65 { "pca6107", 8 | PCA953X_TYPE | PCA_INT, },
66 { "tca6408", 8 | PCA953X_TYPE | PCA_INT, },
67 { "tca6416", 16 | PCA953X_TYPE | PCA_INT, },
68 { "tca6424", 24 | PCA953X_TYPE | PCA_INT, },
71 MODULE_DEVICE_TABLE(i2c, pca953x_id);
77 struct mutex i2c_lock;
79 #ifdef CONFIG_GPIO_PCA953X_IRQ
80 struct mutex irq_lock;
83 uint16_t irq_trig_raise;
84 uint16_t irq_trig_fall;
88 struct i2c_client *client;
89 struct gpio_chip gpio_chip;
90 const char *const *names;
94 static int pca953x_write_reg(struct pca953x_chip *chip, int reg, u32 val)
98 if (chip->gpio_chip.ngpio <= 8)
99 ret = i2c_smbus_write_byte_data(chip->client, reg, val);
100 else if (chip->gpio_chip.ngpio == 24) {
101 ret = i2c_smbus_write_word_data(chip->client,
102 (reg << 2) | REG_ADDR_AI,
104 ret = i2c_smbus_write_byte_data(chip->client,
106 (val & 0xff0000) >> 16);
109 switch (chip->chip_type) {
111 ret = i2c_smbus_write_word_data(chip->client,
115 ret = i2c_smbus_write_byte_data(chip->client, reg << 1,
119 ret = i2c_smbus_write_byte_data(chip->client,
121 (val & 0xff00) >> 8);
127 dev_err(&chip->client->dev, "failed writing register\n");
134 static int pca953x_read_reg(struct pca953x_chip *chip, int reg, u32 *val)
138 if (chip->gpio_chip.ngpio <= 8)
139 ret = i2c_smbus_read_byte_data(chip->client, reg);
140 else if (chip->gpio_chip.ngpio == 24) {
141 ret = i2c_smbus_read_word_data(chip->client, reg << 2);
142 ret |= (i2c_smbus_read_byte_data(chip->client,
143 (reg << 2) + 2)<<16);
146 ret = i2c_smbus_read_word_data(chip->client, reg << 1);
149 dev_err(&chip->client->dev, "failed reading register\n");
157 static int pca953x_gpio_direction_input(struct gpio_chip *gc, unsigned off)
159 struct pca953x_chip *chip;
163 chip = container_of(gc, struct pca953x_chip, gpio_chip);
165 mutex_lock(&chip->i2c_lock);
166 reg_val = chip->reg_direction | (1u << off);
168 switch (chip->chip_type) {
170 offset = PCA953X_DIRECTION;
173 offset = PCA957X_CFG;
176 ret = pca953x_write_reg(chip, offset, reg_val);
180 chip->reg_direction = reg_val;
183 mutex_unlock(&chip->i2c_lock);
187 static int pca953x_gpio_direction_output(struct gpio_chip *gc,
188 unsigned off, int val)
190 struct pca953x_chip *chip;
194 chip = container_of(gc, struct pca953x_chip, gpio_chip);
196 mutex_lock(&chip->i2c_lock);
197 /* set output level */
199 reg_val = chip->reg_output | (1u << off);
201 reg_val = chip->reg_output & ~(1u << off);
203 switch (chip->chip_type) {
205 offset = PCA953X_OUTPUT;
208 offset = PCA957X_OUT;
211 ret = pca953x_write_reg(chip, offset, reg_val);
215 chip->reg_output = reg_val;
218 reg_val = chip->reg_direction & ~(1u << off);
219 switch (chip->chip_type) {
221 offset = PCA953X_DIRECTION;
224 offset = PCA957X_CFG;
227 ret = pca953x_write_reg(chip, offset, reg_val);
231 chip->reg_direction = reg_val;
234 mutex_unlock(&chip->i2c_lock);
238 static int pca953x_gpio_get_value(struct gpio_chip *gc, unsigned off)
240 struct pca953x_chip *chip;
244 chip = container_of(gc, struct pca953x_chip, gpio_chip);
246 mutex_lock(&chip->i2c_lock);
247 switch (chip->chip_type) {
249 offset = PCA953X_INPUT;
255 ret = pca953x_read_reg(chip, offset, ®_val);
256 mutex_unlock(&chip->i2c_lock);
258 /* NOTE: diagnostic already emitted; that's all we should
259 * do unless gpio_*_value_cansleep() calls become different
260 * from their nonsleeping siblings (and report faults).
265 return (reg_val & (1u << off)) ? 1 : 0;
268 static void pca953x_gpio_set_value(struct gpio_chip *gc, unsigned off, int val)
270 struct pca953x_chip *chip;
274 chip = container_of(gc, struct pca953x_chip, gpio_chip);
276 mutex_lock(&chip->i2c_lock);
278 reg_val = chip->reg_output | (1u << off);
280 reg_val = chip->reg_output & ~(1u << off);
282 switch (chip->chip_type) {
284 offset = PCA953X_OUTPUT;
287 offset = PCA957X_OUT;
290 ret = pca953x_write_reg(chip, offset, reg_val);
294 chip->reg_output = reg_val;
296 mutex_unlock(&chip->i2c_lock);
299 static void pca953x_setup_gpio(struct pca953x_chip *chip, int gpios)
301 struct gpio_chip *gc;
303 gc = &chip->gpio_chip;
305 gc->direction_input = pca953x_gpio_direction_input;
306 gc->direction_output = pca953x_gpio_direction_output;
307 gc->get = pca953x_gpio_get_value;
308 gc->set = pca953x_gpio_set_value;
311 gc->base = chip->gpio_start;
313 gc->label = chip->client->name;
314 gc->dev = &chip->client->dev;
315 gc->owner = THIS_MODULE;
316 gc->names = chip->names;
319 #ifdef CONFIG_GPIO_PCA953X_IRQ
320 static int pca953x_gpio_to_irq(struct gpio_chip *gc, unsigned off)
322 struct pca953x_chip *chip;
324 chip = container_of(gc, struct pca953x_chip, gpio_chip);
325 return chip->irq_base + off;
328 static void pca953x_irq_mask(struct irq_data *d)
330 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
332 chip->irq_mask &= ~(1 << (d->irq - chip->irq_base));
335 static void pca953x_irq_unmask(struct irq_data *d)
337 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
339 chip->irq_mask |= 1 << (d->irq - chip->irq_base);
342 static void pca953x_irq_bus_lock(struct irq_data *d)
344 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
346 mutex_lock(&chip->irq_lock);
349 static void pca953x_irq_bus_sync_unlock(struct irq_data *d)
351 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
355 /* Look for any newly setup interrupt */
356 new_irqs = chip->irq_trig_fall | chip->irq_trig_raise;
357 new_irqs &= ~chip->reg_direction;
360 level = __ffs(new_irqs);
361 pca953x_gpio_direction_input(&chip->gpio_chip, level);
362 new_irqs &= ~(1 << level);
365 mutex_unlock(&chip->irq_lock);
368 static int pca953x_irq_set_type(struct irq_data *d, unsigned int type)
370 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
371 uint16_t level = d->irq - chip->irq_base;
372 uint16_t mask = 1 << level;
374 if (!(type & IRQ_TYPE_EDGE_BOTH)) {
375 dev_err(&chip->client->dev, "irq %d: unsupported type %d\n",
380 if (type & IRQ_TYPE_EDGE_FALLING)
381 chip->irq_trig_fall |= mask;
383 chip->irq_trig_fall &= ~mask;
385 if (type & IRQ_TYPE_EDGE_RISING)
386 chip->irq_trig_raise |= mask;
388 chip->irq_trig_raise &= ~mask;
393 static struct irq_chip pca953x_irq_chip = {
395 .irq_mask = pca953x_irq_mask,
396 .irq_unmask = pca953x_irq_unmask,
397 .irq_bus_lock = pca953x_irq_bus_lock,
398 .irq_bus_sync_unlock = pca953x_irq_bus_sync_unlock,
399 .irq_set_type = pca953x_irq_set_type,
402 static uint16_t pca953x_irq_pending(struct pca953x_chip *chip)
410 switch (chip->chip_type) {
412 offset = PCA953X_INPUT;
418 ret = pca953x_read_reg(chip, offset, &cur_stat);
422 /* Remove output pins from the equation */
423 cur_stat &= chip->reg_direction;
425 old_stat = chip->irq_stat;
426 trigger = (cur_stat ^ old_stat) & chip->irq_mask;
431 chip->irq_stat = cur_stat;
433 pending = (old_stat & chip->irq_trig_fall) |
434 (cur_stat & chip->irq_trig_raise);
440 static irqreturn_t pca953x_irq_handler(int irq, void *devid)
442 struct pca953x_chip *chip = devid;
446 pending = pca953x_irq_pending(chip);
452 level = __ffs(pending);
453 handle_nested_irq(level + chip->irq_base);
455 pending &= ~(1 << level);
461 static int pca953x_irq_setup(struct pca953x_chip *chip,
462 const struct i2c_device_id *id,
465 struct i2c_client *client = chip->client;
470 && (id->driver_data & PCA_INT)) {
473 switch (chip->chip_type) {
475 offset = PCA953X_INPUT;
481 ret = pca953x_read_reg(chip, offset, &temporary);
482 chip->irq_stat = temporary;
487 * There is no way to know which GPIO line generated the
488 * interrupt. We have to rely on the previous read for
491 chip->irq_stat &= chip->reg_direction;
492 mutex_init(&chip->irq_lock);
494 chip->irq_base = irq_alloc_descs(-1, irq_base, chip->gpio_chip.ngpio, -1);
495 if (chip->irq_base < 0)
498 for (lvl = 0; lvl < chip->gpio_chip.ngpio; lvl++) {
499 int irq = lvl + chip->irq_base;
501 irq_clear_status_flags(irq, IRQ_NOREQUEST);
502 irq_set_chip_data(irq, chip);
503 irq_set_chip(irq, &pca953x_irq_chip);
504 irq_set_nested_thread(irq, true);
506 set_irq_flags(irq, IRQF_VALID);
508 irq_set_noprobe(irq);
512 ret = request_threaded_irq(client->irq,
515 IRQF_TRIGGER_LOW | IRQF_ONESHOT,
516 dev_name(&client->dev), chip);
518 dev_err(&client->dev, "failed to request irq %d\n",
523 chip->gpio_chip.to_irq = pca953x_gpio_to_irq;
533 static void pca953x_irq_teardown(struct pca953x_chip *chip)
535 if (chip->irq_base != -1) {
536 irq_free_descs(chip->irq_base, chip->gpio_chip.ngpio);
537 free_irq(chip->client->irq, chip);
540 #else /* CONFIG_GPIO_PCA953X_IRQ */
541 static int pca953x_irq_setup(struct pca953x_chip *chip,
542 const struct i2c_device_id *id,
545 struct i2c_client *client = chip->client;
547 if (irq_base != -1 && (id->driver_data & PCA_INT))
548 dev_warn(&client->dev, "interrupt support not compiled in\n");
553 static void pca953x_irq_teardown(struct pca953x_chip *chip)
559 * Handlers for alternative sources of platform_data
561 #ifdef CONFIG_OF_GPIO
563 * Translate OpenFirmware node properties into platform_data
564 * WARNING: This is DEPRECATED and will be removed eventually!
567 pca953x_get_alt_pdata(struct i2c_client *client, int *gpio_base, int *invert)
569 struct device_node *node;
573 node = client->dev.of_node;
578 val = of_get_property(node, "linux,gpio-base", &size);
579 WARN(val, "%s: device-tree property 'linux,gpio-base' is deprecated!", __func__);
581 if (size != sizeof(*val))
582 dev_warn(&client->dev, "%s: wrong linux,gpio-base\n",
585 *gpio_base = be32_to_cpup(val);
588 val = of_get_property(node, "polarity", NULL);
589 WARN(val, "%s: device-tree property 'polarity' is deprecated!", __func__);
595 pca953x_get_alt_pdata(struct i2c_client *client, int *gpio_base, int *invert)
601 static int __devinit device_pca953x_init(struct pca953x_chip *chip, int invert)
605 ret = pca953x_read_reg(chip, PCA953X_OUTPUT, &chip->reg_output);
609 ret = pca953x_read_reg(chip, PCA953X_DIRECTION,
610 &chip->reg_direction);
614 /* set platform specific polarity inversion */
615 ret = pca953x_write_reg(chip, PCA953X_INVERT, invert);
620 static int __devinit device_pca957x_init(struct pca953x_chip *chip, int invert)
625 /* Let every port in proper state, that could save power */
626 pca953x_write_reg(chip, PCA957X_PUPD, 0x0);
627 pca953x_write_reg(chip, PCA957X_CFG, 0xffff);
628 pca953x_write_reg(chip, PCA957X_OUT, 0x0);
630 ret = pca953x_read_reg(chip, PCA957X_IN, &val);
633 ret = pca953x_read_reg(chip, PCA957X_OUT, &chip->reg_output);
636 ret = pca953x_read_reg(chip, PCA957X_CFG, &chip->reg_direction);
640 /* set platform specific polarity inversion */
641 pca953x_write_reg(chip, PCA957X_INVRT, invert);
643 /* To enable register 6, 7 to controll pull up and pull down */
644 pca953x_write_reg(chip, PCA957X_BKEN, 0x202);
651 static int __devinit pca953x_probe(struct i2c_client *client,
652 const struct i2c_device_id *id)
654 struct pca953x_platform_data *pdata;
655 struct pca953x_chip *chip;
656 int irq_base=0, invert=0;
659 chip = kzalloc(sizeof(struct pca953x_chip), GFP_KERNEL);
663 pdata = client->dev.platform_data;
665 irq_base = pdata->irq_base;
666 chip->gpio_start = pdata->gpio_base;
667 invert = pdata->invert;
668 chip->names = pdata->names;
670 pca953x_get_alt_pdata(client, &chip->gpio_start, &invert);
671 #ifdef CONFIG_OF_GPIO
672 /* If I2C node has no interrupts property, disable GPIO interrupts */
673 if (of_find_property(client->dev.of_node, "interrupts", NULL) == NULL)
678 chip->client = client;
680 chip->chip_type = id->driver_data & (PCA953X_TYPE | PCA957X_TYPE);
682 mutex_init(&chip->i2c_lock);
684 /* initialize cached registers from their original values.
685 * we can't share this chip with another i2c master.
687 pca953x_setup_gpio(chip, id->driver_data & PCA_GPIO_MASK);
689 if (chip->chip_type == PCA953X_TYPE)
690 ret = device_pca953x_init(chip, invert);
692 ret = device_pca957x_init(chip, invert);
696 ret = pca953x_irq_setup(chip, id, irq_base);
700 ret = gpiochip_add(&chip->gpio_chip);
704 if (pdata && pdata->setup) {
705 ret = pdata->setup(client, chip->gpio_chip.base,
706 chip->gpio_chip.ngpio, pdata->context);
708 dev_warn(&client->dev, "setup failed, %d\n", ret);
711 i2c_set_clientdata(client, chip);
715 pca953x_irq_teardown(chip);
721 static int pca953x_remove(struct i2c_client *client)
723 struct pca953x_platform_data *pdata = client->dev.platform_data;
724 struct pca953x_chip *chip = i2c_get_clientdata(client);
727 if (pdata && pdata->teardown) {
728 ret = pdata->teardown(client, chip->gpio_chip.base,
729 chip->gpio_chip.ngpio, pdata->context);
731 dev_err(&client->dev, "%s failed, %d\n",
737 ret = gpiochip_remove(&chip->gpio_chip);
739 dev_err(&client->dev, "%s failed, %d\n",
740 "gpiochip_remove()", ret);
744 pca953x_irq_teardown(chip);
749 static struct i2c_driver pca953x_driver = {
753 .probe = pca953x_probe,
754 .remove = pca953x_remove,
755 .id_table = pca953x_id,
758 static int __init pca953x_init(void)
760 return i2c_add_driver(&pca953x_driver);
762 /* register after i2c postcore initcall and before
763 * subsys initcalls that may rely on these GPIOs
765 subsys_initcall(pca953x_init);
767 static void __exit pca953x_exit(void)
769 i2c_del_driver(&pca953x_driver);
771 module_exit(pca953x_exit);
774 MODULE_DESCRIPTION("GPIO expander driver for PCA953x");
775 MODULE_LICENSE("GPL");