xnu-2050.18.24.tar.gz

[apple/xnu.git] / iokit / IOKit / pwr_mgt / RootDomain.h

diff --git a/iokit/IOKit/pwr_mgt/RootDomain.h b/iokit/IOKit/pwr_mgt/RootDomain.h
index 4e89c16fcd6b8e27ca83c80a1fef4ee89173a9fd..95dbc96a51ef8351a327dc5a81c68ee1d3f31768 100644 (file)
--- a/iokit/IOKit/pwr_mgt/RootDomain.h
+++ b/iokit/IOKit/pwr_mgt/RootDomain.h
@@ -1,94 +1,473 @@
 /*
  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
  *
 /*
  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
  *

- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

  * 
  * 

- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.

  * 
  * 

- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER

  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,

- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.

  * 
  * 

- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@

  */
 #ifndef _IOKIT_ROOTDOMAIN_H
 #define _IOKIT_ROOTDOMAIN_H
 
 #include <IOKit/IOService.h>
 #include <IOKit/pwr_mgt/IOPM.h>
  */
 #ifndef _IOKIT_ROOTDOMAIN_H
 #define _IOKIT_ROOTDOMAIN_H
 
 #include <IOKit/IOService.h>
 #include <IOKit/pwr_mgt/IOPM.h>

+#include <IOKit/IOBufferMemoryDescriptor.h> 

 
 

+#ifdef XNU_KERNEL_PRIVATE
+struct AggressivesRecord;
+struct IOPMMessageFilterContext;
+struct IOPMActions;
+struct IOPMSystemSleepParameters;
+class PMSettingObject;
+class IOPMTimeline;
+class PMEventDetails;
+class PMTraceWorker;
+class IOPMPowerStateQueue;

 class RootDomainUserClient;
 class RootDomainUserClient;

+class PMAssertionsTracker;
+#endif

 
 

-#define kRootDomainSupportedFeatures "Supported Features"
+/*!
+ * Types for PM Assertions
+ * For creating, releasing, and getting PM assertion levels.
+ */
+ 
+/*! IOPMDriverAssertionType
+ * A bitfield describing a set of assertions. May be used to specify which assertions
+ * to set with <link>IOPMrootDomain::createPMAssertion</link>; or to query which 
+ * assertions are set with <link>IOPMrootDomain::releasePMAssertion</link>.
+ */
+typedef uint64_t IOPMDriverAssertionType;
+
+/* IOPMDriverAssertionID
+ * Drivers may create PM assertions to request system behavior (keep the system awake,
+ *  or keep the display awake). When a driver creates an assertion via 
+ *  <link>IOPMrootDomain::createPMAssertion</link>, PM returns a handle to 
+ *  the assertion of type IOPMDriverAssertionID.
+ */
+typedef uint64_t IOPMDriverAssertionID;
+#define kIOPMUndefinedDriverAssertionID       0

 
 

+/* IOPMDriverAssertionLevel
+ * Possible values for IOPMDriverAssertionLevel are <link>kIOPMDriverAssertionLevelOff</link>
+ * and <link>kIOPMDriverAssertionLevelOn</link>
+ */
+typedef uint32_t IOPMDriverAssertionLevel;
+#define kIOPMDriverAssertionLevelOff          0
+#define kIOPMDriverAssertionLevelOn           255
+
+/*
+ * Flags for get/setSleepSupported()
+ */

 enum {
     kRootDomainSleepNotSupported       = 0x00000000,
     kRootDomainSleepSupported          = 0x00000001,
     kFrameBufferDeepSleepSupported     = 0x00000002,
 enum {
     kRootDomainSleepNotSupported       = 0x00000000,
     kRootDomainSleepSupported          = 0x00000001,
     kFrameBufferDeepSleepSupported     = 0x00000002,

-    kPCICantSleep                      = 0x00000004
+    kPCICantSleep                   = 0x00000004

 };
 
 };
 

-extern "C"
-{
-       IONotifier * registerSleepWakeInterest(IOServiceInterestHandler, void *, void * = 0);
-        IONotifier * registerPrioritySleepWakeInterest(IOServiceInterestHandler handler, void * self, void * ref = 0);
-        IOReturn acknowledgeSleepWakeNotification(void * );
-        IOReturn vetoSleepWakeNotification(void * PMrefcon);
-        IOReturn rootDomainRestart ( void );
-        IOReturn rootDomainShutdown ( void );
-}
+/* 
+ *IOPMrootDomain registry property keys
+ */
+#define kRootDomainSupportedFeatures        "Supported Features"
+#define kRootDomainSleepReasonKey           "Last Sleep Reason"
+#define kRootDomainSleepOptionsKey          "Last Sleep Options"
+#define kIOPMRootDomainWakeReasonKey        "Wake Reason"
+#define kIOPMRootDomainWakeTypeKey          "Wake Type"
+#define kIOPMRootDomainPowerStatusKey       "Power Status"
+
+/*
+ * Possible sleep reasons found under kRootDomainSleepReasonsKey
+ */
+#define kIOPMClamshellSleepKey              "Clamshell Sleep"
+#define kIOPMPowerButtonSleepKey            "Power Button Sleep"
+#define kIOPMSoftwareSleepKey               "Software Sleep"
+#define kIOPMOSSwitchHibernationKey         "OS Switch Sleep"
+#define kIOPMIdleSleepKey                   "Idle Sleep"
+#define kIOPMLowPowerSleepKey               "Low Power Sleep"
+#define kIOPMThermalEmergencySleepKey       "Thermal Emergency Sleep"
+#define kIOPMMaintenanceSleepKey            "Maintenance Sleep"
+
+/*
+ * String constants for communication with PM CPU
+ */
+#define kIOPMRootDomainLidCloseCString      "LidClose"
+#define kIOPMRootDomainBatPowerCString      "BatPower"
+
+/*
+ * Supported Feature bitfields for IOPMrootDomain::publishFeature()
+ */
+enum {
+    kIOPMSupportedOnAC      = (1<<0),
+    kIOPMSupportedOnBatt    = (1<<1),
+    kIOPMSupportedOnUPS     = (1<<2)
+};
+
+typedef IOReturn (*IOPMSettingControllerCallback)
+                    (OSObject *target, const OSSymbol *type,
+                     OSObject *val, uintptr_t refcon);
+
+__BEGIN_DECLS
+IONotifier *    registerSleepWakeInterest(
+                    IOServiceInterestHandler, void *, void * = 0);
+               
+IONotifier *    registerPrioritySleepWakeInterest(
+                    IOServiceInterestHandler handler, 
+                    void * self, void * ref = 0);
+
+IOReturn        acknowledgeSleepWakeNotification(void * );
+
+IOReturn        vetoSleepWakeNotification(void * PMrefcon);
+__END_DECLS

 
 #define IOPM_ROOTDOMAIN_REV            2
 
 class IOPMrootDomain: public IOService
 {
 
 #define IOPM_ROOTDOMAIN_REV            2
 
 class IOPMrootDomain: public IOService
 {

-OSDeclareDefaultStructors(IOPMrootDomain)
+    OSDeclareFinalStructors(IOPMrootDomain)
+
+public:
+    static IOPMrootDomain * construct( void );
+
+    virtual bool        start( IOService * provider );
+    virtual IOReturn    setAggressiveness( unsigned long, unsigned long );
+    virtual IOReturn    getAggressiveness( unsigned long, unsigned long * );
+
+    virtual IOReturn    sleepSystem( void );
+    IOReturn            sleepSystemOptions( OSDictionary *options );
+
+    virtual IOReturn    setProperties( OSObject * );
+    virtual bool        serializeProperties( OSSerialize * s ) const;
+
+/*! @function systemPowerEventOccurred
+    @abstract Other drivers may inform IOPMrootDomain of system PM events
+    @discussion systemPowerEventOccurred is a richer alternative to receivePowerNotification()
+        Only Apple-owned kexts should have reason to call systemPowerEventOccurred.
+    @param event An OSSymbol describing the type of power event.
+    @param value A 32-bit integer value associated with the event.
+    @param shouldUpdate indicates whether the root domain should send a notification
+        to interested parties. Pass false if you're calling systemPowerEventOccurred
+        several times in succession; and pass true only on the last invocatino.
+    @result kIOReturnSuccess on success */
+
+    IOReturn            systemPowerEventOccurred(
+                                    const OSSymbol *event, 
+                                    uint32_t intValue );
+
+    IOReturn            systemPowerEventOccurred(
+                                    const OSSymbol *event, 
+                                    OSObject *value );
+
+    virtual IOReturn    receivePowerNotification( UInt32 msg );
+
+    virtual void        setSleepSupported( IOOptionBits flags );
+
+    virtual IOOptionBits getSleepSupported( void );
+
+    void                wakeFromDoze( void );
+
+    // KEXT driver announces support of power management feature
+
+    void                publishFeature( const char *feature );

     
     

+    // KEXT driver announces support of power management feature
+    // And specifies power sources with kIOPMSupportedOn{AC/Batt/UPS} bitfield.
+    // Returns a unique uint32_t identifier for later removing support for this
+    // feature. 
+    // NULL is acceptable for uniqueFeatureID for kexts without plans to unload.
+
+    void                publishFeature( const char *feature, 
+                                        uint32_t supportedWhere,
+                                        uint32_t *uniqueFeatureID);
+
+    // KEXT driver announces removal of a previously published power management 
+    // feature. Pass 'uniqueFeatureID' returned from publishFeature()
+
+    IOReturn            removePublishedFeature( uint32_t removeFeatureID );
+
+/*! @function copyPMSetting
+    @abstract Copy the current value for a PM setting. Returns an OSNumber or
+        OSData depending on the setting.
+    @param whichSetting Name of the desired setting.
+    @result OSObject value if valid, NULL otherwise. */
+
+    OSObject *          copyPMSetting( OSSymbol *whichSetting );
+
+/*! @function registerPMSettingController
+    @abstract Register for callbacks on changes to certain PM settings.
+    @param settings NULL terminated array of C strings, each string for a PM 
+        setting that the caller is interested in and wants to get callbacks for. 
+    @param callout C function ptr or member function cast as such.
+    @param target The target of the callback, usually 'this'
+    @param refcon Will be passed to caller in callback; for caller's use.
+    @param handle Caller should keep the OSObject * returned here. If non-NULL,
+        handle will have a retain count of 1 on return. To deregister, pass to
+        unregisterPMSettingController()
+    @result kIOReturnSuccess on success. */
+
+    IOReturn            registerPMSettingController(
+                                 const OSSymbol *settings[],
+                                 IOPMSettingControllerCallback callout,
+                                 OSObject   *target,
+                                 uintptr_t  refcon,
+                                 OSObject   **handle);    // out param
+
+/*! @function registerPMSettingController
+    @abstract Register for callbacks on changes to certain PM settings.
+    @param settings NULL terminated array of C strings, each string for a PM 
+        setting that the caller is interested in and wants to get callbacks for. 
+    @param supportedPowerSources bitfield indicating which power sources these
+        settings are supported for (kIOPMSupportedOnAC, etc.)
+    @param callout C function ptr or member function cast as such.
+    @param target The target of the callback, usually 'this'
+    @param refcon Will be passed to caller in callback; for caller's use.
+    @param handle Caller should keep the OSObject * returned here. If non-NULL,
+        handle will have a retain count of 1 on return. To deregister, pass to
+        unregisterPMSettingController()
+    @result kIOReturnSuccess on success. */
+
+    IOReturn            registerPMSettingController(
+                                 const OSSymbol *settings[],
+                                 uint32_t   supportedPowerSources,
+                                 IOPMSettingControllerCallback callout,
+                                 OSObject   *target,
+                                 uintptr_t  refcon,
+                                 OSObject   **handle);    // out param
+
+    virtual IONotifier * registerInterest(
+                                const OSSymbol * typeOfInterest,
+                                IOServiceInterestHandler handler,
+                                void * target, void * ref = 0 );
+
+    virtual IOReturn    callPlatformFunction(
+                                const OSSymbol *functionName,
+                                bool waitForFunction,
+                                void *param1, void *param2,
+                                void *param3, void *param4 );
+
+/*! @function createPMAssertion
+    @abstract Creates an assertion to influence system power behavior.
+    @param whichAssertionBits A bitfield specify the assertion that the caller requests.
+    @param assertionLevel An integer detailing the initial assertion level, kIOPMDriverAssertionLevelOn
+        or kIOPMDriverAssertionLevelOff.
+    @param ownerService A pointer to the caller's IOService class, for tracking.
+    @param ownerDescription A reverse-DNS string describing the caller's identity and reason.
+    @result On success, returns a new assertion of type IOPMDriverAssertionID
+*/
+    IOPMDriverAssertionID createPMAssertion(
+                                IOPMDriverAssertionType whichAssertionsBits,
+                                IOPMDriverAssertionLevel assertionLevel,
+                                IOService *ownerService,
+                                const char *ownerDescription);
+
+/* @function setPMAssertionLevel
+   @abstract Modify the level of a pre-existing assertion.
+   @discussion Change the value of a PM assertion to influence system behavior, 
+    without undergoing the work required to create or destroy an assertion. Suggested
+    for clients who will assert and de-assert needs for PM behavior several times over
+    their lifespan.
+   @param assertionID An assertion ID previously returned by <link>createPMAssertion</link>
+   @param assertionLevel The new assertion level.
+   @result kIOReturnSuccess if it worked; kIOReturnNotFound or other IOReturn error on failure.
+*/
+    IOReturn setPMAssertionLevel(IOPMDriverAssertionID assertionID, IOPMDriverAssertionLevel assertionLevel);
+
+/*! @function getPMAssertionLevel
+    @absract Returns the active level of the specified assertion(s).
+    @discussion Returns <link>kIOPMDriverAssertionLevelOff</link> or 
+        <link>kIOPMDriverAssertionLevelOn</link>. If multiple assertions are specified
+        in the bitfield, only returns <link>kIOPMDriverAssertionLevelOn</link>
+        if all assertions are active.
+    @param whichAssertionBits Bits defining the assertion or assertions the caller is interested in
+        the level of. If in doubt, pass <link>kIOPMDriverAssertionCPUBit</link> as the argument.
+    @result Returns <link>kIOPMDriverAssertionLevelOff</link> or 
+        <link>kIOPMDriverAssertionLevelOn</link> indicating the specified assertion's levels, if available.
+        If the assertions aren't supported on this machine, or aren't recognized by the OS, the
+        result is undefined.
+*/
+    IOPMDriverAssertionLevel getPMAssertionLevel(IOPMDriverAssertionType whichAssertionBits);
+
+/*! @function releasePMAssertion
+    @abstract Removes an assertion to influence system power behavior.
+    @result On success, returns a new assertion of type IOPMDriverAssertionID *
+*/
+    IOReturn releasePMAssertion(IOPMDriverAssertionID releaseAssertion);
+        
+private:
+    virtual IOReturn    changePowerStateTo( unsigned long ordinal );
+    virtual IOReturn    changePowerStateToPriv( unsigned long ordinal );
+    virtual IOReturn    requestPowerDomainState( IOPMPowerFlags, IOPowerConnection *, unsigned long );
+    virtual void        powerChangeDone( unsigned long );
+    virtual bool        tellChangeDown( unsigned long );
+    virtual bool        askChangeDown( unsigned long );
+    virtual void        tellChangeUp( unsigned long );
+    virtual void        tellNoChangeDown( unsigned long );
+#ifdef XNU_KERNEL_PRIVATE
+    /* Root Domain internals */

 public:
 public:

+    void        tagPowerPlaneService(
+                    IOService *     service,
+                    IOPMActions *   actions );

 
 

-    class IOService * wrangler;                        // we tickle the wrangler on button presses, etc
+    void        overrideOurPowerChange(
+                    IOService *     service,
+                    IOPMActions *   actions,
+                    unsigned long * inOutPowerState,
+                    uint32_t *      inOutChangeFlags );

 
 

-    static IOPMrootDomain * construct( void );
-    virtual bool start( IOService * provider );
-    virtual IOReturn newUserClient ( task_t,  void *, UInt32, IOUserClient ** );
-    virtual IOReturn setAggressiveness ( unsigned long, unsigned long );
-    virtual IOReturn youAreRoot ( void );
-    virtual IOReturn sleepSystem ( void );
-    IOReturn shutdownSystem ( void );
-    IOReturn restartSystem ( void );
-    virtual IOReturn receivePowerNotification (UInt32 msg);
-    virtual void setSleepSupported( IOOptionBits flags );
-    virtual IOOptionBits getSleepSupported();
-    virtual IOReturn requestPowerDomainState ( IOPMPowerFlags, IOPowerConnection *, unsigned long );
-    virtual void handleSleepTimerExpiration ( void );
-    void stopIgnoringClamshellEventsDuringWakeup ( void );
-    void wakeFromDoze( void );
-    void publishFeature( const char *feature );
+    void        handleOurPowerChangeStart(
+                    IOService *     service,
+                    IOPMActions *   actions,
+                    uint32_t        powerState,
+                    uint32_t *      inOutChangeFlags );
+
+    void        handleOurPowerChangeDone(
+                    IOService *     service,
+                    IOPMActions *   actions,
+                    uint32_t        powerState,
+                    uint32_t        changeFlags );
+
+    void        overridePowerChangeForUIService(
+                    IOService *     service,
+                    IOPMActions *   actions,
+                    unsigned long * inOutPowerState,
+                    uint32_t *      inOutChangeFlags );
+
+    void        handleActivityTickleForDisplayWrangler(
+                    IOService *     service,
+                    IOPMActions *   actions );
+
+    bool        shouldDelayChildNotification(
+                    IOService * service );
+
+    void        handlePowerChangeStartForPCIDevice(
+                    IOService *     service,
+                    IOPMActions *   actions, 
+                    uint32_t        powerState,
+                    uint32_t *      inOutChangeFlags );
+
+    void        handlePowerChangeDoneForPCIDevice(
+                    IOService *     service,
+                    IOPMActions *   actions, 
+                    uint32_t        powerState,
+                    uint32_t        changeFlags );
+
+    void        askChangeDownDone(
+                    IOPMPowerChangeFlags * inOutChangeFlags,
+                    bool * cancel );
+
+    void        handlePublishSleepWakeUUID(
+                    bool shouldPublish);
+
+    void        handleQueueSleepWakeUUID(
+                    OSObject *obj);
+
+    void        handleSuspendPMNotificationClient(
+                    uint32_t pid, bool doSuspend);
+
+    IOReturn    setMaintenanceWakeCalendar(
+                    const IOPMCalendarStruct * calendar );
+
+    // Handle callbacks from IOService::systemWillShutdown()
+       void        acknowledgeSystemWillShutdown( IOService * from );
+
+    // Handle platform halt and restart notifications
+       void        handlePlatformHaltRestart( UInt32 pe_type );
+
+    IOReturn    shutdownSystem( void );
+    IOReturn    restartSystem( void );
+    void        handleSleepTimerExpiration( void );
+
+    bool        activitySinceSleep(void);
+    bool        abortHibernation(void);
+
+    IOReturn    joinAggressiveness( IOService * service );
+    void        handleAggressivesRequests( void );
+
+    void        tracePoint( uint8_t point );
+    void        tracePoint( uint8_t point, uint8_t data );
+    void        traceDetail( uint32_t data32 );
+
+    bool        systemMessageFilter(
+                    void * object, void * arg1, void * arg2, void * arg3 );
+
+    void        updatePreventIdleSleepList(
+                    IOService * service, bool addNotRemove );
+    void        updatePreventSystemSleepList(
+                    IOService * service, bool addNotRemove );
+
+    void        publishPMSetting(
+                    const OSSymbol * feature, uint32_t where, uint32_t * featureID );
+
+/*! @function recordPMEvent
+    @abstract Logs IOService PM event timing.
+    @discussion Should only be called from IOServicePM. Should not be exported.
+    @result kIOReturn on success.
+*/
+    IOReturn    recordPMEvent( PMEventDetails *details );
+    IOReturn    recordAndReleasePMEvent( PMEventDetails *details );
+    IOReturn    recordPMEventGated( PMEventDetails *details );
+    IOReturn    recordAndReleasePMEventGated( PMEventDetails *details );
+
+    void        pmStatsRecordEvent(
+                                int             eventIndex,
+                                AbsoluteTime    timestamp);
+
+    void        pmStatsRecordApplicationResponse(
+                                const OSSymbol         *response,
+                                const char                 *name,
+                                int                 messageType,
+                                uint32_t                       delay_ms,
+                                int                            app_pid);
+
+
+/*! @function   suspendPMNotificationsForPID
+    @abstract   kernel process management calls this to disable sleep/wake notifications
+                when a process is suspended.
+    @param      pid the process ID
+    @param      doSuspend true suspends the notifications; false enables them
+*/
+    void        suspendPMNotificationsForPID( uint32_t pid, bool doSuspend);
+
+/*! @function   pmNotificationIsSuspended
+    @abstract   returns true if PM notifications have been suspended
+    @param      pid the process ID
+    @result     true if the process has been suspended
+*/
+    bool        pmNotificationIsSuspended( uint32_t pid );
+
+
+#if HIBERNATION
+    bool        getHibernateSettings(
+                    uint32_t *  hibernateMode,
+                    uint32_t *  hibernateFreeRatio,
+                    uint32_t *  hibernateFreeTime );
+#endif

 
 private:
 
 private:

+    friend class PMSettingObject;
+    friend class RootDomainUserClient;
+    friend class PMAssertionsTracker;

 
 

-    class IORootParent * patriarch;                    // points to our parent
-    long               sleepSlider;                    // pref: idle time before idle sleep
-    long               longestNonSleepSlider;          // pref: longest of other idle times
-    long               extraSleepDelay;                // sleepSlider - longestNonSleepSlider
-    thread_call_t      extraSleepTimer;                // used to wait between say display idle and system idle
-    thread_call_t   clamshellWakeupIgnore;   // Used to ignore clamshell close events while we're waking from sleep
-    
-    virtual void powerChangeDone ( unsigned long );
-    virtual void command_received ( void *, void * , void * , void *);
-    virtual bool tellChangeDown ( unsigned long stateNum);
-    virtual bool askChangeDown ( unsigned long stateNum);
-    virtual void tellChangeUp ( unsigned long );
-    virtual void tellNoChangeDown ( unsigned long );
-    void reportUserInput ( void );

     static IOReturn sysPowerDownHandler( void * target, void * refCon,
                                     UInt32 messageType, IOService * service,
                                     void * messageArgument, vm_size_t argSize );
     static IOReturn sysPowerDownHandler( void * target, void * refCon,
                                     UInt32 messageType, IOService * service,
                                     void * messageArgument, vm_size_t argSize );


@@ -97,51 +476,261 @@ private:
                                     UInt32 messageType, IOService * service,
                                     void * messageArgument, vm_size_t argSize );
 
                                     UInt32 messageType, IOService * service,
                                     void * messageArgument, vm_size_t argSize );
 

-    static bool displayWranglerPublished( void * target, void * refCon,
-                                    IOService * newService);
+    static IOReturn rootBusyStateChangeHandler( void * target, void * refCon,
+                                    UInt32 messageType, IOService * service,
+                                    void * messageArgument, vm_size_t argSize );
+
+    static bool displayWranglerMatchPublished( void * target, void * refCon,
+                                    IOService * newService,
+                                    IONotifier * notifier);

 
 

-    void setQuickSpinDownTimeout ( void );
-    void adjustPowerState( void );
-    void restoreUserSpinDownTimeout ( void );
+    static bool batteryPublished( void * target, void * refCon,
+                                    IOService * resourceService,
+                                    IONotifier * notifier);

 
 

+    IOService *             wrangler;
+
+    IOLock                  *featuresDictLock;  // guards supportedFeatures
+    IOPMPowerStateQueue     *pmPowerStateQueue;
+
+    OSArray                 *allowedPMSettings;
+    OSArray                 *noPublishPMSettings;
+    PMTraceWorker           *pmTracer;
+    PMAssertionsTracker     *pmAssertions;
+
+    // Settings controller info
+    IOLock                  *settingsCtrlLock;  
+    OSDictionary            *settingsCallbacks;
+    OSDictionary            *fPMSettingsDict;
+
+    IONotifier              *_batteryPublishNotifier;
+    IONotifier              *_displayWranglerNotifier;
+
+    // Statistics
+    const OSSymbol          *_statsNameKey;
+    const OSSymbol          *_statsPIDKey;
+    const OSSymbol          *_statsTimeMSKey;
+    const OSSymbol          *_statsResponseTypeKey;
+    const OSSymbol          *_statsMessageTypeKey;

     
     

-    unsigned int user_spindown;       // User's selected disk spindown value
-
-    unsigned int systemBooting:1;
-    unsigned int ignoringClamshell:1;
-    unsigned int allowSleep:1;
-    unsigned int sleepIsSupported:1;
-    unsigned int canSleep:1;
-    unsigned int idleSleepPending:1;
-    unsigned int sleepASAP:1;
-    unsigned int desktopMode:1;
-
-    unsigned int acAdaptorConnect:1;
-    unsigned int ignoringClamshellDuringWakeup:1;
-    unsigned int reservedA:6;
-    unsigned char reservedB[3];
-
-    thread_call_t diskSyncCalloutEntry;
-    IOOptionBits platformSleepSupport;
+    OSString                *queuedSleepWakeUUIDString;
+    OSArray                 *pmStatsAppResponses;
+
+    bool                    uuidPublished;
+
+    // Pref: idle time before idle sleep
+    unsigned long           sleepSlider;               
+    unsigned long           idleSeconds;
+    uint64_t                autoWakeStart;
+    uint64_t                autoWakeEnd;
+
+    // Difference between sleepSlider and longestNonSleepSlider
+    unsigned long           extraSleepDelay;           
+
+    // Used to wait between say display idle and system idle
+    thread_call_t           extraSleepTimer;
+    thread_call_t           diskSyncCalloutEntry;
+
+    // IOPMActions parameter encoding
+    enum {
+        kPMActionsFlagIsDisplayWrangler = 0x00000001,
+        kPMActionsFlagIsGraphicsDevice  = 0x00000002,
+        kPMActionsFlagIsAudioDevice     = 0x00000004,
+        kPMActionsFlagLimitPower        = 0x00000008,
+        kPMActionsPCIBitNumberMask      = 0x000000ff  
+    };
+
+    // Track system capabilities.
+    uint32_t                _desiredCapability;
+    uint32_t                _currentCapability;
+    uint32_t                _pendingCapability;
+    uint32_t                _highestCapability;
+    OSSet *                 _joinedCapabilityClients;
+    uint32_t                _systemStateGeneration;
+
+    // Type of clients that can receive system messages.
+    enum {
+        kSystemMessageClientConfigd   = 0x01,
+        kSystemMessageClientApp       = 0x02,
+        kSystemMessageClientUser      = 0x03,
+        kSystemMessageClientKernel    = 0x04,
+        kSystemMessageClientAll       = 0x07
+    };
+    uint32_t                _systemMessageClientMask;
+
+    // Power state and capability change transitions.
+    enum {
+        kSystemTransitionNone         = 0,
+        kSystemTransitionSleep        = 1,
+        kSystemTransitionWake         = 2,
+        kSystemTransitionCapability   = 3,
+        kSystemTransitionNewCapClient = 4
+    }                       _systemTransitionType;
+
+    unsigned int            systemBooting           :1;
+    unsigned int            systemShutdown          :1;
+    unsigned int            systemDarkWake          :1;
+    unsigned int            clamshellExists         :1;
+    unsigned int            clamshellClosed         :1;
+    unsigned int            clamshellDisabled       :1;
+    unsigned int            desktopMode             :1;
+    unsigned int            acAdaptorConnected      :1;
+
+    unsigned int            idleSleepTimerPending   :1;
+    unsigned int            userDisabledAllSleep    :1;
+    unsigned int            ignoreTellChangeDown    :1;
+    unsigned int            wranglerAsleep          :1;
+    unsigned int            wranglerTickled         :1;
+    unsigned int            wranglerSleepIgnored    :1;
+    unsigned int            graphicsSuppressed      :1;
+    unsigned int            darkWakeThermalAlarm    :1;
+
+    unsigned int            capabilityLoss          :1;
+    unsigned int            pciCantSleepFlag        :1;
+    unsigned int            pciCantSleepValid       :1;
+    unsigned int            logWranglerTickle       :1;
+    unsigned int            logGraphicsClamp        :1;
+    unsigned int            darkWakeToSleepASAP     :1;
+    unsigned int            darkWakeMaintenance     :1;
+    unsigned int            darkWakeSleepService    :1;
+
+    unsigned int            darkWakePostTickle      :1;
+    unsigned int            sleepTimerMaintenance   :1;
+    unsigned int            lowBatteryCondition     :1;
+    unsigned int            darkWakeThermalEmergency:1;
+    unsigned int            hibernateDisabled       :1;
+    unsigned int            hibernateNoDefeat       :1;
+    unsigned int            rejectWranglerTickle    :1;
+    unsigned int            wranglerTickleLatched   :1;
+
+    uint32_t                hibernateMode;
+    uint32_t                userActivityCount;
+    uint32_t                userActivityAtSleep;
+    uint32_t                lastSleepReason;
+    uint32_t                hibernateAborted;
+
+    // Info for communicating system state changes to PMCPU
+    int32_t                 idxPMCPUClamshell;
+    int32_t                 idxPMCPULimitedPower;
+
+    IOOptionBits            platformSleepSupport;
+    uint32_t                _debugWakeSeconds;
+    uint32_t                _lastDebugWakeSeconds;
+
+    queue_head_t            aggressivesQueue;
+    thread_call_t           aggressivesThreadCall;
+    OSData *                aggressivesData;
+
+    AbsoluteTime            wranglerSleepTime;
+    AbsoluteTime            systemWakeTime;
+
+    // PCI top-level PM trace
+    IOService *             pciHostBridgeDevice;
+    IOService *             pciHostBridgeDriver;
+
+    IONotifier *            systemCapabilityNotifier;
+
+    IOPMTimeline            *timeline;
+
+    typedef struct {
+        uint32_t            pid;
+        uint32_t            refcount;
+    } PMNotifySuspendedStruct;
+    
+    uint32_t                pmSuspendedCapacity;    
+    uint32_t                pmSuspendedSize;
+    PMNotifySuspendedStruct *pmSuspendedPIDS;
+
+    OSSet *                 preventIdleSleepList;
+    OSSet *                 preventSystemSleepList;
+
+    UInt32                  _scheduledAlarms;
+
+#if HIBERNATION
+    clock_sec_t             _standbyTimerResetSeconds;
+#endif
+
+    int         findSuspendedPID(uint32_t pid, uint32_t *outRefCount);
+
+       // IOPMrootDomain internal sleep call
+    IOReturn    privateSleepSystem( uint32_t sleepReason );
+    void        reportUserInput( void );
+    bool        checkSystemCanSleep( IOOptionBits options = 0 );
+    bool        checkSystemCanSustainFullWake( void );
+
+    void        adjustPowerState( bool sleepASAP = false );
+    void        setQuickSpinDownTimeout( void );
+    void        restoreUserSpinDownTimeout( void );
+
+    bool        shouldSleepOnClamshellClosed(void );
+    void        sendClientClamshellNotification( void );
+
+    // Inform PMCPU of changes to state like lid, AC vs. battery
+    void        informCPUStateChange( uint32_t type, uint32_t value );
+
+    void        dispatchPowerEvent( uint32_t event, void * arg0, uint64_t arg1 );
+    void        handlePowerNotification( UInt32 msg );
+
+    IOReturn    setPMSetting(const OSSymbol *, OSObject *);
+
+    void        startIdleSleepTimer( uint32_t inSeconds );
+    void        cancelIdleSleepTimer( void );
+
+    IOReturn    setAggressiveness(
+                        unsigned long type,
+                        unsigned long value,
+                        IOOptionBits  options );
+
+    void        synchronizeAggressives(
+                        queue_head_t * services,
+                        const AggressivesRecord * array,
+                        int count );
+
+    void        broadcastAggressives(
+                        const AggressivesRecord * array,
+                        int count );
+
+    // getPMTraceMemoryDescriptor should only be called by our friend RootDomainUserClient
+    IOMemoryDescriptor *getPMTraceMemoryDescriptor(void);
+
+    IOReturn    setPMAssertionUserLevels(IOPMDriverAssertionType);
+
+    void        publishSleepWakeUUID( bool shouldPublish );
+
+    void        evaluatePolicy( int stimulus, uint32_t arg = 0 );
+
+    void evaluateAssertions(IOPMDriverAssertionType newAssertions, 
+                                IOPMDriverAssertionType oldAssertions);
+
+    void        deregisterPMSettingObject( PMSettingObject * pmso );
+
+#if HIBERNATION
+    bool        getSleepOption( const char * key, uint32_t * option );
+    bool        evaluateSystemSleepPolicy( IOPMSystemSleepParameters * p, int phase );
+    void        evaluateSystemSleepPolicyEarly( void );
+    void        evaluateSystemSleepPolicyFinal( void );
+#endif /* HIBERNATION */
+
+    bool        latchDisplayWranglerTickle( bool latch );
+#endif /* XNU_KERNEL_PRIVATE */

 };
 
 };
 

+#ifdef XNU_KERNEL_PRIVATE

 class IORootParent: public IOService
 {
 class IORootParent: public IOService
 {

-OSDeclareDefaultStructors(IORootParent)
+    OSDeclareFinalStructors(IORootParent)

 
 

-private:
-    unsigned long mostRecentChange;
-    

 public:
 public:

-
-    bool start ( IOService * nub );
-    void shutDownSystem ( void );
-    void restartSystem ( void );
-    void sleepSystem ( void );
-    void dozeSystem ( void );
-    void sleepToDoze ( void );
-    void wakeSystem ( void );
+    static void initialize( void );
+    virtual OSObject * copyProperty( const char * aKey ) const;
+    bool start( IOService * nub );
+    void shutDownSystem( void );
+    void restartSystem( void );
+    void sleepSystem( void );
+    void dozeSystem( void );
+    void sleepToDoze( void );
+    void wakeSystem( void );

 };
 };

+#endif /* XNU_KERNEL_PRIVATE */

 
 

-
-#endif /*  _IOKIT_ROOTDOMAIN_H */
+#endif /* _IOKIT_ROOTDOMAIN_H */