ubuntu/vbox/include/VBox/VMMDev2.h

   1 /** @file
   2  * Virtual Device for Guest <-> VMM/Host communication, Mixed Up Mess. (ADD,DEV)
   3  */
   4
   5 /*
   6  * Copyright (C) 2006-2016 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_VMMDev2_h
  27 #define ___VBox_VMMDev2_h
  28
  29 #include <iprt/assert.h>
  30
  31
  32 /** @addtogroup grp_vmmdev
  33  * @{
  34  */
  35
  36
  37 /**
  38  * Seamless mode.
  39  *
  40  * Used by VbglR3SeamlessWaitEvent
  41  *
  42  * @ingroup grp_vmmdev_req
  43  *
  44  * @todo DARN! DARN! DARN! Who forgot to do the 32-bit hack here???
  45  *       FIXME! XXX!
  46  *
  47  *       We will now have to carefully check how our compilers have treated this
  48  *       flag. If any are compressing it into a byte type, we'll have to check
  49  *       how the request memory is initialized. If we are 104% sure it's ok to
  50  *       expand it, we'll expand it. If not, we must redefine the field to a
  51  *       uint8_t and a 3 byte padding.
  52  */
  53 typedef enum
  54 {
  55     VMMDev_Seamless_Disabled         = 0,     /**< normal mode; entire guest desktop displayed. */
  56     VMMDev_Seamless_Visible_Region   = 1,     /**< visible region mode; only top-level guest windows displayed. */
  57     VMMDev_Seamless_Host_Window      = 2      /**< windowed mode; each top-level guest window is represented in a host window. */
  58 } VMMDevSeamlessMode;
  59
  60 /**
  61  * CPU event types.
  62  *
  63  * Used by VbglR3CpuHotplugWaitForEvent
  64  *
  65  * @ingroup grp_vmmdev_req
  66  */
  67 typedef enum
  68 {
  69     VMMDevCpuEventType_Invalid  = 0,
  70     VMMDevCpuEventType_None     = 1,
  71     VMMDevCpuEventType_Plug     = 2,
  72     VMMDevCpuEventType_Unplug   = 3,
  73     VMMDevCpuEventType_SizeHack = 0x7fffffff
  74 } VMMDevCpuEventType;
  75
  76 /**
  77  * HGCM service location types.
  78  * @ingroup grp_vmmdev_req
  79  */
  80 typedef enum
  81 {
  82     VMMDevHGCMLoc_Invalid    = 0,
  83     VMMDevHGCMLoc_LocalHost  = 1,
  84     VMMDevHGCMLoc_LocalHost_Existing = 2,
  85     VMMDevHGCMLoc_SizeHack   = 0x7fffffff
  86 } HGCMServiceLocationType;
  87 AssertCompileSize(HGCMServiceLocationType, 4);
  88
  89 /**
  90  * HGCM host service location.
  91  * @ingroup grp_vmmdev_req
  92  */
  93 typedef struct
  94 {
  95     char achName[128]; /**< This is really szName. */
  96 } HGCMServiceLocationHost;
  97 AssertCompileSize(HGCMServiceLocationHost, 128);
  98
  99 /**
 100  * HGCM service location.
 101  * @ingroup grp_vmmdev_req
 102  */
 103 typedef struct HGCMSERVICELOCATION
 104 {
 105     /** Type of the location. */
 106     HGCMServiceLocationType type;
 107
 108     union
 109     {
 110         HGCMServiceLocationHost host;
 111     } u;
 112 } HGCMServiceLocation;
 113 AssertCompileSize(HGCMServiceLocation, 128+4);
 114
 115 /* forward declarations: */
 116 struct VMMDevReqMousePointer;
 117 struct VMMDevMemory;
 118
 119 /** @} */
 120
 121 #endif
 122