Changeset 57270 in vbox for trunk/src/VBox/VMM/VMMR0

Timestamp:

Aug 11, 2015 9:55:44 AM (9 years ago)

Author:

vboxsync

Message:

VMM/HM: comment typos, doxygen cleanup.

File:

• trunk/src/VBox/VMM/VMMR0/HMR0A.asm (modified) (10 diffs)

trunk/src/VBox/VMM/VMMR0/HMR0A.asm

@@ -376 +376 @@
 ; * Executes VMWRITE, 64-bit value.
 ; *
-; * @returns VBox status code
-; * @param   idxField   x86: [ebp + 08h]  msc: rcx  gcc: rdi   VMCS index
-; * @param   u64Data    x86: [ebp + 0ch]  msc: rdx  gcc: rsi   VM field value
+; * @returns VBox status code.
+; * @param   idxField   x86: [ebp + 08h]  msc: rcx  gcc: rdi   VMCS index.
+; * @param   u64Data    x86: [ebp + 0ch]  msc: rdx  gcc: rsi   VM field value.
 ; */
 ALIGNCODE(16)
@@ -440 +440 @@
 
 ;/**
-; * Executes VMREAD, 64-bit value
+; * Executes VMREAD, 64-bit value.
 ; *
-; * @returns VBox status code
-; * @param   idxField        VMCS index
-; * @param   pData           Ptr to store VM field value
+; * @returns VBox status code.
+; * @param   idxField        VMCS index.
+; * @param   pData           Where to store VM field value.
 ; */
 ;DECLASM(int) VMXReadVmcs64(uint32_t idxField, uint64_t *pData);
@@ -509 +509 @@
 ; * Executes VMREAD, 32-bit value.
 ; *
-; * @returns VBox status code
-; * @param   idxField        VMCS index
-; * @param   pu32Data        Ptr to store VM field value
+; * @returns VBox status code.
+; * @param   idxField        VMCS index.
+; * @param   pu32Data        Where to store VM field value.
 ; */
 ;DECLASM(int) VMXReadVmcs32(uint32_t idxField, uint32_t *pu32Data);
@@ -574 +574 @@
 ; * Executes VMWRITE, 32-bit value.
 ; *
-; * @returns VBox status code
-; * @param   idxField        VMCS index
-; * @param   u32Data         Ptr to store VM field value
+; * @returns VBox status code.
+; * @param   idxField        VMCS index.
+; * @param   u32Data         Where to store VM field value.
 ; */
 ;DECLASM(int) VMXWriteVmcs32(uint32_t idxField, uint32_t u32Data);
@@ -636 +636 @@
 
 ;/**
-; * Executes VMXON
+; * Executes VMXON.
 ; *
-; * @returns VBox status code
-; * @param   HCPhysVMXOn      Physical address of VMXON structure
+; * @returns VBox status code.
+; * @param   HCPhysVMXOn      Physical address of VMXON structure.
 ; */
 ;DECLASM(int) VMXEnable(RTHCPHYS HCPhysVMXOn);
@@ -697 +697 @@
 
 ;/**
-; * Executes VMXOFF
+; * Executes VMXOFF.
 ; */
 ;DECLASM(void) VMXDisable(void);
@@ -726 +726 @@
 
 ;/**
-; * Executes VMCLEAR
+; * Executes VMCLEAR.
 ; *
-; * @returns VBox status code
-; * @param   HCPhysVmcs     Physical address of VM control structure
+; * @returns VBox status code.
+; * @param   HCPhysVmcs     Physical address of VM control structure.
 ; */
 ;DECLASM(int) VMXClearVmcs(RTHCPHYS HCPhysVmcs);
@@ -780 +780 @@
 
 ;/**
-; * Executes VMPTRLD
+; * Executes VMPTRLD.
 ; *
-; * @returns VBox status code
-; * @param   HCPhysVmcs     Physical address of VMCS structure
+; * @returns VBox status code.
+; * @param   HCPhysVmcs     Physical address of VMCS structure.
 ; */
 ;DECLASM(int) VMXActivateVmcs(RTHCPHYS HCPhysVmcs);
@@ -834 +834 @@
 
 ;/**
-; * Executes VMPTRST
+; * Executes VMPTRST.
 ; *
-; * @returns VBox status code
-; * @param    [esp + 04h]  gcc:rdi  msc:rcx   Param 1 - First parameter - Address that will receive the current pointer
+; * @returns VBox status code.
+; * @param    [esp + 04h]  gcc:rdi  msc:rcx   Param 1 - First parameter - Address that will receive the current pointer.
 ; */
 ;DECLASM(int) VMXGetActivatedVmcs(RTHCPHYS *pVMCS);
@@ -882 +882 @@
 
 ;/**
-; * Invalidate a page using invept
-; @param   enmFlush     msc:ecx  gcc:edi  x86:[esp+04]  Type of flush
-; @param   pDescriptor  msc:edx  gcc:esi  x86:[esp+08]  Descriptor pointer
+; * Invalidate a page using INVEPT.
+; @param   enmFlush     msc:ecx  gcc:edi  x86:[esp+04]  Type of flush.
+; @param   pDescriptor  msc:edx  gcc:esi  x86:[esp+08]  Descriptor pointer.
 ; */
 ;DECLASM(int) VMXR0InvEPT(VMX_FLUSH enmFlush, uint64_t *pDescriptor);