pckbd.c revision 677833bc953b6cb418c701facbdcf4aa18d6c44e
#ifdef VBOX
/** @file
*
* VBox input devices:
* PS/2 keyboard & mouse controller device
*/
/*
* Copyright (C) 2006 InnoTek Systemberatung GmbH
*
* 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 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.
*
* If you received this file as part of a commercial VirtualBox
* distribution, then only the terms of your commercial VirtualBox
* license agreement apply instead of the previous paragraph.
*
* --------------------------------------------------------------------
*
* 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 2
/*******************************************************************************
* 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 */
#ifndef VBOX
#include "vl.h"
#endif
#ifdef VBOX
/* debug PC keyboard */
#define DEBUG_KBD
/* debug PC keyboard : only mouse */
#define DEBUG_MOUSE
#endif /* VBOX */
/* 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
typedef struct {
#ifndef VBOX
#endif /* !VBOX */
} KBDQueue;
#ifdef VBOX
#define MOUSE_CMD_QUEUE_SIZE 8
typedef struct {
#define MOUSE_EVENT_QUEUE_SIZE 256
typedef struct {
#endif /* VBOX */
typedef struct KBDState {
#ifdef VBOX
#endif /* VBOX */
/* keyboard state */
/* mouse state */
#ifdef VBOX
/** Pointer to the device instance. */
/** Pointer to the device instance. */
/**
* 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;
#endif
} KBDState;
#ifndef VBOX
#endif
/* 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)
{
#ifdef VBOX
#endif /* VBOX */
int irq12_level, irq1_level;
irq1_level = 0;
irq12_level = 0;
#ifdef VBOX
if (q->count != 0)
{
s->status |= KBD_STAT_OBF;
irq1_level = 1;
}
{
if (s->mode & KBD_MODE_MOUSE_INT)
irq12_level = 1;
}
#else /* !VBOX */
if (q->count != 0) {
s->status |= KBD_STAT_OBF;
s->status |= KBD_STAT_MOUSE_OBF;
if (s->mode & KBD_MODE_MOUSE_INT)
irq12_level = 1;
} else {
if ((s->mode & KBD_MODE_KBD_INT) &&
!(s->mode & KBD_MODE_DISABLE_KBD))
irq1_level = 1;
}
}
#endif /* !VBOX */
#ifndef VBOX
#else /* VBOX */
#endif /* VBOX */
}
{
#ifdef VBOX
#endif /* VBOX */
#if defined(DEBUG_MOUSE) || defined(DEBUG_KBD)
if (aux)
Log(("mouse event: 0x%02x\n", b));
#ifdef DEBUG_KBD
else
Log(("kbd event: 0x%02x\n", b));
#endif
#endif
#ifdef VBOX
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:
}
#else /* !VBOX */
if (q->count >= KBD_QUEUE_SIZE)
return;
if (++q->wptr == KBD_QUEUE_SIZE)
q->wptr = 0;
q->count++;
#endif /* !VBOX */
kbd_update_irq(s);
}
#ifdef IN_RING3
{
}
#endif /* IN_RING3 */
{
int val;
#if defined(DEBUG_KBD)
#endif
return val;
}
#ifndef VBOX
{
#else /* VBOX (we need VMReset return code passed back) */
{
int rc = VINF_SUCCESS;
#endif /* VBOX */
#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
# ifndef VBOX
# else /* VBOX */
# endif /* VBOX */
#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 VBOX
ioport_set_a20(1);
#else /* VBOX */
# ifndef IN_RING3
# else /* IN_RING3 */
# endif /* IN_RING3 */
#endif /* VBOX */
break;
case KBD_CCMD_DISABLE_A20:
#ifndef VBOX
ioport_set_a20(0);
#else /* VBOX */
# ifndef IN_RING3
# else /* IN_RING3 */
# endif /* !IN_RING3 */
#endif /* VBOX */
break;
#endif
case KBD_CCMD_RESET:
#ifndef VBOX
#else /* VBOX */
# ifndef IN_RING3
# else /* IN_RING3 */
# endif /* !IN_RING3 */
#endif /* VBOX */
break;
case 0xff:
/* ignore that - I don't know what is its use */
break;
default:
break;
}
#ifdef VBOX
return rc;
#endif
}
{
KBDQueue *q;
#ifdef VBOX
#endif /* VBOX */
q = &s->queue;
#ifdef VBOX
mcq = &s->mouse_command_queue;
meq = &s->mouse_event_queue;
#else /* !VBOX */
if (q->count == 0) {
#endif /* !VBOX */
/* 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 {
#ifdef VBOX
if (!aux)
{
if (++q->rptr == KBD_QUEUE_SIZE)
q->rptr = 0;
q->count--;
}
else
{
{
}
else
{
}
}
#else /* !VBOX */
if (++q->rptr == KBD_QUEUE_SIZE)
q->rptr = 0;
q->count--;
#endif /* !VBOX */
/* reading deasserts IRQ */
#ifndef VBOX
if (aux)
pic_set_irq(12, 0);
else
pic_set_irq(1, 0);
#else /* VBOX */
if (aux)
else
#endif /* VBOX */
}
/* 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;
}
#ifndef VBOX
#else
#endif
{
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_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_SET_LEDS:
{
#ifdef IN_RING3
PDMKEYBLEDS enmLeds = 0
;
#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;
}
#ifdef VBOX
#else /* !VBOX */
static void kbd_mouse_send_packet(KBDState *s)
#endif /* !VBOX */
{
#ifdef VBOX
#endif /* VBOX */
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;
#ifdef VBOX
#else /* !VBOX */
kbd_queue(s, b, 1);
#endif /* !VBOX */
/* 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;
#ifdef VBOX
#else /* !VBOX */
#endif /* !VBOX */
break;
case 4:
if (dz1 > 7)
dz1 = 7;
else if (dz1 < -7)
dz1 = -7;
#ifdef VBOX
#else /* !VBOX */
kbd_queue(s, b, 1);
#endif /* !VBOX */
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;
/* XXX: SDL sometimes generates nul events: we delete them */
s->mouse_buttons == buttons_state)
return;
s->mouse_buttons = buttons_state;
#ifdef VBOX
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);
break;
}
}
#else /* !VBOX */
if (!(s->mouse_status & MOUSE_STATUS_REMOTE) &&
for(;;) {
/* if not remote, send event. Multiple events are sent if
too big deltas */
break;
}
}
#endif /* !VBOX */
}
#endif /* IN_RING3 */
{
#ifdef DEBUG_MOUSE
#endif
#ifdef VBOX
/* Flush the mouse command response queue. */
s->mouse_command_queue.count = 0;
s->mouse_command_queue.rptr = 0;
s->mouse_command_queue.wptr = 0;
#endif /* VBOX */
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:
#ifdef VBOX
kbd_mouse_send_packet(s, true);
#else /* !VBOX */
#endif /* !VBOX */
break;
case AUX_ENABLE_DEV:
s->mouse_status |= MOUSE_STATUS_ENABLED;
break;
case AUX_DISABLE_DEV:
s->mouse_status &= ~MOUSE_STATUS_ENABLED;
#ifdef VBOX
/* Flush the mouse events queue. */
s->mouse_event_queue.count = 0;
s->mouse_event_queue.rptr = 0;
s->mouse_event_queue.wptr = 0;
#endif /* VBOX */
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;
#ifdef VBOX
/* Flush the mouse events queue. */
s->mouse_event_queue.count = 0;
s->mouse_event_queue.rptr = 0;
s->mouse_event_queue.wptr = 0;
#endif /* VBOX */
break;
default:
break;
}
break;
case AUX_SET_SAMPLE:
s->mouse_sample_rate = val;
/* detect IMPS/2 or IMEX */
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;
else
s->mouse_detect_state = 0;
break;
case 2:
if (val == 80)
s->mouse_detect_state = 0;
break;
case 3:
if (val == 80)
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;
}
}
#ifndef VBOX
{
#else /* VBOX */
{
int rc = VINF_SUCCESS;
#endif /* VBOX */
#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 VBOX
# else /* VBOX */
# ifndef IN_RING3
# else /* IN_RING3 */
# endif /* !IN_RING3 */
# endif /* VBOX */
#endif
if (!(val & 1)) {
#ifndef VBOX
#else /* VBOX */
# ifndef IN_RING3
# else
# endif
#endif /* VBOX */
}
break;
case KBD_CCMD_WRITE_MOUSE:
kbd_write_mouse(s, val);
break;
default:
break;
}
s->write_cmd = 0;
#ifdef VBOX
return rc;
#endif
}
#ifdef IN_RING3
{
KBDQueue *q;
#ifdef VBOX
#endif /* VBOX */
s->kbd_write_cmd = -1;
s->mouse_write_cmd = -1;
#ifdef VBOX /* Resetting everything, keyword was not working right on NT4 reboot. */
s->write_cmd = 0;
s->scan_enabled = 0;
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_buttons = 0;
#endif
q = &s->queue;
q->rptr = 0;
q->wptr = 0;
q->count = 0;
#ifdef VBOX
mcq = &s->mouse_command_queue;
meq = &s->mouse_event_queue;
#endif /* VBOX */
}
{
#ifdef VBOX
int i;
#endif /* VBOX */
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_8s(f, &s->mouse_buttons);
#ifdef VBOX
/*
* 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) % ELEMENTS(s->mouse_command_queue.data))
SSMR3PutU32(f, cItems);
for (i = s->mouse_event_queue.rptr; cItems-- > 0; i = (i + 1) % ELEMENTS(s->mouse_event_queue.data))
/* terminator */
SSMR3PutU32(f, ~0);
#endif /* VBOX */
}
{
#ifdef VBOX
int rc;
#endif
if (version_id != PCKBD_SAVED_STATE_VERSION)
#ifndef VBOX
return -EINVAL;
#else
#endif
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);
qemu_get_8s(f, &s->mouse_buttons);
#ifdef VBOX
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;
/*
* Load the queues
*/
if (VBOX_FAILURE(rc))
return rc;
{
}
for (i = 0; i < u32; i++)
{
if (VBOX_FAILURE(rc))
return rc;
}
if (VBOX_FAILURE(rc))
return rc;
{
}
for (i = 0; i < u32; i++)
{
if (VBOX_FAILURE(rc))
return rc;
}
if (VBOX_FAILURE(rc))
return rc;
{
}
for (i = 0; i < u32; i++)
{
if (VBOX_FAILURE(rc))
return rc;
}
/* terminator */
if (VBOX_FAILURE(rc))
return rc;
if (u32 != ~0)
{
}
#endif /* VBOX */
return 0;
}
#ifndef VBOX
void kbd_init(void)
{
kbd_reset(s);
}
#endif /* !VBOX */
#endif /* IN_RING3 */
#ifdef VBOX /* InnoTek 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 VINF_SUCCESS;
}
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 VINF_SUCCESS;
}
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)
{
if (cb == 1)
{
return rc;
}
return VINF_SUCCESS;
}
#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 u32Version The data unit version number.
*/
static DECLCALLBACK(int) kbdLoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSMHandle, uint32_t u32Version)
{
}
/**
* 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, 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.
* @remark The keyboard controller doesn't support this action, this is just
* implemented to try out the driver<->device structure.
*/
{
int rc;
switch (iLUN)
{
/* LUN #0: keyboard */
case 0:
rc = pDevIns->pDevHlp->pfnDriverAttach(pDevIns, iLUN, &pData->Keyboard.Base, &pData->Keyboard.pDrvBase, "Keyboard Port");
if (VBOX_SUCCESS(rc))
{
pData->Keyboard.pDrv = pData->Keyboard.pDrvBase->pfnQueryInterface(pData->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 = pDevIns->pDevHlp->pfnDriverAttach(pDevIns, iLUN, &pData->Mouse.Base, &pData->Mouse.pDrvBase, "Aux (Mouse) Port");
if (VBOX_SUCCESS(rc))
{
pData->Mouse.pDrv = pData->Mouse.pDrvBase->pfnQueryInterface(pData->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.
* @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
*/
{
}
/**
* 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 (rc == VERR_CFGM_VALUE_NOT_FOUND)
fGCEnabled = true;
else if (VBOX_FAILURE(rc))
{
return rc;
}
if (rc == VERR_CFGM_VALUE_NOT_FOUND)
fR0Enabled = true;
else if (VBOX_FAILURE(rc))
{
return rc;
}
/*
* Initialize the interfaces.
*/
/*
* 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 (VBOX_FAILURE(rc))
return rc;
rc = PDMDevHlpIOPortRegister(pDevIns, 0x64, 1, NULL, kbdIOPortCommandWrite, kbdIOPortStatusRead, NULL, NULL, "PC Keyboard - Command / Status");
if (VBOX_FAILURE(rc))
return rc;
if (fGCEnabled)
{
rc = PDMDevHlpIOPortRegisterGC(pDevIns, 0x60, 1, 0, "kbdIOPortDataWrite", "kbdIOPortDataRead", NULL, NULL, "PC Keyboard - Data");
if (VBOX_FAILURE(rc))
return rc;
rc = PDMDevHlpIOPortRegisterGC(pDevIns, 0x64, 1, 0, "kbdIOPortCommandWrite", "kbdIOPortStatusRead", NULL, NULL, "PC Keyboard - Command / Status");
if (VBOX_FAILURE(rc))
return rc;
}
if (fR0Enabled)
{
rc = pDevIns->pDevHlp->pfnIOPortRegisterR0(pDevIns, 0x60, 1, 0, "kbdIOPortDataWrite", "kbdIOPortDataRead", NULL, NULL, "PC Keyboard - Data");
if (VBOX_FAILURE(rc))
return rc;
rc = pDevIns->pDevHlp->pfnIOPortRegisterR0(pDevIns, 0x64, 1, 0, "kbdIOPortCommandWrite", "kbdIOPortStatusRead", NULL, NULL, "PC Keyboard - Command / Status");
if (VBOX_FAILURE(rc))
return rc;
}
rc = PDMDevHlpSSMRegister(pDevIns, g_DevicePS2KeyboardMouse.szDeviceName, iInstance, PCKBD_SAVED_STATE_VERSION, sizeof(*pData),
if (VBOX_FAILURE(rc))
return rc;
/*
* Attach to the keyboard and mouse drivers.
*/
if (VBOX_FAILURE(rc))
return rc;
if (VBOX_FAILURE(rc))
return rc;
/*
* Initialize the device state.
*/
return VINF_SUCCESS;
}
/**
* The device registration structure.
*/
const PDMDEVREG g_DevicePS2KeyboardMouse =
{
/* u32Version */
/* szDeviceName */
"pckbd",
/* szGCMod */
"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_GC | PDM_DEVREG_FLAGS_R0,
/* fClass */
/* cMaxInstances */
1,
/* cbInstance */
sizeof(KBDState),
/* pfnConstruct */
/* pfnDestruct */
NULL,
/* pfnRelocate */
/* pfnIOCtl */
NULL,
/* pfnPowerOn */
NULL,
/* pfnReset */
/* pfnSuspend */
NULL,
/* pfnResume */
NULL,
/* pfnAttach */
/* pfnDetach */
/* pfnQueryInterface. */
};
#endif /* IN_RING3 */
#endif /* VBOX */