1 // 16bit code to handle keyboard requests.
3 // Copyright (C) 2008 Kevin O'Connor <kevin@koconnor.net>
4 // Copyright (C) 2002 MandrakeSoft S.A.
6 // This file may be distributed under the terms of the GNU GPLv3 license.
8 #include "biosvar.h" // struct bregs
9 #include "util.h" // debug_enter
10 #include "config.h" // CONFIG_*
12 //--------------------------------------------------------------------------
14 //--------------------------------------------------------------------------
16 keyboard_panic(u16 status)
18 // If you're getting a 993 keyboard panic here,
19 // please see the comment in keyboard_init
21 BX_PANIC("Keyboard error:%u\n",status);
28 while ((inb(PORT_PS2_STATUS) & 0x02) && (--max > 0))
29 outb(code, PORT_DIAG);
30 if (!max && code != 0xff)
38 while ( ((inb(PORT_PS2_STATUS) & 0x01) == 0) && (--max>0) )
39 outb(code, PORT_DIAG);
44 //--------------------------------------------------------------------------
46 //--------------------------------------------------------------------------
47 // this file is based on LinuxBIOS implementation of keyboard.c
52 // Coreboot already does low-level keyboard init.
55 /* ------------------- Flush buffers ------------------------*/
56 /* Wait until buffer is empty */
59 /* flush incoming keys */
62 outb(0x00, PORT_DIAG);
63 if (inb(PORT_PS2_STATUS) & 0x01) {
69 // Due to timer issues, and if the IPS setting is > 15000000,
70 // the incoming keys might not be flushed here. That will
71 // cause a panic a few lines below. See sourceforge bug report :
72 // [ 642031 ] FATAL: Keyboard RESET error:993
74 /* ------------------- controller side ----------------------*/
75 /* send cmd = 0xAA, self test 8042 */
76 outb(0xaa, PORT_PS2_STATUS);
81 /* read self-test result, 0x55 should be returned from 0x60 */
82 if (inb(PORT_PS2_DATA) != 0x55)
85 /* send cmd = 0xAB, keyboard interface test */
86 outb(0xab, PORT_PS2_STATUS);
91 /* read keyboard interface test result, */
92 /* 0x00 should be returned form 0x60 */
93 if (inb(PORT_PS2_DATA) != 0x00)
96 /* Enable Keyboard clock */
97 outb(0xae, PORT_PS2_STATUS);
98 outb(0xa8, PORT_PS2_STATUS);
100 /* ------------------- keyboard side ------------------------*/
101 /* reset kerboard and self test (keyboard side) */
102 outb(0xff, PORT_PS2_DATA);
107 /* keyboard should return ACK */
108 if (inb(PORT_PS2_DATA) != 0xfa)
113 if (inb(PORT_PS2_DATA) != 0xaa)
116 /* Disable keyboard */
117 outb(0xf5, PORT_PS2_DATA);
122 /* keyboard should return ACK */
123 if (inb(PORT_PS2_DATA) != 0xfa)
126 /* Write Keyboard Mode */
127 outb(0x60, PORT_PS2_STATUS);
131 /* send cmd: scan code convert, disable mouse, enable IRQ 1 */
132 outb(0x61, PORT_PS2_DATA);
136 /* Enable keyboard */
137 outb(0xf4, PORT_PS2_DATA);
142 /* keyboard should return ACK */
143 if (inb(PORT_PS2_DATA) != 0xfa)
146 outb(0x77, PORT_DIAG);
152 u16 x = offsetof(struct bios_data_area_s, kbd_buf) - 0x400;
153 SET_BDA(kbd_mode, 0x10);
154 SET_BDA(kbd_buf_head, x);
155 SET_BDA(kbd_buf_tail, x);
156 SET_BDA(kbd_buf_start_offset, x);
158 SET_BDA(kbd_buf_end_offset
159 , x + FIELD_SIZEOF(struct bios_data_area_s, kbd_buf));
165 enqueue_key(u8 scan_code, u8 ascii_code)
167 u16 buffer_start = GET_BDA(kbd_buf_start_offset);
168 u16 buffer_end = GET_BDA(kbd_buf_end_offset);
170 u16 buffer_head = GET_BDA(kbd_buf_head);
171 u16 buffer_tail = GET_BDA(kbd_buf_tail);
173 u16 temp_tail = buffer_tail;
175 if (buffer_tail >= buffer_end)
176 buffer_tail = buffer_start;
178 if (buffer_tail == buffer_head)
181 SET_FARVAR(SEG_BDA, *(u8*)(temp_tail+0x400+0), ascii_code);
182 SET_FARVAR(SEG_BDA, *(u8*)(temp_tail+0x400+1), scan_code);
183 SET_BDA(kbd_buf_tail, buffer_tail);
188 dequeue_key(u8 *scan_code, u8 *ascii_code, u8 incr)
193 buffer_head = GET_BDA(kbd_buf_head);
194 buffer_tail = GET_BDA(kbd_buf_tail);
196 if (buffer_head != buffer_tail)
203 *ascii_code = GET_FARVAR(SEG_BDA, *(u8*)(buffer_head+0x400+0));
204 *scan_code = GET_FARVAR(SEG_BDA, *(u8*)(buffer_head+0x400+1));
207 u16 buffer_start = GET_BDA(kbd_buf_start_offset);
208 u16 buffer_end = GET_BDA(kbd_buf_end_offset);
211 if (buffer_head >= buffer_end)
212 buffer_head = buffer_start;
213 SET_BDA(kbd_buf_head, buffer_head);
218 // read keyboard input
220 handle_1600(struct bregs *regs)
222 u8 scan_code, ascii_code;
223 dequeue_key(&scan_code, &ascii_code, 1);
224 if (scan_code != 0 && ascii_code == 0xF0)
226 else if (ascii_code == 0xE0)
228 regs->ax = (scan_code << 8) | ascii_code;
231 // check keyboard status
233 handle_1601(struct bregs *regs)
235 u8 scan_code, ascii_code;
236 if (!dequeue_key(&scan_code, &ascii_code, 0)) {
240 if (scan_code != 0 && ascii_code == 0xF0)
242 else if (ascii_code == 0xE0)
244 regs->ax = (scan_code << 8) | ascii_code;
245 regs->flags &= ~F_ZF;
248 // get shift flag status
250 handle_1602(struct bregs *regs)
252 regs->al = GET_BDA(kbd_flag0);
255 // store key-stroke into buffer
257 handle_1605(struct bregs *regs)
259 regs->al = !enqueue_key(regs->ch, regs->cl);
262 // GET KEYBOARD FUNCTIONALITY
264 handle_1609(struct bregs *regs)
266 // bit Bochs Description
268 // 6 0 INT 16/AH=20h-22h supported (122-key keyboard support)
269 // 5 1 INT 16/AH=10h-12h supported (enhanced keyboard support)
270 // 4 1 INT 16/AH=0Ah supported
271 // 3 0 INT 16/AX=0306h supported
272 // 2 0 INT 16/AX=0305h supported
273 // 1 0 INT 16/AX=0304h supported
274 // 0 0 INT 16/AX=0300h supported
281 handle_160a(struct bregs *regs)
283 outb(0xf2, PORT_PS2_DATA);
286 while ( ((inb(PORT_PS2_STATUS) & 0x01) == 0) && (--max>0) )
287 outb(0x00, PORT_DIAG);
290 if (inb(PORT_PS2_DATA) != 0xfa) {
298 while ( ((inb(PORT_PS2_STATUS) & 0x01) == 0) && (--max>0) )
299 outb(0x00, PORT_DIAG);
302 kbd_code |= (inb(PORT_PS2_DATA) << 8);
308 // read MF-II keyboard input
310 handle_1610(struct bregs *regs)
312 u8 scan_code, ascii_code;
313 dequeue_key(&scan_code, &ascii_code, 1);
314 if (scan_code != 0 && ascii_code == 0xF0)
316 regs->ax = (scan_code << 8) | ascii_code;
319 // check MF-II keyboard status
321 handle_1611(struct bregs *regs)
323 u8 scan_code, ascii_code;
324 if (!dequeue_key(&scan_code, &ascii_code, 0)) {
328 if (scan_code != 0 && ascii_code == 0xF0)
330 regs->ax = (scan_code << 8) | ascii_code;
331 regs->flags &= ~F_ZF;
334 // get extended keyboard status
336 handle_1612(struct bregs *regs)
338 regs->al = GET_BDA(kbd_flag0);
339 regs->ah = (GET_BDA(kbd_flag1) & 0x73) | (GET_BDA(kbd_mode) & 0x0c);
340 //BX_DEBUG_INT16("int16: func 12 sending %04x\n",AX);
344 handle_166f(struct bregs *regs)
346 if (regs->al == 0x08)
347 // unsupported, aka normal keyboard
351 // keyboard capability check called by DOS 5.0+ keyb
353 handle_1692(struct bregs *regs)
355 // function int16 ah=0x10-0x12 supported
359 // 122 keys capability check called by DOS 5.0+ keyb
361 handle_16a2(struct bregs *regs)
363 // don't change AH : function int16 ah=0x20-0x22 NOT supported
369 u8 shift_flags = GET_BDA(kbd_flag0);
370 u8 led_flags = GET_BDA(kbd_led);
371 if (((shift_flags >> 4) & 0x07) ^ ((led_flags & 0x07) == 0))
374 outb(0xed, PORT_PS2_DATA);
375 while ((inb(PORT_PS2_STATUS) & 0x01) == 0)
376 outb(0x21, PORT_DIAG);
377 if (inb(PORT_PS2_DATA) == 0xfa) {
379 led_flags |= (shift_flags >> 4) & 0x07;
380 outb(led_flags & 0x07, PORT_PS2_DATA);
381 while ((inb(PORT_PS2_STATUS) & 0x01) == 0)
382 outb(0x21, PORT_DIAG);
384 SET_BDA(kbd_led, led_flags);
388 // INT 16h Keyboard Service Entry Point
390 handle_16(struct bregs *regs)
399 case 0x00: handle_1600(regs); break;
400 case 0x01: handle_1601(regs); break;
401 case 0x02: handle_1602(regs); break;
402 case 0x05: handle_1605(regs); break;
403 case 0x09: handle_1609(regs); break;
404 case 0x0a: handle_160a(regs); break;
405 case 0x10: handle_1610(regs); break;
406 case 0x11: handle_1611(regs); break;
407 case 0x12: handle_1612(regs); break;
408 case 0x92: handle_1692(regs); break;
409 case 0xa2: handle_16a2(regs); break;
410 case 0x6f: handle_166f(regs); break;
415 #define MAX_SCAN_CODE 0x58
417 static struct scaninfo {
423 } scan_to_scanascii[MAX_SCAN_CODE + 1] = {
424 { none, none, none, none, none },
425 { 0x011b, 0x011b, 0x011b, 0x0100, none }, /* escape */
426 { 0x0231, 0x0221, none, 0x7800, none }, /* 1! */
427 { 0x0332, 0x0340, 0x0300, 0x7900, none }, /* 2@ */
428 { 0x0433, 0x0423, none, 0x7a00, none }, /* 3# */
429 { 0x0534, 0x0524, none, 0x7b00, none }, /* 4$ */
430 { 0x0635, 0x0625, none, 0x7c00, none }, /* 5% */
431 { 0x0736, 0x075e, 0x071e, 0x7d00, none }, /* 6^ */
432 { 0x0837, 0x0826, none, 0x7e00, none }, /* 7& */
433 { 0x0938, 0x092a, none, 0x7f00, none }, /* 8* */
434 { 0x0a39, 0x0a28, none, 0x8000, none }, /* 9( */
435 { 0x0b30, 0x0b29, none, 0x8100, none }, /* 0) */
436 { 0x0c2d, 0x0c5f, 0x0c1f, 0x8200, none }, /* -_ */
437 { 0x0d3d, 0x0d2b, none, 0x8300, none }, /* =+ */
438 { 0x0e08, 0x0e08, 0x0e7f, none, none }, /* backspace */
439 { 0x0f09, 0x0f00, none, none, none }, /* tab */
440 { 0x1071, 0x1051, 0x1011, 0x1000, 0x40 }, /* Q */
441 { 0x1177, 0x1157, 0x1117, 0x1100, 0x40 }, /* W */
442 { 0x1265, 0x1245, 0x1205, 0x1200, 0x40 }, /* E */
443 { 0x1372, 0x1352, 0x1312, 0x1300, 0x40 }, /* R */
444 { 0x1474, 0x1454, 0x1414, 0x1400, 0x40 }, /* T */
445 { 0x1579, 0x1559, 0x1519, 0x1500, 0x40 }, /* Y */
446 { 0x1675, 0x1655, 0x1615, 0x1600, 0x40 }, /* U */
447 { 0x1769, 0x1749, 0x1709, 0x1700, 0x40 }, /* I */
448 { 0x186f, 0x184f, 0x180f, 0x1800, 0x40 }, /* O */
449 { 0x1970, 0x1950, 0x1910, 0x1900, 0x40 }, /* P */
450 { 0x1a5b, 0x1a7b, 0x1a1b, none, none }, /* [{ */
451 { 0x1b5d, 0x1b7d, 0x1b1d, none, none }, /* ]} */
452 { 0x1c0d, 0x1c0d, 0x1c0a, none, none }, /* Enter */
453 { none, none, none, none, none }, /* L Ctrl */
454 { 0x1e61, 0x1e41, 0x1e01, 0x1e00, 0x40 }, /* A */
455 { 0x1f73, 0x1f53, 0x1f13, 0x1f00, 0x40 }, /* S */
456 { 0x2064, 0x2044, 0x2004, 0x2000, 0x40 }, /* D */
457 { 0x2166, 0x2146, 0x2106, 0x2100, 0x40 }, /* F */
458 { 0x2267, 0x2247, 0x2207, 0x2200, 0x40 }, /* G */
459 { 0x2368, 0x2348, 0x2308, 0x2300, 0x40 }, /* H */
460 { 0x246a, 0x244a, 0x240a, 0x2400, 0x40 }, /* J */
461 { 0x256b, 0x254b, 0x250b, 0x2500, 0x40 }, /* K */
462 { 0x266c, 0x264c, 0x260c, 0x2600, 0x40 }, /* L */
463 { 0x273b, 0x273a, none, none, none }, /* ;: */
464 { 0x2827, 0x2822, none, none, none }, /* '" */
465 { 0x2960, 0x297e, none, none, none }, /* `~ */
466 { none, none, none, none, none }, /* L shift */
467 { 0x2b5c, 0x2b7c, 0x2b1c, none, none }, /* |\ */
468 { 0x2c7a, 0x2c5a, 0x2c1a, 0x2c00, 0x40 }, /* Z */
469 { 0x2d78, 0x2d58, 0x2d18, 0x2d00, 0x40 }, /* X */
470 { 0x2e63, 0x2e43, 0x2e03, 0x2e00, 0x40 }, /* C */
471 { 0x2f76, 0x2f56, 0x2f16, 0x2f00, 0x40 }, /* V */
472 { 0x3062, 0x3042, 0x3002, 0x3000, 0x40 }, /* B */
473 { 0x316e, 0x314e, 0x310e, 0x3100, 0x40 }, /* N */
474 { 0x326d, 0x324d, 0x320d, 0x3200, 0x40 }, /* M */
475 { 0x332c, 0x333c, none, none, none }, /* ,< */
476 { 0x342e, 0x343e, none, none, none }, /* .> */
477 { 0x352f, 0x353f, none, none, none }, /* /? */
478 { none, none, none, none, none }, /* R Shift */
479 { 0x372a, 0x372a, none, none, none }, /* * */
480 { none, none, none, none, none }, /* L Alt */
481 { 0x3920, 0x3920, 0x3920, 0x3920, none }, /* space */
482 { none, none, none, none, none }, /* caps lock */
483 { 0x3b00, 0x5400, 0x5e00, 0x6800, none }, /* F1 */
484 { 0x3c00, 0x5500, 0x5f00, 0x6900, none }, /* F2 */
485 { 0x3d00, 0x5600, 0x6000, 0x6a00, none }, /* F3 */
486 { 0x3e00, 0x5700, 0x6100, 0x6b00, none }, /* F4 */
487 { 0x3f00, 0x5800, 0x6200, 0x6c00, none }, /* F5 */
488 { 0x4000, 0x5900, 0x6300, 0x6d00, none }, /* F6 */
489 { 0x4100, 0x5a00, 0x6400, 0x6e00, none }, /* F7 */
490 { 0x4200, 0x5b00, 0x6500, 0x6f00, none }, /* F8 */
491 { 0x4300, 0x5c00, 0x6600, 0x7000, none }, /* F9 */
492 { 0x4400, 0x5d00, 0x6700, 0x7100, none }, /* F10 */
493 { none, none, none, none, none }, /* Num Lock */
494 { none, none, none, none, none }, /* Scroll Lock */
495 { 0x4700, 0x4737, 0x7700, none, 0x20 }, /* 7 Home */
496 { 0x4800, 0x4838, none, none, 0x20 }, /* 8 UP */
497 { 0x4900, 0x4939, 0x8400, none, 0x20 }, /* 9 PgUp */
498 { 0x4a2d, 0x4a2d, none, none, none }, /* - */
499 { 0x4b00, 0x4b34, 0x7300, none, 0x20 }, /* 4 Left */
500 { 0x4c00, 0x4c35, none, none, 0x20 }, /* 5 */
501 { 0x4d00, 0x4d36, 0x7400, none, 0x20 }, /* 6 Right */
502 { 0x4e2b, 0x4e2b, none, none, none }, /* + */
503 { 0x4f00, 0x4f31, 0x7500, none, 0x20 }, /* 1 End */
504 { 0x5000, 0x5032, none, none, 0x20 }, /* 2 Down */
505 { 0x5100, 0x5133, 0x7600, none, 0x20 }, /* 3 PgDn */
506 { 0x5200, 0x5230, none, none, 0x20 }, /* 0 Ins */
507 { 0x5300, 0x532e, none, none, 0x20 }, /* Del */
508 { none, none, none, none, none },
509 { none, none, none, none, none },
510 { 0x565c, 0x567c, none, none, none }, /* \| */
511 { 0x5700, 0x5700, none, none, none }, /* F11 */
512 { 0x5800, 0x5800, none, none, none } /* F12 */
516 process_key(u8 scancode)
518 u8 shift_flags = GET_BDA(kbd_flag0);
519 u8 mf2_flags = GET_BDA(kbd_flag1);
520 u8 mf2_state = GET_BDA(kbd_mode);
524 BX_INFO("KBD: int09 handler: AL=0\n");
527 case 0x3a: /* Caps Lock press */
529 SET_BDA(kbd_flag0, shift_flags);
531 SET_BDA(kbd_flag1, mf2_flags);
533 case 0xba: /* Caps Lock release */
535 SET_BDA(kbd_flag1, mf2_flags);
538 case 0x2a: /* L Shift press */
540 SET_BDA(kbd_flag0, shift_flags);
542 case 0xaa: /* L Shift release */
543 shift_flags &= ~0x02;
544 SET_BDA(kbd_flag0, shift_flags);
547 case 0x36: /* R Shift press */
549 SET_BDA(kbd_flag0, shift_flags);
551 case 0xb6: /* R Shift release */
552 shift_flags &= ~0x01;
553 SET_BDA(kbd_flag0, shift_flags);
556 case 0x1d: /* Ctrl press */
557 if ((mf2_state & 0x01) == 0) {
559 SET_BDA(kbd_flag0, shift_flags);
560 if (mf2_state & 0x02) {
562 SET_BDA(kbd_mode, mf2_state);
565 SET_BDA(kbd_flag1, mf2_flags);
569 case 0x9d: /* Ctrl release */
570 if ((mf2_state & 0x01) == 0) {
571 shift_flags &= ~0x04;
572 SET_BDA(kbd_flag0, shift_flags);
573 if (mf2_state & 0x02) {
575 SET_BDA(kbd_mode, mf2_state);
578 SET_BDA(kbd_flag1, mf2_flags);
583 case 0x38: /* Alt press */
585 SET_BDA(kbd_flag0, shift_flags);
586 if (mf2_state & 0x02) {
588 SET_BDA(kbd_mode, mf2_state);
591 SET_BDA(kbd_flag1, mf2_flags);
594 case 0xb8: /* Alt release */
595 shift_flags &= ~0x08;
596 SET_BDA(kbd_flag0, shift_flags);
597 if (mf2_state & 0x02) {
599 SET_BDA(kbd_mode, mf2_state);
602 SET_BDA(kbd_flag1, mf2_flags);
606 case 0x45: /* Num Lock press */
607 if ((mf2_state & 0x03) == 0) {
609 SET_BDA(kbd_flag1, mf2_flags);
611 SET_BDA(kbd_flag0, shift_flags);
614 case 0xc5: /* Num Lock release */
615 if ((mf2_state & 0x03) == 0) {
617 SET_BDA(kbd_flag1, mf2_flags);
621 case 0x46: /* Scroll Lock press */
623 SET_BDA(kbd_flag1, mf2_flags);
625 SET_BDA(kbd_flag0, shift_flags);
627 case 0xc6: /* Scroll Lock release */
629 SET_BDA(kbd_flag1, mf2_flags);
634 SETBITS_BDA(kbd_mode, 0x02);
638 SETBITS_BDA(kbd_mode, 0x01);
642 if (scancode & 0x80) {
643 break; /* toss key releases ... */
645 if (scancode > MAX_SCAN_CODE) {
646 BX_INFO("KBD: int09h_handler(): unknown scancode read: 0x%02x!\n"
651 struct scaninfo *info = &scan_to_scanascii[scancode];
652 if (shift_flags & 0x08) { /* ALT */
653 asciicode = GET_VAR(CS, info->alt);
654 scancode = GET_VAR(CS, info->alt) >> 8;
655 } else if (shift_flags & 0x04) { /* CONTROL */
656 asciicode = GET_VAR(CS, info->control);
657 scancode = GET_VAR(CS, info->control) >> 8;
658 } else if ((mf2_state & 0x02) > 0
659 && scancode >= 0x47 && scancode <= 0x53) {
660 /* extended keys handling */
662 scancode = GET_VAR(CS, info->normal) >> 8;
663 } else if (shift_flags & 0x03) { /* LSHIFT + RSHIFT */
664 /* check if lock state should be ignored
665 * because a SHIFT key are pressed */
667 if (shift_flags & GET_VAR(CS, info->lock_flags)) {
668 asciicode = GET_VAR(CS, info->normal);
669 scancode = GET_VAR(CS, info->normal) >> 8;
671 asciicode = GET_VAR(CS, info->shift);
672 scancode = GET_VAR(CS, info->shift) >> 8;
675 /* check if lock is on */
676 if (shift_flags & GET_VAR(CS, info->lock_flags)) {
677 asciicode = GET_VAR(CS, info->shift);
678 scancode = GET_VAR(CS, info->shift) >> 8;
680 asciicode = GET_VAR(CS, info->normal);
681 scancode = GET_VAR(CS, info->normal) >> 8;
684 if (scancode==0 && asciicode==0) {
685 BX_INFO("KBD: int09h_handler(): scancode & asciicode are zero?\n");
687 enqueue_key(scancode, asciicode);
690 if ((scancode & 0x7f) != 0x1d) {
694 SET_BDA(kbd_mode, mf2_state);
697 // INT09h : Keyboard Hardware Service Entry Point
704 outb(0xad, PORT_PS2_STATUS);
706 outb(0x0b, PORT_PIC1);
707 if ((inb(PORT_PIC1) & 0x02) == 0)
710 // read key from keyboard controller
711 u8 key = inb(PORT_PS2_DATA);
713 if (CONFIG_KBD_CALL_INT15_4F) {
714 // allow for keyboard intercept
716 memset(&tr, 0, sizeof(tr));
720 call16_int(0x15, &tr);
721 if (!(tr.flags & F_CF))
732 outb(0xae, PORT_PS2_STATUS);