2 * File: drivers/input/keyboard/adp5588_keys.c
3 * Description: keypad driver for ADP5588 and ADP5587
4 * I2C QWERTY Keypad and IO Expander
5 * Bugs: Enter bugs at http://blackfin.uclinux.org/
7 * Copyright (C) 2008-2010 Analog Devices Inc.
8 * Licensed under the GPL-2 or later.
11 #include <linux/module.h>
12 #include <linux/interrupt.h>
13 #include <linux/irq.h>
14 #include <linux/workqueue.h>
15 #include <linux/errno.h>
17 #include <linux/platform_device.h>
18 #include <linux/input.h>
19 #include <linux/i2c.h>
20 #include <linux/gpio.h>
21 #include <linux/slab.h>
23 #include <linux/i2c/adp5588.h>
25 /* Key Event Register xy */
26 #define KEY_EV_PRESSED (1 << 7)
27 #define KEY_EV_MASK (0x7F)
29 #define KP_SEL(x) (0xFFFF >> (16 - x)) /* 2^x-1 */
31 #define KEYP_MAX_EVENT 10
34 * Early pre 4.0 Silicon required to delay readout by at least 25ms,
35 * since the Event Counter Register updated 25ms after the interrupt
38 #define WA_DELAYED_READOUT_REVID(rev) ((rev) < 4)
41 struct i2c_client
*client
;
42 struct input_dev
*input
;
43 struct delayed_work work
;
45 unsigned short keycode
[ADP5588_KEYMAPSIZE
];
46 const struct adp5588_gpi_map
*gpimap
;
47 unsigned short gpimapsize
;
49 unsigned char gpiomap
[ADP5588_MAXGPIO
];
52 struct mutex gpio_lock
; /* Protect cached dir, dat_out */
58 static int adp5588_read(struct i2c_client
*client
, u8 reg
)
60 int ret
= i2c_smbus_read_byte_data(client
, reg
);
63 dev_err(&client
->dev
, "Read Error\n");
68 static int adp5588_write(struct i2c_client
*client
, u8 reg
, u8 val
)
70 return i2c_smbus_write_byte_data(client
, reg
, val
);
74 static int adp5588_gpio_get_value(struct gpio_chip
*chip
, unsigned off
)
76 struct adp5588_kpad
*kpad
= container_of(chip
, struct adp5588_kpad
, gc
);
77 unsigned int bank
= ADP5588_BANK(kpad
->gpiomap
[off
]);
78 unsigned int bit
= ADP5588_BIT(kpad
->gpiomap
[off
]);
81 mutex_lock(&kpad
->gpio_lock
);
83 if (kpad
->dir
[bank
] & bit
)
84 val
= kpad
->dat_out
[bank
];
86 val
= adp5588_read(kpad
->client
, GPIO_DAT_STAT1
+ bank
);
88 mutex_unlock(&kpad
->gpio_lock
);
93 static void adp5588_gpio_set_value(struct gpio_chip
*chip
,
94 unsigned off
, int val
)
96 struct adp5588_kpad
*kpad
= container_of(chip
, struct adp5588_kpad
, gc
);
97 unsigned int bank
= ADP5588_BANK(kpad
->gpiomap
[off
]);
98 unsigned int bit
= ADP5588_BIT(kpad
->gpiomap
[off
]);
100 mutex_lock(&kpad
->gpio_lock
);
103 kpad
->dat_out
[bank
] |= bit
;
105 kpad
->dat_out
[bank
] &= ~bit
;
107 adp5588_write(kpad
->client
, GPIO_DAT_OUT1
+ bank
,
108 kpad
->dat_out
[bank
]);
110 mutex_unlock(&kpad
->gpio_lock
);
113 static int adp5588_gpio_direction_input(struct gpio_chip
*chip
, unsigned off
)
115 struct adp5588_kpad
*kpad
= container_of(chip
, struct adp5588_kpad
, gc
);
116 unsigned int bank
= ADP5588_BANK(kpad
->gpiomap
[off
]);
117 unsigned int bit
= ADP5588_BIT(kpad
->gpiomap
[off
]);
120 mutex_lock(&kpad
->gpio_lock
);
122 kpad
->dir
[bank
] &= ~bit
;
123 ret
= adp5588_write(kpad
->client
, GPIO_DIR1
+ bank
, kpad
->dir
[bank
]);
125 mutex_unlock(&kpad
->gpio_lock
);
130 static int adp5588_gpio_direction_output(struct gpio_chip
*chip
,
131 unsigned off
, int val
)
133 struct adp5588_kpad
*kpad
= container_of(chip
, struct adp5588_kpad
, gc
);
134 unsigned int bank
= ADP5588_BANK(kpad
->gpiomap
[off
]);
135 unsigned int bit
= ADP5588_BIT(kpad
->gpiomap
[off
]);
138 mutex_lock(&kpad
->gpio_lock
);
140 kpad
->dir
[bank
] |= bit
;
143 kpad
->dat_out
[bank
] |= bit
;
145 kpad
->dat_out
[bank
] &= ~bit
;
147 ret
= adp5588_write(kpad
->client
, GPIO_DAT_OUT1
+ bank
,
148 kpad
->dat_out
[bank
]);
149 ret
|= adp5588_write(kpad
->client
, GPIO_DIR1
+ bank
,
152 mutex_unlock(&kpad
->gpio_lock
);
157 static int adp5588_build_gpiomap(struct adp5588_kpad
*kpad
,
158 const struct adp5588_kpad_platform_data
*pdata
)
160 bool pin_used
[ADP5588_MAXGPIO
];
164 memset(pin_used
, 0, sizeof(pin_used
));
166 for (i
= 0; i
< pdata
->rows
; i
++)
169 for (i
= 0; i
< pdata
->cols
; i
++)
170 pin_used
[i
+ GPI_PIN_COL_BASE
- GPI_PIN_BASE
] = true;
172 for (i
= 0; i
< kpad
->gpimapsize
; i
++)
173 pin_used
[kpad
->gpimap
[i
].pin
- GPI_PIN_BASE
] = true;
175 for (i
= 0; i
< ADP5588_MAXGPIO
; i
++)
177 kpad
->gpiomap
[n_unused
++] = i
;
182 static int adp5588_gpio_add(struct adp5588_kpad
*kpad
)
184 struct device
*dev
= &kpad
->client
->dev
;
185 const struct adp5588_kpad_platform_data
*pdata
= dev_get_platdata(dev
);
186 const struct adp5588_gpio_platform_data
*gpio_data
= pdata
->gpio_data
;
192 kpad
->gc
.ngpio
= adp5588_build_gpiomap(kpad
, pdata
);
193 if (kpad
->gc
.ngpio
== 0) {
194 dev_info(dev
, "No unused gpios left to export\n");
198 kpad
->export_gpio
= true;
200 kpad
->gc
.direction_input
= adp5588_gpio_direction_input
;
201 kpad
->gc
.direction_output
= adp5588_gpio_direction_output
;
202 kpad
->gc
.get
= adp5588_gpio_get_value
;
203 kpad
->gc
.set
= adp5588_gpio_set_value
;
204 kpad
->gc
.can_sleep
= 1;
206 kpad
->gc
.base
= gpio_data
->gpio_start
;
207 kpad
->gc
.label
= kpad
->client
->name
;
208 kpad
->gc
.owner
= THIS_MODULE
;
209 kpad
->gc
.names
= gpio_data
->names
;
211 mutex_init(&kpad
->gpio_lock
);
213 error
= gpiochip_add(&kpad
->gc
);
215 dev_err(dev
, "gpiochip_add failed, err: %d\n", error
);
219 for (i
= 0; i
<= ADP5588_BANK(ADP5588_MAXGPIO
); i
++) {
220 kpad
->dat_out
[i
] = adp5588_read(kpad
->client
,
222 kpad
->dir
[i
] = adp5588_read(kpad
->client
, GPIO_DIR1
+ i
);
225 if (gpio_data
->setup
) {
226 error
= gpio_data
->setup(kpad
->client
,
227 kpad
->gc
.base
, kpad
->gc
.ngpio
,
230 dev_warn(dev
, "setup failed, %d\n", error
);
236 static void adp5588_gpio_remove(struct adp5588_kpad
*kpad
)
238 struct device
*dev
= &kpad
->client
->dev
;
239 const struct adp5588_kpad_platform_data
*pdata
= dev_get_platdata(dev
);
240 const struct adp5588_gpio_platform_data
*gpio_data
= pdata
->gpio_data
;
243 if (!kpad
->export_gpio
)
246 if (gpio_data
->teardown
) {
247 error
= gpio_data
->teardown(kpad
->client
,
248 kpad
->gc
.base
, kpad
->gc
.ngpio
,
251 dev_warn(dev
, "teardown failed %d\n", error
);
254 error
= gpiochip_remove(&kpad
->gc
);
256 dev_warn(dev
, "gpiochip_remove failed %d\n", error
);
259 static inline int adp5588_gpio_add(struct adp5588_kpad
*kpad
)
264 static inline void adp5588_gpio_remove(struct adp5588_kpad
*kpad
)
269 static void adp5588_report_events(struct adp5588_kpad
*kpad
, int ev_cnt
)
273 for (i
= 0; i
< ev_cnt
; i
++) {
274 int key
= adp5588_read(kpad
->client
, Key_EVENTA
+ i
);
275 int key_val
= key
& KEY_EV_MASK
;
277 if (key_val
>= GPI_PIN_BASE
&& key_val
<= GPI_PIN_END
) {
278 for (j
= 0; j
< kpad
->gpimapsize
; j
++) {
279 if (key_val
== kpad
->gpimap
[j
].pin
) {
280 input_report_switch(kpad
->input
,
281 kpad
->gpimap
[j
].sw_evt
,
282 key
& KEY_EV_PRESSED
);
287 input_report_key(kpad
->input
,
288 kpad
->keycode
[key_val
- 1],
289 key
& KEY_EV_PRESSED
);
294 static void adp5588_work(struct work_struct
*work
)
296 struct adp5588_kpad
*kpad
= container_of(work
,
297 struct adp5588_kpad
, work
.work
);
298 struct i2c_client
*client
= kpad
->client
;
301 status
= adp5588_read(client
, INT_STAT
);
303 if (status
& ADP5588_OVR_FLOW_INT
) /* Unlikely and should never happen */
304 dev_err(&client
->dev
, "Event Overflow Error\n");
306 if (status
& ADP5588_KE_INT
) {
307 ev_cnt
= adp5588_read(client
, KEY_LCK_EC_STAT
) & ADP5588_KEC
;
309 adp5588_report_events(kpad
, ev_cnt
);
310 input_sync(kpad
->input
);
313 adp5588_write(client
, INT_STAT
, status
); /* Status is W1C */
316 static irqreturn_t
adp5588_irq(int irq
, void *handle
)
318 struct adp5588_kpad
*kpad
= handle
;
321 * use keventd context to read the event fifo registers
322 * Schedule readout at least 25ms after notification for
326 schedule_delayed_work(&kpad
->work
, kpad
->delay
);
331 static int adp5588_setup(struct i2c_client
*client
)
333 const struct adp5588_kpad_platform_data
*pdata
=
334 dev_get_platdata(&client
->dev
);
335 const struct adp5588_gpio_platform_data
*gpio_data
= pdata
->gpio_data
;
337 unsigned char evt_mode1
= 0, evt_mode2
= 0, evt_mode3
= 0;
339 ret
= adp5588_write(client
, KP_GPIO1
, KP_SEL(pdata
->rows
));
340 ret
|= adp5588_write(client
, KP_GPIO2
, KP_SEL(pdata
->cols
) & 0xFF);
341 ret
|= adp5588_write(client
, KP_GPIO3
, KP_SEL(pdata
->cols
) >> 8);
343 if (pdata
->en_keylock
) {
344 ret
|= adp5588_write(client
, UNLOCK1
, pdata
->unlock_key1
);
345 ret
|= adp5588_write(client
, UNLOCK2
, pdata
->unlock_key2
);
346 ret
|= adp5588_write(client
, KEY_LCK_EC_STAT
, ADP5588_K_LCK_EN
);
349 for (i
= 0; i
< KEYP_MAX_EVENT
; i
++)
350 ret
|= adp5588_read(client
, Key_EVENTA
);
352 for (i
= 0; i
< pdata
->gpimapsize
; i
++) {
353 unsigned short pin
= pdata
->gpimap
[i
].pin
;
355 if (pin
<= GPI_PIN_ROW_END
) {
356 evt_mode1
|= (1 << (pin
- GPI_PIN_ROW_BASE
));
358 evt_mode2
|= ((1 << (pin
- GPI_PIN_COL_BASE
)) & 0xFF);
359 evt_mode3
|= ((1 << (pin
- GPI_PIN_COL_BASE
)) >> 8);
363 if (pdata
->gpimapsize
) {
364 ret
|= adp5588_write(client
, GPI_EM1
, evt_mode1
);
365 ret
|= adp5588_write(client
, GPI_EM2
, evt_mode2
);
366 ret
|= adp5588_write(client
, GPI_EM3
, evt_mode3
);
370 for (i
= 0; i
<= ADP5588_BANK(ADP5588_MAXGPIO
); i
++) {
371 int pull_mask
= gpio_data
->pullup_dis_mask
;
373 ret
|= adp5588_write(client
, GPIO_PULL1
+ i
,
374 (pull_mask
>> (8 * i
)) & 0xFF);
378 ret
|= adp5588_write(client
, INT_STAT
,
379 ADP5588_CMP2_INT
| ADP5588_CMP1_INT
|
380 ADP5588_OVR_FLOW_INT
| ADP5588_K_LCK_INT
|
381 ADP5588_GPI_INT
| ADP5588_KE_INT
); /* Status is W1C */
383 ret
|= adp5588_write(client
, CFG
, ADP5588_INT_CFG
|
384 ADP5588_OVR_FLOW_IEN
|
388 dev_err(&client
->dev
, "Write Error\n");
395 static void adp5588_report_switch_state(struct adp5588_kpad
*kpad
)
397 int gpi_stat1
= adp5588_read(kpad
->client
, GPIO_DAT_STAT1
);
398 int gpi_stat2
= adp5588_read(kpad
->client
, GPIO_DAT_STAT2
);
399 int gpi_stat3
= adp5588_read(kpad
->client
, GPIO_DAT_STAT3
);
400 int gpi_stat_tmp
, pin_loc
;
403 for (i
= 0; i
< kpad
->gpimapsize
; i
++) {
404 unsigned short pin
= kpad
->gpimap
[i
].pin
;
406 if (pin
<= GPI_PIN_ROW_END
) {
407 gpi_stat_tmp
= gpi_stat1
;
408 pin_loc
= pin
- GPI_PIN_ROW_BASE
;
409 } else if ((pin
- GPI_PIN_COL_BASE
) < 8) {
410 gpi_stat_tmp
= gpi_stat2
;
411 pin_loc
= pin
- GPI_PIN_COL_BASE
;
413 gpi_stat_tmp
= gpi_stat3
;
414 pin_loc
= pin
- GPI_PIN_COL_BASE
- 8;
417 if (gpi_stat_tmp
< 0) {
418 dev_err(&kpad
->client
->dev
,
419 "Can't read GPIO_DAT_STAT switch %d default to OFF\n",
424 input_report_switch(kpad
->input
,
425 kpad
->gpimap
[i
].sw_evt
,
426 !(gpi_stat_tmp
& (1 << pin_loc
)));
429 input_sync(kpad
->input
);
433 static int adp5588_probe(struct i2c_client
*client
,
434 const struct i2c_device_id
*id
)
436 struct adp5588_kpad
*kpad
;
437 const struct adp5588_kpad_platform_data
*pdata
=
438 dev_get_platdata(&client
->dev
);
439 struct input_dev
*input
;
444 if (!i2c_check_functionality(client
->adapter
,
445 I2C_FUNC_SMBUS_BYTE_DATA
)) {
446 dev_err(&client
->dev
, "SMBUS Byte Data not Supported\n");
451 dev_err(&client
->dev
, "no platform data?\n");
455 if (!pdata
->rows
|| !pdata
->cols
|| !pdata
->keymap
) {
456 dev_err(&client
->dev
, "no rows, cols or keymap from pdata\n");
460 if (pdata
->keymapsize
!= ADP5588_KEYMAPSIZE
) {
461 dev_err(&client
->dev
, "invalid keymapsize\n");
465 if (!pdata
->gpimap
&& pdata
->gpimapsize
) {
466 dev_err(&client
->dev
, "invalid gpimap from pdata\n");
470 if (pdata
->gpimapsize
> ADP5588_GPIMAPSIZE_MAX
) {
471 dev_err(&client
->dev
, "invalid gpimapsize\n");
475 for (i
= 0; i
< pdata
->gpimapsize
; i
++) {
476 unsigned short pin
= pdata
->gpimap
[i
].pin
;
478 if (pin
< GPI_PIN_BASE
|| pin
> GPI_PIN_END
) {
479 dev_err(&client
->dev
, "invalid gpi pin data\n");
483 if (pin
<= GPI_PIN_ROW_END
) {
484 if (pin
- GPI_PIN_ROW_BASE
+ 1 <= pdata
->rows
) {
485 dev_err(&client
->dev
, "invalid gpi row data\n");
489 if (pin
- GPI_PIN_COL_BASE
+ 1 <= pdata
->cols
) {
490 dev_err(&client
->dev
, "invalid gpi col data\n");
497 dev_err(&client
->dev
, "no IRQ?\n");
501 kpad
= kzalloc(sizeof(*kpad
), GFP_KERNEL
);
502 input
= input_allocate_device();
503 if (!kpad
|| !input
) {
508 kpad
->client
= client
;
510 INIT_DELAYED_WORK(&kpad
->work
, adp5588_work
);
512 ret
= adp5588_read(client
, DEV_ID
);
518 revid
= (u8
) ret
& ADP5588_DEVICE_ID_MASK
;
519 if (WA_DELAYED_READOUT_REVID(revid
))
520 kpad
->delay
= msecs_to_jiffies(30);
522 input
->name
= client
->name
;
523 input
->phys
= "adp5588-keys/input0";
524 input
->dev
.parent
= &client
->dev
;
526 input_set_drvdata(input
, kpad
);
528 input
->id
.bustype
= BUS_I2C
;
529 input
->id
.vendor
= 0x0001;
530 input
->id
.product
= 0x0001;
531 input
->id
.version
= revid
;
533 input
->keycodesize
= sizeof(kpad
->keycode
[0]);
534 input
->keycodemax
= pdata
->keymapsize
;
535 input
->keycode
= kpad
->keycode
;
537 memcpy(kpad
->keycode
, pdata
->keymap
,
538 pdata
->keymapsize
* input
->keycodesize
);
540 kpad
->gpimap
= pdata
->gpimap
;
541 kpad
->gpimapsize
= pdata
->gpimapsize
;
543 /* setup input device */
544 __set_bit(EV_KEY
, input
->evbit
);
547 __set_bit(EV_REP
, input
->evbit
);
549 for (i
= 0; i
< input
->keycodemax
; i
++)
550 if (kpad
->keycode
[i
] <= KEY_MAX
)
551 __set_bit(kpad
->keycode
[i
], input
->keybit
);
552 __clear_bit(KEY_RESERVED
, input
->keybit
);
554 if (kpad
->gpimapsize
)
555 __set_bit(EV_SW
, input
->evbit
);
556 for (i
= 0; i
< kpad
->gpimapsize
; i
++)
557 __set_bit(kpad
->gpimap
[i
].sw_evt
, input
->swbit
);
559 error
= input_register_device(input
);
561 dev_err(&client
->dev
, "unable to register input device\n");
565 error
= request_irq(client
->irq
, adp5588_irq
,
566 IRQF_TRIGGER_FALLING
,
567 client
->dev
.driver
->name
, kpad
);
569 dev_err(&client
->dev
, "irq %d busy?\n", client
->irq
);
573 error
= adp5588_setup(client
);
577 if (kpad
->gpimapsize
)
578 adp5588_report_switch_state(kpad
);
580 error
= adp5588_gpio_add(kpad
);
584 device_init_wakeup(&client
->dev
, 1);
585 i2c_set_clientdata(client
, kpad
);
587 dev_info(&client
->dev
, "Rev.%d keypad, irq %d\n", revid
, client
->irq
);
591 free_irq(client
->irq
, kpad
);
592 cancel_delayed_work_sync(&kpad
->work
);
594 input_unregister_device(input
);
597 input_free_device(input
);
603 static int adp5588_remove(struct i2c_client
*client
)
605 struct adp5588_kpad
*kpad
= i2c_get_clientdata(client
);
607 adp5588_write(client
, CFG
, 0);
608 free_irq(client
->irq
, kpad
);
609 cancel_delayed_work_sync(&kpad
->work
);
610 input_unregister_device(kpad
->input
);
611 adp5588_gpio_remove(kpad
);
618 static int adp5588_suspend(struct device
*dev
)
620 struct adp5588_kpad
*kpad
= dev_get_drvdata(dev
);
621 struct i2c_client
*client
= kpad
->client
;
623 disable_irq(client
->irq
);
624 cancel_delayed_work_sync(&kpad
->work
);
626 if (device_may_wakeup(&client
->dev
))
627 enable_irq_wake(client
->irq
);
632 static int adp5588_resume(struct device
*dev
)
634 struct adp5588_kpad
*kpad
= dev_get_drvdata(dev
);
635 struct i2c_client
*client
= kpad
->client
;
637 if (device_may_wakeup(&client
->dev
))
638 disable_irq_wake(client
->irq
);
640 enable_irq(client
->irq
);
645 static const struct dev_pm_ops adp5588_dev_pm_ops
= {
646 .suspend
= adp5588_suspend
,
647 .resume
= adp5588_resume
,
651 static const struct i2c_device_id adp5588_id
[] = {
652 { "adp5588-keys", 0 },
653 { "adp5587-keys", 0 },
656 MODULE_DEVICE_TABLE(i2c
, adp5588_id
);
658 static struct i2c_driver adp5588_driver
= {
660 .name
= KBUILD_MODNAME
,
662 .pm
= &adp5588_dev_pm_ops
,
665 .probe
= adp5588_probe
,
666 .remove
= adp5588_remove
,
667 .id_table
= adp5588_id
,
670 module_i2c_driver(adp5588_driver
);
672 MODULE_LICENSE("GPL");
673 MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>");
674 MODULE_DESCRIPTION("ADP5588/87 Keypad driver");