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