VirtualBox

Changeset 41803 in vbox


Ignore:
Timestamp:
Jun 17, 2012 5:20:33 PM (13 years ago)
Author:
vboxsync
svn:sync-xref-src-repo-rev:
78621
Message:

Doxygen.

Location:
trunk/src/VBox/VMM
Files:
27 edited

Legend:

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

    r41802 r41803  
    21192119 *
    21202120 * @returns true if in real mode, otherwise false.
    2121  * @param   pVCpu       The virtual CPU handle.
     2121 * @param   pVCpu       Pointer to the VMCPU.
    21222122 */
    21232123VMMDECL(bool) CPUMIsGuestNXEnabled(PVMCPU pVCpu)
     
    21312131 *
    21322132 * @returns true if in real mode, otherwise false.
    2133  * @param   pVCpu       The virtual CPU handle.
     2133 * @param   pVCpu       Pointer to the VMCPU.
    21342134 */
    21352135VMMDECL(bool) CPUMIsGuestPageSizeExtEnabled(PVMCPU pVCpu)
     
    21442144 *
    21452145 * @returns true if in real mode, otherwise false.
    2146  * @param   pVCpu       The virtual CPU handle.
     2146 * @param   pVCpu       Pointer to the VMCPU.
    21472147 */
    21482148VMMDECL(bool) CPUMIsGuestPagingEnabled(PVMCPU pVCpu)
     
    21562156 *
    21572157 * @returns true if in real mode, otherwise false.
    2158  * @param   pVCpu       The virtual CPU handle.
     2158 * @param   pVCpu       Pointer to the VMCPU.
    21592159 */
    21602160VMMDECL(bool) CPUMIsGuestR0WriteProtEnabled(PVMCPU pVCpu)
     
    21682168 *
    21692169 * @returns true if in real mode, otherwise false.
    2170  * @param   pVCpu       The virtual CPU handle.
     2170 * @param   pVCpu       Pointer to the VMCPU.
    21712171 */
    21722172VMMDECL(bool) CPUMIsGuestInRealMode(PVMCPU pVCpu)
     
    21802180 *
    21812181 * @returns @c true if it is, @c false if not.
    2182  * @param   pVCpu       The virtual CPU handle.
     2182 * @param   pVCpu       Pointer to the VMCPU.
    21832183 */
    21842184VMMDECL(bool) CPUMIsGuestInRealOrV86Mode(PVMCPU pVCpu)
     
    21932193 *
    21942194 * @returns true if in protected mode, otherwise false.
    2195  * @param   pVCpu       The virtual CPU handle.
     2195 * @param   pVCpu       Pointer to the VMCPU.
    21962196 */
    21972197VMMDECL(bool) CPUMIsGuestInProtectedMode(PVMCPU pVCpu)
     
    22052205 *
    22062206 * @returns true if in paged protected mode, otherwise false.
    2207  * @param   pVCpu       The virtual CPU handle.
     2207 * @param   pVCpu       Pointer to the VMCPU.
    22082208 */
    22092209VMMDECL(bool) CPUMIsGuestInPagedProtectedMode(PVMCPU pVCpu)
     
    22172217 *
    22182218 * @returns true if in long mode, otherwise false.
    2219  * @param   pVCpu       The virtual CPU handle.
     2219 * @param   pVCpu       Pointer to the VMCPU.
    22202220 */
    22212221VMMDECL(bool) CPUMIsGuestInLongMode(PVMCPU pVCpu)
     
    22292229 *
    22302230 * @returns true if in PAE mode, otherwise false.
    2231  * @param   pVCpu       The virtual CPU handle.
     2231 * @param   pVCpu       Pointer to the VMCPU.
    22322232 */
    22332233VMMDECL(bool) CPUMIsGuestInPAEMode(PVMCPU pVCpu)
     
    23352335 *
    23362336 * @returns VBox status code.
    2337  * @param   pVCpu       VMCPU handle
     2337 * @param   pVCpu       Pointer to the VMCPU.
    23382338 */
    23392339VMMDECL(int) CPUMHandleLazyFPU(PVMCPU pVCpu)
  • trunk/src/VBox/VMM/VMMAll/DBGFAll.cpp

    r41783 r41803  
    119119 * @returns stepping (true) or not (false).
    120120 *
    121  * @param   pVCpu       The virtual CPU handle.
     121 * @param   pVCpu       Pointer to the VMCPU.
    122122 */
    123123VMMDECL(bool) DBGFIsStepping(PVMCPU pVCpu)
  • trunk/src/VBox/VMM/VMMAll/IEMAll.cpp

    r41779 r41803  
    28062806 *
    28072807 * @returns true if it is, false if it's in FNSAVE.
    2808  * @param   pVCpu               The virtual CPU handle.
     2808 * @param   pVCpu               Pointer to the VMCPU.
    28092809 */
    28102810DECLINLINE(bool) iemFRegIsFxSaveFormat(PIEMCPU pIemCpu)
  • trunk/src/VBox/VMM/VMMAll/PDMAllCritSect.cpp

    r41802 r41803  
    693693 * @returns false if not owner.
    694694 * @param   pCritSect   The critical section.
    695  * @param   pVCpu       The virtual CPU handle.
     695 * @param   pVCpu       Pointer to the VMCPU.
    696696 */
    697697VMMDECL(bool) PDMCritSectIsOwnerEx(PCPDMCRITSECT pCritSect, PVMCPU pVCpu)
  • trunk/src/VBox/VMM/VMMAll/PGMAllPhys.cpp

    r41802 r41803  
    19911991 *
    19921992 * @returns VBox status code.
    1993  * @param   pVCpu       The VMCPU Handle
     1993 * @param   pVCpu       Pointer to the VMCPU.
    19941994 * @param   GCPtr       The guest pointer to convert.
    19951995 * @param   pGCPhys     Where to store the GC physical address.
     
    20102010 *
    20112011 * @returns VBox status code.
    2012  * @param   pVCpu       The VMCPU Handle
     2012 * @param   pVCpu       Pointer to the VMCPU.
    20132013 * @param   GCPtr       The guest pointer to convert.
    20142014 * @param   pHCPhys     Where to store the HC physical address.
  • trunk/src/VBox/VMM/VMMAll/PGMAllPool.cpp

    r41802 r41803  
    167167 * for mapping conflicts and set the SyncCR3 FF if found.
    168168 *
    169  * @param   pVCpu       VMCPU handle
     169 * @param   pVCpu       Pointer to the VMCPU.
    170170 * @param   pPool       The pool.
    171171 * @param   pPage       The head page.
  • trunk/src/VBox/VMM/VMMAll/REMAll.cpp

    r41800 r41803  
    206206 *
    207207 * @param   pVM         Pointer to the VM.
    208  * @param   pVCpu       The virtual CPU handle of the calling EMT.
     208 * @param   pVCpu       Pointer to the VMCPU of the calling EMT.
    209209 */
    210210VMMDECL(void) REMNotifyHandlerPhysicalFlushIfAlmostFull(PVM pVM, PVMCPU pVCpu)
  • trunk/src/VBox/VMM/VMMAll/SELMAll.cpp

    r41802 r41803  
    140140 *
    141141 * @returns VBox status
    142  * @param   pVCpu       The virtual CPU handle.
     142 * @param   pVCpu       Pointer to the VMCPU.
    143143 * @param   SelReg      Selector register.
    144144 * @param   pCtxCore    CPU context.
     
    448448 *
    449449 * @returns VBox status
    450  * @param   pVCpu       The virtual CPU handle.
     450 * @param   pVCpu       Pointer to the VMCPU.
    451451 * @param   eflags      Current eflags
    452452 * @param   Sel         Selector part.
     
    664664 *
    665665 * @returns VINF_SUCCESS.
    666  * @param   pVCpu   The Virtual CPU handle.
     666 * @param   pVCpu   Pointer to the VMCPU.
    667667 * @param   SelCS   Selector part.
    668668 * @param   pHidCS  The hidden CS register part. Optional.
     
    690690 * @returns VBox status code.
    691691 * @param   pVM     Pointer to the VM.
    692  * @param   pVCpu   The virtual CPU handle.
     692 * @param   pVCpu   Pointer to the VMCPU.
    693693 * @param   SelCPL  Current privilege level. Get this from SS - CS might be conforming!
    694694 *                  A full selector can be passed, we'll only use the RPL part.
     
    833833 *
    834834 * @returns VBox status code.
    835  * @param   pVCpu       The virtual CPU handle.
     835 * @param   pVCpu       Pointer to the VMCPU.
    836836 * @param   eflags      Current eflags
    837837 * @param   SelCPL      Current privilege level. Get this from SS - CS might be
     
    861861 *
    862862 * @returns VBox status code.
    863  * @param   pVCpu       The virtual CPU handle.
     863 * @param   pVCpu        Pointer to the VMCPU.
    864864 * @param   eflags       Current eflags
    865865 * @param   SelCPL       Current privilege level. Get this from SS - CS might be conforming!
     
    894894 * @returns DISCPUMODE according to the selector type (16, 32 or 64 bits)
    895895 * @param   pVM     Pointer to the VM.
    896  * @param   pVCpu   The virtual CPU handle.
     896 * @param   pVCpu   Pointer to the VMCPU.
    897897 * @param   Sel     The selector.
    898898 */
     
    920920 *
    921921 * @returns DISCPUMODE according to the selector type (16, 32 or 64 bits)
    922  * @param   pVCpu      The virtual CPU handle.
     922 * @param   pVCpu      Pointer to the VMCPU.
    923923 * @param   eflags     Current eflags register
    924924 * @param   Sel        The selector.
  • trunk/src/VBox/VMM/VMMR3/CPUM.cpp

    r41802 r41803  
    10611061 * Used by CPUMR3Reset and CPU hot plugging.
    10621062 *
    1063  * @param   pVCpu               The virtual CPU handle.
     1063 * @param   pVCpu               Pointer to the VMCPU.
    10641064 */
    10651065VMMR3DECL(void) CPUMR3ResetCpu(PVMCPU pVCpu)
     
    36053605 *
    36063606 * @returns VBox status code.
    3607  * @param   pVM         Pointer to the VM
    3608  * @param   pVCpu       VMCPU Handle
    3609  * @param   pCtx        CPU context
     3607 * @param   pVM         Pointer to the VM.
     3608 * @param   pVCpu       Pointer to the VMCPU.
     3609 * @param   pCtx        Pointer to the guest CPU context.
    36103610 * @param   GCPtrPC     Program counter (relative to CS) to disassemble from.
    3611  * @param   pCpu        Disassembly state
    3612  * @param   pszPrefix   String prefix for logging (debug only)
     3611 * @param   pCpu        Disassembly state.
     3612 * @param   pszPrefix   String prefix for logging (debug only).
    36133613 *
    36143614 */
     
    40004000 * Leaves REM and works the CPUM_CHANGED_HIDDEN_SEL_REGS_INVALID flag.
    40014001 *
    4002  * @param   pVCpu               The virtual CPU handle.
     4002 * @param   pVCpu               Pointer to the VMCPU.
    40034003 * @param   fNoOutOfSyncSels    This is @c false if there are out of sync
    40044004 *                              registers.
  • trunk/src/VBox/VMM/VMMR3/CPUMDbg.cpp

    r41801 r41803  
    171171 *
    172172 * @returns true if it is, false if it's in FNSAVE.
    173  * @param   pVCpu               The virtual CPU handle.
     173 * @param   pVCpu               Pointer to the VMCPU.
    174174 */
    175175DECLINLINE(bool) cpumR3RegIsFxSaveFormat(PVMCPU pVCpu)
  • trunk/src/VBox/VMM/VMMR3/DBGFAddr.cpp

    r41783 r41803  
    215215 *
    216216 * @returns VBox status code.
    217  * @param   pVCpu           The virtual CPU handle.
     217 * @param   pVCpu           Pointer to the VMCPU.
    218218 * @param   pAddress        The address.
    219219 * @param   pGCPhys         Where to return the physical address.
  • trunk/src/VBox/VMM/VMMR3/DBGFDisas.cpp

    r41802 r41803  
    9090 *
    9191 * @returns VBox status code.
    92  * @param   pVM         Pointer to the VM
    93  * @param   pVCpu       VMCPU handle
     92 * @param   pVM         Pointer to the VM.
     93 * @param   pVCpu       Pointer to the VMCPU.
    9494 * @param   pSelInfo    The selector info.
    9595 * @param   enmMode     The guest paging mode.
     
    323323 * @returns VBox status code.
    324324 * @param       pVM             Pointer to the VM.
    325  * @param       pVCpu           The virtual CPU handle.
     325 * @param       pVCpu           Pointer to the VMCPU.
    326326 * @param       Sel             The code selector. This used to determine the 32/16 bit ness and
    327327 *                              calculation of the actual instruction address.
     
    653653 * @returns VBox status code.
    654654 * @param   pVM             Pointer to the VM.
    655  * @param   pVCpu           The virtual CPU handle, defaults to CPU 0 if NULL.
     655 * @param   pVCpu           Pointer to the VMCPU, defaults to CPU 0 if NULL.
    656656 * @param   Sel             The code selector. This used to determine the 32/16 bit-ness and
    657657 *                          calculation of the actual instruction address.
  • trunk/src/VBox/VMM/VMMR3/DBGFReg.cpp

    r41783 r41803  
    498498 * @returns VBox status code.
    499499 * @param   pVM             Pointer to the VM.
    500  * @param   pVCpu           The virtual CPU handle.
     500 * @param   pVCpu           Pointer to the VMCPU.
    501501 * @param   paRegisters     The register descriptors.
    502502 * @param   fGuestRegs      Set if it's the guest registers, clear if
  • trunk/src/VBox/VMM/VMMR3/PDM.cpp

    r41801 r41803  
    14031403 * Used by PDMR3Reset and CPU hot plugging.
    14041404 *
    1405  * @param   pVCpu               The virtual CPU handle.
     1405 * @param   pVCpu               Pointer to the VMCPU.
    14061406 */
    14071407VMMR3DECL(void) PDMR3ResetCpu(PVMCPU pVCpu)
  • trunk/src/VBox/VMM/VMMR3/PGM.cpp

    r41801 r41803  
    24692469 *
    24702470 * @param   pVM                 Pointer to the VM.
    2471  * @param   pVCpu               The virtual CPU handle.
     2471 * @param   pVCpu               Pointer to the VMCPU.
    24722472 */
    24732473VMMR3DECL(void) PGMR3ResetUnpluggedCpu(PVM pVM, PVMCPU pVCpu)
  • trunk/src/VBox/VMM/VMMR3/PGMSharedPage.cpp

    r41800 r41803  
    197197 * @returns VBox strict status code.
    198198 * @param   pVM                 Pointer to the VM.
    199  * @param   pVCpu               The VMCPU handle for the calling EMT.
     199 * @param   pVCpu               Pointer to the VMCPU of the calling EMT.
    200200 * @param   pvUser              Pointer to a VMCPUID with the requester's ID.
    201201 */
  • trunk/src/VBox/VMM/VMMR3/SELM.cpp

    r41802 r41803  
    23002300 *
    23012301 * @param   pVM         Pointer to the VM.
    2302  * @param   pVCpu       The virtual CPU handle.
     2302 * @param   pVCpu       Pointer to the VMCPU.
    23032303 * @param   Sel         The selector to get info about.
    23042304 * @param   pSelInfo    Where to store the information.
  • trunk/src/VBox/VMM/VMMR3/TM.cpp

    r41801 r41803  
    26102610 * @returns VBox status code, all errors are asserted.
    26112611 * @param   pVM         Pointer to the VM.
    2612  * @param   pVCpu       The virtual CPU handle.
    2613  * @thread  EMT corresponding to the virtual CPU handle.
     2612 * @param   pVCpu       Pointer to the VMCPU.
     2613 * @thread  EMT corresponding to Pointer to the VMCPU.
    26142614 */
    26152615VMMR3DECL(int) TMR3NotifySuspend(PVM pVM, PVMCPU pVCpu)
     
    26532653 * @returns VBox status code, all errors are asserted.
    26542654 * @param   pVM         Pointer to the VM.
    2655  * @param   pVCpu       The virtual CPU handle.
    2656  * @thread  EMT corresponding to the virtual CPU handle.
     2655 * @param   pVCpu       Pointer to the VMCPU.
     2656 * @thread  EMT corresponding to Pointer to the VMCPU.
    26572657 */
    26582658VMMR3DECL(int) TMR3NotifyResume(PVM pVM, PVMCPU pVCpu)
  • trunk/src/VBox/VMM/VMMR3/TRPM.cpp

    r41802 r41803  
    730730 * Used by TRPMR3Reset and CPU hot plugging.
    731731 *
    732  * @param   pVCpu               The virtual CPU handle.
     732 * @param   pVCpu               Pointer to the VMCPU.
    733733 */
    734734VMMR3DECL(void) TRPMR3ResetCpu(PVMCPU pVCpu)
  • trunk/src/VBox/VMM/VMMR3/VM.cpp

    r41802 r41803  
    12111211 *
    12121212 * @param   pVM             Pointer to the VM.
    1213  * @param   pVCpu           The VMCPU handle of the EMT.
     1213 * @param   pVCpu           Pointer to the VMCPU of the EMT.
    12141214 * @param   pvUser          Ignored.
    12151215 */
     
    13001300 *
    13011301 * @param   pVM             Pointer to the VM.
    1302  * @param   pVCpu           The VMCPU handle of the EMT.
     1302 * @param   pVCpu           Pointer to the VMCPU of the EMT.
    13031303 * @param   pvUser          Ignored.
    13041304 */
     
    13821382 *
    13831383 * @param   pVM             Pointer to the VM.
    1384  * @param   pVCpu           The VMCPU handle of the EMT.
     1384 * @param   pVCpu           Pointer to the VMCPU of the EMT.
    13851385 * @param   pvUser          Ignored.
    13861386 */
     
    14641464 *
    14651465 * @param   pVM             Pointer to the VM.
    1466  * @param   pVCpu           The VMCPU handle of the EMT.
     1466 * @param   pVCpu           Pointer to the VMCPU of the EMT.
    14671467 * @param   pvUser          The pfSuspended argument of vmR3SaveTeleport.
    14681468 */
     
    15641564 *
    15651565 * @param   pVM             Pointer to the VM.
    1566  * @param   pVCpu           The VMCPU handle of the EMT.
     1566 * @param   pVCpu           Pointer to the VMCPU of the EMT.
    15671567 * @param   pvUser          The pfSuspended argument of vmR3SaveTeleport.
    15681568 */
     
    21562156 *
    21572157 * @param   pVM             Pointer to the VM.
    2158  * @param   pVCpu           The VMCPU handle of the EMT.
     2158 * @param   pVCpu           Pointer to the VMCPU of the EMT.
    21592159 * @param   pvUser          Ignored.
    21602160 */
     
    27862786 *
    27872787 * @param   pVM             Pointer to the VM.
    2788  * @param   pVCpu           The VMCPU handle of the EMT.
     2788 * @param   pVCpu           Pointer to the VMCPU of the EMT.
    27892789 * @param   pvUser          Ignored.
    27902790 */
     
    40894089 *
    40904090 * @param   pVM             Pointer to the VM.
    4091  * @param   pVCpu           The VMCPU handle of the EMT.
     4091 * @param   pVCpu           Pointer to the VMCPU of the EMT.
    40924092 * @param   pvUser          Ignored.
    40934093 */
  • trunk/src/VBox/VMM/VMMR3/VMEmt.cpp

    r41802 r41803  
    11901190 * @returns VBox strict status code.
    11911191 * @param   pVM                 Pointer to the VM.
    1192  * @param   pVCpu               The VMCPU handle for the calling EMT.
     1192 * @param   pVCpu               Pointer to the VMCPU of the calling EMT.
    11931193 * @param   pvUser              The new g_aHaltMethods index.
    11941194 */
  • trunk/src/VBox/VMM/VMMR3/VMM.cpp

    r41802 r41803  
    20432043 * @returns VBox status code.
    20442044 * @param   pVM     Pointer to the VM.
    2045  * @param   pVCpu   VMCPU handle
     2045 * @param   pVCpu   Pointer to the VMCPU.
    20462046 * @remark  Careful with critsects.
    20472047 */
  • trunk/src/VBox/VMM/VMMRC/SELMRC.cpp

    r41800 r41803  
    259259 * Read wrapper used by selmRCGuestTSSWriteHandler.
    260260 * @returns VBox status code (appropriate for trap handling and GC return).
    261  * @param   pVM         The VM handle
     261 * @param   pVM         Pointer to the VM.
    262262 * @param   pvDst       Where to put the bits we read.
    263263 * @param   pvSrc       Guest address to read from.
  • trunk/src/VBox/VMM/VMMRC/TRPMRCHandlers.cpp

    r41800 r41803  
    128128 *          happened.
    129129 * @param   pVM         Pointer to the VM.
    130  * @param   pVCpu       The virtual CPU handle.
     130 * @param   pVCpu       Pointer to the VMCPU.
    131131 * @param   rc          The VBox status code to return.
    132132 * @param   pRegFrame   Pointer to the register frame for the trap.
     
    720720 *
    721721 * @param   pVM         Pointer to the VM.
    722  * @param   pVCpu       The virtual CPU handle.
     722 * @param   pVCpu       Pointer to the VMCPU.
    723723 * @param   pRegFrame   Pointer to the register frame for the trap.
    724724 * @param   pCpu        The opcode info.
     
    820820 *
    821821 * @param   pVM         Pointer to the VM.
    822  * @param   pVCpu       The virtual CPU handle.
     822 * @param   pVCpu       Pointer to the VMCPU.
    823823 * @param   pRegFrame   Pointer to the register frame for the trap.
    824824 * @param   pCpu        The opcode info.
     
    913913 *
    914914 * @param   pVM         Pointer to the VM.
    915  * @param   pVCpu       The virtual CPU handle.
     915 * @param   pVCpu       Pointer to the VMCPU.
    916916 * @param   pRegFrame   Pointer to the register frame for the trap.
    917917 *                      This will be updated on successful return.
  • trunk/src/VBox/VMM/VMMRZ/DBGFRZ.cpp

    r41783 r41803  
    3939 *
    4040 * @param   pVM         Pointer to the VM.
    41  * @param   pVCpu       The virtual CPU handle.
     41 * @param   pVCpu       Pointer to the VMCPU.
    4242 * @param   pRegFrame   Pointer to the register frame for the trap.
    4343 * @param   uDr6        The DR6 register value.
     
    107107 *
    108108 * @param   pVM         Pointer to the VM.
    109  * @param   pVCpu       The virtual CPU handle.
     109 * @param   pVCpu       Pointer to the VMCPU.
    110110 * @param   pRegFrame   Pointer to the register frame for the trap.
    111111 */
  • trunk/src/VBox/VMM/VMMRZ/VMMRZ.cpp

    r41783 r41803  
    3939 *
    4040 * @param   pVM             Pointer to the VM.
    41  * @param   pVCpu           The virtual CPU handle of the calling EMT.
     41 * @param   pVCpu           Pointer to the VMCPU of the calling EMT.
    4242 * @param   enmOperation    The operation.
    4343 * @param   uArg            The argument to the operation.
  • trunk/src/VBox/VMM/include/EMHandleRCTmpl.h

    r41783 r41803  
    2828 * @returns VBox status code to return to the EM main loop.
    2929 *
    30  * @param   pVM     The VM handle
    31  * @param   pVCpu   The VMCPU handle
     30 * @param   pVM     Pointer to the VM.
     31 * @param   pVCpu   Pointer to the VMCPU.
    3232 * @param   rc      The return code.
    3333 * @param   pCtx    The guest cpu context.
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