2 * Samsung keypad driver
4 * Copyright (C) 2010 Samsung Electronics Co.Ltd
5 * Author: Joonyoung Shim <jy0922.shim@samsung.com>
6 * Author: Donghwa Lee <dh09.lee@samsung.com>
8 * This program is free software; you can redistribute it and/or modify it
9 * under the terms of the GNU General Public License as published by the
10 * Free Software Foundation; either version 2 of the License, or (at your
11 * option) any later version.
14 #include <linux/clk.h>
15 #include <linux/delay.h>
16 #include <linux/err.h>
17 #include <linux/init.h>
18 #include <linux/input.h>
19 #include <linux/interrupt.h>
21 #include <linux/module.h>
22 #include <linux/platform_device.h>
24 #include <linux/pm_runtime.h>
25 #include <linux/slab.h>
27 #include <linux/of_gpio.h>
28 #include <linux/sched.h>
29 #include <linux/input/samsung-keypad.h>
31 #define SAMSUNG_KEYIFCON 0x00
32 #define SAMSUNG_KEYIFSTSCLR 0x04
33 #define SAMSUNG_KEYIFCOL 0x08
34 #define SAMSUNG_KEYIFROW 0x0c
35 #define SAMSUNG_KEYIFFC 0x10
37 /* SAMSUNG_KEYIFCON */
38 #define SAMSUNG_KEYIFCON_INT_F_EN (1 << 0)
39 #define SAMSUNG_KEYIFCON_INT_R_EN (1 << 1)
40 #define SAMSUNG_KEYIFCON_DF_EN (1 << 2)
41 #define SAMSUNG_KEYIFCON_FC_EN (1 << 3)
42 #define SAMSUNG_KEYIFCON_WAKEUPEN (1 << 4)
44 /* SAMSUNG_KEYIFSTSCLR */
45 #define SAMSUNG_KEYIFSTSCLR_P_INT_MASK (0xff << 0)
46 #define SAMSUNG_KEYIFSTSCLR_R_INT_MASK (0xff << 8)
47 #define SAMSUNG_KEYIFSTSCLR_R_INT_OFFSET 8
48 #define S5PV210_KEYIFSTSCLR_P_INT_MASK (0x3fff << 0)
49 #define S5PV210_KEYIFSTSCLR_R_INT_MASK (0x3fff << 16)
50 #define S5PV210_KEYIFSTSCLR_R_INT_OFFSET 16
52 /* SAMSUNG_KEYIFCOL */
53 #define SAMSUNG_KEYIFCOL_MASK (0xff << 0)
54 #define S5PV210_KEYIFCOLEN_MASK (0xff << 8)
56 /* SAMSUNG_KEYIFROW */
57 #define SAMSUNG_KEYIFROW_MASK (0xff << 0)
58 #define S5PV210_KEYIFROW_MASK (0x3fff << 0)
61 #define SAMSUNG_KEYIFFC_MASK (0x3ff << 0)
63 enum samsung_keypad_type {
68 struct samsung_keypad {
69 struct input_dev *input_dev;
70 struct platform_device *pdev;
73 wait_queue_head_t wait;
77 enum samsung_keypad_type type;
78 unsigned int row_shift;
81 unsigned int row_state[SAMSUNG_MAX_COLS];
83 int row_gpios[SAMSUNG_MAX_ROWS];
84 int col_gpios[SAMSUNG_MAX_COLS];
86 unsigned short keycodes[];
89 static void samsung_keypad_scan(struct samsung_keypad *keypad,
90 unsigned int *row_state)
95 for (col = 0; col < keypad->cols; col++) {
96 if (keypad->type == KEYPAD_TYPE_S5PV210) {
97 val = S5PV210_KEYIFCOLEN_MASK;
98 val &= ~(1 << col) << 8;
100 val = SAMSUNG_KEYIFCOL_MASK;
104 writel(val, keypad->base + SAMSUNG_KEYIFCOL);
107 val = readl(keypad->base + SAMSUNG_KEYIFROW);
108 row_state[col] = ~val & ((1 << keypad->rows) - 1);
111 /* KEYIFCOL reg clear */
112 writel(0, keypad->base + SAMSUNG_KEYIFCOL);
115 static bool samsung_keypad_report(struct samsung_keypad *keypad,
116 unsigned int *row_state)
118 struct input_dev *input_dev = keypad->input_dev;
119 unsigned int changed;
120 unsigned int pressed;
121 unsigned int key_down = 0;
123 unsigned int col, row;
125 for (col = 0; col < keypad->cols; col++) {
126 changed = row_state[col] ^ keypad->row_state[col];
127 key_down |= row_state[col];
131 for (row = 0; row < keypad->rows; row++) {
132 if (!(changed & (1 << row)))
135 pressed = row_state[col] & (1 << row);
137 dev_dbg(&keypad->input_dev->dev,
138 "key %s, row: %d, col: %d\n",
139 pressed ? "pressed" : "released", row, col);
141 val = MATRIX_SCAN_CODE(row, col, keypad->row_shift);
143 input_event(input_dev, EV_MSC, MSC_SCAN, val);
144 input_report_key(input_dev,
145 keypad->keycodes[val], pressed);
147 input_sync(keypad->input_dev);
150 memcpy(keypad->row_state, row_state, sizeof(keypad->row_state));
155 static irqreturn_t samsung_keypad_irq(int irq, void *dev_id)
157 struct samsung_keypad *keypad = dev_id;
158 unsigned int row_state[SAMSUNG_MAX_COLS];
162 pm_runtime_get_sync(&keypad->pdev->dev);
165 val = readl(keypad->base + SAMSUNG_KEYIFSTSCLR);
166 /* Clear interrupt. */
167 writel(~0x0, keypad->base + SAMSUNG_KEYIFSTSCLR);
169 samsung_keypad_scan(keypad, row_state);
171 key_down = samsung_keypad_report(keypad, row_state);
173 wait_event_timeout(keypad->wait, keypad->stopped,
174 msecs_to_jiffies(50));
176 } while (key_down && !keypad->stopped);
178 pm_runtime_put(&keypad->pdev->dev);
183 static void samsung_keypad_start(struct samsung_keypad *keypad)
187 pm_runtime_get_sync(&keypad->pdev->dev);
189 /* Tell IRQ thread that it may poll the device. */
190 keypad->stopped = false;
192 clk_enable(keypad->clk);
194 /* Enable interrupt bits. */
195 val = readl(keypad->base + SAMSUNG_KEYIFCON);
196 val |= SAMSUNG_KEYIFCON_INT_F_EN | SAMSUNG_KEYIFCON_INT_R_EN;
197 writel(val, keypad->base + SAMSUNG_KEYIFCON);
199 /* KEYIFCOL reg clear. */
200 writel(0, keypad->base + SAMSUNG_KEYIFCOL);
202 pm_runtime_put(&keypad->pdev->dev);
205 static void samsung_keypad_stop(struct samsung_keypad *keypad)
209 pm_runtime_get_sync(&keypad->pdev->dev);
211 /* Signal IRQ thread to stop polling and disable the handler. */
212 keypad->stopped = true;
213 wake_up(&keypad->wait);
214 disable_irq(keypad->irq);
216 /* Clear interrupt. */
217 writel(~0x0, keypad->base + SAMSUNG_KEYIFSTSCLR);
219 /* Disable interrupt bits. */
220 val = readl(keypad->base + SAMSUNG_KEYIFCON);
221 val &= ~(SAMSUNG_KEYIFCON_INT_F_EN | SAMSUNG_KEYIFCON_INT_R_EN);
222 writel(val, keypad->base + SAMSUNG_KEYIFCON);
224 clk_disable(keypad->clk);
227 * Now that chip should not generate interrupts we can safely
228 * re-enable the handler.
230 enable_irq(keypad->irq);
232 pm_runtime_put(&keypad->pdev->dev);
235 static int samsung_keypad_open(struct input_dev *input_dev)
237 struct samsung_keypad *keypad = input_get_drvdata(input_dev);
239 samsung_keypad_start(keypad);
244 static void samsung_keypad_close(struct input_dev *input_dev)
246 struct samsung_keypad *keypad = input_get_drvdata(input_dev);
248 samsung_keypad_stop(keypad);
252 static struct samsung_keypad_platdata *samsung_keypad_parse_dt(
255 struct samsung_keypad_platdata *pdata;
256 struct matrix_keymap_data *keymap_data;
257 uint32_t *keymap, num_rows = 0, num_cols = 0;
258 struct device_node *np = dev->of_node, *key_np;
259 unsigned int key_count;
261 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
263 dev_err(dev, "could not allocate memory for platform data\n");
267 of_property_read_u32(np, "samsung,keypad-num-rows", &num_rows);
268 of_property_read_u32(np, "samsung,keypad-num-columns", &num_cols);
269 if (!num_rows || !num_cols) {
270 dev_err(dev, "number of keypad rows/columns not specified\n");
273 pdata->rows = num_rows;
274 pdata->cols = num_cols;
276 keymap_data = devm_kzalloc(dev, sizeof(*keymap_data), GFP_KERNEL);
278 dev_err(dev, "could not allocate memory for keymap data\n");
281 pdata->keymap_data = keymap_data;
283 key_count = of_get_child_count(np);
284 keymap_data->keymap_size = key_count;
285 keymap = devm_kzalloc(dev, sizeof(uint32_t) * key_count, GFP_KERNEL);
287 dev_err(dev, "could not allocate memory for keymap\n");
290 keymap_data->keymap = keymap;
292 for_each_child_of_node(np, key_np) {
293 u32 row, col, key_code;
294 of_property_read_u32(key_np, "keypad,row", &row);
295 of_property_read_u32(key_np, "keypad,column", &col);
296 of_property_read_u32(key_np, "linux,code", &key_code);
297 *keymap++ = KEY(row, col, key_code);
300 if (of_get_property(np, "linux,input-no-autorepeat", NULL))
301 pdata->no_autorepeat = true;
302 if (of_get_property(np, "linux,input-wakeup", NULL))
303 pdata->wakeup = true;
308 static void samsung_keypad_parse_dt_gpio(struct device *dev,
309 struct samsung_keypad *keypad)
311 struct device_node *np = dev->of_node;
312 int gpio, error, row, col;
314 for (row = 0; row < keypad->rows; row++) {
315 gpio = of_get_named_gpio(np, "row-gpios", row);
316 keypad->row_gpios[row] = gpio;
317 if (!gpio_is_valid(gpio)) {
318 dev_err(dev, "keypad row[%d]: invalid gpio %d\n",
323 error = devm_gpio_request(dev, gpio, "keypad-row");
326 "keypad row[%d] gpio request failed: %d\n",
330 for (col = 0; col < keypad->cols; col++) {
331 gpio = of_get_named_gpio(np, "col-gpios", col);
332 keypad->col_gpios[col] = gpio;
333 if (!gpio_is_valid(gpio)) {
334 dev_err(dev, "keypad column[%d]: invalid gpio %d\n",
339 error = devm_gpio_request(dev, gpio, "keypad-col");
342 "keypad column[%d] gpio request failed: %d\n",
348 struct samsung_keypad_platdata *samsung_keypad_parse_dt(struct device *dev)
354 static int samsung_keypad_probe(struct platform_device *pdev)
356 const struct samsung_keypad_platdata *pdata;
357 const struct matrix_keymap_data *keymap_data;
358 struct samsung_keypad *keypad;
359 struct resource *res;
360 struct input_dev *input_dev;
361 unsigned int row_shift;
362 unsigned int keymap_size;
365 if (pdev->dev.of_node)
366 pdata = samsung_keypad_parse_dt(&pdev->dev);
368 pdata = pdev->dev.platform_data;
370 dev_err(&pdev->dev, "no platform data defined\n");
374 keymap_data = pdata->keymap_data;
376 dev_err(&pdev->dev, "no keymap data defined\n");
380 if (!pdata->rows || pdata->rows > SAMSUNG_MAX_ROWS)
383 if (!pdata->cols || pdata->cols > SAMSUNG_MAX_COLS)
386 /* initialize the gpio */
388 pdata->cfg_gpio(pdata->rows, pdata->cols);
390 row_shift = get_count_order(pdata->cols);
391 keymap_size = (pdata->rows << row_shift) * sizeof(keypad->keycodes[0]);
393 keypad = devm_kzalloc(&pdev->dev, sizeof(*keypad) + keymap_size,
395 input_dev = devm_input_allocate_device(&pdev->dev);
396 if (!keypad || !input_dev)
399 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
403 keypad->base = devm_ioremap(&pdev->dev, res->start, resource_size(res));
407 keypad->clk = devm_clk_get(&pdev->dev, "keypad");
408 if (IS_ERR(keypad->clk)) {
409 dev_err(&pdev->dev, "failed to get keypad clk\n");
410 return PTR_ERR(keypad->clk);
413 error = clk_prepare(keypad->clk);
415 dev_err(&pdev->dev, "keypad clock prepare failed\n");
419 keypad->input_dev = input_dev;
421 keypad->row_shift = row_shift;
422 keypad->rows = pdata->rows;
423 keypad->cols = pdata->cols;
424 keypad->stopped = true;
425 init_waitqueue_head(&keypad->wait);
427 if (pdev->dev.of_node) {
429 samsung_keypad_parse_dt_gpio(&pdev->dev, keypad);
430 keypad->type = of_device_is_compatible(pdev->dev.of_node,
431 "samsung,s5pv210-keypad");
434 keypad->type = platform_get_device_id(pdev)->driver_data;
437 input_dev->name = pdev->name;
438 input_dev->id.bustype = BUS_HOST;
439 input_dev->dev.parent = &pdev->dev;
441 input_dev->open = samsung_keypad_open;
442 input_dev->close = samsung_keypad_close;
444 error = matrix_keypad_build_keymap(keymap_data, NULL,
445 pdata->rows, pdata->cols,
446 keypad->keycodes, input_dev);
448 dev_err(&pdev->dev, "failed to build keymap\n");
449 goto err_unprepare_clk;
452 input_set_capability(input_dev, EV_MSC, MSC_SCAN);
453 if (!pdata->no_autorepeat)
454 __set_bit(EV_REP, input_dev->evbit);
456 input_set_drvdata(input_dev, keypad);
458 keypad->irq = platform_get_irq(pdev, 0);
459 if (keypad->irq < 0) {
461 goto err_unprepare_clk;
464 error = devm_request_threaded_irq(&pdev->dev, keypad->irq, NULL,
465 samsung_keypad_irq, IRQF_ONESHOT,
466 dev_name(&pdev->dev), keypad);
468 dev_err(&pdev->dev, "failed to register keypad interrupt\n");
469 goto err_unprepare_clk;
472 device_init_wakeup(&pdev->dev, pdata->wakeup);
473 platform_set_drvdata(pdev, keypad);
474 pm_runtime_enable(&pdev->dev);
476 error = input_register_device(keypad->input_dev);
478 goto err_disable_runtime_pm;
480 if (pdev->dev.of_node) {
481 devm_kfree(&pdev->dev, (void *)pdata->keymap_data->keymap);
482 devm_kfree(&pdev->dev, (void *)pdata->keymap_data);
483 devm_kfree(&pdev->dev, (void *)pdata);
487 err_disable_runtime_pm:
488 pm_runtime_disable(&pdev->dev);
489 device_init_wakeup(&pdev->dev, 0);
490 platform_set_drvdata(pdev, NULL);
492 clk_unprepare(keypad->clk);
496 static int samsung_keypad_remove(struct platform_device *pdev)
498 struct samsung_keypad *keypad = platform_get_drvdata(pdev);
500 pm_runtime_disable(&pdev->dev);
501 device_init_wakeup(&pdev->dev, 0);
502 platform_set_drvdata(pdev, NULL);
504 input_unregister_device(keypad->input_dev);
506 clk_unprepare(keypad->clk);
511 #ifdef CONFIG_PM_RUNTIME
512 static int samsung_keypad_runtime_suspend(struct device *dev)
514 struct platform_device *pdev = to_platform_device(dev);
515 struct samsung_keypad *keypad = platform_get_drvdata(pdev);
522 /* This may fail on some SoCs due to lack of controller support */
523 error = enable_irq_wake(keypad->irq);
525 keypad->wake_enabled = true;
527 val = readl(keypad->base + SAMSUNG_KEYIFCON);
528 val |= SAMSUNG_KEYIFCON_WAKEUPEN;
529 writel(val, keypad->base + SAMSUNG_KEYIFCON);
531 clk_disable(keypad->clk);
536 static int samsung_keypad_runtime_resume(struct device *dev)
538 struct platform_device *pdev = to_platform_device(dev);
539 struct samsung_keypad *keypad = platform_get_drvdata(pdev);
545 clk_enable(keypad->clk);
547 val = readl(keypad->base + SAMSUNG_KEYIFCON);
548 val &= ~SAMSUNG_KEYIFCON_WAKEUPEN;
549 writel(val, keypad->base + SAMSUNG_KEYIFCON);
551 if (keypad->wake_enabled)
552 disable_irq_wake(keypad->irq);
558 #ifdef CONFIG_PM_SLEEP
559 static void samsung_keypad_toggle_wakeup(struct samsung_keypad *keypad,
564 clk_enable(keypad->clk);
566 val = readl(keypad->base + SAMSUNG_KEYIFCON);
568 val |= SAMSUNG_KEYIFCON_WAKEUPEN;
569 if (device_may_wakeup(&keypad->pdev->dev))
570 enable_irq_wake(keypad->irq);
572 val &= ~SAMSUNG_KEYIFCON_WAKEUPEN;
573 if (device_may_wakeup(&keypad->pdev->dev))
574 disable_irq_wake(keypad->irq);
576 writel(val, keypad->base + SAMSUNG_KEYIFCON);
578 clk_disable(keypad->clk);
581 static int samsung_keypad_suspend(struct device *dev)
583 struct platform_device *pdev = to_platform_device(dev);
584 struct samsung_keypad *keypad = platform_get_drvdata(pdev);
585 struct input_dev *input_dev = keypad->input_dev;
587 mutex_lock(&input_dev->mutex);
589 if (input_dev->users)
590 samsung_keypad_stop(keypad);
592 samsung_keypad_toggle_wakeup(keypad, true);
594 mutex_unlock(&input_dev->mutex);
599 static int samsung_keypad_resume(struct device *dev)
601 struct platform_device *pdev = to_platform_device(dev);
602 struct samsung_keypad *keypad = platform_get_drvdata(pdev);
603 struct input_dev *input_dev = keypad->input_dev;
605 mutex_lock(&input_dev->mutex);
607 samsung_keypad_toggle_wakeup(keypad, false);
609 if (input_dev->users)
610 samsung_keypad_start(keypad);
612 mutex_unlock(&input_dev->mutex);
618 static const struct dev_pm_ops samsung_keypad_pm_ops = {
619 SET_SYSTEM_SLEEP_PM_OPS(samsung_keypad_suspend, samsung_keypad_resume)
620 SET_RUNTIME_PM_OPS(samsung_keypad_runtime_suspend,
621 samsung_keypad_runtime_resume, NULL)
625 static const struct of_device_id samsung_keypad_dt_match[] = {
626 { .compatible = "samsung,s3c6410-keypad" },
627 { .compatible = "samsung,s5pv210-keypad" },
630 MODULE_DEVICE_TABLE(of, samsung_keypad_dt_match);
633 static struct platform_device_id samsung_keypad_driver_ids[] = {
635 .name = "samsung-keypad",
636 .driver_data = KEYPAD_TYPE_SAMSUNG,
638 .name = "s5pv210-keypad",
639 .driver_data = KEYPAD_TYPE_S5PV210,
643 MODULE_DEVICE_TABLE(platform, samsung_keypad_driver_ids);
645 static struct platform_driver samsung_keypad_driver = {
646 .probe = samsung_keypad_probe,
647 .remove = samsung_keypad_remove,
649 .name = "samsung-keypad",
650 .owner = THIS_MODULE,
651 .of_match_table = of_match_ptr(samsung_keypad_dt_match),
652 .pm = &samsung_keypad_pm_ops,
654 .id_table = samsung_keypad_driver_ids,
656 module_platform_driver(samsung_keypad_driver);
658 MODULE_DESCRIPTION("Samsung keypad driver");
659 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
660 MODULE_AUTHOR("Donghwa Lee <dh09.lee@samsung.com>");
661 MODULE_LICENSE("GPL");