1 | /* $Id: HGCM.h 75500 2018-11-16 01:24:39Z vboxsync $ */
|
---|
2 | /** @file
|
---|
3 | * HGCM - Host-Guest Communication Manager.
|
---|
4 | */
|
---|
5 |
|
---|
6 | /*
|
---|
7 | * Copyright (C) 2006-2017 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 |
|
---|
18 | #ifndef ___HGCM_h_
|
---|
19 | #define ___HGCM_h_
|
---|
20 |
|
---|
21 | #include <VBox/cdefs.h>
|
---|
22 | #include <VBox/types.h>
|
---|
23 | #include <VBox/vmm/pdmifs.h>
|
---|
24 |
|
---|
25 | #include <VBox/VMMDev.h>
|
---|
26 | #include <VBox/hgcmsvc.h>
|
---|
27 |
|
---|
28 | /* HGCM saved state version */
|
---|
29 | #define HGCM_SSM_VERSION 2
|
---|
30 |
|
---|
31 | /* Handle of a HGCM service extension. */
|
---|
32 | struct _HGCMSVCEXTHANDLEDATA;
|
---|
33 | typedef struct _HGCMSVCEXTHANDLEDATA *HGCMSVCEXTHANDLE;
|
---|
34 |
|
---|
35 | RT_C_DECLS_BEGIN
|
---|
36 | int HGCMHostInit(void);
|
---|
37 | int HGCMHostShutdown(void);
|
---|
38 |
|
---|
39 | int HGCMHostReset(void);
|
---|
40 |
|
---|
41 | int HGCMHostLoad(const char *pszServiceLibrary, const char *pszServiceName, PUVM pUVM);
|
---|
42 |
|
---|
43 | int HGCMHostRegisterServiceExtension(HGCMSVCEXTHANDLE *pHandle, const char *pszServiceName, PFNHGCMSVCEXT pfnExtension, void *pvExtension);
|
---|
44 | void HGCMHostUnregisterServiceExtension(HGCMSVCEXTHANDLE handle);
|
---|
45 |
|
---|
46 | int HGCMGuestConnect(PPDMIHGCMPORT pHGCMPort, PVBOXHGCMCMD pCmdPtr, const char *pszServiceName, uint32_t *pClientID);
|
---|
47 | int HGCMGuestDisconnect(PPDMIHGCMPORT pHGCMPort, PVBOXHGCMCMD pCmdPtr, uint32_t clientID);
|
---|
48 | int HGCMGuestCall(PPDMIHGCMPORT pHGCMPort, PVBOXHGCMCMD pCmdPtr, uint32_t clientID, uint32_t function, uint32_t cParms,
|
---|
49 | VBOXHGCMSVCPARM *paParms, uint64_t tsArrival);
|
---|
50 |
|
---|
51 | int HGCMHostCall(const char *pszServiceName, uint32_t function, uint32_t cParms, VBOXHGCMSVCPARM aParms[]);
|
---|
52 |
|
---|
53 | #ifdef VBOX_WITH_CRHGSMI
|
---|
54 | int HGCMHostSvcHandleCreate(const char *pszServiceName, HGCMCVSHANDLE * phSvc);
|
---|
55 | int HGCMHostSvcHandleDestroy(HGCMCVSHANDLE hSvc);
|
---|
56 | int HGCMHostFastCallAsync(HGCMCVSHANDLE hSvc, uint32_t function, PVBOXHGCMSVCPARM pParm,
|
---|
57 | PHGCMHOSTFASTCALLCB pfnCompletion, void *pvCompletion);
|
---|
58 | #endif
|
---|
59 |
|
---|
60 | int HGCMHostSaveState(PSSMHANDLE pSSM);
|
---|
61 | int HGCMHostLoadState(PSSMHANDLE pSSM);
|
---|
62 |
|
---|
63 | RT_C_DECLS_END
|
---|
64 |
|
---|
65 | #endif /* !___HGCM_h_ */
|
---|
66 |
|
---|