xnu-1699.32.7.tar.gz

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

diff --git a/iokit/IOKit/pwr_mgt/IOPM.h b/iokit/IOKit/pwr_mgt/IOPM.h
index 0e5ac04f45e0e12891a2c05daf3918f2c4bde098..4bdddb751ebe3b03c48ac49f7e3d464757bbdf83 100644 (file)
--- a/iokit/IOKit/pwr_mgt/IOPM.h
+++ b/iokit/IOKit/pwr_mgt/IOPM.h
@@ -32,67 +32,118 @@
 #include <IOKit/IOMessage.h>
 #include <IOKit/IOReturn.h>
 
 #include <IOKit/IOMessage.h>
 #include <IOKit/IOReturn.h>
 

-#ifdef __ppc__
-#include <IOKit/pwr_mgt/IOPMDeprecated.h>
-#endif
-
+/*! @header IOPM.h
+    @abstract Defines power management constants and keys used by both in-kernel and user space power management.
+    @discussion IOPM.h defines a range of power management constants used in several in-kernel and user space APIs. Most significantly, the IOPMPowerFlags used to specify the fields of an IOPMPowerState struct are defined here.

 
 

+    Most of the constants defined in IOPM.h are deprecated or for Apple internal use only, and are not elaborated on in headerdoc.
+*/

 
 enum {
     kIOPMMaxPowerStates = 10,
     IOPMMaxPowerStates = kIOPMMaxPowerStates
 };
 
 
 enum {
     kIOPMMaxPowerStates = 10,
     IOPMMaxPowerStates = kIOPMMaxPowerStates
 };
 

+/*! @enum IOPMPowerFlags
+    @abstract Bits are used in defining capabilityFlags, inputPowerRequirements, and outputPowerCharacter in the IOPMPowerState structure.
+    @discussion These bits may be bitwise-OR'd together in the IOPMPowerState capabilityFlags field, the outputPowerCharacter field, and/or the inputPowerRequirement field. 
+    
+    The comments clearly mark whether each flag should be used in the capabilityFlags field, outputPowerCharacter field, and inputPowerRequirement field, or all three.
+    
+    The value of capabilityFlags, inputPowerRequirement or outputPowerCharacter may be 0. Most drivers implement their 'OFF' state, used when asleep, by defininf each of the 3 fields as 0.
+    
+    The bits listed below are only the most common bits used to define a device's power states. Your device's IO family may require that your device specify other input or output power flags to interact properly. Consult family-specific documentation to determine if your IOPower plane parents or children require other power flags; they probably don't.
+
+    @constant kIOPMPowerOn Indicates the device is on, requires power, and provides power. Useful as a: Capability, InputPowerRequirement, OutputPowerCharacter
+
+    @constant kIOPMDeviceUsable Indicates the device is usable in this state. Useful only as a Capability
+
+    @constant kIOPMLowPower 
+    Indicates device is in a low power state. May be bitwis-OR'd together
+    with kIOPMDeviceUsable flag, to indicate the device is still usable.
+    
+    A device with a capability of kIOPMLowPower may:
+       Require either 0 or kIOPMPowerOn from its power parent
+       Offer either kIOPMLowPower, kIOPMPowerOn, or 0 (no power at all)
+         to its power plane children.
+
+    Useful only as a Capability, although USB drivers should consult USB family documentation for other valid circumstances to use the kIOPMLowPower bit.
+
+    @constant kIOPMPreventIdleSleep
+    In the capability field of a power state, disallows idle system sleep while the device is in that state.
+    
+    For example, displays and disks set this capability for their ON power state; since the system may not idle sleep while the display (and thus keyboard or mouse) or the disk is active.
+
+    Useful only as a Capability.
+    
+    @constant kIOPMSleepCapability
+    Used only by certain IOKit Families (USB). Not defined or used by generic Power Management. Read your family documentation to see if you should define a powerstate using these capabilities.
+    
+    @constant kIOPMRestartCapability
+    Used only by certain IOKit Families (USB). Not defined or used by generic Power Management. Read your family documentation to see if you should define a powerstate using these capabilities.
+    
+    @constant kIOPMSleep
+    Used only by certain IOKit Families (USB). Not defined or used by generic Power Management. Read your family documentation to see if you should define a powerstate using these capabilities.
+
+    @constant kIOPMRestart
+    Used only by certain IOKit Families (USB). Not defined or used by generic Power Management. Read your family documentation to see if you should define a powerstate using these capabilities.
+
+    @constant kIOPMInitialDeviceState
+    Indicates the initial power state for the device. If <code>initialPowerStateForDomainState()</code> returns a power state with this flag set in the capability field, then the initial power change is performed without calling the driver's <code>setPowerState()</code>.
+*/

 typedef unsigned long IOPMPowerFlags;
 enum {
 typedef unsigned long IOPMPowerFlags;
 enum {

-    // The following  bits are used in the input and output power fields.
+    kIOPMPowerOn                    = 0x00000002,
+    kIOPMDeviceUsable               = 0x00008000,
+    kIOPMLowPower                   = 0x00010000,
+    kIOPMPreventIdleSleep           = 0x00000040,
+    kIOPMSleepCapability            = 0x00000004,
+    kIOPMRestartCapability          = 0x00000080,
+    kIOPMSleep                      = 0x00000001,
+    kIOPMRestart                    = 0x00000080,
+    kIOPMInitialDeviceState         = 0x00000100
+};
+
+/*
+ * Private IOPMPowerFlags
+ *
+ * For Apple use only
+ * Not for use with non-Apple drivers
+ * Their behavior is undefined
+ */
+enum {

     kIOPMClockNormal                = 0x0004,
     kIOPMClockRunning               = 0x0008,
     kIOPMClockNormal                = 0x0004,
     kIOPMClockRunning               = 0x0008,

-    // Reserved - Used only between root and root parent.
-    kIOPMAuxPowerOn                 = 0x0020,
-    // Reserved - kIOPMPagingAvailable used only by now-defunct paging plexus
-    kIOPMPagingAvailable            = 0x0020,
-    kIOPMPassThrough                = 0x0100,
-    kIOPMDoze                       = 0x0400,
-    // Obsolete - use kIOPMDoze instead of kIOPMSoftSleep
-    kIOPMSoftSleep                  = 0x0400,
-    kIOPMSleep                      = 0x0001,
-    kIOPMRestart                    = 0x0080,
-
-    // The following bits are used in the capabilites field and the power fields
-    kIOPMPowerOn                    = 0x0002,

     kIOPMPreventSystemSleep         = 0x0010,
     kIOPMPreventSystemSleep         = 0x0010,

-    kIOPMPreventIdleSleep           = 0x0040,
-
-    // The following  bits are used in the capabilites field only.
-    // Used between a driver and its policy-maker
-    kIOPMNotAttainable              = 0x0001,
-    // Used internally in a power domain parent
+    kIOPMDoze                       = 0x0400,

     kIOPMChildClamp                 = 0x0080,
     kIOPMChildClamp                 = 0x0080,

-    // Used internally in a power domain parent

     kIOPMChildClamp2                = 0x0200,
     kIOPMChildClamp2                = 0x0200,

-    // Marks device as usable in this state
-    kIOPMDeviceUsable               = 0x8000,
-    // Device runs at max performance in this state
+    kIOPMNotPowerManaged            = 0x0800
+};
+
+/*
+ * Deprecated IOPMPowerFlags
+ * Their behavior is undefined when used in IOPMPowerState
+ * Capability, InputPowerRequirement, or OutputPowerCharacter fields.
+ */
+enum {

     kIOPMMaxPerformance             = 0x4000,
     kIOPMMaxPerformance             = 0x4000,

+    kIOPMPassThrough                = 0x0100,
+    kIOPMAuxPowerOn                 = 0x0020,
+    kIOPMNotAttainable              = 0x0001,

     kIOPMContextRetained            = 0x2000,
     kIOPMConfigRetained             = 0x1000,
     kIOPMContextRetained            = 0x2000,
     kIOPMConfigRetained             = 0x1000,

-    // Device is capable of system sleep in this state
-    kIOPMSleepCapability            = 0x0004,
-    kIOPMRestartCapability          = 0x0080,
-
-    // Reserved - Error code. (this is an error return rather than a bit)
-    kIOPMNotPowerManaged            = 0x0800,
-    // Therefore this bit safely overloads it

     kIOPMStaticPowerValid           = 0x0800,
     kIOPMStaticPowerValid           = 0x0800,

-    
+    kIOPMSoftSleep                  = 0x0400,

     kIOPMCapabilitiesMask =     kIOPMPowerOn | kIOPMDeviceUsable | 
                                 kIOPMMaxPerformance | kIOPMContextRetained | 
                                 kIOPMConfigRetained | kIOPMSleepCapability |
                                 kIOPMRestartCapability
 };
 
     kIOPMCapabilitiesMask =     kIOPMPowerOn | kIOPMDeviceUsable | 
                                 kIOPMMaxPerformance | kIOPMContextRetained | 
                                 kIOPMConfigRetained | kIOPMSleepCapability |
                                 kIOPMRestartCapability
 };
 

-
+/*
+ * Support for old names of IOPMPowerFlag constants
+ */

 enum {
     IOPMNotAttainable           = kIOPMNotAttainable,
     IOPMPowerOn                 = kIOPMPowerOn,
 enum {
     IOPMNotAttainable           = kIOPMNotAttainable,
     IOPMPowerOn                 = kIOPMPowerOn,


@@ -104,7 +155,6 @@ enum {
     IOPMContextRetained         = kIOPMContextRetained,
     IOPMConfigRetained          = kIOPMConfigRetained,
     IOPMNotPowerManaged         = kIOPMNotPowerManaged,
     IOPMContextRetained         = kIOPMContextRetained,
     IOPMConfigRetained          = kIOPMConfigRetained,
     IOPMNotPowerManaged         = kIOPMNotPowerManaged,

-    IOPMPagingAvailable         = kIOPMPagingAvailable,

     IOPMSoftSleep               = kIOPMSoftSleep
 };
 
     IOPMSoftSleep               = kIOPMSoftSleep
 };
 


@@ -159,10 +209,137 @@ enum {
  */
 #define kAppleClamshellCausesSleepKey       "AppleClamshellCausesSleep"
 
  */
 #define kAppleClamshellCausesSleepKey       "AppleClamshellCausesSleep"
 

+/* kIOPMSleepWakeUUIDKey
+ * Key refers to a CFStringRef that will uniquely identify
+ * a sleep/wake cycle for logging & tracking.
+ * The key becomes valid at the beginning of a sleep cycle - before we
+ * initiate any sleep/wake notifications.
+ * The key becomes invalid at the completion of a system wakeup. The
+ * property will not be present in the IOPMrootDomain's registry entry
+ * when it is invalid.
+ * 
+ * See IOPMrootDomain notification kIOPMMessageSleepWakeUUIDChange
+ */
+ #define kIOPMSleepWakeUUIDKey              "SleepWakeUUID"
+
+/* kIOPMDeepSleepEnabledKey
+ * Indicates the Deep Sleep enable state.
+ * It has a boolean value.
+ *  true        == Deep Sleep is enabled
+ *  false       == Deep Sleep is disabled
+ *  not present == Deep Sleep is not supported on this hardware
+ */
+#define kIOPMDeepSleepEnabledKey            "Standby Enabled"
+
+/* kIOPMDeepSleepDelayKey
+ * Key refers to a CFNumberRef that represents the delay in seconds before
+ * entering Deep Sleep state. The property is not present if Deep Sleep is
+ * unsupported.
+ */
+#define kIOPMDeepSleepDelayKey              "Standby Delay"
+
+/* kIOPMDestroyFVKeyOnStandbyKey
+ * Specifies if FileVault key can be stored when going to standby mode
+ * It has a boolean value,
+ *  true        == Destroy FV key when going to standby mode
+ *  false       == Retain FV key when going to standby mode
+ *  not present == Retain FV key when going to standby mode
+ */
+#define kIOPMDestroyFVKeyOnStandbyKey       "DestroyFVKeyOnStandby"
+
+/*******************************************************************************
+ *
+ * Driver PM Assertions
+ *
+ ******************************************************************************/
+
+/* Driver Assertion bitfield description
+ * Driver PM assertions are defined by these bits.
+ */
+enum {
+    /*! kIOPMDriverAssertionCPUBit
+     * When set, PM kernel will prefer to leave the CPU and core hardware
+     * running in "Dark Wake" state, instead of sleeping.
+     */
+    kIOPMDriverAssertionCPUBit                      = 0x01,
+
+    /*! kIOPMDriverAssertionUSBExternalDeviceBit
+     * When set, driver is informing PM that an external USB device is attached.
+     */
+    kIOPMDriverAssertionUSBExternalDeviceBit        = 0x04,
+
+    /*! kIOPMDriverAssertionBluetoothHIDDevicePairedBit
+     * When set, driver is informing PM that a Bluetooth HID device is paired.
+     */
+    kIOPMDriverAssertionBluetoothHIDDevicePairedBit = 0x08,
+
+    /*! kIOPMDriverAssertionExternalMediaMountedBit
+     * When set, driver is informing PM that an external media is mounted.
+     */
+    kIOPMDriverAssertionExternalMediaMountedBit     = 0x10,
+
+    /*! kIOPMDriverAssertionReservedBit5
+     * Reserved for Thunderbolt.
+     */
+    kIOPMDriverAssertionReservedBit5                = 0x20,
+
+    /*! kIOPMDriverAssertionPreventDisplaySleepBit
+     * When set, the display should remain powered on while the system's awake.
+     */
+    kIOPMDriverAssertionPreventDisplaySleepBit      = 0x40,
+
+    /*! kIOPMDriverAssertionReservedBit7
+     * Reserved for storage family.
+     */
+    kIOPMDriverAssertionReservedBit7                = 0x80,
+
+    /*! kIOPMDriverAssertionReservedBit8
+     * Reserved for networking family.
+     */
+    kIOPMDriverAssertionReservedBit8                = 0x100
+};
+
+ /* kIOPMAssertionsDriverKey
+  * This kIOPMrootDomain key refers to a CFNumberRef property, containing
+  * a bitfield describing the aggregate PM assertion levels.
+  * Example: A value of 0 indicates that no driver has asserted anything.
+  * Or, a value of <link>kIOPMDriverAssertionCPUBit</link>
+  *   indicates that a driver (or drivers) have asserted a need fro CPU and video.
+  */
+#define kIOPMAssertionsDriverKey            "DriverPMAssertions"
+
+ /* kIOPMAssertionsDriverKey
+  * This kIOPMrootDomain key refers to a CFNumberRef property, containing
+  * a bitfield describing the aggregate PM assertion levels.
+  * Example: A value of 0 indicates that no driver has asserted anything.
+  * Or, a value of <link>kIOPMDriverAssertionCPUBit</link>
+  *   indicates that a driver (or drivers) have asserted a need fro CPU and video.
+  */
+#define kIOPMAssertionsDriverDetailedKey    "DriverPMAssertionsDetailed"
+
+/*******************************************************************************
+ *
+ * Kernel Driver assertion detailed dictionary keys
+ *
+ * Keys decode the Array & dictionary data structure under IOPMrootDomain property 
+ *  kIOPMAssertionsDriverKey.
+ *
+ */
+#define kIOPMDriverAssertionIDKey               "ID"
+#define kIOPMDriverAssertionCreatedTimeKey      "CreatedTime"
+#define kIOPMDriverAssertionModifiedTimeKey     "ModifiedTime"
+#define kIOPMDriverAssertionOwnerStringKey      "Owner"
+#define kIOPMDriverAssertionOwnerServiceKey     "ServicePtr"
+#define kIOPMDriverAssertionLevelKey            "Level"
+#define kIOPMDriverAssertionAssertedKey         "Assertions"
+

 /*******************************************************************************
  *
  * Root Domain general interest messages
  *
 /*******************************************************************************
  *
  * Root Domain general interest messages
  *

+ * Available by registering for interest type 'gIOGeneralInterest' 
+ * on IOPMrootDomain. 
+ *

  ******************************************************************************/
 
 /* kIOPMMessageClamshellStateChange
  ******************************************************************************/
 
 /* kIOPMMessageClamshellStateChange


@@ -201,17 +378,53 @@ enum {
     kInflowForciblyEnabledBit = (1 << 0)
 };
 
     kInflowForciblyEnabledBit = (1 << 0)
 };
 

+/* kIOPMMessageInternalBatteryFullyDischarged
+ * The battery has drained completely to its "Fully Discharged" state. 
+ */

 #define kIOPMMessageInternalBatteryFullyDischarged  \
                 iokit_family_msg(sub_iokit_powermanagement, 0x120)
 
 #define kIOPMMessageInternalBatteryFullyDischarged  \
                 iokit_family_msg(sub_iokit_powermanagement, 0x120)
 

+/* kIOPMMessageSystemPowerEventOccurred
+ * Some major system thermal property has changed, and interested clients may
+ * modify their behavior.
+ */
+#define kIOPMMessageSystemPowerEventOccurred  \
+                iokit_family_msg(sub_iokit_powermanagement, 0x130)
+
+/* kIOPMMessageSleepWakeUUIDChange
+ * Either a new SleepWakeUUID has been specified at the beginning of a sleep,
+ * or we're removing the existing property upon completion of a wakeup.
+ */
+#define kIOPMMessageSleepWakeUUIDChange  \
+                iokit_family_msg(sub_iokit_powermanagement, 0x140)
+                
+/* kIOPMMessageSleepWakeUUIDSet
+ * Argument accompanying the kIOPMMessageSleepWakeUUIDChange notification when 
+ * a new UUID has been specified.
+ */
+#define kIOPMMessageSleepWakeUUIDSet                    ((void *)1)
+
+/* kIOPMMessageSleepWakeUUIDCleared
+ * Argument accompanying the kIOPMMessageSleepWakeUUIDChange notification when 
+ * the current UUID has been removed.
+ */
+#define kIOPMMessageSleepWakeUUIDCleared                ((void *)0)
+
+/*! kIOPMMessageDriverAssertionsChanged
+ *  Sent when kernel PM driver assertions have changed.
+ */
+#define kIOPMMessageDriverAssertionsChanged  \
+                iokit_family_msg(sub_iokit_powermanagement, 0x150)

 
 /*******************************************************************************
  *
  * Power commands issued to root domain
 
 /*******************************************************************************
  *
  * Power commands issued to root domain

+ * Use with IOPMrootDomain::receivePowerNotification()

  *
  * These commands are issued from system drivers only:
  *      ApplePMU, AppleSMU, IOGraphics, AppleACPIFamily
  *
  *
  * These commands are issued from system drivers only:
  *      ApplePMU, AppleSMU, IOGraphics, AppleACPIFamily
  *

+ * TODO: deprecate kIOPMAllowSleep and kIOPMPreventSleep

  ******************************************************************************/
 enum {
   kIOPMSleepNow                 = (1<<0),  // put machine to sleep now
  ******************************************************************************/
 enum {
   kIOPMSleepNow                 = (1<<0),  // put machine to sleep now


@@ -227,6 +440,7 @@ enum {
   kIOPMClamshellOpened          = (1<<10)  // clamshell was opened
 };
 
   kIOPMClamshellOpened          = (1<<10)  // clamshell was opened
 };
 

+

 /*******************************************************************************
  *
  * Power Management Return Codes
 /*******************************************************************************
  *
  * Power Management Return Codes


@@ -234,25 +448,31 @@ enum {
  ******************************************************************************/
 enum {
     kIOPMNoErr                  = 0,
  ******************************************************************************/
 enum {
     kIOPMNoErr                  = 0,

-    // Returned by powerStateWillChange and powerStateDidChange:
-    // Immediate acknowledgement of power state change
+
+    // Returned by driver's setPowerState(), powerStateWillChangeTo(),
+    // powerStateDidChangeTo(), or acknowledgeSetPowerState() to
+    // implicitly acknowledge power change upon function return.

     kIOPMAckImplied             = 0,
     kIOPMAckImplied             = 0,

-    // Acknowledgement of power state change will come later 
+
+    // Deprecated

     kIOPMWillAckLater           = 1,
     kIOPMWillAckLater           = 1,

-    
-    // Returned by requestDomainState:
-    // Unrecognized specification parameter
+
+    // Returned by requestPowerDomainState() to indicate
+    // unrecognized specification parameter.

     kIOPMBadSpecification       = 4,
     kIOPMBadSpecification       = 4,

-    // No power state matches search specification
+
+    // Returned by requestPowerDomainState() to indicate
+    // no power state matches search specification.

     kIOPMNoSuchState            = 5,
     kIOPMNoSuchState            = 5,

-    
-    // Device cannot change its power for some reason
+
+    // Deprecated

     kIOPMCannotRaisePower       = 6,
     kIOPMCannotRaisePower       = 6,

-    
-  // Returned by changeStateTo:
-    // Requested state doesn't exist
+
+    // Deprecated

     kIOPMParameterError         = 7,
     kIOPMParameterError         = 7,

-    // Device not yet fully hooked into power management
+
+    // Returned when power management state is accessed
+    // before driver has called PMinit().

     kIOPMNotYetInitialized      = 8,
 
     // And the old constants; deprecated
     kIOPMNotYetInitialized      = 8,
 
     // And the old constants; deprecated


@@ -296,6 +516,20 @@ enum {
 #define kIOPMPSLegacyBatteryInfoKey                 "LegacyBatteryInfo"
 #define kIOPMPSBatteryHealthKey                     "BatteryHealth"
 #define kIOPMPSHealthConfidenceKey                  "HealthConfidence"
 #define kIOPMPSLegacyBatteryInfoKey                 "LegacyBatteryInfo"
 #define kIOPMPSBatteryHealthKey                     "BatteryHealth"
 #define kIOPMPSHealthConfidenceKey                  "HealthConfidence"

+#define kIOPMPSCapacityEstimatedKey                    "CapacityEstimated"
+#define kIOPMPSBatteryChargeStatusKey               "ChargeStatus"
+#define kIOPMPSBatteryTemperatureKey                "Temperature"
+#define kIOPMPSAdapterDetailsKey                   "AdapterDetails"
+#define kIOPMPSChargerConfigurationKey             "ChargerConfiguration"
+
+// kIOPMPSBatteryChargeStatusKey may have one of the following values, or may have
+// no value. If kIOPMBatteryChargeStatusKey has a NULL value (or no value) associated with it
+// then charge is proceeding normally. If one of these battery charge status reasons is listed,
+// then the charge may have been interrupted.
+#define kIOPMBatteryChargeStatusTooHot              "HighTemperature"
+#define kIOPMBatteryChargeStatusTooCold             "LowTemperature"
+#define kIOPMBatteryChargeStatusTooHotOrCold       "HighOrLowTemperature"
+#define kIOPMBatteryChargeStatusGradient            "BatteryTemperatureGradient"

 
 // Definitions for battery location, in case of multiple batteries.
 // A location of 0 is unspecified
 
 // Definitions for battery location, in case of multiple batteries.
 // A location of 0 is unspecified


@@ -314,6 +548,16 @@ enum {
     kIOPMGoodValue      = 3
 };
 
     kIOPMGoodValue      = 3
 };
 

+// Keys for kIOPMPSAdapterDetailsKey dictionary
+#define kIOPMPSAdapterDetailsIDKey                 "AdapterID"
+#define kIOPMPSAdapterDetailsWattsKey              "Watts"
+#define kIOPMPSAdapterDetailsRevisionKey           "AdapterRevision"
+#define kIOPMPSAdapterDetailsSerialNumberKey       "SerialNumber"
+#define kIOPMPSAdapterDetailsFamilyKey             "FamilyCode"
+#define kIOPMPSAdapterDetailsAmperageKey           "Amperage"
+#define kIOPMPSAdapterDetailsDescriptionKey        "Description"
+#define kIOPMPSAdapterDetailsPMUConfigurationKey    "PMUConfiguration"
+

 // Battery's time remaining estimate is invalid this long (seconds) after a wake
 #define kIOPMPSInvalidWakeSecondsKey           "BatteryInvalidWakeSeconds"
 
 // Battery's time remaining estimate is invalid this long (seconds) after a wake
 #define kIOPMPSInvalidWakeSecondsKey           "BatteryInvalidWakeSeconds"
 


@@ -326,6 +570,76 @@ enum {
 #define kIOPMPSPostDishargeWaitSecondsKey      "PostDischargeWaitSeconds"
 
 
 #define kIOPMPSPostDishargeWaitSecondsKey      "PostDischargeWaitSeconds"
 
 

+/* CPU Power Management status keys
+ * Pass as arguments to IOPMrootDomain::systemPowerEventOccurred
+ * Or as arguments to IOPMSystemPowerEventOccurred()
+ * Or to decode the dictionary obtained from IOPMCopyCPUPowerStatus()
+ * These keys reflect restrictions placed on the CPU by the system
+ * to bring the CPU's power consumption within allowable thermal and 
+ * power constraints.
+ */
+
+
+/* kIOPMGraphicsPowerLimitsKey
+ *   The key representing the dictionary of graphics power limits.
+ *   The dictionary contains the other kIOPMCPUPower keys & their associated
+ *   values (e.g. Speed limit, Processor Count, and Schedule limits).
+ */
+#define kIOPMGraphicsPowerLimitsKey                     "Graphics_Power_Limits"
+
+/* kIOPMGraphicsPowerLimitPerformanceKey
+ *   The key representing the percent of overall performance made available
+ *   by the graphics chip as a percentage (integer 0 - 100).
+ */
+#define kIOPMGraphicsPowerLimitPerformanceKey           "Graphics_Power_Performance"
+
+
+
+/* kIOPMCPUPowerLimitsKey
+ *   The key representing the dictionary of CPU Power Limits.
+ *   The dictionary contains the other kIOPMCPUPower keys & their associated
+ *   values (e.g. Speed limit, Processor Count, and Schedule limits).
+ */
+#define kIOPMCPUPowerLimitsKey                          "CPU_Power_Limits"
+
+/* kIOPMCPUPowerLimitProcessorSpeedKey defines the speed & voltage limits placed 
+ *   on the CPU.
+ *   Represented as a percentage (0-100) of maximum CPU speed.
+ */
+#define kIOPMCPUPowerLimitProcessorSpeedKey             "CPU_Speed_Limit"
+
+/* kIOPMCPUPowerLimitProcessorCountKey reflects how many, if any, CPUs have been
+ *   taken offline. Represented as an integer number of CPUs (0 - Max CPUs).
+ */
+#define kIOPMCPUPowerLimitProcessorCountKey             "CPU_Available_CPUs"
+
+/* kIOPMCPUPowerLimitSchedulerTimeKey represents the percentage (0-100) of CPU time 
+ *   available. 100% at normal operation. The OS may limit this time for a percentage
+ *   less than 100%.
+ */
+#define kIOPMCPUPowerLimitSchedulerTimeKey              "CPU_Scheduler_Limit"
+
+
+/* Thermal Level Warning Key
+ * Indicates the thermal constraints placed on the system. This value may 
+ * cause clients to action to consume fewer system resources.
+ * The value associated with this warning is defined by the platform.
+ */
+#define kIOPMThermalLevelWarningKey                     "Thermal_Level_Warning"
+
+/* Thermal Warning Level values
+ *      kIOPMThermalWarningLevelNormal - under normal operating conditions
+ *      kIOPMThermalWarningLevelDanger - thermal pressure may cause system slowdown
+ *      kIOPMThermalWarningLevelCrisis - thermal conditions may cause imminent shutdown
+ *
+ * The platform may define additional thermal levels if necessary.
+ */
+enum {
+  kIOPMThermalWarningLevelNormal    = 0,
+  kIOPMThermalWarningLevelDanger    = 5,
+  kIOPMThermalWarningLevelCrisis    = 10
+};
+

 
 // PM Settings Controller setting types
 // Settings types used primarily with:
 
 // PM Settings Controller setting types
 // Settings types used primarily with:


@@ -341,6 +655,7 @@ enum {
 #define kIOPMSettingDisplaySleepUsesDimKey          "Display Sleep Uses Dim"
 #define kIOPMSettingTimeZoneOffsetKey               "TimeZoneOffsetSeconds"
 #define kIOPMSettingMobileMotionModuleKey           "MobileMotionModule"
 #define kIOPMSettingDisplaySleepUsesDimKey          "Display Sleep Uses Dim"
 #define kIOPMSettingTimeZoneOffsetKey               "TimeZoneOffsetSeconds"
 #define kIOPMSettingMobileMotionModuleKey           "MobileMotionModule"

+#define kIOPMSettingGraphicsSwitchKey               "GPUSwitch"

 
 // Setting controlling drivers can register to receive scheduled wake data
 // Either in "CF seconds" type, or structured calendar data in a formatted
 
 // Setting controlling drivers can register to receive scheduled wake data
 // Either in "CF seconds" type, or structured calendar data in a formatted


@@ -355,6 +670,10 @@ enum {
 #define kIOPMSettingDebugWakeRelativeKey            "WakeRelativeToSleep"
 #define kIOPMSettingDebugPowerRelativeKey           "PowerRelativeToShutdown"
 
 #define kIOPMSettingDebugWakeRelativeKey            "WakeRelativeToSleep"
 #define kIOPMSettingDebugPowerRelativeKey           "PowerRelativeToShutdown"
 

+// Maintenance wake calendar.
+#define kIOPMSettingMaintenanceWakeCalendarKey      "MaintenanceWakeCalendarDate"
+
+

 struct IOPMCalendarStruct {
     UInt32      year;
     UInt8       month;
 struct IOPMCalendarStruct {
     UInt32      year;
     UInt8       month;


@@ -362,6 +681,7 @@ struct IOPMCalendarStruct {
     UInt8       hour;
     UInt8       minute;
     UInt8       second;
     UInt8       hour;
     UInt8       minute;
     UInt8       second;

+    UInt8       selector;

 };
 typedef struct IOPMCalendarStruct IOPMCalendarStruct;
 
 };
 typedef struct IOPMCalendarStruct IOPMCalendarStruct;
 


@@ -402,7 +722,6 @@ enum {
     kIOBatteryChargerConnect    = (1 << 0)
 };
 
     kIOBatteryChargerConnect    = (1 << 0)
 };
 

-

 // Private power management message indicating battery data has changed
 // Indicates new data resides in the IORegistry
 #define kIOPMMessageBatteryStatusHasChanged         iokit_family_msg(sub_iokit_pmu, 0x100)
 // Private power management message indicating battery data has changed
 // Indicates new data resides in the IORegistry
 #define kIOPMMessageBatteryStatusHasChanged         iokit_family_msg(sub_iokit_pmu, 0x100)


@@ -428,7 +747,6 @@ enum {
   kIOPMClamshellStateOnWake = (1<<10)     // used only by Platform Expert
 };
 
   kIOPMClamshellStateOnWake = (1<<10)     // used only by Platform Expert
 };
 

-

 // **********************************************
 // Internal power management data structures
 // **********************************************
 // **********************************************
 // Internal power management data structures
 // **********************************************


@@ -445,13 +763,14 @@ enum {
     kIOPMSuperclassPolicy1
 };
 
     kIOPMSuperclassPolicy1
 };
 

-struct stateChangeNote{
+struct stateChangeNote {

     IOPMPowerFlags    stateFlags;
     unsigned long    stateNum;
     void *         powerRef;
 };
 typedef struct stateChangeNote stateChangeNote;
 
     IOPMPowerFlags    stateFlags;
     unsigned long    stateNum;
     void *         powerRef;
 };
 typedef struct stateChangeNote stateChangeNote;
 

+#endif /* KERNEL && __cplusplus */

 struct IOPowerStateChangeNotification {
     void *        powerRef;
     unsigned long    returnValue;
 struct IOPowerStateChangeNotification {
     void *        powerRef;
     unsigned long    returnValue;


@@ -461,8 +780,54 @@ struct IOPowerStateChangeNotification {
 typedef struct IOPowerStateChangeNotification IOPowerStateChangeNotification;
 typedef IOPowerStateChangeNotification sleepWakeNote;
 
 typedef struct IOPowerStateChangeNotification IOPowerStateChangeNotification;
 typedef IOPowerStateChangeNotification sleepWakeNote;
 

-extern void IOPMRegisterDevice(const char *, IOService *);
-#endif /* KERNEL && __cplusplus */
+/*! @struct IOPMSystemCapabilityChangeParameters
+    @abstract A structure describing a system capability change.
+    @discussion A system capability change is a system level transition from a set
+        of system capabilities to a new set of system capabilities. Power management
+        sends a <code>kIOMessageSystemCapabilityChange</code> message and provides
+        this structure as the message data (by reference) to
+        <code>gIOPriorityPowerStateInterest</code> clients when system capability
+        changes.
+    @field notifyRef An identifier for this message notification. Clients with pending
+        I/O can signal completion by calling <code>allowPowerChange()</code> with this
+        value as the argument. Clients that are able to process the notification
+        synchronously should ignore this field.
+    @field maxWaitForReply A return value to the caller indicating the maximum time in
+        microseconds to wait for the <code>allowPowerChange()</code> call. The default
+        value is zero, which indicates the client processing has finished, and power
+        management should not wait for an <code>allowPowerChange()</code> call.
+    @field changeFlags Flags will be set to indicate whether the notification precedes
+        the capability change (<code>kIOPMSystemCapabilityWillChange</code>), or after
+        the capability change has occurred (<code>kIOPMSystemCapabilityDidChange</code>).
+    @field __reserved1 Set to zero.
+    @field fromCapabilities The system capabilities at the start of the transition.
+    @field toCapabilities The system capabilities at the end of the transition.
+    @field __reserved2 Set to zero.
+ */
+struct IOPMSystemCapabilityChangeParameters {
+    uint32_t    notifyRef;
+    uint32_t    maxWaitForReply;
+    uint32_t    changeFlags;
+    uint32_t    __reserved1;
+    uint32_t    fromCapabilities;
+    uint32_t    toCapabilities;
+    uint32_t    __reserved2[4];
+};

 
 

-#endif /* ! _IOKIT_IOPM_H */
+/*! @enum IOPMSystemCapabilityChangeFlags
+    @constant kIOPMSystemCapabilityWillChange Indicates the system capability will change.
+    @constant kIOPMSystemCapabilityDidChange Indicates the system capability has changed.
+*/
+enum {
+    kIOPMSystemCapabilityWillChange = 0x01,
+    kIOPMSystemCapabilityDidChange  = 0x02
+};

 
 

+enum {
+    kIOPMSystemCapabilityCPU        = 0x01,
+    kIOPMSystemCapabilityGraphics   = 0x02,
+    kIOPMSystemCapabilityAudio      = 0x04,
+    kIOPMSystemCapabilityNetwork    = 0x08
+};
+
+#endif /* ! _IOKIT_IOPM_H */