VirtualBox

source: vbox/trunk/src/VBox/Devices/Input/DrvMouseQueue.cpp@ 47631

Last change on this file since 47631 was 47571, checked in by vboxsync, 11 years ago

include,Devices,Main,VirtualBox: multi-touch input.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 13.6 KB
Line 
1/* $Id: DrvMouseQueue.cpp 47571 2013-08-07 09:49:33Z vboxsync $ */
2/** @file
3 * VBox input devices: Mouse queue driver
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
19/*******************************************************************************
20* Header Files *
21*******************************************************************************/
22#define LOG_GROUP LOG_GROUP_DRV_MOUSE_QUEUE
23#include <VBox/vmm/pdmdrv.h>
24#include <iprt/assert.h>
25#include <iprt/uuid.h>
26
27#include "VBoxDD.h"
28
29
30
31/*******************************************************************************
32* Structures and Typedefs *
33*******************************************************************************/
34/**
35 * Mouse queue driver instance data.
36 *
37 * @implements PDMIMOUSECONNECTOR
38 * @implements PDMIMOUSEPORT
39 */
40typedef struct DRVMOUSEQUEUE
41{
42 /** Pointer to the driver instance structure. */
43 PPDMDRVINS pDrvIns;
44 /** Pointer to the mouse port interface of the driver/device above us. */
45 PPDMIMOUSEPORT pUpPort;
46 /** Pointer to the mouse port interface of the driver/device below us. */
47 PPDMIMOUSECONNECTOR pDownConnector;
48 /** Our mouse connector interface. */
49 PDMIMOUSECONNECTOR IConnector;
50 /** Our mouse port interface. */
51 PDMIMOUSEPORT IPort;
52 /** The queue handle. */
53 PPDMQUEUE pQueue;
54 /** Discard input when this flag is set.
55 * We only accept input when the VM is running. */
56 bool fInactive;
57} DRVMOUSEQUEUE, *PDRVMOUSEQUEUE;
58
59
60/**
61 * Event type for @a DRVMOUSEQUEUEITEM
62 */
63enum EVENTTYPE { RELATIVE, ABSOLUTE };
64
65/**
66 * Mouse queue item.
67 */
68typedef struct DRVMOUSEQUEUEITEM
69{
70 /** The core part owned by the queue manager. */
71 PDMQUEUEITEMCORE Core;
72 enum EVENTTYPE enmType;
73 union
74 {
75 uint32_t padding[5];
76 struct
77 {
78 uint32_t fButtons;
79 int32_t dx;
80 int32_t dy;
81 int32_t dz;
82 int32_t dw;
83 } Relative;
84 struct
85 {
86 uint32_t fButtons;
87 uint32_t x;
88 uint32_t y;
89 int32_t dz;
90 int32_t dw;
91 } Absolute;
92 } u;
93} DRVMOUSEQUEUEITEM, *PDRVMOUSEQUEUEITEM;
94
95
96
97/* -=-=-=-=- IBase -=-=-=-=- */
98
99/**
100 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
101 */
102static DECLCALLBACK(void *) drvMouseQueueQueryInterface(PPDMIBASE pInterface, const char *pszIID)
103{
104 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
105 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
106 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
107 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMOUSEPORT, &pThis->IPort);
108 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMOUSECONNECTOR, &pThis->IConnector);
109 return NULL;
110}
111
112
113/* -=-=-=-=- IMousePort -=-=-=-=- */
114
115/** Converts a pointer to DRVMOUSEQUEUE::Port to a DRVMOUSEQUEUE pointer. */
116#define IMOUSEPORT_2_DRVMOUSEQUEUE(pInterface) ( (PDRVMOUSEQUEUE)((char *)(pInterface) - RT_OFFSETOF(DRVMOUSEQUEUE, IPort)) )
117
118
119/**
120 * @interface_method_impl{PDMIMOUSEPORT,pfnPutEvent}
121 */
122static DECLCALLBACK(int) drvMouseQueuePutEvent(PPDMIMOUSEPORT pInterface,
123 int32_t dx, int32_t dy,
124 int32_t dz, int32_t dw,
125 uint32_t fButtons)
126{
127 PDRVMOUSEQUEUE pDrv = IMOUSEPORT_2_DRVMOUSEQUEUE(pInterface);
128 if (pDrv->fInactive)
129 return VINF_SUCCESS;
130
131 PDRVMOUSEQUEUEITEM pItem = (PDRVMOUSEQUEUEITEM)PDMQueueAlloc(pDrv->pQueue);
132 if (pItem)
133 {
134 RT_ZERO(pItem->u.padding);
135 pItem->enmType = RELATIVE;
136 pItem->u.Relative.dx = dx;
137 pItem->u.Relative.dy = dy;
138 pItem->u.Relative.dz = dz;
139 pItem->u.Relative.dw = dw;
140 pItem->u.Relative.fButtons = fButtons;
141 PDMQueueInsert(pDrv->pQueue, &pItem->Core);
142 return VINF_SUCCESS;
143 }
144 return VERR_PDM_NO_QUEUE_ITEMS;
145}
146
147/**
148 * @interface_method_impl{PDMIMOUSEPORT,pfnPutEventAbs}
149 */
150static DECLCALLBACK(int) drvMouseQueuePutEventAbs(PPDMIMOUSEPORT pInterface,
151 uint32_t x, uint32_t y,
152 int32_t dz, int32_t dw,
153 uint32_t fButtons)
154{
155 PDRVMOUSEQUEUE pDrv = IMOUSEPORT_2_DRVMOUSEQUEUE(pInterface);
156 if (pDrv->fInactive)
157 return VINF_SUCCESS;
158
159 PDRVMOUSEQUEUEITEM pItem = (PDRVMOUSEQUEUEITEM)PDMQueueAlloc(pDrv->pQueue);
160 if (pItem)
161 {
162 RT_ZERO(pItem->u.padding);
163 pItem->enmType = ABSOLUTE;
164 pItem->u.Absolute.x = x;
165 pItem->u.Absolute.y = y;
166 pItem->u.Absolute.dz = dz;
167 pItem->u.Absolute.dw = dw;
168 pItem->u.Absolute.fButtons = fButtons;
169 PDMQueueInsert(pDrv->pQueue, &pItem->Core);
170 return VINF_SUCCESS;
171 }
172 return VERR_PDM_NO_QUEUE_ITEMS;
173}
174
175
176static DECLCALLBACK(int) drvMouseQueuePutEventMultiTouch(PPDMIMOUSEPORT pInterface,
177 uint8_t cContacts,
178 const uint64_t *pau64Contacts,
179 uint32_t u32ScanTime)
180{
181 PDRVMOUSEQUEUE pThis = IMOUSEPORT_2_DRVMOUSEQUEUE(pInterface);
182 return pThis->pUpPort->pfnPutEventMultiTouch(pThis->pUpPort, cContacts, pau64Contacts, u32ScanTime);
183}
184
185/* -=-=-=-=- IConnector -=-=-=-=- */
186
187#define PPDMIMOUSECONNECTOR_2_DRVMOUSEQUEUE(pInterface) ( (PDRVMOUSEQUEUE)((char *)(pInterface) - RT_OFFSETOF(DRVMOUSEQUEUE, IConnector)) )
188
189
190/**
191 * Pass absolute mode status changes from the guest through to the frontend
192 * driver.
193 *
194 * @param pInterface Pointer to the mouse connector interface structure.
195 * @param fRel Is relative reporting supported?
196 * @param fAbs Is absolute reporting supported?
197 * @param fMT Is multi-touch reporting supported?
198 */
199static DECLCALLBACK(void) drvMousePassThruReportModes(PPDMIMOUSECONNECTOR pInterface, bool fRel, bool fAbs, bool fMT)
200{
201 PDRVMOUSEQUEUE pDrv = PPDMIMOUSECONNECTOR_2_DRVMOUSEQUEUE(pInterface);
202 pDrv->pDownConnector->pfnReportModes(pDrv->pDownConnector, fRel, fAbs, fMT);
203}
204
205
206
207/* -=-=-=-=- queue -=-=-=-=- */
208
209/**
210 * Queue callback for processing a queued item.
211 *
212 * @returns Success indicator.
213 * If false the item will not be removed and the flushing will stop.
214 * @param pDrvIns The driver instance.
215 * @param pItemCore Pointer to the queue item to process.
216 */
217static DECLCALLBACK(bool) drvMouseQueueConsumer(PPDMDRVINS pDrvIns, PPDMQUEUEITEMCORE pItemCore)
218{
219 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
220 PDRVMOUSEQUEUEITEM pItem = (PDRVMOUSEQUEUEITEM)pItemCore;
221 int rc;
222 if (pItem->enmType == RELATIVE)
223 rc = pThis->pUpPort->pfnPutEvent(pThis->pUpPort,
224 pItem->u.Relative.dx,
225 pItem->u.Relative.dy,
226 pItem->u.Relative.dz,
227 pItem->u.Relative.dw,
228 pItem->u.Relative.fButtons);
229 else if (pItem->enmType == ABSOLUTE)
230 rc = pThis->pUpPort->pfnPutEventAbs(pThis->pUpPort,
231 pItem->u.Absolute.x,
232 pItem->u.Absolute.y,
233 pItem->u.Absolute.dz,
234 pItem->u.Absolute.dw,
235 pItem->u.Absolute.fButtons);
236 else
237 return false;
238 return RT_SUCCESS(rc);
239}
240
241
242/* -=-=-=-=- driver interface -=-=-=-=- */
243
244/**
245 * Power On notification.
246 *
247 * @returns VBox status.
248 * @param pDrvIns The drive instance data.
249 */
250static DECLCALLBACK(void) drvMouseQueuePowerOn(PPDMDRVINS pDrvIns)
251{
252 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
253 pThis->fInactive = false;
254}
255
256
257/**
258 * Reset notification.
259 *
260 * @returns VBox status.
261 * @param pDrvIns The drive instance data.
262 */
263static DECLCALLBACK(void) drvMouseQueueReset(PPDMDRVINS pDrvIns)
264{
265 //PDRVKBDQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVKBDQUEUE);
266 /** @todo purge the queue on reset. */
267}
268
269
270/**
271 * Suspend notification.
272 *
273 * @returns VBox status.
274 * @param pDrvIns The drive instance data.
275 */
276static DECLCALLBACK(void) drvMouseQueueSuspend(PPDMDRVINS pDrvIns)
277{
278 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
279 pThis->fInactive = true;
280}
281
282
283/**
284 * Resume notification.
285 *
286 * @returns VBox status.
287 * @param pDrvIns The drive instance data.
288 */
289static DECLCALLBACK(void) drvMouseQueueResume(PPDMDRVINS pDrvIns)
290{
291 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
292 pThis->fInactive = false;
293}
294
295
296/**
297 * Power Off notification.
298 *
299 * @param pDrvIns The drive instance data.
300 */
301static DECLCALLBACK(void) drvMouseQueuePowerOff(PPDMDRVINS pDrvIns)
302{
303 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
304 pThis->fInactive = true;
305}
306
307
308/**
309 * Construct a mouse driver instance.
310 *
311 * @copydoc FNPDMDRVCONSTRUCT
312 */
313static DECLCALLBACK(int) drvMouseQueueConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
314{
315 PDRVMOUSEQUEUE pDrv = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
316 LogFlow(("drvMouseQueueConstruct: iInstance=%d\n", pDrvIns->iInstance));
317 PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
318
319 /*
320 * Validate configuration.
321 */
322 if (!CFGMR3AreValuesValid(pCfg, "QueueSize\0Interval\0"))
323 return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
324
325 /*
326 * Init basic data members and interfaces.
327 */
328 pDrv->fInactive = true;
329 /* IBase. */
330 pDrvIns->IBase.pfnQueryInterface = drvMouseQueueQueryInterface;
331 /* IMouseConnector. */
332 pDrv->IConnector.pfnReportModes = drvMousePassThruReportModes;
333 /* IMousePort. */
334 pDrv->IPort.pfnPutEvent = drvMouseQueuePutEvent;
335 pDrv->IPort.pfnPutEventAbs = drvMouseQueuePutEventAbs;
336 pDrv->IPort.pfnPutEventMultiTouch = drvMouseQueuePutEventMultiTouch;
337
338 /*
339 * Get the IMousePort interface of the above driver/device.
340 */
341 pDrv->pUpPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIMOUSEPORT);
342 if (!pDrv->pUpPort)
343 {
344 AssertMsgFailed(("Configuration error: No mouse port interface above!\n"));
345 return VERR_PDM_MISSING_INTERFACE_ABOVE;
346 }
347
348 /*
349 * Attach driver below and query it's connector interface.
350 */
351 PPDMIBASE pDownBase;
352 int rc = PDMDrvHlpAttach(pDrvIns, fFlags, &pDownBase);
353 if (RT_FAILURE(rc))
354 {
355 AssertMsgFailed(("Failed to attach driver below us! rc=%Rra\n", rc));
356 return rc;
357 }
358 pDrv->pDownConnector = PDMIBASE_QUERY_INTERFACE(pDownBase, PDMIMOUSECONNECTOR);
359 if (!pDrv->pDownConnector)
360 {
361 AssertMsgFailed(("Configuration error: No mouse connector interface below!\n"));
362 return VERR_PDM_MISSING_INTERFACE_BELOW;
363 }
364
365 /*
366 * Create the queue.
367 */
368 uint32_t cMilliesInterval = 0;
369 rc = CFGMR3QueryU32(pCfg, "Interval", &cMilliesInterval);
370 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
371 cMilliesInterval = 0;
372 else if (RT_FAILURE(rc))
373 {
374 AssertMsgFailed(("Configuration error: 32-bit \"Interval\" -> rc=%Rrc\n", rc));
375 return rc;
376 }
377
378 uint32_t cItems = 0;
379 rc = CFGMR3QueryU32(pCfg, "QueueSize", &cItems);
380 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
381 cItems = 128;
382 else if (RT_FAILURE(rc))
383 {
384 AssertMsgFailed(("Configuration error: 32-bit \"QueueSize\" -> rc=%Rrc\n", rc));
385 return rc;
386 }
387
388 rc = PDMDrvHlpQueueCreate(pDrvIns, sizeof(DRVMOUSEQUEUEITEM), cItems, cMilliesInterval, drvMouseQueueConsumer, "Mouse", &pDrv->pQueue);
389 if (RT_FAILURE(rc))
390 {
391 AssertMsgFailed(("Failed to create driver: cItems=%d cMilliesInterval=%d rc=%Rrc\n", cItems, cMilliesInterval, rc));
392 return rc;
393 }
394
395 return VINF_SUCCESS;
396}
397
398
399/**
400 * Mouse queue driver registration record.
401 */
402const PDMDRVREG g_DrvMouseQueue =
403{
404 /* u32Version */
405 PDM_DRVREG_VERSION,
406 /* szName */
407 "MouseQueue",
408 /* szRCMod */
409 "",
410 /* szR0Mod */
411 "",
412 /* pszDescription */
413 "Mouse queue driver to plug in between the key source and the device to do queueing and inter-thread transport.",
414 /* fFlags */
415 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
416 /* fClass. */
417 PDM_DRVREG_CLASS_MOUSE,
418 /* cMaxInstances */
419 ~0U,
420 /* cbInstance */
421 sizeof(DRVMOUSEQUEUE),
422 /* pfnConstruct */
423 drvMouseQueueConstruct,
424 /* pfnRelocate */
425 NULL,
426 /* pfnDestruct */
427 NULL,
428 /* pfnIOCtl */
429 NULL,
430 /* pfnPowerOn */
431 drvMouseQueuePowerOn,
432 /* pfnReset */
433 drvMouseQueueReset,
434 /* pfnSuspend */
435 drvMouseQueueSuspend,
436 /* pfnResume */
437 drvMouseQueueResume,
438 /* pfnAttach */
439 NULL,
440 /* pfnDetach */
441 NULL,
442 /* pfnPowerOff */
443 drvMouseQueuePowerOff,
444 /* pfnSoftReset */
445 NULL,
446 /* u32EndVersion */
447 PDM_DRVREG_VERSION
448};
449
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette