2 * Keyboard driver for Sharp Spitz, Borzoi and Akita (SL-Cxx00 series)
4 * Copyright (c) 2005 Richard Purdie
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.
14 #include <linux/delay.h>
15 #include <linux/platform_device.h>
16 #include <linux/init.h>
17 #include <linux/input.h>
18 #include <linux/interrupt.h>
19 #include <linux/jiffies.h>
20 #include <linux/module.h>
21 #include <linux/slab.h>
24 #include <asm/arch/spitz.h>
25 #include <asm/arch/hardware.h>
26 #include <asm/arch/pxa-regs.h>
30 #define KB_ROWMASK(r) (1 << (r))
31 #define SCANCODE(r,c) (((r)<<4) + (c) + 1)
32 #define NR_SCANCODES ((KB_ROWS<<4) + 1)
34 #define HINGE_SCAN_INTERVAL (150) /* ms */
36 #define SPITZ_KEY_CALENDER KEY_F1
37 #define SPITZ_KEY_ADDRESS KEY_F2
38 #define SPITZ_KEY_FN KEY_F3
39 #define SPITZ_KEY_CANCEL KEY_F4
40 #define SPITZ_KEY_EXOK KEY_F5
41 #define SPITZ_KEY_EXCANCEL KEY_F6
42 #define SPITZ_KEY_EXJOGDOWN KEY_F7
43 #define SPITZ_KEY_EXJOGUP KEY_F8
44 #define SPITZ_KEY_JAP1 KEY_LEFTALT
45 #define SPITZ_KEY_JAP2 KEY_RIGHTCTRL
46 #define SPITZ_KEY_SYNC KEY_F9
47 #define SPITZ_KEY_MAIL KEY_F10
48 #define SPITZ_KEY_OK KEY_F11
49 #define SPITZ_KEY_MENU KEY_F12
51 static unsigned char spitzkbd_keycode
[NR_SCANCODES
] = {
53 KEY_LEFTCTRL
, KEY_1
, KEY_3
, KEY_5
, KEY_6
, KEY_7
, KEY_9
, KEY_0
, KEY_BACKSPACE
, SPITZ_KEY_EXOK
, SPITZ_KEY_EXCANCEL
, 0, 0, 0, 0, 0, /* 1-16 */
54 0, KEY_2
, KEY_4
, KEY_R
, KEY_Y
, KEY_8
, KEY_I
, KEY_O
, KEY_P
, SPITZ_KEY_EXJOGDOWN
, SPITZ_KEY_EXJOGUP
, 0, 0, 0, 0, 0, /* 17-32 */
55 KEY_TAB
, KEY_Q
, KEY_E
, KEY_T
, KEY_G
, KEY_U
, KEY_J
, KEY_K
, 0, 0, 0, 0, 0, 0, 0, 0, /* 33-48 */
56 SPITZ_KEY_CALENDER
, KEY_W
, KEY_S
, KEY_F
, KEY_V
, KEY_H
, KEY_M
, KEY_L
, 0, KEY_RIGHTSHIFT
, 0, 0, 0, 0, 0, 0, /* 49-64 */
57 SPITZ_KEY_ADDRESS
, KEY_A
, KEY_D
, KEY_C
, KEY_B
, KEY_N
, KEY_DOT
, 0, KEY_ENTER
, KEY_LEFTSHIFT
, 0, 0, 0, 0, 0, 0, /* 65-80 */
58 SPITZ_KEY_MAIL
, KEY_Z
, KEY_X
, KEY_MINUS
, KEY_SPACE
, KEY_COMMA
, 0, KEY_UP
, 0, 0, SPITZ_KEY_FN
, 0, 0, 0, 0, 0, /* 81-96 */
59 KEY_SYSRQ
, SPITZ_KEY_JAP1
, SPITZ_KEY_JAP2
, SPITZ_KEY_CANCEL
, SPITZ_KEY_OK
, SPITZ_KEY_MENU
, KEY_LEFT
, KEY_DOWN
, KEY_RIGHT
, 0, 0, 0, 0, 0, 0, 0 /* 97-112 */
62 static int spitz_strobes
[] = {
63 SPITZ_GPIO_KEY_STROBE0
,
64 SPITZ_GPIO_KEY_STROBE1
,
65 SPITZ_GPIO_KEY_STROBE2
,
66 SPITZ_GPIO_KEY_STROBE3
,
67 SPITZ_GPIO_KEY_STROBE4
,
68 SPITZ_GPIO_KEY_STROBE5
,
69 SPITZ_GPIO_KEY_STROBE6
,
70 SPITZ_GPIO_KEY_STROBE7
,
71 SPITZ_GPIO_KEY_STROBE8
,
72 SPITZ_GPIO_KEY_STROBE9
,
73 SPITZ_GPIO_KEY_STROBE10
,
76 static int spitz_senses
[] = {
77 SPITZ_GPIO_KEY_SENSE0
,
78 SPITZ_GPIO_KEY_SENSE1
,
79 SPITZ_GPIO_KEY_SENSE2
,
80 SPITZ_GPIO_KEY_SENSE3
,
81 SPITZ_GPIO_KEY_SENSE4
,
82 SPITZ_GPIO_KEY_SENSE5
,
83 SPITZ_GPIO_KEY_SENSE6
,
87 unsigned char keycode
[ARRAY_SIZE(spitzkbd_keycode
)];
88 struct input_dev
*input
;
92 struct timer_list timer
;
93 struct timer_list htimer
;
95 unsigned int suspended
;
96 unsigned long suspend_jiffies
;
99 #define KB_DISCHARGE_DELAY 10
100 #define KB_ACTIVATE_DELAY 10
102 /* Helper functions for reading the keyboard matrix
103 * Note: We should really be using pxa_gpio_mode to alter GPDR but it
104 * requires a function call per GPIO bit which is excessive
105 * when we need to access 11 bits at once, multiple times.
106 * These functions must be called within local_irq_save()/local_irq_restore()
109 static inline void spitzkbd_discharge_all(void)
112 GPCR0
= SPITZ_GPIO_G0_STROBE_BIT
;
113 GPDR0
&= ~SPITZ_GPIO_G0_STROBE_BIT
;
114 GPCR1
= SPITZ_GPIO_G1_STROBE_BIT
;
115 GPDR1
&= ~SPITZ_GPIO_G1_STROBE_BIT
;
116 GPCR2
= SPITZ_GPIO_G2_STROBE_BIT
;
117 GPDR2
&= ~SPITZ_GPIO_G2_STROBE_BIT
;
118 GPCR3
= SPITZ_GPIO_G3_STROBE_BIT
;
119 GPDR3
&= ~SPITZ_GPIO_G3_STROBE_BIT
;
122 static inline void spitzkbd_activate_all(void)
124 /* STROBE ALL -> High */
125 GPSR0
= SPITZ_GPIO_G0_STROBE_BIT
;
126 GPDR0
|= SPITZ_GPIO_G0_STROBE_BIT
;
127 GPSR1
= SPITZ_GPIO_G1_STROBE_BIT
;
128 GPDR1
|= SPITZ_GPIO_G1_STROBE_BIT
;
129 GPSR2
= SPITZ_GPIO_G2_STROBE_BIT
;
130 GPDR2
|= SPITZ_GPIO_G2_STROBE_BIT
;
131 GPSR3
= SPITZ_GPIO_G3_STROBE_BIT
;
132 GPDR3
|= SPITZ_GPIO_G3_STROBE_BIT
;
134 udelay(KB_DISCHARGE_DELAY
);
136 /* Clear any interrupts we may have triggered when altering the GPIO lines */
137 GEDR0
= SPITZ_GPIO_G0_SENSE_BIT
;
138 GEDR1
= SPITZ_GPIO_G1_SENSE_BIT
;
139 GEDR2
= SPITZ_GPIO_G2_SENSE_BIT
;
140 GEDR3
= SPITZ_GPIO_G3_SENSE_BIT
;
143 static inline void spitzkbd_activate_col(int col
)
145 int gpio
= spitz_strobes
[col
];
146 GPDR0
&= ~SPITZ_GPIO_G0_STROBE_BIT
;
147 GPDR1
&= ~SPITZ_GPIO_G1_STROBE_BIT
;
148 GPDR2
&= ~SPITZ_GPIO_G2_STROBE_BIT
;
149 GPDR3
&= ~SPITZ_GPIO_G3_STROBE_BIT
;
150 GPSR(gpio
) = GPIO_bit(gpio
);
151 GPDR(gpio
) |= GPIO_bit(gpio
);
154 static inline void spitzkbd_reset_col(int col
)
156 int gpio
= spitz_strobes
[col
];
157 GPDR0
&= ~SPITZ_GPIO_G0_STROBE_BIT
;
158 GPDR1
&= ~SPITZ_GPIO_G1_STROBE_BIT
;
159 GPDR2
&= ~SPITZ_GPIO_G2_STROBE_BIT
;
160 GPDR3
&= ~SPITZ_GPIO_G3_STROBE_BIT
;
161 GPCR(gpio
) = GPIO_bit(gpio
);
162 GPDR(gpio
) |= GPIO_bit(gpio
);
165 static inline int spitzkbd_get_row_status(int col
)
167 return ((GPLR0
>> 12) & 0x01) | ((GPLR0
>> 16) & 0x02)
168 | ((GPLR2
>> 25) & 0x04) | ((GPLR1
<< 1) & 0x08)
169 | ((GPLR1
>> 0) & 0x10) | ((GPLR1
>> 1) & 0x60);
173 * The spitz keyboard only generates interrupts when a key is pressed.
174 * When a key is pressed, we enable a timer which then scans the
175 * keyboard to detect when the key is released.
178 /* Scan the hardware keyboard and push any changes up through the input layer */
179 static void spitzkbd_scankeyboard(struct spitzkbd
*spitzkbd_data
, struct pt_regs
*regs
)
181 unsigned int row
, col
, rowd
;
183 unsigned int num_pressed
, pwrkey
= ((GPLR(SPITZ_GPIO_ON_KEY
) & GPIO_bit(SPITZ_GPIO_ON_KEY
)) != 0);
185 if (spitzkbd_data
->suspended
)
188 spin_lock_irqsave(&spitzkbd_data
->lock
, flags
);
190 input_regs(spitzkbd_data
->input
, regs
);
193 for (col
= 0; col
< KB_COLS
; col
++) {
195 * Discharge the output driver capacitatance
196 * in the keyboard matrix. (Yes it is significant..)
199 spitzkbd_discharge_all();
200 udelay(KB_DISCHARGE_DELAY
);
202 spitzkbd_activate_col(col
);
203 udelay(KB_ACTIVATE_DELAY
);
205 rowd
= spitzkbd_get_row_status(col
);
206 for (row
= 0; row
< KB_ROWS
; row
++) {
207 unsigned int scancode
, pressed
;
209 scancode
= SCANCODE(row
, col
);
210 pressed
= rowd
& KB_ROWMASK(row
);
212 input_report_key(spitzkbd_data
->input
, spitzkbd_data
->keycode
[scancode
], pressed
);
217 spitzkbd_reset_col(col
);
220 spitzkbd_activate_all();
222 input_report_key(spitzkbd_data
->input
, SPITZ_KEY_SYNC
, (GPLR(SPITZ_GPIO_SYNC
) & GPIO_bit(SPITZ_GPIO_SYNC
)) != 0 );
223 input_report_key(spitzkbd_data
->input
, KEY_SUSPEND
, pwrkey
);
225 if (pwrkey
&& time_after(jiffies
, spitzkbd_data
->suspend_jiffies
+ msecs_to_jiffies(1000))) {
226 input_event(spitzkbd_data
->input
, EV_PWR
, KEY_SUSPEND
, 1);
227 spitzkbd_data
->suspend_jiffies
= jiffies
;
230 input_sync(spitzkbd_data
->input
);
232 /* if any keys are pressed, enable the timer */
234 mod_timer(&spitzkbd_data
->timer
, jiffies
+ msecs_to_jiffies(100));
236 spin_unlock_irqrestore(&spitzkbd_data
->lock
, flags
);
240 * spitz keyboard interrupt handler.
242 static irqreturn_t
spitzkbd_interrupt(int irq
, void *dev_id
, struct pt_regs
*regs
)
244 struct spitzkbd
*spitzkbd_data
= dev_id
;
246 if (!timer_pending(&spitzkbd_data
->timer
)) {
247 /** wait chattering delay **/
249 spitzkbd_scankeyboard(spitzkbd_data
, regs
);
256 * spitz timer checking for released keys
258 static void spitzkbd_timer_callback(unsigned long data
)
260 struct spitzkbd
*spitzkbd_data
= (struct spitzkbd
*) data
;
262 spitzkbd_scankeyboard(spitzkbd_data
, NULL
);
266 * The hinge switches generate an interrupt.
267 * We debounce the switches and pass them to the input system.
270 static irqreturn_t
spitzkbd_hinge_isr(int irq
, void *dev_id
, struct pt_regs
*regs
)
272 struct spitzkbd
*spitzkbd_data
= dev_id
;
274 if (!timer_pending(&spitzkbd_data
->htimer
))
275 mod_timer(&spitzkbd_data
->htimer
, jiffies
+ msecs_to_jiffies(HINGE_SCAN_INTERVAL
));
280 #define HINGE_STABLE_COUNT 2
281 static int sharpsl_hinge_state
;
282 static int hinge_count
;
284 static void spitzkbd_hinge_timer(unsigned long data
)
286 struct spitzkbd
*spitzkbd_data
= (struct spitzkbd
*) data
;
290 state
= GPLR(SPITZ_GPIO_SWA
) & (GPIO_bit(SPITZ_GPIO_SWA
)|GPIO_bit(SPITZ_GPIO_SWB
));
291 if (state
!= sharpsl_hinge_state
) {
293 sharpsl_hinge_state
= state
;
294 } else if (hinge_count
< HINGE_STABLE_COUNT
) {
298 if (hinge_count
>= HINGE_STABLE_COUNT
) {
299 spin_lock_irqsave(&spitzkbd_data
->lock
, flags
);
301 input_report_switch(spitzkbd_data
->input
, SW_0
, ((GPLR(SPITZ_GPIO_SWA
) & GPIO_bit(SPITZ_GPIO_SWA
)) != 0));
302 input_report_switch(spitzkbd_data
->input
, SW_1
, ((GPLR(SPITZ_GPIO_SWB
) & GPIO_bit(SPITZ_GPIO_SWB
)) != 0));
303 input_sync(spitzkbd_data
->input
);
305 spin_unlock_irqrestore(&spitzkbd_data
->lock
, flags
);
307 mod_timer(&spitzkbd_data
->htimer
, jiffies
+ msecs_to_jiffies(HINGE_SCAN_INTERVAL
));
312 static int spitzkbd_suspend(struct platform_device
*dev
, pm_message_t state
)
315 struct spitzkbd
*spitzkbd
= platform_get_drvdata(dev
);
316 spitzkbd
->suspended
= 1;
318 /* Set Strobe lines as inputs - *except* strobe line 0 leave this
319 enabled so we can detect a power button press for resume */
320 for (i
= 1; i
< SPITZ_KEY_STROBE_NUM
; i
++)
321 pxa_gpio_mode(spitz_strobes
[i
] | GPIO_IN
);
326 static int spitzkbd_resume(struct platform_device
*dev
)
329 struct spitzkbd
*spitzkbd
= platform_get_drvdata(dev
);
331 for (i
= 0; i
< SPITZ_KEY_STROBE_NUM
; i
++)
332 pxa_gpio_mode(spitz_strobes
[i
] | GPIO_OUT
| GPIO_DFLT_HIGH
);
334 /* Upon resume, ignore the suspend key for a short while */
335 spitzkbd
->suspend_jiffies
= jiffies
;
336 spitzkbd
->suspended
= 0;
341 #define spitzkbd_suspend NULL
342 #define spitzkbd_resume NULL
345 static int __init
spitzkbd_probe(struct platform_device
*dev
)
347 struct spitzkbd
*spitzkbd
;
348 struct input_dev
*input_dev
;
351 spitzkbd
= kzalloc(sizeof(struct spitzkbd
), GFP_KERNEL
);
355 input_dev
= input_allocate_device();
361 platform_set_drvdata(dev
, spitzkbd
);
362 strcpy(spitzkbd
->phys
, "spitzkbd/input0");
364 spin_lock_init(&spitzkbd
->lock
);
366 /* Init Keyboard rescan timer */
367 init_timer(&spitzkbd
->timer
);
368 spitzkbd
->timer
.function
= spitzkbd_timer_callback
;
369 spitzkbd
->timer
.data
= (unsigned long) spitzkbd
;
371 /* Init Hinge Timer */
372 init_timer(&spitzkbd
->htimer
);
373 spitzkbd
->htimer
.function
= spitzkbd_hinge_timer
;
374 spitzkbd
->htimer
.data
= (unsigned long) spitzkbd
;
376 spitzkbd
->suspend_jiffies
= jiffies
;
378 spitzkbd
->input
= input_dev
;
380 input_dev
->private = spitzkbd
;
381 input_dev
->name
= "Spitz Keyboard";
382 input_dev
->phys
= spitzkbd
->phys
;
383 input_dev
->cdev
.dev
= &dev
->dev
;
385 input_dev
->id
.bustype
= BUS_HOST
;
386 input_dev
->id
.vendor
= 0x0001;
387 input_dev
->id
.product
= 0x0001;
388 input_dev
->id
.version
= 0x0100;
390 input_dev
->evbit
[0] = BIT(EV_KEY
) | BIT(EV_REP
) | BIT(EV_PWR
) | BIT(EV_SW
);
391 input_dev
->keycode
= spitzkbd
->keycode
;
392 input_dev
->keycodesize
= sizeof(unsigned char);
393 input_dev
->keycodemax
= ARRAY_SIZE(spitzkbd_keycode
);
395 memcpy(spitzkbd
->keycode
, spitzkbd_keycode
, sizeof(spitzkbd
->keycode
));
396 for (i
= 0; i
< ARRAY_SIZE(spitzkbd_keycode
); i
++)
397 set_bit(spitzkbd
->keycode
[i
], input_dev
->keybit
);
398 clear_bit(0, input_dev
->keybit
);
399 set_bit(SW_0
, input_dev
->swbit
);
400 set_bit(SW_1
, input_dev
->swbit
);
402 input_register_device(input_dev
);
404 mod_timer(&spitzkbd
->htimer
, jiffies
+ msecs_to_jiffies(HINGE_SCAN_INTERVAL
));
406 /* Setup sense interrupts - RisingEdge Detect, sense lines as inputs */
407 for (i
= 0; i
< SPITZ_KEY_SENSE_NUM
; i
++) {
408 pxa_gpio_mode(spitz_senses
[i
] | GPIO_IN
);
409 if (request_irq(IRQ_GPIO(spitz_senses
[i
]), spitzkbd_interrupt
,
410 SA_INTERRUPT
, "Spitzkbd Sense", spitzkbd
))
411 printk(KERN_WARNING
"spitzkbd: Can't get Sense IRQ: %d!\n", i
);
413 set_irq_type(IRQ_GPIO(spitz_senses
[i
]),IRQT_RISING
);
416 /* Set Strobe lines as outputs - set high */
417 for (i
= 0; i
< SPITZ_KEY_STROBE_NUM
; i
++)
418 pxa_gpio_mode(spitz_strobes
[i
] | GPIO_OUT
| GPIO_DFLT_HIGH
);
420 pxa_gpio_mode(SPITZ_GPIO_SYNC
| GPIO_IN
);
421 pxa_gpio_mode(SPITZ_GPIO_ON_KEY
| GPIO_IN
);
422 pxa_gpio_mode(SPITZ_GPIO_SWA
| GPIO_IN
);
423 pxa_gpio_mode(SPITZ_GPIO_SWB
| GPIO_IN
);
425 request_irq(SPITZ_IRQ_GPIO_SYNC
, spitzkbd_interrupt
, SA_INTERRUPT
, "Spitzkbd Sync", spitzkbd
);
426 request_irq(SPITZ_IRQ_GPIO_ON_KEY
, spitzkbd_interrupt
, SA_INTERRUPT
, "Spitzkbd PwrOn", spitzkbd
);
427 request_irq(SPITZ_IRQ_GPIO_SWA
, spitzkbd_hinge_isr
, SA_INTERRUPT
, "Spitzkbd SWA", spitzkbd
);
428 request_irq(SPITZ_IRQ_GPIO_SWB
, spitzkbd_hinge_isr
, SA_INTERRUPT
, "Spitzkbd SWB", spitzkbd
);
430 set_irq_type(SPITZ_IRQ_GPIO_SYNC
, IRQT_BOTHEDGE
);
431 set_irq_type(SPITZ_IRQ_GPIO_ON_KEY
, IRQT_BOTHEDGE
);
432 set_irq_type(SPITZ_IRQ_GPIO_SWA
, IRQT_BOTHEDGE
);
433 set_irq_type(SPITZ_IRQ_GPIO_SWB
, IRQT_BOTHEDGE
);
435 printk(KERN_INFO
"input: Spitz Keyboard Registered\n");
440 static int spitzkbd_remove(struct platform_device
*dev
)
443 struct spitzkbd
*spitzkbd
= platform_get_drvdata(dev
);
445 for (i
= 0; i
< SPITZ_KEY_SENSE_NUM
; i
++)
446 free_irq(IRQ_GPIO(spitz_senses
[i
]), spitzkbd
);
448 free_irq(SPITZ_IRQ_GPIO_SYNC
, spitzkbd
);
449 free_irq(SPITZ_IRQ_GPIO_ON_KEY
, spitzkbd
);
450 free_irq(SPITZ_IRQ_GPIO_SWA
, spitzkbd
);
451 free_irq(SPITZ_IRQ_GPIO_SWB
, spitzkbd
);
453 del_timer_sync(&spitzkbd
->htimer
);
454 del_timer_sync(&spitzkbd
->timer
);
456 input_unregister_device(spitzkbd
->input
);
463 static struct platform_driver spitzkbd_driver
= {
464 .probe
= spitzkbd_probe
,
465 .remove
= spitzkbd_remove
,
466 .suspend
= spitzkbd_suspend
,
467 .resume
= spitzkbd_resume
,
469 .name
= "spitz-keyboard",
473 static int __devinit
spitzkbd_init(void)
475 return platform_driver_register(&spitzkbd_driver
);
478 static void __exit
spitzkbd_exit(void)
480 platform_driver_unregister(&spitzkbd_driver
);
483 module_init(spitzkbd_init
);
484 module_exit(spitzkbd_exit
);
486 MODULE_AUTHOR("Richard Purdie <rpurdie@rpsys.net>");
487 MODULE_DESCRIPTION("Spitz Keyboard Driver");
488 MODULE_LICENSE("GPLv2");