+ OSDictionary *features =
+ (OSDictionary *) getProperty(kRootDomainSupportedFeatures);
+
+ if (features && OSDynamicCast(OSDictionary, features)) {
+ // Any modifications to the dictionary are made to the copy to prevent
+ // races & crashes with userland clients. Dictionary updated
+ // automically later.
+ features = OSDictionary::withDictionary(features);
+ } else {
+ features = NULL;
+ ret = kIOReturnNotFound;
+ goto exit;
+ }
+
+ // We iterate 'features' dictionary looking for an entry tagged
+ // with 'removeFeatureID'. If found, we remove it from our tracking
+ // structures and notify the OS via a general interest message.
+
+ dictIterator = OSCollectionIterator::withCollection(features);
+ if (!dictIterator) {
+ goto exit;
+ }
+
+ while ((dictKey = OSDynamicCast(OSSymbol, dictIterator->getNextObject()))) {
+ osObj = features->getObject(dictKey);
+
+ // Each Feature is either tracked by an OSNumber
+ if (osObj && (numberMember = OSDynamicCast(OSNumber, osObj))) {
+ feature_value = numberMember->unsigned32BitValue();
+ feature_id = (uint16_t)(feature_value >> 16);
+
+ if (feature_id == (uint16_t)removeFeatureID) {
+ // Remove this node
+ features->removeObject(dictKey);
+ madeAChange = true;
+ break;
+ }
+
+ // Or tracked by an OSArray of OSNumbers
+ } else if (osObj && (arrayMember = OSDynamicCast(OSArray, osObj))) {
+ unsigned int arrayCount = arrayMember->getCount();
+
+ for (unsigned int i = 0; i < arrayCount; i++) {
+ osNum = OSDynamicCast(OSNumber, arrayMember->getObject(i));
+ if (!osNum) {
+ continue;
+ }
+
+ feature_value = osNum->unsigned32BitValue();
+ feature_id = (uint16_t)(feature_value >> 16);
+
+ if (feature_id == (uint16_t)removeFeatureID) {
+ // Remove this node
+ if (1 == arrayCount) {
+ // If the array only contains one element, remove
+ // the whole thing.
+ features->removeObject(dictKey);
+ } else {
+ // Otherwise remove the element from a copy of the array.
+ arrayMemberCopy = OSArray::withArray(arrayMember);
+ if (arrayMemberCopy) {
+ arrayMemberCopy->removeObject(i);
+ features->setObject(dictKey, arrayMemberCopy);
+ arrayMemberCopy->release();
+ }
+ }
+
+ madeAChange = true;
+ break;
+ }
+ }
+ }
+ }
+
+ dictIterator->release();
+
+ if (madeAChange) {
+ ret = kIOReturnSuccess;
+
+ setProperty(kRootDomainSupportedFeatures, features);
+
+ // Notify EnergySaver and all those in user space so they might
+ // re-populate their feature specific UI
+ if (pmPowerStateQueue) {
+ pmPowerStateQueue->submitPowerEvent( kPowerEventFeatureChanged );
+ }
+ } else {
+ ret = kIOReturnNotFound;
+ }
+
+exit:
+ if (features) {
+ features->release();
+ }
+ if (featuresDictLock) {
+ IOLockUnlock(featuresDictLock);
+ }
+ return ret;
+}
+
+//******************************************************************************
+// publishPMSetting (private)
+//
+// Should only be called by PMSettingObject to publish a PM Setting as a
+// supported feature.
+//******************************************************************************
+
+void
+IOPMrootDomain::publishPMSetting(
+ const OSSymbol * feature, uint32_t where, uint32_t * featureID )
+{
+ if (noPublishPMSettings &&
+ (noPublishPMSettings->getNextIndexOfObject(feature, 0) != (unsigned int)-1)) {
+ // Setting found in noPublishPMSettings array
+ *featureID = kBadPMFeatureID;
+ return;
+ }
+
+ publishFeature(
+ feature->getCStringNoCopy(), where, featureID);
+}
+
+//******************************************************************************
+// setPMSetting (private)
+//
+// Internal helper to relay PM settings changes from user space to individual
+// drivers. Should be called only by IOPMrootDomain::setProperties.
+//******************************************************************************
+
+IOReturn
+IOPMrootDomain::setPMSetting(
+ const OSSymbol *type,
+ OSObject *object )
+{
+ PMSettingCallEntry *entries = NULL;
+ OSArray *chosen = NULL;
+ const OSArray *array;
+ PMSettingObject *pmso;
+ thread_t thisThread;
+ int i, j, count, capacity;
+
+ if (NULL == type) {
+ return kIOReturnBadArgument;
+ }
+
+ PMSETTING_LOCK();
+
+ // Update settings dict so changes are visible from copyPMSetting().
+ fPMSettingsDict->setObject(type, object);
+
+ // Prep all PMSetting objects with the given 'type' for callout.
+ array = OSDynamicCast(OSArray, settingsCallbacks->getObject(type));
+ if (!array || ((capacity = array->getCount()) == 0)) {
+ goto unlock_exit;
+ }
+
+ // Array to retain PMSetting objects targeted for callout.
+ chosen = OSArray::withCapacity(capacity);
+ if (!chosen) {
+ goto unlock_exit; // error
+ }
+ entries = IONew(PMSettingCallEntry, capacity);
+ if (!entries) {
+ goto unlock_exit; // error
+ }
+ memset(entries, 0, sizeof(PMSettingCallEntry) * capacity);
+
+ thisThread = current_thread();
+
+ for (i = 0, j = 0; i < capacity; i++) {
+ pmso = (PMSettingObject *) array->getObject(i);
+ if (pmso->disabled) {
+ continue;
+ }
+ entries[j].thread = thisThread;
+ queue_enter(&pmso->calloutQueue, &entries[j], PMSettingCallEntry *, link);
+ chosen->setObject(pmso);
+ j++;
+ }
+ count = j;
+ if (!count) {
+ goto unlock_exit;
+ }
+
+ PMSETTING_UNLOCK();
+
+ // Call each pmso in the chosen array.
+ for (i = 0; i < count; i++) {
+ pmso = (PMSettingObject *) chosen->getObject(i);
+ pmso->dispatchPMSetting(type, object);
+ }
+
+ PMSETTING_LOCK();
+ for (i = 0; i < count; i++) {
+ pmso = (PMSettingObject *) chosen->getObject(i);
+ queue_remove(&pmso->calloutQueue, &entries[i], PMSettingCallEntry *, link);
+ if (pmso->waitThread) {
+ PMSETTING_WAKEUP(pmso);
+ }
+ }
+unlock_exit:
+ PMSETTING_UNLOCK();
+
+ if (chosen) {
+ chosen->release();
+ }
+ if (entries) {
+ IODelete(entries, PMSettingCallEntry, capacity);
+ }
+
+ return kIOReturnSuccess;
+}
+
+//******************************************************************************
+// copyPMSetting (public)
+//
+// Allows kexts to safely read setting values, without being subscribed to
+// notifications.
+//******************************************************************************
+
+OSObject *
+IOPMrootDomain::copyPMSetting(
+ OSSymbol *whichSetting)
+{
+ OSObject *obj = NULL;
+
+ if (!whichSetting) {
+ return NULL;
+ }
+
+ PMSETTING_LOCK();
+ obj = fPMSettingsDict->getObject(whichSetting);
+ if (obj) {
+ obj->retain();
+ }
+ PMSETTING_UNLOCK();
+
+ return obj;
+}
+
+//******************************************************************************
+// registerPMSettingController (public)
+//
+// direct wrapper to registerPMSettingController with uint32_t power source arg
+//******************************************************************************
+
+IOReturn
+IOPMrootDomain::registerPMSettingController(
+ const OSSymbol * settings[],
+ IOPMSettingControllerCallback func,
+ OSObject *target,
+ uintptr_t refcon,
+ OSObject **handle)
+{
+ return registerPMSettingController(
+ settings,
+ (kIOPMSupportedOnAC | kIOPMSupportedOnBatt | kIOPMSupportedOnUPS),
+ func, target, refcon, handle);
+}
+
+//******************************************************************************
+// registerPMSettingController (public)
+//
+// Kexts may register for notifications when a particular setting is changed.
+// A list of settings is available in IOPM.h.
+// Arguments:
+// * settings - An OSArray containing OSSymbols. Caller should populate this
+// array with a list of settings caller wants notifications from.
+// * func - A C function callback of the type IOPMSettingControllerCallback
+// * target - caller may provide an OSObject *, which PM will pass as an
+// target to calls to "func"
+// * refcon - caller may provide an void *, which PM will pass as an
+// argument to calls to "func"
+// * handle - This is a return argument. We will populate this pointer upon
+// call success. Hold onto this and pass this argument to
+// IOPMrootDomain::deRegisterPMSettingCallback when unloading your kext
+// Returns:
+// kIOReturnSuccess on success
+//******************************************************************************
+
+IOReturn
+IOPMrootDomain::registerPMSettingController(
+ const OSSymbol * settings[],
+ uint32_t supportedPowerSources,
+ IOPMSettingControllerCallback func,
+ OSObject *target,
+ uintptr_t refcon,
+ OSObject **handle)
+{
+ PMSettingObject *pmso = NULL;
+ OSObject *pmsh = NULL;
+ OSArray *list = NULL;
+ int i;
+
+ if (NULL == settings ||
+ NULL == func ||
+ NULL == handle) {
+ return kIOReturnBadArgument;
+ }
+
+ pmso = PMSettingObject::pmSettingObject(
+ (IOPMrootDomain *) this, func, target,
+ refcon, supportedPowerSources, settings, &pmsh);
+
+ if (!pmso) {
+ *handle = NULL;
+ return kIOReturnInternalError;
+ }
+
+ PMSETTING_LOCK();
+ for (i = 0; settings[i]; i++) {
+ list = OSDynamicCast(OSArray, settingsCallbacks->getObject(settings[i]));
+ if (!list) {
+ // New array of callbacks for this setting
+ list = OSArray::withCapacity(1);
+ settingsCallbacks->setObject(settings[i], list);
+ list->release();
+ }
+
+ // Add caller to the callback list
+ list->setObject(pmso);
+ }
+ PMSETTING_UNLOCK();
+
+ // Return handle to the caller, the setting object is private.
+ *handle = pmsh;
+
+ return kIOReturnSuccess;
+}
+
+//******************************************************************************
+// deregisterPMSettingObject (private)
+//
+// Only called from PMSettingObject.
+//******************************************************************************
+
+void
+IOPMrootDomain::deregisterPMSettingObject( PMSettingObject * pmso )
+{
+ thread_t thisThread = current_thread();
+ PMSettingCallEntry *callEntry;
+ OSCollectionIterator *iter;
+ OSSymbol *sym;
+ OSArray *array;
+ int index;
+ bool wait;
+
+ PMSETTING_LOCK();
+
+ pmso->disabled = true;
+
+ // Wait for all callout threads to finish.
+ do {
+ wait = false;
+ queue_iterate(&pmso->calloutQueue, callEntry, PMSettingCallEntry *, link)
+ {
+ if (callEntry->thread != thisThread) {
+ wait = true;
+ break;
+ }
+ }
+ if (wait) {
+ assert(NULL == pmso->waitThread);
+ pmso->waitThread = thisThread;
+ PMSETTING_WAIT(pmso);
+ pmso->waitThread = NULL;
+ }
+ } while (wait);
+
+ // Search each PM settings array in the kernel.
+ iter = OSCollectionIterator::withCollection(settingsCallbacks);
+ if (iter) {
+ while ((sym = OSDynamicCast(OSSymbol, iter->getNextObject()))) {
+ array = OSDynamicCast(OSArray, settingsCallbacks->getObject(sym));
+ index = array->getNextIndexOfObject(pmso, 0);
+ if (-1 != index) {
+ array->removeObject(index);
+ }
+ }
+ iter->release();
+ }
+
+ PMSETTING_UNLOCK();
+
+ pmso->release();
+}
+
+//******************************************************************************
+// informCPUStateChange
+//
+// Call into PM CPU code so that CPU power savings may dynamically adjust for
+// running on battery, with the lid closed, etc.
+//
+// informCPUStateChange is a no-op on non x86 systems
+// only x86 has explicit support in the IntelCPUPowerManagement kext
+//******************************************************************************
+
+void
+IOPMrootDomain::informCPUStateChange(
+ uint32_t type,
+ uint32_t value )
+{
+#if defined(__i386__) || defined(__x86_64__)
+
+ pmioctlVariableInfo_t varInfoStruct;
+ int pmCPUret = 0;
+ const char *varNameStr = NULL;
+ int32_t *varIndex = NULL;
+
+ if (kInformAC == type) {
+ varNameStr = kIOPMRootDomainBatPowerCString;
+ varIndex = &idxPMCPULimitedPower;
+ } else if (kInformLid == type) {
+ varNameStr = kIOPMRootDomainLidCloseCString;
+ varIndex = &idxPMCPUClamshell;
+ } else {
+ return;
+ }
+
+ // Set the new value!
+ // pmCPUControl will assign us a new ID if one doesn't exist yet
+ bzero(&varInfoStruct, sizeof(pmioctlVariableInfo_t));
+ varInfoStruct.varID = *varIndex;
+ varInfoStruct.varType = vBool;
+ varInfoStruct.varInitValue = value;
+ varInfoStruct.varCurValue = value;
+ strlcpy((char *)varInfoStruct.varName,
+ (const char *)varNameStr,
+ sizeof(varInfoStruct.varName));
+
+ // Set!
+ pmCPUret = pmCPUControl( PMIOCSETVARINFO, (void *)&varInfoStruct );
+
+ // pmCPU only assigns numerical id's when a new varName is specified
+ if ((0 == pmCPUret)
+ && (*varIndex == kCPUUnknownIndex)) {
+ // pmCPUControl has assigned us a new variable ID.
+ // Let's re-read the structure we just SET to learn that ID.
+ pmCPUret = pmCPUControl( PMIOCGETVARNAMEINFO, (void *)&varInfoStruct );
+
+ if (0 == pmCPUret) {
+ // Store it in idxPMCPUClamshell or idxPMCPULimitedPower
+ *varIndex = varInfoStruct.varID;
+ }
+ }
+
+ return;
+
+#endif /* __i386__ || __x86_64__ */
+}
+
+// MARK: -
+// MARK: Deep Sleep Policy
+
+#if HIBERNATION
+
+//******************************************************************************
+// evaluateSystemSleepPolicy
+//******************************************************************************
+
+#define kIOPlatformSystemSleepPolicyKey "IOPlatformSystemSleepPolicy"
+
+// Sleep flags
+enum {
+ kIOPMSleepFlagHibernate = 0x00000001,
+ kIOPMSleepFlagSleepTimerEnable = 0x00000002
+};
+
+struct IOPMSystemSleepPolicyEntry {
+ uint32_t factorMask;
+ uint32_t factorBits;
+ uint32_t sleepFlags;
+ uint32_t wakeEvents;
+} __attribute__((packed));
+
+struct IOPMSystemSleepPolicyTable {
+ uint32_t signature;
+ uint16_t version;
+ uint16_t entryCount;
+ IOPMSystemSleepPolicyEntry entries[];
+} __attribute__((packed));
+
+enum {
+ kIOPMSleepAttributeHibernateSetup = 0x00000001,
+ kIOPMSleepAttributeHibernateSleep = 0x00000002
+};
+
+static uint32_t
+getSleepTypeAttributes( uint32_t sleepType )
+{
+ static const uint32_t sleepTypeAttributes[kIOPMSleepTypeLast] =
+ {
+ /* invalid */ 0,
+ /* abort */ 0,
+ /* normal */ 0,
+ /* safesleep */ kIOPMSleepAttributeHibernateSetup,
+ /* hibernate */ kIOPMSleepAttributeHibernateSetup | kIOPMSleepAttributeHibernateSleep,
+ /* standby */ kIOPMSleepAttributeHibernateSetup | kIOPMSleepAttributeHibernateSleep,
+ /* poweroff */ kIOPMSleepAttributeHibernateSetup | kIOPMSleepAttributeHibernateSleep,
+ /* deepidle */ 0
+ };
+
+ if (sleepType >= kIOPMSleepTypeLast) {
+ return 0;
+ }
+
+ return sleepTypeAttributes[sleepType];
+}
+
+bool
+IOPMrootDomain::evaluateSystemSleepPolicy(
+ IOPMSystemSleepParameters * params, int sleepPhase, uint32_t * hibMode )
+{
+ const IOPMSystemSleepPolicyTable * pt;
+ OSObject * prop = NULL;
+ OSData * policyData;
+ uint64_t currentFactors = 0;
+ char currentFactorsBuf[512];
+ uint32_t standbyDelay = 0;
+ uint32_t powerOffDelay = 0;
+ uint32_t powerOffTimer = 0;
+ uint32_t standbyTimer = 0;
+ uint32_t mismatch;
+ bool standbyEnabled;
+ bool powerOffEnabled;
+ bool found = false;
+
+ // Get platform's sleep policy table
+ if (!gSleepPolicyHandler) {
+ prop = getServiceRoot()->copyProperty(kIOPlatformSystemSleepPolicyKey);
+ if (!prop) {
+ goto done;
+ }
+ }
+
+ // Fetch additional settings
+ standbyEnabled = (getSleepOption(kIOPMDeepSleepDelayKey, &standbyDelay)
+ && (getProperty(kIOPMDeepSleepEnabledKey) == kOSBooleanTrue));
+ powerOffEnabled = (getSleepOption(kIOPMAutoPowerOffDelayKey, &powerOffDelay)
+ && (getProperty(kIOPMAutoPowerOffEnabledKey) == kOSBooleanTrue));
+ if (!getSleepOption(kIOPMAutoPowerOffTimerKey, &powerOffTimer)) {
+ powerOffTimer = powerOffDelay;
+ }
+ if (!getSleepOption(kIOPMDeepSleepTimerKey, &standbyTimer)) {
+ standbyTimer = standbyDelay;
+ }
+
+ DLOG("phase %d, standby %d delay %u timer %u, poweroff %d delay %u timer %u, hibernate 0x%x\n",
+ sleepPhase, standbyEnabled, standbyDelay, standbyTimer,
+ powerOffEnabled, powerOffDelay, powerOffTimer, *hibMode);
+
+ currentFactorsBuf[0] = 0;
+ // pmset level overrides
+ if ((*hibMode & kIOHibernateModeOn) == 0) {
+ if (!gSleepPolicyHandler) {
+ standbyEnabled = false;
+ powerOffEnabled = false;
+ }
+ } else if (!(*hibMode & kIOHibernateModeSleep)) {
+ // Force hibernate (i.e. mode 25)
+ // If standby is enabled, force standy.
+ // If poweroff is enabled, force poweroff.
+ if (standbyEnabled) {
+ currentFactors |= kIOPMSleepFactorStandbyForced;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "StandbyForced");
+ } else if (powerOffEnabled) {
+ currentFactors |= kIOPMSleepFactorAutoPowerOffForced;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "AutoPowerOffForced");
+ } else {
+ currentFactors |= kIOPMSleepFactorHibernateForced;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "HibernateForced");
+ }
+ }
+
+ // Current factors based on environment and assertions
+ if (sleepTimerMaintenance) {
+ currentFactors |= kIOPMSleepFactorSleepTimerWake;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "SleepTimerWake");
+ }
+ if (standbyEnabled && sleepToStandby && !gSleepPolicyHandler) {
+ currentFactors |= kIOPMSleepFactorSleepTimerWake;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "SleepTimerWake");
+ }
+ if (!clamshellClosed) {
+ currentFactors |= kIOPMSleepFactorLidOpen;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "LidOpen");
+ }
+ if (acAdaptorConnected) {
+ currentFactors |= kIOPMSleepFactorACPower;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "ACPower");
+ }
+ if (lowBatteryCondition) {
+ currentFactors |= kIOPMSleepFactorBatteryLow;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "BatteryLow");
+ }
+ if (!standbyDelay || !standbyTimer) {
+ currentFactors |= kIOPMSleepFactorStandbyNoDelay;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "StandbyNoDelay");
+ }
+ if (standbyNixed || !standbyEnabled) {
+ currentFactors |= kIOPMSleepFactorStandbyDisabled;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "StandbyDisabled");
+ }
+ if (resetTimers) {
+ currentFactors |= kIOPMSleepFactorLocalUserActivity;
+ currentFactors &= ~kIOPMSleepFactorSleepTimerWake;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "LocalUserActivity, !SleepTimerWake");
+ }
+ if (getPMAssertionLevel(kIOPMDriverAssertionUSBExternalDeviceBit) !=
+ kIOPMDriverAssertionLevelOff) {
+ currentFactors |= kIOPMSleepFactorUSBExternalDevice;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "USBExternalDevice");
+ }
+ if (getPMAssertionLevel(kIOPMDriverAssertionBluetoothHIDDevicePairedBit) !=
+ kIOPMDriverAssertionLevelOff) {
+ currentFactors |= kIOPMSleepFactorBluetoothHIDDevice;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "BluetoothHIDDevice");
+ }
+ if (getPMAssertionLevel(kIOPMDriverAssertionExternalMediaMountedBit) !=
+ kIOPMDriverAssertionLevelOff) {
+ currentFactors |= kIOPMSleepFactorExternalMediaMounted;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "ExternalMediaMounted");
+ }
+ if (getPMAssertionLevel(kIOPMDriverAssertionReservedBit5) !=
+ kIOPMDriverAssertionLevelOff) {
+ currentFactors |= kIOPMSleepFactorThunderboltDevice;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "ThunderboltDevice");
+ }
+ if (_scheduledAlarms != 0) {
+ currentFactors |= kIOPMSleepFactorRTCAlarmScheduled;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "RTCAlaramScheduled");
+ }
+ if (getPMAssertionLevel(kIOPMDriverAssertionMagicPacketWakeEnabledBit) !=
+ kIOPMDriverAssertionLevelOff) {
+ currentFactors |= kIOPMSleepFactorMagicPacketWakeEnabled;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "MagicPacketWakeEnabled");
+ }
+#define TCPKEEPALIVE 1
+#if TCPKEEPALIVE
+ if (getPMAssertionLevel(kIOPMDriverAssertionNetworkKeepAliveActiveBit) !=
+ kIOPMDriverAssertionLevelOff) {
+ currentFactors |= kIOPMSleepFactorNetworkKeepAliveActive;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "NetworkKeepAliveActive");
+ }
+#endif
+ if (!powerOffEnabled) {
+ currentFactors |= kIOPMSleepFactorAutoPowerOffDisabled;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "AutoPowerOffDisabled");
+ }
+ if (desktopMode) {
+ currentFactors |= kIOPMSleepFactorExternalDisplay;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "ExternalDisplay");
+ }
+ if (userWasActive) {
+ currentFactors |= kIOPMSleepFactorLocalUserActivity;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "LocalUserActivity");
+ }
+ if (darkWakeHibernateError && !CAP_HIGHEST(kIOPMSystemCapabilityGraphics)) {
+ currentFactors |= kIOPMSleepFactorHibernateFailed;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "HibernateFailed");
+ }
+ if (thermalWarningState) {
+ currentFactors |= kIOPMSleepFactorThermalWarning;
+ snprintf(currentFactorsBuf, sizeof(currentFactorsBuf), "%s, %s", currentFactorsBuf, "ThermalWarning");
+ }
+
+ DLOG("sleep factors 0x%llx %s\n", currentFactors, currentFactorsBuf);
+
+ if (gSleepPolicyHandler) {
+ uint32_t savedHibernateMode;
+ IOReturn result;
+
+ if (!gSleepPolicyVars) {
+ gSleepPolicyVars = IONew(IOPMSystemSleepPolicyVariables, 1);
+ if (!gSleepPolicyVars) {
+ goto done;
+ }
+ bzero(gSleepPolicyVars, sizeof(*gSleepPolicyVars));
+ }
+ gSleepPolicyVars->signature = kIOPMSystemSleepPolicySignature;
+ gSleepPolicyVars->version = kIOPMSystemSleepPolicyVersion;
+ gSleepPolicyVars->currentCapability = _currentCapability;
+ gSleepPolicyVars->highestCapability = _highestCapability;
+ gSleepPolicyVars->sleepFactors = currentFactors;
+ gSleepPolicyVars->sleepReason = lastSleepReason;
+ gSleepPolicyVars->sleepPhase = sleepPhase;
+ gSleepPolicyVars->standbyDelay = standbyDelay;
+ gSleepPolicyVars->standbyTimer = standbyTimer;
+ gSleepPolicyVars->poweroffDelay = powerOffDelay;
+ gSleepPolicyVars->scheduledAlarms = _scheduledAlarms | _userScheduledAlarm;
+ gSleepPolicyVars->poweroffTimer = powerOffTimer;
+
+ if (kIOPMSleepPhase0 == sleepPhase) {
+ // preserve hibernateMode
+ savedHibernateMode = gSleepPolicyVars->hibernateMode;
+ gSleepPolicyVars->hibernateMode = *hibMode;
+ } else if (kIOPMSleepPhase1 == sleepPhase) {
+ // use original hibernateMode for phase2
+ gSleepPolicyVars->hibernateMode = *hibMode;
+ }
+
+ result = gSleepPolicyHandler(gSleepPolicyTarget, gSleepPolicyVars, params);
+
+ if (kIOPMSleepPhase0 == sleepPhase) {
+ // restore hibernateMode
+ gSleepPolicyVars->hibernateMode = savedHibernateMode;
+ }
+
+ if ((result != kIOReturnSuccess) ||
+ (kIOPMSleepTypeInvalid == params->sleepType) ||
+ (params->sleepType >= kIOPMSleepTypeLast) ||
+ (kIOPMSystemSleepParametersVersion != params->version)) {
+ MSG("sleep policy handler error\n");
+ goto done;
+ }
+
+ if ((getSleepTypeAttributes(params->sleepType) &
+ kIOPMSleepAttributeHibernateSetup) &&
+ ((*hibMode & kIOHibernateModeOn) == 0)) {
+ *hibMode |= (kIOHibernateModeOn | kIOHibernateModeSleep);
+ }
+
+ DLOG("sleep params v%u, type %u, flags 0x%x, wake 0x%x, timer %u, poweroff %u\n",
+ params->version, params->sleepType, params->sleepFlags,
+ params->ecWakeEvents, params->ecWakeTimer, params->ecPoweroffTimer);
+ found = true;
+ goto done;
+ }
+
+ // Policy table is meaningless without standby enabled
+ if (!standbyEnabled) {
+ goto done;
+ }
+
+ // Validate the sleep policy table
+ policyData = OSDynamicCast(OSData, prop);
+ if (!policyData || (policyData->getLength() <= sizeof(IOPMSystemSleepPolicyTable))) {
+ goto done;
+ }
+
+ pt = (const IOPMSystemSleepPolicyTable *) policyData->getBytesNoCopy();
+ if ((pt->signature != kIOPMSystemSleepPolicySignature) ||
+ (pt->version != 1) || (0 == pt->entryCount)) {
+ goto done;
+ }
+
+ if (((policyData->getLength() - sizeof(IOPMSystemSleepPolicyTable)) !=
+ (sizeof(IOPMSystemSleepPolicyEntry) * pt->entryCount))) {
+ goto done;
+ }
+
+ for (uint32_t i = 0; i < pt->entryCount; i++) {
+ const IOPMSystemSleepPolicyEntry * entry = &pt->entries[i];
+ mismatch = (((uint32_t)currentFactors ^ entry->factorBits) & entry->factorMask);
+
+ DLOG("mask 0x%08x, bits 0x%08x, flags 0x%08x, wake 0x%08x, mismatch 0x%08x\n",
+ entry->factorMask, entry->factorBits,
+ entry->sleepFlags, entry->wakeEvents, mismatch);
+ if (mismatch) {
+ continue;
+ }
+
+ DLOG("^ found match\n");
+ found = true;
+
+ params->version = kIOPMSystemSleepParametersVersion;
+ params->reserved1 = 1;
+ if (entry->sleepFlags & kIOPMSleepFlagHibernate) {
+ params->sleepType = kIOPMSleepTypeStandby;
+ } else {
+ params->sleepType = kIOPMSleepTypeNormalSleep;
+ }
+
+ params->ecWakeEvents = entry->wakeEvents;
+ if (entry->sleepFlags & kIOPMSleepFlagSleepTimerEnable) {
+ if (kIOPMSleepPhase2 == sleepPhase) {
+ clock_sec_t now_secs = gIOLastSleepTime.tv_sec;
+
+ if (!_standbyTimerResetSeconds ||
+ (now_secs <= _standbyTimerResetSeconds)) {
+ // Reset standby timer adjustment
+ _standbyTimerResetSeconds = now_secs;
+ DLOG("standby delay %u, reset %u\n",
+ standbyDelay, (uint32_t) _standbyTimerResetSeconds);
+ } else if (standbyDelay) {
+ // Shorten the standby delay timer
+ clock_sec_t elapsed = now_secs - _standbyTimerResetSeconds;
+ if (standbyDelay > elapsed) {
+ standbyDelay -= elapsed;
+ } else {
+ standbyDelay = 1; // must be > 0
+ }
+ DLOG("standby delay %u, elapsed %u\n",
+ standbyDelay, (uint32_t) elapsed);
+ }
+ }
+ params->ecWakeTimer = standbyDelay;
+ } else if (kIOPMSleepPhase2 == sleepPhase) {
+ // A sleep that does not enable the sleep timer will reset
+ // the standby delay adjustment.
+ _standbyTimerResetSeconds = 0;
+ }
+ break;
+ }
+
+done:
+ if (prop) {
+ prop->release();
+ }
+
+ return found;
+}
+
+static IOPMSystemSleepParameters gEarlySystemSleepParams;
+
+void
+IOPMrootDomain::evaluateSystemSleepPolicyEarly( void )
+{
+ // Evaluate early (priority interest phase), before drivers sleep.
+
+ DLOG("%s\n", __FUNCTION__);
+ removeProperty(kIOPMSystemSleepParametersKey);
+
+ // Full wake resets the standby timer delay adjustment
+ if (_highestCapability & kIOPMSystemCapabilityGraphics) {
+ _standbyTimerResetSeconds = 0;
+ }
+
+ hibernateDisabled = false;
+ hibernateMode = 0;
+ getSleepOption(kIOHibernateModeKey, &hibernateMode);
+
+ // Save for late evaluation if sleep is aborted
+ bzero(&gEarlySystemSleepParams, sizeof(gEarlySystemSleepParams));
+
+ if (evaluateSystemSleepPolicy(&gEarlySystemSleepParams, kIOPMSleepPhase1,
+ &hibernateMode)) {
+ if (!hibernateRetry &&
+ ((getSleepTypeAttributes(gEarlySystemSleepParams.sleepType) &
+ kIOPMSleepAttributeHibernateSetup) == 0)) {
+ // skip hibernate setup
+ hibernateDisabled = true;
+ }
+ }
+
+ // Publish IOPMSystemSleepType
+ uint32_t sleepType = gEarlySystemSleepParams.sleepType;
+ if (sleepType == kIOPMSleepTypeInvalid) {
+ // no sleep policy
+ sleepType = kIOPMSleepTypeNormalSleep;
+ if (hibernateMode & kIOHibernateModeOn) {
+ sleepType = (hibernateMode & kIOHibernateModeSleep) ?
+ kIOPMSleepTypeSafeSleep : kIOPMSleepTypeHibernate;
+ }
+ } else if ((sleepType == kIOPMSleepTypeStandby) &&
+ (gEarlySystemSleepParams.ecPoweroffTimer)) {
+ // report the lowest possible sleep state
+ sleepType = kIOPMSleepTypePowerOff;
+ }
+
+ setProperty(kIOPMSystemSleepTypeKey, sleepType, 32);
+}
+
+void
+IOPMrootDomain::evaluateSystemSleepPolicyFinal( void )
+{
+ IOPMSystemSleepParameters params;
+ OSData * paramsData;
+ bool wakeNow;
+ // Evaluate sleep policy after sleeping drivers but before platform sleep.
+
+ DLOG("%s\n", __FUNCTION__);
+
+ bzero(¶ms, sizeof(params));
+ wakeNow = false;
+ if (evaluateSystemSleepPolicy(¶ms, kIOPMSleepPhase2, &hibernateMode)) {
+ if ((kIOPMSleepTypeStandby == params.sleepType)
+ && gIOHibernateStandbyDisabled && gSleepPolicyVars
+ && (!((kIOPMSleepFactorStandbyForced | kIOPMSleepFactorAutoPowerOffForced | kIOPMSleepFactorHibernateForced)
+ & gSleepPolicyVars->sleepFactors))) {
+ standbyNixed = true;
+ wakeNow = true;
+ }
+ if (wakeNow
+ || ((hibernateDisabled || hibernateAborted) &&
+ (getSleepTypeAttributes(params.sleepType) &
+ kIOPMSleepAttributeHibernateSetup))) {
+ // Final evaluation picked a state requiring hibernation,
+ // but hibernate isn't going to proceed. Arm a short sleep using
+ // the early non-hibernate sleep parameters.
+ bcopy(&gEarlySystemSleepParams, ¶ms, sizeof(params));
+ params.sleepType = kIOPMSleepTypeAbortedSleep;
+ params.ecWakeTimer = 1;
+ if (standbyNixed) {
+ resetTimers = true;
+ } else {
+ // Set hibernateRetry flag to force hibernate setup on the
+ // next sleep.
+ hibernateRetry = true;
+ }
+ DLOG("wake in %u secs for hibernateDisabled %d, hibernateAborted %d, standbyNixed %d\n",
+ params.ecWakeTimer, hibernateDisabled, hibernateAborted, standbyNixed);
+ } else {
+ hibernateRetry = false;
+ }
+
+ if (kIOPMSleepTypeAbortedSleep != params.sleepType) {
+ resetTimers = false;
+ }
+
+ paramsData = OSData::withBytes(¶ms, sizeof(params));
+ if (paramsData) {
+ setProperty(kIOPMSystemSleepParametersKey, paramsData);
+ paramsData->release();
+ }
+
+ if (getSleepTypeAttributes(params.sleepType) &
+ kIOPMSleepAttributeHibernateSleep) {
+ // Disable sleep to force hibernation
+ gIOHibernateMode &= ~kIOHibernateModeSleep;
+ }
+ }
+}
+
+bool
+IOPMrootDomain::getHibernateSettings(
+ uint32_t * hibernateModePtr,
+ uint32_t * hibernateFreeRatio,
+ uint32_t * hibernateFreeTime )
+{
+ // Called by IOHibernateSystemSleep() after evaluateSystemSleepPolicyEarly()
+ // has updated the hibernateDisabled flag.
+
+ bool ok = getSleepOption(kIOHibernateModeKey, hibernateModePtr);
+ getSleepOption(kIOHibernateFreeRatioKey, hibernateFreeRatio);
+ getSleepOption(kIOHibernateFreeTimeKey, hibernateFreeTime);
+ if (hibernateDisabled) {
+ *hibernateModePtr = 0;
+ } else if (gSleepPolicyHandler) {
+ *hibernateModePtr = hibernateMode;
+ }
+ DLOG("hibernateMode 0x%x\n", *hibernateModePtr);
+ return ok;
+}
+
+bool
+IOPMrootDomain::getSleepOption( const char * key, uint32_t * option )
+{
+ OSObject * optionsProp;
+ OSDictionary * optionsDict;
+ OSObject * obj = NULL;
+ OSNumber * num;
+ bool ok = false;
+
+ optionsProp = copyProperty(kRootDomainSleepOptionsKey);
+ optionsDict = OSDynamicCast(OSDictionary, optionsProp);
+
+ if (optionsDict) {
+ obj = optionsDict->getObject(key);
+ if (obj) {
+ obj->retain();
+ }
+ }
+ if (!obj) {
+ obj = copyProperty(key);
+ }
+ if (obj) {
+ if ((num = OSDynamicCast(OSNumber, obj))) {
+ *option = num->unsigned32BitValue();
+ ok = true;
+ } else if (OSDynamicCast(OSBoolean, obj)) {
+ *option = (obj == kOSBooleanTrue) ? 1 : 0;
+ ok = true;
+ }
+ }
+
+ if (obj) {
+ obj->release();
+ }
+ if (optionsProp) {
+ optionsProp->release();
+ }
+
+ return ok;
+}
+#endif /* HIBERNATION */
+
+IOReturn
+IOPMrootDomain::getSystemSleepType( uint32_t * sleepType, uint32_t * standbyTimer )
+{
+#if HIBERNATION
+ IOPMSystemSleepParameters params;
+ uint32_t hibMode = 0;
+ bool ok;
+
+ if (gIOPMWorkLoop->inGate() == false) {
+ IOReturn ret = gIOPMWorkLoop->runAction(
+ OSMemberFunctionCast(IOWorkLoop::Action, this,
+ &IOPMrootDomain::getSystemSleepType),
+ (OSObject *) this,
+ (void *) sleepType, (void *) standbyTimer);
+ return ret;
+ }
+
+ getSleepOption(kIOHibernateModeKey, &hibMode);
+ bzero(¶ms, sizeof(params));
+
+ ok = evaluateSystemSleepPolicy(¶ms, kIOPMSleepPhase0, &hibMode);
+ if (ok) {
+ *sleepType = params.sleepType;
+ if (!getSleepOption(kIOPMDeepSleepTimerKey, standbyTimer) &&
+ !getSleepOption(kIOPMDeepSleepDelayKey, standbyTimer)) {
+ DLOG("Standby delay is not set\n");
+ *standbyTimer = 0;
+ }
+ return kIOReturnSuccess;
+ }
+#endif
+
+ return kIOReturnUnsupported;
+}
+
+// MARK: -
+// MARK: Shutdown and Restart
+
+//******************************************************************************
+// handlePlatformHaltRestart
+//
+//******************************************************************************
+
+// Phases while performing shutdown/restart
+typedef enum {
+ kNotifyDone = 0x00,
+ kNotifyPriorityClients = 0x10,
+ kNotifyPowerPlaneDrivers = 0x20,
+ kNotifyHaltRestartAction = 0x30,
+ kQuiescePM = 0x40,
+} shutdownPhase_t;
+
+
+struct HaltRestartApplierContext {
+ IOPMrootDomain * RootDomain;
+ unsigned long PowerState;
+ IOPMPowerFlags PowerFlags;
+ UInt32 MessageType;
+ UInt32 Counter;
+ const char * LogString;
+ shutdownPhase_t phase;
+
+ IOServiceInterestHandler handler;
+} gHaltRestartCtx;
+
+const char *
+shutdownPhase2String(shutdownPhase_t phase)
+{
+ switch (phase) {
+ case kNotifyDone:
+ return "Notifications completed";
+ case kNotifyPriorityClients:
+ return "Notifying priority clients";
+ case kNotifyPowerPlaneDrivers:
+ return "Notifying power plane drivers";
+ case kNotifyHaltRestartAction:
+ return "Notifying HaltRestart action handlers";
+ case kQuiescePM:
+ return "Quiescing PM";
+ default:
+ return "Unknown";
+ }
+}
+
+static void
+platformHaltRestartApplier( OSObject * object, void * context )
+{
+ IOPowerStateChangeNotification notify;
+ HaltRestartApplierContext * ctx;
+ AbsoluteTime startTime, elapsedTime;
+ uint32_t deltaTime;
+
+ ctx = (HaltRestartApplierContext *) context;
+
+ _IOServiceInterestNotifier * notifier;
+ notifier = OSDynamicCast(_IOServiceInterestNotifier, object);
+ memset(¬ify, 0, sizeof(notify));
+ notify.powerRef = (void *)(uintptr_t)ctx->Counter;
+ notify.returnValue = 0;
+ notify.stateNumber = ctx->PowerState;
+ notify.stateFlags = ctx->PowerFlags;
+
+ if (notifier) {
+ ctx->handler = notifier->handler;
+ }
+
+ clock_get_uptime(&startTime);
+ ctx->RootDomain->messageClient( ctx->MessageType, object, (void *)¬ify );
+ deltaTime = computeDeltaTimeMS(&startTime, &elapsedTime);
+
+ if ((deltaTime > kPMHaltTimeoutMS) && notifier) {
+ LOG("%s handler %p took %u ms\n",
+ ctx->LogString, OBFUSCATE(notifier->handler), deltaTime);
+ halt_log_enter("PowerOff/Restart message to priority client", (const void *) notifier->handler, elapsedTime);
+ }
+
+ ctx->handler = NULL;
+ ctx->Counter++;
+}
+
+static void
+quiescePowerTreeCallback( void * target, void * param )
+{
+ IOLockLock(gPMHaltLock);
+ gPMQuiesced = true;
+ thread_wakeup(param);
+ IOLockUnlock(gPMHaltLock);
+}
+
+void
+IOPMrootDomain::handlePlatformHaltRestart( UInt32 pe_type )
+{
+ AbsoluteTime startTime, elapsedTime;
+ uint32_t deltaTime;
+
+ memset(&gHaltRestartCtx, 0, sizeof(gHaltRestartCtx));
+ gHaltRestartCtx.RootDomain = this;
+
+ clock_get_uptime(&startTime);
+ switch (pe_type) {
+ case kPEHaltCPU:
+ case kPEUPSDelayHaltCPU:
+ gHaltRestartCtx.PowerState = OFF_STATE;
+ gHaltRestartCtx.MessageType = kIOMessageSystemWillPowerOff;
+ gHaltRestartCtx.LogString = "PowerOff";
+ break;
+
+ case kPERestartCPU:
+ gHaltRestartCtx.PowerState = RESTART_STATE;
+ gHaltRestartCtx.MessageType = kIOMessageSystemWillRestart;
+ gHaltRestartCtx.LogString = "Restart";
+ break;
+
+ case kPEPagingOff:
+ gHaltRestartCtx.PowerState = ON_STATE;
+ gHaltRestartCtx.MessageType = kIOMessageSystemPagingOff;
+ gHaltRestartCtx.LogString = "PagingOff";
+ IOService::updateConsoleUsers(NULL, kIOMessageSystemPagingOff);
+#if HIBERNATION
+ IOHibernateSystemRestart();
+#endif
+ break;
+
+ default:
+ return;
+ }
+
+ gHaltRestartCtx.phase = kNotifyPriorityClients;
+ // Notify legacy clients
+ applyToInterested(gIOPriorityPowerStateInterest, platformHaltRestartApplier, &gHaltRestartCtx);
+
+ // For normal shutdown, turn off File Server Mode.
+ if (kPEHaltCPU == pe_type) {
+ const OSSymbol * setting = OSSymbol::withCString(kIOPMSettingRestartOnPowerLossKey);
+ OSNumber * num = OSNumber::withNumber((unsigned long long) 0, 32);
+ if (setting && num) {
+ setPMSetting(setting, num);
+ setting->release();
+ num->release();
+ }
+ }
+
+
+ if (kPEPagingOff != pe_type) {
+ gHaltRestartCtx.phase = kNotifyPowerPlaneDrivers;
+ // Notify in power tree order
+ notifySystemShutdown(this, gHaltRestartCtx.MessageType);
+ }
+
+ gHaltRestartCtx.phase = kNotifyHaltRestartAction;
+#if !CONFIG_EMBEDDED
+ IOCPURunPlatformHaltRestartActions(pe_type);
+#else
+ if (kPEPagingOff != pe_type) {
+ IOCPURunPlatformHaltRestartActions(pe_type);
+ }
+#endif
+
+ // Wait for PM to quiesce
+ if ((kPEPagingOff != pe_type) && gPMHaltLock) {
+ gHaltRestartCtx.phase = kQuiescePM;
+ AbsoluteTime quiesceTime = mach_absolute_time();
+
+ IOLockLock(gPMHaltLock);
+ gPMQuiesced = false;
+ if (quiescePowerTree(this, &quiescePowerTreeCallback, &gPMQuiesced) ==
+ kIOReturnSuccess) {
+ while (!gPMQuiesced) {
+ IOLockSleep(gPMHaltLock, &gPMQuiesced, THREAD_UNINT);
+ }
+ }
+ IOLockUnlock(gPMHaltLock);
+ deltaTime = computeDeltaTimeMS(&quiesceTime, &elapsedTime);
+ DLOG("PM quiesce took %u ms\n", deltaTime);
+ halt_log_enter("Quiesce", NULL, elapsedTime);
+ }
+ gHaltRestartCtx.phase = kNotifyDone;
+
+ deltaTime = computeDeltaTimeMS(&startTime, &elapsedTime);
+ LOG("%s all drivers took %u ms\n", gHaltRestartCtx.LogString, deltaTime);
+
+ halt_log_enter(gHaltRestartCtx.LogString, NULL, elapsedTime);
+
+ deltaTime = computeDeltaTimeMS(&gHaltStartTime, &elapsedTime);
+ LOG("%s total %u ms\n", gHaltRestartCtx.LogString, deltaTime);
+
+ if (gHaltLog && gHaltTimeMaxLog && (deltaTime >= gHaltTimeMaxLog)) {
+ printf("%s total %d ms:%s\n", gHaltRestartCtx.LogString, deltaTime, gHaltLog);
+ }
+
+ checkShutdownTimeout();
+}
+
+bool
+IOPMrootDomain::checkShutdownTimeout()
+{
+ AbsoluteTime elapsedTime;
+ uint32_t deltaTime = computeDeltaTimeMS(&gHaltStartTime, &elapsedTime);
+
+ if (gHaltTimeMaxPanic && (deltaTime >= gHaltTimeMaxPanic)) {
+ return true;
+ }
+ return false;
+}
+
+void
+IOPMrootDomain::panicWithShutdownLog(uint32_t timeoutInMs)
+{
+ if (gHaltLog) {
+ if ((gHaltRestartCtx.phase == kNotifyPriorityClients) && gHaltRestartCtx.handler) {
+ halt_log_enter("Blocked on priority client", (void *)gHaltRestartCtx.handler, mach_absolute_time() - gHaltStartTime);
+ }
+ panic("%s timed out in phase '%s'. Total %d ms:%s",
+ gHaltRestartCtx.LogString, shutdownPhase2String(gHaltRestartCtx.phase), timeoutInMs, gHaltLog);
+ } else {
+ panic("%s timed out in phase \'%s\'. Total %d ms",
+ gHaltRestartCtx.LogString, shutdownPhase2String(gHaltRestartCtx.phase), timeoutInMs);
+ }
+}
+
+//******************************************************************************
+// shutdownSystem
+//
+//******************************************************************************
+
+IOReturn
+IOPMrootDomain::shutdownSystem( void )
+{
+ return kIOReturnUnsupported;
+}
+
+//******************************************************************************
+// restartSystem
+//
+//******************************************************************************
+
+IOReturn
+IOPMrootDomain::restartSystem( void )
+{
+ return kIOReturnUnsupported;
+}
+
+// MARK: -
+// MARK: System Capability
+
+//******************************************************************************
+// tagPowerPlaneService
+//
+// Running on PM work loop thread.
+//******************************************************************************
+
+void
+IOPMrootDomain::tagPowerPlaneService(
+ IOService * service,
+ IOPMActions * actions )
+{
+ uint32_t flags = 0;
+ bool isDisplayWrangler;
+
+ memset(actions, 0, sizeof(*actions));
+ actions->target = this;
+
+ if (service == this) {
+ actions->actionPowerChangeStart =
+ OSMemberFunctionCast(
+ IOPMActionPowerChangeStart, this,
+ &IOPMrootDomain::handleOurPowerChangeStart);
+
+ actions->actionPowerChangeDone =
+ OSMemberFunctionCast(
+ IOPMActionPowerChangeDone, this,
+ &IOPMrootDomain::handleOurPowerChangeDone);
+
+ actions->actionPowerChangeOverride =
+ OSMemberFunctionCast(
+ IOPMActionPowerChangeOverride, this,
+ &IOPMrootDomain::overrideOurPowerChange);
+ return;
+ }
+
+#if !NO_KERNEL_HID
+ isDisplayWrangler = (NULL != service->metaCast("IODisplayWrangler"));
+ if (isDisplayWrangler) {
+ wrangler = service;
+ // found the display wrangler, check for any display assertions already created
+ if (pmAssertions->getActivatedAssertions() & kIOPMDriverAssertionPreventDisplaySleepBit) {
+ DLOG("wrangler setIgnoreIdleTimer\(1) due to pre-existing assertion\n");
+ wrangler->setIgnoreIdleTimer( true );
+ }
+ }
+#else
+ isDisplayWrangler = false;
+#endif
+
+#if defined(__i386__) || defined(__x86_64__)
+ if (isDisplayWrangler) {
+ flags |= kPMActionsFlagIsDisplayWrangler;
+ }
+ if (service->getProperty("IOPMStrictTreeOrder")) {
+ flags |= kPMActionsFlagIsGraphicsDevice;
+ }
+ if (service->getProperty("IOPMUnattendedWakePowerState")) {
+ flags |= kPMActionsFlagIsAudioDevice;
+ }
+#endif
+
+ // Find the power connection object that is a child of the PCI host
+ // bridge, and has a graphics/audio device attached below. Mark the
+ // power branch for delayed child notifications.
+
+ if (flags) {
+ IORegistryEntry * child = service;
+ IORegistryEntry * parent = child->getParentEntry(gIOPowerPlane);
+
+ while (child != this) {
+ if (child->getProperty("IOPCITunnelled") == kOSBooleanTrue) {
+ // Skip delaying notifications and clamping power on external graphics and audio devices.
+ DLOG("Avoiding delayChildNotification on object 0x%llx. flags: 0x%x\n", service->getRegistryEntryID(), flags);
+ flags = 0;
+ break;
+ }
+ if ((parent == pciHostBridgeDriver) ||
+ (parent == this)) {
+ if (OSDynamicCast(IOPowerConnection, child)) {
+ IOPowerConnection * conn = (IOPowerConnection *) child;
+ conn->delayChildNotification = true;
+ DLOG("delayChildNotification for 0x%llx\n", conn->getRegistryEntryID());
+ }
+ break;
+ }
+ child = parent;
+ parent = child->getParentEntry(gIOPowerPlane);
+ }
+ }
+
+ if (flags) {
+ DLOG("%s tag flags %x\n", service->getName(), flags);
+ actions->parameter |= flags;
+ actions->actionPowerChangeOverride =
+ OSMemberFunctionCast(
+ IOPMActionPowerChangeOverride, this,
+ &IOPMrootDomain::overridePowerChangeForUIService);
+
+ if (flags & kPMActionsFlagIsDisplayWrangler) {
+ actions->actionActivityTickle =
+ OSMemberFunctionCast(
+ IOPMActionActivityTickle, this,
+ &IOPMrootDomain::handleActivityTickleForDisplayWrangler);
+
+ actions->actionUpdatePowerClient =
+ OSMemberFunctionCast(
+ IOPMActionUpdatePowerClient, this,
+ &IOPMrootDomain::handleUpdatePowerClientForDisplayWrangler);
+ }
+ return;
+ }
+
+ // Locate the first PCI host bridge for PMTrace.
+ if (!pciHostBridgeDevice && service->metaCast("IOPCIBridge")) {
+ IOService * provider = service->getProvider();
+ if (OSDynamicCast(IOPlatformDevice, provider) &&
+ provider->inPlane(gIODTPlane)) {
+ pciHostBridgeDevice = provider;
+ pciHostBridgeDriver = service;
+ DLOG("PMTrace found PCI host bridge %s->%s\n",
+ provider->getName(), service->getName());
+ }
+ }
+
+ // Tag top-level PCI devices. The order of PMinit() call does not
+ // change across boots and is used as the PCI bit number.
+ if (pciHostBridgeDevice && service->metaCast("IOPCIDevice")) {
+ // Would prefer to check built-in property, but tagPowerPlaneService()
+ // is called before pciDevice->registerService().
+ IORegistryEntry * parent = service->getParentEntry(gIODTPlane);
+ if ((parent == pciHostBridgeDevice) && service->getProperty("acpi-device")) {
+ int bit = pmTracer->recordTopLevelPCIDevice( service );
+ if (bit >= 0) {
+ // Save the assigned bit for fast lookup.
+ actions->parameter |= (bit & kPMActionsPCIBitNumberMask);
+
+ actions->actionPowerChangeStart =
+ OSMemberFunctionCast(
+ IOPMActionPowerChangeStart, this,
+ &IOPMrootDomain::handlePowerChangeStartForPCIDevice);
+
+ actions->actionPowerChangeDone =
+ OSMemberFunctionCast(
+ IOPMActionPowerChangeDone, this,
+ &IOPMrootDomain::handlePowerChangeDoneForPCIDevice);
+ }
+ }
+ }
+}
+
+//******************************************************************************
+// PM actions for root domain
+//******************************************************************************
+
+void
+IOPMrootDomain::overrideOurPowerChange(
+ IOService * service,
+ IOPMActions * actions,
+ IOPMPowerStateIndex * inOutPowerState,
+ IOPMPowerChangeFlags * inOutChangeFlags,
+ IOPMRequestTag requestTag )
+{
+ uint32_t powerState = (uint32_t) *inOutPowerState;
+ uint32_t changeFlags = *inOutChangeFlags;
+ uint32_t currentPowerState = (uint32_t) getPowerState();
+
+#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146))
+ if ((AOT_STATE == powerState) && (ON_STATE == currentPowerState)) {
+ // Assertion may have been taken in AOT leading to changePowerStateTo(AOT)
+ *inOutChangeFlags |= kIOPMNotDone;
+ return;
+ }
+#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */
+
+ if (changeFlags & kIOPMParentInitiated) {
+ // Root parent is permanently pegged at max power,
+ // a parent initiated power change is unexpected.
+ *inOutChangeFlags |= kIOPMNotDone;
+ return;
+ }
+
+ if (powerState < currentPowerState) {
+ if (CAP_CURRENT(kIOPMSystemCapabilityGraphics)) {
+ // Root domain is dropping power state ON->SLEEP.
+ // If system is in full wake, first enter dark wake by
+ // converting the power drop to a capability change.
+ // Once in dark wake, transition to sleep state ASAP.
+
+ darkWakeToSleepASAP = true;
+
+ // Drop graphics and audio capability
+ _desiredCapability &= ~(
+ kIOPMSystemCapabilityGraphics |
+ kIOPMSystemCapabilityAudio);
+
+ // Convert to capability change (ON->ON)
+ *inOutPowerState = getRUN_STATE();
+ *inOutChangeFlags |= kIOPMSynchronize;
+
+ // Revert device desire from SLEEP to ON
+ changePowerStateToPriv(getRUN_STATE());
+ } else {
+ // System is in dark wake, ok to drop power state.
+ // Broadcast root powering down to entire tree.
+ *inOutChangeFlags |= kIOPMRootChangeDown;
+ }
+ } else if (powerState > currentPowerState) {
+ if ((_currentCapability & kIOPMSystemCapabilityCPU) == 0) {
+ // Broadcast power up when waking from sleep, but not for the
+ // initial power change at boot by checking for cpu capability.
+ *inOutChangeFlags |= kIOPMRootChangeUp;
+ }
+ }
+}
+
+void
+IOPMrootDomain::handleOurPowerChangeStart(
+ IOService * service,
+ IOPMActions * actions,
+ IOPMPowerStateIndex powerState,
+ IOPMPowerChangeFlags * inOutChangeFlags,
+ IOPMRequestTag requestTag )
+{
+ uint32_t changeFlags = *inOutChangeFlags;
+ uint32_t currentPowerState = (uint32_t) getPowerState();
+ uint32_t sleepReason = requestTag ? requestTag : kIOPMSleepReasonIdle;
+ bool publishSleepReason = false;
+
+ _systemTransitionType = kSystemTransitionNone;
+ _systemMessageClientMask = 0;
+ capabilityLoss = false;
+ toldPowerdCapWillChange = false;
+
+ if (lowBatteryCondition) {
+ // Low battery notification may arrive after the initial sleep request
+ // has been queued. Override the sleep reason so powerd and others can
+ // treat this as an emergency sleep.
+ sleepReason = kIOPMSleepReasonLowPower;
+ }
+
+ // 1. Explicit capability change.
+
+ if (changeFlags & kIOPMSynchronize) {
+ if (powerState == ON_STATE) {
+ if (changeFlags & kIOPMSyncNoChildNotify) {
+ _systemTransitionType = kSystemTransitionNewCapClient;
+ } else {
+ _systemTransitionType = kSystemTransitionCapability;
+ }
+ }
+ }
+ // 2. Going to sleep (cancellation still possible).
+ else if (powerState < currentPowerState) {
+ _systemTransitionType = kSystemTransitionSleep;
+ }
+ // 3. Woke from (idle or demand) sleep.
+ else if (!systemBooting &&
+ (changeFlags & kIOPMSelfInitiated) &&
+ (powerState > currentPowerState)) {
+ _systemTransitionType = kSystemTransitionWake;
+ _desiredCapability = kIOPMSystemCapabilityCPU |
+ kIOPMSystemCapabilityNetwork;
+
+ // Early exit from dark wake to full (e.g. LID open)
+ if (kFullWakeReasonNone != fullWakeReason) {
+ _desiredCapability |= (
+ kIOPMSystemCapabilityGraphics |
+ kIOPMSystemCapabilityAudio);
+ }
+#if HIBERNATION
+ IOHibernateSetWakeCapabilities(_desiredCapability);
+#endif
+ }
+
+ // Update pending wake capability at the beginning of every
+ // state transition (including synchronize). This will become
+ // the current capability at the end of the transition.
+
+ if (kSystemTransitionSleep == _systemTransitionType) {
+ _pendingCapability = 0;
+ capabilityLoss = true;
+ } else if (kSystemTransitionNewCapClient != _systemTransitionType) {
+ _pendingCapability = _desiredCapability |
+ kIOPMSystemCapabilityCPU |
+ kIOPMSystemCapabilityNetwork;
+
+ if (_pendingCapability & kIOPMSystemCapabilityGraphics) {
+ _pendingCapability |= kIOPMSystemCapabilityAudio;
+ }
+
+ if ((kSystemTransitionCapability == _systemTransitionType) &&
+ (_pendingCapability == _currentCapability)) {
+ // Cancel the PM state change.
+ _systemTransitionType = kSystemTransitionNone;
+ *inOutChangeFlags |= kIOPMNotDone;
+ }
+ if (__builtin_popcount(_pendingCapability) <
+ __builtin_popcount(_currentCapability)) {
+ capabilityLoss = true;
+ }
+ }
+
+ // 1. Capability change.
+
+ if (kSystemTransitionCapability == _systemTransitionType) {
+ // Dark to Full transition.
+ if (CAP_GAIN(kIOPMSystemCapabilityGraphics)) {
+ tracePoint( kIOPMTracePointDarkWakeExit );
+
+ willEnterFullWake();
+ }
+
+ // Full to Dark transition.
+ if (CAP_LOSS(kIOPMSystemCapabilityGraphics)) {
+ // Clear previous stats
+ IOLockLock(pmStatsLock);
+ if (pmStatsAppResponses) {
+ pmStatsAppResponses->release();
+ pmStatsAppResponses = OSArray::withCapacity(5);
+ }
+ IOLockUnlock(pmStatsLock);
+
+
+ tracePoint( kIOPMTracePointDarkWakeEntry );
+ *inOutChangeFlags |= kIOPMSyncTellPowerDown;
+ _systemMessageClientMask = kSystemMessageClientPowerd |
+ kSystemMessageClientLegacyApp;
+
+
+ // rdar://15971327
+ // Prevent user active transitions before notifying clients
+ // that system will sleep.
+ preventTransitionToUserActive(true);
+
+ IOService::setAdvisoryTickleEnable( false );
+
+ // Publish the sleep reason for full to dark wake
+ publishSleepReason = true;
+ lastSleepReason = fullToDarkReason = sleepReason;
+
+ // Publish a UUID for the Sleep --> Wake cycle
+ handlePublishSleepWakeUUID(true);
+ if (sleepDelaysReport) {
+ clock_get_uptime(&ts_sleepStart);
+ DLOG("sleepDelaysReport f->9 start at 0x%llx\n", ts_sleepStart);
+ }
+
+ wranglerTickled = false;
+ }
+ }
+ // 2. System sleep.
+ else if (kSystemTransitionSleep == _systemTransitionType) {
+ // Beginning of a system sleep transition.
+ // Cancellation is still possible.
+ tracePoint( kIOPMTracePointSleepStarted );
+
+ _systemMessageClientMask = kSystemMessageClientAll;
+ if ((_currentCapability & kIOPMSystemCapabilityGraphics) == 0) {
+ _systemMessageClientMask &= ~kSystemMessageClientLegacyApp;
+ }
+ if ((_highestCapability & kIOPMSystemCapabilityGraphics) == 0) {
+ // Kernel priority clients are only notified on the initial
+ // transition to full wake, so don't notify them unless system
+ // has gained graphics capability since the last system wake.
+ _systemMessageClientMask &= ~kSystemMessageClientKernel;
+ }
+#if HIBERNATION
+ gIOHibernateState = 0;
+#endif
+
+ // Record the reason for dark wake back to sleep
+ // System may not have ever achieved full wake
+
+ publishSleepReason = true;
+ lastSleepReason = sleepReason;
+ if (sleepDelaysReport) {
+ clock_get_uptime(&ts_sleepStart);
+ DLOG("sleepDelaysReport 9->0 start at 0x%llx\n", ts_sleepStart);
+ }
+ }
+ // 3. System wake.
+ else if (kSystemTransitionWake == _systemTransitionType) {
+ tracePoint( kIOPMTracePointWakeWillPowerOnClients );
+ // Clear stats about sleep
+
+ if (AOT_STATE == powerState) {
+ _pendingCapability = 0;
+ }
+
+ if (_pendingCapability & kIOPMSystemCapabilityGraphics) {
+ willEnterFullWake();
+ } else {
+ // Message powerd only
+ _systemMessageClientMask = kSystemMessageClientPowerd;
+ tellClients(kIOMessageSystemWillPowerOn);
+ }
+ }
+
+ // The only location where the sleep reason is published. At this point
+ // sleep can still be cancelled, but sleep reason should be published
+ // early for logging purposes.
+
+ if (publishSleepReason) {
+ static const char * IOPMSleepReasons[] =
+ {
+ kIOPMClamshellSleepKey,
+ kIOPMPowerButtonSleepKey,
+ kIOPMSoftwareSleepKey,
+ kIOPMOSSwitchHibernationKey,
+ kIOPMIdleSleepKey,
+ kIOPMLowPowerSleepKey,
+ kIOPMThermalEmergencySleepKey,
+ kIOPMMaintenanceSleepKey,
+ kIOPMSleepServiceExitKey,
+ kIOPMDarkWakeThermalEmergencyKey
+ };
+
+ // Record sleep cause in IORegistry
+ uint32_t reasonIndex = sleepReason - kIOPMSleepReasonClamshell;
+ if (reasonIndex < sizeof(IOPMSleepReasons) / sizeof(IOPMSleepReasons[0])) {
+ DLOG("sleep reason %s\n", IOPMSleepReasons[reasonIndex]);
+ setProperty(kRootDomainSleepReasonKey, IOPMSleepReasons[reasonIndex]);
+ }
+ }
+
+ if ((kSystemTransitionNone != _systemTransitionType) &&
+ (kSystemTransitionNewCapClient != _systemTransitionType)) {
+ _systemStateGeneration++;
+ systemDarkWake = false;
+
+ DLOG("=== START (%s->%s, 0x%x) type %u, gen %u, msg %x, "
+ "dcp %x:%x:%x\n",
+ getPowerStateString(currentPowerState), getPowerStateString((uint32_t) powerState), *inOutChangeFlags,
+ _systemTransitionType, _systemStateGeneration,
+ _systemMessageClientMask,
+ _desiredCapability, _currentCapability, _pendingCapability);
+ }
+
+#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146))
+ if ((AOT_STATE == powerState) && (SLEEP_STATE != currentPowerState)) {
+ panic("illegal AOT entry from %s", getPowerStateString(currentPowerState));
+ }
+ if (_aotNow && (ON_STATE == powerState)) {
+ aotShouldExit(false, true);
+ aotExit(false);
+ }
+#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */
+}
+
+void
+IOPMrootDomain::handleOurPowerChangeDone(
+ IOService * service,
+ IOPMActions * actions,
+ IOPMPowerStateIndex powerState,
+ IOPMPowerChangeFlags changeFlags,
+ IOPMRequestTag requestTag __unused )
+{
+ if (kSystemTransitionNewCapClient == _systemTransitionType) {
+ _systemTransitionType = kSystemTransitionNone;
+ return;
+ }
+
+ if (_systemTransitionType != kSystemTransitionNone) {
+ uint32_t currentPowerState = (uint32_t) getPowerState();
+
+ if (changeFlags & kIOPMNotDone) {
+ // Power down was cancelled or vetoed.
+ _pendingCapability = _currentCapability;
+ lastSleepReason = 0;
+
+ if (!CAP_CURRENT(kIOPMSystemCapabilityGraphics) &&
+ CAP_CURRENT(kIOPMSystemCapabilityCPU)) {
+#if !CONFIG_EMBEDDED
+ pmPowerStateQueue->submitPowerEvent(
+ kPowerEventPolicyStimulus,
+ (void *) kStimulusDarkWakeReentry,
+ _systemStateGeneration );
+#else
+ // On embedded, there are no factors that can prolong a
+ // "darkWake" when a power down is vetoed. We need to
+ // promote to "fullWake" at least once so that factors
+ // that prevent idle sleep can assert themselves if required
+ pmPowerStateQueue->submitPowerEvent(
+ kPowerEventPolicyStimulus,
+ (void *) kStimulusDarkWakeActivityTickle);
+#endif
+ }
+
+ // Revert device desire to max.
+ changePowerStateToPriv(getRUN_STATE());
+ } else {
+ // Send message on dark wake to full wake promotion.
+ // tellChangeUp() handles the normal SLEEP->ON case.
+
+ if (kSystemTransitionCapability == _systemTransitionType) {
+ if (CAP_GAIN(kIOPMSystemCapabilityGraphics)) {
+ lastSleepReason = 0; // stop logging wrangler tickles
+ tellClients(kIOMessageSystemHasPoweredOn);
+ }
+ if (CAP_LOSS(kIOPMSystemCapabilityGraphics)) {
+ // Going dark, reset full wake state
+ // userIsActive will be cleared by wrangler powering down
+ fullWakeReason = kFullWakeReasonNone;
+
+ if (ts_sleepStart) {
+ clock_get_uptime(&wake2DarkwakeDelay);
+ SUB_ABSOLUTETIME(&wake2DarkwakeDelay, &ts_sleepStart);
+ DLOG("sleepDelaysReport f->9 end 0x%llx\n", wake2DarkwakeDelay);
+ ts_sleepStart = 0;
+ }
+ }
+ }
+
+ // Reset state after exiting from dark wake.
+
+ if (CAP_GAIN(kIOPMSystemCapabilityGraphics) ||
+ CAP_LOSS(kIOPMSystemCapabilityCPU)) {
+ darkWakeMaintenance = false;
+ darkWakeToSleepASAP = false;
+ pciCantSleepValid = false;
+ darkWakeSleepService = false;
+
+ if (CAP_LOSS(kIOPMSystemCapabilityCPU)) {
+ // Remove the influence of display power assertion
+ // before next system wake.
+ if (wrangler) {
+ wrangler->changePowerStateForRootDomain(
+ kWranglerPowerStateMin );
+ }
+ removeProperty(gIOPMUserTriggeredFullWakeKey);
+ }
+ }
+
+ // Entered dark mode.
+
+ if (((_pendingCapability & kIOPMSystemCapabilityGraphics) == 0) &&
+ (_pendingCapability & kIOPMSystemCapabilityCPU)) {
+ // Queue an evaluation of whether to remain in dark wake,
+ // and for how long. This serves the purpose of draining
+ // any assertions from the queue.
+
+ pmPowerStateQueue->submitPowerEvent(
+ kPowerEventPolicyStimulus,
+ (void *) kStimulusDarkWakeEntry,
+ _systemStateGeneration );
+ }
+ }
+
+ DLOG("=== FINISH (%s->%s, 0x%x) type %u, gen %u, msg %x, "
+ "dcp %x:%x:%x, dbgtimer %u\n",
+ getPowerStateString(currentPowerState), getPowerStateString((uint32_t) powerState), changeFlags,
+ _systemTransitionType, _systemStateGeneration,
+ _systemMessageClientMask,
+ _desiredCapability, _currentCapability, _pendingCapability,
+ _lastDebugWakeSeconds);
+
+ if (_pendingCapability & kIOPMSystemCapabilityGraphics) {
+ displayWakeCnt++;
+#if DARK_TO_FULL_EVALUATE_CLAMSHELL
+ if (clamshellExists && fullWakeThreadCall &&
+ CAP_HIGHEST(kIOPMSystemCapabilityGraphics)) {
+ // Not the initial graphics full power, graphics won't
+ // send a power notification to trigger a lid state
+ // evaluation.
+
+ AbsoluteTime deadline;
+ clock_interval_to_deadline(45, kSecondScale, &deadline);
+ thread_call_enter_delayed(fullWakeThreadCall, deadline);
+ }
+#endif
+ } else if (CAP_GAIN(kIOPMSystemCapabilityCPU)) {
+ darkWakeCnt++;
+ }
+
+ // Update current system capability.
+ if (_currentCapability != _pendingCapability) {
+ _currentCapability = _pendingCapability;
+ }
+
+ // Update highest system capability.
+
+ _highestCapability |= _currentCapability;
+
+ if (darkWakePostTickle &&
+ (kSystemTransitionWake == _systemTransitionType) &&
+ (gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) ==
+ kDarkWakeFlagHIDTickleLate) {
+ darkWakePostTickle = false;
+ reportUserInput();
+ } else if (wranglerTickled) {
+ requestFullWake( kFullWakeReasonLocalUser );
+ }
+
+ // Reset tracepoint at completion of capability change,
+ // completion of wake transition, and aborted sleep transition.
+
+ if ((_systemTransitionType == kSystemTransitionCapability) ||
+ (_systemTransitionType == kSystemTransitionWake) ||
+ ((_systemTransitionType == kSystemTransitionSleep) &&
+ (changeFlags & kIOPMNotDone))) {
+ setProperty(kIOPMSystemCapabilitiesKey, _currentCapability, 64);
+ tracePoint( kIOPMTracePointSystemUp );
+ }
+
+ _systemTransitionType = kSystemTransitionNone;
+ _systemMessageClientMask = 0;
+ toldPowerdCapWillChange = false;
+
+ logGraphicsClamp = false;
+
+ if (lowBatteryCondition) {
+ privateSleepSystem(kIOPMSleepReasonLowPower);
+ } else if ((fullWakeReason == kFullWakeReasonDisplayOn) && (!displayPowerOnRequested)) {
+ // Request for full wake is removed while system is waking up to full wake
+ DLOG("DisplayOn fullwake request is removed\n");
+ handleDisplayPowerOn();
+ }
+
+ if (isRTCAlarmWake) {
+ pmPowerStateQueue->submitPowerEvent(
+ kPowerEventReceivedPowerNotification, (void *)(uintptr_t) kLocalEvalClamshellCommand );
+ }
+ }
+}
+
+//******************************************************************************
+// PM actions for graphics and audio.
+//******************************************************************************
+
+void
+IOPMrootDomain::overridePowerChangeForUIService(
+ IOService * service,
+ IOPMActions * actions,
+ IOPMPowerStateIndex * inOutPowerState,
+ IOPMPowerChangeFlags * inOutChangeFlags )
+{
+ uint32_t powerState = (uint32_t) *inOutPowerState;
+ uint32_t changeFlags = (uint32_t) *inOutChangeFlags;
+
+ if (kSystemTransitionNone == _systemTransitionType) {
+ // Not in midst of a system transition.
+ // Do not modify power limit enable state.
+ } else if ((actions->parameter & kPMActionsFlagLimitPower) == 0) {
+ // Activate power limiter.
+
+ if ((actions->parameter & kPMActionsFlagIsDisplayWrangler) &&
+ ((_pendingCapability & kIOPMSystemCapabilityGraphics) == 0) &&
+ (changeFlags & kIOPMSynchronize)) {
+ actions->parameter |= kPMActionsFlagLimitPower;
+ } else if ((actions->parameter & kPMActionsFlagIsAudioDevice) &&
+ ((gDarkWakeFlags & kDarkWakeFlagAudioNotSuppressed) == 0) &&
+ ((_pendingCapability & kIOPMSystemCapabilityAudio) == 0) &&
+ (changeFlags & kIOPMSynchronize)) {
+ actions->parameter |= kPMActionsFlagLimitPower;
+ } else if ((actions->parameter & kPMActionsFlagIsGraphicsDevice) &&
+ (_systemTransitionType == kSystemTransitionSleep)) {
+ // For graphics devices, arm the limiter when entering
+ // system sleep. Not when dropping to dark wake.
+ actions->parameter |= kPMActionsFlagLimitPower;
+ }
+
+ if (actions->parameter & kPMActionsFlagLimitPower) {
+ DLOG("+ plimit %s %p\n",
+ service->getName(), OBFUSCATE(service));
+ }
+ } else {
+ // Remove power limit.
+
+ if ((actions->parameter & (
+ kPMActionsFlagIsDisplayWrangler |
+ kPMActionsFlagIsGraphicsDevice)) &&
+ (_pendingCapability & kIOPMSystemCapabilityGraphics)) {
+ actions->parameter &= ~kPMActionsFlagLimitPower;
+ } else if ((actions->parameter & kPMActionsFlagIsAudioDevice) &&
+ (_pendingCapability & kIOPMSystemCapabilityAudio)) {
+ actions->parameter &= ~kPMActionsFlagLimitPower;
+ }
+
+ if ((actions->parameter & kPMActionsFlagLimitPower) == 0) {
+ DLOG("- plimit %s %p\n",
+ service->getName(), OBFUSCATE(service));
+ }
+ }
+
+ if (actions->parameter & kPMActionsFlagLimitPower) {
+ uint32_t maxPowerState = (uint32_t)(-1);
+
+ if (changeFlags & (kIOPMDomainDidChange | kIOPMDomainWillChange)) {
+ // Enforce limit for system power/cap transitions.
+
+ maxPowerState = 0;
+ if ((service->getPowerState() > maxPowerState) &&
+ (actions->parameter & kPMActionsFlagIsDisplayWrangler)) {
+ maxPowerState++;
+
+ // Remove lingering effects of any tickle before entering
+ // dark wake. It will take a new tickle to return to full
+ // wake, so the existing tickle state is useless.
+
+ if (changeFlags & kIOPMDomainDidChange) {
+ *inOutChangeFlags |= kIOPMExpireIdleTimer;
+ }
+ } else if (actions->parameter & kPMActionsFlagIsGraphicsDevice) {
+ maxPowerState++;
+ }
+ } else {
+ // Deny all self-initiated changes when power is limited.
+ // Wrangler tickle should never defeat the limiter.
+
+ maxPowerState = service->getPowerState();
+ }
+
+ if (powerState > maxPowerState) {
+ DLOG("> plimit %s %p (%u->%u, 0x%x)\n",
+ service->getName(), OBFUSCATE(service), powerState, maxPowerState,
+ changeFlags);
+ *inOutPowerState = maxPowerState;
+
+ if (darkWakePostTickle &&
+ (actions->parameter & kPMActionsFlagIsDisplayWrangler) &&
+ (changeFlags & kIOPMDomainWillChange) &&
+ ((gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) ==
+ kDarkWakeFlagHIDTickleEarly)) {
+ darkWakePostTickle = false;
+ reportUserInput();
+ }
+ }
+
+ if (!graphicsSuppressed && (changeFlags & kIOPMDomainDidChange)) {
+ if (logGraphicsClamp) {
+ AbsoluteTime now;
+ uint64_t nsec;
+
+ clock_get_uptime(&now);
+ SUB_ABSOLUTETIME(&now, &gIOLastWakeAbsTime);
+ absolutetime_to_nanoseconds(now, &nsec);
+ if (kIOLogPMRootDomain & gIOKitDebug) {
+ MSG("Graphics suppressed %u ms\n",
+ ((int)((nsec) / NSEC_PER_MSEC)));
+ }
+ }
+ graphicsSuppressed = true;
+ }
+ }
+}
+
+void
+IOPMrootDomain::handleActivityTickleForDisplayWrangler(
+ IOService * service,
+ IOPMActions * actions )
+{
+#if !NO_KERNEL_HID
+ // Warning: Not running in PM work loop context - don't modify state !!!
+ // Trap tickle directed to IODisplayWrangler while running with graphics
+ // capability suppressed.
+
+ assert(service == wrangler);
+
+ clock_get_uptime(&userActivityTime);
+ bool aborting = ((lastSleepReason == kIOPMSleepReasonIdle)
+ || (lastSleepReason == kIOPMSleepReasonMaintenance)
+ || (lastSleepReason == kIOPMSleepReasonSoftware));
+ if (aborting) {
+ userActivityCount++;
+ DLOG("display wrangler tickled1 %d lastSleepReason %d\n",
+ userActivityCount, lastSleepReason);
+ }
+
+ if (!wranglerTickled &&
+ ((_pendingCapability & kIOPMSystemCapabilityGraphics) == 0)) {
+ DLOG("display wrangler tickled\n");
+ if (kIOLogPMRootDomain & gIOKitDebug) {
+ OSReportWithBacktrace("Dark wake display tickle");
+ }
+ if (pmPowerStateQueue) {
+ pmPowerStateQueue->submitPowerEvent(
+ kPowerEventPolicyStimulus,
+ (void *) kStimulusDarkWakeActivityTickle,
+ true /* set wake type */ );
+ }
+ }
+#endif
+}
+
+void
+IOPMrootDomain::handleUpdatePowerClientForDisplayWrangler(
+ IOService * service,
+ IOPMActions * actions,
+ const OSSymbol * powerClient,
+ IOPMPowerStateIndex oldPowerState,
+ IOPMPowerStateIndex newPowerState )
+{
+#if !NO_KERNEL_HID
+ assert(service == wrangler);
+
+ // This function implements half of the user active detection
+ // by monitoring changes to the display wrangler's device desire.
+ //
+ // User becomes active when either:
+ // 1. Wrangler's DeviceDesire increases to max, but wrangler is already
+ // in max power state. This desire change in absence of a power state
+ // change is detected within. This handles the case when user becomes
+ // active while the display is already lit by setDisplayPowerOn().
+ //
+ // 2. Power state change to max, and DeviceDesire is also at max.
+ // Handled by displayWranglerNotification().
+ //
+ // User becomes inactive when DeviceDesire drops to sleep state or below.
+
+ DLOG("wrangler %s (ps %u, %u->%u)\n",
+ powerClient->getCStringNoCopy(),
+ (uint32_t) service->getPowerState(),
+ (uint32_t) oldPowerState, (uint32_t) newPowerState);
+
+ if (powerClient == gIOPMPowerClientDevice) {
+ if ((newPowerState > oldPowerState) &&
+ (newPowerState == kWranglerPowerStateMax) &&
+ (service->getPowerState() == kWranglerPowerStateMax)) {
+ evaluatePolicy( kStimulusEnterUserActiveState );
+ } else if ((newPowerState < oldPowerState) &&
+ (newPowerState <= kWranglerPowerStateSleep)) {
+ evaluatePolicy( kStimulusLeaveUserActiveState );
+ }
+ }
+
+ if (newPowerState <= kWranglerPowerStateSleep) {
+ evaluatePolicy( kStimulusDisplayWranglerSleep );
+ } else if (newPowerState == kWranglerPowerStateMax) {
+ evaluatePolicy( kStimulusDisplayWranglerWake );
+ }
+#endif
+}
+
+//******************************************************************************
+// User active state management
+//******************************************************************************
+
+void
+IOPMrootDomain::preventTransitionToUserActive( bool prevent )
+{
+#if !NO_KERNEL_HID
+ _preventUserActive = prevent;
+ if (wrangler && !_preventUserActive) {
+ // Allowing transition to user active, but the wrangler may have
+ // already powered ON in case of sleep cancel/revert. Poll the
+ // same conditions checked for in displayWranglerNotification()
+ // to bring the user active state up to date.
+
+ if ((wrangler->getPowerState() == kWranglerPowerStateMax) &&
+ (wrangler->getPowerStateForClient(gIOPMPowerClientDevice) ==
+ kWranglerPowerStateMax)) {
+ evaluatePolicy( kStimulusEnterUserActiveState );
+ }
+ }
+#endif
+}
+
+//******************************************************************************
+// Approve usage of delayed child notification by PM.
+//******************************************************************************
+
+bool
+IOPMrootDomain::shouldDelayChildNotification(
+ IOService * service )
+{
+ if (((gDarkWakeFlags & kDarkWakeFlagHIDTickleMask) != 0) &&
+ (kFullWakeReasonNone == fullWakeReason) &&
+ (kSystemTransitionWake == _systemTransitionType)) {
+ DLOG("%s: delay child notify\n", service->getName());
+ return true;
+ }
+ return false;
+}
+
+//******************************************************************************
+// PM actions for PCI device.
+//******************************************************************************
+
+void
+IOPMrootDomain::handlePowerChangeStartForPCIDevice(
+ IOService * service,
+ IOPMActions * actions,
+ IOPMPowerStateIndex powerState,
+ IOPMPowerChangeFlags * inOutChangeFlags )
+{
+ pmTracer->tracePCIPowerChange(
+ PMTraceWorker::kPowerChangeStart,
+ service, *inOutChangeFlags,
+ (actions->parameter & kPMActionsPCIBitNumberMask));
+}
+
+void
+IOPMrootDomain::handlePowerChangeDoneForPCIDevice(
+ IOService * service,
+ IOPMActions * actions,
+ IOPMPowerStateIndex powerState,
+ IOPMPowerChangeFlags changeFlags )
+{
+ pmTracer->tracePCIPowerChange(
+ PMTraceWorker::kPowerChangeCompleted,
+ service, changeFlags,
+ (actions->parameter & kPMActionsPCIBitNumberMask));
+}
+
+//******************************************************************************
+// registerInterest
+//
+// Override IOService::registerInterest() to intercept special clients.
+//******************************************************************************
+
+class IOPMServiceInterestNotifier : public _IOServiceInterestNotifier
+{
+ friend class IOPMrootDomain;
+ OSDeclareDefaultStructors(IOPMServiceInterestNotifier);
+
+protected:
+ uint32_t ackTimeoutCnt;
+ uint32_t msgType;// Message pending ack
+
+ uint64_t uuid0;
+ uint64_t uuid1;
+ const OSSymbol *identifier;
+};
+
+OSDefineMetaClassAndStructors(IOPMServiceInterestNotifier, _IOServiceInterestNotifier)
+
+IONotifier * IOPMrootDomain::registerInterest(
+ const OSSymbol * typeOfInterest,
+ IOServiceInterestHandler handler,
+ void * target, void * ref )
+{
+ IOPMServiceInterestNotifier *notifier = NULL;
+ bool isSystemCapabilityClient;
+ bool isKernelCapabilityClient;
+ IOReturn rc = kIOReturnError;;
+
+ isSystemCapabilityClient =
+ typeOfInterest &&
+ typeOfInterest->isEqualTo(kIOPMSystemCapabilityInterest);
+
+ isKernelCapabilityClient =
+ typeOfInterest &&
+ typeOfInterest->isEqualTo(gIOPriorityPowerStateInterest);
+
+ if (isSystemCapabilityClient) {
+ typeOfInterest = gIOAppPowerStateInterest;
+ }
+
+ notifier = new IOPMServiceInterestNotifier;
+ if (!notifier) {
+ return NULL;
+ }
+
+ if (notifier->init()) {
+ rc = super::registerInterestForNotifier(notifier, typeOfInterest, handler, target, ref);
+ }
+ if (rc != kIOReturnSuccess) {
+ notifier->release();
+ notifier = NULL;
+
+ return NULL;
+ }
+ if (pmPowerStateQueue) {
+ notifier->ackTimeoutCnt = 0;
+ if (isSystemCapabilityClient) {
+ notifier->retain();
+ if (pmPowerStateQueue->submitPowerEvent(
+ kPowerEventRegisterSystemCapabilityClient, notifier) == false) {
+ notifier->release();
+ }
+ }
+
+ if (isKernelCapabilityClient) {
+ notifier->retain();
+ if (pmPowerStateQueue->submitPowerEvent(
+ kPowerEventRegisterKernelCapabilityClient, notifier) == false) {
+ notifier->release();
+ }
+ }
+ }
+
+ OSData *data = NULL;
+ uint8_t *uuid = NULL;
+ OSKext *kext = OSKext::lookupKextWithAddress((vm_address_t)handler);
+ if (kext) {
+ data = kext->copyUUID();
+ }
+ if (data && (data->getLength() == sizeof(uuid_t))) {
+ uuid = (uint8_t *)(data->getBytesNoCopy());
+
+ notifier->uuid0 = ((uint64_t)(uuid[0]) << 56) | ((uint64_t)(uuid[1]) << 48) | ((uint64_t)(uuid[2]) << 40) |
+ ((uint64_t)(uuid[3]) << 32) | ((uint64_t)(uuid[4]) << 24) | ((uint64_t)(uuid[5]) << 16) |
+ ((uint64_t)(uuid[6]) << 8) | (uuid[7]);
+ notifier->uuid1 = ((uint64_t)(uuid[8]) << 56) | ((uint64_t)(uuid[9]) << 48) | ((uint64_t)(uuid[10]) << 40) |
+ ((uint64_t)(uuid[11]) << 32) | ((uint64_t)(uuid[12]) << 24) | ((uint64_t)(uuid[13]) << 16) |
+ ((uint64_t)(uuid[14]) << 8) | (uuid[15]);
+
+ notifier->identifier = kext->getIdentifier();
+ }
+ if (kext) {
+ kext->release();
+ }
+ if (data) {
+ data->release();
+ }
+
+ return notifier;
+}
+
+//******************************************************************************
+// systemMessageFilter
+//
+//******************************************************************************
+
+bool
+IOPMrootDomain::systemMessageFilter(
+ void * object, void * arg1, void * arg2, void * arg3 )
+{
+ const IOPMInterestContext * context = (const IOPMInterestContext *) arg1;
+ bool isCapMsg = (context->messageType == kIOMessageSystemCapabilityChange);
+ bool isCapClient = false;
+ bool allow = false;
+ IOPMServiceInterestNotifier *notifier;
+
+ notifier = OSDynamicCast(IOPMServiceInterestNotifier, (OSObject *)object);
+
+ do {
+ if ((kSystemTransitionNewCapClient == _systemTransitionType) &&
+ (!isCapMsg || !_joinedCapabilityClients ||
+ !_joinedCapabilityClients->containsObject((OSObject *) object))) {
+ break;
+ }
+
+ // Capability change message for app and kernel clients.
+
+ if (isCapMsg) {
+ if ((context->notifyType == kNotifyPriority) ||
+ (context->notifyType == kNotifyCapabilityChangePriority)) {
+ isCapClient = true;
+ }
+
+ if ((context->notifyType == kNotifyCapabilityChangeApps) &&
+ (object == (void *) systemCapabilityNotifier)) {
+ isCapClient = true;
+ }
+ }
+
+ if (isCapClient) {
+ IOPMSystemCapabilityChangeParameters * capArgs =
+ (IOPMSystemCapabilityChangeParameters *) arg2;
+
+ if (kSystemTransitionNewCapClient == _systemTransitionType) {
+ capArgs->fromCapabilities = 0;
+ capArgs->toCapabilities = _currentCapability;
+ capArgs->changeFlags = 0;
+ } else {
+ capArgs->fromCapabilities = _currentCapability;
+ capArgs->toCapabilities = _pendingCapability;
+
+ if (context->isPreChange) {
+ capArgs->changeFlags = kIOPMSystemCapabilityWillChange;
+ } else {
+ capArgs->changeFlags = kIOPMSystemCapabilityDidChange;
+ }
+
+ if ((object == (void *) systemCapabilityNotifier) &&
+ context->isPreChange) {
+ toldPowerdCapWillChange = true;
+ }
+ }
+
+ // Capability change messages only go to the PM configd plugin.
+ // Wait for response post-change if capabilitiy is increasing.
+ // Wait for response pre-change if capability is decreasing.
+
+ if ((context->notifyType == kNotifyCapabilityChangeApps) && arg3 &&
+ ((capabilityLoss && context->isPreChange) ||
+ (!capabilityLoss && !context->isPreChange))) {
+ // app has not replied yet, wait for it
+ *((OSObject **) arg3) = kOSBooleanFalse;
+ }
+
+ allow = true;
+ break;
+ }
+
+ // Capability client will always see kIOMessageCanSystemSleep,
+ // even for demand sleep. It will also have a chance to veto
+ // sleep one last time after all clients have responded to
+ // kIOMessageSystemWillSleep
+
+ if ((kIOMessageCanSystemSleep == context->messageType) ||
+ (kIOMessageSystemWillNotSleep == context->messageType)) {
+ if (object == (OSObject *) systemCapabilityNotifier) {
+ allow = true;
+ break;
+ }
+
+ // Not idle sleep, don't ask apps.
+ if (context->changeFlags & kIOPMSkipAskPowerDown) {
+ break;
+ }
+ }
+
+ if (kIOPMMessageLastCallBeforeSleep == context->messageType) {
+ if ((object == (OSObject *) systemCapabilityNotifier) &&
+ CAP_HIGHEST(kIOPMSystemCapabilityGraphics) &&
+ (fullToDarkReason == kIOPMSleepReasonIdle)) {
+ allow = true;
+ }
+ break;
+ }
+
+ // Reject capability change messages for legacy clients.
+ // Reject legacy system sleep messages for capability client.
+
+ if (isCapMsg || (object == (OSObject *) systemCapabilityNotifier)) {
+ break;
+ }
+
+ // Filter system sleep messages.
+
+ if ((context->notifyType == kNotifyApps) &&
+ (_systemMessageClientMask & kSystemMessageClientLegacyApp)) {
+ allow = true;
+
+ if (notifier) {
+ if (arg3) {
+ if (notifier->ackTimeoutCnt >= 3) {
+ *((OSObject **) arg3) = kOSBooleanFalse;
+ } else {
+ *((OSObject **) arg3) = kOSBooleanTrue;
+ }
+ }
+ }
+ } else if ((context->notifyType == kNotifyPriority) &&
+ (_systemMessageClientMask & kSystemMessageClientKernel)) {
+ allow = true;
+ }
+ }while (false);
+
+ if (allow && isCapMsg && _joinedCapabilityClients) {
+ _joinedCapabilityClients->removeObject((OSObject *) object);
+ if (_joinedCapabilityClients->getCount() == 0) {
+ DLOG("destroyed capability client set %p\n",
+ OBFUSCATE(_joinedCapabilityClients));
+ _joinedCapabilityClients->release();
+ _joinedCapabilityClients = NULL;
+ }
+ }
+ if (notifier) {
+ notifier->msgType = context->messageType;
+ }
+
+ return allow;
+}
+
+//******************************************************************************
+// setMaintenanceWakeCalendar
+//
+//******************************************************************************
+
+IOReturn
+IOPMrootDomain::setMaintenanceWakeCalendar(
+ const IOPMCalendarStruct * calendar )
+{
+ OSData * data;
+ IOReturn ret = 0;
+
+ if (!calendar) {
+ return kIOReturnBadArgument;
+ }
+
+ data = OSData::withBytes((void *) calendar, sizeof(*calendar));
+ if (!data) {
+ return kIOReturnNoMemory;
+ }
+
+ if (kPMCalendarTypeMaintenance == calendar->selector) {
+ ret = setPMSetting(gIOPMSettingMaintenanceWakeCalendarKey, data);
+ if (kIOReturnSuccess == ret) {
+ OSBitOrAtomic(kIOPMAlarmBitMaintenanceWake, &_scheduledAlarms);
+ }
+ } else if (kPMCalendarTypeSleepService == calendar->selector) {
+ ret = setPMSetting(gIOPMSettingSleepServiceWakeCalendarKey, data);
+ if (kIOReturnSuccess == ret) {
+ OSBitOrAtomic(kIOPMAlarmBitSleepServiceWake, &_scheduledAlarms);
+ }
+ }
+ DLOG("_scheduledAlarms = 0x%x\n", (uint32_t) _scheduledAlarms);
+
+ data->release();
+ return ret;
+}
+
+// MARK: -
+// MARK: Display Wrangler
+
+//******************************************************************************
+// displayWranglerNotification
+//
+// Handle the notification when the IODisplayWrangler changes power state.
+//******************************************************************************
+
+IOReturn
+IOPMrootDomain::displayWranglerNotification(
+ void * target, void * refCon,
+ UInt32 messageType, IOService * service,
+ void * messageArgument, vm_size_t argSize )
+{
+#if !NO_KERNEL_HID
+ int displayPowerState;
+ IOPowerStateChangeNotification * params =
+ (IOPowerStateChangeNotification *) messageArgument;
+
+ if ((messageType != kIOMessageDeviceWillPowerOff) &&
+ (messageType != kIOMessageDeviceHasPoweredOn)) {
+ return kIOReturnUnsupported;
+ }
+
+ ASSERT_GATED();
+ if (!gRootDomain) {
+ return kIOReturnUnsupported;
+ }
+
+ displayPowerState = params->stateNumber;
+ DLOG("wrangler %s ps %d\n",
+ getIOMessageString(messageType), displayPowerState);
+
+ switch (messageType) {
+ case kIOMessageDeviceWillPowerOff:
+ // Display wrangler has dropped power due to display idle
+ // or force system sleep.
+ //
+ // 4 Display ON kWranglerPowerStateMax
+ // 3 Display Dim kWranglerPowerStateDim
+ // 2 Display Sleep kWranglerPowerStateSleep
+ // 1 Not visible to user
+ // 0 Not visible to user kWranglerPowerStateMin
+
+ if (displayPowerState <= kWranglerPowerStateSleep) {
+ gRootDomain->evaluatePolicy( kStimulusDisplayWranglerSleep );
+ }
+ break;
+
+ case kIOMessageDeviceHasPoweredOn:
+ // Display wrangler has powered on due to user activity
+ // or wake from sleep.
+
+ if (kWranglerPowerStateMax == displayPowerState) {
+ gRootDomain->evaluatePolicy( kStimulusDisplayWranglerWake );
+
+ // See comment in handleUpdatePowerClientForDisplayWrangler
+ if (service->getPowerStateForClient(gIOPMPowerClientDevice) ==
+ kWranglerPowerStateMax) {
+ gRootDomain->evaluatePolicy( kStimulusEnterUserActiveState );
+ }
+ }
+ break;
+ }
+#endif
+ return kIOReturnUnsupported;
+}
+
+//******************************************************************************
+// displayWranglerMatchPublished
+//
+// Receives a notification when the IODisplayWrangler is published.
+// When it's published we install a power state change handler.
+//******************************************************************************
+
+bool
+IOPMrootDomain::displayWranglerMatchPublished(
+ void * target,
+ void * refCon,
+ IOService * newService,
+ IONotifier * notifier __unused)
+{
+#if !NO_KERNEL_HID
+ // install a handler
+ if (!newService->registerInterest( gIOGeneralInterest,
+ &displayWranglerNotification, target, NULL)) {
+ return false;
+ }
+#endif
+ return true;
+}
+
+//******************************************************************************
+// reportUserInput
+//
+//******************************************************************************
+
+void
+IOPMrootDomain::reportUserInput( void )
+{
+#if !NO_KERNEL_HID
+ OSIterator * iter;
+ OSDictionary * matching;
+
+ if (!wrangler) {
+ matching = serviceMatching("IODisplayWrangler");
+ iter = getMatchingServices(matching);
+ if (matching) {
+ matching->release();
+ }
+ if (iter) {
+ wrangler = OSDynamicCast(IOService, iter->getNextObject());
+ iter->release();
+ }
+ }
+
+ if (wrangler) {
+ wrangler->activityTickle(0, 0);
+ }
+#endif
+}
+
+//******************************************************************************
+// latchDisplayWranglerTickle
+//******************************************************************************
+
+bool
+IOPMrootDomain::latchDisplayWranglerTickle( bool latch )
+{
+#if !NO_KERNEL_HID
+ if (latch) {
+ if (!(_currentCapability & kIOPMSystemCapabilityGraphics) &&
+ !(_pendingCapability & kIOPMSystemCapabilityGraphics) &&
+ !checkSystemCanSustainFullWake()) {
+ // Currently in dark wake, and not transitioning to full wake.
+ // Full wake is unsustainable, so latch the tickle to prevent
+ // the display from lighting up momentarily.
+ wranglerTickleLatched = true;
+ } else {
+ wranglerTickleLatched = false;
+ }
+ } else if (wranglerTickleLatched && checkSystemCanSustainFullWake()) {
+ wranglerTickleLatched = false;
+
+ pmPowerStateQueue->submitPowerEvent(
+ kPowerEventPolicyStimulus,
+ (void *) kStimulusDarkWakeActivityTickle );
+ }
+
+ return wranglerTickleLatched;
+#else
+ return false;
+#endif
+}
+
+//******************************************************************************
+// setDisplayPowerOn
+//
+// For root domain user client
+//******************************************************************************
+
+void
+IOPMrootDomain::setDisplayPowerOn( uint32_t options )
+{
+ pmPowerStateQueue->submitPowerEvent( kPowerEventSetDisplayPowerOn,
+ (void *) NULL, options );
+}
+
+// MARK: -
+// MARK: Battery
+
+//******************************************************************************
+// batteryPublished
+//
+// Notification on battery class IOPowerSource appearance
+//******************************************************************************
+
+bool
+IOPMrootDomain::batteryPublished(
+ void * target,
+ void * root_domain,
+ IOService * resourceService,
+ IONotifier * notifier __unused )
+{
+ // rdar://2936060&4435589
+ // All laptops have dimmable LCD displays
+ // All laptops have batteries
+ // So if this machine has a battery, publish the fact that the backlight
+ // supports dimming.
+ ((IOPMrootDomain *)root_domain)->publishFeature("DisplayDims");
+
+ return true;
+}
+
+// MARK: -
+// MARK: System PM Policy
+
+//******************************************************************************
+// checkSystemSleepAllowed
+//
+//******************************************************************************
+
+bool
+IOPMrootDomain::checkSystemSleepAllowed( IOOptionBits options,
+ uint32_t sleepReason )
+{
+ uint32_t err = 0;
+
+ // Conditions that prevent idle and demand system sleep.
+
+ do {
+ if (userDisabledAllSleep) {
+ err = kPMUserDisabledAllSleep; // 1. user-space sleep kill switch
+ break;
+ }
+
+ if (systemBooting || systemShutdown || gWillShutdown) {
+ err = kPMSystemRestartBootingInProgress; // 2. restart or shutdown in progress
+ break;
+ }
+
+ if (options == 0) {
+ break;
+ }
+
+ // Conditions above pegs the system at full wake.
+ // Conditions below prevent system sleep but does not prevent
+ // dark wake, and must be called from gated context.
+
+#if !CONFIG_SLEEP
+ err = kPMConfigPreventSystemSleep; // 3. config does not support sleep
+ break;
+#endif
+
+ if (lowBatteryCondition || thermalWarningState) {
+ break; // always sleep on low battery or when in thermal warning state
+ }
+
+ if (sleepReason == kIOPMSleepReasonDarkWakeThermalEmergency) {
+ break; // always sleep on dark wake thermal emergencies
+ }
+
+ if (preventSystemSleepList->getCount() != 0) {
+ err = kPMChildPreventSystemSleep; // 4. child prevent system sleep clamp
+ break;
+ }
+
+ if (getPMAssertionLevel( kIOPMDriverAssertionCPUBit ) ==
+ kIOPMDriverAssertionLevelOn) {
+ err = kPMCPUAssertion; // 5. CPU assertion
+ break;
+ }
+
+ if (pciCantSleepValid) {
+ if (pciCantSleepFlag) {
+ err = kPMPCIUnsupported; // 6. PCI card does not support PM (cached)
+ }
+ break;
+ } else if (sleepSupportedPEFunction &&
+ CAP_HIGHEST(kIOPMSystemCapabilityGraphics)) {
+ IOReturn ret;
+ OSBitAndAtomic(~kPCICantSleep, &platformSleepSupport);
+ ret = getPlatform()->callPlatformFunction(
+ sleepSupportedPEFunction, false,
+ NULL, NULL, NULL, NULL);
+ pciCantSleepValid = true;
+ pciCantSleepFlag = false;
+ if ((platformSleepSupport & kPCICantSleep) ||
+ ((ret != kIOReturnSuccess) && (ret != kIOReturnUnsupported))) {
+ err = 6; // 6. PCI card does not support PM
+ pciCantSleepFlag = true;
+ break;
+ }
+ }
+ }while (false);
+
+ if (err) {
+ DLOG("System sleep prevented by %s\n", getSystemSleepPreventerString(err));
+ return false;
+ }
+ return true;
+}
+
+bool
+IOPMrootDomain::checkSystemSleepEnabled( void )
+{
+ return checkSystemSleepAllowed(0, 0);
+}
+
+bool
+IOPMrootDomain::checkSystemCanSleep( uint32_t sleepReason )
+{
+ ASSERT_GATED();
+ return checkSystemSleepAllowed(1, sleepReason);
+}
+
+//******************************************************************************
+// checkSystemCanSustainFullWake
+//******************************************************************************
+
+bool
+IOPMrootDomain::checkSystemCanSustainFullWake( void )
+{
+#if !NO_KERNEL_HID
+ if (lowBatteryCondition || thermalWarningState) {
+ // Low battery wake, or received a low battery notification
+ // while system is awake. This condition will persist until
+ // the following wake.
+ return false;
+ }
+
+ if (clamshellExists && clamshellClosed && !clamshellSleepDisabled) {
+ // Graphics state is unknown and external display might not be probed.
+ // Do not incorporate state that requires graphics to be in max power
+ // such as desktopMode or clamshellDisabled.
+
+ if (!acAdaptorConnected) {
+ DLOG("full wake check: no AC\n");
+ return false;
+ }
+ }
+#endif
+ return true;
+}
+
+//******************************************************************************
+// mustHibernate
+//******************************************************************************
+
+#if HIBERNATION
+
+bool
+IOPMrootDomain::mustHibernate( void )
+{
+ return lowBatteryCondition || thermalWarningState;
+}
+
+#endif /* HIBERNATION */
+
+//******************************************************************************
+// AOT
+//******************************************************************************
+
+// Tables for accumulated days in year by month, latter used for leap years
+
+static const int daysbymonth[] =
+{ 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334, 365 };
+
+static const int lydaysbymonth[] =
+{ 0, 31, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335, 366 };
+
+static int __unused
+IOPMConvertSecondsToCalendar(long secs, IOPMCalendarStruct * dt)
+{
+ const int * dbm = daysbymonth;
+ long n, x, y, z;
+
+ if (secs < 0) {
+ return 0;
+ }
+
+ // Calculate seconds, minutes and hours
+
+ n = secs % (24 * 3600);
+ dt->second = n % 60;
+ n /= 60;
+ dt->minute = n % 60;
+ dt->hour = n / 60;
+
+ // Calculate day of week
+
+ n = secs / (24 * 3600);
+// dt->dayWeek = (n + 4) % 7;
+
+ // Calculate year
+ // Rebase from days since Unix epoch (1/1/1970) store in 'n',
+ // to days since 1/1/1968 to start on 4 year cycle, beginning
+ // on a leap year.
+
+ n += (366 + 365);
+
+ // Every 4 year cycle will be exactly (366 + 365 * 3) = 1461 days.
+ // Valid before 2100, since 2100 is not a leap year.
+
+ x = n / 1461; // number of 4 year cycles
+ y = n % 1461; // days into current 4 year cycle
+ z = 1968 + (4 * x);
+
+ // Add in years in the current 4 year cycle
+
+ if (y >= 366) {
+ y -= 366; // days after the leap year
+ n = y % 365; // days into the current year
+ z += (1 + y / 365); // years after the past 4-yr cycle
+ } else {
+ n = y;
+ dbm = lydaysbymonth;
+ }
+ if (z > 2099) {
+ return 0;
+ }
+
+ dt->year = z;
+
+ // Adjust remaining days value to start at 1
+
+ n += 1;
+
+ // Calculate month
+
+ for (x = 1; n > dbm[x]; x++) {
+ continue;
+ }
+ dt->month = x;
+
+ // Calculate day of month
+
+ dt->day = n - dbm[x - 1];
+
+ return 1;
+}
+
+static long
+IOPMConvertCalendarToSeconds(const IOPMCalendarStruct * dt)
+{
+ const int * dbm = daysbymonth;
+ long y, secs, days;
+
+ if (dt->year < 1970) {
+ return 0;
+ }
+
+ // Seconds elapsed in the current day
+
+ secs = dt->second + 60 * dt->minute + 3600 * dt->hour;
+
+ // Number of days from 1/1/70 to beginning of current year
+ // Account for extra day every 4 years starting at 1973
+
+ y = dt->year - 1970;
+ days = (y * 365) + ((y + 1) / 4);
+
+ // Change table if current year is a leap year
+
+ if ((dt->year % 4) == 0) {
+ dbm = lydaysbymonth;
+ }
+
+ // Add in days elapsed in the current year
+
+ days += (dt->day - 1) + dbm[dt->month - 1];
+
+ // Add accumulated days to accumulated seconds
+
+ secs += 24 * 3600 * days;
+
+ return secs;
+}
+
+#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146))
+
+unsigned long
+IOPMrootDomain::getRUN_STATE(void)
+{
+ return _aotNow ? AOT_STATE : ON_STATE;
+}
+
+bool
+IOPMrootDomain::isAOTMode()
+{
+ return _aotNow;
+}
+
+IOReturn
+IOPMrootDomain::setWakeTime(uint64_t wakeContinuousTime)
+{
+ clock_sec_t nowsecs, wakesecs;
+ clock_usec_t nowmicrosecs, wakemicrosecs;
+ uint64_t nowAbs, wakeAbs;
+
+ clock_gettimeofday_and_absolute_time(&nowsecs, &nowmicrosecs, &nowAbs);
+ wakeAbs = continuoustime_to_absolutetime(wakeContinuousTime);
+ if (wakeAbs < nowAbs) {
+ printf(LOG_PREFIX "wakeAbs %qd < nowAbs %qd\n", wakeAbs, nowAbs);
+ wakeAbs = nowAbs;
+ }
+ wakeAbs -= nowAbs;
+ absolutetime_to_microtime(wakeAbs, &wakesecs, &wakemicrosecs);
+
+ wakesecs += nowsecs;
+ wakemicrosecs += nowmicrosecs;
+ if (wakemicrosecs >= USEC_PER_SEC) {
+ wakesecs++;
+ wakemicrosecs -= USEC_PER_SEC;
+ }
+ if (wakemicrosecs >= (USEC_PER_SEC / 10)) {
+ wakesecs++;
+ }
+
+ IOPMConvertSecondsToCalendar(wakesecs, &_aotWakeTimeCalendar);
+
+ if (_aotWakeTimeContinuous != wakeContinuousTime) {
+ _aotWakeTimeContinuous = wakeContinuousTime;
+ IOLog(LOG_PREFIX "setWakeTime: " YMDTF "\n", YMDT(&_aotWakeTimeCalendar));
+ }
+ _aotWakeTimeCalendar.selector = kPMCalendarTypeMaintenance;
+ _aotWakeTimeUTC = wakesecs;
+
+ return kIOReturnSuccess;
+}
+
+// assumes WAKEEVENT_LOCK
+bool
+IOPMrootDomain::aotShouldExit(bool checkTimeSet, bool software)
+{
+ bool exitNow;
+ const char * reason = "";
+
+ if (software) {
+ _aotExit = true;
+ _aotMetrics->softwareRequestCount++;
+ reason = "software request";
+ } else if (kIOPMWakeEventAOTExitFlags & _aotPendingFlags) {
+ _aotExit = true;
+ reason = gWakeReasonString;
+ } else if (checkTimeSet && (kPMCalendarTypeInvalid == _aotWakeTimeCalendar.selector)) {
+ _aotExit = true;
+ _aotMetrics->noTimeSetCount++;
+ reason = "flipbook expired";
+ } else if ((kIOPMAOTModeRespectTimers & _aotMode) && _scheduledAlarmUTC) {
+ clock_sec_t sec;
+ clock_usec_t usec;
+ clock_get_calendar_microtime(&sec, &usec);
+ if (_scheduledAlarmUTC <= sec) {
+ _aotExit = true;
+ _aotMetrics->rtcAlarmsCount++;
+ reason = "user alarm";
+ }
+ }
+ exitNow = (_aotNow && _aotExit);
+ if (exitNow) {
+ _aotNow = false;
+ IOLog(LOG_PREFIX "AOT exit for %s, sc %d po %d, cp %d, rj %d, ex %d, nt %d, rt %d\n",
+ reason,
+ _aotMetrics->sleepCount,
+ _aotMetrics->possibleCount,
+ _aotMetrics->confirmedPossibleCount,
+ _aotMetrics->rejectedPossibleCount,
+ _aotMetrics->expiredPossibleCount,
+ _aotMetrics->noTimeSetCount,
+ _aotMetrics->rtcAlarmsCount);
+ }
+ return exitNow;
+}
+
+void
+IOPMrootDomain::aotExit(bool cps)
+{
+ _aotTasksSuspended = false;
+ _aotReadyToFullWake = false;
+ if (_aotTimerScheduled) {
+ _aotTimerES->cancelTimeout();
+ _aotTimerScheduled = false;
+ }
+ updateTasksSuspend();
+
+ _aotMetrics->totalTime += mach_absolute_time() - _aotLastWakeTime;
+ _aotLastWakeTime = 0;
+ if (_aotMetrics->sleepCount && (_aotMetrics->sleepCount <= kIOPMAOTMetricsKernelWakeCountMax)) {
+ strlcpy(&_aotMetrics->kernelWakeReason[_aotMetrics->sleepCount - 1][0],
+ gWakeReasonString,
+ sizeof(_aotMetrics->kernelWakeReason[_aotMetrics->sleepCount]));
+ }
+
+ _aotWakeTimeCalendar.selector = kPMCalendarTypeInvalid;
+
+ _systemMessageClientMask = kSystemMessageClientLegacyApp;
+ tellClients(kIOMessageSystemWillPowerOn);
+
+ if (cps) {
+ changePowerStateToPriv(getRUN_STATE());
+ }
+}
+
+void
+IOPMrootDomain::aotEvaluate(IOTimerEventSource * timer)
+{
+ bool exitNow;
+
+ IOLog("aotEvaluate(%d) 0x%x\n", (timer != NULL), _aotPendingFlags);
+
+ WAKEEVENT_LOCK();
+ exitNow = aotShouldExit(false, false);
+ if (timer != NULL) {
+ _aotTimerScheduled = false;
+ }
+ WAKEEVENT_UNLOCK();
+ if (exitNow) {
+ aotExit(true);
+ } else {
+#if 0
+ if (_aotLingerTime) {
+ uint64_t deadline;
+ IOLog("aot linger before sleep\n");
+ clock_absolutetime_interval_to_deadline(_aotLingerTime, &deadline);
+ clock_delay_until(deadline);
+ }
+#endif
+ privateSleepSystem(kIOPMSleepReasonSoftware);
+ }
+}
+
+#else /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */
+
+unsigned long
+IOPMrootDomain::getRUN_STATE(void)
+{
+ return ON_STATE;
+}
+
+IOReturn
+IOPMrootDomain::setWakeTime(uint64_t wakeContinuousTime)
+{
+ return kIOReturnUnsupported;
+}
+
+#endif /* (defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */
+
+//******************************************************************************
+// adjustPowerState
+//
+// Conditions that affect our wake/sleep decision has changed.
+// If conditions dictate that the system must remain awake, clamp power
+// state to max with changePowerStateToPriv(ON). Otherwise if sleepASAP
+// is TRUE, then remove the power clamp and allow the power state to drop
+// to SLEEP_STATE.
+//******************************************************************************
+
+void
+IOPMrootDomain::adjustPowerState( bool sleepASAP )
+{
+ DEBUG_LOG("adjustPowerState ps %s, asap %d, idleSleepEnabled %d\n",
+ getPowerStateString((uint32_t) getPowerState()), sleepASAP, idleSleepEnabled);
+
+ ASSERT_GATED();
+
+#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146))
+ if (_aotNow) {
+ bool exitNow;
+
+ if (AOT_STATE != getPowerState()) {
+ return;
+ }
+ WAKEEVENT_LOCK();
+ exitNow = aotShouldExit(true, false);
+ if (!exitNow
+ && !_aotTimerScheduled
+ && (kIOPMWakeEventAOTPossibleExit == (kIOPMWakeEventAOTPossibleFlags & _aotPendingFlags))) {
+ _aotTimerScheduled = true;
+ if (_aotLingerTime) {
+ _aotTimerES->setTimeout(_aotLingerTime);
+ } else {
+ _aotTimerES->setTimeout(800, kMillisecondScale);
+ }
+ }
+ WAKEEVENT_UNLOCK();
+ if (exitNow) {
+ aotExit(true);
+ } else {
+ _aotReadyToFullWake = true;
+ if (!_aotTimerScheduled) {
+ privateSleepSystem(kIOPMSleepReasonSoftware);
+ }
+ }
+ return;
+ }
+#endif /* (defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */
+
+ if ((!idleSleepEnabled) || !checkSystemSleepEnabled()) {
+ changePowerStateToPriv(getRUN_STATE());
+ } else if (sleepASAP) {
+ changePowerStateToPriv(SLEEP_STATE);
+ }
+}
+
+void
+IOPMrootDomain::handleDisplayPowerOn()
+{
+ if (!wrangler) {
+ return;
+ }
+ if (displayPowerOnRequested) {
+ if (!checkSystemCanSustainFullWake()) {
+ return;
+ }
+
+ // Force wrangler to max power state. If system is in dark wake
+ // this alone won't raise the wrangler's power state.
+
+ wrangler->changePowerStateForRootDomain(kWranglerPowerStateMax);
+
+ // System in dark wake, always requesting full wake should
+ // not have any bad side-effects, even if the request fails.
+
+ if (!CAP_CURRENT(kIOPMSystemCapabilityGraphics)) {
+ setProperty(kIOPMRootDomainWakeTypeKey, kIOPMRootDomainWakeTypeNotification);
+ requestFullWake( kFullWakeReasonDisplayOn );
+ }
+ } else {
+ // Relenquish desire to power up display.
+ // Must first transition to state 1 since wrangler doesn't
+ // power off the displays at state 0. At state 0 the root
+ // domain is removed from the wrangler's power client list.
+
+ wrangler->changePowerStateForRootDomain(kWranglerPowerStateMin + 1);
+ wrangler->changePowerStateForRootDomain(kWranglerPowerStateMin);
+ }
+}
+
+//******************************************************************************
+// dispatchPowerEvent
+//
+// IOPMPowerStateQueue callback function. Running on PM work loop thread.
+//******************************************************************************
+
+void
+IOPMrootDomain::dispatchPowerEvent(
+ uint32_t event, void * arg0, uint64_t arg1 )
+{
+ ASSERT_GATED();
+
+ switch (event) {
+ case kPowerEventFeatureChanged:
+ DMSG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1);
+ messageClients(kIOPMMessageFeatureChange, this);
+ break;
+
+ case kPowerEventReceivedPowerNotification:
+ DMSG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1);
+ handlePowerNotification((UInt32)(uintptr_t) arg0 );
+ break;
+
+ case kPowerEventSystemBootCompleted:
+ DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1);
+ if (systemBooting) {
+ systemBooting = false;
+
+ // read noidle setting from Device Tree
+ IORegistryEntry *defaults = IORegistryEntry::fromPath("IODeviceTree:/defaults");
+ if (defaults != NULL) {
+ OSData *data = OSDynamicCast(OSData, defaults->getProperty("no-idle"));
+ if ((data != NULL) && (data->getLength() == 4)) {
+ gNoIdleFlag = *(uint32_t*)data->getBytesNoCopy();
+ DLOG("Setting gNoIdleFlag to %u from device tree\n", gNoIdleFlag);
+ }
+ defaults->release();
+ }
+ if (lowBatteryCondition) {
+ privateSleepSystem(kIOPMSleepReasonLowPower);
+
+ // The rest is unnecessary since the system is expected
+ // to sleep immediately. The following wake will update
+ // everything.
+ break;
+ }
+
+ sleepWakeDebugMemAlloc();
+ saveFailureData2File();
+
+ // If lid is closed, re-send lid closed notification
+ // now that booting is complete.
+ if (clamshellClosed) {
+ handlePowerNotification(kLocalEvalClamshellCommand);
+ }
+ evaluatePolicy( kStimulusAllowSystemSleepChanged );
+ }
+ break;
+
+ case kPowerEventSystemShutdown:
+ DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1);
+ if (kOSBooleanTrue == (OSBoolean *) arg0) {
+ /* We set systemShutdown = true during shutdown
+ * to prevent sleep at unexpected times while loginwindow is trying
+ * to shutdown apps and while the OS is trying to transition to
+ * complete power of.
+ *
+ * Set to true during shutdown, as soon as loginwindow shows
+ * the "shutdown countdown dialog", through individual app
+ * termination, and through black screen kernel shutdown.
+ */
+ systemShutdown = true;
+ } else {
+ /*
+ * A shutdown was initiated, but then the shutdown
+ * was cancelled, clearing systemShutdown to false here.
+ */
+ systemShutdown = false;
+ }
+ break;
+
+ case kPowerEventUserDisabledSleep:
+ DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1);
+ userDisabledAllSleep = (kOSBooleanTrue == (OSBoolean *) arg0);
+ break;
+
+ case kPowerEventRegisterSystemCapabilityClient:
+ DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1);
+ if (systemCapabilityNotifier) {
+ systemCapabilityNotifier->release();
+ systemCapabilityNotifier = NULL;
+ }
+ if (arg0) {
+ systemCapabilityNotifier = (IONotifier *) arg0;
+ systemCapabilityNotifier->retain();
+ }
+ /* intentional fall-through */
+ [[clang::fallthrough]];
+
+ case kPowerEventRegisterKernelCapabilityClient:
+ DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1);
+ if (!_joinedCapabilityClients) {
+ _joinedCapabilityClients = OSSet::withCapacity(8);
+ }
+ if (arg0) {
+ IONotifier * notify = (IONotifier *) arg0;
+ if (_joinedCapabilityClients) {
+ _joinedCapabilityClients->setObject(notify);
+ synchronizePowerTree( kIOPMSyncNoChildNotify );
+ }
+ notify->release();
+ }
+ break;
+
+ case kPowerEventPolicyStimulus:
+ DMSG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1);
+ if (arg0) {
+ int stimulus = (uintptr_t) arg0;
+ evaluatePolicy( stimulus, (uint32_t) arg1 );
+ }
+ break;
+
+ case kPowerEventAssertionCreate:
+ DMSG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1);
+ if (pmAssertions) {
+ pmAssertions->handleCreateAssertion((OSData *)arg0);
+ }
+ break;
+
+
+ case kPowerEventAssertionRelease:
+ DMSG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1);
+ if (pmAssertions) {
+ pmAssertions->handleReleaseAssertion(arg1);
+ }
+ break;
+
+ case kPowerEventAssertionSetLevel:
+ DMSG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1);
+ if (pmAssertions) {
+ pmAssertions->handleSetAssertionLevel(arg1, (IOPMDriverAssertionLevel)(uintptr_t)arg0);
+ }
+ break;
+
+ case kPowerEventQueueSleepWakeUUID:
+ DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1);
+ handleQueueSleepWakeUUID((OSObject *)arg0);
+ break;
+ case kPowerEventPublishSleepWakeUUID:
+ DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1);
+ handlePublishSleepWakeUUID((bool)arg0);
+ break;
+
+ case kPowerEventSetDisplayPowerOn:
+ DLOG("power event %u args %p 0x%llx\n", event, OBFUSCATE(arg0), arg1);
+ if (!wrangler) {
+ break;
+ }
+ if (arg1 != 0) {
+ displayPowerOnRequested = true;
+ } else {
+ displayPowerOnRequested = false;
+ }
+ handleDisplayPowerOn();
+ break;
+ }
+}
+
+//******************************************************************************
+// systemPowerEventOccurred
+//
+// The power controller is notifying us of a hardware-related power management
+// event that we must handle.
+//
+// systemPowerEventOccurred covers the same functionality that
+// receivePowerNotification does; it simply provides a richer API for conveying
+// more information.
+//******************************************************************************
+
+IOReturn
+IOPMrootDomain::systemPowerEventOccurred(
+ const OSSymbol *event,
+ uint32_t intValue)
+{
+ IOReturn attempt = kIOReturnSuccess;
+ OSNumber *newNumber = NULL;
+
+ if (!event) {
+ return kIOReturnBadArgument;
+ }
+
+ newNumber = OSNumber::withNumber(intValue, 8 * sizeof(intValue));
+ if (!newNumber) {
+ return kIOReturnInternalError;
+ }
+
+ attempt = systemPowerEventOccurred(event, (OSObject *)newNumber);
+
+ newNumber->release();
+
+ return attempt;
+}
+
+void
+IOPMrootDomain::setThermalState(OSObject *value)
+{
+ OSNumber * num;
+
+ if (gIOPMWorkLoop->inGate() == false) {
+ gIOPMWorkLoop->runAction(
+ OSMemberFunctionCast(IOWorkLoop::Action, this, &IOPMrootDomain::setThermalState),
+ (OSObject *)this,
+ (void *)value);
+
+ return;
+ }
+ if (value && (num = OSDynamicCast(OSNumber, value))) {
+ thermalWarningState = ((num->unsigned32BitValue() == kIOPMThermalLevelWarning) ||
+ (num->unsigned32BitValue() == kIOPMThermalLevelTrap)) ? 1 : 0;
+ }
+}
+
+IOReturn
+IOPMrootDomain::systemPowerEventOccurred(
+ const OSSymbol *event,
+ OSObject *value)
+{
+ OSDictionary *thermalsDict = NULL;
+ bool shouldUpdate = true;
+
+ if (!event || !value) {
+ return kIOReturnBadArgument;
+ }
+
+ // LOCK
+ // We reuse featuresDict Lock because it already exists and guards
+ // the very infrequently used publish/remove feature mechanism; so there's zero rsk
+ // of stepping on that lock.
+ if (featuresDictLock) {
+ IOLockLock(featuresDictLock);
+ }
+
+ thermalsDict = (OSDictionary *)getProperty(kIOPMRootDomainPowerStatusKey);
+
+ if (thermalsDict && OSDynamicCast(OSDictionary, thermalsDict)) {
+ thermalsDict = OSDictionary::withDictionary(thermalsDict);
+ } else {
+ thermalsDict = OSDictionary::withCapacity(1);
+ }
+
+ if (!thermalsDict) {
+ shouldUpdate = false;
+ goto exit;
+ }
+
+ thermalsDict->setObject(event, value);
+
+ setProperty(kIOPMRootDomainPowerStatusKey, thermalsDict);
+
+ thermalsDict->release();
+
+exit:
+ // UNLOCK
+ if (featuresDictLock) {
+ IOLockUnlock(featuresDictLock);
+ }
+
+ if (shouldUpdate) {
+ if (event &&
+ event->isEqualTo(kIOPMThermalLevelWarningKey)) {
+ setThermalState(value);
+ }
+ messageClients(kIOPMMessageSystemPowerEventOccurred, (void *)NULL);
+ }
+
+ return kIOReturnSuccess;
+}
+
+//******************************************************************************
+// receivePowerNotification
+//
+// The power controller is notifying us of a hardware-related power management
+// event that we must handle. This may be a result of an 'environment' interrupt
+// from the power mgt micro.
+//******************************************************************************
+
+IOReturn
+IOPMrootDomain::receivePowerNotification( UInt32 msg )
+{
+ if (msg & kIOPMPowerButton) {
+ uint32_t currentPhase = pmTracer->getTracePhase();
+ if (currentPhase != kIOPMTracePointSystemUp && currentPhase > kIOPMTracePointSystemSleep) {
+ DEBUG_LOG("power button pressed during wake. phase = %u\n", currentPhase);
+ swd_flags |= SWD_PWR_BTN_STACKSHOT;
+ thread_call_enter(powerButtonDown);
+ } else {
+ DEBUG_LOG("power button pressed when system is up\n");
+ }
+ } else if (msg & kIOPMPowerButtonUp) {
+ if (swd_flags & SWD_PWR_BTN_STACKSHOT) {
+ swd_flags &= ~SWD_PWR_BTN_STACKSHOT;
+ thread_call_enter(powerButtonUp);
+ }
+ } else {
+ pmPowerStateQueue->submitPowerEvent(
+ kPowerEventReceivedPowerNotification, (void *)(uintptr_t) msg );
+ }
+ return kIOReturnSuccess;
+}
+
+void
+IOPMrootDomain::handlePowerNotification( UInt32 msg )
+{
+ bool eval_clamshell = false;
+ bool eval_clamshell_alarm = false;
+
+ ASSERT_GATED();
+
+ /*
+ * Local (IOPMrootDomain only) eval clamshell command
+ */
+ if (msg & kLocalEvalClamshellCommand) {
+ if (isRTCAlarmWake) {
+ eval_clamshell_alarm = true;
+
+ // reset isRTCAlarmWake. This evaluation should happen only once
+ // on RTC/Alarm wake. Any clamshell events after wake should follow
+ // the regular evaluation
+ isRTCAlarmWake = false;
+ } else {
+ eval_clamshell = true;
+ }
+ }
+
+ /*
+ * Overtemp
+ */
+ if (msg & kIOPMOverTemp) {
+ MSG("PowerManagement emergency overtemp signal. Going to sleep!");
+ privateSleepSystem(kIOPMSleepReasonThermalEmergency);
+ }
+
+ /*
+ * Forward DW thermal notification to client, if system is not going to sleep
+ */
+ if ((msg & kIOPMDWOverTemp) && (_systemTransitionType != kSystemTransitionSleep)) {
+ DLOG("DarkWake thermal limits message received!\n");
+
+ messageClients(kIOPMMessageDarkWakeThermalEmergency);
+ }
+
+ /*
+ * Sleep Now!
+ */
+ if (msg & kIOPMSleepNow) {
+ privateSleepSystem(kIOPMSleepReasonSoftware);
+ }
+
+ /*
+ * Power Emergency
+ */
+ if (msg & kIOPMPowerEmergency) {
+ lowBatteryCondition = true;
+ privateSleepSystem(kIOPMSleepReasonLowPower);
+ }
+
+ /*
+ * Clamshell OPEN
+ */
+ if (msg & kIOPMClamshellOpened) {
+ DLOG("Clamshell opened\n");
+ // Received clamshel open message from clamshell controlling driver
+ // Update our internal state and tell general interest clients
+ clamshellClosed = false;
+ clamshellExists = true;
+
+ // Don't issue a hid tickle when lid is open and polled on wake
+ if (msg & kIOPMSetValue) {
+ setProperty(kIOPMRootDomainWakeTypeKey, "Lid Open");
+ reportUserInput();
+ }
+
+ // Tell PMCPU
+ informCPUStateChange(kInformLid, 0);
+
+ // Tell general interest clients
+ sendClientClamshellNotification();
+
+ bool aborting = ((lastSleepReason == kIOPMSleepReasonClamshell)
+ || (lastSleepReason == kIOPMSleepReasonIdle)
+ || (lastSleepReason == kIOPMSleepReasonMaintenance));
+ if (aborting) {
+ userActivityCount++;
+ }
+ DLOG("clamshell tickled %d lastSleepReason %d\n", userActivityCount, lastSleepReason);
+ }
+
+ /*
+ * Clamshell CLOSED
+ * Send the clamshell interest notification since the lid is closing.
+ */
+ if (msg & kIOPMClamshellClosed) {
+ if (clamshellClosed && clamshellExists) {
+ DLOG("Ignoring redundant Clamshell close event\n");
+ } else {
+ DLOG("Clamshell closed\n");
+ // Received clamshel open message from clamshell controlling driver
+ // Update our internal state and tell general interest clients
+ clamshellClosed = true;
+ clamshellExists = true;
+
+ // Tell PMCPU
+ informCPUStateChange(kInformLid, 1);
+
+ // Tell general interest clients
+ sendClientClamshellNotification();
+
+ // And set eval_clamshell = so we can attempt
+ eval_clamshell = true;
+ }
+ }
+
+ /*
+ * Set Desktop mode (sent from graphics)
+ *
+ * -> reevaluate lid state
+ */
+ if (msg & kIOPMSetDesktopMode) {
+ DLOG("Desktop mode\n");
+ desktopMode = (0 != (msg & kIOPMSetValue));
+ msg &= ~(kIOPMSetDesktopMode | kIOPMSetValue);
+
+ sendClientClamshellNotification();
+
+ // Re-evaluate the lid state
+ eval_clamshell = true;
+ }
+
+ /*
+ * AC Adaptor connected
+ *
+ * -> reevaluate lid state
+ */
+ if (msg & kIOPMSetACAdaptorConnected) {
+ acAdaptorConnected = (0 != (msg & kIOPMSetValue));
+ msg &= ~(kIOPMSetACAdaptorConnected | kIOPMSetValue);
+
+ // Tell CPU PM
+ informCPUStateChange(kInformAC, !acAdaptorConnected);
+
+ // Tell BSD if AC is connected
+ // 0 == external power source; 1 == on battery
+ post_sys_powersource(acAdaptorConnected ? 0:1);
+
+ sendClientClamshellNotification();
+
+ // Re-evaluate the lid state
+ eval_clamshell = true;
+
+ // Lack of AC may have latched a display wrangler tickle.
+ // This mirrors the hardware's USB wake event latch, where a latched
+ // USB wake event followed by an AC attach will trigger a full wake.
+ latchDisplayWranglerTickle( false );
+
+#if HIBERNATION
+ // AC presence will reset the standy timer delay adjustment.
+ _standbyTimerResetSeconds = 0;
+#endif
+ if (!userIsActive) {
+ // Reset userActivityTime when power supply is changed(rdr 13789330)
+ clock_get_uptime(&userActivityTime);
+ }
+ }
+
+ /*
+ * Enable Clamshell (external display disappear)
+ *
+ * -> reevaluate lid state
+ */
+ if (msg & kIOPMEnableClamshell) {
+ DLOG("Clamshell enabled\n");
+ // Re-evaluate the lid state
+ // System should sleep on external display disappearance
+ // in lid closed operation.
+ if (true == clamshellDisabled) {
+ eval_clamshell = true;
+ }
+
+ clamshellDisabled = false;
+ sendClientClamshellNotification();
+ }
+
+ /*
+ * Disable Clamshell (external display appeared)
+ * We don't bother re-evaluating clamshell state. If the system is awake,
+ * the lid is probably open.
+ */
+ if (msg & kIOPMDisableClamshell) {
+ DLOG("Clamshell disabled\n");
+ clamshellDisabled = true;
+ sendClientClamshellNotification();
+ }
+
+ /*
+ * Evaluate clamshell and SLEEP if appropiate
+ */
+ if (eval_clamshell_alarm && clamshellClosed) {
+ if (shouldSleepOnRTCAlarmWake()) {
+ privateSleepSystem(kIOPMSleepReasonClamshell);
+ }
+ } else if (eval_clamshell && clamshellClosed) {
+ if (shouldSleepOnClamshellClosed()) {
+ privateSleepSystem(kIOPMSleepReasonClamshell);
+ } else {
+ evaluatePolicy( kStimulusDarkWakeEvaluate );
+ }
+ }
+
+ if (msg & kIOPMProModeEngaged) {
+ int newState = 1;
+ DLOG("ProModeEngaged\n");
+ messageClient(kIOPMMessageProModeStateChange, systemCapabilityNotifier, &newState, sizeof(newState));
+ }
+
+ if (msg & kIOPMProModeDisengaged) {
+ int newState = 0;
+ DLOG("ProModeDisengaged\n");
+ messageClient(kIOPMMessageProModeStateChange, systemCapabilityNotifier, &newState, sizeof(newState));
+ }
+}
+
+//******************************************************************************
+// evaluatePolicy
+//
+// Evaluate root-domain policy in response to external changes.
+//******************************************************************************
+
+void
+IOPMrootDomain::evaluatePolicy( int stimulus, uint32_t arg )
+{
+ union {
+ struct {
+ int idleSleepEnabled : 1;
+ int idleSleepDisabled : 1;
+ int displaySleep : 1;
+ int sleepDelayChanged : 1;
+ int evaluateDarkWake : 1;
+ int adjustPowerState : 1;
+ int userBecameInactive : 1;
+ } bit;
+ uint32_t u32;
+ } flags;
+
+
+ ASSERT_GATED();
+ flags.u32 = 0;
+
+ switch (stimulus) {
+ case kStimulusDisplayWranglerSleep:
+ DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg);
+ if (!wranglerAsleep) {
+ // first transition to wrangler sleep or lower
+ flags.bit.displaySleep = true;
+ }
+ break;
+
+ case kStimulusDisplayWranglerWake:
+ DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg);
+ displayIdleForDemandSleep = false;
+ wranglerAsleep = false;
+ break;
+
+ case kStimulusEnterUserActiveState:
+ DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg);
+ if (_preventUserActive) {
+ DLOG("user active dropped\n");
+ break;
+ }
+ if (!userIsActive) {
+ userIsActive = true;
+ userWasActive = true;
+ clock_get_uptime(&gUserActiveAbsTime);
+
+ // Stay awake after dropping demand for display power on
+ if (kFullWakeReasonDisplayOn == fullWakeReason) {
+ fullWakeReason = fFullWakeReasonDisplayOnAndLocalUser;
+ DLOG("User activity while in notification wake\n");
+ changePowerStateWithOverrideTo( getRUN_STATE(), 0);
+ }
+
+ kdebugTrace(kPMLogUserActiveState, 0, 1, 0);
+ setProperty(gIOPMUserIsActiveKey, kOSBooleanTrue);
+ messageClients(kIOPMMessageUserIsActiveChanged);
+ }
+ flags.bit.idleSleepDisabled = true;
+ break;
+
+ case kStimulusLeaveUserActiveState:
+ DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg);
+ if (userIsActive) {
+ clock_get_uptime(&gUserInactiveAbsTime);
+ userIsActive = false;
+ clock_get_uptime(&userBecameInactiveTime);
+ flags.bit.userBecameInactive = true;
+
+ kdebugTrace(kPMLogUserActiveState, 0, 0, 0);
+ setProperty(gIOPMUserIsActiveKey, kOSBooleanFalse);
+ messageClients(kIOPMMessageUserIsActiveChanged);
+ }
+ break;
+
+ case kStimulusAggressivenessChanged:
+ {
+ DMSG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg);
+ unsigned long minutesToIdleSleep = 0;
+ unsigned long minutesToDisplayDim = 0;
+ unsigned long minutesDelta = 0;
+
+ // Fetch latest display and system sleep slider values.
+ getAggressiveness(kPMMinutesToSleep, &minutesToIdleSleep);
+ getAggressiveness(kPMMinutesToDim, &minutesToDisplayDim);
+ DLOG("aggressiveness changed: system %u->%u, display %u\n",
+ (uint32_t) sleepSlider,
+ (uint32_t) minutesToIdleSleep,
+ (uint32_t) minutesToDisplayDim);
+
+ DLOG("idle time -> %ld secs (ena %d)\n",
+ idleSeconds, (minutesToIdleSleep != 0));
+
+
+ // How long to wait before sleeping the system once
+ // the displays turns off is indicated by 'extraSleepDelay'.
+
+ if (minutesToIdleSleep > minutesToDisplayDim) {
+ minutesDelta = minutesToIdleSleep - minutesToDisplayDim;
+ } else if (minutesToIdleSleep == minutesToDisplayDim) {
+ minutesDelta = 1;
+ }
+
+ if ((!idleSleepEnabled) && (minutesToIdleSleep != 0)) {
+ idleSleepEnabled = flags.bit.idleSleepEnabled = true;
+ }
+
+ if ((idleSleepEnabled) && (minutesToIdleSleep == 0)) {
+ flags.bit.idleSleepDisabled = true;
+ idleSleepEnabled = false;
+ }
+ if (0x7fffffff == minutesToIdleSleep) {
+ minutesToIdleSleep = idleSeconds;
+ }
+
+ if (((minutesDelta != extraSleepDelay) ||
+ (userActivityTime != userActivityTime_prev)) &&
+ !flags.bit.idleSleepEnabled && !flags.bit.idleSleepDisabled) {
+ flags.bit.sleepDelayChanged = true;
+ }
+
+ if (systemDarkWake && !darkWakeToSleepASAP &&
+ (flags.bit.idleSleepEnabled || flags.bit.idleSleepDisabled)) {
+ // Reconsider decision to remain in dark wake
+ flags.bit.evaluateDarkWake = true;
+ }
+
+ sleepSlider = minutesToIdleSleep;
+ extraSleepDelay = minutesDelta;
+ userActivityTime_prev = userActivityTime;
+ } break;
+
+ case kStimulusDemandSystemSleep:
+ DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg);
+ displayIdleForDemandSleep = true;
+ if (wrangler && wranglerIdleSettings) {
+ // Request wrangler idle only when demand sleep is triggered
+ // from full wake.
+ if (CAP_CURRENT(kIOPMSystemCapabilityGraphics)) {
+ wrangler->setProperties(wranglerIdleSettings);
+ DLOG("Requested wrangler idle\n");
+ }
+ }
+ // arg = sleepReason
+ changePowerStateWithOverrideTo( SLEEP_STATE, arg );
+ break;
+
+ case kStimulusAllowSystemSleepChanged:
+ DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg);
+ flags.bit.adjustPowerState = true;
+ break;
+
+ case kStimulusDarkWakeActivityTickle:
+ DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg);
+ // arg == true implies real and not self generated wrangler tickle.
+ // Update wake type on PM work loop instead of the tickle thread to
+ // eliminate the possibility of an early tickle clobbering the wake
+ // type set by the platform driver.
+ if (arg == true) {
+ setProperty(kIOPMRootDomainWakeTypeKey, kIOPMRootDomainWakeTypeHIDActivity);
+ }
+
+ if (false == wranglerTickled) {
+ if (latchDisplayWranglerTickle(true)) {
+ DLOG("latched tickle\n");
+ break;
+ }
+
+ wranglerTickled = true;
+ DLOG("Requesting full wake after dark wake activity tickle\n");
+ requestFullWake( kFullWakeReasonLocalUser );
+ }
+ break;
+
+ case kStimulusDarkWakeEntry:
+ case kStimulusDarkWakeReentry:
+ DLOG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg);
+ // Any system transitions since the last dark wake transition
+ // will invalid the stimulus.
+
+ if (arg == _systemStateGeneration) {
+ DLOG("dark wake entry\n");
+ systemDarkWake = true;
+
+ // Keep wranglerAsleep an invariant when wrangler is absent
+ if (wrangler) {
+ wranglerAsleep = true;
+ }
+
+ if (kStimulusDarkWakeEntry == stimulus) {
+ clock_get_uptime(&userBecameInactiveTime);
+ flags.bit.evaluateDarkWake = true;
+ if (activitySinceSleep()) {
+ DLOG("User activity recorded while going to darkwake\n");
+ reportUserInput();
+ }
+ }
+
+ // Always accelerate disk spindown while in dark wake,
+ // even if system does not support/allow sleep.
+
+ cancelIdleSleepTimer();
+ setQuickSpinDownTimeout();
+ }
+ break;
+
+ case kStimulusDarkWakeEvaluate:
+ DMSG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg);
+ if (systemDarkWake) {
+ flags.bit.evaluateDarkWake = true;
+ }
+ break;
+
+ case kStimulusNoIdleSleepPreventers:
+ DMSG("evaluatePolicy( %d, 0x%x )\n", stimulus, arg);
+ flags.bit.adjustPowerState = true;
+ break;
+ } /* switch(stimulus) */
+
+ if (flags.bit.evaluateDarkWake && (kFullWakeReasonNone == fullWakeReason)) {
+ if (darkWakeToSleepASAP ||
+ (clamshellClosed && !(desktopMode && acAdaptorConnected))) {
+ uint32_t newSleepReason;
+
+ if (CAP_HIGHEST(kIOPMSystemCapabilityGraphics)) {
+ // System was previously in full wake. Sleep reason from
+ // full to dark already recorded in fullToDarkReason.
+
+ if (lowBatteryCondition) {
+ newSleepReason = kIOPMSleepReasonLowPower;
+ } else {
+ newSleepReason = fullToDarkReason;
+ }
+ } else {
+ // In dark wake from system sleep.
+
+ if (darkWakeSleepService) {
+ newSleepReason = kIOPMSleepReasonSleepServiceExit;
+ } else {
+ newSleepReason = kIOPMSleepReasonMaintenance;
+ }
+ }
+
+ if (checkSystemCanSleep(newSleepReason)) {
+ privateSleepSystem(newSleepReason);
+ }
+ } else { // non-maintenance (network) dark wake
+ if (checkSystemCanSleep(kIOPMSleepReasonIdle)) {
+ // Release power clamp, and wait for children idle.
+ adjustPowerState(true);
+ } else {
+ changePowerStateToPriv(getRUN_STATE());
+ }
+ }
+ }
+
+ if (systemDarkWake) {
+ // The rest are irrelevant while system is in dark wake.
+ flags.u32 = 0;
+ }
+
+ if ((flags.bit.displaySleep) &&
+ (kFullWakeReasonDisplayOn == fullWakeReason)) {
+ // kIOPMSleepReasonMaintenance?
+ DLOG("Display sleep while in notification wake\n");
+ changePowerStateWithOverrideTo( SLEEP_STATE, kIOPMSleepReasonMaintenance );
+ }
+
+ if (flags.bit.userBecameInactive || flags.bit.sleepDelayChanged) {
+ bool cancelQuickSpindown = false;
+
+ if (flags.bit.sleepDelayChanged) {
+ // Cancel existing idle sleep timer and quick disk spindown.
+ // New settings will be applied by the idleSleepEnabled flag
+ // handler below if idle sleep is enabled.
+
+ DLOG("extra sleep timer changed\n");
+ cancelIdleSleepTimer();
+ cancelQuickSpindown = true;
+ } else {
+ DLOG("user inactive\n");
+ }
+
+ if (!userIsActive && idleSleepEnabled) {
+ startIdleSleepTimer(getTimeToIdleSleep());
+ }
+
+ if (cancelQuickSpindown) {
+ restoreUserSpinDownTimeout();
+ }
+ }
+
+ if (flags.bit.idleSleepEnabled) {
+ DLOG("idle sleep timer enabled\n");
+ if (!wrangler) {
+ changePowerStateToPriv(getRUN_STATE());
+ startIdleSleepTimer( idleSeconds );
+ } else {
+ // Start idle timer if prefs now allow system sleep
+ // and user is already inactive. Disk spindown is
+ // accelerated upon timer expiration.
+
+ if (!userIsActive) {
+ startIdleSleepTimer(getTimeToIdleSleep());
+ }
+ }
+ }
+
+ if (flags.bit.idleSleepDisabled) {
+ DLOG("idle sleep timer disabled\n");
+ cancelIdleSleepTimer();
+ restoreUserSpinDownTimeout();
+ adjustPowerState();
+ }
+
+ if (flags.bit.adjustPowerState) {
+ bool sleepASAP = false;
+
+ if (!systemBooting && (0 == idleSleepPreventersCount())) {
+ if (!wrangler) {
+ changePowerStateToPriv(getRUN_STATE());
+ if (idleSleepEnabled) {
+ // stay awake for at least idleSeconds
+ startIdleSleepTimer(idleSeconds);
+ }
+ } else if (!extraSleepDelay && !idleSleepTimerPending && !systemDarkWake) {
+ sleepASAP = true;
+ }
+ }
+
+ adjustPowerState(sleepASAP);
+ }
+}
+
+//******************************************************************************
+
+unsigned int
+IOPMrootDomain::idleSleepPreventersCount()
+{
+#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146))
+ if (_aotMode) {
+ unsigned int count __block;
+ count = 0;
+ preventIdleSleepList->iterateObjects(^bool (OSObject * obj)
+ {
+ count += (NULL == obj->metaCast("AppleARMBacklight"));
+ return false;
+ });
+ return count;
+ }
+#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */
+
+ return preventIdleSleepList->getCount();
+}
+
+
+//******************************************************************************
+// requestFullWake
+//
+// Request transition from dark wake to full wake
+//******************************************************************************
+
+void
+IOPMrootDomain::requestFullWake( FullWakeReason reason )
+{
+ uint32_t options = 0;
+ IOService * pciRoot = NULL;
+ bool promotion = false;
+
+ // System must be in dark wake and a valid reason for entering full wake
+ if ((kFullWakeReasonNone == reason) ||
+ (kFullWakeReasonNone != fullWakeReason) ||
+ (CAP_CURRENT(kIOPMSystemCapabilityGraphics))) {
+ return;
+ }
+
+ // Will clear reason upon exit from full wake
+ fullWakeReason = reason;
+
+ _desiredCapability |= (kIOPMSystemCapabilityGraphics |
+ kIOPMSystemCapabilityAudio);
+
+ if ((kSystemTransitionWake == _systemTransitionType) &&
+ !(_pendingCapability & kIOPMSystemCapabilityGraphics) &&
+ !graphicsSuppressed) {
+ // Promote to full wake while waking up to dark wake due to tickle.
+ // PM will hold off notifying the graphics subsystem about system wake
+ // as late as possible, so if a HID tickle does arrive, graphics can
+ // power up on this same wake cycle. The latency to power up graphics
+ // on the next cycle can be huge on some systems. However, once any
+ // graphics suppression has taken effect, it is too late. All other
+ // graphics devices must be similarly suppressed. But the delay till
+ // the following cycle should be short.
+
+ _pendingCapability |= (kIOPMSystemCapabilityGraphics |
+ kIOPMSystemCapabilityAudio);
+
+ // Immediately bring up audio and graphics
+ pciRoot = pciHostBridgeDriver;
+ willEnterFullWake();
+ promotion = true;
+ }
+
+ // Unsafe to cancel once graphics was powered.
+ // If system woke from dark wake, the return to sleep can
+ // be cancelled. "awake -> dark -> sleep" transition
+ // can be canceled also, during the "dark --> sleep" phase
+ // *prior* to driver power down.
+ if (!CAP_HIGHEST(kIOPMSystemCapabilityGraphics) ||
+ _pendingCapability == 0) {
+ options |= kIOPMSyncCancelPowerDown;
+ }
+
+ synchronizePowerTree(options, pciRoot);
+ if (kFullWakeReasonLocalUser == fullWakeReason) {
+ // IOGraphics doesn't light the display even though graphics is
+ // enabled in kIOMessageSystemCapabilityChange message(radar 9502104)
+ // So, do an explicit activity tickle
+ if (wrangler) {
+ wrangler->activityTickle(0, 0);
+ }
+ }
+
+ // Log a timestamp for the initial full wake request.
+ // System may not always honor this full wake request.
+ if (!CAP_HIGHEST(kIOPMSystemCapabilityGraphics)) {
+ AbsoluteTime now;
+ uint64_t nsec;
+
+ clock_get_uptime(&now);
+ SUB_ABSOLUTETIME(&now, &gIOLastWakeAbsTime);
+ absolutetime_to_nanoseconds(now, &nsec);
+ MSG("full wake %s (reason %u) %u ms\n",
+ promotion ? "promotion" : "request",
+ fullWakeReason, ((int)((nsec) / NSEC_PER_MSEC)));
+ }
+}
+
+//******************************************************************************
+// willEnterFullWake
+//
+// System will enter full wake from sleep, from dark wake, or from dark
+// wake promotion. This function aggregate things that are in common to
+// all three full wake transitions.
+//
+// Assumptions: fullWakeReason was updated
+//******************************************************************************
+
+void
+IOPMrootDomain::willEnterFullWake( void )
+{
+ hibernateRetry = false;
+ sleepToStandby = false;
+ standbyNixed = false;
+ resetTimers = false;
+ sleepTimerMaintenance = false;
+
+ _systemMessageClientMask = kSystemMessageClientPowerd |
+ kSystemMessageClientLegacyApp;
+
+ if ((_highestCapability & kIOPMSystemCapabilityGraphics) == 0) {
+ // Initial graphics full power
+ _systemMessageClientMask |= kSystemMessageClientKernel;
+
+ // Set kIOPMUserTriggeredFullWakeKey before full wake for IOGraphics
+ setProperty(gIOPMUserTriggeredFullWakeKey,
+ (kFullWakeReasonLocalUser == fullWakeReason) ?
+ kOSBooleanTrue : kOSBooleanFalse);
+ }
+#if HIBERNATION
+ IOHibernateSetWakeCapabilities(_pendingCapability);
+#endif
+
+ IOService::setAdvisoryTickleEnable( true );
+ tellClients(kIOMessageSystemWillPowerOn);
+ preventTransitionToUserActive(false);
+}
+
+//******************************************************************************
+// fullWakeDelayedWork
+//
+// System has already entered full wake. Invoked by a delayed thread call.
+//******************************************************************************
+
+void
+IOPMrootDomain::fullWakeDelayedWork( void )
+{
+#if DARK_TO_FULL_EVALUATE_CLAMSHELL
+ // Not gated, don't modify state
+ if ((kSystemTransitionNone == _systemTransitionType) &&
+ CAP_CURRENT(kIOPMSystemCapabilityGraphics)) {
+ receivePowerNotification( kLocalEvalClamshellCommand );
+ }
+#endif
+}
+
+//******************************************************************************
+// evaluateAssertions
+//
+//******************************************************************************
+
+// Bitmask of all kernel assertions that prevent system idle sleep.
+// kIOPMDriverAssertionReservedBit7 is reserved for IOMediaBSDClient.
+#define NO_IDLE_SLEEP_ASSERTIONS_MASK \
+ (kIOPMDriverAssertionReservedBit7 | \
+ kIOPMDriverAssertionPreventSystemIdleSleepBit)
+
+void
+IOPMrootDomain::evaluateAssertions(IOPMDriverAssertionType newAssertions, IOPMDriverAssertionType oldAssertions)
+{
+ IOPMDriverAssertionType changedBits = newAssertions ^ oldAssertions;
+
+ messageClients(kIOPMMessageDriverAssertionsChanged);
+
+ if (changedBits & kIOPMDriverAssertionPreventDisplaySleepBit) {
+ if (wrangler) {
+ bool value = (newAssertions & kIOPMDriverAssertionPreventDisplaySleepBit) ? true : false;
+
+ DLOG("wrangler->setIgnoreIdleTimer\(%d)\n", value);
+ wrangler->setIgnoreIdleTimer( value );
+ }
+ }
+
+ if (changedBits & kIOPMDriverAssertionCPUBit) {
+#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146))
+ if (_aotNow) {
+ IOLog("CPU assertions %d\n", (0 != (kIOPMDriverAssertionCPUBit & newAssertions)));
+ }
+ evaluatePolicy(_aotNow ? kStimulusNoIdleSleepPreventers : kStimulusDarkWakeEvaluate);
+#else
+ evaluatePolicy(kStimulusDarkWakeEvaluate);
+#endif
+ if (!assertOnWakeSecs && gIOLastWakeAbsTime) {
+ AbsoluteTime now;
+ clock_usec_t microsecs;
+ clock_get_uptime(&now);
+ SUB_ABSOLUTETIME(&now, &gIOLastWakeAbsTime);
+ absolutetime_to_microtime(now, &assertOnWakeSecs, µsecs);
+ if (assertOnWakeReport) {
+ HISTREPORT_TALLYVALUE(assertOnWakeReport, (int64_t)assertOnWakeSecs);
+ DLOG("Updated assertOnWake %lu\n", (unsigned long)assertOnWakeSecs);
+ }
+ }
+ }
+
+ if (changedBits & NO_IDLE_SLEEP_ASSERTIONS_MASK) {
+ if ((newAssertions & NO_IDLE_SLEEP_ASSERTIONS_MASK) != 0) {
+ if ((oldAssertions & NO_IDLE_SLEEP_ASSERTIONS_MASK) == 0) {
+ DLOG("PreventIdleSleep driver assertion raised\n");
+ bool ok = updatePreventIdleSleepList(this, true);
+ if (ok && (changedBits & kIOPMDriverAssertionPreventSystemIdleSleepBit)) {
+ // Cancel idle sleep if there is one in progress
+ cancelIdlePowerDown(this);
+ }
+ }
+ } else {
+ DLOG("PreventIdleSleep driver assertion dropped\n");
+ updatePreventIdleSleepList(this, false);
+ }
+ }
+}
+
+// MARK: -
+// MARK: Statistics
+
+//******************************************************************************
+// pmStats
+//
+//******************************************************************************
+
+void
+IOPMrootDomain::pmStatsRecordEvent(
+ int eventIndex,
+ AbsoluteTime timestamp)
+{
+ bool starting = eventIndex & kIOPMStatsEventStartFlag ? true:false;
+ bool stopping = eventIndex & kIOPMStatsEventStopFlag ? true:false;
+ uint64_t delta;
+ uint64_t nsec;
+ OSData *publishPMStats = NULL;
+
+ eventIndex &= ~(kIOPMStatsEventStartFlag | kIOPMStatsEventStopFlag);
+
+ absolutetime_to_nanoseconds(timestamp, &nsec);
+
+ switch (eventIndex) {
+ case kIOPMStatsHibernateImageWrite:
+ if (starting) {
+ gPMStats.hibWrite.start = nsec;
+ } else if (stopping) {
+ gPMStats.hibWrite.stop = nsec;
+ }
+
+ if (stopping) {
+ delta = gPMStats.hibWrite.stop - gPMStats.hibWrite.start;
+ IOLog("PMStats: Hibernate write took %qd ms\n", delta / NSEC_PER_MSEC);
+ }
+ break;
+ case kIOPMStatsHibernateImageRead:
+ if (starting) {
+ gPMStats.hibRead.start = nsec;
+ } else if (stopping) {
+ gPMStats.hibRead.stop = nsec;
+ }
+
+ if (stopping) {
+ delta = gPMStats.hibRead.stop - gPMStats.hibRead.start;
+ IOLog("PMStats: Hibernate read took %qd ms\n", delta / NSEC_PER_MSEC);
+
+ publishPMStats = OSData::withBytes(&gPMStats, sizeof(gPMStats));
+ setProperty(kIOPMSleepStatisticsKey, publishPMStats);
+ publishPMStats->release();
+ bzero(&gPMStats, sizeof(gPMStats));
+ }
+ break;
+ }
+}
+
+/*
+ * Appends a record of the application response to
+ * IOPMrootDomain::pmStatsAppResponses
+ */
+void
+IOPMrootDomain::pmStatsRecordApplicationResponse(
+ const OSSymbol *response,
+ const char *name,
+ int messageType,
+ uint32_t delay_ms,
+ uint64_t id,
+ OSObject *object,
+ IOPMPowerStateIndex powerState)
+{
+ OSDictionary *responseDescription = NULL;
+ OSNumber *delayNum = NULL;
+ OSNumber *powerCaps = NULL;
+ OSNumber *pidNum = NULL;
+ OSNumber *msgNum = NULL;
+ const OSSymbol *appname;
+ const OSSymbol *sleep = NULL, *wake = NULL;
+ IOPMServiceInterestNotifier *notify = NULL;
+
+ if (object && (notify = OSDynamicCast(IOPMServiceInterestNotifier, object))) {
+ if (response->isEqualTo(gIOPMStatsResponseTimedOut)) {
+ notify->ackTimeoutCnt++;
+ } else {
+ notify->ackTimeoutCnt = 0;
+ }
+ }
+
+ if (response->isEqualTo(gIOPMStatsResponsePrompt) ||
+ (_systemTransitionType == kSystemTransitionNone) || (_systemTransitionType == kSystemTransitionNewCapClient)) {
+ return;
+ }
+
+
+ if (response->isEqualTo(gIOPMStatsDriverPSChangeSlow)) {
+ kdebugTrace(kPMLogDrvPSChangeDelay, id, messageType, delay_ms);
+ } else if (notify) {
+ // User space app or kernel capability client
+ if (id) {
+ kdebugTrace(kPMLogAppResponseDelay, id, notify->msgType, delay_ms);
+ } else {
+ kdebugTrace(kPMLogDrvResponseDelay, notify->uuid0, messageType, delay_ms);
+ }
+ notify->msgType = 0;
+ }
+
+ responseDescription = OSDictionary::withCapacity(5);
+ if (responseDescription) {
+ if (response) {
+ responseDescription->setObject(_statsResponseTypeKey, response);
+ }
+
+ msgNum = OSNumber::withNumber(messageType, 32);
+ if (msgNum) {
+ responseDescription->setObject(_statsMessageTypeKey, msgNum);
+ msgNum->release();
+ }
+
+ if (!name && notify && notify->identifier) {
+ name = notify->identifier->getCStringNoCopy();
+ }
+
+ if (name && (strlen(name) > 0)) {
+ appname = OSSymbol::withCString(name);
+ if (appname) {
+ responseDescription->setObject(_statsNameKey, appname);
+ appname->release();
+ }
+ }
+
+ if (!id && notify) {
+ id = notify->uuid0;
+ }
+ if (id != 0) {
+ pidNum = OSNumber::withNumber(id, 64);
+ if (pidNum) {
+ responseDescription->setObject(_statsPIDKey, pidNum);
+ pidNum->release();
+ }
+ }
+
+ delayNum = OSNumber::withNumber(delay_ms, 32);
+ if (delayNum) {
+ responseDescription->setObject(_statsTimeMSKey, delayNum);
+ delayNum->release();
+ }
+
+ if (response->isEqualTo(gIOPMStatsDriverPSChangeSlow)) {
+ powerCaps = OSNumber::withNumber(powerState, 32);
+
+#if !defined(__i386__) && !defined(__x86_64__) && (DEVELOPMENT || DEBUG)
+ IOLog("%s::powerStateChange type(%d) to(%lu) async took %d ms\n",
+ name, messageType,
+ powerState, delay_ms);
+#endif
+ } else {
+ powerCaps = OSNumber::withNumber(_pendingCapability, 32);
+ }
+ if (powerCaps) {
+ responseDescription->setObject(_statsPowerCapsKey, powerCaps);
+ powerCaps->release();
+ }
+
+ sleep = OSSymbol::withCString("Sleep");
+ wake = OSSymbol::withCString("Wake");
+ if (_systemTransitionType == kSystemTransitionSleep) {
+ responseDescription->setObject(kIOPMStatsSystemTransitionKey, sleep);
+ } else if (_systemTransitionType == kSystemTransitionWake) {
+ responseDescription->setObject(kIOPMStatsSystemTransitionKey, wake);
+ } else if (_systemTransitionType == kSystemTransitionCapability) {
+ if (CAP_LOSS(kIOPMSystemCapabilityGraphics)) {
+ responseDescription->setObject(kIOPMStatsSystemTransitionKey, sleep);
+ } else if (CAP_GAIN(kIOPMSystemCapabilityGraphics)) {
+ responseDescription->setObject(kIOPMStatsSystemTransitionKey, wake);
+ }
+ }
+ if (sleep) {
+ sleep->release();
+ }
+ if (wake) {
+ wake->release();
+ }
+
+
+
+ IOLockLock(pmStatsLock);
+ if (pmStatsAppResponses && pmStatsAppResponses->getCount() < 50) {
+ pmStatsAppResponses->setObject(responseDescription);
+ }
+ IOLockUnlock(pmStatsLock);
+
+ responseDescription->release();
+ }
+
+ return;
+}
+
+// MARK: -
+// MARK: PMTraceWorker
+
+//******************************************************************************
+// TracePoint support
+//
+//******************************************************************************
+
+#define kIOPMRegisterNVRAMTracePointHandlerKey \
+ "IOPMRegisterNVRAMTracePointHandler"
+
+IOReturn
+IOPMrootDomain::callPlatformFunction(
+ const OSSymbol * functionName,
+ bool waitForFunction,
+ void * param1, void * param2,
+ void * param3, void * param4 )
+{
+ uint32_t bootFailureCode = 0xffffffff;
+ if (pmTracer && functionName &&
+ functionName->isEqualTo(kIOPMRegisterNVRAMTracePointHandlerKey) &&
+ !pmTracer->tracePointHandler && !pmTracer->tracePointTarget) {
+ uint32_t tracePointPhases, tracePointPCI;
+ uint64_t statusCode;
+
+ pmTracer->tracePointHandler = (IOPMTracePointHandler) param1;
+ pmTracer->tracePointTarget = (void *) param2;
+ tracePointPCI = (uint32_t)(uintptr_t) param3;
+ tracePointPhases = (uint32_t)(uintptr_t) param4;
+ if ((tracePointPhases & 0xff) == kIOPMTracePointSystemSleep) {
+ IORegistryEntry *node = IORegistryEntry::fromPath( "/chosen", gIODTPlane );
+ if (node) {
+ OSData *data = OSDynamicCast( OSData, node->getProperty(kIOEFIBootRomFailureKey));
+ if (data && data->getLength() == sizeof(bootFailureCode)) {
+ memcpy(&bootFailureCode, data->getBytesNoCopy(), sizeof(bootFailureCode));
+ }
+ node->release();
+ }
+ // Failure code from EFI/BootRom is a four byte structure
+ tracePointPCI = OSSwapBigToHostInt32(bootFailureCode);
+ }
+ statusCode = (((uint64_t)tracePointPCI) << 32) | tracePointPhases;
+ if ((tracePointPhases & 0xff) != kIOPMTracePointSystemUp) {
+ MSG("Sleep failure code 0x%08x 0x%08x\n",
+ tracePointPCI, tracePointPhases);
+ }
+ setProperty(kIOPMSleepWakeFailureCodeKey, statusCode, 64);
+ pmTracer->tracePointHandler( pmTracer->tracePointTarget, 0, 0 );
+
+ return kIOReturnSuccess;
+ }
+#if HIBERNATION
+ else if (functionName &&
+ functionName->isEqualTo(kIOPMInstallSystemSleepPolicyHandlerKey)) {
+ if (gSleepPolicyHandler) {
+ return kIOReturnExclusiveAccess;
+ }
+ if (!param1) {
+ return kIOReturnBadArgument;
+ }
+ gSleepPolicyHandler = (IOPMSystemSleepPolicyHandler) param1;
+ gSleepPolicyTarget = (void *) param2;
+ setProperty("IOPMSystemSleepPolicyHandler", kOSBooleanTrue);
+ return kIOReturnSuccess;
+ }
+#endif
+
+ return super::callPlatformFunction(
+ functionName, waitForFunction, param1, param2, param3, param4);
+}
+
+void
+IOPMrootDomain::kdebugTrace(uint32_t event, uint64_t id,
+ uintptr_t param1, uintptr_t param2, uintptr_t param3)
+{
+ uint32_t code = IODBG_POWER(event);
+ uint64_t regId = id;
+ if (regId == 0) {
+ regId = getRegistryEntryID();
+ }
+ IOTimeStampConstant(code, (uintptr_t) regId, param1, param2, param3);
+}
+
+
+void
+IOPMrootDomain::tracePoint( uint8_t point )
+{
+ if (systemBooting) {
+ return;
+ }
+
+ if (kIOPMTracePointWakeCapabilityClients == point) {
+ acceptSystemWakeEvents(false);
+ }
+
+ kdebugTrace(kPMLogSleepWakeTracePoint, 0, point, 0);
+ pmTracer->tracePoint(point);
+}
+
+void
+IOPMrootDomain::traceDetail(OSObject *object, bool start)
+{
+ IOPMServiceInterestNotifier *notifier;
+
+ if (systemBooting) {
+ return;
+ }
+
+ notifier = OSDynamicCast(IOPMServiceInterestNotifier, object);
+ if (!notifier) {
+ return;
+ }
+
+ if (start) {
+ pmTracer->traceDetail( notifier->uuid0 >> 32 );
+ kdebugTrace(kPMLogSleepWakeMessage, pmTracer->getTracePhase(), notifier->msgType, notifier->uuid0, notifier->uuid1);
+ if (notifier->identifier) {
+ DLOG("trace point 0x%02x msg 0x%x to %s\n", pmTracer->getTracePhase(), notifier->msgType,
+ notifier->identifier->getCStringNoCopy());
+ } else {
+ DLOG("trace point 0x%02x msg 0x%x\n", pmTracer->getTracePhase(), notifier->msgType);
+ }
+ notifierThread = current_thread();
+ notifierObject = notifier;
+ notifier->retain();
+ } else {
+ notifierThread = NULL;
+ notifierObject = NULL;
+ notifier->release();
+ }
+}
+
+
+void
+IOPMrootDomain::traceAckDelay(OSObject *object, uint32_t response, uint32_t delay_ms)
+{
+ IOPMServiceInterestNotifier *notifier = OSDynamicCast(IOPMServiceInterestNotifier, object);
+ if (!notifier) {
+ DLOG("Unknown notifier\n");
+ return;
+ }
+
+ if (!systemBooting) {
+ kdebugTrace(kPMLogDrvResponseDelay, notifier->uuid0, notifier->uuid1, response, delay_ms);
+ if (notifier->identifier) {
+ DLOG("Response from %s took %d ms(response:%d)\n",
+ notifier->identifier->getCStringNoCopy(), delay_ms, response);
+ } else {
+ DLOG("Response from kext UUID %llx-%llx took %d ms(response:%d)\n",
+ notifier->uuid0, notifier->uuid1, delay_ms, response);
+ }
+ }
+}
+
+void
+IOPMrootDomain::traceDetail(uint32_t msgType, uint32_t msgIndex, uint32_t delay)
+{
+ if (!systemBooting) {
+ uint32_t detail = ((msgType & 0xffff) << 16) | (delay & 0xffff);
+ pmTracer->traceDetail( detail );
+ kdebugTrace(kPMLogSleepWakeTracePoint, pmTracer->getTracePhase(), msgType, delay);
+ DLOG("trace point 0x%02x msgType 0x%x detail 0x%08x\n", pmTracer->getTracePhase(), msgType, delay);
+ }
+}
+
+
+void
+IOPMrootDomain::configureReportGated(uint64_t channel_id, uint64_t action, void *result)
+{
+ size_t reportSize;
+ void **report = NULL;
+ uint32_t bktCnt;
+ uint32_t bktSize;
+ uint32_t *clientCnt;
+
+ ASSERT_GATED();
+
+ report = NULL;
+ if (channel_id == kAssertDelayChID) {
+ report = &assertOnWakeReport;
+ bktCnt = kAssertDelayBcktCnt;
+ bktSize = kAssertDelayBcktSize;
+ clientCnt = &assertOnWakeClientCnt;
+ } else if (channel_id == kSleepDelaysChID) {
+ report = &sleepDelaysReport;
+ bktCnt = kSleepDelaysBcktCnt;
+ bktSize = kSleepDelaysBcktSize;
+ clientCnt = &sleepDelaysClientCnt;
+ }
+
+ switch (action) {
+ case kIOReportEnable:
+
+ if (*report) {
+ (*clientCnt)++;
+ break;
+ }
+
+ reportSize = HISTREPORT_BUFSIZE(bktCnt);
+ *report = IOMalloc(reportSize);
+ if (*report == NULL) {
+ break;
+ }
+ bzero(*report, reportSize);
+ HISTREPORT_INIT(bktCnt, bktSize, *report, reportSize,
+ getRegistryEntryID(), channel_id, kIOReportCategoryPower);
+
+ if (channel_id == kAssertDelayChID) {
+ assertOnWakeSecs = 0;
+ }
+
+ break;
+
+ case kIOReportDisable:
+ if (*clientCnt == 0) {
+ break;
+ }
+ if (*clientCnt == 1) {
+ IOFree(*report, HISTREPORT_BUFSIZE(bktCnt));
+ *report = NULL;
+ }
+ (*clientCnt)--;
+
+ if (channel_id == kAssertDelayChID) {
+ assertOnWakeSecs = -1; // Invalid value to prevent updates
+ }
+ break;
+
+ case kIOReportGetDimensions:
+ if (*report) {
+ HISTREPORT_UPDATERES(*report, kIOReportGetDimensions, result);
+ }
+ break;
+ }
+
+ return;
+}
+
+IOReturn
+IOPMrootDomain::configureReport(IOReportChannelList *channelList,
+ IOReportConfigureAction action,
+ void *result,
+ void *destination)
+{
+ unsigned cnt;
+ uint64_t configAction = (uint64_t)action;
+
+ for (cnt = 0; cnt < channelList->nchannels; cnt++) {
+ if ((channelList->channels[cnt].channel_id == kSleepCntChID) ||
+ (channelList->channels[cnt].channel_id == kDarkWkCntChID) ||
+ (channelList->channels[cnt].channel_id == kUserWkCntChID)) {
+ if (action != kIOReportGetDimensions) {
+ continue;
+ }
+ SIMPLEREPORT_UPDATERES(kIOReportGetDimensions, result);
+ } else if ((channelList->channels[cnt].channel_id == kAssertDelayChID) ||
+ (channelList->channels[cnt].channel_id == kSleepDelaysChID)) {
+ gIOPMWorkLoop->runAction(
+ OSMemberFunctionCast(IOWorkLoop::Action, this, &IOPMrootDomain::configureReportGated),
+ (OSObject *)this, (void *)channelList->channels[cnt].channel_id,
+ (void *)configAction, (void *)result);
+ }
+ }
+
+ return super::configureReport(channelList, action, result, destination);
+}
+
+IOReturn
+IOPMrootDomain::updateReportGated(uint64_t ch_id, void *result, IOBufferMemoryDescriptor *dest)
+{
+ uint32_t size2cpy;
+ void *data2cpy;
+ void **report;
+
+ ASSERT_GATED();
+
+ report = NULL;
+ if (ch_id == kAssertDelayChID) {
+ report = &assertOnWakeReport;
+ } else if (ch_id == kSleepDelaysChID) {
+ report = &sleepDelaysReport;
+ }
+
+ if (*report == NULL) {
+ return kIOReturnNotOpen;
+ }
+
+ HISTREPORT_UPDATEPREP(*report, data2cpy, size2cpy);
+ if (size2cpy > (dest->getCapacity() - dest->getLength())) {
+ return kIOReturnOverrun;
+ }
+
+ HISTREPORT_UPDATERES(*report, kIOReportCopyChannelData, result);
+ dest->appendBytes(data2cpy, size2cpy);
+
+ return kIOReturnSuccess;
+}
+
+IOReturn
+IOPMrootDomain::updateReport(IOReportChannelList *channelList,
+ IOReportUpdateAction action,
+ void *result,
+ void *destination)
+{
+ uint32_t size2cpy;
+ void *data2cpy;
+ uint8_t buf[SIMPLEREPORT_BUFSIZE];
+ IOBufferMemoryDescriptor *dest = OSDynamicCast(IOBufferMemoryDescriptor, (OSObject *)destination);
+ unsigned cnt;
+ uint64_t ch_id;
+
+ if (action != kIOReportCopyChannelData) {
+ goto exit;
+ }
+
+ for (cnt = 0; cnt < channelList->nchannels; cnt++) {
+ ch_id = channelList->channels[cnt].channel_id;
+
+ if ((ch_id == kAssertDelayChID) || (ch_id == kSleepDelaysChID)) {
+ gIOPMWorkLoop->runAction(
+ OSMemberFunctionCast(IOWorkLoop::Action, this, &IOPMrootDomain::updateReportGated),
+ (OSObject *)this, (void *)ch_id,
+ (void *)result, (void *)dest);
+ continue;
+ } else if ((ch_id == kSleepCntChID) ||
+ (ch_id == kDarkWkCntChID) || (ch_id == kUserWkCntChID)) {
+ SIMPLEREPORT_INIT(buf, sizeof(buf), getRegistryEntryID(), ch_id, kIOReportCategoryPower);
+ } else {
+ continue;
+ }
+
+ if (ch_id == kSleepCntChID) {
+ SIMPLEREPORT_SETVALUE(buf, sleepCnt);
+ } else if (ch_id == kDarkWkCntChID) {
+ SIMPLEREPORT_SETVALUE(buf, darkWakeCnt);
+ } else if (ch_id == kUserWkCntChID) {
+ SIMPLEREPORT_SETVALUE(buf, displayWakeCnt);
+ }
+
+ SIMPLEREPORT_UPDATEPREP(buf, data2cpy, size2cpy);
+ SIMPLEREPORT_UPDATERES(kIOReportCopyChannelData, result);
+ dest->appendBytes(data2cpy, size2cpy);
+ }
+
+exit:
+ return super::updateReport(channelList, action, result, destination);
+}
+
+
+//******************************************************************************
+// PMTraceWorker Class
+//
+//******************************************************************************
+
+#undef super
+#define super OSObject
+OSDefineMetaClassAndStructors(PMTraceWorker, OSObject)
+
+#define kPMBestGuessPCIDevicesCount 25
+#define kPMMaxRTCBitfieldSize 32
+
+PMTraceWorker * PMTraceWorker::tracer(IOPMrootDomain * owner)
+{
+ PMTraceWorker *me;
+
+ me = OSTypeAlloc( PMTraceWorker );
+ if (!me || !me->init()) {
+ return NULL;
+ }
+
+ DLOG("PMTraceWorker %p\n", OBFUSCATE(me));
+
+ // Note that we cannot instantiate the PCI device -> bit mappings here, since
+ // the IODeviceTree has not yet been created by IOPlatformExpert. We create
+ // this dictionary lazily.
+ me->owner = owner;
+ me->pciDeviceBitMappings = NULL;
+ me->pmTraceWorkerLock = IOLockAlloc();
+ me->tracePhase = kIOPMTracePointSystemUp;
+ me->traceData32 = 0;
+ me->loginWindowData = 0;
+ me->coreDisplayData = 0;
+ me->coreGraphicsData = 0;
+ return me;
+}
+
+void
+PMTraceWorker::RTC_TRACE(void)
+{
+ if (tracePointHandler && tracePointTarget) {
+ uint32_t wordA;
+
+ IOLockLock(pmTraceWorkerLock);
+ wordA = (loginWindowData << 24) | (coreDisplayData << 16) |
+ (coreGraphicsData << 8) | tracePhase;
+ IOLockUnlock(pmTraceWorkerLock);
+
+ tracePointHandler( tracePointTarget, traceData32, wordA );
+ _LOG("RTC_TRACE wrote 0x%08x 0x%08x\n", traceData32, wordA);
+ }
+#if DEVELOPMENT || DEBUG
+ if ((swd_panic_phase != 0) && (swd_panic_phase == tracePhase)) {
+ DEBUG_LOG("Causing sleep wake failure in phase 0x%08x\n", tracePhase);
+ IOLock *l = IOLockAlloc();
+ IOLockLock(l);
+ IOLockLock(l);
+ }
+#endif
+}
+
+int
+PMTraceWorker::recordTopLevelPCIDevice(IOService * pciDevice)
+{
+ const OSSymbol * deviceName;
+ int index = -1;
+
+ IOLockLock(pmTraceWorkerLock);
+
+ if (!pciDeviceBitMappings) {
+ pciDeviceBitMappings = OSArray::withCapacity(kPMBestGuessPCIDevicesCount);
+ if (!pciDeviceBitMappings) {
+ goto exit;
+ }
+ }
+
+ // Check for bitmask overflow.
+ if (pciDeviceBitMappings->getCount() >= kPMMaxRTCBitfieldSize) {
+ goto exit;
+ }
+
+ if ((deviceName = pciDevice->copyName()) &&
+ (pciDeviceBitMappings->getNextIndexOfObject(deviceName, 0) == (unsigned int)-1) &&
+ pciDeviceBitMappings->setObject(deviceName)) {
+ index = pciDeviceBitMappings->getCount() - 1;
+ _LOG("PMTrace PCI array: set object %s => %d\n",
+ deviceName->getCStringNoCopy(), index);
+ }
+ if (deviceName) {
+ deviceName->release();
+ }
+ if (!addedToRegistry && (index >= 0)) {
+ addedToRegistry = owner->setProperty("PCITopLevel", this);
+ }
+
+exit:
+ IOLockUnlock(pmTraceWorkerLock);
+ return index;
+}
+
+bool
+PMTraceWorker::serialize(OSSerialize *s) const
+{
+ bool ok = false;
+ if (pciDeviceBitMappings) {
+ IOLockLock(pmTraceWorkerLock);
+ ok = pciDeviceBitMappings->serialize(s);
+ IOLockUnlock(pmTraceWorkerLock);
+ }
+ return ok;
+}
+
+void
+PMTraceWorker::tracePoint(uint8_t phase)
+{
+ // clear trace detail when phase begins
+ if (tracePhase != phase) {
+ traceData32 = 0;
+ }
+
+ tracePhase = phase;
+
+ DLOG("trace point 0x%02x\n", tracePhase);
+ RTC_TRACE();
+}
+
+void
+PMTraceWorker::traceDetail(uint32_t detail)
+{
+ if (detail == traceData32) {
+ return;
+ }
+ traceData32 = detail;
+ RTC_TRACE();
+}
+
+void
+PMTraceWorker::traceComponentWakeProgress(uint32_t component, uint32_t data)
+{
+ switch (component) {
+ case kIOPMLoginWindowProgress:
+ loginWindowData = data & kIOPMLoginWindowProgressMask;
+ break;
+ case kIOPMCoreDisplayProgress:
+ coreDisplayData = data & kIOPMCoreDisplayProgressMask;
+ break;
+ case kIOPMCoreGraphicsProgress:
+ coreGraphicsData = data & kIOPMCoreGraphicsProgressMask;
+ break;
+ default:
+ return;
+ }
+
+ DLOG("component trace point 0x%02x data 0x%08x\n", component, data);
+ RTC_TRACE();
+}
+
+void
+PMTraceWorker::tracePCIPowerChange(
+ change_t type, IOService *service, uint32_t changeFlags, uint32_t bitNum)
+{
+ uint32_t bitMask;
+ uint32_t expectedFlag;
+
+ // Ignore PCI changes outside of system sleep/wake.
+ if ((kIOPMTracePointSleepPowerPlaneDrivers != tracePhase) &&
+ (kIOPMTracePointWakePowerPlaneDrivers != tracePhase)) {
+ return;
+ }
+
+ // Only record the WillChange transition when going to sleep,
+ // and the DidChange on the way up.
+ changeFlags &= (kIOPMDomainWillChange | kIOPMDomainDidChange);
+ expectedFlag = (kIOPMTracePointSleepPowerPlaneDrivers == tracePhase) ?
+ kIOPMDomainWillChange : kIOPMDomainDidChange;
+ if (changeFlags != expectedFlag) {
+ return;
+ }
+
+ // Mark this device off in our bitfield
+ if (bitNum < kPMMaxRTCBitfieldSize) {
+ bitMask = (1 << bitNum);
+
+ if (kPowerChangeStart == type) {
+ traceData32 |= bitMask;
+ _LOG("PMTrace: Device %s started - bit %2d mask 0x%08x => 0x%08x\n",
+ service->getName(), bitNum, bitMask, traceData32);
+ owner->kdebugTrace(kPMLogPCIDevChangeStart, service->getRegistryEntryID(), traceData32, 0);
+ } else {
+ traceData32 &= ~bitMask;
+ _LOG("PMTrace: Device %s finished - bit %2d mask 0x%08x => 0x%08x\n",
+ service->getName(), bitNum, bitMask, traceData32);
+ owner->kdebugTrace(kPMLogPCIDevChangeDone, service->getRegistryEntryID(), traceData32, 0);
+ }
+
+ DLOG("trace point 0x%02x detail 0x%08x\n", tracePhase, traceData32);
+ RTC_TRACE();
+ }
+}
+
+uint64_t
+PMTraceWorker::getPMStatusCode()
+{
+ return ((uint64_t)traceData32 << 32) | ((uint64_t)tracePhase);
+}
+
+uint8_t
+PMTraceWorker::getTracePhase()
+{
+ return tracePhase;
+}
+
+uint32_t
+PMTraceWorker::getTraceData()
+{
+ return traceData32;
+}
+
+// MARK: -
+// MARK: PMHaltWorker
+
+//******************************************************************************
+// PMHaltWorker Class
+//
+//******************************************************************************
+
+PMHaltWorker *
+PMHaltWorker::worker( void )
+{
+ PMHaltWorker * me;
+ IOThread thread;
+
+ do {
+ me = OSTypeAlloc( PMHaltWorker );
+ if (!me || !me->init()) {
+ break;
+ }
+
+ me->lock = IOLockAlloc();
+ if (!me->lock) {
+ break;
+ }
+
+ DLOG("PMHaltWorker %p\n", OBFUSCATE(me));
+ me->retain(); // thread holds extra retain
+ if (KERN_SUCCESS != kernel_thread_start(&PMHaltWorker::main, (void *) me, &thread)) {
+ me->release();
+ break;
+ }
+ thread_deallocate(thread);
+ return me;
projects / apple / xnu.git / blobdiff