Changeset 4567 in vbox

Timestamp:

Sep 6, 2007 11:18:56 AM (17 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

24190

Message:

Documented limitations of address conversion helpers

File:

• trunk/include/VBox/pdmdev.h (modified) (2 diffs)

trunk/include/VBox/pdmdev.h

@@ -2350 +2350 @@
      * @param   cbRange         The size of the range. Use 0 if you don't care about the range.
      * @param   ppvHC           Where to store the HC pointer corresponding to GCPhys.
-     * @thread  Any thread.
+     * @thread  The emulation thread.
+     *
+     * @remark  Careful with page boundraries.
+     * @remark  Do not use the mapping after you return to the caller! (it could get invalidated/changed)
      */
     DECLR3CALLBACKMEMBER(int, pfnPhys2HCVirt,(PPDMDEVINS pDevIns, RTGCPHYS GCPhys, RTUINT cbRange, PRTHCPTR ppvHC));
@@ -2362 +2365 @@
      * @param   pHCPtr          Where to store the HC pointer corresponding to GCPtr.
      * @thread  The emulation thread.
+     *
      * @remark  Careful with page boundraries.
+     * @remark  Do not use the mapping after you return to the caller! (it could get invalidated/changed)
      */
     DECLR3CALLBACKMEMBER(int, pfnPhysGCPtr2HCPtr,(PPDMDEVINS pDevIns, RTGCPTR GCPtr, PRTHCPTR pHCPtr));