VirtualBox

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

Last change on this file since 33000 was 28800, checked in by vboxsync, 14 years ago

Automated rebranding to Oracle copyright/license strings via filemuncher
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.8 KB
Line 
1/* $Id: DrvMouseQueue.cpp 28800 2010-04-27 08:22:32Z vboxsync $ */
2/** @file
3 * VBox input devices: Mouse queue driver
4 */
5
6/*
7 * Copyright (C) 2006-2010 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/pdmdrv.h>
24#include <iprt/assert.h>
25#include <iprt/uuid.h>
26
27#include "Builtins.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 * Mouse queue item.
62 */
63typedef struct DRVMOUSEQUEUEITEM
64{
65 /** The core part owned by the queue manager. */
66 PDMQUEUEITEMCORE Core;
67 uint32_t fAbs;
68 int32_t iDeltaX;
69 int32_t iDeltaY;
70 int32_t iDeltaZ;
71 int32_t iDeltaW;
72 uint32_t fButtonStates;
73 uint32_t uX;
74 uint32_t uY;
75} DRVMOUSEQUEUEITEM, *PDRVMOUSEQUEUEITEM;
76
77
78
79/* -=-=-=-=- IBase -=-=-=-=- */
80
81/**
82 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
83 */
84static DECLCALLBACK(void *) drvMouseQueueQueryInterface(PPDMIBASE pInterface, const char *pszIID)
85{
86 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
87 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
88 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIBASE, &pDrvIns->IBase);
89 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMOUSEPORT, &pThis->IPort);
90 PDMIBASE_RETURN_INTERFACE(pszIID, PDMIMOUSECONNECTOR, &pThis->IConnector);
91 return NULL;
92}
93
94
95/* -=-=-=-=- IMousePort -=-=-=-=- */
96
97/** Converts a pointer to DRVMOUSEQUEUE::Port to a DRVMOUSEQUEUE pointer. */
98#define IMOUSEPORT_2_DRVMOUSEQUEUE(pInterface) ( (PDRVMOUSEQUEUE)((char *)(pInterface) - RT_OFFSETOF(DRVMOUSEQUEUE, IPort)) )
99
100
101/**
102 * @interface_method_impl{PDMIMOUSEPORT,pfnPutEvent}
103 */
104static DECLCALLBACK(int) drvMouseQueuePutEvent(PPDMIMOUSEPORT pInterface, int32_t iDeltaX, int32_t iDeltaY, int32_t iDeltaZ, int32_t iDeltaW, uint32_t fButtonStates)
105{
106 PDRVMOUSEQUEUE pDrv = IMOUSEPORT_2_DRVMOUSEQUEUE(pInterface);
107 if (pDrv->fInactive)
108 return VINF_SUCCESS;
109
110 PDRVMOUSEQUEUEITEM pItem = (PDRVMOUSEQUEUEITEM)PDMQueueAlloc(pDrv->pQueue);
111 if (pItem)
112 {
113 pItem->fAbs = 0;
114 pItem->iDeltaX = iDeltaX;
115 pItem->iDeltaY = iDeltaY;
116 pItem->iDeltaZ = iDeltaZ;
117 pItem->iDeltaW = iDeltaW;
118 pItem->fButtonStates = fButtonStates;
119 pItem->uX = 0;
120 pItem->uY = 0;
121 PDMQueueInsert(pDrv->pQueue, &pItem->Core);
122 return VINF_SUCCESS;
123 }
124 return VERR_PDM_NO_QUEUE_ITEMS;
125}
126
127/**
128 * @interface_method_impl{PDMIMOUSEPORT,pfnPutEventAbs}
129 */
130static DECLCALLBACK(int) drvMouseQueuePutEventAbs(PPDMIMOUSEPORT pInterface, uint32_t uX, uint32_t uY, int32_t iDeltaZ, int32_t iDeltaW, uint32_t fButtonStates)
131{
132 PDRVMOUSEQUEUE pDrv = IMOUSEPORT_2_DRVMOUSEQUEUE(pInterface);
133 if (pDrv->fInactive)
134 return VINF_SUCCESS;
135
136 PDRVMOUSEQUEUEITEM pItem = (PDRVMOUSEQUEUEITEM)PDMQueueAlloc(pDrv->pQueue);
137 if (pItem)
138 {
139 pItem->fAbs = 1;
140 pItem->iDeltaX = 0;
141 pItem->iDeltaY = 0;
142 pItem->iDeltaZ = iDeltaZ;
143 pItem->iDeltaW = iDeltaW;
144 pItem->fButtonStates = fButtonStates;
145 pItem->uX = uX;
146 pItem->uY = uY;
147 PDMQueueInsert(pDrv->pQueue, &pItem->Core);
148 return VINF_SUCCESS;
149 }
150 return VERR_PDM_NO_QUEUE_ITEMS;
151}
152
153
154/* -=-=-=-=- IConnector -=-=-=-=- */
155
156#define PPDMIMOUSECONNECTOR_2_DRVMOUSEQUEUE(pInterface) ( (PDRVMOUSEQUEUE)((char *)(pInterface) - RT_OFFSETOF(DRVMOUSEQUEUE, IConnector)) )
157
158
159/**
160 * Pass absolute mode status changes from the guest through to the frontend
161 * driver.
162 *
163 * @param pInterface Pointer to the mouse connector interface structure.
164 * @param fAbs The new absolute mode state.
165 */
166static DECLCALLBACK(void) drvMousePassThruReportModes(PPDMIMOUSECONNECTOR pInterface, bool fRel, bool fAbs)
167{
168 PDRVMOUSEQUEUE pDrv = PPDMIMOUSECONNECTOR_2_DRVMOUSEQUEUE(pInterface);
169 pDrv->pDownConnector->pfnReportModes(pDrv->pDownConnector, fRel, fAbs);
170}
171
172
173
174/* -=-=-=-=- queue -=-=-=-=- */
175
176/**
177 * Queue callback for processing a queued item.
178 *
179 * @returns Success indicator.
180 * If false the item will not be removed and the flushing will stop.
181 * @param pDrvIns The driver instance.
182 * @param pItemCore Pointer to the queue item to process.
183 */
184static DECLCALLBACK(bool) drvMouseQueueConsumer(PPDMDRVINS pDrvIns, PPDMQUEUEITEMCORE pItemCore)
185{
186 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
187 PDRVMOUSEQUEUEITEM pItem = (PDRVMOUSEQUEUEITEM)pItemCore;
188 int rc;
189 if (!pItem->fAbs)
190 rc = pThis->pUpPort->pfnPutEvent(pThis->pUpPort, pItem->iDeltaX, pItem->iDeltaY, pItem->iDeltaZ, pItem->iDeltaW, pItem->fButtonStates);
191 else
192 rc = pThis->pUpPort->pfnPutEventAbs(pThis->pUpPort, pItem->uX, pItem->uY, pItem->iDeltaZ, pItem->iDeltaW, pItem->fButtonStates);
193 return RT_SUCCESS(rc);
194}
195
196
197/* -=-=-=-=- driver interface -=-=-=-=- */
198
199/**
200 * Power On notification.
201 *
202 * @returns VBox status.
203 * @param pDrvIns The drive instance data.
204 */
205static DECLCALLBACK(void) drvMouseQueuePowerOn(PPDMDRVINS pDrvIns)
206{
207 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
208 pThis->fInactive = false;
209}
210
211
212/**
213 * Reset notification.
214 *
215 * @returns VBox status.
216 * @param pDrvIns The drive instance data.
217 */
218static DECLCALLBACK(void) drvMouseQueueReset(PPDMDRVINS pDrvIns)
219{
220 //PDRVKBDQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVKBDQUEUE);
221 /** @todo purge the queue on reset. */
222}
223
224
225/**
226 * Suspend notification.
227 *
228 * @returns VBox status.
229 * @param pDrvIns The drive instance data.
230 */
231static DECLCALLBACK(void) drvMouseQueueSuspend(PPDMDRVINS pDrvIns)
232{
233 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
234 pThis->fInactive = true;
235}
236
237
238/**
239 * Resume notification.
240 *
241 * @returns VBox status.
242 * @param pDrvIns The drive instance data.
243 */
244static DECLCALLBACK(void) drvMouseQueueResume(PPDMDRVINS pDrvIns)
245{
246 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
247 pThis->fInactive = false;
248}
249
250
251/**
252 * Power Off notification.
253 *
254 * @param pDrvIns The drive instance data.
255 */
256static DECLCALLBACK(void) drvMouseQueuePowerOff(PPDMDRVINS pDrvIns)
257{
258 PDRVMOUSEQUEUE pThis = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
259 pThis->fInactive = true;
260}
261
262
263/**
264 * Construct a mouse driver instance.
265 *
266 * @copydoc FNPDMDRVCONSTRUCT
267 */
268static DECLCALLBACK(int) drvMouseQueueConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfg, uint32_t fFlags)
269{
270 PDRVMOUSEQUEUE pDrv = PDMINS_2_DATA(pDrvIns, PDRVMOUSEQUEUE);
271 LogFlow(("drvMouseQueueConstruct: iInstance=%d\n", pDrvIns->iInstance));
272 PDMDRV_CHECK_VERSIONS_RETURN(pDrvIns);
273
274 /*
275 * Validate configuration.
276 */
277 if (!CFGMR3AreValuesValid(pCfg, "QueueSize\0Interval\0"))
278 return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
279
280 /*
281 * Init basic data members and interfaces.
282 */
283 pDrv->fInactive = true;
284 /* IBase. */
285 pDrvIns->IBase.pfnQueryInterface = drvMouseQueueQueryInterface;
286 /* IMouseConnector. */
287 pDrv->IConnector.pfnReportModes = drvMousePassThruReportModes;
288 /* IMousePort. */
289 pDrv->IPort.pfnPutEvent = drvMouseQueuePutEvent;
290 pDrv->IPort.pfnPutEventAbs = drvMouseQueuePutEventAbs;
291
292 /*
293 * Get the IMousePort interface of the above driver/device.
294 */
295 pDrv->pUpPort = PDMIBASE_QUERY_INTERFACE(pDrvIns->pUpBase, PDMIMOUSEPORT);
296 if (!pDrv->pUpPort)
297 {
298 AssertMsgFailed(("Configuration error: No mouse port interface above!\n"));
299 return VERR_PDM_MISSING_INTERFACE_ABOVE;
300 }
301
302 /*
303 * Attach driver below and query it's connector interface.
304 */
305 PPDMIBASE pDownBase;
306 int rc = PDMDrvHlpAttach(pDrvIns, fFlags, &pDownBase);
307 if (RT_FAILURE(rc))
308 {
309 AssertMsgFailed(("Failed to attach driver below us! rc=%Rra\n", rc));
310 return rc;
311 }
312 pDrv->pDownConnector = PDMIBASE_QUERY_INTERFACE(pDownBase, PDMIMOUSECONNECTOR);
313 if (!pDrv->pDownConnector)
314 {
315 AssertMsgFailed(("Configuration error: No mouse connector interface below!\n"));
316 return VERR_PDM_MISSING_INTERFACE_BELOW;
317 }
318
319 /*
320 * Create the queue.
321 */
322 uint32_t cMilliesInterval = 0;
323 rc = CFGMR3QueryU32(pCfg, "Interval", &cMilliesInterval);
324 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
325 cMilliesInterval = 0;
326 else if (RT_FAILURE(rc))
327 {
328 AssertMsgFailed(("Configuration error: 32-bit \"Interval\" -> rc=%Rrc\n", rc));
329 return rc;
330 }
331
332 uint32_t cItems = 0;
333 rc = CFGMR3QueryU32(pCfg, "QueueSize", &cItems);
334 if (rc == VERR_CFGM_VALUE_NOT_FOUND)
335 cItems = 128;
336 else if (RT_FAILURE(rc))
337 {
338 AssertMsgFailed(("Configuration error: 32-bit \"QueueSize\" -> rc=%Rrc\n", rc));
339 return rc;
340 }
341
342 rc = PDMDrvHlpQueueCreate(pDrvIns, sizeof(DRVMOUSEQUEUEITEM), cItems, cMilliesInterval, drvMouseQueueConsumer, "Mouse", &pDrv->pQueue);
343 if (RT_FAILURE(rc))
344 {
345 AssertMsgFailed(("Failed to create driver: cItems=%d cMilliesInterval=%d rc=%Rrc\n", cItems, cMilliesInterval, rc));
346 return rc;
347 }
348
349 return VINF_SUCCESS;
350}
351
352
353/**
354 * Mouse queue driver registration record.
355 */
356const PDMDRVREG g_DrvMouseQueue =
357{
358 /* u32Version */
359 PDM_DRVREG_VERSION,
360 /* szName */
361 "MouseQueue",
362 /* szRCMod */
363 "",
364 /* szR0Mod */
365 "",
366 /* pszDescription */
367 "Mouse queue driver to plug in between the key source and the device to do queueing and inter-thread transport.",
368 /* fFlags */
369 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
370 /* fClass. */
371 PDM_DRVREG_CLASS_MOUSE,
372 /* cMaxInstances */
373 ~0,
374 /* cbInstance */
375 sizeof(DRVMOUSEQUEUE),
376 /* pfnConstruct */
377 drvMouseQueueConstruct,
378 /* pfnRelocate */
379 NULL,
380 /* pfnDestruct */
381 NULL,
382 /* pfnIOCtl */
383 NULL,
384 /* pfnPowerOn */
385 drvMouseQueuePowerOn,
386 /* pfnReset */
387 drvMouseQueueReset,
388 /* pfnSuspend */
389 drvMouseQueueSuspend,
390 /* pfnResume */
391 drvMouseQueueResume,
392 /* pfnAttach */
393 NULL,
394 /* pfnDetach */
395 NULL,
396 /* pfnPowerOff */
397 drvMouseQueuePowerOff,
398 /* pfnSoftReset */
399 NULL,
400 /* u32EndVersion */
401 PDM_DRVREG_VERSION
402};
403
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
Contact – Privacy policy – Terms of Use