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
, ret
, 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 ret
= gpio_request(gpio
, "keypad-row");
325 dev_err(dev
, "keypad row[%d] gpio request failed\n",
329 for (col
= 0; col
< keypad
->cols
; col
++) {
330 gpio
= of_get_named_gpio(np
, "col-gpios", col
);
331 keypad
->col_gpios
[col
] = gpio
;
332 if (!gpio_is_valid(gpio
)) {
333 dev_err(dev
, "keypad column[%d]: invalid gpio %d\n",
338 ret
= gpio_request(gpio
, "keypad-col");
340 dev_err(dev
, "keypad column[%d] gpio request failed\n",
345 static void samsung_keypad_dt_gpio_free(struct samsung_keypad
*keypad
)
349 for (cnt
= 0; cnt
< keypad
->rows
; cnt
++)
350 if (gpio_is_valid(keypad
->row_gpios
[cnt
]))
351 gpio_free(keypad
->row_gpios
[cnt
]);
353 for (cnt
= 0; cnt
< keypad
->cols
; cnt
++)
354 if (gpio_is_valid(keypad
->col_gpios
[cnt
]))
355 gpio_free(keypad
->col_gpios
[cnt
]);
359 struct samsung_keypad_platdata
*samsung_keypad_parse_dt(struct device
*dev
)
364 static void samsung_keypad_dt_gpio_free(struct samsung_keypad
*keypad
)
369 static int samsung_keypad_probe(struct platform_device
*pdev
)
371 const struct samsung_keypad_platdata
*pdata
;
372 const struct matrix_keymap_data
*keymap_data
;
373 struct samsung_keypad
*keypad
;
374 struct resource
*res
;
375 struct input_dev
*input_dev
;
376 unsigned int row_shift
;
377 unsigned int keymap_size
;
380 if (pdev
->dev
.of_node
)
381 pdata
= samsung_keypad_parse_dt(&pdev
->dev
);
383 pdata
= pdev
->dev
.platform_data
;
385 dev_err(&pdev
->dev
, "no platform data defined\n");
389 keymap_data
= pdata
->keymap_data
;
391 dev_err(&pdev
->dev
, "no keymap data defined\n");
395 if (!pdata
->rows
|| pdata
->rows
> SAMSUNG_MAX_ROWS
)
398 if (!pdata
->cols
|| pdata
->cols
> SAMSUNG_MAX_COLS
)
401 /* initialize the gpio */
403 pdata
->cfg_gpio(pdata
->rows
, pdata
->cols
);
405 row_shift
= get_count_order(pdata
->cols
);
406 keymap_size
= (pdata
->rows
<< row_shift
) * sizeof(keypad
->keycodes
[0]);
408 keypad
= kzalloc(sizeof(*keypad
) + keymap_size
, GFP_KERNEL
);
409 input_dev
= input_allocate_device();
410 if (!keypad
|| !input_dev
) {
415 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
421 keypad
->base
= ioremap(res
->start
, resource_size(res
));
427 keypad
->clk
= clk_get(&pdev
->dev
, "keypad");
428 if (IS_ERR(keypad
->clk
)) {
429 dev_err(&pdev
->dev
, "failed to get keypad clk\n");
430 error
= PTR_ERR(keypad
->clk
);
434 error
= clk_prepare(keypad
->clk
);
436 dev_err(&pdev
->dev
, "keypad clock prepare failed\n");
440 keypad
->input_dev
= input_dev
;
442 keypad
->row_shift
= row_shift
;
443 keypad
->rows
= pdata
->rows
;
444 keypad
->cols
= pdata
->cols
;
445 keypad
->stopped
= true;
446 init_waitqueue_head(&keypad
->wait
);
448 if (pdev
->dev
.of_node
) {
450 samsung_keypad_parse_dt_gpio(&pdev
->dev
, keypad
);
451 keypad
->type
= of_device_is_compatible(pdev
->dev
.of_node
,
452 "samsung,s5pv210-keypad");
455 keypad
->type
= platform_get_device_id(pdev
)->driver_data
;
458 input_dev
->name
= pdev
->name
;
459 input_dev
->id
.bustype
= BUS_HOST
;
460 input_dev
->dev
.parent
= &pdev
->dev
;
462 input_dev
->open
= samsung_keypad_open
;
463 input_dev
->close
= samsung_keypad_close
;
465 error
= matrix_keypad_build_keymap(keymap_data
, NULL
,
466 pdata
->rows
, pdata
->cols
,
467 keypad
->keycodes
, input_dev
);
469 dev_err(&pdev
->dev
, "failed to build keymap\n");
470 goto err_unprepare_clk
;
473 input_set_capability(input_dev
, EV_MSC
, MSC_SCAN
);
474 if (!pdata
->no_autorepeat
)
475 __set_bit(EV_REP
, input_dev
->evbit
);
477 input_set_drvdata(input_dev
, keypad
);
479 keypad
->irq
= platform_get_irq(pdev
, 0);
480 if (keypad
->irq
< 0) {
485 error
= request_threaded_irq(keypad
->irq
, NULL
, samsung_keypad_irq
,
486 IRQF_ONESHOT
, dev_name(&pdev
->dev
), keypad
);
488 dev_err(&pdev
->dev
, "failed to register keypad interrupt\n");
492 device_init_wakeup(&pdev
->dev
, pdata
->wakeup
);
493 platform_set_drvdata(pdev
, keypad
);
494 pm_runtime_enable(&pdev
->dev
);
496 error
= input_register_device(keypad
->input_dev
);
500 if (pdev
->dev
.of_node
) {
501 devm_kfree(&pdev
->dev
, (void *)pdata
->keymap_data
->keymap
);
502 devm_kfree(&pdev
->dev
, (void *)pdata
->keymap_data
);
503 devm_kfree(&pdev
->dev
, (void *)pdata
);
508 free_irq(keypad
->irq
, keypad
);
509 pm_runtime_disable(&pdev
->dev
);
510 device_init_wakeup(&pdev
->dev
, 0);
511 platform_set_drvdata(pdev
, NULL
);
513 clk_unprepare(keypad
->clk
);
515 clk_put(keypad
->clk
);
516 samsung_keypad_dt_gpio_free(keypad
);
518 iounmap(keypad
->base
);
520 input_free_device(input_dev
);
526 static int __devexit
samsung_keypad_remove(struct platform_device
*pdev
)
528 struct samsung_keypad
*keypad
= platform_get_drvdata(pdev
);
530 pm_runtime_disable(&pdev
->dev
);
531 device_init_wakeup(&pdev
->dev
, 0);
532 platform_set_drvdata(pdev
, NULL
);
534 input_unregister_device(keypad
->input_dev
);
537 * It is safe to free IRQ after unregistering device because
538 * samsung_keypad_close will shut off interrupts.
540 free_irq(keypad
->irq
, keypad
);
542 clk_unprepare(keypad
->clk
);
543 clk_put(keypad
->clk
);
544 samsung_keypad_dt_gpio_free(keypad
);
546 iounmap(keypad
->base
);
552 #ifdef CONFIG_PM_RUNTIME
553 static int samsung_keypad_runtime_suspend(struct device
*dev
)
555 struct platform_device
*pdev
= to_platform_device(dev
);
556 struct samsung_keypad
*keypad
= platform_get_drvdata(pdev
);
563 /* This may fail on some SoCs due to lack of controller support */
564 error
= enable_irq_wake(keypad
->irq
);
566 keypad
->wake_enabled
= true;
568 val
= readl(keypad
->base
+ SAMSUNG_KEYIFCON
);
569 val
|= SAMSUNG_KEYIFCON_WAKEUPEN
;
570 writel(val
, keypad
->base
+ SAMSUNG_KEYIFCON
);
572 clk_disable(keypad
->clk
);
577 static int samsung_keypad_runtime_resume(struct device
*dev
)
579 struct platform_device
*pdev
= to_platform_device(dev
);
580 struct samsung_keypad
*keypad
= platform_get_drvdata(pdev
);
586 clk_enable(keypad
->clk
);
588 val
= readl(keypad
->base
+ SAMSUNG_KEYIFCON
);
589 val
&= ~SAMSUNG_KEYIFCON_WAKEUPEN
;
590 writel(val
, keypad
->base
+ SAMSUNG_KEYIFCON
);
592 if (keypad
->wake_enabled
)
593 disable_irq_wake(keypad
->irq
);
599 #ifdef CONFIG_PM_SLEEP
600 static void samsung_keypad_toggle_wakeup(struct samsung_keypad
*keypad
,
605 clk_enable(keypad
->clk
);
607 val
= readl(keypad
->base
+ SAMSUNG_KEYIFCON
);
609 val
|= SAMSUNG_KEYIFCON_WAKEUPEN
;
610 if (device_may_wakeup(&keypad
->pdev
->dev
))
611 enable_irq_wake(keypad
->irq
);
613 val
&= ~SAMSUNG_KEYIFCON_WAKEUPEN
;
614 if (device_may_wakeup(&keypad
->pdev
->dev
))
615 disable_irq_wake(keypad
->irq
);
617 writel(val
, keypad
->base
+ SAMSUNG_KEYIFCON
);
619 clk_disable(keypad
->clk
);
622 static int samsung_keypad_suspend(struct device
*dev
)
624 struct platform_device
*pdev
= to_platform_device(dev
);
625 struct samsung_keypad
*keypad
= platform_get_drvdata(pdev
);
626 struct input_dev
*input_dev
= keypad
->input_dev
;
628 mutex_lock(&input_dev
->mutex
);
630 if (input_dev
->users
)
631 samsung_keypad_stop(keypad
);
633 samsung_keypad_toggle_wakeup(keypad
, true);
635 mutex_unlock(&input_dev
->mutex
);
640 static int samsung_keypad_resume(struct device
*dev
)
642 struct platform_device
*pdev
= to_platform_device(dev
);
643 struct samsung_keypad
*keypad
= platform_get_drvdata(pdev
);
644 struct input_dev
*input_dev
= keypad
->input_dev
;
646 mutex_lock(&input_dev
->mutex
);
648 samsung_keypad_toggle_wakeup(keypad
, false);
650 if (input_dev
->users
)
651 samsung_keypad_start(keypad
);
653 mutex_unlock(&input_dev
->mutex
);
659 static const struct dev_pm_ops samsung_keypad_pm_ops
= {
660 SET_SYSTEM_SLEEP_PM_OPS(samsung_keypad_suspend
, samsung_keypad_resume
)
661 SET_RUNTIME_PM_OPS(samsung_keypad_runtime_suspend
,
662 samsung_keypad_runtime_resume
, NULL
)
666 static const struct of_device_id samsung_keypad_dt_match
[] = {
667 { .compatible
= "samsung,s3c6410-keypad" },
668 { .compatible
= "samsung,s5pv210-keypad" },
671 MODULE_DEVICE_TABLE(of
, samsung_keypad_dt_match
);
674 static struct platform_device_id samsung_keypad_driver_ids
[] = {
676 .name
= "samsung-keypad",
677 .driver_data
= KEYPAD_TYPE_SAMSUNG
,
679 .name
= "s5pv210-keypad",
680 .driver_data
= KEYPAD_TYPE_S5PV210
,
684 MODULE_DEVICE_TABLE(platform
, samsung_keypad_driver_ids
);
686 static struct platform_driver samsung_keypad_driver
= {
687 .probe
= samsung_keypad_probe
,
688 .remove
= samsung_keypad_remove
,
690 .name
= "samsung-keypad",
691 .owner
= THIS_MODULE
,
692 .of_match_table
= of_match_ptr(samsung_keypad_dt_match
),
693 .pm
= &samsung_keypad_pm_ops
,
695 .id_table
= samsung_keypad_driver_ids
,
697 module_platform_driver(samsung_keypad_driver
);
699 MODULE_DESCRIPTION("Samsung keypad driver");
700 MODULE_AUTHOR("Joonyoung Shim <jy0922.shim@samsung.com>");
701 MODULE_AUTHOR("Donghwa Lee <dh09.lee@samsung.com>");
702 MODULE_LICENSE("GPL");