Changeset 68908 in vbox

Timestamp:

Sep 28, 2017 1:26:02 PM (7 years ago)

Author:

vboxsync

Message:

Audio/HDA: Implemented support for attaching + detaching drivers on runtime.

File:

• trunk/src/VBox/Devices/Audio/DevHDA.cpp (modified) (17 diffs)

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

@@ -2154 +2154 @@
 
 /**
- * Adds audio streams of all attached LUNs to a given HDA audio mixer sink.
+ * Adds a driver stream to a specific mixer sink.
  *
  * @returns IPRT status code.
@@ -2160 +2160 @@
  * @param   pSink               HDA mixer sink to add audio streams to.
  * @param   pCfg                Audio stream configuration to use for the audio streams to add.
- */
-static DECLCALLBACK(int) hdaMixerAddStream(PHDASTATE pThis, PHDAMIXERSINK pSink, PPDMAUDIOSTREAMCFG pCfg)
-{
-    AssertPtrReturn(pThis, VERR_INVALID_POINTER);
-    AssertPtrReturn(pSink, VERR_INVALID_POINTER);
-    AssertPtrReturn(pCfg,  VERR_INVALID_POINTER);
-
-    LogFunc(("Sink=%s, Stream=%s\n", pSink->pMixSink->pszName, pCfg->szName));
+ * @param   pDrv                Driver stream to add.
+ */
+static int hdaMixerAddDrvStream(PHDASTATE pThis, PAUDMIXSINK pMixSink, PPDMAUDIOSTREAMCFG pCfg, PHDADRIVER pDrv)
+{
+    AssertPtrReturn(pThis,    VERR_INVALID_POINTER);
+    AssertPtrReturn(pMixSink, VERR_INVALID_POINTER);
+    AssertPtrReturn(pCfg,     VERR_INVALID_POINTER);
+
+    LogFunc(("Sink=%s, Stream=%s\n", pMixSink->pszName, pCfg->szName));
+
+    PPDMAUDIOSTREAMCFG pStreamCfg = DrvAudioHlpStreamCfgDup(pCfg);
+    if (!pStreamCfg)
+        return VERR_NO_MEMORY;
+
+    if (!RTStrPrintf(pStreamCfg->szName, sizeof(pStreamCfg->szName), "%s", pCfg->szName))
+    {
+        RTMemFree(pStreamCfg);
+        return VERR_BUFFER_OVERFLOW;
+    }
+
+    LogFunc(("[LUN#%RU8] %s\n", pDrv->uLUN, pStreamCfg->szName));
+
+    int rc = VINF_SUCCESS;
+
+    PHDADRIVERSTREAM pDrvStream = NULL;
+
+    if (pStreamCfg->enmDir == PDMAUDIODIR_IN)
+    {
+        LogFunc(("enmRecSource=%d\n", pStreamCfg->DestSource.Source));
+
+        switch (pStreamCfg->DestSource.Source)
+        {
+            case PDMAUDIORECSOURCE_LINE:
+                pDrvStream = &pDrv->LineIn;
+                break;
+#ifdef VBOX_WITH_AUDIO_HDA_MIC_IN
+            case PDMAUDIORECSOURCE_MIC:
+                pDrvStream = &pDrv->MicIn;
+                break;
+#endif
+            default:
+                rc = VERR_NOT_SUPPORTED;
+                break;
+        }
+    }
+    else if (pStreamCfg->enmDir == PDMAUDIODIR_OUT)
+    {
+        LogFunc(("enmPlaybackDest=%d\n", pStreamCfg->DestSource.Dest));
+
+        switch (pStreamCfg->DestSource.Dest)
+        {
+            case PDMAUDIOPLAYBACKDEST_FRONT:
+                pDrvStream = &pDrv->Front;
+                break;
+#ifdef VBOX_WITH_AUDIO_HDA_51_SURROUND
+            case PDMAUDIOPLAYBACKDEST_CENTER_LFE:
+                pDrvStream = &pDrv->CenterLFE;
+                break;
+            case PDMAUDIOPLAYBACKDEST_REAR:
+                pDrvStream = &pDrv->Rear;
+                break;
+#endif
+            default:
+                rc = VERR_NOT_SUPPORTED;
+                break;
+        }
+    }
+    else
+        rc = VERR_NOT_SUPPORTED;
+
+    if (RT_SUCCESS(rc))
+    {
+        AssertPtr(pDrvStream);
+        AssertMsg(pDrvStream->pMixStrm == NULL, ("[LUN#%RU8] Driver stream already present when it must not\n", pDrv->uLUN));
+
+        PAUDMIXSTREAM pMixStrm;
+        rc = AudioMixerSinkCreateStream(pMixSink, pDrv->pConnector, pStreamCfg, 0 /* fFlags */, &pMixStrm);
+        if (RT_SUCCESS(rc))
+        {
+            rc = AudioMixerSinkAddStream(pMixSink, pMixStrm);
+            LogFlowFunc(("LUN#%RU8: Added \"%s\" to sink, rc=%Rrc\n", pDrv->uLUN, pStreamCfg->szName, rc));
+        }
+
+        if (RT_SUCCESS(rc))
+            pDrvStream->pMixStrm = pMixStrm;
+    }
+
+    if (pStreamCfg)
+    {
+        RTMemFree(pStreamCfg);
+        pStreamCfg = NULL;
+    }
+
+    LogFlowFuncLeaveRC(rc);
+    return rc;
+}
+
+/**
+ * Adds all current driver streams to a specific mixer sink.
+ *
+ * @returns IPRT status code.
+ * @param   pThis               HDA state.
+ * @param   pMixSink            Mixer sink to add stream to.
+ * @param   pCfg                Audio stream configuration to use for the audio streams to add.
+ */
+static int hdaMixerAddDrvStreams(PHDASTATE pThis, PAUDMIXSINK pMixSink, PPDMAUDIOSTREAMCFG pCfg)
+{
+    AssertPtrReturn(pThis,    VERR_INVALID_POINTER);
+    AssertPtrReturn(pMixSink, VERR_INVALID_POINTER);
+    AssertPtrReturn(pCfg,     VERR_INVALID_POINTER);
+
+    LogFunc(("Sink=%s, Stream=%s\n", pMixSink->pszName, pCfg->szName));
 
     if (!DrvAudioHlpStreamCfgIsValid(pCfg))
-    {
-        LogRel(("HDA: Invalid stream configuration used for sink #%RU8: %RU8 bit, %RU8 channel(s) @ %RU32Hz\n",
-                pSink->uSD, pCfg->Props.cBits, pCfg->Props.cChannels, pCfg->Props.uHz));
-
-        AssertFailed(); /* Should not happen. */
         return VERR_INVALID_PARAMETER;
-    }
-
-    int rc = AudioMixerSinkSetFormat(pSink->pMixSink, &pCfg->Props);
+
+    int rc = AudioMixerSinkSetFormat(pMixSink, &pCfg->Props);
     if (RT_FAILURE(rc))
         return rc;
@@ -2185 +2283 @@
     RTListForEach(&pThis->lstDrv, pDrv, HDADRIVER, Node)
     {
-        int rc2 = VINF_SUCCESS;
-        PHDADRIVERSTREAM pDrvStream = NULL;
-
-        PPDMAUDIOSTREAMCFG pStreamCfg = DrvAudioHlpStreamCfgDup(pCfg);
-        if (!pStreamCfg)
-        {
-            rc = VERR_NO_MEMORY;
-            break;
-        }
-
-        RTStrPrintf(pStreamCfg->szName, RT_ELEMENTS(pStreamCfg->szName), "%s", pCfg->szName);
-
-        if (pStreamCfg->enmDir == PDMAUDIODIR_IN)
-        {
-            LogFunc(("enmRecSource=%d\n", pStreamCfg->DestSource.Source));
-
-            switch (pStreamCfg->DestSource.Source)
-            {
-                case PDMAUDIORECSOURCE_LINE:
-                    pDrvStream = &pDrv->LineIn;
-                    break;
-#ifdef VBOX_WITH_AUDIO_HDA_MIC_IN
-                case PDMAUDIORECSOURCE_MIC:
-                    pDrvStream = &pDrv->MicIn;
-                    break;
-#endif
-                default:
-                    rc2 = VERR_NOT_SUPPORTED;
-                    break;
-            }
-        }
-        else if (pStreamCfg->enmDir == PDMAUDIODIR_OUT)
-        {
-            LogFunc(("enmPlaybackDest=%d\n", pStreamCfg->DestSource.Dest));
-
-            switch (pStreamCfg->DestSource.Dest)
-            {
-                case PDMAUDIOPLAYBACKDEST_FRONT:
-                    pDrvStream = &pDrv->Front;
-                    break;
-#ifdef VBOX_WITH_AUDIO_HDA_51_SURROUND
-                case PDMAUDIOPLAYBACKDEST_CENTER_LFE:
-                    pDrvStream = &pDrv->CenterLFE;
-                    break;
-                case PDMAUDIOPLAYBACKDEST_REAR:
-                    pDrvStream = &pDrv->Rear;
-                    break;
-#endif
-                default:
-                    rc2 = VERR_NOT_SUPPORTED;
-                    break;
-            }
-        }
-        else
-            rc2 = VERR_NOT_SUPPORTED;
-
-        if (RT_SUCCESS(rc2))
-        {
-            AssertPtr(pDrvStream);
-
-            AudioMixerSinkRemoveStream(pSink->pMixSink, pDrvStream->pMixStrm);
-
-            AudioMixerStreamDestroy(pDrvStream->pMixStrm);
-            pDrvStream->pMixStrm = NULL;
-
-            PAUDMIXSTREAM pMixStrm;
-            rc2 = AudioMixerSinkCreateStream(pSink->pMixSink, pDrv->pConnector, pStreamCfg, 0 /* fFlags */, &pMixStrm);
-            if (RT_SUCCESS(rc2))
-            {
-                rc2 = AudioMixerSinkAddStream(pSink->pMixSink, pMixStrm);
-                LogFlowFunc(("LUN#%RU8: Added \"%s\" to sink, rc=%Rrc\n", pDrv->uLUN, pStreamCfg->szName , rc2));
-            }
-
-            if (RT_SUCCESS(rc2))
-                pDrvStream->pMixStrm = pMixStrm;
-
-            /* If creating a stream fails, be forgiving and continue -- don't pass rc2 to rc here. */
-        }
-
-        if (pStreamCfg)
-        {
-            RTMemFree(pStreamCfg);
-            pStreamCfg = NULL;
-        }
+        int rc2 = hdaMixerAddDrvStream(pThis, pMixSink, pCfg, pDrv);
+        if (RT_SUCCESS(rc))
+            rc = rc2;
     }
 
@@ -2295 +2312 @@
     if (pSink)
     {
-        rc = hdaMixerAddStream(pThis, pSink, pCfg);
+        rc = hdaMixerAddDrvStreams(pThis, pSink->pMixSink, pCfg);
 
         AssertPtr(pSink->pMixSink);
@@ -4404 +4421 @@
  *
  * @returns VBox status code.
- * @param   pDevIns     The device instance.
- * @param   pDrv        Driver to (re-)use for (re-)attaching to.
- *                      If NULL is specified, a new driver will be created and appended
- *                      to the driver list.
+ * @param   pThis       HDA state.
  * @param   uLUN        The logical unit which is being detached.
  * @param   fFlags      Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
- */
-static int hdaAttachInternal(PPDMDEVINS pDevIns, PHDADRIVER pDrv, unsigned uLUN, uint32_t fFlags)
+ * @param   ppDrv       Attached driver instance on success. Optional.
+ */
+static int hdaAttachInternal(PHDASTATE pThis, unsigned uLUN, uint32_t fFlags, PHDADRIVER *ppDrv)
 {
     RT_NOREF(fFlags);
-    PHDASTATE pThis = PDMINS_2_DATA(pDevIns, PHDASTATE);
 
     /*
@@ -4424 +4438 @@
 
     PPDMIBASE pDrvBase;
-    int rc = PDMDevHlpDriverAttach(pDevIns, uLUN,
+    int rc = PDMDevHlpDriverAttach(pThis->pDevInsR3, uLUN,
                                    &pThis->IBase, &pDrvBase, pszDesc);
     if (RT_SUCCESS(rc))
     {
-        if (pDrv == NULL)
-            pDrv = (PHDADRIVER)RTMemAllocZ(sizeof(HDADRIVER));
+        PHDADRIVER pDrv = (PHDADRIVER)RTMemAllocZ(sizeof(HDADRIVER));
         if (pDrv)
         {
@@ -4453 +4466 @@
                 pDrv->fAttached = true;
             }
+
+            if (ppDrv)
+                *ppDrv = pDrv;
         }
         else
@@ -4472 +4488 @@
 
 /**
- * Attach command.
+ * Detach command, internal version.
  *
- * This is called to let the device attach to a driver for a specified LUN
- * during runtime. This is not called during VM construction, the device
- * constructor has to attach to all the available drivers.
+ * This is called to let the device detach from a driver for a specified LUN
+ * during runtime.
  *
  * @returns VBox status code.
- * @param   pDevIns     The device instance.
- * @param   uLUN        The logical unit which is being detached.
+ * @param   pThis       HDA state.
+ * @param   pDrv        Driver to detach device from.
  * @param   fFlags      Flags, combination of the PDMDEVATT_FLAGS_* \#defines.
  */
+static int hdaDetachInternal(PHDASTATE pThis, PHDADRIVER pDrv, uint32_t fFlags)
+{
+    RT_NOREF(fFlags);
+
+    AudioMixerSinkRemoveStream(pThis->SinkFront.pMixSink,     pDrv->Front.pMixStrm);
+    AudioMixerStreamDestroy(pDrv->Front.pMixStrm);
+    pDrv->Front.pMixStrm = NULL;
+
+#ifdef VBOX_WITH_AUDIO_HDA_51_SURROUND
+    AudioMixerSinkRemoveStream(pThis->SinkCenterLFE.pMixSink, pDrv->CenterLFE.pMixStrm);
+    AudioMixerStreamDestroy(pDrv->CenterLFE.pMixStrm);
+    pDrv->CenterLFE.pMixStrm = NULL;
+
+    AudioMixerSinkRemoveStream(pThis->SinkRear.pMixSink,      pDrv->Rear.pMixStrm);
+    AudioMixerStreamDestroy(pDrv->Rear.pMixStrm);
+    pDrv->Rear.pMixStrm = NULL;
+#endif
+
+    AudioMixerSinkRemoveStream(pThis->SinkLineIn.pMixSink,    pDrv->LineIn.pMixStrm);
+    AudioMixerStreamDestroy(pDrv->LineIn.pMixStrm);
+    pDrv->LineIn.pMixStrm = NULL;
+
+#ifdef VBOX_WITH_AUDIO_HDA_MIC_IN
+    AudioMixerSinkRemoveStream(pThis->SinkMicIn.pMixSink,     pDrv->MicIn.pMixStrm);
+    AudioMixerStreamDestroy(pDrv->MicIn.pMixStrm);
+    pDrv->MicIn.pMixStrm = NULL;
+#endif
+
+    RTListNodeRemove(&pDrv->Node);
+
+    LogFunc(("uLUN=%u, fFlags=0x%x\n", pDrv->uLUN, fFlags));
+    return VINF_SUCCESS;
+}
+
+/**
+ * @interface_method_impl{PDMDEVREG,pfnAttach}
+ */
 static DECLCALLBACK(int) hdaAttach(PPDMDEVINS pDevIns, unsigned uLUN, uint32_t fFlags)
 {
@@ -4489 +4541 @@
     DEVHDA_LOCK_RETURN(pThis, VINF_IOM_R3_MMIO_WRITE);
 
-    int rc = hdaAttachInternal(pDevIns, NULL /* pDrv */, uLUN, fFlags);
+    PHDADRIVER pDrv;
+    int rc2 = hdaAttachInternal(pThis, uLUN, fFlags, &pDrv);
+    if (RT_SUCCESS(rc2))
+    {
+        PHDASTREAM pStream = hdaGetStreamFromSink(pThis, &pThis->SinkFront);
+        if (DrvAudioHlpStreamCfgIsValid(&pStream->State.Cfg))
+            hdaMixerAddDrvStream(pThis, pThis->SinkFront.pMixSink,     &pStream->State.Cfg, pDrv);
+
+#ifdef VBOX_WITH_AUDIO_HDA_51_SURROUND
+        pStream = hdaGetStreamFromSink(pThis, &pThis->SinkCenterLFE);
+        if (DrvAudioHlpStreamCfgIsValid(&pStream->State.Cfg))
+            hdaMixerAddDrvStream(pThis, pThis->SinkCenterLFE.pMixSink, &pStream->State.Cfg, pDrv);
+
+        pStream = hdaGetStreamFromSink(pThis, &pThis->SinkRear);
+        if (DrvAudioHlpStreamCfgIsValid(&pStream->State.Cfg))
+            hdaMixerAddDrvStream(pThis, pThis->SinkRear.pMixSink,      &pStream->State.Cfg, pDrv);
+#endif
+        pStream = hdaGetStreamFromSink(pThis, &pThis->SinkLineIn);
+        if (DrvAudioHlpStreamCfgIsValid(&pStream->State.Cfg))
+            hdaMixerAddDrvStream(pThis, pThis->SinkLineIn.pMixSink,    &pStream->State.Cfg, pDrv);
+
+#ifdef VBOX_WITH_AUDIO_HDA_MIC_IN
+        pStream = hdaGetStreamFromSink(pThis, &pThis->SinkMicIn);
+        if (DrvAudioHlpStreamCfgIsValid(&pStream->State.Cfg))
+            hdaMixerAddDrvStream(pThis, pThis->SinkMicIn.pMixSink,     &pStream->State.Cfg, pDrv);
+#endif
+    }
 
     DEVHDA_UNLOCK(pThis);
 
-    return rc;
-}
-
+    return VINF_SUCCESS;
+}
+
+/**
+ * @interface_method_impl{PDMDEVREG,pfnDetach}
+ */
 static DECLCALLBACK(void) hdaDetach(PPDMDEVINS pDevIns, unsigned uLUN, uint32_t fFlags)
 {
-    RT_NOREF(pDevIns, uLUN, fFlags);
-    LogFunc(("iLUN=%u, fFlags=0x%x\n", uLUN, fFlags));
-}
-
-/**
- * Powers off the device.
- *
- * @param   pDevIns             Device instance to power off.
- */
-static DECLCALLBACK(void) hdaPowerOff(PPDMDEVINS pDevIns)
-{
     PHDASTATE pThis = PDMINS_2_DATA(pDevIns, PHDASTATE);
 
-    DEVHDA_LOCK_RETURN_VOID(pThis);
-
-    LogRel2(("HDA: Powering off ...\n"));
-
-    /* Ditto goes for the codec, which in turn uses the mixer. */
-    hdaCodecPowerOff(pThis->pCodec);
-
-    /**
-     * Note: Destroy the mixer while powering off and *not* in hdaDestruct,
-     *       giving the mixer the chance to release any references held to
-     *       PDM audio streams it maintains.
-     */
-    if (pThis->pMixer)
-    {
-        AudioMixerDestroy(pThis->pMixer);
-        pThis->pMixer = NULL;
+    LogFunc(("uLUN=%u, fFlags=0x%x\n", uLUN, fFlags));
+
+    DEVHDA_LOCK(pThis);
+
+    PHDADRIVER pDrv, pDrvNext;
+    RTListForEachSafe(&pThis->lstDrv, pDrv, pDrvNext, HDADRIVER, Node)
+    {
+        if (pDrv->uLUN == uLUN)
+        {
+            int rc2 = hdaDetachInternal(pThis, pDrv, fFlags);
+            if (RT_SUCCESS(rc2))
+            {
+                RTMemFree(pDrv);
+                pDrv = NULL;
+            }
+
+            break;
+        }
     }
 
@@ -4533 +4605 @@
 
 /**
- * Re-attaches a new driver to the device's driver chain.
+ * Re-attaches (replaces) a driver with a new driver.
  *
  * @returns VBox status code.
@@ -4541 +4613 @@
  *                      to the driver list.
  * @param   uLUN        The logical unit which is being re-detached.
- * @param   pszDriver   Driver name.
- */
-static int hdaReattach(PHDASTATE pThis, PHDADRIVER pDrv, uint8_t uLUN, const char *pszDriver)
+ * @param   pszDriver   New driver name to attach.
+ */
+static int hdaReattachInternal(PHDASTATE pThis, PHDADRIVER pDrv, uint8_t uLUN, const char *pszDriver)
 {
     AssertPtrReturn(pThis,     VERR_INVALID_POINTER);
     AssertPtrReturn(pszDriver, VERR_INVALID_POINTER);
+
+    int rc;
+
+    if (pDrv)
+    {
+        rc = hdaDetachInternal(pThis, pDrv, 0 /* fFlags */);
+        if (RT_SUCCESS(rc))
+            rc = PDMDevHlpDriverDetach(pThis->pDevInsR3, PDMIBASE_2_PDMDRV(pDrv->pDrvBase), 0 /* fFlags */);
+
+        if (RT_FAILURE(rc))
+            return rc;
+
+        pDrv = NULL;
+    }
 
     PVM pVM = PDMDevHlpGetVM(pThis->pDevInsR3);
@@ -4555 +4641 @@
     CFGMR3RemoveNode(CFGMR3GetChildF(pDev0, "LUN#%u/", uLUN));
 
-    if (pDrv)
-    {
-        /* Re-use a driver instance => detach the driver before. */
-        int rc = PDMDevHlpDriverDetach(pThis->pDevInsR3, PDMIBASE_2_PDMDRV(pDrv->pDrvBase), 0 /* fFlags */);
-        if (RT_FAILURE(rc))
-            return rc;
-    }
-
 #define RC_CHECK() if (RT_FAILURE(rc)) { AssertReleaseRC(rc); break; }
 
-    int rc = VINF_SUCCESS;
     do
     {
@@ -4583 +4660 @@
 
     if (RT_SUCCESS(rc))
-        rc = hdaAttachInternal(pThis->pDevInsR3, pDrv, uLUN, 0 /* fFlags */);
+        rc = hdaAttachInternal(pThis, uLUN, 0 /* fFlags */, NULL /* ppDrv */);
 
     LogFunc(("pThis=%p, uLUN=%u, pszDriver=%s, rc=%Rrc\n", pThis, uLUN, pszDriver, rc));
@@ -4590 +4667 @@
 
     return rc;
+}
+
+/**
+ * Powers off the device.
+ *
+ * @param   pDevIns             Device instance to power off.
+ */
+static DECLCALLBACK(void) hdaPowerOff(PPDMDEVINS pDevIns)
+{
+    PHDASTATE pThis = PDMINS_2_DATA(pDevIns, PHDASTATE);
+
+    DEVHDA_LOCK_RETURN_VOID(pThis);
+
+    LogRel2(("HDA: Powering off ...\n"));
+
+    /* Ditto goes for the codec, which in turn uses the mixer. */
+    hdaCodecPowerOff(pThis->pCodec);
+
+    /**
+     * Note: Destroy the mixer while powering off and *not* in hdaDestruct,
+     *       giving the mixer the chance to release any references held to
+     *       PDM audio streams it maintains.
+     */
+    if (pThis->pMixer)
+    {
+        AudioMixerDestroy(pThis->pMixer);
+        pThis->pMixer = NULL;
+    }
+
+    DEVHDA_UNLOCK(pThis);
 }
 
@@ -4763 +4870 @@
     {
         LogFunc(("Trying to attach driver for LUN #%RU32 ...\n", uLUN));
-        rc = hdaAttachInternal(pDevIns, NULL /* pDrv */, uLUN, 0 /* fFlags */);
+        rc = hdaAttachInternal(pThis, uLUN, 0 /* fFlags */, NULL /* ppDrv */);
         if (RT_FAILURE(rc))
         {
@@ -4770 +4877 @@
             else if (rc == VERR_AUDIO_BACKEND_INIT_FAILED)
             {
-                hdaReattach(pThis, NULL /* pDrv */, uLUN, "NullAudio");
+                hdaReattachInternal(pThis, NULL /* pDrv */, uLUN, "NullAudio");
                 PDMDevHlpVMSetRuntimeError(pDevIns, 0 /*fFlags*/, "HostAudioNotResponding",
                     N_("Host audio backend initialization has failed. Selecting the NULL audio backend "
@@ -4898 +5005 @@
 
                 hdaReset(pDevIns);
-                hdaReattach(pThis, pDrv, pDrv->uLUN, "NullAudio");
+                hdaReattachInternal(pThis, pDrv, pDrv->uLUN, "NullAudio");
 
                 PDMDevHlpVMSetRuntimeError(pDevIns, 0 /*fFlags*/, "HostAudioNotResponding",