DrvMouseQueue.cpp revision 83df31c21044349888e688d5f793ce39007e6693
/** @file
*
* VBox input devices:
* Mouse queue driver
*/
/*
* 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.
*/
/*******************************************************************************
* Header Files *
*******************************************************************************/
#define LOG_GROUP LOG_GROUP_DRV_MOUSE_QUEUE
#include "Builtins.h"
/*******************************************************************************
* Structures and Typedefs *
*******************************************************************************/
/**
* Mouse queue driver instance data.
*/
typedef struct DRVMOUSEQUEUE
{
/** Pointer to the driver instance structure. */
/** Our mouse connector interface. */
/** Our mouse port interface. */
/** The queue handle. */
/** Discard input when this flag is set.
* We only accept input when the VM is running. */
bool fInactive;
/**
* Mouse queue item.
*/
typedef struct DRVMOUSEQUEUEITEM
{
/** The core part owned by the queue manager. */
/* -=-=-=-=- IBase -=-=-=-=- */
/**
* Queries an interface to the driver.
*
* @returns Pointer to interface.
* @returns NULL if the interface was not supported by the driver.
* @param pInterface Pointer to this interface structure.
* @param enmInterface The requested interface identification.
*/
static DECLCALLBACK(void *) drvMouseQueueQueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface)
{
switch (enmInterface)
{
case PDMINTERFACE_BASE:
case PDMINTERFACE_MOUSE_PORT:
default:
return NULL;
}
}
/* -=-=-=-=- IMousePort -=-=-=-=- */
/** Converts a pointer to DRVMOUSEQUEUE::Port to a DRVMOUSEQUEUE pointer. */
#define IMOUSEPORT_2_DRVMOUSEQUEUE(pInterface) ( (PDRVMOUSEQUEUE)((char *)(pInterface) - RT_OFFSETOF(DRVMOUSEQUEUE, Port)) )
/**
* Queues a mouse event.
* Because of the event queueing the EMT context requirement is lifted.
*
* @returns VBox status code.
* @param pInterface Pointer to interface structure.
* @param i32DeltaX The X delta.
* @param i32DeltaY The Y delta.
* @param i32DeltaZ The Z delta.
* @param fButtonStates The button states.
* @thread Any thread.
*/
static DECLCALLBACK(int) drvMouseQueuePutEvent(PPDMIMOUSEPORT pInterface, int32_t i32DeltaX, int32_t i32DeltaY, int32_t i32DeltaZ, uint32_t fButtonStates)
{
return VINF_SUCCESS;
if (pItem)
{
return VINF_SUCCESS;
}
return VERR_PDM_NO_QUEUE_ITEMS;
}
/* -=-=-=-=- queue -=-=-=-=- */
/**
* Queue callback for processing a queued item.
*
* @returns Success indicator.
* If false the item will not be removed and the flushing will stop.
* @param pDrvIns The driver instance.
* @param pItemCore Pointer to the queue item to process.
*/
{
int rc = pThis->pUpPort->pfnPutEvent(pThis->pUpPort, pItem->i32DeltaX, pItem->i32DeltaY, pItem->i32DeltaZ, pItem->fButtonStates);
return RT_SUCCESS(rc);
}
/* -=-=-=-=- driver interface -=-=-=-=- */
/**
* Power On notification.
*
* @returns VBox status.
* @param pDrvIns The drive instance data.
*/
{
}
/**
* Reset notification.
*
* @returns VBox status.
* @param pDrvIns The drive instance data.
*/
{
//PDRVKBDQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVKBDQUEUE);
/** @todo purge the queue on reset. */
}
/**
* Suspend notification.
*
* @returns VBox status.
* @param pDrvIns The drive instance data.
*/
{
}
/**
* Resume notification.
*
* @returns VBox status.
* @param pDrvIns The drive instance data.
*/
{
}
/**
* Power Off notification.
*
* @param pDrvIns The drive instance data.
*/
{
}
/**
* Construct a mouse driver instance.
*
* @returns VBox status.
* @param pDrvIns The driver instance data.
* If the registration structure is needed, pDrvIns->pDrvReg points to it.
* @param pCfgHandle Configuration node handle for the driver. Use this to obtain the configuration
* of the driver instance. It's also found in pDrvIns->pCfgHandle, but like
* iInstance it's expected to be used a bit in this function.
*/
{
/*
* Validate configuration.
*/
/*
* Init basic data members and interfaces.
*/
/* IBase. */
/* IMousePort. */
/*
*/
pDrv->pUpPort = (PPDMIMOUSEPORT)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMINTERFACE_MOUSE_PORT);
{
AssertMsgFailed(("Configuration error: No mouse port interface above!\n"));
return VERR_PDM_MISSING_INTERFACE_ABOVE;
}
/*
* Attach driver below and query it's connector interface.
*/
if (RT_FAILURE(rc))
{
return rc;
}
pDrv->pDownConnector = (PPDMIMOUSECONNECTOR)pDownBase->pfnQueryInterface(pDownBase, PDMINTERFACE_MOUSE_CONNECTOR);
if (!pDrv->pDownConnector)
{
AssertMsgFailed(("Configuration error: No mouse connector interface below!\n"));
return VERR_PDM_MISSING_INTERFACE_BELOW;
}
/*
* Create the queue.
*/
uint32_t cMilliesInterval = 0;
if (rc == VERR_CFGM_VALUE_NOT_FOUND)
cMilliesInterval = 0;
else if (RT_FAILURE(rc))
{
return rc;
}
if (rc == VERR_CFGM_VALUE_NOT_FOUND)
cItems = 128;
else if (RT_FAILURE(rc))
{
return rc;
}
rc = PDMDrvHlpPDMQueueCreate(pDrvIns, sizeof(DRVMOUSEQUEUEITEM), cItems, cMilliesInterval, drvMouseQueueConsumer, "Mouse", &pDrv->pQueue);
if (RT_FAILURE(rc))
{
AssertMsgFailed(("Failed to create driver: cItems=%d cMilliesInterval=%d rc=%Rrc\n", cItems, cMilliesInterval, rc));
return rc;
}
return VINF_SUCCESS;
}
/**
* Mouse queue driver registration record.
*/
const PDMDRVREG g_DrvMouseQueue =
{
/* u32Version */
/* szDriverName */
"MouseQueue",
/* pszDescription */
"Mouse queue driver to plug in between the key source and the device to do queueing and inter-thread transport.",
/* fFlags */
/* fClass. */
/* cMaxInstances */
~0,
/* cbInstance */
sizeof(DRVMOUSEQUEUE),
/* pfnConstruct */
/* pfnDestruct */
NULL,
/* pfnIOCtl */
NULL,
/* pfnPowerOn */
/* pfnReset */
/* pfnSuspend */
/* pfnResume */
/* pfnDetach */
NULL,
/** pfnPowerOff */
};