VirtualBox

Changeset 41801 in vbox for trunk/src/VBox/VMM/VMMAll


Ignore:
Timestamp:
Jun 17, 2012 4:46:51 PM (13 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
78619
Message:

Doxygen.

Location:
trunk/src/VBox/VMM/VMMAll
Files:
11 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/VBox/VMM/VMMAll/CSAMAll.cpp

    r35348 r41801  
    4848 *
    4949 * @returns VBox status code
    50  * @param   pVM         The VM to operate on.
     50 * @param   pVM         Pointer to the VM.
    5151 * @param   pvFault     Fault address
    5252 */
     
    7575 *
    7676 * @returns true -> scanned, false -> not scanned
    77  * @param   pVM         The VM to operate on.
     77 * @param   pVM         Pointer to the VM.
    7878 * @param   pPage       GC page address
    7979 */
     
    101101 *
    102102 * @returns VBox status code.
    103  * @param   pVM         The VM to operate on.
     103 * @param   pVM         Pointer to the VM.
    104104 * @param   pPage       GC page address (not necessarily aligned)
    105105 * @param   fScanned    Mark as scanned or not scanned
     
    172172 *          CSAM want need to scan it.
    173173 * @returns false if the page was already scanned.
    174  * @param   pVM         The VM to operate on.
     174 * @param   pVM         Pointer to the VM.
    175175 * @param   GCPtr       GC pointer of page
    176176 */
     
    195195 *
    196196 * @returns VBox status code.
    197  * @param   pVM         The VM to operate on.
     197 * @param   pVM         Pointer to the VM.
    198198 * @param   GCPtr       GC pointer of page
    199199 */
     
    213213 *
    214214 * @returns VBox status code.
    215  * @param   pVM         The VM to operate on.
     215 * @param   pVM         Pointer to the VM.
    216216 */
    217217VMMDECL(int) CSAMEnableScanning(PVM pVM)
     
    225225 *
    226226 * @returns VBox status code.
    227  * @param   pVM         The VM to operate on.
     227 * @param   pVM         Pointer to the VM.
    228228 */
    229229VMMDECL(int) CSAMDisableScanning(PVM pVM)
     
    242242 *
    243243 * @returns boolean
    244  * @param   pVM         The VM to operate on.
     244 * @param   pVM         Pointer to the VM.
    245245 * @param   GCPtr       GC pointer of page table entry
    246246 */
  • trunk/src/VBox/VMM/VMMAll/EMAll.cpp

    r41800 r41801  
    8181 *
    8282 * @returns Current status.
    83  * @param   pVCpu         The VMCPU to operate on.
     83 * @param   pVCpu         Pointer to the VMCPU.
    8484 */
    8585VMMDECL(EMSTATE) EMGetState(PVMCPU pVCpu)
     
    9191 * Sets the current execution manager status. (use only when you know what you're doing!)
    9292 *
    93  * @param   pVCpu         The VMCPU to operate on.
     93 * @param   pVCpu         Pointer to the VMCPU.
    9494 */
    9595VMMDECL(void)    EMSetState(PVMCPU pVCpu, EMSTATE enmNewState)
     
    183183 *
    184184 * @returns boolean
    185  * @param   pVCpu           The VMCPU to operate on.
     185 * @param   pVCpu           Pointer to the VMCPU.
    186186 * @param   pCtx            Current CPU context.
    187187 */
     
    239239 *
    240240 * @returns bool owner/not owner
    241  * @param   pVM         The VM to operate on.
     241 * @param   pVM         Pointer to the VM.
    242242 */
    243243VMMDECL(bool) EMRemIsLockOwner(PVM pVM)
     
    258258 *
    259259 * @returns VBox status code
    260  * @param   pVM         The VM to operate on.
     260 * @param   pVM         Pointer to the VM.
    261261 */
    262262VMMDECL(int) EMRemTryLock(PVM pVM)
  • trunk/src/VBox/VMM/VMMAll/FTMAll.cpp

    r35346 r41801  
    3636 * @returns VBox status code.
    3737 *
    38  * @param   pVM         The VM to operate on.
     38 * @param   pVM         Pointer to the VM.
    3939 * @param   enmType     Checkpoint type
    4040 */
     
    5757 * @returns true/false
    5858 *
    59  * @param   pVM         The VM to operate on.
     59 * @param   pVM         Pointer to the VM.
    6060 */
    6161VMMDECL(bool)  FTMIsDeltaLoadSaveActive(PVM pVM)
  • trunk/src/VBox/VMM/VMMAll/HWACCMAll.cpp

    r41181 r41801  
    3939 *
    4040 * @returns VBox status code.
    41  * @param   pVCpu       The VMCPU to operate on.
     41 * @param   pVCpu       Pointer to the VMCPU.
    4242 * @param   GCVirt      Page to invalidate
    4343 */
     
    6363 *
    6464 * @returns VBox status code.
    65  * @param   pVCpu       The VMCPU to operate on.
     65 * @param   pVCpu       Pointer to the VMCPU.
    6666 * @param   GCVirt      Page to invalidate
    6767 */
     
    8787 *
    8888 * @returns VBox status code.
    89  * @param   pVCpu       The VMCPU to operate on.
     89 * @param   pVCpu       Pointer to the VMCPU.
    9090 */
    9191VMMDECL(int) HWACCMFlushTLB(PVMCPU pVCpu)
     
    189189 *
    190190 * @returns VBox status code.
    191  * @param   pVM         The VM to operate on.
     191 * @param   pVM         Pointer to the VM.
    192192 * @param   GCVirt      Page to invalidate
    193193 */
     
    223223 *
    224224 * @returns VBox status code.
    225  * @param   pVM       The VM to operate on.
     225 * @param   pVM       Pointer to the VM.
    226226 */
    227227VMMDECL(int) HWACCMFlushTLBOnAllVCpus(PVM pVM)
     
    257257 *
    258258 * @returns boolean
    259  * @param   pVM         The VM to operate on.
     259 * @param   pVM         Pointer to the VM.
    260260 */
    261261VMMDECL(bool) HWACCMIsNestedPagingActive(PVM pVM)
     
    268268 *
    269269 * @returns shadow paging mode
    270  * @param   pVM         The VM to operate on.
     270 * @param   pVM         Pointer to the VM.
    271271 */
    272272VMMDECL(PGMMODE) HWACCMGetShwPagingMode(PVM pVM)
     
    286286 *
    287287 * @returns VBox status code.
    288  * @param   pVM         The VM to operate on.
     288 * @param   pVM         Pointer to the VM.
    289289 * @param   GCPhys      Page to invalidate
    290290 */
     
    329329 *
    330330 * @returns Interrupt event pending state.
    331  * @param   pVM         The VM to operate on.
     331 * @param   pVM         Pointer to the VM.
    332332 */
    333333VMMDECL(bool) HWACCMHasPendingIrq(PVM pVM)
  • trunk/src/VBox/VMM/VMMAll/IOMAll.cpp

    r41800 r41801  
    4444 *
    4545 * @returns bool owner/not owner
    46  * @param   pVM         The VM to operate on.
     46 * @param   pVM         Pointer to the VM.
    4747 */
    4848VMMDECL(bool) IOMIsLockOwner(PVM pVM)
  • trunk/src/VBox/VMM/VMMAll/MMAll.cpp

    r41783 r41801  
    315315 *
    316316 * @returns ring-3 host context address.
    317  * @param   pVM         The VM to operate on.
     317 * @param   pVM         Pointer to the VM.
    318318 * @param   R0Ptr       The ring-0 host context address.
    319319 *                      You'll be damned if this is not in the HMA! :-)
     
    334334 *
    335335 * @returns raw-mode context address.
    336  * @param   pVM         The VM to operate on.
     336 * @param   pVM         Pointer to the VM.
    337337 * @param   R0Ptr       The ring-0 host context address.
    338338 *                      You'll be damned if this is not in the HMA! :-)
     
    354354 *
    355355 * @returns current context address.
    356  * @param   pVM         The VM to operate on.
     356 * @param   pVM         Pointer to the VM.
    357357 * @param   R0Ptr       The ring-0 host context address.
    358358 *                      You'll be damned if this is not in the HMA! :-)
     
    374374 *
    375375 * @returns ring-0 host context address.
    376  * @param   pVM         The VM to operate on.
     376 * @param   pVM         Pointer to the VM.
    377377 * @param   R3Ptr       The ring-3 host context address.
    378378 *                      You'll be damned if this is not in the HMA! :-)
     
    394394 *
    395395 * @returns guest context address.
    396  * @param   pVM         The VM to operate on.
     396 * @param   pVM         Pointer to the VM.
    397397 * @param   R3Ptr       The ring-3 host context address.
    398398 *                      You'll be damned if this is not in the HMA! :-)
     
    415415 *
    416416 * @returns current context address.
    417  * @param   pVM         The VM to operate on.
     417 * @param   pVM         Pointer to the VM.
    418418 * @param   R3Ptr       The ring-3 host context address.
    419419 *                      You'll be damned if this is not in the HMA! :-)
     
    435435 *
    436436 * @returns ring-3 host context address.
    437  * @param   pVM         The VM to operate on.
     437 * @param   pVM         Pointer to the VM.
    438438 * @param   GCPtr       The raw-mode context address.
    439439 *                      You'll be damned if this is not in the HMA! :-)
     
    454454 *
    455455 * @returns ring-0 host context address.
    456  * @param   pVM         The VM to operate on.
     456 * @param   pVM         Pointer to the VM.
    457457 * @param   RCPtr       The raw-mode context address.
    458458 *                      You'll be damned if this is not in the HMA! :-)
     
    473473 *
    474474 * @returns current context address.
    475  * @param   pVM         The VM to operate on.
     475 * @param   pVM         Pointer to the VM.
    476476 * @param   RCPtr       The raw-mode host context address.
    477477 *                      You'll be damned if this is not in the HMA! :-)
     
    493493 *
    494494 * @returns ring-3 host context address.
    495  * @param   pVM         The VM to operate on.
     495 * @param   pVM         Pointer to the VM.
    496496 * @param   pv          The current context address.
    497497 *                      You'll be damned if this is not in the HMA! :-)
     
    513513 *
    514514 * @returns ring-0 host context address.
    515  * @param   pVM         The VM to operate on.
     515 * @param   pVM         Pointer to the VM.
    516516 * @param   pv          The current context address.
    517517 *                      You'll be damned if this is not in the HMA! :-)
     
    534534 *
    535535 * @returns guest context address.
    536  * @param   pVM         The VM to operate on.
     536 * @param   pVM         Pointer to the VM.
    537537 * @param   pv          The current context address.
    538538 *                      You'll be damned if this is not in the HMA! :-)
  • trunk/src/VBox/VMM/VMMAll/MMAllHyper.cpp

    r41800 r41801  
    198198 *
    199199 * @returns VBox status code.
    200  * @param   pVM         The VM to operate on.
     200 * @param   pVM         Pointer to the VM.
    201201 * @param   cb          Number of bytes to allocate.
    202202 * @param   uAlignment  Required memory alignment in bytes.
     
    757757 *
    758758 * @returns VBox status code.
    759  * @param   pVM         The VM to operate on.
     759 * @param   pVM         Pointer to the VM.
    760760 * @param   pv          The memory to free.
    761761 * @remark  Try avoid free hyper memory.
  • trunk/src/VBox/VMM/VMMAll/PATMAll.cpp

    r41800 r41801  
    250250 *
    251251 * @returns VBox status code.
    252  * @param   pVM         The VM to operate on.
     252 * @param   pVM         Pointer to the VM.
    253253 */
    254254VMMDECL(RCPTRTYPE(PPATMGCSTATE)) PATMQueryGCState(PVM pVM)
     
    261261 *
    262262 * @returns VBox status code.
    263  * @param   pVM         The VM to operate on.
     263 * @param   pVM         Pointer to the VM.
    264264 * @param   pAddrGC     Guest context address
    265265 */
     
    323323 *
    324324 * @returns patch record
    325  * @param   pVM         The VM to operate on.
     325 * @param   pVM         Pointer to the VM.
    326326 * @param   pInstrGC    Guest context point to the instruction
    327327 *
     
    447447 *
    448448 * @returns VBox status
    449  * @param   pVM                 The VM to operate on.
     449 * @param   pVM                 Pointer to the VM.
    450450 * @param   pJumpTableGC        Pointer to branch instruction lookup cache
    451451 * @param   pBranchTarget       Original branch target
  • trunk/src/VBox/VMM/VMMAll/TMAll.cpp

    r41800 r41801  
    9494 * clocks that only ticks when we're executing guest code.
    9595 *
    96  * @param   pVCpu       The VMCPU to operate on.
     96 * @param   pVCpu       Pointer to the VMCPU.
    9797 */
    9898VMMDECL(void) TMNotifyStartOfExecution(PVMCPU pVCpu)
     
    116116 * clocks that only ticks when we're executing guest code.
    117117 *
    118  * @param   pVCpu       The VMCPU to operate on.
     118 * @param   pVCpu       Pointer to the VMCPU.
    119119 */
    120120VMMDECL(void) TMNotifyEndOfExecution(PVMCPU pVCpu)
     
    164164 * clocks that only ticks when we're halted.
    165165 *
    166  * @param   pVCpu       The VMCPU to operate on.
     166 * @param   pVCpu       Pointer to the VMCPU.
    167167 */
    168168VMM_INT_DECL(void) TMNotifyStartOfHalt(PVMCPU pVCpu)
     
    188188 * clocks that only ticks when we're halted.
    189189 *
    190  * @param   pVCpu       The VMCPU to operate on.
     190 * @param   pVCpu       Pointer to the VMCPU.
    191191 */
    192192VMM_INT_DECL(void) TMNotifyEndOfHalt(PVMCPU pVCpu)
  • trunk/src/VBox/VMM/VMMAll/TMAllCpu.cpp

    r41783 r41801  
    5454 *
    5555 * @returns VBox status code.
    56  * @param   pVM         The VM to operate on.
    57  * @param   pVCpu       The VMCPU to operate on.
     56 * @param   pVM         Pointer to the VM.
     57 * @param   pVCpu       Pointer to the VMCPU.
    5858 * @internal
    5959 */
     
    8484 *
    8585 * @returns VBox status code.
    86  * @param   pVCpu       The VMCPU to operate on.
     86 * @param   pVCpu       Pointer to the VMCPU.
    8787 * @internal
    8888 */
     
    140140 *
    141141 * @returns true/false accordingly.
    142  * @param   pVCpu       The VMCPU to operate on.
     142 * @param   pVCpu       Pointer to the VMCPU.
    143143 * @param   poffRealTSC     The offset against the TSC of the current CPU.
    144144 *                          Can be NULL.
     
    301301 *
    302302 * @returns Gets the CPU tsc.
    303  * @param   pVCpu       The VMCPU to operate on.
     303 * @param   pVCpu       Pointer to the VMCPU.
    304304 */
    305305DECLINLINE(uint64_t) tmCpuTickGetInternal(PVMCPU pVCpu, bool fCheckTimers)
     
    339339 *
    340340 * @returns Gets the CPU tsc.
    341  * @param   pVCpu       The VMCPU to operate on.
     341 * @param   pVCpu       Pointer to the VMCPU.
    342342 */
    343343VMMDECL(uint64_t) TMCpuTickGet(PVMCPU pVCpu)
     
    351351 *
    352352 * @returns Gets the CPU tsc.
    353  * @param   pVCpu       The VMCPU to operate on.
     353 * @param   pVCpu       Pointer to the VMCPU.
    354354 */
    355355VMM_INT_DECL(uint64_t) TMCpuTickGetNoCheck(PVMCPU pVCpu)
  • trunk/src/VBox/VMM/VMMAll/TRPMAll.cpp

    r41800 r41801  
    349349 *  or does not return at all (when the trap is actually forwarded)
    350350 *
    351  * @param   pVM         The VM to operate on.
     351 * @param   pVM         Pointer to the VM.
    352352 * @param   pRegFrame   Pointer to the register frame for the trap.
    353353 * @param   iGate       Trap or interrupt gate number
     
    829829 *
    830830 * @returns VBox status code.
    831  * @param   pVM         The VM to operate on.
     831 * @param   pVM         Pointer to the VM.
    832832 * @param   iTrap       Interrupt/trap number.
    833833 */
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