DevPS2.cpp revision 3e9c5c3e44de15c28695c7b570bc2551639187e3
/* $Id$ */
/** @file
* DevPS2 - PS/2 keyboard & mouse controller device.
*/
/*
* Copyright (C) 2006-2007 Sun Microsystems, Inc.
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
* Clara, CA 95054 USA or visit http://www.sun.com if you need
* additional information or have any questions.
* --------------------------------------------------------------------
*
* This code is based on:
*
* QEMU PC keyboard emulation (revision 1.12)
*
* Copyright (c) 2003 Fabrice Bellard
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#define LOG_GROUP LOG_GROUP_DEV_KBD
#include "vl_vbox.h"
#include "../Builtins.h"
#define PCKBD_SAVED_STATE_VERSION 3
#ifndef VBOX_DEVICE_STRUCT_TESTCASE
/*******************************************************************************
* Internal Functions *
*******************************************************************************/
PDMBOTHCBDECL(int) kbdIOPortDataRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb);
PDMBOTHCBDECL(int) kbdIOPortDataWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb);
PDMBOTHCBDECL(int) kbdIOPortStatusRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb);
PDMBOTHCBDECL(int) kbdIOPortCommandWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb);
#endif /* !VBOX_DEVICE_STRUCT_TESTCASE */
/* debug PC keyboard */
#define DEBUG_KBD
/* debug PC keyboard : only mouse */
#define DEBUG_MOUSE
/* Keyboard Controller Commands */
#define KBD_CCMD_WRITE_OBUF 0xD2
initiated by the auxiliary device */
#define KBD_CCMD_RESET 0xFE
/* Keyboard Commands */
#define KBD_CMD_ECHO 0xEE
/* Keyboard Replies */
/* Status Register Bits */
/* Controller Mode Register Bits */
#define KBD_MODE_RFU 0x80
/* Mouse Commands */
#define AUX_SET_DEFAULT 0xF6
#define MOUSE_STATUS_REMOTE 0x40
#define MOUSE_STATUS_ENABLED 0x20
#define MOUSE_STATUS_SCALE21 0x10
#define KBD_QUEUE_SIZE 256
# define MOUSE_REPORT_HORIZONTAL 0x01
# define MOUSE_OUTSTANDING_CLICK 0x02
typedef struct {
} KBDQueue;
#define MOUSE_CMD_QUEUE_SIZE 8
typedef struct {
#define MOUSE_EVENT_QUEUE_SIZE 256
typedef struct {
typedef struct KBDState {
/* keyboard state */
/* mouse state */
/** Pointer to the device instance - RC. */
/** Pointer to the device instance - R3 . */
/** Pointer to the device instance. */
/** Critical section protecting the state. */
/**
* Keyboard port - LUN#0.
*/
struct
{
/** The base interface for the keyboard port. */
/** The keyboard port base interface. */
/** The base interface of the attached keyboard driver. */
/** The keyboard interface of the attached keyboard driver. */
} Keyboard;
/**
* Mouse port - LUN#1.
*/
struct
{
/** The base interface for the mouse port. */
/** The mouse port base interface. */
/** The base interface of the attached mouse driver. */
/** The mouse interface of the attached mouse driver. */
} Mouse;
} KBDState;
/* Table to convert from PC scancodes to raw scancodes. */
static const unsigned char ps2_raw_keycode[128] = {
0,118, 22, 30, 38, 37, 46, 54, 61, 62, 70, 69, 78, 85,102, 13,
21, 29, 36, 45, 44, 53, 60, 67, 68, 77, 84, 91, 90, 20, 28, 27,
35, 43, 52, 51, 59, 66, 75, 76, 82, 14, 18, 93, 26, 34, 33, 42,
50, 49, 58, 65, 73, 74, 89,124, 17, 41, 88, 5, 6, 4, 12, 3,
11, 2, 10, 1, 9,119,126,108,117,125,123,107,115,116,121,105,
114,122,112,113,127, 96, 97,120, 7, 15, 23, 31, 39, 47, 55, 63,
71, 79, 86, 94, 8, 16, 24, 32, 40, 48, 56, 64, 72, 80, 87,111,
19, 25, 57, 81, 83, 92, 95, 98, 99,100,101,103,104,106,109,110
};
#ifndef VBOX_DEVICE_STRUCT_TESTCASE
/* update irq and KBD_STAT_[MOUSE_]OBF */
/* XXX: not generating the irqs if KBD_MODE_DISABLE_KBD is set may be
incorrect, but it avoids having to simulate exact delays */
static void kbd_update_irq(KBDState *s)
{
int irq12_level, irq1_level;
irq1_level = 0;
irq12_level = 0;
if (q->count != 0)
{
s->status |= KBD_STAT_OBF;
irq1_level = 1;
}
{
if (s->mode & KBD_MODE_MOUSE_INT)
irq12_level = 1;
}
}
{
#if defined(DEBUG_MOUSE) || defined(DEBUG_KBD)
if (aux == 1)
else if (aux == 2)
#ifdef DEBUG_KBD
else
#endif
#endif
switch (aux)
{
case 0: /* keyboard */
if (q->count >= KBD_QUEUE_SIZE)
return;
if (++q->wptr == KBD_QUEUE_SIZE)
q->wptr = 0;
q->count++;
break;
case 1: /* mouse command response */
return;
break;
case 2: /* mouse event data */
return;
break;
default:
}
kbd_update_irq(s);
}
#ifdef IN_RING3
{
/* XXX: add support for scancode sets 1 and 3 */
{
if (keycode & 0x80)
kbd_queue(s, 0xf0, 0);
}
}
#endif /* IN_RING3 */
{
int val;
#if defined(DEBUG_KBD)
#endif
return val;
}
{
int rc = VINF_SUCCESS;
#ifdef DEBUG_KBD
#endif
switch(val) {
case KBD_CCMD_READ_MODE:
break;
case KBD_CCMD_WRITE_MODE:
case KBD_CCMD_WRITE_OBUF:
case KBD_CCMD_WRITE_AUX_OBUF:
case KBD_CCMD_WRITE_MOUSE:
case KBD_CCMD_WRITE_OUTPORT:
break;
case KBD_CCMD_MOUSE_DISABLE:
s->mode |= KBD_MODE_DISABLE_MOUSE;
break;
case KBD_CCMD_MOUSE_ENABLE:
s->mode &= ~KBD_MODE_DISABLE_MOUSE;
break;
case KBD_CCMD_TEST_MOUSE:
kbd_queue(s, 0x00, 0);
break;
case KBD_CCMD_SELF_TEST:
s->status |= KBD_STAT_SELFTEST;
kbd_queue(s, 0x55, 0);
break;
case KBD_CCMD_KBD_TEST:
kbd_queue(s, 0x00, 0);
break;
case KBD_CCMD_KBD_DISABLE:
s->mode |= KBD_MODE_DISABLE_KBD;
kbd_update_irq(s);
break;
case KBD_CCMD_KBD_ENABLE:
s->mode &= ~KBD_MODE_DISABLE_KBD;
kbd_update_irq(s);
break;
case KBD_CCMD_READ_INPORT:
kbd_queue(s, 0x00, 0);
break;
case KBD_CCMD_READ_OUTPORT:
/* XXX: check that */
#ifdef TARGET_I386
#else
val = 0x01;
#endif
if (s->status & KBD_STAT_OBF)
val |= 0x10;
if (s->status & KBD_STAT_MOUSE_OBF)
val |= 0x20;
break;
#ifdef TARGET_I386
case KBD_CCMD_ENABLE_A20:
# ifndef IN_RING3
# else /* IN_RING3 */
# endif /* IN_RING3 */
break;
case KBD_CCMD_DISABLE_A20:
# ifndef IN_RING3
# else /* IN_RING3 */
# endif /* !IN_RING3 */
break;
#endif
case KBD_CCMD_READ_TSTINP:
/* Keyboard clock line is zero IFF keyboard is disabled */
break;
case KBD_CCMD_RESET:
#ifndef IN_RING3
#else /* IN_RING3 */
#endif /* !IN_RING3 */
break;
case 0xff:
/* ignore that - I don't know what is its use */
break;
/* Make OS/2 happy. */
/* The 8042 RAM is readble using commands 0x20 thru 0x3f, and writable
by 0x60 thru 0x7f. Now days only the firs byte, the mode, is used.
We'll ignore the writes (0x61..7f) and return 0 for all the reads
just to make some OS/2 debug stuff a bit happier. */
case 0x21: case 0x22: case 0x23: case 0x24: case 0x25: case 0x26: case 0x27:
case 0x28: case 0x29: case 0x2a: case 0x2b: case 0x2c: case 0x2d: case 0x2e: case 0x2f:
case 0x30: case 0x31: case 0x32: case 0x33: case 0x34: case 0x35: case 0x36: case 0x37:
case 0x38: case 0x39: case 0x3a: case 0x3b: case 0x3c: case 0x3d: case 0x3e: case 0x3f:
kbd_queue(s, 0, 0);
break;
default:
break;
}
return rc;
}
{
KBDQueue *q;
q = &s->queue;
mcq = &s->mouse_command_queue;
meq = &s->mouse_event_queue;
/* NOTE: if no data left, we return the last keyboard one
(needed for EMM386) */
/* XXX: need a timer to do things correctly */
if (index < 0)
} else {
if (!aux)
{
if (++q->rptr == KBD_QUEUE_SIZE)
q->rptr = 0;
q->count--;
}
else
{
{
}
else
{
}
}
/* reading deasserts IRQ */
if (aux)
else
}
/* reassert IRQs if data left */
kbd_update_irq(s);
#ifdef DEBUG_KBD
#endif
return val;
}
static void kbd_reset_keyboard(KBDState *s)
{
s->scan_enabled = 1;
s->scancode_set = 2;
}
{
switch(s->kbd_write_cmd) {
default:
case -1:
switch(val) {
case 0x00:
kbd_queue(s, KBD_REPLY_ACK, 0);
break;
case 0x05:
kbd_queue(s, KBD_REPLY_RESEND, 0);
break;
case KBD_CMD_GET_ID:
kbd_queue(s, KBD_REPLY_ACK, 0);
kbd_queue(s, 0xab, 0);
kbd_queue(s, 0x83, 0);
break;
case KBD_CMD_ECHO:
kbd_queue(s, KBD_CMD_ECHO, 0);
break;
case KBD_CMD_ENABLE:
s->scan_enabled = 1;
kbd_queue(s, KBD_REPLY_ACK, 0);
break;
case KBD_CMD_SCANCODE:
case KBD_CMD_SET_LEDS:
case KBD_CMD_SET_RATE:
s->kbd_write_cmd = val;
kbd_queue(s, KBD_REPLY_ACK, 0);
break;
case KBD_CMD_RESET_DISABLE:
s->scan_enabled = 0;
kbd_queue(s, KBD_REPLY_ACK, 0);
break;
case KBD_CMD_RESET_ENABLE:
s->scan_enabled = 1;
kbd_queue(s, KBD_REPLY_ACK, 0);
break;
case KBD_CMD_RESET:
kbd_queue(s, KBD_REPLY_ACK, 0);
kbd_queue(s, KBD_REPLY_POR, 0);
break;
default:
kbd_queue(s, KBD_REPLY_ACK, 0);
break;
}
break;
case KBD_CMD_SCANCODE:
#ifdef IN_RING3
if (val == 0) {
if (s->scancode_set == 1)
pc_kbd_put_keycode(s, 0x43);
else if (s->scancode_set == 2)
pc_kbd_put_keycode(s, 0x41);
else if (s->scancode_set == 3)
pc_kbd_put_keycode(s, 0x3f);
} else {
s->scancode_set = val;
kbd_queue(s, KBD_REPLY_ACK, 0);
}
#else
return VINF_IOM_HC_IOPORT_WRITE;
#endif
case KBD_CMD_SET_LEDS:
{
#ifdef IN_RING3
if (val & 0x01)
if (val & 0x02)
if (val & 0x04)
#else
return VINF_IOM_HC_IOPORT_WRITE;
#endif
kbd_queue(s, KBD_REPLY_ACK, 0);
s->kbd_write_cmd = -1;
}
break;
case KBD_CMD_SET_RATE:
kbd_queue(s, KBD_REPLY_ACK, 0);
s->kbd_write_cmd = -1;
break;
}
return VINF_SUCCESS;
}
{
unsigned int b;
/* XXX: increase range to 8 bits ? */
if (dx1 > 127)
dx1 = 127;
else if (dx1 < -127)
dx1 = -127;
if (dy1 > 127)
dy1 = 127;
else if (dy1 < -127)
dy1 = -127;
/* extra byte for IMPS/2 or IMEX */
switch(s->mouse_type) {
default:
break;
case 3:
if (dz1 > 127)
dz1 = 127;
else if (dz1 < -127)
dz1 = -127;
break;
case 4:
if (dz1 > 1)
dz1 = 1;
else if (dz1 < -1)
dz1 = -1;
else if (dw1 > 1)
dw1 = 1;
else if (dw1 < -1)
dw1 = -1;
if (dz1)
dw1 = 0;
else
{
s->mouse_flags &= ~MOUSE_OUTSTANDING_CLICK;
}
break;
}
/* update deltas */
}
#ifdef IN_RING3
static void pc_kbd_mouse_event(void *opaque,
{
/* check if deltas are recorded when disabled */
if (!(s->mouse_status & MOUSE_STATUS_ENABLED))
return;
/* In horizontal reporting mode, we may need to send an additional packet
* for the forth and fifth buttons, as they can't share a packet with a
* horizontal scroll delta. */
if ( s->mouse_type == 4
s->mouse_buttons = buttons_state;
if (!(s->mouse_status & MOUSE_STATUS_REMOTE) &&
for(;;) {
/* if not remote, send event. Multiple events are sent if
too big deltas */
kbd_mouse_send_packet(s, false);
if (s->mouse_dx == 0 && s->mouse_dy == 0 && s->mouse_dz == 0 && s->mouse_dw == 0 && !(s->mouse_flags & MOUSE_OUTSTANDING_CLICK))
break;
}
}
}
#endif /* IN_RING3 */
{
#ifdef DEBUG_MOUSE
#endif
/* Flush the mouse command response queue. */
s->mouse_command_queue.count = 0;
s->mouse_command_queue.rptr = 0;
s->mouse_command_queue.wptr = 0;
switch(s->mouse_write_cmd) {
default:
case -1:
/* mouse command */
if (s->mouse_wrap) {
if (val == AUX_RESET_WRAP) {
s->mouse_wrap = 0;
return;
return;
}
}
switch(val) {
case AUX_SET_SCALE11:
s->mouse_status &= ~MOUSE_STATUS_SCALE21;
break;
case AUX_SET_SCALE21:
s->mouse_status |= MOUSE_STATUS_SCALE21;
break;
case AUX_SET_STREAM:
s->mouse_status &= ~MOUSE_STATUS_REMOTE;
break;
case AUX_SET_WRAP:
s->mouse_wrap = 1;
break;
case AUX_SET_REMOTE:
s->mouse_status |= MOUSE_STATUS_REMOTE;
break;
case AUX_GET_TYPE:
break;
case AUX_SET_RES:
case AUX_SET_SAMPLE:
s->mouse_write_cmd = val;
break;
case AUX_GET_SCALE:
break;
case AUX_POLL:
kbd_mouse_send_packet(s, true);
break;
case AUX_ENABLE_DEV:
s->mouse_status |= MOUSE_STATUS_ENABLED;
break;
case AUX_DISABLE_DEV:
s->mouse_status &= ~MOUSE_STATUS_ENABLED;
/* Flush the mouse events queue. */
s->mouse_event_queue.count = 0;
s->mouse_event_queue.rptr = 0;
s->mouse_event_queue.wptr = 0;
break;
case AUX_SET_DEFAULT:
s->mouse_sample_rate = 100;
s->mouse_resolution = 2;
s->mouse_status = 0;
break;
case AUX_RESET:
s->mouse_sample_rate = 100;
s->mouse_resolution = 2;
s->mouse_status = 0;
s->mouse_type = 0;
/* Flush the mouse events queue. */
s->mouse_event_queue.count = 0;
s->mouse_event_queue.rptr = 0;
s->mouse_event_queue.wptr = 0;
break;
default:
/* NACK all commands we don't know.
The usecase for this is the OS/2 mouse driver which will try
read 0xE2 in order to figure out if it's a trackpoint device
or not. If it doesn't get a NACK (or ACK) on the command it'll
do several hundred thousand status reads before giving up. This
is slows down the OS/2 boot up considerably. (It also seems that
the code is somehow vulnerable while polling like this and that
mouse or keyboard input at this point might screw things up badly.)
Every command or data byte sent to the mouse (except for the
resend command fe) is ACKed with fa. If the command or data
is invalid, it is NACKed with fe. If the next byte is again
invalid, the reply is ERROR: fc. */
/** @todo send error if we NACKed the previous command? */
break;
}
break;
case AUX_SET_SAMPLE:
s->mouse_sample_rate = val;
/* detect IMPS/2 or IMEX */
/* And enable horizontal scrolling reporting when requested */
switch(s->mouse_detect_state) {
default:
case 0:
if (val == 200)
s->mouse_detect_state = 1;
break;
case 1:
if (val == 100)
s->mouse_detect_state = 2;
else if (val == 200)
s->mouse_detect_state = 3;
/* enable horizontal scrolling, byte two */
s->mouse_detect_state = 4;
else
s->mouse_detect_state = 0;
break;
case 2:
if (val == 80)
{
LogRelFlowFunc(("switching mouse device to IMPS/2 mode\n"));
}
s->mouse_detect_state = 0;
break;
case 3:
if (val == 80)
{
LogRelFlowFunc(("switching mouse device to IMEX mode\n"));
}
s->mouse_detect_state = 0;
break;
case 4:
if (val == 40)
{
LogFlowFunc(("enabling IMEX horizontal scrolling reporting\n"));
}
s->mouse_detect_state = 0;
break;
}
s->mouse_write_cmd = -1;
break;
case AUX_SET_RES:
s->mouse_resolution = val;
s->mouse_write_cmd = -1;
break;
}
}
{
int rc = VINF_SUCCESS;
#ifdef DEBUG_KBD
#endif
switch(s->write_cmd) {
case 0:
break;
case KBD_CCMD_WRITE_MODE:
kbd_update_irq(s);
break;
case KBD_CCMD_WRITE_OBUF:
break;
case KBD_CCMD_WRITE_AUX_OBUF:
break;
case KBD_CCMD_WRITE_OUTPORT:
#ifdef TARGET_I386
# ifndef IN_RING3
# else /* IN_RING3 */
# endif /* !IN_RING3 */
#endif
if (!(val & 1)) {
# ifndef IN_RING3
# else
# endif
}
break;
case KBD_CCMD_WRITE_MOUSE:
kbd_write_mouse(s, val);
break;
default:
break;
}
s->write_cmd = 0;
return rc;
}
#ifdef IN_RING3
{
KBDQueue *q;
s->kbd_write_cmd = -1;
s->mouse_write_cmd = -1;
/* Resetting everything, keyword was not working right on NT4 reboot. */
s->write_cmd = 0;
s->scan_enabled = 0;
s->translate = 0;
s->scancode_set = 2;
s->mouse_status = 0;
s->mouse_resolution = 0;
s->mouse_sample_rate = 0;
s->mouse_wrap = 0;
s->mouse_type = 0;
s->mouse_detect_state = 0;
s->mouse_dx = 0;
s->mouse_dy = 0;
s->mouse_dz = 0;
s->mouse_dw = 0;
s->mouse_flags = 0;
s->mouse_buttons = 0;
q = &s->queue;
q->rptr = 0;
q->wptr = 0;
q->count = 0;
mcq = &s->mouse_command_queue;
meq = &s->mouse_event_queue;
}
{
int i;
qemu_put_8s(f, &s->write_cmd);
qemu_put_8s(f, &s->status);
qemu_put_8s(f, &s->mode);
qemu_put_be32s(f, &s->kbd_write_cmd);
qemu_put_be32s(f, &s->scan_enabled);
qemu_put_be32s(f, &s->mouse_write_cmd);
qemu_put_8s(f, &s->mouse_status);
qemu_put_8s(f, &s->mouse_resolution);
qemu_put_8s(f, &s->mouse_sample_rate);
qemu_put_8s(f, &s->mouse_wrap);
qemu_put_8s(f, &s->mouse_type);
qemu_put_8s(f, &s->mouse_detect_state);
qemu_put_be32s(f, &s->mouse_dx);
qemu_put_be32s(f, &s->mouse_dy);
qemu_put_be32s(f, &s->mouse_dz);
qemu_put_be32s(f, &s->mouse_dw);
qemu_put_be32s(f, &s->mouse_flags);
qemu_put_8s(f, &s->mouse_buttons);
/* XXX: s->scancode_set isn't being saved, but we only really support set 2,
* so no real harm done.
*/
/*
* We have to save the queues too.
*/
SSMR3PutU32(f, cItems);
SSMR3PutU32(f, cItems);
for (i = s->mouse_command_queue.rptr; cItems-- > 0; i = (i + 1) % RT_ELEMENTS(s->mouse_command_queue.data))
SSMR3PutU32(f, cItems);
for (i = s->mouse_event_queue.rptr; cItems-- > 0; i = (i + 1) % RT_ELEMENTS(s->mouse_event_queue.data))
/* terminator */
SSMR3PutU32(f, ~0);
}
{
int rc;
qemu_get_8s(f, &s->write_cmd);
qemu_get_8s(f, &s->status);
qemu_get_8s(f, &s->mode);
qemu_get_8s(f, &s->mouse_status);
qemu_get_8s(f, &s->mouse_resolution);
qemu_get_8s(f, &s->mouse_sample_rate);
qemu_get_8s(f, &s->mouse_wrap);
qemu_get_8s(f, &s->mouse_type);
qemu_get_8s(f, &s->mouse_detect_state);
if (version_id > 2)
{
SSMR3GetS32(f, &s->mouse_dw);
SSMR3GetS32(f, &s->mouse_flags);
}
qemu_get_8s(f, &s->mouse_buttons);
s->mouse_command_queue.count = 0;
s->mouse_command_queue.rptr = 0;
s->mouse_command_queue.wptr = 0;
s->mouse_event_queue.count = 0;
s->mouse_event_queue.rptr = 0;
s->mouse_event_queue.wptr = 0;
/* Determine the translation state. */
/*
* Load the queues
*/
if (RT_FAILURE(rc))
return rc;
{
}
for (i = 0; i < u32; i++)
{
if (RT_FAILURE(rc))
return rc;
}
if (RT_FAILURE(rc))
return rc;
{
}
for (i = 0; i < u32; i++)
{
if (RT_FAILURE(rc))
return rc;
}
if (RT_FAILURE(rc))
return rc;
{
}
for (i = 0; i < u32; i++)
{
if (RT_FAILURE(rc))
return rc;
}
/* terminator */
if (RT_FAILURE(rc))
return rc;
if (u32 != ~0U)
{
}
return 0;
}
#endif /* IN_RING3 */
/* VirtualBox code start */
/* -=-=-=-=-=- wrappers -=-=-=-=-=- */
/**
* Port I/O Handler for keyboard data IN operations.
*
* @returns VBox status code.
*
* @param pDevIns The device instance.
* @param pvUser User argument - ignored.
* @param Port Port number used for the IN operation.
* @param pu32 Where to store the result.
* @param cb Number of bytes read.
*/
PDMBOTHCBDECL(int) kbdIOPortDataRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb)
{
if (cb == 1)
{
{
}
return rc;
}
return VERR_IOM_IOPORT_UNUSED;
}
/**
* Port I/O Handler for keyboard data OUT operations.
*
* @returns VBox status code.
*
* @param pDevIns The device instance.
* @param pvUser User argument - ignored.
* @param Port Port number used for the IN operation.
* @param u32 The value to output.
* @param cb The value size in bytes.
*/
PDMBOTHCBDECL(int) kbdIOPortDataWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb)
{
int rc = VINF_SUCCESS;
if (cb == 1)
{
{
}
}
else
return rc;
}
/**
* Port I/O Handler for keyboard status IN operations.
*
* @returns VBox status code.
*
* @param pDevIns The device instance.
* @param pvUser User argument - ignored.
* @param Port Port number used for the IN operation.
* @param pu32 Where to store the result.
* @param cb Number of bytes read.
*/
PDMBOTHCBDECL(int) kbdIOPortStatusRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb)
{
if (cb == 1)
{
{
}
return rc;
}
return VERR_IOM_IOPORT_UNUSED;
}
/**
* Port I/O Handler for keyboard command OUT operations.
*
* @returns VBox status code.
*
* @param pDevIns The device instance.
* @param pvUser User argument - ignored.
* @param Port Port number used for the IN operation.
* @param u32 The value to output.
* @param cb The value size in bytes.
*/
PDMBOTHCBDECL(int) kbdIOPortCommandWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb)
{
int rc = VINF_SUCCESS;
if (cb == 1)
{
{
}
}
else
return rc;
}
#ifdef IN_RING3
/**
* Saves a state of the keyboard device.
*
* @returns VBox status code.
* @param pDevIns The device instance.
* @param pSSMHandle The handle to save the state to.
*/
{
return VINF_SUCCESS;
}
/**
* Loads a saved keyboard device state.
*
* @returns VBox status code.
* @param pDevIns The device instance.
* @param pSSMHandle The handle to the saved state.
* @param uVersion The data unit version number.
* @param uPass The data pass.
*/
static DECLCALLBACK(int) kbdLoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSMHandle, uint32_t uVersion, uint32_t uPass)
{
}
/**
* Reset notification.
*
* @returns VBox status.
* @param pDevIns The device instance data.
*/
{
}
/* -=-=-=-=-=- Keyboard: IBase -=-=-=-=-=- */
/**
* Queries an interface to the driver.
*
* @returns Pointer to interface.
* @returns NULL if the interface was not supported by the device.
* @param pInterface Pointer to the keyboard port base interface (KBDState::Keyboard.Base).
* @param enmInterface The requested interface identification.
*/
static DECLCALLBACK(void *) kbdKeyboardQueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface)
{
switch (enmInterface)
{
case PDMINTERFACE_BASE:
default:
return NULL;
}
}
/* -=-=-=-=-=- Keyboard: IKeyboardPort -=-=-=-=-=- */
/** Converts a keyboard port interface pointer to a keyboard state pointer. */
#define IKEYBOARDPORT_2_KBDSTATE(pInterface) ( (KBDState *)((uintptr_t)pInterface - RT_OFFSETOF(KBDState, Keyboard.Port)) )
/**
* Keyboard event handler.
*
* @returns VBox status code.
* @param pInterface Pointer to the keyboard port interface (KBDState::Keyboard.Port).
* @param u8KeyCode The keycode.
*/
{
return VINF_SUCCESS;
}
/* -=-=-=-=-=- Mouse: IBase -=-=-=-=-=- */
/**
* Queries an interface to the driver.
*
* @returns Pointer to interface.
* @returns NULL if the interface was not supported by the device.
* @param pInterface Pointer to the mouse port base interface (KBDState::Mouse.Base).
* @param enmInterface The requested interface identification.
*/
{
switch (enmInterface)
{
case PDMINTERFACE_BASE:
case PDMINTERFACE_MOUSE_PORT:
default:
return NULL;
}
}
/* -=-=-=-=-=- Mouse: IMousePort -=-=-=-=-=- */
/** Converts a mouse port interface pointer to a keyboard state pointer. */
#define IMOUSEPORT_2_KBDSTATE(pInterface) ( (KBDState *)((uintptr_t)pInterface - RT_OFFSETOF(KBDState, Mouse.Port)) )
/**
* Mouse event handler.
*
* @returns VBox status code.
* @param pInterface Pointer to the mouse port interface (KBDState::Mouse.Port).
* @param i32DeltaX The X delta.
* @param i32DeltaY The Y delta.
* @param i32DeltaZ The Z delta.
* @param fButtonStates The button states.
*/
static DECLCALLBACK(int) kbdMousePutEvent(PPDMIMOUSEPORT pInterface, int32_t i32DeltaX, int32_t i32DeltaY, int32_t i32DeltaZ, int32_t i32DeltaW, uint32_t fButtonStates)
{
return VINF_SUCCESS;
}
/* -=-=-=-=-=- real code -=-=-=-=-=- */
/**
* Attach command.
*
* This is called to let the device attach to a driver for a specified LUN
* during runtime. This is not called during VM construction, the device
* constructor have to attach to all the available drivers.
*
* This is like plugging in the keyboard or mouse after turning on the PC.
*
* @returns VBox status code.
* @param pDevIns The device instance.
* @param iLUN The logical unit which is being detached.
* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
* @remark The keyboard controller doesn't support this action, this is just
* implemented to try out the driver<->device structure.
*/
{
int rc;
("PS/2 device does not support hotplugging\n"),
switch (iLUN)
{
/* LUN #0: keyboard */
case 0:
rc = PDMDevHlpDriverAttach(pDevIns, iLUN, &pThis->Keyboard.Base, &pThis->Keyboard.pDrvBase, "Keyboard Port");
if (RT_SUCCESS(rc))
{
pThis->Keyboard.pDrv = (PDMIKEYBOARDCONNECTOR*)(pThis->Keyboard.pDrvBase->pfnQueryInterface(pThis->Keyboard.pDrvBase, PDMINTERFACE_KEYBOARD_CONNECTOR));
{
}
}
else if (rc == VERR_PDM_NO_ATTACHED_DRIVER)
{
Log(("%s/%d: warning: no driver attached to LUN #0!\n", pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
rc = VINF_SUCCESS;
}
else
break;
case 1:
rc = PDMDevHlpDriverAttach(pDevIns, iLUN, &pThis->Mouse.Base, &pThis->Mouse.pDrvBase, "Aux (Mouse) Port");
if (RT_SUCCESS(rc))
{
pThis->Mouse.pDrv = (PDMIMOUSECONNECTOR*)(pThis->Mouse.pDrvBase->pfnQueryInterface(pThis->Mouse.pDrvBase, PDMINTERFACE_MOUSE_CONNECTOR));
{
}
}
else if (rc == VERR_PDM_NO_ATTACHED_DRIVER)
{
Log(("%s/%d: warning: no driver attached to LUN #1!\n", pDevIns->pDevReg->szDeviceName, pDevIns->iInstance));
rc = VINF_SUCCESS;
}
else
break;
default:
return VERR_PDM_NO_SUCH_LUN;
}
return rc;
}
/**
* Detach notification.
*
* This is called when a driver is detaching itself from a LUN of the device.
* The device should adjust it's state to reflect this.
*
* This is like unplugging the network cable to use it for the laptop or
* something while the PC is still running.
*
* @param pDevIns The device instance.
* @param iLUN The logical unit which is being detached.
* @param fFlags Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
* @remark The keyboard controller doesn't support this action, this is just
* implemented to try out the driver<->device structure.
*/
{
#if 0
/*
* Reset the interfaces and update the controller state.
*/
switch (iLUN)
{
/* LUN #0: keyboard */
case 0:
break;
case 1:
break;
default:
break;
}
#endif
}
/**
* @copydoc FNPDMDEVRELOCATE
*/
{
}
/**
* Destruct a device instance for a VM.
*
* @returns VBox status.
* @param pDevIns The device instance data.
*/
{
return VINF_SUCCESS;
}
/**
* Construct a device instance for a VM.
*
* @returns VBox status.
* @param pDevIns The device instance data.
* If the registration structure is needed, pDevIns->pDevReg points to it.
* @param iInstance Instance number. Use this to figure out which registers and such to use.
* The device number is also found in pDevIns->iInstance, but since it's
* likely to be freqently used PDM passes it as parameter.
* @param pCfgHandle Configuration node handle for the device. Use this to obtain the configuration
* of the device instance. It's also found in pDevIns->pCfgHandle, but like
* iInstance it's expected to be used a bit in this function.
*/
{
int rc;
bool fGCEnabled;
bool fR0Enabled;
/*
* Validate and read the configuration.
*/
if (RT_FAILURE(rc))
if (RT_FAILURE(rc))
/*
* Initialize the interfaces.
*/
/*
* Initialize the critical section.
*/
if (RT_FAILURE(rc))
return rc;
/*
* Register I/O ports, save state, keyboard event handler and mouse event handlers.
*/
rc = PDMDevHlpIOPortRegister(pDevIns, 0x60, 1, NULL, kbdIOPortDataWrite, kbdIOPortDataRead, NULL, NULL, "PC Keyboard - Data");
if (RT_FAILURE(rc))
return rc;
rc = PDMDevHlpIOPortRegister(pDevIns, 0x64, 1, NULL, kbdIOPortCommandWrite, kbdIOPortStatusRead, NULL, NULL, "PC Keyboard - Command / Status");
if (RT_FAILURE(rc))
return rc;
if (fGCEnabled)
{
rc = PDMDevHlpIOPortRegisterGC(pDevIns, 0x60, 1, 0, "kbdIOPortDataWrite", "kbdIOPortDataRead", NULL, NULL, "PC Keyboard - Data");
if (RT_FAILURE(rc))
return rc;
rc = PDMDevHlpIOPortRegisterGC(pDevIns, 0x64, 1, 0, "kbdIOPortCommandWrite", "kbdIOPortStatusRead", NULL, NULL, "PC Keyboard - Command / Status");
if (RT_FAILURE(rc))
return rc;
}
if (fR0Enabled)
{
rc = pDevIns->pDevHlpR3->pfnIOPortRegisterR0(pDevIns, 0x60, 1, 0, "kbdIOPortDataWrite", "kbdIOPortDataRead", NULL, NULL, "PC Keyboard - Data");
if (RT_FAILURE(rc))
return rc;
rc = pDevIns->pDevHlpR3->pfnIOPortRegisterR0(pDevIns, 0x64, 1, 0, "kbdIOPortCommandWrite", "kbdIOPortStatusRead", NULL, NULL, "PC Keyboard - Command / Status");
if (RT_FAILURE(rc))
return rc;
}
rc = PDMDevHlpSSMRegister(pDevIns, PCKBD_SAVED_STATE_VERSION, sizeof(*pThis), kbdSaveExec, kbdLoadExec);
if (RT_FAILURE(rc))
return rc;
/*
* Attach to the keyboard and mouse drivers.
*/
if (RT_FAILURE(rc))
return rc;
if (RT_FAILURE(rc))
return rc;
/*
* Initialize the device state.
*/
return VINF_SUCCESS;
}
/**
* The device registration structure.
*/
const PDMDEVREG g_DevicePS2KeyboardMouse =
{
/* u32Version */
/* szDeviceName */
"pckbd",
/* szRCMod */
"VBoxDDGC.gc",
/* szR0Mod */
"VBoxDDR0.r0",
/* pszDescription */
"PS/2 Keyboard and Mouse device. Emulates both the keyboard, mouse and the keyboard controller. "
"LUN #0 is the keyboard connector. "
/* fFlags */
PDM_DEVREG_FLAGS_HOST_BITS_DEFAULT | PDM_DEVREG_FLAGS_GUEST_BITS_32_64 | PDM_DEVREG_FLAGS_PAE36 | PDM_DEVREG_FLAGS_RC | PDM_DEVREG_FLAGS_R0,
/* fClass */
/* cMaxInstances */
1,
/* cbInstance */
sizeof(KBDState),
/* pfnConstruct */
/* pfnDestruct */
/* pfnRelocate */
/* pfnIOCtl */
NULL,
/* pfnPowerOn */
NULL,
/* pfnReset */
/* pfnSuspend */
NULL,
/* pfnResume */
NULL,
/* pfnAttach */
/* pfnDetach */
/* pfnQueryInterface. */
NULL,
/* pfnInitComplete */
NULL,
/* pfnPowerOff */
NULL,
/* pfnSoftReset */
NULL,
/* u32VersionEnd */
};
#endif /* IN_RING3 */
#endif /* !VBOX_DEVICE_STRUCT_TESTCASE */