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