2 * This file is part of the Palacios Virtual Machine Monitor developed
3 * by the V3VEE Project with funding from the United States National
4 * Science Foundation and the Department of Energy.
6 * The V3VEE Project is a joint project between Northwestern University
7 * and the University of New Mexico. You can find out more at
10 * Copyright (c) 2008, Peter Dinda <pdinda@northwestern.edu>
11 * Copyright (c) 2008, The V3VEE Project <http://www.v3vee.org>
12 * All rights reserved.
14 * Author: Peter Dinda <pdinda@northwestern.edu>
16 * This is free software. You are permitted to use,
17 * redistribute, and modify it as specified in the file "V3VEE_LICENSE".
20 #include <palacios/vmm.h>
21 #include <palacios/vmm_dev_mgr.h>
22 #include <palacios/vmm_types.h>
24 #include <palacios/vmm_ringbuffer.h>
25 #include <palacios/vmm_lock.h>
28 #ifndef CONFIG_DEBUG_KEYBOARD
30 #define PrintDebug(fmt, args...)
33 #define KEYBOARD_DEBUG_80H 0
37 #define KEYBOARD_60H 0x60 // keyboard microcontroller
38 #define KEYBOARD_64H 0x64 // onboard microcontroller
40 #define KEYBOARD_DELAY_80H 0x80 // written for timing
42 #define KEYBOARD_IRQ 0x1
47 // bits for the output port
48 #define OUTPUT_RESET 0x01 // System reset on 0
49 #define OUTPUT_A20 0x02 // A20 gate (1= A20 is gated)
50 #define OUTPUT_RES1 0x04 // reserved
51 #define OUTPUT_RES2 0x08 // reserved
52 #define OUTPUT_OUTPUT_FULL 0x10 // output buffer full
53 #define OUTPUT_INPUT_EMPTY 0x20 // input buffer empty
54 #define OUTPUT_KBD_CLOCK 0x40 // keyboard clock (?)
55 #define OUTPUT_KBD_DATA 0x80 // keyboard data
57 // bits for the input port
59 #define INPUT_RES0 0x01 // reserved
60 #define INPUT_RES1 0x02 // reserved
61 #define INPUT_RES2 0x04 // reserved
62 #define INPUT_RES3 0x08 // reserved
63 #define INPUT_RAM 0x10 // set to 1 if RAM exists?
64 #define INPUT_JUMPER 0x20 // manufacturing jumper?
65 #define INPUT_DISPLAY 0x40 // 0=color, 1=mono
66 #define INPUT_KBD_INHIBIT 0x80 // 1=inhibit keyboard ?
69 #define MOUSE_ACK 0xfa
71 // for queue operations
75 // for queue operations - whether it's data or cmd waiting on 60h
79 // for queue operations - whether this is keyboard or mouse data on 60h
89 uint8_t irq_en : 1; // 1=interrupts enabled
90 uint8_t mouse_irq_en : 1; // 1=interrupts enabled for mouse
91 uint8_t self_test_ok : 1; // 1= self test passed
92 uint8_t override : 1; // MBZ for PS2
93 uint8_t disable : 1; // 1=disabled keyboard
94 uint8_t mouse_disable : 1; // 1=disabled mouse
95 uint8_t translate : 1; // 1=translate to set 1 scancodes (For PC Compatibility)
96 uint8_t rsvd : 1; // must be zero
97 } __attribute__((packed));
98 } __attribute__((packed));
99 } __attribute__((packed));
108 uint8_t out_buf_full : 1; // 1=full (data for system)
109 uint8_t in_buf_full : 1; // 1=full (data for 8042)
110 uint8_t self_test_ok : 1; // 1=self-test-passed
111 uint8_t cmd : 1; // 0=data on 60h, 1=cmd on 64h
112 uint8_t enabled : 1; // 1=keyboard is enabled
113 uint8_t mouse_buf_full : 1; // 1= mouse output buffer full
114 uint8_t timeout_err : 1; // 1=timeout of keybd
115 uint8_t parity_err : 1; // 1=parity error
116 } __attribute__((packed));
117 } __attribute__((packed));
118 } __attribute__((packed));
125 /* This QUEUE_SIZE must be 256 */
126 /* Its designed this way to cause the start/end index to automatically
127 wrap around (2^8 = 256) so an overrun will automatically readjust the
130 #define QUEUE_SIZE 256
132 uint8_t queue[QUEUE_SIZE];
139 struct keyboard_internal {
141 // 0x60 is the port for the keyboard microcontroller
142 // writes are commands
143 // reads from it usually return scancodes
144 // however, it can also return other data
145 // depending on the state of the onboard microcontroller
147 // 0x64 is the port for the onboard microcontroller
148 // writes are commands
152 // state of the onboard microcontroller
153 // this is needed because sometimes 0x60 reads come
154 // from the onboard microcontroller
155 enum {// Normal mode measn we deliver keys
156 // to the vm and accept commands from it
158 // after receiving cmd 0x60
159 // keybaord uC cmd will subsequently arrive
161 // after recieving 0xa5
162 // password arrives on data port, null terminated
164 // after having a d1 sent to 64
165 // we wait for a new output byte on 60
167 // after having a d2 sent to 64
168 // we wait for a new output byte on 60
169 // then make it available as a keystroke
171 // after having a d3 sent to 64
172 // we wait for a new output byte on 60
173 // then make it available as a mouse event
175 // after having a d4 sent to 64
176 // we wait for a new output byte on 60
177 // then send it to the mouse
179 // After the Keyboard LEDs are enabled
180 // we wait for the output byte on 64?
182 // After the Keyboard SET_RATE is called
183 // we wait for the output byte on 64?
189 // Normal mouse state
191 // this is used for setting sample rate
200 struct status_reg status;
202 uint8_t output_byte; // output port of onboard uC (e.g. A20)
203 uint8_t input_byte; // input port of onboard uC
210 struct queue kbd_queue;
211 struct queue mouse_queue;
217 static int update_kb_irq(struct vm_device * dev) {
218 struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data);
222 state->status.out_buf_full = 0;
223 state->status.mouse_buf_full = 0;
226 // If there is pending Keyboard data then it overrides mouse data
227 if (state->kbd_queue.count > 0) {
228 irq_num = KEYBOARD_IRQ;
229 } else if (state->mouse_queue.count > 0) {
231 state->status.mouse_buf_full = 1;
234 PrintDebug("keyboard: interrupt 0x%d\n", irq_num);
237 // Global output buffer flag (for both Keyboard and mouse)
238 state->status.out_buf_full = 1;
240 if (state->cmd.irq_en == 1) {
241 v3_raise_irq(dev->vm, irq_num);
250 /* Only one byte is read per irq
251 * So if the queue is still full after a data read, we re-raise the irq
252 * If we keep reading an empty queue we return the last queue entry
255 static int push_to_output_queue(struct vm_device * dev, uint8_t value, uint8_t cmd, uint8_t mouse) {
256 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
257 struct queue * q = NULL;
261 q = &(state->mouse_queue);
263 q = &(state->kbd_queue);
266 if (q->count == QUEUE_SIZE) {
271 state->status.cmd = 1;
273 state->status.cmd = 0;
276 q->queue[q->end++] = value;
287 static int pull_from_output_queue(struct vm_device * dev, uint8_t * value) {
288 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
289 struct queue * q = NULL;
291 if (state->kbd_queue.count > 0) {
292 q = &(state->kbd_queue);
293 PrintDebug("Reading from Keyboard Queue\n");
294 } else if (state->mouse_queue.count > 0) {
295 q = &(state->mouse_queue);
296 PrintDebug("Reading from Mouse Queue\n");
298 uint8_t idx = state->kbd_queue.start - 1;
299 PrintDebug("No Data in any queue\n");
300 *value = state->kbd_queue.queue[idx];
304 *value = q->queue[q->start++];
308 PrintDebug("Read from Queue: %x\n", *value);
309 PrintDebug("QStart=%d, QEnd=%d\n", q->start, q->end);
319 static int key_event_handler(struct guest_info * info,
320 struct v3_keyboard_event * evt,
321 void * private_data) {
322 struct vm_device * dev = (struct vm_device *)private_data;
323 struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data);
325 PrintDebug("keyboard: injected status 0x%x, and scancode 0x%x\n", evt->status, evt->scan_code);
327 if (evt->scan_code == 0x44) { // F10 debug dump
328 v3_print_guest_state(info);
329 // PrintGuestPageTables(info, info->shdw_pg_state.guest_cr3);
331 #ifdef CONFIG_SYMBIOTIC
332 else if (evt->scan_code == 0x43) { // F9 Sym test
333 PrintDebug("Testing sym call\n");
334 sym_arg_t a0 = 0x1111;
335 sym_arg_t a1 = 0x2222;
336 sym_arg_t a2 = 0x3333;
337 sym_arg_t a3 = 0x4444;
338 sym_arg_t a4 = 0x5555;
340 v3_sym_call5(info, SYMCALL_TEST, &a0, &a1, &a2, &a3, &a4);
342 V3_Print("Symcall Test Returned arg0=%x, arg1=%x, arg2=%x, arg3=%x, arg4=%x\n",
343 (uint32_t)a0, (uint32_t)a1, (uint32_t)a2, (uint32_t)a3, (uint32_t)a4);
345 } else if (evt->scan_code == 0x42) { // F8 Sym test2
346 PrintDebug("Testing sym call\n");
348 v3_sym_call1(info, SYMCALL_MEM_LOOKUP, &addr);
353 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
355 if ( (state->status.enabled == 1) // onboard is enabled
356 && (state->cmd.disable == 0) ) { // keyboard is enabled
358 push_to_output_queue(dev, evt->scan_code, DATA, KEYBOARD);
361 v3_unlock_irqrestore(state->kb_lock, irq_state);
367 static int mouse_event_handler(struct guest_info * info,
368 struct v3_mouse_event * evt,
369 void * private_data) {
370 struct vm_device * dev = (struct vm_device *)private_data;
371 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
374 PrintDebug("keyboard: injected mouse packet 0x %x %x %x\n",
375 evt->data[0], evt->data[1], evt->data[2]);
377 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
379 switch (state->mouse_state) {
382 if (state->cmd.mouse_disable == 0) {
383 push_to_output_queue(dev, evt->data[0], DATA, MOUSE);
384 push_to_output_queue(dev, evt->data[1], DATA, MOUSE);
385 push_to_output_queue(dev, evt->data[2], DATA, MOUSE);
389 PrintError("Invalid mouse state\n");
395 v3_unlock_irqrestore(state->kb_lock, irq_state);
401 static int keyboard_reset_device(struct vm_device * dev) {
402 struct keyboard_internal * data = (struct keyboard_internal *)(dev->private_data);
404 memset(data, 0, sizeof(struct keyboard_internal));
406 data->state = NORMAL;
407 data->mouse_state = STREAM;
410 // PS2, keyboard+mouse enabled, generic translation
413 data->cmd.irq_en = 1;
414 data->cmd.mouse_irq_en = 1;
415 data->cmd.self_test_ok = 1;
419 // buffers empty, no errors
420 data->status.val = 0;
422 data->status.self_test_ok = 1; // self-tests passed
423 data->status.enabled = 1;// keyboard ready
427 data->output_byte = 0; // ?
429 data->input_byte = INPUT_RAM; // we have some
430 // also display=color, jumper 0, keyboard enabled
432 PrintDebug("keyboard: reset device\n");
440 static int keyboard_start_device(struct vm_device * dev) {
441 PrintDebug("keyboard: start device\n");
446 static int keyboard_stop_device(struct vm_device * dev) {
447 PrintDebug("keyboard: stop device\n");
453 static int mouse_write_output(struct vm_device * dev, uint8_t data) {
454 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
456 switch (state->mouse_state) {
461 if (state->mouse_enabled == 0) {
462 push_to_output_queue(dev, 0xfe, DATA, MOUSE) ; // no mouse!
464 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
465 push_to_output_queue(dev, 0xaa, DATA, MOUSE) ;
466 push_to_output_queue(dev, 0x00, DATA, MOUSE) ;
470 /* case 0xfe: //resend */
471 /* PushToOutputQueue(dev, 0xfa, OVERWRITE, DATA, MOUSE) ; */
472 /* PrintDebug(" mouse resend begins "); */
473 /* state->mouse_done_after_ack = 0; */
474 /* state->mouse_needs_ack = 0; */
475 /* state->mouse_state = STREAM1; */
476 /* return 0; // not done */
479 case 0xf6: // set defaults
480 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
481 PrintDebug(" mouse set defaults ");
485 case 0xf5: // disable data reporting
486 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
487 PrintDebug(" mouse disable data reporting ");
490 case 0xf4: // enable data reporting
491 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
492 PrintDebug(" mouse enable data reporting ");
495 case 0xf3: // set sample rate
496 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
497 state->mouse_state = SAMPLE;
498 PrintDebug(" mouse set sample rate begins ");
501 case 0xf2: // get device id
502 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
503 push_to_output_queue(dev, 0x0, DATA, MOUSE);
504 PrintDebug(" mouse get device id begins ");
507 case 0xf0: // set remote mode
508 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
509 PrintDebug(" mouse set remote mode ");
512 case 0xee: // set wrap mode
513 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
514 PrintError(" mouse set wrap mode (ignored) ");
517 case 0xec: // reset wrap mode
518 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
519 PrintError(" mouse reset wrap mode (ignored) ");
522 case 0xeb: // read data
523 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
524 PrintError(" mouse switch to wrap mode (ignored) ");
527 case 0xea: // set stream mode
528 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
529 PrintDebug(" mouse set stream mode ");
532 case 0xe9: // status request
533 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
534 push_to_output_queue(dev, 0x00, DATA, MOUSE);
535 push_to_output_queue(dev, 0x00, DATA, MOUSE);
536 push_to_output_queue(dev, 0x00, DATA, MOUSE);
537 PrintDebug(" mouse status request begins ");
540 case 0xe8: // set resolution
541 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
542 PrintDebug(" mouse set resolution begins ");
543 state->mouse_state = SET_RES;
546 case 0xe7: // set scaling 2:1
547 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
548 PrintDebug(" mouse set scaling 2:1 ");
551 case 0xe6: // set scaling 1:1
552 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
553 PrintDebug(" mouse set scaling 1:1 ");
557 PrintDebug(" receiving unknown mouse command (0x%x) in acceptable state ", data);
565 PrintDebug(" receiving mouse output in unhandled state (0x%x) ", state->mouse_state);
574 #if KEYBOARD_DEBUG_80H
575 static int keyboard_write_delay(ushort_t port, void * src, uint_t length, struct vm_device * dev) {
578 PrintDebug("keyboard: write of 0x%x to 80h\n", *((uint8_t*)src));
581 PrintDebug("keyboard: write of >1 byte to 80h\n", *((uint8_t*)src));
586 static int keyboard_read_delay(ushort_t port, void * dest, uint_t length, struct vm_device * dev) {
589 *(uint8_t *)dest = v3_inb(port);
591 PrintDebug("keyboard: read of 0x%x from 80h\n", *((uint8_t*)dest));
595 PrintDebug("keyboard: read of >1 byte from 80h\n");
606 static int keyboard_write_command(ushort_t port, void * src, uint_t length, struct vm_device * dev) {
607 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
608 uint8_t cmd = *(uint8_t *)src;
610 // Should always be single byte write
612 PrintError("keyboard: write of >1 bytes (%d) to 64h\n", length);
617 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
619 if (state->state != NORMAL) {
620 PrintDebug("keyboard: warning - receiving command on 64h but state != NORMAL\n");
623 PrintDebug("keyboard: command 0x%x on 64h\n", cmd);
626 case 0x20: // READ COMMAND BYTE (returned in 60h)
627 push_to_output_queue(dev, state->cmd.val, COMMAND, KEYBOARD);
628 PrintDebug("keyboard: command byte 0x%x returned\n", state->cmd.val);
631 case 0x60: // WRITE COMMAND BYTE (read from 60h)
632 state->state = WRITING_CMD_BYTE; // we need to make sure we send the next 0x60 byte appropriately
633 PrintDebug("keyboard: prepare to write command byte\n");
636 // case 0x90-9f - write to output port (?)
638 case 0xa1: // Get version number
639 push_to_output_queue(dev, 0x00, COMMAND, KEYBOARD);
640 PrintDebug("keyboard: version number 0x0 returned\n");
643 case 0xa4: // is password installed? send result to 0x60
644 // we don't support passwords
645 push_to_output_queue(dev, 0xf1, COMMAND, KEYBOARD);
646 PrintDebug("keyboard: password not installed\n");
649 case 0xa5: // new password will arrive on 0x60
650 state->state = TRANSMIT_PASSWD;
651 PrintDebug("keyboard: pepare to transmit password\n");
654 case 0xa6: // check passwd;
655 // since we do not support passwords, we will simply ignore this
656 // the implication is that any password check immediately succeeds
657 // with a blank password
658 PrintDebug("keyboard: password check succeeded\n");
661 case 0xa7: // disable mouse
662 state->cmd.mouse_disable = 1;
663 PrintDebug("keyboard: mouse disabled\n");
666 case 0xa8: // enable mouse
667 state->cmd.mouse_disable = 0;
668 PrintDebug("keyboard: mouse enabled\n");
671 case 0xa9: // mouse interface test (always succeeds)
672 push_to_output_queue(dev, 0x00, COMMAND, KEYBOARD);
673 PrintDebug("keyboard: mouse interface test succeeded\n");
676 case 0xaa: // controller self test (always succeeds)
677 push_to_output_queue(dev, 0x55, COMMAND, KEYBOARD);
678 PrintDebug("keyboard: controller self test succeeded\n");
681 case 0xab: // keyboard interface test (always succeeds)
682 push_to_output_queue(dev, 0, COMMAND, KEYBOARD);
683 PrintDebug("keyboard: keyboard interface test succeeded\n");
686 case 0xad: // disable keyboard
687 state->cmd.disable = 1;
688 PrintDebug("keyboard: keyboard disabled\n");
691 case 0xae: // enable keyboard
692 state->cmd.disable = 0;
693 PrintDebug("keyboard: keyboard enabled\n");
696 case 0xaf: // get version
697 push_to_output_queue(dev, 0x00, COMMAND, KEYBOARD);
698 PrintDebug("keyboard: version 0 returned \n");
701 case 0xd0: // return microcontroller output on 60h
702 push_to_output_queue(dev, state->output_byte, COMMAND, KEYBOARD);
703 PrintDebug("keyboard: output byte 0x%x returned\n", state->output_byte);
706 case 0xd1: // request to write next byte on 60h to the microcontroller output port
707 state->state = WRITING_OUTPUT_PORT;
708 PrintDebug("keyboard: prepare to write output byte\n");
711 case 0xd2: // write keyboard buffer (inject key)
712 state->state = INJECTING_KEY;
713 PrintDebug("keyboard: prepare to inject key\n");
716 case 0xd3: // write mouse buffer (inject mouse)
717 state->state = INJECTING_MOUSE;
718 PrintDebug("keyboard: prepare to inject mouse\n");
721 case 0xd4: // write mouse device (command to mouse?)
722 state->state = IN_MOUSE;
723 PrintDebug("keyboard: prepare to inject mouse command\n");
726 case 0xc0: // read input port
727 push_to_output_queue(dev, state->input_byte, COMMAND, KEYBOARD);
728 PrintDebug("keyboard: input byte 0x%x returned\n", state->input_byte);
731 case 0xc1: //copy input port lsn to status msn
732 state->status.val &= 0x0f;
733 state->status.val |= (state->input_byte & 0xf) << 4;
734 PrintDebug("keyboard: copied input byte low 4 bits to status reg hi 4 bits\n");
737 case 0xc2: // copy input port msn to status msn
738 state->status.val &= 0x0f;
739 state->status.val |= (state->input_byte & 0xf0);
740 PrintDebug("keyboard: copied input byte hi 4 bits to status reg hi 4 bits\n");
743 case 0xe0: // read test port
744 push_to_output_queue(dev, state->output_byte >> 6, COMMAND, KEYBOARD);
745 PrintDebug("keyboard: read 0x%x from test port\n", state->output_byte >> 6);
749 case 0xf0: // pulse output port
750 case 0xf1: // this should pulse 0..3 of cmd_byte on output port
751 case 0xf2: // instead of what is currently in output_byte (I think)
752 case 0xf3: // main effect is taht if bit zero is zero
753 case 0xf4: // should cause reset
754 case 0xf5: // I doubt anything more recent than a 286 running
755 case 0xf6: // OS2 with the penalty box will care
765 PrintDebug("keyboard: ignoring pulse of 0x%x (low=pulsed) on output port\n", (cmd & 0xf));
768 // case ac diagonstic - returns 16 bytes from keyboard microcontroler on 60h
770 PrintDebug("keyboard: ignoring command (unimplemented)\n");
774 v3_unlock_irqrestore(state->kb_lock, irq_state);
779 static int keyboard_read_status(ushort_t port, void * dest, uint_t length, struct vm_device * dev) {
780 struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data);
783 PrintError("keyboard: >1 byte read for status (64h)\n");
787 PrintDebug("keyboard: read status (64h): ");
789 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
791 *(uint8_t *)dest = state->status.val;
793 v3_unlock_irqrestore(state->kb_lock, irq_state);
795 PrintDebug("0x%x\n", *(uint8_t *)dest);
800 static int keyboard_write_output(ushort_t port, void * src, uint_t length, struct vm_device * dev) {
801 struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data);
805 PrintError("keyboard: write of 60h with >1 byte\n");
809 uint8_t data = *(uint8_t *)src;
811 PrintDebug("keyboard: output 0x%x on 60h\n", data);
813 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
815 switch (state->state) {
816 case WRITING_CMD_BYTE:
817 state->cmd.val = data;
818 state->state = NORMAL;
819 PrintDebug("keyboard: wrote new command byte 0x%x\n", state->cmd.val);
822 case WRITING_OUTPUT_PORT:
823 state->output_byte = data;
824 state->state = NORMAL;
825 PrintDebug("keyboard: wrote new output byte 0x%x\n", state->output_byte);
829 push_to_output_queue(dev, data, COMMAND, KEYBOARD); // probably should be a call to deliver_key_to_vmm()
830 state->state = NORMAL;
831 PrintDebug("keyboard: injected key 0x%x\n", data);
834 case INJECTING_MOUSE:
835 push_to_output_queue(dev, data, DATA, MOUSE);
836 // PrintDebug("keyboard: ignoring injected mouse event 0x%x\n", data);
837 PrintDebug("keyboard: injected mouse event 0x%x\n", data);
838 state->state = NORMAL;
842 PrintDebug("keyboard: mouse action: ");
843 if (mouse_write_output(dev, data)) {
844 state->state = NORMAL;
849 case TRANSMIT_PASSWD:
852 PrintDebug("keyboard: ignoring password character 0x%x\n",data);
855 state->state = NORMAL;
856 PrintDebug("keyboard: done with password\n");
861 PrintDebug("Keyboard: LEDs being set...\n");
862 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
863 state->state = NORMAL;
867 PrintDebug("Keyboard: Rate being set...\n");
868 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
869 state->state = NORMAL;
874 // command is being sent to keyboard controller
877 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD); // ack
878 push_to_output_queue(dev, 0xaa, COMMAND, KEYBOARD);
879 PrintDebug("keyboard: reset complete and acked\n");
882 case 0xf5: // disable scanning
883 case 0xf4: // enable scanning
885 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
886 // should do something here... PAD
887 PrintDebug("keyboard: %s scanning done and acked\n", (data == 0xf5) ? "disable" : "enable");
891 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
892 state->state = SET_RATE;
895 case 0xf2: // get keyboard ID
896 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
897 push_to_output_queue(dev, 0xab, COMMAND, KEYBOARD);
898 push_to_output_queue(dev, 0x83, COMMAND, KEYBOARD);
899 PrintDebug("Keyboard: Requesting Keyboard ID\n");
902 case 0xed: // enable keyboard LEDs
903 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
904 state->state = SET_LEDS;
908 case 0xfd: // set key type make
909 case 0xfc: // set key typ make/break
910 case 0xfb: // set key type typematic
911 case 0xfa: // set all typematic make/break/typematic
912 case 0xf9: // set all make
913 case 0xf8: // set all make/break
914 case 0xf7: // set all typemaktic
915 case 0xf6: // set defaults
916 PrintError("keyboard: unhandled known command 0x%x on output buffer (60h)\n", data);
921 PrintError("keyboard: unhandled unknown command 0x%x on output buffer (60h)\n", data);
922 state->status.out_buf_full = 1;
930 v3_unlock_irqrestore(state->kb_lock, irq_state);
935 static int keyboard_read_input(ushort_t port, void * dest, uint_t length, struct vm_device * dev) {
936 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
939 PrintError("keyboard: unknown size read from input (60h)\n");
943 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
945 pull_from_output_queue(dev, (uint8_t *)dest);
947 v3_unlock_irqrestore(state->kb_lock, irq_state);
949 PrintDebug("keyboard: read from input (60h): 0x%x\n", *(uint8_t *)dest);
959 static int keyboard_free(struct vm_device * dev) {
961 v3_dev_unhook_io(dev, KEYBOARD_60H);
962 v3_dev_unhook_io(dev, KEYBOARD_64H);
963 #if KEYBOARD_DEBUG_80H
964 v3_dev_unhook_io(dev, KEYBOARD_DELAY_80H);
966 keyboard_reset_device(dev);
974 static struct v3_device_ops dev_ops = {
975 .free = keyboard_free,
976 .reset = keyboard_reset_device,
977 .start = keyboard_start_device,
978 .stop = keyboard_stop_device,
984 static int keyboard_init(struct guest_info * vm, void * cfg_data) {
985 struct keyboard_internal * keyboard_state = NULL;
988 PrintDebug("keyboard: init_device\n");
990 keyboard_state = (struct keyboard_internal *)V3_Malloc(sizeof(struct keyboard_internal));
992 keyboard_state->mouse_queue.start = 0;
993 keyboard_state->mouse_queue.end = 0;
994 keyboard_state->mouse_queue.count = 0;
996 keyboard_state->kbd_queue.start = 0;
997 keyboard_state->kbd_queue.end = 0;
998 keyboard_state->kbd_queue.count = 0;
1000 keyboard_state->mouse_enabled = 0;
1002 struct vm_device * dev = v3_allocate_device("KEYBOARD", &dev_ops, keyboard_state);
1004 if (v3_attach_device(vm, dev) == -1) {
1005 PrintError("Could not attach device %s\n", "KEYBOARD");
1010 keyboard_reset_device(dev);
1013 v3_lock_init(&(keyboard_state->kb_lock));
1017 v3_dev_hook_io(dev, KEYBOARD_64H, &keyboard_read_status, &keyboard_write_command);
1018 v3_dev_hook_io(dev, KEYBOARD_60H, &keyboard_read_input, &keyboard_write_output);
1020 v3_hook_host_event(vm, HOST_KEYBOARD_EVT, V3_HOST_EVENT_HANDLER(key_event_handler), dev);
1021 v3_hook_host_event(vm, HOST_MOUSE_EVT, V3_HOST_EVENT_HANDLER(mouse_event_handler), dev);
1024 #if KEYBOARD_DEBUG_80H
1025 v3_dev_hook_io(dev, KEYBOARD_DELAY_80H, &keyboard_read_delay, &keyboard_write_delay);
1030 // We do not hook the IRQ here. Instead, the underlying device driver
1031 // is responsible to call us back
1038 device_register("KEYBOARD", keyboard_init)