| 1 | /* $Id: HGCM.h 75991 2018-12-05 20:14:57Z 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 | /* Handle of a HGCM service extension. */
|
|---|
| 29 | struct _HGCMSVCEXTHANDLEDATA;
|
|---|
| 30 | typedef struct _HGCMSVCEXTHANDLEDATA *HGCMSVCEXTHANDLE;
|
|---|
| 31 |
|
|---|
| 32 | RT_C_DECLS_BEGIN
|
|---|
| 33 | int HGCMHostInit(void);
|
|---|
| 34 | int HGCMHostShutdown(bool fUvmIsInvalid = false);
|
|---|
| 35 |
|
|---|
| 36 | int HGCMHostReset(bool fForShutdown);
|
|---|
| 37 |
|
|---|
| 38 | int HGCMHostLoad(const char *pszServiceLibrary, const char *pszServiceName, PUVM pUVM, PPDMIHGCMPORT pHgcmPort);
|
|---|
| 39 |
|
|---|
| 40 | int HGCMHostRegisterServiceExtension(HGCMSVCEXTHANDLE *pHandle, const char *pszServiceName, PFNHGCMSVCEXT pfnExtension, void *pvExtension);
|
|---|
| 41 | void HGCMHostUnregisterServiceExtension(HGCMSVCEXTHANDLE handle);
|
|---|
| 42 |
|
|---|
| 43 | int HGCMGuestConnect(PPDMIHGCMPORT pHGCMPort, PVBOXHGCMCMD pCmdPtr, const char *pszServiceName, uint32_t *pClientID);
|
|---|
| 44 | int HGCMGuestDisconnect(PPDMIHGCMPORT pHGCMPort, PVBOXHGCMCMD pCmdPtr, uint32_t clientID);
|
|---|
| 45 | int HGCMGuestCall(PPDMIHGCMPORT pHGCMPort, PVBOXHGCMCMD pCmdPtr, uint32_t clientID, uint32_t function, uint32_t cParms,
|
|---|
| 46 | VBOXHGCMSVCPARM *paParms, uint64_t tsArrival);
|
|---|
| 47 | void HGCMGuestCancelled(PPDMIHGCMPORT pHGCMPort, PVBOXHGCMCMD pCmdPtr, uint32_t idClient);
|
|---|
| 48 |
|
|---|
| 49 | int HGCMHostCall(const char *pszServiceName, uint32_t function, uint32_t cParms, VBOXHGCMSVCPARM aParms[]);
|
|---|
| 50 | int HGCMBroadcastEvent(HGCMNOTIFYEVENT enmEvent);
|
|---|
| 51 |
|
|---|
| 52 | #ifdef VBOX_WITH_CRHGSMI
|
|---|
| 53 | int HGCMHostSvcHandleCreate(const char *pszServiceName, HGCMCVSHANDLE * phSvc);
|
|---|
| 54 | int HGCMHostSvcHandleDestroy(HGCMCVSHANDLE hSvc);
|
|---|
| 55 | int HGCMHostFastCallAsync(HGCMCVSHANDLE hSvc, uint32_t function, PVBOXHGCMSVCPARM pParm,
|
|---|
| 56 | PHGCMHOSTFASTCALLCB pfnCompletion, void *pvCompletion);
|
|---|
| 57 | #endif
|
|---|
| 58 |
|
|---|
| 59 | int HGCMHostSaveState(PSSMHANDLE pSSM);
|
|---|
| 60 | int HGCMHostLoadState(PSSMHANDLE pSSM, uint32_t uVersion);
|
|---|
| 61 |
|
|---|
| 62 | RT_C_DECLS_END
|
|---|
| 63 |
|
|---|
| 64 | #endif /* !___HGCM_h_ */
|
|---|
| 65 |
|
|---|
