MouseImpl.cpp@ 47226

Last change on this file since 47226 was 47226, checked in by vboxsync, 12 years ago
Main/Mouse: more adjustments to prepare for multi-touch.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 28.0 KB

Line
1	/* $Id: MouseImpl.cpp 47226 2013-07-18 08:20:07Z vboxsync $ */
2	/** @file
3	* VirtualBox COM class implementation
4	*/
5
6	/*
7	* Copyright (C) 2006-2012 Oracle Corporation
8	*
9	* This file is part of VirtualBox Open Source Edition (OSE), as
10	* available from http://www.215389.xyz. This file is free software;
11	* you can redistribute it and/or modify it under the terms of the GNU
12	* General Public License (GPL) as published by the Free Software
13	* Foundation, in version 2 as it comes in the "COPYING" file of the
14	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16	*/
17
18	#include <iprt/cpp/utils.h>
19
20	#include "MouseImpl.h"
21	#include "DisplayImpl.h"
22	#include "VMMDev.h"
23
24	#include "AutoCaller.h"
25	#include "Logging.h"
26
27	#include <VBox/vmm/pdmdrv.h>
28	#include <VBox/VMMDev.h>
29
30	#include <iprt/asm.h>
31
32	/** @name Mouse device capabilities bitfield
33	* @{ */
34	enum
35	{
36	/** The mouse device can do relative reporting */
37	MOUSE_DEVCAP_RELATIVE = 1,
38	/** The mouse device can do absolute reporting */
39	MOUSE_DEVCAP_ABSOLUTE = 2,
40	/** The mouse device can do absolute reporting */
41	MOUSE_DEVCAP_MULTI_TOUCH = 4
42	};
43	/** @} */
44
45
46	/**
47	* Mouse driver instance data.
48	*/
49	struct DRVMAINMOUSE
50	{
51	/** Pointer to the mouse object. */
52	Mouse *pMouse;
53	/** Pointer to the driver instance structure. */
54	PPDMDRVINS pDrvIns;
55	/** Pointer to the mouse port interface of the driver/device above us. */
56	PPDMIMOUSEPORT pUpPort;
57	/** Our mouse connector interface. */
58	PDMIMOUSECONNECTOR IConnector;
59	/** The capabilities of this device. */
60	uint32_t u32DevCaps;
61	};
62
63
64	// constructor / destructor
65	/////////////////////////////////////////////////////////////////////////////
66
67	Mouse::Mouse()
68	: mParent(NULL)
69	{
70	}
71
72	Mouse::~Mouse()
73	{
74	}
75
76
77	HRESULT Mouse::FinalConstruct()
78	{
79	RT_ZERO(mpDrv);
80	mcLastX = 0x8000;
81	mcLastY = 0x8000;
82	mfLastButtons = 0;
83	mfVMMDevGuestCaps = 0;
84	return BaseFinalConstruct();
85	}
86
87	void Mouse::FinalRelease()
88	{
89	uninit();
90	BaseFinalRelease();
91	}
92
93	// public methods only for internal purposes
94	/////////////////////////////////////////////////////////////////////////////
95
96	/**
97	* Initializes the mouse object.
98	*
99	* @returns COM result indicator
100	* @param parent handle of our parent object
101	*/
102	HRESULT Mouse::init (ConsoleMouseInterface *parent)
103	{
104	LogFlowThisFunc(("\n"));
105
106	ComAssertRet(parent, E_INVALIDARG);
107
108	/* Enclose the state transition NotReady->InInit->Ready */
109	AutoInitSpan autoInitSpan(this);
110	AssertReturn(autoInitSpan.isOk(), E_FAIL);
111
112	unconst(mParent) = parent;
113
114	unconst(mEventSource).createObject();
115	HRESULT rc = mEventSource->init(static_cast<IMouse*>(this));
116	AssertComRCReturnRC(rc);
117	mMouseEvent.init(mEventSource, VBoxEventType_OnGuestMouse,
118	0, 0, 0, 0, 0);
119
120	/* Confirm a successful initialization */
121	autoInitSpan.setSucceeded();
122
123	return S_OK;
124	}
125
126	/**
127	* Uninitializes the instance and sets the ready flag to FALSE.
128	* Called either from FinalRelease() or by the parent when it gets destroyed.
129	*/
130	void Mouse::uninit()
131	{
132	LogFlowThisFunc(("\n"));
133
134	/* Enclose the state transition Ready->InUninit->NotReady */
135	AutoUninitSpan autoUninitSpan(this);
136	if (autoUninitSpan.uninitDone())
137	return;
138
139	for (unsigned i = 0; i < MOUSE_MAX_DEVICES; ++i)
140	{
141	if (mpDrv[i])
142	mpDrv[i]->pMouse = NULL;
143	mpDrv[i] = NULL;
144	}
145
146	mMouseEvent.uninit();
147	unconst(mEventSource).setNull();
148	unconst(mParent) = NULL;
149	}
150
151
152	// IMouse properties
153	/////////////////////////////////////////////////////////////////////////////
154
155	/** Report the front-end's mouse handling capabilities to the VMM device and
156	* thus to the guest.
157	* @note all calls out of this object are made with no locks held! */
158	HRESULT Mouse::updateVMMDevMouseCaps(uint32_t fCapsAdded,
159	uint32_t fCapsRemoved)
160	{
161	VMMDevMouseInterface *pVMMDev = mParent->getVMMDevMouseInterface();
162	if (!pVMMDev)
163	return E_FAIL; /* No assertion, as the front-ends can send events
164	* at all sorts of inconvenient times. */
165	PPDMIVMMDEVPORT pVMMDevPort = pVMMDev->getVMMDevPort();
166	if (!pVMMDevPort)
167	return E_FAIL; /* same here */
168
169	int rc = pVMMDevPort->pfnUpdateMouseCapabilities(pVMMDevPort, fCapsAdded,
170	fCapsRemoved);
171	return RT_SUCCESS(rc) ? S_OK : E_FAIL;
172	}
173
174	/**
175	* Returns whether the currently active device portfolio can accept absolute
176	* mouse events.
177	*
178	* @returns COM status code
179	* @param absoluteSupported address of result variable
180	*/
181	STDMETHODIMP Mouse::COMGETTER(AbsoluteSupported) (BOOL *absoluteSupported)
182	{
183	if (!absoluteSupported)
184	return E_POINTER;
185
186	AutoCaller autoCaller(this);
187	if (FAILED(autoCaller.rc())) return autoCaller.rc();
188
189	*absoluteSupported = supportsAbs();
190	return S_OK;
191	}
192
193	/**
194	* Returns whether the currently active device portfolio can accept relative
195	* mouse events.
196	*
197	* @returns COM status code
198	* @param relativeSupported address of result variable
199	*/
200	STDMETHODIMP Mouse::COMGETTER(RelativeSupported) (BOOL *relativeSupported)
201	{
202	if (!relativeSupported)
203	return E_POINTER;
204
205	AutoCaller autoCaller(this);
206	if (FAILED(autoCaller.rc())) return autoCaller.rc();
207
208	*relativeSupported = supportsRel();
209	return S_OK;
210	}
211
212	/**
213	* Returns whether the currently active device portfolio can accept multi-touch
214	* mouse events.
215	*
216	* @returns COM status code
217	* @param multiTouchSupported address of result variable
218	*/
219	STDMETHODIMP Mouse::COMGETTER(MultiTouchSupported) (BOOL *multiTouchSupported)
220	{
221	if (!multiTouchSupported)
222	return E_POINTER;
223
224	AutoCaller autoCaller(this);
225	if (FAILED(autoCaller.rc())) return autoCaller.rc();
226
227	*multiTouchSupported = FALSE;
228	return S_OK;
229	}
230
231	/**
232	* Returns whether the guest can currently switch to drawing the mouse cursor
233	* itself if it is asked to by the front-end.
234	*
235	* @returns COM status code
236	* @param pfNeedsHostCursor address of result variable
237	*/
238	STDMETHODIMP Mouse::COMGETTER(NeedsHostCursor) (BOOL *pfNeedsHostCursor)
239	{
240	if (!pfNeedsHostCursor)
241	return E_POINTER;
242
243	AutoCaller autoCaller(this);
244	if (FAILED(autoCaller.rc())) return autoCaller.rc();
245
246	*pfNeedsHostCursor = guestNeedsHostCursor();
247	return S_OK;
248	}
249
250	// IMouse methods
251	/////////////////////////////////////////////////////////////////////////////
252
253	/** Converts a bitfield containing information about mouse buttons currently
254	* held down from the format used by the front-end to the format used by PDM
255	* and the emulated pointing devices. */
256	static uint32_t mouseButtonsToPDM(LONG buttonState)
257	{
258	uint32_t fButtons = 0;
259	if (buttonState & MouseButtonState_LeftButton)
260	fButtons \|= PDMIMOUSEPORT_BUTTON_LEFT;
261	if (buttonState & MouseButtonState_RightButton)
262	fButtons \|= PDMIMOUSEPORT_BUTTON_RIGHT;
263	if (buttonState & MouseButtonState_MiddleButton)
264	fButtons \|= PDMIMOUSEPORT_BUTTON_MIDDLE;
265	if (buttonState & MouseButtonState_XButton1)
266	fButtons \|= PDMIMOUSEPORT_BUTTON_X1;
267	if (buttonState & MouseButtonState_XButton2)
268	fButtons \|= PDMIMOUSEPORT_BUTTON_X2;
269	return fButtons;
270	}
271
272	STDMETHODIMP Mouse::COMGETTER(EventSource)(IEventSource ** aEventSource)
273	{
274	CheckComArgOutPointerValid(aEventSource);
275
276	AutoCaller autoCaller(this);
277	if (FAILED(autoCaller.rc())) return autoCaller.rc();
278
279	// no need to lock - lifetime constant
280	mEventSource.queryInterfaceTo(aEventSource);
281
282	return S_OK;
283	}
284
285	/**
286	* Send a relative pointer event to the relative device we deem most
287	* appropriate.
288	*
289	* @returns COM status code
290	*/
291	HRESULT Mouse::reportRelEventToMouseDev(int32_t dx, int32_t dy, int32_t dz,
292	int32_t dw, uint32_t fButtons)
293	{
294	if (dx \|\| dy \|\| dz \|\| dw \|\| fButtons != mfLastButtons)
295	{
296	PPDMIMOUSEPORT pUpPort = NULL;
297	{
298	AutoReadLock aLock(this COMMA_LOCKVAL_SRC_POS);
299
300	for (unsigned i = 0; !pUpPort && i < MOUSE_MAX_DEVICES; ++i)
301	{
302	if (mpDrv[i] && (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_RELATIVE))
303	pUpPort = mpDrv[i]->pUpPort;
304	}
305	}
306	if (!pUpPort)
307	return S_OK;
308
309	int vrc = pUpPort->pfnPutEvent(pUpPort, dx, dy, dz, dw, fButtons);
310
311	if (RT_FAILURE(vrc))
312	return setError(VBOX_E_IPRT_ERROR,
313	tr("Could not send the mouse event to the virtual mouse (%Rrc)"),
314	vrc);
315	mfLastButtons = fButtons;
316	}
317	return S_OK;
318	}
319
320
321	/**
322	* Send an absolute pointer event to the emulated absolute device we deem most
323	* appropriate.
324	*
325	* @returns COM status code
326	*/
327	HRESULT Mouse::reportAbsEventToMouseDev(int32_t x, int32_t y,
328	int32_t dz, int32_t dw, uint32_t fButtons)
329	{
330	if ( x < VMMDEV_MOUSE_RANGE_MIN
331	\|\| x > VMMDEV_MOUSE_RANGE_MAX)
332	return S_OK;
333	if ( y < VMMDEV_MOUSE_RANGE_MIN
334	\|\| y > VMMDEV_MOUSE_RANGE_MAX)
335	return S_OK;
336	if ( x != mcLastX \|\| y != mcLastY
337	\|\| dz \|\| dw \|\| fButtons != mfLastButtons)
338	{
339	PPDMIMOUSEPORT pUpPort = NULL;
340	{
341	AutoReadLock aLock(this COMMA_LOCKVAL_SRC_POS);
342
343	for (unsigned i = 0; !pUpPort && i < MOUSE_MAX_DEVICES; ++i)
344	{
345	if (mpDrv[i] && (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_ABSOLUTE))
346	pUpPort = mpDrv[i]->pUpPort;
347	}
348	}
349	if (!pUpPort)
350	return S_OK;
351
352	int vrc = pUpPort->pfnPutEventAbs(pUpPort, x, y, dz,
353	dw, fButtons);
354	if (RT_FAILURE(vrc))
355	return setError(VBOX_E_IPRT_ERROR,
356	tr("Could not send the mouse event to the virtual mouse (%Rrc)"),
357	vrc);
358	mfLastButtons = fButtons;
359
360	}
361	return S_OK;
362	}
363
364
365	/**
366	* Send a multi-touch event to the first enabled emulated multi-touch device.
367	*
368	* @returns COM status code
369	*/
370	HRESULT Mouse::reportMTEventToMouseDev(int32_t x, int32_t y,
371	uint32_t cContact, bool fContact)
372	{
373	if ( x < VMMDEV_MOUSE_RANGE_MIN
374	\|\| x > VMMDEV_MOUSE_RANGE_MAX)
375	return S_OK;
376	if ( y < VMMDEV_MOUSE_RANGE_MIN
377	\|\| y > VMMDEV_MOUSE_RANGE_MAX)
378	return S_OK;
379	PPDMIMOUSEPORT pUpPort = NULL;
380	{
381	AutoReadLock aLock(this COMMA_LOCKVAL_SRC_POS);
382
383	for (unsigned i = 0; !pUpPort && i < MOUSE_MAX_DEVICES; ++i)
384	{
385	if ( mpDrv[i]
386	&& (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_MULTI_TOUCH))
387	pUpPort = mpDrv[i]->pUpPort;
388	}
389	}
390	if (!pUpPort)
391	return S_OK;
392
393	int vrc = pUpPort->pfnPutEventMT(pUpPort, x, y,
394	cContact, fContact);
395	if (RT_FAILURE(vrc))
396	return setError(VBOX_E_IPRT_ERROR,
397	tr("Could not send the touch event to the virtual device (%Rrc)"),
398	vrc);
399	return S_OK;
400	}
401
402
403	/**
404	* Send an absolute position event to the VMM device.
405	* @note all calls out of this object are made with no locks held!
406	*
407	* @returns COM status code
408	*/
409	HRESULT Mouse::reportAbsEventToVMMDev(int32_t x, int32_t y)
410	{
411	VMMDevMouseInterface *pVMMDev = mParent->getVMMDevMouseInterface();
412	ComAssertRet(pVMMDev, E_FAIL);
413	PPDMIVMMDEVPORT pVMMDevPort = pVMMDev->getVMMDevPort();
414	ComAssertRet(pVMMDevPort, E_FAIL);
415
416	if (x != mcLastX \|\| y != mcLastY)
417	{
418	int vrc = pVMMDevPort->pfnSetAbsoluteMouse(pVMMDevPort,
419	x, y);
420	if (RT_FAILURE(vrc))
421	return setError(VBOX_E_IPRT_ERROR,
422	tr("Could not send the mouse event to the virtual mouse (%Rrc)"),
423	vrc);
424	}
425	return S_OK;
426	}
427
428
429	/**
430	* Send an absolute pointer event to a pointing device (the VMM device if
431	* possible or whatever emulated absolute device seems best to us if not).
432	*
433	* @returns COM status code
434	*/
435	HRESULT Mouse::reportAbsEvent(int32_t x, int32_t y,
436	int32_t dz, int32_t dw, uint32_t fButtons,
437	bool fUsesVMMDevEvent)
438	{
439	HRESULT rc;
440	/** If we are using the VMMDev to report absolute position but without
441	* VMMDev IRQ support then we need to send a small "jiggle" to the emulated
442	* relative mouse device to alert the guest to changes. */
443	LONG cJiggle = 0;
444
445	/*
446	* Send the absolute mouse position to the device.
447	*/
448	if (x != mcLastX \|\| y != mcLastY)
449	{
450	if (vmmdevCanAbs())
451	{
452	rc = reportAbsEventToVMMDev(x, y);
453	cJiggle = !fUsesVMMDevEvent;
454	}
455	else
456	rc = reportAbsEventToMouseDev(x, y, 0, 0, 0);
457	}
458	rc = reportRelEventToMouseDev(cJiggle, 0, dz, dw, fButtons);
459
460	mcLastX = x;
461	mcLastY = y;
462	return rc;
463	}
464
465	void Mouse::fireMouseEvent(bool fAbsolute, LONG x, LONG y, LONG dz, LONG dw,
466	LONG cContact, LONG fButtons)
467	{
468	/* If mouse button is pressed, we generate new event, to avoid reusable events coalescing and thus
469	dropping key press events */
470	if (fButtons != 0)
471	{
472	VBoxEventDesc evDesc;
473	evDesc.init(mEventSource, VBoxEventType_OnGuestMouse, fAbsolute, x, y,
474	dz, dw, cContact, fButtons);
475	evDesc.fire(0);
476	}
477	else
478	{
479	mMouseEvent.reinit(VBoxEventType_OnGuestMouse, fAbsolute, x, y, dz, dw,
480	cContact, fButtons);
481	mMouseEvent.fire(0);
482	}
483	}
484
485
486	/**
487	* Send a relative mouse event to the guest.
488	* @note the VMMDev capability change is so that the guest knows we are sending
489	* real events over the PS/2 device and not dummy events to signal the
490	* arrival of new absolute pointer data
491	*
492	* @returns COM status code
493	* @param dx X movement
494	* @param dy Y movement
495	* @param dz Z movement
496	* @param fButtons The mouse button state
497	*/
498	STDMETHODIMP Mouse::PutMouseEvent(LONG dx, LONG dy, LONG dz, LONG dw,
499	LONG fButtons)
500	{
501	HRESULT rc;
502	uint32_t fButtonsAdj;
503
504	AutoCaller autoCaller(this);
505	if (FAILED(autoCaller.rc())) return autoCaller.rc();
506	LogRel3(("%s: dx=%d, dy=%d, dz=%d, dw=%d\n", __PRETTY_FUNCTION__,
507	dx, dy, dz, dw));
508
509	fButtonsAdj = mouseButtonsToPDM(fButtons);
510	/* Make sure that the guest knows that we are sending real movement
511	* events to the PS/2 device and not just dummy wake-up ones. */
512	updateVMMDevMouseCaps(0, VMMDEV_MOUSE_HOST_WANTS_ABSOLUTE);
513	rc = reportRelEventToMouseDev(dx, dy, dz, dw, fButtonsAdj);
514
515	fireMouseEvent(false, dx, dy, dz, dw, 0, fButtons);
516
517	return rc;
518	}
519
520	/**
521	* Convert an (X, Y) value pair in screen co-ordinates (starting from 1) to a
522	* value from VMMDEV_MOUSE_RANGE_MIN to VMMDEV_MOUSE_RANGE_MAX. Sets the
523	* optional validity value to false if the pair is not on an active screen and
524	* to true otherwise.
525	* @note since guests with recent versions of X.Org use a different method
526	* to everyone else to map the valuator value to a screen pixel (they
527	* multiply by the screen dimension, do a floating point divide by
528	* the valuator maximum and round the result, while everyone else
529	* does truncating integer operations) we adjust the value we send
530	* so that it maps to the right pixel both when the result is rounded
531	* and when it is truncated.
532	*
533	* @returns COM status value
534	*/
535	HRESULT Mouse::convertDisplayRes(LONG x, LONG y, int32_t pxAdj, int32_t pyAdj,
536	bool *pfValid)
537	{
538	AssertPtrReturn(pxAdj, E_POINTER);
539	AssertPtrReturn(pyAdj, E_POINTER);
540	AssertPtrNullReturn(pfValid, E_POINTER);
541	DisplayMouseInterface *pDisplay = mParent->getDisplayMouseInterface();
542	ComAssertRet(pDisplay, E_FAIL);
543	/** The amount to add to the result (multiplied by the screen width/height)
544	* to compensate for differences in guest methods for mapping back to
545	* pixels */
546	enum { ADJUST_RANGE = - 3 * VMMDEV_MOUSE_RANGE / 4 };
547
548	if (pfValid)
549	*pfValid = true;
550	if (!(mfVMMDevGuestCaps & VMMDEV_MOUSE_NEW_PROTOCOL))
551	{
552	ULONG displayWidth, displayHeight;
553	/* Takes the display lock */
554	HRESULT rc = pDisplay->getScreenResolution(0, &displayWidth,
555	&displayHeight, NULL);
556	if (FAILED(rc))
557	return rc;
558
559	pxAdj = displayWidth ? (x VMMDEV_MOUSE_RANGE + ADJUST_RANGE)
560	/ (LONG) displayWidth: 0;
561	pyAdj = displayHeight ? (y VMMDEV_MOUSE_RANGE + ADJUST_RANGE)
562	/ (LONG) displayHeight: 0;
563	}
564	else
565	{
566	int32_t x1, y1, x2, y2;
567	/* Takes the display lock */
568	pDisplay->getFramebufferDimensions(&x1, &y1, &x2, &y2);
569	pxAdj = x1 < x2 ? ((x - x1) VMMDEV_MOUSE_RANGE + ADJUST_RANGE)
570	/ (x2 - x1) : 0;
571	pyAdj = y1 < y2 ? ((y - y1) VMMDEV_MOUSE_RANGE + ADJUST_RANGE)
572	/ (y2 - y1) : 0;
573	if ( *pxAdj < VMMDEV_MOUSE_RANGE_MIN
574	\|\| *pxAdj > VMMDEV_MOUSE_RANGE_MAX
575	\|\| *pyAdj < VMMDEV_MOUSE_RANGE_MIN
576	\|\| *pyAdj > VMMDEV_MOUSE_RANGE_MAX)
577	if (pfValid)
578	*pfValid = false;
579	}
580	return S_OK;
581	}
582
583
584	/**
585	* Send an absolute mouse event to the VM. This requires either VirtualBox-
586	* specific drivers installed in the guest or absolute pointing device
587	* emulation.
588	* @note the VMMDev capability change is so that the guest knows we are sending
589	* dummy events over the PS/2 device to signal the arrival of new
590	* absolute pointer data, and not pointer real movement data
591	* @note all calls out of this object are made with no locks held!
592	*
593	* @returns COM status code
594	* @param x X position (pixel), starting from 1
595	* @param y Y position (pixel), starting from 1
596	* @param dz Z movement
597	* @param fButtons The mouse button state
598	*/
599	STDMETHODIMP Mouse::PutMouseEventAbsolute(LONG x, LONG y, LONG dz, LONG dw,
600	LONG fButtons)
601	{
602	AutoCaller autoCaller(this);
603	if (FAILED(autoCaller.rc())) return autoCaller.rc();
604
605	LogRel3(("%s: x=%d, y=%d, dz=%d, dw=%d, fButtons=0x%x\n",
606	__PRETTY_FUNCTION__, x, y, dz, dw, fButtons));
607
608	int32_t xAdj, yAdj;
609	uint32_t fButtonsAdj;
610	bool fValid;
611
612	/** @todo the front end should do this conversion to avoid races */
613	/** @note Or maybe not... races are pretty inherent in everything done in
614	* this object and not really bad as far as I can see. */
615	HRESULT rc = convertDisplayRes(x, y, &xAdj, &yAdj, &fValid);
616	if (FAILED(rc)) return rc;
617
618	fButtonsAdj = mouseButtonsToPDM(fButtons);
619	/* If we are doing old-style (IRQ-less) absolute reporting to the VMM
620	* device then make sure the guest is aware of it, so that it knows to
621	* ignore relative movement on the PS/2 device. */
622	updateVMMDevMouseCaps(VMMDEV_MOUSE_HOST_WANTS_ABSOLUTE, 0);
623	if (fValid)
624	{
625	rc = reportAbsEvent(xAdj, yAdj, dz, dw, fButtonsAdj,
626	RT_BOOL( mfVMMDevGuestCaps
627	& VMMDEV_MOUSE_NEW_PROTOCOL));
628
629	fireMouseEvent(true, x, y, dz, dw, 0, fButtons);
630	}
631
632	return rc;
633	}
634
635	/**
636	* @interface_method_impl{IMouse,putMouseEventMultiTouch}
637	*/
638	STDMETHODIMP Mouse::PutMouseEventMultiTouch(LONG x, LONG y, LONG cContact,
639	BOOL fContact)
640	{
641	AutoCaller autoCaller(this);
642	if (FAILED(autoCaller.rc())) return autoCaller.rc();
643
644	LogRel3(("%s: x=%d, y=%d, cContact=%d, fContact=%RTBool\n",
645	__PRETTY_FUNCTION__, x, y, cContact, fContact));
646
647	int32_t xAdj, yAdj;
648	bool fValid;
649
650	/** @todo the front end should do this conversion to avoid races */
651	/** @note Or maybe not... races are pretty inherent in everything done in
652	* this object and not really bad as far as I can see. */
653	HRESULT rc = convertDisplayRes(x, y, &xAdj, &yAdj, &fValid);
654	if (FAILED(rc)) return rc;
655
656	if (fValid)
657	{
658	rc = reportMTEventToMouseDev(xAdj, yAdj, cContact, fContact);
659
660	fireMouseEvent(true, x, y, 0, 0, cContact, fContact);
661	}
662
663	return rc;
664	}
665
666	// private methods
667	/////////////////////////////////////////////////////////////////////////////
668
669
670	/** Does the guest currently rely on the host to draw the mouse cursor or
671	* can it switch to doing it itself in software? */
672	bool Mouse::guestNeedsHostCursor(void)
673	{
674	return RT_BOOL(mfVMMDevGuestCaps & VMMDEV_MOUSE_GUEST_NEEDS_HOST_CURSOR);
675	}
676
677
678	/** Check what sort of reporting can be done using the devices currently
679	* enabled. Does not consider the VMM device. */
680	void Mouse::getDeviceCaps(bool pfAbs, bool pfRel, bool *pfMT)
681	{
682	bool fAbsDev = false;
683	bool fRelDev = false;
684	bool fMTDev = false;
685
686	AutoReadLock aLock(this COMMA_LOCKVAL_SRC_POS);
687
688	for (unsigned i = 0; i < MOUSE_MAX_DEVICES; ++i)
689	if (mpDrv[i])
690	{
691	if (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_ABSOLUTE)
692	fAbsDev = true;
693	if (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_RELATIVE)
694	fRelDev = true;
695	if (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_MULTI_TOUCH)
696	fMTDev = true;
697	}
698	if (pfAbs)
699	*pfAbs = fAbsDev;
700	if (pfRel)
701	*pfRel = fRelDev;
702	}
703
704
705	/** Does the VMM device currently support absolute reporting? */
706	bool Mouse::vmmdevCanAbs(void)
707	{
708	bool fRelDev;
709
710	getDeviceCaps(NULL, &fRelDev, NULL);
711	return (mfVMMDevGuestCaps & VMMDEV_MOUSE_GUEST_CAN_ABSOLUTE)
712	&& fRelDev;
713	}
714
715
716	/** Does the VMM device currently support absolute reporting? */
717	bool Mouse::deviceCanAbs(void)
718	{
719	bool fAbsDev;
720
721	getDeviceCaps(&fAbsDev, NULL, NULL);
722	return fAbsDev;
723	}
724
725
726	/** Can we currently send relative events to the guest? */
727	bool Mouse::supportsRel(void)
728	{
729	bool fRelDev;
730
731	getDeviceCaps(NULL, &fRelDev, NULL);
732	return fRelDev;
733	}
734
735
736	/** Can we currently send absolute events to the guest? */
737	bool Mouse::supportsAbs(void)
738	{
739	bool fAbsDev;
740
741	getDeviceCaps(&fAbsDev, NULL, NULL);
742	return fAbsDev \|\| vmmdevCanAbs();
743	}
744
745
746	/** Can we currently send absolute events to the guest? */
747	bool Mouse::supportsMT(void)
748	{
749	bool fMTDev;
750
751	getDeviceCaps(NULL, NULL, &fMTDev);
752	return fMTDev;
753	}
754
755
756	/** Check what sort of reporting can be done using the devices currently
757	* enabled (including the VMM device) and notify the guest and the front-end.
758	*/
759	void Mouse::sendMouseCapsNotifications(void)
760	{
761	bool fAbsDev, fRelDev, fMTDev, fCanAbs, fNeedsHostCursor;
762
763	{
764	AutoReadLock aLock(this COMMA_LOCKVAL_SRC_POS);
765
766	getDeviceCaps(&fAbsDev, &fRelDev, &fMTDev);
767	fCanAbs = supportsAbs();
768	fNeedsHostCursor = guestNeedsHostCursor();
769	}
770	if (fAbsDev)
771	updateVMMDevMouseCaps(VMMDEV_MOUSE_HOST_HAS_ABS_DEV, 0);
772	else
773	updateVMMDevMouseCaps(0, VMMDEV_MOUSE_HOST_HAS_ABS_DEV);
774	/** @todo this call takes the Console lock in order to update the cached
775	* callback data atomically. However I can't see any sign that the cached
776	* data is ever used again. */
777	mParent->onMouseCapabilityChange(fCanAbs, fRelDev, fMTDev, fNeedsHostCursor);
778	}
779
780
781	/**
782	* @interface_method_impl{PDMIMOUSECONNECTOR,pfnReportModes}
783	* A virtual device is notifying us about its current state and capabilities
784	*/
785	DECLCALLBACK(void) Mouse::mouseReportModes(PPDMIMOUSECONNECTOR pInterface, bool fRel, bool fAbs, bool fMT)
786	{
787	PDRVMAINMOUSE pDrv = RT_FROM_MEMBER(pInterface, DRVMAINMOUSE, IConnector);
788	if (fRel)
789	pDrv->u32DevCaps \|= MOUSE_DEVCAP_RELATIVE;
790	else
791	pDrv->u32DevCaps &= ~MOUSE_DEVCAP_RELATIVE;
792	if (fAbs)
793	pDrv->u32DevCaps \|= MOUSE_DEVCAP_ABSOLUTE;
794	else
795	pDrv->u32DevCaps &= ~MOUSE_DEVCAP_ABSOLUTE;
796	if (fMT)
797	pDrv->u32DevCaps \|= MOUSE_DEVCAP_MULTI_TOUCH;
798	else
799	pDrv->u32DevCaps &= ~MOUSE_DEVCAP_MULTI_TOUCH;
800
801	pDrv->pMouse->sendMouseCapsNotifications();
802	}
803
804
805	/**
806	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
807	*/
808	DECLCALLBACK(void ) Mouse::drvQueryInterface(PPDMIBASE pInterface, const char pszIID)
809	{
810	PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
811	PDRVMAINMOUSE pDrv = PDMINS_2_DATA(pDrvIns, PDRVMAINMOUSE);
812
813	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
814	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMOUSECONNECTOR, &pDrv->IConnector);
815	return NULL;
816	}
817
818
819	/**
820	* Destruct a mouse driver instance.
821	*
822	* @returns VBox status.
823	* @param pDrvIns The driver instance data.
824	*/
825	DECLCALLBACK(void) Mouse::drvDestruct(PPDMDRVINS pDrvIns)
826	{
827	PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
828	PDRVMAINMOUSE pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINMOUSE);
829	LogFlow(("Mouse::drvDestruct: iInstance=%d\n", pDrvIns->iInstance));
830
831	if (pThis->pMouse)
832	{
833	AutoWriteLock mouseLock(pThis->pMouse COMMA_LOCKVAL_SRC_POS);
834	for (unsigned cDev = 0; cDev < MOUSE_MAX_DEVICES; ++cDev)
835	if (pThis->pMouse->mpDrv[cDev] == pThis)
836	{
837	pThis->pMouse->mpDrv[cDev] = NULL;
838	break;
839	}
840	}
841	}
842
843
844	/**
845	* Construct a mouse driver instance.
846	*
847	* @copydoc FNPDMDRVCONSTRUCT
848	*/
849	DECLCALLBACK(int) Mouse::drvConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
850	{
851	PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
852	PDRVMAINMOUSE pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINMOUSE);
853	LogFlow(("drvMainMouse_Construct: iInstance=%d\n", pDrvIns->iInstance));
854
855	/*
856	* Validate configuration.
857	*/
858	if (!CFGMR3AreValuesValid(pCfg, "Object\0"))
859	return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
860	AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
861	("Configuration error: Not possible to attach anything to this driver!\n"),
862	VERR_PDM_DRVINS_NO_ATTACH);
863
864	/*
865	* IBase.
866	*/
867	pDrvIns->IBase.pfnQueryInterface = Mouse::drvQueryInterface;
868
869	pThis->IConnector.pfnReportModes = Mouse::mouseReportModes;
870
871	/*
872	* Get the IMousePort interface of the above driver/device.
873	*/
874	pThis->pUpPort = (PPDMIMOUSEPORT)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMIMOUSEPORT_IID);
875	if (!pThis->pUpPort)
876	{
877	AssertMsgFailed(("Configuration error: No mouse port interface above!\n"));
878	return VERR_PDM_MISSING_INTERFACE_ABOVE;
879	}
880
881	/*
882	* Get the Mouse object pointer and update the mpDrv member.
883	*/
884	void *pv;
885	int rc = CFGMR3QueryPtr(pCfg, "Object", &pv);
886	if (RT_FAILURE(rc))
887	{
888	AssertMsgFailed(("Configuration error: No/bad \"Object\" value! rc=%Rrc\n", rc));
889	return rc;
890	}
891	pThis->pMouse = (Mouse )pv; /* @todo Check this cast! */
892	unsigned cDev;
893	{
894	AutoReadLock mouseLock(pThis->pMouse COMMA_LOCKVAL_SRC_POS);
895
896	for (cDev = 0; cDev < MOUSE_MAX_DEVICES; ++cDev)
897	if (!pThis->pMouse->mpDrv[cDev])
898	{
899	pThis->pMouse->mpDrv[cDev] = pThis;
900	break;
901	}
902	}
903	if (cDev == MOUSE_MAX_DEVICES)
904	return VERR_NO_MORE_HANDLES;
905
906	return VINF_SUCCESS;
907	}
908
909
910	/**
911	* Main mouse driver registration record.
912	*/
913	const PDMDRVREG Mouse::DrvReg =
914	{
915	/* u32Version */
916	PDM_DRVREG_VERSION,
917	/* szName */
918	"MainMouse",
919	/* szRCMod */
920	"",
921	/* szR0Mod */
922	"",
923	/* pszDescription */
924	"Main mouse driver (Main as in the API).",
925	/* fFlags */
926	PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
927	/* fClass. */
928	PDM_DRVREG_CLASS_MOUSE,
929	/* cMaxInstances */
930	~0U,
931	/* cbInstance */
932	sizeof(DRVMAINMOUSE),
933	/* pfnConstruct */
934	Mouse::drvConstruct,
935	/* pfnDestruct */
936	Mouse::drvDestruct,
937	/* pfnRelocate */
938	NULL,
939	/* pfnIOCtl */
940	NULL,
941	/* pfnPowerOn */
942	NULL,
943	/* pfnReset */
944	NULL,
945	/* pfnSuspend */
946	NULL,
947	/* pfnResume */
948	NULL,
949	/* pfnAttach */
950	NULL,
951	/* pfnDetach */
952	NULL,
953	/* pfnPowerOff */
954	NULL,
955	/* pfnSoftReset */
956	NULL,
957	/* u32EndVersion */
958	PDM_DRVREG_VERSION
959	};
960	/* vi: set tabstop=4 shiftwidth=4 expandtab: */

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/src/VBox/Main/src-client/MouseImpl.cpp@ 47226

Download in other formats: