src/kbd.c

   1 // 16bit code to handle keyboard requests.
   2 //
   3 // Copyright (C) 2008  Kevin O'Connor <kevin@koconnor.net>
   4 // Copyright (C) 2002  MandrakeSoft S.A.
   5 //
   6 // This file may be distributed under the terms of the GNU LGPLv3 license.
   7
   8 #include "biosvar.h" // GET_BDA
   9 #include "util.h" // debug_enter
  10 #include "config.h" // CONFIG_*
  11 #include "bregs.h" // struct bregs
  12 #include "ps2port.h" // kbd_command
  13
  14 void
  15 kbd_setup(void)
  16 {
  17     dprintf(3, "init keyboard\n");
  18     u16 x = offsetof(struct bios_data_area_s, kbd_buf);
  19     SET_BDA(kbd_flag2, KF2_101KBD);
  20     SET_BDA(kbd_buf_head, x);
  21     SET_BDA(kbd_buf_tail, x);
  22     SET_BDA(kbd_buf_start_offset, x);
  23
  24     SET_BDA(kbd_buf_end_offset
  25             , x + FIELD_SIZEOF(struct bios_data_area_s, kbd_buf));
  26 }
  27
  28 static u8
  29 enqueue_key(u8 scan_code, u8 ascii_code)
  30 {
  31     u16 buffer_start = GET_BDA(kbd_buf_start_offset);
  32     u16 buffer_end   = GET_BDA(kbd_buf_end_offset);
  33
  34     u16 buffer_head = GET_BDA(kbd_buf_head);
  35     u16 buffer_tail = GET_BDA(kbd_buf_tail);
  36
  37     u16 temp_tail = buffer_tail;
  38     buffer_tail += 2;
  39     if (buffer_tail >= buffer_end)
  40         buffer_tail = buffer_start;
  41
  42     if (buffer_tail == buffer_head)
  43         return 0;
  44
  45     SET_FARVAR(SEG_BDA, *(u8*)(temp_tail+0), ascii_code);
  46     SET_FARVAR(SEG_BDA, *(u8*)(temp_tail+1), scan_code);
  47     SET_BDA(kbd_buf_tail, buffer_tail);
  48     return 1;
  49 }
  50
  51 static void
  52 dequeue_key(struct bregs *regs, int incr, int extended)
  53 {
  54     u16 buffer_head;
  55     u16 buffer_tail;
  56     for (;;) {
  57         buffer_head = GET_BDA(kbd_buf_head);
  58         buffer_tail = GET_BDA(kbd_buf_tail);
  59
  60         if (buffer_head != buffer_tail)
  61             break;
  62         if (!incr) {
  63             regs->flags |= F_ZF;
  64             return;
  65         }
  66         wait_irq();
  67     }
  68
  69     u8 ascii_code = GET_FARVAR(SEG_BDA, *(u8*)(buffer_head+0));
  70     u8 scan_code  = GET_FARVAR(SEG_BDA, *(u8*)(buffer_head+1));
  71     if ((ascii_code == 0xF0 && scan_code != 0)
  72         || (ascii_code == 0xE0 && !extended))
  73         ascii_code = 0;
  74     regs->ax = (scan_code << 8) | ascii_code;
  75
  76     if (!incr) {
  77         regs->flags &= ~F_ZF;
  78         return;
  79     }
  80     u16 buffer_start = GET_BDA(kbd_buf_start_offset);
  81     u16 buffer_end   = GET_BDA(kbd_buf_end_offset);
  82
  83     buffer_head += 2;
  84     if (buffer_head >= buffer_end)
  85         buffer_head = buffer_start;
  86     SET_BDA(kbd_buf_head, buffer_head);
  87 }
  88
  89 // read keyboard input
  90 static void
  91 handle_1600(struct bregs *regs)
  92 {
  93     dequeue_key(regs, 1, 0);
  94 }
  95
  96 // check keyboard status
  97 static void
  98 handle_1601(struct bregs *regs)
  99 {
 100     dequeue_key(regs, 0, 0);
 101 }
 102
 103 // get shift flag status
 104 static void
 105 handle_1602(struct bregs *regs)
 106 {
 107     regs->al = GET_BDA(kbd_flag0);
 108 }
 109
 110 // store key-stroke into buffer
 111 static void
 112 handle_1605(struct bregs *regs)
 113 {
 114     regs->al = !enqueue_key(regs->ch, regs->cl);
 115 }
 116
 117 // GET KEYBOARD FUNCTIONALITY
 118 static void
 119 handle_1609(struct bregs *regs)
 120 {
 121     // bit Bochs Description
 122     //  7    0   reserved
 123     //  6    0   INT 16/AH=20h-22h supported (122-key keyboard support)
 124     //  5    1   INT 16/AH=10h-12h supported (enhanced keyboard support)
 125     //  4    1   INT 16/AH=0Ah supported
 126     //  3    0   INT 16/AX=0306h supported
 127     //  2    0   INT 16/AX=0305h supported
 128     //  1    0   INT 16/AX=0304h supported
 129     //  0    0   INT 16/AX=0300h supported
 130     //
 131     regs->al = 0x30;
 132 }
 133
 134 // GET KEYBOARD ID
 135 static void
 136 handle_160a(struct bregs *regs)
 137 {
 138     u8 param[2];
 139     int ret = kbd_command(ATKBD_CMD_GETID, param);
 140     if (ret) {
 141         regs->bx = 0;
 142         return;
 143     }
 144     regs->bx = (param[1] << 8) | param[0];
 145 }
 146
 147 // read MF-II keyboard input
 148 static void
 149 handle_1610(struct bregs *regs)
 150 {
 151     dequeue_key(regs, 1, 1);
 152 }
 153
 154 // check MF-II keyboard status
 155 static void
 156 handle_1611(struct bregs *regs)
 157 {
 158     dequeue_key(regs, 0, 1);
 159 }
 160
 161 // get extended keyboard status
 162 static void
 163 handle_1612(struct bregs *regs)
 164 {
 165     regs->al = GET_BDA(kbd_flag0);
 166     regs->ah = ((GET_BDA(kbd_flag1) & ~(KF2_RCTRL|KF2_RALT))
 167                 | (GET_BDA(kbd_flag2) & (KF2_RCTRL|KF2_RALT)));
 168     //BX_DEBUG_INT16("int16: func 12 sending %04x\n",AX);
 169 }
 170
 171 static void
 172 handle_166f(struct bregs *regs)
 173 {
 174     if (regs->al == 0x08)
 175         // unsupported, aka normal keyboard
 176         regs->ah = 2;
 177 }
 178
 179 // keyboard capability check called by DOS 5.0+ keyb
 180 static void
 181 handle_1692(struct bregs *regs)
 182 {
 183     // function int16 ah=0x10-0x12 supported
 184     regs->ah = 0x80;
 185 }
 186
 187 // 122 keys capability check called by DOS 5.0+ keyb
 188 static void
 189 handle_16a2(struct bregs *regs)
 190 {
 191     // don't change AH : function int16 ah=0x20-0x22 NOT supported
 192 }
 193
 194 static void
 195 handle_16XX(struct bregs *regs)
 196 {
 197     warn_unimplemented(regs);
 198 }
 199
 200 static void
 201 set_leds(void)
 202 {
 203     u8 shift_flags = (GET_BDA(kbd_flag0) >> 4) & 0x07;
 204     u8 kbd_led = GET_BDA(kbd_flag3);
 205     u8 led_flags = kbd_led & 0x07;
 206     if (shift_flags == led_flags)
 207         return;
 208
 209     int ret = kbd_command(ATKBD_CMD_SETLEDS, &shift_flags);
 210     if (ret)
 211         // Error
 212         return;
 213     kbd_led = (kbd_led & ~0x07) | shift_flags;
 214     SET_BDA(kbd_flag3, kbd_led);
 215 }
 216
 217 // INT 16h Keyboard Service Entry Point
 218 void VISIBLE16
 219 handle_16(struct bregs *regs)
 220 {
 221     debug_enter(regs, DEBUG_HDL_16);
 222     if (! CONFIG_KEYBOARD)
 223         return;
 224
 225     // XXX - set_leds should be called from irq handler
 226     set_leds();
 227
 228     switch (regs->ah) {
 229     case 0x00: handle_1600(regs); break;
 230     case 0x01: handle_1601(regs); break;
 231     case 0x02: handle_1602(regs); break;
 232     case 0x05: handle_1605(regs); break;
 233     case 0x09: handle_1609(regs); break;
 234     case 0x0a: handle_160a(regs); break;
 235     case 0x10: handle_1610(regs); break;
 236     case 0x11: handle_1611(regs); break;
 237     case 0x12: handle_1612(regs); break;
 238     case 0x92: handle_1692(regs); break;
 239     case 0xa2: handle_16a2(regs); break;
 240     case 0x6f: handle_166f(regs); break;
 241     default:   handle_16XX(regs); break;
 242     }
 243 }
 244
 245 #define none 0
 246 #define MNUM KF0_NUMACTIVE
 247 #define MCAP KF0_CAPSACTIVE
 248
 249 static struct scaninfo {
 250     u16 normal;
 251     u16 shift;
 252     u16 control;
 253     u16 alt;
 254     u8 lock_flags;
 255 } scan_to_scanascii[] VAR16 = {
 256     {   none,   none,   none,   none, none },
 257     { 0x011b, 0x011b, 0x011b, 0x0100, none }, /* escape */
 258     { 0x0231, 0x0221,   none, 0x7800, none }, /* 1! */
 259     { 0x0332, 0x0340, 0x0300, 0x7900, none }, /* 2@ */
 260     { 0x0433, 0x0423,   none, 0x7a00, none }, /* 3# */
 261     { 0x0534, 0x0524,   none, 0x7b00, none }, /* 4$ */
 262     { 0x0635, 0x0625,   none, 0x7c00, none }, /* 5% */
 263     { 0x0736, 0x075e, 0x071e, 0x7d00, none }, /* 6^ */
 264     { 0x0837, 0x0826,   none, 0x7e00, none }, /* 7& */
 265     { 0x0938, 0x092a,   none, 0x7f00, none }, /* 8* */
 266     { 0x0a39, 0x0a28,   none, 0x8000, none }, /* 9( */
 267     { 0x0b30, 0x0b29,   none, 0x8100, none }, /* 0) */
 268     { 0x0c2d, 0x0c5f, 0x0c1f, 0x8200, none }, /* -_ */
 269     { 0x0d3d, 0x0d2b,   none, 0x8300, none }, /* =+ */
 270     { 0x0e08, 0x0e08, 0x0e7f,   none, none }, /* backspace */
 271     { 0x0f09, 0x0f00,   none,   none, none }, /* tab */
 272     { 0x1071, 0x1051, 0x1011, 0x1000, MCAP }, /* Q */
 273     { 0x1177, 0x1157, 0x1117, 0x1100, MCAP }, /* W */
 274     { 0x1265, 0x1245, 0x1205, 0x1200, MCAP }, /* E */
 275     { 0x1372, 0x1352, 0x1312, 0x1300, MCAP }, /* R */
 276     { 0x1474, 0x1454, 0x1414, 0x1400, MCAP }, /* T */
 277     { 0x1579, 0x1559, 0x1519, 0x1500, MCAP }, /* Y */
 278     { 0x1675, 0x1655, 0x1615, 0x1600, MCAP }, /* U */
 279     { 0x1769, 0x1749, 0x1709, 0x1700, MCAP }, /* I */
 280     { 0x186f, 0x184f, 0x180f, 0x1800, MCAP }, /* O */
 281     { 0x1970, 0x1950, 0x1910, 0x1900, MCAP }, /* P */
 282     { 0x1a5b, 0x1a7b, 0x1a1b,   none, none }, /* [{ */
 283     { 0x1b5d, 0x1b7d, 0x1b1d,   none, none }, /* ]} */
 284     { 0x1c0d, 0x1c0d, 0x1c0a,   none, none }, /* Enter */
 285     {   none,   none,   none,   none, none }, /* L Ctrl */
 286     { 0x1e61, 0x1e41, 0x1e01, 0x1e00, MCAP }, /* A */
 287     { 0x1f73, 0x1f53, 0x1f13, 0x1f00, MCAP }, /* S */
 288     { 0x2064, 0x2044, 0x2004, 0x2000, MCAP }, /* D */
 289     { 0x2166, 0x2146, 0x2106, 0x2100, MCAP }, /* F */
 290     { 0x2267, 0x2247, 0x2207, 0x2200, MCAP }, /* G */
 291     { 0x2368, 0x2348, 0x2308, 0x2300, MCAP }, /* H */
 292     { 0x246a, 0x244a, 0x240a, 0x2400, MCAP }, /* J */
 293     { 0x256b, 0x254b, 0x250b, 0x2500, MCAP }, /* K */
 294     { 0x266c, 0x264c, 0x260c, 0x2600, MCAP }, /* L */
 295     { 0x273b, 0x273a,   none,   none, none }, /* ;: */
 296     { 0x2827, 0x2822,   none,   none, none }, /* '" */
 297     { 0x2960, 0x297e,   none,   none, none }, /* `~ */
 298     {   none,   none,   none,   none, none }, /* L shift */
 299     { 0x2b5c, 0x2b7c, 0x2b1c,   none, none }, /* |\ */
 300     { 0x2c7a, 0x2c5a, 0x2c1a, 0x2c00, MCAP }, /* Z */
 301     { 0x2d78, 0x2d58, 0x2d18, 0x2d00, MCAP }, /* X */
 302     { 0x2e63, 0x2e43, 0x2e03, 0x2e00, MCAP }, /* C */
 303     { 0x2f76, 0x2f56, 0x2f16, 0x2f00, MCAP }, /* V */
 304     { 0x3062, 0x3042, 0x3002, 0x3000, MCAP }, /* B */
 305     { 0x316e, 0x314e, 0x310e, 0x3100, MCAP }, /* N */
 306     { 0x326d, 0x324d, 0x320d, 0x3200, MCAP }, /* M */
 307     { 0x332c, 0x333c,   none,   none, none }, /* ,< */
 308     { 0x342e, 0x343e,   none,   none, none }, /* .> */
 309     { 0x352f, 0x353f,   none,   none, none }, /* /? */
 310     {   none,   none,   none,   none, none }, /* R Shift */
 311     { 0x372a, 0x372a,   none,   none, none }, /* * */
 312     {   none,   none,   none,   none, none }, /* L Alt */
 313     { 0x3920, 0x3920, 0x3920, 0x3920, none }, /* space */
 314     {   none,   none,   none,   none, none }, /* caps lock */
 315     { 0x3b00, 0x5400, 0x5e00, 0x6800, none }, /* F1 */
 316     { 0x3c00, 0x5500, 0x5f00, 0x6900, none }, /* F2 */
 317     { 0x3d00, 0x5600, 0x6000, 0x6a00, none }, /* F3 */
 318     { 0x3e00, 0x5700, 0x6100, 0x6b00, none }, /* F4 */
 319     { 0x3f00, 0x5800, 0x6200, 0x6c00, none }, /* F5 */
 320     { 0x4000, 0x5900, 0x6300, 0x6d00, none }, /* F6 */
 321     { 0x4100, 0x5a00, 0x6400, 0x6e00, none }, /* F7 */
 322     { 0x4200, 0x5b00, 0x6500, 0x6f00, none }, /* F8 */
 323     { 0x4300, 0x5c00, 0x6600, 0x7000, none }, /* F9 */
 324     { 0x4400, 0x5d00, 0x6700, 0x7100, none }, /* F10 */
 325     {   none,   none,   none,   none, none }, /* Num Lock */
 326     {   none,   none,   none,   none, none }, /* Scroll Lock */
 327     { 0x4700, 0x4737, 0x7700,   none, MNUM }, /* 7 Home */
 328     { 0x4800, 0x4838,   none,   none, MNUM }, /* 8 UP */
 329     { 0x4900, 0x4939, 0x8400,   none, MNUM }, /* 9 PgUp */
 330     { 0x4a2d, 0x4a2d,   none,   none, none }, /* - */
 331     { 0x4b00, 0x4b34, 0x7300,   none, MNUM }, /* 4 Left */
 332     { 0x4c00, 0x4c35,   none,   none, MNUM }, /* 5 */
 333     { 0x4d00, 0x4d36, 0x7400,   none, MNUM }, /* 6 Right */
 334     { 0x4e2b, 0x4e2b,   none,   none, none }, /* + */
 335     { 0x4f00, 0x4f31, 0x7500,   none, MNUM }, /* 1 End */
 336     { 0x5000, 0x5032,   none,   none, MNUM }, /* 2 Down */
 337     { 0x5100, 0x5133, 0x7600,   none, MNUM }, /* 3 PgDn */
 338     { 0x5200, 0x5230,   none,   none, MNUM }, /* 0 Ins */
 339     { 0x5300, 0x532e,   none,   none, MNUM }, /* Del */
 340     {   none,   none,   none,   none, none },
 341     {   none,   none,   none,   none, none },
 342     { 0x565c, 0x567c,   none,   none, none }, /* \| */
 343     { 0x8500, 0x8700, 0x8900, 0x8b00, none }, /* F11 */
 344     { 0x8600, 0x8800, 0x8a00, 0x8c00, none }, /* F12 */
 345 };
 346
 347 // Handle a scancode read from the ps2 port.  Note that "noinline" is
 348 // used to make sure the call to call16_simpint in process_key doesn't
 349 // have the overhead of this function's stack.
 350 static void noinline
 351 __process_key(u8 scancode)
 352 {
 353     u8 flags0 = GET_BDA(kbd_flag0);
 354     u8 flags1 = GET_BDA(kbd_flag1);
 355     u8 flags2 = GET_BDA(kbd_flag2);
 356
 357     if (flags2 & KF2_LAST_E1) {
 358         // Part of "pause" key (sequence is e1 1d 45 e1 9d c5)
 359         if ((scancode & ~0x80) == 0x1d)
 360             // Second key of sequence
 361             return;
 362         // Third key of sequence - clear flag.
 363         flags2 &= ~KF2_LAST_E1;
 364         SET_BDA(kbd_flag2, flags2);
 365
 366         if (scancode == 0xc5) {
 367             // Final key in sequence.
 368
 369             // XXX - do actual pause.
 370         }
 371         return;
 372     }
 373
 374     // XXX - PrtScr should cause int 0x05
 375     // XXX - Ctrl+Break should cause int 0x1B
 376     // XXX - SysReq should cause int 0x15/0x85
 377
 378     switch (scancode) {
 379     case 0x00:
 380         dprintf(1, "KBD: int09 handler: AL=0\n");
 381         return;
 382
 383     case 0x3a: /* Caps Lock press */
 384         flags0 ^= KF0_CAPSACTIVE;
 385         flags1 |= KF1_CAPS;
 386         break;
 387     case 0xba: /* Caps Lock release */
 388         flags1 &= ~KF1_CAPS;
 389         break;
 390
 391     case 0x2a: /* L Shift press */
 392         flags0 |= KF0_LSHIFT;
 393         break;
 394     case 0xaa: /* L Shift release */
 395         flags0 &= ~KF0_LSHIFT;
 396         break;
 397
 398     case 0x36: /* R Shift press */
 399         flags0 |= KF0_RSHIFT;
 400         break;
 401     case 0xb6: /* R Shift release */
 402         flags0 &= ~KF0_RSHIFT;
 403         break;
 404
 405     case 0x1d: /* Ctrl press */
 406         flags0 |= KF0_CTRLACTIVE;
 407         if (flags2 & KF2_LAST_E0)
 408             flags2 |= KF2_RCTRL;
 409         else
 410             flags1 |= KF1_LCTRL;
 411         break;
 412     case 0x9d: /* Ctrl release */
 413         flags0 &= ~KF0_CTRLACTIVE;
 414         if (flags2 & KF2_LAST_E0)
 415             flags2 &= ~KF2_RCTRL;
 416         else
 417             flags1 &= ~KF1_LCTRL;
 418         break;
 419
 420     case 0x38: /* Alt press */
 421         flags0 |= KF0_ALTACTIVE;
 422         if (flags2 & KF2_LAST_E0)
 423             flags2 |= KF2_RALT;
 424         else
 425             flags1 |= KF1_LALT;
 426         break;
 427     case 0xb8: /* Alt release */
 428         flags0 &= ~KF0_ALTACTIVE;
 429         if (flags2 & KF2_LAST_E0)
 430             flags2 &= ~KF2_RALT;
 431         else
 432             flags1 &= ~KF1_LALT;
 433         break;
 434
 435     case 0x45: /* Num Lock press */
 436         flags1 |= KF1_NUM;
 437         flags0 ^= KF0_NUMACTIVE;
 438         break;
 439     case 0xc5: /* Num Lock release */
 440         flags1 &= ~KF1_NUM;
 441         break;
 442
 443     case 0x46: /* Scroll Lock press */
 444         flags1 |= KF1_SCROLL;
 445         flags0 ^= KF0_SCROLLACTIVE;
 446         break;
 447     case 0xc6: /* Scroll Lock release */
 448         flags1 &= ~KF1_SCROLL;
 449         break;
 450
 451     case 0xe0:
 452         // Extended key
 453         flags2 |= KF2_LAST_E0;
 454         SET_BDA(kbd_flag2, flags2);
 455         return;
 456     case 0xe1:
 457         // Start of pause key sequence
 458         flags2 |= KF2_LAST_E1;
 459         break;
 460
 461     default:
 462         if (scancode & 0x80)
 463             // toss key releases
 464             break;
 465         if (scancode == 0x53
 466             && ((flags0 & (KF0_CTRLACTIVE|KF0_ALTACTIVE))
 467                 == (KF0_CTRLACTIVE|KF0_ALTACTIVE))) {
 468             // Ctrl+alt+del - reset machine.
 469             SET_BDA(soft_reset_flag, 0x1234);
 470             reset_vector();
 471         }
 472         if (scancode >= ARRAY_SIZE(scan_to_scanascii)) {
 473             dprintf(1, "KBD: int09h_handler(): unknown scancode read: 0x%02x!\n"
 474                     , scancode);
 475             return;
 476         }
 477         u8 asciicode;
 478         struct scaninfo *info = &scan_to_scanascii[scancode];
 479         if (flags0 & KF0_ALTACTIVE) {
 480             asciicode = GET_GLOBAL(info->alt);
 481             scancode = GET_GLOBAL(info->alt) >> 8;
 482         } else if (flags0 & KF0_CTRLACTIVE) {
 483             asciicode = GET_GLOBAL(info->control);
 484             scancode = GET_GLOBAL(info->control) >> 8;
 485         } else if (flags2 & KF2_LAST_E0
 486                    && scancode >= 0x47 && scancode <= 0x53) {
 487             /* extended keys handling */
 488             asciicode = 0xe0;
 489             scancode = GET_GLOBAL(info->normal) >> 8;
 490         } else if (flags0 & (KF0_RSHIFT|KF0_LSHIFT)) {
 491             /* check if lock state should be ignored because a SHIFT
 492              * key is pressed */
 493
 494             if (flags0 & GET_GLOBAL(info->lock_flags)) {
 495                 asciicode = GET_GLOBAL(info->normal);
 496                 scancode = GET_GLOBAL(info->normal) >> 8;
 497             } else {
 498                 asciicode = GET_GLOBAL(info->shift);
 499                 scancode = GET_GLOBAL(info->shift) >> 8;
 500             }
 501         } else {
 502             /* check if lock is on */
 503             if (flags0 & GET_GLOBAL(info->lock_flags)) {
 504                 asciicode = GET_GLOBAL(info->shift);
 505                 scancode = GET_GLOBAL(info->shift) >> 8;
 506             } else {
 507                 asciicode = GET_GLOBAL(info->normal);
 508                 scancode = GET_GLOBAL(info->normal) >> 8;
 509             }
 510         }
 511         if (scancode==0 && asciicode==0)
 512             dprintf(1, "KBD: scancode & asciicode are zero?\n");
 513         enqueue_key(scancode, asciicode);
 514         break;
 515     }
 516     flags2 &= ~KF2_LAST_E0;
 517
 518     SET_BDA(kbd_flag0, flags0);
 519     SET_BDA(kbd_flag1, flags1);
 520     SET_BDA(kbd_flag2, flags2);
 521 }
 522
 523 void
 524 process_key(u8 key)
 525 {
 526     if (!CONFIG_KEYBOARD)
 527         return;
 528
 529     if (CONFIG_KBD_CALL_INT15_4F) {
 530         // allow for keyboard intercept
 531         u32 eax = (0x4f << 8) | key;
 532         u32 flags;
 533         call16_simpint(0x15, &eax, &flags);
 534         if (!(flags & F_CF))
 535             return;
 536         key = eax;
 537     }
 538     __process_key(key);
 539 }