VirtualBox

source: vbox/trunk/include/VBox/pdmapi.h@ 32287

Last change on this file since 32287 was 30072, checked in by vboxsync, 15 years ago

VMM: Ring-0 stack on guru meditations originating with an assertion for all 32-bit targets. The symbol resolving is ugly. Dump register context as well.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 9.1 KB
Line 
1/** @file
2 * PDM - Pluggable Device Manager, Core API. (VMM)
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-2010 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_pdmapi_h
31#define ___VBox_pdmapi_h
32
33#include <VBox/types.h>
34#include <VBox/sup.h>
35#include <VBox/pdmcommon.h>
36
37RT_C_DECLS_BEGIN
38
39/** @defgroup grp_pdm The Pluggable Device Manager API
40 * @{
41 */
42
43VMMDECL(int) PDMGetInterrupt(PVMCPU pVCpu, uint8_t *pu8Interrupt);
44VMMDECL(int) PDMIsaSetIrq(PVM pVM, uint8_t u8Irq, uint8_t u8Level);
45VMMDECL(int) PDMIoApicSetIrq(PVM pVM, uint8_t u8Irq, uint8_t u8Level);
46VMMDECL(bool) PDMHasIoApic(PVM pVM);
47VMMDECL(int) PDMApicHasPendingIrq(PVM pVM, bool *pfPending);
48VMMDECL(int) PDMApicSetBase(PVM pVM, uint64_t u64Base);
49VMMDECL(int) PDMApicGetBase(PVM pVM, uint64_t *pu64Base);
50VMMDECL(int) PDMApicSetTPR(PVMCPU pVCpu, uint8_t u8TPR);
51VMMDECL(int) PDMApicGetTPR(PVMCPU pVCpu, uint8_t *pu8TPR, bool *pfPending);
52VMMDECL(int) PDMApicWriteMSR(PVM pVM, VMCPUID iCpu, uint32_t u32Reg, uint64_t u64Value);
53VMMDECL(int) PDMApicReadMSR(PVM pVM, VMCPUID iCpu, uint32_t u32Reg, uint64_t *pu64Value);
54VMMDECL(int) PDMVMMDevHeapR3ToGCPhys(PVM pVM, RTR3PTR pv, RTGCPHYS *pGCPhys);
55VMMDECL(bool) PDMVMMDevHeapIsEnabled(PVM pVM);
56
57
58/** @defgroup grp_pdm_r3 The PDM Host Context Ring-3 API
59 * @ingroup grp_pdm
60 * @{
61 */
62
63VMMR3DECL(int) PDMR3InitUVM(PUVM pUVM);
64VMMR3DECL(int) PDMR3LdrLoadVMMR0U(PUVM pUVM);
65VMMR3DECL(int) PDMR3Init(PVM pVM);
66VMMR3DECL(void) PDMR3PowerOn(PVM pVM);
67VMMR3DECL(void) PDMR3ResetCpu(PVMCPU pVCpu);
68VMMR3DECL(void) PDMR3Reset(PVM pVM);
69VMMR3DECL(void) PDMR3Suspend(PVM pVM);
70VMMR3DECL(void) PDMR3Resume(PVM pVM);
71VMMR3DECL(void) PDMR3PowerOff(PVM pVM);
72VMMR3DECL(void) PDMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
73VMMR3DECL(int) PDMR3Term(PVM pVM);
74VMMR3DECL(void) PDMR3TermUVM(PUVM pUVM);
75
76/**
77 * Module enumeration callback function.
78 *
79 * @returns VBox status.
80 * Failure will stop the search and return the return code.
81 * Warnings will be ignored and not returned.
82 * @param pVM VM Handle.
83 * @param pszFilename Module filename.
84 * @param pszName Module name. (short and unique)
85 * @param ImageBase Address where to executable image is loaded.
86 * @param cbImage Size of the executable image.
87 * @param fRC Set if raw-mode context, clear if host context.
88 * @param pvArg User argument.
89 */
90typedef DECLCALLBACK(int) FNPDMR3ENUM(PVM pVM, const char *pszFilename, const char *pszName,
91 RTUINTPTR ImageBase, size_t cbImage, bool fRC, void *pvArg);
92/** Pointer to a FNPDMR3ENUM() function. */
93typedef FNPDMR3ENUM *PFNPDMR3ENUM;
94VMMR3DECL(int) PDMR3LdrEnumModules(PVM pVM, PFNPDMR3ENUM pfnCallback, void *pvArg);
95VMMR3DECL(void) PDMR3LdrRelocateU(PUVM pUVM, RTGCINTPTR offDelta);
96VMMR3DECL(int) PDMR3LdrGetSymbolR3(PVM pVM, const char *pszModule, const char *pszSymbol, void **ppvValue);
97VMMR3DECL(int) PDMR3LdrGetSymbolR0(PVM pVM, const char *pszModule, const char *pszSymbol, PRTR0PTR ppvValue);
98VMMR3DECL(int) PDMR3LdrGetSymbolR0Lazy(PVM pVM, const char *pszModule, const char *pszSymbol, PRTR0PTR ppvValue);
99VMMR3DECL(int) PDMR3LdrLoadRC(PVM pVM, const char *pszFilename, const char *pszName);
100VMMR3DECL(int) PDMR3LdrGetSymbolRC(PVM pVM, const char *pszModule, const char *pszSymbol, PRTRCPTR pRCPtrValue);
101VMMR3DECL(int) PDMR3LdrGetSymbolRCLazy(PVM pVM, const char *pszModule, const char *pszSymbol, PRTRCPTR pRCPtrValue);
102VMMR3DECL(int) PDMR3LdrQueryRCModFromPC(PVM pVM, RTRCPTR uPC,
103 char *pszModName, size_t cchModName, PRTRCPTR pMod,
104 char *pszNearSym1, size_t cchNearSym1, PRTRCPTR pNearSym1,
105 char *pszNearSym2, size_t cchNearSym2, PRTRCPTR pNearSym2);
106VMMR3DECL(int) PDMR3LdrQueryR0ModFromPC(PVM pVM, RTR0PTR uPC,
107 char *pszModName, size_t cchModName, PRTR0PTR pMod,
108 char *pszNearSym1, size_t cchNearSym1, PRTR0PTR pNearSym1,
109 char *pszNearSym2, size_t cchNearSym2, PRTR0PTR pNearSym2);
110VMMR3DECL(int) PDMR3LdrGetInterfaceSymbols(PVM pVM, void *pvInterface, size_t cbInterface,
111 const char *pszModule, const char *pszSymPrefix,
112 const char *pszSymList, bool fRing0OrRC);
113
114VMMR3DECL(int) PDMR3QueryDevice(PVM pVM, const char *pszDevice, unsigned iInstance, PPPDMIBASE ppBase);
115VMMR3DECL(int) PDMR3QueryDeviceLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPPDMIBASE ppBase);
116VMMR3DECL(int) PDMR3QueryLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, PPPDMIBASE ppBase);
117VMMR3DECL(int) PDMR3QueryDriverOnLun(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, const char *pszDriver,
118 PPPDMIBASE ppBase);
119VMMR3DECL(int) PDMR3DeviceAttach(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, uint32_t fFlags, PPDMIBASE *ppBase);
120VMMR3DECL(int) PDMR3DeviceDetach(PVM pVM, const char *pszDevice, unsigned iInstance, unsigned iLun, uint32_t fFlags);
121VMMR3DECL(int) PDMR3DriverAttach(PVM pVM, const char *pszDevice, unsigned iDevIns, unsigned iLun, uint32_t fFlags, PPPDMIBASE ppBase);
122VMMR3DECL(int) PDMR3DriverDetach(PVM pVM, const char *pszDevice, unsigned iDevIns, unsigned iLun,
123 const char *pszDriver, unsigned iOccurance, uint32_t fFlags);
124VMMR3DECL(int) PDMR3DriverReattach(PVM pVM, const char *pszDevice, unsigned iDevIns, unsigned iLun,
125 const char *pszDriver, unsigned iOccurance, uint32_t fFlags, PCFGMNODE pCfg, PPPDMIBASE ppBase);
126VMMR3DECL(void) PDMR3DmaRun(PVM pVM);
127VMMR3DECL(int) PDMR3LockCall(PVM pVM);
128VMMR3DECL(int) PDMR3RegisterVMMDevHeap(PVM pVM, RTGCPHYS GCPhys, RTR3PTR pvHeap, unsigned cbSize);
129VMMR3DECL(int) PDMR3VMMDevHeapAlloc(PVM pVM, unsigned cbSize, RTR3PTR *ppv);
130VMMR3DECL(int) PDMR3VMMDevHeapFree(PVM pVM, RTR3PTR pv);
131VMMR3DECL(int) PDMR3UnregisterVMMDevHeap(PVM pVM, RTGCPHYS GCPhys);
132/** @} */
133
134
135
136/** @defgroup grp_pdm_rc The PDM Raw-Mode Context API
137 * @ingroup grp_pdm
138 * @{
139 */
140/** @} */
141
142
143
144/** @defgroup grp_pdm_r0 The PDM Ring-0 Context API
145 * @ingroup grp_pdm
146 * @{
147 */
148
149/**
150 * Request buffer for PDMR0DriverCallReqHandler / VMMR0_DO_PDM_DRIVER_CALL_REQ_HANDLER.
151 * @see PDMR0DriverCallReqHandler.
152 */
153typedef struct PDMDRIVERCALLREQHANDLERREQ
154{
155 /** The header. */
156 SUPVMMR0REQHDR Hdr;
157 /** The driver instance. */
158 PPDMDRVINSR0 pDrvInsR0;
159 /** The operation. */
160 uint32_t uOperation;
161 /** Explicit alignment padding. */
162 uint32_t u32Alignment;
163 /** Optional 64-bit integer argument. */
164 uint64_t u64Arg;
165} PDMDRIVERCALLREQHANDLERREQ;
166/** Pointer to a PDMR0DriverCallReqHandler / VMMR0_DO_PDM_DRIVER_CALL_REQ_HANDLER
167 * request buffer. */
168typedef PDMDRIVERCALLREQHANDLERREQ *PPDMDRIVERCALLREQHANDLERREQ;
169
170VMMR0_INT_DECL(int) PDMR0DriverCallReqHandler(PVM pVM, PPDMDRIVERCALLREQHANDLERREQ pReq);
171
172/**
173 * Request buffer for PDMR0DeviceCallReqHandler / VMMR0_DO_PDM_DEVICE_CALL_REQ_HANDLER.
174 * @see PDMR0DeviceCallReqHandler.
175 */
176typedef struct PDMDEVICECALLREQHANDLERREQ
177{
178 /** The header. */
179 SUPVMMR0REQHDR Hdr;
180 /** The device instance. */
181 PPDMDEVINSR0 pDevInsR0;
182 /** The request handler for the device. */
183 PFNPDMDEVREQHANDLERR0 pfnReqHandlerR0;
184 /** The operation. */
185 uint32_t uOperation;
186 /** Explicit alignment padding. */
187 uint32_t u32Alignment;
188 /** Optional 64-bit integer argument. */
189 uint64_t u64Arg;
190} PDMDEVICECALLREQHANDLERREQ;
191/** Pointer to a PDMR0DeviceCallReqHandler /
192 * VMMR0_DO_PDM_DEVICE_CALL_REQ_HANDLER request buffer. */
193typedef PDMDEVICECALLREQHANDLERREQ *PPDMDEVICECALLREQHANDLERREQ;
194
195VMMR0_INT_DECL(int) PDMR0DeviceCallReqHandler(PVM pVM, PPDMDEVICECALLREQHANDLERREQ pReq);
196
197/** @} */
198
199RT_C_DECLS_END
200
201/** @} */
202
203#endif
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