Changeset 63564 in vbox

Timestamp:

Aug 16, 2016 2:05:03 PM (8 years ago)

Author:

vboxsync

Message:

scm: cleaning up todos

Location:

trunk/src/VBox/HostDrivers

Files:

• VBoxNetAdp/win/VBoxNetAdp-win.cpp (modified) (10 diffs)
• VBoxNetFlt/win/cfg/VBoxNetCfg.cpp (modified) (1 diff)
• VBoxNetFlt/win/drv/VBoxNetFltM-win.cpp (modified) (2 diffs)
• VBoxNetFlt/win/drv/VBoxNetFltP-win.cpp (modified) (2 diffs)
• VBoxNetFlt/win/drv/VBoxNetFltRt-win.cpp (modified) (11 diffs)
• VBoxNetFlt/win/nobj/VBoxNetFltNobj.cpp (modified) (1 diff)
• VBoxPci/linux/VBoxPci-linux.c (modified) (4 diffs)
• VBoxUSB/win/dev/VBoxUsbPnP.cpp (modified) (1 diff)
• VBoxUSB/win/dev/VBoxUsbRt.cpp (modified) (1 diff)

trunk/src/VBox/HostDrivers/VBoxNetAdp/win/VBoxNetAdp-win.cpp

@@ -197 +197 @@
         pAdapter->hAdapter = hAdapter;
         pAdapter->pGlobals = &g_VBoxNetAdpGlobals;
-        // TODO: Use netadp structure instead!
+        /// @todo Use netadp structure instead!
     /* Use a locally administered version of the OUI we use for the guest NICs. */
     pAdapter->MacAddr.au8[0] = 0x08 | 2;
@@ -207 +207 @@
     pAdapter->MacAddr.au8[5] = uIfIndex & 0xFF;
 
-        //TODO: Statistics?
+        /// @todo Statistics?
 
         *ppAdapter = pAdapter;
@@ -265 +265 @@
         }
 
-        // TODO: Registry?
-
-        // TODO: WDM stack?
-
-        // TODO: DPC?
+        /// @todo Registry?
+
+        /// @todo WDM stack?
+
+        /// @todo DPC?
 
         GAttrs.Header.Type = NDIS_OBJECT_TYPE_MINIPORT_ADAPTER_GENERAL_ATTRIBUTES;
@@ -277 +277 @@
         GAttrs.MediaType = NdisMedium802_3;
         GAttrs.PhysicalMediumType = NdisPhysicalMediumUnspecified;
-        GAttrs.MtuSize = 1500; //TODO
+        GAttrs.MtuSize = 1500; /// @todo
         GAttrs.MaxXmitLinkSpeed = VBOXNETADPWIN_LINK_SPEED;
         GAttrs.XmitLinkSpeed = VBOXNETADPWIN_LINK_SPEED;
@@ -284 +284 @@
         GAttrs.MediaConnectState = vboxNetAdpWinGetConnectState(pAdapter);
         GAttrs.MediaDuplexState = MediaDuplexStateFull;
-        GAttrs.LookaheadSize = 1500; //TODO
+        GAttrs.LookaheadSize = 1500; /// @todo
         GAttrs.MacOptions = VBOXNETADP_MAC_OPTIONS;
         GAttrs.SupportedPacketFilters = VBOXNETADP_SUPPORTED_FILTERS;
-        GAttrs.MaxMulticastListSize = 32; //TODO
+        GAttrs.MaxMulticastListSize = 32; /// @todo
 
         GAttrs.MacAddressLength = ETH_LENGTH_OF_ADDRESS;
@@ -334 +334 @@
     PVBOXNETADP_ADAPTER pAdapter = (PVBOXNETADP_ADAPTER)MiniportAdapterContext;
     LogFlow(("==>vboxNetAdpWinHaltEx\n"));
-    // TODO: Stop something?
+    /// @todo Stop something?
     if (pAdapter)
         vboxNetAdpWinFreeAdapter(pAdapter);
@@ -403 +403 @@
         case OID_GEN_RECEIVE_BUFFER_SPACE:
         case OID_GEN_TRANSMIT_BUFFER_SPACE:
-            // TODO: Make configurable
+            /// @todo Make configurable
             ulTmp = VBOXNETADP_MAX_FRAME_SIZE * 40;
             break;
@@ -418 +418 @@
             pStats->Header.Revision = NDIS_STATISTICS_INFO_REVISION_1;
             pStats->Header.Size = NDIS_SIZEOF_STATISTICS_INFO_REVISION_1;
-            // TODO: We need some stats, don't we?
+            /// @todo We need some stats, don't we?
             break;
         }
@@ -490 +490 @@
                 break;
             }
-            // TODO: For the time being we simply ignore lookahead settings.
+            /// @todo For the time being we simply ignore lookahead settings.
             pSet->BytesRead = sizeof(ULONG);
             Status = NDIS_STATUS_SUCCESS;
@@ -502 +502 @@
                 break;
             }
-            // TODO: For the time being we simply ignore packet filter settings.
+            /// @todo For the time being we simply ignore packet filter settings.
             pSet->BytesRead = pSet->InformationBufferLength;
             Status = NDIS_STATUS_SUCCESS;

trunk/src/VBox/HostDrivers/VBoxNetFlt/win/cfg/VBoxNetCfg.cpp

@@ -3286 +3286 @@
         hr = VBoxNetCfgWinQueryINetCfg(&pNetCfg, TRUE, L"VirtualBox Host-Only Creation",
                                        30 * 1000, /* on Vista we often get 6to4svc.dll holding the lock, wait for 30 sec.  */
-                                       /* TODO: special handling for 6to4svc.dll ???, i.e. several retrieves */
+                                       /** @todo special handling for 6to4svc.dll ???, i.e. several retrieves */
                                        &lpszApp);
         if (hr == S_OK)

trunk/src/VBox/HostDrivers/VBoxNetFlt/win/drv/VBoxNetFltM-win.cpp

@@ -384 +384 @@
     }
 
-    /* TODO: */
+    /** @todo */
     *OpenErrorStatus = Status;
 
@@ -710 +710 @@
 
             /* netflt is active, update the cached value */
-            /* TODO: in case we are are not in promiscuous now, we are issuing a request.
+            /** @todo in case we are are not in promiscuous now, we are issuing a request.
              * what should we do in case of a failure?
              * i.e. should we update the fUpperProtocolSetFilter in completion routine in this case? etc. */

trunk/src/VBox/HostDrivers/VBoxNetFlt/win/drv/VBoxNetFltP-win.cpp

@@ -588 +588 @@
 
 #if defined(DEBUG_NETFLT_PACKETS) || !defined(VBOX_LOOPBACK_USEFLAGS)
-    /* @todo: for optimization we could check only for netflt-mode packets
+    /** @todo for optimization we could check only for netflt-mode packets
      * do it for all for now */
      vboxNetFltWinLbRemoveSendPacket(pNetFlt, pPacket);
@@ -1310 +1310 @@
                     VBOXNETFLT_LBVERIFY(pNetFlt, pPacket);
 #ifdef DEBUG_misha
-                    /*TODO: remove this assert.
+                    /** @todo remove this assert.
                      * this is a temporary assert for debugging purposes:
                      * we're probably doing something wrong with the packets if the miniport reports NDIS_STATUS_RESOURCES */

trunk/src/VBox/HostDrivers/VBoxNetFlt/win/drv/VBoxNetFltRt-win.cpp

@@ -807 +807 @@
 #endif
 
-            /*TODO: FIXME: !!! the better approach for performance would be to dequeue all packets at once
+            /** @todo FIXME: !!! the better approach for performance would be to dequeue all packets at once
              * and then go through all dequeued packets
              * the same should be done for enqueue !!! */
@@ -974 +974 @@
         }
 
-        /* @todo: how would we fail in this case ?*/
+        /** @todo how would we fail in this case ?*/
     }
     return Status;
@@ -1194 +1194 @@
             {
                 AssertFailed();
-                /* TODO: what status to set? */
+                /** @todo what status to set? */
                 fStatus = NDIS_STATUS_FAILURE;
                 vboxNetFltWinMemFree(pSG);
@@ -1224 +1224 @@
             {
                 AssertFailed();
-                /* TODO: what status to set? */
+                /** @todo what status to set? */
                 fStatus = NDIS_STATUS_FAILURE;
                 break;
@@ -1297 +1297 @@
     if (status != NDIS_STATUS_SUCCESS)
     {
-        /* TODO */
+        /** @todo */
         AssertFailed();
     }
@@ -1345 +1345 @@
     if (status != NDIS_STATUS_SUCCESS)
     {
-        /* TODO */
+        /** @todo */
         AssertFailed();
         return false;
@@ -1372 +1372 @@
         if (fStatus != NDIS_STATUS_SUCCESS)
         {
-            /* TODO: */
+            /** @todo */
             AssertFailed();
             return fStatus;
@@ -1405 +1405 @@
             if (fStatus != NDIS_STATUS_SUCCESS)
             {
-                /* TODO */
+                /** @todo */
                 AssertFailed();
                 return fStatus;
@@ -1528 +1528 @@
         PVOID pvMemBuf;
 
-        /* @todo: generally we do not always need to zero-initialize the complete OOB data here, reinitialize only when/what we need,
+        /** @todo generally we do not always need to zero-initialize the complete OOB data here, reinitialize only when/what we need,
          * however we DO need to reset the status for the packets we indicate via NdisMIndicateReceivePacket to avoid packet loss
          * in case the status contains NDIS_STATUS_RESOURCES */
@@ -1586 +1586 @@
                     NdisGetPacketFlags(pPacket) = 0;
                 }
-                /* TODO: set out of bound data */
+                /** @todo set out of bound data */
             }
             else
@@ -1674 +1674 @@
     if (RT_FAILURE(rc))
     {
-        /* TODO: we can not prevent driver unload here */
+        /** @todo we can not prevent driver unload here */
         AssertFailed();
 

trunk/src/VBox/HostDrivers/VBoxNetFlt/win/nobj/VBoxNetFltNobj.cpp

@@ -272 +272 @@
                 else
                 {
-                    /* TODO: we should check the default medium in HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Class\{4D36E972-E325-11CE-BFC1-08002bE10318}\<driver_id>\Ndi\Params\Medium, REG_SZ "Default" value */
+                    /** @todo we should check the default medium in HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Class\{4D36E972-E325-11CE-BFC1-08002bE10318}\<driver_id>\Ndi\Params\Medium, REG_SZ "Default" value */
                     NonStandardAssertBreakpoint();
                     *pbShouldBind = true;

trunk/src/VBox/HostDrivers/VBoxPci/linux/VBoxPci-linux.c

@@ -221 +221 @@
         if (RT_LIKELY(pData->pIommuDomain))
         {
-            /** @todo: KVM checks IOMMU_CAP_CACHE_COHERENCY and sets
+            /** @todo KVM checks IOMMU_CAP_CACHE_COHERENCY and sets
              *  flag IOMMU_CACHE later used when mapping physical
              *  addresses, which could improve performance.
@@ -413 +413 @@
             return VERR_ACCESS_DENIED;
         }
-        /** @todo: RTStrCopy not exported. */
+        /** @todo RTStrCopy not exported. */
         strncpy(pIns->szPrevDriver, currentDriver, sizeof(pIns->szPrevDriver));
     }
@@ -1024 +1024 @@
             vbpci_printk(KERN_DEBUG, pIns->pPciDev, "PCIRAW_POWER_SUSPEND\n");
             rc = VINF_SUCCESS;
-            /// @todo: what do we do here?
+            /// @todo what do we do here?
             break;
         case PCIRAW_POWER_RESUME:
             vbpci_printk(KERN_DEBUG, pIns->pPciDev, "PCIRAW_POWER_RESUME\n");
             rc = VINF_SUCCESS;
-            /// @todo: what do we do here?
+            /// @todo what do we do here?
             break;
         default:
@@ -1061 +1061 @@
 
             flags = IOMMU_READ | IOMMU_WRITE;
-            /* @todo: flags |= IOMMU_CACHE; */
+            /** @todo flags |= IOMMU_CACHE; */
 
             r = iommu_map(domain, GuestStart, HostStart, get_order(cMemSize), flags);

trunk/src/VBox/HostDrivers/VBoxUSB/win/dev/VBoxUsbPnP.cpp

@@ -182 +182 @@
     {
         AssertFailed();
-        /* todo: return more appropriate status ?? */
+        /** @todo return more appropriate status ?? */
         return STATUS_UNSUCCESSFUL;
     }

trunk/src/VBox/HostDrivers/VBoxUSB/win/dev/VBoxUsbRt.cpp

@@ -1155 +1155 @@
                 break;
             case ((USBD_STATUS)0xC0010000L): // USBD_STATUS_CANCELED - too bad usbdi.h and usb.h aren't consistent!
-                // TODO: What the heck are we really supposed to do here?
+                /// @todo What the heck are we really supposed to do here?
                 pUrbInfo->error = USBSUP_XFER_STALL;
                 Status = STATUS_SUCCESS;