VirtualBox

Changeset 65101 in vbox


Ignore:
Timestamp:
Jan 4, 2017 12:07:43 PM (8 years ago)
Author:
vboxsync
Message:

Devices: doxygen fixes

Location:
trunk
Files:
13 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/VBox/vmm/pdmdev.h

    r64844 r65101  
    569569     * @param   iRegion         The region number.
    570570     * @param   cbRegion        Size of the region.
    571      * @param   iType           PCI_ADDRESS_SPACE_MEM, PCI_ADDRESS_SPACE_IO or PCI_ADDRESS_SPACE_MEM_PREFETCH.
     571     * @param   enmType         PCI_ADDRESS_SPACE_MEM, PCI_ADDRESS_SPACE_IO or PCI_ADDRESS_SPACE_MEM_PREFETCH.
    572572     * @param   pfnCallback     Callback for doing the mapping.
    573573     * @remarks Caller enters the PDM critical section.
    … …  
    586586     *                          to call default PCI config read function. Can be NULL.
    587587     * @param   pfnWrite        Pointer to the user defined PCI config write function.
    588      * @param   pfnWriteOld     Pointer to function pointer which will receive the old (default)
     588     * @param   ppfnWriteOld    Pointer to function pointer which will receive the old (default)
    589589     *                          PCI config write function. This way, user can decide when (and if)
    590590     *                          to call default PCI config write function. Can be NULL.

  • trunk/include/VBox/vmm/pdmpci.h

    r64376 r65101  
    7171     * @param   pcbRegion           Where to store region size.
    7272     *
    73      * @param   fMmio               If region is MMIO or IO.
     73     * @param   pfFlags             If region is MMIO or IO.
    7474     * @thread  Any thread.
    7575     */
    … …  
    167167     * @param   pInterface          Pointer to this interface structure.
    168168     * @param   Address             Guest physical address.
     169     *                              @todo Why is this documented as guest physical
     170     *                              address and given a host ring-0 address type?
    169171     * @param   pvValue             Address of value to write.
    170172     * @param   cb                  Access width.
    … …  
    173175     */
    174176    DECLR3CALLBACKMEMBER(int, pfnMmioWrite, (PPDMIPCIRAWUP pInterface,
    175                                              RTR0PTR       Address, /**< Why is this documented as guest physical address and given a host ring-0 address type??? */
     177                                             RTR0PTR       Address,
    176178                                             void const   *pvValue,
    177179                                             unsigned      cb));
    … …  
    183185     * @param   pInterface          Pointer to this interface structure.
    184186     * @param   Address             Guest physical address.
     187     *                              @todo Why is this documented as guest physical
     188     *                              address and given a host ring-0 address type?
    185189     * @param   pvValue             Place to store read value.
    186190     * @param   cb                  Access width.
    … …  
    190194
    191195    DECLR3CALLBACKMEMBER(int, pfnMmioRead, (PPDMIPCIRAWUP pInterface,
    192                                             RTR0PTR       Address, /**< Why is this documented as guest physical address and given a host ring-0 address type??? */
     196                                            RTR0PTR       Address,
    193197                                            void         *pvValue,
    194198                                            unsigned      cb));
    … …  
    243247     * @returns status code
    244248     * @param   pInterface          Pointer to this interface structure.
    245      * @param   pListener           Pointer to the listener object.
    246249     * @param   uGuestIrq           Guest IRQ to be passed to pfnInterruptRequest().
    247250     *
    … …  
    303306     *
    304307     * @param   pInterface          Pointer to this interface structure.
     308     * @param   fFlags              Flags.
    305309     *
    306310     * @thread  Any thread.
    … …  
    326330     * @param   pInterface          Pointer to this interface structure.
    327331     * @param   fFatal              If error is fatal.
    328      * @param   szErrorId           Error ID.
    329      * @param   szMessage           Error message.
     332     * @param   pszErrorId          Error ID.
     333     * @param   pszMessage          Error message.
    330334     *
    331335     * @thread  Any thread.

  • trunk/include/VBox/vmm/pdmpcidevint.h

    r64414 r65101  
    5555 * @param   iBus            The bus number this device is on.
    5656 * @param   iDevice         The number of the device on the bus.
    57  * @param   Address         The configuration space register address. [0..255]
     57 * @param   u32Address      The configuration space register address. [0..255]
    5858 * @param   cb              The register size. [1,2,4]
    5959 */
    … …  
    7070 * @param   iBus            The bus number this device is on.
    7171 * @param   iDevice         The number of the device on the bus.
    72  * @param   Address         The configuration space register address. [0..255]
     72 * @param   u32Address      The configuration space register address. [0..255]
    7373 * @param   u32Value        The value that's being written. The number of bits actually used from
    7474 *                          this value is determined by the cb parameter.

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

    r64706 r65101  
    271271 * Set the IRQ for a PCI device on the host bus - shared by host bus and bridge.
    272272 *
    273  * @param   pDevIns         Device instance of the host PCI Bus.
     273 * @param   pGlobals        Device instance of the host PCI Bus.
    274274 * @param   uDevFn          The device number on the host bus which will raise the IRQ
    275275 * @param   pPciDev         The PCI device structure which raised the interrupt.

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

    r65058 r65101  
    155155 * @param   cb          The value size in bytes.
    156156 */
    157 PDMBOTHCBDECL(int) ich9pciIOPortAddressWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb)
    158 {
    159     LogFlow(("ich9pciIOPortAddressWrite: Port=%#x u32=%#x cb=%d\n", Port, u32, cb));
    160     RT_NOREF2(Port, pvUser);
     157PDMBOTHCBDECL(int) ich9pciIOPortAddressWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t u32, unsigned cb)
     158{
     159    LogFlow(("ich9pciIOPortAddressWrite: Port=%#x u32=%#x cb=%d\n", uPort, u32, cb));
     160    RT_NOREF2(uPort, pvUser);
    161161    if (cb == 4)
    162162    {
    … …  
    192192 * @param   cb          Number of bytes read.
    193193 */
    194 PDMBOTHCBDECL(int) ich9pciIOPortAddressRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb)
    195 {
    196     RT_NOREF2(Port, pvUser);
     194PDMBOTHCBDECL(int) ich9pciIOPortAddressRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t *pu32, unsigned cb)
     195{
     196    RT_NOREF2(uPort, pvUser);
    197197    if (cb == 4)
    198198    {
    … …  
    203203        PCI_UNLOCK(pDevIns);
    204204
    205         LogFlow(("ich9pciIOPortAddressRead: Port=%#x cb=%d -> %#x\n", Port, cb, *pu32));
     205        LogFlow(("ich9pciIOPortAddressRead: Port=%#x cb=%d -> %#x\n", uPort, cb, *pu32));
    206206        return VINF_SUCCESS;
    207207    }
    208208
    209     Log(("ich9pciIOPortAddressRead: Port=%#x cb=%d VERR_IOM_IOPORT_UNUSED\n", Port, cb));
     209    Log(("ich9pciIOPortAddressRead: Port=%#x cb=%d VERR_IOM_IOPORT_UNUSED\n", uPort, cb));
    210210    return VERR_IOM_IOPORT_UNUSED;
    211211}
    … …  
    301301 * @param   cb          The value size in bytes.
    302302 */
    303 PDMBOTHCBDECL(int) ich9pciIOPortDataWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb)
    304 {
    305     LogFlow(("ich9pciIOPortDataWrite: Port=%#x u32=%#x cb=%d\n", Port, u32, cb));
     303PDMBOTHCBDECL(int) ich9pciIOPortDataWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t u32, unsigned cb)
     304{
     305    LogFlow(("ich9pciIOPortDataWrite: Port=%#x u32=%#x cb=%d\n", uPort, u32, cb));
    306306    NOREF(pvUser);
    307307    int rc = VINF_SUCCESS;
    308     if (!(Port % cb))
     308    if (!(uPort % cb))
    309309    {
    310310        PDEVPCIROOT pThis = PDMINS_2_DATA(pDevIns, PDEVPCIROOT);
    311311
    312312        PCI_LOCK(pDevIns, VINF_IOM_R3_IOPORT_WRITE);
    313         rc = ich9pciDataWrite(pThis, Port, u32, cb);
     313        rc = ich9pciDataWrite(pThis, uPort, u32, cb);
    314314        PCI_UNLOCK(pDevIns);
    315315    }
    316316    else
    317         AssertMsgFailed(("Unaligned write to port %#x u32=%#x cb=%d\n", Port, u32, cb));
     317        AssertMsgFailed(("Unaligned write to port %#x u32=%#x cb=%d\n", uPort, u32, cb));
    318318    return rc;
    319319}
    … …  
    422422 * @param   cb          Number of bytes read.
    423423 */
    424 PDMBOTHCBDECL(int) ich9pciIOPortDataRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb)
     424PDMBOTHCBDECL(int) ich9pciIOPortDataRead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t *pu32, unsigned cb)
    425425{
    426426    NOREF(pvUser);
    427     if (!(Port % cb))
     427    if (!(uPort % cb))
    428428    {
    429429        PDEVPCIROOT pThis = PDMINS_2_DATA(pDevIns, PDEVPCIROOT);
    430430
    431431        PCI_LOCK(pDevIns, VINF_IOM_R3_IOPORT_READ);
    432         int rc = ich9pciDataRead(pThis, Port, cb, pu32);
     432        int rc = ich9pciDataRead(pThis, uPort, cb, pu32);
    433433        PCI_UNLOCK(pDevIns);
    434434
    435         LogFlow(("ich9pciIOPortDataRead: Port=%#x cb=%#x -> %#x (%Rrc)\n", Port, cb, *pu32, rc));
     435        LogFlow(("ich9pciIOPortDataRead: Port=%#x cb=%#x -> %#x (%Rrc)\n", uPort, cb, *pu32, rc));
    436436        return rc;
    437437    }
    438     AssertMsgFailed(("Unaligned read from port %#x cb=%d\n", Port, cb));
     438    AssertMsgFailed(("Unaligned read from port %#x cb=%d\n", uPort, cb));
    439439    return VERR_IOM_IOPORT_UNUSED;
    440440}
    … …  
    19091909 * Worker for devpciR3IsConfigByteWritable that update BAR and ROM mappings.
    19101910 *
    1911  * @param   pDev                The PCI device to update the mappings for.
     1911 * @param   pPciDev             The PCI device to update the mappings for.
    19121912 * @param   fP2PBridge          Whether this is a PCI to PCI bridge or not.
    19131913 */

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

    r64373 r65101  
    7373
    7474/**
    75  * @interface_method_impl{PDMIBASE, pfnQueryInterface}
     75 * @interface_method_impl{PDMIBASE,pfnQueryInterface}
    7676 */
    7777static DECLCALLBACK(void *) gimdevR3QueryInterface(PPDMIBASE pInterface, const char *pszIID)

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

    r64482 r65101  
    535535 * @interface_method_impl{PDMIDISPLAYPORT,pfnSetViewport}
    536536 */
    537 DECLCALLBACK(void) vmsvgaPortSetViewport(PPDMIDISPLAYPORT pInterface, uint32_t uScreenId, uint32_t x, uint32_t y, uint32_t cx, uint32_t cy)
     537DECLCALLBACK(void) vmsvgaPortSetViewport(PPDMIDISPLAYPORT pInterface, uint32_t idScreen, uint32_t x, uint32_t y, uint32_t cx, uint32_t cy)
    538538{
    539539    PVGASTATE pThis = RT_FROM_MEMBER(pInterface, VGASTATE, IPort);
    540540
    541     Log(("vmsvgaPortSetViewPort: screen %d (%d,%d)(%d,%d)\n", uScreenId, x, y, cx, cy));
     541    Log(("vmsvgaPortSetViewPort: screen %d (%d,%d)(%d,%d)\n", idScreen, x, y, cx, cy));
    542542    VMSVGAVIEWPORT const OldViewport = pThis->svga.viewport;
    543543
    … …  
    574574     */
    575575    if (pThis->svga.f3DEnabled)
    576         vmsvga3dUpdateHostScreenViewport(pThis, uScreenId, &OldViewport);
     576        vmsvga3dUpdateHostScreenViewport(pThis, idScreen, &OldViewport);
    577577# else
    578     RT_NOREF(uScreenId, OldViewport);
     578    RT_NOREF(idScreen, OldViewport);
    579579# endif
    580580}
    … …  
    14831483 * @param   cb          Number of bytes read.
    14841484 */
    1485 PDMBOTHCBDECL(int) vmsvgaIORead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t *pu32, unsigned cb)
     1485PDMBOTHCBDECL(int) vmsvgaIORead(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t *pu32, unsigned cb)
    14861486{
    14871487    PVGASTATE   pThis = PDMINS_2_DATA(pDevIns, PVGASTATE);
    … …  
    14911491    if (cb != 4)
    14921492    {
    1493         Log(("Ignoring non-dword read at %x cb=%d\n", Port, cb));
     1493        Log(("Ignoring non-dword read at %x cb=%d\n", uPort, cb));
    14941494        *pu32 = UINT32_MAX;
    14951495        return VINF_SUCCESS;
    14961496    }
    14971497
    1498     switch (Port - pThis->svga.BasePort)
     1498    switch (uPort - pThis->svga.BasePort)
    14991499    {
    15001500    case SVGA_INDEX_PORT:
    … …  
    15301530 * @param   cb          The value size in bytes.
    15311531 */
    1532 PDMBOTHCBDECL(int) vmsvgaIOWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT Port, uint32_t u32, unsigned cb)
     1532PDMBOTHCBDECL(int) vmsvgaIOWrite(PPDMDEVINS pDevIns, void *pvUser, RTIOPORT uPort, uint32_t u32, unsigned cb)
    15331533{
    15341534    PVGASTATE   pThis = PDMINS_2_DATA(pDevIns, PVGASTATE);
    … …  
    15381538    if (cb != 4)
    15391539    {
    1540         Log(("Ignoring non-dword write at %x val=%x cb=%d\n", Port, u32, cb));
     1540        Log(("Ignoring non-dword write at %x val=%x cb=%d\n", uPort, u32, cb));
    15411541        return VINF_SUCCESS;
    15421542    }
    15431543
    1544     switch (Port - pThis->svga.BasePort)
     1544    switch (uPort - pThis->svga.BasePort)
    15451545    {
    15461546    case SVGA_INDEX_PORT:

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

    r64483 r65101  
    173173 * @returns true if supported, false if not.
    174174 * @param   pState              The VMSVGA3d state.
    175  * @param   fActualGLVersion    The actual OpenGL version we're working against.
    176175 * @param   rsMinGLVersion      The OpenGL version that introduced this feature
    177176 *                              into the core.

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

    r64483 r65101  
    342342 * @returns VBox status code (currently ignored).
    343343 * @param   pThis               The VGA device instance data.
    344  * @param   sid                 The ID of the surface to destroy.
     344 * @param   pDstSfcImg
     345 * @param   pDstBox
     346 * @param   pSrcSfcImg
     347 * @param   pSrcBox
     348 * @param   enmMode
    345349 */
    346350int vmsvga3dSurfaceStretchBlt(PVGASTATE pThis, SVGA3dSurfaceImageId const *pDstSfcImg, SVGA3dBox const *pDstBox,

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

    r64960 r65101  
    20912091 * @param   cx      The width.
    20922092 * @param   cy      The height.
     2093 * @param   pDrv    The display connector.
    20932094 */
    20942095static int vga_resize_graphic(PVGASTATE pThis, int cx, int cy,
    2095                 PDMIDISPLAYCONNECTOR *pDrv)
     2096                              PDMIDISPLAYCONNECTOR *pDrv)
    20962097{
    20972098    const unsigned cBits = pThis->get_bpp(pThis);
    … …  
    38663867 * @returns VBox status code.
    38673868 *
    3868  * @param   cbDepth     Logo depth.
     3869 * @param   cBits       Logo depth.
    38693870 * @param   xLogo       Logo X position.
    38703871 * @param   yLogo       Logo Y position.
    … …  
    46114612 *
    46124613 * @param   pInterface          Pointer to this interface.
     4614 * @param   bpp                 Bits per pixel.
     4615 * @param   pvVRAM              VRAM.
     4616 * @param   cbLine              Number of bytes per line.
    46134617 * @param   cx                  New display width.
    46144618 * @param   cy                  New display height
    … …  
    47684772 *
    47694773 * @param   pInterface          Pointer to this interface.
     4774 * @param   fFailOnResize       Fail on resize.
    47704775 * @see     PDMIKEYBOARDPORT::pfnUpdateDisplayAll() for details.
    47714776 */
    … …  
    55855590
    55865591/**
    5587  * @copydoc FNSSMDEVSAVEEXEC
     5592 * @copydoc FNSSMDEVLOADEXEC
    55885593 */
    55895594static DECLCALLBACK(int) vgaR3LoadExec(PPDMDEVINS pDevIns, PSSMHANDLE pSSM, uint32_t uVersion, uint32_t uPass)

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

    r64393 r65101  
    32663266 * @callback_method_impl{FNPCICONFIGREAD}
    32673267 */
    3268 static DECLCALLBACK(uint32_t) acpiR3PciConfigRead(PPDMDEVINS pDevIns, PPDMPCIDEV pPciDev, uint32_t Address, unsigned cb)
     3268static DECLCALLBACK(uint32_t) acpiR3PciConfigRead(PPDMDEVINS pDevIns, PPDMPCIDEV pPciDev, uint32_t uAddress, unsigned cb)
    32693269{
    32703270    ACPIState *pThis   = PDMINS_2_DATA(pDevIns, ACPIState *);
    32713271
    3272     Log2(("acpi: PCI config read: 0x%x (%d)\n", Address, cb));
    3273     return pThis->pfnAcpiPciConfigRead(pDevIns, pPciDev, Address, cb);
     3272    Log2(("acpi: PCI config read: 0x%x (%d)\n", uAddress, cb));
     3273    return pThis->pfnAcpiPciConfigRead(pDevIns, pPciDev, uAddress, cb);
    32743274}
    32753275
    … …  
    32773277 * @callback_method_impl{FNPCICONFIGWRITE}
    32783278 */
    3279 static DECLCALLBACK(void) acpiR3PciConfigWrite(PPDMDEVINS pDevIns, PPDMPCIDEV pPciDev, uint32_t Address,
     3279static DECLCALLBACK(void) acpiR3PciConfigWrite(PPDMDEVINS pDevIns, PPDMPCIDEV pPciDev, uint32_t uAddress,
    32803280                                               uint32_t u32Value, unsigned cb)
    32813281{
    32823282    ACPIState *pThis = PDMINS_2_DATA(pDevIns, ACPIState *);
    32833283
    3284     Log2(("acpi: PCI config write: 0x%x -> 0x%x (%d)\n", u32Value, Address, cb));
     3284    Log2(("acpi: PCI config write: 0x%x -> 0x%x (%d)\n", u32Value, uAddress, cb));
    32853285    DEVACPI_LOCK_R3(pThis);
    32863286
    3287     if (Address == VBOX_PCI_INTERRUPT_LINE)
     3287    if (uAddress == VBOX_PCI_INTERRUPT_LINE)
    32883288    {
    32893289        Log(("acpi: ignore interrupt line settings: %d, we'll use hardcoded value %d\n", u32Value, SCI_INT));
    … …  
    32913291    }
    32923292
    3293     pThis->pfnAcpiPciConfigWrite(pDevIns, pPciDev, Address, u32Value, cb);
     3293    pThis->pfnAcpiPciConfigWrite(pDevIns, pPciDev, uAddress, u32Value, cb);
    32943294
    32953295    /* Assume that the base address is only changed when the corresponding
    … …  
    32973297     * functionality is enabled by the guest. */
    32983298
    3299     if (Address == PMREGMISC)
     3299    if (uAddress == PMREGMISC)
    33003300    {
    33013301        RTIOPORT NewIoPortBase = 0;
    … …  
    33113311    }
    33123312
    3313     if (Address == SMBHSTCFG)
     3313    if (uAddress == SMBHSTCFG)
    33143314    {
    33153315        RTIOPORT NewIoPortBase = 0;

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

    r64789 r65101  
    114114 * @param   cbMem       Size of the memory buffer.
    115115 * @param   cBins       Number of bins available.
    116  * @param   cbBinMin    Minimum object size.
     116 * @param   cbMinBin    Minimum object size.
    117117 */
    118118DECLINLINE(uint32_t) iobufMgrGetObjCount(size_t cbMem, unsigned cBins, size_t cbMinBin)

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

    r64274 r65101  
    12071207
    12081208/**
    1209  * @interface_method_impl{PDMISCSIPORT,pfnQueryDeviceLocation}
     1209 * @interface_method_impl{PDMIMEDIAPORT,pfnQueryDeviceLocation}
    12101210 */
    12111211static DECLCALLBACK(int) usbMsdLun0QueryDeviceLocation(PPDMIMEDIAPORT pInterface, const char **ppcszController,
Note: See TracChangeset for help on using the changeset viewer.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette