VirtualBox

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

Last change on this file since 91881 was 91863, checked in by vboxsync, 3 years ago

Devices/Input: Change input drivers to access the CFGM API through the driver helper callback table only, bugref:10074
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.5 KB
Line 
1/* $Id: DrvMouseQueue.cpp 91863 2021-10-20 09:04:02Z vboxsync $ */
2/** @file
3 * VBox input devices: Mouse queue driver
4 */
5
6/*
7 * Copyright (C) 2006-2020 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_UOFFSETOF(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_UOFFSETOF(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 * Flush the mouse queue if there are pending events.
208 *
209 * @param pInterface Pointer to the mouse connector interface structure.
210 */
211static DECLCALLBACK(void) drvMouseFlushQueue(PPDMIMOUSECONNECTOR pInterface)
212{
213 PDRVMOUSEQUEUE pDrv = PPDMIMOUSECONNECTOR_2_DRVMOUSEQUEUE(pInterface);
214
215 AssertPtr(pDrv->pQueue);
216 PDMQueueFlushIfNecessary(pDrv->pQueue);
217}
218
219
220
221/* -=-=-=-=- queue -=-=-=-=- */
222
223/**
224 * Queue callback for processing a queued item.
225 *
226 * @returns Success indicator.
227 * If false the item will not be removed and the flushing will stop.
228 * @param pDrvIns The driver instance.
229 * @param pItemCore Pointer to the queue item to process.
230 */
231static DECLCALLBACK(bool) drvMouseQueueConsumer(PPDMDRVINS pDrvIns, PPDMQUEUEITEMCORE pItemCore)
232{
233 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
234 PDRVMOUSEQUEUEITEM pItem = (PDRVMOUSEQUEUEITEM)pItemCore;
235 int rc;
236 if (pItem->enmType == RELATIVE)
237 rc = pThis->pUpPort->pfnPutEvent(pThis->pUpPort,
238 pItem->u.Relative.dx,
239 pItem->u.Relative.dy,
240 pItem->u.Relative.dz,
241 pItem->u.Relative.dw,
242 pItem->u.Relative.fButtons);
243 else if (pItem->enmType == ABSOLUTE)
244 rc = pThis->pUpPort->pfnPutEventAbs(pThis->pUpPort,
245 pItem->u.Absolute.x,
246 pItem->u.Absolute.y,
247 pItem->u.Absolute.dz,
248 pItem->u.Absolute.dw,
249 pItem->u.Absolute.fButtons);
250 else
251 AssertMsgFailedReturn(("enmType=%d\n", pItem->enmType), true /* remove buggy data */);
252 return rc != VERR_TRY_AGAIN;
253}
254
255
256/* -=-=-=-=- driver interface -=-=-=-=- */
257
258/**
259 * Power On notification.
260 *
261 * @returns VBox status code.
262 * @param pDrvIns The drive instance data.
263 */
264static DECLCALLBACK(void) drvMouseQueuePowerOn(PPDMDRVINS pDrvIns)
265{
266 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
267 pThis->fInactive = false;
268}
269
270
271/**
272 * Reset notification.
273 *
274 * @returns VBox status code.
275 * @param pDrvIns The drive instance data.
276 */
277static DECLCALLBACK(void) drvMouseQueueReset(PPDMDRVINS pDrvIns)
278{
279 //PDRVKBDQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVKBDQUEUE);
280 /** @todo purge the queue on reset. */
281 RT_NOREF(pDrvIns);
282}
283
284
285/**
286 * Suspend notification.
287 *
288 * @returns VBox status code.
289 * @param pDrvIns The drive instance data.
290 */
291static DECLCALLBACK(void) drvMouseQueueSuspend(PPDMDRVINS pDrvIns)
292{
293 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
294 pThis->fInactive = true;
295}
296
297
298/**
299 * Resume notification.
300 *
301 * @returns VBox status code.
302 * @param pDrvIns The drive instance data.
303 */
304static DECLCALLBACK(void) drvMouseQueueResume(PPDMDRVINS pDrvIns)
305{
306 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
307 pThis->fInactive = false;
308}
309
310
311/**
312 * Power Off notification.
313 *
314 * @param pDrvIns The drive instance data.
315 */
316static DECLCALLBACK(void) drvMouseQueuePowerOff(PPDMDRVINS pDrvIns)
317{
318 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
319 pThis->fInactive = true;
320}
321
322
323/**
324 * Construct a mouse driver instance.
325 *
326 * @copydoc FNPDMDRVCONSTRUCT
327 */
328static DECLCALLBACK(int) drvMouseQueueConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
329{
330 PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
331 PDRVMOUSEQUEUE pDrv = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
332 PCPDMDRVHLPR3 pHlp = pDrvIns->pHlpR3;
333
334 LogFlow(("drvMouseQueueConstruct: iInstance=%d\n", pDrvIns->iInstance));
335
336 /*
337 * Validate configuration.
338 */
339 PDMDRV_VALIDATE_CONFIG_RETURN(pDrvIns, "QueueSize|Interval", "");
340
341 /*
342 * Init basic data members and interfaces.
343 */
344 pDrv->fInactive = true;
345 /* IBase. */
346 pDrvIns->IBase.pfnQueryInterface = drvMouseQueueQueryInterface;
347 /* IMouseConnector. */
348 pDrv->IConnector.pfnReportModes = drvMousePassThruReportModes;
349 pDrv->IConnector.pfnFlushQueue = drvMouseFlushQueue;
350 /* IMousePort. */
351 pDrv->IPort.pfnPutEvent = drvMouseQueuePutEvent;
352 pDrv->IPort.pfnPutEventAbs = drvMouseQueuePutEventAbs;
353 pDrv->IPort.pfnPutEventMultiTouch = drvMouseQueuePutEventMultiTouch;
354
355 /*
356 * Get the IMousePort interface of the above driver/device.
357 */
358 pDrv->pUpPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIMOUSEPORT);
359 if (!pDrv->pUpPort)
360 {
361 AssertMsgFailed(("Configuration error: No mouse port interface above!\n"));
362 return VERR_PDM_MISSING_INTERFACE_ABOVE;
363 }
364
365 /*
366 * Attach driver below and query it's connector interface.
367 */
368 PPDMIBASE pDownBase;
369 int rc = PDMDrvHlpAttach(pDrvIns, fFlags, &pDownBase);
370 if (RT_FAILURE(rc))
371 {
372 AssertMsgFailed(("Failed to attach driver below us! rc=%Rra\n", rc));
373 return rc;
374 }
375 pDrv->pDownConnector = PDMIBASE_QUERY_INTERFACE(pDownBase, PDMIMOUSECONNECTOR);
376 if (!pDrv->pDownConnector)
377 {
378 AssertMsgFailed(("Configuration error: No mouse connector interface below!\n"));
379 return VERR_PDM_MISSING_INTERFACE_BELOW;
380 }
381
382 /*
383 * Create the queue.
384 */
385 uint32_t cMilliesInterval = 0;
386 rc = pHlp->pfnCFGMQueryU32(pCfg, "Interval", &cMilliesInterval);
387 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
388 cMilliesInterval = 0;
389 else if (RT_FAILURE(rc))
390 {
391 AssertMsgFailed(("Configuration error: 32-bit \"Interval\" -> rc=%Rrc\n", rc));
392 return rc;
393 }
394
395 uint32_t cItems = 0;
396 rc = pHlp->pfnCFGMQueryU32(pCfg, "QueueSize", &cItems);
397 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
398 cItems = 128;
399 else if (RT_FAILURE(rc))
400 {
401 AssertMsgFailed(("Configuration error: 32-bit \"QueueSize\" -> rc=%Rrc\n", rc));
402 return rc;
403 }
404
405 rc = PDMDrvHlpQueueCreate(pDrvIns, sizeof(DRVMOUSEQUEUEITEM), cItems, cMilliesInterval,
406 drvMouseQueueConsumer, "Mouse", &pDrv->pQueue);
407 if (RT_FAILURE(rc))
408 {
409 AssertMsgFailed(("Failed to create driver: cItems=%d cMilliesInterval=%d rc=%Rrc\n", cItems, cMilliesInterval, rc));
410 return rc;
411 }
412
413 return VINF_SUCCESS;
414}
415
416
417/**
418 * Mouse queue driver registration record.
419 */
420const PDMDRVREG g_DrvMouseQueue =
421{
422 /* u32Version */
423 PDM_DRVREG_VERSION,
424 /* szName */
425 "MouseQueue",
426 /* szRCMod */
427 "",
428 /* szR0Mod */
429 "",
430 /* pszDescription */
431 "Mouse queue driver to plug in between the key source and the device to do queueing and inter-thread transport.",
432 /* fFlags */
433 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
434 /* fClass. */
435 PDM_DRVREG_CLASS_MOUSE,
436 /* cMaxInstances */
437 ~0U,
438 /* cbInstance */
439 sizeof(DRVMOUSEQUEUE),
440 /* pfnConstruct */
441 drvMouseQueueConstruct,
442 /* pfnRelocate */
443 NULL,
444 /* pfnDestruct */
445 NULL,
446 /* pfnIOCtl */
447 NULL,
448 /* pfnPowerOn */
449 drvMouseQueuePowerOn,
450 /* pfnReset */
451 drvMouseQueueReset,
452 /* pfnSuspend */
453 drvMouseQueueSuspend,
454 /* pfnResume */
455 drvMouseQueueResume,
456 /* pfnAttach */
457 NULL,
458 /* pfnDetach */
459 NULL,
460 /* pfnPowerOff */
461 drvMouseQueuePowerOff,
462 /* pfnSoftReset */
463 NULL,
464 /* u32EndVersion */
465 PDM_DRVREG_VERSION
466};
467
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