MouseImpl.cpp@ 47208

Last change on this file since 47208 was 47208, checked in by vboxsync, 11 years ago
Devices/Input: more multi-touch plumbing.
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 27.8 KB

Line
1	/* $Id: MouseImpl.cpp 47208 2013-07-17 11:01:51Z 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.virtualbox.org. 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	if (vmmdevCanAbs())
446	{
447	/*
448	* Send the absolute mouse position to the VMM device.
449	*/
450	if (x != mcLastX \|\| y != mcLastY)
451	{
452	rc = reportAbsEventToVMMDev(x, y);
453	cJiggle = !fUsesVMMDevEvent;
454	}
455	rc = reportRelEventToMouseDev(cJiggle, 0, dz, dw, fButtons);
456	}
457	else
458	rc = reportAbsEventToMouseDev(x, y, 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, LONG Buttons)
466	{
467	/* If mouse button is pressed, we generate new event, to avoid reusable events coalescing and thus
468	dropping key press events */
469	if (Buttons != 0)
470	{
471	VBoxEventDesc evDesc;
472	evDesc.init(mEventSource, VBoxEventType_OnGuestMouse, fAbsolute, x, y, dz, dw, Buttons);
473	evDesc.fire(0);
474	}
475	else
476	{
477	mMouseEvent.reinit(VBoxEventType_OnGuestMouse, fAbsolute, x, y, dz, dw, Buttons);
478	mMouseEvent.fire(0);
479	}
480	}
481
482
483	/**
484	* Send a relative mouse event to the guest.
485	* @note the VMMDev capability change is so that the guest knows we are sending
486	* real events over the PS/2 device and not dummy events to signal the
487	* arrival of new absolute pointer data
488	*
489	* @returns COM status code
490	* @param dx X movement
491	* @param dy Y movement
492	* @param dz Z movement
493	* @param buttonState The mouse button state
494	*/
495	STDMETHODIMP Mouse::PutMouseEvent(LONG dx, LONG dy, LONG dz, LONG dw, LONG buttonState)
496	{
497	HRESULT rc;
498	uint32_t fButtons;
499
500	AutoCaller autoCaller(this);
501	if (FAILED(autoCaller.rc())) return autoCaller.rc();
502	LogRel3(("%s: dx=%d, dy=%d, dz=%d, dw=%d\n", __PRETTY_FUNCTION__,
503	dx, dy, dz, dw));
504
505	fButtons = mouseButtonsToPDM(buttonState);
506	/* Make sure that the guest knows that we are sending real movement
507	* events to the PS/2 device and not just dummy wake-up ones. */
508	updateVMMDevMouseCaps(0, VMMDEV_MOUSE_HOST_WANTS_ABSOLUTE);
509	rc = reportRelEventToMouseDev(dx, dy, dz, dw, fButtons);
510
511	fireMouseEvent(false, dx, dy, dz, dw, buttonState);
512
513	return rc;
514	}
515
516	/**
517	* Convert an (X, Y) value pair in screen co-ordinates (starting from 1) to a
518	* value from VMMDEV_MOUSE_RANGE_MIN to VMMDEV_MOUSE_RANGE_MAX. Sets the
519	* optional validity value to false if the pair is not on an active screen and
520	* to true otherwise.
521	* @note since guests with recent versions of X.Org use a different method
522	* to everyone else to map the valuator value to a screen pixel (they
523	* multiply by the screen dimension, do a floating point divide by
524	* the valuator maximum and round the result, while everyone else
525	* does truncating integer operations) we adjust the value we send
526	* so that it maps to the right pixel both when the result is rounded
527	* and when it is truncated.
528	*
529	* @returns COM status value
530	*/
531	HRESULT Mouse::convertDisplayRes(LONG x, LONG y, int32_t pcX, int32_t pcY,
532	bool *pfValid)
533	{
534	AssertPtrReturn(pcX, E_POINTER);
535	AssertPtrReturn(pcY, E_POINTER);
536	AssertPtrNullReturn(pfValid, E_POINTER);
537	DisplayMouseInterface *pDisplay = mParent->getDisplayMouseInterface();
538	ComAssertRet(pDisplay, E_FAIL);
539	/** The amount to add to the result (multiplied by the screen width/height)
540	* to compensate for differences in guest methods for mapping back to
541	* pixels */
542	enum { ADJUST_RANGE = - 3 * VMMDEV_MOUSE_RANGE / 4 };
543
544	if (pfValid)
545	*pfValid = true;
546	if (!(mfVMMDevGuestCaps & VMMDEV_MOUSE_NEW_PROTOCOL))
547	{
548	ULONG displayWidth, displayHeight;
549	/* Takes the display lock */
550	HRESULT rc = pDisplay->getScreenResolution(0, &displayWidth,
551	&displayHeight, NULL);
552	if (FAILED(rc))
553	return rc;
554
555	pcX = displayWidth ? (x VMMDEV_MOUSE_RANGE + ADJUST_RANGE)
556	/ (LONG) displayWidth: 0;
557	pcY = displayHeight ? (y VMMDEV_MOUSE_RANGE + ADJUST_RANGE)
558	/ (LONG) displayHeight: 0;
559	}
560	else
561	{
562	int32_t x1, y1, x2, y2;
563	/* Takes the display lock */
564	pDisplay->getFramebufferDimensions(&x1, &y1, &x2, &y2);
565	pcX = x1 < x2 ? ((x - x1) VMMDEV_MOUSE_RANGE + ADJUST_RANGE)
566	/ (x2 - x1) : 0;
567	pcY = y1 < y2 ? ((y - y1) VMMDEV_MOUSE_RANGE + ADJUST_RANGE)
568	/ (y2 - y1) : 0;
569	if ( pcX < VMMDEV_MOUSE_RANGE_MIN \|\| pcX > VMMDEV_MOUSE_RANGE_MAX
570	\|\| pcY < VMMDEV_MOUSE_RANGE_MIN \|\| pcY > VMMDEV_MOUSE_RANGE_MAX)
571	if (pfValid)
572	*pfValid = false;
573	}
574	return S_OK;
575	}
576
577
578	/**
579	* Send an absolute mouse event to the VM. This requires either VirtualBox-
580	* specific drivers installed in the guest or absolute pointing device
581	* emulation.
582	* @note the VMMDev capability change is so that the guest knows we are sending
583	* dummy events over the PS/2 device to signal the arrival of new
584	* absolute pointer data, and not pointer real movement data
585	* @note all calls out of this object are made with no locks held!
586	*
587	* @returns COM status code
588	* @param x X position (pixel), starting from 1
589	* @param y Y position (pixel), starting from 1
590	* @param dz Z movement
591	* @param buttonState The mouse button state
592	*/
593	STDMETHODIMP Mouse::PutMouseEventAbsolute(LONG x, LONG y, LONG dz, LONG dw,
594	LONG buttonState)
595	{
596	AutoCaller autoCaller(this);
597	if (FAILED(autoCaller.rc())) return autoCaller.rc();
598
599	LogRel3(("%s: x=%d, y=%d, dz=%d, dw=%d, buttonState=0x%x\n",
600	__PRETTY_FUNCTION__, x, y, dz, dw, buttonState));
601
602	int32_t xAdj, yAdj;
603	uint32_t fButtons;
604	bool fValid;
605
606	/** @todo the front end should do this conversion to avoid races */
607	/** @note Or maybe not... races are pretty inherent in everything done in
608	* this object and not really bad as far as I can see. */
609	HRESULT rc = convertDisplayRes(x, y, &xAdj, &yAdj, &fValid);
610	if (FAILED(rc)) return rc;
611
612	fButtons = mouseButtonsToPDM(buttonState);
613	/* If we are doing old-style (IRQ-less) absolute reporting to the VMM
614	* device then make sure the guest is aware of it, so that it knows to
615	* ignore relative movement on the PS/2 device. */
616	updateVMMDevMouseCaps(VMMDEV_MOUSE_HOST_WANTS_ABSOLUTE, 0);
617	if (fValid)
618	{
619	rc = reportAbsEvent(xAdj, yAdj, dz, dw, fButtons,
620	RT_BOOL( mfVMMDevGuestCaps
621	& VMMDEV_MOUSE_NEW_PROTOCOL));
622
623	fireMouseEvent(true, x, y, dz, dw, buttonState);
624	}
625
626	return rc;
627	}
628
629	/**
630	* @interface_method_impl{IMouse,putMouseEventMultiTouch}
631	*/
632	STDMETHODIMP Mouse::PutMouseEventMultiTouch(LONG x, LONG y, LONG contactID,
633	BOOL inContact)
634	{
635	AutoCaller autoCaller(this);
636	if (FAILED(autoCaller.rc())) return autoCaller.rc();
637
638	LogRel3(("%s: x=%d, y=%d, contactID=%d, inContact=%RTBool\n",
639	__PRETTY_FUNCTION__, x, y, contactID, inContact));
640
641	int32_t xAdj, yAdj;
642	uint32_t fButtons;
643	bool fValid;
644
645	/** @todo the front end should do this conversion to avoid races */
646	/** @note Or maybe not... races are pretty inherent in everything done in
647	* this object and not really bad as far as I can see. */
648	HRESULT rc = convertDisplayRes(x, y, &xAdj, &yAdj, &fValid);
649	if (FAILED(rc)) return rc;
650
651	if (fValid)
652	{
653	rc = reportMTEventToMouseDev(xAdj, yAdj, contactID, inContact);
654
655	// fireMouseEvent(true, x, y, dz, dw, buttonState);
656	}
657
658	return rc;
659	}
660
661	// private methods
662	/////////////////////////////////////////////////////////////////////////////
663
664
665	/** Does the guest currently rely on the host to draw the mouse cursor or
666	* can it switch to doing it itself in software? */
667	bool Mouse::guestNeedsHostCursor(void)
668	{
669	return RT_BOOL(mfVMMDevGuestCaps & VMMDEV_MOUSE_GUEST_NEEDS_HOST_CURSOR);
670	}
671
672
673	/** Check what sort of reporting can be done using the devices currently
674	* enabled. Does not consider the VMM device. */
675	void Mouse::getDeviceCaps(bool pfAbs, bool pfRel, bool *pfMT)
676	{
677	bool fAbsDev = false;
678	bool fRelDev = false;
679	bool fMTDev = false;
680
681	AutoReadLock aLock(this COMMA_LOCKVAL_SRC_POS);
682
683	for (unsigned i = 0; i < MOUSE_MAX_DEVICES; ++i)
684	if (mpDrv[i])
685	{
686	if (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_ABSOLUTE)
687	fAbsDev = true;
688	if (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_RELATIVE)
689	fRelDev = true;
690	if (mpDrv[i]->u32DevCaps & MOUSE_DEVCAP_MULTI_TOUCH)
691	fMTDev = true;
692	}
693	if (pfAbs)
694	*pfAbs = fAbsDev;
695	if (pfRel)
696	*pfRel = fRelDev;
697	}
698
699
700	/** Does the VMM device currently support absolute reporting? */
701	bool Mouse::vmmdevCanAbs(void)
702	{
703	bool fRelDev;
704
705	getDeviceCaps(NULL, &fRelDev, NULL);
706	return (mfVMMDevGuestCaps & VMMDEV_MOUSE_GUEST_CAN_ABSOLUTE)
707	&& fRelDev;
708	}
709
710
711	/** Does the VMM device currently support absolute reporting? */
712	bool Mouse::deviceCanAbs(void)
713	{
714	bool fAbsDev;
715
716	getDeviceCaps(&fAbsDev, NULL, NULL);
717	return fAbsDev;
718	}
719
720
721	/** Can we currently send relative events to the guest? */
722	bool Mouse::supportsRel(void)
723	{
724	bool fRelDev;
725
726	getDeviceCaps(NULL, &fRelDev, NULL);
727	return fRelDev;
728	}
729
730
731	/** Can we currently send absolute events to the guest? */
732	bool Mouse::supportsAbs(void)
733	{
734	bool fAbsDev;
735
736	getDeviceCaps(&fAbsDev, NULL, NULL);
737	return fAbsDev \|\| vmmdevCanAbs();
738	}
739
740
741	/** Can we currently send absolute events to the guest? */
742	bool Mouse::supportsMT(void)
743	{
744	bool fMTDev;
745
746	getDeviceCaps(NULL, NULL, &fMTDev);
747	return fMTDev;
748	}
749
750
751	/** Check what sort of reporting can be done using the devices currently
752	* enabled (including the VMM device) and notify the guest and the front-end.
753	*/
754	void Mouse::sendMouseCapsNotifications(void)
755	{
756	bool fAbsDev, fRelDev, fMTDev, fCanAbs, fNeedsHostCursor;
757
758	{
759	AutoReadLock aLock(this COMMA_LOCKVAL_SRC_POS);
760
761	getDeviceCaps(&fAbsDev, &fRelDev, &fMTDev);
762	fCanAbs = supportsAbs();
763	fNeedsHostCursor = guestNeedsHostCursor();
764	}
765	if (fAbsDev)
766	updateVMMDevMouseCaps(VMMDEV_MOUSE_HOST_HAS_ABS_DEV, 0);
767	else
768	updateVMMDevMouseCaps(0, VMMDEV_MOUSE_HOST_HAS_ABS_DEV);
769	/** @todo this call takes the Console lock in order to update the cached
770	* callback data atomically. However I can't see any sign that the cached
771	* data is ever used again. */
772	mParent->onMouseCapabilityChange(fCanAbs, fRelDev, fMTDev, fNeedsHostCursor);
773	}
774
775
776	/**
777	* @interface_method_impl{PDMIMOUSECONNECTOR,pfnReportModes}
778	* A virtual device is notifying us about its current state and capabilities
779	*/
780	DECLCALLBACK(void) Mouse::mouseReportModes(PPDMIMOUSECONNECTOR pInterface, bool fRel, bool fAbs, bool fMT)
781	{
782	PDRVMAINMOUSE pDrv = RT_FROM_MEMBER(pInterface, DRVMAINMOUSE, IConnector);
783	if (fRel)
784	pDrv->u32DevCaps \|= MOUSE_DEVCAP_RELATIVE;
785	else
786	pDrv->u32DevCaps &= ~MOUSE_DEVCAP_RELATIVE;
787	if (fAbs)
788	pDrv->u32DevCaps \|= MOUSE_DEVCAP_ABSOLUTE;
789	else
790	pDrv->u32DevCaps &= ~MOUSE_DEVCAP_ABSOLUTE;
791	if (fMT)
792	pDrv->u32DevCaps \|= MOUSE_DEVCAP_MULTI_TOUCH;
793	else
794	pDrv->u32DevCaps &= ~MOUSE_DEVCAP_MULTI_TOUCH;
795
796	pDrv->pMouse->sendMouseCapsNotifications();
797	}
798
799
800	/**
801	* @interface_method_impl{PDMIBASE,pfnQueryInterface}
802	*/
803	DECLCALLBACK(void ) Mouse::drvQueryInterface(PPDMIBASE pInterface, const char pszIID)
804	{
805	PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
806	PDRVMAINMOUSE pDrv = PDMINS_2_DATA(pDrvIns, PDRVMAINMOUSE);
807
808	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
809	PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMOUSECONNECTOR, &pDrv->IConnector);
810	return NULL;
811	}
812
813
814	/**
815	* Destruct a mouse driver instance.
816	*
817	* @returns VBox status.
818	* @param pDrvIns The driver instance data.
819	*/
820	DECLCALLBACK(void) Mouse::drvDestruct(PPDMDRVINS pDrvIns)
821	{
822	PDMDRV_CHECK_VERSIONS_RETURN_VOID(pDrvIns);
823	PDRVMAINMOUSE pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINMOUSE);
824	LogFlow(("Mouse::drvDestruct: iInstance=%d\n", pDrvIns->iInstance));
825
826	if (pThis->pMouse)
827	{
828	AutoWriteLock mouseLock(pThis->pMouse COMMA_LOCKVAL_SRC_POS);
829	for (unsigned cDev = 0; cDev < MOUSE_MAX_DEVICES; ++cDev)
830	if (pThis->pMouse->mpDrv[cDev] == pThis)
831	{
832	pThis->pMouse->mpDrv[cDev] = NULL;
833	break;
834	}
835	}
836	}
837
838
839	/**
840	* Construct a mouse driver instance.
841	*
842	* @copydoc FNPDMDRVCONSTRUCT
843	*/
844	DECLCALLBACK(int) Mouse::drvConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
845	{
846	PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
847	PDRVMAINMOUSE pThis = PDMINS_2_DATA(pDrvIns, PDRVMAINMOUSE);
848	LogFlow(("drvMainMouse_Construct: iInstance=%d\n", pDrvIns->iInstance));
849
850	/*
851	* Validate configuration.
852	*/
853	if (!CFGMR3AreValuesValid(pCfg, "Object\0"))
854	return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
855	AssertMsgReturn(PDMDrvHlpNoAttach(pDrvIns) == VERR_PDM_NO_ATTACHED_DRIVER,
856	("Configuration error: Not possible to attach anything to this driver!\n"),
857	VERR_PDM_DRVINS_NO_ATTACH);
858
859	/*
860	* IBase.
861	*/
862	pDrvIns->IBase.pfnQueryInterface = Mouse::drvQueryInterface;
863
864	pThis->IConnector.pfnReportModes = Mouse::mouseReportModes;
865
866	/*
867	* Get the IMousePort interface of the above driver/device.
868	*/
869	pThis->pUpPort = (PPDMIMOUSEPORT)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMIMOUSEPORT_IID);
870	if (!pThis->pUpPort)
871	{
872	AssertMsgFailed(("Configuration error: No mouse port interface above!\n"));
873	return VERR_PDM_MISSING_INTERFACE_ABOVE;
874	}
875
876	/*
877	* Get the Mouse object pointer and update the mpDrv member.
878	*/
879	void *pv;
880	int rc = CFGMR3QueryPtr(pCfg, "Object", &pv);
881	if (RT_FAILURE(rc))
882	{
883	AssertMsgFailed(("Configuration error: No/bad \"Object\" value! rc=%Rrc\n", rc));
884	return rc;
885	}
886	pThis->pMouse = (Mouse )pv; /* @todo Check this cast! */
887	unsigned cDev;
888	{
889	AutoReadLock mouseLock(pThis->pMouse COMMA_LOCKVAL_SRC_POS);
890
891	for (cDev = 0; cDev < MOUSE_MAX_DEVICES; ++cDev)
892	if (!pThis->pMouse->mpDrv[cDev])
893	{
894	pThis->pMouse->mpDrv[cDev] = pThis;
895	break;
896	}
897	}
898	if (cDev == MOUSE_MAX_DEVICES)
899	return VERR_NO_MORE_HANDLES;
900
901	return VINF_SUCCESS;
902	}
903
904
905	/**
906	* Main mouse driver registration record.
907	*/
908	const PDMDRVREG Mouse::DrvReg =
909	{
910	/* u32Version */
911	PDM_DRVREG_VERSION,
912	/* szName */
913	"MainMouse",
914	/* szRCMod */
915	"",
916	/* szR0Mod */
917	"",
918	/* pszDescription */
919	"Main mouse driver (Main as in the API).",
920	/* fFlags */
921	PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
922	/* fClass. */
923	PDM_DRVREG_CLASS_MOUSE,
924	/* cMaxInstances */
925	~0U,
926	/* cbInstance */
927	sizeof(DRVMAINMOUSE),
928	/* pfnConstruct */
929	Mouse::drvConstruct,
930	/* pfnDestruct */
931	Mouse::drvDestruct,
932	/* pfnRelocate */
933	NULL,
934	/* pfnIOCtl */
935	NULL,
936	/* pfnPowerOn */
937	NULL,
938	/* pfnReset */
939	NULL,
940	/* pfnSuspend */
941	NULL,
942	/* pfnResume */
943	NULL,
944	/* pfnAttach */
945	NULL,
946	/* pfnDetach */
947	NULL,
948	/* pfnPowerOff */
949	NULL,
950	/* pfnSoftReset */
951	NULL,
952	/* u32EndVersion */
953	PDM_DRVREG_VERSION
954	};
955	/* 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@ 47208

Download in other formats: