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>
26 #include <palacios/vmm_intr.h>
27 #include <palacios/vmm_host_events.h>
28 #include <palacios/vm_guest.h>
31 #ifndef CONFIG_DEBUG_KEYBOARD
33 #define PrintDebug(fmt, args...)
36 #define KEYBOARD_DEBUG_80H 0
40 #define KEYBOARD_60H 0x60 // keyboard microcontroller
41 #define KEYBOARD_64H 0x64 // onboard microcontroller
43 #define KEYBOARD_DELAY_80H 0x80 // written for timing
45 #define KEYBOARD_IRQ 0x1
50 // bits for the output port
51 #define OUTPUT_RESET 0x01 // System reset on 0
52 #define OUTPUT_A20 0x02 // A20 gate (1= A20 is gated)
53 #define OUTPUT_RES1 0x04 // reserved
54 #define OUTPUT_RES2 0x08 // reserved
55 #define OUTPUT_OUTPUT_FULL 0x10 // output buffer full
56 #define OUTPUT_INPUT_EMPTY 0x20 // input buffer empty
57 #define OUTPUT_KBD_CLOCK 0x40 // keyboard clock (?)
58 #define OUTPUT_KBD_DATA 0x80 // keyboard data
60 // bits for the input port
62 #define INPUT_RES0 0x01 // reserved
63 #define INPUT_RES1 0x02 // reserved
64 #define INPUT_RES2 0x04 // reserved
65 #define INPUT_RES3 0x08 // reserved
66 #define INPUT_RAM 0x10 // set to 1 if RAM exists?
67 #define INPUT_JUMPER 0x20 // manufacturing jumper?
68 #define INPUT_DISPLAY 0x40 // 0=color, 1=mono
69 #define INPUT_KBD_INHIBIT 0x80 // 1=inhibit keyboard ?
72 #define MOUSE_ACK 0xfa
74 // for queue operations
78 // for queue operations - whether it's data or cmd waiting on 60h
82 // for queue operations - whether this is keyboard or mouse data on 60h
92 uint8_t irq_en : 1; // 1=interrupts enabled
93 uint8_t mouse_irq_en : 1; // 1=interrupts enabled for mouse
94 uint8_t self_test_ok : 1; // 1= self test passed
95 uint8_t override : 1; // MBZ for PS2
96 uint8_t disable : 1; // 1=disabled keyboard
97 uint8_t mouse_disable : 1; // 1=disabled mouse
98 uint8_t translate : 1; // 1=translate to set 1 scancodes (For PC Compatibility)
99 uint8_t rsvd : 1; // must be zero
100 } __attribute__((packed));
101 } __attribute__((packed));
102 } __attribute__((packed));
111 uint8_t out_buf_full : 1; // 1=full (data for system)
112 uint8_t in_buf_full : 1; // 1=full (data for 8042)
113 uint8_t self_test_ok : 1; // 1=self-test-passed
114 uint8_t cmd : 1; // 0=data on 60h, 1=cmd on 64h
115 uint8_t enabled : 1; // 1=keyboard is enabled
116 uint8_t mouse_buf_full : 1; // 1= mouse output buffer full
117 uint8_t timeout_err : 1; // 1=timeout of keybd
118 uint8_t parity_err : 1; // 1=parity error
119 } __attribute__((packed));
120 } __attribute__((packed));
121 } __attribute__((packed));
128 /* This QUEUE_SIZE must be 256 */
129 /* Its designed this way to cause the start/end index to automatically
130 wrap around (2^8 = 256) so an overrun will automatically readjust the
133 #define QUEUE_SIZE 256
135 uint8_t queue[QUEUE_SIZE];
142 struct keyboard_internal {
144 // 0x60 is the port for the keyboard microcontroller
145 // writes are commands
146 // reads from it usually return scancodes
147 // however, it can also return other data
148 // depending on the state of the onboard microcontroller
150 // 0x64 is the port for the onboard microcontroller
151 // writes are commands
155 // state of the onboard microcontroller
156 // this is needed because sometimes 0x60 reads come
157 // from the onboard microcontroller
158 enum {// Normal mode measn we deliver keys
159 // to the vm and accept commands from it
161 // after receiving cmd 0x60
162 // keybaord uC cmd will subsequently arrive
164 // after recieving 0xa5
165 // password arrives on data port, null terminated
167 // after having a d1 sent to 64
168 // we wait for a new output byte on 60
170 // after having a d2 sent to 64
171 // we wait for a new output byte on 60
172 // then make it available as a keystroke
174 // after having a d3 sent to 64
175 // we wait for a new output byte on 60
176 // then make it available as a mouse event
178 // after having a d4 sent to 64
179 // we wait for a new output byte on 60
180 // then send it to the mouse
182 // After the Keyboard LEDs are enabled
183 // we wait for the output byte on 64?
185 // After the Keyboard SET_RATE is called
186 // we wait for the output byte on 64?
192 // Normal mouse state
194 // this is used for setting sample rate
203 struct status_reg status;
205 uint8_t output_byte; // output port of onboard uC (e.g. A20)
206 uint8_t input_byte; // input port of onboard uC
213 struct queue kbd_queue;
214 struct queue mouse_queue;
220 static int update_kb_irq(struct vm_device * dev) {
221 struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data);
225 state->status.out_buf_full = 0;
226 state->status.mouse_buf_full = 0;
229 // If there is pending Keyboard data then it overrides mouse data
230 if (state->kbd_queue.count > 0) {
231 irq_num = KEYBOARD_IRQ;
232 } else if (state->mouse_queue.count > 0) {
234 state->status.mouse_buf_full = 1;
237 PrintDebug("keyboard: interrupt 0x%d\n", irq_num);
240 // Global output buffer flag (for both Keyboard and mouse)
241 state->status.out_buf_full = 1;
243 if (state->cmd.irq_en == 1) {
244 v3_raise_irq(dev->vm, irq_num);
253 /* Only one byte is read per irq
254 * So if the queue is still full after a data read, we re-raise the irq
255 * If we keep reading an empty queue we return the last queue entry
258 static int push_to_output_queue(struct vm_device * dev, uint8_t value, uint8_t cmd, uint8_t mouse) {
259 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
260 struct queue * q = NULL;
264 q = &(state->mouse_queue);
266 q = &(state->kbd_queue);
269 if (q->count == QUEUE_SIZE) {
274 state->status.cmd = 1;
276 state->status.cmd = 0;
279 q->queue[q->end++] = value;
290 static int pull_from_output_queue(struct vm_device * dev, uint8_t * value) {
291 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
292 struct queue * q = NULL;
294 if (state->kbd_queue.count > 0) {
295 q = &(state->kbd_queue);
296 PrintDebug("Reading from Keyboard Queue\n");
297 } else if (state->mouse_queue.count > 0) {
298 q = &(state->mouse_queue);
299 PrintDebug("Reading from Mouse Queue\n");
301 uint8_t idx = state->kbd_queue.start - 1;
302 PrintDebug("No Data in any queue\n");
303 *value = state->kbd_queue.queue[idx];
307 *value = q->queue[q->start++];
311 PrintDebug("Read from Queue: %x\n", *value);
312 PrintDebug("QStart=%d, QEnd=%d\n", q->start, q->end);
320 #include <palacios/vmm_telemetry.h>
323 static int key_event_handler(struct v3_vm_info * vm,
324 struct v3_keyboard_event * evt,
325 void * private_data) {
326 struct vm_device * dev = (struct vm_device *)private_data;
327 struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data);
329 PrintDebug("keyboard: injected status 0x%x, and scancode 0x%x\n", evt->status, evt->scan_code);
331 if (evt->scan_code == 0x44) { // F10 debug dump
333 for (i = 0; i < vm->num_cores; i++) {
334 v3_print_guest_state(&(vm->cores[i]));
336 // PrintGuestPageTables(info, info->shdw_pg_state.guest_cr3);
338 #ifdef CONFIG_SYMBIOTIC
339 else if (evt->scan_code == 0x43) { // F9 Sym test
340 struct guest_info * core = &(vm->cores[0]);
341 PrintDebug("Testing sym call\n");
342 sym_arg_t a0 = 0x1111;
343 sym_arg_t a1 = 0x2222;
344 sym_arg_t a2 = 0x3333;
345 sym_arg_t a3 = 0x4444;
346 sym_arg_t a4 = 0x5555;
347 uint64_t call_start = 0;
348 uint64_t call_end = 0;
350 V3_Print("Exits before symcall: %d\n", (uint32_t)core->num_exits);
353 v3_sym_call5(core, SYMCALL_TEST, &a0, &a1, &a2, &a3, &a4);
356 V3_Print("Symcall latency = %d cycles (%d exits)\n", (uint32_t)(call_end - call_start), (uint32_t)core->num_exits);
358 V3_Print("Symcall Test Returned arg0=%x, arg1=%x, arg2=%x, arg3=%x, arg4=%x\n",
359 (uint32_t)a0, (uint32_t)a1, (uint32_t)a2, (uint32_t)a3, (uint32_t)a4);
363 else if (evt->scan_code == 0x42) { // F8 debug toggle
364 extern int v3_dbg_enable;
366 PrintDebug("Toggling Debugging\n");
368 } else if (evt->scan_code == 0x41) { // F7 telemetry dump
369 #ifdef CONFIG_TELEMETRY
370 v3_print_telemetry(vm);
376 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
378 if ( (state->status.enabled == 1) // onboard is enabled
379 && (state->cmd.disable == 0) ) { // keyboard is enabled
381 push_to_output_queue(dev, evt->scan_code, DATA, KEYBOARD);
384 v3_unlock_irqrestore(state->kb_lock, irq_state);
390 static int mouse_event_handler(struct v3_vm_info * vm,
391 struct v3_mouse_event * evt,
392 void * private_data) {
393 struct vm_device * dev = (struct vm_device *)private_data;
394 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
397 PrintDebug("keyboard: injected mouse packet 0x %x %x %x\n",
398 evt->data[0], evt->data[1], evt->data[2]);
400 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
402 switch (state->mouse_state) {
405 if (state->cmd.mouse_disable == 0) {
406 push_to_output_queue(dev, evt->data[0], DATA, MOUSE);
407 push_to_output_queue(dev, evt->data[1], DATA, MOUSE);
408 push_to_output_queue(dev, evt->data[2], DATA, MOUSE);
412 PrintError("Invalid mouse state\n");
418 v3_unlock_irqrestore(state->kb_lock, irq_state);
424 static int keyboard_reset_device(struct vm_device * dev) {
425 struct keyboard_internal * data = (struct keyboard_internal *)(dev->private_data);
427 memset(data, 0, sizeof(struct keyboard_internal));
429 data->state = NORMAL;
430 data->mouse_state = STREAM;
433 // PS2, keyboard+mouse enabled, generic translation
436 data->cmd.irq_en = 1;
437 data->cmd.mouse_irq_en = 1;
438 data->cmd.self_test_ok = 1;
442 // buffers empty, no errors
443 data->status.val = 0;
445 data->status.self_test_ok = 1; // self-tests passed
446 data->status.enabled = 1;// keyboard ready
450 data->output_byte = 0; // ?
452 data->input_byte = INPUT_RAM; // we have some
453 // also display=color, jumper 0, keyboard enabled
455 PrintDebug("keyboard: reset device\n");
463 static int keyboard_start_device(struct vm_device * dev) {
464 PrintDebug("keyboard: start device\n");
469 static int keyboard_stop_device(struct vm_device * dev) {
470 PrintDebug("keyboard: stop device\n");
476 static int mouse_write_output(struct vm_device * dev, uint8_t data) {
477 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
479 switch (state->mouse_state) {
484 if (state->mouse_enabled == 0) {
485 push_to_output_queue(dev, 0xfe, DATA, MOUSE) ; // no mouse!
487 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
488 push_to_output_queue(dev, 0xaa, DATA, MOUSE) ;
489 push_to_output_queue(dev, 0x00, DATA, MOUSE) ;
493 /* case 0xfe: //resend */
494 /* PushToOutputQueue(dev, 0xfa, OVERWRITE, DATA, MOUSE) ; */
495 /* PrintDebug(" mouse resend begins "); */
496 /* state->mouse_done_after_ack = 0; */
497 /* state->mouse_needs_ack = 0; */
498 /* state->mouse_state = STREAM1; */
499 /* return 0; // not done */
502 case 0xf6: // set defaults
503 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
504 PrintDebug(" mouse set defaults ");
508 case 0xf5: // disable data reporting
509 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
510 PrintDebug(" mouse disable data reporting ");
513 case 0xf4: // enable data reporting
514 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
515 PrintDebug(" mouse enable data reporting ");
518 case 0xf3: // set sample rate
519 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
520 state->mouse_state = SAMPLE;
521 PrintDebug(" mouse set sample rate begins ");
524 case 0xf2: // get device id
525 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
526 push_to_output_queue(dev, 0x0, DATA, MOUSE);
527 PrintDebug(" mouse get device id begins ");
530 case 0xf0: // set remote mode
531 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
532 PrintDebug(" mouse set remote mode ");
535 case 0xee: // set wrap mode
536 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
537 PrintError(" mouse set wrap mode (ignored) ");
540 case 0xec: // reset wrap mode
541 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
542 PrintError(" mouse reset wrap mode (ignored) ");
545 case 0xeb: // read data
546 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
547 PrintError(" mouse switch to wrap mode (ignored) ");
550 case 0xea: // set stream mode
551 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
552 PrintDebug(" mouse set stream mode ");
555 case 0xe9: // status request
556 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
557 push_to_output_queue(dev, 0x00, DATA, MOUSE);
558 push_to_output_queue(dev, 0x00, DATA, MOUSE);
559 push_to_output_queue(dev, 0x00, DATA, MOUSE);
560 PrintDebug(" mouse status request begins ");
563 case 0xe8: // set resolution
564 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
565 PrintDebug(" mouse set resolution begins ");
566 state->mouse_state = SET_RES;
569 case 0xe7: // set scaling 2:1
570 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
571 PrintDebug(" mouse set scaling 2:1 ");
574 case 0xe6: // set scaling 1:1
575 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
576 PrintDebug(" mouse set scaling 1:1 ");
580 PrintDebug(" receiving unknown mouse command (0x%x) in acceptable state ", data);
588 PrintDebug(" receiving mouse output in unhandled state (0x%x) ", state->mouse_state);
597 #if KEYBOARD_DEBUG_80H
598 static int keyboard_write_delay(ushort_t port, void * src, uint_t length, struct vm_device * dev) {
601 PrintDebug("keyboard: write of 0x%x to 80h\n", *((uint8_t*)src));
604 PrintDebug("keyboard: write of >1 byte to 80h\n", *((uint8_t*)src));
609 static int keyboard_read_delay(struct guest_info * core, ushort_t port, void * dest, uint_t length, struct vm_device * dev) {
612 *(uint8_t *)dest = v3_inb(port);
614 PrintDebug("keyboard: read of 0x%x from 80h\n", *((uint8_t*)dest));
618 PrintDebug("keyboard: read of >1 byte from 80h\n");
629 static int keyboard_write_command(struct guest_info * core, ushort_t port, void * src, uint_t length, struct vm_device * dev) {
630 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
631 uint8_t cmd = *(uint8_t *)src;
633 // Should always be single byte write
635 PrintError("keyboard: write of >1 bytes (%d) to 64h\n", length);
640 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
642 if (state->state != NORMAL) {
643 PrintDebug("keyboard: warning - receiving command on 64h but state != NORMAL\n");
646 PrintDebug("keyboard: command 0x%x on 64h\n", cmd);
649 case 0x20: // READ COMMAND BYTE (returned in 60h)
650 push_to_output_queue(dev, state->cmd.val, COMMAND, KEYBOARD);
651 PrintDebug("keyboard: command byte 0x%x returned\n", state->cmd.val);
654 case 0x60: // WRITE COMMAND BYTE (read from 60h)
655 state->state = WRITING_CMD_BYTE; // we need to make sure we send the next 0x60 byte appropriately
656 PrintDebug("keyboard: prepare to write command byte\n");
659 // case 0x90-9f - write to output port (?)
661 case 0xa1: // Get version number
662 push_to_output_queue(dev, 0x00, COMMAND, KEYBOARD);
663 PrintDebug("keyboard: version number 0x0 returned\n");
666 case 0xa4: // is password installed? send result to 0x60
667 // we don't support passwords
668 push_to_output_queue(dev, 0xf1, COMMAND, KEYBOARD);
669 PrintDebug("keyboard: password not installed\n");
672 case 0xa5: // new password will arrive on 0x60
673 state->state = TRANSMIT_PASSWD;
674 PrintDebug("keyboard: pepare to transmit password\n");
677 case 0xa6: // check passwd;
678 // since we do not support passwords, we will simply ignore this
679 // the implication is that any password check immediately succeeds
680 // with a blank password
681 PrintDebug("keyboard: password check succeeded\n");
684 case 0xa7: // disable mouse
685 state->cmd.mouse_disable = 1;
686 PrintDebug("keyboard: mouse disabled\n");
689 case 0xa8: // enable mouse
690 state->cmd.mouse_disable = 0;
691 PrintDebug("keyboard: mouse enabled\n");
694 case 0xa9: // mouse interface test (always succeeds)
695 push_to_output_queue(dev, 0x00, COMMAND, KEYBOARD);
696 PrintDebug("keyboard: mouse interface test succeeded\n");
699 case 0xaa: // controller self test (always succeeds)
700 push_to_output_queue(dev, 0x55, COMMAND, KEYBOARD);
701 PrintDebug("keyboard: controller self test succeeded\n");
704 case 0xab: // keyboard interface test (always succeeds)
705 push_to_output_queue(dev, 0, COMMAND, KEYBOARD);
706 PrintDebug("keyboard: keyboard interface test succeeded\n");
709 case 0xad: // disable keyboard
710 state->cmd.disable = 1;
711 PrintDebug("keyboard: keyboard disabled\n");
714 case 0xae: // enable keyboard
715 state->cmd.disable = 0;
716 PrintDebug("keyboard: keyboard enabled\n");
719 case 0xaf: // get version
720 push_to_output_queue(dev, 0x00, COMMAND, KEYBOARD);
721 PrintDebug("keyboard: version 0 returned \n");
724 case 0xd0: // return microcontroller output on 60h
725 push_to_output_queue(dev, state->output_byte, COMMAND, KEYBOARD);
726 PrintDebug("keyboard: output byte 0x%x returned\n", state->output_byte);
729 case 0xd1: // request to write next byte on 60h to the microcontroller output port
730 state->state = WRITING_OUTPUT_PORT;
731 PrintDebug("keyboard: prepare to write output byte\n");
734 case 0xd2: // write keyboard buffer (inject key)
735 state->state = INJECTING_KEY;
736 PrintDebug("keyboard: prepare to inject key\n");
739 case 0xd3: // write mouse buffer (inject mouse)
740 state->state = INJECTING_MOUSE;
741 PrintDebug("keyboard: prepare to inject mouse\n");
744 case 0xd4: // write mouse device (command to mouse?)
745 state->state = IN_MOUSE;
746 PrintDebug("keyboard: prepare to inject mouse command\n");
749 case 0xc0: // read input port
750 push_to_output_queue(dev, state->input_byte, COMMAND, KEYBOARD);
751 PrintDebug("keyboard: input byte 0x%x returned\n", state->input_byte);
754 case 0xc1: //copy input port lsn to status msn
755 state->status.val &= 0x0f;
756 state->status.val |= (state->input_byte & 0xf) << 4;
757 PrintDebug("keyboard: copied input byte low 4 bits to status reg hi 4 bits\n");
760 case 0xc2: // copy input port msn to status msn
761 state->status.val &= 0x0f;
762 state->status.val |= (state->input_byte & 0xf0);
763 PrintDebug("keyboard: copied input byte hi 4 bits to status reg hi 4 bits\n");
766 case 0xe0: // read test port
767 push_to_output_queue(dev, state->output_byte >> 6, COMMAND, KEYBOARD);
768 PrintDebug("keyboard: read 0x%x from test port\n", state->output_byte >> 6);
772 case 0xf0: // pulse output port
773 case 0xf1: // this should pulse 0..3 of cmd_byte on output port
774 case 0xf2: // instead of what is currently in output_byte (I think)
775 case 0xf3: // main effect is taht if bit zero is zero
776 case 0xf4: // should cause reset
777 case 0xf5: // I doubt anything more recent than a 286 running
778 case 0xf6: // OS2 with the penalty box will care
788 PrintDebug("keyboard: ignoring pulse of 0x%x (low=pulsed) on output port\n", (cmd & 0xf));
791 // case ac diagonstic - returns 16 bytes from keyboard microcontroler on 60h
793 PrintDebug("keyboard: ignoring command (unimplemented)\n");
797 v3_unlock_irqrestore(state->kb_lock, irq_state);
802 static int keyboard_read_status(struct guest_info * core, ushort_t port, void * dest, uint_t length, struct vm_device * dev) {
803 struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data);
806 PrintError("keyboard: >1 byte read for status (64h)\n");
810 PrintDebug("keyboard: read status (64h): ");
812 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
814 *(uint8_t *)dest = state->status.val;
816 v3_unlock_irqrestore(state->kb_lock, irq_state);
818 PrintDebug("0x%x\n", *(uint8_t *)dest);
823 static int keyboard_write_output(struct guest_info * core, ushort_t port, void * src, uint_t length, struct vm_device * dev) {
824 struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data);
828 PrintError("keyboard: write of 60h with >1 byte\n");
832 uint8_t data = *(uint8_t *)src;
834 PrintDebug("keyboard: output 0x%x on 60h\n", data);
836 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
838 switch (state->state) {
839 case WRITING_CMD_BYTE:
840 state->cmd.val = data;
841 state->state = NORMAL;
842 PrintDebug("keyboard: wrote new command byte 0x%x\n", state->cmd.val);
845 case WRITING_OUTPUT_PORT:
846 state->output_byte = data;
847 state->state = NORMAL;
848 PrintDebug("keyboard: wrote new output byte 0x%x\n", state->output_byte);
852 push_to_output_queue(dev, data, COMMAND, KEYBOARD); // probably should be a call to deliver_key_to_vmm()
853 state->state = NORMAL;
854 PrintDebug("keyboard: injected key 0x%x\n", data);
857 case INJECTING_MOUSE:
858 push_to_output_queue(dev, data, DATA, MOUSE);
859 // PrintDebug("keyboard: ignoring injected mouse event 0x%x\n", data);
860 PrintDebug("keyboard: injected mouse event 0x%x\n", data);
861 state->state = NORMAL;
865 PrintDebug("keyboard: mouse action: ");
866 if (mouse_write_output(dev, data)) {
867 state->state = NORMAL;
872 case TRANSMIT_PASSWD:
875 PrintDebug("keyboard: ignoring password character 0x%x\n",data);
878 state->state = NORMAL;
879 PrintDebug("keyboard: done with password\n");
884 PrintDebug("Keyboard: LEDs being set...\n");
885 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
886 state->state = NORMAL;
890 PrintDebug("Keyboard: Rate being set...\n");
891 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
892 state->state = NORMAL;
897 // command is being sent to keyboard controller
900 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD); // ack
901 push_to_output_queue(dev, 0xaa, COMMAND, KEYBOARD);
902 PrintDebug("keyboard: reset complete and acked\n");
905 case 0xf5: // disable scanning
906 case 0xf4: // enable scanning
908 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
909 // should do something here... PAD
910 PrintDebug("keyboard: %s scanning done and acked\n", (data == 0xf5) ? "disable" : "enable");
914 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
915 state->state = SET_RATE;
918 case 0xf2: // get keyboard ID
919 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
920 push_to_output_queue(dev, 0xab, COMMAND, KEYBOARD);
921 push_to_output_queue(dev, 0x83, COMMAND, KEYBOARD);
922 PrintDebug("Keyboard: Requesting Keyboard ID\n");
925 case 0xed: // enable keyboard LEDs
926 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
927 state->state = SET_LEDS;
931 case 0xfd: // set key type make
932 case 0xfc: // set key typ make/break
933 case 0xfb: // set key type typematic
934 case 0xfa: // set all typematic make/break/typematic
935 case 0xf9: // set all make
936 case 0xf8: // set all make/break
937 case 0xf7: // set all typemaktic
938 case 0xf6: // set defaults
939 PrintError("keyboard: unhandled known command 0x%x on output buffer (60h)\n", data);
944 PrintError("keyboard: unhandled unknown command 0x%x on output buffer (60h)\n", data);
945 state->status.out_buf_full = 1;
953 v3_unlock_irqrestore(state->kb_lock, irq_state);
958 static int keyboard_read_input(struct guest_info * core, ushort_t port, void * dest, uint_t length, struct vm_device * dev) {
959 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
962 PrintError("keyboard: unknown size read from input (60h)\n");
966 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
968 pull_from_output_queue(dev, (uint8_t *)dest);
970 v3_unlock_irqrestore(state->kb_lock, irq_state);
972 PrintDebug("keyboard: read from input (60h): 0x%x\n", *(uint8_t *)dest);
982 static int keyboard_free(struct vm_device * dev) {
984 v3_dev_unhook_io(dev, KEYBOARD_60H);
985 v3_dev_unhook_io(dev, KEYBOARD_64H);
986 #if KEYBOARD_DEBUG_80H
987 v3_dev_unhook_io(dev, KEYBOARD_DELAY_80H);
989 keyboard_reset_device(dev);
997 static struct v3_device_ops dev_ops = {
998 .free = keyboard_free,
999 .reset = keyboard_reset_device,
1000 .start = keyboard_start_device,
1001 .stop = keyboard_stop_device,
1007 static int keyboard_init(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
1008 struct keyboard_internal * keyboard_state = NULL;
1009 char * name = v3_cfg_val(cfg, "name");
1011 PrintDebug("keyboard: init_device\n");
1013 keyboard_state = (struct keyboard_internal *)V3_Malloc(sizeof(struct keyboard_internal));
1015 keyboard_state->mouse_queue.start = 0;
1016 keyboard_state->mouse_queue.end = 0;
1017 keyboard_state->mouse_queue.count = 0;
1019 keyboard_state->kbd_queue.start = 0;
1020 keyboard_state->kbd_queue.end = 0;
1021 keyboard_state->kbd_queue.count = 0;
1023 keyboard_state->mouse_enabled = 0;
1025 struct vm_device * dev = v3_allocate_device(name, &dev_ops, keyboard_state);
1027 if (v3_attach_device(vm, dev) == -1) {
1028 PrintError("Could not attach device %s\n", name);
1033 keyboard_reset_device(dev);
1036 v3_lock_init(&(keyboard_state->kb_lock));
1040 v3_dev_hook_io(dev, KEYBOARD_64H, &keyboard_read_status, &keyboard_write_command);
1041 v3_dev_hook_io(dev, KEYBOARD_60H, &keyboard_read_input, &keyboard_write_output);
1043 v3_hook_host_event(vm, HOST_KEYBOARD_EVT, V3_HOST_EVENT_HANDLER(key_event_handler), dev);
1044 v3_hook_host_event(vm, HOST_MOUSE_EVT, V3_HOST_EVENT_HANDLER(mouse_event_handler), dev);
1047 #if KEYBOARD_DEBUG_80H
1048 v3_dev_hook_io(dev, KEYBOARD_DELAY_80H, &keyboard_read_delay, &keyboard_write_delay);
1053 // We do not hook the IRQ here. Instead, the underlying device driver
1054 // is responsible to call us back
1061 device_register("KEYBOARD", keyboard_init)