VirtualBox

source: vbox/trunk/include/VBox/vmm/iom.h@ 53420

Last change on this file since 53420 was 50645, checked in by vboxsync, 11 years ago

s/Port/Memory mapped/ in FNIOMMMIOWRITE and FNIOMMMIOFILL comments.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 17.2 KB
Line 
1/** @file
2 * IOM - Input / Output Monitor.
3 */
4
5/*
6 * Copyright (C) 2006-2013 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26#ifndef ___VBox_vmm_iom_h
27#define ___VBox_vmm_iom_h
28
29#include <VBox/types.h>
30#include <VBox/dis.h>
31
32RT_C_DECLS_BEGIN
33
34
35/** @defgroup grp_iom The Input / Ouput Monitor API
36 * @{
37 */
38
39/** @def IOM_NO_PDMINS_CHECKS
40 * Until all devices have been fully adjusted to PDM style, the pPdmIns
41 * parameter is not checked by IOM.
42 * @todo Check this again, now.
43 */
44#define IOM_NO_PDMINS_CHECKS
45
46/**
47 * Macro for checking if an I/O or MMIO emulation call succeeded.
48 *
49 * This macro shall only be used with the IOM APIs where it's mentioned
50 * in the return value description. And there it must be used to correctly
51 * determine if the call succeeded and things like the RIP needs updating.
52 *
53 *
54 * @returns Success indicator (true/false).
55 *
56 * @param rc The status code. This may be evaluated
57 * more than once!
58 *
59 * @remark To avoid making assumptions about the layout of the
60 * VINF_EM_FIRST...VINF_EM_LAST range we're checking explicitly for
61 * each exact exception. However, for efficiency we ASSUME that the
62 * VINF_EM_LAST is smaller than most of the relevant status codes. We
63 * also ASSUME that the VINF_EM_RESCHEDULE_REM status code is the
64 * most frequent status code we'll enounter in this range.
65 *
66 * @todo Will have to add VINF_EM_DBG_HYPER_BREAKPOINT if the
67 * I/O port and MMIO breakpoints should trigger before
68 * the I/O is done. Currently, we don't implement these
69 * kind of breakpoints.
70 */
71#define IOM_SUCCESS(rc) ( (rc) == VINF_SUCCESS \
72 || ( (rc) <= VINF_EM_LAST \
73 && (rc) != VINF_EM_RESCHEDULE_REM \
74 && (rc) >= VINF_EM_FIRST \
75 && (rc) != VINF_EM_RESCHEDULE_RAW \
76 && (rc) != VINF_EM_RESCHEDULE_HM \
77 ) \
78 )
79
80/** @name IOMMMIO_FLAGS_XXX
81 * @{ */
82/** Pass all reads thru unmodified. */
83#define IOMMMIO_FLAGS_READ_PASSTHRU UINT32_C(0x00000000)
84/** All read accesses are DWORD sized (32-bit). */
85#define IOMMMIO_FLAGS_READ_DWORD UINT32_C(0x00000001)
86/** All read accesses are DWORD (32-bit) or QWORD (64-bit) sized.
87 * Only accesses that are both QWORD sized and aligned are performed as QWORD.
88 * All other access will be done DWORD fashion (because it is way simpler). */
89#define IOMMMIO_FLAGS_READ_DWORD_QWORD UINT32_C(0x00000002)
90/** The read access mode mask. */
91#define IOMMMIO_FLAGS_READ_MODE UINT32_C(0x00000003)
92
93/** Pass all writes thru unmodified. */
94#define IOMMMIO_FLAGS_WRITE_PASSTHRU UINT32_C(0x00000000)
95/** All write accesses are DWORD (32-bit) sized and unspecified bytes are
96 * written as zero. */
97#define IOMMMIO_FLAGS_WRITE_DWORD_ZEROED UINT32_C(0x00000010)
98/** All write accesses are either DWORD (32-bit) or QWORD (64-bit) sized,
99 * missing bytes will be written as zero. Only accesses that are both QWORD
100 * sized and aligned are performed as QWORD, all other accesses will be done
101 * DWORD fashion (because it's way simpler). */
102#define IOMMMIO_FLAGS_WRITE_DWORD_QWORD_ZEROED UINT32_C(0x00000020)
103/** All write accesses are DWORD (32-bit) sized and unspecified bytes are
104 * read from the device first as DWORDs.
105 * @remarks This isn't how it happens on real hardware, but it allows
106 * simplifications of devices where reads doesn't change the device
107 * state in any way. */
108#define IOMMMIO_FLAGS_WRITE_DWORD_READ_MISSING UINT32_C(0x00000030)
109/** All write accesses are DWORD (32-bit) or QWORD (64-bit) sized and
110 * unspecified bytes are read from the device first as DWORDs. Only accesses
111 * that are both QWORD sized and aligned are performed as QWORD, all other
112 * accesses will be done DWORD fashion (because it's way simpler).
113 * @remarks This isn't how it happens on real hardware, but it allows
114 * simplifications of devices where reads doesn't change the device
115 * state in any way. */
116#define IOMMMIO_FLAGS_WRITE_DWORD_QWORD_READ_MISSING UINT32_C(0x00000040)
117/** All write accesses are DWORD (32-bit) sized and aligned, attempts at other
118 * accesses are ignored.
119 * @remarks E1000, APIC */
120#define IOMMMIO_FLAGS_WRITE_ONLY_DWORD UINT32_C(0x00000050)
121/** All write accesses are DWORD (32-bit) or QWORD (64-bit) sized and aligned,
122 * attempts at other accesses are ignored.
123 * @remarks Seemingly required by AHCI (although I doubt it's _really_
124 * required as EM/REM doesn't do the right thing in ring-3 anyway,
125 * esp. not in raw-mode). */
126#define IOMMMIO_FLAGS_WRITE_ONLY_DWORD_QWORD UINT32_C(0x00000060)
127/** The read access mode mask. */
128#define IOMMMIO_FLAGS_WRITE_MODE UINT32_C(0x00000070)
129
130/** Whether to do a DBGSTOP on complicated reads.
131 * What this includes depends on the read mode, but generally all misaligned
132 * reads as well as word and byte reads and maybe qword reads. */
133#define IOMMMIO_FLAGS_DBGSTOP_ON_COMPLICATED_READ UINT32_C(0x00000100)
134/** Whether to do a DBGSTOP on complicated writes.
135 * This depends on the write mode, but generally all writes where we have to
136 * supply bytes (zero them or read them). */
137#define IOMMMIO_FLAGS_DBGSTOP_ON_COMPLICATED_WRITE UINT32_C(0x00000200)
138
139/** Mask of valid flags. */
140#define IOMMMIO_FLAGS_VALID_MASK UINT32_C(0x00000373)
141/** @} */
142
143/**
144 * Checks whether the write mode allows aligned QWORD accesses to be passed
145 * thru to the device handler.
146 * @param a_fFlags The MMIO handler flags.
147 * @remarks The current implementation makes ASSUMPTIONS about the mode values!
148 */
149#define IOMMMIO_DOES_WRITE_MODE_ALLOW_QWORD(a_fFlags) RT_BOOL((a_fFlags) & UINT32_C(0x00000020))
150
151
152/**
153 * Port I/O Handler for IN operations.
154 *
155 * @returns VINF_SUCCESS or VINF_EM_*.
156 * @returns VERR_IOM_IOPORT_UNUSED if the port is really unused and a ~0 value should be returned.
157 *
158 * @param pDevIns The device instance.
159 * @param pvUser User argument.
160 * @param uPort Port number used for the IN operation.
161 * @param pu32 Where to store the result. This is always a 32-bit
162 * variable regardless of what @a cb might say.
163 * @param cb Number of bytes read.
164 * @remarks Caller enters the device critical section.
165 */
166typedef DECLCALLBACK(int) FNIOMIOPORTIN(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb);
167/** Pointer to a FNIOMIOPORTIN(). */
168typedef FNIOMIOPORTIN *PFNIOMIOPORTIN;
169
170/**
171 * Port I/O Handler for string IN operations.
172 *
173 * @returns VINF_SUCCESS or VINF_EM_*.
174 * @returns VERR_IOM_IOPORT_UNUSED if the port is really unused and a ~0 value should be returned.
175 *
176 * @param pDevIns The device instance.
177 * @param pvUser User argument.
178 * @param uPort Port number used for the IN operation.
179 * @param pGCPtrDst Pointer to the destination buffer (GC, incremented appropriately).
180 * @param pcTransfers Pointer to the number of transfer units to read, on return remaining transfer units.
181 * @param cb Size of the transfer unit (1, 2 or 4 bytes).
182 * @remarks Caller enters the device critical section.
183 */
184typedef DECLCALLBACK(int) FNIOMIOPORTINSTRING(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, RTGCPTR *pGCPtrDst, PRTGCUINTREG pcTransfers, unsigned cb);
185/** Pointer to a FNIOMIOPORTINSTRING(). */
186typedef FNIOMIOPORTINSTRING *PFNIOMIOPORTINSTRING;
187
188/**
189 * Port I/O Handler for OUT operations.
190 *
191 * @returns VINF_SUCCESS or VINF_EM_*.
192 *
193 * @param pDevIns The device instance.
194 * @param pvUser User argument.
195 * @param uPort Port number used for the OUT operation.
196 * @param u32 The value to output.
197 * @param cb The value size in bytes.
198 * @remarks Caller enters the device critical section.
199 */
200typedef DECLCALLBACK(int) FNIOMIOPORTOUT(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb);
201/** Pointer to a FNIOMIOPORTOUT(). */
202typedef FNIOMIOPORTOUT *PFNIOMIOPORTOUT;
203
204/**
205 * Port I/O Handler for string OUT operations.
206 *
207 * @returns VINF_SUCCESS or VINF_EM_*.
208 *
209 * @param pDevIns The device instance.
210 * @param pvUser User argument.
211 * @param uPort Port number used for the OUT operation.
212 * @param pGCPtrSrc Pointer to the source buffer (GC, incremented appropriately).
213 * @param pcTransfers Pointer to the number of transfer units to write, on return remaining transfer units.
214 * @param cb Size of the transfer unit (1, 2 or 4 bytes).
215 * @remarks Caller enters the device critical section.
216 */
217typedef DECLCALLBACK(int) FNIOMIOPORTOUTSTRING(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, RTGCPTR *pGCPtrSrc, PRTGCUINTREG pcTransfers, unsigned cb);
218/** Pointer to a FNIOMIOPORTOUTSTRING(). */
219typedef FNIOMIOPORTOUTSTRING *PFNIOMIOPORTOUTSTRING;
220
221
222/**
223 * Memory mapped I/O Handler for read operations.
224 *
225 * @returns VBox status code.
226 *
227 * @param pDevIns The device instance.
228 * @param pvUser User argument.
229 * @param GCPhysAddr Physical address (in GC) where the read starts.
230 * @param pv Where to store the result.
231 * @param cb Number of bytes read.
232 * @remarks Caller enters the device critical section.
233 */
234typedef DECLCALLBACK(int) FNIOMMMIOREAD(PPDMDEVINS pDevIns, void *pvUser, RTGCPHYS GCPhysAddr, void *pv, unsigned cb);
235/** Pointer to a FNIOMMMIOREAD(). */
236typedef FNIOMMMIOREAD *PFNIOMMMIOREAD;
237
238/**
239 * Memory mapped I/O Handler for write operations.
240 *
241 * @returns VBox status code.
242 *
243 * @param pDevIns The device instance.
244 * @param pvUser User argument.
245 * @param GCPhysAddr Physical address (in GC) where the read starts.
246 * @param pv Where to fetch the result.
247 * @param cb Number of bytes to write.
248 * @remarks Caller enters the device critical section.
249 */
250typedef DECLCALLBACK(int) FNIOMMMIOWRITE(PPDMDEVINS pDevIns, void *pvUser, RTGCPHYS GCPhysAddr, void const *pv, unsigned cb);
251/** Pointer to a FNIOMMMIOWRITE(). */
252typedef FNIOMMMIOWRITE *PFNIOMMMIOWRITE;
253
254/**
255 * Memory mapped I/O Handler for memset operations, actually for REP STOS* instructions handling.
256 *
257 * @returns VBox status code.
258 *
259 * @param pDevIns The device instance.
260 * @param pvUser User argument.
261 * @param GCPhysAddr Physical address (in GC) where the write starts.
262 * @param u32Item Byte/Word/Dword data to fill.
263 * @param cbItem Size of data in u32Item parameter, restricted to 1/2/4 bytes.
264 * @param cItems Number of iterations.
265 * @remarks Caller enters the device critical section.
266 */
267typedef DECLCALLBACK(int) FNIOMMMIOFILL(PPDMDEVINS pDevIns, void *pvUser, RTGCPHYS GCPhysAddr, uint32_t u32Item, unsigned cbItem, unsigned cItems);
268/** Pointer to a FNIOMMMIOFILL(). */
269typedef FNIOMMMIOFILL *PFNIOMMMIOFILL;
270
271VMMDECL(VBOXSTRICTRC) IOMIOPortRead(PVM pVM, PVMCPU pVCpu, RTIOPORT Port, uint32_t *pu32Value, size_t cbValue);
272VMMDECL(VBOXSTRICTRC) IOMIOPortWrite(PVM pVM, PVMCPU pVCpu, RTIOPORT Port, uint32_t u32Value, size_t cbValue);
273VMMDECL(VBOXSTRICTRC) IOMInterpretOUT(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, PDISCPUSTATE pCpu);
274VMMDECL(VBOXSTRICTRC) IOMInterpretIN(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, PDISCPUSTATE pCpu);
275VMMDECL(VBOXSTRICTRC) IOMIOPortReadString(PVM pVM, PVMCPU pVCpu, RTIOPORT Port, PRTGCPTR pGCPtrDst, PRTGCUINTREG pcTransfers, unsigned cb);
276VMMDECL(VBOXSTRICTRC) IOMIOPortWriteString(PVM pVM, PVMCPU pVCpu, RTIOPORT Port, PRTGCPTR pGCPtrSrc, PRTGCUINTREG pcTransfers, unsigned cb);
277VMMDECL(VBOXSTRICTRC) IOMInterpretINS(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, PDISCPUSTATE pCpu);
278VMMDECL(VBOXSTRICTRC) IOMInterpretINSEx(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, uint32_t uPort, uint32_t uPrefix, DISCPUMODE enmAddrMode, uint32_t cbTransfer);
279VMMDECL(VBOXSTRICTRC) IOMInterpretOUTS(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, PDISCPUSTATE pCpu);
280VMMDECL(VBOXSTRICTRC) IOMInterpretOUTSEx(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, uint32_t uPort, uint32_t uPrefix, DISCPUMODE enmAddrMode, uint32_t cbTransfer);
281VMMDECL(VBOXSTRICTRC) IOMMMIORead(PVM pVM, PVMCPU pVCpu, RTGCPHYS GCPhys, uint32_t *pu32Value, size_t cbValue);
282VMMDECL(VBOXSTRICTRC) IOMMMIOWrite(PVM pVM, PVMCPU pVCpu, RTGCPHYS GCPhys, uint32_t u32Value, size_t cbValue);
283VMMDECL(VBOXSTRICTRC) IOMMMIOPhysHandler(PVM pVM, PVMCPU pVCpu, RTGCUINT uErrorCode, PCPUMCTXCORE pCtxCore, RTGCPHYS GCPhysFault);
284VMMDECL(VBOXSTRICTRC) IOMInterpretCheckPortIOAccess(PVM pVM, PCPUMCTXCORE pCtxCore, RTIOPORT Port, unsigned cb);
285VMMDECL(int) IOMMMIOMapMMIO2Page(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS GCPhysRemapped, uint64_t fPageFlags);
286VMMDECL(int) IOMMMIOMapMMIOHCPage(PVM pVM, PVMCPU pVCpu, RTGCPHYS GCPhys, RTHCPHYS HCPhys, uint64_t fPageFlags);
287VMMDECL(int) IOMMMIOResetRegion(PVM pVM, RTGCPHYS GCPhys);
288VMMDECL(bool) IOMIsLockWriteOwner(PVM pVM);
289
290#ifdef IN_RC
291/** @defgroup grp_iom_rc The IOM Raw-Mode Context API
292 * @ingroup grp_iom
293 * @{
294 */
295VMMRCDECL(VBOXSTRICTRC) IOMRCIOPortHandler(PVM pVM, PVMCPU pVCpu, PCPUMCTXCORE pRegFrame, PDISCPUSTATE pCpu);
296/** @} */
297#endif /* IN_RC */
298
299
300
301#ifdef IN_RING3
302/** @defgroup grp_iom_r3 The IOM Host Context Ring-3 API
303 * @ingroup grp_iom
304 * @{
305 */
306VMMR3_INT_DECL(int) IOMR3Init(PVM pVM);
307VMMR3_INT_DECL(void) IOMR3Reset(PVM pVM);
308VMMR3_INT_DECL(void) IOMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
309VMMR3_INT_DECL(int) IOMR3Term(PVM pVM);
310VMMR3_INT_DECL(int) IOMR3IOPortRegisterR3(PVM pVM, PPDMDEVINS pDevIns, RTIOPORT PortStart, RTUINT cPorts, RTHCPTR pvUser,
311 R3PTRTYPE(PFNIOMIOPORTOUT) pfnOutCallback, R3PTRTYPE(PFNIOMIOPORTIN) pfnInCallback,
312 R3PTRTYPE(PFNIOMIOPORTOUTSTRING) pfnOutStringCallback, R3PTRTYPE(PFNIOMIOPORTINSTRING) pfnInStringCallback,
313 const char *pszDesc);
314VMMR3_INT_DECL(int) IOMR3IOPortRegisterRC(PVM pVM, PPDMDEVINS pDevIns, RTIOPORT PortStart, RTUINT cPorts, RTRCPTR pvUser,
315 RCPTRTYPE(PFNIOMIOPORTOUT) pfnOutCallback, RCPTRTYPE(PFNIOMIOPORTIN) pfnInCallback,
316 RCPTRTYPE(PFNIOMIOPORTOUTSTRING) pfnOutStrCallback, RCPTRTYPE(PFNIOMIOPORTINSTRING) pfnInStrCallback,
317 const char *pszDesc);
318VMMR3_INT_DECL(int) IOMR3IOPortRegisterR0(PVM pVM, PPDMDEVINS pDevIns, RTIOPORT PortStart, RTUINT cPorts, RTR0PTR pvUser,
319 R0PTRTYPE(PFNIOMIOPORTOUT) pfnOutCallback, R0PTRTYPE(PFNIOMIOPORTIN) pfnInCallback,
320 R0PTRTYPE(PFNIOMIOPORTOUTSTRING) pfnOutStrCallback, R0PTRTYPE(PFNIOMIOPORTINSTRING) pfnInStrCallback,
321 const char *pszDesc);
322VMMR3_INT_DECL(int) IOMR3IOPortDeregister(PVM pVM, PPDMDEVINS pDevIns, RTIOPORT PortStart, RTUINT cPorts);
323
324VMMR3_INT_DECL(int) IOMR3MmioRegisterR3(PVM pVM, PPDMDEVINS pDevIns, RTGCPHYS GCPhysStart, uint32_t cbRange, RTHCPTR pvUser,
325 R3PTRTYPE(PFNIOMMMIOWRITE) pfnWriteCallback,
326 R3PTRTYPE(PFNIOMMMIOREAD) pfnReadCallback,
327 R3PTRTYPE(PFNIOMMMIOFILL) pfnFillCallback,
328 uint32_t fFlags, const char *pszDesc);
329VMMR3_INT_DECL(int) IOMR3MmioRegisterR0(PVM pVM, PPDMDEVINS pDevIns, RTGCPHYS GCPhysStart, uint32_t cbRange, RTR0PTR pvUser,
330 R0PTRTYPE(PFNIOMMMIOWRITE) pfnWriteCallback,
331 R0PTRTYPE(PFNIOMMMIOREAD) pfnReadCallback,
332 R0PTRTYPE(PFNIOMMMIOFILL) pfnFillCallback);
333VMMR3_INT_DECL(int) IOMR3MmioRegisterRC(PVM pVM, PPDMDEVINS pDevIns, RTGCPHYS GCPhysStart, uint32_t cbRange, RTGCPTR pvUser,
334 RCPTRTYPE(PFNIOMMMIOWRITE) pfnWriteCallback,
335 RCPTRTYPE(PFNIOMMMIOREAD) pfnReadCallback,
336 RCPTRTYPE(PFNIOMMMIOFILL) pfnFillCallback);
337VMMR3_INT_DECL(int) IOMR3MmioDeregister(PVM pVM, PPDMDEVINS pDevIns, RTGCPHYS GCPhysStart, uint32_t cbRange);
338
339/** @} */
340#endif /* IN_RING3 */
341
342
343/** @} */
344
345RT_C_DECLS_END
346
347#endif
348
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