Changeset 82307 in vbox for trunk/src/VBox/Devices/Audio

Timestamp:

Dec 1, 2019 12:39:11 AM (5 years ago)

Author:

vboxsync

Message:

DevHDA: s/HDA_SSM_/HDA_SAVED_STATE_/g bugref:9218

Location:

trunk/src/VBox/Devices/Audio

Files:

• DevHDA.cpp (modified) (12 diffs)
• HDACodec.cpp (modified) (3 diffs)
• HDACodec.h (modified) (2 diffs)

trunk/src/VBox/Devices/Audio/DevHDA.cpp

@@ -3471 +3471 @@
 }
 
-
-/* PCI callback. */
-
 #ifdef IN_RING3
 
-/* Saved state workers and callbacks. */
+
+/*********************************************************************************************************************************
+*   Saved state                                                                                                                  *
+*********************************************************************************************************************************/
 
 /**
@@ -3711 +3711 @@
     switch (uVersion)
     {
-        case HDA_SSM_VERSION_1:
+        case HDA_SAVED_STATE_VERSION_1:
             /* Starting with r71199, we would save 112 instead of 113
                registers due to some code cleanups.  This only affected trunk
@@ -3726 +3726 @@
             break;
 
-        case HDA_SSM_VERSION_2:
-        case HDA_SSM_VERSION_3:
+        case HDA_SAVED_STATE_VERSION_2:
+        case HDA_SAVED_STATE_VERSION_3:
             cRegs = 112;
             AssertCompile(RT_ELEMENTS(pThis->au32Regs) >= 112);
@@ -3733 +3733 @@
 
         /* Since version 4 we store the register count to stay flexible. */
-        case HDA_SSM_VERSION_4:
-        case HDA_SSM_VERSION_5:
-        case HDA_SSM_VERSION_6:
+        case HDA_SAVED_STATE_VERSION_4:
+        case HDA_SAVED_STATE_VERSION_5:
+        case HDA_SAVED_STATE_VERSION_6:
             rc = pHlp->pfnSSMGetU32(pSSM, &cRegs);
             AssertRCReturn(rc, rc);
@@ -3777 +3777 @@
     switch (uVersion)
     {
-        case HDA_SSM_VERSION_1:
-        case HDA_SSM_VERSION_2:
-        case HDA_SSM_VERSION_3:
-        case HDA_SSM_VERSION_4:
+        case HDA_SAVED_STATE_VERSION_1:
+        case HDA_SAVED_STATE_VERSION_2:
+        case HDA_SAVED_STATE_VERSION_3:
+        case HDA_SAVED_STATE_VERSION_4:
         {
             /* Only load the internal states.
@@ -3856 +3856 @@
                  * Load BDLEs (Buffer Descriptor List Entries) and DMA counters.
                  */
-                if (uVersion == HDA_SSM_VERSION_5)
+                if (uVersion == HDA_SAVED_STATE_VERSION_5)
                 {
                     struct V5HDASTREAMSTATE /* HDASTREAMSTATE + HDABDLE */
@@ -3945 +3945 @@
     }
 
-    if (uVersion <= HDA_SSM_VERSION_6) /* Handle older saved states? */
+    if (uVersion <= HDA_SAVED_STATE_VERSION_6) /* Handle older saved states? */
     {
         rc = hdaR3LoadExecLegacy(pDevIns, pThis, pSSM, uVersion);
@@ -4121 +4121 @@
 }
 
-/* IPRT format type handlers. */
+
+/*********************************************************************************************************************************
+*   IPRT format type handlers                                                                                                    *
+*********************************************************************************************************************************/
 
 /**
@@ -4207 +4210 @@
 }
 
-/* Debug info dumpers */
+
+/*********************************************************************************************************************************
+*   Debug Info Item Handlers                                                                                                     *
+*********************************************************************************************************************************/
 
 static int hdaR3DbgLookupRegByName(const char *pszArgs)
@@ -4391 +4397 @@
 
 
-/* PDMIBASE */
+/*********************************************************************************************************************************
+*   PDMIBASE                                                                                                                     *
+*********************************************************************************************************************************/
 
 /**
@@ -4406 +4414 @@
 
 
-/* PDMDEVREG */
+/*********************************************************************************************************************************
+*   PDMDEVREGR3                                                                                                                  *
+*********************************************************************************************************************************/
 
 /**
@@ -4908 +4918 @@
 #endif
 
-    rc = PDMDevHlpSSMRegister(pDevIns, HDA_SSM_VERSION, sizeof(*pThis), hdaR3SaveExec, hdaR3LoadExec);
+    rc = PDMDevHlpSSMRegister(pDevIns, HDA_SAVED_STATE_VERSION, sizeof(*pThis), hdaR3SaveExec, hdaR3LoadExec);
     AssertRCReturn(rc, rc);
 

trunk/src/VBox/Devices/Audio/HDACodec.cpp

@@ -3131 +3131 @@
     switch (uVersion)
     {
-        case HDA_SSM_VERSION_1:
+        case HDA_SAVED_STATE_VERSION_1:
             AssertReturn(pThis->cTotalNodes == 0x1c, VERR_INTERNAL_ERROR);
             pFields = g_aCodecNodeFieldsV1;
@@ -3137 +3137 @@
             break;
 
-        case HDA_SSM_VERSION_2:
-        case HDA_SSM_VERSION_3:
+        case HDA_SAVED_STATE_VERSION_2:
+        case HDA_SAVED_STATE_VERSION_3:
             AssertReturn(pThis->cTotalNodes == 0x1c, VERR_INTERNAL_ERROR);
             pFields = g_aCodecNodeFields;
@@ -3145 +3145 @@
 
         /* Since version 4 a flexible node count is supported. */
-        case HDA_SSM_VERSION_4:
-        case HDA_SSM_VERSION_5:
-        case HDA_SSM_VERSION:
+        case HDA_SAVED_STATE_VERSION_4:
+        case HDA_SAVED_STATE_VERSION_5:
+        case HDA_SAVED_STATE_VERSION:
         {
             uint32_t cNodes;

trunk/src/VBox/Devices/Audio/HDACodec.h

@@ -132 +132 @@
 int hdaCodecRemoveStream(PHDACODEC pThis, PDMAUDIOMIXERCTL enmMixerCtl);
 
-/** @name Dev HDA saved state verions
- * @todo r=bird: s/HDA_SSM_/HDA_SAVED_STATE_/g - SSM = saved state manager, duh!
+/** @name DevHDA saved state versions
  * @{ */
 /** Added (Controller):              Current wall clock value (this independent from WALCLK register value).
@@ -142 +141 @@
   * Added (Current BDLE per stream): Struct g_aSSMBDLEDescFields7.
   * Added (Current BDLE per stream): Struct g_aSSMBDLEStateFields7. */
-#define HDA_SSM_VERSION   7
-/** Saves the current BDLE state. */
-#define HDA_SSM_VERSION_6 6
+#define HDA_SAVED_STATE_VERSION   7
+/** Saves the current BDLE state.
+ * @since 5.0.14 (r104839) */
+#define HDA_SAVED_STATE_VERSION_6 6
 /** Introduced dynamic number of streams + stream identifiers for serialization.
  *  Bug: Did not save the BDLE states correctly.
- *  Those will be skipped on load then. */
-#define HDA_SSM_VERSION_5 5
+ *  Those will be skipped on load then.
+ * @since 5.0.12 (r104520)  */
+#define HDA_SAVED_STATE_VERSION_5 5
 /** Since this version the number of MMIO registers can be flexible. */
-#define HDA_SSM_VERSION_4 4
-#define HDA_SSM_VERSION_3 3
-#define HDA_SSM_VERSION_2 2
-#define HDA_SSM_VERSION_1 1
+#define HDA_SAVED_STATE_VERSION_4 4
+#define HDA_SAVED_STATE_VERSION_3 3
+#define HDA_SAVED_STATE_VERSION_2 2
+#define HDA_SAVED_STATE_VERSION_1 1
 /** @} */