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" // GET_BDA
9 #include "util.h" // debug_enter
10 #include "config.h" // CONFIG_*
11 #include "pic.h" // eoi_pic1
12 #include "bregs.h" // struct bregs
14 //--------------------------------------------------------------------------
16 //--------------------------------------------------------------------------
18 keyboard_panic(u16 status)
20 // If you're getting a 993 keyboard panic here,
21 // please see the comment in keyboard_init
23 BX_PANIC("Keyboard error:%u\n",status);
30 while ((inb(PORT_PS2_STATUS) & 0x02) && (--max > 0))
31 outb(code, PORT_DIAG);
32 if (!max && code != 0xff)
40 while ( ((inb(PORT_PS2_STATUS) & 0x01) == 0) && (--max>0) )
41 outb(code, PORT_DIAG);
46 //--------------------------------------------------------------------------
48 //--------------------------------------------------------------------------
49 // this file is based on LinuxBIOS implementation of keyboard.c
54 // Coreboot already does low-level keyboard init.
57 /* ------------------- Flush buffers ------------------------*/
58 /* Wait until buffer is empty */
61 /* flush incoming keys */
64 outb(0x00, PORT_DIAG);
65 if (inb(PORT_PS2_STATUS) & 0x01) {
71 // Due to timer issues, and if the IPS setting is > 15000000,
72 // the incoming keys might not be flushed here. That will
73 // cause a panic a few lines below. See sourceforge bug report :
74 // [ 642031 ] FATAL: Keyboard RESET error:993
76 /* ------------------- controller side ----------------------*/
77 /* send cmd = 0xAA, self test 8042 */
78 outb(0xaa, PORT_PS2_STATUS);
83 /* read self-test result, 0x55 should be returned from 0x60 */
84 if (inb(PORT_PS2_DATA) != 0x55)
87 /* send cmd = 0xAB, keyboard interface test */
88 outb(0xab, PORT_PS2_STATUS);
93 /* read keyboard interface test result, */
94 /* 0x00 should be returned form 0x60 */
95 if (inb(PORT_PS2_DATA) != 0x00)
98 /* Enable Keyboard clock */
99 outb(0xae, PORT_PS2_STATUS);
100 outb(0xa8, PORT_PS2_STATUS);
102 /* ------------------- keyboard side ------------------------*/
103 /* reset kerboard and self test (keyboard side) */
104 outb(0xff, PORT_PS2_DATA);
109 /* keyboard should return ACK */
110 if (inb(PORT_PS2_DATA) != 0xfa)
115 if (inb(PORT_PS2_DATA) != 0xaa)
118 /* Disable keyboard */
119 outb(0xf5, PORT_PS2_DATA);
124 /* keyboard should return ACK */
125 if (inb(PORT_PS2_DATA) != 0xfa)
128 /* Write Keyboard Mode */
129 outb(0x60, PORT_PS2_STATUS);
133 /* send cmd: scan code convert, disable mouse, enable IRQ 1 */
134 outb(0x61, PORT_PS2_DATA);
138 /* Enable keyboard */
139 outb(0xf4, PORT_PS2_DATA);
144 /* keyboard should return ACK */
145 if (inb(PORT_PS2_DATA) != 0xfa)
148 outb(0x77, PORT_DIAG);
154 dprintf(3, "init keyboard\n");
155 u16 x = offsetof(struct bios_data_area_s, kbd_buf) - 0x400;
156 SET_BDA(kbd_mode, 0x10);
157 SET_BDA(kbd_buf_head, x);
158 SET_BDA(kbd_buf_tail, x);
159 SET_BDA(kbd_buf_start_offset, x);
161 SET_BDA(kbd_buf_end_offset
162 , x + FIELD_SIZEOF(struct bios_data_area_s, kbd_buf));
166 // Enable IRQ1 (handle_09)
167 unmask_pic1(PIC1_IRQ1);
171 enqueue_key(u8 scan_code, u8 ascii_code)
173 u16 buffer_start = GET_BDA(kbd_buf_start_offset);
174 u16 buffer_end = GET_BDA(kbd_buf_end_offset);
176 u16 buffer_head = GET_BDA(kbd_buf_head);
177 u16 buffer_tail = GET_BDA(kbd_buf_tail);
179 u16 temp_tail = buffer_tail;
181 if (buffer_tail >= buffer_end)
182 buffer_tail = buffer_start;
184 if (buffer_tail == buffer_head)
187 SET_FARVAR(SEG_BDA, *(u8*)(temp_tail+0x400+0), ascii_code);
188 SET_FARVAR(SEG_BDA, *(u8*)(temp_tail+0x400+1), scan_code);
189 SET_BDA(kbd_buf_tail, buffer_tail);
194 dequeue_key(u8 *scan_code, u8 *ascii_code, u8 incr)
199 buffer_head = GET_BDA(kbd_buf_head);
200 buffer_tail = GET_BDA(kbd_buf_tail);
202 if (buffer_head != buffer_tail)
209 *ascii_code = GET_FARVAR(SEG_BDA, *(u8*)(buffer_head+0x400+0));
210 *scan_code = GET_FARVAR(SEG_BDA, *(u8*)(buffer_head+0x400+1));
213 u16 buffer_start = GET_BDA(kbd_buf_start_offset);
214 u16 buffer_end = GET_BDA(kbd_buf_end_offset);
217 if (buffer_head >= buffer_end)
218 buffer_head = buffer_start;
219 SET_BDA(kbd_buf_head, buffer_head);
224 // read keyboard input
226 handle_1600(struct bregs *regs)
228 u8 scan_code, ascii_code;
229 dequeue_key(&scan_code, &ascii_code, 1);
230 if (scan_code != 0 && ascii_code == 0xF0)
232 else if (ascii_code == 0xE0)
234 regs->ax = (scan_code << 8) | ascii_code;
237 // check keyboard status
239 handle_1601(struct bregs *regs)
241 u8 scan_code, ascii_code;
242 if (!dequeue_key(&scan_code, &ascii_code, 0)) {
246 if (scan_code != 0 && ascii_code == 0xF0)
248 else if (ascii_code == 0xE0)
250 regs->ax = (scan_code << 8) | ascii_code;
251 regs->flags &= ~F_ZF;
254 // get shift flag status
256 handle_1602(struct bregs *regs)
258 regs->al = GET_BDA(kbd_flag0);
261 // store key-stroke into buffer
263 handle_1605(struct bregs *regs)
265 regs->al = !enqueue_key(regs->ch, regs->cl);
268 // GET KEYBOARD FUNCTIONALITY
270 handle_1609(struct bregs *regs)
272 // bit Bochs Description
274 // 6 0 INT 16/AH=20h-22h supported (122-key keyboard support)
275 // 5 1 INT 16/AH=10h-12h supported (enhanced keyboard support)
276 // 4 1 INT 16/AH=0Ah supported
277 // 3 0 INT 16/AX=0306h supported
278 // 2 0 INT 16/AX=0305h supported
279 // 1 0 INT 16/AX=0304h supported
280 // 0 0 INT 16/AX=0300h supported
287 handle_160a(struct bregs *regs)
289 outb(0xf2, PORT_PS2_DATA);
292 while ( ((inb(PORT_PS2_STATUS) & 0x01) == 0) && (--max>0) )
293 outb(0x00, PORT_DIAG);
296 if (inb(PORT_PS2_DATA) != 0xfa) {
304 while ( ((inb(PORT_PS2_STATUS) & 0x01) == 0) && (--max>0) )
305 outb(0x00, PORT_DIAG);
308 kbd_code |= (inb(PORT_PS2_DATA) << 8);
314 // read MF-II keyboard input
316 handle_1610(struct bregs *regs)
318 u8 scan_code, ascii_code;
319 dequeue_key(&scan_code, &ascii_code, 1);
320 if (scan_code != 0 && ascii_code == 0xF0)
322 regs->ax = (scan_code << 8) | ascii_code;
325 // check MF-II keyboard status
327 handle_1611(struct bregs *regs)
329 u8 scan_code, ascii_code;
330 if (!dequeue_key(&scan_code, &ascii_code, 0)) {
334 if (scan_code != 0 && ascii_code == 0xF0)
336 regs->ax = (scan_code << 8) | ascii_code;
337 regs->flags &= ~F_ZF;
340 // get extended keyboard status
342 handle_1612(struct bregs *regs)
344 regs->al = GET_BDA(kbd_flag0);
345 regs->ah = (GET_BDA(kbd_flag1) & 0x73) | (GET_BDA(kbd_mode) & 0x0c);
346 //BX_DEBUG_INT16("int16: func 12 sending %04x\n",AX);
350 handle_166f(struct bregs *regs)
352 if (regs->al == 0x08)
353 // unsupported, aka normal keyboard
357 // keyboard capability check called by DOS 5.0+ keyb
359 handle_1692(struct bregs *regs)
361 // function int16 ah=0x10-0x12 supported
365 // 122 keys capability check called by DOS 5.0+ keyb
367 handle_16a2(struct bregs *regs)
369 // don't change AH : function int16 ah=0x20-0x22 NOT supported
375 u8 shift_flags = GET_BDA(kbd_flag0);
376 u8 led_flags = GET_BDA(kbd_led);
377 if (((shift_flags >> 4) & 0x07) ^ ((led_flags & 0x07) == 0))
380 outb(0xed, PORT_PS2_DATA);
381 while ((inb(PORT_PS2_STATUS) & 0x01) == 0)
382 outb(0x21, PORT_DIAG);
383 if (inb(PORT_PS2_DATA) == 0xfa) {
385 led_flags |= (shift_flags >> 4) & 0x07;
386 outb(led_flags & 0x07, PORT_PS2_DATA);
387 while ((inb(PORT_PS2_STATUS) & 0x01) == 0)
388 outb(0x21, PORT_DIAG);
390 SET_BDA(kbd_led, led_flags);
394 // INT 16h Keyboard Service Entry Point
396 handle_16(struct bregs *regs)
398 debug_enter(regs, DEBUG_HDL_16);
405 case 0x00: handle_1600(regs); break;
406 case 0x01: handle_1601(regs); break;
407 case 0x02: handle_1602(regs); break;
408 case 0x05: handle_1605(regs); break;
409 case 0x09: handle_1609(regs); break;
410 case 0x0a: handle_160a(regs); break;
411 case 0x10: handle_1610(regs); break;
412 case 0x11: handle_1611(regs); break;
413 case 0x12: handle_1612(regs); break;
414 case 0x92: handle_1692(regs); break;
415 case 0xa2: handle_16a2(regs); break;
416 case 0x6f: handle_166f(regs); break;
421 #define MAX_SCAN_CODE 0x58
423 static struct scaninfo {
429 } scan_to_scanascii[MAX_SCAN_CODE + 1] = {
430 { none, none, none, none, none },
431 { 0x011b, 0x011b, 0x011b, 0x0100, none }, /* escape */
432 { 0x0231, 0x0221, none, 0x7800, none }, /* 1! */
433 { 0x0332, 0x0340, 0x0300, 0x7900, none }, /* 2@ */
434 { 0x0433, 0x0423, none, 0x7a00, none }, /* 3# */
435 { 0x0534, 0x0524, none, 0x7b00, none }, /* 4$ */
436 { 0x0635, 0x0625, none, 0x7c00, none }, /* 5% */
437 { 0x0736, 0x075e, 0x071e, 0x7d00, none }, /* 6^ */
438 { 0x0837, 0x0826, none, 0x7e00, none }, /* 7& */
439 { 0x0938, 0x092a, none, 0x7f00, none }, /* 8* */
440 { 0x0a39, 0x0a28, none, 0x8000, none }, /* 9( */
441 { 0x0b30, 0x0b29, none, 0x8100, none }, /* 0) */
442 { 0x0c2d, 0x0c5f, 0x0c1f, 0x8200, none }, /* -_ */
443 { 0x0d3d, 0x0d2b, none, 0x8300, none }, /* =+ */
444 { 0x0e08, 0x0e08, 0x0e7f, none, none }, /* backspace */
445 { 0x0f09, 0x0f00, none, none, none }, /* tab */
446 { 0x1071, 0x1051, 0x1011, 0x1000, 0x40 }, /* Q */
447 { 0x1177, 0x1157, 0x1117, 0x1100, 0x40 }, /* W */
448 { 0x1265, 0x1245, 0x1205, 0x1200, 0x40 }, /* E */
449 { 0x1372, 0x1352, 0x1312, 0x1300, 0x40 }, /* R */
450 { 0x1474, 0x1454, 0x1414, 0x1400, 0x40 }, /* T */
451 { 0x1579, 0x1559, 0x1519, 0x1500, 0x40 }, /* Y */
452 { 0x1675, 0x1655, 0x1615, 0x1600, 0x40 }, /* U */
453 { 0x1769, 0x1749, 0x1709, 0x1700, 0x40 }, /* I */
454 { 0x186f, 0x184f, 0x180f, 0x1800, 0x40 }, /* O */
455 { 0x1970, 0x1950, 0x1910, 0x1900, 0x40 }, /* P */
456 { 0x1a5b, 0x1a7b, 0x1a1b, none, none }, /* [{ */
457 { 0x1b5d, 0x1b7d, 0x1b1d, none, none }, /* ]} */
458 { 0x1c0d, 0x1c0d, 0x1c0a, none, none }, /* Enter */
459 { none, none, none, none, none }, /* L Ctrl */
460 { 0x1e61, 0x1e41, 0x1e01, 0x1e00, 0x40 }, /* A */
461 { 0x1f73, 0x1f53, 0x1f13, 0x1f00, 0x40 }, /* S */
462 { 0x2064, 0x2044, 0x2004, 0x2000, 0x40 }, /* D */
463 { 0x2166, 0x2146, 0x2106, 0x2100, 0x40 }, /* F */
464 { 0x2267, 0x2247, 0x2207, 0x2200, 0x40 }, /* G */
465 { 0x2368, 0x2348, 0x2308, 0x2300, 0x40 }, /* H */
466 { 0x246a, 0x244a, 0x240a, 0x2400, 0x40 }, /* J */
467 { 0x256b, 0x254b, 0x250b, 0x2500, 0x40 }, /* K */
468 { 0x266c, 0x264c, 0x260c, 0x2600, 0x40 }, /* L */
469 { 0x273b, 0x273a, none, none, none }, /* ;: */
470 { 0x2827, 0x2822, none, none, none }, /* '" */
471 { 0x2960, 0x297e, none, none, none }, /* `~ */
472 { none, none, none, none, none }, /* L shift */
473 { 0x2b5c, 0x2b7c, 0x2b1c, none, none }, /* |\ */
474 { 0x2c7a, 0x2c5a, 0x2c1a, 0x2c00, 0x40 }, /* Z */
475 { 0x2d78, 0x2d58, 0x2d18, 0x2d00, 0x40 }, /* X */
476 { 0x2e63, 0x2e43, 0x2e03, 0x2e00, 0x40 }, /* C */
477 { 0x2f76, 0x2f56, 0x2f16, 0x2f00, 0x40 }, /* V */
478 { 0x3062, 0x3042, 0x3002, 0x3000, 0x40 }, /* B */
479 { 0x316e, 0x314e, 0x310e, 0x3100, 0x40 }, /* N */
480 { 0x326d, 0x324d, 0x320d, 0x3200, 0x40 }, /* M */
481 { 0x332c, 0x333c, none, none, none }, /* ,< */
482 { 0x342e, 0x343e, none, none, none }, /* .> */
483 { 0x352f, 0x353f, none, none, none }, /* /? */
484 { none, none, none, none, none }, /* R Shift */
485 { 0x372a, 0x372a, none, none, none }, /* * */
486 { none, none, none, none, none }, /* L Alt */
487 { 0x3920, 0x3920, 0x3920, 0x3920, none }, /* space */
488 { none, none, none, none, none }, /* caps lock */
489 { 0x3b00, 0x5400, 0x5e00, 0x6800, none }, /* F1 */
490 { 0x3c00, 0x5500, 0x5f00, 0x6900, none }, /* F2 */
491 { 0x3d00, 0x5600, 0x6000, 0x6a00, none }, /* F3 */
492 { 0x3e00, 0x5700, 0x6100, 0x6b00, none }, /* F4 */
493 { 0x3f00, 0x5800, 0x6200, 0x6c00, none }, /* F5 */
494 { 0x4000, 0x5900, 0x6300, 0x6d00, none }, /* F6 */
495 { 0x4100, 0x5a00, 0x6400, 0x6e00, none }, /* F7 */
496 { 0x4200, 0x5b00, 0x6500, 0x6f00, none }, /* F8 */
497 { 0x4300, 0x5c00, 0x6600, 0x7000, none }, /* F9 */
498 { 0x4400, 0x5d00, 0x6700, 0x7100, none }, /* F10 */
499 { none, none, none, none, none }, /* Num Lock */
500 { none, none, none, none, none }, /* Scroll Lock */
501 { 0x4700, 0x4737, 0x7700, none, 0x20 }, /* 7 Home */
502 { 0x4800, 0x4838, none, none, 0x20 }, /* 8 UP */
503 { 0x4900, 0x4939, 0x8400, none, 0x20 }, /* 9 PgUp */
504 { 0x4a2d, 0x4a2d, none, none, none }, /* - */
505 { 0x4b00, 0x4b34, 0x7300, none, 0x20 }, /* 4 Left */
506 { 0x4c00, 0x4c35, none, none, 0x20 }, /* 5 */
507 { 0x4d00, 0x4d36, 0x7400, none, 0x20 }, /* 6 Right */
508 { 0x4e2b, 0x4e2b, none, none, none }, /* + */
509 { 0x4f00, 0x4f31, 0x7500, none, 0x20 }, /* 1 End */
510 { 0x5000, 0x5032, none, none, 0x20 }, /* 2 Down */
511 { 0x5100, 0x5133, 0x7600, none, 0x20 }, /* 3 PgDn */
512 { 0x5200, 0x5230, none, none, 0x20 }, /* 0 Ins */
513 { 0x5300, 0x532e, none, none, 0x20 }, /* Del */
514 { none, none, none, none, none },
515 { none, none, none, none, none },
516 { 0x565c, 0x567c, none, none, none }, /* \| */
517 { 0x5700, 0x5700, none, none, none }, /* F11 */
518 { 0x5800, 0x5800, none, none, none } /* F12 */
522 process_key(u8 scancode)
524 u8 shift_flags = GET_BDA(kbd_flag0);
525 u8 mf2_flags = GET_BDA(kbd_flag1);
526 u8 mf2_state = GET_BDA(kbd_mode);
530 dprintf(1, "KBD: int09 handler: AL=0\n");
533 case 0x3a: /* Caps Lock press */
535 SET_BDA(kbd_flag0, shift_flags);
537 SET_BDA(kbd_flag1, mf2_flags);
539 case 0xba: /* Caps Lock release */
541 SET_BDA(kbd_flag1, mf2_flags);
544 case 0x2a: /* L Shift press */
546 SET_BDA(kbd_flag0, shift_flags);
548 case 0xaa: /* L Shift release */
549 shift_flags &= ~0x02;
550 SET_BDA(kbd_flag0, shift_flags);
553 case 0x36: /* R Shift press */
555 SET_BDA(kbd_flag0, shift_flags);
557 case 0xb6: /* R Shift release */
558 shift_flags &= ~0x01;
559 SET_BDA(kbd_flag0, shift_flags);
562 case 0x1d: /* Ctrl press */
563 if ((mf2_state & 0x01) == 0) {
565 SET_BDA(kbd_flag0, shift_flags);
566 if (mf2_state & 0x02) {
568 SET_BDA(kbd_mode, mf2_state);
571 SET_BDA(kbd_flag1, mf2_flags);
575 case 0x9d: /* Ctrl release */
576 if ((mf2_state & 0x01) == 0) {
577 shift_flags &= ~0x04;
578 SET_BDA(kbd_flag0, shift_flags);
579 if (mf2_state & 0x02) {
581 SET_BDA(kbd_mode, mf2_state);
584 SET_BDA(kbd_flag1, mf2_flags);
589 case 0x38: /* Alt press */
591 SET_BDA(kbd_flag0, shift_flags);
592 if (mf2_state & 0x02) {
594 SET_BDA(kbd_mode, mf2_state);
597 SET_BDA(kbd_flag1, mf2_flags);
600 case 0xb8: /* Alt release */
601 shift_flags &= ~0x08;
602 SET_BDA(kbd_flag0, shift_flags);
603 if (mf2_state & 0x02) {
605 SET_BDA(kbd_mode, mf2_state);
608 SET_BDA(kbd_flag1, mf2_flags);
612 case 0x45: /* Num Lock press */
613 if ((mf2_state & 0x03) == 0) {
615 SET_BDA(kbd_flag1, mf2_flags);
617 SET_BDA(kbd_flag0, shift_flags);
620 case 0xc5: /* Num Lock release */
621 if ((mf2_state & 0x03) == 0) {
623 SET_BDA(kbd_flag1, mf2_flags);
627 case 0x46: /* Scroll Lock press */
629 SET_BDA(kbd_flag1, mf2_flags);
631 SET_BDA(kbd_flag0, shift_flags);
633 case 0xc6: /* Scroll Lock release */
635 SET_BDA(kbd_flag1, mf2_flags);
640 SETBITS_BDA(kbd_mode, 0x02);
644 SETBITS_BDA(kbd_mode, 0x01);
648 if (scancode & 0x80) {
649 break; /* toss key releases ... */
651 if (scancode > MAX_SCAN_CODE) {
652 dprintf(1, "KBD: int09h_handler(): unknown scancode read: 0x%02x!\n"
657 struct scaninfo *info = &scan_to_scanascii[scancode];
658 if (shift_flags & 0x08) { /* ALT */
659 asciicode = GET_VAR(CS, info->alt);
660 scancode = GET_VAR(CS, info->alt) >> 8;
661 } else if (shift_flags & 0x04) { /* CONTROL */
662 asciicode = GET_VAR(CS, info->control);
663 scancode = GET_VAR(CS, info->control) >> 8;
664 } else if ((mf2_state & 0x02) > 0
665 && scancode >= 0x47 && scancode <= 0x53) {
666 /* extended keys handling */
668 scancode = GET_VAR(CS, info->normal) >> 8;
669 } else if (shift_flags & 0x03) { /* LSHIFT + RSHIFT */
670 /* check if lock state should be ignored
671 * because a SHIFT key are pressed */
673 if (shift_flags & GET_VAR(CS, info->lock_flags)) {
674 asciicode = GET_VAR(CS, info->normal);
675 scancode = GET_VAR(CS, info->normal) >> 8;
677 asciicode = GET_VAR(CS, info->shift);
678 scancode = GET_VAR(CS, info->shift) >> 8;
681 /* check if lock is on */
682 if (shift_flags & GET_VAR(CS, info->lock_flags)) {
683 asciicode = GET_VAR(CS, info->shift);
684 scancode = GET_VAR(CS, info->shift) >> 8;
686 asciicode = GET_VAR(CS, info->normal);
687 scancode = GET_VAR(CS, info->normal) >> 8;
690 if (scancode==0 && asciicode==0) {
691 dprintf(1, "KBD: int09h_handler():"
692 " scancode & asciicode are zero?\n");
694 enqueue_key(scancode, asciicode);
697 if ((scancode & 0x7f) != 0x1d) {
701 SET_BDA(kbd_mode, mf2_state);
704 // INT09h : Keyboard Hardware Service Entry Point
708 debug_isr(DEBUG_ISR_09);
711 outb(0xad, PORT_PS2_STATUS);
713 // Make sure there really is a keyboard irq pending.
714 if (! (get_pic1_isr() & PIC1_IRQ1))
717 // read key from keyboard controller
718 u8 key = inb(PORT_PS2_DATA);
720 if (CONFIG_KBD_CALL_INT15_4F) {
721 // allow for keyboard intercept
723 memset(&tr, 0, sizeof(tr));
727 call16_int(0x15, &tr);
728 if (!(tr.flags & F_CF))
739 outb(0xae, PORT_PS2_STATUS);