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
51 /* ------------------- Flush buffers ------------------------*/
52 /* Wait until buffer is empty */
55 /* flush incoming keys */
58 outb(0x00, PORT_DIAG);
59 if (inb(PORT_PS2_STATUS) & 0x01) {
65 // Due to timer issues, and if the IPS setting is > 15000000,
66 // the incoming keys might not be flushed here. That will
67 // cause a panic a few lines below. See sourceforge bug report :
68 // [ 642031 ] FATAL: Keyboard RESET error:993
70 /* ------------------- controller side ----------------------*/
71 /* send cmd = 0xAA, self test 8042 */
72 outb(0xaa, PORT_PS2_STATUS);
77 /* read self-test result, 0x55 should be returned from 0x60 */
78 if (inb(PORT_PS2_DATA) != 0x55)
81 /* send cmd = 0xAB, keyboard interface test */
82 outb(0xab, PORT_PS2_STATUS);
87 /* read keyboard interface test result, */
88 /* 0x00 should be returned form 0x60 */
89 if (inb(PORT_PS2_DATA) != 0x00)
92 /* Enable Keyboard clock */
93 outb(0xae, PORT_PS2_STATUS);
94 outb(0xa8, PORT_PS2_STATUS);
96 /* ------------------- keyboard side ------------------------*/
97 /* reset kerboard and self test (keyboard side) */
98 outb(0xff, PORT_PS2_DATA);
103 /* keyboard should return ACK */
104 if (inb(PORT_PS2_DATA) != 0xfa)
109 if (inb(PORT_PS2_DATA) != 0xaa)
112 /* Disable keyboard */
113 outb(0xf5, PORT_PS2_DATA);
118 /* keyboard should return ACK */
119 if (inb(PORT_PS2_DATA) != 0xfa)
122 /* Write Keyboard Mode */
123 outb(0x60, PORT_PS2_STATUS);
127 /* send cmd: scan code convert, disable mouse, enable IRQ 1 */
128 outb(0x61, PORT_PS2_DATA);
132 /* Enable keyboard */
133 outb(0xf4, PORT_PS2_DATA);
138 /* keyboard should return ACK */
139 if (inb(PORT_PS2_DATA) != 0xfa)
142 outb(0x77, PORT_DIAG);
148 u16 x = offsetof(struct bios_data_area_s, kbd_buf) - 0x400;
149 SET_BDA(kbd_mode, 0x10);
150 SET_BDA(kbd_buf_head, x);
151 SET_BDA(kbd_buf_tail, x);
152 SET_BDA(kbd_buf_start_offset, x);
154 SET_BDA(kbd_buf_end_offset
155 , x + FIELD_SIZEOF(struct bios_data_area_s, kbd_buf));
161 enqueue_key(u8 scan_code, u8 ascii_code)
163 u16 buffer_start = GET_BDA(kbd_buf_start_offset);
164 u16 buffer_end = GET_BDA(kbd_buf_end_offset);
166 u16 buffer_head = GET_BDA(kbd_buf_head);
167 u16 buffer_tail = GET_BDA(kbd_buf_tail);
169 u16 temp_tail = buffer_tail;
171 if (buffer_tail >= buffer_end)
172 buffer_tail = buffer_start;
174 if (buffer_tail == buffer_head)
177 SET_FARVAR(SEG_BDA, *(u8*)(temp_tail+0x400+0), ascii_code);
178 SET_FARVAR(SEG_BDA, *(u8*)(temp_tail+0x400+1), scan_code);
179 SET_BDA(kbd_buf_tail, buffer_tail);
184 dequeue_key(u8 *scan_code, u8 *ascii_code, u8 incr)
189 buffer_head = GET_BDA(kbd_buf_head);
190 buffer_tail = GET_BDA(kbd_buf_tail);
192 if (buffer_head != buffer_tail)
199 *ascii_code = GET_FARVAR(SEG_BDA, *(u8*)(buffer_head+0x400+0));
200 *scan_code = GET_FARVAR(SEG_BDA, *(u8*)(buffer_head+0x400+1));
203 u16 buffer_start = GET_BDA(kbd_buf_start_offset);
204 u16 buffer_end = GET_BDA(kbd_buf_end_offset);
207 if (buffer_head >= buffer_end)
208 buffer_head = buffer_start;
209 SET_BDA(kbd_buf_head, buffer_head);
214 // read keyboard input
216 handle_1600(struct bregs *regs)
218 u8 scan_code, ascii_code;
219 dequeue_key(&scan_code, &ascii_code, 1);
220 if (scan_code != 0 && ascii_code == 0xF0)
222 else if (ascii_code == 0xE0)
224 regs->ax = (scan_code << 8) | ascii_code;
227 // check keyboard status
229 handle_1601(struct bregs *regs)
231 u8 scan_code, ascii_code;
232 if (!dequeue_key(&scan_code, &ascii_code, 0)) {
236 if (scan_code != 0 && ascii_code == 0xF0)
238 else if (ascii_code == 0xE0)
240 regs->ax = (scan_code << 8) | ascii_code;
241 regs->flags &= ~F_ZF;
244 // get shift flag status
246 handle_1602(struct bregs *regs)
248 regs->al = GET_BDA(kbd_flag0);
251 // store key-stroke into buffer
253 handle_1605(struct bregs *regs)
255 regs->al = !enqueue_key(regs->ch, regs->cl);
258 // GET KEYBOARD FUNCTIONALITY
260 handle_1609(struct bregs *regs)
262 // bit Bochs Description
264 // 6 0 INT 16/AH=20h-22h supported (122-key keyboard support)
265 // 5 1 INT 16/AH=10h-12h supported (enhanced keyboard support)
266 // 4 1 INT 16/AH=0Ah supported
267 // 3 0 INT 16/AX=0306h supported
268 // 2 0 INT 16/AX=0305h supported
269 // 1 0 INT 16/AX=0304h supported
270 // 0 0 INT 16/AX=0300h supported
277 handle_160a(struct bregs *regs)
279 outb(0xf2, PORT_PS2_DATA);
282 while ( ((inb(PORT_PS2_STATUS) & 0x01) == 0) && (--max>0) )
283 outb(0x00, PORT_DIAG);
286 if (inb(PORT_PS2_DATA) != 0xfa) {
294 while ( ((inb(PORT_PS2_STATUS) & 0x01) == 0) && (--max>0) )
295 outb(0x00, PORT_DIAG);
298 kbd_code |= (inb(PORT_PS2_DATA) << 8);
304 // read MF-II keyboard input
306 handle_1610(struct bregs *regs)
308 u8 scan_code, ascii_code;
309 dequeue_key(&scan_code, &ascii_code, 1);
310 if (scan_code != 0 && ascii_code == 0xF0)
312 regs->ax = (scan_code << 8) | ascii_code;
315 // check MF-II keyboard status
317 handle_1611(struct bregs *regs)
319 u8 scan_code, ascii_code;
320 if (!dequeue_key(&scan_code, &ascii_code, 0)) {
324 if (scan_code != 0 && ascii_code == 0xF0)
326 regs->ax = (scan_code << 8) | ascii_code;
327 regs->flags &= ~F_ZF;
330 // get extended keyboard status
332 handle_1612(struct bregs *regs)
334 regs->al = GET_BDA(kbd_flag0);
335 regs->ah = (GET_BDA(kbd_flag1) & 0x73) | (GET_BDA(kbd_mode) & 0x0c);
336 //BX_DEBUG_INT16("int16: func 12 sending %04x\n",AX);
340 handle_166f(struct bregs *regs)
342 if (regs->al == 0x08)
343 // unsupported, aka normal keyboard
347 // keyboard capability check called by DOS 5.0+ keyb
349 handle_1692(struct bregs *regs)
351 // function int16 ah=0x10-0x12 supported
355 // 122 keys capability check called by DOS 5.0+ keyb
357 handle_16a2(struct bregs *regs)
359 // don't change AH : function int16 ah=0x20-0x22 NOT supported
365 u8 shift_flags = GET_BDA(kbd_flag0);
366 u8 led_flags = GET_BDA(kbd_led);
367 if (((shift_flags >> 4) & 0x07) ^ ((led_flags & 0x07) == 0))
370 outb(0xed, PORT_PS2_DATA);
371 while ((inb(PORT_PS2_STATUS) & 0x01) == 0)
372 outb(0x21, PORT_DIAG);
373 if (inb(PORT_PS2_DATA) == 0xfa) {
375 led_flags |= (shift_flags >> 4) & 0x07;
376 outb(led_flags & 0x07, PORT_PS2_DATA);
377 while ((inb(PORT_PS2_STATUS) & 0x01) == 0)
378 outb(0x21, PORT_DIAG);
380 SET_BDA(kbd_led, led_flags);
384 // INT 16h Keyboard Service Entry Point
386 handle_16(struct bregs *regs)
395 case 0x00: handle_1600(regs); break;
396 case 0x01: handle_1601(regs); break;
397 case 0x02: handle_1602(regs); break;
398 case 0x05: handle_1605(regs); break;
399 case 0x09: handle_1609(regs); break;
400 case 0x0a: handle_160a(regs); break;
401 case 0x10: handle_1610(regs); break;
402 case 0x11: handle_1611(regs); break;
403 case 0x12: handle_1612(regs); break;
404 case 0x92: handle_1692(regs); break;
405 case 0xa2: handle_16a2(regs); break;
406 case 0x6f: handle_166f(regs); break;
411 #define MAX_SCAN_CODE 0x58
413 static struct scaninfo {
419 } scan_to_scanascii[MAX_SCAN_CODE + 1] = {
420 { none, none, none, none, none },
421 { 0x011b, 0x011b, 0x011b, 0x0100, none }, /* escape */
422 { 0x0231, 0x0221, none, 0x7800, none }, /* 1! */
423 { 0x0332, 0x0340, 0x0300, 0x7900, none }, /* 2@ */
424 { 0x0433, 0x0423, none, 0x7a00, none }, /* 3# */
425 { 0x0534, 0x0524, none, 0x7b00, none }, /* 4$ */
426 { 0x0635, 0x0625, none, 0x7c00, none }, /* 5% */
427 { 0x0736, 0x075e, 0x071e, 0x7d00, none }, /* 6^ */
428 { 0x0837, 0x0826, none, 0x7e00, none }, /* 7& */
429 { 0x0938, 0x092a, none, 0x7f00, none }, /* 8* */
430 { 0x0a39, 0x0a28, none, 0x8000, none }, /* 9( */
431 { 0x0b30, 0x0b29, none, 0x8100, none }, /* 0) */
432 { 0x0c2d, 0x0c5f, 0x0c1f, 0x8200, none }, /* -_ */
433 { 0x0d3d, 0x0d2b, none, 0x8300, none }, /* =+ */
434 { 0x0e08, 0x0e08, 0x0e7f, none, none }, /* backspace */
435 { 0x0f09, 0x0f00, none, none, none }, /* tab */
436 { 0x1071, 0x1051, 0x1011, 0x1000, 0x40 }, /* Q */
437 { 0x1177, 0x1157, 0x1117, 0x1100, 0x40 }, /* W */
438 { 0x1265, 0x1245, 0x1205, 0x1200, 0x40 }, /* E */
439 { 0x1372, 0x1352, 0x1312, 0x1300, 0x40 }, /* R */
440 { 0x1474, 0x1454, 0x1414, 0x1400, 0x40 }, /* T */
441 { 0x1579, 0x1559, 0x1519, 0x1500, 0x40 }, /* Y */
442 { 0x1675, 0x1655, 0x1615, 0x1600, 0x40 }, /* U */
443 { 0x1769, 0x1749, 0x1709, 0x1700, 0x40 }, /* I */
444 { 0x186f, 0x184f, 0x180f, 0x1800, 0x40 }, /* O */
445 { 0x1970, 0x1950, 0x1910, 0x1900, 0x40 }, /* P */
446 { 0x1a5b, 0x1a7b, 0x1a1b, none, none }, /* [{ */
447 { 0x1b5d, 0x1b7d, 0x1b1d, none, none }, /* ]} */
448 { 0x1c0d, 0x1c0d, 0x1c0a, none, none }, /* Enter */
449 { none, none, none, none, none }, /* L Ctrl */
450 { 0x1e61, 0x1e41, 0x1e01, 0x1e00, 0x40 }, /* A */
451 { 0x1f73, 0x1f53, 0x1f13, 0x1f00, 0x40 }, /* S */
452 { 0x2064, 0x2044, 0x2004, 0x2000, 0x40 }, /* D */
453 { 0x2166, 0x2146, 0x2106, 0x2100, 0x40 }, /* F */
454 { 0x2267, 0x2247, 0x2207, 0x2200, 0x40 }, /* G */
455 { 0x2368, 0x2348, 0x2308, 0x2300, 0x40 }, /* H */
456 { 0x246a, 0x244a, 0x240a, 0x2400, 0x40 }, /* J */
457 { 0x256b, 0x254b, 0x250b, 0x2500, 0x40 }, /* K */
458 { 0x266c, 0x264c, 0x260c, 0x2600, 0x40 }, /* L */
459 { 0x273b, 0x273a, none, none, none }, /* ;: */
460 { 0x2827, 0x2822, none, none, none }, /* '" */
461 { 0x2960, 0x297e, none, none, none }, /* `~ */
462 { none, none, none, none, none }, /* L shift */
463 { 0x2b5c, 0x2b7c, 0x2b1c, none, none }, /* |\ */
464 { 0x2c7a, 0x2c5a, 0x2c1a, 0x2c00, 0x40 }, /* Z */
465 { 0x2d78, 0x2d58, 0x2d18, 0x2d00, 0x40 }, /* X */
466 { 0x2e63, 0x2e43, 0x2e03, 0x2e00, 0x40 }, /* C */
467 { 0x2f76, 0x2f56, 0x2f16, 0x2f00, 0x40 }, /* V */
468 { 0x3062, 0x3042, 0x3002, 0x3000, 0x40 }, /* B */
469 { 0x316e, 0x314e, 0x310e, 0x3100, 0x40 }, /* N */
470 { 0x326d, 0x324d, 0x320d, 0x3200, 0x40 }, /* M */
471 { 0x332c, 0x333c, none, none, none }, /* ,< */
472 { 0x342e, 0x343e, none, none, none }, /* .> */
473 { 0x352f, 0x353f, none, none, none }, /* /? */
474 { none, none, none, none, none }, /* R Shift */
475 { 0x372a, 0x372a, none, none, none }, /* * */
476 { none, none, none, none, none }, /* L Alt */
477 { 0x3920, 0x3920, 0x3920, 0x3920, none }, /* space */
478 { none, none, none, none, none }, /* caps lock */
479 { 0x3b00, 0x5400, 0x5e00, 0x6800, none }, /* F1 */
480 { 0x3c00, 0x5500, 0x5f00, 0x6900, none }, /* F2 */
481 { 0x3d00, 0x5600, 0x6000, 0x6a00, none }, /* F3 */
482 { 0x3e00, 0x5700, 0x6100, 0x6b00, none }, /* F4 */
483 { 0x3f00, 0x5800, 0x6200, 0x6c00, none }, /* F5 */
484 { 0x4000, 0x5900, 0x6300, 0x6d00, none }, /* F6 */
485 { 0x4100, 0x5a00, 0x6400, 0x6e00, none }, /* F7 */
486 { 0x4200, 0x5b00, 0x6500, 0x6f00, none }, /* F8 */
487 { 0x4300, 0x5c00, 0x6600, 0x7000, none }, /* F9 */
488 { 0x4400, 0x5d00, 0x6700, 0x7100, none }, /* F10 */
489 { none, none, none, none, none }, /* Num Lock */
490 { none, none, none, none, none }, /* Scroll Lock */
491 { 0x4700, 0x4737, 0x7700, none, 0x20 }, /* 7 Home */
492 { 0x4800, 0x4838, none, none, 0x20 }, /* 8 UP */
493 { 0x4900, 0x4939, 0x8400, none, 0x20 }, /* 9 PgUp */
494 { 0x4a2d, 0x4a2d, none, none, none }, /* - */
495 { 0x4b00, 0x4b34, 0x7300, none, 0x20 }, /* 4 Left */
496 { 0x4c00, 0x4c35, none, none, 0x20 }, /* 5 */
497 { 0x4d00, 0x4d36, 0x7400, none, 0x20 }, /* 6 Right */
498 { 0x4e2b, 0x4e2b, none, none, none }, /* + */
499 { 0x4f00, 0x4f31, 0x7500, none, 0x20 }, /* 1 End */
500 { 0x5000, 0x5032, none, none, 0x20 }, /* 2 Down */
501 { 0x5100, 0x5133, 0x7600, none, 0x20 }, /* 3 PgDn */
502 { 0x5200, 0x5230, none, none, 0x20 }, /* 0 Ins */
503 { 0x5300, 0x532e, none, none, 0x20 }, /* Del */
504 { none, none, none, none, none },
505 { none, none, none, none, none },
506 { 0x565c, 0x567c, none, none, none }, /* \| */
507 { 0x5700, 0x5700, none, none, none }, /* F11 */
508 { 0x5800, 0x5800, none, none, none } /* F12 */
512 process_key(u8 scancode)
514 u8 shift_flags = GET_BDA(kbd_flag0);
515 u8 mf2_flags = GET_BDA(kbd_flag1);
516 u8 mf2_state = GET_BDA(kbd_mode);
520 BX_INFO("KBD: int09 handler: AL=0\n");
523 case 0x3a: /* Caps Lock press */
525 SET_BDA(kbd_flag0, shift_flags);
527 SET_BDA(kbd_flag1, mf2_flags);
529 case 0xba: /* Caps Lock release */
531 SET_BDA(kbd_flag1, mf2_flags);
534 case 0x2a: /* L Shift press */
536 SET_BDA(kbd_flag0, shift_flags);
538 case 0xaa: /* L Shift release */
539 shift_flags &= ~0x02;
540 SET_BDA(kbd_flag0, shift_flags);
543 case 0x36: /* R Shift press */
545 SET_BDA(kbd_flag0, shift_flags);
547 case 0xb6: /* R Shift release */
548 shift_flags &= ~0x01;
549 SET_BDA(kbd_flag0, shift_flags);
552 case 0x1d: /* Ctrl press */
553 if ((mf2_state & 0x01) == 0) {
555 SET_BDA(kbd_flag0, shift_flags);
556 if (mf2_state & 0x02) {
558 SET_BDA(kbd_mode, mf2_state);
561 SET_BDA(kbd_flag1, mf2_flags);
565 case 0x9d: /* Ctrl release */
566 if ((mf2_state & 0x01) == 0) {
567 shift_flags &= ~0x04;
568 SET_BDA(kbd_flag0, shift_flags);
569 if (mf2_state & 0x02) {
571 SET_BDA(kbd_mode, mf2_state);
574 SET_BDA(kbd_flag1, mf2_flags);
579 case 0x38: /* Alt press */
581 SET_BDA(kbd_flag0, shift_flags);
582 if (mf2_state & 0x02) {
584 SET_BDA(kbd_mode, mf2_state);
587 SET_BDA(kbd_flag1, mf2_flags);
590 case 0xb8: /* Alt release */
591 shift_flags &= ~0x08;
592 SET_BDA(kbd_flag0, shift_flags);
593 if (mf2_state & 0x02) {
595 SET_BDA(kbd_mode, mf2_state);
598 SET_BDA(kbd_flag1, mf2_flags);
602 case 0x45: /* Num Lock press */
603 if ((mf2_state & 0x03) == 0) {
605 SET_BDA(kbd_flag1, mf2_flags);
607 SET_BDA(kbd_flag0, shift_flags);
610 case 0xc5: /* Num Lock release */
611 if ((mf2_state & 0x03) == 0) {
613 SET_BDA(kbd_flag1, mf2_flags);
617 case 0x46: /* Scroll Lock press */
619 SET_BDA(kbd_flag1, mf2_flags);
621 SET_BDA(kbd_flag0, shift_flags);
623 case 0xc6: /* Scroll Lock release */
625 SET_BDA(kbd_flag1, mf2_flags);
630 SETBITS_BDA(kbd_mode, 0x02);
634 SETBITS_BDA(kbd_mode, 0x01);
638 if (scancode & 0x80) {
639 break; /* toss key releases ... */
641 if (scancode > MAX_SCAN_CODE) {
642 BX_INFO("KBD: int09h_handler(): unknown scancode read: 0x%02x!\n"
647 struct scaninfo *info = &scan_to_scanascii[scancode];
648 if (shift_flags & 0x08) { /* ALT */
649 asciicode = GET_VAR(CS, info->alt);
650 scancode = GET_VAR(CS, info->alt) >> 8;
651 } else if (shift_flags & 0x04) { /* CONTROL */
652 asciicode = GET_VAR(CS, info->control);
653 scancode = GET_VAR(CS, info->control) >> 8;
654 } else if ((mf2_state & 0x02) > 0
655 && scancode >= 0x47 && scancode <= 0x53) {
656 /* extended keys handling */
658 scancode = GET_VAR(CS, info->normal) >> 8;
659 } else if (shift_flags & 0x03) { /* LSHIFT + RSHIFT */
660 /* check if lock state should be ignored
661 * because a SHIFT key are pressed */
663 if (shift_flags & GET_VAR(CS, info->lock_flags)) {
664 asciicode = GET_VAR(CS, info->normal);
665 scancode = GET_VAR(CS, info->normal) >> 8;
667 asciicode = GET_VAR(CS, info->shift);
668 scancode = GET_VAR(CS, info->shift) >> 8;
671 /* check if lock is on */
672 if (shift_flags & GET_VAR(CS, info->lock_flags)) {
673 asciicode = GET_VAR(CS, info->shift);
674 scancode = GET_VAR(CS, info->shift) >> 8;
676 asciicode = GET_VAR(CS, info->normal);
677 scancode = GET_VAR(CS, info->normal) >> 8;
680 if (scancode==0 && asciicode==0) {
681 BX_INFO("KBD: int09h_handler(): scancode & asciicode are zero?\n");
683 enqueue_key(scancode, asciicode);
686 if ((scancode & 0x7f) != 0x1d) {
690 SET_BDA(kbd_mode, mf2_state);
693 // INT09h : Keyboard Hardware Service Entry Point
700 outb(0xad, PORT_PS2_STATUS);
702 outb(0x0b, PORT_PIC1);
703 if ((inb(PORT_PIC1) & 0x02) == 0)
706 // read key from keyboard controller
707 u8 key = inb(PORT_PS2_DATA);
709 if (CONFIG_KBD_CALL_INT15_4F) {
710 // allow for keyboard intercept
712 memset(&tr, 0, sizeof(tr));
716 call16_int(0x15, &tr);
717 if (!(tr.flags & F_CF))
728 outb(0xae, PORT_PS2_STATUS);