]> git.saurik.com Git - apple/xnu.git/blobdiff - iokit/Kernel/IOServicePMPrivate.h
projects / apple / xnu.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
xnu-2050.24.15.tar.gz
[apple/xnu.git] / iokit / Kernel / IOServicePMPrivate.h
diff --git a/iokit/Kernel/IOServicePMPrivate.h b/iokit/Kernel/IOServicePMPrivate.h
index 227715d5fba6c1a0e9ee3d89ddb0048b7b6adf7c..47f99ea4501b83e98ccf953d65165afda5e40858 100644 (file)
--- a/iokit/Kernel/IOServicePMPrivate.h
+++ b/iokit/Kernel/IOServicePMPrivate.h
@@ -29,17 +29,164 @@
 #ifndef _IOKIT_IOSERVICEPMPRIVATE_H
 #define _IOKIT_IOSERVICEPMPRIVATE_H
 
 #ifndef _IOKIT_IOSERVICEPMPRIVATE_H
 #define _IOKIT_IOSERVICEPMPRIVATE_H
 
-/*! @class IOServicePM
-    @abstract Power management class.
-*/
+#include <IOKit/IOCommand.h>
+#include <IOKit/IOEventSource.h>
+
+//******************************************************************************
+// PM command types
+//******************************************************************************
+
+enum {
+    /* Command Types */
+    kIOPMRequestTypeInvalid                     = 0x00,
+    kIOPMRequestTypePMStop                      = 0x01,
+    kIOPMRequestTypeAddPowerChild1              = 0x02,
+    kIOPMRequestTypeAddPowerChild2              = 0x03,
+    kIOPMRequestTypeAddPowerChild3              = 0x04,
+    kIOPMRequestTypeRegisterPowerDriver         = 0x05,
+    kIOPMRequestTypeAdjustPowerState            = 0x06,
+    kIOPMRequestTypePowerDomainWillChange       = 0x07,
+    kIOPMRequestTypePowerDomainDidChange        = 0x08,
+    kIOPMRequestTypePowerOverrideOnPriv         = 0x09,
+    kIOPMRequestTypePowerOverrideOffPriv        = 0x0A,
+    kIOPMRequestTypeActivityTickle              = 0x0B,
+    kIOPMRequestTypeRequestPowerState           = 0x0C,
+    kIOPMRequestTypeSynchronizePowerTree        = 0x0D,
+    kIOPMRequestTypeRequestPowerStateOverride   = 0x0E,
+    kIOPMRequestTypeSetIdleTimerPeriod          = 0x0F,
+    kIOPMRequestTypeIgnoreIdleTimer             = 0x10,
+    
+    /* Reply Types */
+    kIOPMRequestTypeReplyStart                  = 0x80,
+    kIOPMRequestTypeAckPowerChange              = 0x81,
+    kIOPMRequestTypeAckSetPowerState            = 0x82,
+    kIOPMRequestTypeAllowPowerChange            = 0x83,
+    kIOPMRequestTypeCancelPowerChange           = 0x84,
+    kIOPMRequestTypeInterestChanged             = 0x85,
+    kIOPMRequestTypeIdleCancel                  = 0x86,
+    kIOPMRequestTypeChildNotifyDelayCancel      = 0x87
+};
+
+//******************************************************************************
+// PM actions - For root domain only
+//******************************************************************************
+
+struct IOPMActions;
+
+typedef void
+(*IOPMActionPowerChangeStart)(
+    void *          target,
+    IOService *     service,
+    IOPMActions *   actions, 
+    uint32_t        powerState,
+    uint32_t *      changeFlags );
+
+typedef void
+(*IOPMActionPowerChangeDone)(
+    void *          target,
+    IOService *     service,
+    IOPMActions *   actions, 
+    uint32_t        powerState,
+    uint32_t        changeFlags );
+
+typedef void
+(*IOPMActionPowerChangeOverride)(
+    void *          target,
+    IOService *     service,
+    IOPMActions *   actions, 
+    unsigned long * powerState,
+    uint32_t *      changeFlags );
+
+typedef void
+(*IOPMActionActivityTickle)(
+    void *          target,
+    IOService *     service,
+    IOPMActions *   actions );
+
+struct IOPMActions {
+    void *                          target;
+    uint32_t                        parameter;
+    IOPMActionPowerChangeStart      actionPowerChangeStart;
+    IOPMActionPowerChangeDone       actionPowerChangeDone;
+    IOPMActionPowerChangeOverride   actionPowerChangeOverride;
+    IOPMActionActivityTickle        actionActivityTickle;
+};
+
+//******************************************************************************
+
+enum {
+       kIOPMEventClassSystemEvent                      = 0x00,
+       kIOPMEventClassDriverEvent                      = 0x1
+};
+
+class PMEventDetails : public OSObject 
+{
+    OSDeclareDefaultStructors( PMEventDetails );
+    friend class IOServicePM;
+    friend class IOPMrootDomain;
+    friend class IOPMTimeline;
+public:  
+  static PMEventDetails *eventDetails(uint32_t   type,
+                                      const char *ownerName,
+                                      uintptr_t  ownerUnique,
+                                      const char *interestName,
+                                      uint8_t    oldState,
+                                      uint8_t    newState,
+                                      uint32_t   result,
+                                      uint32_t   elapsedTimeUS);
+
+  static PMEventDetails *eventDetails(uint32_t   type,
+                                      const char *uuid,
+                                      uint32_t   reason,
+                                      uint32_t   result);
+private:
+  uint8_t                eventClassifier;
+  uint32_t        eventType;
+  const char      *ownerName;
+  uintptr_t       ownerUnique;
+  const char      *interestName;
+  uint8_t         oldState;
+  uint8_t         newState;
+  uint32_t        result;
+  uint32_t        elapsedTimeUS;
+  
+  const char      *uuid;
+  uint32_t        reason;
+};
+
+// Internal concise representation of IOPMPowerState
+struct IOPMPSEntry
+{
+    IOPMPowerFlags     capabilityFlags;
+    IOPMPowerFlags     outputPowerFlags;
+    IOPMPowerFlags     inputPowerFlags;
+    uint32_t        staticPower;
+    uint32_t        settleUpTime;
+    uint32_t        settleDownTime;
+};
+
+//******************************************************************************
+// IOServicePM
+//******************************************************************************
+
 class IOServicePM : public OSObject
 {
     friend class IOService;
 class IOServicePM : public OSObject
 {
     friend class IOService;
+    friend class IOPMWorkQueue;
 
     OSDeclareDefaultStructors( IOServicePM )
 
 private:
 
     OSDeclareDefaultStructors( IOServicePM )
 
 private:
-    // List of interested drivers.
+    // Link IOServicePM objects on IOPMWorkQueue.
+    queue_chain_t           WorkChain;
+    
+    // Queue of IOPMRequest objects.
+    queue_head_t            RequestHead;
+
+    // IOService creator and owner.
+    IOService *             Owner;
+
+    // List of interested drivers (protected by PMLock).
     IOPMinformeeList *      InterestedDrivers;
 
     // How long to wait for controlling driver to acknowledge.
     IOPMinformeeList *      InterestedDrivers;
 
     // How long to wait for controlling driver to acknowledge.
@@ -50,52 +197,52 @@ private:
 
     thread_call_t           AckTimer;
     thread_call_t           SettleTimer;
 
     thread_call_t           AckTimer;
     thread_call_t           SettleTimer;
+    thread_call_t           IdleTimer;
 
     // Settle time after changing power state.
 
     // Settle time after changing power state.
-    unsigned long           SettleTimeUS;
+    uint32_t                SettleTimeUS;
 
     // The flags describing current change note.
 
     // The flags describing current change note.
-    unsigned long           HeadNoteFlags;
+    IOPMPowerChangeFlags    HeadNoteChangeFlags;
 
     // The new power state number being changed to.
 
     // The new power state number being changed to.
-    unsigned long           HeadNotePowerState;
+    IOPMPowerStateIndex     HeadNotePowerState;
 
     // Points to the entry in the power state array.
 
     // Points to the entry in the power state array.
-    IOPMPowerState *        HeadNotePowerArrayEntry;
+    IOPMPSEntry *           HeadNotePowerArrayEntry;
 
     // Power flags supplied by all parents (domain).
 
     // Power flags supplied by all parents (domain).
-    unsigned long           HeadNoteDomainFlags;
+    IOPMPowerFlags          HeadNoteDomainFlags;
+
+    // Power flags supplied by domain accounting for parent changes.
+    IOPMPowerFlags          HeadNoteDomainTargetFlags;
 
     // Connection attached to the changing parent.
     IOPowerConnection *     HeadNoteParentConnection;
     
     // Power flags supplied by the changing parent.
 
     // Connection attached to the changing parent.
     IOPowerConnection *     HeadNoteParentConnection;
     
     // Power flags supplied by the changing parent.
-    unsigned long           HeadNoteParentFlags;
+    IOPMPowerFlags          HeadNoteParentFlags;
 
     // Number of acks still outstanding.
 
     // Number of acks still outstanding.
-    unsigned long           HeadNotePendingAcks;
+    uint32_t                HeadNotePendingAcks;
 
     // PM state lock.
 
     // PM state lock.
-    IOLock     *               PMLock;
-
-    // Initialized to true, then set to false after the initial power change.
-    bool                    InitialChange;
-
-    // Ignore children and driver desires if true.
-    bool                    DeviceOverrides;
-
-    // True if device was active since last idle timer expiration.
-    bool                    DeviceActive;
-
-    // Keeps track of any negative responses from notified apps and clients.
-    bool                                       DoNotPowerDown;
-
-    // True if all our parents know the state of their power domain.
-    bool                                       ParentsKnowState;
-
-    bool                                       StrictTreeOrder;
-    bool                                       IdleTimerStopped;
-       bool                                    AdjustPowerScheduled;
+    IOLock *                PMLock;
+
+    unsigned int            InitialPowerChange:1;
+    unsigned int            InitialSetPowerState:1;
+    unsigned int            DeviceOverrideEnabled:1;
+    unsigned int            DoNotPowerDown:1;
+    unsigned int            ParentsKnowState:1;
+    unsigned int            StrictTreeOrder:1;
+    unsigned int            IdleTimerStopped:1;
+    unsigned int            AdjustPowerScheduled:1;
+    unsigned int            IsPreChange:1;
+    unsigned int            DriverCallBusy:1;
+    unsigned int            PCDFunctionOverride:1;
+    unsigned int            IdleTimerIgnored:1;
+    unsigned int            HasAdvisoryDesire:1;
+    unsigned int            AdvisoryTickleUsed:1;
 
     // Time of last device activity.
     AbsoluteTime            DeviceActiveTimestamp;
 
     // Time of last device activity.
     AbsoluteTime            DeviceActiveTimestamp;
@@ -103,169 +250,189 @@ private:
     // Used to protect activity flag.
     IOLock *                ActivityLock;
 
     // Used to protect activity flag.
     IOLock *                ActivityLock;
 
-    // Idle timer event source.
-    IOTimerEventSource *    IdleTimerEventSource;
-
     // Idle timer's period in seconds.
     unsigned long           IdleTimerPeriod;
     unsigned long           IdleTimerMinPowerState;
     AbsoluteTime            IdleTimerStartTime;
 
     // Power state desired by a subclassed device object.
     // Idle timer's period in seconds.
     unsigned long           IdleTimerPeriod;
     unsigned long           IdleTimerMinPowerState;
     AbsoluteTime            IdleTimerStartTime;
 
     // Power state desired by a subclassed device object.
-    unsigned long           DeviceDesire;
+    IOPMPowerStateIndex     DeviceDesire;
 
     // This is the power state we desire currently.
 
     // This is the power state we desire currently.
-    unsigned long           DesiredPowerState;
+    IOPMPowerStateIndex     DesiredPowerState;
 
     // This is what our parent thinks our need is.
 
     // This is what our parent thinks our need is.
-    unsigned long           PreviousRequest;
+    IOPMPowerFlags          PreviousRequestPowerFlags;
 
     // Cache result from getName(), used in logging.
     const char *            Name;
 
     // Number of power states in the power array.
 
     // Cache result from getName(), used in logging.
     const char *            Name;
 
     // Number of power states in the power array.
-    unsigned long           NumberOfPowerStates;
+    IOPMPowerStateIndex     NumberOfPowerStates;
 
     // Power state array.
 
     // Power state array.
-    IOPMPowerState *           PowerStates;
+    IOPMPSEntry *           PowerStates;
 
     // The controlling driver.
 
     // The controlling driver.
-    IOService *                                ControllingDriver;
+    IOService *             ControllingDriver;
 
     // Our current power state.
 
     // Our current power state.
-    unsigned long                      CurrentPowerState;
+    IOPMPowerStateIndex     CurrentPowerState;
 
     // Logical OR of power flags for each power domain parent.
 
     // Logical OR of power flags for each power domain parent.
-    IOPMPowerFlags                     ParentsCurrentPowerFlags;
+    IOPMPowerFlags          ParentsCurrentPowerFlags;
 
     // The highest power state we can achieve in current power domain.
 
     // The highest power state we can achieve in current power domain.
-    unsigned long                      MaxCapability;
+    IOPMPowerStateIndex     MaxPowerState;
 
     // Logical OR of all output power character flags in the array.
 
     // Logical OR of all output power character flags in the array.
-    IOPMPowerFlags                     OutputPowerCharacterFlags;
+    IOPMPowerFlags          OutputPowerCharacterFlags;
 
     // OSArray which manages responses from notified apps and clients.
 
     // OSArray which manages responses from notified apps and clients.
-    OSArray *                          ResponseArray;
+    OSArray *               ResponseArray;
     OSArray *               NotifyClientArray;
 
     // Used to uniquely identify power management notification to apps and clients.
     OSArray *               NotifyClientArray;
 
     // Used to uniquely identify power management notification to apps and clients.
-    UInt16                                     SerialNumber;
+    UInt16                  SerialNumber;
 
     // Used to communicate desired function to tellClientsWithResponse().
     // This is used because it avoids changing the signatures of the affected virtual methods.
 
     // Used to communicate desired function to tellClientsWithResponse().
     // This is used because it avoids changing the signatures of the affected virtual methods.
-    int                                                OutOfBandParameter;
+    int                     OutOfBandParameter;
 
     AbsoluteTime            DriverCallStartTime;
     IOPMPowerFlags          CurrentCapabilityFlags;
 
     AbsoluteTime            DriverCallStartTime;
     IOPMPowerFlags          CurrentCapabilityFlags;
-    long                    ActivityTicklePowerState;
     unsigned long           CurrentPowerConsumption;
     unsigned long           CurrentPowerConsumption;
-    unsigned long           TempClampPowerState;
-    IOPMWorkQueue *                    PMWorkQueue;
-    OSSet *                                    InsertInterestSet;
-    OSSet *                                    RemoveInterestSet;
-    OSArray *                          NotifyChildArray;
+    IOPMPowerStateIndex     TempClampPowerState;
+    OSArray *               NotifyChildArray;
     OSDictionary *          PowerClients;
     OSDictionary *          PowerClients;
-    thread_call_t                      DriverCallEntry;
-    void *                                     DriverCallParamPtr;
-    IOItemCount                                DriverCallParamCount;
-    IOItemCount                                DriverCallParamSlots;
+    thread_call_t           DriverCallEntry;
+    void *                  DriverCallParamPtr;
+    IOItemCount             DriverCallParamCount;
+    IOItemCount             DriverCallParamSlots;
     uint32_t                DriverCallReason;
     uint32_t                DriverCallReason;
+    uint32_t                OutOfBandMessage;
     uint32_t                TempClampCount;
     uint32_t                OverrideMaxPowerState;
     uint32_t                TempClampCount;
     uint32_t                OverrideMaxPowerState;
+    uint32_t                DeviceUsablePowerState;
+
+    // Protected by ActivityLock - BEGIN
+    int                     ActivityTicklePowerState;
+    int                     AdvisoryTicklePowerState;
     uint32_t                ActivityTickleCount;
     uint32_t                ActivityTickleCount;
+    uint32_t                DeviceWasActive     : 1;
+    uint32_t                AdvisoryTickled     : 1;
+    // Protected by ActivityLock - END
+
     uint32_t                WaitReason;
     uint32_t                WaitReason;
-    uint32_t                NextMachineState;
+    uint32_t                SavedMachineState;
     uint32_t                RootDomainState;
     uint32_t                RootDomainState;
-    uint32_t                ThreadAssertionCount;
 
 
-    // Protected by PMLock
+    // Protected by PMLock - BEGIN
     struct {
     struct {
-        uint32_t            DriverCallBusy : 1;
-        uint32_t            PMStop         : 1;
+        uint32_t            PMStop              : 1;
+        uint32_t            PMDriverCallWait    : 1;
     } LockedFlags;
 
     } LockedFlags;
 
-    thread_t                ThreadAssertionThread;
+    queue_head_t            PMDriverCallQueue;
+    OSSet *                 InsertInterestSet;
+    OSSet *                 RemoveInterestSet;
+    // Protected by PMLock - END
 
 #if PM_VARS_SUPPORT
 
 #if PM_VARS_SUPPORT
-    IOPMprot *                         PMVars;
+    IOPMprot *              PMVars;
 #endif
 
 #endif
 
+    IOPMActions             PMActions;
+
     // Serialize IOServicePM state for debug output.
     IOReturn gatedSerialize( OSSerialize * s );
     virtual bool serialize( OSSerialize * s ) const;
     // Serialize IOServicePM state for debug output.
     IOReturn gatedSerialize( OSSerialize * s );
     virtual bool serialize( OSSerialize * s ) const;
+    
+    // PM log and trace
+    void pmPrint( uint32_t event, uintptr_t param1, uintptr_t param2 ) const;
+    void pmTrace( uint32_t event, uintptr_t param1, uintptr_t param2 ) const;
 };
 
 };
 
+#define fOwner                      pwrMgt->Owner
 #define fInterestedDrivers          pwrMgt->InterestedDrivers
 #define fDriverTimer                pwrMgt->DriverTimer
 #define fInterestedDrivers          pwrMgt->InterestedDrivers
 #define fDriverTimer                pwrMgt->DriverTimer
+#define fMachineState               pwrMgt->MachineState
 #define fAckTimer                   pwrMgt->AckTimer
 #define fSettleTimer                pwrMgt->SettleTimer
 #define fAckTimer                   pwrMgt->AckTimer
 #define fSettleTimer                pwrMgt->SettleTimer
-#define fMachineState               pwrMgt->MachineState
+#define fIdleTimer                  pwrMgt->IdleTimer
 #define fSettleTimeUS               pwrMgt->SettleTimeUS
 #define fSettleTimeUS               pwrMgt->SettleTimeUS
-#define fHeadNoteFlags              pwrMgt->HeadNoteFlags
+#define fHeadNoteChangeFlags        pwrMgt->HeadNoteChangeFlags
 #define fHeadNotePowerState         pwrMgt->HeadNotePowerState
 #define fHeadNotePowerArrayEntry    pwrMgt->HeadNotePowerArrayEntry
 #define fHeadNoteDomainFlags        pwrMgt->HeadNoteDomainFlags
 #define fHeadNotePowerState         pwrMgt->HeadNotePowerState
 #define fHeadNotePowerArrayEntry    pwrMgt->HeadNotePowerArrayEntry
 #define fHeadNoteDomainFlags        pwrMgt->HeadNoteDomainFlags
+#define fHeadNoteDomainTargetFlags  pwrMgt->HeadNoteDomainTargetFlags
 #define fHeadNoteParentConnection   pwrMgt->HeadNoteParentConnection
 #define fHeadNoteParentFlags        pwrMgt->HeadNoteParentFlags
 #define fHeadNotePendingAcks        pwrMgt->HeadNotePendingAcks
 #define fPMLock                     pwrMgt->PMLock
 #define fHeadNoteParentConnection   pwrMgt->HeadNoteParentConnection
 #define fHeadNoteParentFlags        pwrMgt->HeadNoteParentFlags
 #define fHeadNotePendingAcks        pwrMgt->HeadNotePendingAcks
 #define fPMLock                     pwrMgt->PMLock
-#define fInitialChange              pwrMgt->InitialChange
-#define fDeviceOverrides            pwrMgt->DeviceOverrides
+#define fInitialPowerChange         pwrMgt->InitialPowerChange
+#define fInitialSetPowerState       pwrMgt->InitialSetPowerState
+#define fDeviceOverrideEnabled      pwrMgt->DeviceOverrideEnabled
+#define fDoNotPowerDown             pwrMgt->DoNotPowerDown
+#define fParentsKnowState           pwrMgt->ParentsKnowState
+#define fStrictTreeOrder            pwrMgt->StrictTreeOrder
+#define fIdleTimerStopped           pwrMgt->IdleTimerStopped
+#define fAdjustPowerScheduled       pwrMgt->AdjustPowerScheduled
+#define fIsPreChange                pwrMgt->IsPreChange
+#define fDriverCallBusy             pwrMgt->DriverCallBusy
+#define fPCDFunctionOverride        pwrMgt->PCDFunctionOverride
+#define fIdleTimerIgnored           pwrMgt->IdleTimerIgnored
+#define fHasAdvisoryDesire          pwrMgt->HasAdvisoryDesire
+#define fAdvisoryTickleUsed         pwrMgt->AdvisoryTickleUsed
+#define fDeviceActiveTimestamp      pwrMgt->DeviceActiveTimestamp
 #define fActivityLock               pwrMgt->ActivityLock
 #define fActivityLock               pwrMgt->ActivityLock
-#define fIdleTimerEventSource       pwrMgt->IdleTimerEventSource
 #define fIdleTimerPeriod            pwrMgt->IdleTimerPeriod
 #define fIdleTimerMinPowerState     pwrMgt->IdleTimerMinPowerState
 #define fIdleTimerPeriod            pwrMgt->IdleTimerPeriod
 #define fIdleTimerMinPowerState     pwrMgt->IdleTimerMinPowerState
-#define fDeviceActive               pwrMgt->DeviceActive
 #define fIdleTimerStartTime         pwrMgt->IdleTimerStartTime
 #define fIdleTimerStartTime         pwrMgt->IdleTimerStartTime
-#define fDeviceActiveTimestamp      pwrMgt->DeviceActiveTimestamp
-#define fActivityTickleCount        pwrMgt->ActivityTickleCount
 #define fDeviceDesire               pwrMgt->DeviceDesire
 #define fDesiredPowerState          pwrMgt->DesiredPowerState
 #define fDeviceDesire               pwrMgt->DeviceDesire
 #define fDesiredPowerState          pwrMgt->DesiredPowerState
-#define fPreviousRequest            pwrMgt->PreviousRequest
+#define fPreviousRequestPowerFlags  pwrMgt->PreviousRequestPowerFlags
 #define fName                       pwrMgt->Name
 #define fNumberOfPowerStates        pwrMgt->NumberOfPowerStates
 #define fPowerStates                pwrMgt->PowerStates
 #define fControllingDriver          pwrMgt->ControllingDriver
 #define fName                       pwrMgt->Name
 #define fNumberOfPowerStates        pwrMgt->NumberOfPowerStates
 #define fPowerStates                pwrMgt->PowerStates
 #define fControllingDriver          pwrMgt->ControllingDriver
-#define fAggressivenessValue        pwrMgt->AggressivenessValue
-#define fAggressivenessValid        pwrMgt->AggressivenessValid
 #define fCurrentPowerState          pwrMgt->CurrentPowerState
 #define fCurrentPowerState          pwrMgt->CurrentPowerState
-#define fParentsKnowState           pwrMgt->ParentsKnowState
 #define fParentsCurrentPowerFlags   pwrMgt->ParentsCurrentPowerFlags
 #define fParentsCurrentPowerFlags   pwrMgt->ParentsCurrentPowerFlags
-#define fMaxCapability              pwrMgt->MaxCapability
+#define fMaxPowerState              pwrMgt->MaxPowerState
 #define fOutputPowerCharacterFlags  pwrMgt->OutputPowerCharacterFlags
 #define fOutputPowerCharacterFlags  pwrMgt->OutputPowerCharacterFlags
-#define fSerialNumber               pwrMgt->SerialNumber
 #define fResponseArray              pwrMgt->ResponseArray
 #define fNotifyClientArray          pwrMgt->NotifyClientArray
 #define fResponseArray              pwrMgt->ResponseArray
 #define fNotifyClientArray          pwrMgt->NotifyClientArray
-#define fDoNotPowerDown             pwrMgt->DoNotPowerDown
+#define fSerialNumber               pwrMgt->SerialNumber
 #define fOutOfBandParameter         pwrMgt->OutOfBandParameter
 #define fDriverCallStartTime        pwrMgt->DriverCallStartTime
 #define fCurrentCapabilityFlags     pwrMgt->CurrentCapabilityFlags
 #define fCurrentPowerConsumption    pwrMgt->CurrentPowerConsumption
 #define fTempClampPowerState        pwrMgt->TempClampPowerState
 #define fOutOfBandParameter         pwrMgt->OutOfBandParameter
 #define fDriverCallStartTime        pwrMgt->DriverCallStartTime
 #define fCurrentCapabilityFlags     pwrMgt->CurrentCapabilityFlags
 #define fCurrentPowerConsumption    pwrMgt->CurrentPowerConsumption
 #define fTempClampPowerState        pwrMgt->TempClampPowerState
-#define fTempClampCount             pwrMgt->TempClampCount
-#define fOverrideMaxPowerState      pwrMgt->OverrideMaxPowerState
-#define fPMWorkQueue                pwrMgt->PMWorkQueue
-#define fWaitReason                 pwrMgt->WaitReason
-#define fNextMachineState           pwrMgt->NextMachineState
-#define fDriverCallReason           pwrMgt->DriverCallReason
+#define fNotifyChildArray           pwrMgt->NotifyChildArray
+#define fPowerClients               pwrMgt->PowerClients
 #define fDriverCallEntry            pwrMgt->DriverCallEntry
 #define fDriverCallParamPtr         pwrMgt->DriverCallParamPtr
 #define fDriverCallParamCount       pwrMgt->DriverCallParamCount
 #define fDriverCallParamSlots       pwrMgt->DriverCallParamSlots
 #define fDriverCallEntry            pwrMgt->DriverCallEntry
 #define fDriverCallParamPtr         pwrMgt->DriverCallParamPtr
 #define fDriverCallParamCount       pwrMgt->DriverCallParamCount
 #define fDriverCallParamSlots       pwrMgt->DriverCallParamSlots
-#define fActivityTickled            pwrMgt->ActivityTickled
-#define fInsertInterestSet          pwrMgt->InsertInterestSet
-#define fRemoveInterestSet          pwrMgt->RemoveInterestSet
-#define fStrictTreeOrder            pwrMgt->StrictTreeOrder
-#define fNotifyChildArray           pwrMgt->NotifyChildArray
-#define fIdleTimerStopped                      pwrMgt->IdleTimerStopped
-#define fAdjustPowerScheduled       pwrMgt->AdjustPowerScheduled
+#define fDriverCallReason           pwrMgt->DriverCallReason
+#define fOutOfBandMessage           pwrMgt->OutOfBandMessage
+#define fTempClampCount             pwrMgt->TempClampCount
+#define fOverrideMaxPowerState      pwrMgt->OverrideMaxPowerState
+#define fDeviceUsablePowerState     pwrMgt->DeviceUsablePowerState
 #define fActivityTicklePowerState   pwrMgt->ActivityTicklePowerState
 #define fActivityTicklePowerState   pwrMgt->ActivityTicklePowerState
-#define fPMVars                     pwrMgt->PMVars
-#define fPowerClients               pwrMgt->PowerClients
+#define fAdvisoryTicklePowerState   pwrMgt->AdvisoryTicklePowerState
+#define fActivityTickleCount        pwrMgt->ActivityTickleCount
+#define fDeviceWasActive            pwrMgt->DeviceWasActive
+#define fAdvisoryTickled            pwrMgt->AdvisoryTickled
+#define fWaitReason                 pwrMgt->WaitReason
+#define fSavedMachineState          pwrMgt->SavedMachineState
 #define fRootDomainState            pwrMgt->RootDomainState
 #define fRootDomainState            pwrMgt->RootDomainState
-#define fThreadAssertionCount       pwrMgt->ThreadAssertionCount
-#define fThreadAssertionThread      pwrMgt->ThreadAssertionThread
 #define fLockedFlags                pwrMgt->LockedFlags
 #define fLockedFlags                pwrMgt->LockedFlags
+#define fPMDriverCallQueue          pwrMgt->PMDriverCallQueue
+#define fInsertInterestSet          pwrMgt->InsertInterestSet
+#define fRemoveInterestSet          pwrMgt->RemoveInterestSet
+#define fPMVars                     pwrMgt->PMVars
+#define fPMActions                  pwrMgt->PMActions
 
 /*
 When an IOService is waiting for acknowledgement to a power change
 
 /*
 When an IOService is waiting for acknowledgement to a power change
@@ -275,13 +442,28 @@ the ack timer is ticking every tenth of a second.
 */
 #define ACK_TIMER_PERIOD            100000000
 
 */
 #define ACK_TIMER_PERIOD            100000000
 
-#define kIOPMParentInitiated        0x01    // this power change initiated by our  parent
-#define kIOPMWeInitiated            0x02    // this power change initiated by this device
-#define kIOPMNotDone                0x04    // we couldn't make this change
-#define kIOPMDomainWillChange       0x08    // change started by PowerDomainWillChangeTo
-#define kIOPMDomainDidChange        0x10    // change started by PowerDomainDidChangeTo
-#define kIOPMDomainPowerDrop        0x20    // Domain is lowering power
-#define kIOPMSynchronize            0x40    // change triggered by power tree re-sync
+// Max wait time in microseconds for kernel priority and capability clients
+// with async message handlers to acknowledge.
+// 
+#define kPriorityClientMaxWait      (90 * 1000 * 1000)
+#define kCapabilityClientMaxWait    (240 * 1000 * 1000)
+
+// Attributes describing a power state change.
+// See IOPMPowerChangeFlags data type.
+//
+#define kIOPMParentInitiated        0x0001  // this power change initiated by our  parent
+#define kIOPMSelfInitiated          0x0002  // this power change initiated by this device
+#define kIOPMNotDone                0x0004  // we couldn't make this change
+#define kIOPMDomainWillChange       0x0008  // change started by PowerDomainWillChangeTo
+#define kIOPMDomainDidChange        0x0010  // change started by PowerDomainDidChangeTo
+#define kIOPMDomainPowerDrop        0x0020  // Domain is lowering power
+#define kIOPMIgnoreChildren         0x0040  // Ignore children and driver power desires
+#define kIOPMSkipAskPowerDown       0x0080  // skip the ask app phase
+#define kIOPMSynchronize            0x0100  // change triggered by power tree re-sync
+#define kIOPMSyncNoChildNotify      0x0200  // sync root domain only, not entire tree
+#define kIOPMSyncTellPowerDown      0x0400  // send the ask/will power off messages
+#define kIOPMSyncCancelPowerDown    0x0800  // sleep cancel for maintenance wake
+#define kIOPMInitialPowerChange     0x1000  // set for initial power change
 
 enum {
     kDriverCallInformPreChange,
 
 enum {
     kDriverCallInformPreChange,
@@ -294,73 +476,51 @@ struct DriverCallParam {
     IOReturn    Result;
 };
 
     IOReturn    Result;
 };
 
-// values of outofbandparameter
+// values of OutOfBandParameter
 enum {
     kNotifyApps,
 enum {
     kNotifyApps,
-    kNotifyPriority
+    kNotifyPriority,
+    kNotifyCapabilityChangeApps,
+    kNotifyCapabilityChangePriority
 };
 
 };
 
-typedef bool (*IOPMMessageFilter)(OSObject * object, void * context);
+typedef bool (*IOPMMessageFilter)(
+        void * target, void * object, void * arg1, void * arg2, void * arg3 );
 
 // used for applyToInterested
 struct IOPMInterestContext {
 
 // used for applyToInterested
 struct IOPMInterestContext {
-    OSArray *           responseFlags;
-    OSArray *           notifyClients;
-    UInt16              serialNumber;
-    UInt16              counter;
-    UInt32              maxTimeRequested;
-    int                 msgType;
-    IOService *         us;
-    unsigned long       stateNumber;
-    IOPMPowerFlags      stateFlags;
-    const char *        errorLog;
-    IOPMMessageFilter   filterFunc;
+    OSArray *               responseArray;
+    OSArray *               notifyClients;
+    uint16_t                serialNumber;
+    uint8_t                 isPreChange;
+    uint8_t                 enableTracing;
+    uint32_t                maxTimeRequested;
+    uint32_t                messageType;
+    uint32_t                notifyType;
+    IOService *             us;
+    IOPMPowerStateIndex     stateNumber;
+    IOPMPowerFlags          stateFlags;
+    IOPMPowerChangeFlags    changeFlags;
+    const char *            errorLog;
+    IOPMMessageFilter       messageFilter;
 };
 
 };
 
-//*********************************************************************************
+// assertPMDriverCall() options
+enum {
+    kIOPMADC_NoInactiveCheck = 1
+};
+
+//******************************************************************************
 // PM Statistics & Diagnostics
 // PM Statistics & Diagnostics
-//*********************************************************************************
+//******************************************************************************
 
 extern const OSSymbol *gIOPMStatsApplicationResponseTimedOut;
 extern const OSSymbol *gIOPMStatsApplicationResponseCancel;
 extern const OSSymbol *gIOPMStatsApplicationResponseSlow;
 
 
 extern const OSSymbol *gIOPMStatsApplicationResponseTimedOut;
 extern const OSSymbol *gIOPMStatsApplicationResponseCancel;
 extern const OSSymbol *gIOPMStatsApplicationResponseSlow;
 
-//*********************************************************************************
-// PM command types
-//*********************************************************************************
-
-enum {
-    /* Command Types */
-    kIOPMRequestTypeInvalid                     = 0x00,
-    kIOPMRequestTypePMStop                      = 0x01,
-    kIOPMRequestTypeAddPowerChild1              = 0x02,
-    kIOPMRequestTypeAddPowerChild2              = 0x03,
-    kIOPMRequestTypeAddPowerChild3              = 0x04,
-    kIOPMRequestTypeRegisterPowerDriver         = 0x05,
-    kIOPMRequestTypeAdjustPowerState            = 0x06,
-    kIOPMRequestTypePowerDomainWillChange       = 0x07,
-    kIOPMRequestTypePowerDomainDidChange        = 0x08,
-    kIOPMRequestTypePowerOverrideOnPriv         = 0x09,
-    kIOPMRequestTypePowerOverrideOffPriv        = 0x0A,
-    kIOPMRequestTypeActivityTickle              = 0x0B,
-    kIOPMRequestTypeRequestPowerState           = 0x0C,
-    kIOPMRequestTypeSynchronizePowerTree        = 0x0D,
-    kIOPMRequestTypeRequestPowerStateOverride   = 0x0E,
-    kIOPMRequestTypeSetIdleTimerPeriod          = 0x0F,
-
-    /* Reply Types */
-    kIOPMRequestTypeReplyStart                  = 0x80,
-    kIOPMRequestTypeAckPowerChange              = 0x81,
-    kIOPMRequestTypeAckSetPowerState            = 0x82,
-    kIOPMRequestTypeAllowPowerChange            = 0x83,
-    kIOPMRequestTypeCancelPowerChange           = 0x84,
-    kIOPMRequestTypeInterestChanged             = 0x85,
-    kIOPMRequestTypeIdleCancel                  = 0x86
-};
-
-//*********************************************************************************
-// IOServicePM internal helper classes
-//*********************************************************************************
+//******************************************************************************
+// IOPMRequest
+//******************************************************************************
 
 typedef void (*IOPMCompletionAction)(void * target, void * param, IOReturn status);
 
 
 typedef void (*IOPMCompletionAction)(void * target, void * param, IOReturn status);
 
@@ -371,9 +531,9 @@ class IOPMRequest : public IOCommand
 protected:
     IOService *          fTarget;        // request target
     IOPMRequest *        fRequestNext;   // the next request in the chain
 protected:
     IOService *          fTarget;        // request target
     IOPMRequest *        fRequestNext;   // the next request in the chain
-       IOPMRequest *            fRequestRoot;   // the root request in the issue tree
+    IOPMRequest *        fRequestRoot;   // the root request in the issue tree
     IOItemCount          fWorkWaitCount; // execution blocked if non-zero
     IOItemCount          fWorkWaitCount; // execution blocked if non-zero
-       IOItemCount                      fFreeWaitCount; // completion blocked if non-zero      
+    IOItemCount          fFreeWaitCount; // completion blocked if non-zero
     uint32_t             fType;          // request type
 
     IOPMCompletionAction fCompletionAction;
     uint32_t             fType;          // request type
 
     IOPMCompletionAction fCompletionAction;
@@ -401,12 +561,12 @@ public:
         return fRequestNext;
     }
 
         return fRequestNext;
     }
 
-       inline IOPMRequest * getRootRequest( void ) const
-       {
+    inline IOPMRequest * getRootRequest( void ) const
+    {
         if (fRequestRoot) return fRequestRoot;
         if (fCompletionAction) return (IOPMRequest *) this;
         if (fRequestRoot) return fRequestRoot;
         if (fCompletionAction) return (IOPMRequest *) this;
-               return 0;
-       }
+        return 0;
+    }
 
     inline uint32_t      getType( void ) const
     {
 
     inline uint32_t      getType( void ) const
     {
@@ -441,12 +601,16 @@ public:
     static IOPMRequest * create( void );
     bool   init( IOService * owner, IOOptionBits type );
     void   reset( void );
     static IOPMRequest * create( void );
     bool   init( IOService * owner, IOOptionBits type );
     void   reset( void );
-    void   attachNextRequest( IOPMRequest * next );
-    void   detachNextRequest( void );
-    void   attachRootRequest( IOPMRequest * root );
-    void   detachRootRequest( void );
+    bool   attachNextRequest( IOPMRequest * next );
+    bool   detachNextRequest( void );
+    bool   attachRootRequest( IOPMRequest * root );
+    bool   detachRootRequest( void );
 };
 
 };
 
+//******************************************************************************
+// IOPMRequestQueue
+//******************************************************************************
+
 class IOPMRequestQueue : public IOEventSource
 {
     OSDeclareDefaultStructors( IOPMRequestQueue )
 class IOPMRequestQueue : public IOEventSource
 {
     OSDeclareDefaultStructors( IOPMRequestQueue )
@@ -466,9 +630,14 @@ public:
     static  IOPMRequestQueue * create( IOService * inOwner, Action inAction );
     void    queuePMRequest( IOPMRequest * request );
     void    queuePMRequestChain( IOPMRequest ** requests, IOItemCount count );
     static  IOPMRequestQueue * create( IOService * inOwner, Action inAction );
     void    queuePMRequest( IOPMRequest * request );
     void    queuePMRequestChain( IOPMRequest ** requests, IOItemCount count );
-    void    signalWorkAvailable( void );
 };
 
 };
 
+//******************************************************************************
+// IOPMWorkQueue
+//******************************************************************************
+
+#define WORK_QUEUE_STATS    1
+
 class IOPMWorkQueue : public IOEventSource
 {
     OSDeclareDefaultStructors( IOPMWorkQueue )
 class IOPMWorkQueue : public IOEventSource
 {
     OSDeclareDefaultStructors( IOPMWorkQueue )
@@ -476,19 +645,36 @@ class IOPMWorkQueue : public IOEventSource
 public:
     typedef bool (*Action)( IOService *, IOPMRequest *, IOPMWorkQueue * );
 
 public:
     typedef bool (*Action)( IOService *, IOPMRequest *, IOPMWorkQueue * );
 
+#if WORK_QUEUE_STATS
+    uint64_t            fStatCheckForWork;
+    uint64_t            fStatScanEntries;
+    uint64_t            fStatQueueEmpty;
+    uint64_t            fStatNoWorkDone;
+#endif
+
 protected:
 protected:
-    queue_head_t    fWorkQueue;
-    Action          fWorkAction;
-    Action          fRetireAction;
+    queue_head_t        fWorkQueue;
+    Action              fWorkAction;
+    Action              fRetireAction;
+    uint32_t            fQueueLength;
+    uint32_t            fConsumerCount;
+    volatile uint32_t   fProducerCount;
 
     virtual bool checkForWork( void );
     virtual bool init( IOService * inOwner, Action work, Action retire );
 
     virtual bool checkForWork( void );
     virtual bool init( IOService * inOwner, Action work, Action retire );
+    bool    checkRequestQueue( queue_head_t * queue, bool * empty );
 
 public:
     static  IOPMWorkQueue * create( IOService * inOwner, Action work, Action retire );
 
 public:
     static  IOPMWorkQueue * create( IOService * inOwner, Action work, Action retire );
-    void    queuePMRequest( IOPMRequest * request );
+    bool    queuePMRequest( IOPMRequest * request, IOServicePM * pwrMgt );
+    void    signalWorkAvailable( void );
+    void    incrementProducerCount( void );
 };
 
 };
 
+//******************************************************************************
+// IOPMCompletionQueue
+//******************************************************************************
+
 class IOPMCompletionQueue : public IOEventSource
 {
     OSDeclareDefaultStructors( IOPMCompletionQueue )
 class IOPMCompletionQueue : public IOEventSource
 {
     OSDeclareDefaultStructors( IOPMCompletionQueue )
@@ -504,7 +690,7 @@ protected:
 
 public:
     static  IOPMCompletionQueue * create( IOService * inOwner, Action inAction );
 
 public:
     static  IOPMCompletionQueue * create( IOService * inOwner, Action inAction );
-    void    queuePMRequest( IOPMRequest * request );
+    bool    queuePMRequest( IOPMRequest * request );
 };
 
 #endif /* !_IOKIT_IOSERVICEPMPRIVATE_H */
 };
 
 #endif /* !_IOKIT_IOSERVICEPMPRIVATE_H */
mirror of XNU