2 * linux/drivers/input/keyboard/pxa27x_keypad.c
4 * Driver for the pxa27x matrix keyboard controller.
6 * Created: Feb 22, 2007
7 * Author: Rodolfo Giometti <giometti@linux.it>
9 * Based on a previous implementations by Kevin O'Connor
10 * <kevin_at_koconnor.net> and Alex Osborne <bobofdoom@gmail.com> and
11 * on some suggestions by Nicolas Pitre <nico@cam.org>.
13 * This program is free software; you can redistribute it and/or modify
14 * it under the terms of the GNU General Public License version 2 as
15 * published by the Free Software Foundation.
19 #include <linux/kernel.h>
20 #include <linux/module.h>
21 #include <linux/init.h>
22 #include <linux/interrupt.h>
23 #include <linux/input.h>
24 #include <linux/device.h>
25 #include <linux/platform_device.h>
26 #include <linux/clk.h>
27 #include <linux/err.h>
29 #include <asm/mach-types.h>
30 #include <asm/mach/arch.h>
31 #include <asm/mach/map.h>
33 #include <asm/arch/hardware.h>
34 #include <asm/arch/pxa-regs.h>
35 #include <asm/arch/irqs.h>
36 #include <asm/arch/pxa27x_keypad.h>
38 #define DRIVER_NAME "pxa27x-keypad"
40 #define KPAS_MUKP(n) (((n) >> 26) & 0x1f)
41 #define KPAS_RP(n) (((n) >> 4) & 0xf)
42 #define KPAS_CP(n) ((n) & 0xf)
44 #define KPASMKP_MKC_MASK (0xff)
46 #define MAX_MATRIX_KEY_NUM (8 * 8)
48 struct pxa27x_keypad {
49 struct pxa27x_keypad_platform_data *pdata;
52 struct input_dev *input_dev;
54 /* matrix key code map */
55 unsigned int matrix_keycodes[MAX_MATRIX_KEY_NUM];
57 /* state row bits of each column scan */
58 uint32_t matrix_key_state[MAX_MATRIX_KEY_COLS];
61 static void pxa27x_keypad_build_keycode(struct pxa27x_keypad *keypad)
63 struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
64 struct input_dev *input_dev = keypad->input_dev;
68 key = &pdata->matrix_key_map[0];
69 for (i = 0; i < pdata->matrix_key_map_size; i++, key++) {
70 int row = ((*key) >> 28) & 0xf;
71 int col = ((*key) >> 24) & 0xf;
72 int code = (*key) & 0xffffff;
74 keypad->matrix_keycodes[(row << 3) + col] = code;
75 set_bit(code, input_dev->keybit);
79 static inline unsigned int lookup_matrix_keycode(
80 struct pxa27x_keypad *keypad, int row, int col)
82 return keypad->matrix_keycodes[(row << 3) + col];
85 static void pxa27x_keypad_scan_matrix(struct pxa27x_keypad *keypad)
87 struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
88 int row, col, num_keys_pressed = 0;
89 uint32_t new_state[MAX_MATRIX_KEY_COLS];
92 num_keys_pressed = KPAS_MUKP(kpas);
94 memset(new_state, 0, sizeof(new_state));
96 if (num_keys_pressed == 0)
99 if (num_keys_pressed == 1) {
103 /* if invalid row/col, treat as no key pressed */
104 if (col >= pdata->matrix_key_cols ||
105 row >= pdata->matrix_key_rows)
108 new_state[col] = (1 << row);
112 if (num_keys_pressed > 1) {
113 uint32_t kpasmkp0 = KPASMKP0;
114 uint32_t kpasmkp1 = KPASMKP1;
115 uint32_t kpasmkp2 = KPASMKP2;
116 uint32_t kpasmkp3 = KPASMKP3;
118 new_state[0] = kpasmkp0 & KPASMKP_MKC_MASK;
119 new_state[1] = (kpasmkp0 >> 16) & KPASMKP_MKC_MASK;
120 new_state[2] = kpasmkp1 & KPASMKP_MKC_MASK;
121 new_state[3] = (kpasmkp1 >> 16) & KPASMKP_MKC_MASK;
122 new_state[4] = kpasmkp2 & KPASMKP_MKC_MASK;
123 new_state[5] = (kpasmkp2 >> 16) & KPASMKP_MKC_MASK;
124 new_state[6] = kpasmkp3 & KPASMKP_MKC_MASK;
125 new_state[7] = (kpasmkp3 >> 16) & KPASMKP_MKC_MASK;
128 for (col = 0; col < pdata->matrix_key_cols; col++) {
129 uint32_t bits_changed;
131 bits_changed = keypad->matrix_key_state[col] ^ new_state[col];
132 if (bits_changed == 0)
135 for (row = 0; row < pdata->matrix_key_rows; row++) {
136 if ((bits_changed & (1 << row)) == 0)
139 input_report_key(keypad->input_dev,
140 lookup_matrix_keycode(keypad, row, col),
141 new_state[col] & (1 << row));
144 input_sync(keypad->input_dev);
145 memcpy(keypad->matrix_key_state, new_state, sizeof(new_state));
148 static irqreturn_t pxa27x_keypad_irq_handler(int irq, void *dev_id)
150 struct pxa27x_keypad *keypad = dev_id;
151 struct input_dev *input_dev = keypad->input_dev;
152 unsigned long kpc = KPC;
156 unsigned long kpdk = KPDK;
158 if (!(kpdk & KPDK_DKP)) {
159 /* better luck next time */
160 } else if (kpc & KPC_REE0) {
161 unsigned long kprec = KPREC;
164 if (kprec & KPREC_OF0)
165 rel = (kprec & 0xff) + 0x7f;
166 else if (kprec & KPREC_UF0)
167 rel = (kprec & 0xff) - 0x7f - 0xff;
169 rel = (kprec & 0xff) - 0x7f;
172 input_report_rel(input_dev, REL_WHEEL, rel);
173 input_sync(input_dev);
179 pxa27x_keypad_scan_matrix(keypad);
184 static int pxa27x_keypad_open(struct input_dev *dev)
186 struct pxa27x_keypad *keypad = input_get_drvdata(dev);
188 /* Set keypad control register */
191 (2 << 6) | KPC_REE0 | KPC_DK_DEB_SEL |
192 KPC_ME | KPC_MIE | KPC_DE | KPC_DIE);
194 KPC &= ~KPC_AS; /* disable automatic scan */
195 KPC &= ~KPC_IMKP; /* do not ignore multiple keypresses */
197 /* Set rotary count to mid-point value */
200 /* Enable unit clock */
201 clk_enable(keypad->clk);
206 static void pxa27x_keypad_close(struct input_dev *dev)
208 struct pxa27x_keypad *keypad = input_get_drvdata(dev);
210 /* Disable clock unit */
211 clk_disable(keypad->clk);
215 static int pxa27x_keypad_suspend(struct platform_device *pdev, pm_message_t state)
217 struct pxa27x_keypad *keypad = platform_get_drvdata(pdev);
218 struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
220 /* Save controller status */
221 pdata->reg_kpc = KPC;
222 pdata->reg_kprec = KPREC;
227 static int pxa27x_keypad_resume(struct platform_device *pdev)
229 struct pxa27x_keypad *keypad = platform_get_drvdata(pdev);
230 struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
231 struct input_dev *input_dev = keypad->input_dev;
233 mutex_lock(&input_dev->mutex);
235 if (input_dev->users) {
236 /* Restore controller status */
237 KPC = pdata->reg_kpc;
238 KPREC = pdata->reg_kprec;
240 /* Enable unit clock */
241 clk_enable(keypad->clk);
244 mutex_unlock(&input_dev->mutex);
249 #define pxa27x_keypad_suspend NULL
250 #define pxa27x_keypad_resume NULL
253 static int __devinit pxa27x_keypad_probe(struct platform_device *pdev)
255 struct pxa27x_keypad *keypad;
256 struct input_dev *input_dev;
259 keypad = kzalloc(sizeof(struct pxa27x_keypad), GFP_KERNEL);
260 if (keypad == NULL) {
261 dev_err(&pdev->dev, "failed to allocate driver data\n");
265 keypad->pdata = pdev->dev.platform_data;
266 if (keypad->pdata == NULL) {
267 dev_err(&pdev->dev, "no platform data defined\n");
272 keypad->clk = clk_get(&pdev->dev, "KBDCLK");
273 if (IS_ERR(keypad->clk)) {
274 dev_err(&pdev->dev, "failed to get keypad clock\n");
275 error = PTR_ERR(keypad->clk);
279 /* Create and register the input driver. */
280 input_dev = input_allocate_device();
282 dev_err(&pdev->dev, "failed to allocate input device\n");
287 input_dev->name = DRIVER_NAME;
288 input_dev->id.bustype = BUS_HOST;
289 input_dev->open = pxa27x_keypad_open;
290 input_dev->close = pxa27x_keypad_close;
291 input_dev->dev.parent = &pdev->dev;
293 keypad->input_dev = input_dev;
294 input_set_drvdata(input_dev, keypad);
296 input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP) |
298 input_dev->relbit[BIT_WORD(REL_WHEEL)] = BIT_MASK(REL_WHEEL);
300 pxa27x_keypad_build_keycode(keypad);
302 error = request_irq(IRQ_KEYPAD, pxa27x_keypad_irq_handler, IRQF_DISABLED,
303 DRIVER_NAME, keypad);
305 printk(KERN_ERR "Cannot request keypad IRQ\n");
309 platform_set_drvdata(pdev, keypad);
311 /* Register the input device */
312 error = input_register_device(input_dev);
317 * Store rows/cols info into keyboard registers.
320 KPC |= (keypad->pdata->matrix_key_rows - 1) << 26;
321 KPC |= (keypad->pdata->matrix_key_cols - 1) << 23;
323 for (col = 0; col < keypad->pdata->matrix_key_cols; col++)
324 KPC |= KPC_MS0 << col;
329 platform_set_drvdata(pdev, NULL);
330 free_irq(IRQ_KEYPAD, pdev);
332 input_free_device(input_dev);
334 clk_put(keypad->clk);
340 static int __devexit pxa27x_keypad_remove(struct platform_device *pdev)
342 struct pxa27x_keypad *keypad = platform_get_drvdata(pdev);
344 free_irq(IRQ_KEYPAD, pdev);
346 clk_disable(keypad->clk);
347 clk_put(keypad->clk);
349 input_unregister_device(keypad->input_dev);
351 platform_set_drvdata(pdev, NULL);
356 static struct platform_driver pxa27x_keypad_driver = {
357 .probe = pxa27x_keypad_probe,
358 .remove = __devexit_p(pxa27x_keypad_remove),
359 .suspend = pxa27x_keypad_suspend,
360 .resume = pxa27x_keypad_resume,
366 static int __init pxa27x_keypad_init(void)
368 return platform_driver_register(&pxa27x_keypad_driver);
371 static void __exit pxa27x_keypad_exit(void)
373 platform_driver_unregister(&pxa27x_keypad_driver);
376 module_init(pxa27x_keypad_init);
377 module_exit(pxa27x_keypad_exit);
379 MODULE_DESCRIPTION("PXA27x Keypad Controller Driver");
380 MODULE_LICENSE("GPL");