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
32 #define PCA957X_INVRT 1
33 #define PCA957X_BKEN 2
34 #define PCA957X_PUPD 3
38 #define PCA957X_INTS 7
40 #define PCA_GPIO_MASK 0x00FF
41 #define PCA_INT 0x0100
42 #define PCA953X_TYPE 0x1000
43 #define PCA957X_TYPE 0x2000
45 static const struct i2c_device_id pca953x_id[] = {
46 { "pca9534", 8 | PCA953X_TYPE | PCA_INT, },
47 { "pca9535", 16 | PCA953X_TYPE | PCA_INT, },
48 { "pca9536", 4 | PCA953X_TYPE, },
49 { "pca9537", 4 | PCA953X_TYPE | PCA_INT, },
50 { "pca9538", 8 | PCA953X_TYPE | PCA_INT, },
51 { "pca9539", 16 | PCA953X_TYPE | PCA_INT, },
52 { "pca9554", 8 | PCA953X_TYPE | PCA_INT, },
53 { "pca9555", 16 | PCA953X_TYPE | PCA_INT, },
54 { "pca9556", 8 | PCA953X_TYPE, },
55 { "pca9557", 8 | PCA953X_TYPE, },
56 { "pca9574", 8 | PCA957X_TYPE | PCA_INT, },
57 { "pca9575", 16 | PCA957X_TYPE | PCA_INT, },
59 { "max7310", 8 | PCA953X_TYPE, },
60 { "max7312", 16 | PCA953X_TYPE | PCA_INT, },
61 { "max7313", 16 | PCA953X_TYPE | PCA_INT, },
62 { "max7315", 8 | PCA953X_TYPE | PCA_INT, },
63 { "pca6107", 8 | PCA953X_TYPE | PCA_INT, },
64 { "tca6408", 8 | PCA953X_TYPE | PCA_INT, },
65 { "tca6416", 16 | PCA953X_TYPE | PCA_INT, },
66 /* NYET: { "tca6424", 24, }, */
69 MODULE_DEVICE_TABLE(i2c, pca953x_id);
74 uint16_t reg_direction;
75 struct mutex i2c_lock;
77 #ifdef CONFIG_GPIO_PCA953X_IRQ
78 struct mutex irq_lock;
81 uint16_t irq_trig_raise;
82 uint16_t irq_trig_fall;
86 struct i2c_client *client;
87 struct gpio_chip gpio_chip;
88 const char *const *names;
92 static int pca953x_write_reg(struct pca953x_chip *chip, int reg, uint16_t val)
96 if (chip->gpio_chip.ngpio <= 8)
97 ret = i2c_smbus_write_byte_data(chip->client, reg, val);
99 switch (chip->chip_type) {
101 ret = i2c_smbus_write_word_data(chip->client,
105 ret = i2c_smbus_write_byte_data(chip->client, reg << 1,
109 ret = i2c_smbus_write_byte_data(chip->client,
111 (val & 0xff00) >> 8);
117 dev_err(&chip->client->dev, "failed writing register\n");
124 static int pca953x_read_reg(struct pca953x_chip *chip, int reg, uint16_t *val)
128 if (chip->gpio_chip.ngpio <= 8)
129 ret = i2c_smbus_read_byte_data(chip->client, reg);
131 ret = i2c_smbus_read_word_data(chip->client, reg << 1);
134 dev_err(&chip->client->dev, "failed reading register\n");
138 *val = (uint16_t)ret;
142 static int pca953x_gpio_direction_input(struct gpio_chip *gc, unsigned off)
144 struct pca953x_chip *chip;
148 chip = container_of(gc, struct pca953x_chip, gpio_chip);
150 mutex_lock(&chip->i2c_lock);
151 reg_val = chip->reg_direction | (1u << off);
153 switch (chip->chip_type) {
155 offset = PCA953X_DIRECTION;
158 offset = PCA957X_CFG;
161 ret = pca953x_write_reg(chip, offset, reg_val);
165 chip->reg_direction = reg_val;
168 mutex_unlock(&chip->i2c_lock);
172 static int pca953x_gpio_direction_output(struct gpio_chip *gc,
173 unsigned off, int val)
175 struct pca953x_chip *chip;
179 chip = container_of(gc, struct pca953x_chip, gpio_chip);
181 mutex_lock(&chip->i2c_lock);
182 /* set output level */
184 reg_val = chip->reg_output | (1u << off);
186 reg_val = chip->reg_output & ~(1u << off);
188 switch (chip->chip_type) {
190 offset = PCA953X_OUTPUT;
193 offset = PCA957X_OUT;
196 ret = pca953x_write_reg(chip, offset, reg_val);
200 chip->reg_output = reg_val;
203 reg_val = chip->reg_direction & ~(1u << off);
204 switch (chip->chip_type) {
206 offset = PCA953X_DIRECTION;
209 offset = PCA957X_CFG;
212 ret = pca953x_write_reg(chip, offset, reg_val);
216 chip->reg_direction = reg_val;
219 mutex_unlock(&chip->i2c_lock);
223 static int pca953x_gpio_get_value(struct gpio_chip *gc, unsigned off)
225 struct pca953x_chip *chip;
229 chip = container_of(gc, struct pca953x_chip, gpio_chip);
231 mutex_lock(&chip->i2c_lock);
232 switch (chip->chip_type) {
234 offset = PCA953X_INPUT;
240 ret = pca953x_read_reg(chip, offset, ®_val);
241 mutex_unlock(&chip->i2c_lock);
243 /* NOTE: diagnostic already emitted; that's all we should
244 * do unless gpio_*_value_cansleep() calls become different
245 * from their nonsleeping siblings (and report faults).
250 return (reg_val & (1u << off)) ? 1 : 0;
253 static void pca953x_gpio_set_value(struct gpio_chip *gc, unsigned off, int val)
255 struct pca953x_chip *chip;
259 chip = container_of(gc, struct pca953x_chip, gpio_chip);
261 mutex_lock(&chip->i2c_lock);
263 reg_val = chip->reg_output | (1u << off);
265 reg_val = chip->reg_output & ~(1u << off);
267 switch (chip->chip_type) {
269 offset = PCA953X_OUTPUT;
272 offset = PCA957X_OUT;
275 ret = pca953x_write_reg(chip, offset, reg_val);
279 chip->reg_output = reg_val;
281 mutex_unlock(&chip->i2c_lock);
284 static void pca953x_setup_gpio(struct pca953x_chip *chip, int gpios)
286 struct gpio_chip *gc;
288 gc = &chip->gpio_chip;
290 gc->direction_input = pca953x_gpio_direction_input;
291 gc->direction_output = pca953x_gpio_direction_output;
292 gc->get = pca953x_gpio_get_value;
293 gc->set = pca953x_gpio_set_value;
296 gc->base = chip->gpio_start;
298 gc->label = chip->client->name;
299 gc->dev = &chip->client->dev;
300 gc->owner = THIS_MODULE;
301 gc->names = chip->names;
304 #ifdef CONFIG_GPIO_PCA953X_IRQ
305 static int pca953x_gpio_to_irq(struct gpio_chip *gc, unsigned off)
307 struct pca953x_chip *chip;
309 chip = container_of(gc, struct pca953x_chip, gpio_chip);
310 return chip->irq_base + off;
313 static void pca953x_irq_mask(struct irq_data *d)
315 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
317 chip->irq_mask &= ~(1 << (d->irq - chip->irq_base));
320 static void pca953x_irq_unmask(struct irq_data *d)
322 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
324 chip->irq_mask |= 1 << (d->irq - chip->irq_base);
327 static void pca953x_irq_bus_lock(struct irq_data *d)
329 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
331 mutex_lock(&chip->irq_lock);
334 static void pca953x_irq_bus_sync_unlock(struct irq_data *d)
336 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
340 /* Look for any newly setup interrupt */
341 new_irqs = chip->irq_trig_fall | chip->irq_trig_raise;
342 new_irqs &= ~chip->reg_direction;
345 level = __ffs(new_irqs);
346 pca953x_gpio_direction_input(&chip->gpio_chip, level);
347 new_irqs &= ~(1 << level);
350 mutex_unlock(&chip->irq_lock);
353 static int pca953x_irq_set_type(struct irq_data *d, unsigned int type)
355 struct pca953x_chip *chip = irq_data_get_irq_chip_data(d);
356 uint16_t level = d->irq - chip->irq_base;
357 uint16_t mask = 1 << level;
359 if (!(type & IRQ_TYPE_EDGE_BOTH)) {
360 dev_err(&chip->client->dev, "irq %d: unsupported type %d\n",
365 if (type & IRQ_TYPE_EDGE_FALLING)
366 chip->irq_trig_fall |= mask;
368 chip->irq_trig_fall &= ~mask;
370 if (type & IRQ_TYPE_EDGE_RISING)
371 chip->irq_trig_raise |= mask;
373 chip->irq_trig_raise &= ~mask;
378 static struct irq_chip pca953x_irq_chip = {
380 .irq_mask = pca953x_irq_mask,
381 .irq_unmask = pca953x_irq_unmask,
382 .irq_bus_lock = pca953x_irq_bus_lock,
383 .irq_bus_sync_unlock = pca953x_irq_bus_sync_unlock,
384 .irq_set_type = pca953x_irq_set_type,
387 static uint16_t pca953x_irq_pending(struct pca953x_chip *chip)
395 switch (chip->chip_type) {
397 offset = PCA953X_INPUT;
403 ret = pca953x_read_reg(chip, offset, &cur_stat);
407 /* Remove output pins from the equation */
408 cur_stat &= chip->reg_direction;
410 old_stat = chip->irq_stat;
411 trigger = (cur_stat ^ old_stat) & chip->irq_mask;
416 chip->irq_stat = cur_stat;
418 pending = (old_stat & chip->irq_trig_fall) |
419 (cur_stat & chip->irq_trig_raise);
425 static irqreturn_t pca953x_irq_handler(int irq, void *devid)
427 struct pca953x_chip *chip = devid;
431 pending = pca953x_irq_pending(chip);
437 level = __ffs(pending);
438 handle_nested_irq(level + chip->irq_base);
440 pending &= ~(1 << level);
446 static int pca953x_irq_setup(struct pca953x_chip *chip,
447 const struct i2c_device_id *id,
450 struct i2c_client *client = chip->client;
454 && (id->driver_data & PCA_INT)) {
457 switch (chip->chip_type) {
459 offset = PCA953X_INPUT;
465 ret = pca953x_read_reg(chip, offset, &chip->irq_stat);
470 * There is no way to know which GPIO line generated the
471 * interrupt. We have to rely on the previous read for
474 chip->irq_stat &= chip->reg_direction;
475 mutex_init(&chip->irq_lock);
477 chip->irq_base = irq_alloc_descs(-1, irq_base, chip->gpio_chip.ngpio, -1);
478 if (chip->irq_base < 0)
481 for (lvl = 0; lvl < chip->gpio_chip.ngpio; lvl++) {
482 int irq = lvl + chip->irq_base;
484 irq_clear_status_flags(irq, IRQ_NOREQUEST);
485 irq_set_chip_data(irq, chip);
486 irq_set_chip(irq, &pca953x_irq_chip);
487 irq_set_nested_thread(irq, true);
489 set_irq_flags(irq, IRQF_VALID);
491 irq_set_noprobe(irq);
495 ret = request_threaded_irq(client->irq,
498 IRQF_TRIGGER_LOW | IRQF_ONESHOT,
499 dev_name(&client->dev), chip);
501 dev_err(&client->dev, "failed to request irq %d\n",
506 chip->gpio_chip.to_irq = pca953x_gpio_to_irq;
516 static void pca953x_irq_teardown(struct pca953x_chip *chip)
518 if (chip->irq_base != -1) {
519 irq_free_descs(chip->irq_base, chip->gpio_chip.ngpio);
520 free_irq(chip->client->irq, chip);
523 #else /* CONFIG_GPIO_PCA953X_IRQ */
524 static int pca953x_irq_setup(struct pca953x_chip *chip,
525 const struct i2c_device_id *id,
528 struct i2c_client *client = chip->client;
530 if (irq_base != -1 && (id->driver_data & PCA_INT))
531 dev_warn(&client->dev, "interrupt support not compiled in\n");
536 static void pca953x_irq_teardown(struct pca953x_chip *chip)
542 * Handlers for alternative sources of platform_data
544 #ifdef CONFIG_OF_GPIO
546 * Translate OpenFirmware node properties into platform_data
547 * WARNING: This is DEPRECATED and will be removed eventually!
550 pca953x_get_alt_pdata(struct i2c_client *client, int *gpio_base, int *invert)
552 struct device_node *node;
556 node = client->dev.of_node;
561 val = of_get_property(node, "linux,gpio-base", &size);
562 WARN(val, "%s: device-tree property 'linux,gpio-base' is deprecated!", __func__);
564 if (size != sizeof(*val))
565 dev_warn(&client->dev, "%s: wrong linux,gpio-base\n",
568 *gpio_base = be32_to_cpup(val);
571 val = of_get_property(node, "polarity", NULL);
572 WARN(val, "%s: device-tree property 'polarity' is deprecated!", __func__);
578 pca953x_get_alt_pdata(struct i2c_client *client, int *gpio_base, int *invert)
584 static int __devinit device_pca953x_init(struct pca953x_chip *chip, int invert)
588 ret = pca953x_read_reg(chip, PCA953X_OUTPUT, &chip->reg_output);
592 ret = pca953x_read_reg(chip, PCA953X_DIRECTION,
593 &chip->reg_direction);
597 /* set platform specific polarity inversion */
598 ret = pca953x_write_reg(chip, PCA953X_INVERT, invert);
606 static int __devinit device_pca957x_init(struct pca953x_chip *chip, int invert)
611 /* Let every port in proper state, that could save power */
612 pca953x_write_reg(chip, PCA957X_PUPD, 0x0);
613 pca953x_write_reg(chip, PCA957X_CFG, 0xffff);
614 pca953x_write_reg(chip, PCA957X_OUT, 0x0);
616 ret = pca953x_read_reg(chip, PCA957X_IN, &val);
619 ret = pca953x_read_reg(chip, PCA957X_OUT, &chip->reg_output);
622 ret = pca953x_read_reg(chip, PCA957X_CFG, &chip->reg_direction);
626 /* set platform specific polarity inversion */
627 pca953x_write_reg(chip, PCA957X_INVRT, invert);
629 /* To enable register 6, 7 to controll pull up and pull down */
630 pca953x_write_reg(chip, PCA957X_BKEN, 0x202);
637 static int __devinit pca953x_probe(struct i2c_client *client,
638 const struct i2c_device_id *id)
640 struct pca953x_platform_data *pdata;
641 struct pca953x_chip *chip;
642 int irq_base=0, invert=0;
645 chip = kzalloc(sizeof(struct pca953x_chip), GFP_KERNEL);
649 pdata = client->dev.platform_data;
651 irq_base = pdata->irq_base;
652 chip->gpio_start = pdata->gpio_base;
653 invert = pdata->invert;
654 chip->names = pdata->names;
656 pca953x_get_alt_pdata(client, &chip->gpio_start, &invert);
657 #ifdef CONFIG_OF_GPIO
658 /* If I2C node has no interrupts property, disable GPIO interrupts */
659 if (of_find_property(client->dev.of_node, "interrupts", NULL) == NULL)
664 chip->client = client;
666 chip->chip_type = id->driver_data & (PCA953X_TYPE | PCA957X_TYPE);
668 mutex_init(&chip->i2c_lock);
670 /* initialize cached registers from their original values.
671 * we can't share this chip with another i2c master.
673 pca953x_setup_gpio(chip, id->driver_data & PCA_GPIO_MASK);
675 if (chip->chip_type == PCA953X_TYPE)
676 device_pca953x_init(chip, invert);
677 else if (chip->chip_type == PCA957X_TYPE)
678 device_pca957x_init(chip, invert);
682 ret = pca953x_irq_setup(chip, id, irq_base);
686 ret = gpiochip_add(&chip->gpio_chip);
690 if (pdata && pdata->setup) {
691 ret = pdata->setup(client, chip->gpio_chip.base,
692 chip->gpio_chip.ngpio, pdata->context);
694 dev_warn(&client->dev, "setup failed, %d\n", ret);
697 i2c_set_clientdata(client, chip);
701 pca953x_irq_teardown(chip);
707 static int pca953x_remove(struct i2c_client *client)
709 struct pca953x_platform_data *pdata = client->dev.platform_data;
710 struct pca953x_chip *chip = i2c_get_clientdata(client);
713 if (pdata && pdata->teardown) {
714 ret = pdata->teardown(client, chip->gpio_chip.base,
715 chip->gpio_chip.ngpio, pdata->context);
717 dev_err(&client->dev, "%s failed, %d\n",
723 ret = gpiochip_remove(&chip->gpio_chip);
725 dev_err(&client->dev, "%s failed, %d\n",
726 "gpiochip_remove()", ret);
730 pca953x_irq_teardown(chip);
735 static struct i2c_driver pca953x_driver = {
739 .probe = pca953x_probe,
740 .remove = pca953x_remove,
741 .id_table = pca953x_id,
744 static int __init pca953x_init(void)
746 return i2c_add_driver(&pca953x_driver);
748 /* register after i2c postcore initcall and before
749 * subsys initcalls that may rely on these GPIOs
751 subsys_initcall(pca953x_init);
753 static void __exit pca953x_exit(void)
755 i2c_del_driver(&pca953x_driver);
757 module_exit(pca953x_exit);
760 MODULE_DESCRIPTION("GPIO expander driver for PCA953x");
761 MODULE_LICENSE("GPL");