VirtualBox

Changeset 41777 in vbox for trunk/src/VBox/VMM/VMMR3


Ignore:
Timestamp:
Jun 16, 2012 6:49:15 PM (13 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
78595
Message:

Doxygen.

Location:
trunk/src/VBox/VMM/VMMR3
Files:
16 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/VBox/VMM/VMMR3/DBGF.cpp

    r40274 r41777  
    874874 *
    875875 * @returns VBox status code.
    876  * @param   pVM     Pointer to the shared VM structure.
     876 * @param   pVM     Pointer to the VM.
    877877 */
    878878static DECLCALLBACK(int) dbgfR3Attach(PVM pVM)
  • trunk/src/VBox/VMM/VMMR3/DBGFMem.cpp

    r38838 r41777  
    137137 *
    138138 * @returns VBox status code.
    139  * @param   pVM             Pointer to the shared VM structure.
     139 * @param   pVM             Pointer to the VM.
    140140 * @param   pAddress        Where to start reading.
    141141 * @param   pvBuf           Where to store the data we've read.
     
    197197 * @returns VBox status code.
    198198 *
    199  * @param   pVM             Pointer to the shared VM structure.
     199 * @param   pVM             Pointer to the VM.
    200200 * @param   idCpu           The ID of the source CPU context (for the address).
    201201 * @param   pAddress        Where to start reading.
     
    221221 * @returns VBox status code.
    222222 *
    223  * @param   pVM             Pointer to the shared VM structure.
     223 * @param   pVM             Pointer to the VM.
    224224 * @param   idCpu           The ID of the source CPU context (for the address).
    225225 * @param   pAddress        Where to start reading.
     
    269269 * @returns VBox status code.
    270270 *
    271  * @param   pVM             Pointer to the shared VM structure.
     271 * @param   pVM             Pointer to the VM.
    272272 * @param   idCpu           The ID of the source CPU context (for the address).
    273273 * @param   pAddress        Where to start reading.
     
    300300 * @returns VBox status code.
    301301 *
    302  * @param   pVM             Pointer to the shared VM structure.
     302 * @param   pVM             Pointer to the VM.
    303303 * @param   idCpu           The ID of the target CPU context (for the address).
    304304 * @param   pAddress        Where to start writing.
     
    357357 * @returns VBox status code.
    358358 *
    359  * @param   pVM             Pointer to the shared VM structure.
     359 * @param   pVM             Pointer to the VM.
    360360 * @param   idCpu           The ID of the target CPU context (for the address).
    361361 * @param   pAddress        Where to start writing.
  • trunk/src/VBox/VMM/VMMR3/DBGFOS.cpp

    r38838 r41777  
    4646 * Internal cleanup routine called by DBGFR3Term().
    4747 *
    48  * @param   pVM     Pointer to the shared VM structure.
     48 * @param   pVM     Pointer to the VM.
    4949 */
    5050void dbgfR3OSTerm(PVM pVM)
     
    7777 *
    7878 * @returns VBox status code.
    79  * @param   pVM     Pointer to the shared VM structure.
     79 * @param   pVM     Pointer to the VM.
    8080 * @param   pReg    The registration structure.
    8181 */
     
    126126 *
    127127 * @returns VBox status code.
    128  * @param   pVM     Pointer to the shared VM structure.
     128 * @param   pVM     Pointer to the VM.
    129129 * @param   pReg    The registration structure.
    130130 * @thread  Any.
     
    164164 *
    165165 * @returns VBox status code.
    166  * @param   pVM     Pointer to the shared VM structure.
     166 * @param   pVM     Pointer to the VM.
    167167 * @param   pReg    The registration structure.
    168168 */
     
    216216 * @returns VBox status code.
    217217 *
    218  * @param   pVM     Pointer to the shared VM structure.
     218 * @param   pVM     Pointer to the VM.
    219219 * @param   pReg    The registration structure.
    220220 * @thread  Any.
     
    258258 * @retval  VINF_DBGF_OS_NOT_DETCTED if we cannot figure it out.
    259259 *
    260  * @param   pVM         Pointer to the shared VM structure.
     260 * @param   pVM         Pointer to the VM.
    261261 * @param   pszName     Where to store the OS name. Empty string if not detected.
    262262 * @param   cchName     Size of the buffer.
     
    305305 * @retval  VINF_DBGF_OS_NOT_DETCTED if we cannot figure it out.
    306306 *
    307  * @param   pVM         Pointer to the shared VM structure.
     307 * @param   pVM         Pointer to the VM.
    308308 * @param   pszName     Where to store the OS name. Empty string if not detected.
    309309 * @param   cchName     Size of the buffer.
     
    327327 *
    328328 * @returns VBox status code.
    329  * @param   pVM             Pointer to the shared VM structure.
     329 * @param   pVM             Pointer to the VM.
    330330 * @param   pszName         Where to store the OS name. Optional.
    331331 * @param   cchName         The size of the name buffer.
     
    374374 *
    375375 * @returns VBox status code.
    376  * @param   pVM             Pointer to the shared VM structure.
     376 * @param   pVM             Pointer to the VM.
    377377 * @param   pszName         Where to store the OS name. Optional.
    378378 * @param   cchName         The size of the name buffer.
     
    405405 * EMT worker for DBGFR3OSQueryInterface.
    406406 *
    407  * @param   pVM         Pointer to the shared VM structure.
     407 * @param   pVM         Pointer to the VM.
    408408 * @param   enmIf       The interface identifier.
    409409 * @param   ppvIf       Where to store the interface pointer on success.
     
    430430 * @returns Pointer to the digger interface on success, NULL if the interfaces isn't
    431431 *          available or no active guest OS digger.
    432  * @param   pVM         Pointer to the shared VM structure.
     432 * @param   pVM         Pointer to the VM.
    433433 * @param   enmIf       The interface identifier.
    434434 * @thread  Any.
  • trunk/src/VBox/VMM/VMMR3/GMM.cpp

    r39405 r41777  
    7171 *
    7272 * @returns VINF_SUCCESS or VERR_NO_TMP_MEMORY.
    73  * @param       pVM         Pointer to the shared VM structure.
     73 * @param       pVM         Pointer to the VM.
    7474 * @param[out]  ppReq       Where to store the pointer to the request packet.
    7575 * @param       cPages      The number of pages that's to be allocated.
     
    9898 *
    9999 * @returns VBox status code.
    100  * @param   pVM         Pointer to the shared VM structure.
     100 * @param   pVM         Pointer to the VM.
    101101 * @param   pReq        Pointer to the request (returned by GMMR3AllocatePagesPrepare).
    102102 */
     
    152152 *
    153153 * @returns VINF_SUCCESS or VERR_NO_TMP_MEMORY.
    154  * @param       pVM         Pointer to the shared VM structure.
     154 * @param       pVM         Pointer to the VM.
    155155 * @param[out]  ppReq       Where to store the pointer to the request packet.
    156156 * @param       cPages      The number of pages that's to be freed.
     
    178178 *
    179179 * @returns VINF_SUCCESS or VERR_NO_TMP_MEMORY.
    180  * @param       pVM         Pointer to the shared VM structure.
     180 * @param       pVM         Pointer to the VM.
    181181 * @param       pReq        A request buffer previously returned by
    182182 *                          GMMR3FreePagesPrepare().
     
    200200 *
    201201 * @returns VBox status code.
    202  * @param   pVM             Pointer to the shared VM structure.
     202 * @param   pVM             Pointer to the VM.
    203203 * @param   pReq            Pointer to the request (returned by GMMR3FreePagesPrepare).
    204204 * @param   cActualPages    The number of pages actually freed.
     
    246246 * This will not call VMSetError on failure but will use AssertLogRel instead.
    247247 *
    248  * @param   pVM         Pointer to the shared VM structure.
     248 * @param   pVM         Pointer to the VM.
    249249 * @param   pAllocReq   The allocation request to undo.
    250250 */
  • trunk/src/VBox/VMM/VMMR3/MMHyper.cpp

    r39402 r41777  
    527527 * @return VBox status code.
    528528 *
    529  * @param   pVM         Pointer to the shared VM structure.
     529 * @param   pVM         Pointer to the VM.
    530530 * @param   pDevIns     The device owning the MMIO2 memory.
    531531 * @param   iRegion     The region.
  • trunk/src/VBox/VMM/VMMR3/PDM.cpp

    r40958 r41777  
    570570 * Worker for pdmR3Term that terminates a LUN chain.
    571571 *
    572  * @param   pVM         Pointer to the shared VM structure.
     572 * @param   pVM         Pointer to the VM.
    573573 * @param   pLun        The head of the chain.
    574574 * @param   pszDevice   The name of the device (for logging).
  • trunk/src/VBox/VMM/VMMR3/PDMAsyncCompletion.cpp

    r40274 r41777  
    201201 *
    202202 * @returns VBox status code.
    203  * @param   pVM             Pointer to the shared VM structure.
     203 * @param   pVM             Pointer to the VM.
    204204 * @param   pDevIns         The device instance.
    205205 * @param   ppTemplate      Where to store the template pointer on success.
     
    243243 *
    244244 * @returns VBox status code.
    245  * @param   pVM             Pointer to the shared VM structure.
     245 * @param   pVM             Pointer to the VM.
    246246 * @param   pDrvIns         The driver instance.
    247247 * @param   ppTemplate      Where to store the template pointer on success.
     
    286286 *
    287287 * @returns VBox status code.
    288  * @param   pVM             Pointer to the shared VM structure.
     288 * @param   pVM             Pointer to the VM.
    289289 * @param   pUsbIns         The USB device instance.
    290290 * @param   ppTemplate      Where to store the template pointer on success.
     
    328328 *
    329329 * @returns VBox status code.
    330  * @param   pVM             Pointer to the shared VM structure.
     330 * @param   pVM             Pointer to the VM.
    331331 * @param   ppTemplate      Where to store the template pointer on success.
    332332 * @param   pfnCompleted    The completion callback routine.
     
    426426 * @retval  VERR_PDM_ASYNC_TEMPLATE_BUSY if one or more of the templates are still in use.
    427427 *
    428  * @param   pVM             Pointer to the shared VM structure.
     428 * @param   pVM             Pointer to the VM.
    429429 * @param   pDevIns         The device instance.
    430430 */
     
    475475 * @retval  VERR_PDM_ASYNC_TEMPLATE_BUSY if one or more of the templates are still in use.
    476476 *
    477  * @param   pVM             Pointer to the shared VM structure.
     477 * @param   pVM             Pointer to the VM.
    478478 * @param   pDrvIns         The driver instance.
    479479 */
     
    524524 * @retval  VERR_PDM_ASYNC_TEMPLATE_BUSY if one or more of the templates are still in use.
    525525 *
    526  * @param   pVM             Pointer to the shared VM structure.
     526 * @param   pVM             Pointer to the VM.
    527527 * @param   pUsbIns         The USB device instance.
    528528 */
     
    905905 *
    906906 * @returns VBox status code
    907  * @param   pVM Pointer to the shared VM structure.
     907 * @param   pVM Pointer to the VM.
    908908 */
    909909int pdmR3AsyncCompletionInit(PVM pVM)
     
    925925 *
    926926 * @returns VBox status code
    927  * @param   pVM Pointer to the shared VM structure.
     927 * @param   pVM Pointer to the VM.
    928928 */
    929929int pdmR3AsyncCompletionTerm(PVM pVM)
     
    943943 *
    944944 * @returns nothing.
    945  * @param   pVM Pointer to the shared VM structure.
     945 * @param   pVM Pointer to the VM.
    946946 */
    947947void pdmR3AsyncCompletionResume(PVM pVM)
  • trunk/src/VBox/VMM/VMMR3/PDMDevice.cpp

    r40920 r41777  
    469469 *
    470470 * @returns VBox status code.
    471  * @param   pVM     Pointer to the shared VM structure.
     471 * @param   pVM     Pointer to the VM.
    472472 */
    473473static int pdmR3DevLoadModules(PVM pVM)
  • trunk/src/VBox/VMM/VMMR3/PDMNetShaper.cpp

    r40712 r41777  
    8383typedef struct PDMNETSHAPER
    8484{
    85     /** Pointer to the shared VM structure. */
     85    /** Pointer to the VM. */
    8686    PVM                      pVM;
    8787    /** Critical section protecting all members below. */
     
    469469 *
    470470 * @returns VBox status code
    471  * @param   pVM Pointer to the shared VM structure.
     471 * @param   pVM Pointer to the VM.
    472472 */
    473473int pdmR3NetShaperInit(PVM pVM)
     
    517517
    518518                    RTMemFree(pszBwGrpId);
    519                    
     519
    520520                    if (RT_FAILURE(rc))
    521521                        break;
  • trunk/src/VBox/VMM/VMMR3/PDMUsb.cpp

    r40920 r41777  
    918918 * The device must be detached from the HUB at this point.
    919919 *
    920  * @param   pVM             Pointer to the shared VM structure.
     920 * @param   pVM             Pointer to the VM.
    921921 * @param   pUsbIns         The USB device instance to destroy.
    922922 * @thread  EMT
     
    10651065 *
    10661066 * @returns true / false accordingly.
    1067  * @param   pVM     Pointer to the shared VM structure.
     1067 * @param   pVM     Pointer to the VM.
    10681068 */
    10691069VMMR3DECL(bool) PDMR3USBHasHub(PVM pVM)
  • trunk/src/VBox/VMM/VMMR3/PGMDbg.cpp

    r39078 r41777  
    561561 * @retval  VERR_INVALID_ARGUMENT if any other arguments are invalid.
    562562 *
    563  * @param   pVM             Pointer to the shared VM structure.
     563 * @param   pVM             Pointer to the VM.
    564564 * @param   GCPhys          Where to start searching.
    565565 * @param   cbRange         The number of bytes to search.
     
    720720 * @retval  VERR_INVALID_ARGUMENT if any other arguments are invalid.
    721721 *
    722  * @param   pVM             Pointer to the shared VM structure.
     722 * @param   pVM             Pointer to the VM.
    723723 * @param   pVCpu           The CPU context to search in.
    724724 * @param   GCPtr           Where to start searching.
  • trunk/src/VBox/VMM/VMMR3/SSM.cpp

    r39402 r41777  
    950950 *
    951951 * @returns VBox status code.
    952  * @param   pVM             Pointer to the shared VM structure.
     952 * @param   pVM             Pointer to the VM.
    953953 * @param   pSSM            The SSM handle.
    954954 * @param   uPass           The data pass number.
     
    973973 *
    974974 * @returns VBox status code.
    975  * @param   pVM             Pointer to the shared VM structure.
     975 * @param   pVM             Pointer to the VM.
    976976 * @param   pSSM            The SSM handle.
    977977 */
     
    10031003 *
    10041004 * @returns VBox status code.
    1005  * @param   pVM             Pointer to the shared VM structure.
     1005 * @param   pVM             Pointer to the VM.
    10061006 * @param   pSSM            The SSM handle.
    10071007 * @param   uVersion        The version (1).
     
    10671067 *
    10681068 * @returns VBox status code.
    1069  * @param   pVM             Pointer to the shared VM structure.
     1069 * @param   pVM             Pointer to the VM.
    10701070 * @param   pSSM            The SSM handle.
    10711071 * @param   uVersion        The version (1).
  • trunk/src/VBox/VMM/VMMR3/VM.cpp

    r41532 r41777  
    29522952 * structure.
    29532953 *
    2954  * @returns Pointer to the shared VM structure.
     2954 * @returns Pointer to the VM.
    29552955 *          NULL if @a pUVM is invalid (asserted) or if no shared VM structure
    29562956 *          is currently associated with it.
  • trunk/src/VBox/VMM/VMMR3/VMM.cpp

    r40294 r41777  
    283283 *
    284284 * @returns VBox status code.
    285  * @param   pVM     Pointer to the shared VM structure.
     285 * @param   pVM     Pointer to the VM.
    286286 *
    287287 * @remarks The optional guard page gets it protection setup up during R3 init
     
    335335 *
    336336 * @returns VBox status code.
    337  * @param   pVM         Pointer to the shared VM structure.
     337 * @param   pVM         Pointer to the VM.
    338338 */
    339339static int vmmR3InitLoggers(PVM pVM)
     
    18101810 * @returns VBox status code.
    18111811 *
    1812  * @param   pVM             Pointer to the shared VM structure.
     1812 * @param   pVM             Pointer to the VM.
    18131813 * @param   idCpu           The ID of the source CPU context (for the address).
    18141814 * @param   R0Addr          Where to start reading.
  • trunk/src/VBox/VMM/VMMR3/VMMSwitcher.cpp

    r41679 r41777  
    9696 *
    9797 * @returns VBox status code.
    98  * @param   pVM     Pointer to the shared VM structure.
     98 * @param   pVM     Pointer to the VM.
    9999 */
    100100int vmmR3SwitcherInit(PVM pVM)
     
    229229 * Relocate the switchers, called by VMMR#Relocate.
    230230 *
    231  * @param   pVM         Pointer to the shared VM structure.
     231 * @param   pVM         Pointer to the VM.
    232232 * @param   offDelta    The relocation delta.
    233233 */
  • trunk/src/VBox/VMM/VMMR3/VMReq.cpp

    r39402 r41777  
    9494 *          returned.
    9595 *
    96  * @param   pVM             Pointer to the shared VM structure.
     96 * @param   pVM             Pointer to the VM.
    9797 * @param   idDstCpu        The destination CPU(s). Either a specific CPU ID or
    9898 *                          one of the following special values:
     
    127127 * @returns VBox status code returned by VMR3ReqCallVU.
    128128 *
    129  * @param   pVM             Pointer to the shared VM structure.
     129 * @param   pVM             Pointer to the VM.
    130130 * @param   idDstCpu        The destination CPU(s). Either a specific CPU ID or
    131131 *                          one of the following special values:
     
    156156 * @returns VBox status code of VMR3ReqCallVU.
    157157 *
    158  * @param   pVM             Pointer to the shared VM structure.
     158 * @param   pVM             Pointer to the VM.
    159159 * @param   idDstCpu        The destination CPU(s). Either a specific CPU ID or
    160160 *                          one of the following special values:
     
    187187 * @returns VBox status code of VMR3ReqCallVU.
    188188 *
    189  * @param   pVM             Pointer to the shared VM structure.
     189 * @param   pVM             Pointer to the VM.
    190190 * @param   idDstCpu        The destination CPU(s). Either a specific CPU ID or
    191191 *                          one of the following special values:
     
    222222 *          returned.
    223223 *
    224  * @param   pVM             Pointer to the shared VM structure.
     224 * @param   pVM             Pointer to the VM.
    225225 * @param   idDstCpu        The destination CPU(s). Either a specific CPU ID or
    226226 *                          one of the following special values:
     
    256256 * @returns VBox status code of VMR3ReqCallVU.
    257257 *
    258  * @param   pVM             Pointer to the shared VM structure.
     258 * @param   pVM             Pointer to the VM.
    259259 * @param   idDstCpu        The destination CPU(s). Either a specific CPU ID or
    260260 *                          one of the following special values:
Note: See TracChangeset for help on using the changeset viewer.

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