2 * GPIO Chip driver for Analog Devices
3 * ADP5588/ADP5587 I/O Expander and QWERTY Keypad Controller
5 * Copyright 2009-2010 Analog Devices Inc.
7 * Licensed under the GPL-2 or later.
10 #include <linux/module.h>
11 #include <linux/kernel.h>
12 #include <linux/slab.h>
13 #include <linux/init.h>
14 #include <linux/i2c.h>
15 #include <linux/gpio.h>
16 #include <linux/interrupt.h>
17 #include <linux/irq.h>
19 #include <linux/i2c/adp5588.h>
21 #define DRV_NAME "adp5588-gpio"
24 * Early pre 4.0 Silicon required to delay readout by at least 25ms,
25 * since the Event Counter Register updated 25ms after the interrupt
28 #define WA_DELAYED_READOUT_REVID(rev) ((rev) < 4)
31 struct i2c_client
*client
;
32 struct gpio_chip gpio_chip
;
33 struct mutex lock
; /* protect cached dir, dat_out */
34 /* protect serialized access to the interrupt controller bus */
35 struct mutex irq_lock
;
46 static int adp5588_gpio_read(struct i2c_client
*client
, u8 reg
)
48 int ret
= i2c_smbus_read_byte_data(client
, reg
);
51 dev_err(&client
->dev
, "Read Error\n");
56 static int adp5588_gpio_write(struct i2c_client
*client
, u8 reg
, u8 val
)
58 int ret
= i2c_smbus_write_byte_data(client
, reg
, val
);
61 dev_err(&client
->dev
, "Write Error\n");
66 static int adp5588_gpio_get_value(struct gpio_chip
*chip
, unsigned off
)
68 struct adp5588_gpio
*dev
=
69 container_of(chip
, struct adp5588_gpio
, gpio_chip
);
71 return !!(adp5588_gpio_read(dev
->client
,
72 GPIO_DAT_STAT1
+ ADP5588_BANK(off
)) & ADP5588_BIT(off
));
75 static void adp5588_gpio_set_value(struct gpio_chip
*chip
,
76 unsigned off
, int val
)
79 struct adp5588_gpio
*dev
=
80 container_of(chip
, struct adp5588_gpio
, gpio_chip
);
82 bank
= ADP5588_BANK(off
);
83 bit
= ADP5588_BIT(off
);
85 mutex_lock(&dev
->lock
);
87 dev
->dat_out
[bank
] |= bit
;
89 dev
->dat_out
[bank
] &= ~bit
;
91 adp5588_gpio_write(dev
->client
, GPIO_DAT_OUT1
+ bank
,
93 mutex_unlock(&dev
->lock
);
96 static int adp5588_gpio_direction_input(struct gpio_chip
*chip
, unsigned off
)
100 struct adp5588_gpio
*dev
=
101 container_of(chip
, struct adp5588_gpio
, gpio_chip
);
103 bank
= ADP5588_BANK(off
);
105 mutex_lock(&dev
->lock
);
106 dev
->dir
[bank
] &= ~ADP5588_BIT(off
);
107 ret
= adp5588_gpio_write(dev
->client
, GPIO_DIR1
+ bank
, dev
->dir
[bank
]);
108 mutex_unlock(&dev
->lock
);
113 static int adp5588_gpio_direction_output(struct gpio_chip
*chip
,
114 unsigned off
, int val
)
118 struct adp5588_gpio
*dev
=
119 container_of(chip
, struct adp5588_gpio
, gpio_chip
);
121 bank
= ADP5588_BANK(off
);
122 bit
= ADP5588_BIT(off
);
124 mutex_lock(&dev
->lock
);
125 dev
->dir
[bank
] |= bit
;
128 dev
->dat_out
[bank
] |= bit
;
130 dev
->dat_out
[bank
] &= ~bit
;
132 ret
= adp5588_gpio_write(dev
->client
, GPIO_DAT_OUT1
+ bank
,
134 ret
|= adp5588_gpio_write(dev
->client
, GPIO_DIR1
+ bank
,
136 mutex_unlock(&dev
->lock
);
141 #ifdef CONFIG_GPIO_ADP5588_IRQ
142 static int adp5588_gpio_to_irq(struct gpio_chip
*chip
, unsigned off
)
144 struct adp5588_gpio
*dev
=
145 container_of(chip
, struct adp5588_gpio
, gpio_chip
);
146 return dev
->irq_base
+ off
;
149 static void adp5588_irq_bus_lock(struct irq_data
*d
)
151 struct adp5588_gpio
*dev
= irq_data_get_irq_chip_data(d
);
153 mutex_lock(&dev
->irq_lock
);
157 * genirq core code can issue chip->mask/unmask from atomic context.
158 * This doesn't work for slow busses where an access needs to sleep.
159 * bus_sync_unlock() is therefore called outside the atomic context,
160 * syncs the current irq mask state with the slow external controller
161 * and unlocks the bus.
164 static void adp5588_irq_bus_sync_unlock(struct irq_data
*d
)
166 struct adp5588_gpio
*dev
= irq_data_get_irq_chip_data(d
);
169 for (i
= 0; i
<= ADP5588_BANK(ADP5588_MAXGPIO
); i
++)
170 if (dev
->int_en
[i
] ^ dev
->irq_mask
[i
]) {
171 dev
->int_en
[i
] = dev
->irq_mask
[i
];
172 adp5588_gpio_write(dev
->client
, GPIO_INT_EN1
+ i
,
176 mutex_unlock(&dev
->irq_lock
);
179 static void adp5588_irq_mask(struct irq_data
*d
)
181 struct adp5588_gpio
*dev
= irq_data_get_irq_chip_data(d
);
182 unsigned gpio
= d
->irq
- dev
->irq_base
;
184 dev
->irq_mask
[ADP5588_BANK(gpio
)] &= ~ADP5588_BIT(gpio
);
187 static void adp5588_irq_unmask(struct irq_data
*d
)
189 struct adp5588_gpio
*dev
= irq_data_get_irq_chip_data(d
);
190 unsigned gpio
= d
->irq
- dev
->irq_base
;
192 dev
->irq_mask
[ADP5588_BANK(gpio
)] |= ADP5588_BIT(gpio
);
195 static int adp5588_irq_set_type(struct irq_data
*d
, unsigned int type
)
197 struct adp5588_gpio
*dev
= irq_data_get_irq_chip_data(d
);
198 uint16_t gpio
= d
->irq
- dev
->irq_base
;
201 if ((type
& IRQ_TYPE_EDGE_BOTH
)) {
202 dev_err(&dev
->client
->dev
, "irq %d: unsupported type %d\n",
207 bank
= ADP5588_BANK(gpio
);
208 bit
= ADP5588_BIT(gpio
);
210 if (type
& IRQ_TYPE_LEVEL_HIGH
)
211 dev
->int_lvl
[bank
] |= bit
;
212 else if (type
& IRQ_TYPE_LEVEL_LOW
)
213 dev
->int_lvl
[bank
] &= ~bit
;
217 adp5588_gpio_direction_input(&dev
->gpio_chip
, gpio
);
218 adp5588_gpio_write(dev
->client
, GPIO_INT_LVL1
+ bank
,
224 static struct irq_chip adp5588_irq_chip
= {
226 .irq_mask
= adp5588_irq_mask
,
227 .irq_unmask
= adp5588_irq_unmask
,
228 .irq_bus_lock
= adp5588_irq_bus_lock
,
229 .irq_bus_sync_unlock
= adp5588_irq_bus_sync_unlock
,
230 .irq_set_type
= adp5588_irq_set_type
,
233 static int adp5588_gpio_read_intstat(struct i2c_client
*client
, u8
*buf
)
235 int ret
= i2c_smbus_read_i2c_block_data(client
, GPIO_INT_STAT1
, 3, buf
);
238 dev_err(&client
->dev
, "Read INT_STAT Error\n");
243 static irqreturn_t
adp5588_irq_handler(int irq
, void *devid
)
245 struct adp5588_gpio
*dev
= devid
;
246 unsigned status
, bank
, bit
, pending
;
248 status
= adp5588_gpio_read(dev
->client
, INT_STAT
);
250 if (status
& ADP5588_GPI_INT
) {
251 ret
= adp5588_gpio_read_intstat(dev
->client
, dev
->irq_stat
);
253 memset(dev
->irq_stat
, 0, ARRAY_SIZE(dev
->irq_stat
));
255 for (bank
= 0, bit
= 0; bank
<= ADP5588_BANK(ADP5588_MAXGPIO
);
257 pending
= dev
->irq_stat
[bank
] & dev
->irq_mask
[bank
];
260 if (pending
& (1 << bit
)) {
261 handle_nested_irq(dev
->irq_base
+
263 pending
&= ~(1 << bit
);
271 adp5588_gpio_write(dev
->client
, INT_STAT
, status
); /* Status is W1C */
276 static int adp5588_irq_setup(struct adp5588_gpio
*dev
)
278 struct i2c_client
*client
= dev
->client
;
279 struct adp5588_gpio_platform_data
*pdata
=
280 dev_get_platdata(&client
->dev
);
284 adp5588_gpio_write(client
, CFG
, ADP5588_AUTO_INC
);
285 adp5588_gpio_write(client
, INT_STAT
, -1); /* status is W1C */
286 adp5588_gpio_read_intstat(client
, dev
->irq_stat
); /* read to clear */
288 dev
->irq_base
= pdata
->irq_base
;
289 mutex_init(&dev
->irq_lock
);
291 for (gpio
= 0; gpio
< dev
->gpio_chip
.ngpio
; gpio
++) {
292 int irq
= gpio
+ dev
->irq_base
;
293 irq_set_chip_data(irq
, dev
);
294 irq_set_chip_and_handler(irq
, &adp5588_irq_chip
,
296 irq_set_nested_thread(irq
, 1);
299 * ARM needs us to explicitly flag the IRQ as VALID,
300 * once we do so, it will also set the noprobe.
302 set_irq_flags(irq
, IRQF_VALID
);
304 irq_set_noprobe(irq
);
308 ret
= request_threaded_irq(client
->irq
,
311 IRQF_TRIGGER_FALLING
| IRQF_ONESHOT
,
312 dev_name(&client
->dev
), dev
);
314 dev_err(&client
->dev
, "failed to request irq %d\n",
319 dev
->gpio_chip
.to_irq
= adp5588_gpio_to_irq
;
320 adp5588_gpio_write(client
, CFG
,
321 ADP5588_AUTO_INC
| ADP5588_INT_CFG
| ADP5588_GPI_INT
);
330 static void adp5588_irq_teardown(struct adp5588_gpio
*dev
)
333 free_irq(dev
->client
->irq
, dev
);
337 static int adp5588_irq_setup(struct adp5588_gpio
*dev
)
339 struct i2c_client
*client
= dev
->client
;
340 dev_warn(&client
->dev
, "interrupt support not compiled in\n");
345 static void adp5588_irq_teardown(struct adp5588_gpio
*dev
)
348 #endif /* CONFIG_GPIO_ADP5588_IRQ */
350 static int adp5588_gpio_probe(struct i2c_client
*client
,
351 const struct i2c_device_id
*id
)
353 struct adp5588_gpio_platform_data
*pdata
=
354 dev_get_platdata(&client
->dev
);
355 struct adp5588_gpio
*dev
;
356 struct gpio_chip
*gc
;
360 dev_err(&client
->dev
, "missing platform data\n");
364 if (!i2c_check_functionality(client
->adapter
,
365 I2C_FUNC_SMBUS_BYTE_DATA
)) {
366 dev_err(&client
->dev
, "SMBUS Byte Data not Supported\n");
370 dev
= kzalloc(sizeof(*dev
), GFP_KERNEL
);
372 dev_err(&client
->dev
, "failed to alloc memory\n");
376 dev
->client
= client
;
378 gc
= &dev
->gpio_chip
;
379 gc
->direction_input
= adp5588_gpio_direction_input
;
380 gc
->direction_output
= adp5588_gpio_direction_output
;
381 gc
->get
= adp5588_gpio_get_value
;
382 gc
->set
= adp5588_gpio_set_value
;
385 gc
->base
= pdata
->gpio_start
;
386 gc
->ngpio
= ADP5588_MAXGPIO
;
387 gc
->label
= client
->name
;
388 gc
->owner
= THIS_MODULE
;
390 mutex_init(&dev
->lock
);
392 ret
= adp5588_gpio_read(dev
->client
, DEV_ID
);
396 revid
= ret
& ADP5588_DEVICE_ID_MASK
;
398 for (i
= 0, ret
= 0; i
<= ADP5588_BANK(ADP5588_MAXGPIO
); i
++) {
399 dev
->dat_out
[i
] = adp5588_gpio_read(client
, GPIO_DAT_OUT1
+ i
);
400 dev
->dir
[i
] = adp5588_gpio_read(client
, GPIO_DIR1
+ i
);
401 ret
|= adp5588_gpio_write(client
, KP_GPIO1
+ i
, 0);
402 ret
|= adp5588_gpio_write(client
, GPIO_PULL1
+ i
,
403 (pdata
->pullup_dis_mask
>> (8 * i
)) & 0xFF);
404 ret
|= adp5588_gpio_write(client
, GPIO_INT_EN1
+ i
, 0);
409 if (pdata
->irq_base
) {
410 if (WA_DELAYED_READOUT_REVID(revid
)) {
411 dev_warn(&client
->dev
, "GPIO int not supported\n");
413 ret
= adp5588_irq_setup(dev
);
419 ret
= gpiochip_add(&dev
->gpio_chip
);
423 dev_info(&client
->dev
, "IRQ Base: %d Rev.: %d\n",
424 pdata
->irq_base
, revid
);
427 ret
= pdata
->setup(client
, gc
->base
, gc
->ngpio
, pdata
->context
);
429 dev_warn(&client
->dev
, "setup failed, %d\n", ret
);
432 i2c_set_clientdata(client
, dev
);
437 adp5588_irq_teardown(dev
);
443 static int adp5588_gpio_remove(struct i2c_client
*client
)
445 struct adp5588_gpio_platform_data
*pdata
=
446 dev_get_platdata(&client
->dev
);
447 struct adp5588_gpio
*dev
= i2c_get_clientdata(client
);
450 if (pdata
->teardown
) {
451 ret
= pdata
->teardown(client
,
452 dev
->gpio_chip
.base
, dev
->gpio_chip
.ngpio
,
455 dev_err(&client
->dev
, "teardown failed %d\n", ret
);
461 free_irq(dev
->client
->irq
, dev
);
463 ret
= gpiochip_remove(&dev
->gpio_chip
);
465 dev_err(&client
->dev
, "gpiochip_remove failed %d\n", ret
);
473 static const struct i2c_device_id adp5588_gpio_id
[] = {
478 MODULE_DEVICE_TABLE(i2c
, adp5588_gpio_id
);
480 static struct i2c_driver adp5588_gpio_driver
= {
484 .probe
= adp5588_gpio_probe
,
485 .remove
= adp5588_gpio_remove
,
486 .id_table
= adp5588_gpio_id
,
489 module_i2c_driver(adp5588_gpio_driver
);
491 MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>");
492 MODULE_DESCRIPTION("GPIO ADP5588 Driver");
493 MODULE_LICENSE("GPL");