VirtualBox

Changeset 41386 in vbox


Ignore:
Timestamp:
May 22, 2012 9:04:47 AM (12 years ago)
Author:
vboxsync
Message:

VMM/PGM: minor doxygen consistency.

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

Legend:

Unmodified
Added
Removed

  • trunk/src/VBox/VMM/VMMAll/PGMAll.cpp

    r40450 r41386  
    523523 * @returns NULL if not
    524524 *
    525  * @param   pVM         The virtual machine.
     525 * @param   pVM         The VM handle.
    526526 * @param   GCPtr       The guest context pointer.
    527527 */
    … …  
    800800 *
    801801 * @returns VBox status code (appropriate for trap handling and GC return).
    802  * @param   pVM         VM handle.
     802 * @param   pVM         The VM handle.
    803803 * @param   pVCpu       VMCPU handle.
    804804 * @param   pRegFrame   Register frame.
    … …  
    23182318 *
    23192319 * @returns bool locked/not locked
    2320  * @param   pVM         The VM to operate on.
     2320 * @param   pVM         The VM handle.
    23212321 */
    23222322VMMDECL(bool) PGMHasDirtyPages(PVM pVM)
    … …  
    23302330 *
    23312331 * @returns bool owner/not owner
    2332  * @param   pVM         The VM to operate on.
     2332 * @param   pVM         The VM handle.
    23332333 */
    23342334VMMDECL(bool) PGMIsLockOwner(PVM pVM)
    … …  
    23422342 *
    23432343 * @returns VBox status code.
    2344  * @param   pVM             The VM to operate on.
     2344 * @param   pVM             The VM handle.
    23452345 * @param   fUseLargePages  Use/not use large pages
    23462346 */
    … …  
    23582358 *
    23592359 * @returns VBox status code
    2360  * @param   pVM         The VM to operate on.
     2360 * @param   pVM         The VM handle.
    23612361 */
    23622362int pgmLock(PVM pVM)
    … …  
    23762376 *
    23772377 * @returns VBox status code
    2378  * @param   pVM         The VM to operate on.
     2378 * @param   pVM         The VM handle.
    23792379 */
    23802380void pgmUnlock(PVM pVM)
    … …  
    25922592 *
    25932593 * @returns Number of conflicts.
    2594  * @param   pVM     The VM Handle.
     2594 * @param   pVM     The VM handle.
    25952595 */
    25962596VMMDECL(unsigned) PGMAssertNoMappingConflicts(PVM pVM)
    … …  
    26362636 *
    26372637 * @returns Number of conflicts.
    2638  * @param   pVM     The VM Handle.
    2639  * @param   pVCpu   VMCPU handle.
     2638 * @param   pVM     The VM handle.
     2639 * @param   pVCpu   The VMCPU handle.
    26402640 * @param   cr3     The current guest CR3 register value.
    26412641 * @param   cr4     The current guest CR4 register value.

  • trunk/src/VBox/VMM/VMMAll/PGMAllPhys.cpp

    r40280 r41386  
    5757 *
    5858 * @returns VBox status code (appropriate for trap handling and GC return).
    59  * @param   pVM         VM Handle.
     59 * @param   pVM         The VM handle.
    6060 * @param   uErrorCode  CPU Error code.
    6161 * @param   pRegFrame   Trap register frame.
    … …  
    7676 *
    7777 * @returns VBox status code (appropriate for trap handling and GC return).
    78  * @param   pVM         VM Handle.
     78 * @param   pVM         The VM handle.
    7979 * @param   uErrorCode  CPU Error code.
    8080 * @param   pRegFrame   Trap register frame.
    … …  
    547547 * @todo    Propagate VERR_EM_NO_MEMORY up the call tree.
    548548 *
    549  * @param   pVM         The VM address.
     549 * @param   pVM         The VM handle.
    550550 * @param   pPage       The physical page tracking structure. This will
    551551 *                      be modified on success.
    … …  
    703703 * @todo    Propagate VERR_EM_NO_MEMORY up the call tree.
    704704 *
    705  * @param   pVM         The VM address.
     705 * @param   pVM         The VM handle.
    706706 * @param   GCPhys      The address of the page.
    707707 *
    … …  
    792792 * @retval  VERR_PGM_INVALID_LARGE_PAGE_RANGE if it can't be reused
    793793 *
    794  * @param   pVM         The VM address.
     794 * @param   pVM         The VM handle.
    795795 * @param   GCPhys      The address of the page.
    796796 * @param   pLargePage  Page structure of the base page
    … …  
    853853 * @returns VBox strict status code.
    854854 *
    855  * @param   pVM         The VM address.
     855 * @param   pVM         The VM handle.
    856856 * @param   pPage       The physical page tracking structure.
    857857 *
    … …  
    877877 * @retval  VERR_PGM_PHYS_PAGE_RESERVED it it's a valid page but has no physical backing.
    878878 *
    879  * @param   pVM         The VM address.
     879 * @param   pVM         The VM handle.
    880880 * @param   pPage       The physical page tracking structure.
    881881 * @param   GCPhys      The address of the page.
    … …  
    10001000 * @retval  VERR_PGM_PHYS_PAGE_RESERVED it it's a valid page but has no physical backing.
    10011001 *
    1002  * @param   pVM         The VM address.
     1002 * @param   pVM         The VM handle.
    10031003 * @param   pPage       The physical page tracking structure.
    10041004 * @param   GCPhys      The address of the page.
    … …  
    11261126 * @retval  VERR_PGM_PHYS_PAGE_RESERVED it it's a valid page but has no physical backing.
    11271127 *
    1128  * @param   pVM         The VM address.
     1128 * @param   pVM         The VM handle.
    11291129 * @param   pPage       The physical page tracking structure.
    11301130 * @param   GCPhys      The address of the page.
    … …  
    11611161 * @retval  VERR_PGM_PHYS_PAGE_RESERVED it it's a valid page but has no physical backing.
    11621162 *
    1163  * @param   pVM         The VM address.
     1163 * @param   pVM         The VM handle.
    11641164 * @param   pPage       The physical page tracking structure. Must be in the
    11651165 *                      allocated state.
    … …  
    11901190 * @retval  VERR_PGM_PHYS_PAGE_RESERVED it it's a valid page but has no physical backing.
    11911191 *
    1192  * @param   pVM         The VM address.
     1192 * @param   pVM         The VM handle.
    11931193 * @param   pPage       The physical page tracking structure.
    11941194 * @param   GCPhys      The address of the page.
    … …  
    20322032 * Cache PGMPhys memory access
    20332033 *
    2034  * @param   pVM             VM Handle.
     2034 * @param   pVM             The VM handle.
    20352035 * @param   pCache          Cache structure pointer
    20362036 * @param   GCPhys          GC physical address
    … …  
    21972197 * @retval  VERR_PGM_PHYS_WR_HIT_HANDLER in R0 and GC, NEVER in R3.
    21982198 *
    2199  * @param   pVM             VM Handle.
     2199 * @param   pVM             The VM handle.
    22002200 * @param   GCPhys          Physical address start reading from.
    22012201 * @param   pvBuf           Where to put the read bits.
    … …  
    27312731 * @retval  VERR_PGM_PHYS_WR_HIT_HANDLER in R0 and GC, NEVER in R3.
    27322732 *
    2733  * @param   pVM             VM Handle.
     2733 * @param   pVM             The VM handle.
    27342734 * @param   GCPhys          Physical address to write to.
    27352735 * @param   pvBuf           What to write.
    … …  
    28442844 *
    28452845 * @returns VBox status.
    2846  * @param   pVM         VM handle.
     2846 * @param   pVM         The VM handle.
    28472847 * @param   pvDst       The destination address.
    28482848 * @param   GCPhysSrc   The source address (GC physical address).
    … …  
    29162916 *
    29172917 * @returns VBox status.
    2918  * @param   pVM         VM handle.
     2918 * @param   pVM         The VM handle.
    29192919 * @param   GCPhysDst   The GC physical address of the destination.
    29202920 * @param   pvSrc       The source buffer.
    … …  
    39873987 *
    39883988 * @returns The page type.
    3989  * @param   pVM             VM Handle.
     3989 * @param   pVM             The VM handle.
    39903990 * @param   GCPhys          Guest physical address
    39913991 */

  • trunk/src/VBox/VMM/VMMAll/PGMAllPool.cpp

    r40451 r41386  
    140140 *
    141141 * @returns VBox status code suitable for scheduling.
    142  * @param   pVM         VM Handle.
     142 * @param   pVM         The VM handle.
    143143 * @param   pvDst       Destination address
    144144 * @param   pvSrc       Source guest virtual address.
    … …  
    735735 * @returns true if we consider the page as being reused for a different purpose.
    736736 * @returns false if we consider it to still be a paging page.
    737  * @param   pVM         VM Handle.
     737 * @param   pVM         The VM handle.
    738738 * @param   pVCpu       VMCPU Handle.
    739739 * @param   pRegFrame   Trap register frame.
    … …  
    10281028 *
    10291029 * @returns VBox status code (appropriate for GC return).
    1030  * @param   pVM         VM Handle.
     1030 * @param   pVM         The VM handle.
    10311031 * @param   uErrorCode  CPU Error code.
    10321032 * @param   pRegFrame   Trap register frame.
    … …  
    16061606 * Flush a dirty page
    16071607 *
    1608  * @param   pVM             VM Handle.
     1608 * @param   pVM             The VM handle.
    16091609 * @param   pPool           The pool.
    16101610 * @param   idxSlot         Dirty array slot index
    … …  
    17041704 * Add a new dirty page
    17051705 *
    1706  * @param   pVM         VM Handle.
     1706 * @param   pVM         The VM handle.
    17071707 * @param   pPool       The pool.
    17081708 * @param   pPage       The page.
    … …  
    17801780 *
    17811781 * @return dirty or not
    1782  * @param   pVM             VM Handle.
     1782 * @param   pVM             The VM handle.
    17831783 * @param   GCPhys          Guest physical address
    17841784 */
    … …  
    18101810 * Reset all dirty pages by reinstating page monitoring.
    18111811 *
    1812  * @param   pVM             VM Handle.
     1812 * @param   pVM             The VM handle.
    18131813 */
    18141814void pgmPoolResetDirtyPages(PVM pVM)
    … …  
    18481848 * Invalidate the PT entry for the specified page
    18491849 *
    1850  * @param   pVM             VM Handle.
     1850 * @param   pVM             The VM handle.
    18511851 * @param   GCPtrPage       Guest page to invalidate
    18521852 */
    … …  
    18691869 * Reset all dirty pages by reinstating page monitoring.
    18701870 *
    1871  * @param   pVM             VM Handle.
     1871 * @param   pVM             The VM handle.
    18721872 * @param   GCPhysPT        Physical address of the page table
    18731873 */

  • trunk/src/VBox/VMM/VMMR3/PGMMap.cpp

    r39402 r41386  
    4747 *
    4848 * @returns VBox status code.
    49  * @param   pVM             VM Handle.
     49 * @param   pVM             The VM handle.
    5050 * @param   GCPtr           Virtual Address. (Page table aligned!)
    5151 * @param   cb              Size of the range. Must be a 4MB aligned!
    … …  
    215215 *
    216216 * @returns VBox status code.
    217  * @param   pVM     VM Handle.
     217 * @param   pVM     The VM handle.
    218218 * @param   GCPtr   Virtual Address. (Page table aligned!)
    219219 *
    … …  
    289289 *
    290290 * @returns true/false.
    291  * @param   pVM         Pointer to the shared VM structure.
     291 * @param   pVM         The VM handle.
    292292 * @param   iPD         The first PDE in the range.
    293293 * @param   cPTs        The number of PDEs in the range.
    … …  
    313313 * The mapping *must* be in the list.
    314314 *
    315  * @param   pVM             Pointer to the shared VM structure.
     315 * @param   pVM             The VM handle.
    316316 * @param   pMapping        The mapping to unlink.
    317317 */
    … …  
    345345 * Links the mapping.
    346346 *
    347  * @param   pVM             Pointer to the shared VM structure.
     347 * @param   pVM             The VM handle.
    348348 * @param   pMapping        The mapping to linked.
    349349 */
    … …  
    392392 *
    393393 * @returns VBox status code.
    394  * @param   pVM     Pointer to the shared VM structure.
     394 * @param   pVM     The VM handle.
    395395 * @thread  EMT(0)
    396396 */
    … …  
    478478 *
    479479 * @returns VBox status code.
    480  * @param   pVM     The VM.
     480 * @param   pVM     The VM handle.
    481481 * @param   pcb     Where to store the size.
    482482 */
    … …  
    498498 *
    499499 * @returns VBox status code.
    500  * @param   pVM         The VM.
     500 * @param   pVM         The VM handle.
    501501 * @param   GCPtrBase   The address of the reserved range of guest memory.
    502502 * @param   cb          The size of the range starting at GCPtrBase.
    … …  
    538538 *
    539539 * @returns VBox status code.
    540  * @param   pVM         The VM.
     540 * @param   pVM         The VM handle.
    541541 * @param   GCPtrBase   The address of the reserved range of guest memory.
    542542 * @param   cb          The size of the range starting at GCPtrBase.
    … …  
    680680 *
    681681 * @returns VBox status code.
    682  * @param   pVM         The VM.
     682 * @param   pVM         The VM handle.
    683683 */
    684684VMMR3DECL(int) PGMR3MappingsDisable(PVM pVM)
    … …  
    721721 *
    722722 * @returns VBox status code.
    723  * @param   pVM         The VM.
     723 * @param   pVM         The VM handle.
    724724 */
    725725VMMR3DECL(int) PGMR3MappingsUnfix(PVM pVM)
    … …  
    766766 *
    767767 * @returns VBox status code.
    768  * @param   pVM         The virtual machine.
     768 * @param   pVM         The VM handle.
    769769 * @param   Addr        Intermediate context address of the mapping.
    770770 * @param   HCPhys      Start of the range of physical pages. This must be entriely below 4GB!
    … …  
    831831 *
    832832 * @returns VBox status code.
    833  * @param   pVM         VM handle.
    834  * @param   uAddress    Address of the mapping.
    835  * @param   cPages      Number of pages.
     833 * @param   pVM             The VM handle.
     834 * @param   uAddress        Address of the mapping.
     835 * @param   cPages          Number of pages.
    836836 * @param   pPTDefault      Pointer to the default page table for this mapping.
    837837 * @param   pPTPaeDefault   Pointer to the default page table for this mapping.
    … …  
    839839static int pgmR3MapIntermediateCheckOne(PVM pVM, uintptr_t uAddress, unsigned cPages, PX86PT pPTDefault, PX86PTPAE pPTPaeDefault)
    840840{
    841     AssertMsg((uAddress >> X86_PD_SHIFT) + cPages <= 1024, ("64-bit fixme\n"));
     841    AssertMsg((uAddress >> X86_PD_SHIFT) + cPages <= 1024, ("64-bit fixme uAddress=%RGv cPages=%u\n", uAddress, cPages));
    842842
    843843    /*
    … …  
    913913 * Sets up the intermediate page tables for a verified mapping.
    914914 *
    915  * @param   pVM             VM handle.
     915 * @param   pVM             The VM handle.
    916916 * @param   uAddress        Address of the mapping.
    917917 * @param   HCPhys          The physical address of the page range.
    … …  
    10641064 * Relocates a mapping to a new address.
    10651065 *
    1066  * @param   pVM                 VM handle.
     1066 * @param   pVM                 The VM handle.
    10671067 * @param   pMapping            The mapping to relocate.
    10681068 * @param   GCPtrOldMapping     The address of the start of the old mapping.
    … …  
    11861186 *
    11871187 * @returns VBox status code.
    1188  * @param   pVM                 VM Handle.
     1188 * @param   pVM                 The VM handle.
    11891189 * @param   pMapping            The mapping which conflicts.
    11901190 * @param   pPDSrc              The page directory of the guest OS.
    … …  
    12631263 *
    12641264 * @returns VBox status code.
    1265  * @param   pVM                 VM Handle.
     1265 * @param   pVM                 The VM handle.
    12661266 * @param   pMapping            The mapping which conflicts.
    12671267 * @param   GCPtrOldMapping     The address of the start of the current mapping.
    … …  
    13551355 *
    13561356 * @returns VBox status.
    1357  * @param   pVM         VM handle.
     1357 * @param   pVM         The VM handle.
    13581358 * @param   pvDst       The destination address (HC of course).
    13591359 * @param   GCPtrSrc    The source address (GC virtual address).

  • trunk/src/VBox/VMM/VMMR3/PGMPhys.cpp

    r40274 r41386  
    102102 * @retval  VINF_SUCCESS.
    103103 *
    104  * @param   pVM             VM Handle.
     104 * @param   pVM             The VM handle.
    105105 * @param   GCPhys          Physical address to read from.
    106106 * @param   pvBuf           Where to read into.
    … …  
    231231 * @retval  VERR_EM_NO_MEMORY.
    232232 *
    233  * @param   pVM             VM Handle.
     233 * @param   pVM             The VM handle.
    234234 * @param   GCPhys          Physical address to write to.
    235235 * @param   pvBuf           What to write.
    … …  
    735735 * Called when anything was relocated.
    736736 *
    737  * @param   pVM         Pointer to the shared VM structure.
     737 * @param   pVM         The VM handle.
    738738 */
    739739void pgmR3PhysRelinkRamRanges(PVM pVM)
    … …  
    785785 * Links a new RAM range into the list.
    786786 *
    787  * @param   pVM         Pointer to the shared VM structure.
     787 * @param   pVM         The VM handle.
    788788 * @param   pNew        Pointer to the new list entry.
    789789 * @param   pPrev       Pointer to the previous list entry. If NULL, insert as head.
    … …  
    824824 * Unlink an existing RAM range from the list.
    825825 *
    826  * @param   pVM         Pointer to the shared VM structure.
     826 * @param   pVM         The VM handle.
    827827 * @param   pRam        Pointer to the new list entry.
    828828 * @param   pPrev       Pointer to the previous list entry. If NULL, insert as head.
    … …  
    860860 * Unlink an existing RAM range from the list.
    861861 *
    862  * @param   pVM         Pointer to the shared VM structure.
     862 * @param   pVM         The VM handle.
    863863 * @param   pRam        Pointer to the new list entry.
    864864 */
    … …  
    16181618 *
    16191619 * @returns VBox status code.
    1620  * @param   pVM             Pointer to the shared VM structure.
     1620 * @param   pVM             The VM handle.
    16211621 * @param   GCPhys          The physical address of the RAM.
    16221622 * @param   cb              The size of the RAM.
    … …  
    17551755 * @returns VBox status code.
    17561756 *
    1757  * @param   pVM     Pointer to the shared VM structure.
     1757 * @param   pVM     The VM handle.
    17581758 */
    17591759int pgmR3PhysRamPreAllocate(PVM pVM)
    … …  
    18221822 *
    18231823 * @returns VBox status code.
    1824  * @param   pVM     Pointer to the shared VM structure.
     1824 * @param   pVM     The VM handle.
    18251825 */
    18261826int pgmR3PhysRamReset(PVM pVM)
    … …  
    19841984 *
    19851985 * @returns VBox status code.
    1986  * @param   pVM     Pointer to the shared VM structure.
     1986 * @param   pVM     The VM handle.
    19871987 */
    19881988int pgmR3PhysRamTerm(PVM pVM)
    … …  
    20652065 * @returns VBox status code.
    20662066 *
    2067  * @param   pVM             Pointer to the shared VM structure.
     2067 * @param   pVM             The VM handle.
    20682068 * @param   GCPhys          The start of the MMIO region.
    20692069 * @param   cb              The size of the MMIO region.
    … …  
    22312231 *
    22322232 * @returns VBox status code.
    2233  * @param   pVM             Pointer to the shared VM structure.
     2233 * @param   pVM             The VM handle.
    22342234 * @param   GCPhys          The start of the MMIO region.
    22352235 * @param   cb              The size of the MMIO region.
    … …  
    23462346 *
    23472347 * @returns Pointer to the MMIO2 range.
    2348  * @param   pVM             Pointer to the shared VM structure.
     2348 * @param   pVM             The VM handle.
    23492349 * @param   pDevIns         The device instance owning the region.
    23502350 * @param   iRegion         The region.
    … …  
    23812381 * @retval  VERR_ALREADY_EXISTS if the region already exists.
    23822382 *
    2383  * @param   pVM             Pointer to the shared VM structure.
     2383 * @param   pVM             The VM handle.
    23842384 * @param   pDevIns         The device instance owning the region.
    23852385 * @param   iRegion         The region number.  If the MMIO2 memory is a PCI
    … …  
    25092509 *
    25102510 * @returns VBox status code.
    2511  * @param   pVM             Pointer to the shared VM structure.
     2511 * @param   pVM             The VM handle.
    25122512 * @param   pDevIns         The device instance owning the region.
    25132513 * @param   iRegion         The region. If it's UINT32_MAX it'll be a wildcard match.
    … …  
    26142614 * @returns VBox status code.
    26152615 *
    2616  * @param   pVM             Pointer to the shared VM structure.
    2617  * @param   pDevIns         The
     2616 * @param   pVM             The VM handle.
     2617 * @param   pDevIns         The device instance owning the region.
    26182618 */
    26192619VMMR3DECL(int) PGMR3PhysMMIO2Map(PVM pVM, PPDMDEVINS pDevIns, uint32_t iRegion, RTGCPHYS GCPhys)
    … …  
    28702870 *
    28712871 * @returns true/false accordingly.
    2872  * @param   pVM             Pointer to the shared VM structure.
     2872 * @param   pVM             The VM handle.
    28732873 * @param   pDevIns         The owner of the memory, optional.
    28742874 * @param   GCPhys          The address to check.
    … …  
    29082908 *
    29092909 * @returns VBox status code.
    2910  * @param   pVM             Pointer to the shared VM structure.
     2910 * @param   pVM             The VM handle.
    29112911 * @param   pDevIns         The owner of the memory, optional.
    29122912 * @param   iRegion         The region.
    … …  
    29432943 * @return VBox status code.
    29442944 *
    2945  * @param   pVM         Pointer to the shared VM structure.
     2945 * @param   pVM         The VM handle.
    29462946 * @param   pDevIns     The device owning the MMIO2 memory.
    29472947 * @param   iRegion     The region.
    … …  
    29852985 *
    29862986 * @returns VBox status.
    2987  * @param   pVM                 VM Handle.
     2987 * @param   pVM                 The VM handle.
    29882988 * @param   pDevIns             The device instance owning the ROM.
    29892989 * @param   GCPhys              First physical address in the range.
    … …  
    33483348 *
    33493349 * @returns VBox status.
    3350  * @param   pVM                 VM Handle.
     3350 * @param   pVM                 The VM handle.
    33513351 * @param   pDevIns             The device instance owning the ROM.
    33523352 * @param   GCPhys              First physical address in the range.
    … …  
    33823382 * @returns VINF_SUCCESS if the handler have carried out the operation.
    33833383 * @returns VINF_PGM_HANDLER_DO_DEFAULT if the caller should carry out the access operation.
    3384  * @param   pVM             VM Handle.
     3384 * @param   pVM             The VM handle.
    33853385 * @param   GCPhys          The physical address the guest is writing to.
    33863386 * @param   pvPhys          The HC mapping of that address.
    … …  
    36173617 * @retval  VINF_PGM_SYNC_CR3
    36183618 *
    3619  * @param   pVM         Pointer to the shared VM structure.
     3619 * @param   pVM         The VM handle.
    36203620 * @param   GCPhys      Where to start. Page aligned.
    36213621 * @param   cb          How much to change. Page aligned.
    … …  
    39433943 *
    39443944 * @returns VBox status code.
    3945  * @param   pVM         The VM to operate on.
     3945 * @param   pVM         The VM handle.
    39463946 */
    39473947void pgmR3PhysUnmapChunk(PVM pVM)
    … …  
    44084408 * This is used by ballooning, remapping MMIO2, RAM reset and state loading.
    44094409 *
    4410  * @param   pVM             Pointer to the shared VM structure.
     4410 * @param   pVM             The VM handle.
    44114411 * @param   pReq            Pointer to the request.
    44124412 * @param   pcPendingPages  Where the number of pages waiting to be freed are
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