Changeset 89638 in vbox for trunk/src/VBox/Devices

Timestamp:

Jun 11, 2021 10:03:42 PM (4 years ago)

Author:

vboxsync

Message:

DevHda: Validate config values when reading them. Marked a bunch obsolete w/o actually removing them yet. Renamed a couple of members. doxygen. bugref:9890

Location:

trunk/src/VBox/Devices/Audio

Files:

• DevHda.cpp (modified) (3 diffs)
• DevHda.h (modified) (1 diff)
• DevHdaStream.cpp (modified) (1 diff)

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

@@ -4646 +4646 @@
                                   "");
 
-    /* Note: Error checking of this value happens in hdaR3StreamSetUp(). */
-    int rc = pHlp->pfnCFGMQueryU16Def(pCfg, "BufSizeInMs", &pThis->cbCircBufInMs, 0 /* Default value, if not set. */);
+    /** @devcfgm{hda,BufSizeInMs,uint16_t,0,2000,0,ms}
+     * The size of the DMA buffer for input streams expressed in milliseconds. */
+    int rc = pHlp->pfnCFGMQueryU16Def(pCfg, "BufSizeInMs", &pThis->cMsCircBufIn, 0);
     if (RT_FAILURE(rc))
         return PDMDEV_SET_ERROR(pDevIns, rc,
-                                N_("HDA configuration error: failed to read input buffer size (ms) as unsigned integer"));
-
-    /* Note: Error checking of this value happens in hdaR3StreamSetUp(). */
-    rc = pHlp->pfnCFGMQueryU16Def(pCfg, "BufSizeOutMs", &pThis->cbCircBufOutMs, 0 /* Default value, if not set. */);
+                                N_("HDA configuration error: failed to read 'BufSizeInMs' as 16-bit unsigned integer"));
+    if (pThis->cMsCircBufIn > 2000)
+        return PDMDEV_SET_ERROR(pDevIns, VERR_OUT_OF_RANGE,
+                                N_("HDA configuration error: 'BufSizeInMs' is out of bound, max 2000 ms"));
+
+    /** @devcfgm{hda,BufSizeOutMs,uint16_t,0,2000,0,ms}
+     * The size of the DMA buffer for output streams expressed in milliseconds. */
+    rc = pHlp->pfnCFGMQueryU16Def(pCfg, "BufSizeOutMs", &pThis->cMsCircBufOut, 0);
     if (RT_FAILURE(rc))
         return PDMDEV_SET_ERROR(pDevIns, rc,
-                                N_("HDA configuration error: failed to read output buffer size (ms) as unsigned integer"));
-
-    rc = pHlp->pfnCFGMQueryU16Def(pCfg, "TimerHz", &pThis->uTimerHz, HDA_TIMER_HZ_DEFAULT /* Default value, if not set. */);
+                                N_("HDA configuration error: failed to read 'BufSizeOutMs' as 16-bit unsigned integer"));
+    if (pThis->cMsCircBufOut > 2000)
+        return PDMDEV_SET_ERROR(pDevIns, VERR_OUT_OF_RANGE,
+                                N_("HDA configuration error: 'BufSizeOutMs' is out of bound, max 2000 ms"));
+
+    /** @todo uTimerHz isn't used for anything anymore. */
+    rc = pHlp->pfnCFGMQueryU16Def(pCfg, "TimerHz", &pThis->uTimerHz, HDA_TIMER_HZ_DEFAULT);
     if (RT_FAILURE(rc))
         return PDMDEV_SET_ERROR(pDevIns, rc,
                                 N_("HDA configuration error: failed to read Hertz (Hz) rate as unsigned integer"));
-
     if (pThis->uTimerHz != HDA_TIMER_HZ_DEFAULT)
         LogRel(("HDA: Using custom device timer rate (%RU16Hz)\n", pThis->uTimerHz));
@@ -4680 +4688 @@
                                    N_("HDA configuration error: Out of range: 0 <= InitialDelayMs < 256: %u"), pThis->msInitialDelay);
 
+    /** @todo fPosAdjustEnabled is not honored anymore.   */
     rc = pHlp->pfnCFGMQueryBoolDef(pCfg, "PosAdjustEnabled", &pThis->fPosAdjustEnabled, true);
     if (RT_FAILURE(rc))
         return PDMDEV_SET_ERROR(pDevIns, rc,
                                 N_("HDA configuration error: failed to read position adjustment enabled as boolean"));
-
     if (!pThis->fPosAdjustEnabled)
         LogRel(("HDA: Position adjustment is disabled\n"));
 
+    /** @todo cPosAdjustFrames is not consulted anymore.   */
     rc = pHlp->pfnCFGMQueryU16Def(pCfg, "PosAdjustFrames", &pThis->cPosAdjustFrames, HDA_POS_ADJUST_DEFAULT);
     if (RT_FAILURE(rc))
         return PDMDEV_SET_ERROR(pDevIns, rc,
                                 N_("HDA configuration error: failed to read position adjustment frames as unsigned integer"));
-
     if (pThis->cPosAdjustFrames)
         LogRel(("HDA: Using custom position adjustment (%RU16 audio frames)\n", pThis->cPosAdjustFrames));
 
+    /** @todo fTransferHeuristicsEnabled is not used anymore.   */
     rc = pHlp->pfnCFGMQueryBoolDef(pCfg, "TransferHeuristicsEnabled", &pThis->fTransferHeuristicsEnabled, true);
     if (RT_FAILURE(rc))
         return PDMDEV_SET_ERROR(pDevIns, rc,
                                 N_("HDA configuration error: failed to read data transfer heuristics enabled as boolean"));
-
     if (!pThis->fTransferHeuristicsEnabled)
         LogRel(("HDA: Data transfer heuristics are disabled\n"));
@@ -4713 +4721 @@
         return PDMDEV_SET_ERROR(pDevIns, rc,
                                 N_("HDA configuration error: failed to read debugging output path flag as string"));
-
     if (pThisCC->Dbg.fEnabled)
         LogRel2(("HDA: Debug output will be saved to '%s'\n", pThisCC->Dbg.pszOutPath));

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

@@ -122 +122 @@
      * @sa InitialDelayMs config value.  */
     uint16_t                msInitialDelay;
-    /** Buffer size (in ms) of the internal input FIFO buffer.
-     *  The actual buffer size in bytes will depend on the actual stream configuration. */
-    uint16_t                cbCircBufInMs;
-    /** Buffer size (in ms) of the internal output FIFO buffer.
-     *  The actual buffer size in bytes will depend on the actual stream configuration. */
-    uint16_t                cbCircBufOutMs;
+    /** Config: Internal input DMA buffer size override, specified in milliseconds.
+     * Zero means default size according to buffer and stream config.
+     * @sa BufSizeInMs config value.  */
+    uint16_t                cMsCircBufIn;
+    /** Config: Internal output DMA buffer size override, specified in milliseconds.
+     * Zero means default size according to buffer and stream config.
+     * @sa BufSizeOutMs config value.  */
+    uint16_t                cMsCircBufOut;
     /** The start time of the wall clock (WALCLK), measured on the virtual sync clock. */
     uint64_t                tsWalClkStart;

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

@@ -707 +707 @@
              uSD, cbCircBuf, PDMAudioPropsBytesToMilli(&pCfg->Props, cbCircBuf)));
 
-    uint32_t msCircBufCfg = hdaGetDirFromSD(uSD) == PDMAUDIODIR_IN ? pThis->cbCircBufInMs : pThis->cbCircBufOutMs;
+    uint32_t msCircBufCfg = hdaGetDirFromSD(uSD) == PDMAUDIODIR_IN ? pThis->cMsCircBufIn : pThis->cMsCircBufOut;
     if (msCircBufCfg) /* Anything set via CFGM? */
     {