xnu-792.21.3.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 891643d7c2c3c98d80ccafaeadd4456db2532ea6..bf6902e6b7bc5ae7a6173cb6a57acb3892d83145 100644 (file)
--- a/iokit/IOKit/pwr_mgt/IOPM.h
+++ b/iokit/IOKit/pwr_mgt/IOPM.h
@@ -1,23 +1,29 @@
 /*
  * 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_IOPM_H
 #define _IOKIT_IOPM_H
  */
 #ifndef _IOKIT_IOPM_H
 #define _IOKIT_IOPM_H


@@ -118,7 +124,9 @@ enum {
   kIOPMClamshellClosed          = (1<<4),  // clamshell was closed
   kIOPMPowerEmergency           = (1<<5),  // battery dangerously low
   kIOPMDisableClamshell                 = (1<<6),  // do not sleep on clamshell closure
   kIOPMClamshellClosed          = (1<<4),  // clamshell was closed
   kIOPMPowerEmergency           = (1<<5),  // battery dangerously low
   kIOPMDisableClamshell                 = (1<<6),  // do not sleep on clamshell closure

-  kIOPMEnableClamshell          = (1<<7)   // sleep on clamshell closure
+  kIOPMEnableClamshell          = (1<<7),  // sleep on clamshell closure
+  kIOPMProcessorSpeedChange     = (1<<8),  // change the processor speed
+  kIOPMOverTemp                  = (1<<9)   // system dangerously hot

 };
                                         // Return codes
 
 };
                                         // Return codes
 


@@ -266,16 +274,30 @@ enum {
     kPMMinutesToSpinDown,
     kPMMinutesToSleep,
     kPMEthernetWakeOnLANSettings,
     kPMMinutesToSpinDown,
     kPMMinutesToSleep,
     kPMEthernetWakeOnLANSettings,

+    kPMSetProcessorSpeed,
+    kPMPowerSource,
+    kPMMotionSensor,
+    kPMLastAggressivenessType
+};
+#define kMaxType (kPMLastAggressivenessType-1)
+
+// SetAggressiveness values for the kPMPowerSource aggressiveness type
+enum {
+    kIOPMInternalPower = 1,
+    kIOPMExternalPower

 };
 };

-#define kMaxType kPMEthernetWakeOnLANSettings

 
 

+#define kAppleClamshellStateKey           "AppleClamshellState"
+#define kIOREMSleepEnabledKey             "REMSleepEnabled"

 
 

+// Strings for deciphering the dictionary returned from IOPMCopyBatteryInfo

 #define kIOBatteryInfoKey              "IOBatteryInfo"
 #define kIOBatteryCurrentChargeKey     "Current"
 #define kIOBatteryCapacityKey          "Capacity"
 #define kIOBatteryFlagsKey             "Flags"
 #define kIOBatteryVoltageKey           "Voltage"
 #define kIOBatteryAmperageKey          "Amperage"
 #define kIOBatteryInfoKey              "IOBatteryInfo"
 #define kIOBatteryCurrentChargeKey     "Current"
 #define kIOBatteryCapacityKey          "Capacity"
 #define kIOBatteryFlagsKey             "Flags"
 #define kIOBatteryVoltageKey           "Voltage"
 #define kIOBatteryAmperageKey          "Amperage"

+

 enum {
     kIOBatteryInstalled                = (1 << 2),
     kIOBatteryCharge           = (1 << 1),
 enum {
     kIOBatteryInstalled                = (1 << 2),
     kIOBatteryCharge           = (1 << 1),


@@ -283,6 +305,49 @@ enum {
 };
 
 
 };
 
 

+// 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)
+
+// Apple private Legacy messages for re-routing AutoWake and AutoPower messages to the PMU
+// through newer user space IOPMSchedulePowerEvent API
+#define kIOPMUMessageLegacyAutoWake                 iokit_family_msg(sub_iokit_pmu, 0x200)
+#define kIOPMUMessageLegacyAutoPower                   iokit_family_msg(sub_iokit_pmu, 0x210)
+
+// These flags are deprecated. Use the version with the kIOPM prefix below.
+enum {
+  kACInstalled      = kIOBatteryChargerConnect,
+  kBatteryCharging  = kIOBatteryCharge,
+  kBatteryInstalled = kIOBatteryInstalled,
+  kUPSInstalled     = (1<<3),
+  kBatteryAtWarn    = (1<<4),
+  kBatteryDepleted  = (1<<5),
+  kACnoChargeCapability = (1<<6),     // AC adapter cannot charge battery
+  kRawLowBattery    = (1<<7),         // used only by  Platform Expert
+  kForceLowSpeed    = (1<<8)         // set by Platfm Expert, chk'd by Pwr Plugin};
+};
+
+// For use with IOPMPowerSource bFlags
+#define IOPM_POWER_SOURCE_REV   2
+enum {
+  kIOPMACInstalled      = kIOBatteryChargerConnect,
+  kIOPMBatteryCharging  = kIOBatteryCharge,
+  kIOPMBatteryInstalled = kIOBatteryInstalled,
+  kIOPMUPSInstalled     = (1<<3),
+  kIOPMBatteryAtWarn    = (1<<4),
+  kIOPMBatteryDepleted  = (1<<5),
+  kIOPMACnoChargeCapability = (1<<6),     // AC adapter cannot charge battery
+  kIOPMRawLowBattery    = (1<<7),         // used only by  Platform Expert
+  kIOPMForceLowSpeed    = (1<<8),         // set by Platfm Expert, chk'd by Pwr Plugin
+  kIOPMClosedClamshell  = (1<<9),         // set by PMU - reflects state of the clamshell
+  kIOPMClamshellStateOnWake = (1<<10)     // used only by Platform Expert
+};
+
+
+// **********************************************
+// Internal power management data structures
+// **********************************************
+

 #if KERNEL && __cplusplus
 class IOService;
 
 #if KERNEL && __cplusplus
 class IOService;