Changeset 44509 in vbox for trunk/include/VBox

Timestamp:

Feb 1, 2013 1:11:17 PM (12 years ago)

Author:

vboxsync

Message:

Document PIC and APIC callback method locking rules.

File:

• trunk/include/VBox/vmm/pdmdev.h (modified) (10 diffs)

trunk/include/VBox/vmm/pdmdev.h

@@ -820 +820 @@
      * @param   iLevel          IRQ level. See the PDM_IRQ_LEVEL_* \#defines.
      * @param   uTagSrc         The IRQ tag and source (for tracing).
+     * @remarks Caller enters the PDM critical section.
      */
     DECLR3CALLBACKMEMBER(void, pfnSetIrqR3,(PPDMDEVINS pDevIns, int iIrq, int iLevel, uint32_t uTagSrc));
@@ -829 +830 @@
      * @param   pDevIns         Device instance of the PIC.
      * @param   puTagSrc        Where to return the IRQ tag and source.
+     * @remarks Caller enters the PDM critical section.
      */
     DECLR3CALLBACKMEMBER(int, pfnGetInterruptR3,(PPDMDEVINS pDevIns, uint32_t *puTagSrc));
@@ -1041 +1043 @@
      * @param   idCpu           The VCPU Id.
      * @param   puTagSrc        Where to return the tag source.
+     * @remarks Caller enters the PDM critical section
      */
     DECLR3CALLBACKMEMBER(int, pfnGetInterruptR3,(PPDMDEVINS pDevIns, VMCPUID idCpu, uint32_t *puTagSrc));
@@ -1050 +1053 @@
      * @param   pDevIns         Device instance of the APIC.
      * @param   idCpu           The VCPU Id.
+     * @remarks Unlike the other callbacks, the PDM lock may not always be entered
+     *          prior to calling this method.
      */
     DECLR3CALLBACKMEMBER(bool, pfnHasPendingIrqR3,(PPDMDEVINS pDevIns, VMCPUID idCpu));
@@ -1059 +1064 @@
      * @param   idCpu           The VCPU Id.
      * @param   u64Base         The new base.
+     * @remarks Caller enters the PDM critical section.
      */
     DECLR3CALLBACKMEMBER(void, pfnSetBaseR3,(PPDMDEVINS pDevIns, VMCPUID idCpu, uint64_t u64Base));
@@ -1068 +1074 @@
      * @param   pDevIns         Device instance of the APIC.
      * @param   idCpu           The VCPU Id.
+     * @remarks Caller enters the PDM critical section.
      */
     DECLR3CALLBACKMEMBER(uint64_t, pfnGetBaseR3,(PPDMDEVINS pDevIns, VMCPUID idCpu));
@@ -1077 +1084 @@
      * @param   idCpu           The VCPU id.
      * @param   u8TPR           The new TPR.
+     * @remarks Caller enters the PDM critical section.
      */
     DECLR3CALLBACKMEMBER(void, pfnSetTPRR3,(PPDMDEVINS pDevIns, VMCPUID idCpu, uint8_t u8TPR));
@@ -1086 +1094 @@
      * @param   pDevIns         Device instance of the APIC.
      * @param   idCpu           VCPU id
+     * @remarks Caller enters the PDM critical section.
      */
     DECLR3CALLBACKMEMBER(uint8_t, pfnGetTPRR3,(PPDMDEVINS pDevIns, VMCPUID idCpu));
@@ -1135 +1144 @@
      * @param   u8TriggerMode   See APIC implementation.
      * @param   uTagSrc         The IRQ tag and source (for tracing).
+     * @remarks Caller enters the PDM critical section
      */
     DECLR3CALLBACKMEMBER(int,  pfnBusDeliverR3,(PPDMDEVINS pDevIns, uint8_t u8Dest, uint8_t u8DestMode, uint8_t u8DeliveryMode,
@@ -1150 +1160 @@
      * @param   u8Level         The level.
      * @param   uTagSrc         The IRQ tag and source (for tracing).
+     * @remarks Caller enters the PDM critical section
      */
     DECLR3CALLBACKMEMBER(int,  pfnLocalInterruptR3,(PPDMDEVINS pDevIns, uint8_t u8Pin, uint8_t u8Level));