VirtualBox

source: vbox/trunk/include/VBox/vmm/pdmapi.h@ 93115

Last change on this file since 93115 was 93115, checked in by vboxsync, 3 years ago

scm --update-copyright-year
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 15.3 KB
Line 
1/** @file
2 * PDM - Pluggable Device Manager, Core API.
3 *
4 * The 'Core API' has been put in a different header because everyone
5 * is currently including pdm.h. So, pdm.h is for including all of the
6 * PDM stuff, while pdmapi.h is for the core stuff.
7 */
8
9/*
10 * Copyright (C) 2006-2022 Oracle Corporation
11 *
12 * This file is part of VirtualBox Open Source Edition (OSE), as
13 * available from http://www.virtualbox.org. This file is free software;
14 * you can redistribute it and/or modify it under the terms of the GNU
15 * General Public License (GPL) as published by the Free Software
16 * Foundation, in version 2 as it comes in the "COPYING" file of the
17 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
18 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
19 *
20 * The contents of this file may alternatively be used under the terms
21 * of the Common Development and Distribution License Version 1.0
22 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
23 * VirtualBox OSE distribution, in which case the provisions of the
24 * CDDL are applicable instead of those of the GPL.
25 *
26 * You may elect to license modified versions of this file under the
27 * terms and conditions of either the GPL or the CDDL or both.
28 */
29
30#ifndef VBOX_INCLUDED_vmm_pdmapi_h
31#define VBOX_INCLUDED_vmm_pdmapi_h
32#ifndef RT_WITHOUT_PRAGMA_ONCE
33# pragma once
34#endif
35
36#include <VBox/vmm/pdmcommon.h>
37#ifdef IN_RING3
38# include <VBox/vmm/vmapi.h>
39#endif
40#include <VBox/sup.h>
41
42struct PDMDEVMODREGR0;
43
44RT_C_DECLS_BEGIN
45
46/** @defgroup grp_pdm The Pluggable Device Manager API
47 * @ingroup grp_vmm
48 * @{
49 */
50
51VMMDECL(int) PDMGetInterrupt(PVMCPUCC pVCpu, uint8_t *pu8Interrupt);
52VMMDECL(int) PDMIsaSetIrq(PVMCC pVM, uint8_t u8Irq, uint8_t u8Level, uint32_t uTagSrc);
53VMM_INT_DECL(bool) PDMHasIoApic(PVM pVM);
54VMM_INT_DECL(bool) PDMHasApic(PVM pVM);
55VMM_INT_DECL(int) PDMIoApicSetIrq(PVM pVM, PCIBDF uBusDevFn, uint8_t u8Irq, uint8_t u8Level, uint32_t uTagSrc);
56VMM_INT_DECL(void) PDMIoApicBroadcastEoi(PVMCC pVM, uint8_t uVector);
57VMM_INT_DECL(void) PDMIoApicSendMsi(PVMCC pVM, PCIBDF uBusDevFn, PCMSIMSG pMsi, uint32_t uTagSrc);
58VMM_INT_DECL(int) PDMVmmDevHeapR3ToGCPhys(PVM pVM, RTR3PTR pv, RTGCPHYS *pGCPhys);
59VMM_INT_DECL(bool) PDMVmmDevHeapIsEnabled(PVM pVM);
60
61/**
62 * Mapping/unmapping callback for an VMMDev heap allocation.
63 *
64 * @param pVM The cross context VM structure.
65 * @param pvAllocation The allocation address (ring-3).
66 * @param GCPhysAllocation The guest physical address of the mapping if
67 * it's being mapped, NIL_RTGCPHYS if it's being
68 * unmapped.
69 */
70typedef DECLCALLBACKTYPE(void, FNPDMVMMDEVHEAPNOTIFY,(PVM pVM, void *pvAllocation, RTGCPHYS GCPhysAllocation));
71/** Pointer (ring-3) to a FNPDMVMMDEVHEAPNOTIFY function. */
72typedef R3PTRTYPE(FNPDMVMMDEVHEAPNOTIFY *) PFNPDMVMMDEVHEAPNOTIFY;
73
74
75#if defined(IN_RING3) || defined(DOXYGEN_RUNNING)
76/** @defgroup grp_pdm_r3 The PDM Host Context Ring-3 API
77 * @{
78 */
79VMMR3_INT_DECL(int) PDMR3InitUVM(PUVM pUVM);
80VMMR3_INT_DECL(int) PDMR3LdrLoadVMMR0U(PUVM pUVM);
81VMMR3_INT_DECL(int) PDMR3Init(PVM pVM);
82VMMR3_INT_DECL(int) PDMR3InitCompleted(PVM pVM, VMINITCOMPLETED enmWhat);
83VMMR3DECL(void) PDMR3PowerOn(PVM pVM);
84VMMR3_INT_DECL(bool) PDMR3GetResetInfo(PVM pVM, uint32_t fOverride, uint32_t *pfResetFlags);
85VMMR3_INT_DECL(void) PDMR3ResetCpu(PVMCPU pVCpu);
86VMMR3_INT_DECL(void) PDMR3Reset(PVM pVM);
87VMMR3_INT_DECL(void) PDMR3MemSetup(PVM pVM, bool fAtReset);
88VMMR3_INT_DECL(void) PDMR3SoftReset(PVM pVM, uint32_t fResetFlags);
89VMMR3_INT_DECL(void) PDMR3Suspend(PVM pVM);
90VMMR3_INT_DECL(void) PDMR3Resume(PVM pVM);
91VMMR3DECL(void) PDMR3PowerOff(PVM pVM);
92VMMR3_INT_DECL(void) PDMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
93VMMR3_INT_DECL(int) PDMR3Term(PVM pVM);
94VMMR3_INT_DECL(void) PDMR3TermUVM(PUVM pUVM);
95VMMR3_INT_DECL(bool) PDMR3HasLoadedState(PVM pVM);
96
97/** PDM loader context indicator. */
98typedef enum PDMLDRCTX
99{
100 /** Invalid zero value. */
101 PDMLDRCTX_INVALID = 0,
102 /** Ring-0 context. */
103 PDMLDRCTX_RING_0,
104 /** Ring-3 context. */
105 PDMLDRCTX_RING_3,
106 /** Raw-mode context. */
107 PDMLDRCTX_RAW_MODE,
108 /** End of valid context values. */
109 PDMLDRCTX_END,
110 /** 32-bit type hack. */
111 PDMLDRCTX_32BIT_HACK = 0x7fffffff
112} PDMLDRCTX;
113
114/**
115 * Module enumeration callback function.
116 *
117 * @returns VBox status.
118 * Failure will stop the search and return the return code.
119 * Warnings will be ignored and not returned.
120 * @param pVM The cross context VM structure.
121 * @param pszFilename Module filename.
122 * @param pszName Module name. (short and unique)
123 * @param ImageBase Address where to executable image is loaded.
124 * @param cbImage Size of the executable image.
125 * @param enmCtx The context the module is loaded into.
126 * @param pvArg User argument.
127 */
128typedef DECLCALLBACKTYPE(int, FNPDMR3ENUM,(PVM pVM, const char *pszFilename, const char *pszName,
129 RTUINTPTR ImageBase, size_t cbImage, PDMLDRCTX enmCtx, void *pvArg));
130/** Pointer to a FNPDMR3ENUM() function. */
131typedef FNPDMR3ENUM *PFNPDMR3ENUM;
132VMMR3DECL(int) PDMR3LdrEnumModules(PVM pVM, PFNPDMR3ENUM pfnCallback, void *pvArg);
133VMMR3_INT_DECL(void) PDMR3LdrRelocateU(PUVM pUVM, RTGCINTPTR offDelta);
134VMMR3_INT_DECL(int) PDMR3LdrLoadR0(PUVM pUVM, const char *pszModule, const char *pszSearchPath);
135VMMR3_INT_DECL(int) PDMR3LdrGetSymbolR3(PVM pVM, const char *pszModule, const char *pszSymbol, void **ppvValue);
136VMMR3DECL(int) PDMR3LdrGetSymbolR0(PVM pVM, const char *pszModule, const char *pszSymbol, PRTR0PTR ppvValue);
137VMMR3DECL(int) PDMR3LdrGetSymbolR0Lazy(PVM pVM, const char *pszModule, const char *pszSearchPath, const char *pszSymbol, PRTR0PTR ppvValue);
138VMMR3DECL(int) PDMR3LdrLoadRC(PVM pVM, const char *pszFilename, const char *pszName);
139VMMR3DECL(int) PDMR3LdrGetSymbolRC(PVM pVM, const char *pszModule, const char *pszSymbol, PRTRCPTR pRCPtrValue);
140VMMR3DECL(int) PDMR3LdrGetSymbolRCLazy(PVM pVM, const char *pszModule, const char *pszSearchPath, const char *pszSymbol,
141 PRTRCPTR pRCPtrValue);
142VMMR3_INT_DECL(int) PDMR3LdrQueryRCModFromPC(PVM pVM, RTRCPTR uPC,
143 char *pszModName, size_t cchModName, PRTRCPTR pMod,
144 char *pszNearSym1, size_t cchNearSym1, PRTRCPTR pNearSym1,
145 char *pszNearSym2, size_t cchNearSym2, PRTRCPTR pNearSym2);
146VMMR3_INT_DECL(int) PDMR3LdrQueryR0ModFromPC(PVM pVM, RTR0PTR uPC,
147 char *pszModName, size_t cchModName, PRTR0PTR pMod,
148 char *pszNearSym1, size_t cchNearSym1, PRTR0PTR pNearSym1,
149 char *pszNearSym2, size_t cchNearSym2, PRTR0PTR pNearSym2);
150VMMR3_INT_DECL(int) PDMR3LdrGetInterfaceSymbols(PVM pVM, void *pvInterface, size_t cbInterface,
151 const char *pszModule, const char *pszSearchPath,
152 const char *pszSymPrefix, const char *pszSymList,
153 bool fRing0OrRC);
154
155VMMR3DECL(int) PDMR3QueryDevice(PUVM pUVM, const char *pszDevice, unsigned iInstance, PPPDMIBASE ppBase);
156VMMR3DECL(int) PDMR3QueryDeviceLun(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPPDMIBASE ppBase);
157VMMR3DECL(int) PDMR3QueryLun(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPPDMIBASE ppBase);
158VMMR3DECL(int) PDMR3QueryDriverOnLun(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun,
159 const char *pszDriver, PPPDMIBASE ppBase);
160VMMR3DECL(int) PDMR3DeviceAttach(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, uint32_t fFlags,
161 PPDMIBASE *ppBase);
162VMMR3DECL(int) PDMR3DeviceDetach(PUVM pUVM, const char *pszDevice, unsigned iInstance, unsigned iLun, uint32_t fFlags);
163VMMR3_INT_DECL(PPDMCRITSECT) PDMR3DevGetCritSect(PVM pVM, PPDMDEVINS pDevIns);
164VMMR3DECL(int) PDMR3DriverAttach(PUVM pUVM, const char *pszDevice, unsigned iDevIns, unsigned iLun, uint32_t fFlags,
165 PPPDMIBASE ppBase);
166VMMR3DECL(int) PDMR3DriverDetach(PUVM pUVM, const char *pszDevice, unsigned iDevIns, unsigned iLun,
167 const char *pszDriver, unsigned iOccurrence, uint32_t fFlags);
168VMMR3DECL(int) PDMR3DriverReattach(PUVM pVM, const char *pszDevice, unsigned iDevIns, unsigned iLun,
169 const char *pszDriver, unsigned iOccurrence, uint32_t fFlags, PCFGMNODE pCfg,
170 PPPDMIBASE ppBase);
171VMMR3DECL(void) PDMR3DmaRun(PVM pVM);
172
173VMMR3_INT_DECL(int) PDMR3VmmDevHeapAlloc(PVM pVM, size_t cbSize, PFNPDMVMMDEVHEAPNOTIFY pfnNotify, RTR3PTR *ppv);
174VMMR3_INT_DECL(int) PDMR3VmmDevHeapFree(PVM pVM, RTR3PTR pv);
175VMMR3_INT_DECL(int) PDMR3TracingConfig(PVM pVM, const char *pszName, size_t cchName, bool fEnable, bool fApply);
176VMMR3_INT_DECL(bool) PDMR3TracingAreAll(PVM pVM, bool fEnabled);
177VMMR3_INT_DECL(int) PDMR3TracingQueryConfig(PVM pVM, char *pszConfig, size_t cbConfig);
178/** @} */
179#endif /* IN_RING3 */
180
181
182
183/** @defgroup grp_pdm_rc The PDM Raw-Mode Context API
184 * @{
185 */
186/** @} */
187
188
189
190/** @defgroup grp_pdm_r0 The PDM Ring-0 Context API
191 * @{
192 */
193VMMR0_INT_DECL(void) PDMR0Init(void *hMod);
194VMMR0DECL(int) PDMR0DeviceRegisterModule(void *hMod, struct PDMDEVMODREGR0 *pModReg);
195VMMR0DECL(int) PDMR0DeviceDeregisterModule(void *hMod, struct PDMDEVMODREGR0 *pModReg);
196
197VMMR0_INT_DECL(void) PDMR0InitPerVMData(PGVM pGVM);
198VMMR0_INT_DECL(void) PDMR0CleanupVM(PGVM pGVM);
199
200/**
201 * Request buffer for PDMR0DriverCallReqHandler / VMMR0_DO_PDM_DRIVER_CALL_REQ_HANDLER.
202 * @see PDMR0DriverCallReqHandler.
203 */
204typedef struct PDMDRIVERCALLREQHANDLERREQ
205{
206 /** The header. */
207 SUPVMMR0REQHDR Hdr;
208 /** The driver instance. */
209 PPDMDRVINSR0 pDrvInsR0;
210 /** The operation. */
211 uint32_t uOperation;
212 /** Explicit alignment padding. */
213 uint32_t u32Alignment;
214 /** Optional 64-bit integer argument. */
215 uint64_t u64Arg;
216} PDMDRIVERCALLREQHANDLERREQ;
217/** Pointer to a PDMR0DriverCallReqHandler / VMMR0_DO_PDM_DRIVER_CALL_REQ_HANDLER
218 * request buffer. */
219typedef PDMDRIVERCALLREQHANDLERREQ *PPDMDRIVERCALLREQHANDLERREQ;
220
221VMMR0_INT_DECL(int) PDMR0DriverCallReqHandler(PGVM pGVM, PPDMDRIVERCALLREQHANDLERREQ pReq);
222
223
224/**
225 * Request buffer for PDMR0DeviceCreateReqHandler / VMMR0_DO_PDM_DEVICE_CREATE.
226 * @see PDMR0DeviceCreateReqHandler.
227 */
228typedef struct PDMDEVICECREATEREQ
229{
230 /** The header. */
231 SUPVMMR0REQHDR Hdr;
232 /** Out: Where to return the address of the ring-3 device instance. */
233 PPDMDEVINSR3 pDevInsR3;
234
235 /** Copy of PDMDEVREGR3::fFlags for matching with PDMDEVREGR0::fFlags. */
236 uint32_t fFlags;
237 /** Copy of PDMDEVREGR3::fClass for matching with PDMDEVREGR0::fFlags. */
238 uint32_t fClass;
239 /** Copy of PDMDEVREGR3::cMaxInstances for matching with
240 * PDMDEVREGR0::cMaxInstances. */
241 uint32_t cMaxInstances;
242 /** Copy of PDMDEVREGR3::uSharedVersion for matching with
243 * PDMDEVREGR0::uSharedVersion. */
244 uint32_t uSharedVersion;
245 /** Copy of PDMDEVREGR3::cbInstanceShared for matching with
246 * PDMDEVREGR0::cbInstanceShared. */
247 uint32_t cbInstanceShared;
248 /** Copy of PDMDEVREGR3::cbInstanceCC. */
249 uint32_t cbInstanceR3;
250 /** Copy of PDMDEVREGR3::cbInstanceRC for matching with
251 * PDMDEVREGR0::cbInstanceRC. */
252 uint32_t cbInstanceRC;
253 /** Copy of PDMDEVREGR3::cMaxPciDevices for matching with
254 * PDMDEVREGR0::cMaxPciDevices. */
255 uint16_t cMaxPciDevices;
256 /** Copy of PDMDEVREGR3::cMaxMsixVectors for matching with
257 * PDMDEVREGR0::cMaxMsixVectors. */
258 uint16_t cMaxMsixVectors;
259
260 /** The device instance ordinal. */
261 uint32_t iInstance;
262 /** Set if the raw-mode component is desired. */
263 bool fRCEnabled;
264 /** Explicit padding. */
265 bool afReserved[3];
266 /** DBGF tracer event source handle if configured. */
267 DBGFTRACEREVTSRC hDbgfTracerEvtSrc;
268
269 /** In: Device name. */
270 char szDevName[32];
271 /** In: The module name (no path). */
272 char szModName[32];
273} PDMDEVICECREATEREQ;
274/** Pointer to a PDMR0DeviceCreate / VMMR0_DO_PDM_DEVICE_CREATE request buffer. */
275typedef PDMDEVICECREATEREQ *PPDMDEVICECREATEREQ;
276
277VMMR0_INT_DECL(int) PDMR0DeviceCreateReqHandler(PGVM pGVM, PPDMDEVICECREATEREQ pReq);
278
279/**
280 * The ring-0 device call to make.
281 */
282typedef enum PDMDEVICEGENCALL
283{
284 PDMDEVICEGENCALL_INVALID = 0,
285 PDMDEVICEGENCALL_CONSTRUCT,
286 PDMDEVICEGENCALL_DESTRUCT,
287 PDMDEVICEGENCALL_REQUEST,
288 PDMDEVICEGENCALL_END,
289 PDMDEVICEGENCALL_32BIT_HACK = 0x7fffffff
290} PDMDEVICEGENCALL;
291
292/**
293 * Request buffer for PDMR0DeviceGenCallReqHandler / VMMR0_DO_PDM_DEVICE_GEN_CALL.
294 * @see PDMR0DeviceGenCallReqHandler.
295 */
296typedef struct PDMDEVICEGENCALLREQ
297{
298 /** The header. */
299 SUPVMMR0REQHDR Hdr;
300 /** The ring-3 device instance. */
301 PPDMDEVINSR3 pDevInsR3;
302 /** The ring-0 device handle. */
303 uint32_t idxR0Device;
304 /** The call to make. */
305 PDMDEVICEGENCALL enmCall;
306 union
307 {
308 /** PDMDEVICEGENCALL_REQUEST: */
309 struct
310 {
311 /** The request argument. */
312 uint64_t uArg;
313 /** The request number. */
314 uint32_t uReq;
315 } Req;
316 /** Size padding. */
317 uint64_t au64[3];
318 } Params;
319} PDMDEVICEGENCALLREQ;
320/** Pointer to a PDMR0DeviceGenCallReqHandler / VMMR0_DO_PDM_DEVICE_GEN_CALL request buffer. */
321typedef PDMDEVICEGENCALLREQ *PPDMDEVICEGENCALLREQ;
322
323VMMR0_INT_DECL(int) PDMR0DeviceGenCallReqHandler(PGVM pGVM, PPDMDEVICEGENCALLREQ pReq, VMCPUID idCpu);
324
325/**
326 * Request buffer for PDMR0DeviceCompatSetCritSectReqHandler / VMMR0_DO_PDM_DEVICE_COMPAT_SET_CRITSECT
327 * @see PDMR0DeviceCompatSetCritSectReqHandler.
328 */
329typedef struct PDMDEVICECOMPATSETCRITSECTREQ
330{
331 /** The header. */
332 SUPVMMR0REQHDR Hdr;
333 /** The ring-3 device instance. */
334 PPDMDEVINSR3 pDevInsR3;
335 /** The ring-0 device handle. */
336 uint32_t idxR0Device;
337 /** The critical section address (ring-3). */
338 R3PTRTYPE(PPDMCRITSECT) pCritSectR3;
339} PDMDEVICECOMPATSETCRITSECTREQ;
340/** Pointer to a PDMR0DeviceGenCallReqHandler / VMMR0_DO_PDM_DEVICE_GEN_CALL request buffer. */
341typedef PDMDEVICECOMPATSETCRITSECTREQ *PPDMDEVICECOMPATSETCRITSECTREQ;
342
343VMMR0_INT_DECL(int) PDMR0DeviceCompatSetCritSectReqHandler(PGVM pGVM, PPDMDEVICECOMPATSETCRITSECTREQ pReq);
344
345/** @} */
346
347RT_C_DECLS_END
348
349/** @} */
350
351#endif /* !VBOX_INCLUDED_vmm_pdmapi_h */
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