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

/*
 * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * 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.
 * 
 * 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,
 * 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_OSREFERENCE_LICENSE_HEADER_END@
 */
#ifndef _IOKIT_IOPM_H
#define _IOKIT_IOPM_H

#define IOPMMaxPowerStates 10

typedef unsigned long IOPMPowerFlags;
enum {
                        // following  bits are used in the input and output power fields
    kIOPMClockNormal		= 0x0004,
    kIOPMClockRunning		= 0x0008,
    kIOPMAuxPowerOn		= 0x0020,	// used only between root and root parent
    kIOPMPagingAvailable	= 0x0020,	// used only between paging plexus and its children
    kIOPMPassThrough		= 0x0100,
    kIOPMDoze			= 0x0400,
    kIOPMSoftSleep		= 0x0400,	// old usage, replaced by kIOPMDoze
    kIOPMSleep			= 0x0001,
    kIOPMRestart		= 0x0080,
                        // following  bits are used in the capabilites field and the power fields
    kIOPMPowerOn		= 0x0002,
    kIOPMPreventSystemSleep	= 0x0010,
    kIOPMPreventIdleSleep	= 0x0040,
                        // following  bits are used in the capabilites field
    kIOPMNotAttainable		= 0x0001,	// used between a driver and its policy-maker
    kIOPMChildClamp		= 0x0080,	// used internally in a power domain parent
    kIOPMChildClamp2		= 0x0200,	// used internally in a power domain parent
    kIOPMDeviceUsable		= 0x8000,
    kIOPMMaxPerformance	 	= 0x4000,
    kIOPMContextRetained	= 0x2000,
    kIOPMConfigRetained		= 0x1000,
    kIOPMSleepCapability	= 0x0004,
    kIOPMRestartCapability	= 0x0080,
    kIOPMNotPowerManaged	= 0x0800,	// this is an error return rather than a bit
    kIOPMStaticPowerValid	= 0x0800,	// therefore this bit safely overloads it
    
    kIOPMCapabilitiesMask =     kIOPMPowerOn | kIOPMDeviceUsable | kIOPMMaxPerformance |
                                kIOPMContextRetained | kIOPMConfigRetained | kIOPMSleepCapability |
                                kIOPMRestartCapability
};


enum {
    IOPMNotAttainable	= kIOPMNotAttainable,
    IOPMPowerOn		= kIOPMPowerOn,
    IOPMClockNormal	= kIOPMClockNormal,
    IOPMClockRunning	= kIOPMClockRunning,
    IOPMAuxPowerOn	= kIOPMAuxPowerOn,
    IOPMDeviceUsable	= kIOPMDeviceUsable,
    IOPMMaxPerformance	= kIOPMMaxPerformance,
    IOPMContextRetained	= kIOPMContextRetained,
    IOPMConfigRetained	= kIOPMConfigRetained,
    IOPMNotPowerManaged	= kIOPMNotPowerManaged,
    IOPMPagingAvailable	= kIOPMPagingAvailable,
    IOPMSoftSleep	= kIOPMSoftSleep
};


enum {
    kIOPMNextHigherState	= 1,
    kIOPMHighestState		= 2,
    kIOPMNextLowerState		= 3,
    kIOPMLowestState		= 4
};

enum {
    IOPMNextHigherState		= kIOPMNextHigherState,
    IOPMHighestState		= kIOPMHighestState,
    IOPMNextLowerState		= kIOPMNextLowerState,
    IOPMLowestState		= kIOPMLowestState
};


enum {		// commands on power managment command queue
    kIOPMBroadcastAggressiveness = 1,
    kIOPMUnidleDevice
};

enum {		// special value means "power consumption unknown"
    kIOPMUnknown = 0xFFFF
};

// Power events
enum {
  kClamshellClosedEventMask  = (1<<0),  // User closed lid
  kDockingBarEventMask       = (1<<1),  // OBSOLETE
  kACPlugEventMask           = (1<<2),  // User plugged or unplugged adapter
  kFrontPanelButtonEventMask = (1<<3),  // User hit the front panel button
  kBatteryStatusEventMask    = (1<<4)   // Battery status has changed
};

// Power commands issued to root domain
enum {
  kIOPMSleepNow                  = (1<<0),  // put machine to sleep now
  kIOPMAllowSleep                = (1<<1),  // allow idle sleep
  kIOPMPreventSleep              = (1<<2),  // do not allow idle sleep
  kIOPMPowerButton		 = (1<<3),  // power button was pressed
  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
  kIOPMProcessorSpeedChange	 = (1<<8),  // change the processor speed
  kIOPMOverTemp                  = (1<<9)   // system dangerously hot
};
                                        // Return codes

// PUBLIC power management features
// NOTE: this is a direct port from classic, some of these bits
//       are obsolete but are included for completeness
enum {
  kPMHasWakeupTimerMask        = (1<<0),  // 1=wake timer is supported
  kPMHasSharedModemPortMask    = (1<<1),  // Not used
  kPMHasProcessorCyclingMask   = (1<<2),  // 1=processor cycling supported
  kPMMustProcessorCycleMask    = (1<<3),  // Not used
  kPMHasReducedSpeedMask       = (1<<4),  // 1=supports reduced processor speed
  kPMDynamicSpeedChangeMask    = (1<<5),  // 1=supports changing processor speed on the fly
  kPMHasSCSIDiskModeMask       = (1<<6),  // 1=supports using machine as SCSI drive
  kPMCanGetBatteryTimeMask     = (1<<7),  // 1=battery time can be calculated
  kPMCanWakeupOnRingMask       = (1<<8),  // 1=machine can wake on modem ring
  kPMHasDimmingSupportMask     = (1<<9),  // 1=has monitor dimming support
  kPMHasStartupTimerMask       = (1<<10), // 1=can program startup timer
  kPMHasChargeNotificationMask = (1<<11), // 1=client can determine charger status/get notifications
  kPMHasDimSuspendSupportMask  = (1<<12), // 1=can dim diplay to DPMS ('off') state
  kPMHasWakeOnNetActivityMask  = (1<<13), // 1=supports waking upon receipt of net packet
  kPMHasWakeOnLidMask          = (1<<14), // 1=can wake upon lid/case opening
  kPMCanPowerOffPCIBusMask     = (1<<15), // 1=can remove power from PCI bus on sleep
  kPMHasDeepSleepMask          = (1<<16), // 1=supports deep (hibernation) sleep
  kPMHasSleepMask              = (1<<17), // 1=machine support low power sleep (ala powerbooks)
  kPMSupportsServerModeAPIMask = (1<<18), // 1=supports reboot on AC resume for unexpected power loss
  kPMHasUPSIntegrationMask     = (1<<19)  // 1=supports incorporating UPS devices into power source calcs
};

// PRIVATE power management features
// NOTE: this is a direct port from classic, some of these bits
//       are obsolete but are included for completeness.
enum {
  kPMHasExtdBattInfoMask       = (1<<0),  // Not used
  kPMHasBatteryIDMask          = (1<<1),  // Not used
  kPMCanSwitchPowerMask        = (1<<2),  // Not used 
  kPMHasCelsiusCyclingMask     = (1<<3),  // Not used
  kPMHasBatteryPredictionMask  = (1<<4),  // Not used
  kPMHasPowerLevelsMask        = (1<<5),  // Not used
  kPMHasSleepCPUSpeedMask      = (1<<6),  // Not used
  kPMHasBtnIntHandlersMask     = (1<<7),  // 1=supports individual button interrupt handlers
  kPMHasSCSITermPowerMask      = (1<<8),  // 1=supports SCSI termination power switch
  kPMHasADBButtonHandlersMask  = (1<<9),  // 1=supports button handlers via ADB
  kPMHasICTControlMask         = (1<<10), // 1=supports ICT control
  kPMHasLegacyDesktopSleepMask = (1<<11), // 1=supports 'doze' style sleep
  kPMHasDeepIdleMask           = (1<<12), // 1=supports Idle2 in hardware
  kPMOpenLidPreventsSleepMask  = (1<<13), // 1=open case prevent machine from sleeping
  kPMClosedLidCausesSleepMask  = (1<<14), // 1=case closed (clamshell closed) causes sleep
  kPMHasFanControlMask         = (1<<15), // 1=machine has software-programmable fan/thermostat controls
  kPMHasThermalControlMask     = (1<<16), // 1=machine supports thermal monitoring
  kPMHasVStepSpeedChangeMask   = (1<<17), // 1=machine supports processor voltage/clock change
  kPMEnvironEventsPolledMask   = (1<<18)  // 1=machine doesn't generate pmu env ints, we must poll instead 
};

// DEFAULT public and private features for machines whose device tree
// does NOT contain this information (pre-Core99).

// For Cuda-based Desktops

#define kStdDesktopPMFeatures   kPMHasWakeupTimerMask         |\
                                kPMHasProcessorCyclingMask    |\
                                kPMHasDimmingSupportMask      |\
                                kPMHasStartupTimerMask        |\
                                kPMSupportsServerModeAPIMask  |\
                                kPMHasUPSIntegrationMask

#define kStdDesktopPrivPMFeatures  kPMHasExtdBattInfoMask     |\
                                   kPMHasICTControlMask       |\
                                   kPMHasLegacyDesktopSleepMask

#define kStdDesktopNumBatteries 0

// For Wallstreet (PowerBook G3 Series 1998)

#define kWallstreetPMFeatures   kPMHasWakeupTimerMask         |\
                                kPMHasProcessorCyclingMask    |\
                                kPMHasReducedSpeedMask        |\
                                kPMDynamicSpeedChangeMask     |\
                                kPMHasSCSIDiskModeMask        |\
                                kPMCanGetBatteryTimeMask      |\
                                kPMHasDimmingSupportMask      |\
                                kPMHasChargeNotificationMask  |\
                                kPMHasDimSuspendSupportMask   |\
                                kPMHasSleepMask

#define kWallstreetPrivPMFeatures  kPMHasExtdBattInfoMask      |\
                                   kPMHasBatteryIDMask         |\
                                   kPMCanSwitchPowerMask       |\
                                   kPMHasADBButtonHandlersMask |\
                                   kPMHasSCSITermPowerMask     |\
                                   kPMHasICTControlMask        |\
                                   kPMClosedLidCausesSleepMask |\
                                   kPMEnvironEventsPolledMask

#define kStdPowerBookPMFeatures      kWallstreetPMFeatures
#define kStdPowerBookPrivPMFeatures  kWallstreetPrivPMFeatures

#define kStdPowerBookNumBatteries 2

// For 101 (PowerBook G3 Series 1999)

#define k101PMFeatures          kPMHasWakeupTimerMask         |\
                                kPMHasProcessorCyclingMask    |\
                                kPMHasReducedSpeedMask        |\
                                kPMDynamicSpeedChangeMask     |\
                                kPMHasSCSIDiskModeMask        |\
                                kPMCanGetBatteryTimeMask      |\
                                kPMHasDimmingSupportMask      |\
                                kPMHasChargeNotificationMask  |\
                                kPMHasDimSuspendSupportMask   |\
                                kPMHasSleepMask               |\
                                kPMHasUPSIntegrationMask

#define k101PrivPMFeatures      kPMHasExtdBattInfoMask        |\
                                kPMHasBatteryIDMask           |\
                                kPMCanSwitchPowerMask         |\
                                kPMHasADBButtonHandlersMask   |\
                                kPMHasSCSITermPowerMask       |\
                                kPMHasICTControlMask          |\
                                kPMClosedLidCausesSleepMask   |\
                                kPMEnvironEventsPolledMask

#define IOPMNoErr		0	// normal return

                        // returned by powerStateWillChange and powerStateDidChange:
#define IOPMAckImplied		0	// acknowledgement of power state change is implied
#define IOPMWillAckLater	1	// acknowledgement of power state change will come later

                        // returned by requestDomainState
#define IOPMBadSpecification	4	// unrecognized specification parameter
#define IOPMNoSuchState		5	// no power state matches search specification

#define IOPMCannotRaisePower	6	// a device cannot change its power for some reason

                        // returned by changeStateTo
#define IOPMParameterError	7	// requested state doesn't exist
#define IOPMNotYetInitialized	8	// device not yet fully hooked into power management "graph"


						// used by Root Domain UserClient

enum {
    kPMGeneralAggressiveness = 0,
    kPMMinutesToDim,
    kPMMinutesToSpinDown,
    kPMMinutesToSleep,
    kPMEthernetWakeOnLANSettings,
    kPMSetProcessorSpeed,
    kPMPowerSource,
    kPMMotionSensor,
    kPMLastAggressivenessType
};
#define kMaxType (kPMLastAggressivenessType-1)

// SetAggressiveness values for the kPMPowerSource aggressiveness type
enum {
    kIOPMInternalPower = 1,
    kIOPMExternalPower
};

#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"

enum {
    kIOBatteryInstalled		= (1 << 2),
    kIOBatteryCharge		= (1 << 1),
    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)

// 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;

enum {
    kIOPowerEmergencyLevel = 1000
};

enum {
    kIOPMSubclassPolicy,
    kIOPMSuperclassPolicy1
};

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

struct IOPowerStateChangeNotification {
    void *		powerRef;
    unsigned long	returnValue;
    unsigned long	stateNumber;
    IOPMPowerFlags	stateFlags;
};
typedef struct IOPowerStateChangeNotification IOPowerStateChangeNotification;
typedef IOPowerStateChangeNotification sleepWakeNote;

extern void IOPMRegisterDevice(const char *, IOService *);
#endif /* KERNEL && __cplusplus */

#endif /* ! _IOKIT_IOPM_H */
Commit	Line	Data
1c79356b	1	/*
8f6c56a5	2	* Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
8f6c56a5	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
8f6c56a5 A	6	* This file contains Original Code and/or Modifications of Original Code
	7	* as defined in and that are subject to the Apple Public Source License
	8	* Version 2.0 (the 'License'). You may not use this file except in
	9	* compliance with the License. The rights granted to you under the License
	10	* may not be used to create, or enable the creation or redistribution of,
	11	* unlawful or unlicensed copies of an Apple operating system, or to
	12	* circumvent, violate, or enable the circumvention or violation of, any
	13	* terms of an Apple operating system software license agreement.
	14	*
	15	* Please obtain a copy of the License at
	16	* http://www.opensource.apple.com/apsl/ and read it before using this file.
	17	*
	18	* The Original Code and all software distributed under the License are
	19	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
	23	* Please see the License for the specific language governing rights and
8ad349bb	24	* limitations under the License.
8f6c56a5 A	25	*
8f6c56a5 A	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	#ifndef _IOKIT_IOPM_H
	29	#define _IOKIT_IOPM_H
	30
8f6c56a5	31	#define IOPMMaxPowerStates 10
1c79356b A	32
1c79356b A	33	typedef unsigned long IOPMPowerFlags;
0b4e3aa0	34	enum {
8f6c56a5 A	35	// following bits are used in the input and output power fields
	36	kIOPMClockNormal = 0x0004,
	37	kIOPMClockRunning = 0x0008,
	38	kIOPMAuxPowerOn = 0x0020, // used only between root and root parent
	39	kIOPMPagingAvailable = 0x0020, // used only between paging plexus and its children
	40	kIOPMPassThrough = 0x0100,
	41	kIOPMDoze = 0x0400,
	42	kIOPMSoftSleep = 0x0400, // old usage, replaced by kIOPMDoze
	43	kIOPMSleep = 0x0001,
	44	kIOPMRestart = 0x0080,
	45	// following bits are used in the capabilites field and the power fields
	46	kIOPMPowerOn = 0x0002,
	47	kIOPMPreventSystemSleep = 0x0010,
	48	kIOPMPreventIdleSleep = 0x0040,
	49	// following bits are used in the capabilites field
	50	kIOPMNotAttainable = 0x0001, // used between a driver and its policy-maker
	51	kIOPMChildClamp = 0x0080, // used internally in a power domain parent
	52	kIOPMChildClamp2 = 0x0200, // used internally in a power domain parent
	53	kIOPMDeviceUsable = 0x8000,
	54	kIOPMMaxPerformance = 0x4000,
	55	kIOPMContextRetained = 0x2000,
	56	kIOPMConfigRetained = 0x1000,
	57	kIOPMSleepCapability = 0x0004,
	58	kIOPMRestartCapability = 0x0080,
	59	kIOPMNotPowerManaged = 0x0800, // this is an error return rather than a bit
	60	kIOPMStaticPowerValid = 0x0800, // therefore this bit safely overloads it
0b4e3aa0	61
8f6c56a5 A	62	kIOPMCapabilitiesMask = kIOPMPowerOn \| kIOPMDeviceUsable \| kIOPMMaxPerformance \|
8f6c56a5 A	63	kIOPMContextRetained \| kIOPMConfigRetained \| kIOPMSleepCapability \|
0b4e3aa0 A	64	kIOPMRestartCapability
	65	};
	66
	67
	68	enum {
8f6c56a5 A	69	IOPMNotAttainable = kIOPMNotAttainable,
	70	IOPMPowerOn = kIOPMPowerOn,
	71	IOPMClockNormal = kIOPMClockNormal,
	72	IOPMClockRunning = kIOPMClockRunning,
	73	IOPMAuxPowerOn = kIOPMAuxPowerOn,
	74	IOPMDeviceUsable = kIOPMDeviceUsable,
	75	IOPMMaxPerformance = kIOPMMaxPerformance,
	76	IOPMContextRetained = kIOPMContextRetained,
	77	IOPMConfigRetained = kIOPMConfigRetained,
	78	IOPMNotPowerManaged = kIOPMNotPowerManaged,
	79	IOPMPagingAvailable = kIOPMPagingAvailable,
	80	IOPMSoftSleep = kIOPMSoftSleep
0b4e3aa0 A	81	};
	82
	83
	84	enum {
8f6c56a5 A	85	kIOPMNextHigherState = 1,
	86	kIOPMHighestState = 2,
	87	kIOPMNextLowerState = 3,
	88	kIOPMLowestState = 4
0b4e3aa0 A	89	};
	90
	91	enum {
8f6c56a5 A	92	IOPMNextHigherState = kIOPMNextHigherState,
	93	IOPMHighestState = kIOPMHighestState,
	94	IOPMNextLowerState = kIOPMNextLowerState,
	95	IOPMLowestState = kIOPMLowestState
0b4e3aa0	96	};
1c79356b	97
8f6c56a5 A	98
	99
	100	enum { // commands on power managment command queue
0b4e3aa0 A	101	kIOPMBroadcastAggressiveness = 1,
	102	kIOPMUnidleDevice
	103	};
	104
8f6c56a5	105	enum { // special value means "power consumption unknown"
0b4e3aa0	106	kIOPMUnknown = 0xFFFF
1c79356b A	107	};
1c79356b A	108
8f6c56a5	109	// Power events
1c79356b	110	enum {
8f6c56a5 A	111	kClamshellClosedEventMask = (1<<0), // User closed lid
	112	kDockingBarEventMask = (1<<1), // OBSOLETE
	113	kACPlugEventMask = (1<<2), // User plugged or unplugged adapter
	114	kFrontPanelButtonEventMask = (1<<3), // User hit the front panel button
	115	kBatteryStatusEventMask = (1<<4) // Battery status has changed
1c79356b A	116	};
1c79356b A	117
8f6c56a5	118	// Power commands issued to root domain
1c79356b	119	enum {
8f6c56a5 A	120	kIOPMSleepNow = (1<<0), // put machine to sleep now
	121	kIOPMAllowSleep = (1<<1), // allow idle sleep
	122	kIOPMPreventSleep = (1<<2), // do not allow idle sleep
	123	kIOPMPowerButton = (1<<3), // power button was pressed
	124	kIOPMClamshellClosed = (1<<4), // clamshell was closed
	125	kIOPMPowerEmergency = (1<<5), // battery dangerously low
	126	kIOPMDisableClamshell = (1<<6), // do not sleep on clamshell closure
	127	kIOPMEnableClamshell = (1<<7), // sleep on clamshell closure
	128	kIOPMProcessorSpeedChange = (1<<8), // change the processor speed
	129	kIOPMOverTemp = (1<<9) // system dangerously hot
5d5c5d0d	130	};
8f6c56a5	131	// Return codes
5d5c5d0d	132
8f6c56a5 A	133	// PUBLIC power management features
	134	// NOTE: this is a direct port from classic, some of these bits
	135	// are obsolete but are included for completeness
5d5c5d0d	136	enum {
8f6c56a5 A	137	kPMHasWakeupTimerMask = (1<<0), // 1=wake timer is supported
	138	kPMHasSharedModemPortMask = (1<<1), // Not used
	139	kPMHasProcessorCyclingMask = (1<<2), // 1=processor cycling supported
	140	kPMMustProcessorCycleMask = (1<<3), // Not used
	141	kPMHasReducedSpeedMask = (1<<4), // 1=supports reduced processor speed
	142	kPMDynamicSpeedChangeMask = (1<<5), // 1=supports changing processor speed on the fly
	143	kPMHasSCSIDiskModeMask = (1<<6), // 1=supports using machine as SCSI drive
	144	kPMCanGetBatteryTimeMask = (1<<7), // 1=battery time can be calculated
	145	kPMCanWakeupOnRingMask = (1<<8), // 1=machine can wake on modem ring
	146	kPMHasDimmingSupportMask = (1<<9), // 1=has monitor dimming support
	147	kPMHasStartupTimerMask = (1<<10), // 1=can program startup timer
	148	kPMHasChargeNotificationMask = (1<<11), // 1=client can determine charger status/get notifications
	149	kPMHasDimSuspendSupportMask = (1<<12), // 1=can dim diplay to DPMS ('off') state
	150	kPMHasWakeOnNetActivityMask = (1<<13), // 1=supports waking upon receipt of net packet
	151	kPMHasWakeOnLidMask = (1<<14), // 1=can wake upon lid/case opening
	152	kPMCanPowerOffPCIBusMask = (1<<15), // 1=can remove power from PCI bus on sleep
	153	kPMHasDeepSleepMask = (1<<16), // 1=supports deep (hibernation) sleep
	154	kPMHasSleepMask = (1<<17), // 1=machine support low power sleep (ala powerbooks)
	155	kPMSupportsServerModeAPIMask = (1<<18), // 1=supports reboot on AC resume for unexpected power loss
	156	kPMHasUPSIntegrationMask = (1<<19) // 1=supports incorporating UPS devices into power source calcs
1c79356b	157	};
1c79356b	158
8f6c56a5 A	159	// PRIVATE power management features
	160	// NOTE: this is a direct port from classic, some of these bits
	161	// are obsolete but are included for completeness.
1c79356b	162	enum {
8f6c56a5 A	163	kPMHasExtdBattInfoMask = (1<<0), // Not used
	164	kPMHasBatteryIDMask = (1<<1), // Not used
	165	kPMCanSwitchPowerMask = (1<<2), // Not used
	166	kPMHasCelsiusCyclingMask = (1<<3), // Not used
	167	kPMHasBatteryPredictionMask = (1<<4), // Not used
	168	kPMHasPowerLevelsMask = (1<<5), // Not used
	169	kPMHasSleepCPUSpeedMask = (1<<6), // Not used
	170	kPMHasBtnIntHandlersMask = (1<<7), // 1=supports individual button interrupt handlers
	171	kPMHasSCSITermPowerMask = (1<<8), // 1=supports SCSI termination power switch
	172	kPMHasADBButtonHandlersMask = (1<<9), // 1=supports button handlers via ADB
	173	kPMHasICTControlMask = (1<<10), // 1=supports ICT control
	174	kPMHasLegacyDesktopSleepMask = (1<<11), // 1=supports 'doze' style sleep
	175	kPMHasDeepIdleMask = (1<<12), // 1=supports Idle2 in hardware
	176	kPMOpenLidPreventsSleepMask = (1<<13), // 1=open case prevent machine from sleeping
	177	kPMClosedLidCausesSleepMask = (1<<14), // 1=case closed (clamshell closed) causes sleep
	178	kPMHasFanControlMask = (1<<15), // 1=machine has software-programmable fan/thermostat controls
	179	kPMHasThermalControlMask = (1<<16), // 1=machine supports thermal monitoring
	180	kPMHasVStepSpeedChangeMask = (1<<17), // 1=machine supports processor voltage/clock change
	181	kPMEnvironEventsPolledMask = (1<<18) // 1=machine doesn't generate pmu env ints, we must poll instead
c0fea474 A	182	};
c0fea474 A	183
8f6c56a5 A	184	// DEFAULT public and private features for machines whose device tree
	185	// does NOT contain this information (pre-Core99).
	186
	187	// For Cuda-based Desktops
	188
	189	#define kStdDesktopPMFeatures kPMHasWakeupTimerMask \|\
	190	kPMHasProcessorCyclingMask \|\
	191	kPMHasDimmingSupportMask \|\
	192	kPMHasStartupTimerMask \|\
	193	kPMSupportsServerModeAPIMask \|\
	194	kPMHasUPSIntegrationMask
	195
	196	#define kStdDesktopPrivPMFeatures kPMHasExtdBattInfoMask \|\
	197	kPMHasICTControlMask \|\
	198	kPMHasLegacyDesktopSleepMask
	199
	200	#define kStdDesktopNumBatteries 0
	201
	202	// For Wallstreet (PowerBook G3 Series 1998)
	203
	204	#define kWallstreetPMFeatures kPMHasWakeupTimerMask \|\
	205	kPMHasProcessorCyclingMask \|\
	206	kPMHasReducedSpeedMask \|\
	207	kPMDynamicSpeedChangeMask \|\
	208	kPMHasSCSIDiskModeMask \|\
	209	kPMCanGetBatteryTimeMask \|\
	210	kPMHasDimmingSupportMask \|\
	211	kPMHasChargeNotificationMask \|\
	212	kPMHasDimSuspendSupportMask \|\
	213	kPMHasSleepMask
	214
	215	#define kWallstreetPrivPMFeatures kPMHasExtdBattInfoMask \|\
	216	kPMHasBatteryIDMask \|\
	217	kPMCanSwitchPowerMask \|\
	218	kPMHasADBButtonHandlersMask \|\
	219	kPMHasSCSITermPowerMask \|\
	220	kPMHasICTControlMask \|\
	221	kPMClosedLidCausesSleepMask \|\
	222	kPMEnvironEventsPolledMask
	223
	224	#define kStdPowerBookPMFeatures kWallstreetPMFeatures
	225	#define kStdPowerBookPrivPMFeatures kWallstreetPrivPMFeatures
	226
	227	#define kStdPowerBookNumBatteries 2
	228
	229	// For 101 (PowerBook G3 Series 1999)
	230
	231	#define k101PMFeatures kPMHasWakeupTimerMask \|\
	232	kPMHasProcessorCyclingMask \|\
	233	kPMHasReducedSpeedMask \|\
	234	kPMDynamicSpeedChangeMask \|\
	235	kPMHasSCSIDiskModeMask \|\
	236	kPMCanGetBatteryTimeMask \|\
	237	kPMHasDimmingSupportMask \|\
	238	kPMHasChargeNotificationMask \|\
	239	kPMHasDimSuspendSupportMask \|\
	240	kPMHasSleepMask \|\
	241	kPMHasUPSIntegrationMask
	242
	243	#define k101PrivPMFeatures kPMHasExtdBattInfoMask \|\
	244	kPMHasBatteryIDMask \|\
	245	kPMCanSwitchPowerMask \|\
	246	kPMHasADBButtonHandlersMask \|\
	247	kPMHasSCSITermPowerMask \|\
248	kPMHasICTControlMask \|\
249	kPMClosedLidCausesSleepMask \|\
250	kPMEnvironEventsPolledMask
251
252	#define IOPMNoErr 0 // normal return
253
254	// returned by powerStateWillChange and powerStateDidChange:
255	#define IOPMAckImplied 0 // acknowledgement of power state change is implied
256	#define IOPMWillAckLater 1 // acknowledgement of power state change will come later
257
258	// returned by requestDomainState
259	#define IOPMBadSpecification 4 // unrecognized specification parameter
260	#define IOPMNoSuchState 5 // no power state matches search specification
261
262	#define IOPMCannotRaisePower 6 // a device cannot change its power for some reason
263
264	// returned by changeStateTo
265	#define IOPMParameterError 7 // requested state doesn't exist
266	#define IOPMNotYetInitialized 8 // device not yet fully hooked into power management "graph"
267
268
269	// used by Root Domain UserClient
c0fea474	270
1c79356b A	271	enum {
	272	kPMGeneralAggressiveness = 0,
	273	kPMMinutesToDim,
	274	kPMMinutesToSpinDown,
0b4e3aa0 A	275	kPMMinutesToSleep,
0b4e3aa0 A	276	kPMEthernetWakeOnLANSettings,
9bccf70c	277	kPMSetProcessorSpeed,
91447636 A	278	kPMPowerSource,
	279	kPMMotionSensor,
	280	kPMLastAggressivenessType
1c79356b	281	};
91447636	282	#define kMaxType (kPMLastAggressivenessType-1)
1c79356b	283
9bccf70c A	284	// SetAggressiveness values for the kPMPowerSource aggressiveness type
	285	enum {
	286	kIOPMInternalPower = 1,
	287	kIOPMExternalPower
	288	};
	289
8f6c56a5 A	290	#define kAppleClamshellStateKey "AppleClamshellState"
8f6c56a5 A	291	#define kIOREMSleepEnabledKey "REMSleepEnabled"
1c79356b	292
55e303ae	293	// Strings for deciphering the dictionary returned from IOPMCopyBatteryInfo
8f6c56a5 A	294	#define kIOBatteryInfoKey "IOBatteryInfo"
	295	#define kIOBatteryCurrentChargeKey "Current"
	296	#define kIOBatteryCapacityKey "Capacity"
	297	#define kIOBatteryFlagsKey "Flags"
	298	#define kIOBatteryVoltageKey "Voltage"
	299	#define kIOBatteryAmperageKey "Amperage"
d52fe63f	300
1c79356b	301	enum {
8f6c56a5 A	302	kIOBatteryInstalled = (1 << 2),
	303	kIOBatteryCharge = (1 << 1),
	304	kIOBatteryChargerConnect = (1 << 0)
1c79356b A	305	};
1c79356b A	306
e5568f75	307
55e303ae A	308	// Private power management message indicating battery data has changed
	309	// Indicates new data resides in the IORegistry
	310	#define kIOPMMessageBatteryStatusHasChanged iokit_family_msg(sub_iokit_pmu, 0x100)
	311
	312	// Apple private Legacy messages for re-routing AutoWake and AutoPower messages to the PMU
	313	// through newer user space IOPMSchedulePowerEvent API
	314	#define kIOPMUMessageLegacyAutoWake iokit_family_msg(sub_iokit_pmu, 0x200)
8f6c56a5 A	315	#define kIOPMUMessageLegacyAutoPower iokit_family_msg(sub_iokit_pmu, 0x210)
	316
	317	// These flags are deprecated. Use the version with the kIOPM prefix below.
	318	enum {
	319	kACInstalled = kIOBatteryChargerConnect,
	320	kBatteryCharging = kIOBatteryCharge,
	321	kBatteryInstalled = kIOBatteryInstalled,
	322	kUPSInstalled = (1<<3),
	323	kBatteryAtWarn = (1<<4),
	324	kBatteryDepleted = (1<<5),
	325	kACnoChargeCapability = (1<<6), // AC adapter cannot charge battery
	326	kRawLowBattery = (1<<7), // used only by Platform Expert
	327	kForceLowSpeed = (1<<8) // set by Platfm Expert, chk'd by Pwr Plugin};
	328	};
d52fe63f A	329
	330	// For use with IOPMPowerSource bFlags
	331	#define IOPM_POWER_SOURCE_REV 2
	332	enum {
	333	kIOPMACInstalled = kIOBatteryChargerConnect,
	334	kIOPMBatteryCharging = kIOBatteryCharge,
	335	kIOPMBatteryInstalled = kIOBatteryInstalled,
	336	kIOPMUPSInstalled = (1<<3),
	337	kIOPMBatteryAtWarn = (1<<4),
	338	kIOPMBatteryDepleted = (1<<5),
	339	kIOPMACnoChargeCapability = (1<<6), // AC adapter cannot charge battery
	340	kIOPMRawLowBattery = (1<<7), // used only by Platform Expert
	341	kIOPMForceLowSpeed = (1<<8), // set by Platfm Expert, chk'd by Pwr Plugin
	342	kIOPMClosedClamshell = (1<<9), // set by PMU - reflects state of the clamshell
	343	kIOPMClamshellStateOnWake = (1<<10) // used only by Platform Expert
	344	};
	345
	346
55e303ae A	347	// **********************************************
	348	// Internal power management data structures
	349	// **********************************************
1c79356b A	350
	351	#if KERNEL && __cplusplus
	352	class IOService;
	353
	354	enum {
	355	kIOPowerEmergencyLevel = 1000
	356	};
	357
	358	enum {
	359	kIOPMSubclassPolicy,
	360	kIOPMSuperclassPolicy1
	361	};
	362
	363	struct stateChangeNote{
8f6c56a5 A	364	IOPMPowerFlags stateFlags;
	365	unsigned long stateNum;
	366	void * powerRef;
1c79356b A	367	};
	368	typedef struct stateChangeNote stateChangeNote;
	369
0b4e3aa0	370	struct IOPowerStateChangeNotification {
8f6c56a5 A	371	void * powerRef;
	372	unsigned long returnValue;
	373	unsigned long stateNumber;
	374	IOPMPowerFlags stateFlags;
1c79356b	375	};
0b4e3aa0 A	376	typedef struct IOPowerStateChangeNotification IOPowerStateChangeNotification;
0b4e3aa0 A	377	typedef IOPowerStateChangeNotification sleepWakeNote;
1c79356b A	378
	379	extern void IOPMRegisterDevice(const char , IOService );
	380	#endif /* KERNEL && __cplusplus */
	381
	382	#endif /* ! _IOKIT_IOPM_H */
	383