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/init.h>
13 #include <linux/interrupt.h>
14 #include <linux/irq.h>
15 #include <linux/workqueue.h>
16 #include <linux/errno.h>
18 #include <linux/platform_device.h>
19 #include <linux/input.h>
20 #include <linux/i2c.h>
21 #include <linux/gpio.h>
22 #include <linux/slab.h>
24 #include <linux/i2c/adp5588.h>
26 /* Key Event Register xy */
27 #define KEY_EV_PRESSED (1 << 7)
28 #define KEY_EV_MASK (0x7F)
30 #define KP_SEL(x) (0xFFFF >> (16 - x)) /* 2^x-1 */
32 #define KEYP_MAX_EVENT 10
35 * Early pre 4.0 Silicon required to delay readout by at least 25ms,
36 * since the Event Counter Register updated 25ms after the interrupt
39 #define WA_DELAYED_READOUT_REVID(rev) ((rev) < 4)
42 struct i2c_client *client;
43 struct input_dev *input;
44 struct delayed_work work;
46 unsigned short keycode[ADP5588_KEYMAPSIZE];
47 const struct adp5588_gpi_map *gpimap;
48 unsigned short gpimapsize;
50 unsigned char gpiomap[ADP5588_MAXGPIO];
53 struct mutex gpio_lock; /* Protect cached dir, dat_out */
59 static int adp5588_read(struct i2c_client *client, u8 reg)
61 int ret = i2c_smbus_read_byte_data(client, reg);
64 dev_err(&client->dev, "Read Error\n");
69 static int adp5588_write(struct i2c_client *client, u8 reg, u8 val)
71 return i2c_smbus_write_byte_data(client, reg, val);
75 static int adp5588_gpio_get_value(struct gpio_chip *chip, unsigned off)
77 struct adp5588_kpad *kpad = container_of(chip, struct adp5588_kpad, gc);
78 unsigned int bank = ADP5588_BANK(kpad->gpiomap[off]);
79 unsigned int bit = ADP5588_BIT(kpad->gpiomap[off]);
81 return !!(adp5588_read(kpad->client, GPIO_DAT_STAT1 + bank) & bit);
84 static void adp5588_gpio_set_value(struct gpio_chip *chip,
85 unsigned off, int val)
87 struct adp5588_kpad *kpad = container_of(chip, struct adp5588_kpad, gc);
88 unsigned int bank = ADP5588_BANK(kpad->gpiomap[off]);
89 unsigned int bit = ADP5588_BIT(kpad->gpiomap[off]);
91 mutex_lock(&kpad->gpio_lock);
94 kpad->dat_out[bank] |= bit;
96 kpad->dat_out[bank] &= ~bit;
98 adp5588_write(kpad->client, GPIO_DAT_OUT1 + bank,
101 mutex_unlock(&kpad->gpio_lock);
104 static int adp5588_gpio_direction_input(struct gpio_chip *chip, unsigned off)
106 struct adp5588_kpad *kpad = container_of(chip, struct adp5588_kpad, gc);
107 unsigned int bank = ADP5588_BANK(kpad->gpiomap[off]);
108 unsigned int bit = ADP5588_BIT(kpad->gpiomap[off]);
111 mutex_lock(&kpad->gpio_lock);
113 kpad->dir[bank] &= ~bit;
114 ret = adp5588_write(kpad->client, GPIO_DIR1 + bank, kpad->dir[bank]);
116 mutex_unlock(&kpad->gpio_lock);
121 static int adp5588_gpio_direction_output(struct gpio_chip *chip,
122 unsigned off, int val)
124 struct adp5588_kpad *kpad = container_of(chip, struct adp5588_kpad, gc);
125 unsigned int bank = ADP5588_BANK(kpad->gpiomap[off]);
126 unsigned int bit = ADP5588_BIT(kpad->gpiomap[off]);
129 mutex_lock(&kpad->gpio_lock);
131 kpad->dir[bank] |= bit;
134 kpad->dat_out[bank] |= bit;
136 kpad->dat_out[bank] &= ~bit;
138 ret = adp5588_write(kpad->client, GPIO_DAT_OUT1 + bank,
139 kpad->dat_out[bank]);
140 ret |= adp5588_write(kpad->client, GPIO_DIR1 + bank,
143 mutex_unlock(&kpad->gpio_lock);
148 static int adp5588_build_gpiomap(struct adp5588_kpad *kpad,
149 const struct adp5588_kpad_platform_data *pdata)
151 bool pin_used[ADP5588_MAXGPIO];
155 memset(pin_used, 0, sizeof(pin_used));
157 for (i = 0; i < pdata->rows; i++)
160 for (i = 0; i < pdata->cols; i++)
161 pin_used[i + GPI_PIN_COL_BASE - GPI_PIN_BASE] = true;
163 for (i = 0; i < kpad->gpimapsize; i++)
164 pin_used[kpad->gpimap[i].pin - GPI_PIN_BASE] = true;
166 for (i = 0; i < ADP5588_MAXGPIO; i++)
168 kpad->gpiomap[n_unused++] = i;
173 static int adp5588_gpio_add(struct adp5588_kpad *kpad)
175 struct device *dev = &kpad->client->dev;
176 const struct adp5588_kpad_platform_data *pdata = dev->platform_data;
177 const struct adp5588_gpio_platform_data *gpio_data = pdata->gpio_data;
183 kpad->gc.ngpio = adp5588_build_gpiomap(kpad, pdata);
184 if (kpad->gc.ngpio == 0) {
185 dev_info(dev, "No unused gpios left to export\n");
189 kpad->export_gpio = true;
191 kpad->gc.direction_input = adp5588_gpio_direction_input;
192 kpad->gc.direction_output = adp5588_gpio_direction_output;
193 kpad->gc.get = adp5588_gpio_get_value;
194 kpad->gc.set = adp5588_gpio_set_value;
195 kpad->gc.can_sleep = 1;
197 kpad->gc.base = gpio_data->gpio_start;
198 kpad->gc.label = kpad->client->name;
199 kpad->gc.owner = THIS_MODULE;
200 kpad->gc.names = gpio_data->names;
202 mutex_init(&kpad->gpio_lock);
204 error = gpiochip_add(&kpad->gc);
206 dev_err(dev, "gpiochip_add failed, err: %d\n", error);
210 for (i = 0; i <= ADP5588_BANK(ADP5588_MAXGPIO); i++) {
211 kpad->dat_out[i] = adp5588_read(kpad->client,
213 kpad->dir[i] = adp5588_read(kpad->client, GPIO_DIR1 + i);
216 if (gpio_data->setup) {
217 error = gpio_data->setup(kpad->client,
218 kpad->gc.base, kpad->gc.ngpio,
221 dev_warn(dev, "setup failed, %d\n", error);
227 static void adp5588_gpio_remove(struct adp5588_kpad *kpad)
229 struct device *dev = &kpad->client->dev;
230 const struct adp5588_kpad_platform_data *pdata = dev->platform_data;
231 const struct adp5588_gpio_platform_data *gpio_data = pdata->gpio_data;
234 if (!kpad->export_gpio)
237 if (gpio_data->teardown) {
238 error = gpio_data->teardown(kpad->client,
239 kpad->gc.base, kpad->gc.ngpio,
242 dev_warn(dev, "teardown failed %d\n", error);
245 error = gpiochip_remove(&kpad->gc);
247 dev_warn(dev, "gpiochip_remove failed %d\n", error);
250 static inline int adp5588_gpio_add(struct adp5588_kpad *kpad)
255 static inline void adp5588_gpio_remove(struct adp5588_kpad *kpad)
260 static void adp5588_report_events(struct adp5588_kpad *kpad, int ev_cnt)
264 for (i = 0; i < ev_cnt; i++) {
265 int key = adp5588_read(kpad->client, Key_EVENTA + i);
266 int key_val = key & KEY_EV_MASK;
268 if (key_val >= GPI_PIN_BASE && key_val <= GPI_PIN_END) {
269 for (j = 0; j < kpad->gpimapsize; j++) {
270 if (key_val == kpad->gpimap[j].pin) {
271 input_report_switch(kpad->input,
272 kpad->gpimap[j].sw_evt,
273 key & KEY_EV_PRESSED);
278 input_report_key(kpad->input,
279 kpad->keycode[key_val - 1],
280 key & KEY_EV_PRESSED);
285 static void adp5588_work(struct work_struct *work)
287 struct adp5588_kpad *kpad = container_of(work,
288 struct adp5588_kpad, work.work);
289 struct i2c_client *client = kpad->client;
292 status = adp5588_read(client, INT_STAT);
294 if (status & ADP5588_OVR_FLOW_INT) /* Unlikely and should never happen */
295 dev_err(&client->dev, "Event Overflow Error\n");
297 if (status & ADP5588_KE_INT) {
298 ev_cnt = adp5588_read(client, KEY_LCK_EC_STAT) & ADP5588_KEC;
300 adp5588_report_events(kpad, ev_cnt);
301 input_sync(kpad->input);
304 adp5588_write(client, INT_STAT, status); /* Status is W1C */
307 static irqreturn_t adp5588_irq(int irq, void *handle)
309 struct adp5588_kpad *kpad = handle;
312 * use keventd context to read the event fifo registers
313 * Schedule readout at least 25ms after notification for
317 schedule_delayed_work(&kpad->work, kpad->delay);
322 static int adp5588_setup(struct i2c_client *client)
324 const struct adp5588_kpad_platform_data *pdata = client->dev.platform_data;
325 const struct adp5588_gpio_platform_data *gpio_data = pdata->gpio_data;
327 unsigned char evt_mode1 = 0, evt_mode2 = 0, evt_mode3 = 0;
329 ret = adp5588_write(client, KP_GPIO1, KP_SEL(pdata->rows));
330 ret |= adp5588_write(client, KP_GPIO2, KP_SEL(pdata->cols) & 0xFF);
331 ret |= adp5588_write(client, KP_GPIO3, KP_SEL(pdata->cols) >> 8);
333 if (pdata->en_keylock) {
334 ret |= adp5588_write(client, UNLOCK1, pdata->unlock_key1);
335 ret |= adp5588_write(client, UNLOCK2, pdata->unlock_key2);
336 ret |= adp5588_write(client, KEY_LCK_EC_STAT, ADP5588_K_LCK_EN);
339 for (i = 0; i < KEYP_MAX_EVENT; i++)
340 ret |= adp5588_read(client, Key_EVENTA);
342 for (i = 0; i < pdata->gpimapsize; i++) {
343 unsigned short pin = pdata->gpimap[i].pin;
345 if (pin <= GPI_PIN_ROW_END) {
346 evt_mode1 |= (1 << (pin - GPI_PIN_ROW_BASE));
348 evt_mode2 |= ((1 << (pin - GPI_PIN_COL_BASE)) & 0xFF);
349 evt_mode3 |= ((1 << (pin - GPI_PIN_COL_BASE)) >> 8);
353 if (pdata->gpimapsize) {
354 ret |= adp5588_write(client, GPI_EM1, evt_mode1);
355 ret |= adp5588_write(client, GPI_EM2, evt_mode2);
356 ret |= adp5588_write(client, GPI_EM3, evt_mode3);
360 for (i = 0; i <= ADP5588_BANK(ADP5588_MAXGPIO); i++) {
361 int pull_mask = gpio_data->pullup_dis_mask;
363 ret |= adp5588_write(client, GPIO_PULL1 + i,
364 (pull_mask >> (8 * i)) & 0xFF);
368 ret |= adp5588_write(client, INT_STAT,
369 ADP5588_CMP2_INT | ADP5588_CMP1_INT |
370 ADP5588_OVR_FLOW_INT | ADP5588_K_LCK_INT |
371 ADP5588_GPI_INT | ADP5588_KE_INT); /* Status is W1C */
373 ret |= adp5588_write(client, CFG, ADP5588_INT_CFG |
374 ADP5588_OVR_FLOW_IEN |
378 dev_err(&client->dev, "Write Error\n");
385 static void adp5588_report_switch_state(struct adp5588_kpad *kpad)
387 int gpi_stat1 = adp5588_read(kpad->client, GPIO_DAT_STAT1);
388 int gpi_stat2 = adp5588_read(kpad->client, GPIO_DAT_STAT2);
389 int gpi_stat3 = adp5588_read(kpad->client, GPIO_DAT_STAT3);
390 int gpi_stat_tmp, pin_loc;
393 for (i = 0; i < kpad->gpimapsize; i++) {
394 unsigned short pin = kpad->gpimap[i].pin;
396 if (pin <= GPI_PIN_ROW_END) {
397 gpi_stat_tmp = gpi_stat1;
398 pin_loc = pin - GPI_PIN_ROW_BASE;
399 } else if ((pin - GPI_PIN_COL_BASE) < 8) {
400 gpi_stat_tmp = gpi_stat2;
401 pin_loc = pin - GPI_PIN_COL_BASE;
403 gpi_stat_tmp = gpi_stat3;
404 pin_loc = pin - GPI_PIN_COL_BASE - 8;
407 if (gpi_stat_tmp < 0) {
408 dev_err(&kpad->client->dev,
409 "Can't read GPIO_DAT_STAT switch %d default to OFF\n",
414 input_report_switch(kpad->input,
415 kpad->gpimap[i].sw_evt,
416 !(gpi_stat_tmp & (1 << pin_loc)));
419 input_sync(kpad->input);
423 static int adp5588_probe(struct i2c_client *client,
424 const struct i2c_device_id *id)
426 struct adp5588_kpad *kpad;
427 const struct adp5588_kpad_platform_data *pdata = client->dev.platform_data;
428 struct input_dev *input;
433 if (!i2c_check_functionality(client->adapter,
434 I2C_FUNC_SMBUS_BYTE_DATA)) {
435 dev_err(&client->dev, "SMBUS Byte Data not Supported\n");
440 dev_err(&client->dev, "no platform data?\n");
444 if (!pdata->rows || !pdata->cols || !pdata->keymap) {
445 dev_err(&client->dev, "no rows, cols or keymap from pdata\n");
449 if (pdata->keymapsize != ADP5588_KEYMAPSIZE) {
450 dev_err(&client->dev, "invalid keymapsize\n");
454 if (!pdata->gpimap && pdata->gpimapsize) {
455 dev_err(&client->dev, "invalid gpimap from pdata\n");
459 if (pdata->gpimapsize > ADP5588_GPIMAPSIZE_MAX) {
460 dev_err(&client->dev, "invalid gpimapsize\n");
464 for (i = 0; i < pdata->gpimapsize; i++) {
465 unsigned short pin = pdata->gpimap[i].pin;
467 if (pin < GPI_PIN_BASE || pin > GPI_PIN_END) {
468 dev_err(&client->dev, "invalid gpi pin data\n");
472 if (pin <= GPI_PIN_ROW_END) {
473 if (pin - GPI_PIN_ROW_BASE + 1 <= pdata->rows) {
474 dev_err(&client->dev, "invalid gpi row data\n");
478 if (pin - GPI_PIN_COL_BASE + 1 <= pdata->cols) {
479 dev_err(&client->dev, "invalid gpi col data\n");
486 dev_err(&client->dev, "no IRQ?\n");
490 kpad = kzalloc(sizeof(*kpad), GFP_KERNEL);
491 input = input_allocate_device();
492 if (!kpad || !input) {
497 kpad->client = client;
499 INIT_DELAYED_WORK(&kpad->work, adp5588_work);
501 ret = adp5588_read(client, DEV_ID);
507 revid = (u8) ret & ADP5588_DEVICE_ID_MASK;
508 if (WA_DELAYED_READOUT_REVID(revid))
509 kpad->delay = msecs_to_jiffies(30);
511 input->name = client->name;
512 input->phys = "adp5588-keys/input0";
513 input->dev.parent = &client->dev;
515 input_set_drvdata(input, kpad);
517 input->id.bustype = BUS_I2C;
518 input->id.vendor = 0x0001;
519 input->id.product = 0x0001;
520 input->id.version = revid;
522 input->keycodesize = sizeof(kpad->keycode[0]);
523 input->keycodemax = pdata->keymapsize;
524 input->keycode = kpad->keycode;
526 memcpy(kpad->keycode, pdata->keymap,
527 pdata->keymapsize * input->keycodesize);
529 kpad->gpimap = pdata->gpimap;
530 kpad->gpimapsize = pdata->gpimapsize;
532 /* setup input device */
533 __set_bit(EV_KEY, input->evbit);
536 __set_bit(EV_REP, input->evbit);
538 for (i = 0; i < input->keycodemax; i++)
539 __set_bit(kpad->keycode[i] & KEY_MAX, input->keybit);
540 __clear_bit(KEY_RESERVED, input->keybit);
542 if (kpad->gpimapsize)
543 __set_bit(EV_SW, input->evbit);
544 for (i = 0; i < kpad->gpimapsize; i++)
545 __set_bit(kpad->gpimap[i].sw_evt, input->swbit);
547 error = input_register_device(input);
549 dev_err(&client->dev, "unable to register input device\n");
553 error = request_irq(client->irq, adp5588_irq,
554 IRQF_TRIGGER_FALLING,
555 client->dev.driver->name, kpad);
557 dev_err(&client->dev, "irq %d busy?\n", client->irq);
561 error = adp5588_setup(client);
565 if (kpad->gpimapsize)
566 adp5588_report_switch_state(kpad);
568 error = adp5588_gpio_add(kpad);
572 device_init_wakeup(&client->dev, 1);
573 i2c_set_clientdata(client, kpad);
575 dev_info(&client->dev, "Rev.%d keypad, irq %d\n", revid, client->irq);
579 free_irq(client->irq, kpad);
581 input_unregister_device(input);
584 input_free_device(input);
590 static int adp5588_remove(struct i2c_client *client)
592 struct adp5588_kpad *kpad = i2c_get_clientdata(client);
594 adp5588_write(client, CFG, 0);
595 free_irq(client->irq, kpad);
596 cancel_delayed_work_sync(&kpad->work);
597 input_unregister_device(kpad->input);
598 adp5588_gpio_remove(kpad);
605 static int adp5588_suspend(struct device *dev)
607 struct adp5588_kpad *kpad = dev_get_drvdata(dev);
608 struct i2c_client *client = kpad->client;
610 disable_irq(client->irq);
611 cancel_delayed_work_sync(&kpad->work);
613 if (device_may_wakeup(&client->dev))
614 enable_irq_wake(client->irq);
619 static int adp5588_resume(struct device *dev)
621 struct adp5588_kpad *kpad = dev_get_drvdata(dev);
622 struct i2c_client *client = kpad->client;
624 if (device_may_wakeup(&client->dev))
625 disable_irq_wake(client->irq);
627 enable_irq(client->irq);
632 static const struct dev_pm_ops adp5588_dev_pm_ops = {
633 .suspend = adp5588_suspend,
634 .resume = adp5588_resume,
638 static const struct i2c_device_id adp5588_id[] = {
639 { "adp5588-keys", 0 },
640 { "adp5587-keys", 0 },
643 MODULE_DEVICE_TABLE(i2c, adp5588_id);
645 static struct i2c_driver adp5588_driver = {
647 .name = KBUILD_MODNAME,
649 .pm = &adp5588_dev_pm_ops,
652 .probe = adp5588_probe,
653 .remove = adp5588_remove,
654 .id_table = adp5588_id,
657 module_i2c_driver(adp5588_driver);
659 MODULE_LICENSE("GPL");
660 MODULE_AUTHOR("Michael Hennerich <hennerich@blackfin.uclinux.org>");
661 MODULE_DESCRIPTION("ADP5588/87 Keypad driver");