VirtualBox

source: vbox/trunk/src/VBox/Main/VMMDevInterface.cpp@ 4533

Last change on this file since 4533 was 4533, checked in by vboxsync, 18 years ago

Cleaned up a bit
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 24.2 KB
Line 
1/** @file
2 *
3 * VirtualBox Driver Interface to VMM device
4 */
5
6/*
7 * Copyright (C) 2006-2007 innotek GmbH
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 as published by the Free Software Foundation,
13 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
14 * distribution. VirtualBox OSE is distributed in the hope that it will
15 * be useful, but WITHOUT ANY WARRANTY of any kind.
16 */
17
18#include "VMMDev.h"
19#include "ConsoleImpl.h"
20#include "DisplayImpl.h"
21#include "GuestImpl.h"
22
23#include "Logging.h"
24
25#include <VBox/pdmdrv.h>
26#include <VBox/VBoxDev.h>
27#include <VBox/VBoxGuest.h>
28#include <VBox/shflsvc.h>
29#include <iprt/asm.h>
30
31#ifdef VBOX_HGCM
32#include "hgcm/HGCM.h"
33#include "hgcm/HGCMObjects.h"
34#endif
35
36//
37// defines
38//
39
40
41//
42// globals
43//
44
45
46/**
47 * VMMDev driver instance data.
48 */
49typedef struct DRVMAINVMMDEV
50{
51 /** Pointer to the VMMDev object. */
52 VMMDev *pVMMDev;
53 /** Pointer to the driver instance structure. */
54 PPDMDRVINS pDrvIns;
55 /** Pointer to the VMMDev port interface of the driver/device above us. */
56 PPDMIVMMDEVPORT pUpPort;
57 /** Our VMM device connector interface. */
58 PDMIVMMDEVCONNECTOR Connector;
59
60#ifdef VBOX_HGCM
61 /** Pointer to the HGCM port interface of the driver/device above us. */
62 PPDMIHGCMPORT pHGCMPort;
63 /** Our HGCM connector interface. */
64 PDMIHGCMCONNECTOR HGCMConnector;
65#endif
66} DRVMAINVMMDEV, *PDRVMAINVMMDEV;
67
68/** Converts PDMIVMMDEVCONNECTOR pointer to a DRVMAINVMMDEV pointer. */
69#define PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface) ( (PDRVMAINVMMDEV) ((uintptr_t)pInterface - RT_OFFSETOF(DRVMAINVMMDEV, Connector)) )
70
71#ifdef VBOX_HGCM
72/** Converts PDMIHGCMCONNECTOR pointer to a DRVMAINVMMDEV pointer. */
73#define PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface) ( (PDRVMAINVMMDEV) ((uintptr_t)pInterface - RT_OFFSETOF(DRVMAINVMMDEV, HGCMConnector)) )
74#endif
75
76//
77// constructor / destructor
78//
79VMMDev::VMMDev(Console *console) : mpDrv(NULL)
80{
81 mParent = console;
82 int rc = RTSemEventCreate(&mCredentialsEvent);
83 AssertRC(rc);
84#ifdef VBOX_HGCM
85 rc = HGCMHostInit ();
86 AssertRC(rc);
87#endif /* VBOX_HGCM */
88 mu32CredentialsFlags = 0;
89}
90
91VMMDev::~VMMDev()
92{
93#ifdef VBOX_HGCM
94 HGCMHostShutdown ();
95#endif /* VBOX_HGCM */
96 RTSemEventDestroy (mCredentialsEvent);
97 if (mpDrv)
98 mpDrv->pVMMDev = NULL;
99 mpDrv = NULL;
100}
101
102PPDMIVMMDEVPORT VMMDev::getVMMDevPort()
103{
104 Assert(mpDrv);
105 return mpDrv->pUpPort;
106}
107
108
109
110//
111// public methods
112//
113
114/**
115 * Wait on event semaphore for guest credential judgement result.
116 */
117int VMMDev::WaitCredentialsJudgement (uint32_t u32Timeout, uint32_t *pu32CredentialsFlags)
118{
119 if (u32Timeout == 0)
120 {
121 u32Timeout = 5000;
122 }
123
124 int rc = RTSemEventWait (mCredentialsEvent, u32Timeout);
125
126 if (VBOX_SUCCESS (rc))
127 {
128 *pu32CredentialsFlags = mu32CredentialsFlags;
129 }
130
131 return rc;
132}
133
134int VMMDev::SetCredentialsJudgementResult (uint32_t u32Flags)
135{
136 mu32CredentialsFlags = u32Flags;
137
138 int rc = RTSemEventSignal (mCredentialsEvent);
139 AssertRC(rc);
140
141 return rc;
142}
143
144
145/**
146 * Report guest OS version.
147 * Called whenever the Additions issue a guest version report request.
148 *
149 * @param pInterface Pointer to this interface.
150 * @param guestInfo Pointer to guest information structure
151 * @thread The emulation thread.
152 */
153DECLCALLBACK(void) vmmdevUpdateGuestVersion(PPDMIVMMDEVCONNECTOR pInterface, VBoxGuestInfo *guestInfo)
154{
155 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
156
157 Assert(guestInfo);
158 if (!guestInfo)
159 return;
160
161 /* store that information in IGuest */
162 Guest* guest = pDrv->pVMMDev->getParent()->getGuest();
163 Assert(guest);
164 if (!guest)
165 return;
166
167 char version[20];
168 sprintf(version, "%d", guestInfo->additionsVersion);
169 guest->setAdditionsVersion(Bstr(version));
170
171 /*
172 * Tell the console interface about the event
173 * so that it can notify its consumers.
174 */
175 pDrv->pVMMDev->getParent()->onAdditionsStateChange();
176
177 if (guestInfo->additionsVersion < VMMDEV_VERSION)
178 {
179 pDrv->pVMMDev->getParent()->onAdditionsOutdated();
180 }
181}
182
183/**
184 * Update the guest additions capabilities.
185 * This is called when the guest additions capabilities change. The new capabilities
186 * are given and the connector should update its internal state.
187 *
188 * @param pInterface Pointer to this interface.
189 * @param newCapabilities New capabilities.
190 * @thread The emulation thread.
191 */
192DECLCALLBACK(void) vmmdevUpdateGuestCapabilities(PPDMIVMMDEVCONNECTOR pInterface, uint32_t newCapabilities)
193{
194 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
195
196 /* store that information in IGuest */
197 Guest* guest = pDrv->pVMMDev->getParent()->getGuest();
198 Assert(guest);
199 if (!guest)
200 return;
201
202 Assert(!(newCapabilities & ~VMMDEV_GUEST_SUPPORTS_SEAMLESS));
203
204 guest->setSupportsSeamless(BOOL (newCapabilities & VMMDEV_GUEST_SUPPORTS_SEAMLESS));
205
206 /*
207 * Tell the console interface about the event
208 * so that it can notify its consumers.
209 */
210 pDrv->pVMMDev->getParent()->onAdditionsStateChange();
211
212}
213
214/**
215 * Update the mouse capabilities.
216 * This is called when the mouse capabilities change. The new capabilities
217 * are given and the connector should update its internal state.
218 *
219 * @param pInterface Pointer to this interface.
220 * @param newCapabilities New capabilities.
221 * @thread The emulation thread.
222 */
223DECLCALLBACK(void) vmmdevUpdateMouseCapabilities(PPDMIVMMDEVCONNECTOR pInterface, uint32_t newCapabilities)
224{
225 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
226 /*
227 * Tell the console interface about the event
228 * so that it can notify its consumers.
229 */
230 pDrv->pVMMDev->getParent()->onMouseCapabilityChange(BOOL (newCapabilities & VMMDEV_MOUSEGUESTWANTSABS),
231 BOOL (newCapabilities & VMMDEV_MOUSEGUESTNEEDSHOSTCUR));
232}
233
234
235/**
236 * Update the pointer shape or visibility.
237 *
238 * This is called when the mouse pointer shape changes or pointer is hidden/displaying.
239 * The new shape is passed as a caller allocated buffer that will be freed after returning.
240 *
241 * @param pInterface Pointer to this interface.
242 * @param fVisible Whether the pointer is visible or not.
243 * @param fAlpha Alpha channel information is present.
244 * @param xHot Horizontal coordinate of the pointer hot spot.
245 * @param yHot Vertical coordinate of the pointer hot spot.
246 * @param width Pointer width in pixels.
247 * @param height Pointer height in pixels.
248 * @param pShape The shape buffer. If NULL, then only pointer visibility is being changed.
249 * @thread The emulation thread.
250 */
251DECLCALLBACK(void) vmmdevUpdatePointerShape(PPDMIVMMDEVCONNECTOR pInterface, bool fVisible, bool fAlpha,
252 uint32_t xHot, uint32_t yHot,
253 uint32_t width, uint32_t height,
254 void *pShape)
255{
256 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
257
258 /* tell the console about it */
259 pDrv->pVMMDev->getParent()->onMousePointerShapeChange(fVisible, fAlpha,
260 xHot, yHot, width, height, pShape);
261}
262
263DECLCALLBACK(int) iface_VideoAccelEnable(PPDMIVMMDEVCONNECTOR pInterface, bool fEnable, VBVAMEMORY *pVbvaMemory)
264{
265 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
266
267 Display *display = pDrv->pVMMDev->getParent()->getDisplay();
268
269 if (display)
270 {
271 LogSunlover(("MAIN::VMMDevInterface::iface_VideoAccelEnable: %d, %p\n", fEnable, pVbvaMemory));
272 return display->VideoAccelEnable (fEnable, pVbvaMemory);
273 }
274
275 return VERR_NOT_SUPPORTED;
276}
277DECLCALLBACK(void) iface_VideoAccelFlush(PPDMIVMMDEVCONNECTOR pInterface)
278{
279 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
280
281 Display *display = pDrv->pVMMDev->getParent()->getDisplay();
282
283 if (display)
284 {
285 LogSunlover(("MAIN::VMMDevInterface::iface_VideoAccelFlush\n"));
286 display->VideoAccelFlush ();
287 }
288}
289
290DECLCALLBACK(int) vmmdevVideoModeSupported(PPDMIVMMDEVCONNECTOR pInterface, uint32_t width, uint32_t height,
291 uint32_t bpp, bool *fSupported)
292{
293 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
294
295 if (!fSupported)
296 return VERR_INVALID_PARAMETER;
297 IFramebuffer *framebuffer = pDrv->pVMMDev->getParent()->getDisplay()->getFramebuffer();
298 if (framebuffer)
299 framebuffer->VideoModeSupported(width, height, bpp, (BOOL*)fSupported);
300 else
301 *fSupported = true;
302 return VINF_SUCCESS;
303}
304
305DECLCALLBACK(int) vmmdevGetHeightReduction(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *heightReduction)
306{
307 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
308
309 if (!heightReduction)
310 return VERR_INVALID_PARAMETER;
311 IFramebuffer *framebuffer = pDrv->pVMMDev->getParent()->getDisplay()->getFramebuffer();
312 if (framebuffer)
313 framebuffer->COMGETTER(HeightReduction)((ULONG*)heightReduction);
314 else
315 *heightReduction = 0;
316 return VINF_SUCCESS;
317}
318
319DECLCALLBACK(int) vmmdevSetCredentialsJudgementResult(PPDMIVMMDEVCONNECTOR pInterface, uint32_t u32Flags)
320{
321 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
322
323 int rc = pDrv->pVMMDev->SetCredentialsJudgementResult (u32Flags);
324
325 return rc;
326}
327
328DECLCALLBACK(int) vmmdevSetVisibleRegion(PPDMIVMMDEVCONNECTOR pInterface, uint32_t cRect, PRTRECT pRect)
329{
330 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
331
332 if (!cRect)
333 return VERR_INVALID_PARAMETER;
334 IFramebuffer *framebuffer = pDrv->pVMMDev->getParent()->getDisplay()->getFramebuffer();
335 if (framebuffer)
336 framebuffer->SetVisibleRegion((BYTE *)pRect, cRect);
337
338 return VINF_SUCCESS;
339}
340
341DECLCALLBACK(int) vmmdevQueryVisibleRegion(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pcRect, PRTRECT pRect)
342{
343 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
344
345 IFramebuffer *framebuffer = pDrv->pVMMDev->getParent()->getDisplay()->getFramebuffer();
346 if (framebuffer)
347 {
348 ULONG cRect = 0;
349 framebuffer->GetVisibleRegion((BYTE *)pRect, cRect, &cRect);
350
351 *pcRect = cRect;
352 }
353
354 return VINF_SUCCESS;
355}
356
357/**
358 * Request the statistics interval
359 *
360 * @returns VBox status code.
361 * @param pInterface Pointer to this interface.
362 * @param pulInterval Pointer to interval in seconds
363 * @thread The emulation thread.
364 */
365DECLCALLBACK(int) vmmdevQueryStatisticsInterval(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pulInterval)
366{
367 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
368 ULONG val = 0;
369
370 if (!pulInterval)
371 return VERR_INVALID_POINTER;
372
373 /* store that information in IGuest */
374 Guest* guest = pDrv->pVMMDev->getParent()->getGuest();
375 Assert(guest);
376 if (!guest)
377 return VERR_INVALID_PARAMETER; /** @todo wrong error */
378
379 guest->COMGETTER(StatisticsUpdateInterval)(&val);
380 *pulInterval = val;
381 return VINF_SUCCESS;
382}
383
384/**
385 * Report new guest statistics
386 *
387 * @returns VBox status code.
388 * @param pInterface Pointer to this interface.
389 * @param pGuestStats Guest statistics
390 * @thread The emulation thread.
391 */
392DECLCALLBACK(int) vmmdevReportStatistics(PPDMIVMMDEVCONNECTOR pInterface, VBoxGuestStatistics *pGuestStats)
393{
394 PDRVMAINVMMDEV pDrv = PDMIVMMDEVCONNECTOR_2_MAINVMMDEV(pInterface);
395
396 Assert(pGuestStats);
397 if (!pGuestStats)
398 return VERR_INVALID_POINTER;
399
400 /* store that information in IGuest */
401 Guest* guest = pDrv->pVMMDev->getParent()->getGuest();
402 Assert(guest);
403 if (!guest)
404 return VERR_INVALID_PARAMETER; /** @todo wrong error */
405
406 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_CPU_LOAD)
407 guest->SetStatistic(GuestStatisticType_CPULoad, pGuestStats->u32CpuLoad);
408
409 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_THREADS)
410 guest->SetStatistic(GuestStatisticType_Threads, pGuestStats->u32Threads);
411
412 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PROCESSES)
413 guest->SetStatistic(GuestStatisticType_Processes, pGuestStats->u32Processes);
414
415 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PHYS_MEM_TOTAL)
416 guest->SetStatistic(GuestStatisticType_PhysMemTotal, pGuestStats->u32PhysMemTotal);
417
418 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PHYS_MEM_AVAIL)
419 guest->SetStatistic(GuestStatisticType_PhysMemAvailable, pGuestStats->u32PhysMemAvail);
420
421 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PHYS_MEM_BALLOON)
422 guest->SetStatistic(GuestStatisticType_PhysMemBalloon, pGuestStats->u32PhysMemBalloon);
423
424 if (pGuestStats->u32StatCaps & VBOX_GUEST_STAT_PAGE_FILE_SIZE)
425 guest->SetStatistic(GuestStatisticType_PageFileSize, pGuestStats->u32PageFileSize);
426
427 return VINF_SUCCESS;
428}
429
430/**
431 * Inflate or deflate the memory balloon
432 *
433 * @returns VBox status code.
434 * @param pInterface Pointer to this interface.
435 * @param fInflate Inflate or deflate
436 * @param cPages Number of physical pages (must be 256 as we allocate in 1 MB chunks)
437 * @param aPhysPage Array of physical page addresses
438 * @thread The emulation thread.
439 */
440DECLCALLBACK(int) vmmdevChangeMemoryBalloon(PPDMIVMMDEVCONNECTOR pInterface, bool fInflate, uint32_t cPages, RTGCPHYS *aPhysPage)
441{
442 if ( cPages != VMMDEV_MEMORY_BALLOON_CHUNK_PAGES
443 || !aPhysPage)
444 return VERR_INVALID_PARAMETER;
445
446 AssertMsgFailed(("vmmdevChangeMemoryBalloon @todo\n"));
447 return VINF_SUCCESS;
448}
449
450#ifdef VBOX_HGCM
451
452/* HGCM connector interface */
453
454static DECLCALLBACK(int) iface_hgcmConnect (PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, PHGCMSERVICELOCATION pServiceLocation, uint32_t *pu32ClientID)
455{
456 LogSunlover(("Enter\n"));
457
458 PDRVMAINVMMDEV pDrv = PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface);
459
460 if ( !pServiceLocation
461 || ( pServiceLocation->type != VMMDevHGCMLoc_LocalHost
462 && pServiceLocation->type != VMMDevHGCMLoc_LocalHost_Existing))
463 {
464 return VERR_INVALID_PARAMETER;
465 }
466
467 return HGCMGuestConnect (pDrv->pHGCMPort, pCmd, pServiceLocation->u.host.achName, pu32ClientID);
468}
469
470static DECLCALLBACK(int) iface_hgcmDisconnect (PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID)
471{
472 LogSunlover(("Enter\n"));
473
474 PDRVMAINVMMDEV pDrv = PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface);
475
476 return HGCMGuestDisconnect (pDrv->pHGCMPort, pCmd, u32ClientID);
477}
478
479static DECLCALLBACK(int) iface_hgcmCall (PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID, uint32_t u32Function,
480 uint32_t cParms, PVBOXHGCMSVCPARM paParms)
481{
482 LogSunlover(("Enter\n"));
483
484 PDRVMAINVMMDEV pDrv = PDMIHGCMCONNECTOR_2_MAINVMMDEV(pInterface);
485
486 return HGCMGuestCall (pDrv->pHGCMPort, pCmd, u32ClientID, u32Function, cParms, paParms);
487}
488
489/**
490 * Execute state save operation.
491 *
492 * @returns VBox status code.
493 * @param pDrvIns Driver instance of the driver which registered the data unit.
494 * @param pSSM SSM operation handle.
495 */
496static DECLCALLBACK(int) iface_hgcmSave(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM)
497{
498 LogSunlover(("Enter\n"));
499 return HGCMHostSaveState (pSSM);
500}
501
502
503/**
504 * Execute state load operation.
505 *
506 * @returns VBox status code.
507 * @param pDrvIns Driver instance of the driver which registered the data unit.
508 * @param pSSM SSM operation handle.
509 * @param u32Version Data layout version.
510 */
511static DECLCALLBACK(int) iface_hgcmLoad(PPDMDRVINS pDrvIns, PSSMHANDLE pSSM, uint32_t u32Version)
512{
513 LogFlowFunc(("Enter\n"));
514
515 if (u32Version != HGCM_SSM_VERSION)
516 return VERR_SSM_UNSUPPORTED_DATA_UNIT_VERSION;
517
518 return HGCMHostLoadState (pSSM);
519}
520
521int VMMDev::hgcmLoadService (const char *pszServiceName, const char *pszServiceLibrary)
522{
523 return HGCMHostLoad (pszServiceName, pszServiceLibrary);
524}
525
526int VMMDev::hgcmHostCall (const char *pszServiceName, uint32_t u32Function,
527 uint32_t cParms, PVBOXHGCMSVCPARM paParms)
528{
529 return HGCMHostCall (pszServiceName, u32Function, cParms, paParms);
530}
531#endif /* HGCM */
532
533
534/**
535 * Queries an interface to the driver.
536 *
537 * @returns Pointer to interface.
538 * @returns NULL if the interface was not supported by the driver.
539 * @param pInterface Pointer to this interface structure.
540 * @param enmInterface The requested interface identification.
541 */
542DECLCALLBACK(void *) VMMDev::drvQueryInterface(PPDMIBASE pInterface, PDMINTERFACE enmInterface)
543{
544 PPDMDRVINS pDrvIns = PDMIBASE_2_PDMDRV(pInterface);
545 PDRVMAINVMMDEV pDrv = PDMINS2DATA(pDrvIns, PDRVMAINVMMDEV);
546 switch (enmInterface)
547 {
548 case PDMINTERFACE_BASE:
549 return &pDrvIns->IBase;
550 case PDMINTERFACE_VMMDEV_CONNECTOR:
551 return &pDrv->Connector;
552#ifdef VBOX_HGCM
553 case PDMINTERFACE_HGCM_CONNECTOR:
554 return &pDrv->HGCMConnector;
555#endif
556 default:
557 return NULL;
558 }
559}
560
561/**
562 * Destruct a VMMDev driver instance.
563 *
564 * @returns VBox status.
565 * @param pDrvIns The driver instance data.
566 */
567DECLCALLBACK(void) VMMDev::drvDestruct(PPDMDRVINS pDrvIns)
568{
569 PDRVMAINVMMDEV pData = PDMINS2DATA(pDrvIns, PDRVMAINVMMDEV);
570 LogFlow(("VMMDev::drvDestruct: iInstance=%d\n", pDrvIns->iInstance));
571#ifdef VBOX_HGCM
572 /* HGCM is shut down on the VMMDev destructor. */
573#endif /* VBOX_HGCM */
574 if (pData->pVMMDev)
575 {
576 pData->pVMMDev->mpDrv = NULL;
577 }
578}
579
580/**
581 * Reset notification.
582 *
583 * @returns VBox status.
584 * @param pDrvIns The driver instance data.
585 */
586DECLCALLBACK(void) VMMDev::drvReset(PPDMDRVINS pDrvIns)
587{
588 LogFlow(("VMMDev::drvReset: iInstance=%d\n", pDrvIns->iInstance));
589#ifdef VBOX_HGCM
590 HGCMHostReset ();
591#endif /* VBOX_HGCM */
592}
593
594/**
595 * Construct a VMMDev driver instance.
596 *
597 * @returns VBox status.
598 * @param pDrvIns The driver instance data.
599 * If the registration structure is needed, pDrvIns->pDrvReg points to it.
600 * @param pCfgHandle Configuration node handle for the driver. Use this to obtain the configuration
601 * of the driver instance. It's also found in pDrvIns->pCfgHandle, but like
602 * iInstance it's expected to be used a bit in this function.
603 */
604DECLCALLBACK(int) VMMDev::drvConstruct(PPDMDRVINS pDrvIns, PCFGMNODE pCfgHandle)
605{
606 PDRVMAINVMMDEV pData = PDMINS2DATA(pDrvIns, PDRVMAINVMMDEV);
607 LogFlow(("Keyboard::drvConstruct: iInstance=%d\n", pDrvIns->iInstance));
608
609 /*
610 * Validate configuration.
611 */
612 if (!CFGMR3AreValuesValid(pCfgHandle, "Object\0OpenGLEnabled\0"))
613 return VERR_PDM_DRVINS_UNKNOWN_CFG_VALUES;
614 PPDMIBASE pBaseIgnore;
615 int rc = pDrvIns->pDrvHlp->pfnAttach(pDrvIns, &pBaseIgnore);
616 if (rc != VERR_PDM_NO_ATTACHED_DRIVER)
617 {
618 AssertMsgFailed(("Configuration error: Not possible to attach anything to this driver!\n"));
619 return VERR_PDM_DRVINS_NO_ATTACH;
620 }
621
622 /*
623 * IBase.
624 */
625 pDrvIns->IBase.pfnQueryInterface = VMMDev::drvQueryInterface;
626
627 pData->Connector.pfnUpdateGuestVersion = vmmdevUpdateGuestVersion;
628 pData->Connector.pfnUpdateGuestCapabilities = vmmdevUpdateGuestCapabilities;
629 pData->Connector.pfnUpdateMouseCapabilities = vmmdevUpdateMouseCapabilities;
630 pData->Connector.pfnUpdatePointerShape = vmmdevUpdatePointerShape;
631 pData->Connector.pfnVideoAccelEnable = iface_VideoAccelEnable;
632 pData->Connector.pfnVideoAccelFlush = iface_VideoAccelFlush;
633 pData->Connector.pfnVideoModeSupported = vmmdevVideoModeSupported;
634 pData->Connector.pfnGetHeightReduction = vmmdevGetHeightReduction;
635 pData->Connector.pfnSetCredentialsJudgementResult = vmmdevSetCredentialsJudgementResult;
636 pData->Connector.pfnSetVisibleRegion = vmmdevSetVisibleRegion;
637 pData->Connector.pfnQueryVisibleRegion = vmmdevQueryVisibleRegion;
638 pData->Connector.pfnReportStatistics = vmmdevReportStatistics;
639 pData->Connector.pfnQueryStatisticsInterval = vmmdevQueryStatisticsInterval;
640 pData->Connector.pfnChangeMemoryBalloon = vmmdevChangeMemoryBalloon;
641
642#ifdef VBOX_HGCM
643 pData->HGCMConnector.pfnConnect = iface_hgcmConnect;
644 pData->HGCMConnector.pfnDisconnect = iface_hgcmDisconnect;
645 pData->HGCMConnector.pfnCall = iface_hgcmCall;
646#endif
647
648 /*
649 * Get the IVMMDevPort interface of the above driver/device.
650 */
651 pData->pUpPort = (PPDMIVMMDEVPORT)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMINTERFACE_VMMDEV_PORT);
652 if (!pData->pUpPort)
653 {
654 AssertMsgFailed(("Configuration error: No VMMDev port interface above!\n"));
655 return VERR_PDM_MISSING_INTERFACE_ABOVE;
656 }
657
658#ifdef VBOX_HGCM
659 pData->pHGCMPort = (PPDMIHGCMPORT)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMINTERFACE_HGCM_PORT);
660 if (!pData->pHGCMPort)
661 {
662 AssertMsgFailed(("Configuration error: No HGCM port interface above!\n"));
663 return VERR_PDM_MISSING_INTERFACE_ABOVE;
664 }
665#endif
666
667 /*
668 * Get the Console object pointer and update the mpDrv member.
669 */
670 void *pv;
671 rc = CFGMR3QueryPtr(pCfgHandle, "Object", &pv);
672 if (VBOX_FAILURE(rc))
673 {
674 AssertMsgFailed(("Configuration error: No/bad \"Object\" value! rc=%Vrc\n", rc));
675 return rc;
676 }
677
678 pData->pVMMDev = (VMMDev*)pv; /** @todo Check this cast! */
679 pData->pVMMDev->mpDrv = pData;
680
681#ifdef VBOX_HGCM
682 rc = pData->pVMMDev->hgcmLoadService ("VBoxSharedFolders", "VBoxSharedFolders");
683 pData->pVMMDev->fSharedFolderActive = VBOX_SUCCESS(rc);
684 if (VBOX_SUCCESS(rc))
685 {
686 PPDMLED pLed;
687 PPDMILEDPORTS pLedPort;
688
689 LogRel(("Shared Folders service loaded.\n"));
690 pLedPort = (PPDMILEDPORTS)pDrvIns->pUpBase->pfnQueryInterface(pDrvIns->pUpBase, PDMINTERFACE_LED_PORTS);
691 if (!pLedPort)
692 {
693 AssertMsgFailed(("Configuration error: No LED port interface above!\n"));
694 return VERR_PDM_MISSING_INTERFACE_ABOVE;
695 }
696 rc = pLedPort->pfnQueryStatusLed(pLedPort, 0, &pLed);
697 if (VBOX_SUCCESS(rc) && pLed)
698 {
699 VBOXHGCMSVCPARM parm;
700
701 parm.type = VBOX_HGCM_SVC_PARM_PTR;
702 parm.u.pointer.addr = pLed;
703 parm.u.pointer.size = sizeof(*pLed);
704
705 rc = HGCMHostCall("VBoxSharedFolders", SHFL_FN_SET_STATUS_LED, 1, &parm);
706 }
707 else
708 AssertMsgFailed(("pfnQueryStatusLed failed with %Vrc (pLed=%x)\n", rc, pLed));
709 }
710 else
711 {
712 LogRel(("Failed to load Shared Folders service %Vrc\n", rc));
713 }
714
715 bool fEnabled;
716
717 /* Check CFGM option. */
718 rc = CFGMR3QueryBool(pCfgHandle, "OpenGLEnabled", &fEnabled);
719 if ( VBOX_SUCCESS(rc)
720 && fEnabled)
721 {
722 rc = pData->pVMMDev->hgcmLoadService ("VBoxSharedOpenGL", "VBoxSharedOpenGL");
723 if (VBOX_SUCCESS(rc))
724 {
725 LogRel(("Shared OpenGL service loaded.\n"));
726 }
727 else
728 {
729 LogRel(("Failed to load Shared OpenGL service %Vrc\n", rc));
730 }
731 }
732
733 pDrvIns->pDrvHlp->pfnSSMRegister(pDrvIns, "HGCM", 0, HGCM_SSM_VERSION, 4096/* bad guess */, NULL, iface_hgcmSave, NULL, NULL, iface_hgcmLoad, NULL);
734#endif /* VBOX_HGCM */
735
736 return VINF_SUCCESS;
737}
738
739
740/**
741 * VMMDevice driver registration record.
742 */
743const PDMDRVREG VMMDev::DrvReg =
744{
745 /* u32Version */
746 PDM_DRVREG_VERSION,
747 /* szDriverName */
748 "MainVMMDev",
749 /* pszDescription */
750 "Main VMMDev driver (Main as in the API).",
751 /* fFlags */
752 PDM_DRVREG_FLAGS_HOST_BITS_DEFAULT,
753 /* fClass. */
754 PDM_DRVREG_CLASS_VMMDEV,
755 /* cMaxInstances */
756 ~0,
757 /* cbInstance */
758 sizeof(DRVMAINVMMDEV),
759 /* pfnConstruct */
760 VMMDev::drvConstruct,
761 /* pfnDestruct */
762 VMMDev::drvDestruct,
763 /* pfnIOCtl */
764 NULL,
765 /* pfnPowerOn */
766 NULL,
767 /* pfnReset */
768 VMMDev::drvReset,
769 /* pfnSuspend */
770 NULL,
771 /* pfnResume */
772 NULL,
773 /* pfnDetach */
774 NULL
775};
Note: See TracBrowser for help on using the repository browser.

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