X-Git-Url: http://v3vee.org/palacios/gitweb/gitweb.cgi?a=blobdiff_plain;f=palacios%2Fsrc%2Fdevices%2Fkeyboard.c;h=63ff15667f767769655c5cbfd3a19924451d443b;hb=a6d96ef32940e95ae77dcf0fe415039703681a6f;hp=6c71667cf1c41fbc6b1f6272113fe7a56754f94f;hpb=d16ef42bba84c7fe88352e5dc23e5e70a5207e29;p=palacios-OLD.git diff --git a/palacios/src/devices/keyboard.c b/palacios/src/devices/keyboard.c index 6c71667..63ff156 100644 --- a/palacios/src/devices/keyboard.c +++ b/palacios/src/devices/keyboard.c @@ -3,35 +3,234 @@ #include #include -extern struct vmm_os_hooks *os_hooks; +#define KEYBOARD_DEBUG 1 -extern void SerialPrint(const char *format, ...); +#define KEYBOARD_DEBUG_80H 1 +#if KEYBOARD_DEBUG +#define KEYBOARD_DEBUG_PRINT(first, rest...) PrintDebug(first, ##rest) +#else +#define KEYBOARD_DEBUG_PRINT(first, rest...) +#endif -#define KEYBOARD_DATA_REG 0x60 -#define KEYBOARD_CONTROL_REG 0x64 +#define KEYBOARD_60H 0x60 // keyboard microcontroller +#define KEYBOARD_64H 0x64 // onboard microcontroller -#define KEYBOARD_IRQ 0x1 +#define KEYBOARD_DELAY_80H 0x80 // written for timing +#define KEYBOARD_IRQ 0x1 + + +// extract bits for status byte +#define STATUS_OUTPUT_BUFFER_FULL 0x01 // 1=full (data for system) +#define STATUS_INPUT_BUFFER_FULL 0x02 // 1=full (data for 8042) +#define STATUS_SYSTEM 0x04 // 1=self-test-passed +#define STATUS_COMMAND_DATA_AVAIL 0x08 // internal: 0=data on 60h, 0=cmd on 64h +#define STATUS_ENABLED 0x10 // 1=keyboard is enabled +#define STATUS_MOUSE_BUFFER_FULL 0x20 // 1= mouse output buffer full +#define STATUS_TIMEOUT 0x40 // 1=timeout of keybd +#define STATUS_PARITY 0x80 // 1=parity error + +// bits for cmd byte + +#define CMD_INTR 0x01 // 1=interrupts enabled +#define CMD_MOUSE_INTR 0x02 // 1=interrupts enabled for mouse +#define CMD_SYSTEM 0x04 // 1= self test passed +#define CMD_OVERRIDE 0x08 // FORCE 0 for PS2 +#define CMD_DISABLE 0x10 // 1=disabled keyboard +#define CMD_MOUSE_DISABLE 0x20 // 1=disabled mouse +#define CMD_SCANCODE_XLATE 0x40 // 1=translate to set 1 scancodes +#define CMD_RESERVED 0x80 // should be zero + +// The currently targetted keyboard +static struct vm_device *thekeyboard = NULL; struct keyboard_internal { - int x; - // figure this out later - it should be the internal state of the keyboard buffer and - // the emulated status, etc. - // which should be fed from the underlying OS and drained via this interface + // + // 0x60 is the port for the keyboard microcontroller + // writes are commands + // reads from it usually return scancodes + // however, it can also return other data + // depending on the state of the onboard microcontroller + // + // 0x64 is the port for the onboard microcontroller + // writes are commands + // reads are status + // + + // state of the onboard microcontroller + // this is needed because sometimes 0x60 reads come + // from the onboard microcontroller + enum {// Normal mode measn we deliver keys + // to the vm and accept commands from it + NORMAL, + // after receiving cmd 0x60 + // keybaord uC cmd will subsequently arrive + WRITING_CMD_BYTE, + // after recieving 0xa5 + // password arrives on data port, null terminated + TRANSMIT_PASSWD, + // after receiving 0xd1 + // keyboard uC output will arrive + WRITE_OUTPUT, + // after having reset sent to 0x60 + // we immediately ack, and then + // push BAT success (0xaa) after the ack + RESET, + } state; + + + + uchar_t cmd_byte; // for keyboard uC - read/written + // via read/write cmd byte command + uchar_t status_byte; // for on-board uC - read via 64h + + // Data for 8042 + uchar_t input_queue; // + uint_t input_queue_len; // + // Data for system + uchar_t output_queue; // + uint_t output_queue_len; // }; +// +// push item onto outputqueue, optionally overwriting if there is no room +// returns 0 if successful +// +static int PushToOutputQueue(struct vm_device *dev, uchar_t value, uchar_t overwrite) +{ + struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data); + + if ((state->output_queue_len == 0) || overwrite) { + + state->output_queue = value; + state->output_queue_len = 1; + state->status_byte |= STATUS_OUTPUT_BUFFER_FULL; + + return 0; + } else { + KEYBOARD_DEBUG_PRINT("keyboard: PushToOutputQueue Failed - Queue Full\n"); + return -1; + } +} + +#if 1 +// +// pull item from outputqueue +// returns 0 if successful +// +static int PullFromOutputQueue(struct vm_device *dev, uchar_t *value) +{ + struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data); + + if (state->output_queue_len == 1) { + + *value = state->output_queue; + state->output_queue_len = 0; + state->status_byte &= ~STATUS_OUTPUT_BUFFER_FULL; + + return 0; + } else { + KEYBOARD_DEBUG_PRINT("keyboard: PullFromOutputQueue Failed - Queue Empty\n"); + return -1; + } +} +#endif + +#if 0 +// +// push item onto inputqueue, optionally overwriting if there is no room +// returns 0 if successful +// +static int PushToInputQueue(struct vm_device *dev, uchar_t value, uchar_t overwrite) +{ + struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data); + + if ((state->input_queue_len == 0) || overwrite) { + + state->input_queue = value; + state->input_queue_len = 1; + state->status_byte |= STATUS_INPUT_BUFFER_FULL; + + return 0; + } else { + KEYBOARD_DEBUG_PRINT("keyboard: PushToOutputQueue Failed - Queue Full\n"); + return -1; + } +} + +// +// pull item from inputqueue +// returns 0 if successful +// +static int PullFromInputQueue(struct vm_device *dev, uchar_t *value) +{ + struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data); + + if (state->input_queue_len == 1) { + + *value = state->input_queue; + state->input_queue_len = 0; + state->status_byte &= ~STATUS_INPUT_BUFFER_FULL; + + return 0; + } else { + KEYBOARD_DEBUG_PRINT("keyboard: PullFromInputQueue Failed - Queue Empty\n"); + + return -1; + } +} + +#endif + +static struct vm_device *demultiplex_injected_key(uchar_t status, uchar_t scancode) +{ + // this currently does nothing + return thekeyboard; +} +int keyboard_interrupt(uint_t irq, struct vm_device * dev); + +void deliver_key_to_vmm(uchar_t status, uchar_t scancode) +{ + struct vm_device *dev = demultiplex_injected_key(status, scancode); + struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data); + + KEYBOARD_DEBUG_PRINT("keyboard: injected status 0x%x, and scancode 0x%x\n", status, scancode); + + if ( (state->status_byte & STATUS_ENABLED) // onboard is enabled + && (!(state->cmd_byte & CMD_DISABLE)) ) { // keyboard is enabled + + PushToOutputQueue(dev, scancode, 1); + + if (state->cmd_byte & CMD_INTR) { + keyboard_interrupt(KEYBOARD_IRQ, dev); + } + + } +} int keyboard_reset_device(struct vm_device * dev) { - // struct keyboard_internal *data = (struct keyboard_internal *) dev->private_data; + struct keyboard_internal *data = (struct keyboard_internal *)(dev->private_data); + + memset(data, 0, sizeof(struct keyboard_internal)); + + data->cmd_byte = + CMD_INTR // interrupts on + | CMD_MOUSE_INTR // mouse interupts on + | CMD_SYSTEM ; // self test passed + // PS2, keyboard+mouse enabled, generic translation - SerialPrint("keyboard: reset device\n"); + data->status_byte = + STATUS_SYSTEM // self-tests passed + | STATUS_ENABLED ; // keyboard ready + // buffers empty, no errors + KEYBOARD_DEBUG_PRINT("keyboard: reset device\n"); return 0; @@ -39,107 +238,349 @@ int keyboard_reset_device(struct vm_device * dev) - - int keyboard_start_device(struct vm_device *dev) { - SerialPrint("keyboard: start device\n"); + KEYBOARD_DEBUG_PRINT("keyboard: start device\n"); return 0; } int keyboard_stop_device(struct vm_device *dev) { - SerialPrint("keyboard: stop device\n"); + KEYBOARD_DEBUG_PRINT("keyboard: stop device\n"); return 0; } +#if KEYBOARD_DEBUG_80H +int keyboard_write_delay(ushort_t port, + void * src, + uint_t length, + struct vm_device * dev) +{ + + if (length == 1) { + KEYBOARD_DEBUG_PRINT("keyboard: write of 0x%x to 80h\n", *((uchar_t*)src)); + + return 1; + } else { + KEYBOARD_DEBUG_PRINT("keyboard: write of >1 byte to 80h\n", *((uchar_t*)src)); + return length; + } +} -int keyboard_write_control_port(ushort_t port, - void * src, - uint_t length, - struct vm_device * dev) +int keyboard_read_delay(ushort_t port, + void * dest, + uint_t length, + struct vm_device * dev) { - //struct keyboard_internal *data = (struct keyboard_internal *) dev->private_data; - if (length==1) { - uchar_t data = *((uchar_t*)src); - PrintDebug("keyboard: write of 0x%x to control port\n",data); - Out_Byte(KEYBOARD_CONTROL_REG,data); + if (length == 1) { + *((uchar_t*)dest) = In_Byte(port); + + KEYBOARD_DEBUG_PRINT("keyboard: read of 0x%x from 80h\n", *((uchar_t*)dest)); + return 1; } else { - PrintDebug("keyboard: unknown size write to control port!\n"); + KEYBOARD_DEBUG_PRINT("keyboard: read of >1 byte from 80h\n"); + + return length; + } +} +#endif + + + + + +int keyboard_write_command(ushort_t port, + void * src, + uint_t length, + struct vm_device * dev) +{ + struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data); + uchar_t cmd; + + // Should always be single byte write + + if (length != 1) { + KEYBOARD_DEBUG_PRINT("keyboard: write of >1 bytes (%d) to 64h\n", length); return -1; } + + cmd = *((uchar_t*)src); + + if (state->state != NORMAL) { + KEYBOARD_DEBUG_PRINT("keyboard: warning - receiving command on 64h but state != NORMAL\n"); + } + + KEYBOARD_DEBUG_PRINT("keyboard: command 0x%x on 64h\n", cmd); + + switch (cmd) { + + case 0x20: // READ COMMAND BYTE (returned in 60h) + PushToOutputQueue(dev, state->cmd_byte, 1); + state->state = NORMAL; // the next read on 0x60 will get the right data + break; + + case 0x60: // WRITE COMMAND BYTE (read from 60h) + state->state = WRITING_CMD_BYTE; // we need to make sure we send the next 0x60 byte appropriately + break; + + // case 0x90-9f - write to output port (?) + + case 0xa1: // Get version number + PushToOutputQueue(dev, 0, 1); + state->state = NORMAL; + break; + + case 0xa4: // is password installed? send result to 0x60 + // we don't support passwords + PushToOutputQueue(dev, 0xf1, 1); + state->state = NORMAL; + break; + + case 0xa5: // new password will arrive on 0x60 + state->state = TRANSMIT_PASSWD; + break; + + case 0xa6: // check passwd; + // since we do not support passwords, we will simply ignore this + // the implication is that any password check immediately succeeds + // with a blank password + state->state = NORMAL; + break; + + case 0xa7: // disable mouse + state->cmd_byte |= CMD_MOUSE_DISABLE; + state->state = NORMAL; + break; + + case 0xa8: // enable mouse + state->cmd_byte &= ~CMD_MOUSE_DISABLE; + state->state = NORMAL; + break; + + case 0xa9: // mouse interface test (always succeeds) + PushToOutputQueue(dev, 0, 1); + state->state = NORMAL; + break; + + case 0xaa: // controller self test (always succeeds) + PushToOutputQueue(dev, 0x55, 1); + state->state = NORMAL; + break; + + case 0xab: // keyboard interface test (always succeeds) + PushToOutputQueue(dev, 0, 1); + state->state = NORMAL; + break; + + case 0xad: // disable keyboard + state->cmd_byte |= CMD_DISABLE; + state->state = NORMAL; + break; + + case 0xae: // enable keyboard + state->cmd_byte &= ~CMD_DISABLE; + state->state = NORMAL; + break; + + case 0xaf: // get version + PushToOutputQueue(dev, 0x00, 1); + state->state = NORMAL; + break; + + + // case c0 read input port ? + // case c1 copy input port lsn to status + // case c2 copy input port msn to status + + // case d0 read output port + // case d1 write output port + case 0xd1: // Write next 0x60 byte to uC output port + state->state = WRITE_OUTPUT; + break; + + // case d2 write keyboard buffer (inject key) + // case d3 write mouse buffer (inject mouse) + // case d4 write mouse device (command to mouse?) + + // case e0 read test port + + + // case f0..ff pulse output port ? + case 0xf0: + case 0xf1: + case 0xf2: + case 0xf3: + case 0xf4: + case 0xf5: + case 0xf6: + case 0xf7: + case 0xf8: + case 0xf9: + case 0xfa: + case 0xfb: + case 0xfc: + case 0xfd: + case 0xfe: + case 0xff: + PrintDebug("FIXME: keyboard output pulse: %x\n", cmd); + // either set/unset the a20 line (bit 1) + // or reset the machine (bit 0 == 0) + break; + + default: + KEYBOARD_DEBUG_PRINT("keyboard: ignoring command (unimplemented)\n"); + state->state = NORMAL; + return -1; // JRL: We die here to prevent silent errors + break; + } + + return 1; + } -int keyboard_read_control_port(ushort_t port, - void * dest, - uint_t length, - struct vm_device * dev) +int keyboard_read_status(ushort_t port, + void * dest, + uint_t length, + struct vm_device * dev) { - //struct keyboard_internal *data = (struct keyboard_internal *) dev->private_data; + struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data); + + if (length == 1) { + + KEYBOARD_DEBUG_PRINT("keyboard: read status (64h): "); + + *((uchar_t*)dest) = state->status_byte; + + KEYBOARD_DEBUG_PRINT("0x%x\n", *((uchar_t*)dest)); - if (length==1) { - uchar_t data; - PrintDebug("keyboard: read from control port: "); - data=In_Byte(KEYBOARD_CONTROL_REG); - PrintDebug("0x%x\n",data); - memcpy(dest,&data,1); return 1; } else { - PrintDebug("keyboard: unknown size read from control port!\n"); + KEYBOARD_DEBUG_PRINT("keyboard: >1 byte read for status (64h)\n"); return -1; } } -int keyboard_write_data_port(ushort_t port, - void * src, - uint_t length, - struct vm_device * dev) +int keyboard_write_output(ushort_t port, + void * src, + uint_t length, + struct vm_device * dev) { - //struct keyboard_internal *data = (struct keyboard_internal *) dev->private_data; + struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data); - if (length==1) { - uchar_t data = *((uchar_t*)src); - PrintDebug("keyboard: write of 0x%x to data port\n",data); - Out_Byte(KEYBOARD_DATA_REG,data); - return 1; - } else { - PrintDebug("keyboard: unknown size write to data port!\n"); + if (length != 1) { + KEYBOARD_DEBUG_PRINT("keyboard: write of 60h with >1 byte\n"); return -1; } + + uchar_t data = *((uchar_t*)src); + + switch (state->state) { + case WRITING_CMD_BYTE: + state->cmd_byte = data; + state->state = NORMAL; + break; + case TRANSMIT_PASSWD: + if (data) { + //ignore passwd + } else { + // end of password + state->state = NORMAL; + } + break; + case WRITE_OUTPUT: + PrintDebug("FIXME: keyboard write output: %x\n", data); + // either set/unset the a20 line (bit 1) + // or reset the machine (bit 0) + state->state = NORMAL; + break; + + + case NORMAL: + { + // command is being sent to keyboard controller + switch (data) { + case 0xff: // reset + PushToOutputQueue(dev, 0xfa, 1); // ack + state->state = RESET; + break; + case 0xf5: // disable scanning + case 0xf4: // enable scanning + // ack + PushToOutputQueue(dev, 0xfa, 1); + // should do something here... PAD + state->state = NORMAL; + break; + case 0xfe: // resend + case 0xfd: // set key type make + case 0xfc: // set key typ make/break + case 0xfb: // set key type typematic + case 0xfa: // set all typematic make/break/typematic + case 0xf9: // set all make + case 0xf8: // set all make/break + case 0xf7: // set all typemaktic + case 0xf6: // set defaults + case 0xf3: // set typematic delay/rate + default: + KEYBOARD_DEBUG_PRINT("keyboard: unhandled command 0x%x on output buffer (60h)\n", data); + if (data != 0x5) + return -1; // JRL: We die here to prevent silent errors + break; + } + break; + } + default: + KEYBOARD_DEBUG_PRINT("keyboard: unknown state %x on command 0x%x on output buffer (60h)\n", state->state, data); + } + + return 1; } -int keyboard_read_data_port(ushort_t port, - void * dest, - uint_t length, - struct vm_device * dev) +int keyboard_read_input(ushort_t port, + void * dest, + uint_t length, + struct vm_device * dev) { - //struct keyboard_internal *data = (struct keyboard_internal *) dev->private_data; + struct keyboard_internal *state = (struct keyboard_internal *)(dev->private_data); - if (length==1) { + if (length == 1) { uchar_t data; - PrintDebug("keyboard: read from data port: "); - data=In_Byte(KEYBOARD_DATA_REG); - PrintDebug("0x%x\n",data); - memcpy(dest,&data,1); + + KEYBOARD_DEBUG_PRINT("keyboard: read from input (60h): "); + + PullFromOutputQueue(dev, &data); + + if (state->state == RESET) { + // We just delivered the ack for the reset + // now we will ready ourselves to deliver the BAT code (success) + PushToOutputQueue(dev, 0xaa, 1); + state->state = NORMAL; + } + + KEYBOARD_DEBUG_PRINT("0x%x\n", data); + + *((uchar_t*)dest) = data; + return 1; } else { - PrintDebug("keyboard: unknown size read from data port!\n"); + KEYBOARD_DEBUG_PRINT("keyboard: unknown size read from input (60h)\n"); return -1; } } -int keyboard_interrupt(uint_t irq, - struct vm_device * dev) +int keyboard_interrupt(uint_t irq, struct vm_device * dev) { - PrintDebug("keyboard: interrupt\n"); + KEYBOARD_DEBUG_PRINT("keyboard: interrupt\n"); + + dev->vm->vm_ops.raise_irq(dev->vm, irq); + return 0; - // Inject ? + } @@ -148,20 +589,25 @@ int keyboard_init_device(struct vm_device * dev) // struct keyboard_internal *data = (struct keyboard_internal *) dev->private_data; - SerialPrint("keyboard: init_device\n"); + KEYBOARD_DEBUG_PRINT("keyboard: init_device\n"); // Would read state here keyboard_reset_device(dev); // hook ports - dev_hook_io(dev, KEYBOARD_DATA_REG, &keyboard_read_data_port, &keyboard_write_data_port); - dev_hook_io(dev, KEYBOARD_CONTROL_REG, &keyboard_read_control_port, &keyboard_write_control_port); - - // hook irq - // currently assume this is done in vm.c? - //dev_hook_irq(dev,KEYBOARD_IRQ,&keyboard_interrupt); + dev_hook_io(dev, KEYBOARD_64H, &keyboard_read_status, &keyboard_write_command); + dev_hook_io(dev, KEYBOARD_60H, &keyboard_read_input, &keyboard_write_output); + +#if KEYBOARD_DEBUG_80H + dev_hook_io(dev, KEYBOARD_DELAY_80H, &keyboard_read_delay, &keyboard_write_delay); +#endif + + // + // We do not hook the IRQ here. Instead, the underlying device driver + // is responsible to call us back + // return 0; } @@ -169,11 +615,11 @@ int keyboard_init_device(struct vm_device * dev) int keyboard_deinit_device(struct vm_device *dev) { - - //dev_unhook_irq(dev,KEYBOARD_IRQ); - dev_unhook_io(dev, KEYBOARD_DATA_REG); - dev_unhook_io(dev, KEYBOARD_CONTROL_REG); - + dev_unhook_io(dev, KEYBOARD_60H); + dev_unhook_io(dev, KEYBOARD_64H); +#if KEYBOARD_DEBUG_80H + dev_unhook_io(dev, KEYBOARD_DELAY_80H); +#endif keyboard_reset_device(dev); return 0; } @@ -194,9 +640,16 @@ static struct vm_device_ops dev_ops = { struct vm_device *create_keyboard() { - struct keyboard_internal * keyboard_state = os_hooks->malloc(sizeof(struct keyboard_internal)); + + if (thekeyboard != NULL) { + KEYBOARD_DEBUG_PRINT("keyboard: creating >1 keyboard device. This will probably fail!\n"); + } + + struct keyboard_internal * keyboard_state = (struct keyboard_internal *)V3_Malloc(sizeof(struct keyboard_internal)); struct vm_device *device = create_device("KEYBOARD", &dev_ops, keyboard_state); + thekeyboard = device; + return device; }