3 * John W. Linville, linville@tuxdriver.com
5 * Modified from code for support of MIP405 and PIP405 boards. Previous
9 * Denis Peter, MPL AG Switzerland, d.peter@mpl.ch
11 * See file CREDITS for list of people who contributed to this
14 * This program is free software; you can redistribute it and/or
15 * modify it under the terms of the GNU General Public License as
16 * published by the Free Software Foundation; either version 2 of
17 * the License, or (at your option) any later version.
19 * This program is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU General Public License for more details.
24 * You should have received a copy of the GNU General Public License
25 * along with this program; if not, write to the Free Software
26 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
30 * Source partly derived from:
31 * linux/drivers/char/pc_keyb.c
36 #include <asm/processor.h>
41 unsigned char kbd_read_status(void);
42 unsigned char kbd_read_input(void);
43 void kbd_send_data(unsigned char data);
44 void i8259_mask_irq(unsigned int irq);
45 void i8259_unmask_irq(unsigned int irq);
47 /* used only by send_data - set by keyboard_interrupt */
53 #define PRINTF(fmt,args...) printf (fmt ,##args)
55 #define PRINTF(fmt,args...)
58 #define KBD_STAT_KOBF 0x01
59 #define KBD_STAT_IBF 0x02
60 #define KBD_STAT_SYS 0x04
61 #define KBD_STAT_CD 0x08
62 #define KBD_STAT_LOCK 0x10
63 #define KBD_STAT_MOBF 0x20
64 #define KBD_STAT_TI_OUT 0x40
65 #define KBD_STAT_PARERR 0x80
67 #define KBD_INIT_TIMEOUT 2000 /* Timeout in ms for initializing the keyboard */
68 #define KBC_TIMEOUT 250 /* Timeout in ms for sending to keyboard controller */
69 #define KBD_TIMEOUT 2000 /* Timeout in ms for keyboard command acknowledge */
71 * Keyboard Controller Commands
74 #define KBD_CCMD_READ_MODE 0x20 /* Read mode bits */
75 #define KBD_CCMD_WRITE_MODE 0x60 /* Write mode bits */
76 #define KBD_CCMD_GET_VERSION 0xA1 /* Get controller version */
77 #define KBD_CCMD_MOUSE_DISABLE 0xA7 /* Disable mouse interface */
78 #define KBD_CCMD_MOUSE_ENABLE 0xA8 /* Enable mouse interface */
79 #define KBD_CCMD_TEST_MOUSE 0xA9 /* Mouse interface test */
80 #define KBD_CCMD_SELF_TEST 0xAA /* Controller self test */
81 #define KBD_CCMD_KBD_TEST 0xAB /* Keyboard interface test */
82 #define KBD_CCMD_KBD_DISABLE 0xAD /* Keyboard interface disable */
83 #define KBD_CCMD_KBD_ENABLE 0xAE /* Keyboard interface enable */
84 #define KBD_CCMD_WRITE_AUX_OBUF 0xD3 /* Write to output buffer as if
85 initiated by the auxiliary device */
86 #define KBD_CCMD_WRITE_MOUSE 0xD4 /* Write the following byte to the mouse */
92 #define KBD_CMD_SET_LEDS 0xED /* Set keyboard leds */
93 #define KBD_CMD_SET_RATE 0xF3 /* Set typematic rate */
94 #define KBD_CMD_ENABLE 0xF4 /* Enable scanning */
95 #define KBD_CMD_DISABLE 0xF5 /* Disable scanning */
96 #define KBD_CMD_RESET 0xFF /* Reset */
102 #define KBD_REPLY_POR 0xAA /* Power on reset */
103 #define KBD_REPLY_ACK 0xFA /* Command ACK */
104 #define KBD_REPLY_RESEND 0xFE /* Command NACK, send the cmd again */
107 * Status Register Bits
110 #define KBD_STAT_OBF 0x01 /* Keyboard output buffer full */
111 #define KBD_STAT_IBF 0x02 /* Keyboard input buffer full */
112 #define KBD_STAT_SELFTEST 0x04 /* Self test successful */
113 #define KBD_STAT_CMD 0x08 /* Last write was a command write (0=data) */
114 #define KBD_STAT_UNLOCKED 0x10 /* Zero if keyboard locked */
115 #define KBD_STAT_MOUSE_OBF 0x20 /* Mouse output buffer full */
116 #define KBD_STAT_GTO 0x40 /* General receive/xmit timeout */
117 #define KBD_STAT_PERR 0x80 /* Parity error */
119 #define AUX_STAT_OBF (KBD_STAT_OBF | KBD_STAT_MOUSE_OBF)
122 * Controller Mode Register Bits
125 #define KBD_MODE_KBD_INT 0x01 /* Keyboard data generate IRQ1 */
126 #define KBD_MODE_MOUSE_INT 0x02 /* Mouse data generate IRQ12 */
127 #define KBD_MODE_SYS 0x04 /* The system flag (?) */
128 #define KBD_MODE_NO_KEYLOCK 0x08 /* The keylock doesn't affect the keyboard if set */
129 #define KBD_MODE_DISABLE_KBD 0x10 /* Disable keyboard interface */
130 #define KBD_MODE_DISABLE_MOUSE 0x20 /* Disable mouse interface */
131 #define KBD_MODE_KCC 0x40 /* Scan code conversion to PC format */
132 #define KBD_MODE_RFU 0x80
135 #define KDB_DATA_PORT 0x60
136 #define KDB_COMMAND_PORT 0x64
138 #define LED_SCR 0x01 /* scroll lock led */
139 #define LED_CAP 0x04 /* caps lock led */
140 #define LED_NUM 0x02 /* num lock led */
142 #define KBD_BUFFER_LEN 0x20 /* size of the keyboardbuffer */
145 static volatile char kbd_buffer[KBD_BUFFER_LEN];
146 static volatile int in_pointer = 0;
147 static volatile int out_pointer = 0;
150 static unsigned char num_lock = 0;
151 static unsigned char caps_lock = 0;
152 static unsigned char scroll_lock = 0;
153 static unsigned char shift = 0;
154 static unsigned char ctrl = 0;
155 static unsigned char alt = 0;
156 static unsigned char e0 = 0;
157 static unsigned char leds = 0;
159 #define DEVNAME "ps2kbd"
161 /* Simple translation table for the keys */
163 static unsigned char kbd_plain_xlate[] = {
164 0xff,0x1b, '1', '2', '3', '4', '5', '6', '7', '8', '9', '0', '-', '=','\b','\t', /* 0x00 - 0x0f */
165 'q', 'w', 'e', 'r', 't', 'y', 'u', 'i', 'o', 'p', '[', ']','\r',0xff, 'a', 's', /* 0x10 - 0x1f */
166 'd', 'f', 'g', 'h', 'j', 'k', 'l', ';','\'', '`',0xff,'\\', 'z', 'x', 'c', 'v', /* 0x20 - 0x2f */
167 'b', 'n', 'm', ',', '.', '/',0xff,0xff,0xff, ' ',0xff,0xff,0xff,0xff,0xff,0xff, /* 0x30 - 0x3f */
168 0xff,0xff,0xff,0xff,0xff,0xff,0xff, '7', '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
169 '2', '3', '0', '.',0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, /* 0x50 - 0x5F */
173 static unsigned char kbd_shift_xlate[] = {
174 0xff,0x1b, '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+','\b','\t', /* 0x00 - 0x0f */
175 'Q', 'W', 'E', 'R', 'T', 'Y', 'U', 'I', 'O', 'P', '{', '}','\r',0xff, 'A', 'S', /* 0x10 - 0x1f */
176 'D', 'F', 'G', 'H', 'J', 'K', 'L', ':', '"', '~',0xff, '|', 'Z', 'X', 'C', 'V', /* 0x20 - 0x2f */
177 'B', 'N', 'M', '<', '>', '?',0xff,0xff,0xff, ' ',0xff,0xff,0xff,0xff,0xff,0xff, /* 0x30 - 0x3f */
178 0xff,0xff,0xff,0xff,0xff,0xff,0xff, '7', '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
179 '2', '3', '0', '.',0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, /* 0x50 - 0x5F */
183 static unsigned char kbd_ctrl_xlate[] = {
184 0xff,0x1b, '1',0x00, '3', '4', '5',0x1E, '7', '8', '9', '0',0x1F, '=','\b','\t', /* 0x00 - 0x0f */
185 0x11,0x17,0x05,0x12,0x14,0x18,0x15,0x09,0x0f,0x10,0x1b,0x1d,'\n',0xff,0x01,0x13, /* 0x10 - 0x1f */
186 0x04,0x06,0x08,0x09,0x0a,0x0b,0x0c, ';','\'', '~',0x00,0x1c,0x1a,0x18,0x03,0x16, /* 0x20 - 0x2f */
187 0x02,0x0e,0x0d, '<', '>', '?',0xff,0xff,0xff,0x00,0xff,0xff,0xff,0xff,0xff,0xff, /* 0x30 - 0x3f */
188 0xff,0xff,0xff,0xff,0xff,0xff,0xff, '7', '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
189 '2', '3', '0', '.',0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, /* 0x50 - 0x5F */
193 /******************************************************************
195 ******************************************************************/
197 int isa_kbd_init(void)
200 result=kbd_initialize();
203 result = kbd_initialize();
206 printf("AT Keyboard initialized\n");
207 irq_install_handler(KBD_INTERRUPT, (interrupt_handler_t *)kbd_interrupt, NULL);
211 printf("%s\n",result);
216 #ifdef CFG_CONSOLE_OVERWRITE_ROUTINE
217 extern int overwrite_console (void);
219 int overwrite_console (void)
225 int drv_isa_kbd_init (void)
229 char *stdinname = getenv ("stdin");
231 if(isa_kbd_init()==-1)
233 memset (&kbddev, 0, sizeof(kbddev));
234 strcpy(kbddev.name, DEVNAME);
235 kbddev.flags = DEV_FLAGS_INPUT | DEV_FLAGS_SYSTEM;
238 kbddev.getc = kbd_getc ;
239 kbddev.tstc = kbd_testc ;
241 error = device_register (&kbddev);
243 /* check if this is the standard input device */
244 if(strcmp(stdinname,DEVNAME)==0) {
245 /* reassign the console */
246 if(overwrite_console()) {
249 error=console_assign(stdin,DEVNAME);
260 /******************************************************************
262 ******************************************************************/
263 /* puts character in the queue and sets up the in and out pointer */
264 void kbd_put_queue(char data)
266 if((in_pointer+1)==KBD_BUFFER_LEN) {
268 return; /* buffer full */
273 if((in_pointer+1)==out_pointer)
274 return; /* buffer full */
277 kbd_buffer[in_pointer]=data;
281 /* test if a character is in the queue */
284 if(in_pointer==out_pointer)
285 return(0); /* no data */
289 /* gets the character from the queue */
294 while(in_pointer==out_pointer);
295 if((out_pointer+1)==KBD_BUFFER_LEN)
299 c=kbd_buffer[out_pointer];
307 void kbd_set_leds(void)
310 leds&=~LED_CAP; /* switch caps_lock off */
312 leds|=LED_CAP; /* switch on LED */
314 leds&=~LED_NUM; /* switch LED off */
316 leds|=LED_NUM; /* switch on LED */
318 leds&=~LED_SCR; /* switch LED off */
320 leds|=LED_SCR; /* switch on LED */
321 kbd_send_data(KBD_CMD_SET_LEDS);
326 void handle_keyboard_event(unsigned char scancode)
328 unsigned char keycode;
330 /* Convert scancode to keycode */
331 PRINTF("scancode %x\n",scancode);
333 e0=1; /* special charakters */
337 e0=0; /* delete flag */
338 if(!( ((scancode&0x7F)==0x38)|| /* the right ctrl key */
339 ((scancode&0x7F)==0x1D)|| /* the right alt key */
340 ((scancode&0x7F)==0x35)|| /* the right '/' key */
341 ((scancode&0x7F)==0x1C)|| /* the right enter key */
342 ((scancode)==0x48)|| /* arrow up */
343 ((scancode)==0x50)|| /* arrow down */
344 ((scancode)==0x4b)|| /* arrow left */
345 ((scancode)==0x4d))) /* arrow right */
346 /* we swallow unknown e0 codes */
349 /* special cntrl keys */
372 case 0x58: /* F12 key */
375 extern int console_changed;
376 setenv("stdin", DEVNAME);
377 setenv("stdout", "vga");
382 case 0x36: /* shift pressed */
384 return; /* do nothing else */
386 case 0xB6: /* shift released */
388 return; /* do nothing else */
389 case 0x38: /* alt pressed */
391 return; /* do nothing else */
392 case 0xB8: /* alt released */
394 return; /* do nothing else */
395 case 0x1d: /* ctrl pressed */
397 return; /* do nothing else */
398 case 0x9d: /* ctrl released */
400 return; /* do nothing else */
401 case 0x46: /* scrollock pressed */
402 scroll_lock=~scroll_lock;
404 return; /* do nothing else */
405 case 0x3A: /* capslock pressed */
406 caps_lock=~caps_lock;
409 case 0x45: /* numlock pressed */
413 case 0xC6: /* scroll lock released */
414 case 0xC5: /* num lock released */
415 case 0xBA: /* caps lock released */
416 return; /* just swallow */
418 if((scancode&0x80)==0x80) /* key released */
420 /* now, decide which table we need */
421 if(scancode > (sizeof(kbd_plain_xlate)/sizeof(kbd_plain_xlate[0]))) { /* scancode not in list */
422 PRINTF("unkown scancode %X\n",scancode);
423 return; /* swallow it */
425 /* setup plain code first */
426 keycode=kbd_plain_xlate[scancode];
427 if(caps_lock==1) { /* caps_lock is pressed, overwrite plain code */
428 if(scancode > (sizeof(kbd_shift_xlate)/sizeof(kbd_shift_xlate[0]))) { /* scancode not in list */
429 PRINTF("unkown caps-locked scancode %X\n",scancode);
430 return; /* swallow it */
432 keycode=kbd_shift_xlate[scancode];
433 if(keycode<'A') { /* we only want the alphas capital */
434 keycode=kbd_plain_xlate[scancode];
437 if(shift==1) { /* shift overwrites caps_lock */
438 if(scancode > (sizeof(kbd_shift_xlate)/sizeof(kbd_shift_xlate[0]))) { /* scancode not in list */
439 PRINTF("unkown shifted scancode %X\n",scancode);
440 return; /* swallow it */
442 keycode=kbd_shift_xlate[scancode];
444 if(ctrl==1) { /* ctrl overwrites caps_lock and shift */
445 if(scancode > (sizeof(kbd_ctrl_xlate)/sizeof(kbd_ctrl_xlate[0]))) { /* scancode not in list */
446 PRINTF("unkown ctrl scancode %X\n",scancode);
447 return; /* swallow it */
449 keycode=kbd_ctrl_xlate[scancode];
451 /* check if valid keycode */
453 PRINTF("unkown scancode %X\n",scancode);
454 return; /* swallow unknown codes */
457 kbd_put_queue(keycode);
458 PRINTF("%x\n",keycode);
462 * This reads the keyboard status port, and does the
463 * appropriate action.
466 unsigned char handle_kbd_event(void)
468 unsigned char status = kbd_read_status();
469 unsigned int work = 10000;
471 while ((--work > 0) && (status & KBD_STAT_OBF)) {
472 unsigned char scancode;
474 scancode = kbd_read_input();
476 /* Error bytes must be ignored to make the
477 Synaptics touchpads compaq use work */
478 /* Ignore error bytes */
479 if (!(status & (KBD_STAT_GTO | KBD_STAT_PERR)))
481 if (status & KBD_STAT_MOUSE_OBF)
482 ; /* not supported: handle_mouse_event(scancode); */
484 handle_keyboard_event(scancode);
486 status = kbd_read_status();
489 PRINTF("pc_keyb: controller jammed (0x%02X).\n", status);
494 /******************************************************************************
495 * Lowlevel Part of keyboard section
497 unsigned char kbd_read_status(void)
499 return(in8(CFG_ISA_IO_BASE_ADDRESS + KDB_COMMAND_PORT));
502 unsigned char kbd_read_input(void)
504 return(in8(CFG_ISA_IO_BASE_ADDRESS + KDB_DATA_PORT));
507 void kbd_write_command(unsigned char cmd)
509 out8(CFG_ISA_IO_BASE_ADDRESS + KDB_COMMAND_PORT,cmd);
512 void kbd_write_output(unsigned char data)
514 out8(CFG_ISA_IO_BASE_ADDRESS + KDB_DATA_PORT, data);
517 int kbd_read_data(void)
520 unsigned char status;
523 status = kbd_read_status();
524 if (status & KBD_STAT_OBF) {
525 val = kbd_read_input();
526 if (status & (KBD_STAT_GTO | KBD_STAT_PERR))
532 int kbd_wait_for_input(void)
534 unsigned long timeout;
537 timeout = KBD_TIMEOUT;
552 unsigned long timeout = KBC_TIMEOUT * 10;
555 unsigned char status = handle_kbd_event();
556 if (!(status & KBD_STAT_IBF))
564 void kbd_write_command_w(int data)
567 PRINTF("timeout in kbd_write_command_w\n");
568 kbd_write_command(data);
571 void kbd_write_output_w(int data)
574 PRINTF("timeout in kbd_write_output_w\n");
575 kbd_write_output(data);
578 void kbd_send_data(unsigned char data)
580 unsigned char status;
581 i8259_mask_irq(KBD_INTERRUPT); /* disable interrupt */
582 kbd_write_output_w(data);
583 status = kbd_wait_for_input();
584 if (status == KBD_REPLY_ACK)
585 i8259_unmask_irq(KBD_INTERRUPT); /* enable interrupt */
589 char * kbd_initialize(void)
593 in_pointer = 0; /* delete in Buffer */
596 * Test the keyboard interface.
597 * This seems to be the only way to get it going.
598 * If the test is successful a x55 is placed in the input buffer.
600 kbd_write_command_w(KBD_CCMD_SELF_TEST);
601 if (kbd_wait_for_input() != 0x55)
602 return "Kbd: failed self test";
604 * Perform a keyboard interface test. This causes the controller
605 * to test the keyboard clock and data lines. The results of the
606 * test are placed in the input buffer.
608 kbd_write_command_w(KBD_CCMD_KBD_TEST);
609 if (kbd_wait_for_input() != 0x00)
610 return "Kbd: interface failed self test";
612 * Enable the keyboard by allowing the keyboard clock to run.
614 kbd_write_command_w(KBD_CCMD_KBD_ENABLE);
615 status = kbd_wait_for_input();
617 * Reset keyboard. If the read times out
618 * then the assumption is that no keyboard is
619 * plugged into the machine.
620 * This defaults the keyboard to scan-code set 2.
622 * Set up to try again if the keyboard asks for RESEND.
625 kbd_write_output_w(KBD_CMD_RESET);
626 status = kbd_wait_for_input();
627 if (status == KBD_REPLY_ACK)
629 if (status != KBD_REPLY_RESEND)
631 PRINTF("status: %X\n",status);
632 return "Kbd: reset failed, no ACK";
635 if (kbd_wait_for_input() != KBD_REPLY_POR)
636 return "Kbd: reset failed, no POR";
639 * Set keyboard controller mode. During this, the keyboard should be
640 * in the disabled state.
642 * Set up to try again if the keyboard asks for RESEND.
645 kbd_write_output_w(KBD_CMD_DISABLE);
646 status = kbd_wait_for_input();
647 if (status == KBD_REPLY_ACK)
649 if (status != KBD_REPLY_RESEND)
650 return "Kbd: disable keyboard: no ACK";
653 kbd_write_command_w(KBD_CCMD_WRITE_MODE);
654 kbd_write_output_w(KBD_MODE_KBD_INT
656 | KBD_MODE_DISABLE_MOUSE
659 /* ibm powerpc portables need this to use scan-code set 1 -- Cort */
660 kbd_write_command_w(KBD_CCMD_READ_MODE);
661 if (!(kbd_wait_for_input() & KBD_MODE_KCC)) {
663 * If the controller does not support conversion,
664 * Set the keyboard to scan-code set 1.
666 kbd_write_output_w(0xF0);
667 kbd_wait_for_input();
668 kbd_write_output_w(0x01);
669 kbd_wait_for_input();
671 kbd_write_output_w(KBD_CMD_ENABLE);
672 if (kbd_wait_for_input() != KBD_REPLY_ACK)
673 return "Kbd: enable keyboard: no ACK";
676 * Finally, set the typematic rate to maximum.
678 kbd_write_output_w(KBD_CMD_SET_RATE);
679 if (kbd_wait_for_input() != KBD_REPLY_ACK)
680 return "Kbd: Set rate: no ACK";
681 kbd_write_output_w(0x00);
682 if (kbd_wait_for_input() != KBD_REPLY_ACK)
683 return "Kbd: Set rate: no ACK";
687 void kbd_interrupt(void)