VirtualBox

source: vbox/trunk/include/VBox/VBoxGuest2.h@ 59012

Last change on this file since 59012 was 58111, checked in by vboxsync, 9 years ago

include,misc: More Doxygen grouping adjustments.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 3.4 KB
Line 
1/** @file
2 * VBoxGuest - VirtualBox Guest Additions Driver Interface, Mixed Up Mess.
3 * (ADD,DEV)
4 */
5
6/*
7 * Copyright (C) 2006-2015 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27#ifndef ___VBox_VBoxGuest2_h
28#define ___VBox_VBoxGuest2_h
29
30#include <iprt/assert.h>
31
32#ifdef VBOX_WITH_HGCM
33# include <VBox/VMMDev2.h>
34
35/** @addtogroup grp_vmmdev
36 * @{ */
37
38/**
39 * HGCM connect info structure.
40 *
41 * This is used by VBOXGUEST_IOCTL_HGCM_CONNECT and in VbglR0.
42 *
43 * @ingroup grp_vboxguest
44 */
45# pragma pack(1) /* explicit packing for good measure. */
46typedef struct VBoxGuestHGCMConnectInfo
47{
48 int32_t result; /**< OUT */
49 HGCMServiceLocation Loc; /**< IN */
50 uint32_t u32ClientID; /**< OUT */
51} VBoxGuestHGCMConnectInfo;
52AssertCompileSize(VBoxGuestHGCMConnectInfo, 4+4+128+4);
53# pragma pack()
54
55
56/**
57 * HGCM connect info structure.
58 *
59 * This is used by VBOXGUEST_IOCTL_HGCM_DISCONNECT and in VbglR0.
60 *
61 * @ingroup grp_vboxguest
62 */
63typedef struct VBoxGuestHGCMDisconnectInfo
64{
65 int32_t result; /**< OUT */
66 uint32_t u32ClientID; /**< IN */
67} VBoxGuestHGCMDisconnectInfo;
68AssertCompileSize(VBoxGuestHGCMDisconnectInfo, 8);
69
70/**
71 * HGCM call info structure.
72 *
73 * This is used by VBOXGUEST_IOCTL_HGCM_CALL.
74 *
75 * @ingroup grp_vboxguest
76 */
77typedef struct VBoxGuestHGCMCallInfo
78{
79 int32_t result; /**< OUT Host HGCM return code.*/
80 uint32_t u32ClientID; /**< IN The id of the caller. */
81 uint32_t u32Function; /**< IN Function number. */
82 uint32_t cParms; /**< IN How many parms. */
83 /* Parameters follow in form HGCMFunctionParameter aParms[cParms] */
84} VBoxGuestHGCMCallInfo;
85AssertCompileSize(VBoxGuestHGCMCallInfo, 16);
86
87
88/**
89 * HGCM call info structure.
90 *
91 * This is used by VBOXGUEST_IOCTL_HGCM_CALL_TIMED.
92 *
93 * @ingroup grp_vboxguest
94 */
95# pragma pack(1) /* explicit packing for good measure. */
96typedef struct VBoxGuestHGCMCallInfoTimed
97{
98 uint32_t u32Timeout; /**< IN How long to wait for completion before cancelling the call. */
99 uint32_t fInterruptible; /**< IN Is this request interruptible? */
100 VBoxGuestHGCMCallInfo info; /**< IN/OUT The rest of the call information. Placed after the timeout
101 * so that the parameters follow as they would for a normal call. */
102 /* Parameters follow in form HGCMFunctionParameter aParms[cParms] */
103} VBoxGuestHGCMCallInfoTimed;
104AssertCompileSize(VBoxGuestHGCMCallInfoTimed, 8+16);
105# pragma pack()
106
107/** @} */
108
109#endif /* VBOX_WITH_HGCM */
110
111#endif
112
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