Changeset 107309 in vbox for trunk

Timestamp:

Dec 13, 2024 8:13:55 AM (3 months ago)

Author:

vboxsync

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

166340

Message:

UsbNet: bugref:10779 Implemented link state handling

File:

• trunk/src/VBox/Devices/Network/UsbNet.cpp (modified) (8 diffs)

trunk/src/VBox/Devices/Network/UsbNet.cpp ¶

@@ -377 +377 @@
     /** If set the link is temporarily down because of a saved state load. */
     bool                                fLinkTempDown;
+    /** Link Up(/Restore) Timer. */
+    TMTIMERHANDLE                       hTimerLinkUp;
 
     bool                                fInitialLinkStatusSent;
@@ -1368 +1370 @@
 
 
+DECLHIDDEN(void) usbNetLinkStateNotify(PUSBNET pThis, PDMNETWORKLINKSTATE enmLinkState);
+
+/**
+ * @callback_method_impl{FNTMTIMERUSB}
+ *
+ * By the time the host resumes after sleep the network environment may have changed considerably.
+ * We handle this by temporarily lowering the link state. This callback brings the link back up.
+ */
+static DECLCALLBACK(void) usbNetTimerLinkUp(PPDMUSBINS pUsbIns, TMTIMERHANDLE hTimer, void *pvUser)
+{
+    PUSBNET pThis = (PUSBNET)pvUser;
+    RT_NOREF(pUsbIns, hTimer);
+
+    LogFlowFunc(("#%d\n", pUsbIns->iInstance));
+
+    /* @todo: Do we really care for potential races with link state? */
+    pThis->fLinkTempDown = false;
+    if (!pThis->fLinkUp)
+        usbNetLinkStateNotify(pThis, PDMNETWORKLINKSTATE_UP);
+}
+
+
 /**
  * @interface_method_impl{PDMINETWORKCONFIG,pfnSetLinkState}
@@ -1375 +1399 @@
     PUSBNET pThis = RT_FROM_MEMBER(pInterface, USBNET, Lun0.INetworkConfig);
 
-    //bool            fLinkUp;
-
-    LogFlowFunc(("#%d\n", pThis->pUsbIns->iInstance));
+    bool fLinkUp = enmState == PDMNETWORKLINKSTATE_UP;
+
+    LogFlowFunc(("#%d enmState=%d\n", pThis->pUsbIns->iInstance, enmState));
     AssertMsgReturn(enmState > PDMNETWORKLINKSTATE_INVALID && enmState <= PDMNETWORKLINKSTATE_DOWN_RESUME,
                     ("Invalid link state: enmState=%d\n", enmState), VERR_INVALID_PARAMETER);
-    RT_NOREF(pThis);
-
-#if 0
+
     if (enmState == PDMNETWORKLINKSTATE_DOWN_RESUME)
     {
-        dp8390TempLinkDown(pDevIns, pThis);
-        /*
-         * Note that we do not notify the driver about the link state change because
-         * the change is only temporary and can be disregarded from the driver's
-         * point of view (see @bugref{7057}).
-         */
-        return VINF_SUCCESS;
+        pThis->fLinkTempDown = true;
+        /* Do not bother to notify anyone if the link has been down */
+        PDMUsbHlpTimerSetMillies(pThis->pUsbIns, pThis->hTimerLinkUp, 500);    /* 0.5 sec */
     }
     /* has the state changed? */
-    fLinkUp = enmState == PDMNETWORKLINKSTATE_UP;
     if (pThis->fLinkUp != fLinkUp)
     {
         pThis->fLinkUp = fLinkUp;
-        if (fLinkUp)
-        {
-            /* Connect with a configured delay. */
-            pThis->fLinkTempDown = true;
-            pThis->cLinkDownReported = 0;
-            pThis->cLinkRestorePostponed = 0;
-            pThis->Led.Asserted.s.fError = pThis->Led.Actual.s.fError = 1;
-            int rc = PDMDevHlpTimerSetMillies(pDevIns, pThis->hTimerRestore, pThis->cMsLinkUpDelay);
-            AssertRC(rc);
-        }
-        else
-        {
-            /* Disconnect. */
-            pThis->cLinkDownReported = 0;
-            pThis->cLinkRestorePostponed = 0;
-            pThis->Led.Asserted.s.fError = pThis->Led.Actual.s.fError = 1;
-        }
-        Assert(!PDMDevHlpCritSectIsOwner(pDevIns, &pThis->CritSect));
-        if (pThisCC->pDrv)
-            pThisCC->pDrv->pfnNotifyLinkChanged(pThisCC->pDrv, enmState);
-    }
-#endif
+        usbNetLinkStateNotify(pThis, enmState);
+    }
     return VINF_SUCCESS;
 }
@@ -1665 +1662 @@
         return usbNetCompleteStall(pThis, NULL, pUrb, pEp->fHalted ? "Halted pipe" : "No request");
 
-    if (!pThis->fInitialLinkStatusSent)
-    {
-        USBCDCNOTIFICICATION LinkNotification;
-        LinkNotification.bmRequestType     = 0xa1;
-        LinkNotification.bNotificationCode = USB_CDC_NOTIFICATION_CODE_NETWORK_CONNECTION;
-        LinkNotification.wValue            = pThis->fLinkUp ? 1 : 0;
-        LinkNotification.wIndex            = 0;
-        LinkNotification.wLength           = 0;
-        usbNetCompleteNotificationOk(pThis, pUrb, &LinkNotification, sizeof(LinkNotification));
-        pThis->fInitialLinkStatusSent = true;
-    }
-    else if (!pThis->fInitialSpeedChangeSent)
+    /* CONNECTION_SPEED_CHANGE is sent first, followed by NETWORK_CONNECTION. See [NCM10] (section 7.1) */
+    if (!pThis->fInitialSpeedChangeSent)
     {
         USBCDCNOTIFICICATIONSPEEDCHG SpeedChange;
@@ -1689 +1676 @@
         pThis->fInitialSpeedChangeSent = true;
     }
+    else if (!pThis->fInitialLinkStatusSent)
+    {
+        USBCDCNOTIFICICATION LinkNotification;
+        LinkNotification.bmRequestType     = 0xa1;
+        LinkNotification.bNotificationCode = USB_CDC_NOTIFICATION_CODE_NETWORK_CONNECTION;
+        LinkNotification.wValue            = pThis->fLinkUp ? 1 : 0;
+        LinkNotification.wIndex            = 0;
+        LinkNotification.wLength           = 0;
+        usbNetCompleteNotificationOk(pThis, pUrb, &LinkNotification, sizeof(LinkNotification));
+        pThis->fInitialLinkStatusSent = true;
+    }
     else
         usbNetQueueAddTail(&pThis->ToHostIntrQueue, pUrb);
@@ -1694 +1692 @@
     LogFlow(("usbNetHandleIntrDevToHost: Added %p:%s to the to-host interrupt queue\n", pUrb, pUrb->pszDesc));
     return VINF_SUCCESS;
+}
+
+
+/**
+ * Notifies both the guest and the network/driver of link state changes.
+ *
+ * @param   pThis               The UsbNet instance.
+ * @param   enmLinkState        The new link state.
+ */
+DECLHIDDEN(void) usbNetLinkStateNotify(PUSBNET pThis, PDMNETWORKLINKSTATE enmLinkState)
+{
+    LogFlowFunc(("#%d enmLinkState=%d\n", pThis->pUsbIns->iInstance, enmLinkState));
+    RTCritSectEnter(&pThis->CritSect);
+    /* Trigger notifications */
+    pThis->fInitialLinkStatusSent  = false;
+    pThis->fInitialSpeedChangeSent = false;
+    PVUSBURB pUrb = usbNetQueueRemoveHead(&pThis->ToHostIntrQueue);
+    /* If there is a request pending, use it. Otherwise the host should poll us soon. */
+    if (pUrb)
+        usbNetHandleIntrDevToHost(pThis, &pThis->aEps[3], pUrb);
+    RTCritSectLeave(&pThis->CritSect);
+    /* Always notify our network when notifying the guest. */
+    if (pThis->Lun0.pINetwork)
+        pThis->Lun0.pINetwork->pfnNotifyLinkChanged(pThis->Lun0.pINetwork, enmLinkState);
 }
 
@@ -2097 +2119 @@
     LogFlow(("usbNetDestruct/#%u:\n", pUsbIns->iInstance));
 
+    PDMUsbHlpTimerDestroy(pUsbIns, pThis->hTimerLinkUp);
+
     if (RTCritSectIsInitialized(&pThis->CritSect))
     {
@@ -2204 +2228 @@
         return PDMUsbHlpVMSetError(pUsbIns, VERR_PDM_MISSING_INTERFACE_BELOW, RT_SRC_POS,
                                    N_("USBNET failed to query the PDMINETWORKUP from the driver below it"));
+
+    /*
+     * Create the timer for delaying of bringing the link up.
+     */
+    rc = PDMUsbHlpTimerCreate(pUsbIns, TMCLOCK_VIRTUAL, usbNetTimerLinkUp, pThis,
+                              TMTIMER_FLAGS_DEFAULT_CRIT_SECT,
+                              "Link Up", &pThis->hTimerLinkUp);
 
     /*