]> git.saurik.com Git - apple/xnu.git/blobdiff - iokit/IOKit/pwr_mgt/IOPMPrivate.h
xnu-2422.1.72.tar.gz
[apple/xnu.git] / iokit / IOKit / pwr_mgt / IOPMPrivate.h
index 09fdb19e82a7c694f8eda289f517efc46eb66c63..f9bb27642782fdfaa16fdf6bad8031292fcebec9 100644 (file)
@@ -78,7 +78,7 @@
  * @abstract Potential system events logged in the system event record.
  */
 enum {
-       kIOPMEventTypeUndefined                     = 0,
+    kIOPMEventTypeUndefined                     = 0,
 
     /* Event types mark driver events 
      */
@@ -92,18 +92,18 @@ enum {
     /* Start and stop event types bracket major
      * system power management events.
      */
-       kIOPMEventTypeSleep                         = 2001,
-       kIOPMEventTypeSleepDone                     = 2002,
-       kIOPMEventTypeWake                          = 3001,
-       kIOPMEventTypeWakeDone                      = 3002,
-       kIOPMEventTypeDoze                          = 4001,
-       kIOPMEventTypeDozeDone                      = 4002,
-       kIOPMEventTypeLiteWakeUp                    = 5001,
-       kIOPMEventTypeLiteWakeUpDone                = 5002,
-       kIOPMEventTypeLiteWakeDown                  = 5003,
-       kIOPMEventTypeLiteWakeDownDone              = 5004,
-       kIOPMEventTypeUUIDSet                       = 6001,
-       kIOPMEventTypeUUIDClear                     = 6002,
+    kIOPMEventTypeSleep                         = 2001,
+    kIOPMEventTypeSleepDone                     = 2002,
+    kIOPMEventTypeWake                          = 3001,
+    kIOPMEventTypeWakeDone                      = 3002,
+    kIOPMEventTypeDoze                          = 4001,
+    kIOPMEventTypeDozeDone                      = 4002,
+    kIOPMEventTypeLiteWakeUp                    = 5001,
+    kIOPMEventTypeLiteWakeUpDone                = 5002,
+    kIOPMEventTypeLiteWakeDown                  = 5003,
+    kIOPMEventTypeLiteWakeDownDone              = 5004,
+    kIOPMEventTypeUUIDSet                       = 6001,
+    kIOPMEventTypeUUIDClear                     = 6002,
 
     /* Intermediate events that may only occur within the bounds
      * of a major system event (between the event's initiation and its "done event".)
@@ -118,8 +118,28 @@ enum {
     kIOPMEventTypeCalTimeChange                 = 503 | kIOPMEventTypeIntermediateFlag
 };
 
+/*****************************************************************************
+ *
+ * Private Root Domain general interest messages
+ *
+ * Check IOPM.h when adding new messages to avoid conflict.
+ *
+ *****************************************************************************/
+
+/* kIOPMMessageUserIsActiveChanged 
+ * User became active or inactive. Message sent after the kIOPMUserIsActiveKey
+ * property was updated with a new value.
+ */ 
+#define kIOPMMessageUserIsActiveChanged \
+                iokit_family_msg(sub_iokit_powermanagement, 0x400)
+
+/*
+ * Private IOMessage notifications shared between kernel and userspace PM policy
+ */
+#define kIOPMMessageLastCallBeforeSleep \
+                iokit_family_msg(sub_iokit_powermanagement, 0x410)
 
-/* @enum SystemSleepReasons 
+/* @enum SystemSleepReasons
  * @abstract The potential causes for system sleep as logged in the system event record.
  */
 enum {
@@ -131,7 +151,8 @@ enum {
     kIOPMSleepReasonLowPower                    = 106,
     kIOPMSleepReasonThermalEmergency            = 107,
     kIOPMSleepReasonMaintenance                 = 108,
-    kIOPMSleepReasonSleepServiceExit            = 109
+    kIOPMSleepReasonSleepServiceExit            = 109,
+    kIOPMSleepReasonDarkWakeThermalEmergency    = 110
 };
 
 /*
@@ -145,6 +166,7 @@ enum {
 #define kIOPMLowPowerSleepKey                       "Low Power Sleep"
 #define kIOPMThermalEmergencySleepKey               "Thermal Emergency Sleep"
 #define kIOPMSleepServiceExitKey                    "Sleep Service Back to Sleep"
+#define kIOPMDarkWakeThermalEmergencyKey            "Dark Wake Thermal Emergency"
 
 
 enum {
@@ -347,6 +369,7 @@ enum {
 #define kIOPMStatsTimeMSKey                     "TimeMS"
 #define kIOPMStatsApplicationResponseTypeKey    "ResponseType"
 #define kIOPMStatsMessageTypeKey                "MessageType"
+#define kIOPMStatsPowerCapabilityKey            "PowerCaps"
  
 // PM Statistics: potential values for the key kIOPMStatsApplicationResponseTypeKey
 // entry in the application results array.
@@ -617,6 +640,8 @@ enum {
 #define kIOPMSleepWakeFailureLoginKey       "LWFailurePhase"
 #define kIOPMSleepWakeFailureUUIDKey        "UUID"
 #define kIOPMSleepWakeFailureDateKey        "Date"
+#define kIOPMSleepWakeWdogRebootKey         "SWWdogTriggeredRestart"
+#define kIOPMSleepWakeWdogLogsValidKey      "SWWdogLogsValid"
 
 /*****************************************************************************
  *
@@ -624,6 +649,11 @@ enum {
  *
  *****************************************************************************/
 
+/* kIOPMFeatureAutoPowerOffKey
+ * Feature published if Auto Power Off is supported
+ */
+#define kIOPMFeatureAutoPowerOffKey         "AutoPowerOff"
+
 /* kIOPMAutoPowerOffEnabledKey
  * Indicates if Auto Power Off is enabled.
  * It has a boolean value.
@@ -640,6 +670,38 @@ enum {
  */
 #define kIOPMAutoPowerOffDelayKey           "AutoPowerOff Delay"
 
+/* kIOPMAutoPowerOffTimerKey
+ * Key refers to a CFNumberRef that indicates the time in seconds until the
+ * expiration of the Auto Power Off delay period. This value should be used
+ * to program a wake alarm before system sleep.
+ */
+#define kIOPMAutoPowerOffTimerKey           "AutoPowerOff Timer"
+
+/* kIOPMUserWakeAlarmScheduledKey
+ * Key refers to a boolean value that indicates if an user alarm was scheduled
+ * or pending.
+ */
+#define kIOPMUserWakeAlarmScheduledKey      "UserWakeAlarmScheduled"
+
+/* kIOPMDeepIdleSupportedKey
+ * Presence of this key indicates Deep Idle is supported on this platform.
+ * Key will always refer to a value of kOSBooleanTrue.
+ */
+#define kIOPMDeepIdleSupportedKey           "IOPMDeepIdleSupported"
+
+/* kIOPMUserTriggeredFullWakeKey
+ * Key refers to a boolean value that indicates if the first full wake since
+ * last system sleep was triggered by the local user. This property is set
+ * before the initial full wake transition, and removed after powering down
+ * drivers for system sleep.
+ */
+#define kIOPMUserTriggeredFullWakeKey       "IOPMUserTriggeredFullWake"
+
+/* kIOPMUserIsActiveKey
+ * Key refers to a boolean value that indicates if the user is active.
+ */
+#define kIOPMUserIsActiveKey                "IOPMUserIsActive"
+
 /*****************************************************************************
  *
  * System Sleep Policy
@@ -674,12 +736,22 @@ struct IOPMSystemSleepPolicyVariables
 
     uint32_t    standbyDelay;               // standby delay in seconds
     uint32_t    poweroffDelay;              // auto-poweroff delay in seconds
+    uint32_t    scheduledAlarms;            // bitmask of scheduled alarm types
+    uint32_t    poweroffTimer;              // auto-poweroff timer in seconds
 
-    uint32_t    reserved[51];               // pad sizeof 256 bytes
+    uint32_t    reserved[49];               // pad sizeof 256 bytes
 };
 
 enum {
-    kIOPMSleepPhase1 = 1,
+    kIOPMAlarmBitDebugWake                  = 0x01,
+    kIOPMAlarmBitCalendarWake               = 0x02,
+    kIOPMAlarmBitMaintenanceWake            = 0x04,
+    kIOPMAlarmBitSleepServiceWake           = 0x08
+};
+
+enum {
+    kIOPMSleepPhase0 = 0,
+    kIOPMSleepPhase1,
     kIOPMSleepPhase2
 };
 
@@ -700,7 +772,10 @@ enum {
     kIOPMSleepFactorMagicPacketWakeEnabled  = 0x00001000ULL,
     kIOPMSleepFactorHibernateForced         = 0x00010000ULL,
     kIOPMSleepFactorAutoPowerOffDisabled    = 0x00020000ULL,
-    kIOPMSleepFactorAutoPowerOffForced      = 0x00040000ULL
+    kIOPMSleepFactorAutoPowerOffForced      = 0x00040000ULL,
+    kIOPMSleepFactorExternalDisplay         = 0x00080000ULL,
+    kIOPMSleepFactorNetworkKeepAliveActive  = 0x00100000ULL,
+    kIOPMSleepFactorLocalUserActivity       = 0x00200000ULL
 };
 
 // System Sleep Types
@@ -712,14 +787,16 @@ enum {
     kIOPMSleepTypeHibernate                 = 4,
     kIOPMSleepTypeStandby                   = 5,
     kIOPMSleepTypePowerOff                  = 6,
-    kIOPMSleepTypeLast                      = 7
+    kIOPMSleepTypeDeepIdle                  = 7,
+    kIOPMSleepTypeLast                      = 8
 };
 
 // System Sleep Flags
 enum {
     kIOPMSleepFlagDisableHibernateAbort     = 0x00000001,
     kIOPMSleepFlagDisableUSBWakeEvents      = 0x00000002,
-    kIOPMSleepFlagDisableBatlowAssertion    = 0x00000004
+    kIOPMSleepFlagDisableBatlowAssertion    = 0x00000004,
+    kIOPMSleepFlagDisableS4WakeSources      = 0x00000008
 };
 
 // System Wake Events
@@ -728,7 +805,12 @@ enum {
     kIOPMWakeEventLidClose                  = 0x00000002,
     kIOPMWakeEventACAttach                  = 0x00000004,
     kIOPMWakeEventACDetach                  = 0x00000008,
+    kIOPMWakeEventCDInsert                  = 0x00000010,
+    kIOPMWakeEventCDEject                   = 0x00000020,
+    kIOPMWakeEventHPDAttach                 = 0x00000040,
+    kIOPMWakeEventHPDDetach                 = 0x00000080,
     kIOPMWakeEventPowerButton               = 0x00000100,
+    kIOPMWakeEventG3PowerOn                 = 0x00000200,
     kIOPMWakeEventUserPME                   = 0x00000400,
     kIOPMWakeEventSleepTimer                = 0x00000800,
     kIOPMWakeEventBatteryLow                = 0x00001000,
@@ -757,7 +839,44 @@ struct IOPMSystemSleepParameters
     uint32_t    reserved2[10];
 } __attribute__((packed));
 
-#ifdef KERNEL
+
+/*
+ * Sleep Wake debug buffer header
+ */
+typedef struct {
+   uint32_t version;
+   uint32_t alloc_size;
+   uint32_t          dlog_buf_offset; /* Offset at which root domain's logging is stored */
+   volatile uint32_t dlog_cur_pos;    /* Offset at which next trace will be copied to */
+   uint32_t          dlog_size;       /* Size reserverd  for root domain's logging */
+   uint32_t          crc;             /* CRC for spindump & following data. Doesn't cover hdr & DLOG buf */
+   uint32_t          spindump_offset; /* Offset at which spindump offset is stored */
+   uint32_t          spindump_size;
+
+   /* All members from UUID onwards are saved into log file */
+   char             UUID[44]; 
+   char             cps[9];          /* Current power state */
+   char             PMStatusCode[100];
+   char             reason[42];
+} swd_hdr; 
+
+#define SWD_BUF_SIZE            (20*PAGE_SIZE)
+#define SWD_DLOG_SIZE           ((4*PAGE_SIZE)-sizeof(swd_hdr))
+
+/* Bits in swd_flags */
+#define SWD_WDOG_ENABLED    0x1
+#define SWD_BOOT_BY_WDOG    0x2
+#define SWD_VALID_LOGS      0x4
+
+
+/* RootDomain IOReporting channels */
+#define kSleepCntChID IOREPORT_MAKEID('S','l','e','e','p','C','n','t')
+#define kDarkWkCntChID IOREPORT_MAKEID('G','U','I','W','k','C','n','t')
+#define kUserWkCntChID IOREPORT_MAKEID('D','r','k','W','k','C','n','t')
+
+
+
+#if defined(KERNEL) && defined(__cplusplus)
 
 /*!
  * @defined kIOPMInstallSystemSleepPolicyHandlerKey
@@ -771,7 +890,8 @@ struct IOPMSystemSleepParameters
         "IOPMInstallSystemSleepPolicyHandler"
 
 typedef IOReturn (*IOPMSystemSleepPolicyHandler)(
-        void * target, const IOPMSystemSleepPolicyVariables * vars,
+        void * target,
+        const IOPMSystemSleepPolicyVariables * vars,
         IOPMSystemSleepParameters * params );
 
 #endif /* KERNEL */