Changeset 60309 in vbox for trunk/src

Timestamp:

Apr 4, 2016 4:02:21 PM (9 years ago)

Author:

vboxsync

Message:

VMM: Doxygen fixes for r106369.

Location:

trunk/src/VBox/VMM

Files:

• VMMAll/APICAll.cpp (modified) (10 diffs)
• VMMAll/PDMAll.cpp (modified) (2 diffs)
• VMMR3/APIC.cpp (modified) (2 diffs)
• include/PDMInternal.h (modified) (1 diff)

trunk/src/VBox/VMM/VMMAll/APICAll.cpp

@@ -216 +216 @@
 
 /**
- * Gets the current APIC mode.
- *
- * @returns The mode.
- * @param   pApicCpu        The APIC CPU state.
+ * Gets the APIC mode given the base MSR value.
+ *
+ * @returns The APIC mode.
+ * @param   uApicBaseMsr        The APIC Base MSR value.
  */
 static APICMODE apicGetMode(uint64_t uApicBaseMsr)
@@ -337 +337 @@
  *
  * @param   pVCpu           The cross context virtual CPU structure.
+ * @param   uError          The error.
  * @thread  Any.
  */
@@ -350 +351 @@
  *
  * @returns The value of the internal ESR before clearing.
- * @param   pApicCpu        The APIC CPU state.
+ * @param   pVCpu           The cross context virtual CPU structure.
  */
 DECLINLINE(uint32_t) apicClearAllErrors(PVMCPU pVCpu)
@@ -848 +849 @@
  * @returns Strict VBox status code.
  * @param   pVCpu           The cross context virtual CPU structure.
- * @param   uIcrHi          The ICR value.
+ * @param   u64Icr          The ICR (High and Low combined).
  * @param   rcRZ            The return code if the operation cannot be performed
  *                          in the current context.
  */
-static VBOXSTRICTRC apicSetIcr(PVMCPU pVCpu, uint64_t uIcr, int rcRZ)
+static VBOXSTRICTRC apicSetIcr(PVMCPU pVCpu, uint64_t u64Icr, int rcRZ)
 {
     VMCPU_ASSERT_EMT(pVCpu);
@@ -858 +859 @@
 
     /* Validate. */
-    uint32_t const uLo = RT_LO_U32(uIcr);
+    uint32_t const uLo = RT_LO_U32(u64Icr);
     if (RT_LIKELY(!(uLo & ~XAPIC_ICR_LO_WR)))
     {
         /* Update high dword first, then update the low dword which sends the IPI. */
         PX2APICPAGE pX2ApicPage = VMCPU_TO_X2APICPAGE(pVCpu);
-        pX2ApicPage->icr_hi.u32IcrHi = RT_HI_U32(uIcr);
+        pX2ApicPage->icr_hi.u32IcrHi = RT_HI_U32(u64Icr);
         return apicSetIcrLo(pVCpu, uLo,  rcRZ);
     }
@@ -1031 +1032 @@
  * @returns Strict VBox status code.
  * @param   pVCpu           The cross context virtual CPU structure.
- * @param   uLdr            The DFR value.
+ * @param   uDfr            The DFR value.
  *
  * @remarks DFR is not available in x2APIC mode.
@@ -1266 +1267 @@
  *
  * @param   pApicCpu        The APIC CPU state.
+ * @param   uInitialCount   The new initial count.
+ * @param   uTimerShift     The new timer shift.
  * @thread  Any.
  */
@@ -1751 +1754 @@
  * @interface_method_impl{PDMAPICREG,pfnSetBaseMsrR3}
  */
-VMMDECL(VBOXSTRICTRC) APICSetBaseMsr(PPDMDEVINS pDevIns, PVMCPU pVCpu, uint64_t uBase)
+VMMDECL(VBOXSTRICTRC) APICSetBaseMsr(PPDMDEVINS pDevIns, PVMCPU pVCpu, uint64_t u64BaseMsr)
 {
     Assert(pVCpu);
@@ -1757 +1760 @@
     PAPIC    pApic      = VM_TO_APIC(pVCpu->CTX_SUFF(pVM));
     APICMODE enmOldMode = apicGetMode(pApicCpu->uApicBaseMsr);
-    APICMODE enmNewMode = apicGetMode(uBase);
+    APICMODE enmNewMode = apicGetMode(u64BaseMsr);
     uint64_t uBaseMsr   = pApicCpu->uApicBaseMsr;
 
@@ -1915 +1918 @@
 {
     NOREF(uPolarity);
+    NOREF(uTagSrc);
     PVM pVM = PDMDevHlpGetVM(pDevIns);
 

trunk/src/VBox/VMM/VMMAll/PDMAll.cpp

@@ -375 +375 @@
  * @returns Strict VBox status code.
  * @param   pVCpu           The cross context virtual CPU structure.
- * @param   iCpu            Target CPU.
  * @param   u32Reg          MSR to write.
  * @param   u64Value        Value to write.
@@ -396 +395 @@
  * @returns Strict VBox status code.
  * @param   pVCpu           The cross context virtual CPU structure.
- * @param   iCpu            Target CPU.
  * @param   u32Reg          MSR to read.
- * @param   pu64Value       Value read.
+ * @param   pu64Value       Where to store the value read.
  */
 VMM_INT_DECL(VBOXSTRICTRC) PDMApicReadMsr(PVMCPU pVCpu, uint32_t u32Reg, uint64_t *pu64Value)

trunk/src/VBox/VMM/VMMR3/APIC.cpp

@@ -268 +268 @@
  * Gets the timer mode name.
  *
- * @returns The timer mdoe name.
- * @param   enmDestShorthand     The destination shorthand.
+ * @returns The timer mode name.
+ * @param   enmTimerMode         The timer mode.
  */
 static const char *apicGetTimerModeName(XAPICTIMERMODE enmTimerMode)
@@ -794 +794 @@
  *
  * @returns The legacy APIC mode.
- * @param   enmApicMode       The APIC mode to convert.
+ * @param   enmMode       The APIC mode to convert.
  */
 static PDMAPICMODE apicR3ConvertToLegacyApicMode(APICMODE enmMode)

trunk/src/VBox/VMM/include/PDMInternal.h

@@ -581 +581 @@
     DECLR3CALLBACKMEMBER(VBOXSTRICTRC, pfnReadMsrR3, (PPDMDEVINS pDevIns, PVMCPU pVCpu, uint32_t u32Reg, uint64_t *pu64Value));
     /** @copydoc PDMAPICREG::pfnBusDeliverR3 */
-    DECLR3CALLBACKMEMBER(int,       pfnBusDeliverR3,(PPDMDEVINS pDevIns, uint8_t u8Dest, uint8_t u8DestMode, uint8_t u8DeliveryMode,
-                                                     uint8_t iVector, uint8_t u8Polarity, uint8_t u8TriggerMode, uint32_t uTagSrc));
+    DECLR3CALLBACKMEMBER(int,       pfnBusDeliverR3,(PPDMDEVINS pDevIns, uint8_t uDest, uint8_t uDestMode, uint8_t uDeliveryMode,
+                                                     uint8_t uVector, uint8_t uPolarity, uint8_t uTriggerMode, uint32_t uTagSrc));
     /** @copydoc PDMAPICREG::pfnLocalInterruptR3 */
     DECLR3CALLBACKMEMBER(VBOXSTRICTRC, pfnLocalInterruptR3,(PPDMDEVINS pDevIns, PVMCPU pVCpu, uint8_t u8Pin, uint8_t u8Level,