Changeset 44896 in vbox for trunk/include/VBox/vmm

Timestamp:

Mar 1, 2013 8:43:23 PM (12 years ago)

Author:

vboxsync

Message:

Clarified the register getter and setter interface callbacks.

Location:

trunk/include/VBox/vmm

Files:

• dbgf.h (modified) (2 diffs)
• pdmdev.h (modified) (1 diff)

trunk/include/VBox/vmm/dbgf.h

@@ -1323 +1323 @@
     /** Sub-field flags, DBGFREGSUBFIELD_FLAGS_XXX.  */
     uint8_t         fFlags;
-    /** Getter (optional). */
+    /** Getter (optional).
+     * @remarks Does not take the device lock or anything like that.
+     */
     DECLCALLBACKMEMBER(int, pfnGet)(void *pvUser, struct DBGFREGSUBFIELD const *pSubField, PRTUINT128U puValue);
-    /** Setter (optional). */
+    /** Setter (optional).
+     * @remarks Does not take the device lock or anything like that.
+     */
     DECLCALLBACKMEMBER(int, pfnSet)(void *pvUser, struct DBGFREGSUBFIELD const *pSubField, RTUINT128U uValue, RTUINT128U fMask);
 } DBGFREGSUBFIELD;
@@ -1377 +1381 @@
      * thuse the 'off' prefix. */
     uint32_t                offRegister;
-    /** Getter. */
+    /** Getter.
+     * @remarks Does not take the device lock or anything like that.
+     */
     DECLCALLBACKMEMBER(int, pfnGet)(void *pvUser, struct DBGFREGDESC const *pDesc, PDBGFREGVAL pValue);
-    /** Setter. */
+    /** Setter.
+     * @remarks Does not take the device lock or anything like that.
+     */
     DECLCALLBACKMEMBER(int, pfnSet)(void *pvUser, struct DBGFREGDESC const *pDesc, PCDBGFREGVAL pValue, PCDBGFREGVAL pfMask);
     /** Aliases (optional). */

trunk/include/VBox/vmm/pdmdev.h

@@ -2810 +2810 @@
      * @param   pDevIns             The device instance.
      * @param   paRegisters         The register descriptors.
+     *
+     * @remarks The device critical section is NOT entered prior to working the
+     *          callbacks registered via this helper!
      */
     DECLR3CALLBACKMEMBER(int, pfnDBGFRegRegister,(PPDMDEVINS pDevIns, PCDBGFREGDESC paRegisters));