xnu-792.25.20.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 8984051feb12bb59518de15961970c2c1af283f7..2da2b1dc2470c6f834cb4c3a59baee2a002fa460 100644 (file)
--- a/iokit/IOKit/pwr_mgt/RootDomain.h
+++ b/iokit/IOKit/pwr_mgt/RootDomain.h
@@ -25,11 +25,10 @@
 #include <IOKit/IOService.h>
 #include <IOKit/pwr_mgt/IOPM.h>
 
 #include <IOKit/IOService.h>
 #include <IOKit/pwr_mgt/IOPM.h>
 

+class IOPMWorkArbiter;

 class IOPMPowerStateQueue;
 class RootDomainUserClient;
 
 class IOPMPowerStateQueue;
 class RootDomainUserClient;
 

-#define kRootDomainSupportedFeatures "Supported Features"
-

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


@@ -37,31 +36,35 @@ enum {
     kPCICantSleep                      = 0x00000004
 };
 
     kPCICantSleep                      = 0x00000004
 };
 

-// Constants for use as arguments to the settings callback PMU/SMU defines
-// with registerPMSettingsController
+#define kRootDomainSupportedFeatures "Supported Features"
+
+// Supported Feature bitfields for IOPMrootDomain::publishFeature()

 enum {
 enum {

-    kIOPMAutoWakeSetting = 1,
-    kIOPMAutoPowerOnSetting,
-    kIOPMWakeOnRingSetting,
-    kIOPMAutoRestartOnPowerLossSetting,
-    kIOPMWakeOnLidSetting,
-    kIOPMWakeOnACChangeSetting,
-    kIOPMTimeZoneSetting
+    kIOPMSupportedOnAC = 1<<0,
+    kIOPMSupportedOnBatt = 1<<1,
+    kIOPMSupportedOnUPS = 1<<2

 };
 };

-typedef int IOPMSystemSettingType;
-

 
 

-
-typedef IOReturn (*IOPMSettingControllerCallback)(IOPMSystemSettingType arg_type, int arg_val, void *info);
+typedef IOReturn (*IOPMSettingControllerCallback) \
+                    (OSObject *target, const OSSymbol *type, \
+                     OSObject *val, uintptr_t refcon);

 
 extern "C"
 {
 
 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 );
+    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 );

 }
 
 #define IOPM_ROOTDOMAIN_REV            2
 }
 
 #define IOPM_ROOTDOMAIN_REV            2


@@ -73,6 +76,8 @@ OSDeclareDefaultStructors(IOPMrootDomain)
 public:
 
     class IOService * wrangler;                        // we tickle the wrangler on button presses, etc
 public:
 
     class IOService * wrangler;                        // we tickle the wrangler on button presses, etc

+    
+    IOPMWorkArbiter * getPMArbiter(void);

 
     static IOPMrootDomain * construct( void );
     virtual bool start( IOService * provider );
 
     static IOPMrootDomain * construct( void );
     virtual bool start( IOService * provider );


@@ -90,24 +95,95 @@ public:
     void stopIgnoringClamshellEventsDuringWakeup ( void );
     void wakeFromDoze( void );
     void broadcast_it (unsigned long, unsigned long );
     void stopIgnoringClamshellEventsDuringWakeup ( void );
     void wakeFromDoze( void );
     void broadcast_it (unsigned long, unsigned long );

+
+    // KEXT driver announces support of power management feature

     void publishFeature( const char *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 );
+

     void unIdleDevice( IOService *, unsigned long );
     void announcePowerSourceChange( void );
     void unIdleDevice( IOService *, unsigned long );
     void announcePowerSourceChange( void );

-        
+

     // Override of these methods for logging purposes.
     virtual IOReturn changePowerStateTo ( unsigned long ordinal );
     virtual IOReturn changePowerStateToPriv ( unsigned long ordinal );
 
     // Override of these methods for logging purposes.
     virtual IOReturn changePowerStateTo ( unsigned long ordinal );
     virtual IOReturn changePowerStateToPriv ( unsigned long ordinal );
 

-    IOReturn registerPMSettingController(IOPMSettingControllerCallback, void *);
+/*! @function copyPMSetting
+    @abstract Copy the current value for a PM setting. Returns 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

 
 private:
 
 
 private:
 

-    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
+    // Points to our parent
+    class IORootParent * patriarch;
+
+    // Pref: idle time before idle sleep
+    long               sleepSlider;                    
+
+    // Pref: longest of other idle times (disk and display)
+    long               longestNonSleepSlider;          
+
+    // Difference between sleepSlider and longestNonSleepSlider
+    long               extraSleepDelay;                
+
+    // Used to wait between say display idle and system idle
+    thread_call_t      extraSleepTimer;                
+
+    // Used to ignore clamshell close events while we're waking from sleep
+    thread_call_t   clamshellWakeupIgnore;   

     
     virtual void powerChangeDone ( unsigned long );
     virtual void command_received ( void *, void * , void * , void *);
     
     virtual void powerChangeDone ( unsigned long );
     virtual void command_received ( void *, void * , void * , void *);


@@ -127,18 +203,26 @@ private:
     static bool displayWranglerPublished( void * target, void * refCon,
                                     IOService * newService);
 
     static bool displayWranglerPublished( void * target, void * refCon,
                                     IOService * newService);
 

-    static bool batteryLocationPublished( void * target, void * refCon,
+    static bool batteryPublished( void * target, void * refCon,

                                     IOService * resourceService );
 
                                     IOService * resourceService );
 

+    void adjustPowerState ( void );

     void setQuickSpinDownTimeout ( void );
     void setQuickSpinDownTimeout ( void );

-    void adjustPowerState( void );

     void restoreUserSpinDownTimeout ( void );
     void restoreUserSpinDownTimeout ( void );

-
+    
+    bool shouldSleepOnClamshellClosed (void );
+    void sendClientClamshellNotification ( void );
+    

     IOLock                  *featuresDictLock;  // guards supportedFeatures
     IOPMPowerStateQueue     *pmPowerStateQueue;
     IOLock                  *featuresDictLock;  // guards supportedFeatures
     IOPMPowerStateQueue     *pmPowerStateQueue;

+    
+    IOWorkLoop              *arbiterWorkLoop;
+    IOPMWorkArbiter         *pmArbiter;
+    

     unsigned int user_spindown;       // User's selected disk spindown value
 
     unsigned int systemBooting:1;
     unsigned int user_spindown;       // User's selected disk spindown value
 
     unsigned int systemBooting:1;

+    unsigned int systemShutdown:1;

     unsigned int ignoringClamshell:1;
     unsigned int allowSleep:1;
     unsigned int sleepIsSupported:1;
     unsigned int ignoringClamshell:1;
     unsigned int allowSleep:1;
     unsigned int sleepIsSupported:1;


@@ -149,25 +233,29 @@ private:
 
     unsigned int acAdaptorConnect:1;
     unsigned int ignoringClamshellDuringWakeup:1;
 
     unsigned int acAdaptorConnect:1;
     unsigned int ignoringClamshellDuringWakeup:1;

-    unsigned int reservedA:6;
+    unsigned int clamshellIsClosed:1;
+    unsigned int clamshellExists:1;
+    unsigned int reservedA:4;

     unsigned char reservedB[3];
     
     unsigned char reservedB[3];
     

-    struct PMSettingCtrl {
-        IOPMSettingControllerCallback       func;
-        void                                *refcon;
-    };
+    OSArray         *allowedPMSettings;
+    
+    // Settings controller info
+    IORecursiveLock        *settingsCtrlLock;  
+    OSDictionary           *settingsCallbacks;
+    OSDictionary           *fPMSettingsDict;
+    IOReturn setPMSetting(const OSSymbol *, OSObject *);
+
+    thread_call_t           diskSyncCalloutEntry;
+    IONotifier              *_batteryPublishNotifier;
+    IONotifier              *_displayWranglerNotifier;

 
 

-    // Private helper to call PM setting controller
-    IOReturn setPMSetting(int type, OSNumber *);
- 

     struct ExpansionData {    
     struct ExpansionData {    

-        PMSettingCtrl           *_settingController;
-        thread_call_t           diskSyncCalloutEntry;
-        IONotifier              *_batteryLocationNotifier;
-        IONotifier              *_displayWranglerNotifier;

     };
     ExpansionData   *_reserved;
     IOOptionBits platformSleepSupport;
     };
     ExpansionData   *_reserved;
     IOOptionBits platformSleepSupport;

+    
+    friend class PMSettingObject;

 };
 
 class IORootParent: public IOService
 };
 
 class IORootParent: public IOService


@@ -179,6 +267,8 @@ private:
     
 public:
 
     
 public:
 

+    virtual IOReturn changePowerStateToPriv ( unsigned long ordinal );
+

     bool start ( IOService * nub );
     void shutDownSystem ( void );
     void restartSystem ( void );
     bool start ( IOService * nub );
     void shutDownSystem ( void );
     void restartSystem ( void );