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;
281 if (q->end >= (QUEUE_SIZE - 1)) {
297 static int pull_from_output_queue(struct vm_device * dev, uint8_t * value) {
298 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
299 struct queue * q = NULL;
301 if (state->kbd_queue.count > 0) {
302 q = &(state->kbd_queue);
303 PrintDebug("Reading from Keyboard Queue\n");
304 } else if (state->mouse_queue.count > 0) {
305 q = &(state->mouse_queue);
306 PrintDebug("Reading from Mouse Queue\n");
308 uint8_t idx = state->kbd_queue.start - 1;
309 PrintDebug("No Data in any queue\n");
310 *value = state->kbd_queue.queue[idx];
314 *value = q->queue[q->start];
316 if (q->start >= (QUEUE_SIZE - 1)) {
325 PrintDebug("Read from Queue: %x\n", *value);
326 PrintDebug("QStart=%d, QEnd=%d\n", q->start, q->end);
334 #include <palacios/vmm_telemetry.h>
336 #include <palacios/vmm_symmod.h>
339 static int key_event_handler(struct v3_vm_info * vm,
340 struct v3_keyboard_event * evt,
341 void * private_data) {
342 struct vm_device * dev = (struct vm_device *)private_data;
343 struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data);
345 PrintDebug("keyboard: injected status 0x%x, and scancode 0x%x\n", evt->status, evt->scan_code);
347 if (evt->scan_code == 0x44) { // F10 debug dump
349 for (i = 0; i < vm->num_cores; i++) {
350 v3_print_guest_state(&(vm->cores[i]));
352 // PrintGuestPageTables(info, info->shdw_pg_state.guest_cr3);
354 #ifdef CONFIG_SYMCALL
355 else if (evt->scan_code == 0x43) { // F9 Sym test
356 struct guest_info * core = &(vm->cores[0]);
357 PrintDebug("Testing sym call\n");
358 sym_arg_t a0 = 0x1111;
359 sym_arg_t a1 = 0x2222;
360 sym_arg_t a2 = 0x3333;
361 sym_arg_t a3 = 0x4444;
362 sym_arg_t a4 = 0x5555;
363 uint64_t call_start = 0;
364 uint64_t call_end = 0;
366 V3_Print("Exits before symcall: %d\n", (uint32_t)core->num_exits);
369 v3_sym_call5(core, SYMCALL_TEST, &a0, &a1, &a2, &a3, &a4);
372 V3_Print("Symcall latency = %d cycles (%d exits)\n", (uint32_t)(call_end - call_start), (uint32_t)core->num_exits);
374 V3_Print("Symcall Test Returned arg0=%x, arg1=%x, arg2=%x, arg3=%x, arg4=%x\n",
375 (uint32_t)a0, (uint32_t)a1, (uint32_t)a2, (uint32_t)a3, (uint32_t)a4);
379 else if (evt->scan_code == 0x42) { // F8 debug toggle
380 extern int v3_dbg_enable;
382 PrintDebug("Toggling Debugging\n");
386 #ifdef CONFIG_TELEMETRY
388 else if (evt->scan_code == 0x41) { // F7 telemetry dump
389 v3_print_telemetry(vm);
393 else if (evt->scan_code == 0x40) { // F6 Test symmod load
394 v3_load_sym_capsule(vm, "lnx_test");
399 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
401 if ( (state->status.enabled == 1) // onboard is enabled
402 && (state->cmd.disable == 0) ) { // keyboard is enabled
404 push_to_output_queue(dev, evt->scan_code, DATA, KEYBOARD);
407 v3_unlock_irqrestore(state->kb_lock, irq_state);
413 static int mouse_event_handler(struct v3_vm_info * vm,
414 struct v3_mouse_event * evt,
415 void * private_data) {
416 struct vm_device * dev = (struct vm_device *)private_data;
417 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
420 PrintDebug("keyboard: injected mouse packet 0x %x %x %x\n",
421 evt->data[0], evt->data[1], evt->data[2]);
423 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
425 switch (state->mouse_state) {
428 if (state->cmd.mouse_disable == 0) {
429 push_to_output_queue(dev, evt->data[0], DATA, MOUSE);
430 push_to_output_queue(dev, evt->data[1], DATA, MOUSE);
431 push_to_output_queue(dev, evt->data[2], DATA, MOUSE);
435 PrintError("Invalid mouse state\n");
441 v3_unlock_irqrestore(state->kb_lock, irq_state);
447 static int keyboard_reset_device(struct vm_device * dev) {
448 struct keyboard_internal * data = (struct keyboard_internal *)(dev->private_data);
450 memset(data, 0, sizeof(struct keyboard_internal));
452 data->state = NORMAL;
453 data->mouse_state = STREAM;
456 // PS2, keyboard+mouse enabled, generic translation
459 data->cmd.irq_en = 1;
460 data->cmd.mouse_irq_en = 1;
461 data->cmd.self_test_ok = 1;
465 // buffers empty, no errors
466 data->status.val = 0;
468 data->status.self_test_ok = 1; // self-tests passed
469 data->status.enabled = 1;// keyboard ready
473 data->output_byte = 0; // ?
475 data->input_byte = INPUT_RAM; // we have some
476 // also display=color, jumper 0, keyboard enabled
478 PrintDebug("keyboard: reset device\n");
486 static int keyboard_start_device(struct vm_device * dev) {
487 PrintDebug("keyboard: start device\n");
492 static int keyboard_stop_device(struct vm_device * dev) {
493 PrintDebug("keyboard: stop device\n");
499 static int mouse_write_output(struct vm_device * dev, uint8_t data) {
500 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
502 switch (state->mouse_state) {
507 if (state->mouse_enabled == 0) {
508 push_to_output_queue(dev, 0xfe, DATA, MOUSE) ; // no mouse!
510 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
511 push_to_output_queue(dev, 0xaa, DATA, MOUSE) ;
512 push_to_output_queue(dev, 0x00, DATA, MOUSE) ;
516 /* case 0xfe: //resend */
517 /* PushToOutputQueue(dev, 0xfa, OVERWRITE, DATA, MOUSE) ; */
518 /* PrintDebug(" mouse resend begins "); */
519 /* state->mouse_done_after_ack = 0; */
520 /* state->mouse_needs_ack = 0; */
521 /* state->mouse_state = STREAM1; */
522 /* return 0; // not done */
525 case 0xf6: // set defaults
526 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
527 PrintDebug(" mouse set defaults ");
531 case 0xf5: // disable data reporting
532 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
533 PrintDebug(" mouse disable data reporting ");
536 case 0xf4: // enable data reporting
537 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
538 PrintDebug(" mouse enable data reporting ");
541 case 0xf3: // set sample rate
542 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
543 state->mouse_state = SAMPLE;
544 PrintDebug(" mouse set sample rate begins ");
547 case 0xf2: // get device id
548 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
549 push_to_output_queue(dev, 0x0, DATA, MOUSE);
550 PrintDebug(" mouse get device id begins ");
553 case 0xf0: // set remote mode
554 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
555 PrintDebug(" mouse set remote mode ");
558 case 0xee: // set wrap mode
559 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
560 PrintError(" mouse set wrap mode (ignored) ");
563 case 0xec: // reset wrap mode
564 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
565 PrintError(" mouse reset wrap mode (ignored) ");
568 case 0xeb: // read data
569 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
570 PrintError(" mouse switch to wrap mode (ignored) ");
573 case 0xea: // set stream mode
574 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
575 PrintDebug(" mouse set stream mode ");
578 case 0xe9: // status request
579 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
580 push_to_output_queue(dev, 0x00, DATA, MOUSE);
581 push_to_output_queue(dev, 0x00, DATA, MOUSE);
582 push_to_output_queue(dev, 0x00, DATA, MOUSE);
583 PrintDebug(" mouse status request begins ");
586 case 0xe8: // set resolution
587 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
588 PrintDebug(" mouse set resolution begins ");
589 state->mouse_state = SET_RES;
592 case 0xe7: // set scaling 2:1
593 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
594 PrintDebug(" mouse set scaling 2:1 ");
597 case 0xe6: // set scaling 1:1
598 push_to_output_queue(dev, MOUSE_ACK, DATA, MOUSE) ;
599 PrintDebug(" mouse set scaling 1:1 ");
603 PrintDebug(" receiving unknown mouse command (0x%x) in acceptable state ", data);
611 PrintDebug(" receiving mouse output in unhandled state (0x%x) ", state->mouse_state);
620 #if KEYBOARD_DEBUG_80H
621 static int keyboard_write_delay(ushort_t port, void * src, uint_t length, struct vm_device * dev) {
624 PrintDebug("keyboard: write of 0x%x to 80h\n", *((uint8_t*)src));
627 PrintDebug("keyboard: write of >1 byte to 80h\n", *((uint8_t*)src));
632 static int keyboard_read_delay(struct guest_info * core, ushort_t port, void * dest, uint_t length, struct vm_device * dev) {
635 *(uint8_t *)dest = v3_inb(port);
637 PrintDebug("keyboard: read of 0x%x from 80h\n", *((uint8_t*)dest));
641 PrintDebug("keyboard: read of >1 byte from 80h\n");
652 static int keyboard_write_command(struct guest_info * core, ushort_t port, void * src, uint_t length, struct vm_device * dev) {
653 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
654 uint8_t cmd = *(uint8_t *)src;
656 // Should always be single byte write
658 PrintError("keyboard: write of >1 bytes (%d) to 64h\n", length);
663 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
665 if (state->state != NORMAL) {
666 PrintDebug("keyboard: warning - receiving command on 64h but state != NORMAL\n");
669 PrintDebug("keyboard: command 0x%x on 64h\n", cmd);
672 case 0x20: // READ COMMAND BYTE (returned in 60h)
673 push_to_output_queue(dev, state->cmd.val, COMMAND, KEYBOARD);
674 PrintDebug("keyboard: command byte 0x%x returned\n", state->cmd.val);
677 case 0x60: // WRITE COMMAND BYTE (read from 60h)
678 state->state = WRITING_CMD_BYTE; // we need to make sure we send the next 0x60 byte appropriately
679 PrintDebug("keyboard: prepare to write command byte\n");
682 // case 0x90-9f - write to output port (?)
684 case 0xa1: // Get version number
685 push_to_output_queue(dev, 0x00, COMMAND, KEYBOARD);
686 PrintDebug("keyboard: version number 0x0 returned\n");
689 case 0xa4: // is password installed? send result to 0x60
690 // we don't support passwords
691 push_to_output_queue(dev, 0xf1, COMMAND, KEYBOARD);
692 PrintDebug("keyboard: password not installed\n");
695 case 0xa5: // new password will arrive on 0x60
696 state->state = TRANSMIT_PASSWD;
697 PrintDebug("keyboard: pepare to transmit password\n");
700 case 0xa6: // check passwd;
701 // since we do not support passwords, we will simply ignore this
702 // the implication is that any password check immediately succeeds
703 // with a blank password
704 PrintDebug("keyboard: password check succeeded\n");
707 case 0xa7: // disable mouse
708 state->cmd.mouse_disable = 1;
709 PrintDebug("keyboard: mouse disabled\n");
712 case 0xa8: // enable mouse
713 state->cmd.mouse_disable = 0;
714 PrintDebug("keyboard: mouse enabled\n");
717 case 0xa9: // mouse interface test (always succeeds)
718 push_to_output_queue(dev, 0x00, COMMAND, KEYBOARD);
719 PrintDebug("keyboard: mouse interface test succeeded\n");
722 case 0xaa: // controller self test (always succeeds)
723 push_to_output_queue(dev, 0x55, COMMAND, KEYBOARD);
724 PrintDebug("keyboard: controller self test succeeded\n");
727 case 0xab: // keyboard interface test (always succeeds)
728 push_to_output_queue(dev, 0, COMMAND, KEYBOARD);
729 PrintDebug("keyboard: keyboard interface test succeeded\n");
732 case 0xad: // disable keyboard
733 state->cmd.disable = 1;
734 PrintDebug("keyboard: keyboard disabled\n");
737 case 0xae: // enable keyboard
738 state->cmd.disable = 0;
739 PrintDebug("keyboard: keyboard enabled\n");
742 case 0xaf: // get version
743 push_to_output_queue(dev, 0x00, COMMAND, KEYBOARD);
744 PrintDebug("keyboard: version 0 returned \n");
747 case 0xd0: // return microcontroller output on 60h
748 push_to_output_queue(dev, state->output_byte, COMMAND, KEYBOARD);
749 PrintDebug("keyboard: output byte 0x%x returned\n", state->output_byte);
752 case 0xd1: // request to write next byte on 60h to the microcontroller output port
753 state->state = WRITING_OUTPUT_PORT;
754 PrintDebug("keyboard: prepare to write output byte\n");
757 case 0xd2: // write keyboard buffer (inject key)
758 state->state = INJECTING_KEY;
759 PrintDebug("keyboard: prepare to inject key\n");
762 case 0xd3: // write mouse buffer (inject mouse)
763 state->state = INJECTING_MOUSE;
764 PrintDebug("keyboard: prepare to inject mouse\n");
767 case 0xd4: // write mouse device (command to mouse?)
768 state->state = IN_MOUSE;
769 PrintDebug("keyboard: prepare to inject mouse command\n");
772 case 0xc0: // read input port
773 push_to_output_queue(dev, state->input_byte, COMMAND, KEYBOARD);
774 PrintDebug("keyboard: input byte 0x%x returned\n", state->input_byte);
777 case 0xc1: //copy input port lsn to status msn
778 state->status.val &= 0x0f;
779 state->status.val |= (state->input_byte & 0xf) << 4;
780 PrintDebug("keyboard: copied input byte low 4 bits to status reg hi 4 bits\n");
783 case 0xc2: // copy input port msn to status msn
784 state->status.val &= 0x0f;
785 state->status.val |= (state->input_byte & 0xf0);
786 PrintDebug("keyboard: copied input byte hi 4 bits to status reg hi 4 bits\n");
789 case 0xe0: // read test port
790 push_to_output_queue(dev, state->output_byte >> 6, COMMAND, KEYBOARD);
791 PrintDebug("keyboard: read 0x%x from test port\n", state->output_byte >> 6);
795 case 0xf0: // pulse output port
796 case 0xf1: // this should pulse 0..3 of cmd_byte on output port
797 case 0xf2: // instead of what is currently in output_byte (I think)
798 case 0xf3: // main effect is taht if bit zero is zero
799 case 0xf4: // should cause reset
800 case 0xf5: // I doubt anything more recent than a 286 running
801 case 0xf6: // OS2 with the penalty box will care
811 PrintDebug("keyboard: ignoring pulse of 0x%x (low=pulsed) on output port\n", (cmd & 0xf));
814 // case ac diagonstic - returns 16 bytes from keyboard microcontroler on 60h
816 PrintDebug("keyboard: ignoring command (unimplemented)\n");
820 v3_unlock_irqrestore(state->kb_lock, irq_state);
825 static int keyboard_read_status(struct guest_info * core, ushort_t port, void * dest, uint_t length, struct vm_device * dev) {
826 struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data);
829 PrintError("keyboard: >1 byte read for status (64h)\n");
833 PrintDebug("keyboard: read status (64h): ");
835 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
837 *(uint8_t *)dest = state->status.val;
839 v3_unlock_irqrestore(state->kb_lock, irq_state);
841 PrintDebug("0x%x\n", *(uint8_t *)dest);
846 static int keyboard_write_output(struct guest_info * core, ushort_t port, void * src, uint_t length, struct vm_device * dev) {
847 struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data);
851 PrintError("keyboard: write of 60h with >1 byte\n");
855 uint8_t data = *(uint8_t *)src;
857 PrintDebug("keyboard: output 0x%x on 60h\n", data);
859 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
861 switch (state->state) {
862 case WRITING_CMD_BYTE:
863 state->cmd.val = data;
864 state->state = NORMAL;
865 PrintDebug("keyboard: wrote new command byte 0x%x\n", state->cmd.val);
868 case WRITING_OUTPUT_PORT:
869 state->output_byte = data;
870 state->state = NORMAL;
871 PrintDebug("keyboard: wrote new output byte 0x%x\n", state->output_byte);
875 push_to_output_queue(dev, data, COMMAND, KEYBOARD); // probably should be a call to deliver_key_to_vmm()
876 state->state = NORMAL;
877 PrintDebug("keyboard: injected key 0x%x\n", data);
880 case INJECTING_MOUSE:
881 push_to_output_queue(dev, data, DATA, MOUSE);
882 // PrintDebug("keyboard: ignoring injected mouse event 0x%x\n", data);
883 PrintDebug("keyboard: injected mouse event 0x%x\n", data);
884 state->state = NORMAL;
888 PrintDebug("keyboard: mouse action: ");
889 if (mouse_write_output(dev, data)) {
890 state->state = NORMAL;
895 case TRANSMIT_PASSWD:
898 PrintDebug("keyboard: ignoring password character 0x%x\n",data);
901 state->state = NORMAL;
902 PrintDebug("keyboard: done with password\n");
907 PrintDebug("Keyboard: LEDs being set...\n");
908 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
909 state->state = NORMAL;
913 PrintDebug("Keyboard: Rate being set...\n");
914 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
915 state->state = NORMAL;
920 // command is being sent to keyboard controller
923 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD); // ack
924 push_to_output_queue(dev, 0xaa, COMMAND, KEYBOARD);
925 PrintDebug("keyboard: reset complete and acked\n");
928 case 0xf5: // disable scanning
929 case 0xf4: // enable scanning
931 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
932 // should do something here... PAD
933 PrintDebug("keyboard: %s scanning done and acked\n", (data == 0xf5) ? "disable" : "enable");
937 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
938 state->state = SET_RATE;
941 case 0xf2: // get keyboard ID
942 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
943 push_to_output_queue(dev, 0xab, COMMAND, KEYBOARD);
944 push_to_output_queue(dev, 0x83, COMMAND, KEYBOARD);
945 PrintDebug("Keyboard: Requesting Keyboard ID\n");
948 case 0xed: // enable keyboard LEDs
949 push_to_output_queue(dev, 0xfa, COMMAND, KEYBOARD);
950 state->state = SET_LEDS;
954 case 0xfd: // set key type make
955 case 0xfc: // set key typ make/break
956 case 0xfb: // set key type typematic
957 case 0xfa: // set all typematic make/break/typematic
958 case 0xf9: // set all make
959 case 0xf8: // set all make/break
960 case 0xf7: // set all typemaktic
961 case 0xf6: // set defaults
962 PrintError("keyboard: unhandled known command 0x%x on output buffer (60h)\n", data);
967 PrintError("keyboard: unhandled unknown command 0x%x on output buffer (60h)\n", data);
968 state->status.out_buf_full = 1;
976 v3_unlock_irqrestore(state->kb_lock, irq_state);
981 static int keyboard_read_input(struct guest_info * core, ushort_t port, void * dest, uint_t length, struct vm_device * dev) {
982 struct keyboard_internal * state = (struct keyboard_internal *)(dev->private_data);
985 PrintError("keyboard: unknown size read from input (60h)\n");
989 addr_t irq_state = v3_lock_irqsave(state->kb_lock);
991 pull_from_output_queue(dev, (uint8_t *)dest);
993 v3_unlock_irqrestore(state->kb_lock, irq_state);
995 PrintDebug("keyboard: read from input (60h): 0x%x\n", *(uint8_t *)dest);
1005 static int keyboard_free(struct vm_device * dev) {
1007 v3_dev_unhook_io(dev, KEYBOARD_60H);
1008 v3_dev_unhook_io(dev, KEYBOARD_64H);
1009 #if KEYBOARD_DEBUG_80H
1010 v3_dev_unhook_io(dev, KEYBOARD_DELAY_80H);
1012 keyboard_reset_device(dev);
1020 static struct v3_device_ops dev_ops = {
1021 .free = keyboard_free,
1022 .reset = keyboard_reset_device,
1023 .start = keyboard_start_device,
1024 .stop = keyboard_stop_device,
1030 static int keyboard_init(struct v3_vm_info * vm, v3_cfg_tree_t * cfg) {
1031 struct keyboard_internal * keyboard_state = NULL;
1032 char * dev_id = v3_cfg_val(cfg, "ID");
1034 PrintDebug("keyboard: init_device\n");
1036 keyboard_state = (struct keyboard_internal *)V3_Malloc(sizeof(struct keyboard_internal));
1038 memset(keyboard_state, 0, sizeof(struct keyboard_internal));
1040 keyboard_state->mouse_queue.start = 0;
1041 keyboard_state->mouse_queue.end = 0;
1042 keyboard_state->mouse_queue.count = 0;
1044 keyboard_state->kbd_queue.start = 0;
1045 keyboard_state->kbd_queue.end = 0;
1046 keyboard_state->kbd_queue.count = 0;
1048 keyboard_state->mouse_enabled = 0;
1050 struct vm_device * dev = v3_allocate_device(dev_id, &dev_ops, keyboard_state);
1052 if (v3_attach_device(vm, dev) == -1) {
1053 PrintError("Could not attach device %s\n", dev_id);
1058 keyboard_reset_device(dev);
1061 v3_lock_init(&(keyboard_state->kb_lock));
1065 v3_dev_hook_io(dev, KEYBOARD_64H, &keyboard_read_status, &keyboard_write_command);
1066 v3_dev_hook_io(dev, KEYBOARD_60H, &keyboard_read_input, &keyboard_write_output);
1068 v3_hook_host_event(vm, HOST_KEYBOARD_EVT, V3_HOST_EVENT_HANDLER(key_event_handler), dev);
1069 v3_hook_host_event(vm, HOST_MOUSE_EVT, V3_HOST_EVENT_HANDLER(mouse_event_handler), dev);
1072 #if KEYBOARD_DEBUG_80H
1073 v3_dev_hook_io(dev, KEYBOARD_DELAY_80H, &keyboard_read_delay, &keyboard_write_delay);
1078 // We do not hook the IRQ here. Instead, the underlying device driver
1079 // is responsible to call us back
1086 device_register("KEYBOARD", keyboard_init)