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

Timestamp:

Feb 1, 2013 5:10:48 PM (12 years ago)

Author:

vboxsync

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

83558

Message:

SSM dev callback doc update.

File:

• trunk/include/VBox/vmm/ssm.h (modified) (10 diffs)

trunk/include/VBox/vmm/ssm.h

@@ -4 +4 @@
 
 /*
- * Copyright (C) 2006-2010 Oracle Corporation
+ * Copyright (C) 2006-2013 Oracle Corporation
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -400 +400 @@
  * @param   pDevIns         Device instance of the device which registered the data unit.
  * @param   pSSM            SSM operation handle.
+ * @remarks The caller enters the device critical section prior to the call.
  * @thread  Any.
  */
@@ -416 +417 @@
  * @param   pSSM            SSM operation handle.
  * @param   uPass           The pass.
+ * @remarks The caller enters the device critical section prior to the call.
  * @thread  Any.
  */
@@ -438 +440 @@
  * @param   pSSM            SSM operation handle.
  * @param   uPass           The data pass.
+ * @remarks The caller enters the device critical section prior to the call.
  * @thread  Any.
  */
@@ -450 +453 @@
  * @param   pDevIns         Device instance of the device which registered the data unit.
  * @param   pSSM            SSM operation handle.
+ * @remarks The caller enters the device critical section prior to the call.
  */
 typedef DECLCALLBACK(int) FNSSMDEVSAVEPREP(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
@@ -461 +465 @@
  * @param   pDevIns         Device instance of the device which registered the data unit.
  * @param   pSSM            SSM operation handle.
+ * @remarks The caller enters the device critical section prior to the call.
  */
 typedef DECLCALLBACK(int) FNSSMDEVSAVEEXEC(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
@@ -472 +477 @@
  * @param   pDevIns         Device instance of the device which registered the data unit.
  * @param   pSSM            SSM operation handle.
+ * @remarks The caller enters the device critical section prior to the call.
  */
 typedef DECLCALLBACK(int) FNSSMDEVSAVEDONE(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
@@ -483 +489 @@
  * @param   pDevIns         Device instance of the device which registered the data unit.
  * @param   pSSM            SSM operation handle.
+ * @remarks The caller enters the device critical section prior to the call.
  */
 typedef DECLCALLBACK(int) FNSSMDEVLOADPREP(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);
@@ -497 +504 @@
  * @param   uPass           The pass. This is always SSM_PASS_FINAL for units
  *                          that doesn't specify a pfnSaveLive callback.
+ * @remarks The caller enters the device critical section prior to the call.
  */
 typedef DECLCALLBACK(int) FNSSMDEVLOADEXEC(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass);
@@ -508 +516 @@
  * @param   pDevIns         Device instance of the device which registered the data unit.
  * @param   pSSM            SSM operation handle.
+ * @remarks The caller enters the device critical section prior to the call.
  */
 typedef DECLCALLBACK(int) FNSSMDEVLOADDONE(PPDMDEVINS pDevIns, PSSMHANDLE pSSM);