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
15 // Bit definitions for BDA kbd_flag[012]
16 #define KF0_RSHIFT (1<<0)
17 #define KF0_LSHIFT (1<<1)
18 #define KF0_CTRLACTIVE (1<<2)
19 #define KF0_ALTACTIVE (1<<3)
20 #define KF0_SCROLLACTIVE (1<<4)
21 #define KF0_NUMACTIVE (1<<5)
22 #define KF0_CAPSACTIVE (1<<6)
24 #define KF1_LCTRL (1<<0)
25 #define KF1_LALT (1<<1)
26 #define KF1_SCROLL (1<<4)
27 #define KF1_NUM (1<<5)
28 #define KF1_CAPS (1<<6)
30 #define KF2_LAST_E1 (1<<0)
31 #define KF2_LAST_E0 (1<<1)
32 #define KF2_RCTRL (1<<2)
33 #define KF2_RALT (1<<3)
34 #define KF2_101KBD (1<<4)
39 /* flush incoming keys */
40 int ret = i8042_flush();
44 // Controller self-test.
46 ret = i8042_command(I8042_CMD_CTL_TEST, param);
49 if (param[0] != 0x55) {
50 dprintf(1, "i8042 self test failed (got %x not 0x55)\n", param[0]);
54 // Controller keyboard test.
55 ret = i8042_command(I8042_CMD_KBD_TEST, param);
58 if (param[0] != 0x00) {
59 dprintf(1, "i8042 keyboard test failed (got %x not 0x00)\n", param[0]);
63 // Enable keyboard and mouse ports.
64 ret = i8042_command(I8042_CMD_KBD_ENABLE, NULL);
67 ret = i8042_command(I8042_CMD_AUX_ENABLE, NULL);
72 /* ------------------- keyboard side ------------------------*/
73 /* reset keyboard and self test (keyboard side) */
74 ret = kbd_command(ATKBD_CMD_RESET_BAT, param);
77 if (param[0] != 0xaa) {
78 dprintf(1, "keyboard self test failed (got %x not 0xaa)\n", param[0]);
82 /* Disable keyboard */
83 ret = kbd_command(ATKBD_CMD_RESET_DIS, NULL);
87 // Set scancode command (mode 2)
89 ret = kbd_command(ATKBD_CMD_SSCANSET, param);
93 // Keyboard Mode: scan code convert, disable mouse, enable IRQ 1
94 SET_EBDA(ps2ctr, I8042_CTR_AUXDIS | I8042_CTR_XLATE | I8042_CTR_KBDINT);
97 ret = kbd_command(ATKBD_CMD_ENABLE, NULL);
101 dprintf(1, "keyboard initialized\n");
107 dprintf(3, "init keyboard\n");
108 u16 x = offsetof(struct bios_data_area_s, kbd_buf);
109 SET_BDA(kbd_flag2, KF2_101KBD);
110 SET_BDA(kbd_buf_head, x);
111 SET_BDA(kbd_buf_tail, x);
112 SET_BDA(kbd_buf_start_offset, x);
114 SET_BDA(kbd_buf_end_offset
115 , x + FIELD_SIZEOF(struct bios_data_area_s, kbd_buf));
117 if (! CONFIG_KEYBOARD)
122 enable_hwirq(1, entry_09);
126 enqueue_key(u8 scan_code, u8 ascii_code)
128 u16 buffer_start = GET_BDA(kbd_buf_start_offset);
129 u16 buffer_end = GET_BDA(kbd_buf_end_offset);
131 u16 buffer_head = GET_BDA(kbd_buf_head);
132 u16 buffer_tail = GET_BDA(kbd_buf_tail);
134 u16 temp_tail = buffer_tail;
136 if (buffer_tail >= buffer_end)
137 buffer_tail = buffer_start;
139 if (buffer_tail == buffer_head)
142 SET_FARVAR(SEG_BDA, *(u8*)(temp_tail+0), ascii_code);
143 SET_FARVAR(SEG_BDA, *(u8*)(temp_tail+1), scan_code);
144 SET_BDA(kbd_buf_tail, buffer_tail);
149 dequeue_key(struct bregs *regs, int incr, int extended)
154 buffer_head = GET_BDA(kbd_buf_head);
155 buffer_tail = GET_BDA(kbd_buf_tail);
157 if (buffer_head != buffer_tail)
166 u8 ascii_code = GET_FARVAR(SEG_BDA, *(u8*)(buffer_head+0));
167 u8 scan_code = GET_FARVAR(SEG_BDA, *(u8*)(buffer_head+1));
168 if ((ascii_code == 0xF0 && scan_code != 0)
169 || (ascii_code == 0xE0 && !extended))
171 regs->ax = (scan_code << 8) | ascii_code;
174 regs->flags &= ~F_ZF;
177 u16 buffer_start = GET_BDA(kbd_buf_start_offset);
178 u16 buffer_end = GET_BDA(kbd_buf_end_offset);
181 if (buffer_head >= buffer_end)
182 buffer_head = buffer_start;
183 SET_BDA(kbd_buf_head, buffer_head);
186 // read keyboard input
188 handle_1600(struct bregs *regs)
190 dequeue_key(regs, 1, 0);
193 // check keyboard status
195 handle_1601(struct bregs *regs)
197 dequeue_key(regs, 0, 0);
200 // get shift flag status
202 handle_1602(struct bregs *regs)
204 regs->al = GET_BDA(kbd_flag0);
207 // store key-stroke into buffer
209 handle_1605(struct bregs *regs)
211 regs->al = !enqueue_key(regs->ch, regs->cl);
214 // GET KEYBOARD FUNCTIONALITY
216 handle_1609(struct bregs *regs)
218 // bit Bochs Description
220 // 6 0 INT 16/AH=20h-22h supported (122-key keyboard support)
221 // 5 1 INT 16/AH=10h-12h supported (enhanced keyboard support)
222 // 4 1 INT 16/AH=0Ah supported
223 // 3 0 INT 16/AX=0306h supported
224 // 2 0 INT 16/AX=0305h supported
225 // 1 0 INT 16/AX=0304h supported
226 // 0 0 INT 16/AX=0300h supported
233 handle_160a(struct bregs *regs)
236 int ret = kbd_command(ATKBD_CMD_GETID, param);
241 regs->bx = (param[1] << 8) | param[0];
244 // read MF-II keyboard input
246 handle_1610(struct bregs *regs)
248 dequeue_key(regs, 1, 1);
251 // check MF-II keyboard status
253 handle_1611(struct bregs *regs)
255 dequeue_key(regs, 0, 1);
258 // get extended keyboard status
260 handle_1612(struct bregs *regs)
262 regs->al = GET_BDA(kbd_flag0);
263 regs->ah = ((GET_BDA(kbd_flag1) & ~(KF2_RCTRL|KF2_RALT))
264 | (GET_BDA(kbd_flag2) & (KF2_RCTRL|KF2_RALT)));
265 //BX_DEBUG_INT16("int16: func 12 sending %04x\n",AX);
269 handle_166f(struct bregs *regs)
271 if (regs->al == 0x08)
272 // unsupported, aka normal keyboard
276 // keyboard capability check called by DOS 5.0+ keyb
278 handle_1692(struct bregs *regs)
280 // function int16 ah=0x10-0x12 supported
284 // 122 keys capability check called by DOS 5.0+ keyb
286 handle_16a2(struct bregs *regs)
288 // don't change AH : function int16 ah=0x20-0x22 NOT supported
292 handle_16XX(struct bregs *regs)
300 u8 shift_flags = (GET_BDA(kbd_flag0) >> 4) & 0x07;
301 u8 kbd_led = GET_BDA(kbd_led);
302 u8 led_flags = kbd_led & 0x07;
303 if (shift_flags == led_flags)
306 int ret = kbd_command(ATKBD_CMD_SETLEDS, &shift_flags);
310 kbd_led = (kbd_led & ~0x07) | shift_flags;
311 SET_BDA(kbd_led, kbd_led);
314 // INT 16h Keyboard Service Entry Point
316 handle_16(struct bregs *regs)
318 debug_enter(regs, DEBUG_HDL_16);
319 if (! CONFIG_KEYBOARD)
327 case 0x00: handle_1600(regs); break;
328 case 0x01: handle_1601(regs); break;
329 case 0x02: handle_1602(regs); break;
330 case 0x05: handle_1605(regs); break;
331 case 0x09: handle_1609(regs); break;
332 case 0x0a: handle_160a(regs); break;
333 case 0x10: handle_1610(regs); break;
334 case 0x11: handle_1611(regs); break;
335 case 0x12: handle_1612(regs); break;
336 case 0x92: handle_1692(regs); break;
337 case 0xa2: handle_16a2(regs); break;
338 case 0x6f: handle_166f(regs); break;
339 default: handle_16XX(regs); break;
344 #define MNUM KF0_NUMACTIVE
345 #define MCAP KF0_CAPSACTIVE
347 static struct scaninfo {
353 } scan_to_scanascii[] VAR16 = {
354 { none, none, none, none, none },
355 { 0x011b, 0x011b, 0x011b, 0x0100, none }, /* escape */
356 { 0x0231, 0x0221, none, 0x7800, none }, /* 1! */
357 { 0x0332, 0x0340, 0x0300, 0x7900, none }, /* 2@ */
358 { 0x0433, 0x0423, none, 0x7a00, none }, /* 3# */
359 { 0x0534, 0x0524, none, 0x7b00, none }, /* 4$ */
360 { 0x0635, 0x0625, none, 0x7c00, none }, /* 5% */
361 { 0x0736, 0x075e, 0x071e, 0x7d00, none }, /* 6^ */
362 { 0x0837, 0x0826, none, 0x7e00, none }, /* 7& */
363 { 0x0938, 0x092a, none, 0x7f00, none }, /* 8* */
364 { 0x0a39, 0x0a28, none, 0x8000, none }, /* 9( */
365 { 0x0b30, 0x0b29, none, 0x8100, none }, /* 0) */
366 { 0x0c2d, 0x0c5f, 0x0c1f, 0x8200, none }, /* -_ */
367 { 0x0d3d, 0x0d2b, none, 0x8300, none }, /* =+ */
368 { 0x0e08, 0x0e08, 0x0e7f, none, none }, /* backspace */
369 { 0x0f09, 0x0f00, none, none, none }, /* tab */
370 { 0x1071, 0x1051, 0x1011, 0x1000, MCAP }, /* Q */
371 { 0x1177, 0x1157, 0x1117, 0x1100, MCAP }, /* W */
372 { 0x1265, 0x1245, 0x1205, 0x1200, MCAP }, /* E */
373 { 0x1372, 0x1352, 0x1312, 0x1300, MCAP }, /* R */
374 { 0x1474, 0x1454, 0x1414, 0x1400, MCAP }, /* T */
375 { 0x1579, 0x1559, 0x1519, 0x1500, MCAP }, /* Y */
376 { 0x1675, 0x1655, 0x1615, 0x1600, MCAP }, /* U */
377 { 0x1769, 0x1749, 0x1709, 0x1700, MCAP }, /* I */
378 { 0x186f, 0x184f, 0x180f, 0x1800, MCAP }, /* O */
379 { 0x1970, 0x1950, 0x1910, 0x1900, MCAP }, /* P */
380 { 0x1a5b, 0x1a7b, 0x1a1b, none, none }, /* [{ */
381 { 0x1b5d, 0x1b7d, 0x1b1d, none, none }, /* ]} */
382 { 0x1c0d, 0x1c0d, 0x1c0a, none, none }, /* Enter */
383 { none, none, none, none, none }, /* L Ctrl */
384 { 0x1e61, 0x1e41, 0x1e01, 0x1e00, MCAP }, /* A */
385 { 0x1f73, 0x1f53, 0x1f13, 0x1f00, MCAP }, /* S */
386 { 0x2064, 0x2044, 0x2004, 0x2000, MCAP }, /* D */
387 { 0x2166, 0x2146, 0x2106, 0x2100, MCAP }, /* F */
388 { 0x2267, 0x2247, 0x2207, 0x2200, MCAP }, /* G */
389 { 0x2368, 0x2348, 0x2308, 0x2300, MCAP }, /* H */
390 { 0x246a, 0x244a, 0x240a, 0x2400, MCAP }, /* J */
391 { 0x256b, 0x254b, 0x250b, 0x2500, MCAP }, /* K */
392 { 0x266c, 0x264c, 0x260c, 0x2600, MCAP }, /* L */
393 { 0x273b, 0x273a, none, none, none }, /* ;: */
394 { 0x2827, 0x2822, none, none, none }, /* '" */
395 { 0x2960, 0x297e, none, none, none }, /* `~ */
396 { none, none, none, none, none }, /* L shift */
397 { 0x2b5c, 0x2b7c, 0x2b1c, none, none }, /* |\ */
398 { 0x2c7a, 0x2c5a, 0x2c1a, 0x2c00, MCAP }, /* Z */
399 { 0x2d78, 0x2d58, 0x2d18, 0x2d00, MCAP }, /* X */
400 { 0x2e63, 0x2e43, 0x2e03, 0x2e00, MCAP }, /* C */
401 { 0x2f76, 0x2f56, 0x2f16, 0x2f00, MCAP }, /* V */
402 { 0x3062, 0x3042, 0x3002, 0x3000, MCAP }, /* B */
403 { 0x316e, 0x314e, 0x310e, 0x3100, MCAP }, /* N */
404 { 0x326d, 0x324d, 0x320d, 0x3200, MCAP }, /* M */
405 { 0x332c, 0x333c, none, none, none }, /* ,< */
406 { 0x342e, 0x343e, none, none, none }, /* .> */
407 { 0x352f, 0x353f, none, none, none }, /* /? */
408 { none, none, none, none, none }, /* R Shift */
409 { 0x372a, 0x372a, none, none, none }, /* * */
410 { none, none, none, none, none }, /* L Alt */
411 { 0x3920, 0x3920, 0x3920, 0x3920, none }, /* space */
412 { none, none, none, none, none }, /* caps lock */
413 { 0x3b00, 0x5400, 0x5e00, 0x6800, none }, /* F1 */
414 { 0x3c00, 0x5500, 0x5f00, 0x6900, none }, /* F2 */
415 { 0x3d00, 0x5600, 0x6000, 0x6a00, none }, /* F3 */
416 { 0x3e00, 0x5700, 0x6100, 0x6b00, none }, /* F4 */
417 { 0x3f00, 0x5800, 0x6200, 0x6c00, none }, /* F5 */
418 { 0x4000, 0x5900, 0x6300, 0x6d00, none }, /* F6 */
419 { 0x4100, 0x5a00, 0x6400, 0x6e00, none }, /* F7 */
420 { 0x4200, 0x5b00, 0x6500, 0x6f00, none }, /* F8 */
421 { 0x4300, 0x5c00, 0x6600, 0x7000, none }, /* F9 */
422 { 0x4400, 0x5d00, 0x6700, 0x7100, none }, /* F10 */
423 { none, none, none, none, none }, /* Num Lock */
424 { none, none, none, none, none }, /* Scroll Lock */
425 { 0x4700, 0x4737, 0x7700, none, MNUM }, /* 7 Home */
426 { 0x4800, 0x4838, none, none, MNUM }, /* 8 UP */
427 { 0x4900, 0x4939, 0x8400, none, MNUM }, /* 9 PgUp */
428 { 0x4a2d, 0x4a2d, none, none, none }, /* - */
429 { 0x4b00, 0x4b34, 0x7300, none, MNUM }, /* 4 Left */
430 { 0x4c00, 0x4c35, none, none, MNUM }, /* 5 */
431 { 0x4d00, 0x4d36, 0x7400, none, MNUM }, /* 6 Right */
432 { 0x4e2b, 0x4e2b, none, none, none }, /* + */
433 { 0x4f00, 0x4f31, 0x7500, none, MNUM }, /* 1 End */
434 { 0x5000, 0x5032, none, none, MNUM }, /* 2 Down */
435 { 0x5100, 0x5133, 0x7600, none, MNUM }, /* 3 PgDn */
436 { 0x5200, 0x5230, none, none, MNUM }, /* 0 Ins */
437 { 0x5300, 0x532e, none, none, MNUM }, /* Del */
438 { none, none, none, none, none },
439 { none, none, none, none, none },
440 { 0x565c, 0x567c, none, none, none }, /* \| */
441 { 0x8500, 0x8700, 0x8900, 0x8b00, none }, /* F11 */
442 { 0x8600, 0x8800, 0x8a00, 0x8c00, none }, /* F12 */
445 // Handle a scancode read from the ps2 port. Note that "noinline" is
446 // used to make sure the call to call16_simpint in handle_09 doesn't
447 // have the overhead of this function's stack.
449 process_key(u8 scancode)
451 u8 flags0 = GET_BDA(kbd_flag0);
452 u8 flags1 = GET_BDA(kbd_flag1);
453 u8 flags2 = GET_BDA(kbd_flag2);
455 if (flags2 & KF2_LAST_E1) {
456 // Part of "pause" key (sequence is e1 1d 45 e1 9d c5)
457 if ((scancode & ~0x80) == 0x1d)
458 // Second key of sequence
460 // Third key of sequence
461 if (scancode == 0xc5) {
462 // XXX - do actual pause.
464 flags2 &= ~KF2_LAST_E1;
465 SET_BDA(kbd_flag2, flags2);
471 dprintf(1, "KBD: int09 handler: AL=0\n");
474 case 0x3a: /* Caps Lock press */
475 flags0 ^= KF0_CAPSACTIVE;
478 case 0xba: /* Caps Lock release */
482 case 0x2a: /* L Shift press */
483 flags0 |= KF0_LSHIFT;
485 case 0xaa: /* L Shift release */
486 flags0 &= ~KF0_LSHIFT;
489 case 0x36: /* R Shift press */
490 flags0 |= KF0_RSHIFT;
492 case 0xb6: /* R Shift release */
493 flags0 &= ~KF0_RSHIFT;
496 case 0x1d: /* Ctrl press */
497 flags0 |= KF0_CTRLACTIVE;
498 if (flags2 & KF2_LAST_E0)
503 case 0x9d: /* Ctrl release */
504 flags0 &= ~KF0_CTRLACTIVE;
505 if (flags2 & KF2_LAST_E0)
506 flags2 &= ~KF2_RCTRL;
508 flags1 &= ~KF1_LCTRL;
511 case 0x38: /* Alt press */
512 flags0 |= KF0_ALTACTIVE;
513 if (flags2 & KF2_LAST_E0)
518 case 0xb8: /* Alt release */
519 flags0 &= ~KF0_ALTACTIVE;
520 if (flags2 & KF2_LAST_E0)
526 case 0x45: /* Num Lock press */
528 flags0 ^= KF0_NUMACTIVE;
530 case 0xc5: /* Num Lock release */
534 case 0x46: /* Scroll Lock press */
535 flags1 |= KF1_SCROLL;
536 flags0 ^= KF0_SCROLLACTIVE;
538 case 0xc6: /* Scroll Lock release */
539 flags1 &= ~KF1_SCROLL;
544 flags2 |= KF2_LAST_E0;
545 SET_BDA(kbd_flag2, flags2);
548 // Start of pause key sequence
549 flags2 |= KF2_LAST_E1;
557 && ((flags0 & (KF0_CTRLACTIVE|KF0_ALTACTIVE))
558 == (KF0_CTRLACTIVE|KF0_ALTACTIVE))) {
559 // Ctrl+alt+del - reset machine.
560 SET_BDA(soft_reset_flag, 0x1234);
563 if (scancode >= ARRAY_SIZE(scan_to_scanascii)) {
564 dprintf(1, "KBD: int09h_handler(): unknown scancode read: 0x%02x!\n"
569 struct scaninfo *info = &scan_to_scanascii[scancode];
570 if (flags0 & KF0_ALTACTIVE) {
571 asciicode = GET_GLOBAL(info->alt);
572 scancode = GET_GLOBAL(info->alt) >> 8;
573 } else if (flags0 & KF0_CTRLACTIVE) {
574 asciicode = GET_GLOBAL(info->control);
575 scancode = GET_GLOBAL(info->control) >> 8;
576 } else if (flags2 & KF2_LAST_E0
577 && scancode >= 0x47 && scancode <= 0x53) {
578 /* extended keys handling */
580 scancode = GET_GLOBAL(info->normal) >> 8;
581 } else if (flags0 & (KF0_RSHIFT|KF0_LSHIFT)) {
582 /* check if lock state should be ignored because a SHIFT
585 if (flags0 & GET_GLOBAL(info->lock_flags)) {
586 asciicode = GET_GLOBAL(info->normal);
587 scancode = GET_GLOBAL(info->normal) >> 8;
589 asciicode = GET_GLOBAL(info->shift);
590 scancode = GET_GLOBAL(info->shift) >> 8;
593 /* check if lock is on */
594 if (flags0 & GET_GLOBAL(info->lock_flags)) {
595 asciicode = GET_GLOBAL(info->shift);
596 scancode = GET_GLOBAL(info->shift) >> 8;
598 asciicode = GET_GLOBAL(info->normal);
599 scancode = GET_GLOBAL(info->normal) >> 8;
602 if (scancode==0 && asciicode==0)
603 dprintf(1, "KBD: scancode & asciicode are zero?\n");
604 enqueue_key(scancode, asciicode);
607 flags2 &= ~KF2_LAST_E0;
609 SET_BDA(kbd_flag0, flags0);
610 SET_BDA(kbd_flag1, flags1);
611 SET_BDA(kbd_flag2, flags2);
614 // INT09h : Keyboard Hardware Service Entry Point
618 debug_isr(DEBUG_ISR_09);
619 if (! CONFIG_KEYBOARD)
622 // read key from keyboard controller
623 u8 v = inb(PORT_PS2_STATUS);
624 if ((v & (I8042_STR_OBF|I8042_STR_AUXDATA)) != I8042_STR_OBF) {
625 dprintf(1, "keyboard irq but no keyboard data.\n");
628 u8 key = inb(PORT_PS2_DATA);
630 if (CONFIG_KBD_CALL_INT15_4F) {
631 // allow for keyboard intercept
632 u32 eax = (0x4f << 8) | key;
634 call16_simpint(0x15, &eax, &flags);