iom.h@ 39111

Last change on this file since 39111 was 39111, checked in by vboxsync, 13 years ago
IOM,PDM: Working on moving unaligned and non-dword MMIO access splitting and buffering up into IOM (from the device emulation).
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 15.2 KB

Line
1	/** @file
2	* IOM - Input / Output Monitor.
3	*/
4
5	/*
6	* Copyright (C) 2006-2010 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
32	RT_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 is must be used to correctly
51	* determine if the call succeeded and things like the EIP 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
61	* explicitly for each for exach the exceptions.
62	* However, for efficieny we ASSUME that the
63	* VINF_EM_LAST is smaller than most of the relevant
64	* status codes. We also ASSUME that the
65	* VINF_EM_RESCHEDULE_REM status code is the most
66	* frequent status code we'll enounter in this range.
67	*
68	* @todo Will have to add VINF_EM_DBG_HYPER_BREAKPOINT if the
69	* I/O port and MMIO breakpoints should trigger before
70	* the I/O is done. Currently, we don't implement these
71	* kind of breakpoints.
72	*/
73	#define IOM_SUCCESS(rc) ( (rc) == VINF_SUCCESS \
74	\|\| ( (rc) <= VINF_EM_LAST \
75	&& (rc) != VINF_EM_RESCHEDULE_REM \
76	&& (rc) >= VINF_EM_FIRST \
77	&& (rc) != VINF_EM_RESCHEDULE_RAW \
78	&& (rc) != VINF_EM_RESCHEDULE_HWACC \
79	) \
80	)
81
82	/** @name IOMMMIO_FLAGS_XXX
83	* @{ */
84	/** Pass all reads thru unmodified. */
85	#define IOMMMIO_FLAGS_READ_PASSTHRU UINT32_C(0x00000000)
86	/** All read accesses are DWORD sized (32-bit). */
87	#define IOMMMIO_FLAGS_READ_DWORD UINT32_C(0x00000001)
88	/** All read accesses are DWORD (32-bit) or QWORD (64-bit) sized.
89	* Only accesses that are both QWORD sized and aligned are performed as QWORD.
90	* All other access will be done DWORD fashion (because it is way simpler). */
91	#define IOMMMIO_FLAGS_READ_DWORD_QWORD UINT32_C(0x00000002)
92	/** The read access mode mask. */
93	#define IOMMMIO_FLAGS_READ_MODE UINT32_C(0x00000003)
94
95	/** Pass all writes thru unmodified. */
96	#define IOMMMIO_FLAGS_WRITE_PASSTHRU UINT32_C(0x00000000)
97	/** All write accesses are DWORD (32-bit) sized and unspecified bytes are
98	* written as zero. */
99	#define IOMMMIO_FLAGS_WRITE_DWORD_ZEROED UINT32_C(0x00000010)
100	/** All write accesses are either DWORD (32-bit) or QWORD (64-bit) sized,
101	* missing bytes will be written as zero. Only accesses that are both QWORD
102	* sized and aligned are performed as QWORD, all other accesses will be done
103	* DWORD fashion (because it's way simpler). */
104	#define IOMMMIO_FLAGS_WRITE_DWORD_QWORD_ZEROED UINT32_C(0x00000020)
105	/** All write accesses are DWORD (32-bit) sized and unspecified bytes are
106	* read from the device first as DWORDs.
107	* @remarks This isn't how it happens on real hardware, but it allows
108	* simplifications of devices where reads doesn't change the device
109	* state in any way. */
110	#define IOMMMIO_FLAGS_WRITE_DWORD_READ_MISSING UINT32_C(0x00000030)
111	/** All write accesses are DWORD (32-bit) or QWORD (64-bit) sized and
112	* unspecified bytes are read from the device first as DWORDs. Only accesses
113	* that are both QWORD sized and aligned are performed as QWORD, all other
114	* accesses will be done DWORD fashion (because it's way simpler).
115	* @remarks This isn't how it happens on real hardware, but it allows
116	* simplifications of devices where reads doesn't change the device
117	* state in any way. */
118	#define IOMMMIO_FLAGS_WRITE_DWORD_QWORD_READ_MISSING UINT32_C(0x00000040)
119	/** The read access mode mask. */
120	#define IOMMMIO_FLAGS_WRITE_MODE UINT32_C(0x00000070)
121
122	/** Mask of valid flags. */
123	#define IOMMMIO_FLAGS_VALID_MASK UINT32_C(0x00000073)
124	/** @} */
125
126
127	/**
128	* Port I/O Handler for IN operations.
129	*
130	* @returns VINF_SUCCESS or VINF_EM_*.
131	* @returns VERR_IOM_IOPORT_UNUSED if the port is really unused and a ~0 value should be returned.
132	*
133	* @param pDevIns The device instance.
134	* @param pvUser User argument.
135	* @param uPort Port number used for the IN operation.
136	* @param pu32 Where to store the result. This is always a 32-bit
137	* variable regardless of what @a cb might say.
138	* @param cb Number of bytes read.
139	*/
140	typedef DECLCALLBACK(int) FNIOMIOPORTIN(PPDMDEVINS pDevIns, void pvUser, RTIOPORT Port, uint32_t pu32, unsigned cb);
141	/** Pointer to a FNIOMIOPORTIN(). */
142	typedef FNIOMIOPORTIN *PFNIOMIOPORTIN;
143
144	/**
145	* Port I/O Handler for string IN operations.
146	*
147	* @returns VINF_SUCCESS or VINF_EM_*.
148	* @returns VERR_IOM_IOPORT_UNUSED if the port is really unused and a ~0 value should be returned.
149	*
150	* @param pDevIns The device instance.
151	* @param pvUser User argument.
152	* @param uPort Port number used for the IN operation.
153	* @param pGCPtrDst Pointer to the destination buffer (GC, incremented appropriately).
154	* @param pcTransfers Pointer to the number of transfer units to read, on return remaining transfer units.
155	* @param cb Size of the transfer unit (1, 2 or 4 bytes).
156	*/
157	typedef DECLCALLBACK(int) FNIOMIOPORTINSTRING(PPDMDEVINS pDevIns, void pvUser, RTIOPORT Port, RTGCPTR pGCPtrDst, PRTGCUINTREG pcTransfers, unsigned cb);
158	/** Pointer to a FNIOMIOPORTINSTRING(). */
159	typedef FNIOMIOPORTINSTRING *PFNIOMIOPORTINSTRING;
160
161	/**
162	* Port I/O Handler for OUT operations.
163	*
164	* @returns VINF_SUCCESS or VINF_EM_*.
165	*
166	* @param pDevIns The device instance.
167	* @param pvUser User argument.
168	* @param uPort Port number used for the OUT operation.
169	* @param u32 The value to output.
170	* @param cb The value size in bytes.
171	*/
172	typedef DECLCALLBACK(int) FNIOMIOPORTOUT(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb);
173	/** Pointer to a FNIOMIOPORTOUT(). */
174	typedef FNIOMIOPORTOUT *PFNIOMIOPORTOUT;
175
176	/**
177	* Port I/O Handler for string OUT operations.
178	*
179	* @returns VINF_SUCCESS or VINF_EM_*.
180	*
181	* @param pDevIns The device instance.
182	* @param pvUser User argument.
183	* @param uPort Port number used for the OUT operation.
184	* @param pGCPtrSrc Pointer to the source buffer (GC, incremented appropriately).
185	* @param pcTransfers Pointer to the number of transfer units to write, on return remaining transfer units.
186	* @param cb Size of the transfer unit (1, 2 or 4 bytes).
187	*/
188	typedef DECLCALLBACK(int) FNIOMIOPORTOUTSTRING(PPDMDEVINS pDevIns, void pvUser, RTIOPORT Port, RTGCPTR pGCPtrSrc, PRTGCUINTREG pcTransfers, unsigned cb);
189	/** Pointer to a FNIOMIOPORTOUTSTRING(). */
190	typedef FNIOMIOPORTOUTSTRING *PFNIOMIOPORTOUTSTRING;
191
192
193	/**
194	* Memory mapped I/O Handler for read operations.
195	*
196	* @returns VBox status code.
197	*
198	* @param pDevIns The device instance.
199	* @param pvUser User argument.
200	* @param GCPhysAddr Physical address (in GC) where the read starts.
201	* @param pv Where to store the result.
202	* @param cb Number of bytes read.
203	*/
204	typedef DECLCALLBACK(int) FNIOMMMIOREAD(PPDMDEVINS pDevIns, void pvUser, RTGCPHYS GCPhysAddr, void pv, unsigned cb);
205	/** Pointer to a FNIOMMMIOREAD(). */
206	typedef FNIOMMMIOREAD *PFNIOMMMIOREAD;
207
208	/**
209	* Port I/O Handler for write operations.
210	*
211	* @returns VBox status code.
212	*
213	* @param pDevIns The device instance.
214	* @param pvUser User argument.
215	* @param GCPhysAddr Physical address (in GC) where the read starts.
216	* @param pv Where to fetch the result.
217	* @param cb Number of bytes to write.
218	*/
219	typedef DECLCALLBACK(int) FNIOMMMIOWRITE(PPDMDEVINS pDevIns, void pvUser, RTGCPHYS GCPhysAddr, void const pv, unsigned cb);
220	/** Pointer to a FNIOMMMIOWRITE(). */
221	typedef FNIOMMMIOWRITE *PFNIOMMMIOWRITE;
222
223	/**
224	* Port I/O Handler for memset operations, actually for REP STOS* instructions handling.
225	*
226	* @returns VBox status code.
227	*
228	* @param pDevIns The device instance.
229	* @param pvUser User argument.
230	* @param GCPhysAddr Physical address (in GC) where the write starts.
231	* @param u32Item Byte/Word/Dword data to fill.
232	* @param cbItem Size of data in u32Item parameter, restricted to 1/2/4 bytes.
233	* @param cItems Number of iterations.
234	*/
235	typedef DECLCALLBACK(int) FNIOMMMIOFILL(PPDMDEVINS pDevIns, void *pvUser, RTGCPHYS GCPhysAddr, uint32_t u32Item, unsigned cbItem, unsigned cItems);
236	/** Pointer to a FNIOMMMIOFILL(). */
237	typedef FNIOMMMIOFILL *PFNIOMMMIOFILL;
238
239	VMMDECL(VBOXSTRICTRC) IOMIOPortRead(PVM pVM, RTIOPORT Port, uint32_t *pu32Value, size_t cbValue);
240	VMMDECL(VBOXSTRICTRC) IOMIOPortWrite(PVM pVM, RTIOPORT Port, uint32_t u32Value, size_t cbValue);
241	VMMDECL(VBOXSTRICTRC) IOMInterpretOUT(PVM pVM, PCPUMCTXCORE pRegFrame, PDISCPUSTATE pCpu);
242	VMMDECL(VBOXSTRICTRC) IOMInterpretIN(PVM pVM, PCPUMCTXCORE pRegFrame, PDISCPUSTATE pCpu);
243	VMMDECL(VBOXSTRICTRC) IOMIOPortReadString(PVM pVM, RTIOPORT Port, PRTGCPTR pGCPtrDst, PRTGCUINTREG pcTransfers, unsigned cb);
244	VMMDECL(VBOXSTRICTRC) IOMIOPortWriteString(PVM pVM, RTIOPORT Port, PRTGCPTR pGCPtrSrc, PRTGCUINTREG pcTransfers, unsigned cb);
245	VMMDECL(VBOXSTRICTRC) IOMInterpretINS(PVM pVM, PCPUMCTXCORE pRegFrame, PDISCPUSTATE pCpu);
246	VMMDECL(VBOXSTRICTRC) IOMInterpretINSEx(PVM pVM, PCPUMCTXCORE pRegFrame, uint32_t uPort, uint32_t uPrefix, DISCPUMODE enmAddrMode, uint32_t cbTransfer);
247	VMMDECL(VBOXSTRICTRC) IOMInterpretOUTS(PVM pVM, PCPUMCTXCORE pRegFrame, PDISCPUSTATE pCpu);
248	VMMDECL(VBOXSTRICTRC) IOMInterpretOUTSEx(PVM pVM, PCPUMCTXCORE pRegFrame, uint32_t uPort, uint32_t uPrefix, DISCPUMODE enmAddrMode, uint32_t cbTransfer);
249	VMMDECL(VBOXSTRICTRC) IOMMMIORead(PVM pVM, RTGCPHYS GCPhys, uint32_t *pu32Value, size_t cbValue);
250	VMMDECL(VBOXSTRICTRC) IOMMMIOWrite(PVM pVM, RTGCPHYS GCPhys, uint32_t u32Value, size_t cbValue);
251	VMMDECL(VBOXSTRICTRC) IOMMMIOPhysHandler(PVM pVM, RTGCUINT uErrorCode, PCPUMCTXCORE pCtxCore, RTGCPHYS GCPhysFault);
252	VMMDECL(VBOXSTRICTRC) IOMInterpretCheckPortIOAccess(PVM pVM, PCPUMCTXCORE pCtxCore, RTIOPORT Port, unsigned cb);
253	VMMDECL(int) IOMMMIOMapMMIO2Page(PVM pVM, RTGCPHYS GCPhys, RTGCPHYS GCPhysRemapped, uint64_t fPageFlags);
254	VMMDECL(int) IOMMMIOMapMMIOHCPage(PVM pVM, RTGCPHYS GCPhys, RTHCPHYS HCPhys, uint64_t fPageFlags);
255	VMMDECL(int) IOMMMIOResetRegion(PVM pVM, RTGCPHYS GCPhys);
256	VMMDECL(bool) IOMIsLockOwner(PVM pVM);
257
258	#ifdef IN_RC
259	/** @defgroup grp_iom_gc The IOM Guest Context API
260	* @ingroup grp_iom
261	* @{
262	*/
263	VMMRCDECL(VBOXSTRICTRC) IOMGCIOPortHandler(PVM pVM, PCPUMCTXCORE pRegFrame, PDISCPUSTATE pCpu);
264	/** @} */
265	#endif /* IN_RC */
266
267
268
269	#ifdef IN_RING3
270	/** @defgroup grp_iom_r3 The IOM Host Context Ring-3 API
271	* @ingroup grp_iom
272	* @{
273	*/
274	VMMR3_INT_DECL(int) IOMR3Init(PVM pVM);
275	VMMR3_INT_DECL(void) IOMR3Reset(PVM pVM);
276	VMMR3_INT_DECL(void) IOMR3Relocate(PVM pVM, RTGCINTPTR offDelta);
277	VMMR3_INT_DECL(int) IOMR3Term(PVM pVM);
278	VMMR3_INT_DECL(int) IOMR3IOPortRegisterR3(PVM pVM, PPDMDEVINS pDevIns, RTIOPORT PortStart, RTUINT cPorts, RTHCPTR pvUser,
279	R3PTRTYPE(PFNIOMIOPORTOUT) pfnOutCallback, R3PTRTYPE(PFNIOMIOPORTIN) pfnInCallback,
280	R3PTRTYPE(PFNIOMIOPORTOUTSTRING) pfnOutStringCallback, R3PTRTYPE(PFNIOMIOPORTINSTRING) pfnInStringCallback,
281	const char *pszDesc);
282	VMMR3_INT_DECL(int) IOMR3IOPortRegisterRC(PVM pVM, PPDMDEVINS pDevIns, RTIOPORT PortStart, RTUINT cPorts, RTRCPTR pvUser,
283	RCPTRTYPE(PFNIOMIOPORTOUT) pfnOutCallback, RCPTRTYPE(PFNIOMIOPORTIN) pfnInCallback,
284	RCPTRTYPE(PFNIOMIOPORTOUTSTRING) pfnOutStrCallback, RCPTRTYPE(PFNIOMIOPORTINSTRING) pfnInStrCallback,
285	const char *pszDesc);
286	VMMR3_INT_DECL(int) IOMR3IOPortRegisterR0(PVM pVM, PPDMDEVINS pDevIns, RTIOPORT PortStart, RTUINT cPorts, RTR0PTR pvUser,
287	R0PTRTYPE(PFNIOMIOPORTOUT) pfnOutCallback, R0PTRTYPE(PFNIOMIOPORTIN) pfnInCallback,
288	R0PTRTYPE(PFNIOMIOPORTOUTSTRING) pfnOutStrCallback, R0PTRTYPE(PFNIOMIOPORTINSTRING) pfnInStrCallback,
289	const char *pszDesc);
290	VMMR3_INT_DECL(int) IOMR3IOPortDeregister(PVM pVM, PPDMDEVINS pDevIns, RTIOPORT PortStart, RTUINT cPorts);
291
292	VMMR3_INT_DECL(int) IOMR3MmioRegisterR3(PVM pVM, PPDMDEVINS pDevIns, RTGCPHYS GCPhysStart, uint32_t cbRange, RTHCPTR pvUser,
293	R3PTRTYPE(PFNIOMMMIOWRITE) pfnWriteCallback,
294	R3PTRTYPE(PFNIOMMMIOREAD) pfnReadCallback,
295	R3PTRTYPE(PFNIOMMMIOFILL) pfnFillCallback,
296	uint32_t fFlags, const char *pszDesc);
297	VMMR3_INT_DECL(int) IOMR3MmioRegisterR0(PVM pVM, PPDMDEVINS pDevIns, RTGCPHYS GCPhysStart, uint32_t cbRange, RTR0PTR pvUser,
298	R0PTRTYPE(PFNIOMMMIOWRITE) pfnWriteCallback,
299	R0PTRTYPE(PFNIOMMMIOREAD) pfnReadCallback,
300	R0PTRTYPE(PFNIOMMMIOFILL) pfnFillCallback);
301	VMMR3_INT_DECL(int) IOMR3MmioRegisterRC(PVM pVM, PPDMDEVINS pDevIns, RTGCPHYS GCPhysStart, uint32_t cbRange, RTGCPTR pvUser,
302	RCPTRTYPE(PFNIOMMMIOWRITE) pfnWriteCallback,
303	RCPTRTYPE(PFNIOMMMIOREAD) pfnReadCallback,
304	RCPTRTYPE(PFNIOMMMIOFILL) pfnFillCallback);
305	VMMR3_INT_DECL(int) IOMR3MmioDeregister(PVM pVM, PPDMDEVINS pDevIns, RTGCPHYS GCPhysStart, uint32_t cbRange);
306
307	/** @} */
308	#endif /* IN_RING3 */
309
310
311	/** @} */
312
313	RT_C_DECLS_END
314
315	#endif
316

Note: See TracBrowser for help on using the repository browser.

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

Download in other formats: