VirtualBox

source: vbox/trunk/include/VBox/VBoxGuest.h@ 4540

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

Implemented notification for guest about an active VRDP connection.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 46.0 KB
Line 
1/** @file
2 * VBoxGuest - VirtualBox Guest Additions interface
3 */
4
5/*
6 * Copyright (C) 2006-2007 innotek GmbH
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 as published by the Free Software Foundation,
12 * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
13 * distribution. VirtualBox OSE is distributed in the hope that it will
14 * be useful, but WITHOUT ANY WARRANTY of any kind.
15 */
16
17#ifndef ___VBox_VBoxGuest_h
18#define ___VBox_VBoxGuest_h
19
20#include <iprt/cdefs.h>
21#include <iprt/types.h>
22#include <VBox/err.h>
23#include <VBox/ostypes.h>
24
25/*******************************************************************************
26* Defined Constants And Macros *
27*******************************************************************************/
28
29/** @todo The following is a temporary fix for the problem of accessing
30 hypervisor pointers from within guest additions */
31
32/** Hypervisor linear pointer size type */
33typedef uint32_t vmmDevHypPtr;
34/** Hypervisor physical pointer size type */
35typedef uint32_t vmmDevHypPhys;
36
37#if defined(RT_OS_LINUX)
38/** The support device name. */
39# define VBOXGUEST_DEVICE_NAME "/dev/vboxadd"
40
41#elif defined(RT_OS_OS2)
42/** The support device name. */
43# define VBOXGUEST_DEVICE_NAME "\\Dev\\VBoxGst$"
44
45#elif defined(RT_OS_WINDOWS)
46/** The support service name. */
47# define VBOXGUEST_SERVICE_NAME "VBoxGuest"
48/** Win32 Device name. */
49# define VBOXGUEST_DEVICE_NAME "\\\\.\\VBoxGuest"
50/** Global name for Win2k+ */
51# define VBOXGUEST_DEVICE_NAME_GLOBAL "\\\\.\\Global\\VBoxGuest"
52/** Win32 driver name */
53# define VBOXGUEST_DEVICE_NAME_NT L"\\Device\\VBoxGuest"
54/** device name */
55# define VBOXGUEST_DEVICE_NAME_DOS L"\\DosDevices\\VBoxGuest"
56
57#else
58/* PORTME */
59#endif
60
61/** VirtualBox vendor ID */
62#define VBOX_PCI_VENDORID (0x80ee)
63
64/** VMMDev PCI card identifiers */
65#define VMMDEV_VENDORID VBOX_PCI_VENDORID
66#define VMMDEV_DEVICEID (0xcafe)
67
68/** VirtualBox graphics card identifiers */
69#define VBOX_VENDORID VBOX_PCI_VENDORID
70#define VBOX_VESA_VENDORID VBOX_PCI_VENDORID
71#define VBOX_DEVICEID (0xbeef)
72#define VBOX_VESA_DEVICEID (0xbeef)
73
74/**
75 * VBoxGuest port definitions
76 * @{
77 */
78
79/** guest can (== wants to) handle absolute coordinates */
80#define VBOXGUEST_MOUSE_GUEST_CAN_ABSOLUTE BIT(0)
81/** host can (== wants to) send absolute coordinates */
82#define VBOXGUEST_MOUSE_HOST_CAN_ABSOLUTE BIT(1)
83/** guest can *NOT* switch to software cursor and therefore depends on the host cursor */
84#define VBOXGUEST_MOUSE_GUEST_NEEDS_HOST_CURSOR BIT(2)
85/** host does NOT provide support for drawing the cursor itself (e.g. L4 console) */
86#define VBOXGUEST_MOUSE_HOST_CANNOT_HWPOINTER BIT(3)
87
88/** fictive start address of the hypervisor physical memory for MmMapIoSpace */
89#define HYPERVISOR_PHYSICAL_START 0xf8000000
90
91/*
92 * VMMDev Generic Request Interface
93 */
94
95/** port for generic request interface */
96#define PORT_VMMDEV_REQUEST_OFFSET 0
97
98/** Current version of the VMMDev interface.
99 *
100 * Additions are allowed to work only if
101 * additions_major == vmmdev_current && additions_minor <= vmmdev_current.
102 * Additions version is reported to host (VMMDev) by VMMDevReq_ReportGuestInfo.
103 *
104 * @remark These defines also live in the 16-bit and assembly versions of this header.
105 */
106#define VMMDEV_VERSION_MAJOR (0x1)
107#define VMMDEV_VERSION_MINOR (0x4)
108#define VMMDEV_VERSION ((VMMDEV_VERSION_MAJOR << 16) | VMMDEV_VERSION_MINOR)
109
110/**
111 * VMMDev request types.
112 * @note when updating this, adjust vmmdevGetRequestSize() as well
113 */
114typedef enum
115{
116 VMMDevReq_InvalidRequest = 0,
117 VMMDevReq_GetMouseStatus = 1,
118 VMMDevReq_SetMouseStatus = 2,
119 VMMDevReq_SetPointerShape = 3,
120 /** @todo implement on host side */
121 VMMDevReq_GetHostVersion = 4,
122 VMMDevReq_Idle = 5,
123 VMMDevReq_GetHostTime = 10,
124 VMMDevReq_GetHypervisorInfo = 20,
125 VMMDevReq_SetHypervisorInfo = 21,
126 VMMDevReq_SetPowerStatus = 30,
127 VMMDevReq_AcknowledgeEvents = 41,
128 VMMDevReq_CtlGuestFilterMask = 42,
129 VMMDevReq_ReportGuestInfo = 50,
130 VMMDevReq_GetDisplayChangeRequest = 51,
131 VMMDevReq_VideoModeSupported = 52,
132 VMMDevReq_GetHeightReduction = 53,
133 VMMDevReq_GetDisplayChangeRequest2 = 54,
134 VMMDevReq_ReportGuestCapabilities = 55,
135#ifdef VBOX_HGCM
136 VMMDevReq_HGCMConnect = 60,
137 VMMDevReq_HGCMDisconnect = 61,
138 VMMDevReq_HGCMCall = 62,
139#endif
140 VMMDevReq_VideoAccelEnable = 70,
141 VMMDevReq_VideoAccelFlush = 71,
142 VMMDevReq_VideoSetVisibleRegion = 72,
143 VMMDevReq_GetSeamlessChangeRequest = 73,
144 VMMDevReq_QueryCredentials = 100,
145 VMMDevReq_ReportCredentialsJudgement = 101,
146 VMMDevReq_ReportGuestStats = 110,
147 VMMDevReq_GetMemBalloonChangeRequest = 111,
148 VMMDevReq_GetStatisticsChangeRequest = 112,
149 VMMDevReq_ChangeMemBalloon = 113,
150 VMMDevReq_GetVRDPChangeRequest = 150,
151 VMMDevReq_LogString = 200,
152 VMMDevReq_SizeHack = 0x7fffffff
153} VMMDevRequestType;
154
155/** Version of VMMDevRequestHeader structure. */
156#define VMMDEV_REQUEST_HEADER_VERSION (0x10001)
157
158#pragma pack(4)
159/** generic VMMDev request header */
160typedef struct
161{
162 /** size of the structure in bytes (including body). Filled by caller */
163 uint32_t size;
164 /** version of the structure. Filled by caller */
165 uint32_t version;
166 /** type of the request */
167 VMMDevRequestType requestType;
168 /** return code. Filled by VMMDev */
169 int32_t rc;
170 /** reserved fields */
171 uint32_t reserved1;
172 uint32_t reserved2;
173} VMMDevRequestHeader;
174
175/** mouse status request structure */
176typedef struct
177{
178 /** header */
179 VMMDevRequestHeader header;
180 /** mouse feature mask */
181 uint32_t mouseFeatures;
182 /** mouse x position */
183 uint32_t pointerXPos;
184 /** mouse y position */
185 uint32_t pointerYPos;
186} VMMDevReqMouseStatus;
187
188/** Note VBOX_MOUSE_POINTER_* flags are used in guest video driver,
189 * values must be <= 0x8000 and must not be changed.
190 */
191
192/** pointer is visible */
193#define VBOX_MOUSE_POINTER_VISIBLE (0x0001)
194/** pointer has alpha channel */
195#define VBOX_MOUSE_POINTER_ALPHA (0x0002)
196/** pointerData contains new pointer shape */
197#define VBOX_MOUSE_POINTER_SHAPE (0x0004)
198
199/** mouse pointer shape/visibility change request */
200typedef struct
201{
202 /** header */
203 VMMDevRequestHeader header;
204 /** VBOX_MOUSE_POINTER_* bit flags */
205 uint32_t fFlags;
206 /** x coordinate of hot spot */
207 uint32_t xHot;
208 /** y coordinate of hot spot */
209 uint32_t yHot;
210 /** width of the pointer in pixels */
211 uint32_t width;
212 /** height of the pointer in scanlines */
213 uint32_t height;
214 /** Pointer data.
215 *
216 ****
217 * The data consists of 1 bpp AND mask followed by 32 bpp XOR (color) mask.
218 *
219 * For pointers without alpha channel the XOR mask pixels are 32 bit values: (lsb)BGR0(msb).
220 * For pointers with alpha channel the XOR mask consists of (lsb)BGRA(msb) 32 bit values.
221 *
222 * Guest driver must create the AND mask for pointers with alpha channel, so if host does not
223 * support alpha, the pointer could be displayed as a normal color pointer. The AND mask can
224 * be constructed from alpha values. For example alpha value >= 0xf0 means bit 0 in the AND mask.
225 *
226 * The AND mask is 1 bpp bitmap with byte aligned scanlines. Size of AND mask,
227 * therefore, is cbAnd = (width + 7) / 8 * height. The padding bits at the
228 * end of any scanline are undefined.
229 *
230 * The XOR mask follows the AND mask on the next 4 bytes aligned offset:
231 * uint8_t *pXor = pAnd + (cbAnd + 3) & ~3
232 * Bytes in the gap between the AND and the XOR mask are undefined.
233 * XOR mask scanlines have no gap between them and size of XOR mask is:
234 * cXor = width * 4 * height.
235 ****
236 *
237 * Preallocate 4 bytes for accessing actual data as p->pointerData
238 */
239 char pointerData[4];
240} VMMDevReqMousePointer;
241
242/** string log request structure */
243typedef struct
244{
245 /** header */
246 VMMDevRequestHeader header;
247 /** variable length string data */
248 char szString[1];
249} VMMDevReqLogString;
250
251/** host version request structure */
252typedef struct
253{
254 /** header */
255 VMMDevRequestHeader header;
256 /** major version */
257 uint32_t major;
258 /** minor version */
259 uint32_t minor;
260 /** build number */
261 uint32_t build;
262} VMMDevReqHostVersion;
263
264/** guest capabilites structure */
265typedef struct
266{
267 /** header */
268 VMMDevRequestHeader header;
269 /** capabilities (VMMDEV_GUEST_*) */
270 uint32_t caps;
271} VMMDevReqGuestCapabilities;
272
273/** idle request structure */
274typedef struct
275{
276 /** header */
277 VMMDevRequestHeader header;
278} VMMDevReqIdle;
279
280/** host time request structure */
281typedef struct
282{
283 /** header */
284 VMMDevRequestHeader header;
285 /** time in milliseconds since unix epoch. Filled by VMMDev. */
286 uint64_t time;
287} VMMDevReqHostTime;
288
289/** hypervisor info structure */
290typedef struct
291{
292 /** header */
293 VMMDevRequestHeader header;
294 /** guest virtual address of proposed hypervisor start */
295 vmmDevHypPtr hypervisorStart;
296 /** hypervisor size in bytes */
297 uint32_t hypervisorSize;
298} VMMDevReqHypervisorInfo;
299
300/** system power requests */
301typedef enum
302{
303 VMMDevPowerState_Invalid = 0,
304 VMMDevPowerState_Pause = 1,
305 VMMDevPowerState_PowerOff = 2,
306 VMMDevPowerState_SaveState = 3,
307 VMMDevPowerState_SizeHack = 0x7fffffff
308} VMMDevPowerState;
309
310/** system power status structure */
311typedef struct
312{
313 /** header */
314 VMMDevRequestHeader header;
315 /** power state request */
316 VMMDevPowerState powerState;
317} VMMDevPowerStateRequest;
318
319/** pending events structure */
320typedef struct
321{
322 /** header */
323 VMMDevRequestHeader header;
324 /** pending event bitmap */
325 uint32_t events;
326} VMMDevEvents;
327
328/** guest filter mask control */
329typedef struct
330{
331 /** header */
332 VMMDevRequestHeader header;
333 /** mask of events to be added to filter */
334 uint32_t u32OrMask;
335 /** mask of events to be removed from filter */
336 uint32_t u32NotMask;
337} VMMDevCtlGuestFilterMask;
338
339/** guest information structure */
340typedef struct VBoxGuestInfo
341{
342 /** The VMMDev interface version expected by additions. */
343 uint32_t additionsVersion;
344 /** guest OS type */
345 OSType osType;
346 /** @todo */
347} VBoxGuestInfo;
348
349/** guest information structure */
350typedef struct
351{
352 /** header */
353 VMMDevRequestHeader header;
354 /** Guest information. */
355 VBoxGuestInfo guestInfo;
356} VMMDevReportGuestInfo;
357
358/** guest statistics values */
359#define VBOX_GUEST_STAT_CPU_LOAD BIT(0)
360#define VBOX_GUEST_STAT_THREADS BIT(1)
361#define VBOX_GUEST_STAT_PROCESSES BIT(2)
362#define VBOX_GUEST_STAT_PHYS_MEM_TOTAL BIT(3)
363#define VBOX_GUEST_STAT_PHYS_MEM_AVAIL BIT(4)
364#define VBOX_GUEST_STAT_PHYS_MEM_BALLOON BIT(5)
365#define VBOX_GUEST_STAT_PAGE_FILE_SIZE BIT(6)
366
367
368/** guest statistics structure */
369typedef struct VBoxGuestStatistics
370{
371 /** Reported statistics */
372 uint32_t u32StatCaps;
373 /** CPU load (0-100) */
374 uint32_t u32CpuLoad;
375 /** Nr of threads */
376 uint32_t u32Threads;
377 /** Nr of processes */
378 uint32_t u32Processes;
379 /** Total physical memory (megabytes) */
380 uint32_t u32PhysMemTotal;
381 /** Available physical memory (megabytes) */
382 uint32_t u32PhysMemAvail;
383 /** Ballooned physical memory (megabytes) */
384 uint32_t u32PhysMemBalloon;
385 /** Pagefile size (megabytes) */
386 uint32_t u32PageFileSize;
387} VBoxGuestStatistics;
388
389/** guest statistics command structure */
390typedef struct
391{
392 /** header */
393 VMMDevRequestHeader header;
394 /** Guest information. */
395 VBoxGuestStatistics guestStats;
396} VMMDevReportGuestStats;
397
398/** memory balloon change request structure */
399#define VMMDEV_MAX_MEMORY_BALLOON(PhysMemTotal) ((90*PhysMemTotal)/100)
400
401typedef struct
402{
403 /** header */
404 VMMDevRequestHeader header;
405 uint32_t u32BalloonSize;
406 uint32_t eventAck;
407} VMMDevGetMemBalloonChangeRequest;
408
409/** inflate/deflate memory balloon structure */
410#define VMMDEV_MEMORY_BALLOON_CHUNK_PAGES (_1M/4096)
411
412typedef struct
413{
414 /** header */
415 VMMDevRequestHeader header;
416 uint32_t cPages;
417 uint32_t fInflate; /* true = inflate, false = defalte */
418 RTGCPHYS aPhysPage[1]; /* variable size */
419} VMMDevChangeMemBalloon;
420
421/** guest statistics interval change request structure */
422typedef struct
423{
424 /** header */
425 VMMDevRequestHeader header;
426 uint32_t u32StatInterval; /* interval in seconds */
427 uint32_t eventAck;
428} VMMDevGetStatisticsChangeRequest;
429
430/** display change request structure */
431typedef struct
432{
433 /** header */
434 VMMDevRequestHeader header;
435 /** horizontal pixel resolution (0 = do not change) */
436 uint32_t xres;
437 /** vertical pixel resolution (0 = do not change) */
438 uint32_t yres;
439 /** bits per pixel (0 = do not change) */
440 uint32_t bpp;
441 /** Flag that the request is an acknowlegement for the VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST.
442 * Values: 0 - just querying, VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST - event acknowledged.
443 */
444 uint32_t eventAck;
445} VMMDevDisplayChangeRequest;
446
447typedef struct
448{
449 /** header */
450 VMMDevRequestHeader header;
451 /** horizontal pixel resolution (0 = do not change) */
452 uint32_t xres;
453 /** vertical pixel resolution (0 = do not change) */
454 uint32_t yres;
455 /** bits per pixel (0 = do not change) */
456 uint32_t bpp;
457 /** Flag that the request is an acknowlegement for the VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST.
458 * Values: 0 - just querying, VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST - event acknowledged.
459 */
460 uint32_t eventAck;
461 /** 0 for primary display, 1 for the first secondary, etc. */
462 uint32_t display;
463} VMMDevDisplayChangeRequest2;
464
465/** video mode supported request structure */
466typedef struct
467{
468 /** header */
469 VMMDevRequestHeader header;
470 /** horizontal pixel resolution (input) */
471 uint32_t width;
472 /** vertical pixel resolution (input) */
473 uint32_t height;
474 /** bits per pixel (input) */
475 uint32_t bpp;
476 /** supported flag (output) */
477 bool fSupported;
478} VMMDevVideoModeSupportedRequest;
479
480/** video modes height reduction request structure */
481typedef struct
482{
483 /** header */
484 VMMDevRequestHeader header;
485 /** height reduction in pixels (output) */
486 uint32_t heightReduction;
487} VMMDevGetHeightReductionRequest;
488
489#define VRDP_EXPERIENCE_LEVEL_ZERO 0 /* Theming disabled. */
490#define VRDP_EXPERIENCE_LEVEL_LOW 1 /* Full window dragging and desktop wallpaper disabled. */
491#define VRDP_EXPERIENCE_LEVEL_MEDIUM 2 /* Font smoothing, gradients. */
492#define VRDP_EXPERIENCE_LEVEL_HIGH 3 /* Animation effects disabled. */
493#define VRDP_EXPERIENCE_LEVEL_FULL 4 /* Everything enabled. */
494
495typedef struct
496{
497 /** header */
498 VMMDevRequestHeader header;
499 /** Whether VRDP is active or not */
500 uint8_t u8VRDPActive;
501 /** The configured experience level for active VRDP. */
502 uint32_t u32VRDPExperienceLevel;
503} VMMDevVRDPChangeRequest;
504
505
506
507#pragma pack()
508
509#ifdef VBOX_HGCM
510
511/** HGCM flags.
512 * @{
513 */
514#define VBOX_HGCM_REQ_DONE (0x1)
515#define VBOX_HGCM_REQ_CANCELLED (0x2)
516/** @} */
517
518#pragma pack(4)
519typedef struct _VMMDevHGCMRequestHeader
520{
521 /** Request header. */
522 VMMDevRequestHeader header;
523
524 /** HGCM flags. */
525 uint32_t fu32Flags;
526
527 /** Result code. */
528 int32_t result;
529} VMMDevHGCMRequestHeader;
530
531/** HGCM service location types. */
532typedef enum
533{
534 VMMDevHGCMLoc_Invalid = 0,
535 VMMDevHGCMLoc_LocalHost = 1,
536 VMMDevHGCMLoc_LocalHost_Existing = 2,
537 VMMDevHGCMLoc_SizeHack = 0x7fffffff
538} HGCMServiceLocationType;
539
540typedef struct
541{
542 char achName[128];
543} HGCMServiceLocationHost;
544
545typedef struct HGCMSERVICELOCATION
546{
547 /** Type of the location. */
548 HGCMServiceLocationType type;
549
550 union
551 {
552 HGCMServiceLocationHost host;
553 } u;
554} HGCMServiceLocation;
555
556typedef struct
557{
558 /* request header */
559 VMMDevHGCMRequestHeader header;
560
561 /** IN: Description of service to connect to. */
562 HGCMServiceLocation loc;
563
564 /** OUT: Client identifier assigned by local instance of HGCM. */
565 uint32_t u32ClientID;
566} VMMDevHGCMConnect;
567
568typedef struct
569{
570 /* request header */
571 VMMDevHGCMRequestHeader header;
572
573 /** IN: Client identifier. */
574 uint32_t u32ClientID;
575} VMMDevHGCMDisconnect;
576
577typedef enum
578{
579 VMMDevHGCMParmType_Invalid = 0,
580 VMMDevHGCMParmType_32bit = 1,
581 VMMDevHGCMParmType_64bit = 2,
582 VMMDevHGCMParmType_PhysAddr = 3,
583 VMMDevHGCMParmType_LinAddr = 4, /**< In and Out */
584 VMMDevHGCMParmType_LinAddr_In = 5, /**< In (read; host<-guest) */
585 VMMDevHGCMParmType_LinAddr_Out = 6, /**< Out (write; host->guest) */
586 VMMDevHGCMParmType_LinAddr_Locked = 7, /**< Locked In and Out */
587 VMMDevHGCMParmType_LinAddr_Locked_In = 8, /**< Locked In (read; host<-guest) */
588 VMMDevHGCMParmType_LinAddr_Locked_Out = 9, /**< Locked Out (write; host->guest) */
589 VMMDevHGCMParmType_SizeHack = 0x7fffffff
590} HGCMFunctionParameterType;
591
592typedef struct _HGCMFUNCTIONPARAMETER
593{
594 HGCMFunctionParameterType type;
595 union
596 {
597 uint32_t value32;
598 uint64_t value64;
599 struct
600 {
601 uint32_t size;
602
603 union
604 {
605 vmmDevHypPhys physAddr;
606 vmmDevHypPtr linearAddr;
607 } u;
608 } Pointer;
609 } u;
610} HGCMFunctionParameter;
611
612typedef struct
613{
614 /* request header */
615 VMMDevHGCMRequestHeader header;
616
617 /** IN: Client identifier. */
618 uint32_t u32ClientID;
619 /** IN: Service function number. */
620 uint32_t u32Function;
621 /** IN: Number of parameters. */
622 uint32_t cParms;
623 /** Parameters follow in form: HGCMFunctionParameter aParms[X]; */
624} VMMDevHGCMCall;
625#pragma pack()
626
627#define VMMDEV_HGCM_CALL_PARMS(a) ((HGCMFunctionParameter *)((char *)a + sizeof (VMMDevHGCMCall)))
628
629#define VBOX_HGCM_MAX_PARMS 32
630
631#endif /* VBOX_HGCM */
632
633
634#define VBVA_F_STATUS_ACCEPTED (0x01)
635#define VBVA_F_STATUS_ENABLED (0x02)
636
637#pragma pack(4)
638
639typedef struct _VMMDevVideoAccelEnable
640{
641 /* request header */
642 VMMDevRequestHeader header;
643
644 /** 0 - disable, !0 - enable. */
645 uint32_t u32Enable;
646
647 /** The size of VBVAMEMORY::au8RingBuffer expected by driver.
648 * The host will refuse to enable VBVA if the size is not equal to
649 * VBVA_RING_BUFFER_SIZE.
650 */
651 uint32_t cbRingBuffer;
652
653 /** Guest initializes the status to 0. Host sets appropriate VBVA_F_STATUS_ flags. */
654 uint32_t fu32Status;
655
656} VMMDevVideoAccelEnable;
657
658typedef struct _VMMDevVideoAccelFlush
659{
660 /* request header */
661 VMMDevRequestHeader header;
662
663} VMMDevVideoAccelFlush;
664
665
666typedef struct _VMMDevVideoSetVisibleRegion
667{
668 /* request header */
669 VMMDevRequestHeader header;
670
671 /** Number of rectangles */
672 uint32_t cRect;
673
674 /** Rectangle array */
675 RTRECT Rect;
676} VMMDevVideoSetVisibleRegion;
677
678
679/** Seamless mode */
680typedef enum
681{
682 VMMDev_Seamless_Disabled = 0, /* normal mode; entire guest desktop displayed */
683 VMMDev_Seamless_Visible_Region = 1, /* visible region mode; only top-level guest windows displayed */
684 VMMDev_Seamless_Host_Window = 2 /* windowed mode; each top-level guest window is represented in a host window */
685} VMMDevSeamlessMode;
686
687typedef struct
688{
689 /** header */
690 VMMDevRequestHeader header;
691
692 /** New seamless mode */
693 VMMDevSeamlessMode mode;
694 /** Flag that the request is an acknowlegement for the VMMDEV_EVENT_SEAMLESS_MODE_CHANGE_REQUEST.
695 * Values: 0 - just querying, VMMDEV_EVENT_SEAMLESS_MODE_CHANGE_REQUEST - event acknowledged.
696 */
697 uint32_t eventAck;
698} VMMDevSeamlessChangeRequest;
699
700#pragma pack()
701
702#pragma pack(1)
703
704/** VBVA command header. */
705typedef struct _VBVACMDHDR
706{
707 /** Coordinates of affected rectangle. */
708 int16_t x;
709 int16_t y;
710 uint16_t w;
711 uint16_t h;
712} VBVACMDHDR;
713
714/* VBVA order codes. Must be >= 0, because the VRDP server internally
715 * uses negative values to mark some operations.
716 * Values are important since they are used as an index in the
717 * "supported orders" bit mask.
718 */
719#define VBVA_VRDP_DIRTY_RECT (0)
720#define VBVA_VRDP_SOLIDRECT (1)
721#define VBVA_VRDP_SOLIDBLT (2)
722#define VBVA_VRDP_DSTBLT (3)
723#define VBVA_VRDP_SCREENBLT (4)
724#define VBVA_VRDP_PATBLTBRUSH (5)
725#define VBVA_VRDP_MEMBLT (6)
726#define VBVA_VRDP_CACHED_BITMAP (7)
727#define VBVA_VRDP_DELETED_BITMAP (8)
728#define VBVA_VRDP_LINE (9)
729#define VBVA_VRDP_BOUNDS (10)
730#define VBVA_VRDP_REPEAT (11)
731#define VBVA_VRDP_POLYLINE (12)
732#define VBVA_VRDP_ELLIPSE (13)
733#define VBVA_VRDP_SAVESCREEN (14)
734
735#define VBVA_VRDP_INDEX_TO_BIT(__index) (1 << (__index))
736
737#ifndef VRDP_NO_COM
738/* 128 bit bitmap hash. */
739typedef uint8_t VRDPBITMAPHASH[16];
740
741typedef struct _VRDPORDERPOINT
742{
743 int16_t x;
744 int16_t y;
745} VRDPORDERPOINT;
746
747typedef struct _VRDPORDERPOLYPOINTS
748{
749 uint8_t c;
750 VRDPORDERPOINT a[16];
751} VRDPORDERPOLYPOINTS;
752
753typedef struct _VRDPORDERAREA
754{
755 int16_t x;
756 int16_t y;
757 uint16_t w;
758 uint16_t h;
759} VRDPORDERAREA;
760
761typedef struct _VRDPORDERBOUNDS
762{
763 VRDPORDERPOINT pt1;
764 VRDPORDERPOINT pt2;
765} VRDPORDERBOUNDS;
766
767typedef struct _VRDPORDERREPEAT
768{
769 VRDPORDERBOUNDS bounds;
770} VRDPORDERREPEAT;
771
772
773/* Header for bitmap bits in VBVA VRDP operations. */
774typedef struct _VRDPDATABITS
775{
776 /* Size of bitmap data without the header. */
777 uint32_t cb;
778 int16_t x;
779 int16_t y;
780 uint16_t cWidth;
781 uint16_t cHeight;
782 uint8_t cbPixel;
783} VRDPDATABITS;
784
785typedef struct _VRDPORDERSOLIDRECT
786{
787 int16_t x;
788 int16_t y;
789 uint16_t w;
790 uint16_t h;
791 uint32_t rgb;
792} VRDPORDERSOLIDRECT;
793
794typedef struct _VRDPORDERSOLIDBLT
795{
796 int16_t x;
797 int16_t y;
798 uint16_t w;
799 uint16_t h;
800 uint32_t rgb;
801 uint8_t rop;
802} VRDPORDERSOLIDBLT;
803
804typedef struct _VRDPORDERDSTBLT
805{
806 int16_t x;
807 int16_t y;
808 uint16_t w;
809 uint16_t h;
810 uint8_t rop;
811} VRDPORDERDSTBLT;
812
813typedef struct _VRDPORDERSCREENBLT
814{
815 int16_t x;
816 int16_t y;
817 uint16_t w;
818 uint16_t h;
819 int16_t xSrc;
820 int16_t ySrc;
821 uint8_t rop;
822} VRDPORDERSCREENBLT;
823
824typedef struct _VRDPORDERPATBLTBRUSH
825{
826 int16_t x;
827 int16_t y;
828 uint16_t w;
829 uint16_t h;
830 int8_t xSrc;
831 int8_t ySrc;
832 uint32_t rgbFG;
833 uint32_t rgbBG;
834 uint8_t rop;
835 uint8_t pattern[8];
836} VRDPORDERPATBLTBRUSH;
837
838typedef struct _VRDPORDERMEMBLT
839{
840 int16_t x;
841 int16_t y;
842 uint16_t w;
843 uint16_t h;
844 int16_t xSrc;
845 int16_t ySrc;
846 uint8_t rop;
847 VRDPBITMAPHASH hash;
848} VRDPORDERMEMBLT;
849
850typedef struct _VRDPORDERCACHEDBITMAP
851{
852 VRDPBITMAPHASH hash;
853 /* VRDPDATABITS and the bitmap data follows. */
854} VRDPORDERCACHEDBITMAP;
855
856typedef struct _VRDPORDERDELETEDBITMAP
857{
858 VRDPBITMAPHASH hash;
859} VRDPORDERDELETEDBITMAP;
860
861typedef struct _VRDPORDERLINE
862{
863 int16_t x1;
864 int16_t y1;
865 int16_t x2;
866 int16_t y2;
867 int16_t xBounds1;
868 int16_t yBounds1;
869 int16_t xBounds2;
870 int16_t yBounds2;
871 uint8_t mix;
872 uint32_t rgb;
873} VRDPORDERLINE;
874
875typedef struct _VRDPORDERPOLYLINE
876{
877 VRDPORDERPOINT ptStart;
878 uint8_t mix;
879 uint32_t rgb;
880 VRDPORDERPOLYPOINTS points;
881} VRDPORDERPOLYLINE;
882
883typedef struct _VRDPORDERELLIPSE
884{
885 VRDPORDERPOINT pt1;
886 VRDPORDERPOINT pt2;
887 uint8_t mix;
888 uint8_t fillMode;
889 uint32_t rgb;
890} VRDPORDERELLIPSE;
891
892typedef struct _VRDPORDERSAVESCREEN
893{
894 VRDPORDERPOINT pt1;
895 VRDPORDERPOINT pt2;
896 uint8_t ident;
897 uint8_t restore;
898} VRDPORDERSAVESCREEN;
899#endif /* VRDP_NO_COM */
900#pragma pack()
901
902/* The VBVA ring buffer is suitable for transferring large (< 2gb) amount of data.
903 * For example big bitmaps which do not fit to the buffer.
904 *
905 * Guest starts writing to the buffer by initializing a record entry in the
906 * aRecords queue. VBVA_F_RECORD_PARTIAL indicates that the record is being
907 * written. As data is written to the ring buffer, the guest increases off32End
908 * for the record.
909 *
910 * The host reads the aRecords on flushes and processes all completed records.
911 * When host encounters situation when only a partial record presents and
912 * cbRecord & ~VBVA_F_RECORD_PARTIAL >= VBVA_RING_BUFFER_SIZE - VBVA_RING_BUFFER_THRESHOLD,
913 * the host fetched all record data and updates off32Head. After that on each flush
914 * the host continues fetching the data until the record is completed.
915 *
916 */
917
918#define VBVA_RING_BUFFER_SIZE (_4M - _1K)
919#define VBVA_RING_BUFFER_THRESHOLD (4 * _1K)
920
921#define VBVA_MAX_RECORDS (64)
922
923#define VBVA_F_MODE_ENABLED (0x00000001)
924#define VBVA_F_MODE_VRDP (0x00000002)
925#define VBVA_F_MODE_VRDP_RESET (0x00000004)
926#define VBVA_F_MODE_VRDP_ORDER_MASK (0x00000008)
927
928#define VBVA_F_RECORD_PARTIAL (0x80000000)
929
930#pragma pack(1)
931typedef struct _VBVARECORD
932{
933 /** The length of the record. Changed by guest. */
934 uint32_t cbRecord;
935} VBVARECORD;
936
937typedef struct _VBVAMEMORY
938{
939 /** VBVA_F_MODE_* */
940 uint32_t fu32ModeFlags;
941
942 /** The offset where the data start in the buffer. */
943 uint32_t off32Data;
944 /** The offset where next data must be placed in the buffer. */
945 uint32_t off32Free;
946
947 /** The ring buffer for data. */
948 uint8_t au8RingBuffer[VBVA_RING_BUFFER_SIZE];
949
950 /** The queue of record descriptions. */
951 VBVARECORD aRecords[VBVA_MAX_RECORDS];
952 uint32_t indexRecordFirst;
953 uint32_t indexRecordFree;
954
955 /* RDP orders supported by the client. The guest reports only them
956 * and falls back to DIRTY rects for not supported ones.
957 *
958 * (1 << VBVA_VRDP_*)
959 */
960 uint32_t fu32SupportedOrders;
961
962} VBVAMEMORY;
963#pragma pack()
964
965/** @} */
966
967
968/**
969 * VMMDev RAM
970 * @{
971 */
972
973#pragma pack(1)
974/** Layout of VMMDEV RAM region that contains information for guest */
975typedef struct
976{
977 /** size */
978 uint32_t u32Size;
979 /** version */
980 uint32_t u32Version;
981
982 union {
983 /** Flag telling that VMMDev set the IRQ and acknowlegment is required */
984 struct {
985 bool fHaveEvents;
986 } V1_04;
987
988 struct {
989 /** Pending events flags, set by host. */
990 uint32_t u32HostEvents;
991 /** Mask of events the guest wants to see, set by guest. */
992 uint32_t u32GuestEventMask;
993 } V1_03;
994 } V;
995
996 VBVAMEMORY vbvaMemory;
997
998} VMMDevMemory;
999#pragma pack()
1000
1001/** Version of VMMDevMemory structure. */
1002#define VMMDEV_MEMORY_VERSION (1)
1003
1004/** @} */
1005
1006
1007/**
1008 * VMMDev events.
1009 * @{
1010 */
1011
1012/** Host mouse capabilities has been changed. */
1013#define VMMDEV_EVENT_MOUSE_CAPABILITIES_CHANGED BIT(0)
1014/** HGCM event. */
1015#define VMMDEV_EVENT_HGCM BIT(1)
1016/** A display change request has been issued. */
1017#define VMMDEV_EVENT_DISPLAY_CHANGE_REQUEST BIT(2)
1018/** Credentials are available for judgement. */
1019#define VMMDEV_EVENT_JUDGE_CREDENTIALS BIT(3)
1020/** The guest has been restored. */
1021#define VMMDEV_EVENT_RESTORED BIT(4)
1022/** Seamless mode state changed */
1023#define VMMDEV_EVENT_SEAMLESS_MODE_CHANGE_REQUEST BIT(5)
1024/** Memory balloon size changed */
1025#define VMMDEV_EVENT_BALLOON_CHANGE_REQUEST BIT(6)
1026/** Statistics interval changed */
1027#define VMMDEV_EVENT_STATISTICS_INTERVAL_CHANGE_REQUEST BIT(7)
1028/** VRDP status changed. */
1029#define VMMDEV_EVENT_VRDP BIT(7)
1030
1031
1032/** @} */
1033
1034
1035/**
1036 * VBoxGuest IOCTL codes and structures.
1037 *
1038 * The range 0..15 is for basic driver communication.
1039 * The range 16..31 is for HGCM communcation.
1040 * The range 32..47 is reserved for future use.
1041 * The range 48..63 is for OS specific communcation.
1042 * The 7th bit is reserved for future hacks.
1043 * The 8th bit is reserved for distinguishing between 32-bit and 64-bit
1044 * processes in future 64-bit guest additions.
1045 *
1046 * While windows IOCTL function number has to start at 2048 and stop at 4096 there
1047 * never was any need to do this for everyone. A simple ((Function) | 0x800) would
1048 * have sufficed. On Linux we're now intruding upon the type field. Fortunately
1049 * this hasn't caused any trouble because the FILE_DEVICE_UNKNOWN value was set
1050 * to 0x22 (if it were 0x2C it would not have worked soo smoothly). The situation
1051 * would've been the same for *BSD and Darwin since they seems to share common
1052 * _IOC() heritage.
1053 *
1054 * However, on good old OS/2 we only have 8-bit handy for the function number. The
1055 * result from using the old IOCTL function numbers her would've been overlapping
1056 * between the two ranges.
1057 *
1058 * To fix this problem and get rid of all the unnecessary windowsy crap that I
1059 * bet was copied from my SUPDRVIOC.h once upon a time (although the concept of
1060 * prefixing macros with the purpose of avoid clashes with system stuff and
1061 * to indicate exactly how owns them seems to have been lost somewhere along
1062 * the way), I've introduced a VBOXGUEST_IOCTL_CODE for defining generic IN/OUT
1063 * IOCtls on new ports of the additions.
1064 *
1065 * @remark When creating new IOCtl interfaces keep in mind that not all OSes supports
1066 * reporting back the output size. (This got messed up a little bit in VBoxDrv.)
1067 *
1068 * OS/2 restricts the in/out data size to 64KB, while Linux, BSD and Darwin are
1069 * limited by a 14 bits size field (16KB). So, special considerations need to
1070 * be taken if more input/output needs to be passed around.
1071 *
1072 * When passing variable sized input/output special care need to be taken on
1073 * Unix platforms (if we're going to play by the rules) since the size is
1074 * passed as part of the IOCtl code there. IIRC Darwin will use the size to
1075 * perform locking and in/out copying, I don't quite know about linux and *BSD.
1076 *
1077 * @remark If adding interfaces that only has input or only has output, some new macros
1078 * needs to be created so the most efficient IOCtl data buffering method can be
1079 * used.
1080 *
1081 * @{
1082 */
1083#ifdef RT_ARCH_AMD64
1084# define VBOXGUEST_IOCTL_FLAG 128
1085#elif defined(RT_ARCH_X86)
1086# define VBOXGUEST_IOCTL_FLAG 0
1087#else
1088# error "dunno which arch this is!"
1089#endif
1090
1091#if defined(RT_OS_WINDOWS)
1092# define IOCTL_CODE(DeviceType, Function, Method, Access, DataSize_ignored) \
1093 ( ((DeviceType) << 16) | ((Access) << 14) | ((Function) << 2) | (Method))
1094
1095#elif defined(RT_OS_OS2)
1096# define VBOXGUEST_IOCTL_CATEGORY 0xc2
1097# define VBOXGUEST_IOCTL_CODE(Function, Size) ((unsigned char)(Function))
1098# define VBOXGUEST_IOCTL_CATEGORY_FAST 0xc3 /**< Also defined in VBoxGuestA-os2.asm. */
1099# define VBOXGUEST_IOCTL_CODE_FAST(Function) ((unsigned char)(Function))
1100
1101#elif defined(RT_OS_LINUX)
1102# define IOCTL_CODE(DeviceType, Function, Method_ignored, Access_ignored, DataSize) \
1103 ( (3 << 30) | ((DeviceType) << 8) | (Function) | ((DataSize) << 16) )
1104# define METHOD_BUFFERED 0
1105# define FILE_WRITE_ACCESS 0x0002
1106# define FILE_DEVICE_UNKNOWN 0x00000022
1107
1108#elif 0 /* BSD style - needs some adjusting _IORW takes a type and not a size. */
1109# include <sys/ioccom.h>
1110# define VBOXGUEST_IOCTL_CODE(Function, Size) _IORW('V', (Function) | VBOXGUEST_IOCTL_FLAG, (Size))
1111# define VBOXGUEST_IOCTL_CODE_FAST(Function) _IO( 'V', (Function) | VBOXGUEST_IOCTL_FLAG)
1112
1113#else
1114/* PORTME */
1115#endif
1116
1117/** IOCTL to VBoxGuest to query the VMMDev IO port region start. */
1118#ifdef VBOXGUEST_IOCTL_CODE
1119# define VBOXGUEST_IOCTL_GETVMMDEVPORT VBOXGUEST_IOCTL_CODE(1, sizeof(VBoxGuestPortInfo))
1120# define IOCTL_VBOXGUEST_GETVMMDEVPORT VBOXGUEST_IOCTL_GETVMMDEVPORT
1121#else
1122# define IOCTL_VBOXGUEST_GETVMMDEVPORT IOCTL_CODE(FILE_DEVICE_UNKNOWN, 2048, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof(VBoxGuestPortInfo))
1123#endif
1124
1125#pragma pack(4)
1126typedef struct _VBoxGuestPortInfo
1127{
1128 uint32_t portAddress;
1129 VMMDevMemory *pVMMDevMemory;
1130} VBoxGuestPortInfo;
1131
1132/** IOCTL to VBoxGuest to wait for a VMMDev host notification */
1133#ifdef VBOXGUEST_IOCTL_CODE
1134# define VBOXGUEST_IOCTL_WAITEVENT VBOXGUEST_IOCTL_CODE(2, sizeof(VBoxGuestWaitEventInfo))
1135# define IOCTL_VBOXGUEST_WAITEVENT VBOXGUEST_IOCTL_WAITEVENT
1136#else
1137# define IOCTL_VBOXGUEST_WAITEVENT IOCTL_CODE(FILE_DEVICE_UNKNOWN, 2049, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof(VBoxGuestWaitEventInfo))
1138#endif
1139
1140/**
1141 * Result codes for VBoxGuestWaitEventInfo::u32Result
1142 * @{
1143 */
1144/** Successful completion, an event occured. */
1145#define VBOXGUEST_WAITEVENT_OK (0)
1146/** Successful completion, timed out. */
1147#define VBOXGUEST_WAITEVENT_TIMEOUT (1)
1148/** Wait was interrupted. */
1149#define VBOXGUEST_WAITEVENT_INTERRUPTED (2)
1150/** An error occured while processing the request. */
1151#define VBOXGUEST_WAITEVENT_ERROR (3)
1152/** @} */
1153
1154/** Input and output buffers layout of the IOCTL_VBOXGUEST_WAITEVENT */
1155typedef struct _VBoxGuestWaitEventInfo
1156{
1157 /** timeout in milliseconds */
1158 uint32_t u32TimeoutIn;
1159 /** events to wait for */
1160 uint32_t u32EventMaskIn;
1161 /** result code */
1162 uint32_t u32Result;
1163 /** events occured */
1164 uint32_t u32EventFlagsOut;
1165} VBoxGuestWaitEventInfo;
1166
1167/** IOCTL to VBoxGuest to perform a VMM request
1168 * @remark The data buffer for this IOCtl has an variable size, keep this in mind
1169 * on systems where this matters. */
1170#ifdef VBOXGUEST_IOCTL_CODE
1171# define VBOXGUEST_IOCTL_VMMREQUEST(Size) VBOXGUEST_IOCTL_CODE(3, sizeof(VMMDevRequestHeader))
1172# define IOCTL_VBOXGUEST_VMMREQUEST VBOXGUEST_IOCTL_VMMREQUEST(sizeof(VMMDevRequestHeader))
1173#else
1174# define IOCTL_VBOXGUEST_VMMREQUEST IOCTL_CODE(FILE_DEVICE_UNKNOWN, 2050, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof(VMMDevRequestHeader))
1175#endif
1176
1177/** Input and output buffer layout of the IOCTL_VBOXGUEST_CTL_FILTER_MASK. */
1178typedef struct _VBoxGuestFilterMaskInfo
1179{
1180 uint32_t u32OrMask;
1181 uint32_t u32NotMask;
1182} VBoxGuestFilterMaskInfo;
1183#pragma pack()
1184
1185/** IOCTL to VBoxGuest to control event filter mask */
1186#ifdef VBOXGUEST_IOCTL_CODE
1187# define VBOXGUEST_IOCTL_CTL_FILTER_MASK VBOXGUEST_IOCTL_CODE(4, sizeof(VBoxGuestFilterMaskInfo))
1188# define IOCTL_VBOXGUEST_CTL_FILTER_MASK VBOXGUEST_IOCTL_CTL_FILTER_MASK
1189#else
1190# define IOCTL_VBOXGUEST_CTL_FILTER_MASK IOCTL_CODE(FILE_DEVICE_UNKNOWN, 2051, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof (VBoxGuestFilterMaskInfo))
1191#endif
1192
1193/** IOCTL to VBoxGuest to check memory ballooning */
1194#ifdef VBOXGUEST_IOCTL_CODE
1195# define VBOXGUEST_IOCTL_CTL_CHECK_BALLOON_MASK VBOXGUEST_IOCTL_CODE(4, 100)
1196# define IOCTL_VBOXGUEST_CTL_CHECK_BALLOON VBOXGUEST_IOCTL_CTL_CHECK_BALLOON_MASK
1197#else
1198# define IOCTL_VBOXGUEST_CTL_CHECK_BALLOON IOCTL_CODE(FILE_DEVICE_UNKNOWN, 2052, METHOD_BUFFERED, FILE_WRITE_ACCESS, 0)
1199#endif
1200
1201#ifdef VBOX_HGCM
1202/* These structures are shared between the driver and other binaries,
1203 * therefore packing must be defined explicitely.
1204 */
1205#pragma pack(1)
1206typedef struct _VBoxGuestHGCMConnectInfo
1207{
1208 uint32_t result; /**< OUT */
1209 HGCMServiceLocation Loc; /**< IN */
1210 uint32_t u32ClientID; /**< OUT */
1211} VBoxGuestHGCMConnectInfo;
1212
1213typedef struct _VBoxGuestHGCMDisconnectInfo
1214{
1215 uint32_t result; /**< OUT */
1216 uint32_t u32ClientID; /**< IN */
1217} VBoxGuestHGCMDisconnectInfo;
1218
1219typedef struct _VBoxGuestHGCMCallInfo
1220{
1221 uint32_t result; /**< OUT Host HGCM return code.*/
1222 uint32_t u32ClientID; /**< IN The id of the caller. */
1223 uint32_t u32Function; /**< IN Function number. */
1224 uint32_t cParms; /**< IN How many parms. */
1225 /* Parameters follow in form HGCMFunctionParameter aParms[cParms] */
1226} VBoxGuestHGCMCallInfo;
1227#pragma pack()
1228
1229#ifdef VBOXGUEST_IOCTL_CODE
1230# define VBOXGUEST_IOCTL_HGCM_CONNECT VBOXGUEST_IOCTL_CODE(16, sizeof(VBoxGuestHGCMConnectInfo))
1231# define IOCTL_VBOXGUEST_HGCM_CONNECT VBOXGUEST_IOCTL_HGCM_CONNECT
1232# define VBOXGUEST_IOCTL_HGCM_DISCONNECT VBOXGUEST_IOCTL_CODE(17, sizeof(VBoxGuestHGCMDisconnectInfo))
1233# define IOCTL_VBOXGUEST_HGCM_DISCONNECT VBOXGUEST_IOCTL_HGCM_DISCONNECT
1234# define VBOXGUEST_IOCTL_HGCM_CALL(Size) VBOXGUEST_IOCTL_CODE(18, (Size))
1235# define IOCTL_VBOXGUEST_HGCM_CALL VBOXGUEST_IOCTL_HGCM_CALL(sizeof(VBoxGuestHGCMCallInfo))
1236# define VBOXGUEST_IOCTL_CLIPBOARD_CONNECT VBOXGUEST_IOCTL_CODE(19, sizeof(uint32_t))
1237# define IOCTL_VBOXGUEST_CLIPBOARD_CONNECT VBOXGUEST_IOCTL_CLIPBOARD_CONNECT
1238#else
1239# define IOCTL_VBOXGUEST_HGCM_CONNECT IOCTL_CODE(FILE_DEVICE_UNKNOWN, 3072, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof(VBoxGuestHGCMConnectInfo))
1240# define IOCTL_VBOXGUEST_HGCM_DISCONNECT IOCTL_CODE(FILE_DEVICE_UNKNOWN, 3073, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof(VBoxGuestHGCMDisconnectInfo))
1241# define IOCTL_VBOXGUEST_HGCM_CALL IOCTL_CODE(FILE_DEVICE_UNKNOWN, 3074, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof(VBoxGuestHGCMCallInfo))
1242# define IOCTL_VBOXGUEST_CLIPBOARD_CONNECT IOCTL_CODE(FILE_DEVICE_UNKNOWN, 3075, METHOD_BUFFERED, FILE_WRITE_ACCESS, sizeof(uint32_t))
1243#endif
1244
1245#define VBOXGUEST_HGCM_CALL_PARMS(a) ((HGCMFunctionParameter *)((uint8_t *)(a) + sizeof (VBoxGuestHGCMCallInfo)))
1246
1247#endif /* VBOX_HGCM */
1248
1249/*
1250 * Credentials request flags and structure
1251 */
1252
1253#define VMMDEV_CREDENTIALS_STRLEN 128
1254
1255/** query from host whether credentials are present */
1256#define VMMDEV_CREDENTIALS_QUERYPRESENCE BIT(1)
1257/** read credentials from host (can be combined with clear) */
1258#define VMMDEV_CREDENTIALS_READ BIT(2)
1259/** clear credentials on host (can be combined with read) */
1260#define VMMDEV_CREDENTIALS_CLEAR BIT(3)
1261/** read credentials for judgement in the guest */
1262#define VMMDEV_CREDENTIALS_READJUDGE BIT(8)
1263/** clear credentials for judegement on the host */
1264#define VMMDEV_CREDENTIALS_CLEARJUDGE BIT(9)
1265/** report credentials acceptance by guest */
1266#define VMMDEV_CREDENTIALS_JUDGE_OK BIT(10)
1267/** report credentials denial by guest */
1268#define VMMDEV_CREDENTIALS_JUDGE_DENY BIT(11)
1269/** report that no judgement could be made by guest */
1270#define VMMDEV_CREDENTIALS_JUDGE_NOJUDGEMENT BIT(12)
1271
1272/** flag telling the guest that credentials are present */
1273#define VMMDEV_CREDENTIALS_PRESENT BIT(16)
1274/** flag telling guest that local logons should be prohibited */
1275#define VMMDEV_CREDENTIALS_NOLOCALLOGON BIT(17)
1276
1277/** credentials request structure */
1278#pragma pack(4)
1279typedef struct _VMMDevCredentials
1280{
1281 /* request header */
1282 VMMDevRequestHeader header;
1283 /* request flags (in/out) */
1284 uint32_t u32Flags;
1285 /* user name (UTF-8) (out) */
1286 char szUserName[VMMDEV_CREDENTIALS_STRLEN];
1287 /* password (UTF-8) (out) */
1288 char szPassword[VMMDEV_CREDENTIALS_STRLEN];
1289 /* domain name (UTF-8) (out) */
1290 char szDomain[VMMDEV_CREDENTIALS_STRLEN];
1291} VMMDevCredentials;
1292#pragma pack()
1293
1294/** inline helper to determine the request size for the given operation */
1295DECLINLINE(size_t) vmmdevGetRequestSize(VMMDevRequestType requestType)
1296{
1297 switch (requestType)
1298 {
1299 case VMMDevReq_GetMouseStatus:
1300 case VMMDevReq_SetMouseStatus:
1301 return sizeof(VMMDevReqMouseStatus);
1302 case VMMDevReq_SetPointerShape:
1303 return sizeof(VMMDevReqMousePointer);
1304 case VMMDevReq_GetHostVersion:
1305 return sizeof(VMMDevReqHostVersion);
1306 case VMMDevReq_Idle:
1307 return sizeof(VMMDevReqIdle);
1308 case VMMDevReq_GetHostTime:
1309 return sizeof(VMMDevReqHostTime);
1310 case VMMDevReq_GetHypervisorInfo:
1311 case VMMDevReq_SetHypervisorInfo:
1312 return sizeof(VMMDevReqHypervisorInfo);
1313 case VMMDevReq_SetPowerStatus:
1314 return sizeof(VMMDevPowerStateRequest);
1315 case VMMDevReq_AcknowledgeEvents:
1316 return sizeof(VMMDevEvents);
1317 case VMMDevReq_ReportGuestInfo:
1318 return sizeof(VMMDevReportGuestInfo);
1319 case VMMDevReq_GetDisplayChangeRequest:
1320 return sizeof(VMMDevDisplayChangeRequest);
1321 case VMMDevReq_GetDisplayChangeRequest2:
1322 return sizeof(VMMDevDisplayChangeRequest2);
1323 case VMMDevReq_VideoModeSupported:
1324 return sizeof(VMMDevVideoModeSupportedRequest);
1325 case VMMDevReq_GetHeightReduction:
1326 return sizeof(VMMDevGetHeightReductionRequest);
1327 case VMMDevReq_ReportGuestCapabilities:
1328 return sizeof(VMMDevReqGuestCapabilities);
1329#ifdef VBOX_HGCM
1330 case VMMDevReq_HGCMConnect:
1331 return sizeof(VMMDevHGCMConnect);
1332 case VMMDevReq_HGCMDisconnect:
1333 return sizeof(VMMDevHGCMDisconnect);
1334 case VMMDevReq_HGCMCall:
1335 return sizeof(VMMDevHGCMCall);
1336#endif
1337 case VMMDevReq_VideoAccelEnable:
1338 return sizeof(VMMDevVideoAccelEnable);
1339 case VMMDevReq_VideoAccelFlush:
1340 return sizeof(VMMDevVideoAccelFlush);
1341 case VMMDevReq_VideoSetVisibleRegion:
1342 return sizeof(VMMDevVideoSetVisibleRegion);
1343 case VMMDevReq_GetSeamlessChangeRequest:
1344 return sizeof(VMMDevSeamlessChangeRequest);
1345 case VMMDevReq_QueryCredentials:
1346 return sizeof(VMMDevCredentials);
1347 case VMMDevReq_ReportGuestStats:
1348 return sizeof(VMMDevReportGuestStats);
1349 case VMMDevReq_GetMemBalloonChangeRequest:
1350 return sizeof(VMMDevGetMemBalloonChangeRequest);
1351 case VMMDevReq_GetStatisticsChangeRequest:
1352 return sizeof(VMMDevGetStatisticsChangeRequest);
1353 case VMMDevReq_ChangeMemBalloon:
1354 return sizeof(VMMDevChangeMemBalloon);
1355 case VMMDevReq_GetVRDPChangeRequest:
1356 return sizeof(VMMDevVRDPChangeRequest);
1357 case VMMDevReq_LogString:
1358 return sizeof(VMMDevReqLogString);
1359 default:
1360 return 0;
1361 }
1362}
1363
1364/**
1365 * Initializes a request structure.
1366 *
1367 */
1368DECLINLINE(int) vmmdevInitRequest(VMMDevRequestHeader *req, VMMDevRequestType type)
1369{
1370 uint32_t requestSize;
1371 if (!req)
1372 return VERR_INVALID_PARAMETER;
1373 requestSize = (uint32_t)vmmdevGetRequestSize(type);
1374 if (!requestSize)
1375 return VERR_INVALID_PARAMETER;
1376 req->size = requestSize;
1377 req->version = VMMDEV_REQUEST_HEADER_VERSION;
1378 req->requestType = type;
1379 req->rc = VERR_GENERAL_FAILURE;
1380 req->reserved1 = 0;
1381 req->reserved2 = 0;
1382 return VINF_SUCCESS;
1383}
1384
1385
1386#ifdef RT_OS_OS2
1387
1388/**
1389 * The data buffer layout for the IDC entry point (AttachDD).
1390 *
1391 * @remark This is defined in multiple 16-bit headers / sources.
1392 * Some places it's called VBGOS2IDC to short things a bit.
1393 */
1394typedef struct VBOXGUESTOS2IDCCONNECT
1395{
1396 /** VMMDEV_VERSION. */
1397 uint32_t u32Version;
1398 /** Opaque session handle. */
1399 uint32_t u32Session;
1400
1401 /**
1402 * The 32-bit service entry point.
1403 *
1404 * @returns VBox status code.
1405 * @param u32Session The above session handle.
1406 * @param iFunction The requested function.
1407 * @param pvData The input/output data buffer. The caller ensures that this
1408 * cannot be swapped out, or that it's acceptable to take a
1409 * page in fault in the current context. If the request doesn't
1410 * take input or produces output, apssing NULL is okay.
1411 * @param cbData The size of the data buffer.
1412 * @param pcbDataReturned Where to store the amount of data that's returned.
1413 * This can be NULL if pvData is NULL.
1414 */
1415 DECLCALLBACKMEMBER(int, pfnServiceEP)(uint32_t u32Session, unsigned iFunction, void *pvData, size_t cbData, size_t *pcbDataReturned);
1416
1417 /** The 16-bit service entry point for C code (cdecl).
1418 *
1419 * It's the same as the 32-bit entry point, but the types has
1420 * changed to 16-bit equivalents.
1421 *
1422 * @code
1423 * int far cdecl
1424 * VBoxGuestOs2IDCService16(uint32_t u32Session, uint16_t iFunction,
1425 * void far *fpvData, uint16_t cbData, uint16_t far *pcbDataReturned);
1426 * @endcode
1427 */
1428 RTFAR16 fpfnServiceEP;
1429
1430 /** The 16-bit service entry point for Assembly code (register).
1431 *
1432 * This is just a wrapper around fpfnServiceEP to simplify calls
1433 * from 16-bit assembly code.
1434 *
1435 * @returns (e)ax: VBox status code; cx: The amount of data returned.
1436 *
1437 * @param u32Session eax - The above session handle.
1438 * @param iFunction dl - The requested function.
1439 * @param pvData es:bx - The input/output data buffer.
1440 * @param cbData cx - The size of the data buffer.
1441 */
1442 RTFAR16 fpfnServiceAsmEP;
1443} VBOXGUESTOS2IDCCONNECT;
1444/** Pointer to VBOXGUESTOS2IDCCONNECT buffer. */
1445typedef VBOXGUESTOS2IDCCONNECT *PVBOXGUESTOS2IDCCONNECT;
1446
1447/** OS/2 specific: IDC client disconnect request.
1448 *
1449 * This takes no input and it doesn't return anything. Obviously this
1450 * is only recognized if it arrives thru the IDC service EP.
1451 */
1452#define VBOXGUEST_IOCTL_OS2_IDC_DISCONNECT VBOXGUEST_IOCTL_CODE(48, sizeof(uint32_t))
1453
1454#endif /* RT_OS_OS2 */
1455
1456/** @} */
1457
1458
1459#ifdef IN_RING3
1460
1461/** @def VBGLR3DECL
1462 * Ring 3 VBGL declaration.
1463 * @param type The return type of the function declaration.
1464 */
1465#define VBGLR3DECL(type) type VBOXCALL
1466
1467/* General-purpose functions */
1468
1469__BEGIN_DECLS
1470VBGLR3DECL(int) VbglR3Init(void);
1471VBGLR3DECL(void) VbglR3Term(void);
1472VBGLR3DECL(int) VbglR3GRPerform(VMMDevRequestHeader *pReq);
1473# ifdef __iprt_time_h__
1474VBGLR3DECL(int) VbglR3GetHostTime(PRTTIMESPEC pTime);
1475# endif
1476VBGLR3DECL(int) VbglR3InterruptEventWaits(void);
1477
1478/* Shared clipboard */
1479
1480VBGLR3DECL(int) VbglR3ClipboardConnect(uint32_t *pu32ClientId);
1481VBGLR3DECL(int) VbglR3ClipboardDisconnect(uint32_t u32ClientId);
1482VBGLR3DECL(int) VbglR3ClipboardGetHostMsg(uint32_t u32ClientId, uint32_t *pMsg, uint32_t *pfFormats);
1483VBGLR3DECL(int) VbglR3ClipboardReadData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb, uint32_t *pcb);
1484VBGLR3DECL(int) VbglR3ClipboardReportFormats(uint32_t u32ClientId, uint32_t fFormats);
1485VBGLR3DECL(int) VbglR3ClipboardWriteData(uint32_t u32ClientId, uint32_t fFormat, void *pv, uint32_t cb);
1486
1487/* Seamless mode */
1488
1489VBGLR3DECL(int) VbglR3SeamlessSetCap(bool bState);
1490VBGLR3DECL(int) VbglR3SeamlessWaitEvent(VMMDevSeamlessMode *pMode);
1491VBGLR3DECL(int) VbglR3SeamlessSendRects(uint32_t cRects, PRTRECT pRects);
1492
1493__END_DECLS
1494
1495#endif /* IN_RING3 */
1496
1497#endif
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