]> git.saurik.com Git - apple/xnu.git/blobdiff - iokit/IOKit/pwr_mgt/IOPMPrivate.h
xnu-6153.41.3.tar.gz
[apple/xnu.git] / iokit / IOKit / pwr_mgt / IOPMPrivate.h
index 55f86b4755ebff900662225a97a96eff6fae7d32..ee04a50724eacc04bc8200fca20f97089dcde411 100644 (file)
 
 #include <IOKit/pwr_mgt/IOPM.h>
 
-#pragma mark PM Timeline Logging
-/**************************************************
-*
-* Timeline API Keys - Reports timing details for 
-*   applications, drivers, and system during PM activity
-*
-* For kernel-internal use only
-**************************************************/
-
-// Keys for interfacing with IOPMrootDomain Timeline
-/* @constant kIOPMTimelineDictionaryKey
- * @abstract RootDomain key for dictionary describing Timeline's info
- */
-#define kIOPMTimelineDictionaryKey              "PMTimelineLogging"
-
-/* @constant kIOPMTimelineEnabledKey
- * @abstract Boolean value indicating whether the system is recording PM events.
- * @discussion Key may be found in the dictionary at IOPMrootDomain's property 
- * kIOPMTimelineDictionaryKey. uint32_t value; may be 0.
- */
-#define kIOPMTimelineEnabledKey                 "TimelineEnabled"
-
-/* @constant kIOMPTimelineSystemNumberTrackedKey
- * @abstract The maximum number of system power events the system may record.
- * @discussion Key may be found in the dictionary at IOPMrootDomain's property 
- * kIOPMTimelineDictionaryKey. uint32_t value; may be 0.
- */
-#define kIOPMTimelineSystemNumberTrackedKey     "TimelineSystemEventsTracked"
-
-/* @constant kIOPMTimelineSystemBufferSizeKey
- * @abstract Size in bytes  of buffer recording system PM events
- * @discussion Key may be found in the dictionary at IOPMrootDomain's property 
- * kIOPMTimelineDictionaryKey. uint32_t value; may be 0.
- */
-#define kIOPMTimelineSystemBufferSizeKey        "TimelineSystemBufferSize"
-
-
-
 /* @constant kIOPMEventTypeIntermediateFlag
  * @abstract This bit indicates the event is an intermediate event
  *      which must occur within a major system power event.
@@ -78,9 +40,9 @@
  * @abstract Potential system events logged in the system event record.
  */
 enum {
-       kIOPMEventTypeUndefined                     = 0,
+    kIOPMEventTypeUndefined                     = 0,
 
-    /* Event types mark driver events 
+    /* Event types mark driver events
      */
     kIOPMEventTypeSetPowerStateImmediate        = 1001,
     kIOPMEventTypeSetPowerStateDelayed          = 1002,
@@ -92,18 +54,14 @@ 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,
+    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 +76,40 @@ 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)
+
+#define kIOPMMessageIdleSleepPreventers \
+                iokit_family_msg(sub_iokit_powermanagement, 0x420)
 
-/* @enum SystemSleepReasons 
+#define kIOPMMessageSystemSleepPreventers \
+                iokit_family_msg(sub_iokit_powermanagement, 0x430)
+
+#define kIOPMMessageLaunchBootSpinDump \
+                iokit_family_msg(sub_iokit_powermanagement, 0x440)
+
+#define kIOPMMessageProModeStateChange \
+                iokit_family_msg(sub_iokit_powermanagement, 0x450)
+
+/* @enum SystemSleepReasons
  * @abstract The potential causes for system sleep as logged in the system event record.
  */
 enum {
@@ -148,81 +138,14 @@ enum {
 #define kIOPMSleepServiceExitKey                    "Sleep Service Back to Sleep"
 #define kIOPMDarkWakeThermalEmergencyKey            "Dark Wake Thermal Emergency"
 
-
-enum {
-    kIOPMMaxSystemEventsTracked = 25000,
-    kIOPMDefaultSystemEventsTracked = 1000,
-    kMaxPMStringLength = 40,
-};
-
-/* @struct IOPMSystemEventRecord
- * @abstract Records a singe power event to a particular PM entity.
- * This includes changes to a driver's power state, application responses
- * to PM notifications, or system power management milestones.
- */
-typedef struct {
-    union {
-        // For DRIVER events
-        char        ownerName[kMaxPMStringLength];
-        // For SYSTEM events, uuid contains the string describing the active UUID
-        char        uuid[kMaxPMStringLength];
-    };
-
-    // For DRIVER events - records the name of the driver who generated the notifications.
-    char        interestName[kMaxPMStringLength];
-    
-    // DRIVER & SYSTEM - Times are stored as uint64_t
-    // The high 32 bytes are the seconds returned from clock_get_calendar_microtime, 
-    // and the low 32 bytes are the accompanying microseconds.
-    uint64_t    timestamp;
-
-    union {
-        // For DRIVER events - ownerDisambiguateID is a unique descriptor of the driver, to disambiguate
-        // several similarly named drivers.
-        uint64_t    ownerDisambiguateID;
-        // For SYSTEM events - eventReason is a value in SystemSleepReason
-        uint64_t    eventReason;
-    };
-    
-    // DRIVER & SYSTEM - eventType is one of 'SystemEventTypes'
-    // The value of eventType determines, among ohter things, whether this is a SYSTEM or
-    //      DRIVER event type.
-    uint32_t    eventType;
-
-    // DRIVER & SYSTEM - eventResult is an IOReturn value
-    uint32_t    eventResult;
-
-    // DRIVER - If defined, elapsedTimeUS records the entire time a transaction took to complete
-    uint32_t    elapsedTimeUS;
-
-    // DRIVER - in power state changes, oldState & newState are PM power state indices.
-    uint8_t     oldState;
-    uint8_t     newState;
-} IOPMSystemEventRecord;
-
-/* @struct IOPMTraceBufferHeader
- * Occupies the first bytes in the buffer allocated by IOPMrootDomain
- * Describes the size and current index of the trace buffer
- */
-typedef struct {
-       uint32_t        sizeBytes;
-       uint32_t    sizeEntries;
-       uint32_t    index;
-} IOPMTraceBufferHeader;
-
-/* Argument to IOPMrootDomain::clientMemoryForType to acquire
- * memory mapping.
- */
-enum {
-    kPMRootDomainMapTraceBuffer = 1
-};
-
-/**************************************************
-*
-* Accountability API Ends here
-*
-**************************************************/
-
+/*! kIOPMPSRestrictedModeKey
+ *  An IOPMPowerSource property key
+ *  Its property has an integer value.
+ *  - value = 1 when the device is in a low power state and not fully functional.
+ *  - value = 0, or property missing altogether, when the device is
+ *      not in a restricted mode power state.
+*/
+#define kIOPMPSRestrictedModeKey                    "RestrictedMode"
 
 #pragma mark Stray Bitfields
 // Private power commands issued to root domain
@@ -258,11 +181,12 @@ enum {
  */
 #define kIOPMSettingSleepServiceWakeCalendarKey     "SleepServiceWakeCalendarKey"
 
-/*! @constant kIOPMCalendarWakeTypes 
+/*! @constant kIOPMCalendarWakeTypes
  *
  * These are valid values for IOPM.h:IOPMCalendarStruct->selector
  */
 enum {
+    kPMCalendarTypeInvalid = 0,
     kPMCalendarTypeMaintenance = 1,
     kPMCalendarTypeSleepService = 2
 };
@@ -298,7 +222,12 @@ enum {
  * @abstract Shutdown is in progress and irrevocable.
  * @discussion State remains 4 until power is removed from CPU.
  */
-    kIOPMStateConsoleShutdownCertain = 4
+    kIOPMStateConsoleShutdownCertain = 4,
+/* @constant kIOPMStateConsoleSULogoutInitiated
+   Indicates that LoginWindow has initiated a software update restart.
+   The next logout will not immediately lead to a shutdown.
+ */
+    kIOPMStateConsoleSULogoutInitiated = 5
 };
 
 /* @constant kIOPMSettingSilentRunningKey
@@ -320,7 +249,7 @@ enum {
 /*****************************************************************************/
 /*****************************************************************************/
 
-/* PM Statistics - event indices 
+/* PM Statistics - event indices
  * These are arguments to IOPMrootDomain::pmStatsRecordEvent().
  */
 enum {
@@ -330,8 +259,8 @@ enum {
     kIOPMStatsApplicationNotify,
     kIOPMStatsLateDriverAcknowledge,
     kIOPMStatsLateAppAcknowledge,
-    
-    // To designate if you're specifying the start or stop end of 
+
+    // To designate if you're specifying the start or stop end of
     // each of the above events, do a bitwise OR of the appropriate
     // Start/Stop flag and pass the result to IOPMrootDomain to record
     // the event.
@@ -342,6 +271,10 @@ enum {
 // Keys for IOPMrootDomain registry properties
 #define kIOPMSleepStatisticsKey                 "SleepStatistics"
 #define kIOPMSleepStatisticsAppsKey             "AppStatistics"
+#define kIOPMIdleSleepPreventersKey             "IdleSleepPreventers"
+#define kIOPMSystemSleepPreventersKey           "SystemSleepPreventers"
+#define kIOPMIdleSleepPreventersWithIDKey       "IdleSleepPreventersWithID"
+#define kIOPMSystemSleepPreventersWithIDKey     "SystemSleepPreventersWithID"
 
 // Application response statistics
 #define kIOPMStatsNameKey                       "Name"
@@ -349,26 +282,30 @@ enum {
 #define kIOPMStatsTimeMSKey                     "TimeMS"
 #define kIOPMStatsApplicationResponseTypeKey    "ResponseType"
 #define kIOPMStatsMessageTypeKey                "MessageType"
+#define kIOPMStatsPowerCapabilityKey            "PowerCaps"
+#define kIOPMStatsSystemTransitionKey           "TransitionType"
+
 // PM Statistics: potential values for the key kIOPMStatsApplicationResponseTypeKey
 // entry in the application results array.
 #define kIOPMStatsResponseTimedOut      "ResponseTimedOut"
 #define kIOPMStatsResponseCancel        "ResponseCancel"
 #define kIOPMStatsResponseSlow          "ResponseSlow"
+#define kIOPMStatsResponsePrompt        "ResponsePrompt"
+#define kIOPMStatsDriverPSChangeSlow    "DriverPSChangeSlow"
 
 struct PMStatsBounds{
     uint64_t start;
     uint64_t stop;
 };
 typedef struct {
-    
+
     struct PMStatsBounds    hibWrite;
     struct PMStatsBounds    hibRead;
 //    bounds    driverNotifySleep;
 //    bounds    driverNotifyWake;
 //    bounds    appNotifySleep;
-//    bounds    appNotifyWake;  
-//    OSDictionary    *tardyApps;    
+//    bounds    appNotifyWake;
+//    OSDictionary    *tardyApps;
 //    OSDictionary    *tardyDrivers;
 } PMStatsStruct;
 
@@ -423,7 +360,7 @@ enum {
  * Phase ends: All notified clients have acknowledged.
  */
     kIOPMTracePointSleepPriorityClients         = 0x12,
-    
+
 /* When kIOPMTracePointSleepWillChangeInterests is the latest tracePoint,
  * PM is calling powerStateWillChangeTo() on interested drivers of root domain.
  *
@@ -443,7 +380,7 @@ enum {
  *      change have completed.
  */
     kIOPMTracePointSleepPowerPlaneDrivers       = 0x14,
-    
+
 /* When kIOPMTracePointSleepDidChangeInterests is the latest tracePoint,
  * PM is calling powerStateDidChangeTo() on interested drivers of root domain.
  *
@@ -578,7 +515,7 @@ enum {
  * in case any user errors occurred that we could not detect in software.
  *
  * Phase begins: After IOPMrootDomain sends kIOMessageSystemHasPoweredOn message.
- * Phase ends: When loginwindow calls IOPMSleepWakeSetUUID(NULL) the system shall 
+ * Phase ends: When loginwindow calls IOPMSleepWakeSetUUID(NULL) the system shall
  *      be considered awake and usable. The next phase shall be kIOPMTracePointSystemUp.
  */
     kIOPMTracePointSystemLoginwindowPhase       = 0x30,
@@ -603,10 +540,49 @@ enum {
 /*****************************************************************************/
 
 /*
-Ê* kIOPMLoginWindowSecurityDebugKey - identifies PM debug data specific to LoginWindow
- *  for use with IOPMrootDomain.
-Ê*/
-#define kIOPMLoginWindowSecurityDebugKey        "LoginWindowSecurity"
+ * Component wake progress keys
+ *
+ * Certain components have the ability to log their wake progress with
+ * root domain using the keys provided below.
+ *
+ * LoginWindow - 4 bits
+ * CoreDisplay - 8 bits
+ * CoreGraphics - 8 bits
+ *
+ * These bits are stored with the trace phase that gets logged to
+ * the RTC register.
+ */
+
+// Values that should be passed in to IOPMLogWakeProgress
+enum {
+    kIOPMLoginWindowProgress    = 1,
+    kIOPMCoreDisplayProgress    = 2,
+    kIOPMCoreGraphicsProgress   = 3
+};
+
+enum {
+    kIOPMLoginWindowProgressMask    = 0x0f,
+    kIOPMCoreDisplayProgressMask    = 0xff,
+    kIOPMCoreGraphicsProgressMask   = 0xff
+};
+
+/*
+ * kIOPMLoginWindowProgressKey - identifies PM debug data specific to LoginWindow
+ *  for use with IOPMrootDomain. Only 4 bits of data are allotted.
+ */
+#define kIOPMLoginWindowProgressKey             "LoginWindowProgress"
+
+/*
+ * kIOPMCoreDisplayProgressKey - identifies PM debug data specific to CoreDisplay
+ *  for use with IOPMrootDomain. Only 8 bits of data are allotted.
+ */
+#define kIOPMCoreDisplayProgressKey             "CoreDisplayProgress"
+
+/*
+ * kIOPMCoreGraphicsProgressKey - identifies PM debug data specific to CoreGraphics
+ *  for use with IOPMrootDomain. Only 8 bits of data are allotted.
+ */
+#define kIOPMCoreGraphicsProgressKey            "CoreGraphicsProgress"
 
 // For PM internal use only - key to locate sleep failure results within SCDynamicStore.
 #define kIOPMDynamicStoreSleepFailureKey        "SleepFailure"
@@ -619,6 +595,8 @@ enum {
 #define kIOPMSleepWakeFailureLoginKey       "LWFailurePhase"
 #define kIOPMSleepWakeFailureUUIDKey        "UUID"
 #define kIOPMSleepWakeFailureDateKey        "Date"
+#define kIOPMSleepWakeWdogRebootKey         "SWWdogTriggeredRestart"
+#define kIOPMSleepWakeWdogLogsValidKey      "SWWdogLogsValid"
 
 /*****************************************************************************
  *
@@ -654,6 +632,13 @@ enum {
  */
 #define kIOPMAutoPowerOffTimerKey           "AutoPowerOff Timer"
 
+/* kIOPMDeepSleepTimerKey
+ * Key refers to a CFNumberRef that indicates the time in seconds until the
+ * expiration of the Standby delay period. This value should be used
+ * to program a wake alarm before system sleep.
+ */
+#define kIOPMDeepSleepTimerKey                "Standby Timer"
+
 /* kIOPMUserWakeAlarmScheduledKey
  * Key refers to a boolean value that indicates if an user alarm was scheduled
  * or pending.
@@ -666,6 +651,126 @@ enum {
  */
 #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"
+
+/* kIOPMDriverWakeEventsKey
+ * Key refers to a property that should only be examined by powerd.
+ */
+#define kIOPMDriverWakeEventsKey            "IOPMDriverWakeEvents"
+
+/*****************************************************************************
+ *
+ * IOPMDriverWakeEvents dictionary keys
+ *
+ *****************************************************************************/
+
+#define kIOPMWakeEventTimeKey               "Time"
+#define kIOPMWakeEventFlagsKey              "Flags"
+#define kIOPMWakeEventReasonKey             "Reason"
+#define kIOPMWakeEventDetailsKey            "Details"
+
+/* kIOPMFeatureProModeKey
+ * Feature published if ProMode is supported
+ */
+#define kIOPMFeatureProModeKey              "ProMode"
+
+/*****************************************************************************
+ *
+ * Wake event flags reported to IOPMrootDomain::claimSystemWakeEvent()
+ *
+ *****************************************************************************/
+
+#define kIOPMWakeEventSource                0x00000001
+
+#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146))
+/*****************************************************************************
+ *
+ * AOT defs
+ *
+ *****************************************************************************/
+
+// signals the device should wake up to user space running
+#define kIOPMWakeEventAOTExit                   0x00000002
+
+// will start a 400 ms timer before sleeping
+#define kIOPMWakeEventAOTPossibleExit           0x00000004
+
+// signals the device should wake up to user space running
+#define kIOPMWakeEventAOTConfirmedPossibleExit  0x00000008
+
+// signals the device should go back to AOT
+#define kIOPMWakeEventAOTRejectedPossibleExit   0x00000010
+
+// signals the device should go back to AOT
+#define kIOPMWakeEventAOTExpiredPossibleExit    0x00000020
+
+#define kIOPMWakeEventAOTFlags \
+                                 (kIOPMWakeEventAOTExit \
+                                | kIOPMWakeEventAOTPossibleExit \
+                                | kIOPMWakeEventAOTConfirmedPossibleExit \
+                                | kIOPMWakeEventAOTRejectedPossibleExit \
+                                | kIOPMWakeEventAOTExpiredPossibleExit)
+
+#define kIOPMWakeEventAOTPossibleFlags \
+                                 (kIOPMWakeEventAOTPossibleExit \
+                                | kIOPMWakeEventAOTConfirmedPossibleExit \
+                                | kIOPMWakeEventAOTRejectedPossibleExit \
+                                | kIOPMWakeEventAOTExpiredPossibleExit)
+
+#define kIOPMWakeEventAOTPerCycleFlags \
+                                 (kIOPMWakeEventAOTPossibleExit \
+                                | kIOPMWakeEventAOTRejectedPossibleExit \
+                                | kIOPMWakeEventAOTExpiredPossibleExit)
+
+#define kIOPMWakeEventAOTExitFlags \
+                                 (kIOPMWakeEventAOTExit \
+                                | kIOPMWakeEventAOTConfirmedPossibleExit)
+
+enum {
+    kIOPMAOTModeEnable        = 0x00000001,
+    kIOPMAOTModeCycle         = 0x00000002,
+    kIOPMAOTModeAddEventFlags = 0x00000004,
+    kIOPMAOTModeRespectTimers = 0x00000008,
+    kIOPMAOTModeDefault       = (kIOPMAOTModeEnable | kIOPMAOTModeAddEventFlags | kIOPMAOTModeRespectTimers)
+};
+
+enum {
+    kIOPMAOTMetricsKernelWakeCountMax = 24
+};
+
+struct IOPMAOTMetrics
+{
+    uint32_t sleepCount;
+    uint32_t possibleCount;
+    uint32_t confirmedPossibleCount;
+    uint32_t rejectedPossibleCount;
+    uint32_t expiredPossibleCount;
+    uint32_t noTimeSetCount;
+    uint32_t rtcAlarmsCount;
+    uint32_t softwareRequestCount;
+    uint64_t totalTime;
+
+       char     kernelWakeReason[kIOPMAOTMetricsKernelWakeCountMax][64];
+       // 54:10 secs:ms calendar time
+    uint64_t kernelSleepTime[kIOPMAOTMetricsKernelWakeCountMax];
+    uint64_t kernelWakeTime[kIOPMAOTMetricsKernelWakeCountMax];
+};
+
+#define kIOPMAOTPowerKey    "aot-power"
+
+#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */
+
 /*****************************************************************************
  *
  * System Sleep Policy
@@ -681,7 +786,8 @@ enum {
  * @discussion An OSNumber property of root domain that describes the type
  * of system sleep. This property is set after notifying priority sleep/wake
  * clients, but before informing interested drivers and shutting down power
- * plane drivers.
+ * plane drivers. On a hibernate abort or failure, this property will not be
+ * updated and will indicate the failed sleep type.
  */
 #define kIOPMSystemSleepTypeKey             "IOPMSystemSleepType"
 
@@ -699,6 +805,7 @@ struct IOPMSystemSleepPolicyVariables
     uint32_t    hibernateMode;              // current hibernate mode
 
     uint32_t    standbyDelay;               // standby delay in seconds
+    uint32_t    standbyTimer;               // standby timer 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
@@ -737,7 +844,12 @@ enum {
     kIOPMSleepFactorHibernateForced         = 0x00010000ULL,
     kIOPMSleepFactorAutoPowerOffDisabled    = 0x00020000ULL,
     kIOPMSleepFactorAutoPowerOffForced      = 0x00040000ULL,
-    kIOPMSleepFactorExternalDisplay         = 0x00080000ULL
+    kIOPMSleepFactorExternalDisplay         = 0x00080000ULL,
+    kIOPMSleepFactorNetworkKeepAliveActive  = 0x00100000ULL,
+    kIOPMSleepFactorLocalUserActivity       = 0x00200000ULL,
+    kIOPMSleepFactorHibernateFailed         = 0x00400000ULL,
+    kIOPMSleepFactorThermalWarning          = 0x00800000ULL,
+    kIOPMSleepFactorDisplayCaptured         = 0x01000000ULL
 };
 
 // System Sleep Types
@@ -757,7 +869,8 @@ enum {
 enum {
     kIOPMSleepFlagDisableHibernateAbort     = 0x00000001,
     kIOPMSleepFlagDisableUSBWakeEvents      = 0x00000002,
-    kIOPMSleepFlagDisableBatlowAssertion    = 0x00000004
+    kIOPMSleepFlagDisableBatlowAssertion    = 0x00000004,
+    kIOPMSleepFlagDisableS4WakeSources      = 0x00000008
 };
 
 // System Wake Events
@@ -775,7 +888,18 @@ enum {
     kIOPMWakeEventUserPME                   = 0x00000400,
     kIOPMWakeEventSleepTimer                = 0x00000800,
     kIOPMWakeEventBatteryLow                = 0x00001000,
-    kIOPMWakeEventDarkPME                   = 0x00002000
+    kIOPMWakeEventDarkPME                   = 0x00002000,
+    kIOPMWakeEventWifi                      = 0x00004000,
+    kIOPMWakeEventRTCSystem                 = 0x00008000,  // Maintenance RTC wake
+    kIOPMWakeEventUSBCPlugin                = 0x00010000,  // USB-C Plugin
+    kIOPMWakeEventHID                       = 0x00020000,
+    kIOPMWakeEventBluetooth                 = 0x00040000,
+    kIOPMWakeEventDFR                       = 0x00080000,
+    kIOPMWakeEventSD                        = 0x00100000,  // SD card
+    kIOPMWakeEventLANWake                   = 0x00200000,  // Wake on Lan
+    kIOPMWakeEventLANPlugin                 = 0x00400000,  // Ethernet media sense
+    kIOPMWakeEventThunderbolt               = 0x00800000,
+    kIOPMWakeEventRTCUser                   = 0x01000000,  // User requested RTC wake
 };
 
 /*!
@@ -800,6 +924,84 @@ struct IOPMSystemSleepParameters
     uint32_t    reserved2[10];
 } __attribute__((packed));
 
+
+/*
+ * Sleep Wake debug buffer header
+ */
+typedef struct {
+   uint32_t signature;
+   uint32_t alloc_size;
+   uint32_t          crc;             /* CRC for spindump & following data.*/
+   uint32_t          spindump_offset; /* Offset at which spindump offset is stored */
+   uint32_t          spindump_size;
+   uint8_t           is_osx_watchdog;
+
+   /* All members from UUID onwards are saved into log file */
+   char             UUID[44];
+   char             spindump_status[24];   /* stackshot status*/
+   char             PMStatusCode[32];
+   char             reason[32];
+} swd_hdr;
+
+
+#define SWD_HDR_SIGNATURE       0xdeb8da2a
+
+#define SWD_STACKSHOT_SIZE      (40*PAGE_SIZE)
+#define SWD_COMPRESSED_BUFSIZE  (5*PAGE_SIZE)
+#define SWD_ZLIB_BUFSIZE        (10*PAGE_SIZE)
+#define SWD_STACKSHOT_VAR_PREFIX    "sleepwake_diags"
+
+#define SWD_SPINDUMP_SIZE          (256*1024)
+#define SWD_INITIAL_SPINDUMP_SIZE  ((SWD_SPINDUMP_SIZE/2)-sizeof(swd_hdr))
+#define SWD_MAX_STACKSHOTS          (10)
+
+/* Bits in swd_flags */
+#define SWD_WDOG_ENABLED        0x01
+#define SWD_BOOT_BY_SW_WDOG     0x02
+#define SWD_BOOT_BY_OSX_WDOG    0x04
+#define SWD_VALID_LOGS          0x08
+#define SWD_LOGS_IN_FILE        0x10
+#define SWD_LOGS_IN_MEM         0x20
+#define SWD_PWR_BTN_STACKSHOT   0x30
+
+#define SWD_DATA_CRC_ERROR      0x010000
+#define SWD_BUF_SIZE_ERROR      0x020000
+#define SWD_HDR_SIZE_ERROR      0x040000
+#define SWD_FILEOP_ERROR        0x080000
+#define SWD_HDR_SIGNATURE_ERROR 0x100000
+#define SWD_INTERNAL_FAILURE    0x200000
+
+
+/* Filenames associated with the stackshots/logs generated by the SWD */
+#define kOSWatchdogStacksFilename           "/var/log/OSXWatchdogStacks.gz"
+#define kOSWatchdogFailureStringFile        "/var/log/OSWatchdogFailureString.txt"
+#define kSleepWakeStacksFilename            "/var/log/SleepWakeStacks.gz"
+#define kSleepWakeFailureStringFile         "/var/log/SleepWakeFailureString.txt"
+
+
+/* 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')
+
+/*
+ * kAssertDelayChID - Histogram of time elapsed before assertion after wake.
+ */
+#define kAssertDelayBcktCnt     11
+#define kAssertDelayBcktSize    3
+#define kAssertDelayChID IOREPORT_MAKEID('r','d','A','s','r','t','D','l')
+
+/*
+ * kSleepDelaysChID - Histogram of time taken to put system to sleep
+ */
+#define kSleepDelaysBcktCnt     13
+#define kSleepDelaysBcktSize    10
+#define kSleepDelaysChID IOREPORT_MAKEID('r','d','S','l','p','D','l','y')
+
+/* Sleep Options/settings */
+#define kSleepOptionDisplayCapturedModeKey         "DisplayCapturedMode"
+
+
 #if defined(KERNEL) && defined(__cplusplus)
 
 /*!
@@ -810,7 +1012,7 @@ struct IOPMSystemSleepParameters
  * register a sleep policy handler. Only a single sleep policy handler can
  * be installed.
  */
-#define kIOPMInstallSystemSleepPolicyHandlerKey        \
+#define kIOPMInstallSystemSleepPolicyHandlerKey \
         "IOPMInstallSystemSleepPolicyHandler"
 
 typedef IOReturn (*IOPMSystemSleepPolicyHandler)(
@@ -820,4 +1022,22 @@ typedef IOReturn (*IOPMSystemSleepPolicyHandler)(
 
 #endif /* KERNEL */
 
+/*****************************************************************************
+ *
+ * Performance Warning
+ *
+ *****************************************************************************/
+
+/* Performance Warning Key
+ * Key for performance warning event published using IOPMrootDomain::
+ * systemPowerEventOccurred()
+ */
+#define kIOPMPerformanceWarningKey          "Performance_Warning"
+
+/* Performance warning values */
+enum {
+  kIOPMPerformanceNormal    = 0,
+  kIOPMPerformanceWarning   = 100
+};
+
 #endif /* ! _IOKIT_IOPMPRIVATE_H */