diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-06 03:01:46 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-05-06 03:01:46 +0000 |
commit | f8fe689a81f906d1b91bb3220acde2a4ecb14c5b (patch) | |
tree | 26484e9d7e2c67806c2d1760196ff01aaa858e8c /src/VBox/Devices/Graphics/HGSMI/HGSMIHost.h | |
parent | Initial commit. (diff) | |
download | virtualbox-f8fe689a81f906d1b91bb3220acde2a4ecb14c5b.tar.xz virtualbox-f8fe689a81f906d1b91bb3220acde2a4ecb14c5b.zip |
Adding upstream version 6.0.4-dfsg.upstream/6.0.4-dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/VBox/Devices/Graphics/HGSMI/HGSMIHost.h')
-rw-r--r-- | src/VBox/Devices/Graphics/HGSMI/HGSMIHost.h | 113 |
1 files changed, 113 insertions, 0 deletions
diff --git a/src/VBox/Devices/Graphics/HGSMI/HGSMIHost.h b/src/VBox/Devices/Graphics/HGSMI/HGSMIHost.h new file mode 100644 index 00000000..2876f43a --- /dev/null +++ b/src/VBox/Devices/Graphics/HGSMI/HGSMIHost.h @@ -0,0 +1,113 @@ +/* $Id: HGSMIHost.h $ */ +/** @file + * VBox Host Guest Shared Memory Interface (HGSMI), host part. + */ + +/* + * Copyright (C) 2006-2019 Oracle Corporation + * + * This file is part of VirtualBox Open Source Edition (OSE), as + * available from http://www.virtualbox.org. This file is free software; + * you can redistribute it and/or modify it under the terms of the GNU + * General Public License (GPL) as published by the Free Software + * Foundation, in version 2 as it comes in the "COPYING" file of the + * VirtualBox OSE distribution. VirtualBox OSE is distributed in the + * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind. + */ + +#ifndef VBOX_INCLUDED_SRC_Graphics_HGSMI_HGSMIHost_h +#define VBOX_INCLUDED_SRC_Graphics_HGSMI_HGSMIHost_h +#ifndef RT_WITHOUT_PRAGMA_ONCE +# pragma once +#endif + +#include <VBox/vmm/vm.h> + +#include <HGSMI.h> +#include <HGSMIChSetup.h> + +struct HGSMIINSTANCE; +typedef struct HGSMIINSTANCE *PHGSMIINSTANCE; + +/** Callback for the guest notification about a new host buffer. */ +typedef DECLCALLBACK(void) FNHGSMINOTIFYGUEST(void *pvCallback); +typedef FNHGSMINOTIFYGUEST *PFNHGSMINOTIFYGUEST; + +/* + * Public Host API for virtual devices. + */ + +int HGSMICreate(PHGSMIINSTANCE *ppIns, + PVM pVM, + const char *pszName, + HGSMIOFFSET offBase, + uint8_t *pu8MemBase, + HGSMISIZE cbMem, + PFNHGSMINOTIFYGUEST pfnNotifyGuest, + void *pvNotifyGuest, + size_t cbContext); +void HGSMIDestroy(PHGSMIINSTANCE pIns); +void *HGSMIContext(PHGSMIINSTANCE pIns); + +void RT_UNTRUSTED_VOLATILE_GUEST *HGSMIOffsetToPointerHost(PHGSMIINSTANCE pIns, HGSMIOFFSET offBuffer); +HGSMIOFFSET HGSMIPointerToOffsetHost(PHGSMIINSTANCE pIns, const void RT_UNTRUSTED_VOLATILE_GUEST *pv); +bool HGSMIIsOffsetValid(PHGSMIINSTANCE pIns, HGSMIOFFSET offBuffer); +HGSMIOFFSET HGSMIGetAreaOffset(PHGSMIINSTANCE pIns); +HGSMIOFFSET HGSMIGetAreaSize(PHGSMIINSTANCE pIns); + + +int HGSMIHostChannelRegister(PHGSMIINSTANCE pIns, uint8_t u8Channel, + PFNHGSMICHANNELHANDLER pfnChannelHandler, void *pvChannelHandler); +#if 0 /* unused */ +int HGSMIChannelRegisterName (PHGSMIINSTANCE pIns, + const char *pszChannel, + PFNHGSMICHANNELHANDLER pfnChannelHandler, + void *pvChannelHandler, + uint8_t *pu8Channel); +#endif + +int HGSMIHostHeapSetup(PHGSMIINSTANCE pIns, HGSMIOFFSET RT_UNTRUSTED_GUEST offHeap, HGSMISIZE RT_UNTRUSTED_GUEST cbHeap); + +/* + * Virtual hardware IO handlers. + */ + +/* Guests passes a new command buffer to the host. */ +void HGSMIGuestWrite(PHGSMIINSTANCE pIns, HGSMIOFFSET offBuffer); + +/* Guest reads information about guest buffers. */ +HGSMIOFFSET HGSMIGuestRead(PHGSMIINSTANCE pIns); + +/* Guest reads the host FIFO to get a command. */ +HGSMIOFFSET HGSMIHostRead(PHGSMIINSTANCE pIns); + +/* Guest reports that the command at this offset has been processed. */ +void HGSMIHostWrite(PHGSMIINSTANCE pIns, HGSMIOFFSET offBuffer); + +void HGSMISetHostGuestFlags(PHGSMIINSTANCE pIns, uint32_t flags); +uint32_t HGSMIGetHostGuestFlags(HGSMIINSTANCE *pIns); + +void HGSMIClearHostGuestFlags(PHGSMIINSTANCE pIns, uint32_t flags); + +/* + * Low level interface for submitting buffers to the guest. + * + * These functions are not directly available for anyone but the + * virtual hardware device. + */ + +/* Allocate a buffer in the host heap. */ +int HGSMIHostCommandAlloc(PHGSMIINSTANCE pIns, void RT_UNTRUSTED_VOLATILE_GUEST **ppvData, HGSMISIZE cbData, + uint8_t u8Channel, uint16_t u16ChannelInfo); +int HGSMIHostCommandSubmitAndFreeAsynch(PHGSMIINSTANCE pIns, void RT_UNTRUSTED_VOLATILE_GUEST *pvData, bool fDoIrq); +int HGSMIHostCommandFree(PHGSMIINSTANCE pIns, void RT_UNTRUSTED_VOLATILE_GUEST *pvData); + +int HGSMIHostLoadStateExec(PHGSMIINSTANCE pIns, PSSMHANDLE pSSM, uint32_t u32Version); +int HGSMIHostSaveStateExec(PHGSMIINSTANCE pIns, PSSMHANDLE pSSM); + +#ifdef VBOX_WITH_WDDM +int HGSMICompleteGuestCommand(PHGSMIINSTANCE pIns, void RT_UNTRUSTED_VOLATILE_GUEST *pvMem, bool fDoIrq); +#endif + +#endif /* !VBOX_INCLUDED_SRC_Graphics_HGSMI_HGSMIHost_h */ + |