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