]> Pileus Git - ~andy/linux/blob - drivers/input/keyboard/pxa27x_keypad.c
Input: pxa27x-keypad - make platform data const
[~andy/linux] / drivers / input / keyboard / pxa27x_keypad.c
1 /*
2  * linux/drivers/input/keyboard/pxa27x_keypad.c
3  *
4  * Driver for the pxa27x matrix keyboard controller.
5  *
6  * Created:     Feb 22, 2007
7  * Author:      Rodolfo Giometti <giometti@linux.it>
8  *
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@fluxnic.net>.
12  *
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.
16  */
17
18
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>
28 #include <linux/input/matrix_keypad.h>
29 #include <linux/slab.h>
30
31 #include <asm/mach/arch.h>
32 #include <asm/mach/map.h>
33
34 #include <mach/hardware.h>
35 #include <linux/platform_data/keypad-pxa27x.h>
36 /*
37  * Keypad Controller registers
38  */
39 #define KPC             0x0000 /* Keypad Control register */
40 #define KPDK            0x0008 /* Keypad Direct Key register */
41 #define KPREC           0x0010 /* Keypad Rotary Encoder register */
42 #define KPMK            0x0018 /* Keypad Matrix Key register */
43 #define KPAS            0x0020 /* Keypad Automatic Scan register */
44
45 /* Keypad Automatic Scan Multiple Key Presser register 0-3 */
46 #define KPASMKP0        0x0028
47 #define KPASMKP1        0x0030
48 #define KPASMKP2        0x0038
49 #define KPASMKP3        0x0040
50 #define KPKDI           0x0048
51
52 /* bit definitions */
53 #define KPC_MKRN(n)     ((((n) - 1) & 0x7) << 26) /* matrix key row number */
54 #define KPC_MKCN(n)     ((((n) - 1) & 0x7) << 23) /* matrix key column number */
55 #define KPC_DKN(n)      ((((n) - 1) & 0x7) << 6)  /* direct key number */
56
57 #define KPC_AS          (0x1 << 30)  /* Automatic Scan bit */
58 #define KPC_ASACT       (0x1 << 29)  /* Automatic Scan on Activity */
59 #define KPC_MI          (0x1 << 22)  /* Matrix interrupt bit */
60 #define KPC_IMKP        (0x1 << 21)  /* Ignore Multiple Key Press */
61
62 #define KPC_MS(n)       (0x1 << (13 + (n)))     /* Matrix scan line 'n' */
63 #define KPC_MS_ALL      (0xff << 13)
64
65 #define KPC_ME          (0x1 << 12)  /* Matrix Keypad Enable */
66 #define KPC_MIE         (0x1 << 11)  /* Matrix Interrupt Enable */
67 #define KPC_DK_DEB_SEL  (0x1 <<  9)  /* Direct Keypad Debounce Select */
68 #define KPC_DI          (0x1 <<  5)  /* Direct key interrupt bit */
69 #define KPC_RE_ZERO_DEB (0x1 <<  4)  /* Rotary Encoder Zero Debounce */
70 #define KPC_REE1        (0x1 <<  3)  /* Rotary Encoder1 Enable */
71 #define KPC_REE0        (0x1 <<  2)  /* Rotary Encoder0 Enable */
72 #define KPC_DE          (0x1 <<  1)  /* Direct Keypad Enable */
73 #define KPC_DIE         (0x1 <<  0)  /* Direct Keypad interrupt Enable */
74
75 #define KPDK_DKP        (0x1 << 31)
76 #define KPDK_DK(n)      ((n) & 0xff)
77
78 #define KPREC_OF1       (0x1 << 31)
79 #define kPREC_UF1       (0x1 << 30)
80 #define KPREC_OF0       (0x1 << 15)
81 #define KPREC_UF0       (0x1 << 14)
82
83 #define KPREC_RECOUNT0(n)       ((n) & 0xff)
84 #define KPREC_RECOUNT1(n)       (((n) >> 16) & 0xff)
85
86 #define KPMK_MKP        (0x1 << 31)
87 #define KPAS_SO         (0x1 << 31)
88 #define KPASMKPx_SO     (0x1 << 31)
89
90 #define KPAS_MUKP(n)    (((n) >> 26) & 0x1f)
91 #define KPAS_RP(n)      (((n) >> 4) & 0xf)
92 #define KPAS_CP(n)      ((n) & 0xf)
93
94 #define KPASMKP_MKC_MASK        (0xff)
95
96 #define keypad_readl(off)       __raw_readl(keypad->mmio_base + (off))
97 #define keypad_writel(off, v)   __raw_writel((v), keypad->mmio_base + (off))
98
99 #define MAX_MATRIX_KEY_NUM      (MAX_MATRIX_KEY_ROWS * MAX_MATRIX_KEY_COLS)
100 #define MAX_KEYPAD_KEYS         (MAX_MATRIX_KEY_NUM + MAX_DIRECT_KEY_NUM)
101
102 struct pxa27x_keypad {
103         const struct pxa27x_keypad_platform_data *pdata;
104
105         struct clk *clk;
106         struct input_dev *input_dev;
107         void __iomem *mmio_base;
108
109         int irq;
110
111         unsigned short keycodes[MAX_KEYPAD_KEYS];
112         int rotary_rel_code[2];
113
114         /* state row bits of each column scan */
115         uint32_t matrix_key_state[MAX_MATRIX_KEY_COLS];
116         uint32_t direct_key_state;
117
118         unsigned int direct_key_mask;
119 };
120
121 #ifdef CONFIG_OF
122 static int pxa27x_keypad_matrix_key_parse_dt(struct pxa27x_keypad *keypad,
123                                 struct pxa27x_keypad_platform_data *pdata)
124 {
125         struct input_dev *input_dev = keypad->input_dev;
126         struct device *dev = input_dev->dev.parent;
127         u32 rows, cols;
128         int error;
129
130         error = matrix_keypad_parse_of_params(dev, &rows, &cols);
131         if (error)
132                 return error;
133
134         if (rows > MAX_MATRIX_KEY_ROWS || cols > MAX_MATRIX_KEY_COLS) {
135                 dev_err(dev, "rows or cols exceeds maximum value\n");
136                 return -EINVAL;
137         }
138
139         pdata->matrix_key_rows = rows;
140         pdata->matrix_key_cols = cols;
141
142         error = matrix_keypad_build_keymap(NULL, NULL,
143                                            pdata->matrix_key_rows,
144                                            pdata->matrix_key_cols,
145                                            keypad->keycodes, input_dev);
146         if (error)
147                 return error;
148
149         return 0;
150 }
151
152 static int pxa27x_keypad_direct_key_parse_dt(struct pxa27x_keypad *keypad,
153                                 struct pxa27x_keypad_platform_data *pdata)
154 {
155         struct input_dev *input_dev = keypad->input_dev;
156         struct device *dev = input_dev->dev.parent;
157         struct device_node *np = dev->of_node;
158         const __be16 *prop;
159         unsigned short code;
160         unsigned int proplen, size;
161         int i;
162         int error;
163
164         error = of_property_read_u32(np, "marvell,direct-key-count",
165                                      &pdata->direct_key_num);
166         if (error) {
167                 /*
168                  * If do not have marvel,direct-key-count defined,
169                  * it means direct key is not supported.
170                  */
171                 return error == -EINVAL ? 0 : error;
172         }
173
174         error = of_property_read_u32(np, "marvell,direct-key-mask",
175                                      &pdata->direct_key_mask);
176         if (error) {
177                 if (error != -EINVAL)
178                         return error;
179
180                 /*
181                  * If marvell,direct-key-mask is not defined, driver will use
182                  * default value. Default value is set when configure the keypad.
183                  */
184                 pdata->direct_key_mask = 0;
185         }
186
187         pdata->direct_key_low_active = of_property_read_bool(np,
188                                         "marvell,direct-key-low-active");
189
190         prop = of_get_property(np, "marvell,direct-key-map", &proplen);
191         if (!prop)
192                 return -EINVAL;
193
194         if (proplen % sizeof(u16))
195                 return -EINVAL;
196
197         size = proplen / sizeof(u16);
198
199         /* Only MAX_DIRECT_KEY_NUM is accepted.*/
200         if (size > MAX_DIRECT_KEY_NUM)
201                 return -EINVAL;
202
203         for (i = 0; i < size; i++) {
204                 code = be16_to_cpup(prop + i);
205                 keypad->keycodes[MAX_MATRIX_KEY_NUM + i] = code;
206                 __set_bit(code, input_dev->keybit);
207         }
208
209         return 0;
210 }
211
212 static int pxa27x_keypad_rotary_parse_dt(struct pxa27x_keypad *keypad,
213                                 struct pxa27x_keypad_platform_data *pdata)
214 {
215         const __be32 *prop;
216         int i, relkey_ret;
217         unsigned int code, proplen;
218         const char *rotaryname[2] = {
219                         "marvell,rotary0", "marvell,rotary1"};
220         const char relkeyname[] = {"marvell,rotary-rel-key"};
221         struct input_dev *input_dev = keypad->input_dev;
222         struct device *dev = input_dev->dev.parent;
223         struct device_node *np = dev->of_node;
224
225         relkey_ret = of_property_read_u32(np, relkeyname, &code);
226         /* if can read correct rotary key-code, we do not need this. */
227         if (relkey_ret == 0) {
228                 unsigned short relcode;
229
230                 /* rotary0 taks lower half, rotary1 taks upper half. */
231                 relcode = code & 0xffff;
232                 pdata->rotary0_rel_code = (code & 0xffff);
233                 __set_bit(relcode, input_dev->relbit);
234
235                 relcode = code >> 16;
236                 pdata->rotary1_rel_code = relcode;
237                 __set_bit(relcode, input_dev->relbit);
238         }
239
240         for (i = 0; i < 2; i++) {
241                 prop = of_get_property(np, rotaryname[i], &proplen);
242                 /*
243                  * If the prop is not set, it means keypad does not need
244                  * initialize the rotaryX.
245                  */
246                 if (!prop)
247                         continue;
248
249                 code = be32_to_cpup(prop);
250                 /*
251                  * Not all up/down key code are valid.
252                  * Now we depends on direct-rel-code.
253                  */
254                 if ((!(code & 0xffff) || !(code >> 16)) && relkey_ret) {
255                         return relkey_ret;
256                 } else {
257                         unsigned int n = MAX_MATRIX_KEY_NUM + (i << 1);
258                         unsigned short keycode;
259
260                         keycode = code & 0xffff;
261                         keypad->keycodes[n] = keycode;
262                         __set_bit(keycode, input_dev->keybit);
263
264                         keycode = code >> 16;
265                         keypad->keycodes[n + 1] = keycode;
266                         __set_bit(keycode, input_dev->keybit);
267
268                         if (i == 0)
269                                 pdata->rotary0_rel_code = -1;
270                         else
271                                 pdata->rotary1_rel_code = -1;
272                 }
273                 if (i == 0)
274                         pdata->enable_rotary0 = 1;
275                 else
276                         pdata->enable_rotary1 = 1;
277         }
278
279         keypad->rotary_rel_code[0] = pdata->rotary0_rel_code;
280         keypad->rotary_rel_code[1] = pdata->rotary1_rel_code;
281
282         return 0;
283 }
284
285 static int pxa27x_keypad_build_keycode_from_dt(struct pxa27x_keypad *keypad)
286 {
287         struct input_dev *input_dev = keypad->input_dev;
288         struct device *dev = input_dev->dev.parent;
289         struct device_node *np = dev->of_node;
290         struct pxa27x_keypad_platform_data *pdata;
291         int error;
292
293         pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
294         if (!pdata) {
295                 dev_err(dev, "failed to allocate memory for pdata\n");
296                 return -ENOMEM;
297         }
298
299         error = pxa27x_keypad_matrix_key_parse_dt(keypad, pdata);
300         if (error) {
301                 dev_err(dev, "failed to parse matrix key\n");
302                 return error;
303         }
304
305         error = pxa27x_keypad_direct_key_parse_dt(keypad, pdata);
306         if (error) {
307                 dev_err(dev, "failed to parse direct key\n");
308                 return error;
309         }
310
311         error = pxa27x_keypad_rotary_parse_dt(keypad, pdata);
312         if (error) {
313                 dev_err(dev, "failed to parse rotary key\n");
314                 return error;
315         }
316
317         error = of_property_read_u32(np, "marvell,debounce-interval",
318                                      &pdata->debounce_interval);
319         if (error) {
320                 dev_err(dev, "failed to parse debpunce-interval\n");
321                 return error;
322         }
323
324         /*
325          * The keycodes may not only includes matrix key but also the direct
326          * key or rotary key.
327          */
328         input_dev->keycodemax = ARRAY_SIZE(keypad->keycodes);
329
330         keypad->pdata = pdata;
331         return 0;
332 }
333
334 #else
335
336 static int pxa27x_keypad_build_keycode_from_dt(struct pxa27x_keypad *keypad)
337 {
338         dev_info(keypad->input_dev->dev.parent, "missing platform data\n");
339
340         return -EINVAL;
341 }
342
343 #endif
344
345 static int pxa27x_keypad_build_keycode(struct pxa27x_keypad *keypad)
346 {
347         const struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
348         struct input_dev *input_dev = keypad->input_dev;
349         const struct matrix_keymap_data *keymap_data =
350                                 pdata ? pdata->matrix_keymap_data : NULL;
351         unsigned short keycode;
352         int i;
353         int error;
354
355         error = matrix_keypad_build_keymap(keymap_data, NULL,
356                                            pdata->matrix_key_rows,
357                                            pdata->matrix_key_cols,
358                                            keypad->keycodes, input_dev);
359         if (error)
360                 return error;
361
362         /*
363          * The keycodes may not only include matrix keys but also the direct
364          * or rotary keys.
365          */
366         input_dev->keycodemax = ARRAY_SIZE(keypad->keycodes);
367
368         /* For direct keys. */
369         for (i = 0; i < pdata->direct_key_num; i++) {
370                 keycode = pdata->direct_key_map[i];
371                 keypad->keycodes[MAX_MATRIX_KEY_NUM + i] = keycode;
372                 __set_bit(keycode, input_dev->keybit);
373         }
374
375         if (pdata->enable_rotary0) {
376                 if (pdata->rotary0_up_key && pdata->rotary0_down_key) {
377                         keycode = pdata->rotary0_up_key;
378                         keypad->keycodes[MAX_MATRIX_KEY_NUM + 0] = keycode;
379                         __set_bit(keycode, input_dev->keybit);
380
381                         keycode = pdata->rotary0_down_key;
382                         keypad->keycodes[MAX_MATRIX_KEY_NUM + 1] = keycode;
383                         __set_bit(keycode, input_dev->keybit);
384
385                         keypad->rotary_rel_code[0] = -1;
386                 } else {
387                         keypad->rotary_rel_code[0] = pdata->rotary0_rel_code;
388                         __set_bit(pdata->rotary0_rel_code, input_dev->relbit);
389                 }
390         }
391
392         if (pdata->enable_rotary1) {
393                 if (pdata->rotary1_up_key && pdata->rotary1_down_key) {
394                         keycode = pdata->rotary1_up_key;
395                         keypad->keycodes[MAX_MATRIX_KEY_NUM + 2] = keycode;
396                         __set_bit(keycode, input_dev->keybit);
397
398                         keycode = pdata->rotary1_down_key;
399                         keypad->keycodes[MAX_MATRIX_KEY_NUM + 3] = keycode;
400                         __set_bit(keycode, input_dev->keybit);
401
402                         keypad->rotary_rel_code[1] = -1;
403                 } else {
404                         keypad->rotary_rel_code[1] = pdata->rotary1_rel_code;
405                         __set_bit(pdata->rotary1_rel_code, input_dev->relbit);
406                 }
407         }
408
409         __clear_bit(KEY_RESERVED, input_dev->keybit);
410
411         return 0;
412 }
413
414 static void pxa27x_keypad_scan_matrix(struct pxa27x_keypad *keypad)
415 {
416         const struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
417         struct input_dev *input_dev = keypad->input_dev;
418         int row, col, num_keys_pressed = 0;
419         uint32_t new_state[MAX_MATRIX_KEY_COLS];
420         uint32_t kpas = keypad_readl(KPAS);
421
422         num_keys_pressed = KPAS_MUKP(kpas);
423
424         memset(new_state, 0, sizeof(new_state));
425
426         if (num_keys_pressed == 0)
427                 goto scan;
428
429         if (num_keys_pressed == 1) {
430                 col = KPAS_CP(kpas);
431                 row = KPAS_RP(kpas);
432
433                 /* if invalid row/col, treat as no key pressed */
434                 if (col >= pdata->matrix_key_cols ||
435                     row >= pdata->matrix_key_rows)
436                         goto scan;
437
438                 new_state[col] = (1 << row);
439                 goto scan;
440         }
441
442         if (num_keys_pressed > 1) {
443                 uint32_t kpasmkp0 = keypad_readl(KPASMKP0);
444                 uint32_t kpasmkp1 = keypad_readl(KPASMKP1);
445                 uint32_t kpasmkp2 = keypad_readl(KPASMKP2);
446                 uint32_t kpasmkp3 = keypad_readl(KPASMKP3);
447
448                 new_state[0] = kpasmkp0 & KPASMKP_MKC_MASK;
449                 new_state[1] = (kpasmkp0 >> 16) & KPASMKP_MKC_MASK;
450                 new_state[2] = kpasmkp1 & KPASMKP_MKC_MASK;
451                 new_state[3] = (kpasmkp1 >> 16) & KPASMKP_MKC_MASK;
452                 new_state[4] = kpasmkp2 & KPASMKP_MKC_MASK;
453                 new_state[5] = (kpasmkp2 >> 16) & KPASMKP_MKC_MASK;
454                 new_state[6] = kpasmkp3 & KPASMKP_MKC_MASK;
455                 new_state[7] = (kpasmkp3 >> 16) & KPASMKP_MKC_MASK;
456         }
457 scan:
458         for (col = 0; col < pdata->matrix_key_cols; col++) {
459                 uint32_t bits_changed;
460                 int code;
461
462                 bits_changed = keypad->matrix_key_state[col] ^ new_state[col];
463                 if (bits_changed == 0)
464                         continue;
465
466                 for (row = 0; row < pdata->matrix_key_rows; row++) {
467                         if ((bits_changed & (1 << row)) == 0)
468                                 continue;
469
470                         code = MATRIX_SCAN_CODE(row, col, MATRIX_ROW_SHIFT);
471                         input_event(input_dev, EV_MSC, MSC_SCAN, code);
472                         input_report_key(input_dev, keypad->keycodes[code],
473                                          new_state[col] & (1 << row));
474                 }
475         }
476         input_sync(input_dev);
477         memcpy(keypad->matrix_key_state, new_state, sizeof(new_state));
478 }
479
480 #define DEFAULT_KPREC   (0x007f007f)
481
482 static inline int rotary_delta(uint32_t kprec)
483 {
484         if (kprec & KPREC_OF0)
485                 return (kprec & 0xff) + 0x7f;
486         else if (kprec & KPREC_UF0)
487                 return (kprec & 0xff) - 0x7f - 0xff;
488         else
489                 return (kprec & 0xff) - 0x7f;
490 }
491
492 static void report_rotary_event(struct pxa27x_keypad *keypad, int r, int delta)
493 {
494         struct input_dev *dev = keypad->input_dev;
495
496         if (delta == 0)
497                 return;
498
499         if (keypad->rotary_rel_code[r] == -1) {
500                 int code = MAX_MATRIX_KEY_NUM + 2 * r + (delta > 0 ? 0 : 1);
501                 unsigned char keycode = keypad->keycodes[code];
502
503                 /* simulate a press-n-release */
504                 input_event(dev, EV_MSC, MSC_SCAN, code);
505                 input_report_key(dev, keycode, 1);
506                 input_sync(dev);
507                 input_event(dev, EV_MSC, MSC_SCAN, code);
508                 input_report_key(dev, keycode, 0);
509                 input_sync(dev);
510         } else {
511                 input_report_rel(dev, keypad->rotary_rel_code[r], delta);
512                 input_sync(dev);
513         }
514 }
515
516 static void pxa27x_keypad_scan_rotary(struct pxa27x_keypad *keypad)
517 {
518         const struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
519         uint32_t kprec;
520
521         /* read and reset to default count value */
522         kprec = keypad_readl(KPREC);
523         keypad_writel(KPREC, DEFAULT_KPREC);
524
525         if (pdata->enable_rotary0)
526                 report_rotary_event(keypad, 0, rotary_delta(kprec));
527
528         if (pdata->enable_rotary1)
529                 report_rotary_event(keypad, 1, rotary_delta(kprec >> 16));
530 }
531
532 static void pxa27x_keypad_scan_direct(struct pxa27x_keypad *keypad)
533 {
534         const struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
535         struct input_dev *input_dev = keypad->input_dev;
536         unsigned int new_state;
537         uint32_t kpdk, bits_changed;
538         int i;
539
540         kpdk = keypad_readl(KPDK);
541
542         if (pdata->enable_rotary0 || pdata->enable_rotary1)
543                 pxa27x_keypad_scan_rotary(keypad);
544
545         /*
546          * The KPDR_DK only output the key pin level, so it relates to board,
547          * and low level may be active.
548          */
549         if (pdata->direct_key_low_active)
550                 new_state = ~KPDK_DK(kpdk) & keypad->direct_key_mask;
551         else
552                 new_state = KPDK_DK(kpdk) & keypad->direct_key_mask;
553
554         bits_changed = keypad->direct_key_state ^ new_state;
555
556         if (bits_changed == 0)
557                 return;
558
559         for (i = 0; i < pdata->direct_key_num; i++) {
560                 if (bits_changed & (1 << i)) {
561                         int code = MAX_MATRIX_KEY_NUM + i;
562
563                         input_event(input_dev, EV_MSC, MSC_SCAN, code);
564                         input_report_key(input_dev, keypad->keycodes[code],
565                                          new_state & (1 << i));
566                 }
567         }
568         input_sync(input_dev);
569         keypad->direct_key_state = new_state;
570 }
571
572 static void clear_wakeup_event(struct pxa27x_keypad *keypad)
573 {
574         const struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
575
576         if (pdata->clear_wakeup_event)
577                 (pdata->clear_wakeup_event)();
578 }
579
580 static irqreturn_t pxa27x_keypad_irq_handler(int irq, void *dev_id)
581 {
582         struct pxa27x_keypad *keypad = dev_id;
583         unsigned long kpc = keypad_readl(KPC);
584
585         clear_wakeup_event(keypad);
586
587         if (kpc & KPC_DI)
588                 pxa27x_keypad_scan_direct(keypad);
589
590         if (kpc & KPC_MI)
591                 pxa27x_keypad_scan_matrix(keypad);
592
593         return IRQ_HANDLED;
594 }
595
596 static void pxa27x_keypad_config(struct pxa27x_keypad *keypad)
597 {
598         const struct pxa27x_keypad_platform_data *pdata = keypad->pdata;
599         unsigned int mask = 0, direct_key_num = 0;
600         unsigned long kpc = 0;
601
602         /* clear pending interrupt bit */
603         keypad_readl(KPC);
604
605         /* enable matrix keys with automatic scan */
606         if (pdata->matrix_key_rows && pdata->matrix_key_cols) {
607                 kpc |= KPC_ASACT | KPC_MIE | KPC_ME | KPC_MS_ALL;
608                 kpc |= KPC_MKRN(pdata->matrix_key_rows) |
609                        KPC_MKCN(pdata->matrix_key_cols);
610         }
611
612         /* enable rotary key, debounce interval same as direct keys */
613         if (pdata->enable_rotary0) {
614                 mask |= 0x03;
615                 direct_key_num = 2;
616                 kpc |= KPC_REE0;
617         }
618
619         if (pdata->enable_rotary1) {
620                 mask |= 0x0c;
621                 direct_key_num = 4;
622                 kpc |= KPC_REE1;
623         }
624
625         if (pdata->direct_key_num > direct_key_num)
626                 direct_key_num = pdata->direct_key_num;
627
628         /*
629          * Direct keys usage may not start from KP_DKIN0, check the platfrom
630          * mask data to config the specific.
631          */
632         if (pdata->direct_key_mask)
633                 keypad->direct_key_mask = pdata->direct_key_mask;
634         else
635                 keypad->direct_key_mask = ((1 << direct_key_num) - 1) & ~mask;
636
637         /* enable direct key */
638         if (direct_key_num)
639                 kpc |= KPC_DE | KPC_DIE | KPC_DKN(direct_key_num);
640
641         keypad_writel(KPC, kpc | KPC_RE_ZERO_DEB);
642         keypad_writel(KPREC, DEFAULT_KPREC);
643         keypad_writel(KPKDI, pdata->debounce_interval);
644 }
645
646 static int pxa27x_keypad_open(struct input_dev *dev)
647 {
648         struct pxa27x_keypad *keypad = input_get_drvdata(dev);
649
650         /* Enable unit clock */
651         clk_prepare_enable(keypad->clk);
652         pxa27x_keypad_config(keypad);
653
654         return 0;
655 }
656
657 static void pxa27x_keypad_close(struct input_dev *dev)
658 {
659         struct pxa27x_keypad *keypad = input_get_drvdata(dev);
660
661         /* Disable clock unit */
662         clk_disable_unprepare(keypad->clk);
663 }
664
665 #ifdef CONFIG_PM_SLEEP
666 static int pxa27x_keypad_suspend(struct device *dev)
667 {
668         struct platform_device *pdev = to_platform_device(dev);
669         struct pxa27x_keypad *keypad = platform_get_drvdata(pdev);
670
671         /*
672          * If the keypad is used a wake up source, clock can not be disabled.
673          * Or it can not detect the key pressing.
674          */
675         if (device_may_wakeup(&pdev->dev))
676                 enable_irq_wake(keypad->irq);
677         else
678                 clk_disable_unprepare(keypad->clk);
679
680         return 0;
681 }
682
683 static int pxa27x_keypad_resume(struct device *dev)
684 {
685         struct platform_device *pdev = to_platform_device(dev);
686         struct pxa27x_keypad *keypad = platform_get_drvdata(pdev);
687         struct input_dev *input_dev = keypad->input_dev;
688
689         /*
690          * If the keypad is used as wake up source, the clock is not turned
691          * off. So do not need configure it again.
692          */
693         if (device_may_wakeup(&pdev->dev)) {
694                 disable_irq_wake(keypad->irq);
695         } else {
696                 mutex_lock(&input_dev->mutex);
697
698                 if (input_dev->users) {
699                         /* Enable unit clock */
700                         clk_prepare_enable(keypad->clk);
701                         pxa27x_keypad_config(keypad);
702                 }
703
704                 mutex_unlock(&input_dev->mutex);
705         }
706
707         return 0;
708 }
709 #endif
710
711 static SIMPLE_DEV_PM_OPS(pxa27x_keypad_pm_ops,
712                          pxa27x_keypad_suspend, pxa27x_keypad_resume);
713
714
715 static int pxa27x_keypad_probe(struct platform_device *pdev)
716 {
717         const struct pxa27x_keypad_platform_data *pdata =
718                                         dev_get_platdata(&pdev->dev);
719         struct device_node *np = pdev->dev.of_node;
720         struct pxa27x_keypad *keypad;
721         struct input_dev *input_dev;
722         struct resource *res;
723         int irq, error;
724
725         /* Driver need build keycode from device tree or pdata */
726         if (!np && !pdata)
727                 return -EINVAL;
728
729         irq = platform_get_irq(pdev, 0);
730         if (irq < 0) {
731                 dev_err(&pdev->dev, "failed to get keypad irq\n");
732                 return -ENXIO;
733         }
734
735         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
736         if (res == NULL) {
737                 dev_err(&pdev->dev, "failed to get I/O memory\n");
738                 return -ENXIO;
739         }
740
741         keypad = kzalloc(sizeof(struct pxa27x_keypad), GFP_KERNEL);
742         input_dev = input_allocate_device();
743         if (!keypad || !input_dev) {
744                 dev_err(&pdev->dev, "failed to allocate memory\n");
745                 error = -ENOMEM;
746                 goto failed_free;
747         }
748
749         keypad->pdata = pdata;
750         keypad->input_dev = input_dev;
751         keypad->irq = irq;
752
753         res = request_mem_region(res->start, resource_size(res), pdev->name);
754         if (res == NULL) {
755                 dev_err(&pdev->dev, "failed to request I/O memory\n");
756                 error = -EBUSY;
757                 goto failed_free;
758         }
759
760         keypad->mmio_base = ioremap(res->start, resource_size(res));
761         if (keypad->mmio_base == NULL) {
762                 dev_err(&pdev->dev, "failed to remap I/O memory\n");
763                 error = -ENXIO;
764                 goto failed_free_mem;
765         }
766
767         keypad->clk = clk_get(&pdev->dev, NULL);
768         if (IS_ERR(keypad->clk)) {
769                 dev_err(&pdev->dev, "failed to get keypad clock\n");
770                 error = PTR_ERR(keypad->clk);
771                 goto failed_free_io;
772         }
773
774         input_dev->name = pdev->name;
775         input_dev->id.bustype = BUS_HOST;
776         input_dev->open = pxa27x_keypad_open;
777         input_dev->close = pxa27x_keypad_close;
778         input_dev->dev.parent = &pdev->dev;
779
780         input_dev->keycode = keypad->keycodes;
781         input_dev->keycodesize = sizeof(keypad->keycodes[0]);
782         input_dev->keycodemax = ARRAY_SIZE(keypad->keycodes);
783
784         input_set_drvdata(input_dev, keypad);
785
786         input_dev->evbit[0] = BIT_MASK(EV_KEY) | BIT_MASK(EV_REP);
787         input_set_capability(input_dev, EV_MSC, MSC_SCAN);
788
789         if (pdata)
790                 error = pxa27x_keypad_build_keycode(keypad);
791         else
792                 error = pxa27x_keypad_build_keycode_from_dt(keypad);
793         if (error) {
794                 dev_err(&pdev->dev, "failed to build keycode\n");
795                 goto failed_put_clk;
796         }
797
798         if ((pdata->enable_rotary0 && keypad->rotary_rel_code[0] != -1) ||
799             (pdata->enable_rotary1 && keypad->rotary_rel_code[1] != -1)) {
800                 input_dev->evbit[0] |= BIT_MASK(EV_REL);
801         }
802
803         error = request_irq(irq, pxa27x_keypad_irq_handler, 0,
804                             pdev->name, keypad);
805         if (error) {
806                 dev_err(&pdev->dev, "failed to request IRQ\n");
807                 goto failed_put_clk;
808         }
809
810         /* Register the input device */
811         error = input_register_device(input_dev);
812         if (error) {
813                 dev_err(&pdev->dev, "failed to register input device\n");
814                 goto failed_free_irq;
815         }
816
817         platform_set_drvdata(pdev, keypad);
818         device_init_wakeup(&pdev->dev, 1);
819
820         return 0;
821
822 failed_free_irq:
823         free_irq(irq, keypad);
824 failed_put_clk:
825         clk_put(keypad->clk);
826 failed_free_io:
827         iounmap(keypad->mmio_base);
828 failed_free_mem:
829         release_mem_region(res->start, resource_size(res));
830 failed_free:
831         input_free_device(input_dev);
832         kfree(keypad);
833         return error;
834 }
835
836 static int pxa27x_keypad_remove(struct platform_device *pdev)
837 {
838         struct pxa27x_keypad *keypad = platform_get_drvdata(pdev);
839         struct resource *res;
840
841         free_irq(keypad->irq, keypad);
842         clk_put(keypad->clk);
843
844         input_unregister_device(keypad->input_dev);
845         iounmap(keypad->mmio_base);
846
847         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
848         release_mem_region(res->start, resource_size(res));
849
850         kfree(keypad);
851
852         return 0;
853 }
854
855 /* work with hotplug and coldplug */
856 MODULE_ALIAS("platform:pxa27x-keypad");
857
858 #ifdef CONFIG_OF
859 static const struct of_device_id pxa27x_keypad_dt_match[] = {
860         { .compatible = "marvell,pxa27x-keypad" },
861         {},
862 };
863 MODULE_DEVICE_TABLE(of, pxa27x_keypad_dt_match);
864 #endif
865
866 static struct platform_driver pxa27x_keypad_driver = {
867         .probe          = pxa27x_keypad_probe,
868         .remove         = pxa27x_keypad_remove,
869         .driver         = {
870                 .name   = "pxa27x-keypad",
871                 .of_match_table = of_match_ptr(pxa27x_keypad_dt_match),
872                 .owner  = THIS_MODULE,
873                 .pm     = &pxa27x_keypad_pm_ops,
874         },
875 };
876 module_platform_driver(pxa27x_keypad_driver);
877
878 MODULE_DESCRIPTION("PXA27x Keypad Controller Driver");
879 MODULE_LICENSE("GPL");