3 * Denis Peter, MPL AG Switzerland, d.peter@mpl.ch
5 * SPDX-License-Identifier: GPL-2.0+
7 * Source partly derived from:
8 * linux/drivers/char/pc_keyb.c
11 #include <asm/processor.h>
12 #include <stdio_dev.h>
17 unsigned char kbd_read_status(void);
18 unsigned char kbd_read_input(void);
19 void kbd_send_data(unsigned char data);
20 void disable_8259A_irq(unsigned int irq);
21 void enable_8259A_irq(unsigned int irq);
23 /* used only by send_data - set by keyboard_interrupt */
29 #define PRINTF(fmt,args...) printf (fmt ,##args)
31 #define PRINTF(fmt,args...)
34 #define KBD_STAT_KOBF 0x01
35 #define KBD_STAT_IBF 0x02
36 #define KBD_STAT_SYS 0x04
37 #define KBD_STAT_CD 0x08
38 #define KBD_STAT_LOCK 0x10
39 #define KBD_STAT_MOBF 0x20
40 #define KBD_STAT_TI_OUT 0x40
41 #define KBD_STAT_PARERR 0x80
43 #define KBD_INIT_TIMEOUT 1000 /* Timeout in ms for initializing the keyboard */
44 #define KBC_TIMEOUT 250 /* Timeout in ms for sending to keyboard controller */
45 #define KBD_TIMEOUT 2000 /* Timeout in ms for keyboard command acknowledge */
47 * Keyboard Controller Commands
50 #define KBD_CCMD_READ_MODE 0x20 /* Read mode bits */
51 #define KBD_CCMD_WRITE_MODE 0x60 /* Write mode bits */
52 #define KBD_CCMD_GET_VERSION 0xA1 /* Get controller version */
53 #define KBD_CCMD_MOUSE_DISABLE 0xA7 /* Disable mouse interface */
54 #define KBD_CCMD_MOUSE_ENABLE 0xA8 /* Enable mouse interface */
55 #define KBD_CCMD_TEST_MOUSE 0xA9 /* Mouse interface test */
56 #define KBD_CCMD_SELF_TEST 0xAA /* Controller self test */
57 #define KBD_CCMD_KBD_TEST 0xAB /* Keyboard interface test */
58 #define KBD_CCMD_KBD_DISABLE 0xAD /* Keyboard interface disable */
59 #define KBD_CCMD_KBD_ENABLE 0xAE /* Keyboard interface enable */
60 #define KBD_CCMD_WRITE_AUX_OBUF 0xD3 /* Write to output buffer as if
61 initiated by the auxiliary device */
62 #define KBD_CCMD_WRITE_MOUSE 0xD4 /* Write the following byte to the mouse */
68 #define KBD_CMD_SET_LEDS 0xED /* Set keyboard leds */
69 #define KBD_CMD_SET_RATE 0xF3 /* Set typematic rate */
70 #define KBD_CMD_ENABLE 0xF4 /* Enable scanning */
71 #define KBD_CMD_DISABLE 0xF5 /* Disable scanning */
72 #define KBD_CMD_RESET 0xFF /* Reset */
78 #define KBD_REPLY_POR 0xAA /* Power on reset */
79 #define KBD_REPLY_ACK 0xFA /* Command ACK */
80 #define KBD_REPLY_RESEND 0xFE /* Command NACK, send the cmd again */
83 * Status Register Bits
86 #define KBD_STAT_OBF 0x01 /* Keyboard output buffer full */
87 #define KBD_STAT_IBF 0x02 /* Keyboard input buffer full */
88 #define KBD_STAT_SELFTEST 0x04 /* Self test successful */
89 #define KBD_STAT_CMD 0x08 /* Last write was a command write (0=data) */
90 #define KBD_STAT_UNLOCKED 0x10 /* Zero if keyboard locked */
91 #define KBD_STAT_MOUSE_OBF 0x20 /* Mouse output buffer full */
92 #define KBD_STAT_GTO 0x40 /* General receive/xmit timeout */
93 #define KBD_STAT_PERR 0x80 /* Parity error */
95 #define AUX_STAT_OBF (KBD_STAT_OBF | KBD_STAT_MOUSE_OBF)
98 * Controller Mode Register Bits
101 #define KBD_MODE_KBD_INT 0x01 /* Keyboard data generate IRQ1 */
102 #define KBD_MODE_MOUSE_INT 0x02 /* Mouse data generate IRQ12 */
103 #define KBD_MODE_SYS 0x04 /* The system flag (?) */
104 #define KBD_MODE_NO_KEYLOCK 0x08 /* The keylock doesn't affect the keyboard if set */
105 #define KBD_MODE_DISABLE_KBD 0x10 /* Disable keyboard interface */
106 #define KBD_MODE_DISABLE_MOUSE 0x20 /* Disable mouse interface */
107 #define KBD_MODE_KCC 0x40 /* Scan code conversion to PC format */
108 #define KBD_MODE_RFU 0x80
111 #define KDB_DATA_PORT 0x60
112 #define KDB_COMMAND_PORT 0x64
114 #define LED_SCR 0x01 /* scroll lock led */
115 #define LED_CAP 0x04 /* caps lock led */
116 #define LED_NUM 0x02 /* num lock led */
118 #define KBD_BUFFER_LEN 0x20 /* size of the keyboardbuffer */
121 static volatile char kbd_buffer[KBD_BUFFER_LEN];
122 static volatile int in_pointer = 0;
123 static volatile int out_pointer = 0;
126 static unsigned char num_lock = 0;
127 static unsigned char caps_lock = 0;
128 static unsigned char scroll_lock = 0;
129 static unsigned char shift = 0;
130 static unsigned char ctrl = 0;
131 static unsigned char alt = 0;
132 static unsigned char e0 = 0;
133 static unsigned char leds = 0;
135 #define DEVNAME "kbd"
137 /* Simple translation table for the keys */
139 static unsigned char kbd_plain_xlate[] = {
140 0xff,0x1b, '1', '2', '3', '4', '5', '6', '7', '8', '9', '0', '-', '=','\b','\t', /* 0x00 - 0x0f */
141 'q', 'w', 'e', 'r', 't', 'y', 'u', 'i', 'o', 'p', '[', ']','\r',0xff, 'a', 's', /* 0x10 - 0x1f */
142 'd', 'f', 'g', 'h', 'j', 'k', 'l', ';','\'', '`',0xff,'\\', 'z', 'x', 'c', 'v', /* 0x20 - 0x2f */
143 'b', 'n', 'm', ',', '.', '/',0xff,0xff,0xff, ' ',0xff,0xff,0xff,0xff,0xff,0xff, /* 0x30 - 0x3f */
144 0xff,0xff,0xff,0xff,0xff,0xff,0xff, '7', '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
145 '2', '3', '0', '.',0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, /* 0x50 - 0x5F */
149 static unsigned char kbd_shift_xlate[] = {
150 0xff,0x1b, '!', '@', '#', '$', '%', '^', '&', '*', '(', ')', '_', '+','\b','\t', /* 0x00 - 0x0f */
151 'Q', 'W', 'E', 'R', 'T', 'Y', 'U', 'I', 'O', 'P', '{', '}','\r',0xff, 'A', 'S', /* 0x10 - 0x1f */
152 'D', 'F', 'G', 'H', 'J', 'K', 'L', ':', '"', '~',0xff, '|', 'Z', 'X', 'C', 'V', /* 0x20 - 0x2f */
153 'B', 'N', 'M', '<', '>', '?',0xff,0xff,0xff, ' ',0xff,0xff,0xff,0xff,0xff,0xff, /* 0x30 - 0x3f */
154 0xff,0xff,0xff,0xff,0xff,0xff,0xff, '7', '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
155 '2', '3', '0', '.',0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, /* 0x50 - 0x5F */
159 static unsigned char kbd_ctrl_xlate[] = {
160 0xff,0x1b, '1',0x00, '3', '4', '5',0x1E, '7', '8', '9', '0',0x1F, '=','\b','\t', /* 0x00 - 0x0f */
161 0x11,0x17,0x05,0x12,0x14,0x18,0x15,0x09,0x0f,0x10,0x1b,0x1d,'\n',0xff,0x01,0x13, /* 0x10 - 0x1f */
162 0x04,0x06,0x08,0x09,0x0a,0x0b,0x0c, ';','\'', '~',0x00,0x1c,0x1a,0x18,0x03,0x16, /* 0x20 - 0x2f */
163 0x02,0x0e,0x0d, '<', '>', '?',0xff,0xff,0xff,0x00,0xff,0xff,0xff,0xff,0xff,0xff, /* 0x30 - 0x3f */
164 0xff,0xff,0xff,0xff,0xff,0xff,0xff, '7', '8', '9', '-', '4', '5', '6', '+', '1', /* 0x40 - 0x4f */
165 '2', '3', '0', '.',0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff,0xff, /* 0x50 - 0x5F */
169 /******************************************************************
171 ******************************************************************/
172 int isa_kbd_init(void)
175 result=kbd_initialize();
177 PRINTF("AT Keyboard initialized\n");
178 irq_install_handler(25, (interrupt_handler_t *)handle_isa_int, NULL);
179 isa_irq_install_handler(KBD_INTERRUPT, (interrupt_handler_t *)kbd_interrupt, NULL);
182 printf("%s\n",result);
187 #ifdef CONFIG_SYS_CONSOLE_OVERWRITE_ROUTINE
188 extern int overwrite_console (void);
190 int overwrite_console (void)
196 int drv_isa_kbd_init (void)
199 struct stdio_dev kbddev ;
200 char *stdinname = getenv ("stdin");
202 if(isa_kbd_init()==-1)
204 memset (&kbddev, 0, sizeof(kbddev));
205 strcpy(kbddev.name, DEVNAME);
206 kbddev.flags = DEV_FLAGS_INPUT | DEV_FLAGS_SYSTEM;
207 kbddev.getc = kbd_getc ;
208 kbddev.tstc = kbd_testc ;
210 error = stdio_register (&kbddev);
212 /* check if this is the standard input device */
213 if(strcmp(stdinname,DEVNAME)==0) {
214 /* reassign the console */
215 if(overwrite_console()) {
218 error=console_assign(stdin,DEVNAME);
229 /******************************************************************
231 ******************************************************************/
232 /* puts character in the queue and sets up the in and out pointer */
233 void kbd_put_queue(char data)
235 if((in_pointer+1)==KBD_BUFFER_LEN) {
237 return; /* buffer full */
242 if((in_pointer+1)==out_pointer)
243 return; /* buffer full */
246 kbd_buffer[in_pointer]=data;
250 /* test if a character is in the queue */
251 int kbd_testc(struct stdio_dev *dev)
253 if(in_pointer==out_pointer)
254 return(0); /* no data */
258 /* gets the character from the queue */
259 int kbd_getc(struct stdio_dev *dev)
262 while(in_pointer==out_pointer);
263 if((out_pointer+1)==KBD_BUFFER_LEN)
267 c=kbd_buffer[out_pointer];
275 void kbd_set_leds(void)
278 leds&=~LED_CAP; /* switch caps_lock off */
280 leds|=LED_CAP; /* switch on LED */
282 leds&=~LED_NUM; /* switch LED off */
284 leds|=LED_NUM; /* switch on LED */
286 leds&=~LED_SCR; /* switch LED off */
288 leds|=LED_SCR; /* switch on LED */
289 kbd_send_data(KBD_CMD_SET_LEDS);
294 void handle_keyboard_event (unsigned char scancode)
296 unsigned char keycode;
298 /* Convert scancode to keycode */
299 PRINTF ("scancode %x\n", scancode);
300 if (scancode == 0xe0) {
301 e0 = 1; /* special charakters */
305 e0 = 0; /* delete flag */
306 if (!(((scancode & 0x7F) == 0x38) || /* the right ctrl key */
307 ((scancode & 0x7F) == 0x1D) || /* the right alt key */
308 ((scancode & 0x7F) == 0x35) || /* the right '/' key */
309 ((scancode & 0x7F) == 0x1C)))
310 /* the right enter key */
311 /* we swallow unknown e0 codes */
314 /* special cntrl keys */
317 case 0x36: /* shift pressed */
319 return; /* do nothing else */
321 case 0xB6: /* shift released */
323 return; /* do nothing else */
324 case 0x38: /* alt pressed */
326 return; /* do nothing else */
327 case 0xB8: /* alt released */
329 return; /* do nothing else */
330 case 0x1d: /* ctrl pressed */
332 return; /* do nothing else */
333 case 0x9d: /* ctrl released */
335 return; /* do nothing else */
336 case 0x46: /* scrollock pressed */
337 scroll_lock = ~scroll_lock;
339 return; /* do nothing else */
340 case 0x3A: /* capslock pressed */
341 caps_lock = ~caps_lock;
344 case 0x45: /* numlock pressed */
345 num_lock = ~num_lock;
348 case 0xC6: /* scroll lock released */
349 case 0xC5: /* num lock released */
350 case 0xBA: /* caps lock released */
351 return; /* just swallow */
353 if ((scancode & 0x80) == 0x80) /* key released */
355 /* now, decide which table we need */
356 if (scancode > (sizeof (kbd_plain_xlate) / sizeof (kbd_plain_xlate[0]))) { /* scancode not in list */
357 PRINTF ("unkown scancode %X\n", scancode);
358 return; /* swallow it */
360 /* setup plain code first */
361 keycode = kbd_plain_xlate[scancode];
362 if (caps_lock == 1) { /* caps_lock is pressed, overwrite plain code */
363 if (scancode > (sizeof (kbd_shift_xlate) / sizeof (kbd_shift_xlate[0]))) { /* scancode not in list */
364 PRINTF ("unkown caps-locked scancode %X\n", scancode);
365 return; /* swallow it */
367 keycode = kbd_shift_xlate[scancode];
368 if (keycode < 'A') { /* we only want the alphas capital */
369 keycode = kbd_plain_xlate[scancode];
372 if (shift == 1) { /* shift overwrites caps_lock */
373 if (scancode > (sizeof (kbd_shift_xlate) / sizeof (kbd_shift_xlate[0]))) { /* scancode not in list */
374 PRINTF ("unkown shifted scancode %X\n", scancode);
375 return; /* swallow it */
377 keycode = kbd_shift_xlate[scancode];
379 if (ctrl == 1) { /* ctrl overwrites caps_lock and shift */
380 if (scancode > (sizeof (kbd_ctrl_xlate) / sizeof (kbd_ctrl_xlate[0]))) { /* scancode not in list */
381 PRINTF ("unkown ctrl scancode %X\n", scancode);
382 return; /* swallow it */
384 keycode = kbd_ctrl_xlate[scancode];
386 /* check if valid keycode */
387 if (keycode == 0xff) {
388 PRINTF ("unkown scancode %X\n", scancode);
389 return; /* swallow unknown codes */
392 kbd_put_queue (keycode);
393 PRINTF ("%x\n", keycode);
397 * This reads the keyboard status port, and does the
398 * appropriate action.
401 unsigned char handle_kbd_event(void)
403 unsigned char status = kbd_read_status();
404 unsigned int work = 10000;
406 while ((--work > 0) && (status & KBD_STAT_OBF)) {
407 unsigned char scancode;
409 scancode = kbd_read_input();
411 /* Error bytes must be ignored to make the
412 Synaptics touchpads compaq use work */
413 /* Ignore error bytes */
414 if (!(status & (KBD_STAT_GTO | KBD_STAT_PERR)))
416 if (status & KBD_STAT_MOUSE_OBF)
417 ; /* not supported: handle_mouse_event(scancode); */
419 handle_keyboard_event(scancode);
421 status = kbd_read_status();
424 PRINTF("pc_keyb: controller jammed (0x%02X).\n", status);
429 /******************************************************************************
430 * Lowlevel Part of keyboard section
432 unsigned char kbd_read_status(void)
434 return(in8(CONFIG_SYS_ISA_IO_BASE_ADDRESS + KDB_COMMAND_PORT));
437 unsigned char kbd_read_input(void)
439 return(in8(CONFIG_SYS_ISA_IO_BASE_ADDRESS + KDB_DATA_PORT));
442 void kbd_write_command(unsigned char cmd)
444 out8(CONFIG_SYS_ISA_IO_BASE_ADDRESS + KDB_COMMAND_PORT,cmd);
447 void kbd_write_output(unsigned char data)
449 out8(CONFIG_SYS_ISA_IO_BASE_ADDRESS + KDB_DATA_PORT, data);
452 int kbd_read_data(void)
455 unsigned char status;
458 status = kbd_read_status();
459 if (status & KBD_STAT_OBF) {
460 val = kbd_read_input();
461 if (status & (KBD_STAT_GTO | KBD_STAT_PERR))
467 int kbd_wait_for_input(void)
469 unsigned long timeout;
472 timeout = KBD_TIMEOUT;
487 unsigned long timeout = KBC_TIMEOUT * 10;
490 unsigned char status = handle_kbd_event();
491 if (!(status & KBD_STAT_IBF))
499 void kbd_write_command_w(int data)
502 PRINTF("timeout in kbd_write_command_w\n");
503 kbd_write_command(data);
506 void kbd_write_output_w(int data)
509 PRINTF("timeout in kbd_write_output_w\n");
510 kbd_write_output(data);
513 void kbd_send_data(unsigned char data)
515 unsigned char status;
516 disable_8259A_irq(1); /* disable interrupt */
517 kbd_write_output_w(data);
518 status = kbd_wait_for_input();
519 if (status == KBD_REPLY_ACK)
520 enable_8259A_irq(1); /* enable interrupt */
524 char * kbd_initialize(void)
528 in_pointer = 0; /* delete in Buffer */
531 * Test the keyboard interface.
532 * This seems to be the only way to get it going.
533 * If the test is successful a x55 is placed in the input buffer.
535 kbd_write_command_w(KBD_CCMD_SELF_TEST);
536 if (kbd_wait_for_input() != 0x55)
537 return "Kbd: failed self test";
539 * Perform a keyboard interface test. This causes the controller
540 * to test the keyboard clock and data lines. The results of the
541 * test are placed in the input buffer.
543 kbd_write_command_w(KBD_CCMD_KBD_TEST);
544 if (kbd_wait_for_input() != 0x00)
545 return "Kbd: interface failed self test";
547 * Enable the keyboard by allowing the keyboard clock to run.
549 kbd_write_command_w(KBD_CCMD_KBD_ENABLE);
550 status = kbd_wait_for_input();
552 * Reset keyboard. If the read times out
553 * then the assumption is that no keyboard is
554 * plugged into the machine.
555 * This defaults the keyboard to scan-code set 2.
557 * Set up to try again if the keyboard asks for RESEND.
560 kbd_write_output_w(KBD_CMD_RESET);
561 status = kbd_wait_for_input();
562 if (status == KBD_REPLY_ACK)
564 if (status != KBD_REPLY_RESEND) {
565 PRINTF("status: %X\n",status);
566 return "Kbd: reset failed, no ACK";
569 if (kbd_wait_for_input() != KBD_REPLY_POR)
570 return "Kbd: reset failed, no POR";
573 * Set keyboard controller mode. During this, the keyboard should be
574 * in the disabled state.
576 * Set up to try again if the keyboard asks for RESEND.
579 kbd_write_output_w(KBD_CMD_DISABLE);
580 status = kbd_wait_for_input();
581 if (status == KBD_REPLY_ACK)
583 if (status != KBD_REPLY_RESEND)
584 return "Kbd: disable keyboard: no ACK";
587 kbd_write_command_w(KBD_CCMD_WRITE_MODE);
588 kbd_write_output_w(KBD_MODE_KBD_INT
590 | KBD_MODE_DISABLE_MOUSE
593 /* AMCC powerpc portables need this to use scan-code set 1 -- Cort */
594 kbd_write_command_w(KBD_CCMD_READ_MODE);
595 if (!(kbd_wait_for_input() & KBD_MODE_KCC)) {
597 * If the controller does not support conversion,
598 * Set the keyboard to scan-code set 1.
600 kbd_write_output_w(0xF0);
601 kbd_wait_for_input();
602 kbd_write_output_w(0x01);
603 kbd_wait_for_input();
605 kbd_write_output_w(KBD_CMD_ENABLE);
606 if (kbd_wait_for_input() != KBD_REPLY_ACK)
607 return "Kbd: enable keyboard: no ACK";
610 * Finally, set the typematic rate to maximum.
612 kbd_write_output_w(KBD_CMD_SET_RATE);
613 if (kbd_wait_for_input() != KBD_REPLY_ACK)
614 return "Kbd: Set rate: no ACK";
615 kbd_write_output_w(0x00);
616 if (kbd_wait_for_input() != KBD_REPLY_ACK)
617 return "Kbd: Set rate: no ACK";
621 void kbd_interrupt(void)