/* $Id: MouseImpl.cpp 30676 2010-07-06 16:36:43Z vboxsync $ */ /** @file * VirtualBox COM class implementation */ /* * Copyright (C) 2006-2008 Oracle Corporation * * This file is part of VirtualBox Open Source Edition (OSE), as * available from http://www.virtualbox.org. This file is free software; * you can redistribute it and/or modify it under the terms of the GNU * 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. */ #include "MouseImpl.h" #include "DisplayImpl.h" #include "VMMDev.h" #include "AutoCaller.h" #include "Logging.h" #include #include #include /** @name Mouse device capabilities bitfield * @{ */ enum { /** The mouse device can do relative reporting */ MOUSE_DEVCAP_RELATIVE = 1, /** The mouse device can do absolute reporting */ MOUSE_DEVCAP_ABSOLUTE = 2 }; /** @} */ /** * Mouse driver instance data. */ struct DRVMAINMOUSE { /** Pointer to the mouse object. */ Mouse *pMouse; /** Pointer to the driver instance structure. */ PPDMDRVINS pDrvIns; /** Pointer to the mouse port interface of the driver/device above us. */ PPDMIMOUSEPORT pUpPort; /** Our mouse connector interface. */ PDMIMOUSECONNECTOR IConnector; /** The capabilities of this device. */ uint32_t u32DevCaps; }; // constructor / destructor ///////////////////////////////////////////////////////////////////////////// Mouse::Mouse() : mParent(NULL) { } Mouse::~Mouse() { } HRESULT Mouse::FinalConstruct() { RT_ZERO(mpDrv); fVMMDevCanAbs = false; fVMMDevNeedsHostCursor = false; mLastAbsX = 0x8000; mLastAbsY = 0x8000; mLastButtons = 0; return S_OK; } void Mouse::FinalRelease() { uninit(); } // public methods only for internal purposes ///////////////////////////////////////////////////////////////////////////// /** * Initializes the mouse object. * * @returns COM result indicator * @param parent handle of our parent object */ HRESULT Mouse::init (Console *parent) { LogFlowThisFunc(("\n")); ComAssertRet(parent, E_INVALIDARG); /* Enclose the state transition NotReady->InInit->Ready */ AutoInitSpan autoInitSpan(this); AssertReturn(autoInitSpan.isOk(), E_FAIL); unconst(mParent) = parent; #ifdef RT_OS_L4 /* L4 console has no own mouse cursor */ uHostCaps = VMMDEV_MOUSE_HOST_CANNOT_HWPOINTER; #else uHostCaps = 0; #endif /* Confirm a successful initialization */ autoInitSpan.setSucceeded(); return S_OK; } /** * Uninitializes the instance and sets the ready flag to FALSE. * Called either from FinalRelease() or by the parent when it gets destroyed. */ void Mouse::uninit() { LogFlowThisFunc(("\n")); /* Enclose the state transition Ready->InUninit->NotReady */ AutoUninitSpan autoUninitSpan(this); if (autoUninitSpan.uninitDone()) return; for (unsigned i = 0; i < MOUSE_MAX_DEVICES; ++i) { if (mpDrv[i]) mpDrv[i]->pMouse = NULL; mpDrv[i] = NULL; } #ifdef VBOXBFE_WITHOUT_COM mParent = NULL; #else unconst(mParent) = NULL; #endif } // IMouse properties ///////////////////////////////////////////////////////////////////////////// HRESULT Mouse::getVMMDevMouseCaps(uint32_t *pfCaps) { AssertPtrReturn(pfCaps, E_POINTER); VMMDev *pVMMDev = mParent->getVMMDev(); ComAssertRet(pVMMDev, E_FAIL); PPDMIVMMDEVPORT pVMMDevPort = pVMMDev->getVMMDevPort(); ComAssertRet(pVMMDevPort, E_FAIL); int rc = pVMMDevPort->pfnQueryMouseCapabilities(pVMMDevPort, pfCaps); return RT_SUCCESS(rc) ? S_OK : E_FAIL; } HRESULT Mouse::setVMMDevMouseCaps(uint32_t fCaps) { VMMDev *pVMMDev = mParent->getVMMDev(); ComAssertRet(pVMMDev, E_FAIL); PPDMIVMMDEVPORT pVMMDevPort = pVMMDev->getVMMDevPort(); ComAssertRet(pVMMDevPort, E_FAIL); int rc = pVMMDevPort->pfnSetMouseCapabilities(pVMMDevPort, fCaps); return RT_SUCCESS(rc) ? S_OK : E_FAIL; } /** * Returns whether the current setup can accept absolute mouse * events. * * @returns COM status code * @param absoluteSupported address of result variable */ STDMETHODIMP Mouse::COMGETTER(AbsoluteSupported) (BOOL *absoluteSupported) { if (!absoluteSupported) return E_POINTER; AutoCaller autoCaller(this); if (FAILED(autoCaller.rc())) return autoCaller.rc(); AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS); bool fAbs = false; if (fVMMDevCanAbs) fAbs = TRUE; for (unsigned i = 0; i < MOUSE_MAX_DEVICES; ++i) if (mpDrv[i] && (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_ABSOLUTE)) fAbs = TRUE; *absoluteSupported = fAbs; return S_OK; } /** * Returns whether the current setup can accept relative mouse * events. * * @returns COM status code * @param relativeSupported address of result variable */ STDMETHODIMP Mouse::COMGETTER(RelativeSupported) (BOOL *relativeSupported) { if (!relativeSupported) return E_POINTER; AutoCaller autoCaller(this); if (FAILED(autoCaller.rc())) return autoCaller.rc(); AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS); bool fRel = false; for (unsigned i = 0; i < MOUSE_MAX_DEVICES; ++i) if (mpDrv[i] && (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_RELATIVE)) fRel = TRUE; *relativeSupported = fRel; return S_OK; } /** * Returns whether the guest can currently draw the mouse cursor itself. * * @returns COM status code * @param pfNeedsHostCursor address of result variable */ STDMETHODIMP Mouse::COMGETTER(NeedsHostCursor) (BOOL *pfNeedsHostCursor) { if (!pfNeedsHostCursor) return E_POINTER; AutoCaller autoCaller(this); if (FAILED(autoCaller.rc())) return autoCaller.rc(); AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS); *pfNeedsHostCursor = fVMMDevNeedsHostCursor; return S_OK; } // IMouse methods ///////////////////////////////////////////////////////////////////////////// static uint32_t mouseButtonsToPDM(LONG buttonState) { uint32_t fButtons = 0; if (buttonState & MouseButtonState_LeftButton) fButtons |= PDMIMOUSEPORT_BUTTON_LEFT; if (buttonState & MouseButtonState_RightButton) fButtons |= PDMIMOUSEPORT_BUTTON_RIGHT; if (buttonState & MouseButtonState_MiddleButton) fButtons |= PDMIMOUSEPORT_BUTTON_MIDDLE; if (buttonState & MouseButtonState_XButton1) fButtons |= PDMIMOUSEPORT_BUTTON_X1; if (buttonState & MouseButtonState_XButton2) fButtons |= PDMIMOUSEPORT_BUTTON_X2; return fButtons; } /** * Send a relative event to the mouse device. * * @returns COM status code */ HRESULT Mouse::reportRelEventToMouseDev(int32_t dx, int32_t dy, int32_t dz, int32_t dw, uint32_t fButtons) { if (dx || dy || dz || dw || fButtons != mLastButtons) { PPDMIMOUSEPORT pUpPort = NULL; for (unsigned i = 0; !pUpPort && i < MOUSE_MAX_DEVICES; ++i) { if (mpDrv[i] && (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_RELATIVE)) pUpPort = mpDrv[i]->pUpPort; } if (!pUpPort) return S_OK; int vrc = pUpPort->pfnPutEvent(pUpPort, dx, dy, dz, dw, fButtons); if (RT_FAILURE(vrc)) return setError(VBOX_E_IPRT_ERROR, tr("Could not send the mouse event to the virtual mouse (%Rrc)"), vrc); } return S_OK; } /** * Send an absolute position event to the mouse device. * * @returns COM status code */ HRESULT Mouse::reportAbsEventToMouseDev(uint32_t mouseXAbs, uint32_t mouseYAbs, int32_t dz, int32_t dw, uint32_t fButtons) { if ( mouseXAbs != mLastAbsX || mouseYAbs != mLastAbsY || dz || dw || fButtons != mLastButtons) { PPDMIMOUSEPORT pUpPort = NULL; for (unsigned i = 0; !pUpPort && i < MOUSE_MAX_DEVICES; ++i) { if (mpDrv[i] && (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_ABSOLUTE)) pUpPort = mpDrv[i]->pUpPort; } if (!pUpPort) return S_OK; int vrc = pUpPort->pfnPutEventAbs(pUpPort, mouseXAbs, mouseYAbs, dz, dw, fButtons); if (RT_FAILURE(vrc)) return setError(VBOX_E_IPRT_ERROR, tr("Could not send the mouse event to the virtual mouse (%Rrc)"), vrc); } return S_OK; } /** * Send an absolute position event to the VMM device. * * @returns COM status code */ HRESULT Mouse::reportAbsEventToVMMDev(uint32_t mouseXAbs, uint32_t mouseYAbs) { VMMDev *pVMMDev = mParent->getVMMDev(); ComAssertRet(pVMMDev, E_FAIL); PPDMIVMMDEVPORT pVMMDevPort = pVMMDev->getVMMDevPort(); ComAssertRet(pVMMDevPort, E_FAIL); if (mouseXAbs != mLastAbsX || mouseYAbs != mLastAbsY) { int vrc = pVMMDevPort->pfnSetAbsoluteMouse(pVMMDevPort, mouseXAbs, mouseYAbs); if (RT_FAILURE(vrc)) return setError(VBOX_E_IPRT_ERROR, tr("Could not send the mouse event to the virtual mouse (%Rrc)"), vrc); } return S_OK; } /** * Send a mouse event. * * @returns COM status code * @param dx X movement * @param dy Y movement * @param dz Z movement * @param buttonState The mouse button state */ STDMETHODIMP Mouse::PutMouseEvent(LONG dx, LONG dy, LONG dz, LONG dw, LONG buttonState) { HRESULT rc = S_OK; AutoCaller autoCaller(this); if (FAILED(autoCaller.rc())) return autoCaller.rc(); AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS); LogRel3(("%s: dx=%d, dy=%d, dz=%d, dw=%d\n", __PRETTY_FUNCTION__, dx, dy, dz, dw)); /* * This method being called implies that the host no * longer wants to use absolute coordinates. If the VMM * device isn't aware of that yet, tell it. */ if (uHostCaps & VMMDEV_MOUSE_HOST_CAN_ABSOLUTE) { uHostCaps &= ~VMMDEV_MOUSE_HOST_CAN_ABSOLUTE; setVMMDevMouseCaps(uHostCaps); } uint32_t fButtons = mouseButtonsToPDM(buttonState); rc = reportRelEventToMouseDev(dx, dy, dz, dw, fButtons); if (SUCCEEDED(rc)) mLastButtons = fButtons; return rc; } /** * Convert an X value in screen co-ordinates (starting from 1) to a value * from 0 to 0xffff. * * @returns COM status value */ HRESULT Mouse::convertDisplayWidth(LONG x, uint32_t *pcX) { AssertPtrReturn(pcX, E_POINTER); Display *pDisplay = mParent->getDisplay(); ComAssertRet(pDisplay, E_FAIL); ULONG displayWidth; HRESULT rc = pDisplay->GetScreenResolution (0, &displayWidth, NULL, NULL); if (FAILED(rc)) return rc; *pcX = displayWidth ? ((x - 1) * 0xFFFF) / displayWidth: 0; return S_OK; } /** * Convert a Y value in screen co-ordinates (starting from 1) to a value * from 0 to 0xffff. * * @returns COM status value */ HRESULT Mouse::convertDisplayHeight(LONG y, uint32_t *pcY) { AssertPtrReturn(pcY, E_POINTER); Display *pDisplay = mParent->getDisplay(); ComAssertRet(pDisplay, E_FAIL); ULONG displayHeight; HRESULT rc = pDisplay->GetScreenResolution (0, NULL, &displayHeight, NULL); if (FAILED(rc)) return rc; *pcY = displayHeight ? ((y - 1) * 0xFFFF) / displayHeight: 0; return S_OK; } /** * Send an absolute mouse event to the VM. This only works * when the required guest support has been installed. * * @returns COM status code * @param x X position (pixel), starting from 1 * @param y Y position (pixel), starting from 1 * @param dz Z movement * @param buttonState The mouse button state */ STDMETHODIMP Mouse::PutMouseEventAbsolute(LONG x, LONG y, LONG dz, LONG dw, LONG buttonState) { AutoCaller autoCaller(this); if (FAILED(autoCaller.rc())) return autoCaller.rc(); AutoWriteLock alock(this COMMA_LOCKVAL_SRC_POS); LogRel3(("%s: x=%d, y=%d, dz=%d, dw=%d, buttonState=0x%x\n", __PRETTY_FUNCTION__, x, y, dz, dw, buttonState)); uint32_t mouseXAbs; /** @todo the front end should do this conversion to avoid races */ HRESULT rc = convertDisplayWidth(x, &mouseXAbs); if (FAILED(rc)) return rc; /** * @todo multi-monitor Windows guests expect this to be unbounded. * Understand the issues involved and fix for the rest. */ /* if (mouseXAbs > 0xffff) mouseXAbs = mLastAbsX; */ uint32_t mouseYAbs; rc = convertDisplayHeight(y, &mouseYAbs); if (FAILED(rc)) return rc; /* if (mouseYAbs > 0xffff) mouseYAbs = mLastAbsY; */ uint32_t fButtons = mouseButtonsToPDM(buttonState); uint32_t mouseCaps; rc = getVMMDevMouseCaps(&mouseCaps); if (FAILED(rc)) return rc; /* * This method being called implies that the host wants * to use absolute coordinates. If the VMM device isn't * aware of that yet, tell it. */ if (!(mouseCaps & VMMDEV_MOUSE_HOST_CAN_ABSOLUTE)) { uHostCaps |= VMMDEV_MOUSE_HOST_CAN_ABSOLUTE; setVMMDevMouseCaps(uHostCaps); } if (fVMMDevCanAbs) { /* * Send the absolute mouse position to the VMM device. */ rc = reportAbsEventToVMMDev(mouseXAbs, mouseYAbs); /* We may need to send an additional event for button information or * to wake up older guests to the changed absolute co-ordinates. If * the event is a pure wake up one, we make sure it contains some * (possibly phony) event data to make sure it isn't just discarded * on the way. */ bool fNeedsJiggle = !(mouseCaps & VMMDEV_MOUSE_GUEST_USES_VMMDEV); if (fNeedsJiggle || fButtons != mLastButtons || dz || dw) { rc = reportRelEventToMouseDev(fNeedsJiggle ? 1 : 0, 0, dz, dw, fButtons); } } else rc = reportAbsEventToMouseDev(mouseXAbs, mouseYAbs, dz, dw, fButtons); if (FAILED(rc)) return rc; mLastAbsX = mouseXAbs; mLastAbsY = mouseYAbs; mLastButtons = fButtons; return rc; } // private methods ///////////////////////////////////////////////////////////////////////////// void Mouse::sendMouseCapsNotifications(void) { bool fAbsDev = false; bool fRelDev = false; uint32_t u32MouseCaps; for (unsigned i = 0; i < MOUSE_MAX_DEVICES; ++i) if (mpDrv[i]) { if (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_ABSOLUTE) fAbsDev = true; if (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_RELATIVE) fRelDev = true; } if (SUCCEEDED(getVMMDevMouseCaps(&u32MouseCaps))) fVMMDevCanAbs = (u32MouseCaps & VMMDEV_MOUSE_GUEST_CAN_ABSOLUTE) && fRelDev; else fVMMDevCanAbs = false; mParent->onMouseCapabilityChange(fAbsDev || fVMMDevCanAbs, fRelDev, fVMMDevNeedsHostCursor); /** @todo if this gets called during device initialisation we get an * error due to VMMDev not being initialised yet. */ if (fAbsDev && !(uHostCaps & VMMDEV_MOUSE_HOST_HAS_ABS_DEV)) uHostCaps |= VMMDEV_MOUSE_HOST_HAS_ABS_DEV; if (!fAbsDev && (uHostCaps & VMMDEV_MOUSE_HOST_HAS_ABS_DEV)) uHostCaps &= ~VMMDEV_MOUSE_HOST_HAS_ABS_DEV; setVMMDevMouseCaps(uHostCaps); } /** * @interface_method_impl{PDMIMOUSECONNECTOR,pfnReportModes} */ DECLCALLBACK(void) Mouse::mouseReportModes(PPDMIMOUSECONNECTOR pInterface, bool fRel, bool fAbs) { PDRVMAINMOUSE pDrv = RT_FROM_MEMBER(pInterface, DRVMAINMOUSE, IConnector); if (fRel) pDrv->u32DevCaps |= MOUSE_DEVCAP_RELATIVE; else pDrv->u32DevCaps &= ~MOUSE_DEVCAP_RELATIVE; if (fAbs) pDrv->u32DevCaps |= MOUSE_DEVCAP_ABSOLUTE; else pDrv->u32DevCaps &= ~MOUSE_DEVCAP_ABSOLUTE; pDrv->pMouse->sendMouseCapsNotifications(); } /** * @interface_method_impl{PDMIBASE,pfnQueryInterface} */ DECLCALLBACK(void *) Mouse::drvQueryInterface(PPDMIBASE pInterface, const char *pszIID) { PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface); PDRVMAINMOUSE pDrv = PDMINS_2_DATA(pDrvIns, PDRVMAINMOUSE); PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase); PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMOUSECONNECTOR, &pDrv->IConnector); return NULL; } /** * Destruct a mouse driver instance. * * @returns VBox status. * @param pDrvIns The driver instance data. */ DECLCALLBACK(void) Mouse::drvDestruct(PPDMDRVINS pDrvIns) { PDRVMAINMOUSE pData = PDMINS_2_DATA(pDrvIns, PDRVMAINMOUSE); LogFlow(("Mouse::drvDestruct: iInstance=%d\n", pDrvIns->iInstance)); PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns); if (pData->pMouse) { AutoWriteLock mouseLock(pData->pMouse COMMA_LOCKVAL_SRC_POS); for (unsigned cDev = 0; cDev < MOUSE_MAX_DEVICES; ++cDev) if (pData->pMouse->mpDrv[cDev] == pData) { pData->pMouse->mpDrv[cDev] = NULL; break; } } } /** * Construct a mouse driver instance. * * @copydoc FNPDMDRVCONSTRUCT */ DECLCALLBACK(int) Mouse::drvConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags) { PDRVMAINMOUSE pData = PDMINS_2_DATA(pDrvIns, PDRVMAINMOUSE); LogFlow(("drvMainMouse_Construct: iInstance=%d\n", pDrvIns->iInstance)); PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns); /* * Validate configuration. */ if (!CFGMR3AreValuesValid(pCfg, "Object\0")) return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES; AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER, ("Configuration error: Not possible to attach anything to this driver!\n"), VERR_PDM_DRVINS_NO_ATTACH); /* * IBase. */ pDrvIns->IBase.pfnQueryInterface = Mouse::drvQueryInterface; pData->IConnector.pfnReportModes = Mouse::mouseReportModes; /* * Get the IMousePort interface of the above driver/device. */ pData->pUpPort = (PPDMIMOUSEPORT)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMIMOUSEPORT_IID); if (!pData->pUpPort) { AssertMsgFailed(("Configuration error: No mouse port interface above!\n")); return VERR_PDM_MISSING_INTERFACE_ABOVE; } /* * Get the Mouse object pointer and update the mpDrv member. */ void *pv; int rc = CFGMR3QueryPtr(pCfg, "Object", &pv); if (RT_FAILURE(rc)) { AssertMsgFailed(("Configuration error: No/bad \"Object\" value! rc=%Rrc\n", rc)); return rc; } pData->pMouse = (Mouse *)pv; /** @todo Check this cast! */ unsigned cDev; for (cDev = 0; cDev < MOUSE_MAX_DEVICES; ++cDev) if (!pData->pMouse->mpDrv[cDev]) { pData->pMouse->mpDrv[cDev] = pData; break; } if (cDev == MOUSE_MAX_DEVICES) return VERR_NO_MORE_HANDLES; return VINF_SUCCESS; } /** * Main mouse driver registration record. */ const PDMDRVREG Mouse::DrvReg = { /* u32Version */ PDM_DRVREG_VERSION, /* szName */ "MainMouse", /* szRCMod */ "", /* szR0Mod */ "", /* pszDescription */ "Main mouse driver (Main as in the API).", /* fFlags */ PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT, /* fClass. */ PDM_DRVREG_CLASS_MOUSE, /* cMaxInstances */ ~0, /* cbInstance */ sizeof(DRVMAINMOUSE), /* pfnConstruct */ Mouse::drvConstruct, /* pfnDestruct */ Mouse::drvDestruct, /* pfnRelocate */ NULL, /* pfnIOCtl */ NULL, /* pfnPowerOn */ NULL, /* pfnReset */ NULL, /* pfnSuspend */ NULL, /* pfnResume */ NULL, /* pfnAttach */ NULL, /* pfnDetach */ NULL, /* pfnPowerOff */ NULL, /* pfnSoftReset */ NULL, /* u32EndVersion */ PDM_DRVREG_VERSION }; /* vi: set tabstop=4 shiftwidth=4 expandtab: */