Merge branch 'for-33' of git://repo.or.cz/linux-kbuild
[linux-2.6-block.git] / drivers / input / keyboard / ep93xx_keypad.c
CommitLineData
e06003af
HS
1/*
2 * Driver for the Cirrus EP93xx matrix keypad controller.
3 *
4 * Copyright (c) 2008 H Hartley Sweeten <hsweeten@visionengravers.com>
5 *
6 * Based on the pxa27x matrix keypad controller by Rodolfo Giometti.
7 *
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License version 2 as
10 * published by the Free Software Foundation.
11 *
12 * NOTE:
13 *
14 * The 3-key reset is triggered by pressing the 3 keys in
15 * Row 0, Columns 2, 4, and 7 at the same time. This action can
16 * be disabled by setting the EP93XX_KEYPAD_DISABLE_3_KEY flag.
17 *
18 * Normal operation for the matrix does not autorepeat the key press.
19 * This action can be enabled by setting the EP93XX_KEYPAD_AUTOREPEAT
20 * flag.
21 */
22
23#include <linux/platform_device.h>
24#include <linux/interrupt.h>
e06003af 25#include <linux/clk.h>
60214f05
HS
26#include <linux/io.h>
27#include <linux/input/matrix_keypad.h>
e06003af
HS
28
29#include <mach/hardware.h>
e06003af
HS
30#include <mach/ep93xx_keypad.h>
31
32/*
33 * Keypad Interface Register offsets
34 */
35#define KEY_INIT 0x00 /* Key Scan Initialization register */
36#define KEY_DIAG 0x04 /* Key Scan Diagnostic register */
37#define KEY_REG 0x08 /* Key Value Capture register */
38
39/* Key Scan Initialization Register bit defines */
40#define KEY_INIT_DBNC_MASK (0x00ff0000)
41#define KEY_INIT_DBNC_SHIFT (16)
42#define KEY_INIT_DIS3KY (1<<15)
43#define KEY_INIT_DIAG (1<<14)
44#define KEY_INIT_BACK (1<<13)
45#define KEY_INIT_T2 (1<<12)
46#define KEY_INIT_PRSCL_MASK (0x000003ff)
47#define KEY_INIT_PRSCL_SHIFT (0)
48
49/* Key Scan Diagnostic Register bit defines */
50#define KEY_DIAG_MASK (0x0000003f)
51#define KEY_DIAG_SHIFT (0)
52
53/* Key Value Capture Register bit defines */
54#define KEY_REG_K (1<<15)
55#define KEY_REG_INT (1<<14)
56#define KEY_REG_2KEYS (1<<13)
57#define KEY_REG_1KEY (1<<12)
58#define KEY_REG_KEY2_MASK (0x00000fc0)
59#define KEY_REG_KEY2_SHIFT (6)
60#define KEY_REG_KEY1_MASK (0x0000003f)
61#define KEY_REG_KEY1_SHIFT (0)
62
60214f05 63#define EP93XX_MATRIX_SIZE (EP93XX_MATRIX_ROWS * EP93XX_MATRIX_COLS)
e06003af
HS
64
65struct ep93xx_keypad {
66 struct ep93xx_keypad_platform_data *pdata;
e06003af 67 struct input_dev *input_dev;
60214f05
HS
68 struct clk *clk;
69
e06003af
HS
70 void __iomem *mmio_base;
71
60214f05 72 unsigned int matrix_keycodes[EP93XX_MATRIX_SIZE];
e06003af
HS
73
74 int key1;
75 int key2;
76
60214f05
HS
77 int irq;
78
79 bool enabled;
e06003af
HS
80};
81
82static void ep93xx_keypad_build_keycode(struct ep93xx_keypad *keypad)
83{
84 struct ep93xx_keypad_platform_data *pdata = keypad->pdata;
85 struct input_dev *input_dev = keypad->input_dev;
60214f05 86 unsigned int *key;
e06003af
HS
87 int i;
88
60214f05
HS
89 key = &pdata->matrix_key_map[0];
90 for (i = 0; i < pdata->matrix_key_map_size; i++, key++) {
91 int row = KEY_ROW(*key);
92 int col = KEY_COL(*key);
93 int code = KEY_VAL(*key);
e06003af
HS
94
95 keypad->matrix_keycodes[(row << 3) + col] = code;
96 __set_bit(code, input_dev->keybit);
97 }
98}
99
100static irqreturn_t ep93xx_keypad_irq_handler(int irq, void *dev_id)
101{
102 struct ep93xx_keypad *keypad = dev_id;
103 struct input_dev *input_dev = keypad->input_dev;
60214f05 104 unsigned int status;
e06003af
HS
105 int keycode, key1, key2;
106
60214f05
HS
107 status = __raw_readl(keypad->mmio_base + KEY_REG);
108
e06003af
HS
109 keycode = (status & KEY_REG_KEY1_MASK) >> KEY_REG_KEY1_SHIFT;
110 key1 = keypad->matrix_keycodes[keycode];
111
112 keycode = (status & KEY_REG_KEY2_MASK) >> KEY_REG_KEY2_SHIFT;
113 key2 = keypad->matrix_keycodes[keycode];
114
115 if (status & KEY_REG_2KEYS) {
116 if (keypad->key1 && key1 != keypad->key1 && key2 != keypad->key1)
117 input_report_key(input_dev, keypad->key1, 0);
118
119 if (keypad->key2 && key1 != keypad->key2 && key2 != keypad->key2)
120 input_report_key(input_dev, keypad->key2, 0);
121
122 input_report_key(input_dev, key1, 1);
123 input_report_key(input_dev, key2, 1);
124
125 keypad->key1 = key1;
126 keypad->key2 = key2;
127
128 } else if (status & KEY_REG_1KEY) {
129 if (keypad->key1 && key1 != keypad->key1)
130 input_report_key(input_dev, keypad->key1, 0);
131
132 if (keypad->key2 && key1 != keypad->key2)
133 input_report_key(input_dev, keypad->key2, 0);
134
135 input_report_key(input_dev, key1, 1);
136
137 keypad->key1 = key1;
138 keypad->key2 = 0;
139
140 } else {
141 input_report_key(input_dev, keypad->key1, 0);
142 input_report_key(input_dev, keypad->key2, 0);
143
144 keypad->key1 = keypad->key2 = 0;
145 }
146 input_sync(input_dev);
147
148 return IRQ_HANDLED;
149}
150
151static void ep93xx_keypad_config(struct ep93xx_keypad *keypad)
152{
153 struct ep93xx_keypad_platform_data *pdata = keypad->pdata;
154 unsigned int val = 0;
155
60214f05
HS
156 if (pdata->flags & EP93XX_KEYPAD_KDIV)
157 clk_set_rate(keypad->clk, EP93XX_KEYTCHCLK_DIV4);
158 else
159 clk_set_rate(keypad->clk, EP93XX_KEYTCHCLK_DIV16);
e06003af
HS
160
161 if (pdata->flags & EP93XX_KEYPAD_DISABLE_3_KEY)
162 val |= KEY_INIT_DIS3KY;
163 if (pdata->flags & EP93XX_KEYPAD_DIAG_MODE)
164 val |= KEY_INIT_DIAG;
165 if (pdata->flags & EP93XX_KEYPAD_BACK_DRIVE)
166 val |= KEY_INIT_BACK;
167 if (pdata->flags & EP93XX_KEYPAD_TEST_MODE)
168 val |= KEY_INIT_T2;
169
170 val |= ((pdata->debounce << KEY_INIT_DBNC_SHIFT) & KEY_INIT_DBNC_MASK);
171
172 val |= ((pdata->prescale << KEY_INIT_PRSCL_SHIFT) & KEY_INIT_PRSCL_MASK);
173
60214f05 174 __raw_writel(val, keypad->mmio_base + KEY_INIT);
e06003af
HS
175}
176
177static int ep93xx_keypad_open(struct input_dev *pdev)
178{
179 struct ep93xx_keypad *keypad = input_get_drvdata(pdev);
180
181 if (!keypad->enabled) {
182 ep93xx_keypad_config(keypad);
183 clk_enable(keypad->clk);
60214f05 184 keypad->enabled = true;
e06003af
HS
185 }
186
187 return 0;
188}
189
190static void ep93xx_keypad_close(struct input_dev *pdev)
191{
192 struct ep93xx_keypad *keypad = input_get_drvdata(pdev);
193
194 if (keypad->enabled) {
195 clk_disable(keypad->clk);
60214f05 196 keypad->enabled = false;
e06003af
HS
197 }
198}
199
200
201#ifdef CONFIG_PM
202/*
203 * NOTE: I don't know if this is correct, or will work on the ep93xx.
204 *
205 * None of the existing ep93xx drivers have power management support.
206 * But, this is basically what the pxa27x_keypad driver does.
207 */
208static int ep93xx_keypad_suspend(struct platform_device *pdev,
209 pm_message_t state)
210{
211 struct ep93xx_keypad *keypad = platform_get_drvdata(pdev);
212 struct input_dev *input_dev = keypad->input_dev;
213
214 mutex_lock(&input_dev->mutex);
215
216 if (keypad->enabled) {
217 clk_disable(keypad->clk);
60214f05 218 keypad->enabled = false;
e06003af
HS
219 }
220
221 mutex_unlock(&input_dev->mutex);
222
223 if (device_may_wakeup(&pdev->dev))
224 enable_irq_wake(keypad->irq);
225
226 return 0;
227}
228
229static int ep93xx_keypad_resume(struct platform_device *pdev)
230{
231 struct ep93xx_keypad *keypad = platform_get_drvdata(pdev);
232 struct input_dev *input_dev = keypad->input_dev;
233
234 if (device_may_wakeup(&pdev->dev))
235 disable_irq_wake(keypad->irq);
236
237 mutex_lock(&input_dev->mutex);
238
239 if (input_dev->users) {
240 if (!keypad->enabled) {
241 ep93xx_keypad_config(keypad);
242 clk_enable(keypad->clk);
60214f05 243 keypad->enabled = true;
e06003af
HS
244 }
245 }
246
247 mutex_unlock(&input_dev->mutex);
248
249 return 0;
250}
251#else /* !CONFIG_PM */
252#define ep93xx_keypad_suspend NULL
253#define ep93xx_keypad_resume NULL
254#endif /* !CONFIG_PM */
255
256static int __devinit ep93xx_keypad_probe(struct platform_device *pdev)
257{
258 struct ep93xx_keypad *keypad;
e06003af
HS
259 struct input_dev *input_dev;
260 struct resource *res;
60214f05 261 int err;
e06003af
HS
262
263 keypad = kzalloc(sizeof(struct ep93xx_keypad), GFP_KERNEL);
60214f05 264 if (!keypad)
e06003af 265 return -ENOMEM;
e06003af 266
60214f05
HS
267 keypad->pdata = pdev->dev.platform_data;
268 if (!keypad->pdata) {
269 err = -EINVAL;
270 goto failed_free;
271 }
e06003af 272
60214f05
HS
273 keypad->irq = platform_get_irq(pdev, 0);
274 if (!keypad->irq) {
e06003af
HS
275 err = -ENXIO;
276 goto failed_free;
277 }
278
279 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
280 if (!res) {
e06003af
HS
281 err = -ENXIO;
282 goto failed_free;
283 }
284
285 res = request_mem_region(res->start, resource_size(res), pdev->name);
286 if (!res) {
e06003af
HS
287 err = -EBUSY;
288 goto failed_free;
289 }
290
291 keypad->mmio_base = ioremap(res->start, resource_size(res));
292 if (keypad->mmio_base == NULL) {
e06003af
HS
293 err = -ENXIO;
294 goto failed_free_mem;
295 }
296
60214f05
HS
297 err = ep93xx_keypad_acquire_gpio(pdev);
298 if (err)
299 goto failed_free_io;
e06003af 300
60214f05 301 keypad->clk = clk_get(&pdev->dev, NULL);
e06003af 302 if (IS_ERR(keypad->clk)) {
e06003af 303 err = PTR_ERR(keypad->clk);
60214f05 304 goto failed_free_gpio;
e06003af
HS
305 }
306
e06003af
HS
307 input_dev = input_allocate_device();
308 if (!input_dev) {
e06003af
HS
309 err = -ENOMEM;
310 goto failed_put_clk;
311 }
312
313 keypad->input_dev = input_dev;
314
315 input_dev->name = pdev->name;
316 input_dev->id.bustype = BUS_HOST;
317 input_dev->open = ep93xx_keypad_open;
318 input_dev->close = ep93xx_keypad_close;
319 input_dev->dev.parent = &pdev->dev;
320 input_dev->keycode = keypad->matrix_keycodes;
321 input_dev->keycodesize = sizeof(keypad->matrix_keycodes[0]);
322 input_dev->keycodemax = ARRAY_SIZE(keypad->matrix_keycodes);
323
324 input_set_drvdata(input_dev, keypad);
325
326 input_dev->evbit[0] = BIT_MASK(EV_KEY);
327 if (keypad->pdata->flags & EP93XX_KEYPAD_AUTOREPEAT)
328 input_dev->evbit[0] |= BIT_MASK(EV_REP);
329
330 ep93xx_keypad_build_keycode(keypad);
331 platform_set_drvdata(pdev, keypad);
332
60214f05
HS
333 err = request_irq(keypad->irq, ep93xx_keypad_irq_handler,
334 IRQF_DISABLED, pdev->name, keypad);
335 if (err)
e06003af 336 goto failed_free_dev;
e06003af 337
e06003af 338 err = input_register_device(input_dev);
60214f05 339 if (err)
e06003af 340 goto failed_free_irq;
e06003af
HS
341
342 device_init_wakeup(&pdev->dev, 1);
343
344 return 0;
345
346failed_free_irq:
60214f05 347 free_irq(keypad->irq, pdev);
e06003af
HS
348 platform_set_drvdata(pdev, NULL);
349failed_free_dev:
350 input_free_device(input_dev);
351failed_put_clk:
352 clk_put(keypad->clk);
60214f05
HS
353failed_free_gpio:
354 ep93xx_keypad_release_gpio(pdev);
e06003af 355failed_free_io:
e06003af
HS
356 iounmap(keypad->mmio_base);
357failed_free_mem:
358 release_mem_region(res->start, resource_size(res));
359failed_free:
360 kfree(keypad);
361 return err;
362}
363
364static int __devexit ep93xx_keypad_remove(struct platform_device *pdev)
365{
366 struct ep93xx_keypad *keypad = platform_get_drvdata(pdev);
367 struct resource *res;
e06003af
HS
368
369 free_irq(keypad->irq, pdev);
370
371 platform_set_drvdata(pdev, NULL);
372
373 if (keypad->enabled)
374 clk_disable(keypad->clk);
375 clk_put(keypad->clk);
376
377 input_unregister_device(keypad->input_dev);
378
60214f05 379 ep93xx_keypad_release_gpio(pdev);
e06003af
HS
380
381 iounmap(keypad->mmio_base);
382
383 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
384 release_mem_region(res->start, resource_size(res));
385
386 kfree(keypad);
387
388 return 0;
389}
390
391static struct platform_driver ep93xx_keypad_driver = {
392 .driver = {
393 .name = "ep93xx-keypad",
394 .owner = THIS_MODULE,
395 },
396 .probe = ep93xx_keypad_probe,
397 .remove = __devexit_p(ep93xx_keypad_remove),
398 .suspend = ep93xx_keypad_suspend,
399 .resume = ep93xx_keypad_resume,
400};
401
402static int __init ep93xx_keypad_init(void)
403{
404 return platform_driver_register(&ep93xx_keypad_driver);
405}
406
407static void __exit ep93xx_keypad_exit(void)
408{
409 platform_driver_unregister(&ep93xx_keypad_driver);
410}
411
412module_init(ep93xx_keypad_init);
413module_exit(ep93xx_keypad_exit);
414
415MODULE_LICENSE("GPL");
416MODULE_AUTHOR("H Hartley Sweeten <hsweeten@visionengravers.com>");
417MODULE_DESCRIPTION("EP93xx Matrix Keypad Controller");
418MODULE_ALIAS("platform:ep93xx-keypad");