1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
/** @file
*
* VBox Host Guest Shared Memory Interface (HGSMI).
* Host part.
*/
/*
* Copyright (C) 2006-2010 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 ___HGSMIHost_h
#define ___HGSMIHost_h
#include <VBox/vmm/vm.h>
#include <VBox/HGSMI/HGSMI.h>
#include <VBox/HGSMI/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 *HGSMIOffsetToPointerHost (PHGSMIINSTANCE pIns,
HGSMIOFFSET offBuffer);
HGSMIOFFSET HGSMIPointerToOffsetHost (PHGSMIINSTANCE pIns,
const void *pv);
int HGSMIHostChannelRegister (PHGSMIINSTANCE pIns,
uint8_t u8Channel,
PFNHGSMICHANNELHANDLER pfnChannelHandler,
void *pvChannelHandler,
HGSMICHANNELHANDLER *pOldHandler);
int HGSMIChannelRegisterName (PHGSMIINSTANCE pIns,
const char *pszChannel,
PFNHGSMICHANNELHANDLER pfnChannelHandler,
void *pvChannelHandler,
uint8_t *pu8Channel,
HGSMICHANNELHANDLER *pOldHandler);
int HGSMIChannelHandlerCall (PHGSMIINSTANCE pIns,
const HGSMICHANNELHANDLER *pHandler,
const HGSMIBUFFERHEADER *pHeader);
int HGSMISetupHostHeap (PHGSMIINSTANCE pIns,
HGSMIOFFSET offHeap,
HGSMISIZE cbHeap);
int HGSMISaveStateExec (PHGSMIINSTANCE pIns, PSSMHANDLE pSSM);
int HGSMILoadStateExec (PHGSMIINSTANCE pIns, PSSMHANDLE pSSM);
/*
* 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);
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 **ppvMem,
HGSMISIZE cbMem,
uint8_t u8Channel,
uint16_t u16ChannelInfo);
int HGSMIHostCommandProcess (PHGSMIINSTANCE pIns,
void *pvMem);
int HGSMIHostCommandProcessAndFreeAsynch (PHGSMIINSTANCE pIns,
void *pvMem,
bool bDoIrq);
int HGSMIHostCommandFree (PHGSMIINSTANCE pIns,
void *pvMem);
int HGSMIHostLoadStateExec (PHGSMIINSTANCE pIns, PSSMHANDLE pSSM, uint32_t u32Version);
int HGSMIHostSaveStateExec (PHGSMIINSTANCE pIns, PSSMHANDLE pSSM);
#ifdef VBOX_WITH_WDDM
int HGSMICompleteGuestCommand(PHGSMIINSTANCE pIns, void *pvMem, bool bDoIrq);
#endif
#endif /* !___HGSMIHost_h*/
|
