VirtualBox

source: vbox/trunk/include/VBox/vmm/pdmifs.h@ 61675

Last change on this file since 61675 was 61675, checked in by vboxsync, 8 years ago

Devices/ACPI: Notify the guest by sending a battery status change event by calling the GPE bit 0 handler. Also tell the guest to re-evaluate _BST (battery dynamic state) and _PSR (AC adapter status). I don't think that the guest needs to re-evaluate _BIF (battery info) at this time. Thanks Dennis Wassenberg / secunet!
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 94.9 KB
Line 
1/** @file
2 * PDM - Pluggable Device Manager, Interfaces.
3 */
4
5/*
6 * Copyright (C) 2006-2015 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___VBox_vmm_pdmifs_h
27#define ___VBox_vmm_pdmifs_h
28
29#include <iprt/sg.h>
30#include <VBox/types.h>
31#include <VBox/hgcmsvc.h>
32
33
34RT_C_DECLS_BEGIN
35
36/** @defgroup grp_pdm_interfaces The PDM Interface Definitions
37 * @ingroup grp_pdm
38 *
39 * For historical reasons (the PDMINTERFACE enum) a lot of interface was stuffed
40 * together in this group instead, dragging stuff into global space that didn't
41 * need to be there and making this file huge (>2500 lines). Since we're using
42 * UUIDs as interface identifiers (IIDs) now, no only generic PDM interface will
43 * be added to this file. Component specific interface should be defined in the
44 * header file of that component.
45 *
46 * Interfaces consists of a method table (typedef'ed struct) and an interface
47 * ID. The typename of the method table should have an 'I' in it, be all
48 * capitals and according to the rules, no underscores. The interface ID is a
49 * \#define constructed by appending '_IID' to the typename. The IID value is a
50 * UUID string on the form "a2299c0d-b709-4551-aa5a-73f59ffbed74". If you stick
51 * to these rules, you can make use of the PDMIBASE_QUERY_INTERFACE and
52 * PDMIBASE_RETURN_INTERFACE when querying interface and implementing
53 * PDMIBASE::pfnQueryInterface respectively.
54 *
55 * In most interface descriptions the orientation of the interface is given as
56 * 'down' or 'up'. This refers to a model with the device on the top and the
57 * drivers stacked below it. Sometimes there is mention of 'main' or 'external'
58 * which normally means the same, i.e. the Main or VBoxBFE API. Picture the
59 * orientation of 'main' as horizontal.
60 *
61 * @{
62 */
63
64
65/** @name PDMIBASE
66 * @{
67 */
68
69/**
70 * PDM Base Interface.
71 *
72 * Everyone implements this.
73 */
74typedef struct PDMIBASE
75{
76 /**
77 * Queries an interface to the driver.
78 *
79 * @returns Pointer to interface.
80 * @returns NULL if the interface was not supported by the driver.
81 * @param pInterface Pointer to this interface structure.
82 * @param pszIID The interface ID, a UUID string.
83 * @thread Any thread.
84 */
85 DECLR3CALLBACKMEMBER(void *, pfnQueryInterface,(struct PDMIBASE *pInterface, const char *pszIID));
86} PDMIBASE;
87/** PDMIBASE interface ID. */
88#define PDMIBASE_IID "a2299c0d-b709-4551-aa5a-73f59ffbed74"
89
90/**
91 * Helper macro for querying an interface from PDMIBASE.
92 *
93 * @returns Correctly typed PDMIBASE::pfnQueryInterface return value.
94 *
95 * @param pIBase Pointer to the base interface.
96 * @param InterfaceType The interface type name. The interface ID is
97 * derived from this by appending _IID.
98 */
99#define PDMIBASE_QUERY_INTERFACE(pIBase, InterfaceType) \
100 ( (InterfaceType *)(pIBase)->pfnQueryInterface(pIBase, InterfaceType##_IID ) )
101
102/**
103 * Helper macro for implementing PDMIBASE::pfnQueryInterface.
104 *
105 * Return @a pInterface if @a pszIID matches the @a InterfaceType. This will
106 * perform basic type checking.
107 *
108 * @param pszIID The ID of the interface that is being queried.
109 * @param InterfaceType The interface type name. The interface ID is
110 * derived from this by appending _IID.
111 * @param pInterface The interface address expression.
112 */
113#define PDMIBASE_RETURN_INTERFACE(pszIID, InterfaceType, pInterface) \
114 do { \
115 if (RTUuidCompare2Strs((pszIID), InterfaceType##_IID) == 0) \
116 { \
117 P##InterfaceType pReturnInterfaceTypeCheck = (pInterface); \
118 return pReturnInterfaceTypeCheck; \
119 } \
120 } while (0)
121
122/** @} */
123
124
125/** @name PDMIBASERC
126 * @{
127 */
128
129/**
130 * PDM Base Interface for querying ring-mode context interfaces in
131 * ring-3.
132 *
133 * This is mandatory for drivers present in raw-mode context.
134 */
135typedef struct PDMIBASERC
136{
137 /**
138 * Queries an ring-mode context interface to the driver.
139 *
140 * @returns Pointer to interface.
141 * @returns NULL if the interface was not supported by the driver.
142 * @param pInterface Pointer to this interface structure.
143 * @param pszIID The interface ID, a UUID string.
144 * @thread Any thread.
145 */
146 DECLR3CALLBACKMEMBER(RTRCPTR, pfnQueryInterface,(struct PDMIBASERC *pInterface, const char *pszIID));
147} PDMIBASERC;
148/** Pointer to a PDM Base Interface for query ring-mode context interfaces. */
149typedef PDMIBASERC *PPDMIBASERC;
150/** PDMIBASERC interface ID. */
151#define PDMIBASERC_IID "f6a6c649-6cb3-493f-9737-4653f221aeca"
152
153/**
154 * Helper macro for querying an interface from PDMIBASERC.
155 *
156 * @returns PDMIBASERC::pfnQueryInterface return value.
157 *
158 * @param pIBaseRC Pointer to the base raw-mode context interface. Can
159 * be NULL.
160 * @param InterfaceType The interface type base name, no trailing RC. The
161 * interface ID is derived from this by appending _IID.
162 *
163 * @remarks Unlike PDMIBASE_QUERY_INTERFACE, this macro is not able to do any
164 * implicit type checking for you.
165 */
166#define PDMIBASERC_QUERY_INTERFACE(pIBaseRC, InterfaceType) \
167 ( (P##InterfaceType##RC)((pIBaseRC) ? (pIBaseRC)->pfnQueryInterface(pIBaseRC, InterfaceType##_IID) : NIL_RTRCPTR) )
168
169/**
170 * Helper macro for implementing PDMIBASERC::pfnQueryInterface.
171 *
172 * Return @a pInterface if @a pszIID matches the @a InterfaceType. This will
173 * perform basic type checking.
174 *
175 * @param pIns Pointer to the instance data.
176 * @param pszIID The ID of the interface that is being queried.
177 * @param InterfaceType The interface type base name, no trailing RC. The
178 * interface ID is derived from this by appending _IID.
179 * @param pInterface The interface address expression. This must resolve
180 * to some address within the instance data.
181 * @remarks Don't use with PDMIBASE.
182 */
183#define PDMIBASERC_RETURN_INTERFACE(pIns, pszIID, InterfaceType, pInterface) \
184 do { \
185 Assert((uintptr_t)pInterface - PDMINS_2_DATA(pIns, uintptr_t) < _4M); \
186 if (RTUuidCompare2Strs((pszIID), InterfaceType##_IID) == 0) \
187 { \
188 InterfaceType##RC *pReturnInterfaceTypeCheck = (pInterface); \
189 return (uintptr_t)pReturnInterfaceTypeCheck \
190 - PDMINS_2_DATA(pIns, uintptr_t) \
191 + PDMINS_2_DATA_RCPTR(pIns); \
192 } \
193 } while (0)
194
195/** @} */
196
197
198/** @name PDMIBASER0
199 * @{
200 */
201
202/**
203 * PDM Base Interface for querying ring-0 interfaces in ring-3.
204 *
205 * This is mandatory for drivers present in ring-0 context.
206 */
207typedef struct PDMIBASER0
208{
209 /**
210 * Queries an ring-0 interface to the driver.
211 *
212 * @returns Pointer to interface.
213 * @returns NULL if the interface was not supported by the driver.
214 * @param pInterface Pointer to this interface structure.
215 * @param pszIID The interface ID, a UUID string.
216 * @thread Any thread.
217 */
218 DECLR3CALLBACKMEMBER(RTR0PTR, pfnQueryInterface,(struct PDMIBASER0 *pInterface, const char *pszIID));
219} PDMIBASER0;
220/** Pointer to a PDM Base Interface for query ring-0 context interfaces. */
221typedef PDMIBASER0 *PPDMIBASER0;
222/** PDMIBASER0 interface ID. */
223#define PDMIBASER0_IID "9c9b99b8-7f53-4f59-a3c2-5bc9659c7944"
224
225/**
226 * Helper macro for querying an interface from PDMIBASER0.
227 *
228 * @returns PDMIBASER0::pfnQueryInterface return value.
229 *
230 * @param pIBaseR0 Pointer to the base ring-0 interface. Can be NULL.
231 * @param InterfaceType The interface type base name, no trailing R0. The
232 * interface ID is derived from this by appending _IID.
233 *
234 * @remarks Unlike PDMIBASE_QUERY_INTERFACE, this macro is not able to do any
235 * implicit type checking for you.
236 */
237#define PDMIBASER0_QUERY_INTERFACE(pIBaseR0, InterfaceType) \
238 ( (P##InterfaceType##R0)((pIBaseR0) ? (pIBaseR0)->pfnQueryInterface(pIBaseR0, InterfaceType##_IID) : NIL_RTR0PTR) )
239
240/**
241 * Helper macro for implementing PDMIBASER0::pfnQueryInterface.
242 *
243 * Return @a pInterface if @a pszIID matches the @a InterfaceType. This will
244 * perform basic type checking.
245 *
246 * @param pIns Pointer to the instance data.
247 * @param pszIID The ID of the interface that is being queried.
248 * @param InterfaceType The interface type base name, no trailing R0. The
249 * interface ID is derived from this by appending _IID.
250 * @param pInterface The interface address expression. This must resolve
251 * to some address within the instance data.
252 * @remarks Don't use with PDMIBASE.
253 */
254#define PDMIBASER0_RETURN_INTERFACE(pIns, pszIID, InterfaceType, pInterface) \
255 do { \
256 Assert((uintptr_t)pInterface - PDMINS_2_DATA(pIns, uintptr_t) < _4M); \
257 if (RTUuidCompare2Strs((pszIID), InterfaceType##_IID) == 0) \
258 { \
259 InterfaceType##R0 *pReturnInterfaceTypeCheck = (pInterface); \
260 return (uintptr_t)pReturnInterfaceTypeCheck \
261 - PDMINS_2_DATA(pIns, uintptr_t) \
262 + PDMINS_2_DATA_R0PTR(pIns); \
263 } \
264 } while (0)
265
266/** @} */
267
268
269/**
270 * Dummy interface.
271 *
272 * This is used to typedef other dummy interfaces. The purpose of a dummy
273 * interface is to validate the logical function of a driver/device and
274 * full a natural interface pair.
275 */
276typedef struct PDMIDUMMY
277{
278 RTHCPTR pvDummy;
279} PDMIDUMMY;
280
281
282/** Pointer to a mouse port interface. */
283typedef struct PDMIMOUSEPORT *PPDMIMOUSEPORT;
284/**
285 * Mouse port interface (down).
286 * Pair with PDMIMOUSECONNECTOR.
287 */
288typedef struct PDMIMOUSEPORT
289{
290 /**
291 * Puts a mouse event.
292 *
293 * This is called by the source of mouse events. The event will be passed up
294 * until the topmost driver, which then calls the registered event handler.
295 *
296 * @returns VBox status code. Return VERR_TRY_AGAIN if you cannot process the
297 * event now and want it to be repeated at a later point.
298 *
299 * @param pInterface Pointer to this interface structure.
300 * @param dx The X delta.
301 * @param dy The Y delta.
302 * @param dz The Z delta.
303 * @param dw The W (horizontal scroll button) delta.
304 * @param fButtons The button states, see the PDMIMOUSEPORT_BUTTON_* \#defines.
305 */
306 DECLR3CALLBACKMEMBER(int, pfnPutEvent,(PPDMIMOUSEPORT pInterface,
307 int32_t dx, int32_t dy, int32_t dz,
308 int32_t dw, uint32_t fButtons));
309 /**
310 * Puts an absolute mouse event.
311 *
312 * This is called by the source of mouse events. The event will be passed up
313 * until the topmost driver, which then calls the registered event handler.
314 *
315 * @returns VBox status code. Return VERR_TRY_AGAIN if you cannot process the
316 * event now and want it to be repeated at a later point.
317 *
318 * @param pInterface Pointer to this interface structure.
319 * @param x The X value, in the range 0 to 0xffff.
320 * @param z The Y value, in the range 0 to 0xffff.
321 * @param dz The Z delta.
322 * @param dw The W (horizontal scroll button) delta.
323 * @param fButtons The button states, see the PDMIMOUSEPORT_BUTTON_* \#defines.
324 */
325 DECLR3CALLBACKMEMBER(int, pfnPutEventAbs,(PPDMIMOUSEPORT pInterface,
326 uint32_t x, uint32_t z,
327 int32_t dz, int32_t dw,
328 uint32_t fButtons));
329 /**
330 * Puts a multi-touch event.
331 *
332 * @returns VBox status code. Return VERR_TRY_AGAIN if you cannot process the
333 * event now and want it to be repeated at a later point.
334 *
335 * @param pInterface Pointer to this interface structure.
336 * @param cContacts How many touch contacts in this event.
337 * @param pau64Contacts Pointer to array of packed contact information.
338 * Each 64bit element contains:
339 * Bits 0..15: X coordinate in pixels (signed).
340 * Bits 16..31: Y coordinate in pixels (signed).
341 * Bits 32..39: contact identifier.
342 * Bit 40: "in contact" flag, which indicates that
343 * there is a contact with the touch surface.
344 * Bit 41: "in range" flag, the contact is close enough
345 * to the touch surface.
346 * All other bits are reserved for future use and must be set to 0.
347 * @param u32ScanTime Timestamp of this event in milliseconds. Only relative
348 * time between event is important.
349 */
350 DECLR3CALLBACKMEMBER(int, pfnPutEventMultiTouch,(PPDMIMOUSEPORT pInterface,
351 uint8_t cContacts,
352 const uint64_t *pau64Contacts,
353 uint32_t u32ScanTime));
354} PDMIMOUSEPORT;
355/** PDMIMOUSEPORT interface ID. */
356#define PDMIMOUSEPORT_IID "359364f0-9fa3-4490-a6b4-7ed771901c93"
357
358/** Mouse button defines for PDMIMOUSEPORT::pfnPutEvent.
359 * @{ */
360#define PDMIMOUSEPORT_BUTTON_LEFT RT_BIT(0)
361#define PDMIMOUSEPORT_BUTTON_RIGHT RT_BIT(1)
362#define PDMIMOUSEPORT_BUTTON_MIDDLE RT_BIT(2)
363#define PDMIMOUSEPORT_BUTTON_X1 RT_BIT(3)
364#define PDMIMOUSEPORT_BUTTON_X2 RT_BIT(4)
365/** @} */
366
367
368/** Pointer to a mouse connector interface. */
369typedef struct PDMIMOUSECONNECTOR *PPDMIMOUSECONNECTOR;
370/**
371 * Mouse connector interface (up).
372 * Pair with PDMIMOUSEPORT.
373 */
374typedef struct PDMIMOUSECONNECTOR
375{
376 /**
377 * Notifies the the downstream driver of changes to the reporting modes
378 * supported by the driver
379 *
380 * @param pInterface Pointer to this interface structure.
381 * @param fRelative Whether relative mode is currently supported.
382 * @param fAbsolute Whether absolute mode is currently supported.
383 * @param fAbsolute Whether multi-touch mode is currently supported.
384 */
385 DECLR3CALLBACKMEMBER(void, pfnReportModes,(PPDMIMOUSECONNECTOR pInterface, bool fRelative, bool fAbsolute, bool fMultiTouch));
386
387 /**
388 * Flushes the mouse queue if it contains pending events.
389 *
390 * @param pInterface Pointer to this interface structure.
391 */
392 DECLR3CALLBACKMEMBER(void, pfnFlushQueue,(PPDMIMOUSECONNECTOR pInterface));
393
394} PDMIMOUSECONNECTOR;
395/** PDMIMOUSECONNECTOR interface ID. */
396#define PDMIMOUSECONNECTOR_IID "ce64d7bd-fa8f-41d1-a6fb-d102a2d6bffe"
397
398
399/** Pointer to a keyboard port interface. */
400typedef struct PDMIKEYBOARDPORT *PPDMIKEYBOARDPORT;
401/**
402 * Keyboard port interface (down).
403 * Pair with PDMIKEYBOARDCONNECTOR.
404 */
405typedef struct PDMIKEYBOARDPORT
406{
407 /**
408 * Puts a scan code based keyboard event.
409 *
410 * This is called by the source of keyboard events. The event will be passed up
411 * until the topmost driver, which then calls the registered event handler.
412 *
413 * @returns VBox status code. Return VERR_TRY_AGAIN if you cannot process the
414 * event now and want it to be repeated at a later point.
415 *
416 * @param pInterface Pointer to this interface structure.
417 * @param u8ScanCode The scan code to queue.
418 */
419 DECLR3CALLBACKMEMBER(int, pfnPutEventScan,(PPDMIKEYBOARDPORT pInterface, uint8_t u8KeyCode));
420
421 /**
422 * Puts a USB HID usage ID based keyboard event.
423 *
424 * This is called by the source of keyboard events. The event will be passed up
425 * until the topmost driver, which then calls the registered event handler.
426 *
427 * @returns VBox status code. Return VERR_TRY_AGAIN if you cannot process the
428 * event now and want it to be repeated at a later point.
429 *
430 * @param pInterface Pointer to this interface structure.
431 * @param u32UsageID The HID usage code event to queue.
432 */
433 DECLR3CALLBACKMEMBER(int, pfnPutEventHid,(PPDMIKEYBOARDPORT pInterface, uint32_t u32UsageID));
434} PDMIKEYBOARDPORT;
435/** PDMIKEYBOARDPORT interface ID. */
436#define PDMIKEYBOARDPORT_IID "2a0844f0-410b-40ab-a6ed-6575f3aa3e29"
437
438
439/**
440 * Keyboard LEDs.
441 */
442typedef enum PDMKEYBLEDS
443{
444 /** No leds. */
445 PDMKEYBLEDS_NONE = 0x0000,
446 /** Num Lock */
447 PDMKEYBLEDS_NUMLOCK = 0x0001,
448 /** Caps Lock */
449 PDMKEYBLEDS_CAPSLOCK = 0x0002,
450 /** Scroll Lock */
451 PDMKEYBLEDS_SCROLLLOCK = 0x0004
452} PDMKEYBLEDS;
453
454/** Pointer to keyboard connector interface. */
455typedef struct PDMIKEYBOARDCONNECTOR *PPDMIKEYBOARDCONNECTOR;
456/**
457 * Keyboard connector interface (up).
458 * Pair with PDMIKEYBOARDPORT
459 */
460typedef struct PDMIKEYBOARDCONNECTOR
461{
462 /**
463 * Notifies the the downstream driver about an LED change initiated by the guest.
464 *
465 * @param pInterface Pointer to this interface structure.
466 * @param enmLeds The new led mask.
467 */
468 DECLR3CALLBACKMEMBER(void, pfnLedStatusChange,(PPDMIKEYBOARDCONNECTOR pInterface, PDMKEYBLEDS enmLeds));
469
470 /**
471 * Notifies the the downstream driver of changes in driver state.
472 *
473 * @param pInterface Pointer to this interface structure.
474 * @param fActive Whether interface wishes to get "focus".
475 */
476 DECLR3CALLBACKMEMBER(void, pfnSetActive,(PPDMIKEYBOARDCONNECTOR pInterface, bool fActive));
477
478 /**
479 * Flushes the keyboard queue if it contains pending events.
480 *
481 * @param pInterface Pointer to this interface structure.
482 */
483 DECLR3CALLBACKMEMBER(void, pfnFlushQueue,(PPDMIKEYBOARDCONNECTOR pInterface));
484
485} PDMIKEYBOARDCONNECTOR;
486/** PDMIKEYBOARDCONNECTOR interface ID. */
487#define PDMIKEYBOARDCONNECTOR_IID "db3f7bd5-953e-436f-9f8e-077905a92d82"
488
489
490
491/** Pointer to a display port interface. */
492typedef struct PDMIDISPLAYPORT *PPDMIDISPLAYPORT;
493/**
494 * Display port interface (down).
495 * Pair with PDMIDISPLAYCONNECTOR.
496 */
497typedef struct PDMIDISPLAYPORT
498{
499 /**
500 * Update the display with any changed regions.
501 *
502 * Flushes any display changes to the memory pointed to by the
503 * PDMIDISPLAYCONNECTOR interface and calles PDMIDISPLAYCONNECTOR::pfnUpdateRect()
504 * while doing so.
505 *
506 * @returns VBox status code.
507 * @param pInterface Pointer to this interface.
508 * @thread The emulation thread.
509 */
510 DECLR3CALLBACKMEMBER(int, pfnUpdateDisplay,(PPDMIDISPLAYPORT pInterface));
511
512 /**
513 * Update the entire display.
514 *
515 * Flushes the entire display content to the memory pointed to by the
516 * PDMIDISPLAYCONNECTOR interface and calles PDMIDISPLAYCONNECTOR::pfnUpdateRect().
517 *
518 * @returns VBox status code.
519 * @param pInterface Pointer to this interface.
520 * @param fFailOnResize Fail is a resize is pending.
521 * @thread The emulation thread.
522 */
523 DECLR3CALLBACKMEMBER(int, pfnUpdateDisplayAll,(PPDMIDISPLAYPORT pInterface, bool fFailOnResize));
524
525 /**
526 * Return the current guest resolution and color depth in bits per pixel (bpp).
527 *
528 * As the graphics card is able to provide display updates with the bpp
529 * requested by the host, this method can be used to query the actual
530 * guest color depth.
531 *
532 * @returns VBox status code.
533 * @param pInterface Pointer to this interface.
534 * @param pcBits Where to store the current guest color depth.
535 * @param pcx Where to store the horizontal resolution.
536 * @param pcy Where to store the vertical resolution.
537 * @thread Any thread.
538 */
539 DECLR3CALLBACKMEMBER(int, pfnQueryVideoMode,(PPDMIDISPLAYPORT pInterface, uint32_t *pcBits, uint32_t *pcx, uint32_t *pcy));
540
541 /**
542 * Sets the refresh rate and restart the timer.
543 * The rate is defined as the minimum interval between the return of
544 * one PDMIDISPLAYPORT::pfnRefresh() call to the next one.
545 *
546 * The interval timer will be restarted by this call. So at VM startup
547 * this function must be called to start the refresh cycle. The refresh
548 * rate is not saved, but have to be when resuming a loaded VM state.
549 *
550 * @returns VBox status code.
551 * @param pInterface Pointer to this interface.
552 * @param cMilliesInterval Number of millis between two refreshes.
553 * @thread Any thread.
554 */
555 DECLR3CALLBACKMEMBER(int, pfnSetRefreshRate,(PPDMIDISPLAYPORT pInterface, uint32_t cMilliesInterval));
556
557 /**
558 * Create a 32-bbp screenshot of the display.
559 *
560 * This will allocate and return a 32-bbp bitmap. Size of the bitmap scanline in bytes is 4*width.
561 *
562 * The allocated bitmap buffer must be freed with pfnFreeScreenshot.
563 *
564 * @param pInterface Pointer to this interface.
565 * @param ppbData Where to store the pointer to the allocated
566 * buffer.
567 * @param pcbData Where to store the actual size of the bitmap.
568 * @param pcx Where to store the width of the bitmap.
569 * @param pcy Where to store the height of the bitmap.
570 * @thread The emulation thread.
571 */
572 DECLR3CALLBACKMEMBER(int, pfnTakeScreenshot,(PPDMIDISPLAYPORT pInterface, uint8_t **ppbData, size_t *pcbData, uint32_t *pcx, uint32_t *pcy));
573
574 /**
575 * Free screenshot buffer.
576 *
577 * This will free the memory buffer allocated by pfnTakeScreenshot.
578 *
579 * @param pInterface Pointer to this interface.
580 * @param pbData Pointer to the buffer returned by
581 * pfnTakeScreenshot.
582 * @thread Any.
583 */
584 DECLR3CALLBACKMEMBER(void, pfnFreeScreenshot,(PPDMIDISPLAYPORT pInterface, uint8_t *pbData));
585
586 /**
587 * Copy bitmap to the display.
588 *
589 * This will convert and copy a 32-bbp bitmap (with dword aligned scanline length) to
590 * the memory pointed to by the PDMIDISPLAYCONNECTOR interface.
591 *
592 * @param pInterface Pointer to this interface.
593 * @param pvData Pointer to the bitmap bits.
594 * @param x The upper left corner x coordinate of the destination rectangle.
595 * @param y The upper left corner y coordinate of the destination rectangle.
596 * @param cx The width of the source and destination rectangles.
597 * @param cy The height of the source and destination rectangles.
598 * @thread The emulation thread.
599 * @remark This is just a convenience for using the bitmap conversions of the
600 * graphics device.
601 */
602 DECLR3CALLBACKMEMBER(int, pfnDisplayBlt,(PPDMIDISPLAYPORT pInterface, const void *pvData, uint32_t x, uint32_t y, uint32_t cx, uint32_t cy));
603
604 /**
605 * Render a rectangle from guest VRAM to Framebuffer.
606 *
607 * @param pInterface Pointer to this interface.
608 * @param x The upper left corner x coordinate of the rectangle to be updated.
609 * @param y The upper left corner y coordinate of the rectangle to be updated.
610 * @param cx The width of the rectangle to be updated.
611 * @param cy The height of the rectangle to be updated.
612 * @thread The emulation thread.
613 */
614 DECLR3CALLBACKMEMBER(void, pfnUpdateDisplayRect,(PPDMIDISPLAYPORT pInterface, int32_t x, int32_t y, uint32_t cx, uint32_t cy));
615
616 /**
617 * Inform the VGA device whether the Display is directly using the guest VRAM and there is no need
618 * to render the VRAM to the framebuffer memory.
619 *
620 * @param pInterface Pointer to this interface.
621 * @param fRender Whether the VRAM content must be rendered to the framebuffer.
622 * @thread The emulation thread.
623 */
624 DECLR3CALLBACKMEMBER(void, pfnSetRenderVRAM,(PPDMIDISPLAYPORT pInterface, bool fRender));
625
626 /**
627 * Render a bitmap rectangle from source to target buffer.
628 *
629 * @param pInterface Pointer to this interface.
630 * @param cx The width of the rectangle to be copied.
631 * @param cy The height of the rectangle to be copied.
632 * @param pbSrc Source frame buffer 0,0.
633 * @param xSrc The upper left corner x coordinate of the source rectangle.
634 * @param ySrc The upper left corner y coordinate of the source rectangle.
635 * @param cxSrc The width of the source frame buffer.
636 * @param cySrc The height of the source frame buffer.
637 * @param cbSrcLine The line length of the source frame buffer.
638 * @param cSrcBitsPerPixel The pixel depth of the source.
639 * @param pbDst Destination frame buffer 0,0.
640 * @param xDst The upper left corner x coordinate of the destination rectangle.
641 * @param yDst The upper left corner y coordinate of the destination rectangle.
642 * @param cxDst The width of the destination frame buffer.
643 * @param cyDst The height of the destination frame buffer.
644 * @param cbDstLine The line length of the destination frame buffer.
645 * @param cDstBitsPerPixel The pixel depth of the destination.
646 * @thread The emulation thread.
647 */
648 DECLR3CALLBACKMEMBER(int, pfnCopyRect,(PPDMIDISPLAYPORT pInterface, uint32_t cx, uint32_t cy,
649 const uint8_t *pbSrc, int32_t xSrc, int32_t ySrc, uint32_t cxSrc, uint32_t cySrc, uint32_t cbSrcLine, uint32_t cSrcBitsPerPixel,
650 uint8_t *pbDst, int32_t xDst, int32_t yDst, uint32_t cxDst, uint32_t cyDst, uint32_t cbDstLine, uint32_t cDstBitsPerPixel));
651
652 /**
653 * Inform the VGA device of viewport changes (as a result of e.g. scrolling).
654 *
655 * @param pInterface Pointer to this interface.
656 * @param idScreen The screen updates are for.
657 * @param x The upper left corner x coordinate of the new viewport rectangle
658 * @param y The upper left corner y coordinate of the new viewport rectangle
659 * @param cx The width of the new viewport rectangle
660 * @param cy The height of the new viewport rectangle
661 * @thread GUI thread?
662 *
663 * @remarks Is allowed to be NULL.
664 */
665 DECLR3CALLBACKMEMBER(void, pfnSetViewport,(PPDMIDISPLAYPORT pInterface,
666 uint32_t idScreen, uint32_t x, uint32_t y, uint32_t cx, uint32_t cy));
667
668 /**
669 * Send a video mode hint to the VGA device.
670 *
671 * @param pInterface Pointer to this interface.
672 * @param cx The X resolution.
673 * @param cy The Y resolution.
674 * @param cBPP The bit count.
675 * @param iDisplay The screen number.
676 * @param dx X offset into the virtual framebuffer or ~0.
677 * @param dy Y offset into the virtual framebuffer or ~0.
678 * @param fEnabled Is this screen currently enabled?
679 * @param fNotifyGuest Should the device send the guest an IRQ?
680 * Set for the last hint of a series.
681 * @thread Schedules on the emulation thread.
682 */
683 DECLR3CALLBACKMEMBER(int, pfnSendModeHint, (PPDMIDISPLAYPORT pInterface, uint32_t cx, uint32_t cy,
684 uint32_t cBPP, uint32_t iDisplay, uint32_t dx,
685 uint32_t dy, uint32_t fEnabled, uint32_t fNotifyGuest));
686
687 /**
688 * Send the guest a notification about host cursor capabilities changes.
689 *
690 * @param pInterface Pointer to this interface.
691 * @param fCapabilitiesAdded New supported capabilities.
692 * @param fCapabilitiesRemoved No longer supported capabilities.
693 * @thread Any.
694 */
695 DECLR3CALLBACKMEMBER(void, pfnReportHostCursorCapabilities, (PPDMIDISPLAYPORT pInterface, uint32_t fCapabilitiesAdded,
696 uint32_t fCapabilitiesRemoved));
697
698 /**
699 * Tell the graphics device about the host cursor position.
700 *
701 * @param pInterface Pointer to this interface.
702 * @param x X offset into the cursor range.
703 * @param y Y offset into the cursor range.
704 * @thread Any.
705 */
706 DECLR3CALLBACKMEMBER(void, pfnReportHostCursorPosition, (PPDMIDISPLAYPORT pInterface, uint32_t x, uint32_t y));
707} PDMIDISPLAYPORT;
708/** PDMIDISPLAYPORT interface ID. */
709#ifdef VBOX_WITH_VMSVGA
710#define PDMIDISPLAYPORT_IID "9672e2b0-1aef-4c4d-9108-864cdb28333f"
711#else
712#define PDMIDISPLAYPORT_IID "323f3412-8903-4564-b04c-cbfe0d2d1596"
713#endif
714
715
716typedef struct VBOXVHWACMD *PVBOXVHWACMD; /**< @todo r=bird: A line what it is to make doxygen happy. */
717typedef struct VBVACMDHDR *PVBVACMDHDR;
718typedef struct VBVAINFOSCREEN *PVBVAINFOSCREEN;
719typedef struct VBVAINFOVIEW *PVBVAINFOVIEW;
720typedef struct VBVAHOSTFLAGS *PVBVAHOSTFLAGS;
721struct VBOXVDMACMD_CHROMIUM_CMD; /* <- chromium [hgsmi] command */
722struct VBOXVDMACMD_CHROMIUM_CTL; /* <- chromium [hgsmi] command */
723
724
725/** Pointer to a display connector interface. */
726typedef struct PDMIDISPLAYCONNECTOR *PPDMIDISPLAYCONNECTOR;
727struct VBOXCRCMDCTL;
728typedef DECLCALLBACKPTR(void, PFNCRCTLCOMPLETION)(struct VBOXCRCMDCTL* pCmd, uint32_t cbCmd, int rc, void *pvCompletion);
729/**
730 * Display connector interface (up).
731 * Pair with PDMIDISPLAYPORT.
732 */
733typedef struct PDMIDISPLAYCONNECTOR
734{
735 /**
736 * Resize the display.
737 * This is called when the resolution changes. This usually happens on
738 * request from the guest os, but may also happen as the result of a reset.
739 * If the callback returns VINF_VGA_RESIZE_IN_PROGRESS, the caller (VGA device)
740 * must not access the connector and return.
741 *
742 * @returns VINF_SUCCESS if the framebuffer resize was completed,
743 * VINF_VGA_RESIZE_IN_PROGRESS if resize takes time and not yet finished.
744 * @param pInterface Pointer to this interface.
745 * @param cBits Color depth (bits per pixel) of the new video mode.
746 * @param pvVRAM Address of the guest VRAM.
747 * @param cbLine Size in bytes of a single scan line.
748 * @param cx New display width.
749 * @param cy New display height.
750 * @thread The emulation thread.
751 */
752 DECLR3CALLBACKMEMBER(int, pfnResize,(PPDMIDISPLAYCONNECTOR pInterface, uint32_t cBits, void *pvVRAM, uint32_t cbLine,
753 uint32_t cx, uint32_t cy));
754
755 /**
756 * Update a rectangle of the display.
757 * PDMIDISPLAYPORT::pfnUpdateDisplay is the caller.
758 *
759 * @param pInterface Pointer to this interface.
760 * @param x The upper left corner x coordinate of the rectangle.
761 * @param y The upper left corner y coordinate of the rectangle.
762 * @param cx The width of the rectangle.
763 * @param cy The height of the rectangle.
764 * @thread The emulation thread.
765 */
766 DECLR3CALLBACKMEMBER(void, pfnUpdateRect,(PPDMIDISPLAYCONNECTOR pInterface, uint32_t x, uint32_t y, uint32_t cx, uint32_t cy));
767
768 /**
769 * Refresh the display.
770 *
771 * The interval between these calls is set by
772 * PDMIDISPLAYPORT::pfnSetRefreshRate(). The driver should call
773 * PDMIDISPLAYPORT::pfnUpdateDisplay() if it wishes to refresh the
774 * display. PDMIDISPLAYPORT::pfnUpdateDisplay calls pfnUpdateRect with
775 * the changed rectangles.
776 *
777 * @param pInterface Pointer to this interface.
778 * @thread The emulation thread.
779 */
780 DECLR3CALLBACKMEMBER(void, pfnRefresh,(PPDMIDISPLAYCONNECTOR pInterface));
781
782 /**
783 * Reset the display.
784 *
785 * Notification message when the graphics card has been reset.
786 *
787 * @param pInterface Pointer to this interface.
788 * @thread The emulation thread.
789 */
790 DECLR3CALLBACKMEMBER(void, pfnReset,(PPDMIDISPLAYCONNECTOR pInterface));
791
792 /**
793 * LFB video mode enter/exit.
794 *
795 * Notification message when LinearFrameBuffer video mode is enabled/disabled.
796 *
797 * @param pInterface Pointer to this interface.
798 * @param fEnabled false - LFB mode was disabled,
799 * true - an LFB mode was disabled
800 * @thread The emulation thread.
801 */
802 DECLR3CALLBACKMEMBER(void, pfnLFBModeChange,(PPDMIDISPLAYCONNECTOR pInterface, bool fEnabled));
803
804 /**
805 * Process the guest graphics adapter information.
806 *
807 * Direct notification from guest to the display connector.
808 *
809 * @param pInterface Pointer to this interface.
810 * @param pvVRAM Address of the guest VRAM.
811 * @param u32VRAMSize Size of the guest VRAM.
812 * @thread The emulation thread.
813 */
814 DECLR3CALLBACKMEMBER(void, pfnProcessAdapterData,(PPDMIDISPLAYCONNECTOR pInterface, void *pvVRAM, uint32_t u32VRAMSize));
815
816 /**
817 * Process the guest display information.
818 *
819 * Direct notification from guest to the display connector.
820 *
821 * @param pInterface Pointer to this interface.
822 * @param pvVRAM Address of the guest VRAM.
823 * @param uScreenId The index of the guest display to be processed.
824 * @thread The emulation thread.
825 */
826 DECLR3CALLBACKMEMBER(void, pfnProcessDisplayData,(PPDMIDISPLAYCONNECTOR pInterface, void *pvVRAM, unsigned uScreenId));
827
828 /**
829 * Process the guest Video HW Acceleration command.
830 *
831 * @param pInterface Pointer to this interface.
832 * @param pCmd Video HW Acceleration Command to be processed.
833 * @returns VINF_SUCCESS - command is completed,
834 * VINF_CALLBACK_RETURN - command will by asynchronously completed via complete callback
835 * VERR_INVALID_STATE - the command could not be processed (most likely because the framebuffer was disconnected) - the post should be retried later
836 * @thread The emulation thread.
837 */
838 DECLR3CALLBACKMEMBER(int, pfnVHWACommandProcess,(PPDMIDISPLAYCONNECTOR pInterface, PVBOXVHWACMD pCmd));
839
840 /**
841 * Process the guest chromium command.
842 *
843 * @param pInterface Pointer to this interface.
844 * @param pCmd Video HW Acceleration Command to be processed.
845 * @thread The emulation thread.
846 */
847 DECLR3CALLBACKMEMBER(void, pfnCrHgsmiCommandProcess,(PPDMIDISPLAYCONNECTOR pInterface, struct VBOXVDMACMD_CHROMIUM_CMD* pCmd, uint32_t cbCmd));
848
849 /**
850 * Process the guest chromium control command.
851 *
852 * @param pInterface Pointer to this interface.
853 * @param pCmd Video HW Acceleration Command to be processed.
854 * @thread The emulation thread.
855 */
856 DECLR3CALLBACKMEMBER(void, pfnCrHgsmiControlProcess,(PPDMIDISPLAYCONNECTOR pInterface, struct VBOXVDMACMD_CHROMIUM_CTL* pCtl, uint32_t cbCtl));
857
858 /**
859 * Process the guest chromium control command.
860 *
861 * @param pInterface Pointer to this interface.
862 * @param pCmd Video HW Acceleration Command to be processed.
863 * @param cbCmd Undocumented!
864 * @param pfnCompletion Undocumented!
865 * @param pvCompletion Undocumented!
866 * @thread The emulation thread.
867 */
868 DECLR3CALLBACKMEMBER(int, pfnCrHgcmCtlSubmit,(PPDMIDISPLAYCONNECTOR pInterface, struct VBOXCRCMDCTL *pCmd, uint32_t cbCmd,
869 PFNCRCTLCOMPLETION pfnCompletion, void *pvCompletion));
870
871 /**
872 * The specified screen enters VBVA mode.
873 *
874 * @param pInterface Pointer to this interface.
875 * @param uScreenId The screen updates are for.
876 * @param pHostFlags Undocumented!
877 * @param fRenderThreadMode if true - the graphics device has a separate thread that does all rendering.
878 * This means that:
879 * 1. most pfnVBVAXxx callbacks (see the individual documentation for each one)
880 * will be called in the context of the render thread rather than the emulation thread
881 * 2. PDMIDISPLAYCONNECTOR implementor (i.e. DisplayImpl) must NOT notify crogl backend
882 * about vbva-originated events (e.g. resize), because crogl is working in CrCmd mode,
883 * in the context of the render thread as part of the Graphics device, and gets notified about those events directly
884 * @thread if fRenderThreadMode is TRUE - the render thread, otherwise - the emulation thread.
885 */
886 DECLR3CALLBACKMEMBER(int, pfnVBVAEnable,(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId,
887 PVBVAHOSTFLAGS pHostFlags, bool fRenderThreadMode));
888
889 /**
890 * The specified screen leaves VBVA mode.
891 *
892 * @param pInterface Pointer to this interface.
893 * @param uScreenId The screen updates are for.
894 * @thread if render thread mode is on (fRenderThreadMode that was passed to pfnVBVAEnable is TRUE) - the render thread pfnVBVAEnable was called in,
895 * otherwise - the emulation thread.
896 */
897 DECLR3CALLBACKMEMBER(void, pfnVBVADisable,(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId));
898
899 /**
900 * A sequence of pfnVBVAUpdateProcess calls begins.
901 *
902 * @param pInterface Pointer to this interface.
903 * @param uScreenId The screen updates are for.
904 * @thread if render thread mode is on (fRenderThreadMode that was passed to pfnVBVAEnable is TRUE) - the render thread pfnVBVAEnable was called in,
905 * otherwise - the emulation thread.
906 */
907 DECLR3CALLBACKMEMBER(void, pfnVBVAUpdateBegin,(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId));
908
909 /**
910 * Process the guest VBVA command.
911 *
912 * @param pInterface Pointer to this interface.
913 * @param uScreenId The screen updates are for.
914 * @param pCmd Video HW Acceleration Command to be processed.
915 * @param cbCmd Undocumented!
916 * @thread if render thread mode is on (fRenderThreadMode that was passed to pfnVBVAEnable is TRUE) - the render thread pfnVBVAEnable was called in,
917 * otherwise - the emulation thread.
918 */
919 DECLR3CALLBACKMEMBER(void, pfnVBVAUpdateProcess,(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId,
920 const PVBVACMDHDR pCmd, size_t cbCmd));
921
922 /**
923 * A sequence of pfnVBVAUpdateProcess calls ends.
924 *
925 * @param pInterface Pointer to this interface.
926 * @param uScreenId The screen updates are for.
927 * @param x The upper left corner x coordinate of the combined rectangle of all VBVA updates.
928 * @param y The upper left corner y coordinate of the rectangle.
929 * @param cx The width of the rectangle.
930 * @param cy The height of the rectangle.
931 * @thread if render thread mode is on (fRenderThreadMode that was passed to pfnVBVAEnable is TRUE) - the render thread pfnVBVAEnable was called in,
932 * otherwise - the emulation thread.
933 */
934 DECLR3CALLBACKMEMBER(void, pfnVBVAUpdateEnd,(PPDMIDISPLAYCONNECTOR pInterface, unsigned uScreenId, int32_t x, int32_t y, uint32_t cx, uint32_t cy));
935
936 /**
937 * Resize the display.
938 * This is called when the resolution changes. This usually happens on
939 * request from the guest os, but may also happen as the result of a reset.
940 * If the callback returns VINF_VGA_RESIZE_IN_PROGRESS, the caller (VGA device)
941 * must not access the connector and return.
942 *
943 * @todo Merge with pfnResize.
944 *
945 * @returns VINF_SUCCESS if the framebuffer resize was completed,
946 * VINF_VGA_RESIZE_IN_PROGRESS if resize takes time and not yet finished.
947 * @param pInterface Pointer to this interface.
948 * @param pView The description of VRAM block for this screen.
949 * @param pScreen The data of screen being resized.
950 * @param pvVRAM Address of the guest VRAM.
951 * @param fResetInputMapping Whether to reset the absolute pointing device to screen position co-ordinate
952 * mapping. Needed for real resizes, as the caller on the guest may not know how
953 * to set the mapping. Not wanted when we restore a saved state and are resetting
954 * the mode.
955 * @thread if render thread mode is on (fRenderThreadMode that was passed to pfnVBVAEnable is TRUE) - the render thread pfnVBVAEnable was called in,
956 * otherwise - the emulation thread.
957 */
958 DECLR3CALLBACKMEMBER(int, pfnVBVAResize,(PPDMIDISPLAYCONNECTOR pInterface, const PVBVAINFOVIEW pView, const PVBVAINFOSCREEN pScreen, void *pvVRAM, bool fResetInputMapping));
959
960 /**
961 * Update the pointer shape.
962 * This is called when the mouse pointer shape changes. The new shape
963 * is passed as a caller allocated buffer that will be freed after returning
964 *
965 * @param pInterface Pointer to this interface.
966 * @param fVisible Visibility indicator (if false, the other parameters are undefined).
967 * @param fAlpha Flag whether alpha channel is being passed.
968 * @param xHot Pointer hot spot x coordinate.
969 * @param yHot Pointer hot spot y coordinate.
970 * @param x Pointer new x coordinate on screen.
971 * @param y Pointer new y coordinate on screen.
972 * @param cx Pointer width in pixels.
973 * @param cy Pointer height in pixels.
974 * @param cbScanline Size of one scanline in bytes.
975 * @param pvShape New shape buffer.
976 * @thread The emulation thread.
977 */
978 DECLR3CALLBACKMEMBER(int, pfnVBVAMousePointerShape,(PPDMIDISPLAYCONNECTOR pInterface, bool fVisible, bool fAlpha,
979 uint32_t xHot, uint32_t yHot, uint32_t cx, uint32_t cy,
980 const void *pvShape));
981
982 /**
983 * The guest capabilities were updated.
984 *
985 * @param pInterface Pointer to this interface.
986 * @param fCapabilities The new capability flag state.
987 * @thread The emulation thread.
988 */
989 DECLR3CALLBACKMEMBER(void, pfnVBVAGuestCapabilityUpdate,(PPDMIDISPLAYCONNECTOR pInterface, uint32_t fCapabilities));
990
991 /** Read-only attributes.
992 * For preformance reasons some readonly attributes are kept in the interface.
993 * We trust the interface users to respect the readonlyness of these.
994 * @{
995 */
996 /** Pointer to the display data buffer. */
997 uint8_t *pbData;
998 /** Size of a scanline in the data buffer. */
999 uint32_t cbScanline;
1000 /** The color depth (in bits) the graphics card is supposed to provide. */
1001 uint32_t cBits;
1002 /** The display width. */
1003 uint32_t cx;
1004 /** The display height. */
1005 uint32_t cy;
1006 /** @} */
1007
1008 /**
1009 * The guest display input mapping rectangle was updated.
1010 *
1011 * @param pInterface Pointer to this interface.
1012 * @param xOrigin Upper left X co-ordinate relative to the first screen.
1013 * @param yOrigin Upper left Y co-ordinate relative to the first screen.
1014 * @param cx Rectangle width.
1015 * @param cy Rectangle height.
1016 * @thread The emulation thread.
1017 */
1018 DECLR3CALLBACKMEMBER(void, pfnVBVAInputMappingUpdate,(PPDMIDISPLAYCONNECTOR pInterface, int32_t xOrigin, int32_t yOrigin, uint32_t cx, uint32_t cy));
1019} PDMIDISPLAYCONNECTOR;
1020/** PDMIDISPLAYCONNECTOR interface ID. */
1021#define PDMIDISPLAYCONNECTOR_IID "e883a720-85fb-11e4-a307-0b06689c9661"
1022
1023
1024/** Pointer to a secret key interface. */
1025typedef struct PDMISECKEY *PPDMISECKEY;
1026
1027/**
1028 * Secret key interface to retrieve secret keys.
1029 */
1030typedef struct PDMISECKEY
1031{
1032 /**
1033 * Retains a key identified by the ID. The caller will only hold a reference
1034 * to the key and must not modify the key buffer in any way.
1035 *
1036 * @returns VBox status code.
1037 * @param pInterface Pointer to this interface.
1038 * @param pszId The alias/id for the key to retrieve.
1039 * @param ppbKey Where to store the pointer to the key buffer on success.
1040 * @param pcbKey Where to store the size of the key in bytes on success.
1041 */
1042 DECLR3CALLBACKMEMBER(int, pfnKeyRetain, (PPDMISECKEY pInterface, const char *pszId,
1043 const uint8_t **pbKey, size_t *pcbKey));
1044
1045 /**
1046 * Releases one reference of the key identified by the given identifier.
1047 * The caller must not access the key buffer after calling this operation.
1048 *
1049 * @returns VBox status code.
1050 * @param pInterface Pointer to this interface.
1051 * @param pszId The alias/id for the key to release.
1052 *
1053 * @note: It is advised to release the key whenever it is not used anymore so the entity
1054 * storing the key can do anything to make retrieving the key from memory more
1055 * difficult like scrambling the memory buffer for instance.
1056 */
1057 DECLR3CALLBACKMEMBER(int, pfnKeyRelease, (PPDMISECKEY pInterface, const char *pszId));
1058
1059 /**
1060 * Retains a password identified by the ID. The caller will only hold a reference
1061 * to the password and must not modify the buffer in any way.
1062 *
1063 * @returns VBox status code.
1064 * @param pInterface Pointer to this interface.
1065 * @param pszId The alias/id for the password to retrieve.
1066 * @param ppszPassword Where to store the pointer to the password on success.
1067 */
1068 DECLR3CALLBACKMEMBER(int, pfnPasswordRetain, (PPDMISECKEY pInterface, const char *pszId,
1069 const char **ppszPassword));
1070
1071 /**
1072 * Releases one reference of the password identified by the given identifier.
1073 * The caller must not access the password after calling this operation.
1074 *
1075 * @returns VBox status code.
1076 * @param pInterface Pointer to this interface.
1077 * @param pszId The alias/id for the password to release.
1078 *
1079 * @note: It is advised to release the password whenever it is not used anymore so the entity
1080 * storing the password can do anything to make retrieving the password from memory more
1081 * difficult like scrambling the memory buffer for instance.
1082 */
1083 DECLR3CALLBACKMEMBER(int, pfnPasswordRelease, (PPDMISECKEY pInterface, const char *pszId));
1084} PDMISECKEY;
1085/** PDMISECKEY interface ID. */
1086#define PDMISECKEY_IID "3d698355-d995-453d-960f-31566a891df2"
1087
1088/** Pointer to a secret key helper interface. */
1089typedef struct PDMISECKEYHLP *PPDMISECKEYHLP;
1090
1091/**
1092 * Secret key helper interface for non critical functionality.
1093 */
1094typedef struct PDMISECKEYHLP
1095{
1096 /**
1097 * Notifies the interface provider that a key couldn't be retrieved from the key store.
1098 *
1099 * @returns VBox status code.
1100 * @param pInterface Pointer to this interface.
1101 */
1102 DECLR3CALLBACKMEMBER(int, pfnKeyMissingNotify, (PPDMISECKEYHLP pInterface));
1103
1104} PDMISECKEYHLP;
1105/** PDMISECKEY interface ID. */
1106#define PDMISECKEYHLP_IID "7be96168-4156-40ac-86d2-3073bf8b318e"
1107
1108
1109/** Pointer to a char port interface. */
1110typedef struct PDMICHARPORT *PPDMICHARPORT;
1111/**
1112 * Char port interface (down).
1113 * Pair with PDMICHARCONNECTOR.
1114 */
1115typedef struct PDMICHARPORT
1116{
1117 /**
1118 * Deliver data read to the device/driver.
1119 *
1120 * @returns VBox status code.
1121 * @param pInterface Pointer to the interface structure containing the called function pointer.
1122 * @param pvBuf Where the read bits are stored.
1123 * @param pcbRead Number of bytes available for reading/having been read.
1124 * @thread Any thread.
1125 */
1126 DECLR3CALLBACKMEMBER(int, pfnNotifyRead,(PPDMICHARPORT pInterface, const void *pvBuf, size_t *pcbRead));
1127
1128 /**
1129 * Notify the device/driver when the status lines changed.
1130 *
1131 * @returns VBox status code.
1132 * @param pInterface Pointer to the interface structure containing the called function pointer.
1133 * @param fNewStatusLine New state of the status line pins.
1134 * @thread Any thread.
1135 */
1136 DECLR3CALLBACKMEMBER(int, pfnNotifyStatusLinesChanged,(PPDMICHARPORT pInterface, uint32_t fNewStatusLines));
1137
1138 /**
1139 * Notify the device when the driver buffer is full.
1140 *
1141 * @returns VBox status code.
1142 * @param pInterface Pointer to the interface structure containing the called function pointer.
1143 * @param fFull Buffer full.
1144 * @thread Any thread.
1145 */
1146 DECLR3CALLBACKMEMBER(int, pfnNotifyBufferFull,(PPDMICHARPORT pInterface, bool fFull));
1147
1148 /**
1149 * Notify the device/driver that a break occurred.
1150 *
1151 * @returns VBox statsus code.
1152 * @param pInterface Pointer to the interface structure containing the called function pointer.
1153 * @thread Any thread.
1154 */
1155 DECLR3CALLBACKMEMBER(int, pfnNotifyBreak,(PPDMICHARPORT pInterface));
1156} PDMICHARPORT;
1157/** PDMICHARPORT interface ID. */
1158#define PDMICHARPORT_IID "22769834-ea8b-4a6d-ade1-213dcdbd1228"
1159
1160/** @name Bit mask definitions for status line type.
1161 * @{ */
1162#define PDMICHARPORT_STATUS_LINES_DCD RT_BIT(0)
1163#define PDMICHARPORT_STATUS_LINES_RI RT_BIT(1)
1164#define PDMICHARPORT_STATUS_LINES_DSR RT_BIT(2)
1165#define PDMICHARPORT_STATUS_LINES_CTS RT_BIT(3)
1166/** @} */
1167
1168
1169/** Pointer to a char interface. */
1170typedef struct PDMICHARCONNECTOR *PPDMICHARCONNECTOR;
1171/**
1172 * Char connector interface (up).
1173 * Pair with PDMICHARPORT.
1174 */
1175typedef struct PDMICHARCONNECTOR
1176{
1177 /**
1178 * Write bits.
1179 *
1180 * @returns VBox status code.
1181 * @param pInterface Pointer to the interface structure containing the called function pointer.
1182 * @param pvBuf Where to store the write bits.
1183 * @param cbWrite Number of bytes to write.
1184 * @thread Any thread.
1185 */
1186 DECLR3CALLBACKMEMBER(int, pfnWrite,(PPDMICHARCONNECTOR pInterface, const void *pvBuf, size_t cbWrite));
1187
1188 /**
1189 * Set device parameters.
1190 *
1191 * @returns VBox status code.
1192 * @param pInterface Pointer to the interface structure containing the called function pointer.
1193 * @param Bps Speed of the serial connection. (bits per second)
1194 * @param chParity Parity method: 'E' - even, 'O' - odd, 'N' - none.
1195 * @param cDataBits Number of data bits.
1196 * @param cStopBits Number of stop bits.
1197 * @thread Any thread.
1198 */
1199 DECLR3CALLBACKMEMBER(int, pfnSetParameters,(PPDMICHARCONNECTOR pInterface, unsigned Bps, char chParity, unsigned cDataBits, unsigned cStopBits));
1200
1201 /**
1202 * Set the state of the modem lines.
1203 *
1204 * @returns VBox status code.
1205 * @param pInterface Pointer to the interface structure containing the called function pointer.
1206 * @param fRequestToSend Set to true to make the Request to Send line active otherwise to 0.
1207 * @param fDataTerminalReady Set to true to make the Data Terminal Ready line active otherwise 0.
1208 * @thread Any thread.
1209 */
1210 DECLR3CALLBACKMEMBER(int, pfnSetModemLines,(PPDMICHARCONNECTOR pInterface, bool fRequestToSend, bool fDataTerminalReady));
1211
1212 /**
1213 * Sets the TD line into break condition.
1214 *
1215 * @returns VBox status code.
1216 * @param pInterface Pointer to the interface structure containing the called function pointer.
1217 * @param fBreak Set to true to let the device send a break false to put into normal operation.
1218 * @thread Any thread.
1219 */
1220 DECLR3CALLBACKMEMBER(int, pfnSetBreak,(PPDMICHARCONNECTOR pInterface, bool fBreak));
1221} PDMICHARCONNECTOR;
1222/** PDMICHARCONNECTOR interface ID. */
1223#define PDMICHARCONNECTOR_IID "4ad5c190-b408-4cef-926f-fbffce0dc5cc"
1224
1225
1226/** Pointer to a stream interface. */
1227typedef struct PDMISTREAM *PPDMISTREAM;
1228/**
1229 * Stream interface (up).
1230 * Makes up the foundation for PDMICHARCONNECTOR. No pair interface.
1231 */
1232typedef struct PDMISTREAM
1233{
1234 /**
1235 * Read bits.
1236 *
1237 * @returns VBox status code.
1238 * @param pInterface Pointer to the interface structure containing the called function pointer.
1239 * @param pvBuf Where to store the read bits.
1240 * @param cbRead Number of bytes to read/bytes actually read.
1241 * @thread Any thread.
1242 */
1243 DECLR3CALLBACKMEMBER(int, pfnRead,(PPDMISTREAM pInterface, void *pvBuf, size_t *cbRead));
1244
1245 /**
1246 * Write bits.
1247 *
1248 * @returns VBox status code.
1249 * @param pInterface Pointer to the interface structure containing the called function pointer.
1250 * @param pvBuf Where to store the write bits.
1251 * @param cbWrite Number of bytes to write/bytes actually written.
1252 * @thread Any thread.
1253 */
1254 DECLR3CALLBACKMEMBER(int, pfnWrite,(PPDMISTREAM pInterface, const void *pvBuf, size_t *cbWrite));
1255} PDMISTREAM;
1256/** PDMISTREAM interface ID. */
1257#define PDMISTREAM_IID "d1a5bf5e-3d2c-449a-bde9-addd7920b71f"
1258
1259
1260/** Mode of the parallel port */
1261typedef enum PDMPARALLELPORTMODE
1262{
1263 /** First invalid mode. */
1264 PDM_PARALLEL_PORT_MODE_INVALID = 0,
1265 /** SPP (Compatibility mode). */
1266 PDM_PARALLEL_PORT_MODE_SPP,
1267 /** EPP Data mode. */
1268 PDM_PARALLEL_PORT_MODE_EPP_DATA,
1269 /** EPP Address mode. */
1270 PDM_PARALLEL_PORT_MODE_EPP_ADDR,
1271 /** ECP mode (not implemented yet). */
1272 PDM_PARALLEL_PORT_MODE_ECP,
1273 /** 32bit hack. */
1274 PDM_PARALLEL_PORT_MODE_32BIT_HACK = 0x7fffffff
1275} PDMPARALLELPORTMODE;
1276
1277/** Pointer to a host parallel port interface. */
1278typedef struct PDMIHOSTPARALLELPORT *PPDMIHOSTPARALLELPORT;
1279/**
1280 * Host parallel port interface (down).
1281 * Pair with PDMIHOSTPARALLELCONNECTOR.
1282 */
1283typedef struct PDMIHOSTPARALLELPORT
1284{
1285 /**
1286 * Notify device/driver that an interrupt has occurred.
1287 *
1288 * @returns VBox status code.
1289 * @param pInterface Pointer to the interface structure containing the called function pointer.
1290 * @thread Any thread.
1291 */
1292 DECLR3CALLBACKMEMBER(int, pfnNotifyInterrupt,(PPDMIHOSTPARALLELPORT pInterface));
1293} PDMIHOSTPARALLELPORT;
1294/** PDMIHOSTPARALLELPORT interface ID. */
1295#define PDMIHOSTPARALLELPORT_IID "f24b8668-e7f6-4eaa-a14c-4aa2a5f7048e"
1296
1297
1298
1299/** Pointer to a Host Parallel connector interface. */
1300typedef struct PDMIHOSTPARALLELCONNECTOR *PPDMIHOSTPARALLELCONNECTOR;
1301/**
1302 * Host parallel connector interface (up).
1303 * Pair with PDMIHOSTPARALLELPORT.
1304 */
1305typedef struct PDMIHOSTPARALLELCONNECTOR
1306{
1307 /**
1308 * Write bits.
1309 *
1310 * @returns VBox status code.
1311 * @param pInterface Pointer to the interface structure containing the called function pointer.
1312 * @param pvBuf Where to store the write bits.
1313 * @param cbWrite Number of bytes to write.
1314 * @param enmMode Mode to write the data.
1315 * @thread Any thread.
1316 * @todo r=klaus cbWrite only defines buffer length, method needs a way top return actually written amount of data.
1317 */
1318 DECLR3CALLBACKMEMBER(int, pfnWrite,(PPDMIHOSTPARALLELCONNECTOR pInterface, const void *pvBuf,
1319 size_t cbWrite, PDMPARALLELPORTMODE enmMode));
1320
1321 /**
1322 * Read bits.
1323 *
1324 * @returns VBox status code.
1325 * @param pInterface Pointer to the interface structure containing the called function pointer.
1326 * @param pvBuf Where to store the read bits.
1327 * @param cbRead Number of bytes to read.
1328 * @param enmMode Mode to read the data.
1329 * @thread Any thread.
1330 * @todo r=klaus cbRead only defines buffer length, method needs a way top return actually read amount of data.
1331 */
1332 DECLR3CALLBACKMEMBER(int, pfnRead,(PPDMIHOSTPARALLELCONNECTOR pInterface, void *pvBuf,
1333 size_t cbRead, PDMPARALLELPORTMODE enmMode));
1334
1335 /**
1336 * Set data direction of the port (forward/reverse).
1337 *
1338 * @returns VBox status code.
1339 * @param pInterface Pointer to the interface structure containing the called function pointer.
1340 * @param fForward Flag whether to indicate whether the port is operated in forward or reverse mode.
1341 * @thread Any thread.
1342 */
1343 DECLR3CALLBACKMEMBER(int, pfnSetPortDirection,(PPDMIHOSTPARALLELCONNECTOR pInterface, bool fForward));
1344
1345 /**
1346 * Write control register bits.
1347 *
1348 * @returns VBox status code.
1349 * @param pInterface Pointer to the interface structure containing the called function pointer.
1350 * @param fReg The new control register value.
1351 * @thread Any thread.
1352 */
1353 DECLR3CALLBACKMEMBER(int, pfnWriteControl,(PPDMIHOSTPARALLELCONNECTOR pInterface, uint8_t fReg));
1354
1355 /**
1356 * Read control register bits.
1357 *
1358 * @returns VBox status code.
1359 * @param pInterface Pointer to the interface structure containing the called function pointer.
1360 * @param pfReg Where to store the control register bits.
1361 * @thread Any thread.
1362 */
1363 DECLR3CALLBACKMEMBER(int, pfnReadControl,(PPDMIHOSTPARALLELCONNECTOR pInterface, uint8_t *pfReg));
1364
1365 /**
1366 * Read status register bits.
1367 *
1368 * @returns VBox status code.
1369 * @param pInterface Pointer to the interface structure containing the called function pointer.
1370 * @param pfReg Where to store the status register bits.
1371 * @thread Any thread.
1372 */
1373 DECLR3CALLBACKMEMBER(int, pfnReadStatus,(PPDMIHOSTPARALLELCONNECTOR pInterface, uint8_t *pfReg));
1374
1375} PDMIHOSTPARALLELCONNECTOR;
1376/** PDMIHOSTPARALLELCONNECTOR interface ID. */
1377#define PDMIHOSTPARALLELCONNECTOR_IID "7c532602-7438-4fbc-9265-349d9f0415f9"
1378
1379
1380/** ACPI power source identifier */
1381typedef enum PDMACPIPOWERSOURCE
1382{
1383 PDM_ACPI_POWER_SOURCE_UNKNOWN = 0,
1384 PDM_ACPI_POWER_SOURCE_OUTLET,
1385 PDM_ACPI_POWER_SOURCE_BATTERY
1386} PDMACPIPOWERSOURCE;
1387/** Pointer to ACPI battery state. */
1388typedef PDMACPIPOWERSOURCE *PPDMACPIPOWERSOURCE;
1389
1390/** ACPI battey capacity */
1391typedef enum PDMACPIBATCAPACITY
1392{
1393 PDM_ACPI_BAT_CAPACITY_MIN = 0,
1394 PDM_ACPI_BAT_CAPACITY_MAX = 100,
1395 PDM_ACPI_BAT_CAPACITY_UNKNOWN = 255
1396} PDMACPIBATCAPACITY;
1397/** Pointer to ACPI battery capacity. */
1398typedef PDMACPIBATCAPACITY *PPDMACPIBATCAPACITY;
1399
1400/** ACPI battery state. See ACPI 3.0 spec '_BST (Battery Status)' */
1401typedef enum PDMACPIBATSTATE
1402{
1403 PDM_ACPI_BAT_STATE_CHARGED = 0x00,
1404 PDM_ACPI_BAT_STATE_DISCHARGING = 0x01,
1405 PDM_ACPI_BAT_STATE_CHARGING = 0x02,
1406 PDM_ACPI_BAT_STATE_CRITICAL = 0x04
1407} PDMACPIBATSTATE;
1408/** Pointer to ACPI battery state. */
1409typedef PDMACPIBATSTATE *PPDMACPIBATSTATE;
1410
1411/** Pointer to an ACPI port interface. */
1412typedef struct PDMIACPIPORT *PPDMIACPIPORT;
1413/**
1414 * ACPI port interface (down). Used by both the ACPI driver and (grumble) main.
1415 * Pair with PDMIACPICONNECTOR.
1416 */
1417typedef struct PDMIACPIPORT
1418{
1419 /**
1420 * Send an ACPI power off event.
1421 *
1422 * @returns VBox status code
1423 * @param pInterface Pointer to the interface structure containing the called function pointer.
1424 */
1425 DECLR3CALLBACKMEMBER(int, pfnPowerButtonPress,(PPDMIACPIPORT pInterface));
1426
1427 /**
1428 * Send an ACPI sleep button event.
1429 *
1430 * @returns VBox status code
1431 * @param pInterface Pointer to the interface structure containing the called function pointer.
1432 */
1433 DECLR3CALLBACKMEMBER(int, pfnSleepButtonPress,(PPDMIACPIPORT pInterface));
1434
1435 /**
1436 * Check if the last power button event was handled by the guest.
1437 *
1438 * @returns VBox status code
1439 * @param pInterface Pointer to the interface structure containing the called function pointer.
1440 * @param pfHandled Is set to true if the last power button event was handled, false otherwise.
1441 */
1442 DECLR3CALLBACKMEMBER(int, pfnGetPowerButtonHandled,(PPDMIACPIPORT pInterface, bool *pfHandled));
1443
1444 /**
1445 * Check if the guest entered the ACPI mode.
1446 *
1447 * @returns VBox status code
1448 * @param pInterface Pointer to the interface structure containing the called function pointer.
1449 * @param pfEnabled Is set to true if the guest entered the ACPI mode, false otherwise.
1450 */
1451 DECLR3CALLBACKMEMBER(int, pfnGetGuestEnteredACPIMode,(PPDMIACPIPORT pInterface, bool *pfEntered));
1452
1453 /**
1454 * Check if the given CPU is still locked by the guest.
1455 *
1456 * @returns VBox status code
1457 * @param pInterface Pointer to the interface structure containing the called function pointer.
1458 * @param uCpu The CPU to check for.
1459 * @param pfLocked Is set to true if the CPU is still locked by the guest, false otherwise.
1460 */
1461 DECLR3CALLBACKMEMBER(int, pfnGetCpuStatus,(PPDMIACPIPORT pInterface, unsigned uCpu, bool *pfLocked));
1462
1463 /**
1464 * Send an ACPI monitor hot-plug event.
1465 *
1466 * @returns VBox status code
1467 * @param pInterface Pointer to the interface structure containing
1468 * the called function pointer.
1469 */
1470 DECLR3CALLBACKMEMBER(int, pfnMonitorHotPlugEvent,(PPDMIACPIPORT pInterface));
1471
1472 /**
1473 * Send a battery status change event.
1474 *
1475 * @returns VBox status code
1476 * @param pInterface Pointer to the interface structure containing
1477 * the called function pointer.
1478 */
1479 DECLR3CALLBACKMEMBER(int, pfnBatteryStatusChangeEvent,(PPDMIACPIPORT pInterface));
1480} PDMIACPIPORT;
1481/** PDMIACPIPORT interface ID. */
1482#define PDMIACPIPORT_IID "d64233e3-7bb0-4ef1-a313-2bcfafbe6260"
1483
1484
1485/** Pointer to an ACPI connector interface. */
1486typedef struct PDMIACPICONNECTOR *PPDMIACPICONNECTOR;
1487/**
1488 * ACPI connector interface (up).
1489 * Pair with PDMIACPIPORT.
1490 */
1491typedef struct PDMIACPICONNECTOR
1492{
1493 /**
1494 * Get the current power source of the host system.
1495 *
1496 * @returns VBox status code
1497 * @param pInterface Pointer to the interface structure containing the called function pointer.
1498 * @param penmPowerSource Pointer to the power source result variable.
1499 */
1500 DECLR3CALLBACKMEMBER(int, pfnQueryPowerSource,(PPDMIACPICONNECTOR, PPDMACPIPOWERSOURCE penmPowerSource));
1501
1502 /**
1503 * Query the current battery status of the host system.
1504 *
1505 * @returns VBox status code?
1506 * @param pInterface Pointer to the interface structure containing the called function pointer.
1507 * @param pfPresent Is set to true if battery is present, false otherwise.
1508 * @param penmRemainingCapacity Pointer to the battery remaining capacity (0 - 100 or 255 for unknown).
1509 * @param penmBatteryState Pointer to the battery status.
1510 * @param pu32PresentRate Pointer to the present rate (0..1000 of the total capacity).
1511 */
1512 DECLR3CALLBACKMEMBER(int, pfnQueryBatteryStatus,(PPDMIACPICONNECTOR, bool *pfPresent, PPDMACPIBATCAPACITY penmRemainingCapacity,
1513 PPDMACPIBATSTATE penmBatteryState, uint32_t *pu32PresentRate));
1514} PDMIACPICONNECTOR;
1515/** PDMIACPICONNECTOR interface ID. */
1516#define PDMIACPICONNECTOR_IID "19c7de73-5ae0-4841-a106-21825f43b206"
1517
1518
1519/** Pointer to a VMMDevice port interface. */
1520typedef struct PDMIVMMDEVPORT *PPDMIVMMDEVPORT;
1521/**
1522 * VMMDevice port interface (down).
1523 * Pair with PDMIVMMDEVCONNECTOR.
1524 */
1525typedef struct PDMIVMMDEVPORT
1526{
1527 /**
1528 * Return the current absolute mouse position in pixels
1529 *
1530 * @returns VBox status code
1531 * @param pInterface Pointer to the interface structure containing the called function pointer.
1532 * @param pxAbs Pointer of result value, can be NULL
1533 * @param pyAbs Pointer of result value, can be NULL
1534 */
1535 DECLR3CALLBACKMEMBER(int, pfnQueryAbsoluteMouse,(PPDMIVMMDEVPORT pInterface, int32_t *pxAbs, int32_t *pyAbs));
1536
1537 /**
1538 * Set the new absolute mouse position in pixels
1539 *
1540 * @returns VBox status code
1541 * @param pInterface Pointer to the interface structure containing the called function pointer.
1542 * @param xAbs New absolute X position
1543 * @param yAbs New absolute Y position
1544 */
1545 DECLR3CALLBACKMEMBER(int, pfnSetAbsoluteMouse,(PPDMIVMMDEVPORT pInterface, int32_t xAbs, int32_t yAbs));
1546
1547 /**
1548 * Return the current mouse capability flags
1549 *
1550 * @returns VBox status code
1551 * @param pInterface Pointer to the interface structure containing the called function pointer.
1552 * @param pfCapabilities Pointer of result value
1553 */
1554 DECLR3CALLBACKMEMBER(int, pfnQueryMouseCapabilities,(PPDMIVMMDEVPORT pInterface, uint32_t *pfCapabilities));
1555
1556 /**
1557 * Set the current mouse capability flag (host side)
1558 *
1559 * @returns VBox status code
1560 * @param pInterface Pointer to the interface structure containing the called function pointer.
1561 * @param fCapsAdded Mask of capabilities to add to the flag
1562 * @param fCapsRemoved Mask of capabilities to remove from the flag
1563 */
1564 DECLR3CALLBACKMEMBER(int, pfnUpdateMouseCapabilities,(PPDMIVMMDEVPORT pInterface, uint32_t fCapsAdded, uint32_t fCapsRemoved));
1565
1566 /**
1567 * Issue a display resolution change request.
1568 *
1569 * Note that there can only one request in the queue and that in case the guest does
1570 * not process it, issuing another request will overwrite the previous.
1571 *
1572 * @returns VBox status code
1573 * @param pInterface Pointer to the interface structure containing the called function pointer.
1574 * @param cx Horizontal pixel resolution (0 = do not change).
1575 * @param cy Vertical pixel resolution (0 = do not change).
1576 * @param cBits Bits per pixel (0 = do not change).
1577 * @param idxDisplay The display index.
1578 * @param xOrigin The X coordinate of the lower left
1579 * corner of the secondary display with
1580 * ID = idxDisplay
1581 * @param yOrigin The Y coordinate of the lower left
1582 * corner of the secondary display with
1583 * ID = idxDisplay
1584 * @param fEnabled Whether the display is enabled or not. (Guessing
1585 * again.)
1586 * @param fChangeOrigin Whether the display origin point changed. (Guess)
1587 */
1588 DECLR3CALLBACKMEMBER(int, pfnRequestDisplayChange,(PPDMIVMMDEVPORT pInterface, uint32_t cx,
1589 uint32_t cy, uint32_t cBits, uint32_t idxDisplay,
1590 int32_t xOrigin, int32_t yOrigin, bool fEnabled, bool fChangeOrigin));
1591
1592 /**
1593 * Pass credentials to guest.
1594 *
1595 * Note that there can only be one set of credentials and the guest may or may not
1596 * query them and may do whatever it wants with them.
1597 *
1598 * @returns VBox status code.
1599 * @param pInterface Pointer to the interface structure containing the called function pointer.
1600 * @param pszUsername User name, may be empty (UTF-8).
1601 * @param pszPassword Password, may be empty (UTF-8).
1602 * @param pszDomain Domain name, may be empty (UTF-8).
1603 * @param fFlags VMMDEV_SETCREDENTIALS_*.
1604 */
1605 DECLR3CALLBACKMEMBER(int, pfnSetCredentials,(PPDMIVMMDEVPORT pInterface, const char *pszUsername,
1606 const char *pszPassword, const char *pszDomain,
1607 uint32_t fFlags));
1608
1609 /**
1610 * Notify the driver about a VBVA status change.
1611 *
1612 * @returns Nothing. Because it is informational callback.
1613 * @param pInterface Pointer to the interface structure containing the called function pointer.
1614 * @param fEnabled Current VBVA status.
1615 */
1616 DECLR3CALLBACKMEMBER(void, pfnVBVAChange, (PPDMIVMMDEVPORT pInterface, bool fEnabled));
1617
1618 /**
1619 * Issue a seamless mode change request.
1620 *
1621 * Note that there can only one request in the queue and that in case the guest does
1622 * not process it, issuing another request will overwrite the previous.
1623 *
1624 * @returns VBox status code
1625 * @param pInterface Pointer to the interface structure containing the called function pointer.
1626 * @param fEnabled Seamless mode enabled or not
1627 */
1628 DECLR3CALLBACKMEMBER(int, pfnRequestSeamlessChange,(PPDMIVMMDEVPORT pInterface, bool fEnabled));
1629
1630 /**
1631 * Issue a memory balloon change request.
1632 *
1633 * Note that there can only one request in the queue and that in case the guest does
1634 * not process it, issuing another request will overwrite the previous.
1635 *
1636 * @returns VBox status code
1637 * @param pInterface Pointer to the interface structure containing the called function pointer.
1638 * @param cMbBalloon Balloon size in megabytes
1639 */
1640 DECLR3CALLBACKMEMBER(int, pfnSetMemoryBalloon,(PPDMIVMMDEVPORT pInterface, uint32_t cMbBalloon));
1641
1642 /**
1643 * Issue a statistcs interval change request.
1644 *
1645 * Note that there can only one request in the queue and that in case the guest does
1646 * not process it, issuing another request will overwrite the previous.
1647 *
1648 * @returns VBox status code
1649 * @param pInterface Pointer to the interface structure containing the called function pointer.
1650 * @param cSecsStatInterval Statistics query interval in seconds
1651 * (0=disable).
1652 */
1653 DECLR3CALLBACKMEMBER(int, pfnSetStatisticsInterval,(PPDMIVMMDEVPORT pInterface, uint32_t cSecsStatInterval));
1654
1655 /**
1656 * Notify the guest about a VRDP status change.
1657 *
1658 * @returns VBox status code
1659 * @param pInterface Pointer to the interface structure containing the called function pointer.
1660 * @param fVRDPEnabled Current VRDP status.
1661 * @param uVRDPExperienceLevel Which visual effects to be disabled in
1662 * the guest.
1663 */
1664 DECLR3CALLBACKMEMBER(int, pfnVRDPChange, (PPDMIVMMDEVPORT pInterface, bool fVRDPEnabled, uint32_t uVRDPExperienceLevel));
1665
1666 /**
1667 * Notify the guest of CPU hot-unplug event.
1668 *
1669 * @returns VBox status code
1670 * @param pInterface Pointer to the interface structure containing the called function pointer.
1671 * @param idCpuCore The core id of the CPU to remove.
1672 * @param idCpuPackage The package id of the CPU to remove.
1673 */
1674 DECLR3CALLBACKMEMBER(int, pfnCpuHotUnplug, (PPDMIVMMDEVPORT pInterface, uint32_t idCpuCore, uint32_t idCpuPackage));
1675
1676 /**
1677 * Notify the guest of CPU hot-plug event.
1678 *
1679 * @returns VBox status code
1680 * @param pInterface Pointer to the interface structure containing the called function pointer.
1681 * @param idCpuCore The core id of the CPU to add.
1682 * @param idCpuPackage The package id of the CPU to add.
1683 */
1684 DECLR3CALLBACKMEMBER(int, pfnCpuHotPlug, (PPDMIVMMDEVPORT pInterface, uint32_t idCpuCore, uint32_t idCpuPackage));
1685
1686} PDMIVMMDEVPORT;
1687/** PDMIVMMDEVPORT interface ID. */
1688#define PDMIVMMDEVPORT_IID "d7e52035-3b6c-422e-9215-2a75646a945d"
1689
1690
1691/** Pointer to a HPET legacy notification interface. */
1692typedef struct PDMIHPETLEGACYNOTIFY *PPDMIHPETLEGACYNOTIFY;
1693/**
1694 * HPET legacy notification interface.
1695 */
1696typedef struct PDMIHPETLEGACYNOTIFY
1697{
1698 /**
1699 * Notify about change of HPET legacy mode.
1700 *
1701 * @param pInterface Pointer to the interface structure containing the
1702 * called function pointer.
1703 * @param fActivated If HPET legacy mode is activated (@c true) or
1704 * deactivated (@c false).
1705 */
1706 DECLR3CALLBACKMEMBER(void, pfnModeChanged,(PPDMIHPETLEGACYNOTIFY pInterface, bool fActivated));
1707} PDMIHPETLEGACYNOTIFY;
1708/** PDMIHPETLEGACYNOTIFY interface ID. */
1709#define PDMIHPETLEGACYNOTIFY_IID "c9ada595-4b65-4311-8b21-b10498997774"
1710
1711
1712/** @name Flags for PDMIVMMDEVPORT::pfnSetCredentials.
1713 * @{ */
1714/** The guest should perform a logon with the credentials. */
1715#define VMMDEV_SETCREDENTIALS_GUESTLOGON RT_BIT(0)
1716/** The guest should prevent local logons. */
1717#define VMMDEV_SETCREDENTIALS_NOLOCALLOGON RT_BIT(1)
1718/** The guest should verify the credentials. */
1719#define VMMDEV_SETCREDENTIALS_JUDGE RT_BIT(15)
1720/** @} */
1721
1722/** Forward declaration of the guest information structure. */
1723struct VBoxGuestInfo;
1724/** Forward declaration of the guest information-2 structure. */
1725struct VBoxGuestInfo2;
1726/** Forward declaration of the guest statistics structure */
1727struct VBoxGuestStatistics;
1728/** Forward declaration of the guest status structure */
1729struct VBoxGuestStatus;
1730
1731/** Forward declaration of the video accelerator command memory. */
1732struct VBVAMEMORY;
1733/** Pointer to video accelerator command memory. */
1734typedef struct VBVAMEMORY *PVBVAMEMORY;
1735
1736/** Pointer to a VMMDev connector interface. */
1737typedef struct PDMIVMMDEVCONNECTOR *PPDMIVMMDEVCONNECTOR;
1738/**
1739 * VMMDev connector interface (up).
1740 * Pair with PDMIVMMDEVPORT.
1741 */
1742typedef struct PDMIVMMDEVCONNECTOR
1743{
1744 /**
1745 * Update guest facility status.
1746 *
1747 * Called in response to VMMDevReq_ReportGuestStatus, reset or state restore.
1748 *
1749 * @param pInterface Pointer to this interface.
1750 * @param uFacility The facility.
1751 * @param uStatus The status.
1752 * @param fFlags Flags assoicated with the update. Currently
1753 * reserved and should be ignored.
1754 * @param pTimeSpecTS Pointer to the timestamp of this report.
1755 * @thread The emulation thread.
1756 */
1757 DECLR3CALLBACKMEMBER(void, pfnUpdateGuestStatus,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t uFacility, uint16_t uStatus,
1758 uint32_t fFlags, PCRTTIMESPEC pTimeSpecTS));
1759
1760 /**
1761 * Updates a guest user state.
1762 *
1763 * Called in response to VMMDevReq_ReportGuestUserState.
1764 *
1765 * @param pInterface Pointer to this interface.
1766 * @param pszUser Guest user name to update status for.
1767 * @param pszDomain Domain the guest user is bound to. Optional.
1768 * @param uState New guest user state to notify host about.
1769 * @param pabDetails Pointer to optional state data.
1770 * @param cbDetails Size (in bytes) of optional state data.
1771 * @thread The emulation thread.
1772 */
1773 DECLR3CALLBACKMEMBER(void, pfnUpdateGuestUserState,(PPDMIVMMDEVCONNECTOR pInterface, const char *pszUser,
1774 const char *pszDomain, uint32_t uState,
1775 const uint8_t *pabDetails, uint32_t cbDetails));
1776
1777 /**
1778 * Reports the guest API and OS version.
1779 * Called whenever the Additions issue a guest info report request.
1780 *
1781 * @param pInterface Pointer to this interface.
1782 * @param pGuestInfo Pointer to guest information structure
1783 * @thread The emulation thread.
1784 */
1785 DECLR3CALLBACKMEMBER(void, pfnUpdateGuestInfo,(PPDMIVMMDEVCONNECTOR pInterface, const struct VBoxGuestInfo *pGuestInfo));
1786
1787 /**
1788 * Reports the detailed Guest Additions version.
1789 *
1790 * @param pInterface Pointer to this interface.
1791 * @param uFullVersion The guest additions version as a full version.
1792 * Use VBOX_FULL_VERSION_GET_MAJOR,
1793 * VBOX_FULL_VERSION_GET_MINOR and
1794 * VBOX_FULL_VERSION_GET_BUILD to access it.
1795 * (This will not be zero, so turn down the
1796 * paranoia level a notch.)
1797 * @param pszName Pointer to the sanitized version name. This can
1798 * be empty, but will not be NULL. If not empty,
1799 * it will contain a build type tag and/or a
1800 * publisher tag. If both, then they are separated
1801 * by an underscore (VBOX_VERSION_STRING fashion).
1802 * @param uRevision The SVN revision. Can be 0.
1803 * @param fFeatures Feature mask, currently none are defined.
1804 *
1805 * @thread The emulation thread.
1806 */
1807 DECLR3CALLBACKMEMBER(void, pfnUpdateGuestInfo2,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t uFullVersion,
1808 const char *pszName, uint32_t uRevision, uint32_t fFeatures));
1809
1810 /**
1811 * Update the guest additions capabilities.
1812 * This is called when the guest additions capabilities change. The new capabilities
1813 * are given and the connector should update its internal state.
1814 *
1815 * @param pInterface Pointer to this interface.
1816 * @param newCapabilities New capabilities.
1817 * @thread The emulation thread.
1818 */
1819 DECLR3CALLBACKMEMBER(void, pfnUpdateGuestCapabilities,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t newCapabilities));
1820
1821 /**
1822 * Update the mouse capabilities.
1823 * This is called when the mouse capabilities change. The new capabilities
1824 * are given and the connector should update its internal state.
1825 *
1826 * @param pInterface Pointer to this interface.
1827 * @param newCapabilities New capabilities.
1828 * @thread The emulation thread.
1829 */
1830 DECLR3CALLBACKMEMBER(void, pfnUpdateMouseCapabilities,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t newCapabilities));
1831
1832 /**
1833 * Update the pointer shape.
1834 * This is called when the mouse pointer shape changes. The new shape
1835 * is passed as a caller allocated buffer that will be freed after returning
1836 *
1837 * @param pInterface Pointer to this interface.
1838 * @param fVisible Visibility indicator (if false, the other parameters are undefined).
1839 * @param fAlpha Flag whether alpha channel is being passed.
1840 * @param xHot Pointer hot spot x coordinate.
1841 * @param yHot Pointer hot spot y coordinate.
1842 * @param x Pointer new x coordinate on screen.
1843 * @param y Pointer new y coordinate on screen.
1844 * @param cx Pointer width in pixels.
1845 * @param cy Pointer height in pixels.
1846 * @param cbScanline Size of one scanline in bytes.
1847 * @param pvShape New shape buffer.
1848 * @thread The emulation thread.
1849 */
1850 DECLR3CALLBACKMEMBER(void, pfnUpdatePointerShape,(PPDMIVMMDEVCONNECTOR pInterface, bool fVisible, bool fAlpha,
1851 uint32_t xHot, uint32_t yHot,
1852 uint32_t cx, uint32_t cy,
1853 void *pvShape));
1854
1855 /**
1856 * Enable or disable video acceleration on behalf of guest.
1857 *
1858 * @param pInterface Pointer to this interface.
1859 * @param fEnable Whether to enable acceleration.
1860 * @param pVbvaMemory Video accelerator memory.
1861
1862 * @return VBox rc. VINF_SUCCESS if VBVA was enabled.
1863 * @thread The emulation thread.
1864 */
1865 DECLR3CALLBACKMEMBER(int, pfnVideoAccelEnable,(PPDMIVMMDEVCONNECTOR pInterface, bool fEnable, PVBVAMEMORY pVbvaMemory));
1866
1867 /**
1868 * Force video queue processing.
1869 *
1870 * @param pInterface Pointer to this interface.
1871 * @thread The emulation thread.
1872 */
1873 DECLR3CALLBACKMEMBER(void, pfnVideoAccelFlush,(PPDMIVMMDEVCONNECTOR pInterface));
1874
1875 /**
1876 * Return whether the given video mode is supported/wanted by the host.
1877 *
1878 * @returns VBox status code
1879 * @param pInterface Pointer to this interface.
1880 * @param display The guest monitor, 0 for primary.
1881 * @param cy Video mode horizontal resolution in pixels.
1882 * @param cx Video mode vertical resolution in pixels.
1883 * @param cBits Video mode bits per pixel.
1884 * @param pfSupported Where to put the indicator for whether this mode is supported. (output)
1885 * @thread The emulation thread.
1886 */
1887 DECLR3CALLBACKMEMBER(int, pfnVideoModeSupported,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t display, uint32_t cx, uint32_t cy, uint32_t cBits, bool *pfSupported));
1888
1889 /**
1890 * Queries by how many pixels the height should be reduced when calculating video modes
1891 *
1892 * @returns VBox status code
1893 * @param pInterface Pointer to this interface.
1894 * @param pcyReduction Pointer to the result value.
1895 * @thread The emulation thread.
1896 */
1897 DECLR3CALLBACKMEMBER(int, pfnGetHeightReduction,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pcyReduction));
1898
1899 /**
1900 * Informs about a credentials judgement result from the guest.
1901 *
1902 * @returns VBox status code
1903 * @param pInterface Pointer to this interface.
1904 * @param fFlags Judgement result flags.
1905 * @thread The emulation thread.
1906 */
1907 DECLR3CALLBACKMEMBER(int, pfnSetCredentialsJudgementResult,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t fFlags));
1908
1909 /**
1910 * Set the visible region of the display
1911 *
1912 * @returns VBox status code.
1913 * @param pInterface Pointer to this interface.
1914 * @param cRect Number of rectangles in pRect
1915 * @param pRect Rectangle array
1916 * @thread The emulation thread.
1917 */
1918 DECLR3CALLBACKMEMBER(int, pfnSetVisibleRegion,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t cRect, PRTRECT pRect));
1919
1920 /**
1921 * Query the visible region of the display
1922 *
1923 * @returns VBox status code.
1924 * @param pInterface Pointer to this interface.
1925 * @param pcRect Number of rectangles in pRect
1926 * @param pRect Rectangle array (set to NULL to query the number of rectangles)
1927 * @thread The emulation thread.
1928 */
1929 DECLR3CALLBACKMEMBER(int, pfnQueryVisibleRegion,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pcRect, PRTRECT pRect));
1930
1931 /**
1932 * Request the statistics interval
1933 *
1934 * @returns VBox status code.
1935 * @param pInterface Pointer to this interface.
1936 * @param pulInterval Pointer to interval in seconds
1937 * @thread The emulation thread.
1938 */
1939 DECLR3CALLBACKMEMBER(int, pfnQueryStatisticsInterval,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pulInterval));
1940
1941 /**
1942 * Report new guest statistics
1943 *
1944 * @returns VBox status code.
1945 * @param pInterface Pointer to this interface.
1946 * @param pGuestStats Guest statistics
1947 * @thread The emulation thread.
1948 */
1949 DECLR3CALLBACKMEMBER(int, pfnReportStatistics,(PPDMIVMMDEVCONNECTOR pInterface, struct VBoxGuestStatistics *pGuestStats));
1950
1951 /**
1952 * Query the current balloon size
1953 *
1954 * @returns VBox status code.
1955 * @param pInterface Pointer to this interface.
1956 * @param pcbBalloon Balloon size
1957 * @thread The emulation thread.
1958 */
1959 DECLR3CALLBACKMEMBER(int, pfnQueryBalloonSize,(PPDMIVMMDEVCONNECTOR pInterface, uint32_t *pcbBalloon));
1960
1961 /**
1962 * Query the current page fusion setting
1963 *
1964 * @returns VBox status code.
1965 * @param pInterface Pointer to this interface.
1966 * @param pfPageFusionEnabled Pointer to boolean
1967 * @thread The emulation thread.
1968 */
1969 DECLR3CALLBACKMEMBER(int, pfnIsPageFusionEnabled,(PPDMIVMMDEVCONNECTOR pInterface, bool *pfPageFusionEnabled));
1970
1971} PDMIVMMDEVCONNECTOR;
1972/** PDMIVMMDEVCONNECTOR interface ID. */
1973#define PDMIVMMDEVCONNECTOR_IID "aff90240-a443-434e-9132-80c186ab97d4"
1974
1975
1976/**
1977 * Generic status LED core.
1978 * Note that a unit doesn't have to support all the indicators.
1979 */
1980typedef union PDMLEDCORE
1981{
1982 /** 32-bit view. */
1983 uint32_t volatile u32;
1984 /** Bit view. */
1985 struct
1986 {
1987 /** Reading/Receiving indicator. */
1988 uint32_t fReading : 1;
1989 /** Writing/Sending indicator. */
1990 uint32_t fWriting : 1;
1991 /** Busy indicator. */
1992 uint32_t fBusy : 1;
1993 /** Error indicator. */
1994 uint32_t fError : 1;
1995 } s;
1996} PDMLEDCORE;
1997
1998/** LED bit masks for the u32 view.
1999 * @{ */
2000/** Reading/Receiving indicator. */
2001#define PDMLED_READING RT_BIT(0)
2002/** Writing/Sending indicator. */
2003#define PDMLED_WRITING RT_BIT(1)
2004/** Busy indicator. */
2005#define PDMLED_BUSY RT_BIT(2)
2006/** Error indicator. */
2007#define PDMLED_ERROR RT_BIT(3)
2008/** @} */
2009
2010
2011/**
2012 * Generic status LED.
2013 * Note that a unit doesn't have to support all the indicators.
2014 */
2015typedef struct PDMLED
2016{
2017 /** Just a magic for sanity checking. */
2018 uint32_t u32Magic;
2019 uint32_t u32Alignment; /**< structure size alignment. */
2020 /** The actual LED status.
2021 * Only the device is allowed to change this. */
2022 PDMLEDCORE Actual;
2023 /** The asserted LED status which is cleared by the reader.
2024 * The device will assert the bits but never clear them.
2025 * The driver clears them as it sees fit. */
2026 PDMLEDCORE Asserted;
2027} PDMLED;
2028
2029/** Pointer to an LED. */
2030typedef PDMLED *PPDMLED;
2031/** Pointer to a const LED. */
2032typedef const PDMLED *PCPDMLED;
2033
2034/** Magic value for PDMLED::u32Magic. */
2035#define PDMLED_MAGIC UINT32_C(0x11335577)
2036
2037/** Pointer to an LED ports interface. */
2038typedef struct PDMILEDPORTS *PPDMILEDPORTS;
2039/**
2040 * Interface for exporting LEDs (down).
2041 * Pair with PDMILEDCONNECTORS.
2042 */
2043typedef struct PDMILEDPORTS
2044{
2045 /**
2046 * Gets the pointer to the status LED of a unit.
2047 *
2048 * @returns VBox status code.
2049 * @param pInterface Pointer to the interface structure containing the called function pointer.
2050 * @param iLUN The unit which status LED we desire.
2051 * @param ppLed Where to store the LED pointer.
2052 */
2053 DECLR3CALLBACKMEMBER(int, pfnQueryStatusLed,(PPDMILEDPORTS pInterface, unsigned iLUN, PPDMLED *ppLed));
2054
2055} PDMILEDPORTS;
2056/** PDMILEDPORTS interface ID. */
2057#define PDMILEDPORTS_IID "435e0cec-8549-4ca0-8c0d-98e52f1dc038"
2058
2059
2060/** Pointer to an LED connectors interface. */
2061typedef struct PDMILEDCONNECTORS *PPDMILEDCONNECTORS;
2062/**
2063 * Interface for reading LEDs (up).
2064 * Pair with PDMILEDPORTS.
2065 */
2066typedef struct PDMILEDCONNECTORS
2067{
2068 /**
2069 * Notification about a unit which have been changed.
2070 *
2071 * The driver must discard any pointers to data owned by
2072 * the unit and requery it.
2073 *
2074 * @param pInterface Pointer to the interface structure containing the called function pointer.
2075 * @param iLUN The unit number.
2076 */
2077 DECLR3CALLBACKMEMBER(void, pfnUnitChanged,(PPDMILEDCONNECTORS pInterface, unsigned iLUN));
2078} PDMILEDCONNECTORS;
2079/** PDMILEDCONNECTORS interface ID. */
2080#define PDMILEDCONNECTORS_IID "8ed63568-82a7-4193-b57b-db8085ac4495"
2081
2082
2083/** Pointer to a Media Notification interface. */
2084typedef struct PDMIMEDIANOTIFY *PPDMIMEDIANOTIFY;
2085/**
2086 * Interface for exporting Medium eject information (up). No interface pair.
2087 */
2088typedef struct PDMIMEDIANOTIFY
2089{
2090 /**
2091 * Signals that the medium was ejected.
2092 *
2093 * @returns VBox status code.
2094 * @param pInterface Pointer to the interface structure containing the called function pointer.
2095 * @param iLUN The unit which had the medium ejected.
2096 */
2097 DECLR3CALLBACKMEMBER(int, pfnEjected,(PPDMIMEDIANOTIFY pInterface, unsigned iLUN));
2098
2099} PDMIMEDIANOTIFY;
2100/** PDMIMEDIANOTIFY interface ID. */
2101#define PDMIMEDIANOTIFY_IID "fc22d53e-feb1-4a9c-b9fb-0a990a6ab288"
2102
2103
2104/** The special status unit number */
2105#define PDM_STATUS_LUN 999
2106
2107
2108#ifdef VBOX_WITH_HGCM
2109
2110/** Abstract HGCM command structure. Used only to define a typed pointer. */
2111struct VBOXHGCMCMD;
2112
2113/** Pointer to HGCM command structure. This pointer is unique and identifies
2114 * the command being processed. The pointer is passed to HGCM connector methods,
2115 * and must be passed back to HGCM port when command is completed.
2116 */
2117typedef struct VBOXHGCMCMD *PVBOXHGCMCMD;
2118
2119/** Pointer to a HGCM port interface. */
2120typedef struct PDMIHGCMPORT *PPDMIHGCMPORT;
2121/**
2122 * Host-Guest communication manager port interface (down). Normally implemented
2123 * by VMMDev.
2124 * Pair with PDMIHGCMCONNECTOR.
2125 */
2126typedef struct PDMIHGCMPORT
2127{
2128 /**
2129 * Notify the guest on a command completion.
2130 *
2131 * @param pInterface Pointer to this interface.
2132 * @param rc The return code (VBox error code).
2133 * @param pCmd A pointer that identifies the completed command.
2134 *
2135 * @returns VBox status code
2136 */
2137 DECLR3CALLBACKMEMBER(void, pfnCompleted,(PPDMIHGCMPORT pInterface, int32_t rc, PVBOXHGCMCMD pCmd));
2138
2139} PDMIHGCMPORT;
2140/** PDMIHGCMPORT interface ID. */
2141# define PDMIHGCMPORT_IID "e00a0cbf-b75a-45c3-87f4-41cddbc5ae0b"
2142
2143
2144/** Pointer to a HGCM service location structure. */
2145typedef struct HGCMSERVICELOCATION *PHGCMSERVICELOCATION;
2146
2147/** Pointer to a HGCM connector interface. */
2148typedef struct PDMIHGCMCONNECTOR *PPDMIHGCMCONNECTOR;
2149/**
2150 * The Host-Guest communication manager connector interface (up). Normally
2151 * implemented by Main::VMMDevInterface.
2152 * Pair with PDMIHGCMPORT.
2153 */
2154typedef struct PDMIHGCMCONNECTOR
2155{
2156 /**
2157 * Locate a service and inform it about a client connection.
2158 *
2159 * @param pInterface Pointer to this interface.
2160 * @param pCmd A pointer that identifies the command.
2161 * @param pServiceLocation Pointer to the service location structure.
2162 * @param pu32ClientID Where to store the client id for the connection.
2163 * @return VBox status code.
2164 * @thread The emulation thread.
2165 */
2166 DECLR3CALLBACKMEMBER(int, pfnConnect,(PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, PHGCMSERVICELOCATION pServiceLocation, uint32_t *pu32ClientID));
2167
2168 /**
2169 * Disconnect from service.
2170 *
2171 * @param pInterface Pointer to this interface.
2172 * @param pCmd A pointer that identifies the command.
2173 * @param u32ClientID The client id returned by the pfnConnect call.
2174 * @return VBox status code.
2175 * @thread The emulation thread.
2176 */
2177 DECLR3CALLBACKMEMBER(int, pfnDisconnect,(PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID));
2178
2179 /**
2180 * Process a guest issued command.
2181 *
2182 * @param pInterface Pointer to this interface.
2183 * @param pCmd A pointer that identifies the command.
2184 * @param u32ClientID The client id returned by the pfnConnect call.
2185 * @param u32Function Function to be performed by the service.
2186 * @param cParms Number of parameters in the array pointed to by paParams.
2187 * @param paParms Pointer to an array of parameters.
2188 * @return VBox status code.
2189 * @thread The emulation thread.
2190 */
2191 DECLR3CALLBACKMEMBER(int, pfnCall,(PPDMIHGCMCONNECTOR pInterface, PVBOXHGCMCMD pCmd, uint32_t u32ClientID, uint32_t u32Function,
2192 uint32_t cParms, PVBOXHGCMSVCPARM paParms));
2193
2194} PDMIHGCMCONNECTOR;
2195/** PDMIHGCMCONNECTOR interface ID. */
2196# define PDMIHGCMCONNECTOR_IID "a1104758-c888-4437-8f2a-7bac17865b5c"
2197
2198#endif /* VBOX_WITH_HGCM */
2199
2200
2201/** Pointer to a display VBVA callbacks interface. */
2202typedef struct PDMIDISPLAYVBVACALLBACKS *PPDMIDISPLAYVBVACALLBACKS;
2203/**
2204 * Display VBVA callbacks interface (up).
2205 */
2206typedef struct PDMIDISPLAYVBVACALLBACKS
2207{
2208
2209 /**
2210 * Informs guest about completion of processing the given Video HW Acceleration
2211 * command, does not wait for the guest to process the command.
2212 *
2213 * @returns ???
2214 * @param pInterface Pointer to this interface.
2215 * @param pCmd The Video HW Acceleration Command that was
2216 * completed.
2217 */
2218 DECLR3CALLBACKMEMBER(int, pfnVHWACommandCompleteAsync, (PPDMIDISPLAYVBVACALLBACKS pInterface,
2219 PVBOXVHWACMD pCmd));
2220
2221 DECLR3CALLBACKMEMBER(int, pfnCrHgsmiCommandCompleteAsync, (PPDMIDISPLAYVBVACALLBACKS pInterface,
2222 struct VBOXVDMACMD_CHROMIUM_CMD* pCmd, int rc));
2223
2224 DECLR3CALLBACKMEMBER(int, pfnCrHgsmiControlCompleteAsync, (PPDMIDISPLAYVBVACALLBACKS pInterface,
2225 struct VBOXVDMACMD_CHROMIUM_CTL* pCmd, int rc));
2226
2227 DECLR3CALLBACKMEMBER(int, pfnCrCtlSubmit, (PPDMIDISPLAYVBVACALLBACKS pInterface,
2228 struct VBOXCRCMDCTL* pCmd, uint32_t cbCmd,
2229 PFNCRCTLCOMPLETION pfnCompletion,
2230 void *pvCompletion));
2231
2232 DECLR3CALLBACKMEMBER(int, pfnCrCtlSubmitSync, (PPDMIDISPLAYVBVACALLBACKS pInterface,
2233 struct VBOXCRCMDCTL* pCmd, uint32_t cbCmd));
2234} PDMIDISPLAYVBVACALLBACKS;
2235/** PDMIDISPLAYVBVACALLBACKS */
2236#define PDMIDISPLAYVBVACALLBACKS_IID "ddac0bd0-332d-4671-8853-732921a80216"
2237
2238/** Pointer to a PCI raw connector interface. */
2239typedef struct PDMIPCIRAWCONNECTOR *PPDMIPCIRAWCONNECTOR;
2240/**
2241 * PCI raw connector interface (up).
2242 */
2243typedef struct PDMIPCIRAWCONNECTOR
2244{
2245
2246 /**
2247 *
2248 */
2249 DECLR3CALLBACKMEMBER(int, pfnDeviceConstructComplete, (PPDMIPCIRAWCONNECTOR pInterface, const char *pcszName,
2250 uint32_t uHostPciAddress, uint32_t uGuestPciAddress,
2251 int rc));
2252
2253} PDMIPCIRAWCONNECTOR;
2254/** PDMIPCIRAWCONNECTOR interface ID. */
2255#define PDMIPCIRAWCONNECTOR_IID "14aa9c6c-8869-4782-9dfc-910071a6aebf"
2256
2257/** @} */
2258
2259RT_C_DECLS_END
2260
2261#endif
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