X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/6d2010ae8f7a6078e10b361c6962983bab233e0f..c6bf4f310a33a9262d455ea4d3f0630b1255e3fe:/iokit/Kernel/IOServicePM.cpp diff --git a/iokit/Kernel/IOServicePM.cpp b/iokit/Kernel/IOServicePM.cpp index bd7bcd002..5cdc56a78 100644 --- a/iokit/Kernel/IOServicePM.cpp +++ b/iokit/Kernel/IOServicePM.cpp @@ -1,8 +1,8 @@ /* - * Copyright (c) 1998-2006 Apple Computer, Inc. All rights reserved. + * Copyright (c) 1998-2016 Apple Inc. All rights reserved. * * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ - * + * * This file contains Original Code and/or Modifications of Original Code * as defined in and that are subject to the Apple Public Source License * Version 2.0 (the 'License'). You may not use this file except in @@ -11,10 +11,10 @@ * unlawful or unlicensed copies of an Apple operating system, or to * circumvent, violate, or enable the circumvention or violation of, any * terms of an Apple operating system software license agreement. - * + * * Please obtain a copy of the License at * http://www.opensource.apple.com/apsl/ and read it before using this file. - * + * * The Original Code and all software distributed under the License are * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, @@ -22,13 +22,10 @@ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. * Please see the License for the specific language governing rights and * limitations under the License. - * + * * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ -//#undef IOASSERT -//#define IOASSERT 1 - #include #include #include @@ -38,6 +35,9 @@ #include #include #include +#include +#include +#include #include #include @@ -47,79 +47,105 @@ #include #include +#include +#include #include +#include // Required for notification instrumentation #include "IOServicePrivate.h" #include "IOServicePMPrivate.h" #include "IOKitKernelInternal.h" + static void settle_timer_expired(thread_call_param_t, thread_call_param_t); static void idle_timer_expired(thread_call_param_t, thread_call_param_t); static void tellKernelClientApplier(OSObject * object, void * arg); static void tellAppClientApplier(OSObject * object, void * arg); -static uint64_t computeTimeDeltaNS( const AbsoluteTime * start ) +static uint64_t +computeTimeDeltaNS( const AbsoluteTime * start ) { - AbsoluteTime now; - uint64_t nsec; + AbsoluteTime now; + uint64_t nsec; - clock_get_uptime(&now); - SUB_ABSOLUTETIME(&now, start); - absolutetime_to_nanoseconds(now, &nsec); - return nsec; + clock_get_uptime(&now); + SUB_ABSOLUTETIME(&now, start); + absolutetime_to_nanoseconds(now, &nsec); + return nsec; } #if PM_VARS_SUPPORT OSDefineMetaClassAndStructors(IOPMprot, OSObject) #endif -// Container class for recording system power events -OSDefineMetaClassAndStructors( PMEventDetails, OSObject ); - //****************************************************************************** // Globals //****************************************************************************** -static bool gIOPMInitialized = false; -static uint32_t gIOPMBusyCount = 0; -static uint32_t gIOPMWorkCount = 0; -static IOWorkLoop * gIOPMWorkLoop = 0; -static IOPMRequestQueue * gIOPMRequestQueue = 0; -static IOPMRequestQueue * gIOPMReplyQueue = 0; -static IOPMWorkQueue * gIOPMWorkQueue = 0; -static IOPMCompletionQueue * gIOPMFreeQueue = 0; -static IOPMRequest * gIOPMRequest = 0; -static IOPlatformExpert * gPlatform = 0; -static IOService * gIOPMRootNode = 0; - -static const OSSymbol * gIOPMPowerClientDevice = 0; -static const OSSymbol * gIOPMPowerClientDriver = 0; -static const OSSymbol * gIOPMPowerClientChildProxy = 0; -static const OSSymbol * gIOPMPowerClientChildren = 0; +static bool gIOPMInitialized = false; +static uint32_t gIOPMBusyRequestCount = 0; +static uint32_t gIOPMWorkInvokeCount = 0; +static uint32_t gIOPMTickleGeneration = 0; +static IOWorkLoop * gIOPMWorkLoop = NULL; +static IOPMRequestQueue * gIOPMRequestQueue = NULL; +static IOPMRequestQueue * gIOPMReplyQueue = NULL; +static IOPMWorkQueue * gIOPMWorkQueue = NULL; +static IOPMCompletionQueue * gIOPMCompletionQueue = NULL; +static IOPMRequest * gIOPMRequest = NULL; +static IOService * gIOPMRootNode = NULL; +static IOPlatformExpert * gPlatform = NULL; + + +const OSSymbol * gIOPMPowerClientDevice = NULL; +const OSSymbol * gIOPMPowerClientDriver = NULL; +const OSSymbol * gIOPMPowerClientChildProxy = NULL; +const OSSymbol * gIOPMPowerClientChildren = NULL; +const OSSymbol * gIOPMPowerClientRootDomain = NULL; + +static const OSSymbol * gIOPMPowerClientAdvisoryTickle = NULL; +static bool gIOPMAdvisoryTickleEnabled = true; +static thread_t gIOPMWatchDogThread = NULL; +uint32_t gCanSleepTimeout = 0; + +static uint32_t +getPMRequestType( void ) +{ + uint32_t type = kIOPMRequestTypeInvalid; + if (gIOPMRequest) { + type = gIOPMRequest->getType(); + } + return type; +} -static uint32_t getPMRequestType( void ) +static IOPMRequestTag +getPMRequestTag( void ) { - uint32_t type = kIOPMRequestTypeInvalid; - if (gIOPMRequest) - type = gIOPMRequest->getType(); - return type; + IOPMRequestTag tag = 0; + if (gIOPMRequest && + (gIOPMRequest->getType() == kIOPMRequestTypeRequestPowerStateOverride)) { + tag = gIOPMRequest->fRequestTag; + } + return tag; } +SYSCTL_UINT(_kern, OID_AUTO, pmtimeout, CTLFLAG_RW | CTLFLAG_LOCKED, &gCanSleepTimeout, 0, "Power Management Timeout"); + //****************************************************************************** // Macros //****************************************************************************** -#define PM_ERROR(x...) do { kprintf(x); IOLog(x); } while (false) +#define PM_ERROR(x...) do { kprintf(x);IOLog(x); \ + } while (false) #define PM_LOG(x...) do { kprintf(x); } while (false) #define PM_LOG1(x...) do { \ - if (kIOLogDebugPower & gIOKitDebug) \ - kprintf(x); } while (false) + if (kIOLogDebugPower & gIOKitDebug) \ + kprintf(x); } while (false) #define PM_LOG2(x...) do { \ - if (kIOLogDebugPower & gIOKitDebug) \ - kprintf(x); } while (false) + if (kIOLogDebugPower & gIOKitDebug) \ + kprintf(x); } while (false) #if 0 #define PM_LOG3(x...) do { kprintf(x); } while (false) @@ -128,10 +154,10 @@ static uint32_t getPMRequestType( void ) #endif #define RD_LOG(x...) do { \ - if ((kIOLogPMRootDomain & gIOKitDebug) && \ - (getPMRootDomain() == this)) \ - kprintf("PMRD: " x); } while (false) - + if ((kIOLogPMRootDomain & gIOKitDebug) && \ + (getPMRootDomain() == this)) { \ + kprintf("PMRD: " x); \ + }} while (false) #define PM_ASSERT_IN_GATE(x) \ do { \ assert(gIOPMWorkLoop->inGate()); \ @@ -142,60 +168,115 @@ do { \ #define PM_LOCK_SLEEP(event, dl) IOLockSleepDeadline(fPMLock, event, dl, THREAD_UNINT) #define PM_LOCK_WAKEUP(event) IOLockWakeup(fPMLock, event, false) +#define us_per_s 1000000 #define ns_per_us 1000 -#define k30seconds (30*1000000) +#define k30Seconds (30*us_per_s) +#define k5Seconds ( 5*us_per_s) +#if CONFIG_EMBEDDED +#define kCanSleepMaxTimeReq k5Seconds +#else +#define kCanSleepMaxTimeReq k30Seconds +#endif +#define kMaxTimeRequested k30Seconds #define kMinAckTimeoutTicks (10*1000000) #define kIOPMTardyAckSPSKey "IOPMTardyAckSetPowerState" #define kIOPMTardyAckPSCKey "IOPMTardyAckPowerStateChange" #define kPwrMgtKey "IOPowerManagement" -#define OUR_PMLog(t, a, b) \ - do { gPlatform->PMLog( fName, t, a, b); } while(0) +#define OUR_PMLog(t, a, b) do { \ + if (pwrMgt) { \ + if (gIOKitDebug & kIOLogPower) \ + pwrMgt->pmPrint(t, a, b); \ + if (gIOKitTrace & kIOTracePowerMgmt) \ + pwrMgt->pmTrace(t, DBG_FUNC_NONE, a, b); \ + } \ + } while(0) + +#define OUR_PMLogFuncStart(t, a, b) do { \ + if (pwrMgt) { \ + if (gIOKitDebug & kIOLogPower) \ + pwrMgt->pmPrint(t, a, b); \ + if (gIOKitTrace & kIOTracePowerMgmt) \ + pwrMgt->pmTrace(t, DBG_FUNC_START, a, b); \ + } \ + } while(0) + +#define OUR_PMLogFuncEnd(t, a, b) do { \ + if (pwrMgt) { \ + if (gIOKitDebug & kIOLogPower) \ + pwrMgt->pmPrint(-t, a, b); \ + if (gIOKitTrace & kIOTracePowerMgmt) \ + pwrMgt->pmTrace(t, DBG_FUNC_END, a, b); \ + } \ + } while(0) #define NS_TO_MS(nsec) ((int)((nsec) / 1000000ULL)) #define NS_TO_US(nsec) ((int)((nsec) / 1000ULL)) -#if CONFIG_EMBEDDED #define SUPPORT_IDLE_CANCEL 1 -#endif -#define kIOPMPowerStateMax 0xFFFFFFFF +#define kIOPMPowerStateMax 0xFFFFFFFF +#define kInvalidTicklePowerState kIOPMPowerStateMax + +#define kNoTickleCancelWindow (60ULL * 1000ULL * 1000ULL * 1000ULL) #define IS_PM_ROOT (this == gIOPMRootNode) #define IS_ROOT_DOMAIN (getPMRootDomain() == this) -#define IS_POWER_DROP (fHeadNotePowerState < fCurrentPowerState) -#define IS_POWER_RISE (fHeadNotePowerState > fCurrentPowerState) +#define IS_POWER_DROP (StateOrder(fHeadNotePowerState) < StateOrder(fCurrentPowerState)) +#define IS_POWER_RISE (StateOrder(fHeadNotePowerState) > StateOrder(fCurrentPowerState)) // log setPowerStates longer than (ns): +#if defined(__i386__) || defined(__x86_64__) +#define LOG_SETPOWER_TIMES (300ULL * 1000ULL * 1000ULL) +#else #define LOG_SETPOWER_TIMES (50ULL * 1000ULL * 1000ULL) +#endif // log app responses longer than (ns): #define LOG_APP_RESPONSE_TIMES (100ULL * 1000ULL * 1000ULL) // use message tracer to log messages longer than (ns): #define LOG_APP_RESPONSE_MSG_TRACER (3 * 1000ULL * 1000ULL * 1000ULL) +// log kext responses longer than (ns): +#define LOG_KEXT_RESPONSE_TIMES (100ULL * 1000ULL * 1000ULL) + enum { - kReserveDomainPower = 1 + kReserveDomainPower = 1 }; #define MS_PUSH(n) \ do { assert(kIOPM_BadMachineState == fSavedMachineState); \ - assert(kIOPM_BadMachineState != n); \ - fSavedMachineState = n; } while (false) + assert(kIOPM_BadMachineState != n); \ + fSavedMachineState = n; } while (false) #define MS_POP() \ do { assert(kIOPM_BadMachineState != fSavedMachineState); \ - fMachineState = fSavedMachineState; \ - fSavedMachineState = kIOPM_BadMachineState; } while (false) + fMachineState = fSavedMachineState; \ + fSavedMachineState = kIOPM_BadMachineState; } while (false) #define PM_ACTION_0(a) \ do { if (fPMActions.a) { \ - (fPMActions.a)(fPMActions.target, this, &fPMActions); } \ - } while (false) + (fPMActions.a)(fPMActions.target, this, &fPMActions); } \ + } while (false) #define PM_ACTION_2(a, x, y) \ do { if (fPMActions.a) { \ - (fPMActions.a)(fPMActions.target, this, &fPMActions, x, y); } \ - } while (false) + (fPMActions.a)(fPMActions.target, this, &fPMActions, x, y, \ + getPMRequestTag()); } \ + } while (false) + +#define PM_ACTION_3(a, x, y, z) \ + do { if (fPMActions.a) { \ + (fPMActions.a)(fPMActions.target, this, &fPMActions, x, y, z); } \ + } while (false) + +static OSNumber * copyClientIDForNotification( + OSObject *object, + IOPMInterestContext *context); + +static void logClientIDForNotification( + OSObject *object, + IOPMInterestContext *context, + const char *logString); //********************************************************************************* // PM machine states @@ -204,368 +285,213 @@ enum { //********************************************************************************* enum { - kIOPM_Finished = 0, - - kIOPM_OurChangeTellClientsPowerDown = 1, - kIOPM_OurChangeTellPriorityClientsPowerDown = 2, - kIOPM_OurChangeNotifyInterestedDriversWillChange = 3, - kIOPM_OurChangeSetPowerState = 4, - kIOPM_OurChangeWaitForPowerSettle = 5, - kIOPM_OurChangeNotifyInterestedDriversDidChange = 6, - kIOPM_OurChangeTellCapabilityDidChange = 7, - kIOPM_OurChangeFinish = 8, - - kIOPM_ParentChangeTellPriorityClientsPowerDown = 10, - kIOPM_ParentChangeNotifyInterestedDriversWillChange = 11, - kIOPM_ParentChangeSetPowerState = 12, - kIOPM_ParentChangeWaitForPowerSettle = 13, - kIOPM_ParentChangeNotifyInterestedDriversDidChange = 14, - kIOPM_ParentChangeTellCapabilityDidChange = 15, - kIOPM_ParentChangeAcknowledgePowerChange = 16, - - kIOPM_NotifyChildrenStart = 17, - kIOPM_NotifyChildrenOrdered = 18, - kIOPM_NotifyChildrenDelayed = 19, - kIOPM_SyncTellClientsPowerDown = 20, - kIOPM_SyncTellPriorityClientsPowerDown = 21, - kIOPM_SyncNotifyWillChange = 22, - kIOPM_SyncNotifyDidChange = 23, - kIOPM_SyncTellCapabilityDidChange = 24, - kIOPM_SyncFinish = 25, - kIOPM_TellCapabilityChangeDone = 26, - kIOPM_DriverThreadCallDone = 27, - - kIOPM_BadMachineState = 0xFFFFFFFF + kIOPM_Finished = 0, + + kIOPM_OurChangeTellClientsPowerDown = 1, + kIOPM_OurChangeTellUserPMPolicyPowerDown = 2, + kIOPM_OurChangeTellPriorityClientsPowerDown = 3, + kIOPM_OurChangeNotifyInterestedDriversWillChange = 4, + kIOPM_OurChangeSetPowerState = 5, + kIOPM_OurChangeWaitForPowerSettle = 6, + kIOPM_OurChangeNotifyInterestedDriversDidChange = 7, + kIOPM_OurChangeTellCapabilityDidChange = 8, + kIOPM_OurChangeFinish = 9, + + kIOPM_ParentChangeTellPriorityClientsPowerDown = 10, + kIOPM_ParentChangeNotifyInterestedDriversWillChange = 11, + kIOPM_ParentChangeSetPowerState = 12, + kIOPM_ParentChangeWaitForPowerSettle = 13, + kIOPM_ParentChangeNotifyInterestedDriversDidChange = 14, + kIOPM_ParentChangeTellCapabilityDidChange = 15, + kIOPM_ParentChangeAcknowledgePowerChange = 16, + + kIOPM_NotifyChildrenStart = 17, + kIOPM_NotifyChildrenOrdered = 18, + kIOPM_NotifyChildrenDelayed = 19, + kIOPM_SyncTellClientsPowerDown = 20, + kIOPM_SyncTellPriorityClientsPowerDown = 21, + kIOPM_SyncNotifyWillChange = 22, + kIOPM_SyncNotifyDidChange = 23, + kIOPM_SyncTellCapabilityDidChange = 24, + kIOPM_SyncFinish = 25, + kIOPM_TellCapabilityChangeDone = 26, + kIOPM_DriverThreadCallDone = 27, + + kIOPM_BadMachineState = 0xFFFFFFFF }; - - /* - Power Management defines a few roles that drivers can play in their own, - and other drivers', power management. We briefly define those here. - - Many drivers implement their policy maker and power controller within the same - IOService object, but that is not required. - -== Policy Maker == - * Virtual IOService PM methods a "policy maker" may implement - * maxCapabilityForDomainState() - * initialPowerStateForDomainState() - * powerStateForDomainState() - - * Virtual IOService PM methods a "policy maker" may CALL - * PMinit() - -== Power Controller == - * Virtual IOService PM methods a "power controller" may implement - * setPowerState() - - * Virtual IOService PM methods a "power controller" may CALL - * joinPMtree() - * registerPowerDriver() - -======================= - There are two different kinds of power state changes. - * One is initiated by a subclassed device object which has either decided - to change power state, or its controlling driver has suggested it, or - some other driver wants to use the idle device and has asked it to become - usable. - * The second kind of power state change is initiated by the power domain - parent. - The two are handled through different code paths. - - We maintain a queue of "change notifications," or change notes. - * Usually the queue is empty. - * When it isn't, usually there is one change note in it - * It's possible to have more than one power state change pending at one - time, so a queue is implemented. - Example: - * The subclass device decides it's idle and initiates a change to a lower - power state. This causes interested parties to be notified, but they - don't all acknowledge right away. This causes the change note to sit - in the queue until all the acks are received. During this time, the - device decides it isn't idle anymore and wants to raise power back up - again. This change can't be started, however, because the previous one - isn't complete yet, so the second one waits in the queue. During this - time, the parent decides to lower or raise the power state of the entire - power domain and notifies the device, and that notification goes into - the queue, too, and can't be actioned until the others are. - - == SelfInitiated == - This is how a power change initiated by the subclass device is handled: - -> First, all interested parties are notified of the change via their - powerStateWillChangeTo method. If they all don't acknowledge via return - code, then we have to wait. If they do, or when they finally all - acknowledge via our acknowledgePowerChange method, then we can continue. - -> We call the controlling driver, instructing it to change to the new state - -> Then we wait for power to settle. If there is no settling-time, or after - it has passed, - -> we notify interested parties again, this time via their - powerStateDidChangeTo methods. - -> When they have all acked, we're done. - If we lowered power and don't need the power domain to be in its current power - state, we suggest to the parent that it lower the power domain state. - - == PowerDomainDownInitiated == -How a change to a lower power domain state initiated by the parent is handled: - -> First, we figure out what power state we will be in when the new domain - state is reached. - -> Then all interested parties are notified that we are moving to that new - state. - -> When they have acknowledged, we call the controlling driver to assume - that state and we wait for power to settle. - -> Then we acknowledge our preparedness to our parent. When all its - interested parties have acknowledged, - -> it lowers power and then notifies its interested parties again. - -> When we get this call, we notify our interested parties that the power - state has changed, and when they have all acknowledged, we're done. - - == PowerDomainUpInitiated == -How a change to a higher power domain state initiated by the parent is handled: - -> We figure out what power state we will be in when the new domain state is - reached. - -> If it is different from our current state we acknowledge the parent. - -> When all the parent's interested parties have acknowledged, it raises - power in the domain and waits for power to settle. - -> Then it notifies everyone that the new state has been reached. - -> When we get this call, we call the controlling driver, instructing it to - assume the new state, and wait for power to settle. - -> Then we notify our interested parties. When they all acknowledge we are - done. - - In either of the two power domain state cases above, it is possible that we - will not be changing state even though the domain is. - Examples: - * A change to a lower domain state may not affect us because we are already - in a low enough state, - * We will not take advantage of a change to a higher domain state, because - we have no need of the higher power. In such cases, there is nothing to - do but acknowledge the parent. So when the parent calls our - powerDomainWillChange method, and we decide that we will not be changing - state, we merely acknowledge the parent, via return code, and wait. - When the parent subsequently calls powerStateDidChange, we acknowledge again - via return code, and the change is complete. - - == 4 Paths Through State Machine == - Power state changes are processed in a state machine, and since there are four - varieties of power state changes, there are four major paths through the state - machine. - - == 5. No Need To change == - The fourth is nearly trivial. In this path, the parent is changing the domain - state, but we are not changing the device state. The change starts when the - parent calls powerDomainWillChange. All we do is acknowledge the parent. When - the parent calls powerStateDidChange, we acknowledge the parent again, and - we're done. - - == 1. OurChange Down == XXX gvdl - The first is fairly simple. It starts: - * when a power domain child calls requestPowerDomainState and we decide to - change power states to accomodate the child, - * or if our power-controlling driver calls changePowerStateTo, - * or if some other driver which is using our device calls makeUsable, - * or if a subclassed object calls changePowerStateToPriv. - These are all power changes initiated by us, not forced upon us by the parent. - - -> We start by notifying interested parties. - -> If they all acknowledge via return code, we can go on to state - "msSetPowerState". - -> Otherwise, we start the ack timer and wait for the stragglers to - acknowlege by calling acknowledgePowerChange. - -> We move on to state "msSetPowerState" when all the - stragglers have acknowledged, or when the ack timer expires on - all those which didn't acknowledge. - In "msSetPowerState" we call the power-controlling driver to change the - power state of the hardware. - -> If it returns saying it has done so, we go on to state - "msWaitForPowerSettle". - -> Otherwise, we have to wait for it, so we set the ack timer and wait. - -> When it calls acknowledgeSetPowerState, or when the ack timer - expires, we go on. - In "msWaitForPowerSettle", we look in the power state array to see if - there is any settle time required when changing from our current state to the - new state. - -> If not, we go right away to "msNotifyInterestedDriversDidChange". - -> Otherwise, we set the settle timer and wait. When it expires, we move on. - In "msNotifyInterestedDriversDidChange" state, we notify all our - interested parties via their powerStateDidChange methods that we have finished - changing power state. - -> If they all acknowledge via return code, we move on to "msFinish". - -> Otherwise we set the ack timer and wait. When they have all - acknowledged, or when the ack timer has expired for those that didn't, - we move on to "msFinish". - In "msFinish" we remove the used change note from the head of the queue - and start the next one if one exists. - - == 2. Parent Change Down == - Start at Stage 2 of OurChange Down XXX gvdl - - == 3. Change Up == - Start at Stage 4 of OurChange Down XXX gvdl - -Note all parent requested changes need to acknowledge the power has changed to the parent when done. - */ - //********************************************************************************* // [public] PMinit // // Initialize power management. //********************************************************************************* -void IOService::PMinit ( void ) -{ - if ( !initialized ) - { - if ( !gIOPMInitialized ) - { - gPlatform = getPlatform(); - gIOPMWorkLoop = IOWorkLoop::workLoop(); - if (gIOPMWorkLoop) - { - gIOPMRequestQueue = IOPMRequestQueue::create( - this, OSMemberFunctionCast(IOPMRequestQueue::Action, - this, &IOService::servicePMRequestQueue)); - - gIOPMReplyQueue = IOPMRequestQueue::create( - this, OSMemberFunctionCast(IOPMRequestQueue::Action, - this, &IOService::servicePMReplyQueue)); - - gIOPMWorkQueue = IOPMWorkQueue::create( - this, - OSMemberFunctionCast(IOPMWorkQueue::Action, this, - &IOService::servicePMRequest), - OSMemberFunctionCast(IOPMWorkQueue::Action, this, - &IOService::retirePMRequest)); - - gIOPMFreeQueue = IOPMCompletionQueue::create( - this, OSMemberFunctionCast(IOPMCompletionQueue::Action, - this, &IOService::servicePMFreeQueue)); - - if (gIOPMWorkLoop->addEventSource(gIOPMRequestQueue) != - kIOReturnSuccess) - { - gIOPMRequestQueue->release(); - gIOPMRequestQueue = 0; - } - - if (gIOPMWorkLoop->addEventSource(gIOPMReplyQueue) != - kIOReturnSuccess) - { - gIOPMReplyQueue->release(); - gIOPMReplyQueue = 0; - } - - if (gIOPMWorkLoop->addEventSource(gIOPMWorkQueue) != - kIOReturnSuccess) - { - gIOPMWorkQueue->release(); - gIOPMWorkQueue = 0; - } - - if (gIOPMWorkLoop->addEventSource(gIOPMFreeQueue) != - kIOReturnSuccess) - { - gIOPMFreeQueue->release(); - gIOPMFreeQueue = 0; - } - - gIOPMPowerClientDevice = - OSSymbol::withCStringNoCopy( "DevicePowerState" ); - - gIOPMPowerClientDriver = - OSSymbol::withCStringNoCopy( "DriverPowerState" ); - - gIOPMPowerClientChildProxy = - OSSymbol::withCStringNoCopy( "ChildProxyPowerState" ); - - gIOPMPowerClientChildren = - OSSymbol::withCStringNoCopy( "ChildrenPowerState" ); - } - - if (gIOPMRequestQueue && gIOPMReplyQueue && gIOPMFreeQueue) - gIOPMInitialized = true; - } - if (!gIOPMInitialized) - return; - - pwrMgt = new IOServicePM; - pwrMgt->init(); - setProperty(kPwrMgtKey, pwrMgt); - - queue_init(&pwrMgt->WorkChain); - queue_init(&pwrMgt->RequestHead); - queue_init(&pwrMgt->PMDriverCallQueue); - - fOwner = this; - fPMLock = IOLockAlloc(); - fInterestedDrivers = new IOPMinformeeList; - fInterestedDrivers->initialize(); - fDesiredPowerState = 0; - fDeviceDesire = 0; - fInitialPowerChange = true; - fInitialSetPowerState = true; - fPreviousRequestPowerFlags = 0; - fDeviceOverrideEnabled = false; - fMachineState = kIOPM_Finished; - fSavedMachineState = kIOPM_BadMachineState; - fIdleTimerMinPowerState = 0; - fActivityLock = IOLockAlloc(); - fStrictTreeOrder = false; - fActivityTicklePowerState = -1; - fControllingDriver = NULL; - fPowerStates = NULL; - fNumberOfPowerStates = 0; - fCurrentPowerState = 0; - fParentsCurrentPowerFlags = 0; - fMaxPowerState = 0; - fName = getName(); - fParentsKnowState = false; - fSerialNumber = 0; - fResponseArray = NULL; - fNotifyClientArray = NULL; - fCurrentPowerConsumption = kIOPMUnknown; - fOverrideMaxPowerState = kIOPMPowerStateMax; - - if (!gIOPMRootNode && (getParentEntry(gIOPowerPlane) == getRegistryRoot())) - { - gIOPMRootNode = this; - fParentsKnowState = true; - } - - fAckTimer = thread_call_allocate( +void +IOService::PMinit( void ) +{ + if (!initialized) { + if (!gIOPMInitialized) { + gPlatform = getPlatform(); + gIOPMWorkLoop = IOWorkLoop::workLoop(); + if (gIOPMWorkLoop) { + gIOPMRequestQueue = IOPMRequestQueue::create( + this, OSMemberFunctionCast(IOPMRequestQueue::Action, + this, &IOService::actionPMRequestQueue)); + + gIOPMReplyQueue = IOPMRequestQueue::create( + this, OSMemberFunctionCast(IOPMRequestQueue::Action, + this, &IOService::actionPMReplyQueue)); + + gIOPMWorkQueue = IOPMWorkQueue::create(this, + OSMemberFunctionCast(IOPMWorkQueue::Action, this, + &IOService::actionPMWorkQueueInvoke), + OSMemberFunctionCast(IOPMWorkQueue::Action, this, + &IOService::actionPMWorkQueueRetire)); + + gIOPMCompletionQueue = IOPMCompletionQueue::create( + this, OSMemberFunctionCast(IOPMCompletionQueue::Action, + this, &IOService::actionPMCompletionQueue)); + + if (gIOPMWorkLoop->addEventSource(gIOPMRequestQueue) != + kIOReturnSuccess) { + gIOPMRequestQueue->release(); + gIOPMRequestQueue = NULL; + } + + if (gIOPMWorkLoop->addEventSource(gIOPMReplyQueue) != + kIOReturnSuccess) { + gIOPMReplyQueue->release(); + gIOPMReplyQueue = NULL; + } + + if (gIOPMWorkLoop->addEventSource(gIOPMWorkQueue) != + kIOReturnSuccess) { + gIOPMWorkQueue->release(); + gIOPMWorkQueue = NULL; + } + + // Must be added after the work queue, which pushes request + // to the completion queue without signaling the work loop. + if (gIOPMWorkLoop->addEventSource(gIOPMCompletionQueue) != + kIOReturnSuccess) { + gIOPMCompletionQueue->release(); + gIOPMCompletionQueue = NULL; + } + + gIOPMPowerClientDevice = + OSSymbol::withCStringNoCopy( "DevicePowerState" ); + + gIOPMPowerClientDriver = + OSSymbol::withCStringNoCopy( "DriverPowerState" ); + + gIOPMPowerClientChildProxy = + OSSymbol::withCStringNoCopy( "ChildProxyPowerState" ); + + gIOPMPowerClientChildren = + OSSymbol::withCStringNoCopy( "ChildrenPowerState" ); + + gIOPMPowerClientAdvisoryTickle = + OSSymbol::withCStringNoCopy( "AdvisoryTicklePowerState" ); + + gIOPMPowerClientRootDomain = + OSSymbol::withCStringNoCopy( "RootDomainPower" ); + } + + if (gIOPMRequestQueue && gIOPMReplyQueue && gIOPMCompletionQueue) { + gIOPMInitialized = true; + } + } + if (!gIOPMInitialized) { + return; + } + + pwrMgt = new IOServicePM; + pwrMgt->init(); + setProperty(kPwrMgtKey, pwrMgt); + + queue_init(&pwrMgt->WorkChain); + queue_init(&pwrMgt->RequestHead); + queue_init(&pwrMgt->PMDriverCallQueue); + + fOwner = this; + fPMLock = IOLockAlloc(); + fInterestedDrivers = new IOPMinformeeList; + fInterestedDrivers->initialize(); + fDesiredPowerState = kPowerStateZero; + fDeviceDesire = kPowerStateZero; + fInitialPowerChange = true; + fInitialSetPowerState = true; + fPreviousRequestPowerFlags = 0; + fDeviceOverrideEnabled = false; + fMachineState = kIOPM_Finished; + fSavedMachineState = kIOPM_BadMachineState; + fIdleTimerMinPowerState = kPowerStateZero; + fActivityLock = IOLockAlloc(); + fStrictTreeOrder = false; + fActivityTicklePowerState = kInvalidTicklePowerState; + fAdvisoryTicklePowerState = kInvalidTicklePowerState; + fControllingDriver = NULL; + fPowerStates = NULL; + fNumberOfPowerStates = 0; + fCurrentPowerState = kPowerStateZero; + fParentsCurrentPowerFlags = 0; + fMaxPowerState = kPowerStateZero; + fName = getName(); + fParentsKnowState = false; + fSerialNumber = 0; + fResponseArray = NULL; + fNotifyClientArray = NULL; + fCurrentPowerConsumption = kIOPMUnknown; + fOverrideMaxPowerState = kIOPMPowerStateMax; + + if (!gIOPMRootNode && (getParentEntry(gIOPowerPlane) == getRegistryRoot())) { + gIOPMRootNode = this; + fParentsKnowState = true; + } else if (getProperty(kIOPMResetPowerStateOnWakeKey) == kOSBooleanTrue) { + fResetPowerStateOnWake = true; + } + + if (IS_ROOT_DOMAIN) { + fWatchdogTimer = thread_call_allocate( + &IOService::watchdog_timer_expired, (thread_call_param_t)this); + fWatchdogLock = IOLockAlloc(); + + fBlockedArray = OSArray::withCapacity(4); + } + + fAckTimer = thread_call_allocate( &IOService::ack_timer_expired, (thread_call_param_t)this); - fSettleTimer = thread_call_allocate( + fSettleTimer = thread_call_allocate( &settle_timer_expired, (thread_call_param_t)this); - fIdleTimer = thread_call_allocate( - &idle_timer_expired, (thread_call_param_t)this); - fDriverCallEntry = thread_call_allocate( + fIdleTimer = thread_call_allocate( + &idle_timer_expired, (thread_call_param_t)this); + fDriverCallEntry = thread_call_allocate( (thread_call_func_t) &IOService::pmDriverCallout, this); - assert(fDriverCallEntry); - - // Check for powerChangeDone override. - if (OSMemberFunctionCast(void (*)(void), - getResourceService(), &IOService::powerChangeDone) != - OSMemberFunctionCast(void (*)(void), - this, &IOService::powerChangeDone)) - { - fPCDFunctionOverride = true; - } + assert(fDriverCallEntry); + + // Check for powerChangeDone override. + if (OSMemberFunctionCast(void (*)(void), + getResourceService(), &IOService::powerChangeDone) != + OSMemberFunctionCast(void (*)(void), + this, &IOService::powerChangeDone)) { + fPCDFunctionOverride = true; + } #if PM_VARS_SUPPORT - IOPMprot * prot = new IOPMprot; - if (prot) - { - prot->init(); - prot->ourName = fName; - prot->thePlatform = gPlatform; - fPMVars = prot; - pm_vars = prot; + IOPMprot * prot = new IOPMprot; + if (prot) { + prot->init(); + prot->ourName = fName; + prot->thePlatform = gPlatform; + fPMVars = prot; + pm_vars = prot; } #else - pm_vars = (void *) (uintptr_t) true; + pm_vars = (void *) (uintptr_t) true; #endif - initialized = true; - } + initialized = true; + } } //********************************************************************************* @@ -574,85 +500,106 @@ void IOService::PMinit ( void ) // Free the data created by PMinit. Only called from IOService::free(). //********************************************************************************* -void IOService::PMfree ( void ) -{ - initialized = false; - pm_vars = 0; - - if ( pwrMgt ) - { - assert(fMachineState == kIOPM_Finished); - assert(fInsertInterestSet == NULL); - assert(fRemoveInterestSet == NULL); - assert(fNotifyChildArray == NULL); - assert(queue_empty(&pwrMgt->RequestHead)); - assert(queue_empty(&fPMDriverCallQueue)); - - if ( fSettleTimer ) { - thread_call_cancel(fSettleTimer); - thread_call_free(fSettleTimer); - fSettleTimer = NULL; - } - if ( fAckTimer ) { - thread_call_cancel(fAckTimer); - thread_call_free(fAckTimer); - fAckTimer = NULL; - } - if ( fIdleTimer ) { - thread_call_cancel(fIdleTimer); - thread_call_free(fIdleTimer); - fIdleTimer = NULL; - } - if ( fDriverCallEntry ) { - thread_call_free(fDriverCallEntry); - fDriverCallEntry = NULL; - } - if ( fPMLock ) { - IOLockFree(fPMLock); - fPMLock = NULL; - } - if ( fActivityLock ) { - IOLockFree(fActivityLock); - fActivityLock = NULL; - } - if ( fInterestedDrivers ) { - fInterestedDrivers->release(); - fInterestedDrivers = NULL; - } - if (fDriverCallParamSlots && fDriverCallParamPtr) { - IODelete(fDriverCallParamPtr, DriverCallParam, fDriverCallParamSlots); - fDriverCallParamPtr = 0; - fDriverCallParamSlots = 0; - } - if ( fResponseArray ) { - fResponseArray->release(); - fResponseArray = NULL; - } - if ( fNotifyClientArray ) { - fNotifyClientArray->release(); - fNotifyClientArray = NULL; - } - if (fPowerStates && fNumberOfPowerStates) { - IODelete(fPowerStates, IOPMPSEntry, fNumberOfPowerStates); - fNumberOfPowerStates = 0; - fPowerStates = NULL; - } - if (fPowerClients) { - fPowerClients->release(); - fPowerClients = 0; - } +void +IOService::PMfree( void ) +{ + initialized = false; + pm_vars = NULL; + + if (pwrMgt) { + assert(fMachineState == kIOPM_Finished); + assert(fInsertInterestSet == NULL); + assert(fRemoveInterestSet == NULL); + assert(fNotifyChildArray == NULL); + assert(queue_empty(&pwrMgt->RequestHead)); + assert(queue_empty(&fPMDriverCallQueue)); + + if (fWatchdogTimer) { + thread_call_cancel(fWatchdogTimer); + thread_call_free(fWatchdogTimer); + fWatchdogTimer = NULL; + } + + if (fWatchdogLock) { + IOLockFree(fWatchdogLock); + fWatchdogLock = NULL; + } + + if (fBlockedArray) { + fBlockedArray->release(); + fBlockedArray = NULL; + } + + if (fSettleTimer) { + thread_call_cancel(fSettleTimer); + thread_call_free(fSettleTimer); + fSettleTimer = NULL; + } + if (fAckTimer) { + thread_call_cancel(fAckTimer); + thread_call_free(fAckTimer); + fAckTimer = NULL; + } + if (fIdleTimer) { + thread_call_cancel(fIdleTimer); + thread_call_free(fIdleTimer); + fIdleTimer = NULL; + } + if (fDriverCallEntry) { + thread_call_free(fDriverCallEntry); + fDriverCallEntry = NULL; + } + if (fPMLock) { + IOLockFree(fPMLock); + fPMLock = NULL; + } + if (fActivityLock) { + IOLockFree(fActivityLock); + fActivityLock = NULL; + } + if (fInterestedDrivers) { + fInterestedDrivers->release(); + fInterestedDrivers = NULL; + } + if (fDriverCallParamSlots && fDriverCallParamPtr) { + IODelete(fDriverCallParamPtr, DriverCallParam, fDriverCallParamSlots); + fDriverCallParamPtr = NULL; + fDriverCallParamSlots = 0; + } + if (fResponseArray) { + fResponseArray->release(); + fResponseArray = NULL; + } + if (fNotifyClientArray) { + fNotifyClientArray->release(); + fNotifyClientArray = NULL; + } + if (fPowerStates && fNumberOfPowerStates) { + IODelete(fPowerStates, IOPMPSEntry, fNumberOfPowerStates); + fNumberOfPowerStates = 0; + fPowerStates = NULL; + } + if (fPowerClients) { + fPowerClients->release(); + fPowerClients = NULL; + } #if PM_VARS_SUPPORT - if (fPMVars) - { - fPMVars->release(); - fPMVars = 0; - } + if (fPMVars) { + fPMVars->release(); + fPMVars = NULL; + } #endif - pwrMgt->release(); - pwrMgt = 0; - } + pwrMgt->release(); + pwrMgt = NULL; + } +} + +void +IOService::PMDebug( uint32_t event, uintptr_t param1, uintptr_t param2 ) +{ + OUR_PMLog(event, param1, param2); } //********************************************************************************* @@ -668,13 +615,14 @@ void IOService::PMfree ( void ) // meaning it may not be initialized for power management. //********************************************************************************* -void IOService::joinPMtree ( IOService * driver ) +void +IOService::joinPMtree( IOService * driver ) { - IOPlatformExpert * platform; + IOPlatformExpert * platform; - platform = getPlatform(); - assert(platform != 0); - platform->PMRegisterDevice(this, driver); + platform = getPlatform(); + assert(platform != NULL); + platform->PMRegisterDevice(this, driver); } #ifndef __LP64__ @@ -684,9 +632,10 @@ void IOService::joinPMtree ( IOService * driver ) // Power Managment is informing us that we are the root power domain. //********************************************************************************* -IOReturn IOService::youAreRoot ( void ) +IOReturn +IOService::youAreRoot( void ) { - return IOPMNoErr; + return IOPMNoErr; } #endif /* !__LP64__ */ @@ -697,37 +646,37 @@ IOReturn IOService::youAreRoot ( void ) // from power plane. //********************************************************************************* -void IOService::PMstop ( void ) +void +IOService::PMstop( void ) { - IOPMRequest * request; + IOPMRequest * request; - if (!initialized) - return; + if (!initialized) { + return; + } - PM_LOCK(); + PM_LOCK(); - if (fLockedFlags.PMStop) - { - PM_LOG2("%s: PMstop() already stopped\n", fName); - PM_UNLOCK(); - return; - } + if (fLockedFlags.PMStop) { + PM_LOG2("%s: PMstop() already stopped\n", fName); + PM_UNLOCK(); + return; + } - // Inhibit future driver calls. - fLockedFlags.PMStop = true; + // Inhibit future driver calls. + fLockedFlags.PMStop = true; - // Wait for all prior driver calls to finish. - waitForPMDriverCall(); + // Wait for all prior driver calls to finish. + waitForPMDriverCall(); - PM_UNLOCK(); + PM_UNLOCK(); - // The rest of the work is performed async. - request = acquirePMRequest( this, kIOPMRequestTypePMStop ); - if (request) - { - PM_LOG2("%s: %p PMstop\n", getName(), this); - submitPMRequest( request ); - } + // The rest of the work is performed async. + request = acquirePMRequest( this, kIOPMRequestTypePMStop ); + if (request) { + PM_LOG2("%s: %p PMstop\n", getName(), OBFUSCATE(this)); + submitPMRequest( request ); + } } //********************************************************************************* @@ -736,94 +685,92 @@ void IOService::PMstop ( void ) // Disconnect the node from all parents and children in the power plane. //********************************************************************************* -void IOService::handlePMstop ( IOPMRequest * request ) +void +IOService::handlePMstop( IOPMRequest * request ) { - OSIterator * iter; - OSObject * next; - IOPowerConnection * connection; - IOService * theChild; - IOService * theParent; + OSIterator * iter; + OSObject * next; + IOPowerConnection * connection; + IOService * theChild; + IOService * theParent; PM_ASSERT_IN_GATE(); - PM_LOG2("%s: %p %s start\n", getName(), this, __FUNCTION__); - - // remove the property - removeProperty(kPwrMgtKey); - - // detach parents - iter = getParentIterator(gIOPowerPlane); - if ( iter ) - { - while ( (next = iter->getNextObject()) ) - { - if ( (connection = OSDynamicCast(IOPowerConnection, next)) ) - { - theParent = (IOService *)connection->copyParentEntry(gIOPowerPlane); - if ( theParent ) - { - theParent->removePowerChild(connection); - theParent->release(); - } - } - } - iter->release(); - } - - // detach IOConnections - detachAbove( gIOPowerPlane ); - - // no more power state changes - fParentsKnowState = false; - - // detach children - iter = getChildIterator(gIOPowerPlane); - if ( iter ) - { - while ( (next = iter->getNextObject()) ) - { - if ( (connection = OSDynamicCast(IOPowerConnection, next)) ) - { - theChild = ((IOService *)(connection->copyChildEntry(gIOPowerPlane))); - if ( theChild ) - { - // detach nub from child - connection->detachFromChild(theChild, gIOPowerPlane); - theChild->release(); - } - // detach us from nub - detachFromChild(connection, gIOPowerPlane); - } - } - iter->release(); - } - - // Remove all interested drivers from the list, including the power - // controlling driver. - // - // Usually, the controlling driver and the policy-maker functionality - // are implemented by the same object, and without the deregistration, - // the object will be holding an extra retain on itself, and cannot - // be freed. - - if ( fInterestedDrivers ) - { - IOPMinformeeList * list = fInterestedDrivers; - IOPMinformee * item; - - PM_LOCK(); - while ((item = list->firstInList())) - { - list->removeFromList(item->whatObject); - } - PM_UNLOCK(); - } - - // Tell idleTimerExpired() to ignore idle timer. - fIdleTimerPeriod = 0; - if (fIdleTimer && thread_call_cancel(fIdleTimer)) - release(); - - PM_LOG2("%s: %p %s done\n", getName(), this, __FUNCTION__); + PM_LOG2("%s: %p %s start\n", getName(), OBFUSCATE(this), __FUNCTION__); + + // remove driver from prevent system sleep lists + getPMRootDomain()->updatePreventIdleSleepList(this, false); + getPMRootDomain()->updatePreventSystemSleepList(this, false); + + // remove the property + removeProperty(kPwrMgtKey); + + // detach parents + iter = getParentIterator(gIOPowerPlane); + if (iter) { + while ((next = iter->getNextObject())) { + if ((connection = OSDynamicCast(IOPowerConnection, next))) { + theParent = (IOService *)connection->copyParentEntry(gIOPowerPlane); + if (theParent) { + theParent->removePowerChild(connection); + theParent->release(); + } + } + } + iter->release(); + } + + // detach IOConnections + detachAbove( gIOPowerPlane ); + + // no more power state changes + fParentsKnowState = false; + + // detach children + iter = getChildIterator(gIOPowerPlane); + if (iter) { + while ((next = iter->getNextObject())) { + if ((connection = OSDynamicCast(IOPowerConnection, next))) { + theChild = ((IOService *)(connection->copyChildEntry(gIOPowerPlane))); + if (theChild) { + // detach nub from child + connection->detachFromChild(theChild, gIOPowerPlane); + theChild->release(); + } + // detach us from nub + detachFromChild(connection, gIOPowerPlane); + } + } + iter->release(); + } + + // Remove all interested drivers from the list, including the power + // controlling driver. + // + // Usually, the controlling driver and the policy-maker functionality + // are implemented by the same object, and without the deregistration, + // the object will be holding an extra retain on itself, and cannot + // be freed. + + if (fInterestedDrivers) { + IOPMinformeeList * list = fInterestedDrivers; + IOPMinformee * item; + + PM_LOCK(); + while ((item = list->firstInList())) { + list->removeFromList(item->whatObject); + } + PM_UNLOCK(); + } + + // Clear idle period to prevent idleTimerExpired() from servicing + // idle timer expirations. + + fIdleTimerPeriod = 0; + if (fIdleTimer && thread_call_cancel(fIdleTimer)) { + release(); + } + + PM_LOG2("%s: %p %s done\n", getName(), OBFUSCATE(this), __FUNCTION__); } //********************************************************************************* @@ -832,45 +779,44 @@ void IOService::handlePMstop ( IOPMRequest * request ) // Power Management is informing us who our children are. //********************************************************************************* -IOReturn IOService::addPowerChild ( IOService * child ) +IOReturn +IOService::addPowerChild( IOService * child ) { - IOPowerConnection * connection = 0; - IOPMRequest * requests[3] = {0, 0, 0}; - OSIterator * iter; - bool ok = true; + IOPowerConnection * connection = NULL; + IOPMRequest * requests[3] = {NULL, NULL, NULL}; + OSIterator * iter; + bool ok = true; - if (!child) + if (!child) { return kIOReturnBadArgument; + } - if (!initialized || !child->initialized) + if (!initialized || !child->initialized) { return IOPMNotYetInitialized; + } - OUR_PMLog( kPMLogAddChild, (uintptr_t) child, 0 ); + OUR_PMLog( kPMLogAddChild, (uintptr_t) child, 0 ); do { // Is this child already one of our children? iter = child->getParentIterator( gIOPowerPlane ); - if ( iter ) - { - IORegistryEntry * entry; - OSObject * next; + if (iter) { + IORegistryEntry * entry; + OSObject * next; - while ((next = iter->getNextObject())) - { + while ((next = iter->getNextObject())) { if ((entry = OSDynamicCast(IORegistryEntry, next)) && - isChild(entry, gIOPowerPlane)) - { + isChild(entry, gIOPowerPlane)) { ok = false; break; - } + } } iter->release(); } - if (!ok) - { - PM_LOG("%s: %s (%p) is already a child\n", - getName(), child->getName(), child); + if (!ok) { + PM_LOG2("%s: %s (%p) is already a child\n", + getName(), child->getName(), OBFUSCATE(child)); break; } @@ -881,26 +827,28 @@ IOReturn IOService::addPowerChild ( IOService * child ) // block on the PM work loop. connection = new IOPowerConnection; - if (!connection) + if (!connection) { break; + } // Create a chain of PM requests to perform the bottom-half // work from the PM work loop. requests[0] = acquirePMRequest( - /* target */ this, - /* type */ kIOPMRequestTypeAddPowerChild1 ); + /* target */ this, + /* type */ kIOPMRequestTypeAddPowerChild1 ); requests[1] = acquirePMRequest( - /* target */ child, - /* type */ kIOPMRequestTypeAddPowerChild2 ); + /* target */ child, + /* type */ kIOPMRequestTypeAddPowerChild2 ); requests[2] = acquirePMRequest( - /* target */ this, - /* type */ kIOPMRequestTypeAddPowerChild3 ); + /* target */ this, + /* type */ kIOPMRequestTypeAddPowerChild3 ); - if (!requests[0] || !requests[1] || !requests[2]) + if (!requests[0] || !requests[1] || !requests[2]) { break; + } requests[0]->attachNextRequest( requests[1] ); requests[1]->attachNextRequest( requests[2] ); @@ -918,15 +866,22 @@ IOReturn IOService::addPowerChild ( IOService * child ) requests[1]->fArg0 = connection; requests[2]->fArg0 = connection; - submitPMRequest( requests, 3 ); + submitPMRequests( requests, 3 ); return kIOReturnSuccess; - } - while (false); + }while (false); - if (connection) connection->release(); - if (requests[0]) releasePMRequest(requests[0]); - if (requests[1]) releasePMRequest(requests[1]); - if (requests[2]) releasePMRequest(requests[2]); + if (connection) { + connection->release(); + } + if (requests[0]) { + releasePMRequest(requests[0]); + } + if (requests[1]) { + releasePMRequest(requests[1]); + } + if (requests[2]) { + releasePMRequest(requests[2]); + } // Silent failure, to prevent platform drivers from adding the child // to the root domain. @@ -940,22 +895,22 @@ IOReturn IOService::addPowerChild ( IOService * child ) // Step 1/3 of adding a power child. Called on the power parent. //********************************************************************************* -void IOService::addPowerChild1 ( IOPMRequest * request ) +void +IOService::addPowerChild1( IOPMRequest * request ) { - unsigned long tempDesire = 0; + IOPMPowerStateIndex tempDesire = kPowerStateZero; // Make us temporary usable before adding the child. PM_ASSERT_IN_GATE(); - OUR_PMLog( kPMLogMakeUsable, kPMLogMakeUsable, 0 ); + OUR_PMLog( kPMLogMakeUsable, kPMLogMakeUsable, 0 ); - if (fControllingDriver && inPlane(gIOPowerPlane) && fParentsKnowState) - { - tempDesire = fNumberOfPowerStates - 1; + if (fControllingDriver && inPlane(gIOPowerPlane) && fParentsKnowState) { + tempDesire = fHighestPowerState; } - if (tempDesire && (IS_PM_ROOT || (fMaxPowerState >= tempDesire))) - { + if ((tempDesire != kPowerStateZero) && + (IS_PM_ROOT || (StateOrder(fMaxPowerState) >= StateOrder(tempDesire)))) { adjustPowerState(tempDesire); } } @@ -967,20 +922,20 @@ void IOService::addPowerChild1 ( IOPMRequest * request ) // Execution blocked behind addPowerChild1. //********************************************************************************* -void IOService::addPowerChild2 ( IOPMRequest * request ) +void +IOService::addPowerChild2( IOPMRequest * request ) { IOPowerConnection * connection = (IOPowerConnection *) request->fArg0; IOService * parent; - IOPMPowerFlags powerFlags; - bool knowsState; - unsigned long powerState; - unsigned long tempDesire; + IOPMPowerFlags powerFlags; + bool knowsState; + unsigned long powerState; + unsigned long tempDesire; PM_ASSERT_IN_GATE(); parent = (IOService *) connection->getParentEntry(gIOPowerPlane); - if (!parent || !inPlane(gIOPowerPlane)) - { + if (!parent || !inPlane(gIOPowerPlane)) { PM_LOG("%s: addPowerChild2 not in power plane\n", getName()); return; } @@ -991,29 +946,29 @@ void IOService::addPowerChild2 ( IOPMRequest * request ) knowsState = (parent->fPowerStates) && (parent->fParentsKnowState); powerState = parent->fCurrentPowerState; - if (knowsState) + if (knowsState) { powerFlags = parent->fPowerStates[powerState].outputPowerFlags; - else + } else { powerFlags = 0; + } // Set our power parent. - OUR_PMLog(kPMLogSetParent, knowsState, powerFlags); + OUR_PMLog(kPMLogSetParent, knowsState, powerFlags); setParentInfo( powerFlags, connection, knowsState ); connection->setReadyFlag(true); - if ( fControllingDriver && fParentsKnowState ) - { - fMaxPowerState = fControllingDriver->maxCapabilityForDomainState(fParentsCurrentPowerFlags); - // initially change into the state we are already in - tempDesire = fControllingDriver->initialPowerStateForDomainState(fParentsCurrentPowerFlags); - fPreviousRequestPowerFlags = (IOPMPowerFlags)(-1); - adjustPowerState(tempDesire); - } + if (fControllingDriver && fParentsKnowState) { + fMaxPowerState = fControllingDriver->maxCapabilityForDomainState(fParentsCurrentPowerFlags); + // initially change into the state we are already in + tempDesire = fControllingDriver->initialPowerStateForDomainState(fParentsCurrentPowerFlags); + fPreviousRequestPowerFlags = (IOPMPowerFlags)(-1); + adjustPowerState(tempDesire); + } - getPMRootDomain()->tagPowerPlaneService(this, &fPMActions); + getPMRootDomain()->tagPowerPlaneService(this, &fPMActions); } //********************************************************************************* @@ -1023,28 +978,26 @@ void IOService::addPowerChild2 ( IOPMRequest * request ) // Execution blocked behind addPowerChild2. //********************************************************************************* -void IOService::addPowerChild3 ( IOPMRequest * request ) +void +IOService::addPowerChild3( IOPMRequest * request ) { IOPowerConnection * connection = (IOPowerConnection *) request->fArg0; IOService * child; - IOPMrootDomain * rootDomain = getPMRootDomain(); + IOPMrootDomain * rootDomain = getPMRootDomain(); PM_ASSERT_IN_GATE(); child = (IOService *) connection->getChildEntry(gIOPowerPlane); - if (child && inPlane(gIOPowerPlane)) - { - if (child->getProperty("IOPMStrictTreeOrder")) - { + if (child && inPlane(gIOPowerPlane)) { + if ((this != rootDomain) && child->getProperty("IOPMStrictTreeOrder")) { PM_LOG1("%s: strict PM order enforced\n", getName()); fStrictTreeOrder = true; } - if (rootDomain) - rootDomain->joinAggressiveness( child ); - } - else - { + if (rootDomain) { + rootDomain->joinAggressiveness( child ); + } + } else { PM_LOG("%s: addPowerChild3 not in power plane\n", getName()); } @@ -1061,7 +1014,8 @@ void IOService::addPowerChild3 ( IOPMRequest * request ) // to assume that state. //********************************************************************************* -IOReturn IOService::setPowerParent ( +IOReturn +IOService::setPowerParent( IOPowerConnection * theParent, bool stateKnown, IOPMPowerFlags powerFlags ) { return kIOReturnUnsupported; @@ -1074,42 +1028,44 @@ IOReturn IOService::setPowerParent ( // Called on a parent whose child is being removed by PMstop(). //********************************************************************************* -IOReturn IOService::removePowerChild ( IOPowerConnection * theNub ) +IOReturn +IOService::removePowerChild( IOPowerConnection * theNub ) { - IORegistryEntry * theChild; + IORegistryEntry * theChild; PM_ASSERT_IN_GATE(); - OUR_PMLog( kPMLogRemoveChild, 0, 0 ); - - theNub->retain(); - - // detach nub from child - theChild = theNub->copyChildEntry(gIOPowerPlane); - if ( theChild ) - { - theNub->detachFromChild(theChild, gIOPowerPlane); - theChild->release(); - } - // detach from the nub - detachFromChild(theNub, gIOPowerPlane); - - // Are we awaiting an ack from this child? - if ( theNub->getAwaitingAck() ) - { + OUR_PMLog( kPMLogRemoveChild, 0, 0 ); + + theNub->retain(); + + // detach nub from child + theChild = theNub->copyChildEntry(gIOPowerPlane); + if (theChild) { + theNub->detachFromChild(theChild, gIOPowerPlane); + theChild->release(); + } + // detach from the nub + detachFromChild(theNub, gIOPowerPlane); + + // Are we awaiting an ack from this child? + if (theNub->getAwaitingAck()) { // yes, pretend we got one theNub->setAwaitingAck(false); - if (fHeadNotePendingAcks != 0 ) - { + if (fHeadNotePendingAcks != 0) { // that's one fewer ack to worry about fHeadNotePendingAcks--; // is that the last? - if ( fHeadNotePendingAcks == 0 ) - { + if (fHeadNotePendingAcks == 0) { stop_ack_timer(); + getPMRootDomain()->reset_watchdog_timer(this, 0); + + // This parent may have a request in the work queue that is + // blocked on fHeadNotePendingAcks=0. And removePowerChild() + // is called while executing the child's PMstop request so they + // can occur simultaneously. IOPMWorkQueue::checkForWork() must + // restart and check all request queues again. - // Request unblocked, work queue - // should re-scan all busy requests. gIOPMWorkQueue->incrementProducerCount(); } } @@ -1118,20 +1074,18 @@ IOReturn IOService::removePowerChild ( IOPowerConnection * theNub ) theNub->release(); // A child has gone away, re-scan children desires and clamp bits. - // The fPendingAdjustPowerRequest helps to reduce redundant parent work. + // The fPendingAdjustPowerRequest helps to reduce redundant parent work. - if (!fAdjustPowerScheduled) - { + if (!fAdjustPowerScheduled) { IOPMRequest * request; request = acquirePMRequest( this, kIOPMRequestTypeAdjustPowerState ); - if (request) - { + if (request) { submitPMRequest( request ); fAdjustPowerScheduled = true; } } - return IOPMNoErr; + return IOPMNoErr; } //********************************************************************************* @@ -1140,32 +1094,32 @@ IOReturn IOService::removePowerChild ( IOPowerConnection * theNub ) // A driver has called us volunteering to control power to our device. //********************************************************************************* -IOReturn IOService::registerPowerDriver ( - IOService * powerDriver, - IOPMPowerState * powerStates, - unsigned long numberOfStates ) +IOReturn +IOService::registerPowerDriver( + IOService * powerDriver, + IOPMPowerState * powerStates, + unsigned long numberOfStates ) { - IOPMRequest * request; - IOPMPSEntry * powerStatesCopy = 0; + IOPMRequest * request; + IOPMPSEntry * powerStatesCopy = NULL; + IOPMPowerStateIndex stateOrder; + IOReturn error = kIOReturnSuccess; - if (!initialized) + if (!initialized) { return IOPMNotYetInitialized; + } - // Validate arguments. - if (!powerStates || (numberOfStates < 2)) - { + if (!powerStates || (numberOfStates < 2)) { OUR_PMLog(kPMLogControllingDriverErr5, numberOfStates, 0); return kIOReturnBadArgument; } - if (!powerDriver || !powerDriver->initialized) - { + if (!powerDriver || !powerDriver->initialized) { OUR_PMLog(kPMLogControllingDriverErr4, 0, 0); return kIOReturnBadArgument; } - if (powerStates[0].version != kIOPMPowerStateVersion1) - { + if (powerStates[0].version > kIOPMPowerStateVersion2) { OUR_PMLog(kPMLogControllingDriverErr1, powerStates[0].version, 0); return kIOReturnBadArgument; } @@ -1173,22 +1127,51 @@ IOReturn IOService::registerPowerDriver ( do { // Make a copy of the supplied power state array. powerStatesCopy = IONew(IOPMPSEntry, numberOfStates); - if (!powerStatesCopy) + if (!powerStatesCopy) { + error = kIOReturnNoMemory; break; + } + + // Initialize to bogus values + for (IOPMPowerStateIndex i = 0; i < numberOfStates; i++) { + powerStatesCopy[i].stateOrderToIndex = kIOPMPowerStateMax; + } - for (uint32_t i = 0; i < numberOfStates; i++) - { - powerStatesCopy[i].capabilityFlags = powerStates[i].capabilityFlags; - powerStatesCopy[i].outputPowerFlags = powerStates[i].outputPowerCharacter; - powerStatesCopy[i].inputPowerFlags = powerStates[i].inputPowerRequirement; - powerStatesCopy[i].staticPower = powerStates[i].staticPower; - powerStatesCopy[i].settleUpTime = powerStates[i].settleUpTime; - powerStatesCopy[i].settleDownTime = powerStates[i].settleDownTime; - } + for (uint32_t i = 0; i < numberOfStates; i++) { + powerStatesCopy[i].capabilityFlags = powerStates[i].capabilityFlags; + powerStatesCopy[i].outputPowerFlags = powerStates[i].outputPowerCharacter; + powerStatesCopy[i].inputPowerFlags = powerStates[i].inputPowerRequirement; + powerStatesCopy[i].staticPower = powerStates[i].staticPower; + powerStatesCopy[i].settleUpTime = powerStates[i].settleUpTime; + powerStatesCopy[i].settleDownTime = powerStates[i].settleDownTime; + if (powerStates[i].version >= kIOPMPowerStateVersion2) { + stateOrder = powerStates[i].stateOrder; + } else { + stateOrder = i; + } + + if (stateOrder < numberOfStates) { + powerStatesCopy[i].stateOrder = stateOrder; + powerStatesCopy[stateOrder].stateOrderToIndex = i; + } + } + + for (IOPMPowerStateIndex i = 0; i < numberOfStates; i++) { + if (powerStatesCopy[i].stateOrderToIndex == kIOPMPowerStateMax) { + // power state order missing + error = kIOReturnBadArgument; + break; + } + } + if (kIOReturnSuccess != error) { + break; + } request = acquirePMRequest( this, kIOPMRequestTypeRegisterPowerDriver ); - if (!request) + if (!request) { + error = kIOReturnNoMemory; break; + } powerDriver->retain(); request->fArg0 = (void *) powerDriver; @@ -1197,24 +1180,27 @@ IOReturn IOService::registerPowerDriver ( submitPMRequest( request ); return kIOReturnSuccess; - } - while (false); + }while (false); - if (powerStatesCopy) + if (powerStatesCopy) { IODelete(powerStatesCopy, IOPMPSEntry, numberOfStates); - return kIOReturnNoMemory; + } + + return error; } //********************************************************************************* // [private] handleRegisterPowerDriver //********************************************************************************* -void IOService::handleRegisterPowerDriver ( IOPMRequest * request ) +void +IOService::handleRegisterPowerDriver( IOPMRequest * request ) { IOService * powerDriver = (IOService *) request->fArg0; IOPMPSEntry * powerStates = (IOPMPSEntry *) request->fArg1; unsigned long numberOfStates = (unsigned long) request->fArg2; - unsigned long i; + unsigned long i, stateIndex; + unsigned long lowestPowerState; IOService * root; OSIterator * iter; @@ -1223,21 +1209,66 @@ void IOService::handleRegisterPowerDriver ( IOPMRequest * request ) assert(powerDriver); assert(numberOfStates > 1); - if ( !fNumberOfPowerStates ) - { + if (!fNumberOfPowerStates) { OUR_PMLog(kPMLogControllingDriver, - (unsigned long) numberOfStates, - (unsigned long) kIOPMPowerStateVersion1); + (unsigned long) numberOfStates, + (unsigned long) kIOPMPowerStateVersion1); - fPowerStates = powerStates; + fPowerStates = powerStates; fNumberOfPowerStates = numberOfStates; fControllingDriver = powerDriver; - fCurrentCapabilityFlags = fPowerStates[0].capabilityFlags; + fCurrentCapabilityFlags = fPowerStates[0].capabilityFlags; - // make a mask of all the character bits we know about - fOutputPowerCharacterFlags = 0; - for ( i = 0; i < numberOfStates; i++ ) { - fOutputPowerCharacterFlags |= fPowerStates[i].outputPowerFlags; + lowestPowerState = fPowerStates[0].stateOrderToIndex; + fHighestPowerState = fPowerStates[numberOfStates - 1].stateOrderToIndex; + +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + { + uint32_t aotFlags; + IOService * service; + OSObject * object; + OSData * data; + + // Disallow kIOPMAOTPower states unless device tree enabled + + aotFlags = 0; + service = this; + while (service && !service->inPlane(gIODTPlane)) { + service = service->getProvider(); + } + if (service) { + object = service->copyProperty(kIOPMAOTPowerKey, gIODTPlane); + data = OSDynamicCast(OSData, object); + if (data && (data->getLength() >= sizeof(uint32_t))) { + aotFlags = ((uint32_t *)data->getBytesNoCopy())[0]; + } + OSSafeReleaseNULL(object); + } + if (!aotFlags) { + for (i = 0; i < numberOfStates; i++) { + if (kIOPMAOTPower & fPowerStates[i].inputPowerFlags) { + fPowerStates[i].inputPowerFlags = 0xFFFFFFFF; + fPowerStates[i].capabilityFlags = 0; + fPowerStates[i].outputPowerFlags = 0; + } + } + } + } +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + + // OR'in all the output power flags + fMergedOutputPowerFlags = 0; + fDeviceUsablePowerState = lowestPowerState; + for (i = 0; i < numberOfStates; i++) { + fMergedOutputPowerFlags |= fPowerStates[i].outputPowerFlags; + + stateIndex = fPowerStates[i].stateOrderToIndex; + assert(stateIndex < numberOfStates); + if ((fDeviceUsablePowerState == lowestPowerState) && + (fPowerStates[stateIndex].capabilityFlags & IOPMDeviceUsable)) { + // The minimum power state that the device is usable + fDeviceUsablePowerState = stateIndex; + } } // Register powerDriver as interested, unless already done. @@ -1248,17 +1279,15 @@ void IOService::handleRegisterPowerDriver ( IOPMRequest * request ) root = getPlatform()->getProvider(); assert(root); if (!root || - ((OSMemberFunctionCast(void (*)(void), - root, &IOService::powerStateDidChangeTo)) != - ((OSMemberFunctionCast(void (*)(void), - this, &IOService::powerStateDidChangeTo)))) || - ((OSMemberFunctionCast(void (*)(void), - root, &IOService::powerStateWillChangeTo)) != - ((OSMemberFunctionCast(void (*)(void), - this, &IOService::powerStateWillChangeTo))))) - { - if (fInterestedDrivers->findItem(powerDriver) == NULL) - { + ((OSMemberFunctionCast(void (*)(void), + root, &IOService::powerStateDidChangeTo)) != + ((OSMemberFunctionCast(void (*)(void), + this, &IOService::powerStateDidChangeTo)))) || + ((OSMemberFunctionCast(void (*)(void), + root, &IOService::powerStateWillChangeTo)) != + ((OSMemberFunctionCast(void (*)(void), + this, &IOService::powerStateWillChangeTo))))) { + if (fInterestedDrivers->findItem(powerDriver) == NULL) { PM_LOCK(); fInterestedDrivers->appendNewInformee(powerDriver); PM_UNLOCK(); @@ -1267,37 +1296,28 @@ void IOService::handleRegisterPowerDriver ( IOPMRequest * request ) // Examine all existing power clients and perform limit check. - if (fPowerClients) - { - iter = OSCollectionIterator::withCollection(fPowerClients); - if (iter) - { - const OSSymbol * client; - while ((client = (const OSSymbol *) iter->getNextObject())) - { - uint32_t powerState = getPowerStateForClient(client); - if (powerState >= numberOfStates) - { - updatePowerClient(client, numberOfStates - 1); - } - } - iter->release(); - } - } - - if ( inPlane(gIOPowerPlane) && fParentsKnowState ) - { - unsigned long tempDesire; + if (fPowerClients && + (iter = OSCollectionIterator::withCollection(fPowerClients))) { + const OSSymbol * client; + while ((client = (const OSSymbol *) iter->getNextObject())) { + IOPMPowerStateIndex powerState = getPowerStateForClient(client); + if (powerState >= numberOfStates) { + updatePowerClient(client, fHighestPowerState); + } + } + iter->release(); + } + + if (inPlane(gIOPowerPlane) && fParentsKnowState) { + IOPMPowerStateIndex tempDesire; fMaxPowerState = fControllingDriver->maxCapabilityForDomainState(fParentsCurrentPowerFlags); // initially change into the state we are already in tempDesire = fControllingDriver->initialPowerStateForDomainState(fParentsCurrentPowerFlags); adjustPowerState(tempDesire); } - } - else - { + } else { OUR_PMLog(kPMLogControllingDriverErr2, numberOfStates, 0); - IODelete(powerStates, IOPMPSEntry, numberOfStates); + IODelete(powerStates, IOPMPSEntry, numberOfStates); } powerDriver->release(); @@ -1312,84 +1332,93 @@ void IOService::handleRegisterPowerDriver ( IOPMRequest * request ) // out what the current power state of the device is. //********************************************************************************* -IOPMPowerFlags IOService::registerInterestedDriver ( IOService * driver ) +IOPMPowerFlags +IOService::registerInterestedDriver( IOService * driver ) { - IOPMRequest * request; - bool signal; + IOPMRequest * request; + bool signal; - if (!driver || !initialized || !fInterestedDrivers) - return 0; + if (!driver || !initialized || !fInterestedDrivers) { + return 0; + } - PM_LOCK(); - signal = (!fInsertInterestSet && !fRemoveInterestSet); - if (fInsertInterestSet == NULL) - fInsertInterestSet = OSSet::withCapacity(4); - if (fInsertInterestSet) - { - fInsertInterestSet->setObject(driver); - if (fRemoveInterestSet) - fRemoveInterestSet->removeObject(driver); - } - PM_UNLOCK(); + PM_LOCK(); + signal = (!fInsertInterestSet && !fRemoveInterestSet); + if (fInsertInterestSet == NULL) { + fInsertInterestSet = OSSet::withCapacity(4); + } + if (fInsertInterestSet) { + fInsertInterestSet->setObject(driver); + if (fRemoveInterestSet) { + fRemoveInterestSet->removeObject(driver); + } + } + PM_UNLOCK(); - if (signal) - { - request = acquirePMRequest( this, kIOPMRequestTypeInterestChanged ); - if (request) - submitPMRequest( request ); - } + if (signal) { + request = acquirePMRequest( this, kIOPMRequestTypeInterestChanged ); + if (request) { + submitPMRequest( request ); + } + } - // This return value cannot be trusted, but return a value - // for those clients that care. + // This return value cannot be trusted, but return a value + // for those clients that care. - OUR_PMLog(kPMLogInterestedDriver, kIOPMDeviceUsable, 2); - return kIOPMDeviceUsable; + OUR_PMLog(kPMLogInterestedDriver, kIOPMDeviceUsable, 2); + return kIOPMDeviceUsable; } //********************************************************************************* // [public] deRegisterInterestedDriver //********************************************************************************* -IOReturn IOService::deRegisterInterestedDriver ( IOService * driver ) +IOReturn +IOService::deRegisterInterestedDriver( IOService * driver ) { - IOPMinformeeList * list; - IOPMinformee * item; - IOPMRequest * request; - bool signal; + IOPMinformee * item; + IOPMRequest * request; + bool signal; + + if (!driver) { + return kIOReturnBadArgument; + } + if (!initialized || !fInterestedDrivers) { + return IOPMNotPowerManaged; + } - if (!driver) - return kIOReturnBadArgument; - if (!initialized || !fInterestedDrivers) - return IOPMNotPowerManaged; + PM_LOCK(); + if (fInsertInterestSet) { + fInsertInterestSet->removeObject(driver); + } - PM_LOCK(); - signal = (!fRemoveInterestSet && !fInsertInterestSet); - if (fRemoveInterestSet == NULL) - fRemoveInterestSet = OSSet::withCapacity(4); - if (fRemoveInterestSet) - { - fRemoveInterestSet->setObject(driver); - if (fInsertInterestSet) - fInsertInterestSet->removeObject(driver); + item = fInterestedDrivers->findItem(driver); + if (!item) { + PM_UNLOCK(); + return kIOReturnNotFound; + } - list = fInterestedDrivers; - item = list->findItem(driver); - if (item && item->active) - { - item->active = false; - waitForPMDriverCall( driver ); - } - } - PM_UNLOCK(); + signal = (!fRemoveInterestSet && !fInsertInterestSet); + if (fRemoveInterestSet == NULL) { + fRemoveInterestSet = OSSet::withCapacity(4); + } + if (fRemoveInterestSet) { + fRemoveInterestSet->setObject(driver); + if (item->active) { + item->active = false; + waitForPMDriverCall( driver ); + } + } + PM_UNLOCK(); - if (signal) - { - request = acquirePMRequest( this, kIOPMRequestTypeInterestChanged ); - if (request) - submitPMRequest( request ); - } + if (signal) { + request = acquirePMRequest( this, kIOPMRequestTypeInterestChanged ); + if (request) { + submitPMRequest( request ); + } + } - return IOPMNoErr; + return IOPMNoErr; } //********************************************************************************* @@ -1398,50 +1427,44 @@ IOReturn IOService::deRegisterInterestedDriver ( IOService * driver ) // Handle interest added or removed. //********************************************************************************* -void IOService::handleInterestChanged( IOPMRequest * request ) -{ - IOService * driver; - IOPMinformee * informee; - IOPMinformeeList * list = fInterestedDrivers; - - PM_LOCK(); - - if (fInsertInterestSet) - { - while ((driver = (IOService *) fInsertInterestSet->getAnyObject())) - { - if (list->findItem(driver) == NULL) - { - informee = list->appendNewInformee(driver); - } - fInsertInterestSet->removeObject(driver); - } - fInsertInterestSet->release(); - fInsertInterestSet = 0; - } - - if (fRemoveInterestSet) - { - while ((driver = (IOService *) fRemoveInterestSet->getAnyObject())) - { - informee = list->findItem(driver); - if (informee) - { - // Clean-up async interest acknowledgement - if (fHeadNotePendingAcks && informee->timer) - { - informee->timer = 0; - fHeadNotePendingAcks--; - } - list->removeFromList(driver); - } - fRemoveInterestSet->removeObject(driver); - } - fRemoveInterestSet->release(); - fRemoveInterestSet = 0; - } - - PM_UNLOCK(); +void +IOService::handleInterestChanged( IOPMRequest * request ) +{ + IOService * driver; + IOPMinformee * informee; + IOPMinformeeList * list = fInterestedDrivers; + + PM_LOCK(); + + if (fInsertInterestSet) { + while ((driver = (IOService *) fInsertInterestSet->getAnyObject())) { + if (list->findItem(driver) == NULL) { + informee = list->appendNewInformee(driver); + } + fInsertInterestSet->removeObject(driver); + } + fInsertInterestSet->release(); + fInsertInterestSet = NULL; + } + + if (fRemoveInterestSet) { + while ((driver = (IOService *) fRemoveInterestSet->getAnyObject())) { + informee = list->findItem(driver); + if (informee) { + // Clean-up async interest acknowledgement + if (fHeadNotePendingAcks && informee->timer) { + informee->timer = 0; + fHeadNotePendingAcks--; + } + list->removeFromList(driver); + } + fRemoveInterestSet->removeObject(driver); + } + fRemoveInterestSet->release(); + fRemoveInterestSet = NULL; + } + + PM_UNLOCK(); } //********************************************************************************* @@ -1458,143 +1481,125 @@ void IOService::handleInterestChanged( IOPMRequest * request ) // of a "current change note".) //********************************************************************************* -IOReturn IOService::acknowledgePowerChange ( IOService * whichObject ) +IOReturn +IOService::acknowledgePowerChange( IOService * whichObject ) { IOPMRequest * request; - if (!initialized) + if (!initialized) { return IOPMNotYetInitialized; - if (!whichObject) + } + if (!whichObject) { return kIOReturnBadArgument; + } request = acquirePMRequest( this, kIOPMRequestTypeAckPowerChange ); - if (!request) + if (!request) { return kIOReturnNoMemory; + } whichObject->retain(); request->fArg0 = whichObject; submitPMRequest( request ); - return IOPMNoErr; + return IOPMNoErr; } //********************************************************************************* // [private] handleAcknowledgePowerChange //********************************************************************************* -bool IOService::handleAcknowledgePowerChange ( IOPMRequest * request ) +bool +IOService::handleAcknowledgePowerChange( IOPMRequest * request ) { - IOPMinformee * informee; - unsigned long childPower = kIOPMUnknown; - IOService * theChild; - IOService * whichObject; - bool all_acked = false; + IOPMinformee * informee; + unsigned long childPower = kIOPMUnknown; + IOService * theChild; + IOService * whichObject; + bool all_acked = false; PM_ASSERT_IN_GATE(); whichObject = (IOService *) request->fArg0; assert(whichObject); - // one of our interested drivers? + // one of our interested drivers? informee = fInterestedDrivers->findItem( whichObject ); - if ( informee == NULL ) - { - if ( !isChild(whichObject, gIOPowerPlane) ) - { + if (informee == NULL) { + if (!isChild(whichObject, gIOPowerPlane)) { OUR_PMLog(kPMLogAcknowledgeErr1, 0, 0); goto no_err; - } else { - OUR_PMLog(kPMLogChildAcknowledge, fHeadNotePendingAcks, 0); - } - } else { - OUR_PMLog(kPMLogDriverAcknowledge, fHeadNotePendingAcks, 0); - } - - if ( fHeadNotePendingAcks != 0 ) - { - assert(fPowerStates != NULL); - - // yes, make sure we're expecting acks - if ( informee != NULL ) - { - // it's an interested driver - // make sure we're expecting this ack - if ( informee->timer != 0 ) - { -#if LOG_SETPOWER_TIMES - if (informee->timer > 0) - { - uint64_t nsec = computeTimeDeltaNS(&informee->startTime); - if (nsec > LOG_SETPOWER_TIMES) - PM_LOG("%s::powerState%sChangeTo(%p, %s, %lu -> %lu) async took %d ms\n", - informee->whatObject->getName(), - (fDriverCallReason == kDriverCallInformPreChange) ? "Will" : "Did", - informee->whatObject, - fName, fCurrentPowerState, fHeadNotePowerState, NS_TO_US(nsec)); - - uint16_t logType = (fDriverCallReason == kDriverCallInformPreChange) - ? kIOPMEventTypePSWillChangeTo - : kIOPMEventTypePSDidChangeTo; - - PMEventDetails *details = PMEventDetails::eventDetails( - logType, - fName, - (uintptr_t)this, - informee->whatObject->getName(), - 0, 0, 0, - NS_TO_MS(nsec)); - - getPMRootDomain()->recordAndReleasePMEventGated( details ); - } -#endif - // mark it acked - informee->timer = 0; - // that's one fewer to worry about - fHeadNotePendingAcks--; - } else { - // this driver has already acked - OUR_PMLog(kPMLogAcknowledgeErr2, 0, 0); - } - } else { - // it's a child - // make sure we're expecting this ack - if ( ((IOPowerConnection *)whichObject)->getAwaitingAck() ) - { - // that's one fewer to worry about - fHeadNotePendingAcks--; - ((IOPowerConnection *)whichObject)->setAwaitingAck(false); - theChild = (IOService *)whichObject->copyChildEntry(gIOPowerPlane); - if ( theChild ) - { - childPower = theChild->currentPowerConsumption(); - theChild->release(); - } - if ( childPower == kIOPMUnknown ) - { - fHeadNotePowerArrayEntry->staticPower = kIOPMUnknown; - } else { - if (fHeadNotePowerArrayEntry->staticPower != kIOPMUnknown) - { - fHeadNotePowerArrayEntry->staticPower += childPower; - } - } - } - } - - if ( fHeadNotePendingAcks == 0 ) { + } else { + OUR_PMLog(kPMLogChildAcknowledge, fHeadNotePendingAcks, 0); + } + } else { + OUR_PMLog(kPMLogDriverAcknowledge, fHeadNotePendingAcks, 0); + } + + if (fHeadNotePendingAcks != 0) { + assert(fPowerStates != NULL); + + // yes, make sure we're expecting acks + if (informee != NULL) { + // it's an interested driver + // make sure we're expecting this ack + if (informee->timer != 0) { + if (informee->timer > 0) { + uint64_t nsec = computeTimeDeltaNS(&informee->startTime); + if (nsec > LOG_SETPOWER_TIMES) { + getPMRootDomain()->pmStatsRecordApplicationResponse( + gIOPMStatsDriverPSChangeSlow, informee->whatObject->getName(), + fDriverCallReason, NS_TO_MS(nsec), informee->whatObject->getRegistryEntryID(), + NULL, fHeadNotePowerState); + } + } + + // mark it acked + informee->timer = 0; + // that's one fewer to worry about + fHeadNotePendingAcks--; + } else { + // this driver has already acked + OUR_PMLog(kPMLogAcknowledgeErr2, 0, 0); + } + } else { + // it's a child + // make sure we're expecting this ack + if (((IOPowerConnection *)whichObject)->getAwaitingAck()) { + // that's one fewer to worry about + fHeadNotePendingAcks--; + ((IOPowerConnection *)whichObject)->setAwaitingAck(false); + theChild = (IOService *)whichObject->copyChildEntry(gIOPowerPlane); + if (theChild) { + childPower = theChild->currentPowerConsumption(); + theChild->release(); + } + if (childPower == kIOPMUnknown) { + fHeadNotePowerArrayEntry->staticPower = kIOPMUnknown; + } else { + if (fHeadNotePowerArrayEntry->staticPower != kIOPMUnknown) { + fHeadNotePowerArrayEntry->staticPower += childPower; + } + } + } + } + + if (fHeadNotePendingAcks == 0) { // yes, stop the timer stop_ack_timer(); // and now we can continue all_acked = true; + getPMRootDomain()->reset_watchdog_timer(this, 0); } - } else { - OUR_PMLog(kPMLogAcknowledgeErr3, 0, 0); // not expecting anybody to ack - } + } else { + OUR_PMLog(kPMLogAcknowledgeErr3, 0, 0); // not expecting anybody to ack + } no_err: - if (whichObject) + if (whichObject) { whichObject->release(); + } - return all_acked; + return all_acked; } //********************************************************************************* @@ -1605,16 +1610,19 @@ no_err: // We continue to process the power state change. //********************************************************************************* -IOReturn IOService::acknowledgeSetPowerState ( void ) +IOReturn +IOService::acknowledgeSetPowerState( void ) { IOPMRequest * request; - if (!initialized) + if (!initialized) { return IOPMNotYetInitialized; + } request = acquirePMRequest( this, kIOPMRequestTypeAckSetPowerState ); - if (!request) + if (!request) { return kIOReturnNoMemory; + } submitPMRequest( request ); return kIOReturnSuccess; @@ -1624,27 +1632,28 @@ IOReturn IOService::acknowledgeSetPowerState ( void ) // [private] adjustPowerState //********************************************************************************* -void IOService::adjustPowerState ( uint32_t clamp ) +void +IOService::adjustPowerState( uint32_t clamp ) { PM_ASSERT_IN_GATE(); - computeDesiredState(clamp); - if (fControllingDriver && fParentsKnowState && inPlane(gIOPowerPlane)) - { - IOPMPowerChangeFlags changeFlags = kIOPMSelfInitiated; + computeDesiredState(clamp, false); + if (fControllingDriver && fParentsKnowState && inPlane(gIOPowerPlane)) { + IOPMPowerChangeFlags changeFlags = kIOPMSelfInitiated; - // Indicate that children desires were ignored, and do not ask - // apps for permission to drop power. This is used by root domain - // for demand sleep. + // Indicate that children desires must be ignored, and do not ask + // apps for permission to drop power. This is used by root domain + // for demand sleep. - if (getPMRequestType() == kIOPMRequestTypeRequestPowerStateOverride) - changeFlags |= (kIOPMIgnoreChildren | kIOPMSkipAskPowerDown); + if (getPMRequestType() == kIOPMRequestTypeRequestPowerStateOverride) { + changeFlags |= (kIOPMIgnoreChildren | kIOPMSkipAskPowerDown); + } startPowerChange( - /* flags */ changeFlags, - /* power state */ fDesiredPowerState, - /* domain flags */ 0, - /* connection */ 0, - /* parent flags */ 0); + /* flags */ changeFlags, + /* power state */ fDesiredPowerState, + /* domain flags */ 0, + /* connection */ NULL, + /* parent flags */ 0); } } @@ -1652,71 +1661,84 @@ void IOService::adjustPowerState ( uint32_t clamp ) // [public] synchronizePowerTree //********************************************************************************* -IOReturn IOService::synchronizePowerTree ( - IOOptionBits options, - IOService * notifyRoot ) +IOReturn +IOService::synchronizePowerTree( + IOOptionBits options, + IOService * notifyRoot ) { - IOPMRequest * request_c = 0; - IOPMRequest * request_s; + IOPMRequest * request_c = NULL; + IOPMRequest * request_s; - if (this != getPMRootDomain()) - return kIOReturnBadArgument; - if (!initialized) + if (this != getPMRootDomain()) { + return kIOReturnBadArgument; + } + if (!initialized) { return kIOPMNotYetInitialized; + } + + OUR_PMLog(kPMLogCSynchronizePowerTree, options, (notifyRoot != NULL)); + + if (notifyRoot) { + IOPMRequest * nr; + + // Cancels don't need to be synchronized. + nr = acquirePMRequest(notifyRoot, kIOPMRequestTypeChildNotifyDelayCancel); + if (nr) { + submitPMRequest(nr); + } + nr = acquirePMRequest(getPMRootDomain(), kIOPMRequestTypeChildNotifyDelayCancel); + if (nr) { + submitPMRequest(nr); + } + } + + request_s = acquirePMRequest( this, kIOPMRequestTypeSynchronizePowerTree ); + if (!request_s) { + goto error_no_memory; + } + + if (options & kIOPMSyncCancelPowerDown) { + request_c = acquirePMRequest( this, kIOPMRequestTypeIdleCancel ); + } + if (request_c) { + request_c->attachNextRequest( request_s ); + submitPMRequest(request_c); + } + + request_s->fArg0 = (void *)(uintptr_t) options; + submitPMRequest(request_s); - if (notifyRoot) - { - IOPMRequest * nr; - - // Cancels don't need to be synchronized. - nr = acquirePMRequest(notifyRoot, kIOPMRequestTypeChildNotifyDelayCancel); - if (nr) submitPMRequest(nr); - nr = acquirePMRequest(getPMRootDomain(), kIOPMRequestTypeChildNotifyDelayCancel); - if (nr) submitPMRequest(nr); - } - - request_s = acquirePMRequest( this, kIOPMRequestTypeSynchronizePowerTree ); - if (!request_s) - goto error_no_memory; - - if (options & kIOPMSyncCancelPowerDown) - request_c = acquirePMRequest( this, kIOPMRequestTypeIdleCancel ); - if (request_c) - { - request_c->attachNextRequest( request_s ); - submitPMRequest(request_c); - } - - request_s->fArg0 = (void *)(uintptr_t) options; - submitPMRequest(request_s); - - return kIOReturnSuccess; + return kIOReturnSuccess; error_no_memory: - if (request_c) releasePMRequest(request_c); - if (request_s) releasePMRequest(request_s); - return kIOReturnNoMemory; + if (request_c) { + releasePMRequest(request_c); + } + if (request_s) { + releasePMRequest(request_s); + } + return kIOReturnNoMemory; } //********************************************************************************* // [private] handleSynchronizePowerTree //********************************************************************************* -void IOService::handleSynchronizePowerTree ( IOPMRequest * request ) +void +IOService::handleSynchronizePowerTree( IOPMRequest * request ) { PM_ASSERT_IN_GATE(); if (fControllingDriver && fParentsKnowState && inPlane(gIOPowerPlane) && - (fCurrentPowerState == fNumberOfPowerStates - 1)) - { - IOOptionBits options = (uintptr_t) request->fArg0; + (fCurrentPowerState == fHighestPowerState)) { + IOOptionBits options = (uintptr_t) request->fArg0; startPowerChange( - /* flags */ kIOPMSelfInitiated | kIOPMSynchronize | - (options & kIOPMSyncNoChildNotify), - /* power state */ fCurrentPowerState, - /* domain flags */ 0, - /* connection */ 0, - /* parent flags */ 0); + /* flags */ kIOPMSelfInitiated | kIOPMSynchronize | + (options & kIOPMSyncNoChildNotify), + /* power state */ fCurrentPowerState, + /* domain flags */ 0, + /* connection */ NULL, + /* parent flags */ 0); } } @@ -1731,9 +1753,10 @@ void IOService::handleSynchronizePowerTree ( IOPMRequest * request ) // kind of change is occuring in the domain. //********************************************************************************* -IOReturn IOService::powerDomainWillChangeTo ( - IOPMPowerFlags newPowerFlags, - IOPowerConnection * whichParent ) +IOReturn +IOService::powerDomainWillChangeTo( + IOPMPowerFlags newPowerFlags, + IOPowerConnection * whichParent ) { assert(false); return kIOReturnUnsupported; @@ -1744,77 +1767,83 @@ IOReturn IOService::powerDomainWillChangeTo ( // [private] handlePowerDomainWillChangeTo //********************************************************************************* -void IOService::handlePowerDomainWillChangeTo ( IOPMRequest * request ) -{ - IOPMPowerFlags parentPowerFlags = (IOPMPowerFlags) request->fArg0; - IOPowerConnection * whichParent = (IOPowerConnection *) request->fArg1; - IOPMPowerChangeFlags parentChangeFlags = (IOPMPowerChangeFlags)(uintptr_t) request->fArg2; - IOPMPowerChangeFlags myChangeFlags; - OSIterator * iter; - OSObject * next; - IOPowerConnection * connection; - IOPMPowerStateIndex newPowerState; - IOPMPowerFlags combinedPowerFlags; - bool savedParentsKnowState; - IOReturn result = IOPMAckImplied; +void +IOService::handlePowerDomainWillChangeTo( IOPMRequest * request ) +{ + IOPMPowerFlags parentPowerFlags = (IOPMPowerFlags) request->fArg0; + IOPowerConnection * whichParent = (IOPowerConnection *) request->fArg1; + IOPMPowerChangeFlags parentChangeFlags = (IOPMPowerChangeFlags)(uintptr_t) request->fArg2; + IOPMPowerChangeFlags myChangeFlags; + OSIterator * iter; + OSObject * next; + IOPowerConnection * connection; + IOPMPowerStateIndex maxPowerState; + IOPMPowerFlags combinedPowerFlags; + bool savedParentsKnowState; + IOReturn result = IOPMAckImplied; PM_ASSERT_IN_GATE(); - OUR_PMLog(kPMLogWillChange, parentPowerFlags, 0); + OUR_PMLog(kPMLogWillChange, parentPowerFlags, 0); - if (!inPlane(gIOPowerPlane) || !whichParent || !whichParent->getAwaitingAck()) - { + if (!inPlane(gIOPowerPlane) || !whichParent || !whichParent->getAwaitingAck()) { PM_LOG("%s::%s not in power tree\n", getName(), __FUNCTION__); - goto exit_no_ack; + goto exit_no_ack; } savedParentsKnowState = fParentsKnowState; - // Combine parents' output power flags. + // Combine parents' output power flags. combinedPowerFlags = 0; - iter = getParentIterator(gIOPowerPlane); - if ( iter ) - { - while ( (next = iter->getNextObject()) ) - { - if ( (connection = OSDynamicCast(IOPowerConnection, next)) ) - { - if ( connection == whichParent ) - combinedPowerFlags |= parentPowerFlags; - else - combinedPowerFlags |= connection->parentCurrentPowerFlags(); - } - } - iter->release(); - } - - // If our initial change has yet to occur, then defer the power change - // until after the power domain has completed its power transition. - - if ( fControllingDriver && !fInitialPowerChange ) - { - newPowerState = fControllingDriver->maxCapabilityForDomainState( - combinedPowerFlags); - - // Absorb parent's kIOPMSynchronize flag. - myChangeFlags = kIOPMParentInitiated | kIOPMDomainWillChange | - (parentChangeFlags & kIOPMSynchronize); + iter = getParentIterator(gIOPowerPlane); + if (iter) { + while ((next = iter->getNextObject())) { + if ((connection = OSDynamicCast(IOPowerConnection, next))) { + if (connection == whichParent) { + combinedPowerFlags |= parentPowerFlags; + } else { + combinedPowerFlags |= connection->parentCurrentPowerFlags(); + } + } + } + iter->release(); + } + + // If our initial change has yet to occur, then defer the power change + // until after the power domain has completed its power transition. + + if (fControllingDriver && !fInitialPowerChange) { + maxPowerState = fControllingDriver->maxCapabilityForDomainState( + combinedPowerFlags); + + if (parentChangeFlags & kIOPMDomainPowerDrop) { + // fMaxPowerState set a limit on self-initiated power changes. + // Update it before a parent power drop. + fMaxPowerState = maxPowerState; + } + + // Use kIOPMSynchronize below instead of kIOPMRootBroadcastFlags + // to avoid propagating the root change flags if any service must + // change power state due to root's will-change notification. + // Root does not change power state for kIOPMSynchronize. + + myChangeFlags = kIOPMParentInitiated | kIOPMDomainWillChange | + (parentChangeFlags & kIOPMSynchronize); result = startPowerChange( - /* flags */ myChangeFlags, - /* power state */ newPowerState, - /* domain flags */ combinedPowerFlags, - /* connection */ whichParent, - /* parent flags */ parentPowerFlags); + /* flags */ myChangeFlags, + /* power state */ maxPowerState, + /* domain flags */ combinedPowerFlags, + /* connection */ whichParent, + /* parent flags */ parentPowerFlags); } // If parent is dropping power, immediately update the parent's // capability flags. Any future merging of parent(s) combined // power flags should account for this power drop. - if (parentChangeFlags & kIOPMDomainPowerDrop) - { + if (parentChangeFlags & kIOPMDomainPowerDrop) { setParentInfo(parentPowerFlags, whichParent, true); } @@ -1822,21 +1851,21 @@ void IOService::handlePowerDomainWillChangeTo ( IOPMRequest * request ) // transition, i.e. startPowerChange() returned IOPMAckImplied. We are // still required to issue an ACK to our parent. - if (IOPMAckImplied == result) - { + if (IOPMAckImplied == result) { IOService * parent; parent = (IOService *) whichParent->copyParentEntry(gIOPowerPlane); assert(parent); - if ( parent ) - { + if (parent) { parent->acknowledgePowerChange( whichParent ); parent->release(); } } exit_no_ack: - // Drop the retain from notifyChild(). - if (whichParent) whichParent->release(); + // Drop the retain from notifyChild(). + if (whichParent) { + whichParent->release(); + } } #ifndef __LP64__ @@ -1850,9 +1879,10 @@ exit_no_ack: // kind of change is occuring in the domain. //********************************************************************************* -IOReturn IOService::powerDomainDidChangeTo ( - IOPMPowerFlags newPowerFlags, - IOPowerConnection * whichParent ) +IOReturn +IOService::powerDomainDidChangeTo( + IOPMPowerFlags newPowerFlags, + IOPowerConnection * whichParent ) { assert(false); return kIOReturnUnsupported; @@ -1863,83 +1893,132 @@ IOReturn IOService::powerDomainDidChangeTo ( // [private] handlePowerDomainDidChangeTo //********************************************************************************* -void IOService::handlePowerDomainDidChangeTo ( IOPMRequest * request ) -{ - IOPMPowerFlags parentPowerFlags = (IOPMPowerFlags) request->fArg0; - IOPowerConnection * whichParent = (IOPowerConnection *) request->fArg1; - IOPMPowerChangeFlags parentChangeFlags = (IOPMPowerChangeFlags)(uintptr_t) request->fArg2; - IOPMPowerChangeFlags myChangeFlags; - IOPMPowerStateIndex newPowerState; - IOPMPowerStateIndex initialDesire; - bool savedParentsKnowState; - IOReturn result = IOPMAckImplied; +void +IOService::handlePowerDomainDidChangeTo( IOPMRequest * request ) +{ + IOPMPowerFlags parentPowerFlags = (IOPMPowerFlags) request->fArg0; + IOPowerConnection * whichParent = (IOPowerConnection *) request->fArg1; + IOPMPowerChangeFlags parentChangeFlags = (IOPMPowerChangeFlags)(uintptr_t) request->fArg2; + IOPMPowerChangeFlags myChangeFlags; + IOPMPowerStateIndex maxPowerState; + IOPMPowerStateIndex initialDesire = kPowerStateZero; + bool computeDesire = false; + bool desireChanged = false; + bool savedParentsKnowState; + IOReturn result = IOPMAckImplied; PM_ASSERT_IN_GATE(); - OUR_PMLog(kPMLogDidChange, parentPowerFlags, 0); + OUR_PMLog(kPMLogDidChange, parentPowerFlags, 0); - if (!inPlane(gIOPowerPlane) || !whichParent || !whichParent->getAwaitingAck()) - { + if (!inPlane(gIOPowerPlane) || !whichParent || !whichParent->getAwaitingAck()) { PM_LOG("%s::%s not in power tree\n", getName(), __FUNCTION__); - goto exit_no_ack; + goto exit_no_ack; } savedParentsKnowState = fParentsKnowState; - setParentInfo(parentPowerFlags, whichParent, true); + setParentInfo(parentPowerFlags, whichParent, true); - if ( fControllingDriver ) - { - newPowerState = fControllingDriver->maxCapabilityForDomainState( - fParentsCurrentPowerFlags); + if (fControllingDriver) { + maxPowerState = fControllingDriver->maxCapabilityForDomainState( + fParentsCurrentPowerFlags); + + if ((parentChangeFlags & kIOPMDomainPowerDrop) == 0) { + // fMaxPowerState set a limit on self-initiated power changes. + // Update it after a parent power rise. + fMaxPowerState = maxPowerState; + } + + if (fInitialPowerChange) { + computeDesire = true; + initialDesire = fControllingDriver->initialPowerStateForDomainState( + fParentsCurrentPowerFlags); + } else if (parentChangeFlags & kIOPMRootChangeUp) { + if (fAdvisoryTickleUsed) { + // On system wake, re-compute the desired power state since + // gIOPMAdvisoryTickleEnabled will change for a full wake, + // which is an input to computeDesiredState(). This is not + // necessary for a dark wake because powerChangeDone() will + // handle the dark to full wake case, but it does no harm. + + desireChanged = true; + } + + if (fResetPowerStateOnWake) { + // Query the driver for the desired power state on system wake. + // Default implementation returns the lowest power state. + + IOPMPowerStateIndex wakePowerState = + fControllingDriver->initialPowerStateForDomainState( + kIOPMRootDomainState | kIOPMPowerOn ); + + // fDesiredPowerState was adjusted before going to sleep + // with fDeviceDesire at min. + + if (StateOrder(wakePowerState) > StateOrder(fDesiredPowerState)) { + // Must schedule a power adjustment if we changed the + // device desire. That will update the desired domain + // power on the parent power connection and ping the + // power parent if necessary. + + updatePowerClient(gIOPMPowerClientDevice, wakePowerState); + desireChanged = true; + } + } + } + + if (computeDesire || desireChanged) { + computeDesiredState(initialDesire, false); + } - if (fInitialPowerChange) - { - initialDesire = fControllingDriver->initialPowerStateForDomainState( - fParentsCurrentPowerFlags); - computeDesiredState(initialDesire); - } + // Absorb and propagate parent's broadcast flags + myChangeFlags = kIOPMParentInitiated | kIOPMDomainDidChange | + (parentChangeFlags & kIOPMRootBroadcastFlags); - // Absorb parent's kIOPMSynchronize flag. - myChangeFlags = kIOPMParentInitiated | kIOPMDomainDidChange | - (parentChangeFlags & kIOPMSynchronize); +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + if (kIOPMAOTPower & fPowerStates[maxPowerState].inputPowerFlags) { + IOLog("aotPS %s0x%qx[%ld]\n", getName(), getRegistryEntryID(), maxPowerState); + } +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ result = startPowerChange( - /* flags */ myChangeFlags, - /* power state */ newPowerState, - /* domain flags */ fParentsCurrentPowerFlags, - /* connection */ whichParent, - /* parent flags */ 0); + /* flags */ myChangeFlags, + /* power state */ maxPowerState, + /* domain flags */ fParentsCurrentPowerFlags, + /* connection */ whichParent, + /* parent flags */ 0); } // Parent is expecting an ACK from us. If we did not embark on a state // transition, i.e. startPowerChange() returned IOPMAckImplied. We are // still required to issue an ACK to our parent. - if (IOPMAckImplied == result) - { + if (IOPMAckImplied == result) { IOService * parent; parent = (IOService *) whichParent->copyParentEntry(gIOPowerPlane); assert(parent); - if ( parent ) - { + if (parent) { parent->acknowledgePowerChange( whichParent ); parent->release(); } } // If the parent registers its power driver late, then this is the - // first opportunity to tell our parent about our desire. + // first opportunity to tell our parent about our desire. Or if the + // child's desire changed during a parent change notify. - if (!savedParentsKnowState && fParentsKnowState) - { - PM_LOG1("%s::powerDomainDidChangeTo parentsKnowState = true\n", - getName()); + if (fControllingDriver && + ((!savedParentsKnowState && fParentsKnowState) || desireChanged)) { + PM_LOG1("%s::powerDomainDidChangeTo parentsKnowState %d\n", + getName(), fParentsKnowState); requestDomainPower( fDesiredPowerState ); } exit_no_ack: - // Drop the retain from notifyChild(). - if (whichParent) whichParent->release(); + // Drop the retain from notifyChild(). + if (whichParent) { + whichParent->release(); + } } //********************************************************************************* @@ -1948,100 +2027,83 @@ exit_no_ack: // Set our connection data for one specific parent, and then combine all the parent // data together. //********************************************************************************* - -void IOService::setParentInfo ( - IOPMPowerFlags newPowerFlags, + +void +IOService::setParentInfo( + IOPMPowerFlags newPowerFlags, IOPowerConnection * whichParent, - bool knowsState ) + bool knowsState ) { - OSIterator * iter; - OSObject * next; - IOPowerConnection * conn; + OSIterator * iter; + OSObject * next; + IOPowerConnection * conn; PM_ASSERT_IN_GATE(); - // set our connection data - whichParent->setParentCurrentPowerFlags(newPowerFlags); - whichParent->setParentKnowsState(knowsState); - - // recompute our parent info - fParentsCurrentPowerFlags = 0; - fParentsKnowState = true; - - iter = getParentIterator(gIOPowerPlane); - if ( iter ) - { - while ( (next = iter->getNextObject()) ) - { - if ( (conn = OSDynamicCast(IOPowerConnection, next)) ) - { - fParentsKnowState &= conn->parentKnowsState(); - fParentsCurrentPowerFlags |= conn->parentCurrentPowerFlags(); - } - } - iter->release(); - } -} - -//********************************************************************************* -// [private] rebuildChildClampBits -// -// The ChildClamp bits (kIOPMChildClamp & kIOPMChildClamp2) in our capabilityFlags -// indicate that one of our children (or grandchildren or great-grandchildren ...) -// doesn't support idle or system sleep in its current state. Since we don't track -// the origin of each bit, every time any child changes state we have to clear -// these bits and rebuild them. -//********************************************************************************* - -void IOService::rebuildChildClampBits ( void ) -{ - unsigned long i; - OSIterator * iter; - OSObject * next; - IOPowerConnection * connection; - unsigned long powerState; - - // A child's desires has changed. We need to rebuild the child-clamp bits in - // our power state array. Start by clearing the bits in each power state. - - for ( i = 0; i < fNumberOfPowerStates; i++ ) - { - fPowerStates[i].capabilityFlags &= ~(kIOPMChildClamp | kIOPMChildClamp2); - } - - if (!inPlane(gIOPowerPlane)) + // set our connection data + whichParent->setParentCurrentPowerFlags(newPowerFlags); + whichParent->setParentKnowsState(knowsState); + + // recompute our parent info + fParentsCurrentPowerFlags = 0; + fParentsKnowState = true; + + iter = getParentIterator(gIOPowerPlane); + if (iter) { + while ((next = iter->getNextObject())) { + if ((conn = OSDynamicCast(IOPowerConnection, next))) { + fParentsKnowState &= conn->parentKnowsState(); + fParentsCurrentPowerFlags |= conn->parentCurrentPowerFlags(); + } + } + iter->release(); + } +} + +//****************************************************************************** +// [private] trackSystemSleepPreventers +//****************************************************************************** + +void +IOService::trackSystemSleepPreventers( + IOPMPowerStateIndex oldPowerState, + IOPMPowerStateIndex newPowerState, + IOPMPowerChangeFlags changeFlags __unused ) +{ + IOPMPowerFlags oldCapability, newCapability; + + oldCapability = fPowerStates[oldPowerState].capabilityFlags & + (kIOPMPreventIdleSleep | kIOPMPreventSystemSleep); + newCapability = fPowerStates[newPowerState].capabilityFlags & + (kIOPMPreventIdleSleep | kIOPMPreventSystemSleep); + + if (fHeadNoteChangeFlags & kIOPMInitialPowerChange) { + oldCapability = 0; + } + if (oldCapability == newCapability) { return; + } - // Loop through the children. When we encounter the calling child, save the - // computed state as this child's desire. And set the ChildClamp bits in any - // of our states that some child has clamp on. - - iter = getChildIterator(gIOPowerPlane); - if ( iter ) - { - while ( (next = iter->getNextObject()) ) - { - if ( (connection = OSDynamicCast(IOPowerConnection, next)) ) - { - if (connection->getReadyFlag() == false) - { - PM_LOG3("[%s] %s: connection not ready\n", - getName(), __FUNCTION__); - continue; - } + if ((oldCapability ^ newCapability) & kIOPMPreventIdleSleep) { + bool enablePrevention = ((oldCapability & kIOPMPreventIdleSleep) == 0); + bool idleCancelAllowed = getPMRootDomain()->updatePreventIdleSleepList( + this, enablePrevention); +#if SUPPORT_IDLE_CANCEL + if (idleCancelAllowed && enablePrevention) { + IOPMRequest * cancelRequest; - powerState = connection->getDesiredDomainState(); - if (powerState < fNumberOfPowerStates) - { - if ( connection->getPreventIdleSleepFlag() ) - fPowerStates[powerState].capabilityFlags |= kIOPMChildClamp; - if ( connection->getPreventSystemSleepFlag() ) - fPowerStates[powerState].capabilityFlags |= kIOPMChildClamp2; - } - } - } - iter->release(); - } + cancelRequest = acquirePMRequest( getPMRootDomain(), kIOPMRequestTypeIdleCancel ); + if (cancelRequest) { + submitPMRequest( cancelRequest ); + } + } +#endif + } + + if ((oldCapability ^ newCapability) & kIOPMPreventSystemSleep) { + getPMRootDomain()->updatePreventSystemSleepList(this, + ((oldCapability & kIOPMPreventSystemSleep) == 0)); + } } //********************************************************************************* @@ -2050,52 +2112,51 @@ void IOService::rebuildChildClampBits ( void ) // Called on a power parent when a child's power requirement changes. //********************************************************************************* -IOReturn IOService::requestPowerDomainState( - IOPMPowerFlags childRequestPowerFlags, - IOPowerConnection * childConnection, - unsigned long specification ) +IOReturn +IOService::requestPowerDomainState( + IOPMPowerFlags childRequestPowerFlags, + IOPowerConnection * childConnection, + unsigned long specification ) { - IOPMPowerStateIndex ps; - IOPMPowerFlags outputPowerFlags; - IOService * child; + IOPMPowerStateIndex order, powerState; + IOPMPowerFlags outputPowerFlags; + IOService * child; IOPMRequest * subRequest; - bool preventIdle, preventSleep; - bool adjustPower = false; + bool adjustPower = false; - if (!initialized) + if (!initialized) { return IOPMNotYetInitialized; + } - if (gIOPMWorkLoop->onThread() == false) - { + if (gIOPMWorkLoop->onThread() == false) { PM_LOG("%s::requestPowerDomainState\n", getName()); return kIOReturnSuccess; } - OUR_PMLog(kPMLogRequestDomain, childRequestPowerFlags, specification); + OUR_PMLog(kPMLogRequestDomain, childRequestPowerFlags, specification); - if (!isChild(childConnection, gIOPowerPlane)) + if (!isChild(childConnection, gIOPowerPlane)) { return kIOReturnNotAttached; + } - if (!fControllingDriver || !fNumberOfPowerStates) - return kIOReturnNotReady; + if (!fControllingDriver || !fNumberOfPowerStates) { + return kIOReturnNotReady; + } child = (IOService *) childConnection->getChildEntry(gIOPowerPlane); assert(child); - preventIdle = ((childRequestPowerFlags & kIOPMPreventIdleSleep) != 0); - preventSleep = ((childRequestPowerFlags & kIOPMPreventSystemSleep) != 0); - childRequestPowerFlags &= ~(kIOPMPreventIdleSleep | kIOPMPreventSystemSleep); + // Remove flags from child request which we can't possibly supply + childRequestPowerFlags &= fMergedOutputPowerFlags; - // Merge in the power flags contributed by this power parent - // at its current or impending power state. + // Merge in the power flags contributed by this power parent + // at its current or impending power state. - outputPowerFlags = fPowerStates[fCurrentPowerState].outputPowerFlags; - if (fMachineState != kIOPM_Finished) - { - if (IS_POWER_DROP && !IS_ROOT_DOMAIN) - { - // Use the lower power state when dropping power. - // Must be careful since a power drop can be canceled + outputPowerFlags = fPowerStates[fCurrentPowerState].outputPowerFlags; + if (fMachineState != kIOPM_Finished) { + if (IS_POWER_DROP && !IS_ROOT_DOMAIN) { + // Use the lower power state when dropping power. + // Must be careful since a power drop can be cancelled // from the following states: // - kIOPM_OurChangeTellClientsPowerDown // - kIOPM_OurChangeTellPriorityClientsPowerDown @@ -2105,26 +2166,21 @@ IOReturn IOService::requestPowerDomainState( // the power drop if possible, then schedule an adjustment to // re-evaluate the parent's power state. // - // Root domain is excluded to avoid idle sleep issues. And permit + // Root domain is excluded to avoid idle sleep issues. And allow // root domain children to pop up when system is going to sleep. if ((fMachineState == kIOPM_OurChangeTellClientsPowerDown) || - (fMachineState == kIOPM_OurChangeTellPriorityClientsPowerDown)) - { - fDoNotPowerDown = true; // cancel power drop - adjustPower = true; // schedule an adjustment + (fMachineState == kIOPM_OurChangeTellPriorityClientsPowerDown)) { + fDoNotPowerDown = true; // cancel power drop + adjustPower = true;// schedule an adjustment PM_LOG1("%s: power drop cancelled in state %u by %s\n", - getName(), fMachineState, child->getName()); - } - else - { + getName(), fMachineState, child->getName()); + } else { // Beyond cancellation point, report the impending state. outputPowerFlags = - fPowerStates[fHeadNotePowerState].outputPowerFlags; + fPowerStates[fHeadNotePowerState].outputPowerFlags; } - } - else if (IS_POWER_RISE) - { + } else if (IS_POWER_RISE) { // When raising power, must report the output power flags from // child's perspective. A child power request may arrive while // parent is transitioning upwards. If a request arrives after @@ -2132,83 +2188,63 @@ IOReturn IOService::requestPowerDomainState( // for the next power state, then using the power supplied by // fCurrentPowerState is incorrect, and might cause the child // to wait when it should not. - + outputPowerFlags = childConnection->parentCurrentPowerFlags(); } - } - child->fHeadNoteDomainTargetFlags |= outputPowerFlags; + } + child->fHeadNoteDomainTargetFlags |= outputPowerFlags; - // Map child's requested power flags to one of our power state. + // Map child's requested power flags to one of our power state. - for (ps = 0; ps < fNumberOfPowerStates; ps++) - { - if ((fPowerStates[ps].outputPowerFlags & childRequestPowerFlags) == - (fOutputPowerCharacterFlags & childRequestPowerFlags)) - break; - } - if (ps >= fNumberOfPowerStates) - { - ps = 0; // should never happen - } + for (order = 0; order < fNumberOfPowerStates; order++) { + powerState = fPowerStates[order].stateOrderToIndex; + if ((fPowerStates[powerState].outputPowerFlags & childRequestPowerFlags) + == childRequestPowerFlags) { + break; + } + } + if (order >= fNumberOfPowerStates) { + powerState = kPowerStateZero; + } - // Conditions that warrants a power adjustment on this parent. - // Adjust power will also propagate any changes to the child's - // prevent idle/sleep flags towards the root domain. + // Conditions that warrants a power adjustment on this parent. + // Adjust power will also propagate any changes to the child's + // prevent idle/sleep flags towards the root domain. - if (!childConnection->childHasRequestedPower() || - (ps != childConnection->getDesiredDomainState()) || - (childConnection->getPreventIdleSleepFlag() != preventIdle) || - (childConnection->getPreventSystemSleepFlag() != preventSleep)) - adjustPower = true; + if (!childConnection->childHasRequestedPower() || + (powerState != childConnection->getDesiredDomainState())) { + adjustPower = true; + } #if ENABLE_DEBUG_LOGS - if (adjustPower) - { - PM_LOG("requestPowerDomainState[%s]: %s, init %d, %u->%u\n", - getName(), child->getName(), - !childConnection->childHasRequestedPower(), - (uint32_t) childConnection->getDesiredDomainState(), - (uint32_t) ps); - } + if (adjustPower) { + PM_LOG("requestPowerDomainState[%s]: %s, init %d, %u->%u\n", + getName(), child->getName(), + !childConnection->childHasRequestedPower(), + (uint32_t) childConnection->getDesiredDomainState(), + (uint32_t) powerState); + } #endif // Record the child's desires on the connection. -#if SUPPORT_IDLE_CANCEL - bool attemptCancel = (preventIdle && !childConnection->getPreventIdleSleepFlag()); -#endif childConnection->setChildHasRequestedPower(); - childConnection->setDesiredDomainState( ps ); - childConnection->setPreventIdleSleepFlag( preventIdle ); - childConnection->setPreventSystemSleepFlag( preventSleep ); + childConnection->setDesiredDomainState( powerState ); // Schedule a request to re-evaluate all children desires and // adjust power state. Submit a request if one wasn't pending, // or if the current request is part of a call tree. - if (adjustPower && !fDeviceOverrideEnabled && - (!fAdjustPowerScheduled || gIOPMRequest->getRootRequest())) - { + if (adjustPower && !fDeviceOverrideEnabled && + (!fAdjustPowerScheduled || gIOPMRequest->getRootRequest())) { subRequest = acquirePMRequest( - this, kIOPMRequestTypeAdjustPowerState, gIOPMRequest ); - if (subRequest) - { + this, kIOPMRequestTypeAdjustPowerState, gIOPMRequest ); + if (subRequest) { submitPMRequest( subRequest ); fAdjustPowerScheduled = true; } - } - -#if SUPPORT_IDLE_CANCEL - if (attemptCancel) - { - subRequest = acquirePMRequest( this, kIOPMRequestTypeIdleCancel ); - if (subRequest) - { - submitPMRequest( subRequest ); - } } -#endif - return kIOReturnSuccess; + return kIOReturnSuccess; } //********************************************************************************* @@ -2220,9 +2256,10 @@ IOReturn IOService::requestPowerDomainState( // We enter the highest state until addPowerChild is called. //********************************************************************************* -IOReturn IOService::temporaryPowerClampOn ( void ) +IOReturn +IOService::temporaryPowerClampOn( void ) { - return requestPowerState( gIOPMPowerClientChildProxy, kIOPMPowerStateMax ); + return requestPowerState( gIOPMPowerClientChildProxy, kIOPMPowerStateMax ); } //********************************************************************************* @@ -2237,22 +2274,25 @@ IOReturn IOService::temporaryPowerClampOn ( void ) // highest power state. //********************************************************************************* -IOReturn IOService::makeUsable ( void ) +IOReturn +IOService::makeUsable( void ) { - OUR_PMLog(kPMLogMakeUsable, 0, 0); - return requestPowerState( gIOPMPowerClientDevice, kIOPMPowerStateMax ); + OUR_PMLog(kPMLogMakeUsable, 0, 0); + return requestPowerState( gIOPMPowerClientDevice, kIOPMPowerStateMax ); } //********************************************************************************* // [public] currentCapability //********************************************************************************* -IOPMPowerFlags IOService::currentCapability ( void ) +IOPMPowerFlags +IOService::currentCapability( void ) { - if (!initialized) + if (!initialized) { return IOPMNotPowerManaged; + } - return fCurrentCapabilityFlags; + return fCurrentCapabilityFlags; } //********************************************************************************* @@ -2263,10 +2303,11 @@ IOPMPowerFlags IOService::currentCapability ( void ) // power states differ, then a power state change is initiated. //********************************************************************************* -IOReturn IOService::changePowerStateTo ( unsigned long ordinal ) +IOReturn +IOService::changePowerStateTo( unsigned long ordinal ) { - OUR_PMLog(kPMLogChangeStateTo, ordinal, 0); - return requestPowerState( gIOPMPowerClientDriver, ordinal ); + OUR_PMLog(kPMLogChangeStateTo, ordinal, 0); + return requestPowerState( gIOPMPowerClientDriver, ordinal ); } //********************************************************************************* @@ -2277,14 +2318,15 @@ IOReturn IOService::changePowerStateTo ( unsigned long ordinal ) // power states differ, then a power state change is initiated. //********************************************************************************* -IOReturn IOService::changePowerStateToPriv ( unsigned long ordinal ) +IOReturn +IOService::changePowerStateToPriv( unsigned long ordinal ) { - OUR_PMLog(kPMLogChangeStateToPriv, ordinal, 0); - return requestPowerState( gIOPMPowerClientDevice, ordinal ); + OUR_PMLog(kPMLogChangeStateToPriv, ordinal, 0); + return requestPowerState( gIOPMPowerClientDevice, ordinal ); } //********************************************************************************* -// [protected] changePowerStateWithOverrideTo +// [public] changePowerStateWithOverrideTo // // Called by our driver subclass to change power state. The new desired power // state is computed and compared against the current power state. If those @@ -2292,231 +2334,312 @@ IOReturn IOService::changePowerStateToPriv ( unsigned long ordinal ) // Override enforced - Children and Driver desires are ignored. //********************************************************************************* -IOReturn IOService::changePowerStateWithOverrideTo ( unsigned long ordinal ) +IOReturn +IOService::changePowerStateWithOverrideTo( IOPMPowerStateIndex ordinal, + IOPMRequestTag tag ) { IOPMRequest * request; - if (!initialized) + if (!initialized) { return kIOPMNotYetInitialized; + } - OUR_PMLog(kPMLogChangeStateToPriv, ordinal, 0); + OUR_PMLog(kPMLogChangeStateToPriv, ordinal, 0); request = acquirePMRequest( this, kIOPMRequestTypeRequestPowerStateOverride ); - if (!request) + if (!request) { return kIOReturnNoMemory; + } - gIOPMPowerClientDevice->retain(); - request->fArg0 = (void *) ordinal; - request->fArg1 = (void *) gIOPMPowerClientDevice; - request->fArg2 = 0; + gIOPMPowerClientDevice->retain(); + request->fRequestTag = tag; + request->fArg0 = (void *) ordinal; + request->fArg1 = (void *) gIOPMPowerClientDevice; + request->fArg2 = NULL; #if NOT_READY - if (action) - request->installCompletionAction( action, target, param ); + if (action) { + request->installCompletionAction( action, target, param ); + } #endif // Prevent needless downwards power transitions by clamping power // until the scheduled request is executed. - if (gIOPMWorkLoop->inGate() && (ordinal < fNumberOfPowerStates)) - { - fTempClampPowerState = max(fTempClampPowerState, ordinal); + if (gIOPMWorkLoop->inGate() && (ordinal < fNumberOfPowerStates)) { + fTempClampPowerState = StateMax(fTempClampPowerState, ordinal); fTempClampCount++; fOverrideMaxPowerState = ordinal; request->fArg2 = (void *) (uintptr_t) true; } submitPMRequest( request ); - return IOPMNoErr; + return IOPMNoErr; +} + +//********************************************************************************* +// [public] changePowerStateForRootDomain +// +// Adjust the root domain's power desire on the target +//********************************************************************************* + +IOReturn +IOService::changePowerStateForRootDomain( IOPMPowerStateIndex ordinal ) +{ + OUR_PMLog(kPMLogChangeStateForRootDomain, ordinal, 0); + return requestPowerState( gIOPMPowerClientRootDomain, ordinal ); +} + +//********************************************************************************* +// [public for PMRD] quiescePowerTree +// +// For root domain to issue a request to quiesce the power tree. +// Supplied callback invoked upon completion. +//********************************************************************************* + +IOReturn +IOService::quiescePowerTree( + void * target, IOPMCompletionAction action, void * param ) +{ + IOPMRequest * request; + + if (!initialized) { + return kIOPMNotYetInitialized; + } + if (!target || !action) { + return kIOReturnBadArgument; + } + + OUR_PMLog(kPMLogQuiescePowerTree, 0, 0); + + // Target the root node instead of root domain. This is to avoid blocking + // the quiesce request behind an existing root domain request in the work + // queue. Root parent and root domain requests in the work queue must not + // block the completion of the quiesce request. + + request = acquirePMRequest(gIOPMRootNode, kIOPMRequestTypeQuiescePowerTree); + if (!request) { + return kIOReturnNoMemory; + } + + request->installCompletionAction(target, action, param); + + // Submit through the normal request flow. This will make sure any request + // already in the request queue will get pushed over to the work queue for + // execution. Any request submitted after this request may not be serviced. + + submitPMRequest( request ); + return kIOReturnSuccess; } //********************************************************************************* // [private] requestPowerState //********************************************************************************* -IOReturn IOService::requestPowerState ( - const OSSymbol * client, - uint32_t state ) +IOReturn +IOService::requestPowerState( + const OSSymbol * client, + uint32_t state ) { IOPMRequest * request; - if (!client) - return kIOReturnBadArgument; - if (!initialized) + if (!client) { + return kIOReturnBadArgument; + } + if (!initialized) { return kIOPMNotYetInitialized; + } request = acquirePMRequest( this, kIOPMRequestTypeRequestPowerState ); - if (!request) + if (!request) { return kIOReturnNoMemory; + } - client->retain(); - request->fArg0 = (void *) state; - request->fArg1 = (void *) client; - request->fArg2 = 0; + client->retain(); + request->fArg0 = (void *)(uintptr_t) state; + request->fArg1 = (void *) client; + request->fArg2 = NULL; #if NOT_READY - if (action) - request->installCompletionAction( action, target, param ); + if (action) { + request->installCompletionAction( action, target, param ); + } #endif // Prevent needless downwards power transitions by clamping power // until the scheduled request is executed. - if (gIOPMWorkLoop->inGate() && (state < fNumberOfPowerStates)) - { - fTempClampPowerState = max(fTempClampPowerState, state); + if (gIOPMWorkLoop->inGate() && (state < fNumberOfPowerStates)) { + fTempClampPowerState = StateMax(fTempClampPowerState, state); fTempClampCount++; request->fArg2 = (void *) (uintptr_t) true; } submitPMRequest( request ); - return IOPMNoErr; + return IOPMNoErr; } //********************************************************************************* // [private] handleRequestPowerState //********************************************************************************* -void IOService::handleRequestPowerState ( IOPMRequest * request ) +void +IOService::handleRequestPowerState( IOPMRequest * request ) { - const OSSymbol * client = (const OSSymbol *) request->fArg1; - uint32_t state = (uint32_t)(uintptr_t) request->fArg0; + const OSSymbol * client = (const OSSymbol *) request->fArg1; + uint32_t state = (uint32_t)(uintptr_t) request->fArg0; PM_ASSERT_IN_GATE(); - if (request->fArg2) - { + if (request->fArg2) { assert(fTempClampCount != 0); - if (fTempClampCount) fTempClampCount--; - if (!fTempClampCount) fTempClampPowerState = 0; + if (fTempClampCount) { + fTempClampCount--; + } + if (!fTempClampCount) { + fTempClampPowerState = kPowerStateZero; + } } - if (fNumberOfPowerStates && (state >= fNumberOfPowerStates)) - state = fNumberOfPowerStates - 1; + if (fNumberOfPowerStates && (state >= fNumberOfPowerStates)) { + state = fHighestPowerState; + } - // The power suppression due to changePowerStateWithOverrideTo() expires - // upon the next "device" power request - changePowerStateToPriv(). + // The power suppression due to changePowerStateWithOverrideTo() expires + // upon the next "device" power request - changePowerStateToPriv(). - if ((getPMRequestType() != kIOPMRequestTypeRequestPowerStateOverride) && - (client == gIOPMPowerClientDevice)) - fOverrideMaxPowerState = kIOPMPowerStateMax; + if ((getPMRequestType() != kIOPMRequestTypeRequestPowerStateOverride) && + (client == gIOPMPowerClientDevice)) { + fOverrideMaxPowerState = kIOPMPowerStateMax; + } - if ((state == 0) && - (client != gIOPMPowerClientDevice) && - (client != gIOPMPowerClientDriver) && - (client != gIOPMPowerClientChildProxy)) + if ((state == kPowerStateZero) && + (client != gIOPMPowerClientDevice) && + (client != gIOPMPowerClientDriver) && + (client != gIOPMPowerClientChildProxy)) { removePowerClient(client); - else + } else { updatePowerClient(client, state); + } adjustPowerState(); - client->release(); + client->release(); } //********************************************************************************* // [private] Helper functions to update/remove power clients. //********************************************************************************* -void IOService::updatePowerClient( const OSSymbol * client, uint32_t powerState ) +void +IOService::updatePowerClient( const OSSymbol * client, uint32_t powerState ) { - if (!fPowerClients) - fPowerClients = OSDictionary::withCapacity(4); - if (fPowerClients && client) - { - OSNumber * num = (OSNumber *) fPowerClients->getObject(client); - if (num) - num->setValue(powerState); - else - { - num = OSNumber::withNumber(powerState, 32); - if (num) - { - fPowerClients->setObject(client, num); - num->release(); - } - } - } + IOPMPowerStateIndex oldPowerState = kPowerStateZero; + + if (!fPowerClients) { + fPowerClients = OSDictionary::withCapacity(4); + } + if (fPowerClients && client) { + OSNumber * num = (OSNumber *) fPowerClients->getObject(client); + if (num) { + oldPowerState = num->unsigned32BitValue(); + num->setValue(powerState); + } else { + num = OSNumber::withNumber(powerState, 32); + if (num) { + fPowerClients->setObject(client, num); + num->release(); + } + } + + PM_ACTION_3(actionUpdatePowerClient, client, oldPowerState, powerState); + } } -void IOService::removePowerClient( const OSSymbol * client ) +void +IOService::removePowerClient( const OSSymbol * client ) { - if (fPowerClients && client) - fPowerClients->removeObject(client); + if (fPowerClients && client) { + fPowerClients->removeObject(client); + } } -uint32_t IOService::getPowerStateForClient( const OSSymbol * client ) +uint32_t +IOService::getPowerStateForClient( const OSSymbol * client ) { - uint32_t powerState = 0; + uint32_t powerState = kPowerStateZero; - if (fPowerClients && client) - { - OSNumber * num = (OSNumber *) fPowerClients->getObject(client); - if (num) powerState = num->unsigned32BitValue(); - } - return powerState; + if (fPowerClients && client) { + OSNumber * num = (OSNumber *) fPowerClients->getObject(client); + if (num) { + powerState = num->unsigned32BitValue(); + } + } + return powerState; } //********************************************************************************* // [protected] powerOverrideOnPriv //********************************************************************************* -IOReturn IOService::powerOverrideOnPriv ( void ) +IOReturn +IOService::powerOverrideOnPriv( void ) { IOPMRequest * request; - if (!initialized) + if (!initialized) { return IOPMNotYetInitialized; + } - if (gIOPMWorkLoop->inGate()) - { + if (gIOPMWorkLoop->inGate()) { fDeviceOverrideEnabled = true; return IOPMNoErr; } request = acquirePMRequest( this, kIOPMRequestTypePowerOverrideOnPriv ); - if (!request) + if (!request) { return kIOReturnNoMemory; + } submitPMRequest( request ); - return IOPMNoErr; + return IOPMNoErr; } //********************************************************************************* // [protected] powerOverrideOffPriv //********************************************************************************* -IOReturn IOService::powerOverrideOffPriv ( void ) +IOReturn +IOService::powerOverrideOffPriv( void ) { IOPMRequest * request; - if (!initialized) + if (!initialized) { return IOPMNotYetInitialized; + } - if (gIOPMWorkLoop->inGate()) - { + if (gIOPMWorkLoop->inGate()) { fDeviceOverrideEnabled = false; return IOPMNoErr; } request = acquirePMRequest( this, kIOPMRequestTypePowerOverrideOffPriv ); - if (!request) + if (!request) { return kIOReturnNoMemory; + } submitPMRequest( request ); - return IOPMNoErr; + return IOPMNoErr; } //********************************************************************************* // [private] handlePowerOverrideChanged //********************************************************************************* -void IOService::handlePowerOverrideChanged ( IOPMRequest * request ) +void +IOService::handlePowerOverrideChanged( IOPMRequest * request ) { PM_ASSERT_IN_GATE(); - if (request->getType() == kIOPMRequestTypePowerOverrideOnPriv) - { + if (request->getType() == kIOPMRequestTypePowerOverrideOnPriv) { OUR_PMLog(kPMLogOverrideOn, 0, 0); fDeviceOverrideEnabled = true; - } - else - { + } else { OUR_PMLog(kPMLogOverrideOff, 0, 0); fDeviceOverrideEnabled = false; } @@ -2528,126 +2651,138 @@ void IOService::handlePowerOverrideChanged ( IOPMRequest * request ) // [private] computeDesiredState //********************************************************************************* -void IOService::computeDesiredState ( unsigned long localClamp ) +void +IOService::computeDesiredState( unsigned long localClamp, bool computeOnly ) { - OSIterator * iter; - OSObject * next; - IOPowerConnection * connection; - uint32_t desiredState = 0; - uint32_t newPowerState = 0; - bool hasChildren = false; + OSIterator * iter; + OSObject * next; + IOPowerConnection * connection; + uint32_t desiredState = kPowerStateZero; + uint32_t newPowerState = kPowerStateZero; + bool hasChildren = false; // Desired power state is always 0 without a controlling driver. - if (!fNumberOfPowerStates) - { - fDesiredPowerState = 0; - //PM_LOG("%s::%s no controlling driver\n", getName(), __FUNCTION__); + if (!fNumberOfPowerStates) { + fDesiredPowerState = kPowerStateZero; return; } - // Examine the children's desired power state. - - iter = getChildIterator(gIOPowerPlane); - if (iter) - { - while ((next = iter->getNextObject())) - { - if ((connection = OSDynamicCast(IOPowerConnection, next))) - { - if (connection->getReadyFlag() == false) - { - PM_LOG3("[%s] %s: connection not ready\n", - getName(), __FUNCTION__); - continue; - } - if (connection->childHasRequestedPower()) - hasChildren = true; - if (connection->getDesiredDomainState() > desiredState) - desiredState = connection->getDesiredDomainState(); - } - } - iter->release(); - } - if (hasChildren) - updatePowerClient(gIOPMPowerClientChildren, desiredState); - else - removePowerClient(gIOPMPowerClientChildren); - - // Iterate through all power clients to determine the min power state. - - iter = OSCollectionIterator::withCollection(fPowerClients); - if (iter) - { - const OSSymbol * client; - while ((client = (const OSSymbol *) iter->getNextObject())) - { + // Examine the children's desired power state. + + iter = getChildIterator(gIOPowerPlane); + if (iter) { + while ((next = iter->getNextObject())) { + if ((connection = OSDynamicCast(IOPowerConnection, next))) { + if (connection->getReadyFlag() == false) { + PM_LOG3("[%s] %s: connection not ready\n", + getName(), __FUNCTION__); + continue; + } + if (connection->childHasRequestedPower()) { + hasChildren = true; + } + desiredState = StateMax(connection->getDesiredDomainState(), desiredState); + } + } + iter->release(); + } + if (hasChildren) { + updatePowerClient(gIOPMPowerClientChildren, desiredState); + } else { + removePowerClient(gIOPMPowerClientChildren); + } + + // Iterate through all power clients to determine the min power state. + + iter = OSCollectionIterator::withCollection(fPowerClients); + if (iter) { + const OSSymbol * client; + while ((client = (const OSSymbol *) iter->getNextObject())) { // Ignore child and driver when override is in effect. - if ((fDeviceOverrideEnabled || - (getPMRequestType() == kIOPMRequestTypeRequestPowerStateOverride)) && - ((client == gIOPMPowerClientChildren) || - (client == gIOPMPowerClientDriver))) - continue; + if ((fDeviceOverrideEnabled || + (getPMRequestType() == kIOPMRequestTypeRequestPowerStateOverride)) && + ((client == gIOPMPowerClientChildren) || + (client == gIOPMPowerClientDriver))) { + continue; + } // Ignore child proxy when children are present. - if (hasChildren && (client == gIOPMPowerClientChildProxy)) - continue; + if (hasChildren && (client == gIOPMPowerClientChildProxy)) { + continue; + } + + // Advisory tickles are irrelevant unless system is in full wake + if (client == gIOPMPowerClientAdvisoryTickle && + !gIOPMAdvisoryTickleEnabled) { + continue; + } - desiredState = getPowerStateForClient(client); - assert(desiredState < fNumberOfPowerStates); + desiredState = getPowerStateForClient(client); + assert(desiredState < fNumberOfPowerStates); PM_LOG1(" %u %s\n", - desiredState, client->getCStringNoCopy()); + desiredState, client->getCStringNoCopy()); - newPowerState = max(newPowerState, desiredState); + newPowerState = StateMax(newPowerState, desiredState); - if (client == gIOPMPowerClientDevice) - fDeviceDesire = desiredState; - } - iter->release(); - } + if (client == gIOPMPowerClientDevice) { + fDeviceDesire = desiredState; + } + } + iter->release(); + } - // Factor in the temporary power desires. + // Factor in the temporary power desires. - newPowerState = max(newPowerState, localClamp); - newPowerState = max(newPowerState, fTempClampPowerState); + newPowerState = StateMax(newPowerState, localClamp); + newPowerState = StateMax(newPowerState, fTempClampPowerState); - // Limit check against max power override. + // Limit check against max power override. - newPowerState = min(newPowerState, fOverrideMaxPowerState); + newPowerState = StateMin(newPowerState, fOverrideMaxPowerState); - // Limit check against number of power states. + // Limit check against number of power states. - if (newPowerState >= fNumberOfPowerStates) - newPowerState = fNumberOfPowerStates - 1; + if (newPowerState >= fNumberOfPowerStates) { + newPowerState = fHighestPowerState; + } - fDesiredPowerState = newPowerState; +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + if (getPMRootDomain()->isAOTMode()) { + if ((kIOPMPreventIdleSleep & fPowerStates[newPowerState].capabilityFlags) + && !(kIOPMPreventIdleSleep & fPowerStates[fDesiredPowerState].capabilityFlags)) { + getPMRootDomain()->claimSystemWakeEvent(this, kIOPMWakeEventAOTExit, getName(), NULL); + } + } +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ - PM_LOG1(" temp %u, clamp %u, current %u, new %u\n", - (uint32_t) localClamp, (uint32_t) fTempClampPowerState, - (uint32_t) fCurrentPowerState, newPowerState); + fDesiredPowerState = newPowerState; - // Restart idle timer if stopped and device desire has increased. + PM_LOG1(" temp %u, clamp %u, current %u, new %u\n", + (uint32_t) localClamp, (uint32_t) fTempClampPowerState, + (uint32_t) fCurrentPowerState, newPowerState); - if (fDeviceDesire && fIdleTimerStopped) - { - fIdleTimerStopped = false; - fActivityTickleCount = 0; - clock_get_uptime(&fIdleTimerStartTime); - start_PM_idle_timer(); - } + if (!computeOnly) { + // Restart idle timer if possible when device desire has increased. + // Or if an advisory desire exists. - // Invalidate cached tickle power state when desires change, and not - // due to a tickle request. This invalidation must occur before the - // power state change to minimize races. We want to err on the side - // of servicing more activity tickles rather than dropping one when - // the device is in a low power state. + if (fIdleTimerPeriod && fIdleTimerStopped) { + restartIdleTimer(); + } - if ((getPMRequestType() != kIOPMRequestTypeActivityTickle) && - (fActivityTicklePowerState != -1)) - { - IOLockLock(fActivityLock); - fActivityTicklePowerState = -1; - IOLockUnlock(fActivityLock); + // Invalidate cached tickle power state when desires change, and not + // due to a tickle request. In case the driver has requested a lower + // power state, but the tickle is caching a higher power state which + // will drop future tickles until the cached value is lowered or in- + // validated. The invalidation must occur before the power transition + // to avoid dropping a necessary tickle. + + if ((getPMRequestType() != kIOPMRequestTypeActivityTickle) && + (fActivityTicklePowerState != kInvalidTicklePowerState)) { + IOLockLock(fActivityLock); + fActivityTicklePowerState = kInvalidTicklePowerState; + IOLockUnlock(fActivityLock); + } } } @@ -2656,22 +2791,27 @@ void IOService::computeDesiredState ( unsigned long localClamp ) // //********************************************************************************* -unsigned long IOService::currentPowerConsumption ( void ) +unsigned long +IOService::currentPowerConsumption( void ) { - if (!initialized) - return kIOPMUnknown; + if (!initialized) { + return kIOPMUnknown; + } - return fCurrentPowerConsumption; + return fCurrentPowerConsumption; } //********************************************************************************* // [deprecated] getPMworkloop //********************************************************************************* -IOWorkLoop * IOService::getPMworkloop ( void ) +#ifndef __LP64__ +IOWorkLoop * +IOService::getPMworkloop( void ) { return gIOPMWorkLoop; } +#endif #if NOT_YET @@ -2680,72 +2820,64 @@ IOWorkLoop * IOService::getPMworkloop ( void ) //********************************************************************************* static void -applyToPowerChildren( - IOService * service, - IOServiceApplierFunction applier, - void * context, - IOOptionBits options ) +applyToPowerChildren( + IOService * service, + IOServiceApplierFunction applier, + void * context, + IOOptionBits options ) { PM_ASSERT_IN_GATE(); - IORegistryEntry * entry; - IORegistryIterator * iter; - IOPowerConnection * connection; - IOService * child; - - iter = IORegistryIterator::iterateOver(service, gIOPowerPlane, options); - if (iter) - { - while ((entry = iter->getNextObject())) - { - // Get child of IOPowerConnection objects - if ((connection = OSDynamicCast(IOPowerConnection, entry))) - { - child = (IOService *) connection->copyChildEntry(gIOPowerPlane); - if (child) - { - (*applier)(child, context); - child->release(); - } - } - } - iter->release(); - } + IORegistryEntry * entry; + IORegistryIterator * iter; + IOPowerConnection * connection; + IOService * child; + + iter = IORegistryIterator::iterateOver(service, gIOPowerPlane, options); + if (iter) { + while ((entry = iter->getNextObject())) { + // Get child of IOPowerConnection objects + if ((connection = OSDynamicCast(IOPowerConnection, entry))) { + child = (IOService *) connection->copyChildEntry(gIOPowerPlane); + if (child) { + (*applier)(child, context); + child->release(); + } + } + } + iter->release(); + } } static void -applyToPowerParent( - IOService * service, - IOServiceApplierFunction applier, - void * context, - IOOptionBits options ) +applyToPowerParent( + IOService * service, + IOServiceApplierFunction applier, + void * context, + IOOptionBits options ) { PM_ASSERT_IN_GATE(); - IORegistryEntry * entry; - IORegistryIterator * iter; - IOPowerConnection * connection; - IOService * parent; - - iter = IORegistryIterator::iterateOver(service, gIOPowerPlane, - options | kIORegistryIterateParents); - if (iter) - { - while ((entry = iter->getNextObject())) - { - // Get child of IOPowerConnection objects - if ((connection = OSDynamicCast(IOPowerConnection, entry))) - { - parent = (IOService *) connection->copyParentEntry(gIOPowerPlane); - if (parent) - { - (*applier)(parent, context); - parent->release(); - } - } - } - iter->release(); - } + IORegistryEntry * entry; + IORegistryIterator * iter; + IOPowerConnection * connection; + IOService * parent; + + iter = IORegistryIterator::iterateOver(service, gIOPowerPlane, + options | kIORegistryIterateParents); + if (iter) { + while ((entry = iter->getNextObject())) { + // Get child of IOPowerConnection objects + if ((connection = OSDynamicCast(IOPowerConnection, entry))) { + parent = (IOService *) connection->copyParentEntry(gIOPowerPlane); + if (parent) { + (*applier)(parent, context); + parent->release(); + } + } + } + iter->release(); + } } #endif /* NOT_YET */ @@ -2753,6 +2885,12 @@ applyToPowerParent( // MARK: - // MARK: Activity Tickle & Idle Timer +void +IOService::setAdvisoryTickleEnable( bool enable ) +{ + gIOPMAdvisoryTickleEnabled = enable; +} + //********************************************************************************* // [public] activityTickle // @@ -2763,81 +2901,148 @@ applyToPowerParent( // should be intercepted by a subclass. //********************************************************************************* -bool IOService::activityTickle ( unsigned long type, unsigned long stateNumber ) +bool +IOService::activityTickle( unsigned long type, unsigned long stateNumber ) { - IOPMRequest * request; - bool noPowerChange = true; + IOPMRequest * request; + bool noPowerChange = true; + uint32_t tickleFlags; - if ( initialized && stateNumber && (type == kIOPMSuperclassPolicy1) ) - { - IOLockLock(fActivityLock); + if (!initialized) { + return true; // no power change + } + if ((type == kIOPMSuperclassPolicy1) && StateOrder(stateNumber)) { + IOLockLock(fActivityLock); // Record device activity for the idle timer handler. - fDeviceWasActive = true; - fActivityTickleCount++; - clock_get_uptime(&fDeviceActiveTimestamp); + fDeviceWasActive = true; + fActivityTickleCount++; + clock_get_uptime(&fDeviceActiveTimestamp); - PM_ACTION_0(actionActivityTickle); + PM_ACTION_0(actionActivityTickle); // Record the last tickle power state. // This helps to filter out redundant tickles as // this function may be called from the data path. - if (fActivityTicklePowerState < (long)stateNumber) - { + if ((fActivityTicklePowerState == kInvalidTicklePowerState) + || StateOrder(fActivityTicklePowerState) < StateOrder(stateNumber)) { fActivityTicklePowerState = stateNumber; noPowerChange = false; + tickleFlags = kTickleTypeActivity | kTickleTypePowerRise; request = acquirePMRequest( this, kIOPMRequestTypeActivityTickle ); - if (request) - { - request->fArg0 = (void *) stateNumber; // power state - request->fArg1 = (void *) (uintptr_t) true; // power rise + if (request) { + request->fArg0 = (void *) stateNumber; + request->fArg1 = (void *)(uintptr_t) tickleFlags; + request->fArg2 = (void *)(uintptr_t) gIOPMTickleGeneration; submitPMRequest(request); } } IOLockUnlock(fActivityLock); - } + } else if ((type == kIOPMActivityTickleTypeAdvisory) && + ((stateNumber = fDeviceUsablePowerState) != kPowerStateZero)) { + IOLockLock(fActivityLock); + + fAdvisoryTickled = true; + + if (fAdvisoryTicklePowerState != stateNumber) { + fAdvisoryTicklePowerState = stateNumber; + noPowerChange = false; + + tickleFlags = kTickleTypeAdvisory | kTickleTypePowerRise; + request = acquirePMRequest( this, kIOPMRequestTypeActivityTickle ); + if (request) { + request->fArg0 = (void *) stateNumber; + request->fArg1 = (void *)(uintptr_t) tickleFlags; + request->fArg2 = (void *)(uintptr_t) gIOPMTickleGeneration; + submitPMRequest(request); + } + } + + IOLockUnlock(fActivityLock); + } // Returns false if the activityTickle might cause a transition to a // higher powered state, true otherwise. - return noPowerChange; + return noPowerChange; } //********************************************************************************* // [private] handleActivityTickle //********************************************************************************* -void IOService::handleActivityTickle ( IOPMRequest * request ) +void +IOService::handleActivityTickle( IOPMRequest * request ) { - uint32_t ticklePowerState = (uint32_t)(uintptr_t) request->fArg0; - bool adjustPower = false; + uint32_t ticklePowerState = (uint32_t)(uintptr_t) request->fArg0; + uint32_t tickleFlags = (uint32_t)(uintptr_t) request->fArg1; + uint32_t tickleGeneration = (uint32_t)(uintptr_t) request->fArg2; + bool adjustPower = false; PM_ASSERT_IN_GATE(); - if (request->fArg1) - { - // Power rise from activity tickle. - if ((ticklePowerState > fDeviceDesire) && - (ticklePowerState < fNumberOfPowerStates)) - { - fIdleTimerMinPowerState = ticklePowerState; + if (fResetPowerStateOnWake && (tickleGeneration != gIOPMTickleGeneration)) { + // Drivers that don't want power restored on wake will drop any + // tickles that pre-dates the current system wake. The model is + // that each wake is a fresh start, with power state depressed + // until a new tickle or an explicit power up request from the + // driver. It is possible for the PM work loop to enter the + // system sleep path with tickle requests queued. + + return; + } + + if (tickleFlags & kTickleTypeActivity) { + IOPMPowerStateIndex deviceDesireOrder = StateOrder(fDeviceDesire); + uint32_t idleTimerGeneration = ticklePowerState; // kTickleTypePowerDrop + + if (tickleFlags & kTickleTypePowerRise) { + if ((StateOrder(ticklePowerState) > deviceDesireOrder) && + (ticklePowerState < fNumberOfPowerStates)) { + fIdleTimerMinPowerState = ticklePowerState; + updatePowerClient(gIOPMPowerClientDevice, ticklePowerState); + adjustPower = true; + } + } else if ((deviceDesireOrder > StateOrder(fIdleTimerMinPowerState)) && + (idleTimerGeneration == fIdleTimerGeneration)) { + // Power drop due to idle timer expiration. + // Do not allow idle timer to reduce power below tickle power. + // This prevents the idle timer from decreasing the device desire + // to zero and cancelling the effect of a pre-sleep tickle when + // system wakes up to doze state, while the device is unable to + // raise its power state to satisfy the tickle. + + deviceDesireOrder--; + if (deviceDesireOrder < fNumberOfPowerStates) { + ticklePowerState = fPowerStates[deviceDesireOrder].stateOrderToIndex; + updatePowerClient(gIOPMPowerClientDevice, ticklePowerState); + adjustPower = true; + } + } + } else { // advisory tickle + if (tickleFlags & kTickleTypePowerRise) { + if ((ticklePowerState == fDeviceUsablePowerState) && + (ticklePowerState < fNumberOfPowerStates)) { + updatePowerClient(gIOPMPowerClientAdvisoryTickle, ticklePowerState); + fHasAdvisoryDesire = true; + fAdvisoryTickleUsed = true; + adjustPower = true; + } else { + IOLockLock(fActivityLock); + fAdvisoryTicklePowerState = kInvalidTicklePowerState; + IOLockUnlock(fActivityLock); + } + } else if (fHasAdvisoryDesire) { + removePowerClient(gIOPMPowerClientAdvisoryTickle); + fHasAdvisoryDesire = false; adjustPower = true; } } - else if (fDeviceDesire > fIdleTimerMinPowerState) - { - // Power drop due to idle timer expiration. - // Do not allow idle timer to reduce power below tickle power. - ticklePowerState = fDeviceDesire - 1; - adjustPower = true; - } - if (adjustPower) - { - updatePowerClient(gIOPMPowerClientDevice, ticklePowerState); + if (adjustPower) { adjustPowerState(); } } @@ -2849,22 +3054,46 @@ void IOService::handleActivityTickle ( IOPMRequest * request ) // Start the idle timer. Period is in seconds. //****************************************************************************** -IOReturn IOService::setIdleTimerPeriod ( unsigned long period ) +IOReturn +IOService::setIdleTimerPeriod( unsigned long period ) +{ + if (!initialized) { + return IOPMNotYetInitialized; + } + + OUR_PMLog(kPMLogSetIdleTimerPeriod, period, fIdleTimerPeriod); + + IOPMRequest * request = + acquirePMRequest( this, kIOPMRequestTypeSetIdleTimerPeriod ); + if (!request) { + return kIOReturnNoMemory; + } + + request->fArg0 = (void *) period; + submitPMRequest( request ); + + return kIOReturnSuccess; +} + +IOReturn +IOService::setIgnoreIdleTimer( bool ignore ) { - if (!initialized) + if (!initialized) { return IOPMNotYetInitialized; + } - OUR_PMLog(kPMLogSetIdleTimerPeriod, period, fIdleTimerPeriod); + OUR_PMLog(kIOPMRequestTypeIgnoreIdleTimer, ignore, 0); - IOPMRequest * request = - acquirePMRequest( this, kIOPMRequestTypeSetIdleTimerPeriod ); - if (!request) - return kIOReturnNoMemory; + IOPMRequest * request = + acquirePMRequest( this, kIOPMRequestTypeIgnoreIdleTimer ); + if (!request) { + return kIOReturnNoMemory; + } - request->fArg0 = (void *) period; - submitPMRequest( request ); + request->fArg0 = (void *) ignore; + submitPMRequest( request ); - return kIOReturnSuccess; + return kIOReturnSuccess; } //****************************************************************************** @@ -2874,73 +3103,100 @@ IOReturn IOService::setIdleTimerPeriod ( unsigned long period ) // next lowest power state. //****************************************************************************** -SInt32 IOService::nextIdleTimeout( - AbsoluteTime currentTime, - AbsoluteTime lastActivity, - unsigned int powerState) -{ - AbsoluteTime delta; - UInt64 delta_ns; - SInt32 delta_secs; - SInt32 delay_secs; - - // Calculate time difference using funky macro from clock.h. - delta = currentTime; - SUB_ABSOLUTETIME(&delta, &lastActivity); - - // Figure it in seconds. - absolutetime_to_nanoseconds(delta, &delta_ns); - delta_secs = (SInt32)(delta_ns / NSEC_PER_SEC); +SInt32 +IOService::nextIdleTimeout( + AbsoluteTime currentTime, + AbsoluteTime lastActivity, + unsigned int powerState) +{ + AbsoluteTime delta; + UInt64 delta_ns; + SInt32 delta_secs; + SInt32 delay_secs; + + // Calculate time difference using funky macro from clock.h. + delta = currentTime; + SUB_ABSOLUTETIME(&delta, &lastActivity); + + // Figure it in seconds. + absolutetime_to_nanoseconds(delta, &delta_ns); + delta_secs = (SInt32)(delta_ns / NSEC_PER_SEC); + + // Be paranoid about delta somehow exceeding timer period. + if (delta_secs < (int) fIdleTimerPeriod) { + delay_secs = (int) fIdleTimerPeriod - delta_secs; + } else { + delay_secs = (int) fIdleTimerPeriod; + } - // Be paranoid about delta somehow exceeding timer period. - if (delta_secs < (int) fIdleTimerPeriod) - delay_secs = (int) fIdleTimerPeriod - delta_secs; - else - delay_secs = (int) fIdleTimerPeriod; - - return (SInt32)delay_secs; + return (SInt32)delay_secs; } //********************************************************************************* // [public] start_PM_idle_timer //********************************************************************************* -void IOService::start_PM_idle_timer ( void ) +void +IOService::start_PM_idle_timer( void ) { - static const int maxTimeout = 100000; - static const int minTimeout = 1; - AbsoluteTime uptime, deadline; - SInt32 idle_in = 0; + static const int maxTimeout = 100000; + static const int minTimeout = 1; + AbsoluteTime uptime, deadline; + SInt32 idle_in = 0; boolean_t pending; - if (!initialized || !fIdleTimerPeriod) + if (!initialized || !fIdleTimerPeriod) { return; + } + + IOLockLock(fActivityLock); + + clock_get_uptime(&uptime); - IOLockLock(fActivityLock); + // Subclasses may modify idle sleep algorithm + idle_in = nextIdleTimeout(uptime, fDeviceActiveTimestamp, fCurrentPowerState); - clock_get_uptime(&uptime); + // Check for out-of range responses + if (idle_in > maxTimeout) { + // use standard implementation + idle_in = IOService::nextIdleTimeout(uptime, + fDeviceActiveTimestamp, + fCurrentPowerState); + } else if (idle_in < minTimeout) { + idle_in = fIdleTimerPeriod; + } + + IOLockUnlock(fActivityLock); - // Subclasses may modify idle sleep algorithm - idle_in = nextIdleTimeout(uptime, fDeviceActiveTimestamp, fCurrentPowerState); + fNextIdleTimerPeriod = idle_in; + fIdleTimerStartTime = uptime; - // Check for out-of range responses - if (idle_in > maxTimeout) - { - // use standard implementation - idle_in = IOService::nextIdleTimeout(uptime, - fDeviceActiveTimestamp, - fCurrentPowerState); - } else if (idle_in < minTimeout) { - idle_in = fIdleTimerPeriod; - } + retain(); + clock_interval_to_absolutetime_interval(idle_in, kSecondScale, &deadline); + ADD_ABSOLUTETIME(&deadline, &uptime); + pending = thread_call_enter_delayed(fIdleTimer, deadline); + if (pending) { + release(); + } +} - IOLockUnlock(fActivityLock); +//********************************************************************************* +// [private] restartIdleTimer +//********************************************************************************* - retain(); - clock_interval_to_absolutetime_interval(idle_in, kSecondScale, &deadline); - ADD_ABSOLUTETIME(&deadline, &uptime); - pending = thread_call_enter_delayed(fIdleTimer, deadline); - if (pending) release(); +void +IOService::restartIdleTimer( void ) +{ + if (fDeviceDesire != kPowerStateZero) { + fIdleTimerStopped = false; + fActivityTickleCount = 0; + start_PM_idle_timer(); + } else if (fHasAdvisoryDesire) { + fIdleTimerStopped = false; + start_PM_idle_timer(); + } else { + fIdleTimerStopped = true; + } } //********************************************************************************* @@ -2948,16 +3204,17 @@ void IOService::start_PM_idle_timer ( void ) //********************************************************************************* static void -idle_timer_expired ( - thread_call_param_t arg0, thread_call_param_t arg1 ) +idle_timer_expired( + thread_call_param_t arg0, thread_call_param_t arg1 ) { IOService * me = (IOService *) arg0; - if (gIOPMWorkLoop) + if (gIOPMWorkLoop) { gIOPMWorkLoop->runAction( - OSMemberFunctionCast(IOWorkLoop::Action, me, - &IOService::idleTimerExpired), - me); + OSMemberFunctionCast(IOWorkLoop::Action, me, + &IOService::idleTimerExpired), + me); + } me->release(); } @@ -2970,40 +3227,65 @@ idle_timer_expired ( // activity, switch to the next lower power state and restart the timer. //********************************************************************************* -void IOService::idleTimerExpired( void ) +void +IOService::idleTimerExpired( void ) { - IOPMRequest * request; - bool restartTimer = true; + IOPMRequest * request; + bool restartTimer = true; + uint32_t tickleFlags; + + if (!initialized || !fIdleTimerPeriod || fIdleTimerStopped || + fLockedFlags.PMStop) { + return; + } - if ( !initialized || !fIdleTimerPeriod || fLockedFlags.PMStop ) - return; + fIdleTimerStartTime = 0; IOLockLock(fActivityLock); // Check for device activity (tickles) over last timer period. - if (fDeviceWasActive) - { + if (fDeviceWasActive) { // Device was active - do not drop power, restart timer. fDeviceWasActive = false; - } - else - { + } else if (!fIdleTimerIgnored) { // No device activity - drop power state by one level. // Decrement the cached tickle power state when possible. - // This value may be (-1) before activityTickle() is called, - // but the power drop request must be issued regardless. + // This value may be kInvalidTicklePowerState before activityTickle() + // is called, but the power drop request must be issued regardless. - if (fActivityTicklePowerState > 0) - { + if ((fActivityTicklePowerState != kInvalidTicklePowerState) && + (fActivityTicklePowerState != kPowerStateZero)) { fActivityTicklePowerState--; } + tickleFlags = kTickleTypeActivity | kTickleTypePowerDrop; request = acquirePMRequest( this, kIOPMRequestTypeActivityTickle ); - if (request) - { - request->fArg0 = (void *) 0; // power state (irrelevant) - request->fArg1 = (void *) (uintptr_t) false; // power drop + if (request) { + request->fArg0 = (void *)(uintptr_t) fIdleTimerGeneration; + request->fArg1 = (void *)(uintptr_t) tickleFlags; + request->fArg2 = (void *)(uintptr_t) gIOPMTickleGeneration; + submitPMRequest( request ); + + // Do not restart timer until after the tickle request has been + // processed. + + restartTimer = false; + } + } + + if (fAdvisoryTickled) { + fAdvisoryTickled = false; + } else if (fHasAdvisoryDesire) { + // Want new tickles to turn into pm request after we drop the lock + fAdvisoryTicklePowerState = kInvalidTicklePowerState; + + tickleFlags = kTickleTypeAdvisory | kTickleTypePowerDrop; + request = acquirePMRequest( this, kIOPMRequestTypeActivityTickle ); + if (request) { + request->fArg0 = (void *)(uintptr_t) fIdleTimerGeneration; + request->fArg1 = (void *)(uintptr_t) tickleFlags; + request->fArg2 = (void *)(uintptr_t) gIOPMTickleGeneration; submitPMRequest( request ); // Do not restart timer until after the tickle request has been @@ -3011,12 +3293,13 @@ void IOService::idleTimerExpired( void ) restartTimer = false; } - } + } IOLockUnlock(fActivityLock); - if (restartTimer) + if (restartTimer) { start_PM_idle_timer(); + } } #ifndef __LP64__ @@ -3024,7 +3307,8 @@ void IOService::idleTimerExpired( void ) // [deprecated] PM_idle_timer_expiration //********************************************************************************* -void IOService::PM_idle_timer_expiration ( void ) +void +IOService::PM_idle_timer_expiration( void ) { } @@ -3032,7 +3316,8 @@ void IOService::PM_idle_timer_expiration ( void ) // [deprecated] command_received //********************************************************************************* -void IOService::command_received ( void *statePtr , void *, void * , void * ) +void +IOService::command_received( void *statePtr, void *, void *, void * ) { } #endif /* !__LP64__ */ @@ -3044,9 +3329,10 @@ void IOService::command_received ( void *statePtr , void *, void * , void * ) // power domains will pass it on to their children, etc. //********************************************************************************* -IOReturn IOService::setAggressiveness ( unsigned long type, unsigned long newLevel ) +IOReturn +IOService::setAggressiveness( unsigned long type, unsigned long newLevel ) { - return kIOReturnSuccess; + return kIOReturnSuccess; } //********************************************************************************* @@ -3055,14 +3341,16 @@ IOReturn IOService::setAggressiveness ( unsigned long type, unsigned long newLev // Called by the user client. //********************************************************************************* -IOReturn IOService::getAggressiveness ( unsigned long type, unsigned long * currentLevel ) +IOReturn +IOService::getAggressiveness( unsigned long type, unsigned long * currentLevel ) { - IOPMrootDomain * rootDomain = getPMRootDomain(); + IOPMrootDomain * rootDomain = getPMRootDomain(); - if (!rootDomain) - return kIOReturnNotReady; - - return rootDomain->getAggressiveness( type, currentLevel ); + if (!rootDomain) { + return kIOReturnNotReady; + } + + return rootDomain->getAggressiveness( type, currentLevel ); } //********************************************************************************* @@ -3070,12 +3358,14 @@ IOReturn IOService::getAggressiveness ( unsigned long type, unsigned long * curr // //********************************************************************************* -UInt32 IOService::getPowerState ( void ) +UInt32 +IOService::getPowerState( void ) { - if (!initialized) - return 0; + if (!initialized) { + return kPowerStateZero; + } - return fCurrentPowerState; + return fCurrentPowerState; } #ifndef __LP64__ @@ -3086,75 +3376,67 @@ UInt32 IOService::getPowerState ( void ) // power domains will pass it on to their children, etc. //********************************************************************************* -IOReturn IOService::systemWake ( void ) -{ - OSIterator * iter; - OSObject * next; - IOPowerConnection * connection; - IOService * theChild; - - iter = getChildIterator(gIOPowerPlane); - if ( iter ) - { - while ( (next = iter->getNextObject()) ) - { - if ( (connection = OSDynamicCast(IOPowerConnection, next)) ) - { - if (connection->getReadyFlag() == false) - { +IOReturn +IOService::systemWake( void ) +{ + OSIterator * iter; + OSObject * next; + IOPowerConnection * connection; + IOService * theChild; + + iter = getChildIterator(gIOPowerPlane); + if (iter) { + while ((next = iter->getNextObject())) { + if ((connection = OSDynamicCast(IOPowerConnection, next))) { + if (connection->getReadyFlag() == false) { PM_LOG3("[%s] %s: connection not ready\n", - getName(), __FUNCTION__); + getName(), __FUNCTION__); continue; } - theChild = (IOService *)connection->copyChildEntry(gIOPowerPlane); - if ( theChild ) - { - theChild->systemWake(); - theChild->release(); - } - } - } - iter->release(); - } + theChild = (IOService *)connection->copyChildEntry(gIOPowerPlane); + if (theChild) { + theChild->systemWake(); + theChild->release(); + } + } + } + iter->release(); + } - if ( fControllingDriver != NULL ) - { - if ( fControllingDriver->didYouWakeSystem() ) - { - makeUsable(); - } - } + if (fControllingDriver != NULL) { + if (fControllingDriver->didYouWakeSystem()) { + makeUsable(); + } + } - return IOPMNoErr; + return IOPMNoErr; } //********************************************************************************* // [deprecated] temperatureCriticalForZone //********************************************************************************* -IOReturn IOService::temperatureCriticalForZone ( IOService * whichZone ) -{ - IOService * theParent; - IOService * theNub; - - OUR_PMLog(kPMLogCriticalTemp, 0, 0); - - if ( inPlane(gIOPowerPlane) && !IS_PM_ROOT ) - { - theNub = (IOService *)copyParentEntry(gIOPowerPlane); - if ( theNub ) - { - theParent = (IOService *)theNub->copyParentEntry(gIOPowerPlane); - theNub->release(); - if ( theParent ) - { - theParent->temperatureCriticalForZone(whichZone); - theParent->release(); - } - } - } - return IOPMNoErr; +IOReturn +IOService::temperatureCriticalForZone( IOService * whichZone ) +{ + IOService * theParent; + IOService * theNub; + + OUR_PMLog(kPMLogCriticalTemp, 0, 0); + + if (inPlane(gIOPowerPlane) && !IS_PM_ROOT) { + theNub = (IOService *)copyParentEntry(gIOPowerPlane); + if (theNub) { + theParent = (IOService *)theNub->copyParentEntry(gIOPowerPlane); + theNub->release(); + if (theParent) { + theParent->temperatureCriticalForZone(whichZone); + theParent->release(); + } + } + } + return IOPMNoErr; } #endif /* !__LP64__ */ @@ -3167,44 +3449,87 @@ IOReturn IOService::temperatureCriticalForZone ( IOService * whichZone ) // All power state changes starts here. //********************************************************************************* -IOReturn IOService::startPowerChange( - IOPMPowerChangeFlags changeFlags, - IOPMPowerStateIndex powerState, - IOPMPowerFlags domainFlags, - IOPowerConnection * parentConnection, - IOPMPowerFlags parentFlags ) +IOReturn +IOService::startPowerChange( + IOPMPowerChangeFlags changeFlags, + IOPMPowerStateIndex powerState, + IOPMPowerFlags domainFlags, + IOPowerConnection * parentConnection, + IOPMPowerFlags parentFlags ) { + uint32_t savedPMActionsParam; + PM_ASSERT_IN_GATE(); assert( fMachineState == kIOPM_Finished ); - assert( powerState < fNumberOfPowerStates ); + assert( powerState < fNumberOfPowerStates ); + + if (powerState >= fNumberOfPowerStates) { + return IOPMAckImplied; + } + + fIsPreChange = true; + savedPMActionsParam = fPMActions.parameter; + PM_ACTION_2(actionPowerChangeOverride, &powerState, &changeFlags); + + // rdar://problem/55040032 + // Schedule a power adjustment after removing the power clamp + // to inform our power parent(s) about our latest desired domain + // power state. For a self-initiated change, let OurChangeStart() + // automatically request parent power when necessary. + if (!fAdjustPowerScheduled && + ((changeFlags & kIOPMSelfInitiated) == 0) && + ((fPMActions.parameter & kPMActionsFlagLimitPower) == 0) && + ((savedPMActionsParam & kPMActionsFlagLimitPower) != 0)) { + IOPMRequest * request = acquirePMRequest(this, kIOPMRequestTypeAdjustPowerState); + if (request) { + submitPMRequest(request); + fAdjustPowerScheduled = true; + } + } + + if (changeFlags & kIOPMExpireIdleTimer) { + // Root domain requested removal of tickle influence + if (StateOrder(fDeviceDesire) > StateOrder(powerState)) { + // Reset device desire down to the clamped power state + updatePowerClient(gIOPMPowerClientDevice, powerState); + computeDesiredState(kPowerStateZero, true); - if (powerState >= fNumberOfPowerStates) - return IOPMAckImplied; + // Invalidate tickle cache so the next tickle will issue a request + IOLockLock(fActivityLock); + fDeviceWasActive = false; + fActivityTicklePowerState = kInvalidTicklePowerState; + IOLockUnlock(fActivityLock); - fIsPreChange = true; - PM_ACTION_2(actionPowerChangeOverride, &powerState, &changeFlags); + fIdleTimerMinPowerState = kPowerStateZero; + } + } + + // Root domain's override handler may cancel the power change by + // setting the kIOPMNotDone flag. + + if (changeFlags & kIOPMNotDone) { + return IOPMAckImplied; + } // Forks to either Driver or Parent initiated power change paths. - fHeadNoteChangeFlags = changeFlags; - fHeadNotePowerState = powerState; - fHeadNotePowerArrayEntry = &fPowerStates[ powerState ]; + fHeadNoteChangeFlags = changeFlags; + fHeadNotePowerState = powerState; + fHeadNotePowerArrayEntry = &fPowerStates[powerState]; fHeadNoteParentConnection = NULL; - if (changeFlags & kIOPMSelfInitiated) - { - if (changeFlags & kIOPMSynchronize) - OurSyncStart(); - else - OurChangeStart(); + if (changeFlags & kIOPMSelfInitiated) { + if (changeFlags & kIOPMSynchronize) { + OurSyncStart(); + } else { + OurChangeStart(); + } return 0; - } - else - { + } else { assert(changeFlags & kIOPMParentInitiated); - fHeadNoteDomainFlags = domainFlags; + fHeadNoteDomainFlags = domainFlags; fHeadNoteParentFlags = parentFlags; - fHeadNoteParentConnection = parentConnection; + fHeadNoteParentConnection = parentConnection; return ParentChangeStart(); } } @@ -3213,82 +3538,96 @@ IOReturn IOService::startPowerChange( // [private] notifyInterestedDrivers //********************************************************************************* -bool IOService::notifyInterestedDrivers ( void ) -{ - IOPMinformee * informee; - IOPMinformeeList * list = fInterestedDrivers; - DriverCallParam * param; - IOItemCount count; - - PM_ASSERT_IN_GATE(); - assert( fDriverCallParamCount == 0 ); - assert( fHeadNotePendingAcks == 0 ); - - fHeadNotePendingAcks = 0; - - count = list->numberOfItems(); - if (!count) - goto done; // no interested drivers - - // Allocate an array of interested drivers and their return values - // for the callout thread. Everything else is still "owned" by the - // PM work loop, which can run to process acknowledgePowerChange() - // responses. - - param = (DriverCallParam *) fDriverCallParamPtr; - if (count > fDriverCallParamSlots) - { - if (fDriverCallParamSlots) - { - assert(fDriverCallParamPtr); - IODelete(fDriverCallParamPtr, DriverCallParam, fDriverCallParamSlots); - fDriverCallParamPtr = 0; - fDriverCallParamSlots = 0; - } - - param = IONew(DriverCallParam, count); - if (!param) - goto done; // no memory - - fDriverCallParamPtr = (void *) param; - fDriverCallParamSlots = count; - } - - informee = list->firstInList(); - assert(informee); - for (IOItemCount i = 0; i < count; i++) - { - informee->timer = -1; - param[i].Target = informee; - informee->retain(); - informee = list->nextInList( informee ); - } - - fDriverCallParamCount = count; - fHeadNotePendingAcks = count; - - // Block state machine and wait for callout completion. - assert(!fDriverCallBusy); - fDriverCallBusy = true; - thread_call_enter( fDriverCallEntry ); - return true; +bool +IOService::notifyInterestedDrivers( void ) +{ + IOPMinformee * informee; + IOPMinformeeList * list = fInterestedDrivers; + DriverCallParam * param; + IOItemCount count; + IOItemCount skipCnt = 0; + + PM_ASSERT_IN_GATE(); + assert( fDriverCallParamCount == 0 ); + assert( fHeadNotePendingAcks == 0 ); + + fHeadNotePendingAcks = 0; + + count = list->numberOfItems(); + if (!count) { + goto done; // no interested drivers + } + // Allocate an array of interested drivers and their return values + // for the callout thread. Everything else is still "owned" by the + // PM work loop, which can run to process acknowledgePowerChange() + // responses. + + param = (DriverCallParam *) fDriverCallParamPtr; + if (count > fDriverCallParamSlots) { + if (fDriverCallParamSlots) { + assert(fDriverCallParamPtr); + IODelete(fDriverCallParamPtr, DriverCallParam, fDriverCallParamSlots); + fDriverCallParamPtr = NULL; + fDriverCallParamSlots = 0; + } + + param = IONew(DriverCallParam, count); + if (!param) { + goto done; // no memory + } + fDriverCallParamPtr = (void *) param; + fDriverCallParamSlots = count; + } + + informee = list->firstInList(); + assert(informee); + for (IOItemCount i = 0; i < count; i++) { + if (fInitialSetPowerState || (fHeadNoteChangeFlags & kIOPMInitialPowerChange)) { + // Skip notifying self, if 'kIOPMInitialDeviceState' is set and + // this is the initial power state change + if ((this == informee->whatObject) && + (fHeadNotePowerArrayEntry->capabilityFlags & kIOPMInitialDeviceState)) { + skipCnt++; + continue; + } + } + informee->timer = -1; + param[i].Target = informee; + informee->retain(); + informee = list->nextInList( informee ); + } + + count -= skipCnt; + if (!count) { + goto done; + } + fDriverCallParamCount = count; + fHeadNotePendingAcks = count; + + // Block state machine and wait for callout completion. + assert(!fDriverCallBusy); + fDriverCallBusy = true; + thread_call_enter( fDriverCallEntry ); + return true; done: - // Return false if there are no interested drivers or could not schedule - // callout thread due to error. - return false; + // Return false if there are no interested drivers or could not schedule + // callout thread due to error. + return false; } //********************************************************************************* // [private] notifyInterestedDriversDone //********************************************************************************* -void IOService::notifyInterestedDriversDone ( void ) +void +IOService::notifyInterestedDriversDone( void ) { - IOPMinformee * informee; - IOItemCount count; - DriverCallParam * param; - IOReturn result; + IOPMinformee * informee; + IOItemCount count; + DriverCallParam * param; + IOReturn result; + int maxTimeout = 0; PM_ASSERT_IN_GATE(); assert( fDriverCallBusy == false ); @@ -3297,173 +3636,202 @@ void IOService::notifyInterestedDriversDone ( void ) param = (DriverCallParam *) fDriverCallParamPtr; count = fDriverCallParamCount; - if (param && count) - { - for (IOItemCount i = 0; i < count; i++, param++) - { + if (param && count) { + for (IOItemCount i = 0; i < count; i++, param++) { informee = (IOPMinformee *) param->Target; result = param->Result; - if ((result == IOPMAckImplied) || (result < 0)) - { + if ((result == IOPMAckImplied) || (result < 0)) { // Interested driver return IOPMAckImplied. - // If informee timer is zero, it must have de-registered - // interest during the thread callout. That also drops - // the pending ack count. + // If informee timer is zero, it must have de-registered + // interest during the thread callout. That also drops + // the pending ack count. - if (fHeadNotePendingAcks && informee->timer) - fHeadNotePendingAcks--; + if (fHeadNotePendingAcks && informee->timer) { + fHeadNotePendingAcks--; + } - informee->timer = 0; - } - else if (informee->timer) - { - assert(informee->timer == -1); + informee->timer = 0; + } else if (informee->timer) { + assert(informee->timer == -1); - // Driver has not acked, and has returned a positive result. - // Enforce a minimum permissible timeout value. - // Make the min value large enough so timeout is less likely - // to occur if a driver misinterpreted that the return value - // should be in microsecond units. And make it large enough - // to be noticeable if a driver neglects to ack. + // Driver has not acked, and has returned a positive result. + // Enforce a minimum permissible timeout value. + // Make the min value large enough so timeout is less likely + // to occur if a driver misinterpreted that the return value + // should be in microsecond units. And make it large enough + // to be noticeable if a driver neglects to ack. - if (result < kMinAckTimeoutTicks) - result = kMinAckTimeoutTicks; + if (result < kMinAckTimeoutTicks) { + result = kMinAckTimeoutTicks; + } - informee->timer = (result / (ACK_TIMER_PERIOD / ns_per_us)) + 1; + informee->timer = (result / (ACK_TIMER_PERIOD / ns_per_us)) + 1; + if (result > maxTimeout) { + maxTimeout = result; + } } // else, child has already acked or driver has removed interest, - // and head_note_pendingAcks decremented. + // and head_note_pendingAcks decremented. // informee may have been removed from the interested drivers list, - // thus the informee must be retained across the callout. + // thus the informee must be retained across the callout. informee->release(); } fDriverCallParamCount = 0; - if ( fHeadNotePendingAcks ) - { + if (fHeadNotePendingAcks) { OUR_PMLog(kPMLogStartAckTimer, 0, 0); start_ack_timer(); + getPMRootDomain()->reset_watchdog_timer(this, maxTimeout / USEC_PER_SEC + 1); } } - MS_POP(); // pushed by notifyAll() + MS_POP(); // pop the machine state passed to notifyAll() + + // If interest acks are outstanding, block the state machine until + // fHeadNotePendingAcks drops to zero before notifying root domain. + // Otherwise notify root domain directly. + + if (!fHeadNotePendingAcks) { + notifyRootDomain(); + } else { + MS_PUSH(fMachineState); + fMachineState = kIOPM_NotifyChildrenStart; + } +} + +//********************************************************************************* +// [private] notifyRootDomain +//********************************************************************************* + +void +IOService::notifyRootDomain( void ) +{ + assert( fDriverCallBusy == false ); + + // Only for root domain in the will-change phase + if (!IS_ROOT_DOMAIN || (fMachineState != kIOPM_OurChangeSetPowerState)) { + notifyChildren(); + return; + } + + MS_PUSH(fMachineState); // push notifyAll() machine state + fMachineState = kIOPM_DriverThreadCallDone; + + // Call IOPMrootDomain::willNotifyPowerChildren() on a thread call + // to avoid a deadlock. + fDriverCallReason = kRootDomainInformPreChange; + fDriverCallBusy = true; + thread_call_enter( fDriverCallEntry ); +} - // If interest acks are outstanding, wait for fHeadNotePendingAcks to become - // zero before notifying children. This enforces the children after interest - // ordering even for async interest clients. +void +IOService::notifyRootDomainDone( void ) +{ + assert( fDriverCallBusy == false ); + assert( fMachineState == kIOPM_DriverThreadCallDone ); - if (!fHeadNotePendingAcks) - { - notifyChildren(); - } - else - { - MS_PUSH(fMachineState); - fMachineState = kIOPM_NotifyChildrenStart; - PM_LOG2("%s: %u outstanding async interest\n", - getName(), fHeadNotePendingAcks); - } + MS_POP(); // pop notifyAll() machine state + notifyChildren(); } //********************************************************************************* // [private] notifyChildren //********************************************************************************* -void IOService::notifyChildren ( void ) -{ - OSIterator * iter; - OSObject * next; - IOPowerConnection * connection; - OSArray * children = 0; - IOPMrootDomain * rootDomain; - bool delayNotify = false; - - if ((fHeadNotePowerState != fCurrentPowerState) && - (IS_POWER_DROP == fIsPreChange) && - ((rootDomain = getPMRootDomain()) == this)) - { - rootDomain->tracePoint( IS_POWER_DROP ? - kIOPMTracePointSleepPowerPlaneDrivers : - kIOPMTracePointWakePowerPlaneDrivers ); - } - - if (fStrictTreeOrder) +void +IOService::notifyChildren( void ) +{ + OSIterator * iter; + OSObject * next; + IOPowerConnection * connection; + OSArray * children = NULL; + IOPMrootDomain * rootDomain; + bool delayNotify = false; + + if ((fHeadNotePowerState != fCurrentPowerState) && + (IS_POWER_DROP == fIsPreChange) && + ((rootDomain = getPMRootDomain()) == this)) { + rootDomain->tracePoint( IS_POWER_DROP ? + kIOPMTracePointSleepPowerPlaneDrivers : + kIOPMTracePointWakePowerPlaneDrivers ); + } + + if (fStrictTreeOrder) { children = OSArray::withCapacity(8); + } + + // Sum child power consumption in notifyChild() + fHeadNotePowerArrayEntry->staticPower = 0; - // Sum child power consumption in notifyChild() - fHeadNotePowerArrayEntry->staticPower = 0; - - iter = getChildIterator(gIOPowerPlane); - if ( iter ) - { - while ((next = iter->getNextObject())) - { - if ((connection = OSDynamicCast(IOPowerConnection, next))) - { - if (connection->getReadyFlag() == false) - { + iter = getChildIterator(gIOPowerPlane); + if (iter) { + while ((next = iter->getNextObject())) { + if ((connection = OSDynamicCast(IOPowerConnection, next))) { + if (connection->getReadyFlag() == false) { PM_LOG3("[%s] %s: connection not ready\n", - getName(), __FUNCTION__); + getName(), __FUNCTION__); continue; } - // Mechanism to postpone the did-change notification to - // certain power children to order those children last. - // Cannot be used together with strict tree ordering. - - if (!fIsPreChange && - (connection->delayChildNotification) && - getPMRootDomain()->shouldDelayChildNotification(this)) - { - if (!children) - { - children = OSArray::withCapacity(8); - if (children) - delayNotify = true; - } - if (delayNotify) - { - children->setObject( connection ); - continue; - } - } - - if (!delayNotify && children) + // Mechanism to postpone the did-change notification to + // certain power children to order those children last. + // Cannot be used together with strict tree ordering. + + if (!fIsPreChange && + connection->delayChildNotification && + getPMRootDomain()->shouldDelayChildNotification(this)) { + if (!children) { + children = OSArray::withCapacity(8); + if (children) { + delayNotify = true; + } + } + if (delayNotify) { + children->setObject( connection ); + continue; + } + } + + if (!delayNotify && children) { children->setObject( connection ); - else + } else { notifyChild( connection ); + } } - } - iter->release(); - } - - if (children && (children->getCount() == 0)) - { - children->release(); - children = 0; - } - if (children) - { - assert(fNotifyChildArray == 0); - fNotifyChildArray = children; - MS_PUSH(fMachineState); + } + iter->release(); + } - if (delayNotify) - { - // Wait for exiting child notifications to complete, - // before notifying the children in the array. - fMachineState = kIOPM_NotifyChildrenDelayed; - PM_LOG2("%s: %d children in delayed array\n", - getName(), children->getCount()); - } - else - { - // Notify children in the array one at a time. - fMachineState = kIOPM_NotifyChildrenOrdered; - } + if (children && (children->getCount() == 0)) { + children->release(); + children = NULL; + } + if (children) { + assert(fNotifyChildArray == NULL); + fNotifyChildArray = children; + MS_PUSH(fMachineState); + + if (delayNotify) { + // Block until all non-delayed children have acked their + // notification. Then notify the remaining delayed child + // in the array. This is used to hold off graphics child + // notification while the rest of the system powers up. + // If a hid tickle arrives during this time, the delayed + // children are immediately notified and root domain will + // not clamp power for dark wake. + + fMachineState = kIOPM_NotifyChildrenDelayed; + PM_LOG2("%s: %d children in delayed array\n", + getName(), children->getCount()); + } else { + // Child array created to support strict notification order. + // Notify children in the array one at a time. + + fMachineState = kIOPM_NotifyChildrenOrdered; + } } } @@ -3471,7 +3839,8 @@ void IOService::notifyChildren ( void ) // [private] notifyChildrenOrdered //********************************************************************************* -void IOService::notifyChildrenOrdered ( void ) +void +IOService::notifyChildrenOrdered( void ) { PM_ASSERT_IN_GATE(); assert(fNotifyChildArray); @@ -3486,19 +3855,16 @@ void IOService::notifyChildrenOrdered ( void ) // We have the ability to power off in reverse child index order. // That works nicely on some machines, but not on all HW configs. - if (fNotifyChildArray->getCount()) - { - IOPowerConnection * connection; + if (fNotifyChildArray->getCount()) { + IOPowerConnection * connection; connection = (IOPowerConnection *) fNotifyChildArray->getObject(0); - fNotifyChildArray->removeObject(0); notifyChild( connection ); - } - else - { + fNotifyChildArray->removeObject(0); + } else { fNotifyChildArray->release(); - fNotifyChildArray = 0; + fNotifyChildArray = NULL; - MS_POP(); // pushed by notifyChildren() + MS_POP(); // pushed by notifyChildren() } } @@ -3506,50 +3872,54 @@ void IOService::notifyChildrenOrdered ( void ) // [private] notifyChildrenDelayed //********************************************************************************* -void IOService::notifyChildrenDelayed ( void ) +void +IOService::notifyChildrenDelayed( void ) { - IOPowerConnection * connection; + IOPowerConnection * connection; PM_ASSERT_IN_GATE(); assert(fNotifyChildArray); assert(fMachineState == kIOPM_NotifyChildrenDelayed); - // Wait after all non-delayed children and interested drivers have ack'ed, - // then notify all delayed children. When explicitly cancelled, interest - // acks (and ack timer) may still be outstanding. + // Wait after all non-delayed children and interested drivers have ack'ed, + // then notify all delayed children. If notify delay is canceled, child + // acks may be outstanding with PM blocked on fHeadNotePendingAcks != 0. + // But the handling for either case is identical. - for (int i = 0; ; i++) - { + for (int i = 0;; i++) { connection = (IOPowerConnection *) fNotifyChildArray->getObject(i); - if (!connection) - break; + if (!connection) { + break; + } notifyChild( connection ); - } + } - PM_LOG2("%s: notified delayed children\n", getName()); - fNotifyChildArray->release(); - fNotifyChildArray = 0; - - MS_POP(); // pushed by notifyChildren() + PM_LOG2("%s: notified delayed children\n", getName()); + fNotifyChildArray->release(); + fNotifyChildArray = NULL; + + MS_POP(); // pushed by notifyChildren() } //********************************************************************************* // [private] notifyAll //********************************************************************************* -IOReturn IOService::notifyAll ( uint32_t nextMS ) +IOReturn +IOService::notifyAll( uint32_t nextMS ) { - // Save the next machine_state to be restored by notifyInterestedDriversDone() + // Save the machine state to be restored by notifyInterestedDriversDone() PM_ASSERT_IN_GATE(); - MS_PUSH(nextMS); + MS_PUSH(nextMS); fMachineState = kIOPM_DriverThreadCallDone; fDriverCallReason = fIsPreChange ? - kDriverCallInformPreChange : kDriverCallInformPostChange; + kDriverCallInformPreChange : kDriverCallInformPostChange; - if (!notifyInterestedDrivers()) + if (!notifyInterestedDrivers()) { notifyInterestedDriversDone(); + } return IOPMWillAckLater; } @@ -3560,44 +3930,49 @@ IOReturn IOService::notifyAll ( uint32_t nextMS ) // Thread call context //********************************************************************************* -IOReturn IOService::actionDriverCalloutDone ( +IOReturn +IOService::actionDriverCalloutDone( OSObject * target, void * arg0, void * arg1, void * arg2, void * arg3 ) { - IOServicePM * pwrMgt = (IOServicePM *) arg0; + IOServicePM * pwrMgt = (IOServicePM *) arg0; - assert( fDriverCallBusy ); - fDriverCallBusy = false; + assert( fDriverCallBusy ); + fDriverCallBusy = false; - assert(gIOPMWorkQueue); - gIOPMWorkQueue->signalWorkAvailable(); + assert(gIOPMWorkQueue); + gIOPMWorkQueue->signalWorkAvailable(); - return kIOReturnSuccess; + return kIOReturnSuccess; } -void IOService::pmDriverCallout ( IOService * from ) +void +IOService::pmDriverCallout( IOService * from ) { assert(from); - switch (from->fDriverCallReason) - { - case kDriverCallSetPowerState: - from->driverSetPowerState(); - break; - - case kDriverCallInformPreChange: - case kDriverCallInformPostChange: - from->driverInformPowerChange(); - break; - - default: - panic("IOService::pmDriverCallout bad machine state %x", - from->fDriverCallReason); + switch (from->fDriverCallReason) { + case kDriverCallSetPowerState: + from->driverSetPowerState(); + break; + + case kDriverCallInformPreChange: + case kDriverCallInformPostChange: + from->driverInformPowerChange(); + break; + + case kRootDomainInformPreChange: + getPMRootDomain()->willNotifyPowerChildren(from->fHeadNotePowerState); + break; + + default: + panic("IOService::pmDriverCallout bad machine state %x", + from->fDriverCallReason); } gIOPMWorkLoop->runAction(actionDriverCalloutDone, - /* target */ from, - /* arg0 */ (void *) from->pwrMgt ); + /* target */ from, + /* arg0 */ (void *) from->pwrMgt ); } //********************************************************************************* @@ -3606,67 +3981,63 @@ void IOService::pmDriverCallout ( IOService * from ) // Thread call context //********************************************************************************* -void IOService::driverSetPowerState ( void ) -{ - IOPMPowerStateIndex powerState; - DriverCallParam * param; - IOPMDriverCallEntry callEntry; - AbsoluteTime end; - IOReturn result; - uint32_t oldPowerState = getPowerState(); - - assert( fDriverCallBusy ); - assert( fDriverCallParamPtr ); - assert( fDriverCallParamCount == 1 ); - - param = (DriverCallParam *) fDriverCallParamPtr; - powerState = fHeadNotePowerState; - - if (assertPMDriverCall(&callEntry)) - { - OUR_PMLog( kPMLogProgramHardware, (uintptr_t) this, powerState); - clock_get_uptime(&fDriverCallStartTime); - result = fControllingDriver->setPowerState( powerState, this ); - clock_get_uptime(&end); - OUR_PMLog((UInt32) -kPMLogProgramHardware, (uintptr_t) this, (UInt32) result); - - deassertPMDriverCall(&callEntry); - - if (result < 0) - { - PM_LOG("%s::setPowerState(%p, %lu -> %lu) returned 0x%x\n", - fName, this, fCurrentPowerState, powerState, result); - } - -#if LOG_SETPOWER_TIMES - if ((result == IOPMAckImplied) || (result < 0)) - { - uint64_t nsec; - - SUB_ABSOLUTETIME(&end, &fDriverCallStartTime); - absolutetime_to_nanoseconds(end, &nsec); - if (nsec > LOG_SETPOWER_TIMES) - PM_LOG("%s::setPowerState(%p, %lu -> %lu) took %d ms\n", - fName, this, fCurrentPowerState, powerState, NS_TO_MS(nsec)); - - PMEventDetails *details = PMEventDetails::eventDetails( - kIOPMEventTypeSetPowerStateImmediate, // type - fName, // who - (uintptr_t)this, // owner unique - NULL, // interest name - (uint8_t)oldPowerState, // old - (uint8_t)powerState, // new - 0, // result - NS_TO_US(nsec)); // usec completion time - - getPMRootDomain()->recordAndReleasePMEventGated( details ); - } -#endif - } - else - result = kIOPMAckImplied; +void +IOService::driverSetPowerState( void ) +{ + IOPMPowerStateIndex powerState; + DriverCallParam * param; + IOPMDriverCallEntry callEntry; + AbsoluteTime end; + IOReturn result; + uint32_t oldPowerState = getPowerState(); + + assert( fDriverCallBusy ); + assert( fDriverCallParamPtr ); + assert( fDriverCallParamCount == 1 ); + + param = (DriverCallParam *) fDriverCallParamPtr; + powerState = fHeadNotePowerState; + + if (assertPMDriverCall(&callEntry, kIOPMDriverCallMethodSetPowerState)) { + OUR_PMLogFuncStart(kPMLogProgramHardware, (uintptr_t) this, powerState); + clock_get_uptime(&fDriverCallStartTime); + result = fControllingDriver->setPowerState( powerState, this ); + clock_get_uptime(&end); + OUR_PMLogFuncEnd(kPMLogProgramHardware, (uintptr_t) this, (UInt32) result); + + deassertPMDriverCall(&callEntry); + + // Record the most recent max power state residency timings. + // Use with DeviceActiveTimestamp to diagnose tickle issues. + if (powerState == fHighestPowerState) { + fMaxPowerStateEntryTime = end; + } else if (oldPowerState == fHighestPowerState) { + fMaxPowerStateExitTime = end; + } + + if (result < 0) { + PM_LOG("%s::setPowerState(%p, %lu -> %lu) returned 0x%x\n", + fName, OBFUSCATE(this), fCurrentPowerState, powerState, result); + } + + + if ((result == IOPMAckImplied) || (result < 0)) { + uint64_t nsec; + + SUB_ABSOLUTETIME(&end, &fDriverCallStartTime); + absolutetime_to_nanoseconds(end, &nsec); + if (nsec > LOG_SETPOWER_TIMES) { + getPMRootDomain()->pmStatsRecordApplicationResponse( + gIOPMStatsDriverPSChangeSlow, + fName, kDriverCallSetPowerState, NS_TO_MS(nsec), getRegistryEntryID(), + NULL, powerState); + } + } + } else { + result = kIOPMAckImplied; + } - param->Result = result; + param->Result = result; } //********************************************************************************* @@ -3675,91 +4046,72 @@ void IOService::driverSetPowerState ( void ) // Thread call context //********************************************************************************* -void IOService::driverInformPowerChange ( void ) -{ - IOPMinformee * informee; - IOService * driver; - DriverCallParam * param; - IOPMDriverCallEntry callEntry; - IOPMPowerFlags powerFlags; - IOPMPowerStateIndex powerState; - AbsoluteTime end; - IOReturn result; - IOItemCount count; - - assert( fDriverCallBusy ); - assert( fDriverCallParamPtr ); - assert( fDriverCallParamCount ); - - param = (DriverCallParam *) fDriverCallParamPtr; - count = fDriverCallParamCount; - - powerFlags = fHeadNotePowerArrayEntry->capabilityFlags; - powerState = fHeadNotePowerState; - - for (IOItemCount i = 0; i < count; i++) - { - informee = (IOPMinformee *) param->Target; - driver = informee->whatObject; - - if (assertPMDriverCall(&callEntry, 0, informee)) - { - if (fDriverCallReason == kDriverCallInformPreChange) - { - OUR_PMLog(kPMLogInformDriverPreChange, (uintptr_t) this, powerState); - clock_get_uptime(&informee->startTime); - result = driver->powerStateWillChangeTo(powerFlags, powerState, this); - clock_get_uptime(&end); - OUR_PMLog((UInt32)-kPMLogInformDriverPreChange, (uintptr_t) this, result); - } - else - { - OUR_PMLog(kPMLogInformDriverPostChange, (uintptr_t) this, powerState); - clock_get_uptime(&informee->startTime); - result = driver->powerStateDidChangeTo(powerFlags, powerState, this); - clock_get_uptime(&end); - OUR_PMLog((UInt32)-kPMLogInformDriverPostChange, (uintptr_t) this, result); - } - - deassertPMDriverCall(&callEntry); - -#if LOG_SETPOWER_TIMES - if ((result == IOPMAckImplied) || (result < 0)) - { - uint64_t nsec; - - SUB_ABSOLUTETIME(&end, &informee->startTime); - absolutetime_to_nanoseconds(end, &nsec); - if (nsec > LOG_SETPOWER_TIMES) - PM_LOG("%s::powerState%sChangeTo(%p, %s, %lu -> %lu) took %d ms\n", - driver->getName(), - (fDriverCallReason == kDriverCallInformPreChange) ? "Will" : "Did", - driver, fName, fCurrentPowerState, powerState, NS_TO_MS(nsec)); - - uint16_t logType = (fDriverCallReason == kDriverCallInformPreChange) - ? kIOPMEventTypePSWillChangeTo - : kIOPMEventTypePSDidChangeTo; - - PMEventDetails *details = PMEventDetails::eventDetails( - logType, // type - fName, // who - (uintptr_t)this, // owner unique - driver->getName(), // interest name - (uint8_t)fCurrentPowerState, // old - (uint8_t)fHeadNotePowerState, // new - 0, // result - NS_TO_US(nsec)); // usec completion time - - getPMRootDomain()->recordAndReleasePMEventGated( details ); - } -#endif - } - else - result = kIOPMAckImplied; +void +IOService::driverInformPowerChange( void ) +{ + IOPMinformee * informee; + IOService * driver; + DriverCallParam * param; + IOPMDriverCallEntry callEntry; + IOPMPowerFlags powerFlags; + IOPMPowerStateIndex powerState; + AbsoluteTime end; + IOReturn result; + IOItemCount count; + IOOptionBits callMethod = (fDriverCallReason == kDriverCallInformPreChange) ? + kIOPMDriverCallMethodWillChange : kIOPMDriverCallMethodDidChange; + + assert( fDriverCallBusy ); + assert( fDriverCallParamPtr ); + assert( fDriverCallParamCount ); + + param = (DriverCallParam *) fDriverCallParamPtr; + count = fDriverCallParamCount; + + powerFlags = fHeadNotePowerArrayEntry->capabilityFlags; + powerState = fHeadNotePowerState; + + for (IOItemCount i = 0; i < count; i++) { + informee = (IOPMinformee *) param->Target; + driver = informee->whatObject; + + if (assertPMDriverCall(&callEntry, callMethod, informee)) { + if (fDriverCallReason == kDriverCallInformPreChange) { + OUR_PMLogFuncStart(kPMLogInformDriverPreChange, (uintptr_t) this, powerState); + clock_get_uptime(&informee->startTime); + result = driver->powerStateWillChangeTo(powerFlags, powerState, this); + clock_get_uptime(&end); + OUR_PMLogFuncEnd(kPMLogInformDriverPreChange, (uintptr_t) this, result); + } else { + OUR_PMLogFuncStart(kPMLogInformDriverPostChange, (uintptr_t) this, powerState); + clock_get_uptime(&informee->startTime); + result = driver->powerStateDidChangeTo(powerFlags, powerState, this); + clock_get_uptime(&end); + OUR_PMLogFuncEnd(kPMLogInformDriverPostChange, (uintptr_t) this, result); + } + + deassertPMDriverCall(&callEntry); - param->Result = result; - param++; - } + + if ((result == IOPMAckImplied) || (result < 0)) { + uint64_t nsec; + + SUB_ABSOLUTETIME(&end, &informee->startTime); + absolutetime_to_nanoseconds(end, &nsec); + if (nsec > LOG_SETPOWER_TIMES) { + getPMRootDomain()->pmStatsRecordApplicationResponse( + gIOPMStatsDriverPSChangeSlow, driver->getName(), + fDriverCallReason, NS_TO_MS(nsec), driver->getRegistryEntryID(), + NULL, powerState); + } + } + } else { + result = kIOPMAckImplied; + } + + param->Result = result; + param++; + } } //********************************************************************************* @@ -3769,118 +4121,116 @@ void IOService::driverInformPowerChange ( void ) // If the object acknowledges the current change, we return TRUE. //********************************************************************************* -bool IOService::notifyChild ( IOPowerConnection * theNub ) +bool +IOService::notifyChild( IOPowerConnection * theNub ) { - IOReturn ret = IOPMAckImplied; - unsigned long childPower; - IOService * theChild; + IOReturn ret = IOPMAckImplied; + unsigned long childPower; + IOService * theChild; IOPMRequest * childRequest; - IOPMPowerChangeFlags requestArg2; + IOPMPowerChangeFlags requestArg2; int requestType; PM_ASSERT_IN_GATE(); - theChild = (IOService *)(theNub->copyChildEntry(gIOPowerPlane)); - if (!theChild) - { - assert(false); - return true; - } - - // Unless the child handles the notification immediately and returns - // kIOPMAckImplied, we'll be awaiting their acknowledgement later. - fHeadNotePendingAcks++; - theNub->setAwaitingAck(true); + theChild = (IOService *)(theNub->copyChildEntry(gIOPowerPlane)); + if (!theChild) { + return true; + } + + // Unless the child handles the notification immediately and returns + // kIOPMAckImplied, we'll be awaiting their acknowledgement later. + fHeadNotePendingAcks++; + theNub->setAwaitingAck(true); - requestArg2 = fHeadNoteChangeFlags; - if (fHeadNotePowerState < fCurrentPowerState) - requestArg2 |= kIOPMDomainPowerDrop; + requestArg2 = fHeadNoteChangeFlags; + if (StateOrder(fHeadNotePowerState) < StateOrder(fCurrentPowerState)) { + requestArg2 |= kIOPMDomainPowerDrop; + } - requestType = fIsPreChange ? - kIOPMRequestTypePowerDomainWillChange : - kIOPMRequestTypePowerDomainDidChange; + requestType = fIsPreChange ? + kIOPMRequestTypePowerDomainWillChange : + kIOPMRequestTypePowerDomainDidChange; childRequest = acquirePMRequest( theChild, requestType ); - if (childRequest) - { - theNub->retain(); + if (childRequest) { + theNub->retain(); childRequest->fArg0 = (void *) fHeadNotePowerArrayEntry->outputPowerFlags; childRequest->fArg1 = (void *) theNub; - childRequest->fArg2 = (void *) requestArg2; + childRequest->fArg2 = (void *)(uintptr_t) requestArg2; theChild->submitPMRequest( childRequest ); ret = IOPMWillAckLater; - } - else - { + } else { ret = IOPMAckImplied; - fHeadNotePendingAcks--; + fHeadNotePendingAcks--; theNub->setAwaitingAck(false); - childPower = theChild->currentPowerConsumption(); - if ( childPower == kIOPMUnknown ) - { - fHeadNotePowerArrayEntry->staticPower = kIOPMUnknown; - } else { - if (fHeadNotePowerArrayEntry->staticPower != kIOPMUnknown ) - fHeadNotePowerArrayEntry->staticPower += childPower; - } - } + childPower = theChild->currentPowerConsumption(); + if (childPower == kIOPMUnknown) { + fHeadNotePowerArrayEntry->staticPower = kIOPMUnknown; + } else { + if (fHeadNotePowerArrayEntry->staticPower != kIOPMUnknown) { + fHeadNotePowerArrayEntry->staticPower += childPower; + } + } + } - theChild->release(); - return (IOPMAckImplied == ret); + theChild->release(); + return IOPMAckImplied == ret; } //********************************************************************************* // [private] notifyControllingDriver //********************************************************************************* -bool IOService::notifyControllingDriver ( void ) +bool +IOService::notifyControllingDriver( void ) { - DriverCallParam * param; + DriverCallParam * param; - PM_ASSERT_IN_GATE(); - assert( fDriverCallParamCount == 0 ); - assert( fControllingDriver ); + PM_ASSERT_IN_GATE(); + assert( fDriverCallParamCount == 0 ); + assert( fControllingDriver ); - if (fInitialSetPowerState) - { - // Driver specified flag to skip the inital setPowerState() - if (fHeadNotePowerArrayEntry->capabilityFlags & kIOPMInitialDeviceState) - { - return false; - } - fInitialSetPowerState = false; - } + if (fInitialSetPowerState) { + fInitialSetPowerState = false; + fHeadNoteChangeFlags |= kIOPMInitialPowerChange; - param = (DriverCallParam *) fDriverCallParamPtr; - if (!param) - { - param = IONew(DriverCallParam, 1); - if (!param) - return false; // no memory + // Driver specified flag to skip the inital setPowerState() + if (fHeadNotePowerArrayEntry->capabilityFlags & kIOPMInitialDeviceState) { + return false; + } + } - fDriverCallParamPtr = (void *) param; - fDriverCallParamSlots = 1; - } + param = (DriverCallParam *) fDriverCallParamPtr; + if (!param) { + param = IONew(DriverCallParam, 1); + if (!param) { + return false; // no memory + } + fDriverCallParamPtr = (void *) param; + fDriverCallParamSlots = 1; + } - param->Target = fControllingDriver; - fDriverCallParamCount = 1; - fDriverTimer = -1; + param->Target = fControllingDriver; + fDriverCallParamCount = 1; + fDriverTimer = -1; - // Block state machine and wait for callout completion. - assert(!fDriverCallBusy); - fDriverCallBusy = true; - thread_call_enter( fDriverCallEntry ); + // Block state machine and wait for callout completion. + assert(!fDriverCallBusy); + fDriverCallBusy = true; + thread_call_enter( fDriverCallEntry ); - return true; + return true; } //********************************************************************************* // [private] notifyControllingDriverDone //********************************************************************************* -void IOService::notifyControllingDriverDone( void ) +void +IOService::notifyControllingDriverDone( void ) { - DriverCallParam * param; - IOReturn result; + DriverCallParam * param; + IOReturn result; PM_ASSERT_IN_GATE(); param = (DriverCallParam *) fDriverCallParamPtr; @@ -3888,46 +4238,43 @@ void IOService::notifyControllingDriverDone( void ) assert( fDriverCallBusy == false ); assert( fMachineState == kIOPM_DriverThreadCallDone ); - if (param && fDriverCallParamCount) - { + if (param && fDriverCallParamCount) { assert(fDriverCallParamCount == 1); - + // the return value from setPowerState() result = param->Result; - if ((result == IOPMAckImplied) || (result < 0)) - { - fDriverTimer = 0; - } - else if (fDriverTimer) - { - assert(fDriverTimer == -1); + if ((result == IOPMAckImplied) || (result < 0)) { + fDriverTimer = 0; + } else if (fDriverTimer) { + assert(fDriverTimer == -1); - // Driver has not acked, and has returned a positive result. - // Enforce a minimum permissible timeout value. - // Make the min value large enough so timeout is less likely - // to occur if a driver misinterpreted that the return value - // should be in microsecond units. And make it large enough - // to be noticeable if a driver neglects to ack. + // Driver has not acked, and has returned a positive result. + // Enforce a minimum permissible timeout value. + // Make the min value large enough so timeout is less likely + // to occur if a driver misinterpreted that the return value + // should be in microsecond units. And make it large enough + // to be noticeable if a driver neglects to ack. - if (result < kMinAckTimeoutTicks) - result = kMinAckTimeoutTicks; + if (result < kMinAckTimeoutTicks) { + result = kMinAckTimeoutTicks; + } - fDriverTimer = (result / (ACK_TIMER_PERIOD / ns_per_us)) + 1; + fDriverTimer = (result / (ACK_TIMER_PERIOD / ns_per_us)) + 1; } // else, child has already acked and driver_timer reset to 0. fDriverCallParamCount = 0; - if ( fDriverTimer ) - { + if (fDriverTimer) { OUR_PMLog(kPMLogStartAckTimer, 0, 0); start_ack_timer(); + getPMRootDomain()->reset_watchdog_timer(this, result / USEC_PER_SEC + 1); } } - MS_POP(); // pushed by OurChangeSetPowerState() - fIsPreChange = false; + MS_POP(); // pushed by OurChangeSetPowerState() + fIsPreChange = false; } //********************************************************************************* @@ -3936,136 +4283,167 @@ void IOService::notifyControllingDriverDone( void ) // A power change is done. //********************************************************************************* -void IOService::all_done ( void ) -{ - IOPMPowerStateIndex prevPowerState; - const IOPMPSEntry * powerStatePtr; - IOPMDriverCallEntry callEntry; - uint32_t prevMachineState = fMachineState; - bool callAction = false; - - fMachineState = kIOPM_Finished; - - if ((fHeadNoteChangeFlags & kIOPMSynchronize) && - ((prevMachineState == kIOPM_Finished) || - (prevMachineState == kIOPM_SyncFinish))) - { - // Sync operation and no power change occurred. - // Do not inform driver and clients about this request completion, - // except for the originator (root domain). - - PM_ACTION_2(actionPowerChangeDone, - fHeadNotePowerState, fHeadNoteChangeFlags); +void +IOService::all_done( void ) +{ + IOPMPowerStateIndex prevPowerState; + const IOPMPSEntry * powerStatePtr; + IOPMDriverCallEntry callEntry; + uint32_t prevMachineState = fMachineState; + bool actionCalled = false; + uint64_t ts; + + fMachineState = kIOPM_Finished; + + if ((fHeadNoteChangeFlags & kIOPMSynchronize) && + ((prevMachineState == kIOPM_Finished) || + (prevMachineState == kIOPM_SyncFinish))) { + // Sync operation and no power change occurred. + // Do not inform driver and clients about this request completion, + // except for the originator (root domain). + + PM_ACTION_2(actionPowerChangeDone, + fHeadNotePowerState, fHeadNoteChangeFlags); + + if (getPMRequestType() == kIOPMRequestTypeSynchronizePowerTree) { + powerChangeDone(fCurrentPowerState); + } else if (fAdvisoryTickleUsed) { + // Not root domain and advisory tickle target. + // Re-adjust power after power tree sync at the 'did' pass + // to recompute desire and adjust power state between dark + // and full wake transitions. Root domain is responsible + // for calling setAdvisoryTickleEnable() before starting + // the kIOPMSynchronize power change. + + if (!fAdjustPowerScheduled && + (fHeadNoteChangeFlags & kIOPMDomainDidChange)) { + IOPMRequest * request; + request = acquirePMRequest( this, kIOPMRequestTypeAdjustPowerState ); + if (request) { + submitPMRequest( request ); + fAdjustPowerScheduled = true; + } + } + } - if (getPMRequestType() == kIOPMRequestTypeSynchronizePowerTree) - { - powerChangeDone(fCurrentPowerState); - } + return; + } - return; - } + // our power change + if (fHeadNoteChangeFlags & kIOPMSelfInitiated) { + // power state changed + if ((fHeadNoteChangeFlags & kIOPMNotDone) == 0) { + trackSystemSleepPreventers( + fCurrentPowerState, fHeadNotePowerState, fHeadNoteChangeFlags); - // our power change - if ( fHeadNoteChangeFlags & kIOPMSelfInitiated ) - { - // could our driver switch to the new state? - if ( !( fHeadNoteChangeFlags & kIOPMNotDone) ) - { // we changed, tell our parent - requestDomainPower(fHeadNotePowerState); - - // yes, did power raise? - if ( fCurrentPowerState < fHeadNotePowerState ) - { - // yes, inform clients and apps - tellChangeUp (fHeadNotePowerState); - } - prevPowerState = fCurrentPowerState; - // either way - fCurrentPowerState = fHeadNotePowerState; + requestDomainPower(fHeadNotePowerState); + + // yes, did power raise? + if (StateOrder(fCurrentPowerState) < StateOrder(fHeadNotePowerState)) { + // yes, inform clients and apps + tellChangeUp(fHeadNotePowerState); + } + prevPowerState = fCurrentPowerState; + // either way + fCurrentPowerState = fHeadNotePowerState; + PM_LOCK(); + if (fReportBuf) { + ts = mach_absolute_time(); + STATEREPORT_SETSTATE(fReportBuf, fCurrentPowerState, ts); + } + PM_UNLOCK(); #if PM_VARS_SUPPORT - fPMVars->myCurrentState = fCurrentPowerState; + fPMVars->myCurrentState = fCurrentPowerState; #endif - OUR_PMLog(kPMLogChangeDone, fCurrentPowerState, 0); - PM_ACTION_2(actionPowerChangeDone, - fHeadNotePowerState, fHeadNoteChangeFlags); - callAction = true; - - powerStatePtr = &fPowerStates[fCurrentPowerState]; - fCurrentCapabilityFlags = powerStatePtr->capabilityFlags; - if (fCurrentCapabilityFlags & kIOPMStaticPowerValid) - fCurrentPowerConsumption = powerStatePtr->staticPower; - - // inform subclass policy-maker - if (fPCDFunctionOverride && fParentsKnowState && - assertPMDriverCall(&callEntry, kIOPMADC_NoInactiveCheck)) - { - powerChangeDone(prevPowerState); - deassertPMDriverCall(&callEntry); - } - } - else if (getPMRequestType() == kIOPMRequestTypeRequestPowerStateOverride) - { - // changePowerStateWithOverrideTo() was cancelled - fOverrideMaxPowerState = kIOPMPowerStateMax; - } - } - - // parent's power change - if ( fHeadNoteChangeFlags & kIOPMParentInitiated) - { - if (((fHeadNoteChangeFlags & kIOPMDomainWillChange) && - (fCurrentPowerState >= fHeadNotePowerState)) || - ((fHeadNoteChangeFlags & kIOPMDomainDidChange) && - (fCurrentPowerState < fHeadNotePowerState))) - { - // did power raise? - if ( fCurrentPowerState < fHeadNotePowerState ) - { - // yes, inform clients and apps - tellChangeUp (fHeadNotePowerState); - } - // either way - prevPowerState = fCurrentPowerState; - fCurrentPowerState = fHeadNotePowerState; + OUR_PMLog(kPMLogChangeDone, fCurrentPowerState, prevPowerState); + PM_ACTION_2(actionPowerChangeDone, + fHeadNotePowerState, fHeadNoteChangeFlags); + actionCalled = true; + + powerStatePtr = &fPowerStates[fCurrentPowerState]; + fCurrentCapabilityFlags = powerStatePtr->capabilityFlags; + if (fCurrentCapabilityFlags & kIOPMStaticPowerValid) { + fCurrentPowerConsumption = powerStatePtr->staticPower; + } + + if (fHeadNoteChangeFlags & kIOPMRootChangeDown) { + // Bump tickle generation count once the entire tree is down + gIOPMTickleGeneration++; + } + + // inform subclass policy-maker + if (fPCDFunctionOverride && fParentsKnowState && + assertPMDriverCall(&callEntry, kIOPMDriverCallMethodChangeDone, NULL, kIOPMDriverCallNoInactiveCheck)) { + powerChangeDone(prevPowerState); + deassertPMDriverCall(&callEntry); + } + } else if (getPMRequestType() == kIOPMRequestTypeRequestPowerStateOverride) { + // changePowerStateWithOverrideTo() was cancelled + fOverrideMaxPowerState = kIOPMPowerStateMax; + } + } + + // parent-initiated power change + if (fHeadNoteChangeFlags & kIOPMParentInitiated) { + if (fHeadNoteChangeFlags & kIOPMRootChangeDown) { + ParentChangeRootChangeDown(); + } + + // power state changed + if ((fHeadNoteChangeFlags & kIOPMNotDone) == 0) { + trackSystemSleepPreventers( + fCurrentPowerState, fHeadNotePowerState, fHeadNoteChangeFlags); + + // did power raise? + if (StateOrder(fCurrentPowerState) < StateOrder(fHeadNotePowerState)) { + // yes, inform clients and apps + tellChangeUp(fHeadNotePowerState); + } + // either way + prevPowerState = fCurrentPowerState; + fCurrentPowerState = fHeadNotePowerState; + PM_LOCK(); + if (fReportBuf) { + ts = mach_absolute_time(); + STATEREPORT_SETSTATE(fReportBuf, fCurrentPowerState, ts); + } + PM_UNLOCK(); #if PM_VARS_SUPPORT - fPMVars->myCurrentState = fCurrentPowerState; + fPMVars->myCurrentState = fCurrentPowerState; #endif - fMaxPowerState = fControllingDriver->maxCapabilityForDomainState(fHeadNoteDomainFlags); - - OUR_PMLog(kPMLogChangeDone, fCurrentPowerState, 0); - PM_ACTION_2(actionPowerChangeDone, - fHeadNotePowerState, fHeadNoteChangeFlags); - callAction = true; - - powerStatePtr = &fPowerStates[fCurrentPowerState]; - fCurrentCapabilityFlags = powerStatePtr->capabilityFlags; - if (fCurrentCapabilityFlags & kIOPMStaticPowerValid) - fCurrentPowerConsumption = powerStatePtr->staticPower; - - // inform subclass policy-maker - if (fPCDFunctionOverride && fParentsKnowState && - assertPMDriverCall(&callEntry, kIOPMADC_NoInactiveCheck)) - { - powerChangeDone(prevPowerState); - deassertPMDriverCall(&callEntry); - } - } - } - - // When power rises enough to satisfy the tickle's desire for more power, - // the condition preventing idle-timer from dropping power is removed. - - if (fCurrentPowerState >= fIdleTimerMinPowerState) - { - fIdleTimerMinPowerState = 0; - } - - if (!callAction) - { - PM_ACTION_2(actionPowerChangeDone, - fHeadNotePowerState, fHeadNoteChangeFlags); - } + + OUR_PMLog(kPMLogChangeDone, fCurrentPowerState, prevPowerState); + PM_ACTION_2(actionPowerChangeDone, + fHeadNotePowerState, fHeadNoteChangeFlags); + actionCalled = true; + + powerStatePtr = &fPowerStates[fCurrentPowerState]; + fCurrentCapabilityFlags = powerStatePtr->capabilityFlags; + if (fCurrentCapabilityFlags & kIOPMStaticPowerValid) { + fCurrentPowerConsumption = powerStatePtr->staticPower; + } + + // inform subclass policy-maker + if (fPCDFunctionOverride && fParentsKnowState && + assertPMDriverCall(&callEntry, kIOPMDriverCallMethodChangeDone, NULL, kIOPMDriverCallNoInactiveCheck)) { + powerChangeDone(prevPowerState); + deassertPMDriverCall(&callEntry); + } + } + } + + // When power rises enough to satisfy the tickle's desire for more power, + // the condition preventing idle-timer from dropping power is removed. + + if (StateOrder(fCurrentPowerState) >= StateOrder(fIdleTimerMinPowerState)) { + fIdleTimerMinPowerState = kPowerStateZero; + } + + if (!actionCalled) { + PM_ACTION_2(actionPowerChangeDone, + fHeadNotePowerState, fHeadNoteChangeFlags); + } } // MARK: - @@ -4077,226 +4455,243 @@ void IOService::all_done ( void ) // Begin the processing of a power change initiated by us. //********************************************************************************* -void IOService::OurChangeStart ( void ) +void +IOService::OurChangeStart( void ) { PM_ASSERT_IN_GATE(); - OUR_PMLog( kPMLogStartDeviceChange, fHeadNotePowerState, fCurrentPowerState ); + OUR_PMLog( kPMLogStartDeviceChange, fHeadNotePowerState, fCurrentPowerState ); // fMaxPowerState is our maximum possible power state based on the current // power state of our parents. If we are trying to raise power beyond the // maximum, send an async request for more power to all parents. - if (!IS_PM_ROOT && (fMaxPowerState < fHeadNotePowerState)) - { - fHeadNoteChangeFlags |= kIOPMNotDone; - requestDomainPower(fHeadNotePowerState); - OurChangeFinish(); - return; - } + if (!IS_PM_ROOT && (StateOrder(fMaxPowerState) < StateOrder(fHeadNotePowerState))) { + fHeadNoteChangeFlags |= kIOPMNotDone; + requestDomainPower(fHeadNotePowerState); + OurChangeFinish(); + return; + } // Redundant power changes skips to the end of the state machine. - if (!fInitialPowerChange && (fHeadNotePowerState == fCurrentPowerState)) - { + if (!fInitialPowerChange && (fHeadNotePowerState == fCurrentPowerState)) { OurChangeFinish(); return; - } - fInitialPowerChange = false; + } + fInitialPowerChange = false; - // Change started, but may not complete... - // Can be canceled (power drop) or deferred (power rise). + // Change started, but may not complete... + // Can be canceled (power drop) or deferred (power rise). - PM_ACTION_2(actionPowerChangeStart, fHeadNotePowerState, &fHeadNoteChangeFlags); + PM_ACTION_2(actionPowerChangeStart, fHeadNotePowerState, &fHeadNoteChangeFlags); // Two separate paths, depending if power is being raised or lowered. // Lowering power is subject to approval by clients of this service. - if (IS_POWER_DROP) - { - fDoNotPowerDown = false; - - // Ask for persmission to drop power state - fMachineState = kIOPM_OurChangeTellClientsPowerDown; - fOutOfBandParameter = kNotifyApps; - askChangeDown(fHeadNotePowerState); - } - else - { - // This service is raising power and parents are able to support the - // new power state. However a parent may have already committed to - // drop power, which might force this object to temporarily drop power. - // This results in "oscillations" before the state machines converge - // to a steady state. - // - // To prevent this, a child must make a power reservation against all - // parents before raising power. If the reservation fails, indicating - // that the child will be unable to sustain the higher power state, - // then the child will signal the parent to adjust power, and the child - // will defer its power change. - - IOReturn ret; - - // Reserve parent power necessary to achieve fHeadNotePowerState. - ret = requestDomainPower( fHeadNotePowerState, kReserveDomainPower ); - if (ret != kIOReturnSuccess) - { - // Reservation failed, defer power rise. - fHeadNoteChangeFlags |= kIOPMNotDone; - OurChangeFinish(); - return; - } + if (IS_POWER_DROP) { + fDoNotPowerDown = false; + + // Ask for persmission to drop power state + fMachineState = kIOPM_OurChangeTellClientsPowerDown; + fOutOfBandParameter = kNotifyApps; + askChangeDown(fHeadNotePowerState); + } else { + // This service is raising power and parents are able to support the + // new power state. However a parent may have already committed to + // drop power, which might force this object to temporarily drop power. + // This results in "oscillations" before the state machines converge + // to a steady state. + // + // To prevent this, a child must make a power reservation against all + // parents before raising power. If the reservation fails, indicating + // that the child will be unable to sustain the higher power state, + // then the child will signal the parent to adjust power, and the child + // will defer its power change. + + IOReturn ret; + + // Reserve parent power necessary to achieve fHeadNotePowerState. + ret = requestDomainPower( fHeadNotePowerState, kReserveDomainPower ); + if (ret != kIOReturnSuccess) { + // Reservation failed, defer power rise. + fHeadNoteChangeFlags |= kIOPMNotDone; + OurChangeFinish(); + return; + } - OurChangeTellCapabilityWillChange(); - } + OurChangeTellCapabilityWillChange(); + } } +//********************************************************************************* +// [private] requestDomainPowerApplier +// +// Call requestPowerDomainState() on all power parents. //********************************************************************************* struct IOPMRequestDomainPowerContext { - IOService * child; // the requesting child - IOPMPowerFlags requestPowerFlags; // power flags requested by child + IOService * child; // the requesting child + IOPMPowerFlags requestPowerFlags;// power flags requested by child }; static void requestDomainPowerApplier( - IORegistryEntry * entry, - void * inContext ) + IORegistryEntry * entry, + void * inContext ) { - IOPowerConnection * connection; - IOService * parent; - IOPMRequestDomainPowerContext * context; + IOPowerConnection * connection; + IOService * parent; + IOPMRequestDomainPowerContext * context; - if ((connection = OSDynamicCast(IOPowerConnection, entry)) == 0) - return; - parent = (IOService *) connection->copyParentEntry(gIOPowerPlane); - if (!parent) - return; + if ((connection = OSDynamicCast(IOPowerConnection, entry)) == NULL) { + return; + } + parent = (IOService *) connection->copyParentEntry(gIOPowerPlane); + if (!parent) { + return; + } - assert(inContext); - context = (IOPMRequestDomainPowerContext *) inContext; + assert(inContext); + context = (IOPMRequestDomainPowerContext *) inContext; - if (connection->parentKnowsState() && connection->getReadyFlag()) - { - parent->requestPowerDomainState( - context->requestPowerFlags, - connection, - IOPMLowestState); - } + if (connection->parentKnowsState() && connection->getReadyFlag()) { + parent->requestPowerDomainState( + context->requestPowerFlags, + connection, + IOPMLowestState); + } - parent->release(); + parent->release(); } //********************************************************************************* // [private] requestDomainPower +// +// Called by a power child to broadcast its desired power state to all parents. +// If the child self-initiates a power change, it must call this function to +// allow its parents to adjust power state. //********************************************************************************* -IOReturn IOService::requestDomainPower( - IOPMPowerStateIndex ourPowerState, - IOOptionBits options ) +IOReturn +IOService::requestDomainPower( + IOPMPowerStateIndex ourPowerState, + IOOptionBits options ) { - const IOPMPSEntry * powerStateEntry; - IOPMPowerFlags requestPowerFlags; - IOPMPowerStateIndex maxPowerState; - IOPMRequestDomainPowerContext context; + IOPMPowerFlags requestPowerFlags; + IOPMPowerStateIndex maxPowerState; + IOPMRequestDomainPowerContext context; PM_ASSERT_IN_GATE(); - assert(ourPowerState < fNumberOfPowerStates); - if (ourPowerState >= fNumberOfPowerStates) - return kIOReturnBadArgument; - if (IS_PM_ROOT) - return kIOReturnSuccess; - - // Fetch the input power flags for the requested power state. - // Parent request is stated in terms of required power flags. - - powerStateEntry = &fPowerStates[ourPowerState]; - requestPowerFlags = powerStateEntry->inputPowerFlags; - - if (powerStateEntry->capabilityFlags & (kIOPMChildClamp | kIOPMPreventIdleSleep)) - requestPowerFlags |= kIOPMPreventIdleSleep; - if (powerStateEntry->capabilityFlags & (kIOPMChildClamp2 | kIOPMPreventSystemSleep)) - requestPowerFlags |= kIOPMPreventSystemSleep; - - // Disregard the "previous request" for power reservation. - - if (((options & kReserveDomainPower) == 0) && - (fPreviousRequestPowerFlags == requestPowerFlags)) - { - // skip if domain already knows our requirements - goto done; - } - fPreviousRequestPowerFlags = requestPowerFlags; - - context.child = this; - context.requestPowerFlags = requestPowerFlags; - fHeadNoteDomainTargetFlags = 0; - applyToParents(requestDomainPowerApplier, &context, gIOPowerPlane); - - if (options & kReserveDomainPower) - { - maxPowerState = fControllingDriver->maxCapabilityForDomainState( - fHeadNoteDomainTargetFlags ); - - if (maxPowerState < fHeadNotePowerState) - { - PM_LOG1("%s: power desired %u:0x%x got %u:0x%x\n", - getName(), - (uint32_t) ourPowerState, (uint32_t) requestPowerFlags, - (uint32_t) maxPowerState, (uint32_t) fHeadNoteDomainTargetFlags); - return kIOReturnNoPower; - } - } + assert(ourPowerState < fNumberOfPowerStates); + if (ourPowerState >= fNumberOfPowerStates) { + return kIOReturnBadArgument; + } + if (IS_PM_ROOT) { + return kIOReturnSuccess; + } + + // Fetch our input power flags for the requested power state. + // Parent request is stated in terms of required power flags. + + requestPowerFlags = fPowerStates[ourPowerState].inputPowerFlags; + + // Disregard the "previous request" for power reservation. + + if (((options & kReserveDomainPower) == 0) && + (fPreviousRequestPowerFlags == requestPowerFlags)) { + // skip if domain already knows our requirements + goto done; + } + fPreviousRequestPowerFlags = requestPowerFlags; + + // The results will be collected by fHeadNoteDomainTargetFlags + context.child = this; + context.requestPowerFlags = requestPowerFlags; + fHeadNoteDomainTargetFlags = 0; + applyToParents(requestDomainPowerApplier, &context, gIOPowerPlane); + + if (options & kReserveDomainPower) { + maxPowerState = fControllingDriver->maxCapabilityForDomainState( + fHeadNoteDomainTargetFlags ); + + if (StateOrder(maxPowerState) < StateOrder(ourPowerState)) { + PM_LOG1("%s: power desired %u:0x%x got %u:0x%x\n", + getName(), + (uint32_t) ourPowerState, (uint32_t) requestPowerFlags, + (uint32_t) maxPowerState, (uint32_t) fHeadNoteDomainTargetFlags); + return kIOReturnNoPower; + } + } done: - return kIOReturnSuccess; + return kIOReturnSuccess; } //********************************************************************************* // [private] OurSyncStart //********************************************************************************* -void IOService::OurSyncStart ( void ) +void +IOService::OurSyncStart( void ) { PM_ASSERT_IN_GATE(); - if (fInitialPowerChange) - return; + if (fInitialPowerChange) { + return; + } - PM_ACTION_2(actionPowerChangeStart, fHeadNotePowerState, &fHeadNoteChangeFlags); + PM_ACTION_2(actionPowerChangeStart, fHeadNotePowerState, &fHeadNoteChangeFlags); - if (fHeadNoteChangeFlags & kIOPMNotDone) - { + if (fHeadNoteChangeFlags & kIOPMNotDone) { OurChangeFinish(); return; - } + } - if (fHeadNoteChangeFlags & kIOPMSyncTellPowerDown) - { - fDoNotPowerDown = false; + if (fHeadNoteChangeFlags & kIOPMSyncTellPowerDown) { + fDoNotPowerDown = false; - // Ask for permission to drop power state - fMachineState = kIOPM_SyncTellClientsPowerDown; - fOutOfBandParameter = kNotifyApps; - askChangeDown(fHeadNotePowerState); - } - else - { - // Only inform capability app and clients. - tellSystemCapabilityChange( kIOPM_SyncNotifyWillChange ); - } + // Ask for permission to drop power state + fMachineState = kIOPM_SyncTellClientsPowerDown; + fOutOfBandParameter = kNotifyApps; + askChangeDown(fHeadNotePowerState); + } else { + // Only inform capability app and clients. + tellSystemCapabilityChange( kIOPM_SyncNotifyWillChange ); + } } //********************************************************************************* // [private] OurChangeTellClientsPowerDown // // All applications and kernel clients have acknowledged our permission to drop -// power. Here we notify them that we will lower the power and wait for acks. +// power. Here we notify them that we will lower the power and wait for acks. //********************************************************************************* -void IOService::OurChangeTellClientsPowerDown ( void ) +void +IOService::OurChangeTellClientsPowerDown( void ) +{ + if (!IS_ROOT_DOMAIN) { + fMachineState = kIOPM_OurChangeTellPriorityClientsPowerDown; + } else { + fMachineState = kIOPM_OurChangeTellUserPMPolicyPowerDown; + } + tellChangeDown1(fHeadNotePowerState); +} + +//********************************************************************************* +// [private] OurChangeTellUserPMPolicyPowerDown +// +// All applications and kernel clients have acknowledged our permission to drop +// power. Here we notify power management policy in user-space and wait for acks +// one last time before we lower power +//********************************************************************************* +void +IOService::OurChangeTellUserPMPolicyPowerDown( void ) { - fMachineState = kIOPM_OurChangeTellPriorityClientsPowerDown; - tellChangeDown1(fHeadNotePowerState); + fMachineState = kIOPM_OurChangeTellPriorityClientsPowerDown; + fOutOfBandParameter = kNotifyApps; + + tellClientsWithResponse(kIOPMMessageLastCallBeforeSleep); } //********************************************************************************* @@ -4306,10 +4701,11 @@ void IOService::OurChangeTellClientsPowerDown ( void ) // power. Here we notify "priority" clients that we are lowering power. //********************************************************************************* -void IOService::OurChangeTellPriorityClientsPowerDown ( void ) +void +IOService::OurChangeTellPriorityClientsPowerDown( void ) { - fMachineState = kIOPM_OurChangeNotifyInterestedDriversWillChange; - tellChangeDown2(fHeadNotePowerState); + fMachineState = kIOPM_OurChangeNotifyInterestedDriversWillChange; + tellChangeDown2(fHeadNotePowerState); } //********************************************************************************* @@ -4319,12 +4715,14 @@ void IOService::OurChangeTellPriorityClientsPowerDown ( void ) // system capability change when raising power state. //********************************************************************************* -void IOService::OurChangeTellCapabilityWillChange ( void ) +void +IOService::OurChangeTellCapabilityWillChange( void ) { - if (!IS_ROOT_DOMAIN) - return OurChangeNotifyInterestedDriversWillChange(); + if (!IS_ROOT_DOMAIN) { + return OurChangeNotifyInterestedDriversWillChange(); + } - tellSystemCapabilityChange( kIOPM_OurChangeNotifyInterestedDriversWillChange ); + tellSystemCapabilityChange( kIOPM_OurChangeNotifyInterestedDriversWillChange ); } //********************************************************************************* @@ -4334,27 +4732,19 @@ void IOService::OurChangeTellCapabilityWillChange ( void ) // Here we notify interested drivers pre-change. //********************************************************************************* -void IOService::OurChangeNotifyInterestedDriversWillChange ( void ) -{ - IOPMrootDomain * rootDomain; - if ((rootDomain = getPMRootDomain()) == this) - { - if (IS_POWER_DROP) - { - rootDomain->tracePoint( kIOPMTracePointSleepWillChangeInterests ); - - PMEventDetails *details = PMEventDetails::eventDetails( - kIOPMEventTypeAppNotificationsFinished, - NULL, - 100, - kIOReturnSuccess); - rootDomain->recordAndReleasePMEventGated( details ); - } - else - rootDomain->tracePoint( kIOPMTracePointWakeWillChangeInterests ); - } +void +IOService::OurChangeNotifyInterestedDriversWillChange( void ) +{ + IOPMrootDomain * rootDomain; + if ((rootDomain = getPMRootDomain()) == this) { + if (IS_POWER_DROP) { + rootDomain->tracePoint( kIOPMTracePointSleepWillChangeInterests ); + } else { + rootDomain->tracePoint( kIOPMTracePointWakeWillChangeInterests ); + } + } - notifyAll( kIOPM_OurChangeSetPowerState ); + notifyAll( kIOPM_OurChangeSetPowerState ); } //********************************************************************************* @@ -4364,14 +4754,16 @@ void IOService::OurChangeNotifyInterestedDriversWillChange ( void ) // change. Wait for async completions. //********************************************************************************* -void IOService::OurChangeSetPowerState ( void ) +void +IOService::OurChangeSetPowerState( void ) { - MS_PUSH( kIOPM_OurChangeWaitForPowerSettle ); - fMachineState = kIOPM_DriverThreadCallDone; - fDriverCallReason = kDriverCallSetPowerState; + MS_PUSH( kIOPM_OurChangeWaitForPowerSettle ); + fMachineState = kIOPM_DriverThreadCallDone; + fDriverCallReason = kDriverCallSetPowerState; - if (notifyControllingDriver() == false) - notifyControllingDriverDone(); + if (notifyControllingDriver() == false) { + notifyControllingDriverDone(); + } } //********************************************************************************* @@ -4381,10 +4773,11 @@ void IOService::OurChangeSetPowerState ( void ) // Wait for the driver specified settle time to expire. //********************************************************************************* -void IOService::OurChangeWaitForPowerSettle ( void ) +void +IOService::OurChangeWaitForPowerSettle( void ) { - fMachineState = kIOPM_OurChangeNotifyInterestedDriversDidChange; - startSettleTimer(); + fMachineState = kIOPM_OurChangeNotifyInterestedDriversDidChange; + startSettleTimer(); } //********************************************************************************* @@ -4394,17 +4787,17 @@ void IOService::OurChangeWaitForPowerSettle ( void ) // all our interested drivers post-change. //********************************************************************************* -void IOService::OurChangeNotifyInterestedDriversDidChange ( void ) +void +IOService::OurChangeNotifyInterestedDriversDidChange( void ) { - IOPMrootDomain * rootDomain; - if ((rootDomain = getPMRootDomain()) == this) - { - rootDomain->tracePoint( IS_POWER_DROP ? - kIOPMTracePointSleepDidChangeInterests : - kIOPMTracePointWakeDidChangeInterests ); - } + IOPMrootDomain * rootDomain; + if ((rootDomain = getPMRootDomain()) == this) { + rootDomain->tracePoint( IS_POWER_DROP ? + kIOPMTracePointSleepDidChangeInterests : + kIOPMTracePointWakeDidChangeInterests ); + } - notifyAll( kIOPM_OurChangeTellCapabilityDidChange ); + notifyAll( kIOPM_OurChangeTellCapabilityDidChange ); } //********************************************************************************* @@ -4413,16 +4806,18 @@ void IOService::OurChangeNotifyInterestedDriversDidChange ( void ) // For root domain to notify capability power-change. //********************************************************************************* -void IOService::OurChangeTellCapabilityDidChange ( void ) +void +IOService::OurChangeTellCapabilityDidChange( void ) { - if (!IS_ROOT_DOMAIN) - return OurChangeFinish(); + if (!IS_ROOT_DOMAIN) { + return OurChangeFinish(); + } - getPMRootDomain()->tracePoint( IS_POWER_DROP ? - kIOPMTracePointSleepCapabilityClients : - kIOPMTracePointWakeCapabilityClients ); + getPMRootDomain()->tracePoint( IS_POWER_DROP ? + kIOPMTracePointSleepCapabilityClients : + kIOPMTracePointWakeCapabilityClients ); - tellSystemCapabilityChange( kIOPM_OurChangeFinish ); + tellSystemCapabilityChange( kIOPM_OurChangeFinish ); } //********************************************************************************* @@ -4431,9 +4826,10 @@ void IOService::OurChangeTellCapabilityDidChange ( void ) // Done with this self-induced power state change. //********************************************************************************* -void IOService::OurChangeFinish ( void ) +void +IOService::OurChangeFinish( void ) { - all_done(); + all_done(); } // MARK: - @@ -4445,71 +4841,162 @@ void IOService::OurChangeFinish ( void ) // Here we begin the processing of a power change initiated by our parent. //********************************************************************************* -IOReturn IOService::ParentChangeStart ( void ) +IOReturn +IOService::ParentChangeStart( void ) { PM_ASSERT_IN_GATE(); - OUR_PMLog( kPMLogStartParentChange, fHeadNotePowerState, fCurrentPowerState ); - - // Power domain is lowering power - if ( fHeadNotePowerState < fCurrentPowerState ) - { - // TODO: redundant? See handlePowerDomainWillChangeTo() - setParentInfo( fHeadNoteParentFlags, fHeadNoteParentConnection, true ); + OUR_PMLog( kPMLogStartParentChange, fHeadNotePowerState, fCurrentPowerState ); + + // Root power domain has transitioned to its max power state + if ((fHeadNoteChangeFlags & (kIOPMDomainDidChange | kIOPMRootChangeUp)) == + (kIOPMDomainDidChange | kIOPMRootChangeUp)) { + // Restart the idle timer stopped by ParentChangeRootChangeDown() + if (fIdleTimerPeriod && fIdleTimerStopped) { + restartIdleTimer(); + } + } - PM_ACTION_2(actionPowerChangeStart, fHeadNotePowerState, &fHeadNoteChangeFlags); + // Power domain is forcing us to lower power + if (StateOrder(fHeadNotePowerState) < StateOrder(fCurrentPowerState)) { + PM_ACTION_2(actionPowerChangeStart, fHeadNotePowerState, &fHeadNoteChangeFlags); - // Tell apps and kernel clients - fInitialPowerChange = false; - fMachineState = kIOPM_ParentChangeTellPriorityClientsPowerDown; + // Tell apps and kernel clients + fInitialPowerChange = false; + fMachineState = kIOPM_ParentChangeTellPriorityClientsPowerDown; tellChangeDown1(fHeadNotePowerState); - return IOPMWillAckLater; - } - - // Power domain is raising power - if ( fHeadNotePowerState > fCurrentPowerState ) - { - if ( fDesiredPowerState > fCurrentPowerState ) - { - if ( fDesiredPowerState < fHeadNotePowerState ) - { - // We power up, but not all the way - fHeadNotePowerState = fDesiredPowerState; + return IOPMWillAckLater; + } + + // Power domain is allowing us to raise power up to fHeadNotePowerState + if (StateOrder(fHeadNotePowerState) > StateOrder(fCurrentPowerState)) { + if (StateOrder(fDesiredPowerState) > StateOrder(fCurrentPowerState)) { + if (StateOrder(fDesiredPowerState) < StateOrder(fHeadNotePowerState)) { + // We power up, but not all the way + fHeadNotePowerState = fDesiredPowerState; fHeadNotePowerArrayEntry = &fPowerStates[fDesiredPowerState]; - OUR_PMLog(kPMLogAmendParentChange, fHeadNotePowerState, 0); - } - } else { - // We don't need to change - fHeadNotePowerState = fCurrentPowerState; - fHeadNotePowerArrayEntry = &fPowerStates[fCurrentPowerState]; - OUR_PMLog(kPMLogAmendParentChange, fHeadNotePowerState, 0); - } - } - - if ( fHeadNoteChangeFlags & kIOPMDomainDidChange ) - { - if ( fHeadNotePowerState > fCurrentPowerState ) - { - PM_ACTION_2(actionPowerChangeStart, - fHeadNotePowerState, &fHeadNoteChangeFlags); - - // Parent did change up - start our change up - fInitialPowerChange = false; - ParentChangeTellCapabilityWillChange(); - return IOPMWillAckLater; - } - else if (fHeadNoteChangeFlags & kIOPMSynchronize) - { - // We do not need to change power state, but notify - // children to propagate tree synchronization. - fMachineState = kIOPM_SyncNotifyDidChange; - fDriverCallReason = kDriverCallInformPreChange; - notifyChildren(); - return IOPMWillAckLater; - } - } - - all_done(); - return IOPMAckImplied; + OUR_PMLog(kPMLogAmendParentChange, fHeadNotePowerState, 0); + } + } else { + // We don't need to change + fHeadNotePowerState = fCurrentPowerState; + fHeadNotePowerArrayEntry = &fPowerStates[fCurrentPowerState]; + OUR_PMLog(kPMLogAmendParentChange, fHeadNotePowerState, 0); + } + } + + if (fHeadNoteChangeFlags & kIOPMDomainDidChange) { + if (StateOrder(fHeadNotePowerState) > StateOrder(fCurrentPowerState)) { + PM_ACTION_2(actionPowerChangeStart, + fHeadNotePowerState, &fHeadNoteChangeFlags); + + // Parent did change up - start our change up + fInitialPowerChange = false; + ParentChangeTellCapabilityWillChange(); + return IOPMWillAckLater; + } else if (fHeadNoteChangeFlags & kIOPMRootBroadcastFlags) { + // No need to change power state, but broadcast change + // to our children. + fMachineState = kIOPM_SyncNotifyDidChange; + fDriverCallReason = kDriverCallInformPreChange; + fHeadNoteChangeFlags |= kIOPMNotDone; + notifyChildren(); + return IOPMWillAckLater; + } + } + + // No power state change necessary + fHeadNoteChangeFlags |= kIOPMNotDone; + + all_done(); + return IOPMAckImplied; +} + +//****************************************************************************** +// [private] ParentChangeRootChangeDown +// +// Root domain has finished the transition to the system sleep state. And all +// drivers in the power plane should have powered down. Cancel the idle timer, +// and also reset the device desire for those drivers that don't want power +// automatically restored on wake. +//****************************************************************************** + +void +IOService::ParentChangeRootChangeDown( void ) +{ + // Always stop the idle timer before root power down + if (fIdleTimerPeriod && !fIdleTimerStopped) { + fIdleTimerStopped = true; + if (fIdleTimer && thread_call_cancel(fIdleTimer)) { + release(); + } + } + + if (fResetPowerStateOnWake) { + // Reset device desire down to the lowest power state. + // Advisory tickle desire is intentionally untouched since + // it has no effect until system is promoted to full wake. + + if (fDeviceDesire != kPowerStateZero) { + updatePowerClient(gIOPMPowerClientDevice, kPowerStateZero); + computeDesiredState(kPowerStateZero, true); + requestDomainPower( fDesiredPowerState ); + PM_LOG1("%s: tickle desire removed\n", fName); + } + + // Invalidate tickle cache so the next tickle will issue a request + IOLockLock(fActivityLock); + fDeviceWasActive = false; + fActivityTicklePowerState = kInvalidTicklePowerState; + IOLockUnlock(fActivityLock); + + fIdleTimerMinPowerState = kPowerStateZero; + } else if (fAdvisoryTickleUsed) { + // Less aggressive mechanism to accelerate idle timer expiration + // before system sleep. May not always allow the driver to wake + // up from system sleep in the min power state. + + AbsoluteTime now; + uint64_t nsec; + bool dropTickleDesire = false; + + if (fIdleTimerPeriod && !fIdleTimerIgnored && + (fIdleTimerMinPowerState == kPowerStateZero) && + (fDeviceDesire != kPowerStateZero)) { + IOLockLock(fActivityLock); + + if (!fDeviceWasActive) { + // No tickles since the last idle timer expiration. + // Safe to drop the device desire to zero. + dropTickleDesire = true; + } else { + // Was tickled since the last idle timer expiration, + // but not in the last minute. + clock_get_uptime(&now); + SUB_ABSOLUTETIME(&now, &fDeviceActiveTimestamp); + absolutetime_to_nanoseconds(now, &nsec); + if (nsec >= kNoTickleCancelWindow) { + dropTickleDesire = true; + } + } + + if (dropTickleDesire) { + // Force the next tickle to raise power state + fDeviceWasActive = false; + fActivityTicklePowerState = kInvalidTicklePowerState; + } + + IOLockUnlock(fActivityLock); + } + + if (dropTickleDesire) { + // Advisory tickle desire is intentionally untouched since + // it has no effect until system is promoted to full wake. + + updatePowerClient(gIOPMPowerClientDevice, kPowerStateZero); + computeDesiredState(kPowerStateZero, true); + PM_LOG1("%s: tickle desire dropped\n", fName); + } + } } //********************************************************************************* @@ -4519,9 +5006,10 @@ IOReturn IOService::ParentChangeStart ( void ) // power. Here we notify "priority" clients that we are lowering power. //********************************************************************************* -void IOService::ParentChangeTellPriorityClientsPowerDown ( void ) +void +IOService::ParentChangeTellPriorityClientsPowerDown( void ) { - fMachineState = kIOPM_ParentChangeNotifyInterestedDriversWillChange; + fMachineState = kIOPM_ParentChangeNotifyInterestedDriversWillChange; tellChangeDown2(fHeadNotePowerState); } @@ -4532,12 +5020,14 @@ void IOService::ParentChangeTellPriorityClientsPowerDown ( void ) // root domain to notify apps and drivers about the system capability change. //********************************************************************************* -void IOService::ParentChangeTellCapabilityWillChange ( void ) +void +IOService::ParentChangeTellCapabilityWillChange( void ) { - if (!IS_ROOT_DOMAIN) - return ParentChangeNotifyInterestedDriversWillChange(); + if (!IS_ROOT_DOMAIN) { + return ParentChangeNotifyInterestedDriversWillChange(); + } - tellSystemCapabilityChange( kIOPM_ParentChangeNotifyInterestedDriversWillChange ); + tellSystemCapabilityChange( kIOPM_ParentChangeNotifyInterestedDriversWillChange ); } //********************************************************************************* @@ -4547,7 +5037,8 @@ void IOService::ParentChangeTellCapabilityWillChange ( void ) // Here we notify interested drivers pre-change. //********************************************************************************* -void IOService::ParentChangeNotifyInterestedDriversWillChange ( void ) +void +IOService::ParentChangeNotifyInterestedDriversWillChange( void ) { notifyAll( kIOPM_ParentChangeSetPowerState ); } @@ -4559,14 +5050,16 @@ void IOService::ParentChangeNotifyInterestedDriversWillChange ( void ) // change. Wait for async completions. //********************************************************************************* -void IOService::ParentChangeSetPowerState ( void ) +void +IOService::ParentChangeSetPowerState( void ) { - MS_PUSH( kIOPM_ParentChangeWaitForPowerSettle ); - fMachineState = kIOPM_DriverThreadCallDone; - fDriverCallReason = kDriverCallSetPowerState; + MS_PUSH( kIOPM_ParentChangeWaitForPowerSettle ); + fMachineState = kIOPM_DriverThreadCallDone; + fDriverCallReason = kDriverCallSetPowerState; - if (notifyControllingDriver() == false) - notifyControllingDriverDone(); + if (notifyControllingDriver() == false) { + notifyControllingDriverDone(); + } } //********************************************************************************* @@ -4576,10 +5069,11 @@ void IOService::ParentChangeSetPowerState ( void ) // parent. Wait for the driver specified settle time to expire. //********************************************************************************* -void IOService::ParentChangeWaitForPowerSettle ( void ) +void +IOService::ParentChangeWaitForPowerSettle( void ) { fMachineState = kIOPM_ParentChangeNotifyInterestedDriversDidChange; - startSettleTimer(); + startSettleTimer(); } //********************************************************************************* @@ -4589,9 +5083,10 @@ void IOService::ParentChangeWaitForPowerSettle ( void ) // all our interested drivers post-change. //********************************************************************************* -void IOService::ParentChangeNotifyInterestedDriversDidChange ( void ) +void +IOService::ParentChangeNotifyInterestedDriversDidChange( void ) { - notifyAll( kIOPM_ParentChangeTellCapabilityDidChange ); + notifyAll( kIOPM_ParentChangeTellCapabilityDidChange ); } //********************************************************************************* @@ -4600,35 +5095,37 @@ void IOService::ParentChangeNotifyInterestedDriversDidChange ( void ) // For root domain to notify capability power-change. //********************************************************************************* -void IOService::ParentChangeTellCapabilityDidChange ( void ) +void +IOService::ParentChangeTellCapabilityDidChange( void ) { - if (!IS_ROOT_DOMAIN) - return ParentChangeAcknowledgePowerChange(); + if (!IS_ROOT_DOMAIN) { + return ParentChangeAcknowledgePowerChange(); + } - tellSystemCapabilityChange( kIOPM_ParentChangeAcknowledgePowerChange ); + tellSystemCapabilityChange( kIOPM_ParentChangeAcknowledgePowerChange ); } //********************************************************************************* // [private] ParentAcknowledgePowerChange // -// Acknowledge our power parent that our power change is done. +// Acknowledge our power parent that our power change is done. //********************************************************************************* -void IOService::ParentChangeAcknowledgePowerChange ( void ) +void +IOService::ParentChangeAcknowledgePowerChange( void ) { - IORegistryEntry * nub; - IOService * parent; + IORegistryEntry * nub; + IOService * parent; - nub = fHeadNoteParentConnection; - nub->retain(); - all_done(); - parent = (IOService *)nub->copyParentEntry(gIOPowerPlane); - if ( parent ) - { - parent->acknowledgePowerChange((IOService *)nub); - parent->release(); - } - nub->release(); + nub = fHeadNoteParentConnection; + nub->retain(); + all_done(); + parent = (IOService *)nub->copyParentEntry(gIOPowerPlane); + if (parent) { + parent->acknowledgePowerChange((IOService *)nub); + parent->release(); + } + nub->release(); } // MARK: - @@ -4641,7 +5138,8 @@ void IOService::ParentChangeAcknowledgePowerChange ( void ) // there is a new power state. //********************************************************************************* -void IOService::settleTimerExpired( void ) +void +IOService::settleTimerExpired( void ) { fSettleTimeUS = 0; gIOPMWorkQueue->signalWorkAvailable(); @@ -4658,11 +5156,10 @@ settle_timer_expired( thread_call_param_t arg0, thread_call_param_t arg1 ) { IOService * me = (IOService *) arg0; - if (gIOPMWorkLoop && gIOPMWorkQueue) - { + if (gIOPMWorkLoop && gIOPMWorkQueue) { gIOPMWorkLoop->runAction( - OSMemberFunctionCast(IOWorkLoop::Action, me, &IOService::settleTimerExpired), - me); + OSMemberFunctionCast(IOWorkLoop::Action, me, &IOService::settleTimerExpired), + me); } me->release(); } @@ -4673,44 +5170,55 @@ settle_timer_expired( thread_call_param_t arg0, thread_call_param_t arg1 ) // Calculate a power-settling delay in microseconds and start a timer. //********************************************************************************* -void IOService::startSettleTimer( void ) -{ - AbsoluteTime deadline; - IOPMPowerStateIndex i; - uint32_t settleTime = 0; +void +IOService::startSettleTimer( void ) +{ +#if NOT_USEFUL + // This function is broken and serves no useful purpose since it never + // updates fSettleTimeUS to a non-zero value to stall the state machine, + // yet it starts a delay timer. It appears no driver relies on a delay + // from settleUpTime and settleDownTime in the power state table. + + AbsoluteTime deadline; + IOPMPowerStateIndex stateIndex; + IOPMPowerStateIndex currentOrder, newOrder, i; + uint32_t settleTime = 0; boolean_t pending; PM_ASSERT_IN_GATE(); - i = fCurrentPowerState; - - // lowering power - if ( fHeadNotePowerState < fCurrentPowerState ) - { - while ( i > fHeadNotePowerState ) - { - settleTime += (uint32_t) fPowerStates[i].settleDownTime; - i--; - } - } - - // raising power - if ( fHeadNotePowerState > fCurrentPowerState ) - { - while ( i < fHeadNotePowerState ) - { - settleTime += (uint32_t) fPowerStates[i+1].settleUpTime; - i++; - } - } - - if (settleTime) - { - retain(); - clock_interval_to_deadline(settleTime, kMicrosecondScale, &deadline); - pending = thread_call_enter_delayed(fSettleTimer, deadline); - if (pending) release(); - } + currentOrder = StateOrder(fCurrentPowerState); + newOrder = StateOrder(fHeadNotePowerState); + + i = currentOrder; + + // lowering power + if (newOrder < currentOrder) { + while (i > newOrder) { + stateIndex = fPowerStates[i].stateOrderToIndex; + settleTime += (uint32_t) fPowerStates[stateIndex].settleDownTime; + i--; + } + } + + // raising power + if (newOrder > currentOrder) { + while (i < newOrder) { + stateIndex = fPowerStates[i + 1].stateOrderToIndex; + settleTime += (uint32_t) fPowerStates[stateIndex].settleUpTime; + i++; + } + } + + if (settleTime) { + retain(); + clock_interval_to_deadline(settleTime, kMicrosecondScale, &deadline); + pending = thread_call_enter_delayed(fSettleTimer, deadline); + if (pending) { + release(); + } + } +#endif } //********************************************************************************* @@ -4729,206 +5237,369 @@ void IOService::startSettleTimer( void ) //********************************************************************************* #ifndef __LP64__ -void IOService::ack_timer_ticked ( void ) +#if MACH_ASSERT +__dead2 +#endif +void +IOService::ack_timer_ticked( void ) { assert(false); } #endif /* !__LP64__ */ -bool IOService::ackTimerTick( void ) +bool +IOService::ackTimerTick( void ) { - IOPMinformee * nextObject; - bool done = false; + IOPMinformee * nextObject; + bool done = false; PM_ASSERT_IN_GATE(); - switch (fMachineState) { - case kIOPM_OurChangeWaitForPowerSettle: - case kIOPM_ParentChangeWaitForPowerSettle: - // are we waiting for controlling driver to acknowledge? - if ( fDriverTimer > 0 ) - { - // yes, decrement timer tick - fDriverTimer--; - if ( fDriverTimer == 0 ) - { - // controlling driver is tardy - uint64_t nsec = computeTimeDeltaNS(&fDriverCallStartTime); - OUR_PMLog(kPMLogCtrlDriverTardy, 0, 0); - setProperty(kIOPMTardyAckSPSKey, kOSBooleanTrue); - PM_ERROR("%s::setPowerState(%p, %lu -> %lu) timed out after %d ms\n", - fName, this, fCurrentPowerState, fHeadNotePowerState, NS_TO_MS(nsec)); - -#if LOG_SETPOWER_TIMES - PMEventDetails *details = PMEventDetails::eventDetails( - kIOPMEventTypeSetPowerStateDelayed, // type - fName, // who - (uintptr_t)this, // owner unique - NULL, // interest name - (uint8_t)getPowerState(), // old - 0, // new - kIOReturnTimeout, // result - NS_TO_US(nsec)); // usec completion time - - getPMRootDomain()->recordAndReleasePMEventGated( details ); -#endif - - if (gIOKitDebug & kIOLogDebugPower) - { - panic("%s::setPowerState(%p, %lu -> %lu) timed out after %d ms", - fName, this, fCurrentPowerState, fHeadNotePowerState, NS_TO_MS(nsec)); - } - else - { - // Unblock state machine and pretend driver has acked. - done = true; + switch (fMachineState) { + case kIOPM_OurChangeWaitForPowerSettle: + case kIOPM_ParentChangeWaitForPowerSettle: + // are we waiting for controlling driver to acknowledge? + if (fDriverTimer > 0) { + // yes, decrement timer tick + fDriverTimer--; + if (fDriverTimer == 0) { + // controlling driver is tardy + uint64_t nsec = computeTimeDeltaNS(&fDriverCallStartTime); + OUR_PMLog(kPMLogCtrlDriverTardy, 0, 0); + setProperty(kIOPMTardyAckSPSKey, kOSBooleanTrue); + PM_ERROR("%s::setPowerState(%p, %lu -> %lu) timed out after %d ms\n", + fName, OBFUSCATE(this), fCurrentPowerState, fHeadNotePowerState, NS_TO_MS(nsec)); + +#if DEBUG || DEVELOPMENT || CONFIG_EMBEDDED + uint32_t panic_allowed = -1; + PE_parse_boot_argn("setpowerstate_panic", &panic_allowed, sizeof(panic_allowed)); + if (panic_allowed != 0) { + // rdar://problem/48743340 - excluding AppleSEPManager from panic + const char *whitelist = "AppleSEPManager"; + if (strncmp(fName, whitelist, strlen(whitelist))) { + panic("%s::setPowerState(%p, %lu -> %lu) timed out after %d ms", + fName, this, fCurrentPowerState, fHeadNotePowerState, NS_TO_MS(nsec)); } - } else { - // still waiting, set timer again - start_ack_timer(); - } - } - break; - - case kIOPM_NotifyChildrenStart: - // are we waiting for interested parties to acknowledge? - if ( fHeadNotePendingAcks != 0 ) - { - // yes, go through the list of interested drivers - nextObject = fInterestedDrivers->firstInList(); - // and check each one - while ( nextObject != NULL ) - { - if ( nextObject->timer > 0 ) - { - nextObject->timer--; - // this one should have acked by now - if ( nextObject->timer == 0 ) - { - uint64_t nsec = computeTimeDeltaNS(&nextObject->startTime); - OUR_PMLog(kPMLogIntDriverTardy, 0, 0); - nextObject->whatObject->setProperty(kIOPMTardyAckPSCKey, kOSBooleanTrue); - PM_ERROR("%s::powerState%sChangeTo(%p, %s, %lu -> %lu) timed out after %d ms\n", - nextObject->whatObject->getName(), - (fDriverCallReason == kDriverCallInformPreChange) ? "Will" : "Did", - nextObject->whatObject, fName, fCurrentPowerState, fHeadNotePowerState, - NS_TO_MS(nsec)); - -#if LOG_SETPOWER_TIMES - uint16_t logType = (fDriverCallReason == kDriverCallInformPreChange) - ? kIOPMEventTypePSWillChangeTo - : kIOPMEventTypePSDidChangeTo; - - PMEventDetails *details = PMEventDetails::eventDetails( - logType, // type - fName, // who - (uintptr_t)this, // owner unique - nextObject->whatObject->getName(), // interest name - (uint8_t)fCurrentPowerState, // old - (uint8_t)fHeadNotePowerState, // new - kIOReturnTimeout, // result - NS_TO_US(nsec)); // usec completion time - - getPMRootDomain()->recordAndReleasePMEventGated( details ); -#endif - - // Pretend driver has acked. - fHeadNotePendingAcks--; - } - } - nextObject = fInterestedDrivers->nextInList(nextObject); - } - - // is that the last? - if ( fHeadNotePendingAcks == 0 ) - { - // yes, we can continue + } else { + PM_ERROR("setPowerState panic disabled by setpowerstate_panic boot-arg\n"); + } +#else + if (gIOKitDebug & kIOLogDebugPower) { + panic("%s::setPowerState(%p, %lu -> %lu) timed out after %d ms", + fName, this, fCurrentPowerState, fHeadNotePowerState, NS_TO_MS(nsec)); + } else { + // panic for first party kexts + const void *function_addr = NULL; + OSKext *kext = NULL; + function_addr = OSMemberFunctionCast(const void *, fControllingDriver, &IOService::setPowerState); + kext = OSKext::lookupKextWithAddress((vm_address_t)function_addr); + if (kext) { + const char *bundleID = kext->getIdentifierCString(); + const char *apple_prefix = "com.apple"; + const char *kernel_prefix = "__kernel__"; + if (strncmp(bundleID, apple_prefix, strlen(apple_prefix)) == 0 || strncmp(bundleID, kernel_prefix, strlen(kernel_prefix)) == 0) { + // first party client + panic("%s::setPowerState(%p : %p, %lu -> %lu) timed out after %d ms", + fName, this, function_addr, fCurrentPowerState, fHeadNotePowerState, NS_TO_MS(nsec)); + } + kext->release(); + } + // Unblock state machine and pretend driver has acked. done = true; - } else { - // no, set timer again - start_ack_timer(); - } - } - break; - - // TODO: aggreggate this - case kIOPM_OurChangeTellClientsPowerDown: - case kIOPM_OurChangeTellPriorityClientsPowerDown: - case kIOPM_OurChangeNotifyInterestedDriversWillChange: - case kIOPM_ParentChangeTellPriorityClientsPowerDown: - case kIOPM_ParentChangeNotifyInterestedDriversWillChange: - case kIOPM_SyncTellClientsPowerDown: - case kIOPM_SyncTellPriorityClientsPowerDown: - case kIOPM_SyncNotifyWillChange: - case kIOPM_TellCapabilityChangeDone: - // apps didn't respond in time - cleanClientResponses(true); - OUR_PMLog(kPMLogClientTardy, 0, 1); - // tardy equates to approval - done = true; - break; + } +#endif + getPMRootDomain()->reset_watchdog_timer(this, 0); + } else { + // still waiting, set timer again + start_ack_timer(); + } + } + break; + + case kIOPM_NotifyChildrenStart: + // are we waiting for interested parties to acknowledge? + if (fHeadNotePendingAcks != 0) { + // yes, go through the list of interested drivers + nextObject = fInterestedDrivers->firstInList(); + // and check each one + while (nextObject != NULL) { + if (nextObject->timer > 0) { + nextObject->timer--; + // this one should have acked by now + if (nextObject->timer == 0) { + uint64_t nsec = computeTimeDeltaNS(&nextObject->startTime); + OUR_PMLog(kPMLogIntDriverTardy, 0, 0); + nextObject->whatObject->setProperty(kIOPMTardyAckPSCKey, kOSBooleanTrue); + PM_ERROR("%s::powerState%sChangeTo(%p, %s, %lu -> %lu) timed out after %d ms\n", + nextObject->whatObject->getName(), + (fDriverCallReason == kDriverCallInformPreChange) ? "Will" : "Did", + OBFUSCATE(nextObject->whatObject), fName, fCurrentPowerState, fHeadNotePowerState, + NS_TO_MS(nsec)); + + // Pretend driver has acked. + fHeadNotePendingAcks--; + } + } + nextObject = fInterestedDrivers->nextInList(nextObject); + } - default: - PM_LOG1("%s: unexpected ack timer tick (state = %d)\n", - getName(), fMachineState); - break; - } + // is that the last? + if (fHeadNotePendingAcks == 0) { + // yes, we can continue + done = true; + getPMRootDomain()->reset_watchdog_timer(this, 0); + } else { + // no, set timer again + start_ack_timer(); + } + } + break; + + // TODO: aggreggate this + case kIOPM_OurChangeTellClientsPowerDown: + case kIOPM_OurChangeTellUserPMPolicyPowerDown: + case kIOPM_OurChangeTellPriorityClientsPowerDown: + case kIOPM_OurChangeNotifyInterestedDriversWillChange: + case kIOPM_ParentChangeTellPriorityClientsPowerDown: + case kIOPM_ParentChangeNotifyInterestedDriversWillChange: + case kIOPM_SyncTellClientsPowerDown: + case kIOPM_SyncTellPriorityClientsPowerDown: + case kIOPM_SyncNotifyWillChange: + case kIOPM_TellCapabilityChangeDone: + // apps didn't respond in time + cleanClientResponses(true); + OUR_PMLog(kPMLogClientTardy, 0, 1); + // tardy equates to approval + done = true; + break; + + default: + PM_LOG1("%s: unexpected ack timer tick (state = %d)\n", + getName(), fMachineState); + break; + } return done; } //********************************************************************************* -// [private] start_ack_timer +// [private] start_watchdog_timer //********************************************************************************* - -void IOService::start_ack_timer ( void ) +void +IOService::start_watchdog_timer( void ) { - start_ack_timer( ACK_TIMER_PERIOD, kNanosecondScale ); + int timeout; + uint64_t deadline; + + if (!fWatchdogTimer || (kIOSleepWakeWdogOff & gIOKitDebug)) { + return; + } + + IOLockLock(fWatchdogLock); + + timeout = getPMRootDomain()->getWatchdogTimeout(); + clock_interval_to_deadline(timeout, kSecondScale, &deadline); + fWatchdogDeadline = deadline; + start_watchdog_timer(deadline); + IOLockUnlock(fWatchdogLock); } -void IOService::start_ack_timer ( UInt32 interval, UInt32 scale ) +void +IOService::start_watchdog_timer(uint64_t deadline) { - AbsoluteTime deadline; - boolean_t pending; + IOLockAssert(fWatchdogLock, kIOLockAssertOwned); - clock_interval_to_deadline(interval, scale, &deadline); - - retain(); - pending = thread_call_enter_delayed(fAckTimer, deadline); - if (pending) release(); + if (!thread_call_isactive(fWatchdogTimer)) { + thread_call_enter_delayed(fWatchdogTimer, deadline); + } } //********************************************************************************* -// [private] stop_ack_timer +// [private] stop_watchdog_timer //********************************************************************************* -void IOService::stop_ack_timer ( void ) +void +IOService::stop_watchdog_timer( void ) { - boolean_t pending; + if (!fWatchdogTimer || (kIOSleepWakeWdogOff & gIOKitDebug)) { + return; + } + + IOLockLock(fWatchdogLock); + + thread_call_cancel(fWatchdogTimer); + fWatchdogDeadline = 0; + + while (fBlockedArray->getCount()) { + IOService *obj = OSDynamicCast(IOService, fBlockedArray->getObject(0)); + if (obj) { + PM_ERROR("WDOG:Object %s unexpected in blocked array\n", obj->fName); + fBlockedArray->removeObject(0); + } + } - pending = thread_call_cancel(fAckTimer); - if (pending) release(); + IOLockUnlock(fWatchdogLock); } //********************************************************************************* -// [static] actionAckTimerExpired -// -// Inside PM work loop's gate. +// reset_watchdog_timer //********************************************************************************* -IOReturn -IOService::actionAckTimerExpired ( - OSObject * target, - void * arg0, void * arg1, - void * arg2, void * arg3 ) +void +IOService::reset_watchdog_timer(IOService *blockedObject, int pendingResponseTimeout) { - IOService * me = (IOService *) target; - bool done; + unsigned int i; + uint64_t deadline; + IOService *obj; - // done will be true if the timer tick unblocks the machine state, + if (!fWatchdogTimer || (kIOSleepWakeWdogOff & gIOKitDebug)) { + return; + } + + + IOLockLock(fWatchdogLock); + if (!fWatchdogDeadline) { + goto exit; + } + + i = fBlockedArray->getNextIndexOfObject(blockedObject, 0); + if (pendingResponseTimeout == 0) { + blockedObject->fPendingResponseDeadline = 0; + if (i == (unsigned int)-1) { + goto exit; + } + fBlockedArray->removeObject(i); + } else { + // Set deadline 2secs after the expected response timeout to allow + // ack timer to handle the timeout. + clock_interval_to_deadline(pendingResponseTimeout + 2, kSecondScale, &deadline); + + if (i != (unsigned int)-1) { + PM_ERROR("WDOG:Object %s is already blocked for responses. Ignoring timeout %d\n", + fName, pendingResponseTimeout); + goto exit; + } + + for (i = 0; i < fBlockedArray->getCount(); i++) { + obj = OSDynamicCast(IOService, fBlockedArray->getObject(i)); + if (obj && (obj->fPendingResponseDeadline < deadline)) { + blockedObject->fPendingResponseDeadline = deadline; + fBlockedArray->setObject(i, blockedObject); + break; + } + } + if (i == fBlockedArray->getCount()) { + blockedObject->fPendingResponseDeadline = deadline; + fBlockedArray->setObject(blockedObject); + } + } + + obj = OSDynamicCast(IOService, fBlockedArray->getObject(0)); + if (!obj) { + int timeout = getPMRootDomain()->getWatchdogTimeout(); + clock_interval_to_deadline(timeout, kSecondScale, &deadline); + } else { + deadline = obj->fPendingResponseDeadline; + } + + thread_call_cancel(fWatchdogTimer); + start_watchdog_timer(deadline); + +exit: + IOLockUnlock(fWatchdogLock); +} + + +//********************************************************************************* +// [static] watchdog_timer_expired +// +// Inside PM work loop's gate. +//********************************************************************************* + +void +IOService::watchdog_timer_expired( thread_call_param_t arg0, thread_call_param_t arg1 ) +{ + IOService * me = (IOService *) arg0; + + + gIOPMWatchDogThread = current_thread(); + getPMRootDomain()->sleepWakeDebugTrig(true); + gIOPMWatchDogThread = NULL; + thread_call_free(me->fWatchdogTimer); + me->fWatchdogTimer = NULL; + + return; +} + + +IOWorkLoop * +IOService::getIOPMWorkloop( void ) +{ + return gIOPMWorkLoop; +} + + + +//********************************************************************************* +// [private] start_ack_timer +//********************************************************************************* + +void +IOService::start_ack_timer( void ) +{ + start_ack_timer( ACK_TIMER_PERIOD, kNanosecondScale ); +} + +void +IOService::start_ack_timer( UInt32 interval, UInt32 scale ) +{ + AbsoluteTime deadline; + boolean_t pending; + + clock_interval_to_deadline(interval, scale, &deadline); + + retain(); + pending = thread_call_enter_delayed(fAckTimer, deadline); + if (pending) { + release(); + } +} + +//********************************************************************************* +// [private] stop_ack_timer +//********************************************************************************* + +void +IOService::stop_ack_timer( void ) +{ + boolean_t pending; + + pending = thread_call_cancel(fAckTimer); + if (pending) { + release(); + } +} + +//********************************************************************************* +// [static] actionAckTimerExpired +// +// Inside PM work loop's gate. +//********************************************************************************* + +IOReturn +IOService::actionAckTimerExpired( + OSObject * target, + void * arg0, void * arg1, + void * arg2, void * arg3 ) +{ + IOService * me = (IOService *) target; + bool done; + + // done will be true if the timer tick unblocks the machine state, // otherwise no need to signal the work loop. done = me->ackTimerTick(); - if (done && gIOPMWorkQueue) + if (done && gIOPMWorkQueue) { gIOPMWorkQueue->signalWorkAvailable(); + } return kIOReturnSuccess; } @@ -4940,17 +5611,17 @@ IOService::actionAckTimerExpired ( //********************************************************************************* void -IOService::ack_timer_expired ( thread_call_param_t arg0, thread_call_param_t arg1 ) +IOService::ack_timer_expired( thread_call_param_t arg0, thread_call_param_t arg1 ) { IOService * me = (IOService *) arg0; - if (gIOPMWorkLoop) - { + if (gIOPMWorkLoop) { gIOPMWorkLoop->runAction(&actionAckTimerExpired, me); } me->release(); } + // MARK: - // MARK: Client Messaging @@ -4958,24 +5629,22 @@ IOService::ack_timer_expired ( thread_call_param_t arg0, thread_call_param_t arg // [private] tellSystemCapabilityChange //********************************************************************************* -void IOService::tellSystemCapabilityChange( uint32_t nextMS ) +void +IOService::tellSystemCapabilityChange( uint32_t nextMS ) { MS_PUSH( nextMS ); - fMachineState = kIOPM_TellCapabilityChangeDone; - fOutOfBandMessage = kIOMessageSystemCapabilityChange; - - if (fIsPreChange) - { - // Notify app first on pre-change. - fOutOfBandParameter = kNotifyCapabilityChangeApps; - } - else - { - // Notify kernel clients first on post-change. - fOutOfBandParameter = kNotifyCapabilityChangePriority; - } + fMachineState = kIOPM_TellCapabilityChangeDone; + fOutOfBandMessage = kIOMessageSystemCapabilityChange; + + if (fIsPreChange) { + // Notify app first on pre-change. + fOutOfBandParameter = kNotifyCapabilityChangeApps; + } else { + // Notify kernel clients first on post-change. + fOutOfBandParameter = kNotifyCapabilityChangePriority; + } - tellClientsWithResponse( fOutOfBandMessage ); + tellClientsWithResponse( fOutOfBandMessage ); } //********************************************************************************* @@ -4990,9 +5659,10 @@ void IOService::tellSystemCapabilityChange( uint32_t nextMS ) // Return true if we don't have to wait for acknowledgements //********************************************************************************* -bool IOService::askChangeDown ( unsigned long stateNum ) +bool +IOService::askChangeDown( unsigned long stateNum ) { - return tellClientsWithResponse( kIOMessageCanDevicePowerOff ); + return tellClientsWithResponse( kIOMessageCanDevicePowerOff ); } //********************************************************************************* @@ -5004,10 +5674,11 @@ bool IOService::askChangeDown ( unsigned long stateNum ) // Return true if we don't have to wait for acknowledgements //********************************************************************************* -bool IOService::tellChangeDown1 ( unsigned long stateNum ) +bool +IOService::tellChangeDown1( unsigned long stateNum ) { - fOutOfBandParameter = kNotifyApps; - return tellChangeDown(stateNum); + fOutOfBandParameter = kNotifyApps; + return tellChangeDown(stateNum); } //********************************************************************************* @@ -5018,10 +5689,11 @@ bool IOService::tellChangeDown1 ( unsigned long stateNum ) // Return true if we don't have to wait for acknowledgements //********************************************************************************* -bool IOService::tellChangeDown2 ( unsigned long stateNum ) +bool +IOService::tellChangeDown2( unsigned long stateNum ) { - fOutOfBandParameter = kNotifyPriority; - return tellChangeDown(stateNum); + fOutOfBandParameter = kNotifyPriority; + return tellChangeDown(stateNum); } //********************************************************************************* @@ -5036,9 +5708,10 @@ bool IOService::tellChangeDown2 ( unsigned long stateNum ) // Return true if we don't have to wait for acknowledgements //********************************************************************************* -bool IOService::tellChangeDown ( unsigned long stateNum ) +bool +IOService::tellChangeDown( unsigned long stateNum ) { - return tellClientsWithResponse( kIOMessageDeviceWillPowerOff ); + return tellClientsWithResponse( kIOMessageDeviceWillPowerOff ); } //********************************************************************************* @@ -5046,91 +5719,94 @@ bool IOService::tellChangeDown ( unsigned long stateNum ) // //********************************************************************************* -static void logAppTimeouts ( OSObject * object, void * arg ) -{ - IOPMInterestContext * context = (IOPMInterestContext *) arg; - OSObject * flag; - unsigned int clientIndex; - - if (OSDynamicCast(_IOServiceInterestNotifier, object)) - { - // Discover the 'counter' value or index assigned to this client - // when it was notified, by searching for the array index of the - // client in an array holding the cached interested clients. - - clientIndex = context->notifyClients->getNextIndexOfObject(object, 0); - - if ((clientIndex != (unsigned int) -1) && - (flag = context->responseArray->getObject(clientIndex)) && - (flag != kOSBooleanTrue)) - { - OSString * clientID = 0; - context->us->messageClient(context->messageType, object, &clientID); - PM_ERROR(context->errorLog, clientID ? clientID->getCStringNoCopy() : ""); - - // TODO: record message type if possible - IOService::getPMRootDomain()->pmStatsRecordApplicationResponse( - gIOPMStatsApplicationResponseTimedOut, - clientID ? clientID->getCStringNoCopy() : "", - 0, (30*1000), -1); - - if (clientID) - clientID->release(); - } - } -} - -void IOService::cleanClientResponses ( bool logErrors ) -{ - if (logErrors && fResponseArray) - { - switch ( fOutOfBandParameter ) { - case kNotifyApps: - case kNotifyCapabilityChangeApps: - if (fNotifyClientArray) - { - IOPMInterestContext context; - - context.responseArray = fResponseArray; - context.notifyClients = fNotifyClientArray; - context.serialNumber = fSerialNumber; - context.messageType = kIOMessageCopyClientID; - context.notifyType = kNotifyApps; - context.isPreChange = fIsPreChange; - context.enableTracing = false; - context.us = this; - context.maxTimeRequested = 0; - context.stateNumber = fHeadNotePowerState; - context.stateFlags = fHeadNotePowerArrayEntry->capabilityFlags; - context.changeFlags = fHeadNoteChangeFlags; - context.errorLog = "PM notification timeout (%s)\n"; - - applyToInterested(gIOAppPowerStateInterest, logAppTimeouts, (void *) &context); - } - break; - - default: - // kNotifyPriority, kNotifyCapabilityChangePriority - // TODO: identify the priority client that has not acked - PM_ERROR("PM priority notification timeout\n"); - if (gIOKitDebug & kIOLogDebugPower) - { - panic("PM priority notification timeout"); - } - break; - } - } - - if (fResponseArray) - { - fResponseArray->release(); - fResponseArray = NULL; - } - if (fNotifyClientArray) - { - fNotifyClientArray->release(); - fNotifyClientArray = NULL; - } +static void +logAppTimeouts( OSObject * object, void * arg ) +{ + IOPMInterestContext * context = (IOPMInterestContext *) arg; + OSObject * flag; + unsigned int clientIndex; + int pid = 0; + char name[128]; + + if (OSDynamicCast(_IOServiceInterestNotifier, object)) { + // Discover the 'counter' value or index assigned to this client + // when it was notified, by searching for the array index of the + // client in an array holding the cached interested clients. + + clientIndex = context->notifyClients->getNextIndexOfObject(object, 0); + + if ((clientIndex != (unsigned int) -1) && + (flag = context->responseArray->getObject(clientIndex)) && + (flag != kOSBooleanTrue)) { + OSNumber *clientID = copyClientIDForNotification(object, context); + + name[0] = '\0'; + if (clientID) { + pid = clientID->unsigned32BitValue(); + proc_name(pid, name, sizeof(name)); + clientID->release(); + } + + PM_ERROR(context->errorLog, pid, name); + + // TODO: record message type if possible + IOService::getPMRootDomain()->pmStatsRecordApplicationResponse( + gIOPMStatsResponseTimedOut, + name, 0, (30 * 1000), pid, object); + } + } +} + +void +IOService::cleanClientResponses( bool logErrors ) +{ + if (logErrors && fResponseArray) { + switch (fOutOfBandParameter) { + case kNotifyApps: + case kNotifyCapabilityChangeApps: + if (fNotifyClientArray) { + IOPMInterestContext context; + + context.responseArray = fResponseArray; + context.notifyClients = fNotifyClientArray; + context.serialNumber = fSerialNumber; + context.messageType = kIOMessageCopyClientID; + context.notifyType = kNotifyApps; + context.isPreChange = fIsPreChange; + context.enableTracing = false; + context.us = this; + context.maxTimeRequested = 0; + context.stateNumber = fHeadNotePowerState; + context.stateFlags = fHeadNotePowerArrayEntry->capabilityFlags; + context.changeFlags = fHeadNoteChangeFlags; + context.errorLog = "PM notification timeout (pid %d, %s)\n"; + + applyToInterested(gIOAppPowerStateInterest, logAppTimeouts, (void *) &context); + } + break; + + default: + // kNotifyPriority, kNotifyCapabilityChangePriority + // TODO: identify the priority client that has not acked + PM_ERROR("PM priority notification timeout\n"); + if (gIOKitDebug & kIOLogDebugPower) { + panic("PM priority notification timeout"); + } + break; + } + } + + if (IS_ROOT_DOMAIN) { + getPMRootDomain()->reset_watchdog_timer(this, 0); + } + if (fResponseArray) { + fResponseArray->release(); + fResponseArray = NULL; + } + if (fNotifyClientArray) { + fNotifyClientArray->release(); + fNotifyClientArray = NULL; + } } //********************************************************************************* @@ -5142,122 +5818,149 @@ void IOService::cleanClientResponses ( bool logErrors ) // Return true if we don't have to wait for acknowledgements //********************************************************************************* -bool IOService::tellClientsWithResponse ( int messageType ) +bool +IOService::tellClientsWithResponse( int messageType ) { - IOPMInterestContext context; - bool isRootDomain = IS_ROOT_DOMAIN; + IOPMInterestContext context; + bool isRootDomain = IS_ROOT_DOMAIN; + uint32_t maxTimeOut = kMaxTimeRequested; PM_ASSERT_IN_GATE(); - assert( fResponseArray == NULL ); - assert( fNotifyClientArray == NULL ); - - RD_LOG("tellClientsWithResponse( %s, %d )\n", - getIOMessageString(messageType), fOutOfBandParameter); - - fResponseArray = OSArray::withCapacity( 1 ); - if (!fResponseArray) - goto exit; - - fResponseArray->setCapacityIncrement(8); - if (++fSerialNumber == 0) - fSerialNumber++; - - context.responseArray = fResponseArray; - context.notifyClients = 0; - context.serialNumber = fSerialNumber; - context.messageType = messageType; - context.notifyType = fOutOfBandParameter; - context.isPreChange = fIsPreChange; - context.enableTracing = false; - context.us = this; - context.maxTimeRequested = 0; - context.stateNumber = fHeadNotePowerState; - context.stateFlags = fHeadNotePowerArrayEntry->capabilityFlags; - context.changeFlags = fHeadNoteChangeFlags; - context.messageFilter = (isRootDomain) ? - OSMemberFunctionCast( - IOPMMessageFilter, - this, - &IOPMrootDomain::systemMessageFilter) : 0; - - switch ( fOutOfBandParameter ) { - case kNotifyApps: - applyToInterested( gIOAppPowerStateInterest, - pmTellAppWithResponse, (void *) &context ); - - if (isRootDomain && - (fMachineState != kIOPM_OurChangeTellClientsPowerDown) && - (fMachineState != kIOPM_SyncTellClientsPowerDown)) - { - // Notify capability app for tellChangeDown1() - // but not for askChangeDown(). - context.notifyType = kNotifyCapabilityChangeApps; - context.messageType = kIOMessageSystemCapabilityChange; - applyToInterested( gIOAppPowerStateInterest, - pmTellCapabilityAppWithResponse, (void *) &context ); - context.notifyType = fOutOfBandParameter; - context.messageType = messageType; - } - context.maxTimeRequested = k30seconds; - - applyToInterested( gIOGeneralInterest, - pmTellClientWithResponse, (void *) &context ); - - fNotifyClientArray = context.notifyClients; - break; - - case kNotifyPriority: - context.enableTracing = isRootDomain; - applyToInterested( gIOPriorityPowerStateInterest, - pmTellClientWithResponse, (void *) &context ); - - if (isRootDomain) - { - // Notify capability clients for tellChangeDown2(). - context.notifyType = kNotifyCapabilityChangePriority; - context.messageType = kIOMessageSystemCapabilityChange; - applyToInterested( gIOPriorityPowerStateInterest, - pmTellCapabilityClientWithResponse, (void *) &context ); - } - break; - - case kNotifyCapabilityChangeApps: - applyToInterested( gIOAppPowerStateInterest, - pmTellCapabilityAppWithResponse, (void *) &context ); - fNotifyClientArray = context.notifyClients; - context.maxTimeRequested = k30seconds; - break; - - case kNotifyCapabilityChangePriority: - applyToInterested( gIOPriorityPowerStateInterest, - pmTellCapabilityClientWithResponse, (void *) &context ); - break; - } - - // do we have to wait for somebody? - if ( !checkForDone() ) - { - OUR_PMLog(kPMLogStartAckTimer, context.maxTimeRequested, 0); - if (context.enableTracing) - getPMRootDomain()->traceDetail( context.maxTimeRequested / 1000 ); - start_ack_timer( context.maxTimeRequested / 1000, kMillisecondScale ); - return false; - } + assert( fResponseArray == NULL ); + assert( fNotifyClientArray == NULL ); + + if (messageType == (int)kIOPMMessageLastCallBeforeSleep) { + RD_LOG("tellClientsWithResponse( kIOPMMessageLastCallBeforeSleep, %d )\n", + fOutOfBandParameter); + } else { + RD_LOG("tellClientsWithResponse( %s, %d )\n", + getIOMessageString(messageType), fOutOfBandParameter); + } + + fResponseArray = OSArray::withCapacity( 1 ); + if (!fResponseArray) { + goto exit; + } + + fResponseArray->setCapacityIncrement(8); + if (++fSerialNumber == 0) { + fSerialNumber++; + } + + context.responseArray = fResponseArray; + context.notifyClients = NULL; + context.serialNumber = fSerialNumber; + context.messageType = messageType; + context.notifyType = fOutOfBandParameter; + context.skippedInDark = 0; + context.notSkippedInDark = 0; + context.isPreChange = fIsPreChange; + context.enableTracing = false; + context.us = this; + context.maxTimeRequested = 0; + context.stateNumber = fHeadNotePowerState; + context.stateFlags = fHeadNotePowerArrayEntry->capabilityFlags; + context.changeFlags = fHeadNoteChangeFlags; + context.messageFilter = (isRootDomain) ? + OSMemberFunctionCast( + IOPMMessageFilter, + this, + &IOPMrootDomain::systemMessageFilter) : NULL; + + switch (fOutOfBandParameter) { + case kNotifyApps: + applyToInterested( gIOAppPowerStateInterest, + pmTellAppWithResponse, (void *) &context ); + + if (isRootDomain && + (fMachineState != kIOPM_OurChangeTellClientsPowerDown) && + (fMachineState != kIOPM_SyncTellClientsPowerDown) && + (context.messageType != kIOPMMessageLastCallBeforeSleep)) { + // Notify capability app for tellChangeDown1() + // but not for askChangeDown(). + context.notifyType = kNotifyCapabilityChangeApps; + context.messageType = kIOMessageSystemCapabilityChange; + applyToInterested( gIOAppPowerStateInterest, + pmTellCapabilityAppWithResponse, (void *) &context ); + context.notifyType = fOutOfBandParameter; + context.messageType = messageType; + } + if (context.messageType == kIOMessageCanSystemSleep) { + maxTimeOut = kCanSleepMaxTimeReq; + if (gCanSleepTimeout) { + maxTimeOut = (gCanSleepTimeout * us_per_s); + } + } + context.maxTimeRequested = maxTimeOut; + context.enableTracing = isRootDomain; + applyToInterested( gIOGeneralInterest, + pmTellClientWithResponse, (void *) &context ); + + break; + + case kNotifyPriority: + context.enableTracing = isRootDomain; + applyToInterested( gIOPriorityPowerStateInterest, + pmTellClientWithResponse, (void *) &context ); + + if (isRootDomain) { + // Notify capability clients for tellChangeDown2(). + context.notifyType = kNotifyCapabilityChangePriority; + context.messageType = kIOMessageSystemCapabilityChange; + applyToInterested( gIOPriorityPowerStateInterest, + pmTellCapabilityClientWithResponse, (void *) &context ); + } + break; + + case kNotifyCapabilityChangeApps: + applyToInterested( gIOAppPowerStateInterest, + pmTellCapabilityAppWithResponse, (void *) &context ); + if (context.messageType == kIOMessageCanSystemSleep) { + maxTimeOut = kCanSleepMaxTimeReq; + if (gCanSleepTimeout) { + maxTimeOut = (gCanSleepTimeout * us_per_s); + } + } + context.maxTimeRequested = maxTimeOut; + break; + + case kNotifyCapabilityChangePriority: + context.enableTracing = isRootDomain; + applyToInterested( gIOPriorityPowerStateInterest, + pmTellCapabilityClientWithResponse, (void *) &context ); + break; + } + fNotifyClientArray = context.notifyClients; + + if (context.skippedInDark) { + IOLog("tellClientsWithResponse(%s, %d) %d of %d skipped in dark\n", + getIOMessageString(messageType), fOutOfBandParameter, + context.skippedInDark, context.skippedInDark + context.notSkippedInDark); + } + + // do we have to wait for somebody? + if (!checkForDone()) { + OUR_PMLog(kPMLogStartAckTimer, context.maxTimeRequested, 0); + if (context.enableTracing) { + getPMRootDomain()->traceDetail(context.messageType, 0, context.maxTimeRequested / 1000); + getPMRootDomain()->reset_watchdog_timer(this, context.maxTimeRequested / USEC_PER_SEC + 1); + } + start_ack_timer( context.maxTimeRequested / 1000, kMillisecondScale ); + return false; + } exit: - // everybody responded - if (fResponseArray) - { - fResponseArray->release(); - fResponseArray = NULL; - } - if (fNotifyClientArray) - { - fNotifyClientArray->release(); - fNotifyClientArray = NULL; - } + // everybody responded + if (fResponseArray) { + fResponseArray->release(); + fResponseArray = NULL; + } + if (fNotifyClientArray) { + fNotifyClientArray->release(); + fNotifyClientArray = NULL; + } - return true; + return true; } //********************************************************************************* @@ -5267,74 +5970,94 @@ exit: // cookie we can identify the response with. //********************************************************************************* -void IOService::pmTellAppWithResponse ( OSObject * object, void * arg ) -{ - IOPMInterestContext * context = (IOPMInterestContext *) arg; - IOServicePM * pwrMgt = context->us->pwrMgt; - uint32_t msgIndex, msgRef, msgType; +void +IOService::pmTellAppWithResponse( OSObject * object, void * arg ) +{ + IOPMInterestContext * context = (IOPMInterestContext *) arg; + IOServicePM * pwrMgt = context->us->pwrMgt; + uint32_t msgIndex, msgRef, msgType; + OSNumber *clientID = NULL; + proc_t proc = NULL; + boolean_t proc_suspended = FALSE; + OSObject * waitForReply = kOSBooleanTrue; #if LOG_APP_RESPONSE_TIMES - AbsoluteTime now; + AbsoluteTime now; #endif - if (!OSDynamicCast(_IOServiceInterestNotifier, object)) - return; - - if (context->messageFilter && - !context->messageFilter(context->us, object, context, 0, 0)) - { - if (kIOLogDebugPower & gIOKitDebug) - { - // Log client pid/name and client array index. - OSString * clientID = 0; - context->us->messageClient(kIOMessageCopyClientID, object, &clientID); - PM_LOG("%s DROP App %s, %s\n", - context->us->getName(), - getIOMessageString(context->messageType), - clientID ? clientID->getCStringNoCopy() : ""); - if (clientID) clientID->release(); - } - return; - } - - // Create client array (for tracking purposes) only if the service - // has app clients. Usually only root domain does. - if (0 == context->notifyClients) - context->notifyClients = OSArray::withCapacity( 32 ); - - msgType = context->messageType; - msgIndex = context->responseArray->getCount(); - msgRef = ((context->serialNumber & 0xFFFF) << 16) + (msgIndex & 0xFFFF); - - OUR_PMLog(kPMLogAppNotify, msgType, msgRef); - if (kIOLogDebugPower & gIOKitDebug) - { - // Log client pid/name and client array index. - OSString * clientID = 0; - context->us->messageClient(kIOMessageCopyClientID, object, &clientID); - PM_LOG("%s MESG App(%u) %s, %s\n", - context->us->getName(), - msgIndex, getIOMessageString(msgType), - clientID ? clientID->getCStringNoCopy() : ""); - if (clientID) clientID->release(); - } + if (!OSDynamicCast(_IOServiceInterestNotifier, object)) { + return; + } -#if LOG_APP_RESPONSE_TIMES - OSNumber * num; - clock_get_uptime(&now); - num = OSNumber::withNumber(AbsoluteTime_to_scalar(&now), sizeof(uint64_t) * 8); - if (num) - { - context->responseArray->setObject(msgIndex, num); - num->release(); - } - else -#endif - context->responseArray->setObject(msgIndex, kOSBooleanFalse); + if (context->us == getPMRootDomain()) { + if ((clientID = copyClientIDForNotification(object, context))) { + uint32_t clientPID = clientID->unsigned32BitValue(); + clientID->release(); + proc = proc_find(clientPID); + + if (proc) { + proc_suspended = get_task_pidsuspended((task_t) proc->task); + if (proc_suspended) { + logClientIDForNotification(object, context, "PMTellAppWithResponse - Suspended"); +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + } else if (getPMRootDomain()->isAOTMode() && get_task_suspended((task_t) proc->task)) { + proc_suspended = true; + context->skippedInDark++; +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + } + proc_rele(proc); + if (proc_suspended) { + return; + } + } + } + } + + if (context->messageFilter && + !context->messageFilter(context->us, object, context, NULL, &waitForReply)) { + if (kIOLogDebugPower & gIOKitDebug) { + logClientIDForNotification(object, context, "DROP App"); + } + return; + } + context->notSkippedInDark++; + + // Create client array (for tracking purposes) only if the service + // has app clients. Usually only root domain does. + if (NULL == context->notifyClients) { + context->notifyClients = OSArray::withCapacity( 32 ); + } + + msgType = context->messageType; + msgIndex = context->responseArray->getCount(); + msgRef = ((context->serialNumber & 0xFFFF) << 16) + (msgIndex & 0xFFFF); - if (context->notifyClients) - context->notifyClients->setObject(msgIndex, object); + OUR_PMLog(kPMLogAppNotify, msgType, msgRef); + if (kIOLogDebugPower & gIOKitDebug) { + logClientIDForNotification(object, context, "MESG App"); + } - context->us->messageClient(msgType, object, (void *) msgRef); + if (waitForReply == kOSBooleanTrue) { + OSNumber * num; + clock_get_uptime(&now); + num = OSNumber::withNumber(AbsoluteTime_to_scalar(&now), sizeof(uint64_t) * 8); + if (num) { + context->responseArray->setObject(msgIndex, num); + num->release(); + } else { + context->responseArray->setObject(msgIndex, kOSBooleanFalse); + } + } else { + context->responseArray->setObject(msgIndex, kOSBooleanTrue); + if (kIOLogDebugPower & gIOKitDebug) { + logClientIDForNotification(object, context, "App response ignored"); + } + } + + if (context->notifyClients) { + context->notifyClients->setObject(msgIndex, object); + } + + context->us->messageClient(msgType, object, (void *)(uintptr_t) msgRef); } //********************************************************************************* @@ -5344,286 +6067,363 @@ void IOService::pmTellAppWithResponse ( OSObject * object, void * arg ) // so we compute a cookie we can identify the response with. //********************************************************************************* -void IOService::pmTellClientWithResponse ( OSObject * object, void * arg ) -{ - IOPowerStateChangeNotification notify; - IOPMInterestContext * context = (IOPMInterestContext *) arg; - OSObject * replied = kOSBooleanTrue; - _IOServiceInterestNotifier * notifier; - uint32_t msgIndex, msgRef, msgType; - IOReturn retCode; - - if (context->messageFilter && - !context->messageFilter(context->us, object, context, 0, 0)) - { - if ((kIOLogDebugPower & gIOKitDebug) && - (OSDynamicCast(_IOServiceInterestNotifier, object))) - { - _IOServiceInterestNotifier *n = (_IOServiceInterestNotifier *) object; - PM_LOG("%s DROP Client %s, notifier %p, handler %p\n", - context->us->getName(), - getIOMessageString(context->messageType), - object, n->handler); - } - return; - } - - notifier = OSDynamicCast(_IOServiceInterestNotifier, object); - msgType = context->messageType; - msgIndex = context->responseArray->getCount(); - msgRef = ((context->serialNumber & 0xFFFF) << 16) + (msgIndex & 0xFFFF); - - IOServicePM * pwrMgt = context->us->pwrMgt; - if (gIOKitDebug & kIOLogPower) { +void +IOService::pmTellClientWithResponse( OSObject * object, void * arg ) +{ + IOPowerStateChangeNotification notify; + IOPMInterestContext * context = (IOPMInterestContext *) arg; + OSObject * replied = kOSBooleanTrue; + _IOServiceInterestNotifier * notifier; + uint32_t msgIndex, msgRef, msgType; + IOReturn retCode; + AbsoluteTime start, end; + uint64_t nsec; + + if (context->messageFilter && + !context->messageFilter(context->us, object, context, NULL, NULL)) { + if ((kIOLogDebugPower & gIOKitDebug) && + (OSDynamicCast(_IOServiceInterestNotifier, object))) { + _IOServiceInterestNotifier *n = (_IOServiceInterestNotifier *) object; + PM_LOG("%s DROP Client %s, notifier %p, handler %p\n", + context->us->getName(), + getIOMessageString(context->messageType), + OBFUSCATE(object), OBFUSCATE(n->handler)); + } + return; + } + + notifier = OSDynamicCast(_IOServiceInterestNotifier, object); + msgType = context->messageType; + msgIndex = context->responseArray->getCount(); + msgRef = ((context->serialNumber & 0xFFFF) << 16) + (msgIndex & 0xFFFF); + + IOServicePM * pwrMgt = context->us->pwrMgt; + if (gIOKitDebug & kIOLogPower) { OUR_PMLog(kPMLogClientNotify, msgRef, msgType); if (OSDynamicCast(IOService, object)) { const char *who = ((IOService *) object)->getName(); gPlatform->PMLog(who, kPMLogClientNotify, (uintptr_t) object, 0); - } - else if (notifier) { + } else if (notifier) { OUR_PMLog(kPMLogClientNotify, (uintptr_t) notifier->handler, 0); - } - } - if ((kIOLogDebugPower & gIOKitDebug) && notifier) - { - PM_LOG("%s MESG Client %s, notifier %p, handler %p\n", - context->us->getName(), - getIOMessageString(msgType), - object, notifier->handler); - } - - notify.powerRef = (void *)(uintptr_t) msgRef; - notify.returnValue = 0; - notify.stateNumber = context->stateNumber; - notify.stateFlags = context->stateFlags; - - if (context->enableTracing && (notifier != 0)) - { - uint32_t detail = ((msgIndex & 0xff) << 24) | - ((msgType & 0xfff) << 12) | - (((uintptr_t) notifier->handler) & 0xfff); - getPMRootDomain()->traceDetail( detail ); - } - - retCode = context->us->messageClient(msgType, object, (void *) ¬ify); - if ( kIOReturnSuccess == retCode ) - { - if ( 0 == notify.returnValue ) - { - // client doesn't want time to respond + } + } + if ((kIOLogDebugPower & gIOKitDebug) && notifier) { + PM_LOG("%s MESG Client %s, notifier %p, handler %p\n", + context->us->getName(), + getIOMessageString(msgType), + OBFUSCATE(object), OBFUSCATE(notifier->handler)); + } + + if (NULL == context->notifyClients) { + context->notifyClients = OSArray::withCapacity( 32 ); + } + + notify.powerRef = (void *)(uintptr_t) msgRef; + notify.returnValue = 0; + notify.stateNumber = context->stateNumber; + notify.stateFlags = context->stateFlags; + + if (context->enableTracing && (notifier != NULL)) { + getPMRootDomain()->traceDetail(notifier, true); + } + + clock_get_uptime(&start); + retCode = context->us->messageClient(msgType, object, (void *) ¬ify, sizeof(notify)); + clock_get_uptime(&end); + + if (context->enableTracing && (notifier != NULL)) { + getPMRootDomain()->traceDetail(notifier, false); + } + + + if (kIOReturnSuccess == retCode) { + if (0 == notify.returnValue) { OUR_PMLog(kPMLogClientAcknowledge, msgRef, (uintptr_t) object); - } - else - { - replied = kOSBooleanFalse; - if ( notify.returnValue > context->maxTimeRequested ) - { - if (notify.returnValue > kPriorityClientMaxWait) - { - context->maxTimeRequested = kPriorityClientMaxWait; - PM_ERROR("%s: client %p returned %llu for %s\n", - context->us->getName(), - notifier ? (void *) notifier->handler : object, - (uint64_t) notify.returnValue, - getIOMessageString(msgType)); - } - else - context->maxTimeRequested = notify.returnValue; - } - } - } - else - { - // not a client of ours - // so we won't be waiting for response - OUR_PMLog(kPMLogClientAcknowledge, msgRef, 0); - } + context->responseArray->setObject(msgIndex, replied); + } else { + replied = kOSBooleanFalse; + if (notify.returnValue > context->maxTimeRequested) { + if (notify.returnValue > kPriorityClientMaxWait) { + context->maxTimeRequested = kPriorityClientMaxWait; + PM_ERROR("%s: client %p returned %llu for %s\n", + context->us->getName(), + notifier ? (void *) OBFUSCATE(notifier->handler) : OBFUSCATE(object), + (uint64_t) notify.returnValue, + getIOMessageString(msgType)); + } else { + context->maxTimeRequested = notify.returnValue; + } + } + // + // Track time taken to ack, by storing the timestamp of + // callback completion + OSNumber * num; + num = OSNumber::withNumber(AbsoluteTime_to_scalar(&end), sizeof(uint64_t) * 8); + if (num) { + context->responseArray->setObject(msgIndex, num); + num->release(); + } else { + context->responseArray->setObject(msgIndex, replied); + } + } - context->responseArray->setObject(msgIndex, replied); + if (context->enableTracing) { + SUB_ABSOLUTETIME(&end, &start); + absolutetime_to_nanoseconds(end, &nsec); + + if ((nsec > LOG_KEXT_RESPONSE_TIMES) || (notify.returnValue != 0)) { + getPMRootDomain()->traceAckDelay(notifier, notify.returnValue / 1000, NS_TO_MS(nsec)); + } + } + } else { + // not a client of ours + // so we won't be waiting for response + OUR_PMLog(kPMLogClientAcknowledge, msgRef, 0); + context->responseArray->setObject(msgIndex, replied); + } + if (context->notifyClients) { + context->notifyClients->setObject(msgIndex, object); + } } //********************************************************************************* // [static private] pmTellCapabilityAppWithResponse //********************************************************************************* -void IOService::pmTellCapabilityAppWithResponse ( OSObject * object, void * arg ) +void +IOService::pmTellCapabilityAppWithResponse( OSObject * object, void * arg ) { - IOPMSystemCapabilityChangeParameters msgArg; - IOPMInterestContext * context = (IOPMInterestContext *) arg; - OSObject * replied = kOSBooleanTrue; - IOServicePM * pwrMgt = context->us->pwrMgt; - uint32_t msgIndex, msgRef, msgType; + IOPMSystemCapabilityChangeParameters msgArg; + IOPMInterestContext * context = (IOPMInterestContext *) arg; + OSObject * replied = kOSBooleanTrue; + IOServicePM * pwrMgt = context->us->pwrMgt; + uint32_t msgIndex, msgRef, msgType; #if LOG_APP_RESPONSE_TIMES - AbsoluteTime now; + AbsoluteTime now; #endif - if (!OSDynamicCast(_IOServiceInterestNotifier, object)) - return; - - memset(&msgArg, 0, sizeof(msgArg)); - if (context->messageFilter && - !context->messageFilter(context->us, object, context, &msgArg, &replied)) - { - return; - } - - // Create client array (for tracking purposes) only if the service - // has app clients. Usually only root domain does. - if (0 == context->notifyClients) - context->notifyClients = OSArray::withCapacity( 32 ); - - msgType = context->messageType; - msgIndex = context->responseArray->getCount(); - msgRef = ((context->serialNumber & 0xFFFF) << 16) + (msgIndex & 0xFFFF); - - OUR_PMLog(kPMLogAppNotify, msgType, msgRef); - if (kIOLogDebugPower & gIOKitDebug) - { - // Log client pid/name and client array index. - OSString * clientID = 0; - context->us->messageClient(kIOMessageCopyClientID, object, &clientID); - PM_LOG("%s MESG App(%u) %s, wait %u, %s\n", - context->us->getName(), - msgIndex, getIOMessageString(msgType), - (replied != kOSBooleanTrue), - clientID ? clientID->getCStringNoCopy() : ""); - if (clientID) clientID->release(); - } - - msgArg.notifyRef = msgRef; - msgArg.maxWaitForReply = 0; - - if (replied == kOSBooleanTrue) - { - msgArg.notifyRef = 0; - context->responseArray->setObject(msgIndex, kOSBooleanTrue); - if (context->notifyClients) - context->notifyClients->setObject(msgIndex, kOSBooleanTrue); - } - else - { -#if LOG_APP_RESPONSE_TIMES - OSNumber * num; - clock_get_uptime(&now); - num = OSNumber::withNumber(AbsoluteTime_to_scalar(&now), sizeof(uint64_t) * 8); - if (num) - { - context->responseArray->setObject(msgIndex, num); - num->release(); - } - else -#endif - context->responseArray->setObject(msgIndex, kOSBooleanFalse); + if (!OSDynamicCast(_IOServiceInterestNotifier, object)) { + return; + } + + memset(&msgArg, 0, sizeof(msgArg)); + if (context->messageFilter && + !context->messageFilter(context->us, object, context, &msgArg, &replied)) { + return; + } - if (context->notifyClients) - context->notifyClients->setObject(msgIndex, object); - } + if (context->us == getPMRootDomain() && +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + getPMRootDomain()->isAOTMode() +#else /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + false +#endif /* (defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + ) { + OSNumber *clientID = NULL; + boolean_t proc_suspended = FALSE; + proc_t proc = NULL; + if ((clientID = copyClientIDForNotification(object, context))) { + uint32_t clientPID = clientID->unsigned32BitValue(); + clientID->release(); + proc = proc_find(clientPID); + if (proc) { + proc_suspended = get_task_pidsuspended((task_t) proc->task); + if (proc_suspended) { + logClientIDForNotification(object, context, "PMTellCapablityAppWithResponse - Suspended"); + } else if (get_task_suspended((task_t) proc->task)) { + proc_suspended = true; + context->skippedInDark++; + } + proc_rele(proc); + if (proc_suspended) { + return; + } + } + } + } + context->notSkippedInDark++; - context->us->messageClient(msgType, object, (void *) &msgArg, sizeof(msgArg)); + // Create client array (for tracking purposes) only if the service + // has app clients. Usually only root domain does. + if (NULL == context->notifyClients) { + context->notifyClients = OSArray::withCapacity( 32 ); + } + + msgType = context->messageType; + msgIndex = context->responseArray->getCount(); + msgRef = ((context->serialNumber & 0xFFFF) << 16) + (msgIndex & 0xFFFF); + + OUR_PMLog(kPMLogAppNotify, msgType, msgRef); + if (kIOLogDebugPower & gIOKitDebug) { + // Log client pid/name and client array index. + OSNumber * clientID = NULL; + OSString * clientIDString = NULL;; + context->us->messageClient(kIOMessageCopyClientID, object, &clientID); + if (clientID) { + clientIDString = IOCopyLogNameForPID(clientID->unsigned32BitValue()); + } + + PM_LOG("%s MESG App(%u) %s, wait %u, %s\n", + context->us->getName(), + msgIndex, getIOMessageString(msgType), + (replied != kOSBooleanTrue), + clientIDString ? clientIDString->getCStringNoCopy() : ""); + if (clientID) { + clientID->release(); + } + if (clientIDString) { + clientIDString->release(); + } + } + + msgArg.notifyRef = msgRef; + msgArg.maxWaitForReply = 0; + + if (replied == kOSBooleanTrue) { + msgArg.notifyRef = 0; + context->responseArray->setObject(msgIndex, kOSBooleanTrue); + if (context->notifyClients) { + context->notifyClients->setObject(msgIndex, kOSBooleanTrue); + } + } else { + OSNumber * num; + clock_get_uptime(&now); + num = OSNumber::withNumber(AbsoluteTime_to_scalar(&now), sizeof(uint64_t) * 8); + if (num) { + context->responseArray->setObject(msgIndex, num); + num->release(); + } else { + context->responseArray->setObject(msgIndex, kOSBooleanFalse); + } + + if (context->notifyClients) { + context->notifyClients->setObject(msgIndex, object); + } + } + + context->us->messageClient(msgType, object, (void *) &msgArg, sizeof(msgArg)); } //********************************************************************************* // [static private] pmTellCapabilityClientWithResponse //********************************************************************************* -void IOService::pmTellCapabilityClientWithResponse( - OSObject * object, void * arg ) -{ - IOPMSystemCapabilityChangeParameters msgArg; - IOPMInterestContext * context = (IOPMInterestContext *) arg; - OSObject * replied = kOSBooleanTrue; - _IOServiceInterestNotifier * notifier; - uint32_t msgIndex, msgRef, msgType; - IOReturn retCode; - - memset(&msgArg, 0, sizeof(msgArg)); - if (context->messageFilter && - !context->messageFilter(context->us, object, context, &msgArg, 0)) - { - if ((kIOLogDebugPower & gIOKitDebug) && - (OSDynamicCast(_IOServiceInterestNotifier, object))) - { - _IOServiceInterestNotifier *n = (_IOServiceInterestNotifier *) object; - PM_LOG("%s DROP Client %s, notifier %p, handler %p\n", - context->us->getName(), - getIOMessageString(context->messageType), - object, n->handler); - } - return; - } - - notifier = OSDynamicCast(_IOServiceInterestNotifier, object); - msgType = context->messageType; - msgIndex = context->responseArray->getCount(); - msgRef = ((context->serialNumber & 0xFFFF) << 16) + (msgIndex & 0xFFFF); - - IOServicePM * pwrMgt = context->us->pwrMgt; - if (gIOKitDebug & kIOLogPower) { +void +IOService::pmTellCapabilityClientWithResponse( + OSObject * object, void * arg ) +{ + IOPMSystemCapabilityChangeParameters msgArg; + IOPMInterestContext * context = (IOPMInterestContext *) arg; + OSObject * replied = kOSBooleanTrue; + _IOServiceInterestNotifier * notifier; + uint32_t msgIndex, msgRef, msgType; + IOReturn retCode; + AbsoluteTime start, end; + uint64_t nsec; + + memset(&msgArg, 0, sizeof(msgArg)); + if (context->messageFilter && + !context->messageFilter(context->us, object, context, &msgArg, NULL)) { + if ((kIOLogDebugPower & gIOKitDebug) && + (OSDynamicCast(_IOServiceInterestNotifier, object))) { + _IOServiceInterestNotifier *n = (_IOServiceInterestNotifier *) object; + PM_LOG("%s DROP Client %s, notifier %p, handler %p\n", + context->us->getName(), + getIOMessageString(context->messageType), + OBFUSCATE(object), OBFUSCATE(n->handler)); + } + return; + } + + if (NULL == context->notifyClients) { + context->notifyClients = OSArray::withCapacity( 32 ); + } + notifier = OSDynamicCast(_IOServiceInterestNotifier, object); + msgType = context->messageType; + msgIndex = context->responseArray->getCount(); + msgRef = ((context->serialNumber & 0xFFFF) << 16) + (msgIndex & 0xFFFF); + + IOServicePM * pwrMgt = context->us->pwrMgt; + if (gIOKitDebug & kIOLogPower) { OUR_PMLog(kPMLogClientNotify, msgRef, msgType); if (OSDynamicCast(IOService, object)) { const char *who = ((IOService *) object)->getName(); gPlatform->PMLog(who, kPMLogClientNotify, (uintptr_t) object, 0); - } - else if (notifier) { + } else if (notifier) { OUR_PMLog(kPMLogClientNotify, (uintptr_t) notifier->handler, 0); } - } - if ((kIOLogDebugPower & gIOKitDebug) && notifier) - { - PM_LOG("%s MESG Client %s, notifier %p, handler %p\n", - context->us->getName(), - getIOMessageString(msgType), - object, notifier->handler); - } - - msgArg.notifyRef = msgRef; - msgArg.maxWaitForReply = 0; - - if (context->enableTracing && (notifier != 0)) - { - uint32_t detail = ((msgIndex & 0xff) << 24) | - ((msgType & 0xfff) << 12) | - (((uintptr_t) notifier->handler) & 0xfff); - getPMRootDomain()->traceDetail( detail ); - } - - retCode = context->us->messageClient( - msgType, object, (void *) &msgArg, sizeof(msgArg)); - - if ( kIOReturnSuccess == retCode ) - { - if ( 0 == msgArg.maxWaitForReply ) - { - // client doesn't want time to respond + } + if ((kIOLogDebugPower & gIOKitDebug) && notifier) { + PM_LOG("%s MESG Client %s, notifier %p, handler %p\n", + context->us->getName(), + getIOMessageString(msgType), + OBFUSCATE(object), OBFUSCATE(notifier->handler)); + } + + msgArg.notifyRef = msgRef; + msgArg.maxWaitForReply = 0; + + if (context->enableTracing && (notifier != NULL)) { + getPMRootDomain()->traceDetail(notifier, true); + } + + clock_get_uptime(&start); + retCode = context->us->messageClient( + msgType, object, (void *) &msgArg, sizeof(msgArg)); + clock_get_uptime(&end); + if (context->enableTracing && (notifier != NULL)) { + getPMRootDomain()->traceDetail(notifier, false); + } + + if (kIOReturnSuccess == retCode) { + if (0 == msgArg.maxWaitForReply) { + // client doesn't want time to respond OUR_PMLog(kPMLogClientAcknowledge, msgRef, (uintptr_t) object); - } - else - { - replied = kOSBooleanFalse; - if ( msgArg.maxWaitForReply > context->maxTimeRequested ) - { - if (msgArg.maxWaitForReply > kCapabilityClientMaxWait) - { - context->maxTimeRequested = kCapabilityClientMaxWait; - PM_ERROR("%s: client %p returned %u for %s\n", - context->us->getName(), - notifier ? (void *) notifier->handler : object, - msgArg.maxWaitForReply, - getIOMessageString(msgType)); - } - else - context->maxTimeRequested = msgArg.maxWaitForReply; - } - } - } - else - { - // not a client of ours - // so we won't be waiting for response - OUR_PMLog(kPMLogClientAcknowledge, msgRef, 0); - } + context->responseArray->setObject(msgIndex, replied); + } else { + replied = kOSBooleanFalse; + if (msgArg.maxWaitForReply > context->maxTimeRequested) { + if (msgArg.maxWaitForReply > kCapabilityClientMaxWait) { + context->maxTimeRequested = kCapabilityClientMaxWait; + PM_ERROR("%s: client %p returned %u for %s\n", + context->us->getName(), + notifier ? (void *) OBFUSCATE(notifier->handler) : OBFUSCATE(object), + msgArg.maxWaitForReply, + getIOMessageString(msgType)); + } else { + context->maxTimeRequested = msgArg.maxWaitForReply; + } + } - context->responseArray->setObject(msgIndex, replied); + // Track time taken to ack, by storing the timestamp of + // callback completion + OSNumber * num; + num = OSNumber::withNumber(AbsoluteTime_to_scalar(&end), sizeof(uint64_t) * 8); + if (num) { + context->responseArray->setObject(msgIndex, num); + num->release(); + } else { + context->responseArray->setObject(msgIndex, replied); + } + } + + if (context->enableTracing) { + SUB_ABSOLUTETIME(&end, &start); + absolutetime_to_nanoseconds(end, &nsec); + + if ((nsec > LOG_KEXT_RESPONSE_TIMES) || (msgArg.maxWaitForReply != 0)) { + getPMRootDomain()->traceAckDelay(notifier, msgArg.maxWaitForReply / 1000, NS_TO_MS(nsec)); + } + } + } else { + // not a client of ours + // so we won't be waiting for response + OUR_PMLog(kPMLogClientAcknowledge, msgRef, 0); + context->responseArray->setObject(msgIndex, replied); + } + if (context->notifyClients) { + context->notifyClients->setObject(msgIndex, object); + } } //********************************************************************************* @@ -5632,377 +6432,686 @@ void IOService::pmTellCapabilityClientWithResponse( // Notify registered applications and kernel clients that we are not // dropping power. // -// Subclass can override this to send a different message type. Parameter is -// the aborted destination state number. +// Subclass can override this to send a different message type. Parameter is +// the aborted destination state number. +//********************************************************************************* + +void +IOService::tellNoChangeDown( unsigned long ) +{ + return tellClients( kIOMessageDeviceWillNotPowerOff ); +} + +//********************************************************************************* +// [public] tellChangeUp +// +// Notify registered applications and kernel clients that we are raising power. +// +// Subclass can override this to send a different message type. Parameter is +// the aborted destination state number. +//********************************************************************************* + +void +IOService::tellChangeUp( unsigned long ) +{ + return tellClients( kIOMessageDeviceHasPoweredOn ); +} + +//********************************************************************************* +// [protected] tellClients +// +// Notify registered applications and kernel clients of something. +//********************************************************************************* + +void +IOService::tellClients( int messageType ) +{ + IOPMInterestContext context; + + RD_LOG("tellClients( %s )\n", getIOMessageString(messageType)); + + memset(&context, 0, sizeof(context)); + context.messageType = messageType; + context.isPreChange = fIsPreChange; + context.us = this; + context.stateNumber = fHeadNotePowerState; + context.stateFlags = fHeadNotePowerArrayEntry->capabilityFlags; + context.changeFlags = fHeadNoteChangeFlags; + context.enableTracing = IS_ROOT_DOMAIN; + context.messageFilter = (IS_ROOT_DOMAIN) ? + OSMemberFunctionCast( + IOPMMessageFilter, + this, + &IOPMrootDomain::systemMessageFilter) : NULL; + + context.notifyType = kNotifyPriority; + applyToInterested( gIOPriorityPowerStateInterest, + tellKernelClientApplier, (void *) &context ); + + context.notifyType = kNotifyApps; + applyToInterested( gIOAppPowerStateInterest, + tellAppClientApplier, (void *) &context ); + + applyToInterested( gIOGeneralInterest, + tellKernelClientApplier, (void *) &context ); +} + +//********************************************************************************* +// [private] tellKernelClientApplier +// +// Message a kernel client. +//********************************************************************************* + +static void +tellKernelClientApplier( OSObject * object, void * arg ) +{ + IOPowerStateChangeNotification notify; + IOPMInterestContext * context = (IOPMInterestContext *) arg; + + if (context->messageFilter && + !context->messageFilter(context->us, object, context, NULL, NULL)) { + if ((kIOLogDebugPower & gIOKitDebug) && + (OSDynamicCast(_IOServiceInterestNotifier, object))) { + _IOServiceInterestNotifier *n = (_IOServiceInterestNotifier *) object; + PM_LOG("%s DROP Client %s, notifier %p, handler %p\n", + context->us->getName(), + IOService::getIOMessageString(context->messageType), + OBFUSCATE(object), OBFUSCATE(n->handler)); + } + return; + } + + notify.powerRef = (void *) NULL; + notify.returnValue = 0; + notify.stateNumber = context->stateNumber; + notify.stateFlags = context->stateFlags; + + if (context->enableTracing && object) { + IOService::getPMRootDomain()->traceDetail(object, true); + } + context->us->messageClient(context->messageType, object, ¬ify, sizeof(notify)); + if (context->enableTracing && object) { + IOService::getPMRootDomain()->traceDetail(object, false); + } + + + + if ((kIOLogDebugPower & gIOKitDebug) && + (OSDynamicCast(_IOServiceInterestNotifier, object))) { + _IOServiceInterestNotifier *n = (_IOServiceInterestNotifier *) object; + PM_LOG("%s MESG Client %s, notifier %p, handler %p\n", + context->us->getName(), + IOService::getIOMessageString(context->messageType), + OBFUSCATE(object), OBFUSCATE(n->handler)); + } +} + +static OSNumber * +copyClientIDForNotification( + OSObject *object, + IOPMInterestContext *context) +{ + OSNumber *clientID = NULL; + context->us->messageClient(kIOMessageCopyClientID, object, &clientID); + return clientID; +} + +static void +logClientIDForNotification( + OSObject *object, + IOPMInterestContext *context, + const char *logString) +{ + OSString *logClientID = NULL; + OSNumber *clientID = copyClientIDForNotification(object, context); + + if (logString) { + if (clientID) { + logClientID = IOCopyLogNameForPID(clientID->unsigned32BitValue()); + } + + PM_LOG("%s %s %s, %s\n", + context->us->getName(), logString, + IOService::getIOMessageString(context->messageType), + logClientID ? logClientID->getCStringNoCopy() : ""); + + if (logClientID) { + logClientID->release(); + } + } + + if (clientID) { + clientID->release(); + } + + return; +} + +static void +tellAppClientApplier( OSObject * object, void * arg ) +{ + IOPMInterestContext * context = (IOPMInterestContext *) arg; + OSNumber * clientID = NULL; + proc_t proc = NULL; + boolean_t proc_suspended = FALSE; + + if (context->us == IOService::getPMRootDomain()) { + if ((clientID = copyClientIDForNotification(object, context))) { + uint32_t clientPID = clientID->unsigned32BitValue(); + clientID->release(); + proc = proc_find(clientPID); + + if (proc) { + proc_suspended = get_task_pidsuspended((task_t) proc->task); + if (proc_suspended) { + logClientIDForNotification(object, context, "tellAppClientApplier - Suspended"); +#if !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) + } else if (IOService::getPMRootDomain()->isAOTMode() && get_task_suspended((task_t) proc->task)) { + proc_suspended = true; + context->skippedInDark++; +#endif /* !(defined(RC_HIDE_N144) || defined(RC_HIDE_N146)) */ + } + proc_rele(proc); + if (proc_suspended) { + return; + } + } + } + } + + if (context->messageFilter && + !context->messageFilter(context->us, object, context, NULL, NULL)) { + if (kIOLogDebugPower & gIOKitDebug) { + logClientIDForNotification(object, context, "DROP App"); + } + return; + } + context->notSkippedInDark++; + + if (kIOLogDebugPower & gIOKitDebug) { + logClientIDForNotification(object, context, "MESG App"); + } + + context->us->messageClient(context->messageType, object, NULL); +} + +//********************************************************************************* +// [private] checkForDone +//********************************************************************************* + +bool +IOService::checkForDone( void ) +{ + int i = 0; + OSObject * theFlag; + + if (fResponseArray == NULL) { + return true; + } + + for (i = 0;; i++) { + theFlag = fResponseArray->getObject(i); + + if (NULL == theFlag) { + break; + } + + if (kOSBooleanTrue != theFlag) { + return false; + } + } + return true; +} + +//********************************************************************************* +// [public] responseValid +//********************************************************************************* + +bool +IOService::responseValid( uint32_t refcon, int pid ) +{ + UInt16 serialComponent; + UInt16 ordinalComponent; + OSObject * theFlag; + OSObject *object = NULL; + + serialComponent = (refcon >> 16) & 0xFFFF; + ordinalComponent = (refcon & 0xFFFF); + + if (serialComponent != fSerialNumber) { + return false; + } + + if (fResponseArray == NULL) { + return false; + } + + theFlag = fResponseArray->getObject(ordinalComponent); + + if (theFlag == NULL) { + return false; + } + + if (fNotifyClientArray) { + object = fNotifyClientArray->getObject(ordinalComponent); + } + + OSNumber * num; + if ((num = OSDynamicCast(OSNumber, theFlag))) { + AbsoluteTime now; + AbsoluteTime start; + uint64_t nsec; + char name[128]; + + clock_get_uptime(&now); + AbsoluteTime_to_scalar(&start) = num->unsigned64BitValue(); + SUB_ABSOLUTETIME(&now, &start); + absolutetime_to_nanoseconds(now, &nsec); + + if (pid != 0) { + name[0] = '\0'; + proc_name(pid, name, sizeof(name)); + + if (nsec > LOG_APP_RESPONSE_TIMES) { + IOLog("PM response took %d ms (%d, %s)\n", NS_TO_MS(nsec), + pid, name); + } + + + if (nsec > LOG_APP_RESPONSE_MSG_TRACER) { + // TODO: populate the messageType argument + getPMRootDomain()->pmStatsRecordApplicationResponse( + gIOPMStatsResponseSlow, + name, 0, NS_TO_MS(nsec), pid, object); + } else { + getPMRootDomain()->pmStatsRecordApplicationResponse( + gIOPMStatsResponsePrompt, + name, 0, NS_TO_MS(nsec), pid, object); + } + } else { + getPMRootDomain()->traceAckDelay(object, 0, NS_TO_MS(nsec)); + } + + if (kIOLogDebugPower & gIOKitDebug) { + PM_LOG("Ack(%u) %u ms\n", + (uint32_t) ordinalComponent, + NS_TO_MS(nsec)); + } + theFlag = kOSBooleanFalse; + } else if (object) { + getPMRootDomain()->pmStatsRecordApplicationResponse( + gIOPMStatsResponsePrompt, + NULL, 0, 0, pid, object); + } + + if (kOSBooleanFalse == theFlag) { + fResponseArray->replaceObject(ordinalComponent, kOSBooleanTrue); + } + + return true; +} + +//********************************************************************************* +// [public] allowPowerChange +// +// Our power state is about to lower, and we have notified applications +// and kernel clients, and one of them has acknowledged. If this is the last to do +// so, and all acknowledgements are positive, we continue with the power change. +//********************************************************************************* + +IOReturn +IOService::allowPowerChange( unsigned long refcon ) +{ + IOPMRequest * request; + + if (!initialized) { + // we're unloading + return kIOReturnSuccess; + } + + request = acquirePMRequest( this, kIOPMRequestTypeAllowPowerChange ); + if (!request) { + return kIOReturnNoMemory; + } + + request->fArg0 = (void *) refcon; + request->fArg1 = (void *)(uintptr_t) proc_selfpid(); + request->fArg2 = (void *) NULL; + submitPMRequest( request ); + + return kIOReturnSuccess; +} + +#ifndef __LP64__ +IOReturn +IOService::serializedAllowPowerChange2( unsigned long refcon ) +{ + // [deprecated] public + return kIOReturnUnsupported; +} +#endif /* !__LP64__ */ + +//********************************************************************************* +// [public] cancelPowerChange +// +// Our power state is about to lower, and we have notified applications +// and kernel clients, and one of them has vetoed the change. If this is the last +// client to respond, we abandon the power change. +//********************************************************************************* + +IOReturn +IOService::cancelPowerChange( unsigned long refcon ) +{ + IOPMRequest * request; + char name[128]; + pid_t pid = proc_selfpid(); + + if (!initialized) { + // we're unloading + return kIOReturnSuccess; + } + + name[0] = '\0'; + proc_name(pid, name, sizeof(name)); + PM_ERROR("PM notification cancel (pid %d, %s)\n", pid, name); + + request = acquirePMRequest( this, kIOPMRequestTypeCancelPowerChange ); + if (!request) { + return kIOReturnNoMemory; + } + + request->fArg0 = (void *) refcon; + request->fArg1 = (void *)(uintptr_t) proc_selfpid(); + request->fArg2 = (void *) OSString::withCString(name); + submitPMRequest( request ); + + return kIOReturnSuccess; +} + +//********************************************************************************* +// cancelIdlePowerDown +// +// Internal method to trigger an idle cancel or revert +//********************************************************************************* + +void +IOService::cancelIdlePowerDown( IOService * service ) +{ + IOPMRequest * request; + + request = acquirePMRequest(service, kIOPMRequestTypeIdleCancel); + if (request) { + submitPMRequest(request); + } +} + +#ifndef __LP64__ +IOReturn +IOService::serializedCancelPowerChange2( unsigned long refcon ) +{ + // [deprecated] public + return kIOReturnUnsupported; +} + +//********************************************************************************* +// PM_Clamp_Timer_Expired +// +// called when clamp timer expires...set power state to 0. //********************************************************************************* -void IOService::tellNoChangeDown ( unsigned long ) +void +IOService::PM_Clamp_Timer_Expired( void ) { - return tellClients( kIOMessageDeviceWillNotPowerOff ); } //********************************************************************************* -// [public] tellChangeUp -// -// Notify registered applications and kernel clients that we are raising power. +// clampPowerOn // -// Subclass can override this to send a different message type. Parameter is -// the aborted destination state number. +// Set to highest available power state for a minimum of duration milliseconds //********************************************************************************* -void IOService::tellChangeUp ( unsigned long ) +void +IOService::clampPowerOn( unsigned long duration ) { - return tellClients( kIOMessageDeviceHasPoweredOn ); } +#endif /* !__LP64__ */ //********************************************************************************* -// [protected] tellClients +// configurePowerStateReport // -// Notify registered applications and kernel clients of something. +// Configures the IOStateReport for kPMPowerStateChannel //********************************************************************************* - -void IOService::tellClients ( int messageType ) +IOReturn +IOService::configurePowerStatesReport( IOReportConfigureAction action, void *result ) { - IOPMInterestContext context; + IOReturn rc = kIOReturnSuccess; + size_t reportSize; + unsigned long i; + uint64_t ts; - RD_LOG("tellClients( %s )\n", getIOMessageString(messageType)); + if (!pwrMgt) { + return kIOReturnUnsupported; + } - memset(&context, 0, sizeof(context)); - context.messageType = messageType; - context.isPreChange = fIsPreChange; - context.us = this; - context.stateNumber = fHeadNotePowerState; - context.stateFlags = fHeadNotePowerArrayEntry->capabilityFlags; - context.changeFlags = fHeadNoteChangeFlags; - context.messageFilter = (IS_ROOT_DOMAIN) ? - OSMemberFunctionCast( - IOPMMessageFilter, - this, - &IOPMrootDomain::systemMessageFilter) : 0; + if (!fNumberOfPowerStates) { + return kIOReturnSuccess; // For drivers which are in power plane, but haven't called registerPowerDriver() + } + PM_LOCK(); - context.notifyType = kNotifyPriority; - applyToInterested( gIOPriorityPowerStateInterest, - tellKernelClientApplier, (void *) &context ); + switch (action) { + case kIOReportEnable: + if (fReportBuf) { + fReportClientCnt++; + break; + } + reportSize = STATEREPORT_BUFSIZE(fNumberOfPowerStates); + fReportBuf = IOMalloc(reportSize); + if (!fReportBuf) { + rc = kIOReturnNoMemory; + break; + } + memset(fReportBuf, 0, reportSize); - context.notifyType = kNotifyApps; - applyToInterested( gIOAppPowerStateInterest, - tellAppClientApplier, (void *) &context ); + STATEREPORT_INIT(fNumberOfPowerStates, fReportBuf, reportSize, + getRegistryEntryID(), kPMPowerStatesChID, kIOReportCategoryPower); - applyToInterested( gIOGeneralInterest, - tellKernelClientApplier, (void *) &context ); -} + for (i = 0; i < fNumberOfPowerStates; i++) { + unsigned bits = 0; -//********************************************************************************* -// [private] tellKernelClientApplier -// -// Message a kernel client. -//********************************************************************************* + if (fPowerStates[i].capabilityFlags & kIOPMPowerOn) { + bits |= kPMReportPowerOn; + } + if (fPowerStates[i].capabilityFlags & kIOPMDeviceUsable) { + bits |= kPMReportDeviceUsable; + } + if (fPowerStates[i].capabilityFlags & kIOPMLowPower) { + bits |= kPMReportLowPower; + } -static void tellKernelClientApplier ( OSObject * object, void * arg ) -{ - IOPowerStateChangeNotification notify; - IOPMInterestContext * context = (IOPMInterestContext *) arg; + STATEREPORT_SETSTATEID(fReportBuf, i, ((bits & 0xff) << 8) | + ((StateOrder(fMaxPowerState) & 0xf) << 4) | (StateOrder(i) & 0xf)); + } + ts = mach_absolute_time(); + STATEREPORT_SETSTATE(fReportBuf, fCurrentPowerState, ts); + break; - if (context->messageFilter && - !context->messageFilter(context->us, object, context, 0, 0)) - { - if ((kIOLogDebugPower & gIOKitDebug) && - (OSDynamicCast(_IOServiceInterestNotifier, object))) - { - _IOServiceInterestNotifier *n = (_IOServiceInterestNotifier *) object; - PM_LOG("%s DROP Client %s, notifier %p, handler %p\n", - context->us->getName(), - IOService::getIOMessageString(context->messageType), - object, n->handler); + case kIOReportDisable: + if (fReportClientCnt == 0) { + rc = kIOReturnBadArgument; + break; } - return; - } + if (fReportClientCnt == 1) { + IOFree(fReportBuf, STATEREPORT_BUFSIZE(fNumberOfPowerStates)); + fReportBuf = NULL; + } + fReportClientCnt--; + break; - notify.powerRef = (void *) 0; - notify.returnValue = 0; - notify.stateNumber = context->stateNumber; - notify.stateFlags = context->stateFlags; + case kIOReportGetDimensions: + if (fReportBuf) { + STATEREPORT_UPDATERES(fReportBuf, kIOReportGetDimensions, result); + } + break; + } - context->us->messageClient(context->messageType, object, ¬ify); + PM_UNLOCK(); - if ((kIOLogDebugPower & gIOKitDebug) && - (OSDynamicCast(_IOServiceInterestNotifier, object))) - { - _IOServiceInterestNotifier *n = (_IOServiceInterestNotifier *) object; - PM_LOG("%s MESG Client %s, notifier %p, handler %p\n", - context->us->getName(), - IOService::getIOMessageString(context->messageType), - object, n->handler); - } + return rc; } //********************************************************************************* -// [private] tellAppClientApplier +// updatePowerStateReport // -// Message a registered application. +// Updates the IOStateReport for kPMPowerStateChannel //********************************************************************************* - -static void tellAppClientApplier ( OSObject * object, void * arg ) +IOReturn +IOService::updatePowerStatesReport( IOReportConfigureAction action, void *result, void *destination ) { - IOPMInterestContext * context = (IOPMInterestContext *) arg; + uint32_t size2cpy; + void *data2cpy; + uint64_t ts; + IOReturn rc = kIOReturnSuccess; + IOBufferMemoryDescriptor *dest = OSDynamicCast(IOBufferMemoryDescriptor, (OSObject *)destination); - if (context->messageFilter && - !context->messageFilter(context->us, object, context, 0, 0)) - { - if (kIOLogDebugPower & gIOKitDebug) - { - // Log client pid/name and client array index. - OSString * clientID = 0; - context->us->messageClient(kIOMessageCopyClientID, object, &clientID); - PM_LOG("%s DROP App %s, %s\n", - context->us->getName(), - IOService::getIOMessageString(context->messageType), - clientID ? clientID->getCStringNoCopy() : ""); - if (clientID) clientID->release(); - } - return; - } - if (kIOLogDebugPower & gIOKitDebug) - { - // Log client pid/name and client array index. - OSString * clientID = 0; - context->us->messageClient(kIOMessageCopyClientID, object, &clientID); - PM_LOG("%s MESG App %s, %s\n", - context->us->getName(), - IOService::getIOMessageString(context->messageType), - clientID ? clientID->getCStringNoCopy() : ""); - if (clientID) clientID->release(); - } + if (!pwrMgt) { + return kIOReturnUnsupported; + } + if (!fNumberOfPowerStates) { + return kIOReturnSuccess; + } - context->us->messageClient(context->messageType, object, 0); -} + if (!result || !dest) { + return kIOReturnBadArgument; + } + PM_LOCK(); -//********************************************************************************* -// [private] checkForDone -//********************************************************************************* + switch (action) { + case kIOReportCopyChannelData: + if (!fReportBuf) { + rc = kIOReturnNotOpen; + break; + } -bool IOService::checkForDone ( void ) -{ - int i = 0; - OSObject * theFlag; + ts = mach_absolute_time(); + STATEREPORT_UPDATEPREP(fReportBuf, ts, data2cpy, size2cpy); + if (size2cpy > (dest->getCapacity() - dest->getLength())) { + rc = kIOReturnOverrun; + break; + } - if ( fResponseArray == NULL ) - { - return true; - } - - for ( i = 0; ; i++ ) - { - theFlag = fResponseArray->getObject(i); - if ( theFlag == NULL ) - { - break; - } - if ( kOSBooleanTrue != theFlag ) - { - return false; - } - } - return true; -} + STATEREPORT_UPDATERES(fReportBuf, kIOReportCopyChannelData, result); + dest->appendBytes(data2cpy, size2cpy); + break; -//********************************************************************************* -// [public] responseValid -//********************************************************************************* + default: + break; + } -bool IOService::responseValid ( uint32_t refcon, int pid ) -{ - UInt16 serialComponent; - UInt16 ordinalComponent; - OSObject * theFlag; - - serialComponent = (refcon >> 16) & 0xFFFF; - ordinalComponent = (refcon & 0xFFFF); - - if ( serialComponent != fSerialNumber ) - { - return false; - } - - if ( fResponseArray == NULL ) - { - return false; - } - - theFlag = fResponseArray->getObject(ordinalComponent); - - if ( theFlag == 0 ) - { - return false; - } - - OSNumber * num; - if ((num = OSDynamicCast(OSNumber, theFlag))) - { -#if LOG_APP_RESPONSE_TIMES - AbsoluteTime now; - AbsoluteTime start; - uint64_t nsec; - OSString *name = IOCopyLogNameForPID(pid); - - clock_get_uptime(&now); - AbsoluteTime_to_scalar(&start) = num->unsigned64BitValue(); - SUB_ABSOLUTETIME(&now, &start); - absolutetime_to_nanoseconds(now, &nsec); - - PMEventDetails *details = PMEventDetails::eventDetails( - kIOPMEventTypeAppResponse, // type - name ? name->getCStringNoCopy() : "", // who - (uintptr_t)pid, // owner unique - NULL, // interest name - 0, // old - 0, // new - 0, // result - NS_TO_US(nsec)); // usec completion time - - getPMRootDomain()->recordAndReleasePMEventGated( details ); - - if (kIOLogDebugPower & gIOKitDebug) - { - PM_LOG("Ack(%u) %u ms\n", - (uint32_t) ordinalComponent, - NS_TO_MS(nsec)); - } - - // > 100 ms - if (nsec > LOG_APP_RESPONSE_TIMES) - { - PM_LOG("PM response took %d ms (%s)\n", NS_TO_MS(nsec), - name ? name->getCStringNoCopy() : ""); - - if (nsec > LOG_APP_RESPONSE_MSG_TRACER) - { - // TODO: populate the messageType argument - getPMRootDomain()->pmStatsRecordApplicationResponse( - gIOPMStatsApplicationResponseSlow, - name ? name->getCStringNoCopy() : "", 0, - NS_TO_MS(nsec), pid); - } - } - - if (name) - name->release(); -#endif - theFlag = kOSBooleanFalse; - } + PM_UNLOCK(); - if ( kOSBooleanFalse == theFlag ) - { - fResponseArray->replaceObject(ordinalComponent, kOSBooleanTrue); - } - - return true; + return rc; } //********************************************************************************* -// [public] allowPowerChange +// configureSimplePowerReport // -// Our power state is about to lower, and we have notified applications -// and kernel clients, and one of them has acknowledged. If this is the last to do -// so, and all acknowledgements are positive, we continue with the power change. +// Configures the IOSimpleReport for given channel id //********************************************************************************* - -IOReturn IOService::allowPowerChange ( unsigned long refcon ) +IOReturn +IOService::configureSimplePowerReport(IOReportConfigureAction action, void *result ) { - IOPMRequest * request; + IOReturn rc = kIOReturnSuccess; - if ( !initialized ) - { - // we're unloading - return kIOReturnSuccess; - } + if (!pwrMgt) { + return kIOReturnUnsupported; + } - request = acquirePMRequest( this, kIOPMRequestTypeAllowPowerChange ); - if (!request) - return kIOReturnNoMemory; + if (!fNumberOfPowerStates) { + return rc; + } - request->fArg0 = (void *) refcon; - request->fArg1 = (void *) proc_selfpid(); - request->fArg2 = (void *) 0; - submitPMRequest( request ); + switch (action) { + case kIOReportEnable: + case kIOReportDisable: + break; - return kIOReturnSuccess; -} + case kIOReportGetDimensions: + SIMPLEREPORT_UPDATERES(kIOReportGetDimensions, result); + break; + } -#ifndef __LP64__ -IOReturn IOService::serializedAllowPowerChange2 ( unsigned long refcon ) -{ - // [deprecated] public - return kIOReturnUnsupported; + + return rc; } -#endif /* !__LP64__ */ //********************************************************************************* -// [public] cancelPowerChange +// updateSimplePowerReport // -// Our power state is about to lower, and we have notified applications -// and kernel clients, and one of them has vetoed the change. If this is the last -// client to respond, we abandon the power change. +// Updates the IOSimpleReport for the given chanel id //********************************************************************************* - -IOReturn IOService::cancelPowerChange ( unsigned long refcon ) +IOReturn +IOService::updateSimplePowerReport( IOReportConfigureAction action, void *result, void *destination ) { - IOPMRequest * request; - OSString * name; + uint32_t size2cpy; + void *data2cpy; + uint64_t buf[SIMPLEREPORT_BUFSIZE / sizeof(uint64_t) + 1]; // Force a 8-byte alignment + IOBufferMemoryDescriptor *dest = OSDynamicCast(IOBufferMemoryDescriptor, (OSObject *)destination); + IOReturn rc = kIOReturnSuccess; + unsigned bits = 0; - if ( !initialized ) - { - // we're unloading - return kIOReturnSuccess; - } - name = IOCopyLogNameForPID(proc_selfpid()); - PM_ERROR("PM notification cancel (%s)\n", name ? name->getCStringNoCopy() : ""); + if (!pwrMgt) { + return kIOReturnUnsupported; + } + if (!result || !dest) { + return kIOReturnBadArgument; + } - request = acquirePMRequest( this, kIOPMRequestTypeCancelPowerChange ); - if (!request) - { - if (name) - name->release(); - return kIOReturnNoMemory; - } + if (!fNumberOfPowerStates) { + return rc; + } + PM_LOCK(); - request->fArg0 = (void *) refcon; - request->fArg1 = (void *) proc_selfpid(); - request->fArg2 = (void *) name; - submitPMRequest( request ); + switch (action) { + case kIOReportCopyChannelData: - return kIOReturnSuccess; -} + SIMPLEREPORT_INIT(buf, sizeof(buf), getRegistryEntryID(), kPMCurrStateChID, kIOReportCategoryPower); -#ifndef __LP64__ -IOReturn IOService::serializedCancelPowerChange2 ( unsigned long refcon ) -{ - // [deprecated] public - return kIOReturnUnsupported; -} + if (fPowerStates[fCurrentPowerState].capabilityFlags & kIOPMPowerOn) { + bits |= kPMReportPowerOn; + } + if (fPowerStates[fCurrentPowerState].capabilityFlags & kIOPMDeviceUsable) { + bits |= kPMReportDeviceUsable; + } + if (fPowerStates[fCurrentPowerState].capabilityFlags & kIOPMLowPower) { + bits |= kPMReportLowPower; + } -//********************************************************************************* -// PM_Clamp_Timer_Expired -// -// called when clamp timer expires...set power state to 0. -//********************************************************************************* -void IOService::PM_Clamp_Timer_Expired ( void ) -{ -} + SIMPLEREPORT_SETVALUE(buf, ((bits & 0xff) << 8) | ((StateOrder(fMaxPowerState) & 0xf) << 4) | + (StateOrder(fCurrentPowerState) & 0xf)); -//********************************************************************************* -// clampPowerOn -// -// Set to highest available power state for a minimum of duration milliseconds -//********************************************************************************* + SIMPLEREPORT_UPDATEPREP(buf, data2cpy, size2cpy); + if (size2cpy > (dest->getCapacity() - dest->getLength())) { + rc = kIOReturnOverrun; + break; + } -void IOService::clampPowerOn ( unsigned long duration ) -{ + SIMPLEREPORT_UPDATERES(kIOReportCopyChannelData, result); + dest->appendBytes(data2cpy, size2cpy); + break; + + default: + break; + } + + PM_UNLOCK(); + + return kIOReturnSuccess; } -#endif /* !__LP64__ */ + + // MARK: - // MARK: Driver Overrides @@ -6013,91 +7122,74 @@ void IOService::clampPowerOn ( unsigned long duration ) // Does nothing here. This should be implemented in a subclass driver. //********************************************************************************* -IOReturn IOService::setPowerState ( +IOReturn +IOService::setPowerState( unsigned long powerStateOrdinal, IOService * whatDevice ) { - return IOPMNoErr; + return IOPMNoErr; } //********************************************************************************* // [public] maxCapabilityForDomainState // -// Finds the highest power state in the array whose input power -// requirement is equal to the input parameter. Where a more intelligent -// decision is possible, override this in the subclassed driver. +// Finds the highest power state in the array whose input power requirement +// is equal to the input parameter. Where a more intelligent decision is +// possible, override this in the subclassed driver. //********************************************************************************* -unsigned long IOService::maxCapabilityForDomainState ( IOPMPowerFlags domainState ) +IOPMPowerStateIndex +IOService::getPowerStateForDomainFlags( IOPMPowerFlags flags ) { - int i; + IOPMPowerStateIndex stateIndex; - if (fNumberOfPowerStates == 0 ) - { - return 0; - } - for ( i = fNumberOfPowerStates - 1; i >= 0; i-- ) - { - if ( (domainState & fPowerStates[i].inputPowerFlags) == - fPowerStates[i].inputPowerFlags ) - { - return i; - } - } - return 0; + if (!fNumberOfPowerStates) { + return kPowerStateZero; + } + + for (int order = fNumberOfPowerStates - 1; order >= 0; order--) { + stateIndex = fPowerStates[order].stateOrderToIndex; + + if ((flags & fPowerStates[stateIndex].inputPowerFlags) == + fPowerStates[stateIndex].inputPowerFlags) { + return stateIndex; + } + } + return kPowerStateZero; +} + +unsigned long +IOService::maxCapabilityForDomainState( IOPMPowerFlags domainState ) +{ + return getPowerStateForDomainFlags(domainState); } //********************************************************************************* // [public] initialPowerStateForDomainState // -// Finds the highest power state in the array whose input power -// requirement is equal to the input parameter. Where a more intelligent -// decision is possible, override this in the subclassed driver. +// Called to query the power state for the initial power transition. //********************************************************************************* -unsigned long IOService::initialPowerStateForDomainState ( IOPMPowerFlags domainState ) +unsigned long +IOService::initialPowerStateForDomainState( IOPMPowerFlags domainState ) { - int i; + if (fResetPowerStateOnWake && (domainState & kIOPMRootDomainState)) { + // Return lowest power state for any root power domain changes + return kPowerStateZero; + } - if (fNumberOfPowerStates == 0 ) - { - return 0; - } - for ( i = fNumberOfPowerStates - 1; i >= 0; i-- ) - { - if ( (domainState & fPowerStates[i].inputPowerFlags) == - fPowerStates[i].inputPowerFlags ) - { - return i; - } - } - return 0; + return getPowerStateForDomainFlags(domainState); } //********************************************************************************* // [public] powerStateForDomainState // -// Finds the highest power state in the array whose input power -// requirement is equal to the input parameter. Where a more intelligent -// decision is possible, override this in the subclassed driver. +// This method is not called from PM. //********************************************************************************* -unsigned long IOService::powerStateForDomainState ( IOPMPowerFlags domainState ) +unsigned long +IOService::powerStateForDomainState( IOPMPowerFlags domainState ) { - int i; - - if (fNumberOfPowerStates == 0 ) - { - return 0; - } - for ( i = fNumberOfPowerStates - 1; i >= 0; i-- ) - { - if ( (domainState & fPowerStates[i].inputPowerFlags) == - fPowerStates[i].inputPowerFlags ) - { - return i; - } - } - return 0; + return getPowerStateForDomainFlags(domainState); } #ifndef __LP64__ @@ -6107,9 +7199,10 @@ unsigned long IOService::powerStateForDomainState ( IOPMPowerFlags domainState ) // Does nothing here. This should be implemented in a subclass driver. //********************************************************************************* -bool IOService::didYouWakeSystem ( void ) +bool +IOService::didYouWakeSystem( void ) { - return false; + return false; } #endif /* !__LP64__ */ @@ -6119,9 +7212,10 @@ bool IOService::didYouWakeSystem ( void ) // Does nothing here. This should be implemented in a subclass driver. //********************************************************************************* -IOReturn IOService::powerStateWillChangeTo ( IOPMPowerFlags, unsigned long, IOService * ) +IOReturn +IOService::powerStateWillChangeTo( IOPMPowerFlags, unsigned long, IOService * ) { - return kIOPMAckImplied; + return kIOPMAckImplied; } //********************************************************************************* @@ -6130,9 +7224,10 @@ IOReturn IOService::powerStateWillChangeTo ( IOPMPowerFlags, unsigned long, IOSe // Does nothing here. This should be implemented in a subclass driver. //********************************************************************************* -IOReturn IOService::powerStateDidChangeTo ( IOPMPowerFlags, unsigned long, IOService * ) +IOReturn +IOService::powerStateDidChangeTo( IOPMPowerFlags, unsigned long, IOService * ) { - return kIOPMAckImplied; + return kIOPMAckImplied; } //********************************************************************************* @@ -6142,7 +7237,8 @@ IOReturn IOService::powerStateDidChangeTo ( IOPMPowerFlags, unsigned long, IOSer // Does nothing here. This should be implemented in a subclass policy-maker. //********************************************************************************* -void IOService::powerChangeDone ( unsigned long ) +void +IOService::powerChangeDone( unsigned long ) { } @@ -6153,9 +7249,10 @@ void IOService::powerChangeDone ( unsigned long ) // Does nothing here. This should be implemented in a subclass driver. //********************************************************************************* -IOReturn IOService::newTemperature ( long currentTemp, IOService * whichZone ) +IOReturn +IOService::newTemperature( long currentTemp, IOService * whichZone ) { - return IOPMNoErr; + return IOPMNoErr; } #endif /* !__LP64__ */ @@ -6165,11 +7262,13 @@ IOReturn IOService::newTemperature ( long currentTemp, IOService * whichZone ) // System shutdown and restart notification. //********************************************************************************* -void IOService::systemWillShutdown( IOOptionBits specifier ) +void +IOService::systemWillShutdown( IOOptionBits specifier ) { IOPMrootDomain * rootDomain = IOService::getPMRootDomain(); - if (rootDomain) + if (rootDomain) { rootDomain->acknowledgeSystemWillShutdown( this ); + } } // MARK: - @@ -6181,26 +7280,24 @@ void IOService::systemWillShutdown( IOOptionBits specifier ) IOPMRequest * IOService::acquirePMRequest( IOService * target, IOOptionBits requestType, - IOPMRequest * active ) + IOPMRequest * active ) { IOPMRequest * request; assert(target); request = IOPMRequest::create(); - if (request) - { + if (request) { request->init( target, requestType ); - if (active) - { - IOPMRequest * root = active->getRootRequest(); - if (root) request->attachRootRequest(root); - } - } - else - { - PM_ERROR("%s: No memory for PM request type 0x%x\n", - target->getName(), (uint32_t) requestType); + if (active) { + IOPMRequest * root = active->getRootRequest(); + if (root) { + request->attachRootRequest(root); + } + } + } else { + PM_ERROR("%s: No memory for PM request type 0x%x\n", + target->getName(), (uint32_t) requestType); } return request; } @@ -6209,144 +7306,153 @@ IOService::acquirePMRequest( IOService * target, IOOptionBits requestType, // [private static] releasePMRequest //********************************************************************************* -void IOService::releasePMRequest( IOPMRequest * request ) +void +IOService::releasePMRequest( IOPMRequest * request ) { - if (request) - { + if (request) { request->reset(); request->release(); } } //********************************************************************************* -// [private] submitPMRequest +// [private static] submitPMRequest //********************************************************************************* -void IOService::submitPMRequest( IOPMRequest * request ) +void +IOService::submitPMRequest( IOPMRequest * request ) { assert( request ); assert( gIOPMReplyQueue ); assert( gIOPMRequestQueue ); PM_LOG1("[+ %02lx] %p [%p %s] %p %p %p\n", - (long)request->getType(), request, - request->getTarget(), request->getTarget()->getName(), - request->fArg0, request->fArg1, request->fArg2); + (long)request->getType(), OBFUSCATE(request), + OBFUSCATE(request->getTarget()), request->getTarget()->getName(), + OBFUSCATE(request->fArg0), + OBFUSCATE(request->fArg1), OBFUSCATE(request->fArg2)); - if (request->isReplyType()) + if (request->isReplyType()) { gIOPMReplyQueue->queuePMRequest( request ); - else + } else { gIOPMRequestQueue->queuePMRequest( request ); + } } -void IOService::submitPMRequest( IOPMRequest ** requests, IOItemCount count ) +void +IOService::submitPMRequests( IOPMRequest ** requests, IOItemCount count ) { assert( requests ); assert( count > 0 ); assert( gIOPMRequestQueue ); - for (IOItemCount i = 0; i < count; i++) - { + for (IOItemCount i = 0; i < count; i++) { IOPMRequest * req = requests[i]; PM_LOG1("[+ %02lx] %p [%p %s] %p %p %p\n", - (long)req->getType(), req, - req->getTarget(), req->getTarget()->getName(), - req->fArg0, req->fArg1, req->fArg2); + (long)req->getType(), OBFUSCATE(req), + OBFUSCATE(req->getTarget()), req->getTarget()->getName(), + OBFUSCATE(req->fArg0), + OBFUSCATE(req->fArg1), OBFUSCATE(req->fArg2)); } gIOPMRequestQueue->queuePMRequestChain( requests, count ); } //********************************************************************************* -// [private] servicePMRequestQueue +// [private] actionPMRequestQueue // -// Called from IOPMRequestQueue::checkForWork(). +// IOPMRequestQueue::checkForWork() passing a new request to the request target. //********************************************************************************* -bool IOService::servicePMRequestQueue( - IOPMRequest * request, - IOPMRequestQueue * queue ) +bool +IOService::actionPMRequestQueue( + IOPMRequest * request, + IOPMRequestQueue * queue ) { - bool more; + bool more; + + if (initialized) { + // Work queue will immediately execute the request if the per-service + // request queue is empty. Note pwrMgt is the target's IOServicePM. - if (initialized) - { - // Work queue will immediately execute the queue'd request if possible. - // If execution blocks, the work queue will wait for a producer signal. - // Only need to signal more when completing attached requests. + more = gIOPMWorkQueue->queuePMRequest(request, pwrMgt); + } else { + // Calling PM without PMinit() is not allowed, fail the request. + // Need to signal more when completing attached requests. - more = gIOPMWorkQueue->queuePMRequest(request, pwrMgt); - return more; - } + PM_LOG("%s: PM not initialized\n", getName()); + PM_LOG1("[- %02x] %p [%p %s] !initialized\n", + request->getType(), OBFUSCATE(request), + OBFUSCATE(this), getName()); - // Calling PM without PMinit() is not allowed, fail the request. + more = gIOPMCompletionQueue->queuePMRequest(request); + if (more) { + gIOPMWorkQueue->incrementProducerCount(); + } + } - PM_LOG("%s: PM not initialized\n", getName()); - fAdjustPowerScheduled = false; - more = gIOPMFreeQueue->queuePMRequest(request); - if (more) gIOPMWorkQueue->incrementProducerCount(); return more; } //********************************************************************************* -// [private] servicePMFreeQueue +// [private] actionPMCompletionQueue // -// Called from IOPMCompletionQueue::checkForWork(). +// IOPMCompletionQueue::checkForWork() passing a completed request to the +// request target. //********************************************************************************* -bool IOService::servicePMFreeQueue( - IOPMRequest * request, +bool +IOService::actionPMCompletionQueue( + IOPMRequest * request, IOPMCompletionQueue * queue ) { - bool more = request->getNextRequest(); - IOPMRequest * root = request->getRootRequest(); + bool more = (request->getNextRequest() != NULL); + IOPMRequest * root = request->getRootRequest(); - if (root && (root != request)) - more = true; - if (more) - gIOPMWorkQueue->incrementProducerCount(); + if (root && (root != request)) { + more = true; + } + if (more) { + gIOPMWorkQueue->incrementProducerCount(); + } releasePMRequest( request ); return more; } //********************************************************************************* -// [private] retirePMRequest +// [private] actionPMWorkQueueRetire // -// Called by IOPMWorkQueue to retire a completed request. +// IOPMWorkQueue::checkForWork() passing a retired request to the request target. //********************************************************************************* -bool IOService::retirePMRequest( IOPMRequest * request, IOPMWorkQueue * queue ) +bool +IOService::actionPMWorkQueueRetire( IOPMRequest * request, IOPMWorkQueue * queue ) { assert(request && queue); PM_LOG1("[- %02x] %p [%p %s] state %d, busy %d\n", - request->getType(), request, this, getName(), - fMachineState, gIOPMBusyCount); - - // Catch requests created by idleTimerExpired(). - - if ((request->getType() == kIOPMRequestTypeActivityTickle) && - (request->fArg1 == (void *) (uintptr_t) false)) - { - // Idle timer power drop request completed. - // Restart the idle timer if deviceDesire can go lower, otherwise set - // a flag so we know to restart idle timer when deviceDesire goes up. - - if (fDeviceDesire > 0) - { - fActivityTickleCount = 0; - clock_get_uptime(&fIdleTimerStartTime); - start_PM_idle_timer(); + request->getType(), OBFUSCATE(request), + OBFUSCATE(this), getName(), + fMachineState, gIOPMBusyRequestCount); + + // Catch requests created by idleTimerExpired() + if (request->getType() == kIOPMRequestTypeActivityTickle) { + uint32_t tickleFlags = (uint32_t)(uintptr_t) request->fArg1; + + if ((tickleFlags & kTickleTypePowerDrop) && fIdleTimerPeriod) { + restartIdleTimer(); + } else if (tickleFlags == (kTickleTypeActivity | kTickleTypePowerRise)) { + // Invalidate any idle power drop that got queued while + // processing this request. + fIdleTimerGeneration++; } - else - fIdleTimerStopped = true; } - // If the request is linked, then Work queue has already incremented its - // producer count. + // When the completed request is linked, tell work queue there is + // more work pending. - return (gIOPMFreeQueue->queuePMRequest( request )); + return gIOPMCompletionQueue->queuePMRequest( request ); } //********************************************************************************* @@ -6355,58 +7461,56 @@ bool IOService::retirePMRequest( IOPMRequest * request, IOPMWorkQueue * queue ) // Check if machine state transition is blocked. //********************************************************************************* -bool IOService::isPMBlocked ( IOPMRequest * request, int count ) +bool +IOService::isPMBlocked( IOPMRequest * request, int count ) { - int reason = 0; + int reason = 0; do { - if (kIOPM_Finished == fMachineState) + if (kIOPM_Finished == fMachineState) { break; + } - if (kIOPM_DriverThreadCallDone == fMachineState) - { - // 5 = kDriverCallInformPreChange - // 6 = kDriverCallInformPostChange - // 7 = kDriverCallSetPowerState - if (fDriverCallBusy) - reason = 5 + fDriverCallReason; + if (kIOPM_DriverThreadCallDone == fMachineState) { + // 5 = kDriverCallInformPreChange + // 6 = kDriverCallInformPostChange + // 7 = kDriverCallSetPowerState + // 8 = kRootDomainInformPreChange + if (fDriverCallBusy) { + reason = 5 + fDriverCallReason; + } break; } // Waiting on driver's setPowerState() timeout. - if (fDriverTimer) - { + if (fDriverTimer) { reason = 1; break; } // Child or interested driver acks pending. - if (fHeadNotePendingAcks) - { + if (fHeadNotePendingAcks) { reason = 2; break; } // Waiting on apps or priority power interest clients. - if (fResponseArray) - { + if (fResponseArray) { reason = 3; break; } // Waiting on settle timer expiration. - if (fSettleTimeUS) - { + if (fSettleTimeUS) { reason = 4; break; } } while (false); fWaitReason = reason; - if (reason) - { - if (count) - { + if (reason) { + if (count) { PM_LOG1("[B %02x] %p [%p %s] state %d, reason %d\n", - request->getType(), request, this, getName(), - fMachineState, reason); + request->getType(), OBFUSCATE(request), + OBFUSCATE(this), getName(), + fMachineState, reason); } return true; @@ -6416,301 +7520,288 @@ bool IOService::isPMBlocked ( IOPMRequest * request, int count ) } //********************************************************************************* -// [private] servicePMRequest +// [private] actionPMWorkQueueInvoke // -// Service a request from our work queue. +// IOPMWorkQueue::checkForWork() passing a request to the +// request target for execution. //********************************************************************************* -bool IOService::servicePMRequest( IOPMRequest * request, IOPMWorkQueue * queue ) +bool +IOService::actionPMWorkQueueInvoke( IOPMRequest * request, IOPMWorkQueue * queue ) { - bool done = false; - int loop = 0; + bool done = false; + int loop = 0; assert(request && queue); - while (isPMBlocked(request, loop++) == false) - { + while (isPMBlocked(request, loop++) == false) { PM_LOG1("[W %02x] %p [%p %s] state %d\n", - request->getType(), request, this, getName(), fMachineState); + request->getType(), OBFUSCATE(request), + OBFUSCATE(this), getName(), fMachineState); gIOPMRequest = request; - gIOPMWorkCount++; + gIOPMWorkInvokeCount++; // Every PM machine states must be handled in one of the cases below. - switch ( fMachineState ) - { - case kIOPM_Finished: - executePMRequest( request ); - break; + switch (fMachineState) { + case kIOPM_Finished: + start_watchdog_timer(); - case kIOPM_OurChangeTellClientsPowerDown: - // Root domain might self cancel due to assertions. - if (IS_ROOT_DOMAIN) - { - bool cancel = (bool) fDoNotPowerDown; - getPMRootDomain()->askChangeDownDone( - &fHeadNoteChangeFlags, &cancel); - fDoNotPowerDown = cancel; - } - - // askChangeDown() done, was it vetoed? - if (!fDoNotPowerDown) - { - if (IS_ROOT_DOMAIN) { - PMEventDetails *details = PMEventDetails::eventDetails( - kIOPMEventTypeAppNotificationsFinished, - NULL, - 0, - 0); - - getPMRootDomain()->recordAndReleasePMEventGated( details ); - } - - // no, we can continue - OurChangeTellClientsPowerDown(); - } - else - { - if (IS_ROOT_DOMAIN) { - PMEventDetails *details = PMEventDetails::eventDetails( - kIOPMEventTypeSleepDone, - NULL, - 1, /* reason: 1 == Ask clients succeeded */ - kIOReturnAborted); /* result */ - - getPMRootDomain()->recordAndReleasePMEventGated( details ); - } - - OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState); - PM_ERROR("%s: idle cancel\n", fName); - // yes, rescind the warning + executePMRequest( request ); + break; + + case kIOPM_OurChangeTellClientsPowerDown: + // Root domain might self cancel due to assertions. + if (IS_ROOT_DOMAIN) { + bool cancel = (bool) fDoNotPowerDown; + getPMRootDomain()->askChangeDownDone( + &fHeadNoteChangeFlags, &cancel); + fDoNotPowerDown = cancel; + } + + // askChangeDown() done, was it vetoed? + if (!fDoNotPowerDown) { + // no, we can continue + OurChangeTellClientsPowerDown(); + } else { + OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState); + PM_ERROR("%s: idle cancel, state %u\n", fName, fMachineState); + if (IS_ROOT_DOMAIN) { + // RootDomain already sent "WillSleep" to its clients + tellChangeUp(fCurrentPowerState); + } else { tellNoChangeDown(fHeadNotePowerState); - // mark the change note un-actioned - fHeadNoteChangeFlags |= kIOPMNotDone; - // and we're done - OurChangeFinish(); } - break; + // mark the change note un-actioned + fHeadNoteChangeFlags |= kIOPMNotDone; + // and we're done + OurChangeFinish(); + } + break; - case kIOPM_OurChangeTellPriorityClientsPowerDown: - // tellChangeDown(kNotifyApps) done, was it cancelled? - if (fDoNotPowerDown) - { - if (IS_ROOT_DOMAIN) { - PMEventDetails *details = PMEventDetails::eventDetails( - kIOPMEventTypeSleepDone, - NULL, - 2, /* reason: 2 == Client cancelled wake */ - kIOReturnAborted); /* result */ - - getPMRootDomain()->recordAndReleasePMEventGated( details ); - } - OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState); - PM_ERROR("%s: idle revert\n", fName); - // no, tell clients we're back in the old state + case kIOPM_OurChangeTellUserPMPolicyPowerDown: + // PMRD: tellChangeDown/kNotifyApps done, was it cancelled? + if (fDoNotPowerDown) { + OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState); + PM_ERROR("%s: idle cancel, state %u\n", fName, fMachineState); + if (IS_ROOT_DOMAIN) { + // RootDomain already sent "WillSleep" to its clients tellChangeUp(fCurrentPowerState); - // mark the change note un-actioned - fHeadNoteChangeFlags |= kIOPMNotDone; - // and we're done - OurChangeFinish(); - } - else - { - if (IS_ROOT_DOMAIN) { - PMEventDetails *details = PMEventDetails::eventDetails( - kIOPMEventTypeAppNotificationsFinished, - NULL, - 2, /* reason: 2 == TellPriorityClientsDone */ - kIOReturnSuccess); /* result */ - - getPMRootDomain()->recordAndReleasePMEventGated( details ); - } - // yes, we can continue - OurChangeTellPriorityClientsPowerDown(); + } else { + tellNoChangeDown(fHeadNotePowerState); } - break; + // mark the change note un-actioned + fHeadNoteChangeFlags |= kIOPMNotDone; + // and we're done + OurChangeFinish(); + } else { + OurChangeTellUserPMPolicyPowerDown(); + } + break; - case kIOPM_OurChangeNotifyInterestedDriversWillChange: - OurChangeNotifyInterestedDriversWillChange(); - break; + case kIOPM_OurChangeTellPriorityClientsPowerDown: + // PMRD: LastCallBeforeSleep notify done + // Non-PMRD: tellChangeDown/kNotifyApps done + if (fDoNotPowerDown) { + OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState); + PM_ERROR("%s: idle revert, state %u\n", fName, fMachineState); + // no, tell clients we're back in the old state + tellChangeUp(fCurrentPowerState); + // mark the change note un-actioned + fHeadNoteChangeFlags |= kIOPMNotDone; + // and we're done + OurChangeFinish(); + } else { + // yes, we can continue + OurChangeTellPriorityClientsPowerDown(); + } + break; - case kIOPM_OurChangeSetPowerState: - OurChangeSetPowerState(); - break; + case kIOPM_OurChangeNotifyInterestedDriversWillChange: + OurChangeNotifyInterestedDriversWillChange(); + break; - case kIOPM_OurChangeWaitForPowerSettle: - OurChangeWaitForPowerSettle(); - break; + case kIOPM_OurChangeSetPowerState: + OurChangeSetPowerState(); + break; - case kIOPM_OurChangeNotifyInterestedDriversDidChange: - OurChangeNotifyInterestedDriversDidChange(); - break; + case kIOPM_OurChangeWaitForPowerSettle: + OurChangeWaitForPowerSettle(); + break; - case kIOPM_OurChangeTellCapabilityDidChange: - OurChangeTellCapabilityDidChange(); - break; + case kIOPM_OurChangeNotifyInterestedDriversDidChange: + OurChangeNotifyInterestedDriversDidChange(); + break; - case kIOPM_OurChangeFinish: - OurChangeFinish(); - break; + case kIOPM_OurChangeTellCapabilityDidChange: + OurChangeTellCapabilityDidChange(); + break; - case kIOPM_ParentChangeTellPriorityClientsPowerDown: - ParentChangeTellPriorityClientsPowerDown(); - break; + case kIOPM_OurChangeFinish: + OurChangeFinish(); + break; - case kIOPM_ParentChangeNotifyInterestedDriversWillChange: - ParentChangeNotifyInterestedDriversWillChange(); - break; + case kIOPM_ParentChangeTellPriorityClientsPowerDown: + ParentChangeTellPriorityClientsPowerDown(); + break; - case kIOPM_ParentChangeSetPowerState: - ParentChangeSetPowerState(); - break; + case kIOPM_ParentChangeNotifyInterestedDriversWillChange: + ParentChangeNotifyInterestedDriversWillChange(); + break; - case kIOPM_ParentChangeWaitForPowerSettle: - ParentChangeWaitForPowerSettle(); - break; + case kIOPM_ParentChangeSetPowerState: + ParentChangeSetPowerState(); + break; - case kIOPM_ParentChangeNotifyInterestedDriversDidChange: - ParentChangeNotifyInterestedDriversDidChange(); - break; + case kIOPM_ParentChangeWaitForPowerSettle: + ParentChangeWaitForPowerSettle(); + break; - case kIOPM_ParentChangeTellCapabilityDidChange: - ParentChangeTellCapabilityDidChange(); - break; + case kIOPM_ParentChangeNotifyInterestedDriversDidChange: + ParentChangeNotifyInterestedDriversDidChange(); + break; - case kIOPM_ParentChangeAcknowledgePowerChange: - ParentChangeAcknowledgePowerChange(); - break; + case kIOPM_ParentChangeTellCapabilityDidChange: + ParentChangeTellCapabilityDidChange(); + break; - case kIOPM_DriverThreadCallDone: - if (fDriverCallReason == kDriverCallSetPowerState) - notifyControllingDriverDone(); - else - notifyInterestedDriversDone(); + case kIOPM_ParentChangeAcknowledgePowerChange: + ParentChangeAcknowledgePowerChange(); + break; + + case kIOPM_DriverThreadCallDone: + switch (fDriverCallReason) { + case kDriverCallInformPreChange: + case kDriverCallInformPostChange: + notifyInterestedDriversDone(); + break; + case kDriverCallSetPowerState: + notifyControllingDriverDone(); + break; + case kRootDomainInformPreChange: + notifyRootDomainDone(); break; + default: + panic("%s: bad call reason %x", + getName(), fDriverCallReason); + } + break; + + case kIOPM_NotifyChildrenOrdered: + notifyChildrenOrdered(); + break; + + case kIOPM_NotifyChildrenDelayed: + notifyChildrenDelayed(); + break; + + case kIOPM_NotifyChildrenStart: + // pop notifyAll() state saved by notifyInterestedDriversDone() + MS_POP(); + notifyRootDomain(); + break; + + case kIOPM_SyncTellClientsPowerDown: + // Root domain might self cancel due to assertions. + if (IS_ROOT_DOMAIN) { + bool cancel = (bool) fDoNotPowerDown; + getPMRootDomain()->askChangeDownDone( + &fHeadNoteChangeFlags, &cancel); + fDoNotPowerDown = cancel; + } + if (!fDoNotPowerDown) { + fMachineState = kIOPM_SyncTellPriorityClientsPowerDown; + fOutOfBandParameter = kNotifyApps; + tellChangeDown(fHeadNotePowerState); + } else { + // Cancelled by IOPMrootDomain::askChangeDownDone() or + // askChangeDown/kNotifyApps + OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState); + PM_ERROR("%s: idle cancel, state %u\n", fName, fMachineState); + tellNoChangeDown(fHeadNotePowerState); + fHeadNoteChangeFlags |= kIOPMNotDone; + OurChangeFinish(); + } + break; + + case kIOPM_SyncTellPriorityClientsPowerDown: + // PMRD: tellChangeDown/kNotifyApps done, was it cancelled? + if (!fDoNotPowerDown) { + fMachineState = kIOPM_SyncNotifyWillChange; + fOutOfBandParameter = kNotifyPriority; + tellChangeDown(fHeadNotePowerState); + } else { + OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState); + PM_ERROR("%s: idle revert, state %u\n", fName, fMachineState); + tellChangeUp(fCurrentPowerState); + fHeadNoteChangeFlags |= kIOPMNotDone; + OurChangeFinish(); + } + break; + + case kIOPM_SyncNotifyWillChange: + if (kIOPMSyncNoChildNotify & fHeadNoteChangeFlags) { + fMachineState = kIOPM_SyncFinish; + continue; + } + fMachineState = kIOPM_SyncNotifyDidChange; + fDriverCallReason = kDriverCallInformPreChange; + notifyChildren(); + break; + + case kIOPM_SyncNotifyDidChange: + fIsPreChange = false; + + if (fHeadNoteChangeFlags & kIOPMParentInitiated) { + fMachineState = kIOPM_SyncFinish; + } else { + assert(IS_ROOT_DOMAIN); + fMachineState = kIOPM_SyncTellCapabilityDidChange; + } + + fDriverCallReason = kDriverCallInformPostChange; + notifyChildren(); + break; - case kIOPM_NotifyChildrenOrdered: - notifyChildrenOrdered(); - break; + case kIOPM_SyncTellCapabilityDidChange: + tellSystemCapabilityChange( kIOPM_SyncFinish ); + break; - case kIOPM_NotifyChildrenDelayed: - notifyChildrenDelayed(); - break; + case kIOPM_SyncFinish: + if (fHeadNoteChangeFlags & kIOPMParentInitiated) { + ParentChangeAcknowledgePowerChange(); + } else { + OurChangeFinish(); + } + break; - case kIOPM_NotifyChildrenStart: - PM_LOG2("%s: kIOPM_NotifyChildrenStart done\n", getName()); - MS_POP(); // from notifyInterestedDriversDone() - notifyChildren(); - break; - - case kIOPM_SyncTellClientsPowerDown: - // Root domain might self cancel due to assertions. - if (IS_ROOT_DOMAIN) - { - bool cancel = (bool) fDoNotPowerDown; - getPMRootDomain()->askChangeDownDone( - &fHeadNoteChangeFlags, &cancel); - fDoNotPowerDown = cancel; - } - if (!fDoNotPowerDown) - { - fMachineState = kIOPM_SyncTellPriorityClientsPowerDown; - fOutOfBandParameter = kNotifyApps; - tellChangeDown(fHeadNotePowerState); - } - else - { - OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState); - PM_ERROR("%s: idle cancel\n", fName); - tellNoChangeDown(fHeadNotePowerState); - fHeadNoteChangeFlags |= kIOPMNotDone; - OurChangeFinish(); + case kIOPM_TellCapabilityChangeDone: + if (fIsPreChange) { + if (fOutOfBandParameter == kNotifyCapabilityChangePriority) { + MS_POP(); // tellSystemCapabilityChange() + continue; } - break; - - case kIOPM_SyncTellPriorityClientsPowerDown: - if (!fDoNotPowerDown) - { - fMachineState = kIOPM_SyncNotifyWillChange; - fOutOfBandParameter = kNotifyPriority; - tellChangeDown(fHeadNotePowerState); - } - else - { - OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState); - PM_ERROR("%s: idle revert\n", fName); - tellChangeUp(fCurrentPowerState); - fHeadNoteChangeFlags |= kIOPMNotDone; - OurChangeFinish(); + fOutOfBandParameter = kNotifyCapabilityChangePriority; + } else { + if (fOutOfBandParameter == kNotifyCapabilityChangeApps) { + MS_POP(); // tellSystemCapabilityChange() + continue; } - break; - - case kIOPM_SyncNotifyWillChange: - if (kIOPMSyncNoChildNotify & fHeadNoteChangeFlags) - { - fMachineState = kIOPM_SyncFinish; - continue; - } - fMachineState = kIOPM_SyncNotifyDidChange; - fDriverCallReason = kDriverCallInformPreChange; - notifyChildren(); - break; - - case kIOPM_SyncNotifyDidChange: - fIsPreChange = false; - - if (fHeadNoteChangeFlags & kIOPMParentInitiated) - fMachineState = kIOPM_SyncFinish; - else - fMachineState = kIOPM_SyncTellCapabilityDidChange; - - fDriverCallReason = kDriverCallInformPostChange; - notifyChildren(); - break; - - case kIOPM_SyncTellCapabilityDidChange: - tellSystemCapabilityChange( kIOPM_SyncFinish ); - break; - - case kIOPM_SyncFinish: - if (fHeadNoteChangeFlags & kIOPMParentInitiated) - ParentChangeAcknowledgePowerChange(); - else - OurChangeFinish(); - break; - - case kIOPM_TellCapabilityChangeDone: - if (fIsPreChange) - { - if (fOutOfBandParameter == kNotifyCapabilityChangePriority) - { - MS_POP(); // tellSystemCapabilityChange() - continue; - } - fOutOfBandParameter = kNotifyCapabilityChangePriority; - } - else - { - if (fOutOfBandParameter == kNotifyCapabilityChangeApps) - { - MS_POP(); // tellSystemCapabilityChange() - continue; - } - fOutOfBandParameter = kNotifyCapabilityChangeApps; - } - tellClientsWithResponse( fOutOfBandMessage ); - break; + fOutOfBandParameter = kNotifyCapabilityChangeApps; + } + tellClientsWithResponse( fOutOfBandMessage ); + break; - default: - panic("servicePMWorkQueue: unknown machine state %x", - fMachineState); + default: + panic("PMWorkQueueInvoke: unknown machine state %x", + fMachineState); } - gIOPMRequest = 0; + gIOPMRequest = NULL; - if (fMachineState == kIOPM_Finished) - { + if (fMachineState == kIOPM_Finished) { + stop_watchdog_timer(); done = true; break; } @@ -6723,223 +7814,221 @@ bool IOService::servicePMRequest( IOPMRequest * request, IOPMWorkQueue * queue ) // [private] executePMRequest //********************************************************************************* -void IOService::executePMRequest( IOPMRequest * request ) +void +IOService::executePMRequest( IOPMRequest * request ) { assert( kIOPM_Finished == fMachineState ); - switch (request->getType()) - { - case kIOPMRequestTypePMStop: - handlePMstop( request ); - break; + switch (request->getType()) { + case kIOPMRequestTypePMStop: + handlePMstop( request ); + break; - case kIOPMRequestTypeAddPowerChild1: - addPowerChild1( request ); - break; + case kIOPMRequestTypeAddPowerChild1: + addPowerChild1( request ); + break; - case kIOPMRequestTypeAddPowerChild2: - addPowerChild2( request ); - break; + case kIOPMRequestTypeAddPowerChild2: + addPowerChild2( request ); + break; - case kIOPMRequestTypeAddPowerChild3: - addPowerChild3( request ); - break; + case kIOPMRequestTypeAddPowerChild3: + addPowerChild3( request ); + break; - case kIOPMRequestTypeRegisterPowerDriver: - handleRegisterPowerDriver( request ); - break; + case kIOPMRequestTypeRegisterPowerDriver: + handleRegisterPowerDriver( request ); + break; - case kIOPMRequestTypeAdjustPowerState: - fAdjustPowerScheduled = false; - rebuildChildClampBits(); - adjustPowerState(); - break; + case kIOPMRequestTypeAdjustPowerState: + fAdjustPowerScheduled = false; + adjustPowerState(); + break; - case kIOPMRequestTypePowerDomainWillChange: - handlePowerDomainWillChangeTo( request ); - break; + case kIOPMRequestTypePowerDomainWillChange: + handlePowerDomainWillChangeTo( request ); + break; - case kIOPMRequestTypePowerDomainDidChange: - - handlePowerDomainDidChangeTo( request ); - break; + case kIOPMRequestTypePowerDomainDidChange: + handlePowerDomainDidChangeTo( request ); + break; - case kIOPMRequestTypeRequestPowerState: - case kIOPMRequestTypeRequestPowerStateOverride: - handleRequestPowerState( request ); - break; + case kIOPMRequestTypeRequestPowerState: + case kIOPMRequestTypeRequestPowerStateOverride: + handleRequestPowerState( request ); + break; - case kIOPMRequestTypePowerOverrideOnPriv: - case kIOPMRequestTypePowerOverrideOffPriv: - handlePowerOverrideChanged( request ); - break; + case kIOPMRequestTypePowerOverrideOnPriv: + case kIOPMRequestTypePowerOverrideOffPriv: + handlePowerOverrideChanged( request ); + break; - case kIOPMRequestTypeActivityTickle: - handleActivityTickle( request ); - break; + case kIOPMRequestTypeActivityTickle: + handleActivityTickle( request ); + break; - case kIOPMRequestTypeSynchronizePowerTree: - handleSynchronizePowerTree( request ); - break; + case kIOPMRequestTypeSynchronizePowerTree: + handleSynchronizePowerTree( request ); + break; + + case kIOPMRequestTypeSetIdleTimerPeriod: + { + fIdleTimerPeriod = (uintptr_t) request->fArg0; + fNextIdleTimerPeriod = fIdleTimerPeriod; + if ((false == fLockedFlags.PMStop) && (fIdleTimerPeriod > 0)) { + restartIdleTimer(); + } + } + break; - case kIOPMRequestTypeSetIdleTimerPeriod: - { - fIdleTimerPeriod = (uintptr_t) request->fArg0; + case kIOPMRequestTypeIgnoreIdleTimer: + fIdleTimerIgnored = request->fArg0 ? 1 : 0; + break; - if ((false == fLockedFlags.PMStop) && (fIdleTimerPeriod > 0)) - { - fActivityTickleCount = 0; - clock_get_uptime(&fIdleTimerStartTime); - start_PM_idle_timer(); - } - } - break; + case kIOPMRequestTypeQuiescePowerTree: + gIOPMWorkQueue->finishQuiesceRequest(request); + break; - default: - panic("executePMRequest: unknown request type %x", request->getType()); + default: + panic("executePMRequest: unknown request type %x", request->getType()); } } //********************************************************************************* -// [private] servicePMReplyQueue +// [private] actionPMReplyQueue +// +// IOPMRequestQueue::checkForWork() passing a reply-type request to the +// request target. //********************************************************************************* -bool IOService::servicePMReplyQueue( IOPMRequest * request, IOPMRequestQueue * queue ) +bool +IOService::actionPMReplyQueue( IOPMRequest * request, IOPMRequestQueue * queue ) { bool more = false; assert( request && queue ); - assert( request->isReplyType() ); + assert( request->isReplyType()); PM_LOG1("[A %02x] %p [%p %s] state %d\n", - request->getType(), request, this, getName(), fMachineState); - - switch ( request->getType() ) - { - case kIOPMRequestTypeAllowPowerChange: - case kIOPMRequestTypeCancelPowerChange: - // Check if we are expecting this response. - if (responseValid((uint32_t)(uintptr_t) request->fArg0, - (int)(uintptr_t) request->fArg1)) - { - if (kIOPMRequestTypeCancelPowerChange == request->getType()) - { - // Clients are not allowed to cancel when kIOPMSkipAskPowerDown - // flag is set. Only root domain will set this flag. - - if ((fHeadNoteChangeFlags & kIOPMSkipAskPowerDown) == 0) - { - fDoNotPowerDown = true; - - OSString * name = (OSString *) request->fArg2; - getPMRootDomain()->pmStatsRecordApplicationResponse( - gIOPMStatsApplicationResponseCancel, - name ? name->getCStringNoCopy() : "", 0, - 0, (int)(uintptr_t) request->fArg1); - } - } - - if (checkForDone()) - { - stop_ack_timer(); - cleanClientResponses(false); - more = true; + request->getType(), OBFUSCATE(request), + OBFUSCATE(this), getName(), fMachineState); + + switch (request->getType()) { + case kIOPMRequestTypeAllowPowerChange: + case kIOPMRequestTypeCancelPowerChange: + // Check if we are expecting this response. + if (responseValid((uint32_t)(uintptr_t) request->fArg0, + (int)(uintptr_t) request->fArg1)) { + if (kIOPMRequestTypeCancelPowerChange == request->getType()) { + // Clients are not allowed to cancel when kIOPMSkipAskPowerDown + // flag is set. Only root domain will set this flag. + // However, there is one exception to this rule. User-space PM + // policy may choose to cancel sleep even after all clients have + // been notified that we will lower power. + + if ((fMachineState == kIOPM_OurChangeTellUserPMPolicyPowerDown) + || (fMachineState == kIOPM_OurChangeTellPriorityClientsPowerDown) + || ((fHeadNoteChangeFlags & kIOPMSkipAskPowerDown) == 0)) { + fDoNotPowerDown = true; + + OSString * name = (OSString *) request->fArg2; + getPMRootDomain()->pmStatsRecordApplicationResponse( + gIOPMStatsResponseCancel, + name ? name->getCStringNoCopy() : "", 0, + 0, (int)(uintptr_t) request->fArg1, NULL); } } - // OSString containing app name in Arg2 must be released. - if (request->getType() == kIOPMRequestTypeCancelPowerChange) - { - OSObject * obj = (OSObject *) request->fArg2; - if (obj) obj->release(); - } - break; - - case kIOPMRequestTypeAckPowerChange: - more = handleAcknowledgePowerChange( request ); - break; - case kIOPMRequestTypeAckSetPowerState: - if (fDriverTimer == -1) - { - // driver acked while setPowerState() call is in-flight. - // take this ack, return value from setPowerState() is irrelevant. - OUR_PMLog(kPMLogDriverAcknowledgeSet, - (uintptr_t) this, fDriverTimer); - fDriverTimer = 0; - } - else if (fDriverTimer > 0) - { - // expected ack, stop the timer + if (checkForDone()) { stop_ack_timer(); - -#if LOG_SETPOWER_TIMES - uint64_t nsec = computeTimeDeltaNS(&fDriverCallStartTime); - if (nsec > LOG_SETPOWER_TIMES) - PM_LOG("%s::setPowerState(%p, %lu -> %lu) async took %d ms\n", - fName, this, fCurrentPowerState, fHeadNotePowerState, NS_TO_MS(nsec)); - - PMEventDetails *details = PMEventDetails::eventDetails( - kIOPMEventTypeSetPowerStateDelayed, // type - fName, // who - (uintptr_t)this, // owner unique - NULL, // interest name - (uint8_t)getPowerState(), // old - (uint8_t)fHeadNotePowerState, // new - 0, // result - NS_TO_US(nsec)); // usec completion time - - getPMRootDomain()->recordAndReleasePMEventGated( details ); -#endif - OUR_PMLog(kPMLogDriverAcknowledgeSet, (uintptr_t) this, fDriverTimer); - fDriverTimer = 0; + cleanClientResponses(false); more = true; } - else - { - // unexpected ack - OUR_PMLog(kPMLogAcknowledgeErr4, (uintptr_t) this, 0); + } + // OSString containing app name in Arg2 must be released. + if (request->getType() == kIOPMRequestTypeCancelPowerChange) { + OSObject * obj = (OSObject *) request->fArg2; + if (obj) { + obj->release(); } - break; + } + break; + + case kIOPMRequestTypeAckPowerChange: + more = handleAcknowledgePowerChange( request ); + break; + + case kIOPMRequestTypeAckSetPowerState: + if (fDriverTimer == -1) { + // driver acked while setPowerState() call is in-flight. + // take this ack, return value from setPowerState() is irrelevant. + OUR_PMLog(kPMLogDriverAcknowledgeSet, + (uintptr_t) this, fDriverTimer); + fDriverTimer = 0; + } else if (fDriverTimer > 0) { + // expected ack, stop the timer + stop_ack_timer(); - case kIOPMRequestTypeInterestChanged: - handleInterestChanged( request ); - more = true; - break; + getPMRootDomain()->reset_watchdog_timer(this, 0); - case kIOPMRequestTypeIdleCancel: - if ((fMachineState == kIOPM_OurChangeTellClientsPowerDown) - || (fMachineState == kIOPM_OurChangeTellPriorityClientsPowerDown) - || (fMachineState == kIOPM_SyncTellClientsPowerDown) - || (fMachineState == kIOPM_SyncTellPriorityClientsPowerDown)) - { - OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState); - PM_LOG2("%s: cancel from machine state %d\n", - getName(), fMachineState); - fDoNotPowerDown = true; - // Stop waiting for app replys. - if ((fMachineState == kIOPM_OurChangeTellPriorityClientsPowerDown) || - (fMachineState == kIOPM_SyncTellPriorityClientsPowerDown)) - cleanClientResponses(false); - more = true; + uint64_t nsec = computeTimeDeltaNS(&fDriverCallStartTime); + if (nsec > LOG_SETPOWER_TIMES) { + getPMRootDomain()->pmStatsRecordApplicationResponse( + gIOPMStatsDriverPSChangeSlow, + fName, kDriverCallSetPowerState, NS_TO_MS(nsec), getRegistryEntryID(), + NULL, fHeadNotePowerState); } - break; - case kIOPMRequestTypeChildNotifyDelayCancel: - if (fMachineState == kIOPM_NotifyChildrenDelayed) - { - PM_LOG2("%s: delay notify cancelled\n", getName()); - notifyChildrenDelayed(); - } - break; + OUR_PMLog(kPMLogDriverAcknowledgeSet, (uintptr_t) this, fDriverTimer); + fDriverTimer = 0; + more = true; + } else { + // unexpected ack + OUR_PMLog(kPMLogAcknowledgeErr4, (uintptr_t) this, 0); + } + break; + + case kIOPMRequestTypeInterestChanged: + handleInterestChanged( request ); + more = true; + break; + + case kIOPMRequestTypeIdleCancel: + if ((fMachineState == kIOPM_OurChangeTellClientsPowerDown) + || (fMachineState == kIOPM_OurChangeTellUserPMPolicyPowerDown) + || (fMachineState == kIOPM_OurChangeTellPriorityClientsPowerDown) + || (fMachineState == kIOPM_SyncTellClientsPowerDown) + || (fMachineState == kIOPM_SyncTellPriorityClientsPowerDown)) { + OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState); + PM_LOG2("%s: cancel from machine state %d\n", + getName(), fMachineState); + fDoNotPowerDown = true; + // Stop waiting for app replys. + if ((fMachineState == kIOPM_OurChangeTellPriorityClientsPowerDown) || + (fMachineState == kIOPM_OurChangeTellUserPMPolicyPowerDown) || + (fMachineState == kIOPM_SyncTellPriorityClientsPowerDown) || + (fMachineState == kIOPM_SyncTellClientsPowerDown)) { + cleanClientResponses(false); + } + more = true; + } + break; - default: - panic("servicePMReplyQueue: unknown reply type %x", - request->getType()); + case kIOPMRequestTypeChildNotifyDelayCancel: + if (fMachineState == kIOPM_NotifyChildrenDelayed) { + PM_LOG2("%s: delay notify cancelled\n", getName()); + notifyChildrenDelayed(); + } + break; + + default: + panic("PMReplyQueue: unknown reply type %x", request->getType()); } - more |= gIOPMFreeQueue->queuePMRequest(request); - if (more) - gIOPMWorkQueue->incrementProducerCount(); + more |= gIOPMCompletionQueue->queuePMRequest(request); + if (more) { + gIOPMWorkQueue->incrementProducerCount(); + } return more; } @@ -6948,149 +8037,197 @@ bool IOService::servicePMReplyQueue( IOPMRequest * request, IOPMRequestQueue * q // [private] assertPMDriverCall / deassertPMDriverCall //********************************************************************************* -bool IOService::assertPMDriverCall( - IOPMDriverCallEntry * entry, - IOOptionBits options, - IOPMinformee * inform ) -{ - IOService * target = 0; - bool ok = false; - - if (!initialized) - return false; - - PM_LOCK(); - - if (fLockedFlags.PMStop) - { - goto fail; - } - - if (((options & kIOPMADC_NoInactiveCheck) == 0) && isInactive()) - { - goto fail; - } - - if (inform) - { - if (!inform->active) - { - goto fail; - } - target = inform->whatObject; - if (target->isInactive()) - { - goto fail; - } - } - - entry->thread = current_thread(); - entry->target = target; - queue_enter(&fPMDriverCallQueue, entry, IOPMDriverCallEntry *, link); - ok = true; +bool +IOService::assertPMDriverCall( + IOPMDriverCallEntry * entry, + IOOptionBits method, + const IOPMinformee * inform, + IOOptionBits options ) +{ + IOService * target = NULL; + bool ok = false; + + if (!initialized) { + return false; + } + + PM_LOCK(); + + if (fLockedFlags.PMStop) { + goto fail; + } + + if (((options & kIOPMDriverCallNoInactiveCheck) == 0) && isInactive()) { + goto fail; + } + + if (inform) { + if (!inform->active) { + goto fail; + } + target = inform->whatObject; + if (target->isInactive()) { + goto fail; + } + } + + // Record calling address for sleep failure diagnostics + switch (method) { + case kIOPMDriverCallMethodSetPowerState: + entry->callMethod = OSMemberFunctionCast(const void *, fControllingDriver, &IOService::setPowerState); + break; + case kIOPMDriverCallMethodWillChange: + entry->callMethod = OSMemberFunctionCast(const void *, target, &IOService::powerStateWillChangeTo); + break; + case kIOPMDriverCallMethodDidChange: + entry->callMethod = OSMemberFunctionCast(const void *, target, &IOService::powerStateDidChangeTo); + break; + case kIOPMDriverCallMethodUnknown: + case kIOPMDriverCallMethodSetAggressive: + default: + entry->callMethod = NULL; + break; + } + + entry->thread = current_thread(); + entry->target = target; + queue_enter(&fPMDriverCallQueue, entry, IOPMDriverCallEntry *, link); + ok = true; fail: - PM_UNLOCK(); - - return ok; -} - -void IOService::deassertPMDriverCall( IOPMDriverCallEntry * entry ) -{ - bool wakeup = false; - - PM_LOCK(); - - assert( !queue_empty(&fPMDriverCallQueue) ); - queue_remove(&fPMDriverCallQueue, entry, IOPMDriverCallEntry *, link); - if (fLockedFlags.PMDriverCallWait) - { - wakeup = true; - } - - PM_UNLOCK(); - - if (wakeup) - PM_LOCK_WAKEUP(&fPMDriverCallQueue); -} - -void IOService::waitForPMDriverCall( IOService * target ) -{ - const IOPMDriverCallEntry * entry; - thread_t thread = current_thread(); - AbsoluteTime deadline; - int waitResult; - bool log = true; - bool wait; - - do { - wait = false; - queue_iterate(&fPMDriverCallQueue, entry, const IOPMDriverCallEntry *, link) - { - // Target of interested driver call - if (target && (target != entry->target)) - continue; - - if (entry->thread == thread) - { - if (log) - { - PM_LOG("%s: %s(%s) on PM thread\n", - fName, __FUNCTION__, target ? target->getName() : ""); - OSReportWithBacktrace("%s: %s(%s) on PM thread\n", - fName, __FUNCTION__, target ? target->getName() : ""); - log = false; - } - continue; - } - - wait = true; - break; - } - - if (wait) - { - fLockedFlags.PMDriverCallWait = true; - clock_interval_to_deadline(15, kSecondScale, &deadline); - waitResult = PM_LOCK_SLEEP(&fPMDriverCallQueue, deadline); - fLockedFlags.PMDriverCallWait = false; - if (THREAD_TIMED_OUT == waitResult) - { - PM_ERROR("%s: waitForPMDriverCall timeout\n", fName); - wait = false; - } - } - } while (wait); + PM_UNLOCK(); + + return ok; +} + +void +IOService::deassertPMDriverCall( IOPMDriverCallEntry * entry ) +{ + bool wakeup = false; + + PM_LOCK(); + + assert( !queue_empty(&fPMDriverCallQueue)); + queue_remove(&fPMDriverCallQueue, entry, IOPMDriverCallEntry *, link); + if (fLockedFlags.PMDriverCallWait) { + wakeup = true; + } + + PM_UNLOCK(); + + if (wakeup) { + PM_LOCK_WAKEUP(&fPMDriverCallQueue); + } +} + +bool +IOService::getBlockingDriverCall(thread_t *thread, const void **callMethod) +{ + const IOPMDriverCallEntry * entry = NULL; + bool blocked = false; + + if (!initialized) { + return false; + } + + if (current_thread() != gIOPMWatchDogThread) { + // Meant to be accessed only from watchdog thread + return false; + } + + PM_LOCK(); + entry = qe_queue_first(&fPMDriverCallQueue, IOPMDriverCallEntry, link); + if (entry) { + *thread = entry->thread; + *callMethod = entry->callMethod; + blocked = true; + } + PM_UNLOCK(); + + return blocked; +} + + +void +IOService::waitForPMDriverCall( IOService * target ) +{ + const IOPMDriverCallEntry * entry; + thread_t thread = current_thread(); + AbsoluteTime deadline; + int waitResult; + bool log = true; + bool wait; + + do { + wait = false; + queue_iterate(&fPMDriverCallQueue, entry, const IOPMDriverCallEntry *, link) + { + // Target of interested driver call + if (target && (target != entry->target)) { + continue; + } + + if (entry->thread == thread) { + if (log) { + PM_LOG("%s: %s(%s) on PM thread\n", + fName, __FUNCTION__, target ? target->getName() : ""); + OSReportWithBacktrace("%s: %s(%s) on PM thread\n", + fName, __FUNCTION__, target ? target->getName() : ""); + log = false; + } + continue; + } + + wait = true; + break; + } + + if (wait) { + fLockedFlags.PMDriverCallWait = true; + clock_interval_to_deadline(15, kSecondScale, &deadline); + waitResult = PM_LOCK_SLEEP(&fPMDriverCallQueue, deadline); + fLockedFlags.PMDriverCallWait = false; + if (THREAD_TIMED_OUT == waitResult) { + PM_ERROR("%s: waitForPMDriverCall timeout\n", fName); + wait = false; + } + } + } while (wait); } //********************************************************************************* // [private] Debug helpers //********************************************************************************* -const char * IOService::getIOMessageString( uint32_t msg ) +const char * +IOService::getIOMessageString( uint32_t msg ) { -#define MSG_ENTRY(x) {x, #x} +#define MSG_ENTRY(x) {(int) x, #x} - static const IONamedValue msgNames[] = { - MSG_ENTRY( kIOMessageCanDevicePowerOff ), - MSG_ENTRY( kIOMessageDeviceWillPowerOff ), - MSG_ENTRY( kIOMessageDeviceWillNotPowerOff ), - MSG_ENTRY( kIOMessageDeviceHasPoweredOn ), - MSG_ENTRY( kIOMessageCanSystemPowerOff ), - MSG_ENTRY( kIOMessageSystemWillPowerOff ), - MSG_ENTRY( kIOMessageSystemWillNotPowerOff ), - MSG_ENTRY( kIOMessageCanSystemSleep ), - MSG_ENTRY( kIOMessageSystemWillSleep ), - MSG_ENTRY( kIOMessageSystemWillNotSleep ), - MSG_ENTRY( kIOMessageSystemHasPoweredOn ), - MSG_ENTRY( kIOMessageSystemWillRestart ), - MSG_ENTRY( kIOMessageSystemWillPowerOn ), - MSG_ENTRY( kIOMessageSystemCapabilityChange ) - }; + static const IONamedValue msgNames[] = { + MSG_ENTRY( kIOMessageCanDevicePowerOff ), + MSG_ENTRY( kIOMessageDeviceWillPowerOff ), + MSG_ENTRY( kIOMessageDeviceWillNotPowerOff ), + MSG_ENTRY( kIOMessageDeviceHasPoweredOn ), + MSG_ENTRY( kIOMessageCanSystemPowerOff ), + MSG_ENTRY( kIOMessageSystemWillPowerOff ), + MSG_ENTRY( kIOMessageSystemWillNotPowerOff ), + MSG_ENTRY( kIOMessageCanSystemSleep ), + MSG_ENTRY( kIOMessageSystemWillSleep ), + MSG_ENTRY( kIOMessageSystemWillNotSleep ), + MSG_ENTRY( kIOMessageSystemHasPoweredOn ), + MSG_ENTRY( kIOMessageSystemWillRestart ), + MSG_ENTRY( kIOMessageSystemWillPowerOn ), + MSG_ENTRY( kIOMessageSystemCapabilityChange ), + MSG_ENTRY( kIOPMMessageLastCallBeforeSleep ), + MSG_ENTRY( kIOMessageSystemPagingOff ), + { 0, NULL } + }; - return IOFindNameForValue(msg, msgNames); + return IOFindNameForValue(msg, msgNames); } + // MARK: - // MARK: IOPMRequest @@ -7102,140 +8239,151 @@ const char * IOService::getIOMessageString( uint32_t msg ) OSDefineMetaClassAndStructors( IOPMRequest, IOCommand ); -IOPMRequest * IOPMRequest::create( void ) +IOPMRequest * +IOPMRequest::create( void ) { IOPMRequest * me = OSTypeAlloc(IOPMRequest); - if (me && !me->init(0, kIOPMRequestTypeInvalid)) - { + if (me && !me->init(NULL, kIOPMRequestTypeInvalid)) { me->release(); - me = 0; + me = NULL; } return me; } -bool IOPMRequest::init( IOService * target, IOOptionBits type ) +bool +IOPMRequest::init( IOService * target, IOOptionBits type ) { - if (!IOCommand::init()) + if (!IOCommand::init()) { return false; + } - fType = type; - fTarget = target; - fCompletionStatus = kIOReturnSuccess; + fRequestType = type; + fTarget = target; - if (fTarget) + if (fTarget) { fTarget->retain(); + } + + // Root node and root domain requests does not prevent the power tree from + // becoming quiescent. + + fIsQuiesceBlocker = ((fTarget != gIOPMRootNode) && + (fTarget != IOService::getPMRootDomain())); return true; } -void IOPMRequest::reset( void ) +void +IOPMRequest::reset( void ) { assert( fWorkWaitCount == 0 ); assert( fFreeWaitCount == 0 ); detachNextRequest(); - detachRootRequest(); + detachRootRequest(); - fType = kIOPMRequestTypeInvalid; + if (fCompletionAction && (fRequestType == kIOPMRequestTypeQuiescePowerTree)) { + // Call the completion on PM work loop context + fCompletionAction(fCompletionTarget, fCompletionParam); + fCompletionAction = NULL; + } - if (fCompletionAction) - { - fCompletionAction(fCompletionTarget, fCompletionParam, fCompletionStatus); - } + fRequestType = kIOPMRequestTypeInvalid; - if (fTarget) - { + if (fTarget) { fTarget->release(); - fTarget = 0; - } + fTarget = NULL; + } } -bool IOPMRequest::attachNextRequest( IOPMRequest * next ) +bool +IOPMRequest::attachNextRequest( IOPMRequest * next ) { - bool ok = false; + bool ok = false; - if (!fRequestNext) - { - // Postpone the execution of the next request after - // this request. - fRequestNext = next; - fRequestNext->fWorkWaitCount++; + if (!fRequestNext) { + // Postpone the execution of the next request after + // this request. + fRequestNext = next; + fRequestNext->fWorkWaitCount++; #if LOG_REQUEST_ATTACH - kprintf("Attached next: %p [0x%x] -> %p [0x%x, %u] %s\n", - this, (uint32_t) fType, fRequestNext, - (uint32_t) fRequestNext->fType, - (uint32_t) fRequestNext->fWorkWaitCount, - fTarget->getName()); + PM_LOG("Attached next: %p [0x%x] -> %p [0x%x, %u] %s\n", + OBFUSCATE(this), fRequestType, OBFUSCATE(fRequestNext), + fRequestNext->fRequestType, + (uint32_t) fRequestNext->fWorkWaitCount, + fTarget->getName()); #endif - ok = true; - } - return ok; + ok = true; + } + return ok; } -bool IOPMRequest::detachNextRequest( void ) +bool +IOPMRequest::detachNextRequest( void ) { - bool ok = false; + bool ok = false; - if (fRequestNext) - { - assert(fRequestNext->fWorkWaitCount); - if (fRequestNext->fWorkWaitCount) - fRequestNext->fWorkWaitCount--; + if (fRequestNext) { + assert(fRequestNext->fWorkWaitCount); + if (fRequestNext->fWorkWaitCount) { + fRequestNext->fWorkWaitCount--; + } #if LOG_REQUEST_ATTACH - kprintf("Detached next: %p [0x%x] -> %p [0x%x, %u] %s\n", - this, (uint32_t) fType, fRequestNext, - (uint32_t) fRequestNext->fType, - (uint32_t) fRequestNext->fWorkWaitCount, - fTarget->getName()); + PM_LOG("Detached next: %p [0x%x] -> %p [0x%x, %u] %s\n", + OBFUSCATE(this), fRequestType, OBFUSCATE(fRequestNext), + fRequestNext->fRequestType, + (uint32_t) fRequestNext->fWorkWaitCount, + fTarget->getName()); #endif - fRequestNext = 0; - ok = true; - } - return ok; + fRequestNext = NULL; + ok = true; + } + return ok; } -bool IOPMRequest::attachRootRequest( IOPMRequest * root ) +bool +IOPMRequest::attachRootRequest( IOPMRequest * root ) { - bool ok = false; + bool ok = false; - if (!fRequestRoot) - { - // Delay the completion of the root request after - // this request. - fRequestRoot = root; - fRequestRoot->fFreeWaitCount++; + if (!fRequestRoot) { + // Delay the completion of the root request after + // this request. + fRequestRoot = root; + fRequestRoot->fFreeWaitCount++; #if LOG_REQUEST_ATTACH - kprintf("Attached root: %p [0x%x] -> %p [0x%x, %u] %s\n", - this, (uint32_t) fType, fRequestRoot, - (uint32_t) fRequestRoot->fType, - (uint32_t) fRequestRoot->fFreeWaitCount, - fTarget->getName()); + PM_LOG("Attached root: %p [0x%x] -> %p [0x%x, %u] %s\n", + OBFUSCATE(this), (uint32_t) fType, OBFUSCATE(fRequestRoot), + (uint32_t) fRequestRoot->fType, + (uint32_t) fRequestRoot->fFreeWaitCount, + fTarget->getName()); #endif - ok = true; - } - return ok; + ok = true; + } + return ok; } -bool IOPMRequest::detachRootRequest( void ) +bool +IOPMRequest::detachRootRequest( void ) { - bool ok = false; + bool ok = false; - if (fRequestRoot) - { - assert(fRequestRoot->fFreeWaitCount); - if (fRequestRoot->fFreeWaitCount) - fRequestRoot->fFreeWaitCount--; + if (fRequestRoot) { + assert(fRequestRoot->fFreeWaitCount); + if (fRequestRoot->fFreeWaitCount) { + fRequestRoot->fFreeWaitCount--; + } #if LOG_REQUEST_ATTACH - kprintf("Detached root: %p [0x%x] -> %p [0x%x, %u] %s\n", - this, (uint32_t) fType, fRequestRoot, - (uint32_t) fRequestRoot->fType, - (uint32_t) fRequestRoot->fFreeWaitCount, - fTarget->getName()); + PM_LOG("Detached root: %p [0x%x] -> %p [0x%x, %u] %s\n", + OBFUSCATE(this), (uint32_t) fType, OBFUSCATE(fRequestRoot), + (uint32_t) fRequestRoot->fType, + (uint32_t) fRequestRoot->fFreeWaitCount, + fTarget->getName()); #endif - fRequestRoot = 0; - ok = true; - } - return ok; + fRequestRoot = NULL; + ok = true; + } + return ok; } // MARK: - @@ -7249,44 +8397,49 @@ bool IOPMRequest::detachRootRequest( void ) OSDefineMetaClassAndStructors( IOPMRequestQueue, IOEventSource ); -IOPMRequestQueue * IOPMRequestQueue::create( IOService * inOwner, Action inAction ) +IOPMRequestQueue * +IOPMRequestQueue::create( IOService * inOwner, Action inAction ) { IOPMRequestQueue * me = OSTypeAlloc(IOPMRequestQueue); - if (me && !me->init(inOwner, inAction)) - { + if (me && !me->init(inOwner, inAction)) { me->release(); - me = 0; + me = NULL; } return me; } -bool IOPMRequestQueue::init( IOService * inOwner, Action inAction ) +bool +IOPMRequestQueue::init( IOService * inOwner, Action inAction ) { - if (!inAction || !IOEventSource::init(inOwner, (IOEventSourceAction)inAction)) - return false; + if (!inAction || !IOEventSource::init(inOwner, (IOEventSourceAction)inAction)) { + return false; + } queue_init(&fQueue); fLock = IOLockAlloc(); - return (fLock != 0); + return fLock != NULL; } -void IOPMRequestQueue::free( void ) +void +IOPMRequestQueue::free( void ) { - if (fLock) - { + if (fLock) { IOLockFree(fLock); - fLock = 0; + fLock = NULL; } return IOEventSource::free(); } -void IOPMRequestQueue::queuePMRequest( IOPMRequest * request ) +void +IOPMRequestQueue::queuePMRequest( IOPMRequest * request ) { assert(request); IOLockLock(fLock); - queue_enter(&fQueue, request, IOPMRequest *, fCommandChain); + queue_enter(&fQueue, request, typeof(request), fCommandChain); IOLockUnlock(fLock); - if (workLoop) signalWorkAvailable(); + if (workLoop) { + signalWorkAvailable(); + } } void @@ -7296,29 +8449,37 @@ IOPMRequestQueue::queuePMRequestChain( IOPMRequest ** requests, IOItemCount coun assert(requests && count); IOLockLock(fLock); - while (count--) - { + while (count--) { next = *requests; requests++; - queue_enter(&fQueue, next, IOPMRequest *, fCommandChain); + queue_enter(&fQueue, next, typeof(next), fCommandChain); } IOLockUnlock(fLock); - if (workLoop) signalWorkAvailable(); + if (workLoop) { + signalWorkAvailable(); + } } -bool IOPMRequestQueue::checkForWork( void ) +bool +IOPMRequestQueue::checkForWork( void ) { - Action dqAction = (Action) action; - IOPMRequest * request; - IOService * target; - bool more = false; + Action dqAction = (Action) action; + IOPMRequest * request; + IOService * target; + int dequeueCount = 0; + bool more = false; IOLockLock( fLock ); - while (!queue_empty(&fQueue)) - { - queue_remove_first( &fQueue, request, IOPMRequest *, fCommandChain ); - IOLockUnlock( fLock ); + while (!queue_empty(&fQueue)) { + if (dequeueCount++ >= kMaxDequeueCount) { + // Allow other queues a chance to work + more = true; + break; + } + + queue_remove_first(&fQueue, request, typeof(request), fCommandChain); + IOLockUnlock(fLock); target = request->getTarget(); assert(target); more |= (*dqAction)( target, request, this ); @@ -7335,185 +8496,248 @@ bool IOPMRequestQueue::checkForWork( void ) //********************************************************************************* // IOPMWorkQueue Class // -// Queue of IOServicePM objects with busy IOPMRequest(s). +// Queue of IOServicePM objects, each with a queue of IOPMRequest sharing the +// same target. //********************************************************************************* OSDefineMetaClassAndStructors( IOPMWorkQueue, IOEventSource ); IOPMWorkQueue * -IOPMWorkQueue::create( IOService * inOwner, Action work, Action retire ) +IOPMWorkQueue::create( IOService * inOwner, Action invoke, Action retire ) { IOPMWorkQueue * me = OSTypeAlloc(IOPMWorkQueue); - if (me && !me->init(inOwner, work, retire)) - { + if (me && !me->init(inOwner, invoke, retire)) { me->release(); - me = 0; + me = NULL; } return me; } -bool IOPMWorkQueue::init( IOService * inOwner, Action work, Action retire ) +bool +IOPMWorkQueue::init( IOService * inOwner, Action invoke, Action retire ) { - if (!work || !retire || - !IOEventSource::init(inOwner, (IOEventSourceAction)0)) + if (!invoke || !retire || + !IOEventSource::init(inOwner, (IOEventSourceAction)NULL)) { return false; + } queue_init(&fWorkQueue); - fWorkAction = work; + fInvokeAction = invoke; fRetireAction = retire; - fConsumerCount = fProducerCount = 0; + fConsumerCount = fProducerCount = 0; return true; } -bool IOPMWorkQueue::queuePMRequest( IOPMRequest * request, IOServicePM * pwrMgt ) +bool +IOPMWorkQueue::queuePMRequest( IOPMRequest * request, IOServicePM * pwrMgt ) { - bool more = false; - bool empty; + queue_head_t * requestQueue; + bool more = false; + bool empty; assert( request ); - assert( pwrMgt ); - assert( onThread() ); - assert( queue_next(&request->fCommandChain) == - queue_prev(&request->fCommandChain) ); - - gIOPMBusyCount++; - - // Add new request to the tail of the per-service request queue. - // Then immediately check the request queue to minimize latency - // if the queue was empty. - - empty = queue_empty(&pwrMgt->RequestHead); - queue_enter(&pwrMgt->RequestHead, request, IOPMRequest *, fCommandChain); - if (empty) - { - more = checkRequestQueue(&pwrMgt->RequestHead, &empty); - if (!empty) - { - // New Request is blocked, add IOServicePM to work queue. - assert( queue_next(&pwrMgt->WorkChain) == - queue_prev(&pwrMgt->WorkChain) ); - - queue_enter(&fWorkQueue, pwrMgt, IOServicePM *, WorkChain); - fQueueLength++; - PM_LOG3("IOPMWorkQueue: [%u] added %s@%p to queue\n", - fQueueLength, pwrMgt->Name, pwrMgt); - } - } - - return more; -} - -bool IOPMWorkQueue::checkRequestQueue( queue_head_t * queue, bool * empty ) -{ - IOPMRequest * request; - IOService * target; - bool more = false; - bool done = false; - - assert(!queue_empty(queue)); - do { - request = (IOPMRequest *) queue_first(queue); - if (request->isWorkBlocked()) - break; // cannot start, blocked on attached request + assert( pwrMgt ); + assert( onThread()); + assert( queue_next(&request->fCommandChain) == + queue_prev(&request->fCommandChain)); + + gIOPMBusyRequestCount++; + + if (request->isQuiesceType()) { + if ((request->getTarget() == gIOPMRootNode) && !fQuiesceStartTime) { + // Attach new quiesce request to all quiesce blockers in the queue + fQuiesceStartTime = mach_absolute_time(); + attachQuiesceRequest(request); + fQuiesceRequest = request; + } + } else if (fQuiesceRequest && request->isQuiesceBlocker()) { + // Attach the new quiesce blocker to the blocked quiesce request + request->attachNextRequest(fQuiesceRequest); + } + // Add new request to the tail of the per-service request queue. + // Then immediately check the request queue to minimize latency + // if the queue was empty. + + requestQueue = &pwrMgt->RequestHead; + empty = queue_empty(requestQueue); + queue_enter(requestQueue, request, typeof(request), fCommandChain); + if (empty) { + more = checkRequestQueue(requestQueue, &empty); + if (!empty) { + // Request just added is blocked, add its target IOServicePM + // to the work queue. + assert( queue_next(&pwrMgt->WorkChain) == + queue_prev(&pwrMgt->WorkChain)); + + queue_enter(&fWorkQueue, pwrMgt, typeof(pwrMgt), WorkChain); + fQueueLength++; + PM_LOG3("IOPMWorkQueue: [%u] added %s@%p to queue\n", + fQueueLength, pwrMgt->Name, OBFUSCATE(pwrMgt)); + } + } + + return more; +} + +bool +IOPMWorkQueue::checkRequestQueue( queue_head_t * requestQueue, bool * empty ) +{ + IOPMRequest * request; + IOService * target; + bool more = false; + bool done = false; + + assert(!queue_empty(requestQueue)); + do { + request = (typeof(request))queue_first(requestQueue); + if (request->isWorkBlocked()) { + break; // request dispatch blocked on attached request + } target = request->getTarget(); - done = (*fWorkAction)( target, request, this ); - if (!done) - break; // work started, blocked on PM state machine + if (fInvokeAction) { + done = (*fInvokeAction)( target, request, this ); + } else { + PM_LOG("PM request 0x%x dropped\n", request->getType()); + done = true; + } + if (!done) { + break; // PM state machine blocked + } + assert(gIOPMBusyRequestCount > 0); + if (gIOPMBusyRequestCount) { + gIOPMBusyRequestCount--; + } - assert(gIOPMBusyCount > 0); - if (gIOPMBusyCount) - gIOPMBusyCount--; + if (request == fQuiesceRequest) { + fQuiesceRequest = NULL; + } - queue_remove_first(queue, request, IOPMRequest *, fCommandChain); - more |= (*fRetireAction)( target, request, this ); - done = queue_empty(queue); - } while (!done); + queue_remove_first(requestQueue, request, typeof(request), fCommandChain); + more |= (*fRetireAction)( target, request, this ); + done = queue_empty(requestQueue); + } while (!done); - *empty = done; + *empty = done; - if (more) - { - // Retired request blocks another request, since the - // blocked request may reside in the work queue, we - // must bump the producer count to avoid work stall. - fProducerCount++; - } + if (more) { + // Retired a request that may unblock a previously visited request + // that is still waiting on the work queue. Must trigger another + // queue check. + fProducerCount++; + } - return more; + return more; } -bool IOPMWorkQueue::checkForWork( void ) +bool +IOPMWorkQueue::checkForWork( void ) { IOServicePM * entry; IOServicePM * next; - bool more = false; - bool empty; + bool more = false; + bool empty; #if WORK_QUEUE_STATS - fStatCheckForWork++; + fStatCheckForWork++; #endif - // Each producer signal triggers a full iteration over - // all IOServicePM entries in the work queue. + // Iterate over all IOServicePM entries in the work queue, + // and check each entry's request queue. - while (fConsumerCount != fProducerCount) - { - PM_LOG3("IOPMWorkQueue: checkForWork %u %u\n", - fProducerCount, fConsumerCount); + while (fConsumerCount != fProducerCount) { + PM_LOG3("IOPMWorkQueue: checkForWork %u %u\n", + fProducerCount, fConsumerCount); - fConsumerCount = fProducerCount; + fConsumerCount = fProducerCount; -#if WORK_QUEUE_STATS - if (queue_empty(&fWorkQueue)) - { - fStatQueueEmpty++; - break; - } - fStatScanEntries++; - uint32_t cachedWorkCount = gIOPMWorkCount; +#if WORK_QUEUE_STATS + if (queue_empty(&fWorkQueue)) { + fStatQueueEmpty++; + break; + } + fStatScanEntries++; + uint32_t cachedWorkCount = gIOPMWorkInvokeCount; #endif - entry = (IOServicePM *) queue_first(&fWorkQueue); - while (!queue_end(&fWorkQueue, (queue_entry_t) entry)) - { - more |= checkRequestQueue(&entry->RequestHead, &empty); - - // Get next entry, points to head if current entry is last. - next = (IOServicePM *) queue_next(&entry->WorkChain); - - // if request queue is empty, remove IOServicePM from queue. - if (empty) - { - assert(fQueueLength); - if (fQueueLength) fQueueLength--; - PM_LOG3("IOPMWorkQueue: [%u] removed %s@%p from queue\n", - fQueueLength, entry->Name, entry); - queue_remove(&fWorkQueue, entry, IOServicePM *, WorkChain); - } - entry = next; - } + __IGNORE_WCASTALIGN(entry = (typeof(entry))queue_first(&fWorkQueue)); + while (!queue_end(&fWorkQueue, (queue_entry_t) entry)) { + more |= checkRequestQueue(&entry->RequestHead, &empty); + + // Get next entry, points to head if current entry is last. + __IGNORE_WCASTALIGN(next = (typeof(next))queue_next(&entry->WorkChain)); + + // if request queue is empty, remove IOServicePM from work queue. + if (empty) { + assert(fQueueLength); + if (fQueueLength) { + fQueueLength--; + } + PM_LOG3("IOPMWorkQueue: [%u] removed %s@%p from queue\n", + fQueueLength, entry->Name, OBFUSCATE(entry)); + queue_remove(&fWorkQueue, entry, typeof(entry), WorkChain); + } + entry = next; + } #if WORK_QUEUE_STATS - if (cachedWorkCount == gIOPMWorkCount) - fStatNoWorkDone++; + if (cachedWorkCount == gIOPMWorkInvokeCount) { + fStatNoWorkDone++; + } #endif - } + } - return more; + return more; } -void IOPMWorkQueue::signalWorkAvailable( void ) +void +IOPMWorkQueue::signalWorkAvailable( void ) { - fProducerCount++; + fProducerCount++; IOEventSource::signalWorkAvailable(); } -void IOPMWorkQueue::incrementProducerCount( void ) +void +IOPMWorkQueue::incrementProducerCount( void ) +{ + fProducerCount++; +} + +void +IOPMWorkQueue::attachQuiesceRequest( IOPMRequest * quiesceRequest ) +{ + IOServicePM * entry; + IOPMRequest * request; + + if (queue_empty(&fWorkQueue)) { + return; + } + + queue_iterate(&fWorkQueue, entry, typeof(entry), WorkChain) + { + queue_iterate(&entry->RequestHead, request, typeof(request), fCommandChain) + { + // Attach the quiesce request to any request in the queue that + // is not linked to a next request. These requests will block + // the quiesce request. + + if (request->isQuiesceBlocker()) { + request->attachNextRequest(quiesceRequest); + } + } + } +} + +void +IOPMWorkQueue::finishQuiesceRequest( IOPMRequest * quiesceRequest ) { - fProducerCount++; + if (fQuiesceRequest && (quiesceRequest == fQuiesceRequest) && + (fQuiesceStartTime != 0)) { + fInvokeAction = NULL; + fQuiesceFinishTime = mach_absolute_time(); + } } // MARK: - @@ -7529,57 +8753,58 @@ IOPMCompletionQueue * IOPMCompletionQueue::create( IOService * inOwner, Action inAction ) { IOPMCompletionQueue * me = OSTypeAlloc(IOPMCompletionQueue); - if (me && !me->init(inOwner, inAction)) - { + if (me && !me->init(inOwner, inAction)) { me->release(); - me = 0; + me = NULL; } return me; } -bool IOPMCompletionQueue::init( IOService * inOwner, Action inAction ) +bool +IOPMCompletionQueue::init( IOService * inOwner, Action inAction ) { - if (!inAction || !IOEventSource::init(inOwner, (IOEventSourceAction)inAction)) - return false; + if (!inAction || !IOEventSource::init(inOwner, (IOEventSourceAction)inAction)) { + return false; + } queue_init(&fQueue); return true; } -bool IOPMCompletionQueue::queuePMRequest( IOPMRequest * request ) +bool +IOPMCompletionQueue::queuePMRequest( IOPMRequest * request ) { - bool more; + bool more; assert(request); - // unblock dependent request - more = request->detachNextRequest(); - queue_enter(&fQueue, request, IOPMRequest *, fCommandChain); - return more; + // unblock dependent request + more = request->detachNextRequest(); + queue_enter(&fQueue, request, typeof(request), fCommandChain); + return more; } -bool IOPMCompletionQueue::checkForWork( void ) +bool +IOPMCompletionQueue::checkForWork( void ) { - Action dqAction = (Action) action; - IOPMRequest * request; + Action dqAction = (Action) action; + IOPMRequest * request; IOPMRequest * next; - IOService * target; - bool more = false; - - request = (IOPMRequest *) queue_first(&fQueue); - while (!queue_end(&fQueue, (queue_entry_t) request)) - { - next = (IOPMRequest *) queue_next(&request->fCommandChain); - if (!request->isFreeBlocked()) - { - queue_remove(&fQueue, request, IOPMRequest *, fCommandChain); - target = request->getTarget(); - assert(target); - more |= (*dqAction)( target, request, this ); - } - request = next; - } - - return more; + IOService * target; + bool more = false; + + request = (typeof(request))queue_first(&fQueue); + while (!queue_end(&fQueue, (queue_entry_t) request)) { + next = (typeof(next))queue_next(&request->fCommandChain); + if (!request->isFreeBlocked()) { + queue_remove(&fQueue, request, typeof(request), fCommandChain); + target = request->getTarget(); + assert(target); + more |= (*dqAction)( target, request, this ); + } + request = next; + } + + return more; } // MARK: - @@ -7596,160 +8821,163 @@ OSDefineMetaClassAndStructors(IOServicePM, OSObject) static void setPMProperty( OSDictionary * dict, const char * key, uint64_t value ) { - OSNumber * num = OSNumber::withNumber(value, sizeof(value) * 8); - if (num) - { - dict->setObject(key, num); - num->release(); - } + OSNumber * num = OSNumber::withNumber(value, sizeof(value) * 8); + if (num) { + dict->setObject(key, num); + num->release(); + } } -IOReturn IOServicePM::gatedSerialize( OSSerialize * s ) +IOReturn +IOServicePM::gatedSerialize( OSSerialize * s ) const { - OSDictionary * dict; - bool ok = false; - int dictSize = 5; + OSDictionary * dict; + bool ok = false; + int powerClamp = -1; + int dictSize = 6; - if (IdleTimerPeriod) + if (IdleTimerPeriod) { dictSize += 4; + } + + if (PMActions.parameter & kPMActionsFlagLimitPower) { + dictSize += 1; + powerClamp = 0; + if (PMActions.parameter & + (kPMActionsFlagIsDisplayWrangler | kPMActionsFlagIsGraphicsDevice)) { + powerClamp++; + } + } #if WORK_QUEUE_STATS - if (gIOPMRootNode == ControllingDriver) - dictSize += 4; + if (gIOPMRootNode == ControllingDriver) { + dictSize += 4; + } #endif - if (PowerClients) - dict = OSDictionary::withDictionary( - PowerClients, PowerClients->getCount() + dictSize); - else - dict = OSDictionary::withCapacity(dictSize); + if (PowerClients) { + dict = OSDictionary::withDictionary( + PowerClients, PowerClients->getCount() + dictSize); + } else { + dict = OSDictionary::withCapacity(dictSize); + } - if (dict) - { - setPMProperty(dict, "CurrentPowerState", CurrentPowerState); - if (NumberOfPowerStates) - setPMProperty(dict, "MaxPowerState", NumberOfPowerStates-1); - if (DesiredPowerState != CurrentPowerState) - setPMProperty(dict, "DesiredPowerState", DesiredPowerState); - if (kIOPM_Finished != MachineState) - setPMProperty(dict, "MachineState", MachineState); - if (DeviceOverrideEnabled) - dict->setObject("PowerOverrideOn", kOSBooleanTrue); - - if (IdleTimerPeriod) - { - AbsoluteTime now; - AbsoluteTime delta; - uint64_t nsecs; + if (dict) { + setPMProperty(dict, "CurrentPowerState", CurrentPowerState); + setPMProperty(dict, "CapabilityFlags", CurrentCapabilityFlags); + if (NumberOfPowerStates) { + setPMProperty(dict, "MaxPowerState", NumberOfPowerStates - 1); + } + if (DesiredPowerState != CurrentPowerState) { + setPMProperty(dict, "DesiredPowerState", DesiredPowerState); + } + if (kIOPM_Finished != MachineState) { + setPMProperty(dict, "MachineState", MachineState); + } + if (DeviceOverrideEnabled) { + dict->setObject("PowerOverrideOn", kOSBooleanTrue); + } + if (powerClamp >= 0) { + setPMProperty(dict, "PowerClamp", powerClamp); + } + + if (IdleTimerPeriod) { + AbsoluteTime now; + AbsoluteTime delta; + uint64_t nsecs; - clock_get_uptime(&now); + clock_get_uptime(&now); - // The idle timer period in milliseconds. - setPMProperty(dict, "IdleTimerPeriod", IdleTimerPeriod * 1000ULL); + // The idle timer period in milliseconds + setPMProperty(dict, "IdleTimerPeriod", NextIdleTimerPeriod * 1000ULL); - // The number of activity tickles recorded since device idle - setPMProperty(dict, "ActivityTickles", ActivityTickleCount); + // Number of tickles since the last idle timer expiration + setPMProperty(dict, "ActivityTickles", ActivityTickleCount); - if (AbsoluteTime_to_scalar(&DeviceActiveTimestamp)) - { - // The number of milliseconds since the last activity tickle. - delta = now; - SUB_ABSOLUTETIME(&delta, &DeviceActiveTimestamp); - absolutetime_to_nanoseconds(delta, &nsecs); - setPMProperty(dict, "TimeSinceLastTickle", NS_TO_MS(nsecs)); - } + if (AbsoluteTime_to_scalar(&DeviceActiveTimestamp)) { + // Milliseconds since the last activity tickle + delta = now; + SUB_ABSOLUTETIME(&delta, &DeviceActiveTimestamp); + absolutetime_to_nanoseconds(delta, &nsecs); + setPMProperty(dict, "TimeSinceLastTickle", NS_TO_MS(nsecs)); + } - if (AbsoluteTime_to_scalar(&IdleTimerStartTime)) - { - // The number of milliseconds since the last device idle. - delta = now; - SUB_ABSOLUTETIME(&delta, &IdleTimerStartTime); - absolutetime_to_nanoseconds(delta, &nsecs); - setPMProperty(dict, "TimeSinceDeviceIdle", NS_TO_MS(nsecs)); - } + if (!IdleTimerStopped && AbsoluteTime_to_scalar(&IdleTimerStartTime)) { + // Idle timer elapsed time in milliseconds + delta = now; + SUB_ABSOLUTETIME(&delta, &IdleTimerStartTime); + absolutetime_to_nanoseconds(delta, &nsecs); + setPMProperty(dict, "IdleTimerElapsedTime", NS_TO_MS(nsecs)); + } } #if WORK_QUEUE_STATS - if (gIOPMRootNode == Owner) - { - setPMProperty(dict, "WQ-CheckForWork", - gIOPMWorkQueue->fStatCheckForWork); - setPMProperty(dict, "WQ-ScanEntries", - gIOPMWorkQueue->fStatScanEntries); - setPMProperty(dict, "WQ-QueueEmpty", - gIOPMWorkQueue->fStatQueueEmpty); - setPMProperty(dict, "WQ-NoWorkDone", - gIOPMWorkQueue->fStatNoWorkDone); - } + if (gIOPMRootNode == Owner) { + setPMProperty(dict, "WQ-CheckForWork", + gIOPMWorkQueue->fStatCheckForWork); + setPMProperty(dict, "WQ-ScanEntries", + gIOPMWorkQueue->fStatScanEntries); + setPMProperty(dict, "WQ-QueueEmpty", + gIOPMWorkQueue->fStatQueueEmpty); + setPMProperty(dict, "WQ-NoWorkDone", + gIOPMWorkQueue->fStatNoWorkDone); + } #endif + if (HasAdvisoryDesire && !gIOPMAdvisoryTickleEnabled) { + // Don't report advisory tickle when it has no influence + dict->removeObject(gIOPMPowerClientAdvisoryTickle); + } + ok = dict->serialize(s); dict->release(); } - return (ok ? kIOReturnSuccess : kIOReturnNoMemory); + return ok ? kIOReturnSuccess : kIOReturnNoMemory; } -bool IOServicePM::serialize( OSSerialize * s ) const +bool +IOServicePM::serialize( OSSerialize * s ) const { - IOReturn ret = kIOReturnNotReady; + IOReturn ret = kIOReturnNotReady; - if (gIOPMWorkLoop) - { + if (gIOPMWatchDogThread == current_thread()) { + // Calling without lock as this data is collected for debug purpose, before reboot. + // The workloop is probably already hung in state machine. + ret = gatedSerialize(s); + } else if (gIOPMWorkLoop) { ret = gIOPMWorkLoop->runAction( - OSMemberFunctionCast(IOWorkLoop::Action, this, &IOServicePM::gatedSerialize), - (OSObject *) this, (void *) s); - } - - return (kIOReturnSuccess == ret); -} - -PMEventDetails* PMEventDetails::eventDetails(uint32_t type, - const char *ownerName, - uintptr_t ownerUnique, - const char *interestName, - uint8_t oldState, - uint8_t newState, - uint32_t result, - uint32_t elapsedTimeUS) { - - PMEventDetails *myself; - myself = new PMEventDetails; - - if(myself) { - myself->eventType = type; - myself->ownerName = ownerName; - myself->ownerUnique = ownerUnique; - myself->interestName = interestName; - myself->oldState = oldState; - myself->newState = newState; - myself->result = result; - myself->elapsedTimeUS = elapsedTimeUS; - - myself->eventClassifier = kIOPMEventClassDriverEvent; - } - - return myself; -} - - -PMEventDetails* PMEventDetails::eventDetails(uint32_t type, - const char *uuid, - uint32_t reason, - uint32_t result) { - - PMEventDetails *myself; - myself = new PMEventDetails; - - if(myself) { - myself->eventType = type; - myself->uuid = uuid; - myself->reason = reason; - myself->result = result; - - myself->eventClassifier = kIOPMEventClassSystemEvent; - } - - return myself; + OSMemberFunctionCast(IOWorkLoop::Action, this, &IOServicePM::gatedSerialize), + (OSObject *) this, (void *) s); + } + + return kIOReturnSuccess == ret; +} + +void +IOServicePM::pmPrint( + uint32_t event, + uintptr_t param1, + uintptr_t param2 ) const +{ + gPlatform->PMLog(Name, event, param1, param2); } +void +IOServicePM::pmTrace( + uint32_t event, + uint32_t eventFunc, + uintptr_t param1, + uintptr_t param2 ) const +{ + uintptr_t nameAsArg = 0; + + assert(event < KDBG_CODE_MAX); + assert((eventFunc & ~KDBG_FUNC_MASK) == 0); + + // Copy the first characters of the name into an uintptr_t. + // NULL termination is not required. + strncpy((char*)&nameAsArg, Name, sizeof(nameAsArg)); + + IOTimeStampConstant(IODBG_POWER(event) | eventFunc, nameAsArg, (uintptr_t)Owner->getRegistryEntryID(), (uintptr_t)(OBFUSCATE(param1)), (uintptr_t)(OBFUSCATE(param2))); +}