c038b7c7eff0e8ea20f009b83eb4b1658040a229
[linux-3.10.git] / arch / m68k / atari / atakeyb.c
1 /*
2  * Atari Keyboard driver for 680x0 Linux
3  *
4  * This file is subject to the terms and conditions of the GNU General Public
5  * License.  See the file COPYING in the main directory of this archive
6  * for more details.
7  */
8
9 /*
10  * Atari support by Robert de Vries
11  * enhanced by Bjoern Brauel and Roman Hodek
12  *
13  * 2.6 and input cleanup (removed autorepeat stuff) for 2.6.21
14  * 06/07 Michael Schmitz
15  */
16
17 #include <linux/module.h>
18 #include <linux/sched.h>
19 #include <linux/kernel.h>
20 #include <linux/interrupt.h>
21 #include <linux/errno.h>
22 #include <linux/keyboard.h>
23 #include <linux/delay.h>
24 #include <linux/timer.h>
25 #include <linux/kd.h>
26 #include <linux/random.h>
27 #include <linux/init.h>
28 #include <linux/kbd_kern.h>
29
30 #include <asm/atariints.h>
31 #include <asm/atarihw.h>
32 #include <asm/atarikb.h>
33 #include <asm/atari_joystick.h>
34 #include <asm/irq.h>
35
36 extern unsigned int keymap_count;
37
38 /* Hook for MIDI serial driver */
39 void (*atari_MIDI_interrupt_hook) (void);
40 /* Hook for mouse driver */
41 void (*atari_mouse_interrupt_hook) (char *);
42 /* Hook for keyboard inputdev  driver */
43 void (*atari_input_keyboard_interrupt_hook) (unsigned char, char);
44 /* Hook for mouse inputdev  driver */
45 void (*atari_input_mouse_interrupt_hook) (char *);
46 EXPORT_SYMBOL(atari_mouse_interrupt_hook);
47 EXPORT_SYMBOL(atari_input_keyboard_interrupt_hook);
48 EXPORT_SYMBOL(atari_input_mouse_interrupt_hook);
49
50 /* variables for IKBD self test: */
51
52 /* state: 0: off; >0: in progress; >1: 0xf1 received */
53 static volatile int ikbd_self_test;
54 /* timestamp when last received a char */
55 static volatile unsigned long self_test_last_rcv;
56 /* bitmap of keys reported as broken */
57 static unsigned long broken_keys[128/(sizeof(unsigned long)*8)] = { 0, };
58
59 #define BREAK_MASK      (0x80)
60
61 /*
62  * ++roman: The following changes were applied manually:
63  *
64  *  - The Alt (= Meta) key works in combination with Shift and
65  *    Control, e.g. Alt+Shift+a sends Meta-A (0xc1), Alt+Control+A sends
66  *    Meta-Ctrl-A (0x81) ...
67  *
68  *  - The parentheses on the keypad send '(' and ')' with all
69  *    modifiers (as would do e.g. keypad '+'), but they cannot be used as
70  *    application keys (i.e. sending Esc O c).
71  *
72  *  - HELP and UNDO are mapped to be F21 and F24, resp, that send the
73  *    codes "\E[M" and "\E[P". (This is better than the old mapping to
74  *    F11 and F12, because these codes are on Shift+F1/2 anyway.) This
75  *    way, applications that allow their own keyboard mappings
76  *    (e.g. tcsh, X Windows) can be configured to use them in the way
77  *    the label suggests (providing help or undoing).
78  *
79  *  - Console switching is done with Alt+Fx (consoles 1..10) and
80  *    Shift+Alt+Fx (consoles 11..20).
81  *
82  *  - The misc. special function implemented in the kernel are mapped
83  *    to the following key combinations:
84  *
85  *      ClrHome          -> Home/Find
86  *      Shift + ClrHome  -> End/Select
87  *      Shift + Up       -> Page Up
88  *      Shift + Down     -> Page Down
89  *      Alt + Help       -> show system status
90  *      Shift + Help     -> show memory info
91  *      Ctrl + Help      -> show registers
92  *      Ctrl + Alt + Del -> Reboot
93  *      Alt + Undo       -> switch to last console
94  *      Shift + Undo     -> send interrupt
95  *      Alt + Insert     -> stop/start output (same as ^S/^Q)
96  *      Alt + Up         -> Scroll back console (if implemented)
97  *      Alt + Down       -> Scroll forward console (if implemented)
98  *      Alt + CapsLock   -> NumLock
99  *
100  * ++Andreas:
101  *
102  *  - Help mapped to K_HELP
103  *  - Undo mapped to K_UNDO (= K_F246)
104  *  - Keypad Left/Right Parenthesis mapped to new K_PPAREN[LR]
105  */
106
107 typedef enum kb_state_t {
108         KEYBOARD, AMOUSE, RMOUSE, JOYSTICK, CLOCK, RESYNC
109 } KB_STATE_T;
110
111 #define IS_SYNC_CODE(sc)        ((sc) >= 0x04 && (sc) <= 0xfb)
112
113 typedef struct keyboard_state {
114         unsigned char buf[6];
115         int len;
116         KB_STATE_T state;
117 } KEYBOARD_STATE;
118
119 KEYBOARD_STATE kb_state;
120
121 /* ++roman: If a keyboard overrun happened, we can't tell in general how much
122  * bytes have been lost and in which state of the packet structure we are now.
123  * This usually causes keyboards bytes to be interpreted as mouse movements
124  * and vice versa, which is very annoying. It seems better to throw away some
125  * bytes (that are usually mouse bytes) than to misinterpret them. Therefor I
126  * introduced the RESYNC state for IKBD data. In this state, the bytes up to
127  * one that really looks like a key event (0x04..0xf2) or the start of a mouse
128  * packet (0xf8..0xfb) are thrown away, but at most 2 bytes. This at least
129  * speeds up the resynchronization of the event structure, even if maybe a
130  * mouse movement is lost. However, nothing is perfect. For bytes 0x01..0x03,
131  * it's really hard to decide whether they're mouse or keyboard bytes. Since
132  * overruns usually occur when moving the Atari mouse rapidly, they're seen as
133  * mouse bytes here. If this is wrong, only a make code of the keyboard gets
134  * lost, which isn't too bad. Loosing a break code would be disastrous,
135  * because then the keyboard repeat strikes...
136  */
137
138 static irqreturn_t atari_keyboard_interrupt(int irq, void *dummy)
139 {
140         u_char acia_stat;
141         int scancode;
142         int break_flag;
143
144 repeat:
145         if (acia.mid_ctrl & ACIA_IRQ)
146                 if (atari_MIDI_interrupt_hook)
147                         atari_MIDI_interrupt_hook();
148         acia_stat = acia.key_ctrl;
149         /* check out if the interrupt came from this ACIA */
150         if (!((acia_stat | acia.mid_ctrl) & ACIA_IRQ))
151                 return IRQ_HANDLED;
152
153         if (acia_stat & ACIA_OVRN) {
154                 /* a very fast typist or a slow system, give a warning */
155                 /* ...happens often if interrupts were disabled for too long */
156                 printk(KERN_DEBUG "Keyboard overrun\n");
157                 scancode = acia.key_data;
158                 if (ikbd_self_test)
159                         /* During self test, don't do resyncing, just process the code */
160                         goto interpret_scancode;
161                 else if (IS_SYNC_CODE(scancode)) {
162                         /* This code seem already to be the start of a new packet or a
163                          * single scancode */
164                         kb_state.state = KEYBOARD;
165                         goto interpret_scancode;
166                 } else {
167                         /* Go to RESYNC state and skip this byte */
168                         kb_state.state = RESYNC;
169                         kb_state.len = 1;       /* skip max. 1 another byte */
170                         goto repeat;
171                 }
172         }
173
174         if (acia_stat & ACIA_RDRF) {
175                 /* received a character */
176                 scancode = acia.key_data;       /* get it or reset the ACIA, I'll get it! */
177                 tasklet_schedule(&keyboard_tasklet);
178         interpret_scancode:
179                 switch (kb_state.state) {
180                 case KEYBOARD:
181                         switch (scancode) {
182                         case 0xF7:
183                                 kb_state.state = AMOUSE;
184                                 kb_state.len = 0;
185                                 break;
186
187                         case 0xF8:
188                         case 0xF9:
189                         case 0xFA:
190                         case 0xFB:
191                                 kb_state.state = RMOUSE;
192                                 kb_state.len = 1;
193                                 kb_state.buf[0] = scancode;
194                                 break;
195
196                         case 0xFC:
197                                 kb_state.state = CLOCK;
198                                 kb_state.len = 0;
199                                 break;
200
201                         case 0xFE:
202                         case 0xFF:
203                                 kb_state.state = JOYSTICK;
204                                 kb_state.len = 1;
205                                 kb_state.buf[0] = scancode;
206                                 break;
207
208                         case 0xF1:
209                                 /* during self-test, note that 0xf1 received */
210                                 if (ikbd_self_test) {
211                                         ++ikbd_self_test;
212                                         self_test_last_rcv = jiffies;
213                                         break;
214                                 }
215                                 /* FALL THROUGH */
216
217                         default:
218                                 break_flag = scancode & BREAK_MASK;
219                                 scancode &= ~BREAK_MASK;
220                                 if (ikbd_self_test) {
221                                         /* Scancodes sent during the self-test stand for broken
222                                          * keys (keys being down). The code *should* be a break
223                                          * code, but nevertheless some AT keyboard interfaces send
224                                          * make codes instead. Therefore, simply ignore
225                                          * break_flag...
226                                          */
227                                         int keyval, keytyp;
228
229                                         set_bit(scancode, broken_keys);
230                                         self_test_last_rcv = jiffies;
231                                         /* new Linux scancodes; approx. */
232                                         keyval = scancode;
233                                         keytyp = KTYP(keyval) - 0xf0;
234                                         keyval = KVAL(keyval);
235
236                                         printk(KERN_WARNING "Key with scancode %d ", scancode);
237                                         if (keytyp == KT_LATIN || keytyp == KT_LETTER) {
238                                                 if (keyval < ' ')
239                                                         printk("('^%c') ", keyval + '@');
240                                                 else
241                                                         printk("('%c') ", keyval);
242                                         }
243                                         printk("is broken -- will be ignored.\n");
244                                         break;
245                                 } else if (test_bit(scancode, broken_keys))
246                                         break;
247
248                                 if (atari_input_keyboard_interrupt_hook)
249                                         atari_input_keyboard_interrupt_hook((unsigned char)scancode, !break_flag);
250                                 break;
251                         }
252                         break;
253
254                 case AMOUSE:
255                         kb_state.buf[kb_state.len++] = scancode;
256                         if (kb_state.len == 5) {
257                                 kb_state.state = KEYBOARD;
258                                 /* not yet used */
259                                 /* wake up someone waiting for this */
260                         }
261                         break;
262
263                 case RMOUSE:
264                         kb_state.buf[kb_state.len++] = scancode;
265                         if (kb_state.len == 3) {
266                                 kb_state.state = KEYBOARD;
267                                 if (atari_mouse_interrupt_hook)
268                                         atari_mouse_interrupt_hook(kb_state.buf);
269                         }
270                         break;
271
272                 case JOYSTICK:
273                         kb_state.buf[1] = scancode;
274                         kb_state.state = KEYBOARD;
275 #ifdef FIXED_ATARI_JOYSTICK
276                         atari_joystick_interrupt(kb_state.buf);
277 #endif
278                         break;
279
280                 case CLOCK:
281                         kb_state.buf[kb_state.len++] = scancode;
282                         if (kb_state.len == 6) {
283                                 kb_state.state = KEYBOARD;
284                                 /* wake up someone waiting for this.
285                                    But will this ever be used, as Linux keeps its own time.
286                                    Perhaps for synchronization purposes? */
287                                 /* wake_up_interruptible(&clock_wait); */
288                         }
289                         break;
290
291                 case RESYNC:
292                         if (kb_state.len <= 0 || IS_SYNC_CODE(scancode)) {
293                                 kb_state.state = KEYBOARD;
294                                 goto interpret_scancode;
295                         }
296                         kb_state.len--;
297                         break;
298                 }
299         }
300
301 #if 0
302         if (acia_stat & ACIA_CTS)
303                 /* cannot happen */;
304 #endif
305
306         if (acia_stat & (ACIA_FE | ACIA_PE)) {
307                 printk("Error in keyboard communication\n");
308         }
309
310         /* handle_scancode() can take a lot of time, so check again if
311          * some character arrived
312          */
313         goto repeat;
314 }
315
316 /*
317  * I write to the keyboard without using interrupts, I poll instead.
318  * This takes for the maximum length string allowed (7) at 7812.5 baud
319  * 8 data 1 start 1 stop bit: 9.0 ms
320  * If this takes too long for normal operation, interrupt driven writing
321  * is the solution. (I made a feeble attempt in that direction but I
322  * kept it simple for now.)
323  */
324 void ikbd_write(const char *str, int len)
325 {
326         u_char acia_stat;
327
328         if ((len < 1) || (len > 7))
329                 panic("ikbd: maximum string length exceeded");
330         while (len) {
331                 acia_stat = acia.key_ctrl;
332                 if (acia_stat & ACIA_TDRE) {
333                         acia.key_data = *str++;
334                         len--;
335                 }
336         }
337 }
338
339 /* Reset (without touching the clock) */
340 void ikbd_reset(void)
341 {
342         static const char cmd[2] = { 0x80, 0x01 };
343
344         ikbd_write(cmd, 2);
345
346         /*
347          * if all's well code 0xF1 is returned, else the break codes of
348          * all keys making contact
349          */
350 }
351
352 /* Set mouse button action */
353 void ikbd_mouse_button_action(int mode)
354 {
355         char cmd[2] = { 0x07, mode };
356
357         ikbd_write(cmd, 2);
358 }
359
360 /* Set relative mouse position reporting */
361 void ikbd_mouse_rel_pos(void)
362 {
363         static const char cmd[1] = { 0x08 };
364
365         ikbd_write(cmd, 1);
366 }
367 EXPORT_SYMBOL(ikbd_mouse_rel_pos);
368
369 /* Set absolute mouse position reporting */
370 void ikbd_mouse_abs_pos(int xmax, int ymax)
371 {
372         char cmd[5] = { 0x09, xmax>>8, xmax&0xFF, ymax>>8, ymax&0xFF };
373
374         ikbd_write(cmd, 5);
375 }
376
377 /* Set mouse keycode mode */
378 void ikbd_mouse_kbd_mode(int dx, int dy)
379 {
380         char cmd[3] = { 0x0A, dx, dy };
381
382         ikbd_write(cmd, 3);
383 }
384
385 /* Set mouse threshold */
386 void ikbd_mouse_thresh(int x, int y)
387 {
388         char cmd[3] = { 0x0B, x, y };
389
390         ikbd_write(cmd, 3);
391 }
392 EXPORT_SYMBOL(ikbd_mouse_thresh);
393
394 /* Set mouse scale */
395 void ikbd_mouse_scale(int x, int y)
396 {
397         char cmd[3] = { 0x0C, x, y };
398
399         ikbd_write(cmd, 3);
400 }
401
402 /* Interrogate mouse position */
403 void ikbd_mouse_pos_get(int *x, int *y)
404 {
405         static const char cmd[1] = { 0x0D };
406
407         ikbd_write(cmd, 1);
408
409         /* wait for returning bytes */
410 }
411
412 /* Load mouse position */
413 void ikbd_mouse_pos_set(int x, int y)
414 {
415         char cmd[6] = { 0x0E, 0x00, x>>8, x&0xFF, y>>8, y&0xFF };
416
417         ikbd_write(cmd, 6);
418 }
419
420 /* Set Y=0 at bottom */
421 void ikbd_mouse_y0_bot(void)
422 {
423         static const char cmd[1] = { 0x0F };
424
425         ikbd_write(cmd, 1);
426 }
427
428 /* Set Y=0 at top */
429 void ikbd_mouse_y0_top(void)
430 {
431         static const char cmd[1] = { 0x10 };
432
433         ikbd_write(cmd, 1);
434 }
435 EXPORT_SYMBOL(ikbd_mouse_y0_top);
436
437 /* Resume */
438 void ikbd_resume(void)
439 {
440         static const char cmd[1] = { 0x11 };
441
442         ikbd_write(cmd, 1);
443 }
444
445 /* Disable mouse */
446 void ikbd_mouse_disable(void)
447 {
448         static const char cmd[1] = { 0x12 };
449
450         ikbd_write(cmd, 1);
451 }
452 EXPORT_SYMBOL(ikbd_mouse_disable);
453
454 /* Pause output */
455 void ikbd_pause(void)
456 {
457         static const char cmd[1] = { 0x13 };
458
459         ikbd_write(cmd, 1);
460 }
461
462 /* Set joystick event reporting */
463 void ikbd_joystick_event_on(void)
464 {
465         static const char cmd[1] = { 0x14 };
466
467         ikbd_write(cmd, 1);
468 }
469
470 /* Set joystick interrogation mode */
471 void ikbd_joystick_event_off(void)
472 {
473         static const char cmd[1] = { 0x15 };
474
475         ikbd_write(cmd, 1);
476 }
477
478 /* Joystick interrogation */
479 void ikbd_joystick_get_state(void)
480 {
481         static const char cmd[1] = { 0x16 };
482
483         ikbd_write(cmd, 1);
484 }
485
486 #if 0
487 /* This disables all other ikbd activities !!!! */
488 /* Set joystick monitoring */
489 void ikbd_joystick_monitor(int rate)
490 {
491         static const char cmd[2] = { 0x17, rate };
492
493         ikbd_write(cmd, 2);
494
495         kb_state.state = JOYSTICK_MONITOR;
496 }
497 #endif
498
499 /* some joystick routines not in yet (0x18-0x19) */
500
501 /* Disable joysticks */
502 void ikbd_joystick_disable(void)
503 {
504         static const char cmd[1] = { 0x1A };
505
506         ikbd_write(cmd, 1);
507 }
508
509 /* Time-of-day clock set */
510 void ikbd_clock_set(int year, int month, int day, int hour, int minute, int second)
511 {
512         char cmd[7] = { 0x1B, year, month, day, hour, minute, second };
513
514         ikbd_write(cmd, 7);
515 }
516
517 /* Interrogate time-of-day clock */
518 void ikbd_clock_get(int *year, int *month, int *day, int *hour, int *minute, int second)
519 {
520         static const char cmd[1] = { 0x1C };
521
522         ikbd_write(cmd, 1);
523 }
524
525 /* Memory load */
526 void ikbd_mem_write(int address, int size, char *data)
527 {
528         panic("Attempt to write data into keyboard memory");
529 }
530
531 /* Memory read */
532 void ikbd_mem_read(int address, char data[6])
533 {
534         char cmd[3] = { 0x21, address>>8, address&0xFF };
535
536         ikbd_write(cmd, 3);
537
538         /* receive data and put it in data */
539 }
540
541 /* Controller execute */
542 void ikbd_exec(int address)
543 {
544         char cmd[3] = { 0x22, address>>8, address&0xFF };
545
546         ikbd_write(cmd, 3);
547 }
548
549 /* Status inquiries (0x87-0x9A) not yet implemented */
550
551 /* Set the state of the caps lock led. */
552 void atari_kbd_leds(unsigned int leds)
553 {
554         char cmd[6] = {32, 0, 4, 1, 254 + ((leds & 4) != 0), 0};
555
556         ikbd_write(cmd, 6);
557 }
558
559 /*
560  * The original code sometimes left the interrupt line of
561  * the ACIAs low forever. I hope, it is fixed now.
562  *
563  * Martin Rogge, 20 Aug 1995
564  */
565
566 static int atari_keyb_done = 0;
567
568 int atari_keyb_init(void)
569 {
570         if (atari_keyb_done)
571                 return 0;
572
573         kb_state.state = KEYBOARD;
574         kb_state.len = 0;
575
576         request_irq(IRQ_MFP_ACIA, atari_keyboard_interrupt, IRQ_TYPE_SLOW,
577                     "keyboard/mouse/MIDI", atari_keyboard_interrupt);
578
579         atari_turnoff_irq(IRQ_MFP_ACIA);
580         do {
581                 /* reset IKBD ACIA */
582                 acia.key_ctrl = ACIA_RESET |
583                                 ((atari_switches & ATARI_SWITCH_IKBD) ?
584                                  ACIA_RHTID : 0);
585                 (void)acia.key_ctrl;
586                 (void)acia.key_data;
587
588                 /* reset MIDI ACIA */
589                 acia.mid_ctrl = ACIA_RESET |
590                                 ((atari_switches & ATARI_SWITCH_MIDI) ?
591                                  ACIA_RHTID : 0);
592                 (void)acia.mid_ctrl;
593                 (void)acia.mid_data;
594
595                 /* divide 500kHz by 64 gives 7812.5 baud */
596                 /* 8 data no parity 1 start 1 stop bit */
597                 /* receive interrupt enabled */
598                 /* RTS low (except if switch selected), transmit interrupt disabled */
599                 acia.key_ctrl = (ACIA_DIV64|ACIA_D8N1S|ACIA_RIE) |
600                                 ((atari_switches & ATARI_SWITCH_IKBD) ?
601                                  ACIA_RHTID : ACIA_RLTID);
602
603                 acia.mid_ctrl = ACIA_DIV16 | ACIA_D8N1S |
604                                 ((atari_switches & ATARI_SWITCH_MIDI) ?
605                                  ACIA_RHTID : 0);
606
607         /* make sure the interrupt line is up */
608         } while ((mfp.par_dt_reg & 0x10) == 0);
609
610         /* enable ACIA Interrupts */
611         mfp.active_edge &= ~0x10;
612         atari_turnon_irq(IRQ_MFP_ACIA);
613
614         ikbd_self_test = 1;
615         ikbd_reset();
616         /* wait for a period of inactivity (here: 0.25s), then assume the IKBD's
617          * self-test is finished */
618         self_test_last_rcv = jiffies;
619         while (time_before(jiffies, self_test_last_rcv + HZ/4))
620                 barrier();
621         /* if not incremented: no 0xf1 received */
622         if (ikbd_self_test == 1)
623                 printk(KERN_ERR "WARNING: keyboard self test failed!\n");
624         ikbd_self_test = 0;
625
626         ikbd_mouse_disable();
627         ikbd_joystick_disable();
628
629 #ifdef FIXED_ATARI_JOYSTICK
630         atari_joystick_init();
631 #endif
632
633         // flag init done
634         atari_keyb_done = 1;
635         return 0;
636 }
637 EXPORT_SYMBOL_GPL(atari_keyb_init);