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 LGPLv3 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
13 #include "ps2port.h" // i8042_flush
19 // Coreboot already does low-level keyboard init.
22 /* flush incoming keys */
23 int ret = i8042_flush();
27 // Controller self-test.
29 ret = i8042_command(I8042_CMD_CTL_TEST, param);
32 if (param[0] != 0x55) {
33 dprintf(1, "i8042 self test failed (got %x not 0x55)\n", param[0]);
37 // Controller keyboard test.
38 ret = i8042_command(I8042_CMD_KBD_TEST, param);
41 if (param[0] != 0x00) {
42 dprintf(1, "i8042 keyboard test failed (got %x not 0x00)\n", param[0]);
46 // Enable keyboard and mouse ports.
47 ret = i8042_command(I8042_CMD_KBD_ENABLE, NULL);
50 ret = i8042_command(I8042_CMD_AUX_ENABLE, NULL);
55 /* ------------------- keyboard side ------------------------*/
56 /* reset keyboard and self test (keyboard side) */
57 ret = kbd_command(ATKBD_CMD_RESET_BAT, param);
58 if (ret != 0 && ret != 2)
60 if (param[0] != 0xaa) {
61 dprintf(1, "keyboard self test failed (got %x not 0xaa)\n", param[0]);
65 /* Disable keyboard */
66 ret = kbd_command(ATKBD_CMD_RESET_DIS, NULL);
71 // Keyboard Mode: scan code convert, disable mouse, enable IRQ 1
72 SET_EBDA(ps2ctr, I8042_CTR_AUXDIS | I8042_CTR_XLATE | I8042_CTR_KBDINT);
75 ret = kbd_command(ATKBD_CMD_ENABLE, NULL);
79 dprintf(1, "keyboard initialized\n");
85 dprintf(3, "init keyboard\n");
86 u16 x = offsetof(struct bios_data_area_s, kbd_buf);
87 SET_BDA(kbd_mode, 0x10);
88 SET_BDA(kbd_buf_head, x);
89 SET_BDA(kbd_buf_tail, x);
90 SET_BDA(kbd_buf_start_offset, x);
92 SET_BDA(kbd_buf_end_offset
93 , x + FIELD_SIZEOF(struct bios_data_area_s, kbd_buf));
95 if (! CONFIG_KEYBOARD)
100 enable_hwirq(1, entry_09);
104 enqueue_key(u8 scan_code, u8 ascii_code)
106 u16 buffer_start = GET_BDA(kbd_buf_start_offset);
107 u16 buffer_end = GET_BDA(kbd_buf_end_offset);
109 u16 buffer_head = GET_BDA(kbd_buf_head);
110 u16 buffer_tail = GET_BDA(kbd_buf_tail);
112 u16 temp_tail = buffer_tail;
114 if (buffer_tail >= buffer_end)
115 buffer_tail = buffer_start;
117 if (buffer_tail == buffer_head)
120 SET_FARVAR(SEG_BDA, *(u8*)(temp_tail+0), ascii_code);
121 SET_FARVAR(SEG_BDA, *(u8*)(temp_tail+1), scan_code);
122 SET_BDA(kbd_buf_tail, buffer_tail);
127 dequeue_key(struct bregs *regs, int incr, int extended)
132 buffer_head = GET_BDA(kbd_buf_head);
133 buffer_tail = GET_BDA(kbd_buf_tail);
135 if (buffer_head != buffer_tail)
144 u8 ascii_code = GET_FARVAR(SEG_BDA, *(u8*)(buffer_head+0));
145 u8 scan_code = GET_FARVAR(SEG_BDA, *(u8*)(buffer_head+1));
146 if ((ascii_code == 0xF0 && scan_code != 0)
147 || (ascii_code == 0xE0 && !extended))
149 regs->ax = (scan_code << 8) | ascii_code;
152 regs->flags &= ~F_ZF;
155 u16 buffer_start = GET_BDA(kbd_buf_start_offset);
156 u16 buffer_end = GET_BDA(kbd_buf_end_offset);
159 if (buffer_head >= buffer_end)
160 buffer_head = buffer_start;
161 SET_BDA(kbd_buf_head, buffer_head);
164 // read keyboard input
166 handle_1600(struct bregs *regs)
168 dequeue_key(regs, 1, 0);
171 // check keyboard status
173 handle_1601(struct bregs *regs)
175 dequeue_key(regs, 0, 0);
178 // get shift flag status
180 handle_1602(struct bregs *regs)
182 regs->al = GET_BDA(kbd_flag0);
185 // store key-stroke into buffer
187 handle_1605(struct bregs *regs)
189 regs->al = !enqueue_key(regs->ch, regs->cl);
192 // GET KEYBOARD FUNCTIONALITY
194 handle_1609(struct bregs *regs)
196 // bit Bochs Description
198 // 6 0 INT 16/AH=20h-22h supported (122-key keyboard support)
199 // 5 1 INT 16/AH=10h-12h supported (enhanced keyboard support)
200 // 4 1 INT 16/AH=0Ah supported
201 // 3 0 INT 16/AX=0306h supported
202 // 2 0 INT 16/AX=0305h supported
203 // 1 0 INT 16/AX=0304h supported
204 // 0 0 INT 16/AX=0300h supported
211 handle_160a(struct bregs *regs)
214 int ret = kbd_command(ATKBD_CMD_GETID, param);
219 regs->bx = (param[1] << 8) | param[0];
222 // read MF-II keyboard input
224 handle_1610(struct bregs *regs)
226 dequeue_key(regs, 1, 1);
229 // check MF-II keyboard status
231 handle_1611(struct bregs *regs)
233 dequeue_key(regs, 0, 1);
236 // get extended keyboard status
238 handle_1612(struct bregs *regs)
240 regs->al = GET_BDA(kbd_flag0);
241 regs->ah = (GET_BDA(kbd_flag1) & 0x73) | (GET_BDA(kbd_mode) & 0x0c);
242 //BX_DEBUG_INT16("int16: func 12 sending %04x\n",AX);
246 handle_166f(struct bregs *regs)
248 if (regs->al == 0x08)
249 // unsupported, aka normal keyboard
253 // keyboard capability check called by DOS 5.0+ keyb
255 handle_1692(struct bregs *regs)
257 // function int16 ah=0x10-0x12 supported
261 // 122 keys capability check called by DOS 5.0+ keyb
263 handle_16a2(struct bregs *regs)
265 // don't change AH : function int16 ah=0x20-0x22 NOT supported
269 handle_16XX(struct bregs *regs)
277 u8 shift_flags = (GET_BDA(kbd_flag0) >> 4) & 0x07;
278 u8 kbd_led = GET_BDA(kbd_led);
279 u8 led_flags = kbd_led & 0x07;
280 if (shift_flags == led_flags)
283 int ret = kbd_command(ATKBD_CMD_SETLEDS, &shift_flags);
287 kbd_led = (kbd_led & ~0x07) | shift_flags;
288 SET_BDA(kbd_led, kbd_led);
291 // INT 16h Keyboard Service Entry Point
293 handle_16(struct bregs *regs)
295 debug_enter(regs, DEBUG_HDL_16);
296 if (! CONFIG_KEYBOARD)
304 case 0x00: handle_1600(regs); break;
305 case 0x01: handle_1601(regs); break;
306 case 0x02: handle_1602(regs); break;
307 case 0x05: handle_1605(regs); break;
308 case 0x09: handle_1609(regs); break;
309 case 0x0a: handle_160a(regs); break;
310 case 0x10: handle_1610(regs); break;
311 case 0x11: handle_1611(regs); break;
312 case 0x12: handle_1612(regs); break;
313 case 0x92: handle_1692(regs); break;
314 case 0xa2: handle_16a2(regs); break;
315 case 0x6f: handle_166f(regs); break;
316 default: handle_16XX(regs); break;
321 #define MAX_SCAN_CODE 0x58
323 static struct scaninfo {
329 } scan_to_scanascii[MAX_SCAN_CODE + 1] VAR16 = {
330 { none, none, none, none, none },
331 { 0x011b, 0x011b, 0x011b, 0x0100, none }, /* escape */
332 { 0x0231, 0x0221, none, 0x7800, none }, /* 1! */
333 { 0x0332, 0x0340, 0x0300, 0x7900, none }, /* 2@ */
334 { 0x0433, 0x0423, none, 0x7a00, none }, /* 3# */
335 { 0x0534, 0x0524, none, 0x7b00, none }, /* 4$ */
336 { 0x0635, 0x0625, none, 0x7c00, none }, /* 5% */
337 { 0x0736, 0x075e, 0x071e, 0x7d00, none }, /* 6^ */
338 { 0x0837, 0x0826, none, 0x7e00, none }, /* 7& */
339 { 0x0938, 0x092a, none, 0x7f00, none }, /* 8* */
340 { 0x0a39, 0x0a28, none, 0x8000, none }, /* 9( */
341 { 0x0b30, 0x0b29, none, 0x8100, none }, /* 0) */
342 { 0x0c2d, 0x0c5f, 0x0c1f, 0x8200, none }, /* -_ */
343 { 0x0d3d, 0x0d2b, none, 0x8300, none }, /* =+ */
344 { 0x0e08, 0x0e08, 0x0e7f, none, none }, /* backspace */
345 { 0x0f09, 0x0f00, none, none, none }, /* tab */
346 { 0x1071, 0x1051, 0x1011, 0x1000, 0x40 }, /* Q */
347 { 0x1177, 0x1157, 0x1117, 0x1100, 0x40 }, /* W */
348 { 0x1265, 0x1245, 0x1205, 0x1200, 0x40 }, /* E */
349 { 0x1372, 0x1352, 0x1312, 0x1300, 0x40 }, /* R */
350 { 0x1474, 0x1454, 0x1414, 0x1400, 0x40 }, /* T */
351 { 0x1579, 0x1559, 0x1519, 0x1500, 0x40 }, /* Y */
352 { 0x1675, 0x1655, 0x1615, 0x1600, 0x40 }, /* U */
353 { 0x1769, 0x1749, 0x1709, 0x1700, 0x40 }, /* I */
354 { 0x186f, 0x184f, 0x180f, 0x1800, 0x40 }, /* O */
355 { 0x1970, 0x1950, 0x1910, 0x1900, 0x40 }, /* P */
356 { 0x1a5b, 0x1a7b, 0x1a1b, none, none }, /* [{ */
357 { 0x1b5d, 0x1b7d, 0x1b1d, none, none }, /* ]} */
358 { 0x1c0d, 0x1c0d, 0x1c0a, none, none }, /* Enter */
359 { none, none, none, none, none }, /* L Ctrl */
360 { 0x1e61, 0x1e41, 0x1e01, 0x1e00, 0x40 }, /* A */
361 { 0x1f73, 0x1f53, 0x1f13, 0x1f00, 0x40 }, /* S */
362 { 0x2064, 0x2044, 0x2004, 0x2000, 0x40 }, /* D */
363 { 0x2166, 0x2146, 0x2106, 0x2100, 0x40 }, /* F */
364 { 0x2267, 0x2247, 0x2207, 0x2200, 0x40 }, /* G */
365 { 0x2368, 0x2348, 0x2308, 0x2300, 0x40 }, /* H */
366 { 0x246a, 0x244a, 0x240a, 0x2400, 0x40 }, /* J */
367 { 0x256b, 0x254b, 0x250b, 0x2500, 0x40 }, /* K */
368 { 0x266c, 0x264c, 0x260c, 0x2600, 0x40 }, /* L */
369 { 0x273b, 0x273a, none, none, none }, /* ;: */
370 { 0x2827, 0x2822, none, none, none }, /* '" */
371 { 0x2960, 0x297e, none, none, none }, /* `~ */
372 { none, none, none, none, none }, /* L shift */
373 { 0x2b5c, 0x2b7c, 0x2b1c, none, none }, /* |\ */
374 { 0x2c7a, 0x2c5a, 0x2c1a, 0x2c00, 0x40 }, /* Z */
375 { 0x2d78, 0x2d58, 0x2d18, 0x2d00, 0x40 }, /* X */
376 { 0x2e63, 0x2e43, 0x2e03, 0x2e00, 0x40 }, /* C */
377 { 0x2f76, 0x2f56, 0x2f16, 0x2f00, 0x40 }, /* V */
378 { 0x3062, 0x3042, 0x3002, 0x3000, 0x40 }, /* B */
379 { 0x316e, 0x314e, 0x310e, 0x3100, 0x40 }, /* N */
380 { 0x326d, 0x324d, 0x320d, 0x3200, 0x40 }, /* M */
381 { 0x332c, 0x333c, none, none, none }, /* ,< */
382 { 0x342e, 0x343e, none, none, none }, /* .> */
383 { 0x352f, 0x353f, none, none, none }, /* /? */
384 { none, none, none, none, none }, /* R Shift */
385 { 0x372a, 0x372a, none, none, none }, /* * */
386 { none, none, none, none, none }, /* L Alt */
387 { 0x3920, 0x3920, 0x3920, 0x3920, none }, /* space */
388 { none, none, none, none, none }, /* caps lock */
389 { 0x3b00, 0x5400, 0x5e00, 0x6800, none }, /* F1 */
390 { 0x3c00, 0x5500, 0x5f00, 0x6900, none }, /* F2 */
391 { 0x3d00, 0x5600, 0x6000, 0x6a00, none }, /* F3 */
392 { 0x3e00, 0x5700, 0x6100, 0x6b00, none }, /* F4 */
393 { 0x3f00, 0x5800, 0x6200, 0x6c00, none }, /* F5 */
394 { 0x4000, 0x5900, 0x6300, 0x6d00, none }, /* F6 */
395 { 0x4100, 0x5a00, 0x6400, 0x6e00, none }, /* F7 */
396 { 0x4200, 0x5b00, 0x6500, 0x6f00, none }, /* F8 */
397 { 0x4300, 0x5c00, 0x6600, 0x7000, none }, /* F9 */
398 { 0x4400, 0x5d00, 0x6700, 0x7100, none }, /* F10 */
399 { none, none, none, none, none }, /* Num Lock */
400 { none, none, none, none, none }, /* Scroll Lock */
401 { 0x4700, 0x4737, 0x7700, none, 0x20 }, /* 7 Home */
402 { 0x4800, 0x4838, none, none, 0x20 }, /* 8 UP */
403 { 0x4900, 0x4939, 0x8400, none, 0x20 }, /* 9 PgUp */
404 { 0x4a2d, 0x4a2d, none, none, none }, /* - */
405 { 0x4b00, 0x4b34, 0x7300, none, 0x20 }, /* 4 Left */
406 { 0x4c00, 0x4c35, none, none, 0x20 }, /* 5 */
407 { 0x4d00, 0x4d36, 0x7400, none, 0x20 }, /* 6 Right */
408 { 0x4e2b, 0x4e2b, none, none, none }, /* + */
409 { 0x4f00, 0x4f31, 0x7500, none, 0x20 }, /* 1 End */
410 { 0x5000, 0x5032, none, none, 0x20 }, /* 2 Down */
411 { 0x5100, 0x5133, 0x7600, none, 0x20 }, /* 3 PgDn */
412 { 0x5200, 0x5230, none, none, 0x20 }, /* 0 Ins */
413 { 0x5300, 0x532e, none, none, 0x20 }, /* Del */
414 { none, none, none, none, none },
415 { none, none, none, none, none },
416 { 0x565c, 0x567c, none, none, none }, /* \| */
417 { 0x8500, 0x8700, 0x8900, 0x8b00, none }, /* F11 */
418 { 0x8600, 0x8800, 0x8a00, 0x8c00, none }, /* F12 */
421 // Handle a scancode read from the ps2 port. Note that "noinline" is
422 // used to make sure the call to call16_simpint in handle_09 doesn't
423 // have the overhead of this function's stack.
425 process_key(u8 scancode)
427 u8 shift_flags = GET_BDA(kbd_flag0);
428 u8 mf2_flags = GET_BDA(kbd_flag1);
429 u8 mf2_state = GET_BDA(kbd_mode);
433 dprintf(1, "KBD: int09 handler: AL=0\n");
436 case 0x3a: /* Caps Lock press */
438 SET_BDA(kbd_flag0, shift_flags);
440 SET_BDA(kbd_flag1, mf2_flags);
442 case 0xba: /* Caps Lock release */
444 SET_BDA(kbd_flag1, mf2_flags);
447 case 0x2a: /* L Shift press */
449 SET_BDA(kbd_flag0, shift_flags);
451 case 0xaa: /* L Shift release */
452 shift_flags &= ~0x02;
453 SET_BDA(kbd_flag0, shift_flags);
456 case 0x36: /* R Shift press */
458 SET_BDA(kbd_flag0, shift_flags);
460 case 0xb6: /* R Shift release */
461 shift_flags &= ~0x01;
462 SET_BDA(kbd_flag0, shift_flags);
465 case 0x1d: /* Ctrl press */
466 if ((mf2_state & 0x01) == 0) {
468 SET_BDA(kbd_flag0, shift_flags);
469 if (mf2_state & 0x02) {
471 SET_BDA(kbd_mode, mf2_state);
474 SET_BDA(kbd_flag1, mf2_flags);
478 case 0x9d: /* Ctrl release */
479 if ((mf2_state & 0x01) == 0) {
480 shift_flags &= ~0x04;
481 SET_BDA(kbd_flag0, shift_flags);
482 if (mf2_state & 0x02) {
484 SET_BDA(kbd_mode, mf2_state);
487 SET_BDA(kbd_flag1, mf2_flags);
492 case 0x38: /* Alt press */
494 SET_BDA(kbd_flag0, shift_flags);
495 if (mf2_state & 0x02) {
497 SET_BDA(kbd_mode, mf2_state);
500 SET_BDA(kbd_flag1, mf2_flags);
503 case 0xb8: /* Alt release */
504 shift_flags &= ~0x08;
505 SET_BDA(kbd_flag0, shift_flags);
506 if (mf2_state & 0x02) {
508 SET_BDA(kbd_mode, mf2_state);
511 SET_BDA(kbd_flag1, mf2_flags);
515 case 0x45: /* Num Lock press */
516 if ((mf2_state & 0x03) == 0) {
518 SET_BDA(kbd_flag1, mf2_flags);
520 SET_BDA(kbd_flag0, shift_flags);
523 case 0xc5: /* Num Lock release */
524 if ((mf2_state & 0x03) == 0) {
526 SET_BDA(kbd_flag1, mf2_flags);
530 case 0x46: /* Scroll Lock press */
532 SET_BDA(kbd_flag1, mf2_flags);
534 SET_BDA(kbd_flag0, shift_flags);
536 case 0xc6: /* Scroll Lock release */
538 SET_BDA(kbd_flag1, mf2_flags);
543 SETBITS_BDA(kbd_mode, 0x02);
547 SETBITS_BDA(kbd_mode, 0x01);
554 if (scancode == 0x53 && (shift_flags & 0x0c) == 0x0c)
555 // Ctrl+alt+del - reset machine.
557 if (scancode > MAX_SCAN_CODE) {
558 dprintf(1, "KBD: int09h_handler(): unknown scancode read: 0x%02x!\n"
563 struct scaninfo *info = &scan_to_scanascii[scancode];
564 if (shift_flags & 0x08) { /* ALT */
565 asciicode = GET_GLOBAL(info->alt);
566 scancode = GET_GLOBAL(info->alt) >> 8;
567 } else if (shift_flags & 0x04) { /* CONTROL */
568 asciicode = GET_GLOBAL(info->control);
569 scancode = GET_GLOBAL(info->control) >> 8;
570 } else if ((mf2_state & 0x02) > 0
571 && scancode >= 0x47 && scancode <= 0x53) {
572 /* extended keys handling */
574 scancode = GET_GLOBAL(info->normal) >> 8;
575 } else if (shift_flags & 0x03) { /* LSHIFT + RSHIFT */
576 /* check if lock state should be ignored
577 * because a SHIFT key are pressed */
579 if (shift_flags & GET_GLOBAL(info->lock_flags)) {
580 asciicode = GET_GLOBAL(info->normal);
581 scancode = GET_GLOBAL(info->normal) >> 8;
583 asciicode = GET_GLOBAL(info->shift);
584 scancode = GET_GLOBAL(info->shift) >> 8;
587 /* check if lock is on */
588 if (shift_flags & GET_GLOBAL(info->lock_flags)) {
589 asciicode = GET_GLOBAL(info->shift);
590 scancode = GET_GLOBAL(info->shift) >> 8;
592 asciicode = GET_GLOBAL(info->normal);
593 scancode = GET_GLOBAL(info->normal) >> 8;
596 if (scancode==0 && asciicode==0) {
597 dprintf(1, "KBD: int09h_handler():"
598 " scancode & asciicode are zero?\n");
600 enqueue_key(scancode, asciicode);
603 if ((scancode & 0x7f) != 0x1d) {
607 SET_BDA(kbd_mode, mf2_state);
610 // INT09h : Keyboard Hardware Service Entry Point
614 debug_isr(DEBUG_ISR_09);
615 if (! CONFIG_KEYBOARD)
618 // read key from keyboard controller
619 u8 v = inb(PORT_PS2_STATUS);
620 if ((v & (I8042_STR_OBF|I8042_STR_AUXDATA)) != I8042_STR_OBF) {
621 dprintf(1, "keyboard irq but no keyboard data.\n");
624 u8 key = inb(PORT_PS2_DATA);
626 if (CONFIG_KBD_CALL_INT15_4F) {
627 // allow for keyboard intercept
628 u32 eax = (0x4f << 8) | key;
630 call16_simpint(0x15, &eax, &flags);