Changeset 65101 in vbox for trunk/src

Timestamp:

Jan 4, 2017 12:07:43 PM (8 years ago)

Author:

vboxsync

Message:

Devices: doxygen fixes

Location:

trunk/src/VBox/Devices

Files:

• Bus/DevPCI.cpp (modified) (1 diff)
• Bus/DevPciIch9.cpp (modified) (6 diffs)
• GIMDev/GIMDev.cpp (modified) (1 diff)
• Graphics/DevVGA-SVGA.cpp (modified) (6 diffs)
• Graphics/DevVGA-SVGA3d-ogl.cpp (modified) (1 diff)
• Graphics/DevVGA-SVGA3d.cpp (modified) (1 diff)
• Graphics/DevVGA.cpp (modified) (5 diffs)
• PC/DevACPI.cpp (modified) (5 diffs)
• Storage/IOBufMgmt.cpp (modified) (1 diff)
• Storage/UsbMsd.cpp (modified) (1 diff)

trunk/src/VBox/Devices/Bus/DevPCI.cpp

@@ -271 +271 @@
  * Set the IRQ for a PCI device on the host bus - shared by host bus and bridge.
  *
- * @param   pDevIns         Device instance of the host PCI Bus.
+ * @param   pGlobals        Device instance of the host PCI Bus.
  * @param   uDevFn          The device number on the host bus which will raise the IRQ
  * @param   pPciDev         The PCI device structure which raised the interrupt.

trunk/src/VBox/Devices/Bus/DevPciIch9.cpp

@@ -155 +155 @@
  * @param   cb          The value size in bytes.
  */
-PDMBOTHCBDECL(int) ich9pciIOPortAddressWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb)
-{
-    LogFlow(("ich9pciIOPortAddressWrite: Port=%#x u32=%#x cb=%d\n", Port, u32, cb));
-    RT_NOREF2(Port, pvUser);
+PDMBOTHCBDECL(int) ich9pciIOPortAddressWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t u32, unsigned cb)
+{
+    LogFlow(("ich9pciIOPortAddressWrite: Port=%#x u32=%#x cb=%d\n", uPort, u32, cb));
+    RT_NOREF2(uPort, pvUser);
     if (cb == 4)
     {
@@ -192 +192 @@
  * @param   cb          Number of bytes read.
  */
-PDMBOTHCBDECL(int) ich9pciIOPortAddressRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb)
-{
-    RT_NOREF2(Port, pvUser);
+PDMBOTHCBDECL(int) ich9pciIOPortAddressRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t *pu32, unsigned cb)
+{
+    RT_NOREF2(uPort, pvUser);
     if (cb == 4)
     {
@@ -203 +203 @@
         PCI_UNLOCK(pDevIns);
 
-        LogFlow(("ich9pciIOPortAddressRead: Port=%#x cb=%d -> %#x\n", Port, cb, *pu32));
+        LogFlow(("ich9pciIOPortAddressRead: Port=%#x cb=%d -> %#x\n", uPort, cb, *pu32));
         return VINF_SUCCESS;
     }
 
-    Log(("ich9pciIOPortAddressRead: Port=%#x cb=%d VERR_IOM_IOPORT_UNUSED\n", Port, cb));
+    Log(("ich9pciIOPortAddressRead: Port=%#x cb=%d VERR_IOM_IOPORT_UNUSED\n", uPort, cb));
     return VERR_IOM_IOPORT_UNUSED;
 }
@@ -301 +301 @@
  * @param   cb          The value size in bytes.
  */
-PDMBOTHCBDECL(int) ich9pciIOPortDataWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb)
-{
-    LogFlow(("ich9pciIOPortDataWrite: Port=%#x u32=%#x cb=%d\n", Port, u32, cb));
+PDMBOTHCBDECL(int) ich9pciIOPortDataWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t u32, unsigned cb)
+{
+    LogFlow(("ich9pciIOPortDataWrite: Port=%#x u32=%#x cb=%d\n", uPort, u32, cb));
     NOREF(pvUser);
     int rc = VINF_SUCCESS;
-    if (!(Port % cb))
+    if (!(uPort % cb))
     {
         PDEVPCIROOT pThis = PDMINS_2_DATA(pDevIns, PDEVPCIROOT);
 
         PCI_LOCK(pDevIns, VINF_IOM_R3_IOPORT_WRITE);
-        rc = ich9pciDataWrite(pThis, Port, u32, cb);
+        rc = ich9pciDataWrite(pThis, uPort, u32, cb);
         PCI_UNLOCK(pDevIns);
     }
     else
-        AssertMsgFailed(("Unaligned write to port %#x u32=%#x cb=%d\n", Port, u32, cb));
+        AssertMsgFailed(("Unaligned write to port %#x u32=%#x cb=%d\n", uPort, u32, cb));
     return rc;
 }
@@ -422 +422 @@
  * @param   cb          Number of bytes read.
  */
-PDMBOTHCBDECL(int) ich9pciIOPortDataRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb)
+PDMBOTHCBDECL(int) ich9pciIOPortDataRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t *pu32, unsigned cb)
 {
     NOREF(pvUser);
-    if (!(Port % cb))
+    if (!(uPort % cb))
     {
         PDEVPCIROOT pThis = PDMINS_2_DATA(pDevIns, PDEVPCIROOT);
 
         PCI_LOCK(pDevIns, VINF_IOM_R3_IOPORT_READ);
-        int rc = ich9pciDataRead(pThis, Port, cb, pu32);
+        int rc = ich9pciDataRead(pThis, uPort, cb, pu32);
         PCI_UNLOCK(pDevIns);
 
-        LogFlow(("ich9pciIOPortDataRead: Port=%#x cb=%#x -> %#x (%Rrc)\n", Port, cb, *pu32, rc));
+        LogFlow(("ich9pciIOPortDataRead: Port=%#x cb=%#x -> %#x (%Rrc)\n", uPort, cb, *pu32, rc));
         return rc;
     }
-    AssertMsgFailed(("Unaligned read from port %#x cb=%d\n", Port, cb));
+    AssertMsgFailed(("Unaligned read from port %#x cb=%d\n", uPort, cb));
     return VERR_IOM_IOPORT_UNUSED;
 }
@@ -1909 +1909 @@
  * Worker for devpciR3IsConfigByteWritable that update BAR and ROM mappings.
  *
- * @param   pDev                The PCI device to update the mappings for.
+ * @param   pPciDev             The PCI device to update the mappings for.
  * @param   fP2PBridge          Whether this is a PCI to PCI bridge or not.
  */

trunk/src/VBox/Devices/GIMDev/GIMDev.cpp

@@ -73 +73 @@
 
 /**
- * @interface_method_impl{PDMIBASE, pfnQueryInterface}
+ * @interface_method_impl{PDMIBASE,pfnQueryInterface}
  */
 static DECLCALLBACK(void *) gimdevR3QueryInterface(PPDMIBASE pInterface, const char *pszIID)

trunk/src/VBox/Devices/Graphics/DevVGA-SVGA.cpp

@@ -535 +535 @@
  * @interface_method_impl{PDMIDISPLAYPORT,pfnSetViewport}
  */
-DECLCALLBACK(void) vmsvgaPortSetViewport(PPDMIDISPLAYPORT pInterface, uint32_t uScreenId, uint32_t x, uint32_t y, uint32_t cx, uint32_t cy)
+DECLCALLBACK(void) vmsvgaPortSetViewport(PPDMIDISPLAYPORT pInterface, uint32_t idScreen, uint32_t x, uint32_t y, uint32_t cx, uint32_t cy)
 {
     PVGASTATE pThis = RT_FROM_MEMBER(pInterface, VGASTATE, IPort);
 
-    Log(("vmsvgaPortSetViewPort: screen %d (%d,%d)(%d,%d)\n", uScreenId, x, y, cx, cy));
+    Log(("vmsvgaPortSetViewPort: screen %d (%d,%d)(%d,%d)\n", idScreen, x, y, cx, cy));
     VMSVGAVIEWPORT const OldViewport = pThis->svga.viewport;
 
@@ -574 +574 @@
      */
     if (pThis->svga.f3DEnabled)
-        vmsvga3dUpdateHostScreenViewport(pThis, uScreenId, &OldViewport);
+        vmsvga3dUpdateHostScreenViewport(pThis, idScreen, &OldViewport);
 # else
-    RT_NOREF(uScreenId, OldViewport);
+    RT_NOREF(idScreen, OldViewport);
 # endif
 }
@@ -1483 +1483 @@
  * @param   cb          Number of bytes read.
  */
-PDMBOTHCBDECL(int) vmsvgaIORead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb)
+PDMBOTHCBDECL(int) vmsvgaIORead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t *pu32, unsigned cb)
 {
     PVGASTATE   pThis = PDMINS_2_DATA(pDevIns, PVGASTATE);
@@ -1491 +1491 @@
     if (cb != 4)
     {
-        Log(("Ignoring non-dword read at %x cb=%d\n", Port, cb));
+        Log(("Ignoring non-dword read at %x cb=%d\n", uPort, cb));
         *pu32 = UINT32_MAX;
         return VINF_SUCCESS;
     }
 
-    switch (Port - pThis->svga.BasePort)
+    switch (uPort - pThis->svga.BasePort)
     {
     case SVGA_INDEX_PORT:
@@ -1530 +1530 @@
  * @param   cb          The value size in bytes.
  */
-PDMBOTHCBDECL(int) vmsvgaIOWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb)
+PDMBOTHCBDECL(int) vmsvgaIOWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t u32, unsigned cb)
 {
     PVGASTATE   pThis = PDMINS_2_DATA(pDevIns, PVGASTATE);
@@ -1538 +1538 @@
     if (cb != 4)
     {
-        Log(("Ignoring non-dword write at %x val=%x cb=%d\n", Port, u32, cb));
+        Log(("Ignoring non-dword write at %x val=%x cb=%d\n", uPort, u32, cb));
         return VINF_SUCCESS;
     }
 
-    switch (Port - pThis->svga.BasePort)
+    switch (uPort - pThis->svga.BasePort)
     {
     case SVGA_INDEX_PORT:

trunk/src/VBox/Devices/Graphics/DevVGA-SVGA3d-ogl.cpp

@@ -173 +173 @@
  * @returns true if supported, false if not.
  * @param   pState              The VMSVGA3d state.
- * @param   fActualGLVersion    The actual OpenGL version we're working against.
  * @param   rsMinGLVersion      The OpenGL version that introduced this feature
  *                              into the core.

trunk/src/VBox/Devices/Graphics/DevVGA-SVGA3d.cpp

@@ -342 +342 @@
  * @returns VBox status code (currently ignored).
  * @param   pThis               The VGA device instance data.
- * @param   sid                 The ID of the surface to destroy.
+ * @param   pDstSfcImg
+ * @param   pDstBox
+ * @param   pSrcSfcImg
+ * @param   pSrcBox
+ * @param   enmMode
  */
 int vmsvga3dSurfaceStretchBlt(PVGASTATE pThis, SVGA3dSurfaceImageId const *pDstSfcImg, SVGA3dBox const *pDstBox,

trunk/src/VBox/Devices/Graphics/DevVGA.cpp

@@ -2091 +2091 @@
  * @param   cx      The width.
  * @param   cy      The height.
+ * @param   pDrv    The display connector.
  */
 static int vga_resize_graphic(PVGASTATE pThis, int cx, int cy,
-                PDMIDISPLAYCONNECTOR *pDrv)
+                              PDMIDISPLAYCONNECTOR *pDrv)
 {
     const unsigned cBits = pThis->get_bpp(pThis);
@@ -3866 +3867 @@
  * @returns VBox status code.
  *
- * @param   cbDepth     Logo depth.
+ * @param   cBits       Logo depth.
  * @param   xLogo       Logo X position.
  * @param   yLogo       Logo Y position.
@@ -4611 +4612 @@
  *
  * @param   pInterface          Pointer to this interface.
+ * @param   bpp                 Bits per pixel.
+ * @param   pvVRAM              VRAM.
+ * @param   cbLine              Number of bytes per line.
  * @param   cx                  New display width.
  * @param   cy                  New display height
@@ -4768 +4772 @@
  *
  * @param   pInterface          Pointer to this interface.
+ * @param   fFailOnResize       Fail on resize.
  * @see     PDMIKEYBOARDPORT::pfnUpdateDisplayAll() for details.
  */
@@ -5585 +5590 @@
 
 /**
- * @copydoc FNSSMDEVSAVEEXEC
+ * @copydoc FNSSMDEVLOADEXEC
  */
 static DECLCALLBACK(int) vgaR3LoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)

trunk/src/VBox/Devices/PC/DevACPI.cpp

@@ -3266 +3266 @@
  * @callback_method_impl{FNPCICONFIGREAD}
  */
-static DECLCALLBACK(uint32_t) acpiR3PciConfigRead(PPDMDEVINS pDevIns, PPDMPCIDEV pPciDev, uint32_t Address, unsigned cb)
+static DECLCALLBACK(uint32_t) acpiR3PciConfigRead(PPDMDEVINS pDevIns, PPDMPCIDEV pPciDev, uint32_t uAddress, unsigned cb)
 {
     ACPIState *pThis   = PDMINS_2_DATA(pDevIns, ACPIState *);
 
-    Log2(("acpi: PCI config read: 0x%x (%d)\n", Address, cb));
-    return pThis->pfnAcpiPciConfigRead(pDevIns, pPciDev, Address, cb);
+    Log2(("acpi: PCI config read: 0x%x (%d)\n", uAddress, cb));
+    return pThis->pfnAcpiPciConfigRead(pDevIns, pPciDev, uAddress, cb);
 }
 
@@ -3277 +3277 @@
  * @callback_method_impl{FNPCICONFIGWRITE}
  */
-static DECLCALLBACK(void) acpiR3PciConfigWrite(PPDMDEVINS pDevIns, PPDMPCIDEV pPciDev, uint32_t Address,
+static DECLCALLBACK(void) acpiR3PciConfigWrite(PPDMDEVINS pDevIns, PPDMPCIDEV pPciDev, uint32_t uAddress,
                                                uint32_t u32Value, unsigned cb)
 {
     ACPIState *pThis = PDMINS_2_DATA(pDevIns, ACPIState *);
 
-    Log2(("acpi: PCI config write: 0x%x -> 0x%x (%d)\n", u32Value, Address, cb));
+    Log2(("acpi: PCI config write: 0x%x -> 0x%x (%d)\n", u32Value, uAddress, cb));
     DEVACPI_LOCK_R3(pThis);
 
-    if (Address == VBOX_PCI_INTERRUPT_LINE)
+    if (uAddress == VBOX_PCI_INTERRUPT_LINE)
     {
         Log(("acpi: ignore interrupt line settings: %d, we'll use hardcoded value %d\n", u32Value, SCI_INT));
@@ -3291 +3291 @@
     }
 
-    pThis->pfnAcpiPciConfigWrite(pDevIns, pPciDev, Address, u32Value, cb);
+    pThis->pfnAcpiPciConfigWrite(pDevIns, pPciDev, uAddress, u32Value, cb);
 
     /* Assume that the base address is only changed when the corresponding
@@ -3297 +3297 @@
      * functionality is enabled by the guest. */
 
-    if (Address == PMREGMISC)
+    if (uAddress == PMREGMISC)
     {
         RTIOPORT NewIoPortBase = 0;
@@ -3311 +3311 @@
     }
 
-    if (Address == SMBHSTCFG)
+    if (uAddress == SMBHSTCFG)
     {
         RTIOPORT NewIoPortBase = 0;

trunk/src/VBox/Devices/Storage/IOBufMgmt.cpp

@@ -114 +114 @@
  * @param   cbMem       Size of the memory buffer.
  * @param   cBins       Number of bins available.
- * @param   cbBinMin    Minimum object size.
+ * @param   cbMinBin    Minimum object size.
  */
 DECLINLINE(uint32_t) iobufMgrGetObjCount(size_t cbMem, unsigned cBins, size_t cbMinBin)

trunk/src/VBox/Devices/Storage/UsbMsd.cpp

@@ -1207 +1207 @@
 
 /**
- * @interface_method_impl{PDMISCSIPORT,pfnQueryDeviceLocation}
+ * @interface_method_impl{PDMIMEDIAPORT,pfnQueryDeviceLocation}
  */
 static DECLCALLBACK(int) usbMsdLun0QueryDeviceLocation(PPDMIMEDIAPORT pInterface, const char **ppcszController,