* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
*/
+//#undef IOASSERT
+//#define IOASSERT 1
+
#include <IOKit/assert.h>
#include <IOKit/IOKitDebug.h>
#include <IOKit/IOLib.h>
#include <IOKit/IOMessage.h>
#include <IOKit/IOPlatformExpert.h>
#include <IOKit/IOService.h>
-#include <IOKit/IOTimerEventSource.h>
+#include <IOKit/IOEventSource.h>
#include <IOKit/IOWorkLoop.h>
#include <IOKit/IOCommand.h>
#include <IOKit/pwr_mgt/IOPMinformeeList.h>
#include <IOKit/pwr_mgt/IOPowerConnection.h>
#include <IOKit/pwr_mgt/RootDomain.h>
+#include <IOKit/pwr_mgt/IOPMPrivate.h>
#include <sys/proc.h>
+#include <libkern/OSDebug.h>
// Required for notification instrumentation
#include "IOServicePrivate.h"
#include "IOKitKernelInternal.h"
static void settle_timer_expired(thread_call_param_t, thread_call_param_t);
-static void PM_idle_timer_expired(OSObject *, IOTimerEventSource *);
-void tellAppWithResponse(OSObject * object, void * context) { /*empty*/ }
-void tellClientWithResponse(OSObject * object, void * context) { /*empty*/ }
-void tellClient(OSObject * object, void * context);
-IOReturn serializedAllowPowerChange(OSObject *, void *, void *, void *, void *);
+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 )
{
return nsec;
}
+#if PM_VARS_SUPPORT
OSDefineMetaClassAndStructors(IOPMprot, OSObject)
+#endif
-// log setPowerStates longer than (ns):
-#define LOG_SETPOWER_TIMES (50ULL * 1000ULL * 1000ULL)
-// log app responses longer than (ns):
-#define LOG_APP_RESPONSE_TIMES (100ULL * 1000ULL * 1000ULL)
+// Container class for recording system power events
+OSDefineMetaClassAndStructors( PMEventDetails, OSObject );
-//*********************************************************************************
+//******************************************************************************
// Globals
-//*********************************************************************************
+//******************************************************************************
-static bool gIOPMInitialized = false;
-static IOItemCount gIOPMBusyCount = 0;
-static IOWorkLoop * gIOPMWorkLoop = 0;
-static IOPMRequestQueue * gIOPMRequestQueue = 0;
-static IOPMRequestQueue * gIOPMReplyQueue = 0;
-static IOPMRequestQueue * gIOPMFreeQueue = 0;
+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 uint32_t getPMRequestType( void )
+{
+ uint32_t type = kIOPMRequestTypeInvalid;
+ if (gIOPMRequest)
+ type = gIOPMRequest->getType();
+ return type;
+}
+
+//******************************************************************************
// Macros
-//*********************************************************************************
+//******************************************************************************
+
+#define PM_ERROR(x...) do { kprintf(x); IOLog(x); } while (false)
+#define PM_LOG(x...) do { kprintf(x); } while (false)
-#define PM_ERROR(x...) do { kprintf(x); IOLog(x); } while (false)
-#define PM_DEBUG(x...) do { kprintf(x); } while (false)
+#define PM_LOG1(x...) do { \
+ if (kIOLogDebugPower & gIOKitDebug) \
+ kprintf(x); } while (false)
-#define PM_TRACE(x...) do { \
- if (kIOLogDebugPower & gIOKitDebug) kprintf(x); } while (false)
+#define PM_LOG2(x...) do { \
+ if (kIOLogDebugPower & gIOKitDebug) \
+ kprintf(x); } while (false)
+
+#if 0
+#define PM_LOG3(x...) do { kprintf(x); } while (false)
+#else
+#define PM_LOG3(x...)
+#endif
-#define PM_CONNECT(x...)
+#define RD_LOG(x...) do { \
+ if ((kIOLogPMRootDomain & gIOKitDebug) && \
+ (getPMRootDomain() == this)) \
+ kprintf("PMRD: " x); } while (false)
#define PM_ASSERT_IN_GATE(x) \
do { \
assert(gIOPMWorkLoop->inGate()); \
} while(false)
-#define PM_LOCK() IOLockLock(fPMLock)
-#define PM_UNLOCK() IOLockUnlock(fPMLock)
+#define PM_LOCK() IOLockLock(fPMLock)
+#define PM_UNLOCK() IOLockUnlock(fPMLock)
+#define PM_LOCK_SLEEP(event, dl) IOLockSleepDeadline(fPMLock, event, dl, THREAD_UNINT)
+#define PM_LOCK_WAKEUP(event) IOLockWakeup(fPMLock, event, false)
-#define ns_per_us 1000
-#define k30seconds (30*1000000)
-#define kMinAckTimeoutTicks (10*1000000)
-#define kIOPMTardyAckSPSKey "IOPMTardyAckSetPowerState"
-#define kIOPMTardyAckPSCKey "IOPMTardyAckPowerStateChange"
-#define kPwrMgtKey "IOPowerManagement"
+#define ns_per_us 1000
+#define k30seconds (30*1000000)
+#define kMinAckTimeoutTicks (10*1000000)
+#define kIOPMTardyAckSPSKey "IOPMTardyAckSetPowerState"
+#define kIOPMTardyAckPSCKey "IOPMTardyAckPowerStateChange"
+#define kPwrMgtKey "IOPowerManagement"
#define OUR_PMLog(t, a, b) \
- do { fPlatform->PMLog( fName, t, a, b); } while(0)
+ do { gPlatform->PMLog( fName, t, a, b); } while(0)
-#define NS_TO_MS(nsec) ((int)((nsec) / 1000000ULL))
+#define NS_TO_MS(nsec) ((int)((nsec) / 1000000ULL))
+#define NS_TO_US(nsec) ((int)((nsec) / 1000ULL))
#if CONFIG_EMBEDDED
-#define SUPPORT_IDLE_CANCEL 1
+#define SUPPORT_IDLE_CANCEL 1
#endif
+#define kIOPMPowerStateMax 0xFFFFFFFF
+
+#define IS_PM_ROOT (this == gIOPMRootNode)
+#define IS_ROOT_DOMAIN (getPMRootDomain() == this)
+#define IS_POWER_DROP (fHeadNotePowerState < fCurrentPowerState)
+#define IS_POWER_RISE (fHeadNotePowerState > fCurrentPowerState)
+
+// log setPowerStates longer than (ns):
+#define LOG_SETPOWER_TIMES (50ULL * 1000ULL * 1000ULL)
+// 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)
+
+enum {
+ kReserveDomainPower = 1
+};
+
+#define MS_PUSH(n) \
+ do { assert(kIOPM_BadMachineState == fSavedMachineState); \
+ assert(kIOPM_BadMachineState != n); \
+ fSavedMachineState = n; } while (false)
+
+#define MS_POP() \
+ do { assert(kIOPM_BadMachineState != fSavedMachineState); \
+ fMachineState = fSavedMachineState; \
+ fSavedMachineState = kIOPM_BadMachineState; } while (false)
+
+#define PM_ACTION_0(a) \
+ do { if (fPMActions.a) { \
+ (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)
+
//*********************************************************************************
// PM machine states
+//
+// Check kgmacros after modifying machine states.
//*********************************************************************************
enum {
+ kIOPM_Finished = 0,
+
kIOPM_OurChangeTellClientsPowerDown = 1,
kIOPM_OurChangeTellPriorityClientsPowerDown = 2,
kIOPM_OurChangeNotifyInterestedDriversWillChange = 3,
kIOPM_OurChangeSetPowerState = 4,
kIOPM_OurChangeWaitForPowerSettle = 5,
kIOPM_OurChangeNotifyInterestedDriversDidChange = 6,
- kIOPM_OurChangeFinish = 7,
- kIOPM_ParentDownTellPriorityClientsPowerDown = 8,
- kIOPM_ParentDownNotifyInterestedDriversWillChange = 9,
- /* 10 not used */
- kIOPM_ParentDownNotifyDidChangeAndAcknowledgeChange = 11,
- kIOPM_ParentDownSetPowerState = 12,
- kIOPM_ParentDownWaitForPowerSettle = 13,
- kIOPM_ParentDownAcknowledgeChange = 14,
- kIOPM_ParentUpSetPowerState = 15,
- /* 16 not used */
- kIOPM_ParentUpWaitForSettleTime = 17,
- kIOPM_ParentUpNotifyInterestedDriversDidChange = 18,
- kIOPM_ParentUpAcknowledgePowerChange = 19,
- kIOPM_Finished = 20,
- kIOPM_DriverThreadCallDone = 21,
- kIOPM_NotifyChildrenDone = 22
+ 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
};
*/
//*********************************************************************************
-// [public virtual] PMinit
+// [public] PMinit
//
// Initialize power management.
//*********************************************************************************
{
if ( !gIOPMInitialized )
{
- gIOPMWorkLoop = IOWorkLoop::workLoop();
- if (gIOPMWorkLoop)
- {
- gIOPMRequestQueue = IOPMRequestQueue::create(
- this, OSMemberFunctionCast(IOPMRequestQueue::Action,
- this, &IOService::servicePMRequestQueue));
+ 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;
+ }
- gIOPMReplyQueue = IOPMRequestQueue::create(
- this, OSMemberFunctionCast(IOPMRequestQueue::Action,
- this, &IOService::servicePMReplyQueue));
+ if (gIOPMWorkLoop->addEventSource(gIOPMReplyQueue) !=
+ kIOReturnSuccess)
+ {
+ gIOPMReplyQueue->release();
+ gIOPMReplyQueue = 0;
+ }
- gIOPMFreeQueue = IOPMRequestQueue::create(
- this, OSMemberFunctionCast(IOPMRequestQueue::Action,
- this, &IOService::servicePMFreeQueue));
+ if (gIOPMWorkLoop->addEventSource(gIOPMWorkQueue) !=
+ kIOReturnSuccess)
+ {
+ gIOPMWorkQueue->release();
+ gIOPMWorkQueue = 0;
+ }
- if (gIOPMWorkLoop->addEventSource(gIOPMRequestQueue) !=
- kIOReturnSuccess)
- {
- gIOPMRequestQueue->release();
- gIOPMRequestQueue = 0;
- }
+ if (gIOPMWorkLoop->addEventSource(gIOPMFreeQueue) !=
+ kIOReturnSuccess)
+ {
+ gIOPMFreeQueue->release();
+ gIOPMFreeQueue = 0;
+ }
- if (gIOPMWorkLoop->addEventSource(gIOPMReplyQueue) !=
- kIOReturnSuccess)
- {
- gIOPMReplyQueue->release();
- gIOPMReplyQueue = 0;
- }
+ gIOPMPowerClientDevice =
+ OSSymbol::withCStringNoCopy( "DevicePowerState" );
- if (gIOPMWorkLoop->addEventSource(gIOPMFreeQueue) !=
- kIOReturnSuccess)
- {
- gIOPMFreeQueue->release();
- gIOPMFreeQueue = 0;
- }
- }
+ gIOPMPowerClientDriver =
+ OSSymbol::withCStringNoCopy( "DriverPowerState" );
- if (gIOPMRequestQueue && gIOPMReplyQueue && gIOPMFreeQueue)
- gIOPMInitialized = true;
- }
- if (!gIOPMInitialized)
- return;
+ 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;
- fWeAreRoot = false;
fPMLock = IOLockAlloc();
fInterestedDrivers = new IOPMinformeeList;
fInterestedDrivers->initialize();
fDesiredPowerState = 0;
- fDriverDesire = 0;
fDeviceDesire = 0;
- fInitialChange = true;
- fNeedToBecomeUsable = false;
- fPreviousRequest = 0;
- fDeviceOverrides = false;
+ fInitialPowerChange = true;
+ fInitialSetPowerState = true;
+ fPreviousRequestPowerFlags = 0;
+ fDeviceOverrideEnabled = false;
fMachineState = kIOPM_Finished;
- fIdleTimerEventSource = NULL;
+ fSavedMachineState = kIOPM_BadMachineState;
fIdleTimerMinPowerState = 0;
fActivityLock = IOLockAlloc();
- fClampOn = false;
fStrictTreeOrder = false;
fActivityTicklePowerState = -1;
fControllingDriver = NULL;
fNumberOfPowerStates = 0;
fCurrentPowerState = 0;
fParentsCurrentPowerFlags = 0;
- fMaxCapability = 0;
+ fMaxPowerState = 0;
fName = getName();
- fPlatform = getPlatform();
fParentsKnowState = false;
fSerialNumber = 0;
fResponseArray = NULL;
- fDoNotPowerDown = true;
+ fNotifyClientArray = NULL;
fCurrentPowerConsumption = kIOPMUnknown;
+ fOverrideMaxPowerState = kIOPMPowerStateMax;
- for (unsigned int i = 0; i <= kMaxType; i++)
+ if (!gIOPMRootNode && (getParentEntry(gIOPowerPlane) == getRegistryRoot()))
{
- fAggressivenessValue[i] = 0;
- fAggressivenessValid[i] = false;
+ gIOPMRootNode = this;
+ fParentsKnowState = true;
}
fAckTimer = thread_call_allocate(
&IOService::ack_timer_expired, (thread_call_param_t)this);
fSettleTimer = thread_call_allocate(
&settle_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);
+ 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;
{
prot->init();
prot->ourName = fName;
- prot->thePlatform = fPlatform;
+ prot->thePlatform = gPlatform;
fPMVars = prot;
pm_vars = prot;
}
#else
- pm_vars = (IOPMprot *) true;
+ pm_vars = (void *) (uintptr_t) true;
#endif
initialized = true;
}
//*********************************************************************************
-// [public] PMfree
+// [private] PMfree
//
-// Free up the data created in PMinit, if it exists.
+// Free the data created by PMinit. Only called from IOService::free().
//*********************************************************************************
void IOService::PMfree ( void )
{
- initialized = false;
+ initialized = false;
pm_vars = 0;
if ( pwrMgt )
- {
- assert(fMachineState == kIOPM_Finished);
- assert(fInsertInterestSet == NULL);
- assert(fRemoveInterestSet == NULL);
+ {
+ assert(fMachineState == kIOPM_Finished);
+ assert(fInsertInterestSet == NULL);
+ assert(fRemoveInterestSet == NULL);
assert(fNotifyChildArray == NULL);
+ assert(queue_empty(&pwrMgt->RequestHead));
+ assert(queue_empty(&fPMDriverCallQueue));
- if ( fIdleTimerEventSource != NULL ) {
- getPMworkloop()->removeEventSource(fIdleTimerEventSource);
- fIdleTimerEventSource->release();
- fIdleTimerEventSource = NULL;
- }
if ( fSettleTimer ) {
thread_call_cancel(fSettleTimer);
thread_call_free(fSettleTimer);
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;
IOLockFree(fActivityLock);
fActivityLock = NULL;
}
- if ( fInterestedDrivers ) {
- fInterestedDrivers->release();
- fInterestedDrivers = NULL;
- }
- if ( fPMWorkQueue ) {
- getPMworkloop()->removeEventSource(fPMWorkQueue);
- fPMWorkQueue->release();
- fPMWorkQueue = 0;
- }
- if (fDriverCallParamSlots && fDriverCallParamPtr) {
- IODelete(fDriverCallParamPtr, DriverCallParam, fDriverCallParamSlots);
- fDriverCallParamPtr = 0;
- fDriverCallParamSlots = 0;
- }
+ 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, IOPMPowerState, fNumberOfPowerStates);
+ IODelete(fPowerStates, IOPMPSEntry, fNumberOfPowerStates);
fNumberOfPowerStates = 0;
fPowerStates = NULL;
}
+ if (fPowerClients) {
+ fPowerClients->release();
+ fPowerClients = 0;
+ }
#if PM_VARS_SUPPORT
- if (fPMVars)
- {
- fPMVars->release();
- fPMVars = 0;
- }
+ if (fPMVars)
+ {
+ fPMVars->release();
+ fPMVars = 0;
+ }
#endif
pwrMgt->release();
- pwrMgt = 0;
+ pwrMgt = 0;
}
}
//*********************************************************************************
-// [public virtual] joinPMtree
+// [public] joinPMtree
//
// A policy-maker calls its nub here when initializing, to be attached into
// the power management hierarchy. The default function is to call the
void IOService::joinPMtree ( IOService * driver )
{
- IOPlatformExpert * platform;
+ IOPlatformExpert * platform;
platform = getPlatform();
assert(platform != 0);
platform->PMRegisterDevice(this, driver);
}
+#ifndef __LP64__
//*********************************************************************************
-// [public virtual] youAreRoot
+// [deprecated] youAreRoot
//
// Power Managment is informing us that we are the root power domain.
-// The only difference between us and any other power domain is that
-// we have no parent and therefore never call it.
//*********************************************************************************
IOReturn IOService::youAreRoot ( void )
{
- fWeAreRoot = true;
- fParentsKnowState = true;
- attachToParent( getRegistryRoot(), gIOPowerPlane );
return IOPMNoErr;
}
+#endif /* !__LP64__ */
//*********************************************************************************
-// [public virtual] PMstop
+// [public] PMstop
//
// Immediately stop driver callouts. Schedule an async stop request to detach
// from power plane.
void IOService::PMstop ( void )
{
- IOPMRequest * request;
+ IOPMRequest * request;
- if (!initialized)
- return;
+ if (!initialized)
+ return;
+
+ PM_LOCK();
+
+ if (fLockedFlags.PMStop)
+ {
+ PM_LOG2("%s: PMstop() already stopped\n", fName);
+ PM_UNLOCK();
+ return;
+ }
+
+ // Inhibit future driver calls.
+ fLockedFlags.PMStop = true;
- // Schedule an async PMstop request, but immediately stop any further
- // calls to the controlling or interested drivers. This device will
- // continue to exist in the power plane and participate in power state
- // changes until the PMstop async request is processed.
+ // Wait for all prior driver calls to finish.
+ waitForPMDriverCall();
- PM_LOCK();
- fWillPMStop = true;
- if (fDriverCallBusy)
- PM_DEBUG("%s::PMstop() driver call busy\n", getName());
PM_UNLOCK();
- request = acquirePMRequest( this, kIOPMRequestTypePMStop );
- if (request)
- {
- PM_TRACE("[%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(), this);
+ submitPMRequest( request );
+ }
}
//*********************************************************************************
-// handlePMstop
+// [private] handlePMstop
//
-// Disconnect the node from its parents and children in the Power Plane.
+// Disconnect the node from all parents and children in the power plane.
//*********************************************************************************
void IOService::handlePMstop ( IOPMRequest * request )
{
- OSIterator * iter;
+ OSIterator * iter;
OSObject * next;
IOPowerConnection * connection;
IOService * theChild;
IOService * theParent;
PM_ASSERT_IN_GATE();
- PM_TRACE("[%s] %p %s start\n", getName(), this, __FUNCTION__);
+ PM_LOG2("%s: %p %s start\n", getName(), this, __FUNCTION__);
// remove the property
removeProperty(kPwrMgtKey);
if ( fInterestedDrivers )
{
- IOPMinformeeList * list = fInterestedDrivers;
+ IOPMinformeeList * list = fInterestedDrivers;
IOPMinformee * item;
- PM_LOCK();
- while ((item = list->firstInList()))
- {
- list->removeFromList(item->whatObject);
- }
- PM_UNLOCK();
- }
+ PM_LOCK();
+ while ((item = list->firstInList()))
+ {
+ list->removeFromList(item->whatObject);
+ }
+ PM_UNLOCK();
+ }
- // Tell PM_idle_timer_expiration() to ignore idle timer.
- fIdleTimerPeriod = 0;
+ // Tell idleTimerExpired() to ignore idle timer.
+ fIdleTimerPeriod = 0;
+ if (fIdleTimer && thread_call_cancel(fIdleTimer))
+ release();
- fWillPMStop = false;
- PM_TRACE("[%s] %p %s done\n", getName(), this, __FUNCTION__);
+ PM_LOG2("%s: %p %s done\n", getName(), this, __FUNCTION__);
}
//*********************************************************************************
-// [public virtual] addPowerChild
+// [public] addPowerChild
//
// Power Management is informing us who our children are.
//*********************************************************************************
if (!initialized || !child->initialized)
return IOPMNotYetInitialized;
- OUR_PMLog( kPMLogAddChild, 0, 0 );
+ OUR_PMLog( kPMLogAddChild, (uintptr_t) child, 0 );
do {
// Is this child already one of our children?
}
if (!ok)
{
- PM_DEBUG("[%s] %s (%p) is already a child\n",
+ PM_LOG("%s: %s (%p) is already a child\n",
getName(), child->getName(), child);
break;
}
if (!requests[0] || !requests[1] || !requests[2])
break;
- requests[0]->setParentRequest( requests[1] );
- requests[1]->setParentRequest( requests[2] );
+ requests[0]->attachNextRequest( requests[1] );
+ requests[1]->attachNextRequest( requests[2] );
connection->init();
connection->start(this);
if (requests[1]) releasePMRequest(requests[1]);
if (requests[2]) releasePMRequest(requests[2]);
- // silent failure, to prevent platform drivers from adding the child
+ // Silent failure, to prevent platform drivers from adding the child
// to the root domain.
- return IOPMNoErr;
+
+ return kIOReturnSuccess;
}
//*********************************************************************************
// [private] addPowerChild1
//
-// Called on the power parent.
+// Step 1/3 of adding a power child. Called on the power parent.
//*********************************************************************************
void IOService::addPowerChild1 ( IOPMRequest * request )
// Make us temporary usable before adding the child.
PM_ASSERT_IN_GATE();
- OUR_PMLog( kPMLogMakeUsable, kPMLogMakeUsable, fDeviceDesire );
+ OUR_PMLog( kPMLogMakeUsable, kPMLogMakeUsable, 0 );
if (fControllingDriver && inPlane(gIOPowerPlane) && fParentsKnowState)
{
tempDesire = fNumberOfPowerStates - 1;
}
- if (tempDesire && (fWeAreRoot || (fMaxCapability >= tempDesire)))
+ if (tempDesire && (IS_PM_ROOT || (fMaxPowerState >= tempDesire)))
{
- computeDesiredState( tempDesire );
- changeState();
+ adjustPowerState(tempDesire);
}
}
//*********************************************************************************
// [private] addPowerChild2
//
-// Called on the joining child. Blocked behind addPowerChild1.
+// Step 2/3 of adding a power child. Called on the joining child.
+// Execution blocked behind addPowerChild1.
//*********************************************************************************
void IOService::addPowerChild2 ( IOPMRequest * request )
if (!parent || !inPlane(gIOPowerPlane))
{
- PM_DEBUG("[%s] addPowerChild2 not in power plane\n", getName());
+ PM_LOG("%s: addPowerChild2 not in power plane\n", getName());
return;
}
- // Parent will be waiting for us to complete this stage, safe to
- // directly access parent's vars.
+ // Parent will be waiting for us to complete this stage.
+ // It is safe to directly access parent's vars.
knowsState = (parent->fPowerStates) && (parent->fParentsKnowState);
powerState = parent->fCurrentPowerState;
if (knowsState)
- powerFlags = parent->fPowerStates[powerState].outputPowerCharacter;
+ powerFlags = parent->fPowerStates[powerState].outputPowerFlags;
else
powerFlags = 0;
if ( fControllingDriver && fParentsKnowState )
{
- fMaxCapability = fControllingDriver->maxCapabilityForDomainState(fParentsCurrentPowerFlags);
+ fMaxPowerState = fControllingDriver->maxCapabilityForDomainState(fParentsCurrentPowerFlags);
// initially change into the state we are already in
tempDesire = fControllingDriver->initialPowerStateForDomainState(fParentsCurrentPowerFlags);
- computeDesiredState(tempDesire);
- fPreviousRequest = 0xffffffff;
- changeState();
+ fPreviousRequestPowerFlags = (IOPMPowerFlags)(-1);
+ adjustPowerState(tempDesire);
}
+
+ getPMRootDomain()->tagPowerPlaneService(this, &fPMActions);
}
//*********************************************************************************
// [private] addPowerChild3
//
-// Called on the parent. Blocked behind addPowerChild2.
+// Step 3/3 of adding a power child. Called on the parent.
+// Execution blocked behind addPowerChild2.
//*********************************************************************************
void IOService::addPowerChild3 ( IOPMRequest * request )
{
IOPowerConnection * connection = (IOPowerConnection *) request->fArg0;
IOService * child;
- unsigned int i;
+ IOPMrootDomain * rootDomain = getPMRootDomain();
PM_ASSERT_IN_GATE();
child = (IOService *) connection->getChildEntry(gIOPowerPlane);
{
if (child->getProperty("IOPMStrictTreeOrder"))
{
- PM_DEBUG("[%s] strict ordering enforced\n", getName());
+ PM_LOG1("%s: strict PM order enforced\n", getName());
fStrictTreeOrder = true;
}
- for (i = 0; i <= kMaxType; i++)
- {
- if ( fAggressivenessValid[i] )
- {
- child->setAggressiveness(i, fAggressivenessValue[i]);
- }
- }
+ if (rootDomain)
+ rootDomain->joinAggressiveness( child );
}
else
{
- PM_DEBUG("[%s] addPowerChild3 not in power plane\n", getName());
+ PM_LOG("%s: addPowerChild3 not in power plane\n", getName());
}
connection->release();
}
+#ifndef __LP64__
//*********************************************************************************
-// [public virtual deprecated] setPowerParent
+// [deprecated] setPowerParent
//
// Power Management is informing us who our parent is.
// If we have a controlling driver, find out, given our newly-informed
{
return kIOReturnUnsupported;
}
+#endif /* !__LP64__ */
//*********************************************************************************
-// [public virtual] removePowerChild
+// [public] removePowerChild
//
// Called on a parent whose child is being removed by PMstop().
//*********************************************************************************
OUR_PMLog( kPMLogRemoveChild, 0, 0 );
theNub->retain();
-
+
// detach nub from child
theChild = theNub->copyChildEntry(gIOPowerPlane);
if ( theChild )
if ( fHeadNotePendingAcks == 0 )
{
stop_ack_timer();
+
+ // Request unblocked, work queue
+ // should re-scan all busy requests.
+ gIOPMWorkQueue->incrementProducerCount();
}
}
}
theNub->release();
- // Schedule a request to re-scan child desires and clamp bits.
- if (!fWillAdjustPowerState)
+ // A child has gone away, re-scan children desires and clamp bits.
+ // The fPendingAdjustPowerRequest helps to reduce redundant parent work.
+
+ if (!fAdjustPowerScheduled)
{
IOPMRequest * request;
-
request = acquirePMRequest( this, kIOPMRequestTypeAdjustPowerState );
if (request)
{
submitPMRequest( request );
- fWillAdjustPowerState = true;
+ fAdjustPowerScheduled = true;
}
}
}
//*********************************************************************************
-// [public virtual] registerPowerDriver
+// [public] registerPowerDriver
//
// A driver has called us volunteering to control power to our device.
//*********************************************************************************
IOPMPowerState * powerStates,
unsigned long numberOfStates )
{
- IOPMRequest * request;
- IOPMPowerState * powerStatesCopy = 0;
+ IOPMRequest * request;
+ IOPMPSEntry * powerStatesCopy = 0;
if (!initialized)
return IOPMNotYetInitialized;
return kIOReturnBadArgument;
}
- if (!powerDriver)
+ if (!powerDriver || !powerDriver->initialized)
{
OUR_PMLog(kPMLogControllingDriverErr4, 0, 0);
return kIOReturnBadArgument;
do {
// Make a copy of the supplied power state array.
- powerStatesCopy = IONew(IOPMPowerState, numberOfStates);
+ powerStatesCopy = IONew(IOPMPSEntry, numberOfStates);
if (!powerStatesCopy)
break;
- bcopy( powerStates, powerStatesCopy,
- sizeof(IOPMPowerState) * numberOfStates );
+ 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;
+ }
request = acquirePMRequest( this, kIOPMRequestTypeRegisterPowerDriver );
if (!request)
while (false);
if (powerStatesCopy)
- IODelete(powerStatesCopy, IOPMPowerState, numberOfStates);
+ IODelete(powerStatesCopy, IOPMPSEntry, numberOfStates);
return kIOReturnNoMemory;
}
void IOService::handleRegisterPowerDriver ( IOPMRequest * request )
{
- IOService * powerDriver = (IOService *) request->fArg0;
- IOPMPowerState * powerStates = (IOPMPowerState *) request->fArg1;
- unsigned long numberOfStates = (unsigned long) request->fArg2;
- unsigned long i;
- IOService * root;
+ IOService * powerDriver = (IOService *) request->fArg0;
+ IOPMPSEntry * powerStates = (IOPMPSEntry *) request->fArg1;
+ unsigned long numberOfStates = (unsigned long) request->fArg2;
+ unsigned long i;
+ IOService * root;
+ OSIterator * iter;
PM_ASSERT_IN_GATE();
assert(powerStates);
{
OUR_PMLog(kPMLogControllingDriver,
(unsigned long) numberOfStates,
- (unsigned long) powerStates[0].version);
+ (unsigned long) kIOPMPowerStateVersion1);
fPowerStates = powerStates;
fNumberOfPowerStates = numberOfStates;
// make a mask of all the character bits we know about
fOutputPowerCharacterFlags = 0;
for ( i = 0; i < numberOfStates; i++ ) {
- fOutputPowerCharacterFlags |= fPowerStates[i].outputPowerCharacter;
+ fOutputPowerCharacterFlags |= fPowerStates[i].outputPowerFlags;
}
// Register powerDriver as interested, unless already done.
}
}
- if ( fNeedToBecomeUsable ) {
- fNeedToBecomeUsable = false;
- fDeviceDesire = fNumberOfPowerStates - 1;
- }
+ // 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;
- fMaxCapability = fControllingDriver->maxCapabilityForDomainState(fParentsCurrentPowerFlags);
+ fMaxPowerState = fControllingDriver->maxCapabilityForDomainState(fParentsCurrentPowerFlags);
// initially change into the state we are already in
tempDesire = fControllingDriver->initialPowerStateForDomainState(fParentsCurrentPowerFlags);
- computeDesiredState(tempDesire);
- changeState();
+ adjustPowerState(tempDesire);
}
}
else
{
OUR_PMLog(kPMLogControllingDriverErr2, numberOfStates, 0);
- IODelete(powerStates, IOPMPowerState, numberOfStates);
+ IODelete(powerStates, IOPMPSEntry, numberOfStates);
}
powerDriver->release();
}
//*********************************************************************************
-// [public virtual] registerInterestedDriver
+// [public] registerInterestedDriver
//
// Add the caller to our list of interested drivers and return our current
// power state. If we don't have a power-controlling driver yet, we will
IOPMPowerFlags IOService::registerInterestedDriver ( IOService * driver )
{
- IOPMRequest * request;
- bool signal;
+ IOPMRequest * request;
+ bool signal;
- if (!initialized || !fInterestedDrivers)
- return IOPMNotPowerManaged;
+ if (!driver || !initialized || !fInterestedDrivers)
+ return 0;
- PM_LOCK();
- signal = (!fInsertInterestSet && !fRemoveInterestSet);
- if (fInsertInterestSet == NULL)
- fInsertInterestSet = OSSet::withCapacity(4);
- if (fInsertInterestSet)
- fInsertInterestSet->setObject(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;
}
//*********************************************************************************
-// [public virtual] deRegisterInterestedDriver
+// [public] deRegisterInterestedDriver
//*********************************************************************************
IOReturn IOService::deRegisterInterestedDriver ( IOService * driver )
{
- IOPMinformeeList * list;
+ IOPMinformeeList * list;
IOPMinformee * item;
- IOPMRequest * request;
- bool signal;
+ IOPMRequest * request;
+ bool signal;
- if (!initialized || !fInterestedDrivers)
- return IOPMNotPowerManaged;
-
- PM_LOCK();
- signal = (!fRemoveInterestSet && !fInsertInterestSet);
- if (fRemoveInterestSet == NULL)
- fRemoveInterestSet = OSSet::withCapacity(4);
- if (fRemoveInterestSet)
- {
- fRemoveInterestSet->setObject(driver);
+ if (!driver)
+ return kIOReturnBadArgument;
+ if (!initialized || !fInterestedDrivers)
+ return IOPMNotPowerManaged;
+
+ PM_LOCK();
+ signal = (!fRemoveInterestSet && !fInsertInterestSet);
+ if (fRemoveInterestSet == NULL)
+ fRemoveInterestSet = OSSet::withCapacity(4);
+ if (fRemoveInterestSet)
+ {
+ fRemoveInterestSet->setObject(driver);
+ if (fInsertInterestSet)
+ fInsertInterestSet->removeObject(driver);
- list = fInterestedDrivers;
- item = list->findItem(driver);
- if (item && item->active)
- {
- item->active = false;
- }
- if (fDriverCallBusy)
- PM_DEBUG("%s::deRegisterInterestedDriver() driver call busy\n", getName());
- }
- PM_UNLOCK();
+ list = fInterestedDrivers;
+ item = list->findItem(driver);
+ if (item && 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;
}
//*********************************************************************************
void IOService::handleInterestChanged( IOPMRequest * request )
{
- IOService * driver;
+ IOService * driver;
IOPMinformee * informee;
- IOPMinformeeList * list = fInterestedDrivers;
+ IOPMinformeeList * list = fInterestedDrivers;
- PM_LOCK();
+ PM_LOCK();
- if (fInsertInterestSet)
- {
- while ((driver = (IOService *) fInsertInterestSet->getAnyObject()))
- {
- if ((list->findItem(driver) == NULL) &&
- (!fRemoveInterestSet ||
- !fRemoveInterestSet->containsObject(driver)))
- {
- informee = list->appendNewInformee(driver);
- }
- fInsertInterestSet->removeObject(driver);
- }
- fInsertInterestSet->release();
- fInsertInterestSet = 0;
- }
+ 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)
- {
- if (fHeadNotePendingAcks && informee->timer)
- {
- informee->timer = 0;
- fHeadNotePendingAcks--;
- }
- list->removeFromList(driver);
- }
- fRemoveInterestSet->removeObject(driver);
- }
- fRemoveInterestSet->release();
- fRemoveInterestSet = 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();
+ PM_UNLOCK();
}
//*********************************************************************************
-// [public virtual] acknowledgePowerChange
+// [public] acknowledgePowerChange
//
// After we notified one of the interested drivers or a power-domain child
// of an impending change in power, it has called to say it is now
request = acquirePMRequest( this, kIOPMRequestTypeAckPowerChange );
if (!request)
- {
- PM_ERROR("%s::%s no memory\n", getName(), __FUNCTION__);
return kIOReturnNoMemory;
- }
whichObject->retain();
request->fArg0 = whichObject;
{
uint64_t nsec = computeTimeDeltaNS(&informee->startTime);
if (nsec > LOG_SETPOWER_TIMES)
- PM_DEBUG("%s::powerState%sChangeTo(%p, %s, %lu -> %lu) async took %d ms\n",
+ 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, fHeadNoteState, NS_TO_MS(nsec));
+ 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
}
if ( childPower == kIOPMUnknown )
{
- fPowerStates[fHeadNoteState].staticPower = kIOPMUnknown;
+ fHeadNotePowerArrayEntry->staticPower = kIOPMUnknown;
} else {
- if ( fPowerStates[fHeadNoteState].staticPower != kIOPMUnknown )
+ if (fHeadNotePowerArrayEntry->staticPower != kIOPMUnknown)
{
- fPowerStates[fHeadNoteState].staticPower += childPower;
+ fHeadNotePowerArrayEntry->staticPower += childPower;
}
}
}
}
//*********************************************************************************
-// [public virtual] acknowledgeSetPowerState
+// [public] acknowledgeSetPowerState
//
// After we instructed our controlling driver to change power states,
// it has called to say it has finished doing so.
request = acquirePMRequest( this, kIOPMRequestTypeAckSetPowerState );
if (!request)
- {
- PM_ERROR("%s::%s no memory\n", getName(), __FUNCTION__);
return kIOReturnNoMemory;
- }
submitPMRequest( request );
return kIOReturnSuccess;
//*********************************************************************************
// [private] adjustPowerState
-//
-// Child has signaled a change - child changed it's desire, new child added,
-// existing child removed. Adjust our power state accordingly.
//*********************************************************************************
-void IOService::adjustPowerState( void )
+void IOService::adjustPowerState ( uint32_t clamp )
{
PM_ASSERT_IN_GATE();
- if (inPlane(gIOPowerPlane))
+ computeDesiredState(clamp);
+ if (fControllingDriver && fParentsKnowState && inPlane(gIOPowerPlane))
{
- rebuildChildClampBits();
- computeDesiredState();
- if ( fControllingDriver && fParentsKnowState )
- changeState();
+ 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.
+
+ if (getPMRequestType() == kIOPMRequestTypeRequestPowerStateOverride)
+ changeFlags |= (kIOPMIgnoreChildren | kIOPMSkipAskPowerDown);
+
+ startPowerChange(
+ /* flags */ changeFlags,
+ /* power state */ fDesiredPowerState,
+ /* domain flags */ 0,
+ /* connection */ 0,
+ /* parent flags */ 0);
}
- else
+}
+
+//*********************************************************************************
+// [public] synchronizePowerTree
+//*********************************************************************************
+
+IOReturn IOService::synchronizePowerTree (
+ IOOptionBits options,
+ IOService * notifyRoot )
+{
+ IOPMRequest * request_c = 0;
+ IOPMRequest * request_s;
+
+ if (this != getPMRootDomain())
+ return kIOReturnBadArgument;
+ if (!initialized)
+ return kIOPMNotYetInitialized;
+
+ 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;
+
+error_no_memory:
+ if (request_c) releasePMRequest(request_c);
+ if (request_s) releasePMRequest(request_s);
+ return kIOReturnNoMemory;
+}
+
+//*********************************************************************************
+// [private] handleSynchronizePowerTree
+//*********************************************************************************
+
+void IOService::handleSynchronizePowerTree ( IOPMRequest * request )
+{
+ PM_ASSERT_IN_GATE();
+ if (fControllingDriver && fParentsKnowState && inPlane(gIOPowerPlane) &&
+ (fCurrentPowerState == fNumberOfPowerStates - 1))
{
- PM_DEBUG("[%s] %s: not in power tree\n", getName(), __FUNCTION__);
- return;
+ IOOptionBits options = (uintptr_t) request->fArg0;
+
+ startPowerChange(
+ /* flags */ kIOPMSelfInitiated | kIOPMSynchronize |
+ (options & kIOPMSyncNoChildNotify),
+ /* power state */ fCurrentPowerState,
+ /* domain flags */ 0,
+ /* connection */ 0,
+ /* parent flags */ 0);
}
- fWillAdjustPowerState = false;
}
+#ifndef __LP64__
//*********************************************************************************
-// [public deprecated] powerDomainWillChangeTo
+// [deprecated] powerDomainWillChangeTo
//
// Called by the power-hierarchy parent notifying of a new power state
// in the power domain.
assert(false);
return kIOReturnUnsupported;
}
+#endif /* !__LP64__ */
//*********************************************************************************
// [private] handlePowerDomainWillChangeTo
void IOService::handlePowerDomainWillChangeTo ( IOPMRequest * request )
{
- IOPMPowerFlags newPowerFlags = (IOPMPowerFlags) request->fArg0;
- IOPowerConnection * whichParent = (IOPowerConnection *) request->fArg1;
- bool powerWillDrop = (bool) request->fArg2;
- OSIterator * iter;
- OSObject * next;
- IOPowerConnection * connection;
- unsigned long newPowerState;
- IOPMPowerFlags combinedPowerFlags;
- bool savedParentsKnowState;
- IOReturn result = IOPMAckImplied;
+ 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;
PM_ASSERT_IN_GATE();
- OUR_PMLog(kPMLogWillChange, newPowerFlags, 0);
+ OUR_PMLog(kPMLogWillChange, parentPowerFlags, 0);
if (!inPlane(gIOPowerPlane) || !whichParent || !whichParent->getAwaitingAck())
{
- PM_DEBUG("[%s] %s: not in power tree\n", getName(), __FUNCTION__);
+ PM_LOG("%s::%s not in power tree\n", getName(), __FUNCTION__);
goto exit_no_ack;
}
savedParentsKnowState = fParentsKnowState;
- // Combine parents' power flags to determine our maximum state
- // within the new power domain
+ // Combine parents' output power flags.
+
combinedPowerFlags = 0;
iter = getParentIterator(gIOPowerPlane);
if ( (connection = OSDynamicCast(IOPowerConnection, next)) )
{
if ( connection == whichParent )
- combinedPowerFlags |= newPowerFlags;
+ combinedPowerFlags |= parentPowerFlags;
else
combinedPowerFlags |= connection->parentCurrentPowerFlags();
}
iter->release();
}
- if ( fControllingDriver )
+ // 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);
- result = enqueuePowerChange(
- /* flags */ IOPMParentInitiated | IOPMDomainWillChange,
+ // Absorb parent's kIOPMSynchronize flag.
+ myChangeFlags = kIOPMParentInitiated | kIOPMDomainWillChange |
+ (parentChangeFlags & kIOPMSynchronize);
+
+ result = startPowerChange(
+ /* flags */ myChangeFlags,
/* power state */ newPowerState,
- /* domain state */ combinedPowerFlags,
+ /* domain flags */ combinedPowerFlags,
/* connection */ whichParent,
- /* parent state */ newPowerFlags);
+ /* 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 (powerWillDrop)
+ if (parentChangeFlags & kIOPMDomainPowerDrop)
{
- setParentInfo(newPowerFlags, whichParent, true);
+ setParentInfo(parentPowerFlags, whichParent, true);
}
// Parent is expecting an ACK from us. If we did not embark on a state
- // transition, when enqueuePowerChang() returns IOPMAckImplied. We are
+ // transition, i.e. startPowerChange() returned IOPMAckImplied. We are
// still required to issue an ACK to our parent.
if (IOPMAckImplied == result)
}
}
- // If the parent registers it's power driver late, then this is the
- // first opportunity to tell our parent about our desire.
-
- if (!savedParentsKnowState && fParentsKnowState)
- {
- PM_TRACE("[%s] powerDomainWillChangeTo: parentsKnowState = true\n",
- getName());
- ask_parent( fDesiredPowerState );
- }
-
exit_no_ack:
// Drop the retain from notifyChild().
if (whichParent) whichParent->release();
}
+#ifndef __LP64__
//*********************************************************************************
-// [public deprecated] powerDomainDidChangeTo
+// [deprecated] powerDomainDidChangeTo
//
// Called by the power-hierarchy parent after the power state of the power domain
// has settled at a new level.
assert(false);
return kIOReturnUnsupported;
}
+#endif /* !__LP64__ */
//*********************************************************************************
// [private] handlePowerDomainDidChangeTo
void IOService::handlePowerDomainDidChangeTo ( IOPMRequest * request )
{
- IOPMPowerFlags newPowerFlags = (IOPMPowerFlags) request->fArg0;
- IOPowerConnection * whichParent = (IOPowerConnection *) request->fArg1;
- unsigned long newPowerState;
- bool savedParentsKnowState;
- IOReturn result = IOPMAckImplied;
+ 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;
PM_ASSERT_IN_GATE();
- OUR_PMLog(kPMLogDidChange, newPowerFlags, 0);
+ OUR_PMLog(kPMLogDidChange, parentPowerFlags, 0);
if (!inPlane(gIOPowerPlane) || !whichParent || !whichParent->getAwaitingAck())
{
- PM_DEBUG("[%s] %s: not in power tree\n", getName(), __FUNCTION__);
+ PM_LOG("%s::%s not in power tree\n", getName(), __FUNCTION__);
goto exit_no_ack;
}
savedParentsKnowState = fParentsKnowState;
- setParentInfo(newPowerFlags, whichParent, true);
+ setParentInfo(parentPowerFlags, whichParent, true);
if ( fControllingDriver )
{
newPowerState = fControllingDriver->maxCapabilityForDomainState(
fParentsCurrentPowerFlags);
- result = enqueuePowerChange(
- /* flags */ IOPMParentInitiated | IOPMDomainDidChange,
+ if (fInitialPowerChange)
+ {
+ initialDesire = fControllingDriver->initialPowerStateForDomainState(
+ fParentsCurrentPowerFlags);
+ computeDesiredState(initialDesire);
+ }
+
+ // Absorb parent's kIOPMSynchronize flag.
+ myChangeFlags = kIOPMParentInitiated | kIOPMDomainDidChange |
+ (parentChangeFlags & kIOPMSynchronize);
+
+ result = startPowerChange(
+ /* flags */ myChangeFlags,
/* power state */ newPowerState,
- /* domain state */ fParentsCurrentPowerFlags,
+ /* domain flags */ fParentsCurrentPowerFlags,
/* connection */ whichParent,
- /* parent state */ 0);
+ /* parent flags */ 0);
}
// Parent is expecting an ACK from us. If we did not embark on a state
- // transition, when enqueuePowerChang() returns IOPMAckImplied. We are
+ // transition, i.e. startPowerChange() returned IOPMAckImplied. We are
// still required to issue an ACK to our parent.
if (IOPMAckImplied == result)
}
}
- // If the parent registers it's power driver late, then this is the
+ // If the parent registers its power driver late, then this is the
// first opportunity to tell our parent about our desire.
if (!savedParentsKnowState && fParentsKnowState)
{
- PM_TRACE("[%s] powerDomainDidChangeTo: parentsKnowState = true\n",
+ PM_LOG1("%s::powerDomainDidChangeTo parentsKnowState = true\n",
getName());
- ask_parent( fDesiredPowerState );
+ requestDomainPower( fDesiredPowerState );
}
exit_no_ack:
fPowerStates[i].capabilityFlags &= ~(kIOPMChildClamp | kIOPMChildClamp2);
}
+ if (!inPlane(gIOPowerPlane))
+ 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.
{
if (connection->getReadyFlag() == false)
{
- PM_CONNECT("[%s] %s: connection not ready\n",
+ PM_LOG3("[%s] %s: connection not ready\n",
getName(), __FUNCTION__);
continue;
}
}
//*********************************************************************************
-// [public virtual] requestPowerDomainState
+// [public] requestPowerDomainState
//
-// The child of a power domain calls it parent here to request power of a certain
-// character.
+// Called on a power parent when a child's power requirement changes.
//*********************************************************************************
-IOReturn IOService::requestPowerDomainState (
- IOPMPowerFlags desiredState,
- IOPowerConnection * whichChild,
- unsigned long specification )
+IOReturn IOService::requestPowerDomainState(
+ IOPMPowerFlags childRequestPowerFlags,
+ IOPowerConnection * childConnection,
+ unsigned long specification )
{
- unsigned long i;
- unsigned long computedState;
- unsigned long theDesiredState;
- IOService * child;
- IOPMRequest * childRequest;
+ IOPMPowerStateIndex ps;
+ IOPMPowerFlags outputPowerFlags;
+ IOService * child;
+ IOPMRequest * subRequest;
+ bool preventIdle, preventSleep;
+ bool adjustPower = false;
if (!initialized)
return IOPMNotYetInitialized;
if (gIOPMWorkLoop->onThread() == false)
{
- PM_DEBUG("[%s] called requestPowerDomainState\n", getName());
+ PM_LOG("%s::requestPowerDomainState\n", getName());
return kIOReturnSuccess;
}
- theDesiredState = desiredState & ~(kIOPMPreventIdleSleep | kIOPMPreventSystemSleep);
-
- OUR_PMLog(kPMLogRequestDomain, desiredState, specification);
+ OUR_PMLog(kPMLogRequestDomain, childRequestPowerFlags, specification);
- if (!isChild(whichChild, gIOPowerPlane))
+ if (!isChild(childConnection, gIOPowerPlane))
return kIOReturnNotAttached;
- if (fControllingDriver == NULL || !fPowerStates)
- return IOPMNotYetInitialized;
+ if (!fControllingDriver || !fNumberOfPowerStates)
+ return kIOReturnNotReady;
- child = (IOService *) whichChild->getChildEntry(gIOPowerPlane);
+ child = (IOService *) childConnection->getChildEntry(gIOPowerPlane);
assert(child);
- switch (specification) {
- case IOPMLowestState:
- i = 0;
- while ( i < fNumberOfPowerStates )
- {
- if ( ( fPowerStates[i].outputPowerCharacter & theDesiredState) ==
- (theDesiredState & fOutputPowerCharacterFlags) )
- {
- break;
- }
- i++;
- }
- if ( i >= fNumberOfPowerStates )
- {
- return IOPMNoSuchState;
- }
- break;
+ preventIdle = ((childRequestPowerFlags & kIOPMPreventIdleSleep) != 0);
+ preventSleep = ((childRequestPowerFlags & kIOPMPreventSystemSleep) != 0);
+ childRequestPowerFlags &= ~(kIOPMPreventIdleSleep | kIOPMPreventSystemSleep);
- case IOPMNextLowerState:
- i = fCurrentPowerState - 1;
- while ( (int) i >= 0 )
- {
- if ( ( fPowerStates[i].outputPowerCharacter & theDesiredState) ==
- (theDesiredState & fOutputPowerCharacterFlags) )
- {
- break;
- }
- i--;
- }
- if ( (int) i < 0 )
- {
- return IOPMNoSuchState;
- }
- break;
+ // Merge in the power flags contributed by this power parent
+ // at its current or impending power state.
- case IOPMHighestState:
- i = fNumberOfPowerStates;
- while ( (int) i >= 0 )
- {
- i--;
- if ( ( fPowerStates[i].outputPowerCharacter & theDesiredState) ==
- (theDesiredState & fOutputPowerCharacterFlags) )
- {
- break;
- }
- }
- if ( (int) i < 0 )
- {
- return IOPMNoSuchState;
- }
- break;
+ 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
+ // from the following states:
+ // - kIOPM_OurChangeTellClientsPowerDown
+ // - kIOPM_OurChangeTellPriorityClientsPowerDown
+ //
+ // The child must not wait for this parent to raise power
+ // if the power drop was cancelled. The solution is to cancel
+ // 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 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
+ PM_LOG1("%s: power drop cancelled in state %u by %s\n",
+ getName(), fMachineState, child->getName());
+ }
+ else
+ {
+ // Beyond cancellation point, report the impending state.
+ outputPowerFlags =
+ fPowerStates[fHeadNotePowerState].outputPowerFlags;
+ }
+ }
+ 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
+ // setParentInfo() has already recorded the output power flags
+ // 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;
- case IOPMNextHigherState:
- i = fCurrentPowerState + 1;
- while ( i < fNumberOfPowerStates )
- {
- if ( ( fPowerStates[i].outputPowerCharacter & theDesiredState) ==
- (theDesiredState & fOutputPowerCharacterFlags) )
- {
- break;
- }
- i++;
- }
- if ( i == fNumberOfPowerStates )
- {
- return IOPMNoSuchState;
- }
- break;
+ // Map child's requested power flags to one of our power state.
- default:
- return IOPMBadSpecification;
+ for (ps = 0; ps < fNumberOfPowerStates; ps++)
+ {
+ if ((fPowerStates[ps].outputPowerFlags & childRequestPowerFlags) ==
+ (fOutputPowerCharacterFlags & childRequestPowerFlags))
+ break;
+ }
+ if (ps >= fNumberOfPowerStates)
+ {
+ ps = 0; // should never happen
}
- computedState = i;
+ // 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.
- // Clamp removed on the initial power request from a new child.
+ if (!childConnection->childHasRequestedPower() ||
+ (ps != childConnection->getDesiredDomainState()) ||
+ (childConnection->getPreventIdleSleepFlag() != preventIdle) ||
+ (childConnection->getPreventSystemSleepFlag() != preventSleep))
+ adjustPower = true;
- if (fClampOn && !whichChild->childHasRequestedPower())
- {
- PM_TRACE("[%s] %p power clamp removed (child = %p)\n",
- getName(), this, whichChild);
- fClampOn = false;
- fDeviceDesire = 0;
- }
+#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);
+ }
+#endif
// Record the child's desires on the connection.
#if SUPPORT_IDLE_CANCEL
- bool attemptCancel = ((kIOPMPreventIdleSleep & desiredState) && !whichChild->getPreventIdleSleepFlag());
+ bool attemptCancel = (preventIdle && !childConnection->getPreventIdleSleepFlag());
#endif
- whichChild->setDesiredDomainState( computedState );
- whichChild->setPreventIdleSleepFlag( desiredState & kIOPMPreventIdleSleep );
- whichChild->setPreventSystemSleepFlag( desiredState & kIOPMPreventSystemSleep );
- whichChild->setChildHasRequestedPower();
-
- if (whichChild->getReadyFlag() == false)
- return IOPMNoErr;
+ childConnection->setChildHasRequestedPower();
+ childConnection->setDesiredDomainState( ps );
+ childConnection->setPreventIdleSleepFlag( preventIdle );
+ childConnection->setPreventSystemSleepFlag( preventSleep );
- // Issue a ping for us to re-evaluate all children desires and
- // possibly change power state.
+ // 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 (!fWillAdjustPowerState && !fDeviceOverrides)
- {
- childRequest = acquirePMRequest( this, kIOPMRequestTypeAdjustPowerState );
- if (childRequest)
+ if (adjustPower && !fDeviceOverrideEnabled &&
+ (!fAdjustPowerScheduled || gIOPMRequest->getRootRequest()))
+ {
+ subRequest = acquirePMRequest(
+ this, kIOPMRequestTypeAdjustPowerState, gIOPMRequest );
+ if (subRequest)
{
- submitPMRequest( childRequest );
- fWillAdjustPowerState = true;
+ submitPMRequest( subRequest );
+ fAdjustPowerScheduled = true;
}
- }
+ }
+
#if SUPPORT_IDLE_CANCEL
if (attemptCancel)
{
- childRequest = acquirePMRequest( this, kIOPMRequestTypeIdleCancel );
- if (childRequest)
+ subRequest = acquirePMRequest( this, kIOPMRequestTypeIdleCancel );
+ if (subRequest)
{
- submitPMRequest( childRequest );
+ submitPMRequest( subRequest );
}
}
#endif
- return IOPMNoErr;
+ return kIOReturnSuccess;
}
//*********************************************************************************
-// [public virtual] temporaryPowerClampOn
+// [public] temporaryPowerClampOn
//
// A power domain wants to clamp its power on till it has children which
// will thendetermine the power domain state.
IOReturn IOService::temporaryPowerClampOn ( void )
{
- IOPMRequest * request;
-
- if (!initialized)
- return IOPMNotYetInitialized;
-
- request = acquirePMRequest( this, kIOPMRequestTypeTemporaryPowerClamp );
- if (!request)
- return kIOReturnNoMemory;
-
- submitPMRequest( request );
- return IOPMNoErr;
+ return requestPowerState( gIOPMPowerClientChildProxy, kIOPMPowerStateMax );
}
//*********************************************************************************
-// [public virtual] makeUsable
+// [public] makeUsable
//
// Some client of our device is asking that we become usable. Although
// this has not come from a subclassed device object, treat it exactly
IOReturn IOService::makeUsable ( void )
{
- IOPMRequest * request;
-
- if (!initialized)
- return IOPMNotYetInitialized;
-
OUR_PMLog(kPMLogMakeUsable, 0, 0);
+ return requestPowerState( gIOPMPowerClientDevice, kIOPMPowerStateMax );
+}
- request = acquirePMRequest( this, kIOPMRequestTypeMakeUsable );
- if (!request)
- return kIOReturnNoMemory;
+//*********************************************************************************
+// [public] currentCapability
+//*********************************************************************************
- submitPMRequest( request );
- return IOPMNoErr;
+IOPMPowerFlags IOService::currentCapability ( void )
+{
+ if (!initialized)
+ return IOPMNotPowerManaged;
+
+ return fCurrentCapabilityFlags;
}
//*********************************************************************************
-// [private] handleMakeUsable
+// [public] changePowerStateTo
//
-// Handle a request to become usable.
+// Called by our power-controlling driver to change power state. The new desired
+// power state is computed and compared against the current power state. If those
+// power states differ, then a power state change is initiated.
//*********************************************************************************
-void IOService::handleMakeUsable ( IOPMRequest * request )
+IOReturn IOService::changePowerStateTo ( unsigned long ordinal )
{
- PM_ASSERT_IN_GATE();
- if ( fControllingDriver )
- {
- fDeviceDesire = fNumberOfPowerStates - 1;
- computeDesiredState();
- if ( inPlane(gIOPowerPlane) && fParentsKnowState )
- {
- changeState();
- }
- }
- else
- {
- fNeedToBecomeUsable = true;
- }
+ OUR_PMLog(kPMLogChangeStateTo, ordinal, 0);
+ return requestPowerState( gIOPMPowerClientDriver, ordinal );
}
//*********************************************************************************
-// [public virtual] currentCapability
+// [protected] changePowerStateToPriv
+//
+// 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
+// power states differ, then a power state change is initiated.
//*********************************************************************************
-IOPMPowerFlags IOService::currentCapability ( void )
+IOReturn IOService::changePowerStateToPriv ( unsigned long ordinal )
{
- if (!initialized)
- return IOPMNotPowerManaged;
-
- return fCurrentCapabilityFlags;
+ OUR_PMLog(kPMLogChangeStateToPriv, ordinal, 0);
+ return requestPowerState( gIOPMPowerClientDevice, ordinal );
}
//*********************************************************************************
-// [public virtual] changePowerStateTo
+// [protected] changePowerStateWithOverrideTo
//
-// For some reason, our power-controlling driver has decided it needs to change
-// power state. We enqueue the power change so that appropriate parties
-// will be notified, and then we will instruct the driver to make the change.
+// 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
+// power states differ, then a power state change is initiated.
+// Override enforced - Children and Driver desires are ignored.
//*********************************************************************************
-IOReturn IOService::changePowerStateTo ( unsigned long ordinal )
+IOReturn IOService::changePowerStateWithOverrideTo ( unsigned long ordinal )
{
IOPMRequest * request;
if (!initialized)
- return IOPMNotYetInitialized;
+ return kIOPMNotYetInitialized;
- OUR_PMLog(kPMLogChangeStateTo, ordinal, 0);
+ OUR_PMLog(kPMLogChangeStateToPriv, ordinal, 0);
- request = acquirePMRequest( this, kIOPMRequestTypeChangePowerStateTo );
+ request = acquirePMRequest( this, kIOPMRequestTypeRequestPowerStateOverride );
if (!request)
return kIOReturnNoMemory;
- request->fArg0 = (void *) ordinal;
- request->fArg1 = (void *) false;
+ gIOPMPowerClientDevice->retain();
+ request->fArg0 = (void *) ordinal;
+ request->fArg1 = (void *) gIOPMPowerClientDevice;
+ request->fArg2 = 0;
+#if NOT_READY
+ if (action)
+ request->installCompletionAction( action, target, param );
+#endif
- // Avoid needless downwards power transitions by clamping power in
- // computeDesiredState() until the delayed request is processed.
+ // Prevent needless downwards power transitions by clamping power
+ // until the scheduled request is executed.
- if (gIOPMWorkLoop->inGate())
+ if (gIOPMWorkLoop->inGate() && (ordinal < fNumberOfPowerStates))
{
fTempClampPowerState = max(fTempClampPowerState, ordinal);
fTempClampCount++;
- request->fArg1 = (void *) true;
+ fOverrideMaxPowerState = ordinal;
+ request->fArg2 = (void *) (uintptr_t) true;
+ }
+
+ submitPMRequest( request );
+ return IOPMNoErr;
+}
+
+//*********************************************************************************
+// [private] requestPowerState
+//*********************************************************************************
+
+IOReturn IOService::requestPowerState (
+ const OSSymbol * client,
+ uint32_t state )
+{
+ IOPMRequest * request;
+
+ if (!client)
+ return kIOReturnBadArgument;
+ if (!initialized)
+ return kIOPMNotYetInitialized;
+
+ request = acquirePMRequest( this, kIOPMRequestTypeRequestPowerState );
+ if (!request)
+ return kIOReturnNoMemory;
+
+ client->retain();
+ request->fArg0 = (void *) state;
+ request->fArg1 = (void *) client;
+ request->fArg2 = 0;
+#if NOT_READY
+ 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);
+ fTempClampCount++;
+ request->fArg2 = (void *) (uintptr_t) true;
}
submitPMRequest( request );
}
//*********************************************************************************
-// [private] handleChangePowerStateTo
+// [private] handleRequestPowerState
//*********************************************************************************
-void IOService::handleChangePowerStateTo ( IOPMRequest * request )
+void IOService::handleRequestPowerState ( IOPMRequest * request )
{
- unsigned long ordinal = (unsigned long) request->fArg0;
+ const OSSymbol * client = (const OSSymbol *) request->fArg1;
+ uint32_t state = (uint32_t)(uintptr_t) request->fArg0;
PM_ASSERT_IN_GATE();
- if (request->fArg1)
+ if (request->fArg2)
{
assert(fTempClampCount != 0);
- if (fTempClampCount)
- fTempClampCount--;
- if (!fTempClampCount)
- fTempClampPowerState = 0;
+ if (fTempClampCount) fTempClampCount--;
+ if (!fTempClampCount) fTempClampPowerState = 0;
}
- if ( fControllingDriver && (ordinal < fNumberOfPowerStates))
+ if (fNumberOfPowerStates && (state >= fNumberOfPowerStates))
+ state = fNumberOfPowerStates - 1;
+
+ // The power suppression due to changePowerStateWithOverrideTo() expires
+ // upon the next "device" power request - changePowerStateToPriv().
+
+ if ((getPMRequestType() != kIOPMRequestTypeRequestPowerStateOverride) &&
+ (client == gIOPMPowerClientDevice))
+ fOverrideMaxPowerState = kIOPMPowerStateMax;
+
+ if ((state == 0) &&
+ (client != gIOPMPowerClientDevice) &&
+ (client != gIOPMPowerClientDriver) &&
+ (client != gIOPMPowerClientChildProxy))
+ removePowerClient(client);
+ else
+ updatePowerClient(client, state);
+
+ adjustPowerState();
+ client->release();
+}
+
+//*********************************************************************************
+// [private] Helper functions to update/remove power clients.
+//*********************************************************************************
+
+void IOService::updatePowerClient( const OSSymbol * client, uint32_t powerState )
+{
+ if (!fPowerClients)
+ fPowerClients = OSDictionary::withCapacity(4);
+ if (fPowerClients && client)
{
- fDriverDesire = ordinal;
- computeDesiredState();
- if ( inPlane(gIOPowerPlane) && fParentsKnowState )
- {
- changeState();
- }
- }
+ 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();
+ }
+ }
+ }
+}
+
+void IOService::removePowerClient( const OSSymbol * client )
+{
+ if (fPowerClients && client)
+ fPowerClients->removeObject(client);
+}
+
+uint32_t IOService::getPowerStateForClient( const OSSymbol * client )
+{
+ uint32_t powerState = 0;
+
+ if (fPowerClients && client)
+ {
+ OSNumber * num = (OSNumber *) fPowerClients->getObject(client);
+ if (num) powerState = num->unsigned32BitValue();
+ }
+ return powerState;
}
//*********************************************************************************
-// [public virtual] changePowerStateToPriv
-//
-// For some reason, a subclassed device object has decided it needs to change
-// power state. We enqueue the power change so that appropriate parties
-// will be notified, and then we will instruct the driver to make the change.
+// [protected] powerOverrideOnPriv
//*********************************************************************************
-IOReturn IOService::changePowerStateToPriv ( unsigned long ordinal )
+IOReturn IOService::powerOverrideOnPriv ( void )
{
IOPMRequest * request;
- if (!initialized)
+ if (!initialized)
return IOPMNotYetInitialized;
- request = acquirePMRequest( this, kIOPMRequestTypeChangePowerStateToPriv );
+ if (gIOPMWorkLoop->inGate())
+ {
+ fDeviceOverrideEnabled = true;
+ return IOPMNoErr;
+ }
+
+ request = acquirePMRequest( this, kIOPMRequestTypePowerOverrideOnPriv );
if (!request)
return kIOReturnNoMemory;
- request->fArg0 = (void *) ordinal;
- request->fArg1 = (void *) false;
+ submitPMRequest( request );
+ return IOPMNoErr;
+}
+
+//*********************************************************************************
+// [protected] powerOverrideOffPriv
+//*********************************************************************************
+
+IOReturn IOService::powerOverrideOffPriv ( void )
+{
+ IOPMRequest * request;
- // Avoid needless downwards power transitions by clamping power in
- // computeDesiredState() until the delayed request is processed.
+ if (!initialized)
+ return IOPMNotYetInitialized;
if (gIOPMWorkLoop->inGate())
{
- fTempClampPowerState = max(fTempClampPowerState, ordinal);
- fTempClampCount++;
- request->fArg1 = (void *) true;
+ fDeviceOverrideEnabled = false;
+ return IOPMNoErr;
}
+ request = acquirePMRequest( this, kIOPMRequestTypePowerOverrideOffPriv );
+ if (!request)
+ return kIOReturnNoMemory;
+
submitPMRequest( request );
return IOPMNoErr;
}
//*********************************************************************************
-// [private] handleChangePowerStateToPriv
+// [private] handlePowerOverrideChanged
//*********************************************************************************
-void IOService::handleChangePowerStateToPriv ( IOPMRequest * request )
+void IOService::handlePowerOverrideChanged ( IOPMRequest * request )
{
- unsigned long ordinal = (unsigned long) request->fArg0;
-
PM_ASSERT_IN_GATE();
- OUR_PMLog(kPMLogChangeStateToPriv, ordinal, 0);
- if (request->fArg1)
+ if (request->getType() == kIOPMRequestTypePowerOverrideOnPriv)
{
- assert(fTempClampCount != 0);
- if (fTempClampCount)
- fTempClampCount--;
- if (!fTempClampCount)
- fTempClampPowerState = 0;
- }
-
- if ( fControllingDriver && (ordinal < fNumberOfPowerStates))
+ OUR_PMLog(kPMLogOverrideOn, 0, 0);
+ fDeviceOverrideEnabled = true;
+ }
+ else
{
- fDeviceDesire = ordinal;
- computeDesiredState();
- if ( inPlane(gIOPowerPlane) && fParentsKnowState )
- {
- changeState();
- }
+ OUR_PMLog(kPMLogOverrideOff, 0, 0);
+ fDeviceOverrideEnabled = false;
}
+
+ adjustPowerState();
}
//*********************************************************************************
// [private] computeDesiredState
//*********************************************************************************
-void IOService::computeDesiredState ( unsigned long tempDesire )
+void IOService::computeDesiredState ( unsigned long localClamp )
{
OSIterator * iter;
OSObject * next;
IOPowerConnection * connection;
- unsigned long newDesiredState = 0;
- unsigned long childDesire = 0;
- unsigned long deviceDesire;
-
- if (tempDesire)
- deviceDesire = tempDesire;
- else
- deviceDesire = fDeviceDesire;
+ uint32_t desiredState = 0;
+ uint32_t newPowerState = 0;
+ bool hasChildren = false;
- // If clamp is on, always override deviceDesire to max.
+ // Desired power state is always 0 without a controlling driver.
- if (fClampOn && fNumberOfPowerStates)
- deviceDesire = fNumberOfPowerStates - 1;
+ if (!fNumberOfPowerStates)
+ {
+ fDesiredPowerState = 0;
+ //PM_LOG("%s::%s no controlling driver\n", getName(), __FUNCTION__);
+ return;
+ }
- // Compute the maximum of our children's desires,
- // our controlling driver's desire, and the subclass device's desire.
+ // Examine the children's desired power state.
- if ( !fDeviceOverrides )
+ iter = getChildIterator(gIOPowerPlane);
+ if (iter)
{
- iter = getChildIterator(gIOPowerPlane);
- if ( iter )
+ while ((next = iter->getNextObject()))
{
- while ( (next = iter->getNextObject()) )
+ if ((connection = OSDynamicCast(IOPowerConnection, next)))
{
- if ( (connection = OSDynamicCast(IOPowerConnection, next)) )
+ if (connection->getReadyFlag() == false)
{
- if (connection->getReadyFlag() == false)
- {
- PM_CONNECT("[%s] %s: connection not ready\n",
- getName(), __FUNCTION__);
- continue;
- }
-
- if (connection->getDesiredDomainState() > childDesire)
- childDesire = connection->getDesiredDomainState();
+ 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();
}
+ iter->release();
+ }
+ if (hasChildren)
+ updatePowerClient(gIOPMPowerClientChildren, desiredState);
+ else
+ removePowerClient(gIOPMPowerClientChildren);
+
+ // Iterate through all power clients to determine the min power state.
- fChildrenDesire = childDesire;
- newDesiredState = max(childDesire, fDriverDesire);
+ 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;
+
+ // Ignore child proxy when children are present.
+ if (hasChildren && (client == gIOPMPowerClientChildProxy))
+ continue;
+
+ desiredState = getPowerStateForClient(client);
+ assert(desiredState < fNumberOfPowerStates);
+ PM_LOG1(" %u %s\n",
+ desiredState, client->getCStringNoCopy());
+
+ newPowerState = max(newPowerState, desiredState);
+
+ if (client == gIOPMPowerClientDevice)
+ fDeviceDesire = desiredState;
+ }
+ iter->release();
}
- newDesiredState = max(deviceDesire, newDesiredState);
- if (fTempClampCount && (fTempClampPowerState < fNumberOfPowerStates))
- newDesiredState = max(fTempClampPowerState, newDesiredState);
+ // Factor in the temporary power desires.
+
+ newPowerState = max(newPowerState, localClamp);
+ newPowerState = max(newPowerState, fTempClampPowerState);
+
+ // Limit check against max power override.
+
+ newPowerState = min(newPowerState, fOverrideMaxPowerState);
- fDesiredPowerState = newDesiredState;
-
// Limit check against number of power states.
- if (fNumberOfPowerStates == 0)
- fDesiredPowerState = 0;
- else if (fDesiredPowerState >= fNumberOfPowerStates)
- fDesiredPowerState = fNumberOfPowerStates - 1;
+ if (newPowerState >= fNumberOfPowerStates)
+ newPowerState = fNumberOfPowerStates - 1;
+
+ fDesiredPowerState = newPowerState;
- // Restart idle timer if stopped and deviceDesire 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 && fActivityTimerStopped)
+ // Restart idle timer if stopped and device desire has increased.
+
+ if (fDeviceDesire && fIdleTimerStopped)
{
- fActivityTimerStopped = false;
+ fIdleTimerStopped = false;
+ fActivityTickleCount = 0;
+ clock_get_uptime(&fIdleTimerStartTime);
start_PM_idle_timer();
}
// of servicing more activity tickles rather than dropping one when
// the device is in a low power state.
- if (fPMRequest && (fPMRequest->getType() != kIOPMRequestTypeActivityTickle) &&
+ if ((getPMRequestType() != kIOPMRequestTypeActivityTickle) &&
(fActivityTicklePowerState != -1))
{
IOLockLock(fActivityLock);
fActivityTicklePowerState = -1;
IOLockUnlock(fActivityLock);
}
-
- PM_TRACE(" NewState %ld, Child %ld, Driver %ld, Device %ld, Clamp %d (%ld)\n",
- fDesiredPowerState, childDesire, fDriverDesire, deviceDesire,
- fClampOn, fTempClampCount ? fTempClampPowerState : 0);
-}
-
-//*********************************************************************************
-// [private] changeState
-//
-// A subclass object, our controlling driver, or a power domain child
-// has asked for a different power state. Here we compute what new
-// state we should enter and enqueue the change (or start it).
-//*********************************************************************************
-
-IOReturn IOService::changeState ( void )
-{
- IOReturn result;
-
- PM_ASSERT_IN_GATE();
- assert(inPlane(gIOPowerPlane));
- assert(fParentsKnowState);
- assert(fControllingDriver);
-
- result = enqueuePowerChange(
- /* flags */ IOPMWeInitiated,
- /* power state */ fDesiredPowerState,
- /* domain state */ 0,
- /* connection */ 0,
- /* parent state */ 0);
-
- return result;
}
//*********************************************************************************
-// [public virtual] currentPowerConsumption
+// [public] currentPowerConsumption
//
//*********************************************************************************
}
//*********************************************************************************
-// [public virtual] getPMworkloop
+// [deprecated] getPMworkloop
//*********************************************************************************
IOWorkLoop * IOService::getPMworkloop ( void )
return gIOPMWorkLoop;
}
+#if NOT_YET
+
//*********************************************************************************
-// [public virtual] activityTickle
-//
-// The tickle with parameter kIOPMSuperclassPolicy1 causes the activity
-// flag to be set, and the device state checked. If the device has been
-// powered down, it is powered up again.
+// Power Parent/Children Applier
+//*********************************************************************************
+
+static void
+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();
+ }
+}
+
+static void
+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();
+ }
+}
+
+#endif /* NOT_YET */
+
+// MARK: -
+// MARK: Activity Tickle & Idle Timer
+
+//*********************************************************************************
+// [public] activityTickle
+//
+// The tickle with parameter kIOPMSuperclassPolicy1 causes the activity
+// flag to be set, and the device state checked. If the device has been
+// powered down, it is powered up again.
// The tickle with parameter kIOPMSubclassPolicy is ignored here and
// should be intercepted by a subclass.
//*********************************************************************************
// Record device activity for the idle timer handler.
- fDeviceActive = true;
+ fDeviceWasActive = true;
+ fActivityTickleCount++;
clock_get_uptime(&fDeviceActiveTimestamp);
+ 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 (request)
{
request->fArg0 = (void *) stateNumber; // power state
- request->fArg1 = (void *) true; // power rise
+ request->fArg1 = (void *) (uintptr_t) true; // power rise
submitPMRequest(request);
}
}
}
//*********************************************************************************
-// [public virtual] setIdleTimerPeriod
-//
-// A subclass policy-maker is going to use our standard idleness
-// detection service. Make a command queue and an idle timer and
-// connect them to the power management workloop. Finally,
-// start the timer.
+// [private] handleActivityTickle
//*********************************************************************************
-IOReturn IOService::setIdleTimerPeriod ( unsigned long period )
+void IOService::handleActivityTickle ( IOPMRequest * request )
{
- IOWorkLoop * wl = getPMworkloop();
+ uint32_t ticklePowerState = (uint32_t)(uintptr_t) request->fArg0;
+ bool adjustPower = false;
- if (!initialized || !wl)
- return IOPMNotYetInitialized;
+ PM_ASSERT_IN_GATE();
+ if (request->fArg1)
+ {
+ // Power rise from activity tickle.
+ if ((ticklePowerState > fDeviceDesire) &&
+ (ticklePowerState < fNumberOfPowerStates))
+ {
+ fIdleTimerMinPowerState = ticklePowerState;
+ 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;
+ }
- OUR_PMLog(PMsetIdleTimerPeriod, period, 0);
+ if (adjustPower)
+ {
+ updatePowerClient(gIOPMPowerClientDevice, ticklePowerState);
+ adjustPowerState();
+ }
+}
- fIdleTimerPeriod = period;
+//******************************************************************************
+// [public] setIdleTimerPeriod
+//
+// A subclass policy-maker is using our standard idleness detection service.
+// Start the idle timer. Period is in seconds.
+//******************************************************************************
- if ( period > 0 )
- {
- // make the timer event
- if ( fIdleTimerEventSource == NULL )
- {
- IOTimerEventSource * timerSrc;
+IOReturn IOService::setIdleTimerPeriod ( unsigned long period )
+{
+ if (!initialized)
+ return IOPMNotYetInitialized;
- timerSrc = IOTimerEventSource::timerEventSource(
- this, PM_idle_timer_expired);
-
- if (timerSrc && (wl->addEventSource(timerSrc) != kIOReturnSuccess))
- {
- timerSrc->release();
- timerSrc = 0;
- }
+ OUR_PMLog(kPMLogSetIdleTimerPeriod, period, fIdleTimerPeriod);
- fIdleTimerEventSource = timerSrc;
- }
+ IOPMRequest * request =
+ acquirePMRequest( this, kIOPMRequestTypeSetIdleTimerPeriod );
+ if (!request)
+ return kIOReturnNoMemory;
- start_PM_idle_timer();
- }
- return IOPMNoErr;
+ request->fArg0 = (void *) period;
+ submitPMRequest( request );
+
+ return kIOReturnSuccess;
}
//******************************************************************************
-// [public virtual] nextIdleTimeout
+// [public] nextIdleTimeout
//
// Returns how many "seconds from now" the device should idle into its
// next lowest power state.
AbsoluteTime lastActivity,
unsigned int powerState)
{
- AbsoluteTime delta;
- UInt64 delta_ns;
- SInt32 delta_secs;
- SInt32 delay_secs;
+ AbsoluteTime delta;
+ UInt64 delta_ns;
+ SInt32 delta_secs;
+ SInt32 delay_secs;
// Calculate time difference using funky macro from clock.h.
delta = currentTime;
delta_secs = (SInt32)(delta_ns / NSEC_PER_SEC);
// Be paranoid about delta somehow exceeding timer period.
- if (delta_secs < (int) fIdleTimerPeriod )
+ if (delta_secs < (int) fIdleTimerPeriod)
delay_secs = (int) fIdleTimerPeriod - delta_secs;
else
delay_secs = (int) fIdleTimerPeriod;
return (SInt32)delay_secs;
}
-//******************************************************************************
-// [public virtual] start_PM_idle_timer
-//
-// The parameter is a pointer to us. Use it to call our timeout method.
-//******************************************************************************
+//*********************************************************************************
+// [public] start_PM_idle_timer
+//*********************************************************************************
void IOService::start_PM_idle_timer ( void )
{
- static const int maxTimeout = 100000;
- static const int minTimeout = 1;
- AbsoluteTime uptime;
- 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 || !fIdleTimerEventSource)
+ if (!initialized || !fIdleTimerPeriod)
return;
IOLockLock(fActivityLock);
clock_get_uptime(&uptime);
-
+
// Subclasses may modify idle sleep algorithm
idle_in = nextIdleTimeout(uptime, fDeviceActiveTimestamp, fCurrentPowerState);
IOLockUnlock(fActivityLock);
- fIdleTimerEventSource->setTimeout(idle_in, NSEC_PER_SEC);
+ retain();
+ clock_interval_to_absolutetime_interval(idle_in, kSecondScale, &deadline);
+ ADD_ABSOLUTETIME(&deadline, &uptime);
+ pending = thread_call_enter_delayed(fIdleTimer, deadline);
+ if (pending) release();
}
//*********************************************************************************
-// [private] PM_idle_timer_expired
-//
-// The parameter is a pointer to us. Use it to call our timeout method.
+// idle_timer_expired
//*********************************************************************************
-void PM_idle_timer_expired ( OSObject * ourSelves, IOTimerEventSource * )
+static void
+idle_timer_expired (
+ thread_call_param_t arg0, thread_call_param_t arg1 )
{
- ((IOService *)ourSelves)->PM_idle_timer_expiration();
+ IOService * me = (IOService *) arg0;
+
+ if (gIOPMWorkLoop)
+ gIOPMWorkLoop->runAction(
+ OSMemberFunctionCast(IOWorkLoop::Action, me,
+ &IOService::idleTimerExpired),
+ me);
+
+ me->release();
}
//*********************************************************************************
-// [public virtual] PM_idle_timer_expiration
+// [private] idleTimerExpired
//
-// The idle timer has expired. If there has been activity since the last
+// The idle timer has expired. If there has been activity since the last
// expiration, just restart the timer and return. If there has not been
// activity, switch to the next lower power state and restart the timer.
//*********************************************************************************
-void IOService::PM_idle_timer_expiration ( void )
+void IOService::idleTimerExpired( void )
{
IOPMRequest * request;
bool restartTimer = true;
- if ( !initialized || !fIdleTimerPeriod )
+ if ( !initialized || !fIdleTimerPeriod || fLockedFlags.PMStop )
return;
IOLockLock(fActivityLock);
// Check for device activity (tickles) over last timer period.
- if (fDeviceActive)
+ if (fDeviceWasActive)
{
// Device was active - do not drop power, restart timer.
- fDeviceActive = false;
+ fDeviceWasActive = false;
}
else
{
if (request)
{
request->fArg0 = (void *) 0; // power state (irrelevant)
- request->fArg1 = (void *) false; // power drop
+ request->fArg1 = (void *) (uintptr_t) false; // power drop
submitPMRequest( request );
// Do not restart timer until after the tickle request has been
start_PM_idle_timer();
}
+#ifndef __LP64__
//*********************************************************************************
-// [public virtual] command_received
-//
+// [deprecated] PM_idle_timer_expiration
+//*********************************************************************************
+
+void IOService::PM_idle_timer_expiration ( void )
+{
+}
+
+//*********************************************************************************
+// [deprecated] command_received
//*********************************************************************************
void IOService::command_received ( void *statePtr , void *, void * , void * )
{
}
+#endif /* !__LP64__ */
//*********************************************************************************
-// [public virtual] setAggressiveness
+// [public] setAggressiveness
//
// Pass on the input parameters to all power domain children. All those which are
// power domains will pass it on to their children, etc.
IOReturn IOService::setAggressiveness ( unsigned long type, unsigned long newLevel )
{
- OSIterator * iter;
- OSObject * next;
- IOPowerConnection * connection;
- IOService * child;
-
- if (!initialized)
- return IOPMNotYetInitialized;
-
- if (getPMRootDomain() == this)
- OUR_PMLog(kPMLogSetAggressiveness, type, newLevel);
-
- if ( type <= kMaxType )
- {
- fAggressivenessValue[type] = newLevel;
- fAggressivenessValid[type] = true;
- }
-
- iter = getChildIterator(gIOPowerPlane);
- if ( iter )
- {
- while ( (next = iter->getNextObject()) )
- {
- if ( (connection = OSDynamicCast(IOPowerConnection, next)) )
- {
- if (connection->getReadyFlag() == false)
- {
- PM_CONNECT("[%s] %s: connection not ready\n",
- getName(), __FUNCTION__);
- continue;
- }
-
- child = ((IOService *)(connection->copyChildEntry(gIOPowerPlane)));
- if ( child )
- {
- child->setAggressiveness(type, newLevel);
- child->release();
- }
- }
- }
- iter->release();
- }
-
- return IOPMNoErr;
+ return kIOReturnSuccess;
}
//*********************************************************************************
-// [public virtual] getAggressiveness
+// [public] getAggressiveness
//
// Called by the user client.
//*********************************************************************************
IOReturn IOService::getAggressiveness ( unsigned long type, unsigned long * currentLevel )
{
- if ( !initialized || (type > kMaxType) )
- return kIOReturnBadArgument;
-
- if ( !fAggressivenessValid[type] )
- return kIOReturnInvalid;
-
- *currentLevel = fAggressivenessValue[type];
+ IOPMrootDomain * rootDomain = getPMRootDomain();
- return kIOReturnSuccess;
+ if (!rootDomain)
+ return kIOReturnNotReady;
+
+ return rootDomain->getAggressiveness( type, currentLevel );
}
//*********************************************************************************
return fCurrentPowerState;
}
+#ifndef __LP64__
//*********************************************************************************
-// [public virtual] systemWake
+// [deprecated] systemWake
//
// Pass this to all power domain children. All those which are
// power domains will pass it on to their children, etc.
IOPowerConnection * connection;
IOService * theChild;
- OUR_PMLog(kPMLogSystemWake, 0, 0);
-
iter = getChildIterator(gIOPowerPlane);
if ( iter )
{
{
if (connection->getReadyFlag() == false)
{
- PM_CONNECT("[%s] %s: connection not ready\n",
+ PM_LOG3("[%s] %s: connection not ready\n",
getName(), __FUNCTION__);
continue;
}
}
//*********************************************************************************
-// [public virtual] temperatureCriticalForZone
+// [deprecated] temperatureCriticalForZone
//*********************************************************************************
IOReturn IOService::temperatureCriticalForZone ( IOService * whichZone )
OUR_PMLog(kPMLogCriticalTemp, 0, 0);
- if ( inPlane(gIOPowerPlane) && !fWeAreRoot )
+ if ( inPlane(gIOPowerPlane) && !IS_PM_ROOT )
{
theNub = (IOService *)copyParentEntry(gIOPowerPlane);
if ( theNub )
}
return IOPMNoErr;
}
+#endif /* !__LP64__ */
-//*********************************************************************************
-// [public] powerOverrideOnPriv
-//*********************************************************************************
-
-IOReturn IOService::powerOverrideOnPriv ( void )
-{
- IOPMRequest * request;
-
- if (!initialized)
- return IOPMNotYetInitialized;
-
- if (gIOPMWorkLoop->inGate())
- {
- fDeviceOverrides = true;
- return IOPMNoErr;
- }
-
- request = acquirePMRequest( this, kIOPMRequestTypePowerOverrideOnPriv );
- if (!request)
- return kIOReturnNoMemory;
-
- submitPMRequest( request );
- return IOPMNoErr;
-}
-
-//*********************************************************************************
-// [public] powerOverrideOffPriv
-//*********************************************************************************
-
-IOReturn IOService::powerOverrideOffPriv ( void )
-{
- IOPMRequest * request;
-
- if (!initialized)
- return IOPMNotYetInitialized;
-
- if (gIOPMWorkLoop->inGate())
- {
- fDeviceOverrides = false;
- return IOPMNoErr;
- }
-
- request = acquirePMRequest( this, kIOPMRequestTypePowerOverrideOffPriv );
- if (!request)
- return kIOReturnNoMemory;
-
- submitPMRequest( request );
- return IOPMNoErr;
-}
-
-//*********************************************************************************
-// [private] handlePowerOverrideChanged
-//*********************************************************************************
-
-void IOService::handlePowerOverrideChanged ( IOPMRequest * request )
-{
- PM_ASSERT_IN_GATE();
- if (request->getType() == kIOPMRequestTypePowerOverrideOnPriv)
- {
- OUR_PMLog(kPMLogOverrideOn, 0, 0);
- fDeviceOverrides = true;
- }
- else
- {
- OUR_PMLog(kPMLogOverrideOff, 0, 0);
- fDeviceOverrides = false;
- }
-
- if (fControllingDriver && inPlane(gIOPowerPlane) && fParentsKnowState)
- {
- computeDesiredState();
- changeState();
- }
-}
+// MARK: -
+// MARK: Power Change (Common)
//*********************************************************************************
-// [private] enqueuePowerChange
+// [private] startPowerChange
+//
+// All power state changes starts here.
//*********************************************************************************
-IOReturn IOService::enqueuePowerChange (
- unsigned long flags,
- unsigned long whatStateOrdinal,
- unsigned long domainState,
- IOPowerConnection * whichParent,
- unsigned long singleParentState )
+IOReturn IOService::startPowerChange(
+ IOPMPowerChangeFlags changeFlags,
+ IOPMPowerStateIndex powerState,
+ IOPMPowerFlags domainFlags,
+ IOPowerConnection * parentConnection,
+ IOPMPowerFlags parentFlags )
{
- changeNoteItem changeNote;
- IOPMPowerState * powerStatePtr;
-
PM_ASSERT_IN_GATE();
assert( fMachineState == kIOPM_Finished );
- assert( whatStateOrdinal < fNumberOfPowerStates );
+ assert( powerState < fNumberOfPowerStates );
- if (whatStateOrdinal >= fNumberOfPowerStates)
+ if (powerState >= fNumberOfPowerStates)
return IOPMAckImplied;
- powerStatePtr = &fPowerStates[whatStateOrdinal];
+ fIsPreChange = true;
+ PM_ACTION_2(actionPowerChangeOverride, &powerState, &changeFlags);
- // Initialize the change note
- changeNote.flags = flags;
- changeNote.newStateNumber = whatStateOrdinal;
- changeNote.outputPowerCharacter = powerStatePtr->outputPowerCharacter;
- changeNote.inputPowerRequirement = powerStatePtr->inputPowerRequirement;
- changeNote.capabilityFlags = powerStatePtr->capabilityFlags;
- changeNote.parent = NULL;
+ // Forks to either Driver or Parent initiated power change paths.
- if (flags & IOPMParentInitiated )
- {
- changeNote.domainState = domainState;
- changeNote.parent = whichParent;
- changeNote.singleParentState = singleParentState;
- }
+ fHeadNoteChangeFlags = changeFlags;
+ fHeadNotePowerState = powerState;
+ fHeadNotePowerArrayEntry = &fPowerStates[ powerState ];
+ fHeadNoteParentConnection = NULL;
- if (flags & IOPMWeInitiated )
+ if (changeFlags & kIOPMSelfInitiated)
{
- start_our_change(&changeNote);
+ if (changeFlags & kIOPMSynchronize)
+ OurSyncStart();
+ else
+ OurChangeStart();
return 0;
}
else
{
- return start_parent_change(&changeNote);
+ assert(changeFlags & kIOPMParentInitiated);
+ fHeadNoteDomainFlags = domainFlags;
+ fHeadNoteParentFlags = parentFlags;
+ fHeadNoteParentConnection = parentConnection;
+ return ParentChangeStart();
}
}
bool IOService::notifyInterestedDrivers ( void )
{
- IOPMinformee * informee;
- IOPMinformeeList * list = fInterestedDrivers;
- DriverCallParam * param;
- IOItemCount count;
+ IOPMinformee * informee;
+ IOPMinformeeList * list = fInterestedDrivers;
+ DriverCallParam * param;
+ IOItemCount count;
- PM_ASSERT_IN_GATE();
- assert( fDriverCallBusy == false );
- assert( fDriverCallParamCount == 0 );
- assert( fHeadNotePendingAcks == 0 );
+ PM_ASSERT_IN_GATE();
+ assert( fDriverCallParamCount == 0 );
+ assert( fHeadNotePendingAcks == 0 );
- count = list->numberOfItems();
- if (!count)
- goto done; // no interested drivers
+ fHeadNotePendingAcks = 0;
- // 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.
+ count = list->numberOfItems();
+ if (!count)
+ goto done; // no interested drivers
- param = (DriverCallParam *) fDriverCallParamPtr;
- if (count > fDriverCallParamSlots)
- {
- if (fDriverCallParamSlots)
- {
- assert(fDriverCallParamPtr);
- IODelete(fDriverCallParamPtr, DriverCallParam, fDriverCallParamSlots);
- fDriverCallParamPtr = 0;
- fDriverCallParamSlots = 0;
- }
+ // 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 = IONew(DriverCallParam, count);
- if (!param)
- goto done; // no memory
+ param = (DriverCallParam *) fDriverCallParamPtr;
+ if (count > fDriverCallParamSlots)
+ {
+ if (fDriverCallParamSlots)
+ {
+ assert(fDriverCallParamPtr);
+ IODelete(fDriverCallParamPtr, DriverCallParam, fDriverCallParamSlots);
+ fDriverCallParamPtr = 0;
+ fDriverCallParamSlots = 0;
+ }
- fDriverCallParamPtr = (void *) param;
- fDriverCallParamSlots = count;
- }
+ param = IONew(DriverCallParam, count);
+ if (!param)
+ goto done; // no memory
- 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 );
- }
+ fDriverCallParamPtr = (void *) param;
+ fDriverCallParamSlots = count;
+ }
- fDriverCallParamCount = count;
- fHeadNotePendingAcks = 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 );
+ }
- // Machine state will be blocked pending callout thread completion.
+ fDriverCallParamCount = count;
+ fHeadNotePendingAcks = count;
- PM_LOCK();
- fDriverCallBusy = true;
- PM_UNLOCK();
- thread_call_enter( fDriverCallEntry );
- return true;
+ // Block state machine and wait for callout completion.
+ assert(!fDriverCallBusy);
+ fDriverCallBusy = true;
+ thread_call_enter( fDriverCallEntry );
+ return true;
done:
- // no interested drivers or did 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;
}
//*********************************************************************************
void IOService::notifyInterestedDriversDone ( void )
{
- IOPMinformee * informee;
- IOItemCount count;
- DriverCallParam * param;
- IOReturn result;
+ IOPMinformee * informee;
+ IOItemCount count;
+ DriverCallParam * param;
+ IOReturn result;
PM_ASSERT_IN_GATE();
- param = (DriverCallParam *) fDriverCallParamPtr;
- count = fDriverCallParamCount;
-
assert( fDriverCallBusy == false );
assert( fMachineState == kIOPM_DriverThreadCallDone );
+ param = (DriverCallParam *) fDriverCallParamPtr;
+ count = fDriverCallParamCount;
+
if (param && count)
{
for (IOItemCount i = 0; i < count; i++, param++)
if ((result == IOPMAckImplied) || (result < 0))
{
- // child return IOPMAckImplied
- informee->timer = 0;
- fHeadNotePendingAcks--;
+ // 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 (fHeadNotePendingAcks && informee->timer)
+ fHeadNotePendingAcks--;
+
+ informee->timer = 0;
}
else if (informee->timer)
{
}
}
- // Hop back to original machine state path (from notifyAll)
- fMachineState = fNextMachineState;
+ MS_POP(); // pushed by notifyAll()
- notifyChildren();
+ // 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.
+
+ if (!fHeadNotePendingAcks)
+ {
+ notifyChildren();
+ }
+ else
+ {
+ MS_PUSH(fMachineState);
+ fMachineState = kIOPM_NotifyChildrenStart;
+ PM_LOG2("%s: %u outstanding async interest\n",
+ getName(), fHeadNotePendingAcks);
+ }
}
//*********************************************************************************
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)
children = OSArray::withCapacity(8);
// Sum child power consumption in notifyChild()
- fPowerStates[fHeadNoteState].staticPower = 0;
+ fHeadNotePowerArrayEntry->staticPower = 0;
iter = getChildIterator(gIOPowerPlane);
if ( iter )
{
if (connection->getReadyFlag() == false)
{
- PM_CONNECT("[%s] %s: connection not ready\n",
+ PM_LOG3("[%s] %s: connection not ready\n",
getName(), __FUNCTION__);
continue;
}
- if (children)
- children->setObject( connection );
+ // 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
- notifyChild( connection,
- fDriverCallReason == kDriverCallInformPreChange );
+ notifyChild( connection );
}
}
iter->release();
}
+ if (children && (children->getCount() == 0))
+ {
+ children->release();
+ children = 0;
+ }
if (children)
{
- if (children->getCount() == 0)
- {
- children->release();
- children = 0;
- }
- else
- {
- assert(fNotifyChildArray == 0);
- fNotifyChildArray = children;
- fNextMachineState = fMachineState;
- fMachineState = kIOPM_NotifyChildrenDone;
- }
+ assert(fNotifyChildArray == 0);
+ fNotifyChildArray = children;
+ MS_PUSH(fMachineState);
+
+ 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;
+ }
}
}
//*********************************************************************************
-// [private] notifyChildrenDone
+// [private] notifyChildrenOrdered
//*********************************************************************************
-void IOService::notifyChildrenDone ( void )
+void IOService::notifyChildrenOrdered ( void )
{
PM_ASSERT_IN_GATE();
assert(fNotifyChildArray);
- assert(fMachineState == kIOPM_NotifyChildrenDone);
+ assert(fMachineState == kIOPM_NotifyChildrenOrdered);
- // Interested drivers have all acked (if any), ack timer stopped.
- // Notify one child, wait for it's ack, then repeat for next child.
+ // Notify one child, wait for it to ack, then repeat for next child.
// This is a workaround for some drivers with multiple instances at
// the same branch in the power tree, but the driver is slow to power
// up unless the tree ordering is observed. Problem observed only on
IOPowerConnection * connection;
connection = (IOPowerConnection *) fNotifyChildArray->getObject(0);
fNotifyChildArray->removeObject(0);
- notifyChild( connection, fDriverCallReason == kDriverCallInformPreChange );
+ notifyChild( connection );
}
else
{
fNotifyChildArray->release();
fNotifyChildArray = 0;
- fMachineState = fNextMachineState;
+
+ MS_POP(); // pushed by notifyChildren()
}
}
+//*********************************************************************************
+// [private] notifyChildrenDelayed
+//*********************************************************************************
+
+void IOService::notifyChildrenDelayed ( void )
+{
+ 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.
+
+ for (int i = 0; ; i++)
+ {
+ connection = (IOPowerConnection *) fNotifyChildArray->getObject(i);
+ if (!connection)
+ break;
+
+ notifyChild( connection );
+ }
+
+ PM_LOG2("%s: notified delayed children\n", getName());
+ fNotifyChildArray->release();
+ fNotifyChildArray = 0;
+
+ MS_POP(); // pushed by notifyChildren()
+}
+
//*********************************************************************************
// [private] notifyAll
//*********************************************************************************
-IOReturn IOService::notifyAll ( bool is_prechange )
+IOReturn IOService::notifyAll ( uint32_t nextMS )
{
// Save the next machine_state to be restored by notifyInterestedDriversDone()
PM_ASSERT_IN_GATE();
- fNextMachineState = fMachineState;
+ MS_PUSH(nextMS);
fMachineState = kIOPM_DriverThreadCallDone;
- fDriverCallReason = is_prechange ?
+ fDriverCallReason = fIsPreChange ?
kDriverCallInformPreChange : kDriverCallInformPostChange;
if (!notifyInterestedDrivers())
void * arg0, void * arg1,
void * arg2, void * arg3 )
{
- IOServicePM * pwrMgt = (IOServicePM *) arg0;
+ IOServicePM * pwrMgt = (IOServicePM *) arg0;
- PM_LOCK();
- fDriverCallBusy = false;
- PM_UNLOCK();
+ assert( fDriverCallBusy );
+ fDriverCallBusy = false;
- if (gIOPMReplyQueue)
- gIOPMReplyQueue->signalWorkAvailable();
+ assert(gIOPMWorkQueue);
+ gIOPMWorkQueue->signalWorkAvailable();
- return kIOReturnSuccess;
+ return kIOReturnSuccess;
}
void IOService::pmDriverCallout ( IOService * from )
break;
default:
- IOPanic("IOService::pmDriverCallout bad machine state");
+ panic("IOService::pmDriverCallout bad machine state %x",
+ from->fDriverCallReason);
}
gIOPMWorkLoop->runAction(actionDriverCalloutDone,
void IOService::driverSetPowerState ( void )
{
- IOService * driver;
- unsigned long powerState;
- DriverCallParam * param;
- IOReturn result;
+ IOPMPowerStateIndex powerState;
+ DriverCallParam * param;
+ IOPMDriverCallEntry callEntry;
AbsoluteTime end;
+ IOReturn result;
+ uint32_t oldPowerState = getPowerState();
- assert( fDriverCallBusy );
- param = (DriverCallParam *) fDriverCallParamPtr;
- assert( param );
- assert( fDriverCallParamCount == 1 );
+ assert( fDriverCallBusy );
+ assert( fDriverCallParamPtr );
+ assert( fDriverCallParamCount == 1 );
- driver = fControllingDriver;
- powerState = fHeadNoteState;
+ param = (DriverCallParam *) fDriverCallParamPtr;
+ powerState = fHeadNotePowerState;
- if (!fWillPMStop)
- {
- OUR_PMLog( kPMLogProgramHardware, (UInt32) this, powerState);
+ if (assertPMDriverCall(&callEntry))
+ {
+ OUR_PMLog( kPMLogProgramHardware, (uintptr_t) this, powerState);
clock_get_uptime(&fDriverCallStartTime);
- result = driver->setPowerState( powerState, this );
+ result = fControllingDriver->setPowerState( powerState, this );
clock_get_uptime(&end);
- OUR_PMLog((UInt32) -kPMLogProgramHardware, (UInt32) this, (UInt32) result);
+ 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))
SUB_ABSOLUTETIME(&end, &fDriverCallStartTime);
absolutetime_to_nanoseconds(end, &nsec);
if (nsec > LOG_SETPOWER_TIMES)
- PM_DEBUG("%s::setPowerState(%p, %lu -> %lu) took %d ms\n",
+ 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;
+ }
+ else
+ result = kIOPMAckImplied;
- param->Result = result;
+ param->Result = result;
}
//*********************************************************************************
void IOService::driverInformPowerChange ( void )
{
- IOItemCount count;
- IOPMinformee * informee;
- IOService * driver;
- IOReturn result;
- IOPMPowerFlags powerFlags;
- unsigned long powerState;
- DriverCallParam * param;
+ IOPMinformee * informee;
+ IOService * driver;
+ DriverCallParam * param;
+ IOPMDriverCallEntry callEntry;
+ IOPMPowerFlags powerFlags;
+ IOPMPowerStateIndex powerState;
AbsoluteTime end;
+ IOReturn result;
+ IOItemCount count;
- assert( fDriverCallBusy );
- param = (DriverCallParam *) fDriverCallParamPtr;
- count = fDriverCallParamCount;
- assert( count && param );
+ assert( fDriverCallBusy );
+ assert( fDriverCallParamPtr );
+ assert( fDriverCallParamCount );
- powerFlags = fHeadNoteCapabilityFlags;
- powerState = fHeadNoteState;
+ param = (DriverCallParam *) fDriverCallParamPtr;
+ count = fDriverCallParamCount;
- for (IOItemCount i = 0; i < count; i++)
- {
- informee = (IOPMinformee *) param->Target;
- driver = informee->whatObject;
+ powerFlags = fHeadNotePowerArrayEntry->capabilityFlags;
+ powerState = fHeadNotePowerState;
- if (!fWillPMStop && informee->active)
- {
- if (fDriverCallReason == kDriverCallInformPreChange)
- {
- OUR_PMLog(kPMLogInformDriverPreChange, (UInt32) this, powerState);
+ 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);
+ result = driver->powerStateWillChangeTo(powerFlags, powerState, this);
clock_get_uptime(&end);
- OUR_PMLog((UInt32)-kPMLogInformDriverPreChange, (UInt32) this, result);
- }
- else
- {
- OUR_PMLog(kPMLogInformDriverPostChange, (UInt32) this, powerState);
+ 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);
+ result = driver->powerStateDidChangeTo(powerFlags, powerState, this);
clock_get_uptime(&end);
- OUR_PMLog((UInt32)-kPMLogInformDriverPostChange, (UInt32) this, result);
- }
+ OUR_PMLog((UInt32)-kPMLogInformDriverPostChange, (uintptr_t) this, result);
+ }
+
+ deassertPMDriverCall(&callEntry);
#if LOG_SETPOWER_TIMES
if ((result == IOPMAckImplied) || (result < 0))
SUB_ABSOLUTETIME(&end, &informee->startTime);
absolutetime_to_nanoseconds(end, &nsec);
if (nsec > LOG_SETPOWER_TIMES)
- PM_DEBUG("%s::powerState%sChangeTo(%p, %s, %lu -> %lu) took %d ms\n",
+ 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;
+ }
+ else
+ result = kIOPMAckImplied;
- param->Result = result;
- param++;
- }
+ param->Result = result;
+ param++;
+ }
}
//*********************************************************************************
// If the object acknowledges the current change, we return TRUE.
//*********************************************************************************
-bool IOService::notifyChild ( IOPowerConnection * theNub, bool is_prechange )
+bool IOService::notifyChild ( IOPowerConnection * theNub )
{
- IOReturn k = IOPMAckImplied;
- unsigned long childPower;
- IOService * theChild;
- IOPMRequest * childRequest;
- int requestType;
+ IOReturn ret = IOPMAckImplied;
+ unsigned long childPower;
+ IOService * theChild;
+ IOPMRequest * childRequest;
+ IOPMPowerChangeFlags requestArg2;
+ int requestType;
PM_ASSERT_IN_GATE();
theChild = (IOService *)(theNub->copyChildEntry(gIOPowerPlane));
// kIOPMAckImplied, we'll be awaiting their acknowledgement later.
fHeadNotePendingAcks++;
theNub->setAwaitingAck(true);
-
- requestType = is_prechange ?
- kIOPMRequestTypePowerDomainWillChange :
- kIOPMRequestTypePowerDomainDidChange;
+
+ requestArg2 = fHeadNoteChangeFlags;
+ if (fHeadNotePowerState < fCurrentPowerState)
+ requestArg2 |= kIOPMDomainPowerDrop;
+
+ requestType = fIsPreChange ?
+ kIOPMRequestTypePowerDomainWillChange :
+ kIOPMRequestTypePowerDomainDidChange;
childRequest = acquirePMRequest( theChild, requestType );
if (childRequest)
{
theNub->retain();
- childRequest->fArg0 = (void *) fHeadNoteOutputFlags;
+ childRequest->fArg0 = (void *) fHeadNotePowerArrayEntry->outputPowerFlags;
childRequest->fArg1 = (void *) theNub;
- childRequest->fArg2 = (void *) (fHeadNoteState < fCurrentPowerState);
+ childRequest->fArg2 = (void *) requestArg2;
theChild->submitPMRequest( childRequest );
- k = IOPMWillAckLater;
+ ret = IOPMWillAckLater;
}
else
{
- k = IOPMAckImplied;
+ ret = IOPMAckImplied;
fHeadNotePendingAcks--;
theNub->setAwaitingAck(false);
childPower = theChild->currentPowerConsumption();
if ( childPower == kIOPMUnknown )
{
- fPowerStates[fHeadNoteState].staticPower = kIOPMUnknown;
+ fHeadNotePowerArrayEntry->staticPower = kIOPMUnknown;
} else {
- if ( fPowerStates[fHeadNoteState].staticPower != kIOPMUnknown )
- {
- fPowerStates[fHeadNoteState].staticPower += childPower;
- }
+ if (fHeadNotePowerArrayEntry->staticPower != kIOPMUnknown )
+ fHeadNotePowerArrayEntry->staticPower += childPower;
}
}
theChild->release();
- return (k == IOPMAckImplied);
+ return (IOPMAckImplied == ret);
}
//*********************************************************************************
-// [private] OurChangeTellClientsPowerDown
-//
-// All registered applications and kernel clients have positively acknowledged our
-// intention of lowering power. Here we notify them all that we will definitely
-// lower the power. If we don't have to wait for any of them to acknowledge, we
-// carry on by notifying interested drivers. Otherwise, we do wait.
+// [private] notifyControllingDriver
//*********************************************************************************
-void IOService::OurChangeTellClientsPowerDown ( void )
+bool IOService::notifyControllingDriver ( void )
{
- fMachineState = kIOPM_OurChangeTellPriorityClientsPowerDown;
- tellChangeDown1(fHeadNoteState);
-}
+ DriverCallParam * param;
-//*********************************************************************************
-// [private] OurChangeTellPriorityClientsPowerDown
-//
-// All registered applications and kernel clients have positively acknowledged our
-// intention of lowering power. Here we notify "priority" clients that we are
-// lowering power. If we don't have to wait for any of them to acknowledge, we
-// carry on by notifying interested drivers. Otherwise, we do wait.
-//*********************************************************************************
+ PM_ASSERT_IN_GATE();
+ assert( fDriverCallParamCount == 0 );
+ assert( fControllingDriver );
-void IOService::OurChangeTellPriorityClientsPowerDown ( void )
-{
- fMachineState = kIOPM_OurChangeNotifyInterestedDriversWillChange;
- tellChangeDown2(fHeadNoteState);
-}
+ if (fInitialSetPowerState)
+ {
+ // Driver specified flag to skip the inital setPowerState()
+ if (fHeadNotePowerArrayEntry->capabilityFlags & kIOPMInitialDeviceState)
+ {
+ return false;
+ }
+ fInitialSetPowerState = false;
+ }
-//*********************************************************************************
-// [private] OurChangeNotifyInterestedDriversWillChange
-//
-// All registered applications and kernel clients have acknowledged our notification
-// that we are lowering power. Here we notify interested drivers. If we don't have
-// to wait for any of them to acknowledge, we instruct our power driver to make the
-// change. Otherwise, we do wait.
-//*********************************************************************************
+ param = (DriverCallParam *) fDriverCallParamPtr;
+ if (!param)
+ {
+ param = IONew(DriverCallParam, 1);
+ if (!param)
+ return false; // no memory
-void IOService::OurChangeNotifyInterestedDriversWillChange ( void )
-{
- fMachineState = kIOPM_OurChangeSetPowerState;
- notifyAll( true );
-}
+ fDriverCallParamPtr = (void *) param;
+ fDriverCallParamSlots = 1;
+ }
-//*********************************************************************************
-// [private] OurChangeSetPowerState
-//
-// All interested drivers have acknowledged our pre-change notification of a power
-// change we initiated. Here we instruct our controlling driver to make
-// the change to the hardware. If it does so, we continue processing
-// (waiting for settle and notifying interested parties post-change.)
-// If it doesn't, we have to wait for it to acknowledge and then continue.
-//*********************************************************************************
+ param->Target = fControllingDriver;
+ fDriverCallParamCount = 1;
+ fDriverTimer = -1;
-void IOService::OurChangeSetPowerState ( void )
-{
- fNextMachineState = kIOPM_OurChangeWaitForPowerSettle;
- fMachineState = kIOPM_DriverThreadCallDone;
- fDriverCallReason = kDriverCallSetPowerState;
+ // Block state machine and wait for callout completion.
+ assert(!fDriverCallBusy);
+ fDriverCallBusy = true;
+ thread_call_enter( fDriverCallEntry );
- if (notifyControllingDriver() == false)
- notifyControllingDriverDone();
+ return true;
}
//*********************************************************************************
-// [private] OurChangeWaitForPowerSettle
-//
-// Our controlling driver has changed power state on the hardware
-// during a power change we initiated. Here we see if we need to wait
-// for power to settle before continuing. If not, we continue processing
-// (notifying interested parties post-change). If so, we wait and
-// continue later.
+// [private] notifyControllingDriverDone
//*********************************************************************************
-void IOService::OurChangeWaitForPowerSettle ( void )
+void IOService::notifyControllingDriverDone( void )
{
- fMachineState = kIOPM_OurChangeNotifyInterestedDriversDidChange;
- fSettleTimeUS = compute_settle_time();
- if ( fSettleTimeUS )
- {
- startSettleTimer(fSettleTimeUS);
- }
-}
-
-//*********************************************************************************
-// [private] OurChangeNotifyInterestedDriversDidChange
-//
-// Power has settled on a power change we initiated. Here we notify
-// all our interested parties post-change. If they all acknowledge, we're
-// done with this change note, and we can start on the next one.
-// Otherwise we have to wait for acknowledgements and finish up later.
-//*********************************************************************************
+ DriverCallParam * param;
+ IOReturn result;
-void IOService::OurChangeNotifyInterestedDriversDidChange ( void )
-{
- fMachineState = kIOPM_OurChangeFinish;
- notifyAll(false);
-}
+ PM_ASSERT_IN_GATE();
+ param = (DriverCallParam *) fDriverCallParamPtr;
-//*********************************************************************************
-// [private] OurChangeFinish
-//
-// Power has settled on a power change we initiated, and
-// all our interested parties have acknowledged. We're
-// done with this change note, and we can start on the next one.
-//*********************************************************************************
+ assert( fDriverCallBusy == false );
+ assert( fMachineState == kIOPM_DriverThreadCallDone );
-void IOService::OurChangeFinish ( void )
-{
- all_done();
-}
+ if (param && fDriverCallParamCount)
+ {
+ assert(fDriverCallParamCount == 1);
+
+ // the return value from setPowerState()
+ result = param->Result;
-//*********************************************************************************
-// [private] ParentDownTellPriorityClientsPowerDown
-//
-// All applications and kernel clients have been notified of a power lowering
-// initiated by the parent and we had to wait for responses. Here
-// we notify any priority clients. If they all ack, we continue with the power change.
-// If at least one doesn't, we have to wait for it to acknowledge and then continue.
-//*********************************************************************************
+ if ((result == IOPMAckImplied) || (result < 0))
+ {
+ fDriverTimer = 0;
+ }
+ else if (fDriverTimer)
+ {
+ assert(fDriverTimer == -1);
-void IOService::ParentDownTellPriorityClientsPowerDown ( void )
-{
- fMachineState = kIOPM_ParentDownNotifyInterestedDriversWillChange;
- tellChangeDown2(fHeadNoteState);
-}
+ // 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.
-//*********************************************************************************
-// [private] ParentDownNotifyInterestedDriversWillChange
-//
-// All applications and kernel clients have been notified of a power lowering
-// initiated by the parent and we had to wait for their responses. Here we notify
-// any interested drivers and power domain children. If they all ack, we continue
-// with the power change.
-// If at least one doesn't, we have to wait for it to acknowledge and then continue.
-//*********************************************************************************
+ if (result < kMinAckTimeoutTicks)
+ result = kMinAckTimeoutTicks;
-void IOService::ParentDownNotifyInterestedDriversWillChange ( void )
-{
- fMachineState = kIOPM_ParentDownSetPowerState;
- notifyAll( true );
-}
+ fDriverTimer = (result / (ACK_TIMER_PERIOD / ns_per_us)) + 1;
+ }
+ // else, child has already acked and driver_timer reset to 0.
-//*********************************************************************************
-// [private] ParentDownSetPowerState
-//
-// We had to wait for it, but all parties have acknowledged our pre-change
-// notification of a power lowering initiated by the parent.
-// Here we instruct our controlling driver
-// to put the hardware in the state it needs to be in when the domain is
-// lowered. If it does so, we continue processing
-// (waiting for settle and acknowledging the parent.)
-// If it doesn't, we have to wait for it to acknowledge and then continue.
-//*********************************************************************************
+ fDriverCallParamCount = 0;
-void IOService::ParentDownSetPowerState ( void )
-{
- fNextMachineState = kIOPM_ParentDownWaitForPowerSettle;
- fMachineState = kIOPM_DriverThreadCallDone;
- fDriverCallReason = kDriverCallSetPowerState;
+ if ( fDriverTimer )
+ {
+ OUR_PMLog(kPMLogStartAckTimer, 0, 0);
+ start_ack_timer();
+ }
+ }
- if (notifyControllingDriver() == false)
- notifyControllingDriverDone();
+ MS_POP(); // pushed by OurChangeSetPowerState()
+ fIsPreChange = false;
}
//*********************************************************************************
-// [private] ParentDownWaitForPowerSettle
+// [private] all_done
//
-// Our controlling driver has changed power state on the hardware
-// during a power change initiated by our parent. We have had to wait
-// for acknowledgement from interested parties, or we have had to wait
-// for the controlling driver to change the state. Here we see if we need
-// to wait for power to settle before continuing. If not, we continue
-// processing (acknowledging our preparedness to the parent).
-// If so, we wait and continue later.
+// A power change is done.
//*********************************************************************************
-void IOService::ParentDownWaitForPowerSettle ( void )
+void IOService::all_done ( void )
{
- fMachineState = kIOPM_ParentDownNotifyDidChangeAndAcknowledgeChange;
- fSettleTimeUS = compute_settle_time();
- if ( fSettleTimeUS )
- {
- startSettleTimer(fSettleTimeUS);
- }
-}
+ IOPMPowerStateIndex prevPowerState;
+ const IOPMPSEntry * powerStatePtr;
+ IOPMDriverCallEntry callEntry;
+ uint32_t prevMachineState = fMachineState;
+ bool callAction = false;
-//*********************************************************************************
-// [private] ParentDownNotifyDidChangeAndAcknowledgeChange
-//
-// Power has settled on a power change initiated by our parent. Here we
-// notify interested parties.
-//*********************************************************************************
+ fMachineState = kIOPM_Finished;
-void IOService::ParentDownNotifyDidChangeAndAcknowledgeChange ( void )
-{
- fMachineState = kIOPM_ParentDownAcknowledgeChange;
- notifyAll(false);
-}
+ 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).
-//*********************************************************************************
-// [private] ParentDownAcknowledgeChange
-//
-// We had to wait for it, but all parties have acknowledged our post-change
-// notification of a power lowering initiated by the parent.
-// Here we acknowledge the parent.
-// We are done with this change note, and we can start on the next one.
-//*********************************************************************************
+ PM_ACTION_2(actionPowerChangeDone,
+ fHeadNotePowerState, fHeadNoteChangeFlags);
-void IOService::ParentDownAcknowledgeChange ( void )
-{
- IORegistryEntry * nub;
- IOService * parent;
+ if (getPMRequestType() == kIOPMRequestTypeSynchronizePowerTree)
+ {
+ powerChangeDone(fCurrentPowerState);
+ }
- nub = fHeadNoteParent;
- nub->retain();
- all_done();
- parent = (IOService *)nub->copyParentEntry(gIOPowerPlane);
- if ( parent )
- {
- parent->acknowledgePowerChange((IOService *)nub);
- parent->release();
+ return;
}
- nub->release();
-}
-
-//*********************************************************************************
-// [private] ParentUpSetPowerState
-//
-// Our parent has informed us via powerStateDidChange that it has
-// raised the power in our power domain, and we have had to wait
-// for some interested party to acknowledge our notification.
-// Here we instruct our controlling
-// driver to program the hardware to take advantage of the higher domain
-// power. If it does so, we continue processing
-// (waiting for settle and notifying interested parties post-change.)
-// If it doesn't, we have to wait for it to acknowledge and then continue.
-//*********************************************************************************
-void IOService::ParentUpSetPowerState ( void )
-{
- fNextMachineState = kIOPM_ParentUpWaitForSettleTime;
- fMachineState = kIOPM_DriverThreadCallDone;
- fDriverCallReason = kDriverCallSetPowerState;
+ // our power change
+ if ( fHeadNoteChangeFlags & kIOPMSelfInitiated )
+ {
+ // could our driver switch to the new state?
+ if ( !( fHeadNoteChangeFlags & kIOPMNotDone) )
+ {
+ // we changed, tell our parent
+ requestDomainPower(fHeadNotePowerState);
- if (notifyControllingDriver() == false)
- notifyControllingDriverDone();
-}
+ // yes, did power raise?
+ if ( fCurrentPowerState < fHeadNotePowerState )
+ {
+ // yes, inform clients and apps
+ tellChangeUp (fHeadNotePowerState);
+ }
+ prevPowerState = fCurrentPowerState;
+ // either way
+ fCurrentPowerState = fHeadNotePowerState;
+#if PM_VARS_SUPPORT
+ fPMVars->myCurrentState = fCurrentPowerState;
+#endif
+ OUR_PMLog(kPMLogChangeDone, fCurrentPowerState, 0);
+ PM_ACTION_2(actionPowerChangeDone,
+ fHeadNotePowerState, fHeadNoteChangeFlags);
+ callAction = true;
-//*********************************************************************************
-// [private] ParentUpWaitForSettleTime
-//
-// Our controlling driver has changed power state on the hardware
-// during a power raise initiated by the parent, but we had to wait for it.
-// Here we see if we need to wait for power to settle before continuing.
-// If not, we continue processing (notifying interested parties post-change).
-// If so, we wait and continue later.
-//*********************************************************************************
+ powerStatePtr = &fPowerStates[fCurrentPowerState];
+ fCurrentCapabilityFlags = powerStatePtr->capabilityFlags;
+ if (fCurrentCapabilityFlags & kIOPMStaticPowerValid)
+ fCurrentPowerConsumption = powerStatePtr->staticPower;
-void IOService::ParentUpWaitForSettleTime ( void )
+ // 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)))
+ {
+ if ((fHeadNoteChangeFlags & kIOPMPowerSuppressed) &&
+ (fHeadNotePowerState != fCurrentPowerState) &&
+ (fHeadNotePowerState == fDesiredPowerState))
+ {
+ // Power changed, and desired power state restored.
+ // Clear any prior power desire while in suppressed state.
+ requestDomainPower(fHeadNotePowerState);
+ }
+
+ // did power raise?
+ if ( fCurrentPowerState < fHeadNotePowerState )
+ {
+ // yes, inform clients and apps
+ tellChangeUp (fHeadNotePowerState);
+ }
+ // either way
+ prevPowerState = fCurrentPowerState;
+ fCurrentPowerState = fHeadNotePowerState;
+#if PM_VARS_SUPPORT
+ 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);
+ }
+}
+
+// MARK: -
+// MARK: Power Change Initiated by Driver
+
+//*********************************************************************************
+// [private] OurChangeStart
+//
+// Begin the processing of a power change initiated by us.
+//*********************************************************************************
+
+void IOService::OurChangeStart ( void )
{
- fMachineState = kIOPM_ParentUpNotifyInterestedDriversDidChange;
- fSettleTimeUS = compute_settle_time();
- if ( fSettleTimeUS )
+ PM_ASSERT_IN_GATE();
+ 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;
+ }
+
+ // Redundant power changes skips to the end of the state machine.
+
+ if (!fInitialPowerChange && (fHeadNotePowerState == fCurrentPowerState))
+ {
+ OurChangeFinish();
+ return;
+ }
+ fInitialPowerChange = false;
+
+ // Change started, but may not complete...
+ // Can be canceled (power drop) or deferred (power rise).
+
+ 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)
{
- startSettleTimer(fSettleTimeUS);
+ 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();
}
}
//*********************************************************************************
-// [private] ParentUpNotifyInterestedDriversDidChange
+
+struct IOPMRequestDomainPowerContext {
+ IOService * child; // the requesting child
+ IOPMPowerFlags requestPowerFlags; // power flags requested by child
+};
+
+static void
+requestDomainPowerApplier(
+ IORegistryEntry * entry,
+ void * inContext )
+{
+ IOPowerConnection * connection;
+ IOService * parent;
+ IOPMRequestDomainPowerContext * context;
+
+ if ((connection = OSDynamicCast(IOPowerConnection, entry)) == 0)
+ return;
+ parent = (IOService *) connection->copyParentEntry(gIOPowerPlane);
+ if (!parent)
+ return;
+
+ assert(inContext);
+ context = (IOPMRequestDomainPowerContext *) inContext;
+
+ if (connection->parentKnowsState() && connection->getReadyFlag())
+ {
+ parent->requestPowerDomainState(
+ context->requestPowerFlags,
+ connection,
+ IOPMLowestState);
+ }
+
+ parent->release();
+}
+
+//*********************************************************************************
+// [private] requestDomainPower
+//*********************************************************************************
+
+IOReturn IOService::requestDomainPower(
+ IOPMPowerStateIndex ourPowerState,
+ IOOptionBits options )
+{
+ const IOPMPSEntry * powerStateEntry;
+ 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;
+ }
+ }
+
+done:
+ return kIOReturnSuccess;
+}
+
+//*********************************************************************************
+// [private] OurSyncStart
+//*********************************************************************************
+
+void IOService::OurSyncStart ( void )
+{
+ PM_ASSERT_IN_GATE();
+
+ if (fInitialPowerChange)
+ return;
+
+ PM_ACTION_2(actionPowerChangeStart, fHeadNotePowerState, &fHeadNoteChangeFlags);
+
+ if (fHeadNoteChangeFlags & kIOPMNotDone)
+ {
+ OurChangeFinish();
+ return;
+ }
+
+ 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 );
+ }
+}
+
+//*********************************************************************************
+// [private] OurChangeTellClientsPowerDown
//
-// Power has settled on a power raise initiated by the parent.
-// Here we notify all our interested parties post-change. If they all acknowledge,
-// we're done with this change note, and we can start on the next one.
-// Otherwise we have to wait for acknowledgements and finish up later.
+// 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.
//*********************************************************************************
-void IOService::ParentUpNotifyInterestedDriversDidChange ( void )
+void IOService::OurChangeTellClientsPowerDown ( void )
{
- fMachineState = kIOPM_ParentUpAcknowledgePowerChange;
- notifyAll(false);
+ fMachineState = kIOPM_OurChangeTellPriorityClientsPowerDown;
+ tellChangeDown1(fHeadNotePowerState);
}
//*********************************************************************************
-// [private] ParentUpAcknowledgePowerChange
+// [private] OurChangeTellPriorityClientsPowerDown
//
-// All parties have acknowledged our post-change notification of a power
-// raising initiated by the parent. Here we acknowledge the parent.
-// We are done with this change note, and we can start on the next one.
+// All applications and kernel clients have acknowledged our intention to drop
+// power. Here we notify "priority" clients that we are lowering power.
//*********************************************************************************
-void IOService::ParentUpAcknowledgePowerChange ( void )
+void IOService::OurChangeTellPriorityClientsPowerDown ( void )
{
- IORegistryEntry * nub;
- IOService * parent;
+ fMachineState = kIOPM_OurChangeNotifyInterestedDriversWillChange;
+ tellChangeDown2(fHeadNotePowerState);
+}
- nub = fHeadNoteParent;
- nub->retain();
- all_done();
- parent = (IOService *)nub->copyParentEntry(gIOPowerPlane);
- if ( parent )
+//*********************************************************************************
+// [private] OurChangeTellCapabilityWillChange
+//
+// Extra stage for root domain to notify apps and drivers about the
+// system capability change when raising power state.
+//*********************************************************************************
+
+void IOService::OurChangeTellCapabilityWillChange ( void )
+{
+ if (!IS_ROOT_DOMAIN)
+ return OurChangeNotifyInterestedDriversWillChange();
+
+ tellSystemCapabilityChange( kIOPM_OurChangeNotifyInterestedDriversWillChange );
+}
+
+//*********************************************************************************
+// [private] OurChangeNotifyInterestedDriversWillChange
+//
+// All applications and kernel clients have acknowledged our power state change.
+// Here we notify interested drivers pre-change.
+//*********************************************************************************
+
+void IOService::OurChangeNotifyInterestedDriversWillChange ( void )
+{
+ IOPMrootDomain * rootDomain;
+ if ((rootDomain = getPMRootDomain()) == this)
{
- parent->acknowledgePowerChange((IOService *)nub);
- parent->release();
+ if (IS_POWER_DROP)
+ {
+ rootDomain->tracePoint( kIOPMTracePointSleepWillChangeInterests );
+
+ PMEventDetails *details = PMEventDetails::eventDetails(
+ kIOPMEventTypeAppNotificationsFinished,
+ NULL,
+ 100,
+ kIOReturnSuccess);
+ rootDomain->recordAndReleasePMEventGated( details );
+ }
+ else
+ rootDomain->tracePoint( kIOPMTracePointWakeWillChangeInterests );
}
- nub->release();
+
+ notifyAll( kIOPM_OurChangeSetPowerState );
}
//*********************************************************************************
-// [private] all_done
+// [private] OurChangeSetPowerState
//
-// A power change is complete, and the used post-change note is at
-// the head of the queue. Remove it and set myCurrentState to the result
-// of the change. Start up the next change in queue.
+// Instruct our controlling driver to program the hardware for the power state
+// change. Wait for async completions.
//*********************************************************************************
-void IOService::all_done ( void )
+void IOService::OurChangeSetPowerState ( void )
{
- unsigned long previous_state;
+ MS_PUSH( kIOPM_OurChangeWaitForPowerSettle );
+ fMachineState = kIOPM_DriverThreadCallDone;
+ fDriverCallReason = kDriverCallSetPowerState;
- fMachineState = kIOPM_Finished;
+ if (notifyControllingDriver() == false)
+ notifyControllingDriverDone();
+}
- // our power change
- if ( fHeadNoteFlags & IOPMWeInitiated )
+//*********************************************************************************
+// [private] OurChangeWaitForPowerSettle
+//
+// Our controlling driver has completed the power state change we initiated.
+// Wait for the driver specified settle time to expire.
+//*********************************************************************************
+
+void IOService::OurChangeWaitForPowerSettle ( void )
+{
+ fMachineState = kIOPM_OurChangeNotifyInterestedDriversDidChange;
+ startSettleTimer();
+}
+
+//*********************************************************************************
+// [private] OurChangeNotifyInterestedDriversDidChange
+//
+// Power has settled on a power change we initiated. Here we notify
+// all our interested drivers post-change.
+//*********************************************************************************
+
+void IOService::OurChangeNotifyInterestedDriversDidChange ( void )
+{
+ IOPMrootDomain * rootDomain;
+ if ((rootDomain = getPMRootDomain()) == this)
{
- // could our driver switch to the new state?
- if ( !( fHeadNoteFlags & IOPMNotDone) )
- {
- // we changed, tell our parent
- if ( !fWeAreRoot )
- {
- ask_parent(fHeadNoteState);
- }
+ rootDomain->tracePoint( IS_POWER_DROP ?
+ kIOPMTracePointSleepDidChangeInterests :
+ kIOPMTracePointWakeDidChangeInterests );
+ }
- // yes, did power raise?
- if ( fCurrentPowerState < fHeadNoteState )
- {
- // yes, inform clients and apps
- tellChangeUp (fHeadNoteState);
- }
- previous_state = fCurrentPowerState;
- // either way
- fCurrentPowerState = fHeadNoteState;
-#if PM_VARS_SUPPORT
- fPMVars->myCurrentState = fCurrentPowerState;
-#endif
- OUR_PMLog(kPMLogChangeDone, fCurrentPowerState, 0);
+ notifyAll( kIOPM_OurChangeTellCapabilityDidChange );
+}
- // inform subclass policy-maker
- if (!fWillPMStop && fParentsKnowState)
- powerChangeDone(previous_state);
- else
- PM_DEBUG("%s::powerChangeDone() skipped\n", getName());
- }
+//*********************************************************************************
+// [private] OurChangeTellCapabilityDidChange
+//
+// For root domain to notify capability power-change.
+//*********************************************************************************
+
+void IOService::OurChangeTellCapabilityDidChange ( void )
+{
+ if (!IS_ROOT_DOMAIN)
+ return OurChangeFinish();
+
+ getPMRootDomain()->tracePoint( IS_POWER_DROP ?
+ kIOPMTracePointSleepCapabilityClients :
+ kIOPMTracePointWakeCapabilityClients );
+
+ tellSystemCapabilityChange( kIOPM_OurChangeFinish );
+}
+
+//*********************************************************************************
+// [private] OurChangeFinish
+//
+// Done with this self-induced power state change.
+//*********************************************************************************
+
+void IOService::OurChangeFinish ( void )
+{
+ all_done();
+}
+
+// MARK: -
+// MARK: Power Change Initiated by Parent
+
+//*********************************************************************************
+// [private] ParentChangeStart
+//
+// Here we begin the processing of a power change initiated by our parent.
+//*********************************************************************************
+
+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 );
+
+ PM_ACTION_2(actionPowerChangeStart, fHeadNotePowerState, &fHeadNoteChangeFlags);
+
+ // Tell apps and kernel clients
+ fInitialPowerChange = false;
+ fMachineState = kIOPM_ParentChangeTellPriorityClientsPowerDown;
+ tellChangeDown1(fHeadNotePowerState);
+ return IOPMWillAckLater;
}
- // parent's power change
- if ( fHeadNoteFlags & IOPMParentInitiated)
+ // Power domain is raising power
+ if ( fHeadNotePowerState > fCurrentPowerState )
{
- if (((fHeadNoteFlags & IOPMDomainWillChange) && (fCurrentPowerState >= fHeadNoteState)) ||
- ((fHeadNoteFlags & IOPMDomainDidChange) && (fCurrentPowerState < fHeadNoteState)))
+ if ( fDesiredPowerState > fCurrentPowerState )
{
- // did power raise?
- if ( fCurrentPowerState < fHeadNoteState )
+ if ( fDesiredPowerState < fHeadNotePowerState )
{
- // yes, inform clients and apps
- tellChangeUp (fHeadNoteState);
- }
- // either way
- previous_state = fCurrentPowerState;
- fCurrentPowerState = fHeadNoteState;
-#if PM_VARS_SUPPORT
- fPMVars->myCurrentState = fCurrentPowerState;
-#endif
- fMaxCapability = fControllingDriver->maxCapabilityForDomainState(fHeadNoteDomainState);
+ // 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);
+ }
+ }
- OUR_PMLog(kPMLogChangeDone, fCurrentPowerState, 0);
+ if ( fHeadNoteChangeFlags & kIOPMDomainDidChange )
+ {
+ if ( fHeadNotePowerState > fCurrentPowerState )
+ {
+ PM_ACTION_2(actionPowerChangeStart,
+ fHeadNotePowerState, &fHeadNoteChangeFlags);
- // inform subclass policy-maker
- if (!fWillPMStop && fParentsKnowState)
- powerChangeDone(previous_state);
- else
- PM_DEBUG("%s::powerChangeDone() skipped\n", getName());
+ // 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;
}
}
- if (fCurrentPowerState < fNumberOfPowerStates)
- {
- const IOPMPowerState * powerStatePtr = &fPowerStates[fCurrentPowerState];
+ all_done();
+ return IOPMAckImplied;
+}
- fCurrentCapabilityFlags = powerStatePtr->capabilityFlags;
- if (fCurrentCapabilityFlags & kIOPMStaticPowerValid)
- fCurrentPowerConsumption = powerStatePtr->staticPower;
- }
+//*********************************************************************************
+// [private] ParentChangeTellPriorityClientsPowerDown
+//
+// All applications and kernel clients have acknowledged our intention to drop
+// power. Here we notify "priority" clients that we are lowering power.
+//*********************************************************************************
- // When power rises enough to satisfy the tickle's desire for more power,
- // the condition preventing idle-timer from dropping power is removed.
+void IOService::ParentChangeTellPriorityClientsPowerDown ( void )
+{
+ fMachineState = kIOPM_ParentChangeNotifyInterestedDriversWillChange;
+ tellChangeDown2(fHeadNotePowerState);
+}
- if (fCurrentPowerState >= fIdleTimerMinPowerState)
+//*********************************************************************************
+// [private] ParentChangeTellCapabilityWillChange
+//
+// All (legacy) applications and kernel clients have acknowledged, extra stage for
+// root domain to notify apps and drivers about the system capability change.
+//*********************************************************************************
+
+void IOService::ParentChangeTellCapabilityWillChange ( void )
+{
+ if (!IS_ROOT_DOMAIN)
+ return ParentChangeNotifyInterestedDriversWillChange();
+
+ tellSystemCapabilityChange( kIOPM_ParentChangeNotifyInterestedDriversWillChange );
+}
+
+//*********************************************************************************
+// [private] ParentChangeNotifyInterestedDriversWillChange
+//
+// All applications and kernel clients have acknowledged our power state change.
+// Here we notify interested drivers pre-change.
+//*********************************************************************************
+
+void IOService::ParentChangeNotifyInterestedDriversWillChange ( void )
+{
+ notifyAll( kIOPM_ParentChangeSetPowerState );
+}
+
+//*********************************************************************************
+// [private] ParentChangeSetPowerState
+//
+// Instruct our controlling driver to program the hardware for the power state
+// change. Wait for async completions.
+//*********************************************************************************
+
+void IOService::ParentChangeSetPowerState ( void )
+{
+ MS_PUSH( kIOPM_ParentChangeWaitForPowerSettle );
+ fMachineState = kIOPM_DriverThreadCallDone;
+ fDriverCallReason = kDriverCallSetPowerState;
+
+ if (notifyControllingDriver() == false)
+ notifyControllingDriverDone();
+}
+
+//*********************************************************************************
+// [private] ParentChangeWaitForPowerSettle
+//
+// Our controlling driver has completed the power state change initiated by our
+// parent. Wait for the driver specified settle time to expire.
+//*********************************************************************************
+
+void IOService::ParentChangeWaitForPowerSettle ( void )
+{
+ fMachineState = kIOPM_ParentChangeNotifyInterestedDriversDidChange;
+ startSettleTimer();
+}
+
+//*********************************************************************************
+// [private] ParentChangeNotifyInterestedDriversDidChange
+//
+// Power has settled on a power change initiated by our parent. Here we notify
+// all our interested drivers post-change.
+//*********************************************************************************
+
+void IOService::ParentChangeNotifyInterestedDriversDidChange ( void )
+{
+ notifyAll( kIOPM_ParentChangeTellCapabilityDidChange );
+}
+
+//*********************************************************************************
+// [private] ParentChangeTellCapabilityDidChange
+//
+// For root domain to notify capability power-change.
+//*********************************************************************************
+
+void IOService::ParentChangeTellCapabilityDidChange ( void )
+{
+ if (!IS_ROOT_DOMAIN)
+ return ParentChangeAcknowledgePowerChange();
+
+ tellSystemCapabilityChange( kIOPM_ParentChangeAcknowledgePowerChange );
+}
+
+//*********************************************************************************
+// [private] ParentAcknowledgePowerChange
+//
+// Acknowledge our power parent that our power change is done.
+//*********************************************************************************
+
+void IOService::ParentChangeAcknowledgePowerChange ( void )
+{
+ IORegistryEntry * nub;
+ IOService * parent;
+
+ nub = fHeadNoteParentConnection;
+ nub->retain();
+ all_done();
+ parent = (IOService *)nub->copyParentEntry(gIOPowerPlane);
+ if ( parent )
{
- fIdleTimerMinPowerState = 0;
+ parent->acknowledgePowerChange((IOService *)nub);
+ parent->release();
}
+ nub->release();
+}
+
+// MARK: -
+// MARK: Ack and Settle timers
+
+//*********************************************************************************
+// [private] settleTimerExpired
+//
+// Power has settled after our last change. Notify interested parties that
+// there is a new power state.
+//*********************************************************************************
+
+void IOService::settleTimerExpired( void )
+{
+ fSettleTimeUS = 0;
+ gIOPMWorkQueue->signalWorkAvailable();
}
//*********************************************************************************
-// [public] settleTimerExpired
+// settle_timer_expired
//
-// Power has settled after our last change. Notify interested parties that
-// there is a new power state.
+// Holds a retain while the settle timer callout is in flight.
//*********************************************************************************
-void IOService::settleTimerExpired ( void )
+static void
+settle_timer_expired( thread_call_param_t arg0, thread_call_param_t arg1 )
{
- fSettleTimeUS = 0;
+ IOService * me = (IOService *) arg0;
+
+ if (gIOPMWorkLoop && gIOPMWorkQueue)
+ {
+ gIOPMWorkLoop->runAction(
+ OSMemberFunctionCast(IOWorkLoop::Action, me, &IOService::settleTimerExpired),
+ me);
+ }
+ me->release();
}
//*********************************************************************************
-// [private] compute_settle_time
+// [private] startSettleTimer
//
-// Compute the power-settling delay in microseconds for the
-// change from myCurrentState to head_note_state.
+// Calculate a power-settling delay in microseconds and start a timer.
//*********************************************************************************
-unsigned long IOService::compute_settle_time ( void )
+void IOService::startSettleTimer( void )
{
- unsigned long totalTime;
- unsigned long i;
+ AbsoluteTime deadline;
+ IOPMPowerStateIndex i;
+ uint32_t settleTime = 0;
+ boolean_t pending;
PM_ASSERT_IN_GATE();
- // compute total time to attain the new state
- totalTime = 0;
i = fCurrentPowerState;
- // we're lowering power
- if ( fHeadNoteState < fCurrentPowerState )
+ // lowering power
+ if ( fHeadNotePowerState < fCurrentPowerState )
{
- while ( i > fHeadNoteState )
+ while ( i > fHeadNotePowerState )
{
- totalTime += fPowerStates[i].settleDownTime;
+ settleTime += (uint32_t) fPowerStates[i].settleDownTime;
i--;
}
}
- // we're raising power
- if ( fHeadNoteState > fCurrentPowerState )
+ // raising power
+ if ( fHeadNotePowerState > fCurrentPowerState )
{
- while ( i < fHeadNoteState )
+ while ( i < fHeadNotePowerState )
{
- totalTime += fPowerStates[i+1].settleUpTime;
+ settleTime += (uint32_t) fPowerStates[i+1].settleUpTime;
i++;
}
}
- return totalTime;
-}
-
-//*********************************************************************************
-// [private] startSettleTimer
-//
-// Enter a power-settling delay in microseconds and start a timer for that delay.
-//*********************************************************************************
-
-IOReturn IOService::startSettleTimer ( unsigned long delay )
-{
- AbsoluteTime deadline;
- boolean_t pending;
-
- retain();
- clock_interval_to_deadline(delay, kMicrosecondScale, &deadline);
- pending = thread_call_enter_delayed(fSettleTimer, deadline);
- if (pending) release();
-
- return IOPMNoErr;
+ if (settleTime)
+ {
+ retain();
+ clock_interval_to_deadline(settleTime, kMicrosecondScale, &deadline);
+ pending = thread_call_enter_delayed(fSettleTimer, deadline);
+ if (pending) release();
+ }
}
//*********************************************************************************
-// [public] ackTimerTick
+// [private] ackTimerTick
//
// The acknowledgement timeout periodic timer has ticked.
// If we are awaiting acks for a power change notification,
// machine state, false otherwise.
//*********************************************************************************
+#ifndef __LP64__
void IOService::ack_timer_ticked ( void )
{
assert(false);
}
+#endif /* !__LP64__ */
bool IOService::ackTimerTick( void )
{
PM_ASSERT_IN_GATE();
switch (fMachineState) {
case kIOPM_OurChangeWaitForPowerSettle:
- case kIOPM_ParentDownWaitForPowerSettle:
- case kIOPM_ParentUpWaitForSettleTime:
+ case kIOPM_ParentChangeWaitForPowerSettle:
// are we waiting for controlling driver to acknowledge?
if ( fDriverTimer > 0 )
{
OUR_PMLog(kPMLogCtrlDriverTardy, 0, 0);
setProperty(kIOPMTardyAckSPSKey, kOSBooleanTrue);
PM_ERROR("%s::setPowerState(%p, %lu -> %lu) timed out after %d ms\n",
- fName, this, fCurrentPowerState, fHeadNoteState, NS_TO_MS(nsec));
+ 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, fHeadNoteState, NS_TO_MS(nsec));
+ fName, this, fCurrentPowerState, fHeadNotePowerState, NS_TO_MS(nsec));
}
else
{
}
break;
- case kIOPM_OurChangeSetPowerState:
- case kIOPM_OurChangeFinish:
- case kIOPM_ParentDownSetPowerState:
- case kIOPM_ParentDownAcknowledgeChange:
- case kIOPM_ParentUpSetPowerState:
- case kIOPM_ParentUpAcknowledgePowerChange:
- case kIOPM_NotifyChildrenDone:
+ case kIOPM_NotifyChildrenStart:
// are we waiting for interested parties to acknowledge?
if ( fHeadNotePendingAcks != 0 )
{
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, fHeadNoteState,
+ 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--;
}
}
break;
- case kIOPM_ParentDownTellPriorityClientsPowerDown:
- case kIOPM_ParentDownNotifyInterestedDriversWillChange:
- case kIOPM_OurChangeTellClientsPowerDown:
- case kIOPM_OurChangeTellPriorityClientsPowerDown:
- case kIOPM_OurChangeNotifyInterestedDriversWillChange:
- // apps didn't respond in time
- cleanClientResponses(true);
- OUR_PMLog(kPMLogClientTardy, 0, 1);
- // tardy equates to approval
- done = true;
- break;
-
- default:
- PM_TRACE("[%s] unexpected ack timer tick (state = %ld)\n",
- getName(), fMachineState);
- break;
- }
- return done;
-}
-
-//*********************************************************************************
-// [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] settleTimerExpired
-//
-// 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 && gIOPMReplyQueue)
- gIOPMReplyQueue->signalWorkAvailable();
-
- return kIOReturnSuccess;
-}
-
-//*********************************************************************************
-// ack_timer_expired
-//
-// Thread call function. Holds a retain while the callout is in flight.
-//*********************************************************************************
-
-void
-IOService::ack_timer_expired ( thread_call_param_t arg0, thread_call_param_t arg1 )
-{
- IOService * me = (IOService *) arg0;
-
- if (gIOPMWorkLoop)
- {
- gIOPMWorkLoop->runAction(&actionAckTimerExpired, me);
- }
- me->release();
-}
-
-//*********************************************************************************
-// settleTimerExpired
-//
-// Inside PM work loop's gate.
-//*********************************************************************************
-
-static IOReturn
-settleTimerExpired (
- OSObject * target,
- void * arg0, void * arg1,
- void * arg2, void * arg3 )
-{
- IOService * me = (IOService *) target;
- me->settleTimerExpired();
- return kIOReturnSuccess;
-}
-
-//*********************************************************************************
-// settle_timer_expired
-//
-// Thread call function. Holds a retain while the callout is in flight.
-//*********************************************************************************
-
-static void
-settle_timer_expired ( thread_call_param_t arg0, thread_call_param_t arg1 )
-{
- IOService * me = (IOService *) arg0;
-
- if (gIOPMWorkLoop && gIOPMReplyQueue)
- {
- gIOPMWorkLoop->runAction(settleTimerExpired, me);
- gIOPMReplyQueue->signalWorkAvailable();
- }
- me->release();
-}
-
-//*********************************************************************************
-// [private] start_parent_change
-//
-// Here we begin the processing of a power change initiated by our parent.
-//*********************************************************************************
-
-IOReturn IOService::start_parent_change ( const changeNoteItem * changeNote )
-{
- fHeadNoteFlags = changeNote->flags;
- fHeadNoteState = changeNote->newStateNumber;
- fHeadNoteOutputFlags = changeNote->outputPowerCharacter;
- fHeadNoteDomainState = changeNote->domainState;
- fHeadNoteParent = changeNote->parent;
- fHeadNoteCapabilityFlags = changeNote->capabilityFlags;
-
- PM_ASSERT_IN_GATE();
- OUR_PMLog( kPMLogStartParentChange, fHeadNoteState, fCurrentPowerState );
-
- // Power domain is lowering power
- if ( fHeadNoteState < fCurrentPowerState )
- {
- setParentInfo(
- changeNote->singleParentState,
- fHeadNoteParent, true );
-
- // tell apps and kernel clients
- fInitialChange = false;
- fMachineState = kIOPM_ParentDownTellPriorityClientsPowerDown;
- tellChangeDown1(fHeadNoteState);
- return IOPMWillAckLater;
- }
-
- // Power domain is raising power
- if ( fHeadNoteState > fCurrentPowerState )
- {
- IOPMPowerState * powerStatePtr;
-
- if ( fDesiredPowerState > fCurrentPowerState )
- {
- if ( fDesiredPowerState < fHeadNoteState )
- {
- // We power up, but not all the way
- fHeadNoteState = fDesiredPowerState;
- powerStatePtr = &fPowerStates[fHeadNoteState];
- fHeadNoteOutputFlags = powerStatePtr->outputPowerCharacter;
- fHeadNoteCapabilityFlags = powerStatePtr->capabilityFlags;
- OUR_PMLog(kPMLogAmendParentChange, fHeadNoteState, 0);
- }
- } else {
- // We don't need to change
- fHeadNoteState = fCurrentPowerState;
- powerStatePtr = &fPowerStates[fHeadNoteState];
- fHeadNoteOutputFlags = powerStatePtr->outputPowerCharacter;
- fHeadNoteCapabilityFlags = powerStatePtr->capabilityFlags;
- OUR_PMLog(kPMLogAmendParentChange, fHeadNoteState, 0);
- }
- }
-
- if ((fHeadNoteState > fCurrentPowerState) &&
- (fHeadNoteFlags & IOPMDomainDidChange))
- {
- // Parent did change up - start our change up
- fInitialChange = false;
- fMachineState = kIOPM_ParentUpSetPowerState;
- notifyAll( true );
- return IOPMWillAckLater;
- }
-
- all_done();
- return IOPMAckImplied;
-}
-
-//*********************************************************************************
-// [private] start_our_change
-//
-// Here we begin the processing of a power change initiated by us.
-//*********************************************************************************
-
-void IOService::start_our_change ( const changeNoteItem * changeNote )
-{
- fHeadNoteFlags = changeNote->flags;
- fHeadNoteState = changeNote->newStateNumber;
- fHeadNoteOutputFlags = changeNote->outputPowerCharacter;
- fHeadNoteCapabilityFlags = changeNote->capabilityFlags;
-
- PM_ASSERT_IN_GATE();
-
- OUR_PMLog( kPMLogStartDeviceChange, fHeadNoteState, fCurrentPowerState );
-
- // can our driver switch to the new state?
- if (( fHeadNoteCapabilityFlags & IOPMNotAttainable ) ||
- ((fMaxCapability < fHeadNoteState) && (!fWeAreRoot)))
- {
- // mark the change note un-actioned
- fHeadNoteFlags |= IOPMNotDone;
-
- // no, ask the parent to do it then
- if ( !fWeAreRoot )
- {
- ask_parent(fHeadNoteState);
- }
- all_done();
- return;
- }
-
- if ( !fInitialChange )
- {
- if ( fHeadNoteState == fCurrentPowerState )
- {
- // we initiated a null change; forget it
- all_done();
- return;
- }
- }
- fInitialChange = false;
-
- // dropping power?
- if ( fHeadNoteState < fCurrentPowerState )
- {
- // yes, in case we have to wait for acks
- fMachineState = kIOPM_OurChangeTellClientsPowerDown;
- fDoNotPowerDown = false;
-
- // ask apps and kernel clients if we can drop power
- fOutOfBandParameter = kNotifyApps;
- askChangeDown(fHeadNoteState);
- } else {
- // in case they don't all ack
- fMachineState = kIOPM_OurChangeSetPowerState;
- // notify interested drivers and children
- notifyAll(true);
- }
-}
-
-//*********************************************************************************
-// [private] ask_parent
-//
-// Call the power domain parent to ask for a higher power state in the domain
-// or to suggest a lower power state.
-//*********************************************************************************
-
-IOReturn IOService::ask_parent ( unsigned long requestedState )
-{
- OSIterator * iter;
- OSObject * next;
- IOPowerConnection * connection;
- IOService * parent;
- const IOPMPowerState * powerStatePtr;
- unsigned long ourRequest;
-
- PM_ASSERT_IN_GATE();
- if (requestedState >= fNumberOfPowerStates)
- return IOPMNoErr;
-
- powerStatePtr = &fPowerStates[requestedState];
- ourRequest = powerStatePtr->inputPowerRequirement;
-
- if ( powerStatePtr->capabilityFlags & (kIOPMChildClamp | kIOPMPreventIdleSleep) )
- {
- ourRequest |= kIOPMPreventIdleSleep;
- }
- if ( powerStatePtr->capabilityFlags & (kIOPMChildClamp2 | kIOPMPreventSystemSleep) )
- {
- ourRequest |= kIOPMPreventSystemSleep;
- }
-
- // is this a new desire?
- if ( fPreviousRequest == ourRequest )
- {
- // no, the parent knows already, just return
- return IOPMNoErr;
- }
-
- if ( fWeAreRoot )
- {
- return IOPMNoErr;
- }
- fPreviousRequest = ourRequest;
-
- iter = getParentIterator(gIOPowerPlane);
- if ( iter )
- {
- while ( (next = iter->getNextObject()) )
- {
- if ( (connection = OSDynamicCast(IOPowerConnection, next)) )
- {
- parent = (IOService *)connection->copyParentEntry(gIOPowerPlane);
- if ( parent ) {
- if ( parent->requestPowerDomainState(
- ourRequest, connection, IOPMLowestState) != IOPMNoErr )
- {
- OUR_PMLog(kPMLogRequestDenied, fPreviousRequest, 0);
- }
- parent->release();
- }
- }
- }
- iter->release();
- }
-
- return IOPMNoErr;
+ // 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;
+
+ default:
+ PM_LOG1("%s: unexpected ack timer tick (state = %d)\n",
+ getName(), fMachineState);
+ break;
+ }
+ return done;
}
//*********************************************************************************
-// [private] notifyControllingDriver
+// [private] start_ack_timer
//*********************************************************************************
-bool IOService::notifyControllingDriver ( void )
+void IOService::start_ack_timer ( void )
{
- DriverCallParam * param;
- unsigned long powerState;
-
- PM_ASSERT_IN_GATE();
- assert( fDriverCallBusy == false );
- assert( fDriverCallParamCount == 0 );
- assert( fControllingDriver );
-
- powerState = fHeadNoteState;
- if (fPowerStates[powerState].capabilityFlags & IOPMNotAttainable )
- return false; // state not attainable
+ start_ack_timer( ACK_TIMER_PERIOD, kNanosecondScale );
+}
- param = (DriverCallParam *) fDriverCallParamPtr;
- if (!param)
- {
- param = IONew(DriverCallParam, 1);
- if (!param)
- return false; // no memory
+void IOService::start_ack_timer ( UInt32 interval, UInt32 scale )
+{
+ AbsoluteTime deadline;
+ boolean_t pending;
- fDriverCallParamPtr = (void *) param;
- fDriverCallParamSlots = 1;
- }
+ clock_interval_to_deadline(interval, scale, &deadline);
- param->Target = fControllingDriver;
- fDriverCallParamCount = 1;
+ retain();
+ pending = thread_call_enter_delayed(fAckTimer, deadline);
+ if (pending) release();
+}
- fDriverTimer = -1;
+//*********************************************************************************
+// [private] stop_ack_timer
+//*********************************************************************************
- // Machine state for this object will stall waiting for a reply
- // from the callout thread.
+void IOService::stop_ack_timer ( void )
+{
+ boolean_t pending;
- PM_LOCK();
- fDriverCallBusy = true;
- PM_UNLOCK();
- thread_call_enter( fDriverCallEntry );
- return true;
+ pending = thread_call_cancel(fAckTimer);
+ if (pending) release();
}
//*********************************************************************************
-// [private] notifyControllingDriverDone
+// [static] actionAckTimerExpired
+//
+// Inside PM work loop's gate.
//*********************************************************************************
-void IOService::notifyControllingDriverDone( void )
+IOReturn
+IOService::actionAckTimerExpired (
+ OSObject * target,
+ void * arg0, void * arg1,
+ void * arg2, void * arg3 )
{
- DriverCallParam * param;
- IOReturn result;
+ IOService * me = (IOService *) target;
+ bool done;
- PM_ASSERT_IN_GATE();
- param = (DriverCallParam *) fDriverCallParamPtr;
+ // done will be true if the timer tick unblocks the machine state,
+ // otherwise no need to signal the work loop.
- assert( fDriverCallBusy == false );
- assert( fMachineState == kIOPM_DriverThreadCallDone );
+ done = me->ackTimerTick();
+ if (done && gIOPMWorkQueue)
+ gIOPMWorkQueue->signalWorkAvailable();
- if (param)
- {
- assert(fDriverCallParamCount == 1);
-
- // the return value from setPowerState()
- result = param->Result;
+ return kIOReturnSuccess;
+}
- if ((result == IOPMAckImplied) || (result < 0))
- {
- // child return IOPMAckImplied
- fDriverTimer = 0;
- }
- else if (fDriverTimer)
- {
- assert(fDriverTimer == -1);
+//*********************************************************************************
+// ack_timer_expired
+//
+// Thread call function. Holds a retain while the callout is in flight.
+//*********************************************************************************
- // 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.
+void
+IOService::ack_timer_expired ( thread_call_param_t arg0, thread_call_param_t arg1 )
+{
+ IOService * me = (IOService *) arg0;
- if (result < kMinAckTimeoutTicks)
- result = kMinAckTimeoutTicks;
+ if (gIOPMWorkLoop)
+ {
+ gIOPMWorkLoop->runAction(&actionAckTimerExpired, me);
+ }
+ me->release();
+}
- fDriverTimer = (result / (ACK_TIMER_PERIOD / ns_per_us)) + 1;
- }
- // else, child has already acked and driver_timer reset to 0.
+// MARK: -
+// MARK: Client Messaging
- fDriverCallParamCount = 0;
+//*********************************************************************************
+// [private] tellSystemCapabilityChange
+//*********************************************************************************
- if ( fDriverTimer )
- {
- OUR_PMLog(kPMLogStartAckTimer, 0, 0);
- start_ack_timer();
- }
- }
+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;
+ }
- // Hop back to original machine state path.
- fMachineState = fNextMachineState;
+ tellClientsWithResponse( fOutOfBandMessage );
}
//*********************************************************************************
-// [public virtual] askChangeDown
+// [public] askChangeDown
//
// Ask registered applications and kernel clients if we can change to a lower
// power state.
}
//*********************************************************************************
-// [public] tellChangeDown1
+// [private] tellChangeDown1
//
// Notify registered applications and kernel clients that we are definitely
// dropping power.
}
//*********************************************************************************
-// [public] tellChangeDown2
+// [private] tellChangeDown2
//
// Notify priority clients that we are definitely dropping power.
//
}
//*********************************************************************************
-// [public virtual] tellChangeDown
+// [public] tellChangeDown
//
// Notify registered applications and kernel clients that we are definitely
// dropping power.
//
//*********************************************************************************
-static void logAppTimeouts ( OSObject * object, void * context)
+static void logAppTimeouts ( OSObject * object, void * arg )
{
- struct context *theContext = (struct context *)context;
- OSObject *flag;
+ 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( !OSDynamicCast( IOService, object) ) {
- flag = theContext->responseFlags->getObject(theContext->counter);
- if (kOSBooleanTrue != flag)
+ if ((clientIndex != (unsigned int) -1) &&
+ (flag = context->responseArray->getObject(clientIndex)) &&
+ (flag != kOSBooleanTrue))
{
OSString * clientID = 0;
- theContext->us->messageClient(theContext->msgType, object, &clientID);
- PM_ERROR(theContext->errorLog, clientID ? clientID->getCStringNoCopy() : "");
+ 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();
}
- theContext->counter += 1;
}
}
void IOService::cleanClientResponses ( bool logErrors )
{
- struct context theContext;
-
- if (logErrors && fResponseArray) {
- theContext.responseFlags = fResponseArray;
- theContext.serialNumber = fSerialNumber;
- theContext.counter = 0;
- theContext.msgType = kIOMessageCopyClientID;
- theContext.us = this;
- theContext.maxTimeRequested = 0;
- theContext.stateNumber = fHeadNoteState;
- theContext.stateFlags = fHeadNoteCapabilityFlags;
- theContext.errorLog = "PM notification timeout (%s)\n";
-
+ if (logErrors && fResponseArray)
+ {
switch ( fOutOfBandParameter ) {
case kNotifyApps:
- applyToInterested(gIOAppPowerStateInterest, logAppTimeouts, (void *) &theContext);
- case kNotifyPriority:
+ 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)
+ if (fResponseArray)
{
- // get rid of this stuff
fResponseArray->release();
fResponseArray = NULL;
}
-
- return;
+ if (fNotifyClientArray)
+ {
+ fNotifyClientArray->release();
+ fNotifyClientArray = NULL;
+ }
}
//*********************************************************************************
-// [public] tellClientsWithResponse
+// [protected] tellClientsWithResponse
//
// Notify registered applications and kernel clients that we are definitely
// dropping power.
bool IOService::tellClientsWithResponse ( int messageType )
{
- struct context theContext;
+ IOPMInterestContext context;
+ bool isRootDomain = IS_ROOT_DOMAIN;
PM_ASSERT_IN_GATE();
+ assert( fResponseArray == NULL );
+ assert( fNotifyClientArray == NULL );
+
+ RD_LOG("tellClientsWithResponse( %s, %d )\n",
+ getIOMessageString(messageType), fOutOfBandParameter);
fResponseArray = OSArray::withCapacity( 1 );
- fSerialNumber += 1;
-
- theContext.responseFlags = fResponseArray;
- theContext.serialNumber = fSerialNumber;
- theContext.counter = 0;
- theContext.msgType = messageType;
- theContext.us = this;
- theContext.maxTimeRequested = 0;
- theContext.stateNumber = fHeadNoteState;
- theContext.stateFlags = fHeadNoteCapabilityFlags;
+ 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 *)&theContext);
- applyToInterested(gIOGeneralInterest,
- pmTellClientWithResponse, (void *)&theContext);
+ 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:
- applyToInterested(gIOPriorityPowerStateInterest,
- pmTellClientWithResponse, (void *)&theContext);
+ 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,theContext.maxTimeRequested, 0);
- start_ack_timer( theContext.maxTimeRequested / 1000, kMillisecondScale );
+ OUR_PMLog(kPMLogStartAckTimer, context.maxTimeRequested, 0);
+ if (context.enableTracing)
+ getPMRootDomain()->traceDetail( context.maxTimeRequested / 1000 );
+ start_ack_timer( context.maxTimeRequested / 1000, kMillisecondScale );
return false;
}
+exit:
// everybody responded
- fResponseArray->release();
- fResponseArray = NULL;
- // cleanClientResponses(false);
-
+ if (fResponseArray)
+ {
+ fResponseArray->release();
+ fResponseArray = NULL;
+ }
+ if (fNotifyClientArray)
+ {
+ fNotifyClientArray->release();
+ fNotifyClientArray = NULL;
+ }
+
return true;
}
// cookie we can identify the response with.
//*********************************************************************************
-void IOService::pmTellAppWithResponse ( OSObject * object, void * context )
-{
- struct context * theContext = (struct context *) context;
- IOServicePM * pwrMgt = theContext->us->pwrMgt;
- AbsoluteTime now;
+void IOService::pmTellAppWithResponse ( OSObject * object, void * arg )
+{
+ IOPMInterestContext * context = (IOPMInterestContext *) arg;
+ IOServicePM * pwrMgt = context->us->pwrMgt;
+ uint32_t msgIndex, msgRef, msgType;
+#if LOG_APP_RESPONSE_TIMES
+ 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 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->notifyClients)
+ context->notifyClients->setObject(msgIndex, object);
+
+ context->us->messageClient(msgType, object, (void *) msgRef);
+}
+
+//*********************************************************************************
+// [static private] pmTellClientWithResponse
+//
+// We send a message to an in-kernel client, and we expect a response,
+// 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) {
+ 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) {
+ 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
+ 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);
+}
+
+//*********************************************************************************
+// [static private] pmTellCapabilityAppWithResponse
+//*********************************************************************************
+
+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;
+#if LOG_APP_RESPONSE_TIMES
+ 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 );
- if( OSDynamicCast( IOService, object) )
+ msgType = context->messageType;
+ msgIndex = context->responseArray->getCount();
+ msgRef = ((context->serialNumber & 0xFFFF) << 16) + (msgIndex & 0xFFFF);
+
+ OUR_PMLog(kPMLogAppNotify, msgType, msgRef);
+ if (kIOLogDebugPower & gIOKitDebug)
{
- // Automatically 'ack' in kernel clients
- theContext->responseFlags->setObject(theContext->counter, kOSBooleanTrue);
+ // 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();
+ }
- const char *who = ((IOService *) object)->getName();
- fPlatform->PMLog(who,
- kPMLogClientAcknowledge, theContext->msgType, * (UInt32 *) object);
- } else {
- UInt32 refcon = ((theContext->serialNumber & 0xFFFF)<<16)
- + (theContext->counter & 0xFFFF);
- OUR_PMLog(kPMLogAppNotify, theContext->msgType, refcon);
+ 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)
{
- theContext->responseFlags->setObject(theContext->counter, num);
+ context->responseArray->setObject(msgIndex, num);
num->release();
}
else
#endif
- theContext->responseFlags->setObject(theContext->counter, kOSBooleanFalse);
-
- theContext->us->messageClient(theContext->msgType, object, (void *)refcon);
- if ( theContext->maxTimeRequested < k30seconds )
- {
- theContext->maxTimeRequested = k30seconds;
- }
+ context->responseArray->setObject(msgIndex, kOSBooleanFalse);
- theContext->counter += 1;
+ if (context->notifyClients)
+ context->notifyClients->setObject(msgIndex, object);
}
+
+ context->us->messageClient(msgType, object, (void *) &msgArg, sizeof(msgArg));
}
//*********************************************************************************
-// [static private] pmTellClientWithResponse
-//
-// We send a message to an in-kernel client, and we expect a response, so we compute a
-// cookie we can identify the response with.
-// If it doesn't understand the notification (it is not power-management savvy)
-// we won't wait for it to prepare for sleep. If it tells us via a return code
-// in the passed struct that it is currently ready, we won't wait for it to prepare.
-// If it tells us via the return code in the struct that it does need time, we will chill.
+// [static private] pmTellCapabilityClientWithResponse
//*********************************************************************************
-void IOService::pmTellClientWithResponse ( OSObject * object, void * context )
+void IOService::pmTellCapabilityClientWithResponse(
+ OSObject * object, void * arg )
{
- struct context *theContext = (struct context *)context;
- IOPowerStateChangeNotification notify;
- UInt32 refcon;
- IOReturn retCode;
- OSObject *theFlag;
+ IOPMSystemCapabilityChangeParameters msgArg;
+ IOPMInterestContext * context = (IOPMInterestContext *) arg;
+ OSObject * replied = kOSBooleanTrue;
+ _IOServiceInterestNotifier * notifier;
+ uint32_t msgIndex, msgRef, msgType;
+ IOReturn retCode;
- refcon = ((theContext->serialNumber & 0xFFFF)<<16) + (theContext->counter & 0xFFFF);
- theContext->responseFlags->setObject(theContext->counter, kOSBooleanFalse);
+ 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;
+ }
- IOServicePM * pwrMgt = theContext->us->pwrMgt;
+ 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, refcon, (UInt32) theContext->msgType);
+ OUR_PMLog(kPMLogClientNotify, msgRef, msgType);
if (OSDynamicCast(IOService, object)) {
const char *who = ((IOService *) object)->getName();
- fPlatform->PMLog(who,
- kPMLogClientNotify, * (UInt32 *) object, (UInt32) object);
- } else if (OSDynamicCast(_IOServiceInterestNotifier, object)) {
- _IOServiceInterestNotifier *n = (_IOServiceInterestNotifier *) object;
- OUR_PMLog(kPMLogClientNotify, (UInt32) n->handler, 0);
+ gPlatform->PMLog(who, kPMLogClientNotify, (uintptr_t) object, 0);
+ }
+ 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 *)refcon;
- notify.returnValue = 0;
- notify.stateNumber = theContext->stateNumber;
- notify.stateFlags = theContext->stateFlags;
- retCode = theContext->us->messageClient(theContext->msgType,object,(void *)¬ify);
- if ( retCode == kIOReturnSuccess )
+ 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 ( notify.returnValue == 0 )
+ if ( 0 == msgArg.maxWaitForReply )
{
// client doesn't want time to respond
- theContext->responseFlags->replaceObject(theContext->counter, kOSBooleanTrue);
- OUR_PMLog(kPMLogClientAcknowledge, refcon, (UInt32) object);
- } else {
- // it does want time, and it hasn't responded yet
- theFlag = theContext->responseFlags->getObject(theContext->counter);
- if ( kOSBooleanTrue != theFlag )
+ OUR_PMLog(kPMLogClientAcknowledge, msgRef, (uintptr_t) object);
+ }
+ else
+ {
+ replied = kOSBooleanFalse;
+ if ( msgArg.maxWaitForReply > context->maxTimeRequested )
{
- // so note its time requirement
- if ( theContext->maxTimeRequested < notify.returnValue )
+ if (msgArg.maxWaitForReply > kCapabilityClientMaxWait)
{
- theContext->maxTimeRequested = notify.returnValue;
+ 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 {
- OUR_PMLog(kPMLogClientAcknowledge, refcon, 0);
+ }
+ else
+ {
// not a client of ours
// so we won't be waiting for response
- theContext->responseFlags->replaceObject(theContext->counter, kOSBooleanTrue);
+ OUR_PMLog(kPMLogClientAcknowledge, msgRef, 0);
}
- theContext->counter += 1;
+
+ context->responseArray->setObject(msgIndex, replied);
}
//*********************************************************************************
-// [public virtual] tellNoChangeDown
+// [public] tellNoChangeDown
//
// Notify registered applications and kernel clients that we are not
// dropping power.
}
//*********************************************************************************
-// [public virtual] tellChangeUp
+// [public] tellChangeUp
//
// Notify registered applications and kernel clients that we are raising power.
//
}
//*********************************************************************************
-// [public] tellClients
+// [protected] tellClients
//
// Notify registered applications and kernel clients of something.
//*********************************************************************************
void IOService::tellClients ( int messageType )
{
- struct context theContext;
+ IOPMInterestContext context;
- theContext.msgType = messageType;
- theContext.us = this;
- theContext.stateNumber = fHeadNoteState;
- theContext.stateFlags = fHeadNoteCapabilityFlags;
+ RD_LOG("tellClients( %s )\n", getIOMessageString(messageType));
- applyToInterested(gIOPriorityPowerStateInterest,tellClient,(void *)&theContext);
- applyToInterested(gIOAppPowerStateInterest,tellClient, (void *)&theContext);
- applyToInterested(gIOGeneralInterest,tellClient, (void *)&theContext);
+ 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;
+
+ context.notifyType = kNotifyPriority;
+ applyToInterested( gIOPriorityPowerStateInterest,
+ tellKernelClientApplier, (void *) &context );
+
+ context.notifyType = kNotifyApps;
+ applyToInterested( gIOAppPowerStateInterest,
+ tellAppClientApplier, (void *) &context );
+
+ applyToInterested( gIOGeneralInterest,
+ tellKernelClientApplier, (void *) &context );
}
//*********************************************************************************
-// [global] tellClient
+// [private] tellKernelClientApplier
//
-// Notify a registered application or kernel client of something.
+// Message a kernel client.
//*********************************************************************************
-void tellClient ( OSObject * object, void * context )
+static void tellKernelClientApplier ( OSObject * object, void * arg )
{
- struct context * theContext = (struct context *) context;
IOPowerStateChangeNotification notify;
+ IOPMInterestContext * context = (IOPMInterestContext *) arg;
+
+ 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);
+ }
+ return;
+ }
- notify.powerRef = (void *) 0;
+ notify.powerRef = (void *) 0;
notify.returnValue = 0;
- notify.stateNumber = theContext->stateNumber;
- notify.stateFlags = theContext->stateFlags;
+ notify.stateNumber = context->stateNumber;
+ notify.stateFlags = context->stateFlags;
+
+ context->us->messageClient(context->messageType, object, ¬ify);
+
+ 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);
+ }
+}
+
+//*********************************************************************************
+// [private] tellAppClientApplier
+//
+// Message a registered application.
+//*********************************************************************************
+
+static void tellAppClientApplier ( OSObject * object, void * arg )
+{
+ IOPMInterestContext * context = (IOPMInterestContext *) arg;
+
+ 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();
+ }
- theContext->us->messageClient(theContext->msgType, object, ¬ify);
+ context->us->messageClient(context->messageType, object, 0);
}
//*********************************************************************************
// [public] responseValid
//*********************************************************************************
-bool IOService::responseValid ( unsigned long x, int pid )
+bool IOService::responseValid ( uint32_t refcon, int pid )
{
UInt16 serialComponent;
UInt16 ordinalComponent;
OSObject * theFlag;
- unsigned long refcon = (unsigned long) x;
serialComponent = (refcon >> 16) & 0xFFFF;
ordinalComponent = (refcon & 0xFFFF);
#if LOG_APP_RESPONSE_TIMES
AbsoluteTime now;
AbsoluteTime start;
- uint64_t nsec;
+ 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)
{
- OSString * name = IOCopyLogNameForPID(pid);
- PM_DEBUG("PM response took %d ms (%s)\n", NS_TO_MS(nsec),
+ PM_LOG("PM response took %d ms (%s)\n", NS_TO_MS(nsec),
name ? name->getCStringNoCopy() : "");
- if (name)
- name->release();
+
+ 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;
}
}
//*********************************************************************************
-// [public virtual] allowPowerChange
+// [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.
-//
-// We serialize this processing with timer expiration with a command gate on the
-// power management workloop, which the timer expiration is command gated to as well.
//*********************************************************************************
IOReturn IOService::allowPowerChange ( unsigned long refcon )
request = acquirePMRequest( this, kIOPMRequestTypeAllowPowerChange );
if (!request)
- {
- PM_ERROR("%s::%s no memory\n", getName(), __FUNCTION__);
return kIOReturnNoMemory;
- }
request->fArg0 = (void *) refcon;
request->fArg1 = (void *) proc_selfpid();
+ request->fArg2 = (void *) 0;
submitPMRequest( request );
return kIOReturnSuccess;
}
-IOReturn serializedAllowPowerChange ( OSObject *owner, void * refcon, void *, void *, void *)
-{
- // [deprecated] public
- return kIOReturnUnsupported;
-}
-
+#ifndef __LP64__
IOReturn IOService::serializedAllowPowerChange2 ( unsigned long refcon )
{
// [deprecated] public
return kIOReturnUnsupported;
}
+#endif /* !__LP64__ */
//*********************************************************************************
-// [public virtual] cancelPowerChange
+// [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.
-//
-// We serialize this processing with timer expiration with a command gate on the
-// power management workloop, which the timer expiration is command gated to as well.
//*********************************************************************************
IOReturn IOService::cancelPowerChange ( unsigned long refcon )
{
- IOPMRequest * request;
+ IOPMRequest * request;
+ OSString * name;
if ( !initialized )
{
return kIOReturnSuccess;
}
- OSString * name = IOCopyLogNameForPID(proc_selfpid());
+ name = IOCopyLogNameForPID(proc_selfpid());
PM_ERROR("PM notification cancel (%s)\n", name ? name->getCStringNoCopy() : "");
- if (name)
- name->release();
request = acquirePMRequest( this, kIOPMRequestTypeCancelPowerChange );
if (!request)
- {
- PM_ERROR("%s::%s no memory\n", getName(), __FUNCTION__);
- return kIOReturnNoMemory;
- }
-
- request->fArg0 = (void *) refcon;
- request->fArg1 = (void *) proc_selfpid();
- submitPMRequest( request );
+ {
+ if (name)
+ name->release();
+ return kIOReturnNoMemory;
+ }
- return kIOReturnSuccess;
-}
+ request->fArg0 = (void *) refcon;
+ request->fArg1 = (void *) proc_selfpid();
+ request->fArg2 = (void *) name;
+ submitPMRequest( request );
-IOReturn serializedCancelPowerChange ( OSObject *owner, void * refcon, void *, void *, void *)
-{
- // [deprecated] public
- return kIOReturnUnsupported;
+ return kIOReturnSuccess;
}
+#ifndef __LP64__
IOReturn IOService::serializedCancelPowerChange2 ( unsigned long refcon )
{
// [deprecated] public
return kIOReturnUnsupported;
}
-#if 0
-//*********************************************************************************
-// c_PM_clamp_Timer_Expired (C Func)
-//
-// Called when our clamp timer expires...we will call the object method.
-//*********************************************************************************
-
-static void c_PM_Clamp_Timer_Expired ( OSObject * client, IOTimerEventSource * )
-{
- if (client)
- ((IOService *)client)->PM_Clamp_Timer_Expired ();
-}
-#endif
-
//*********************************************************************************
// PM_Clamp_Timer_Expired
//
void IOService::PM_Clamp_Timer_Expired ( void )
{
-#if 0
- if ( ! initialized )
- {
- // we're unloading
- return;
- }
-
- changePowerStateToPriv (0);
-#endif
}
//*********************************************************************************
// Set to highest available power state for a minimum of duration milliseconds
//*********************************************************************************
-#define kFiveMinutesInNanoSeconds (300 * NSEC_PER_SEC)
-
void IOService::clampPowerOn ( unsigned long duration )
{
-#if 0
- changePowerStateToPriv (fNumberOfPowerStates-1);
-
- if ( pwrMgt->clampTimerEventSrc == NULL ) {
- pwrMgt->clampTimerEventSrc = IOTimerEventSource::timerEventSource(this,
- c_PM_Clamp_Timer_Expired);
-
- IOWorkLoop * workLoop = getPMworkloop ();
-
- if ( !pwrMgt->clampTimerEventSrc || !workLoop ||
- ( workLoop->addEventSource( pwrMgt->clampTimerEventSrc) != kIOReturnSuccess) ) {
-
- }
- }
-
- pwrMgt->clampTimerEventSrc->setTimeout(300*USEC_PER_SEC, USEC_PER_SEC);
-#endif
}
+#endif /* !__LP64__ */
+
+// MARK: -
+// MARK: Driver Overrides
//*********************************************************************************
-// [public virtual] setPowerState
+// [public] setPowerState
//
// Does nothing here. This should be implemented in a subclass driver.
//*********************************************************************************
}
//*********************************************************************************
-// [public virtual] maxCapabilityForDomainState
+// [public] maxCapabilityForDomainState
//
// Finds the highest power state in the array whose input power
// requirement is equal to the input parameter. Where a more intelligent
}
for ( i = fNumberOfPowerStates - 1; i >= 0; i-- )
{
- if ( (domainState & fPowerStates[i].inputPowerRequirement) ==
- fPowerStates[i].inputPowerRequirement )
+ if ( (domainState & fPowerStates[i].inputPowerFlags) ==
+ fPowerStates[i].inputPowerFlags )
{
return i;
}
}
//*********************************************************************************
-// [public virtual] initialPowerStateForDomainState
+// [public] initialPowerStateForDomainState
//
// Finds the highest power state in the array whose input power
// requirement is equal to the input parameter. Where a more intelligent
}
for ( i = fNumberOfPowerStates - 1; i >= 0; i-- )
{
- if ( (domainState & fPowerStates[i].inputPowerRequirement) ==
- fPowerStates[i].inputPowerRequirement )
+ if ( (domainState & fPowerStates[i].inputPowerFlags) ==
+ fPowerStates[i].inputPowerFlags )
{
return i;
}
}
//*********************************************************************************
-// [public virtual] powerStateForDomainState
+// [public] powerStateForDomainState
//
// Finds the highest power state in the array whose input power
// requirement is equal to the input parameter. Where a more intelligent
}
for ( i = fNumberOfPowerStates - 1; i >= 0; i-- )
{
- if ( (domainState & fPowerStates[i].inputPowerRequirement) ==
- fPowerStates[i].inputPowerRequirement )
+ if ( (domainState & fPowerStates[i].inputPowerFlags) ==
+ fPowerStates[i].inputPowerFlags )
{
return i;
}
return 0;
}
+#ifndef __LP64__
//*********************************************************************************
-// [public virtual] didYouWakeSystem
+// [deprecated] didYouWakeSystem
//
// Does nothing here. This should be implemented in a subclass driver.
//*********************************************************************************
-bool IOService::didYouWakeSystem ( void )
+bool IOService::didYouWakeSystem ( void )
{
return false;
}
+#endif /* !__LP64__ */
//*********************************************************************************
-// [public virtual] powerStateWillChangeTo
+// [public] powerStateWillChangeTo
//
// Does nothing here. This should be implemented in a subclass driver.
//*********************************************************************************
}
//*********************************************************************************
-// [public virtual] powerStateDidChangeTo
+// [public] powerStateDidChangeTo
//
// Does nothing here. This should be implemented in a subclass driver.
//*********************************************************************************
}
//*********************************************************************************
-// [public virtual] powerChangeDone
+// [protected] powerChangeDone
//
// Called from PM work loop thread.
// Does nothing here. This should be implemented in a subclass policy-maker.
{
}
+#ifndef __LP64__
//*********************************************************************************
-// [public virtual] newTemperature
+// [deprecated] newTemperature
//
// Does nothing here. This should be implemented in a subclass driver.
//*********************************************************************************
{
return IOPMNoErr;
}
+#endif /* !__LP64__ */
//*********************************************************************************
-// [public virtual] systemWillShutdown
+// [public] systemWillShutdown
//
// System shutdown and restart notification.
//*********************************************************************************
rootDomain->acknowledgeSystemWillShutdown( this );
}
+// MARK: -
+// MARK: PM State Machine
+
//*********************************************************************************
// [private static] acquirePMRequest
//*********************************************************************************
IOPMRequest *
-IOService::acquirePMRequest( IOService * target, IOOptionBits requestType )
+IOService::acquirePMRequest( IOService * target, IOOptionBits requestType,
+ IOPMRequest * active )
{
IOPMRequest * 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);
}
return request;
}
assert( gIOPMReplyQueue );
assert( gIOPMRequestQueue );
- PM_TRACE("[+ %02lx] %p [%p %s] %p %p %p\n",
- request->getType(), request,
+ 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);
- if (request->isReply())
+ if (request->isReplyType())
gIOPMReplyQueue->queuePMRequest( request );
else
gIOPMRequestQueue->queuePMRequest( request );
for (IOItemCount i = 0; i < count; i++)
{
IOPMRequest * req = requests[i];
- PM_TRACE("[+ %02lx] %p [%p %s] %p %p %p\n",
- req->getType(), req,
+ 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);
}
//*********************************************************************************
// [private] servicePMRequestQueue
+//
+// Called from IOPMRequestQueue::checkForWork().
//*********************************************************************************
bool IOService::servicePMRequestQueue(
IOPMRequest * request,
IOPMRequestQueue * queue )
{
- // Calling PM methods without PMinit() is not allowed, fail the requests.
-
- if (!initialized)
- {
- PM_DEBUG("[%s] %s: PM not initialized\n", getName(), __FUNCTION__);
- goto done;
- }
-
- // Create an IOPMWorkQueue on demand, when the initial PM request is
- // received.
+ bool more;
- if (!fPMWorkQueue)
- {
- // Allocate and attach an IOPMWorkQueue on demand to avoid taking
- // the work loop lock in PMinit(), which may deadlock with certain
- // drivers / families.
-
- fPMWorkQueue = IOPMWorkQueue::create(
- /* target */ this,
- /* Work */ OSMemberFunctionCast(IOPMWorkQueue::Action, this,
- &IOService::servicePMRequest),
- /* Done */ OSMemberFunctionCast(IOPMWorkQueue::Action, this,
- &IOService::retirePMRequest)
- );
-
- if (fPMWorkQueue &&
- (gIOPMWorkLoop->addEventSource(fPMWorkQueue) != kIOReturnSuccess))
- {
- PM_ERROR("[%s] %s: addEventSource failed\n",
- getName(), __FUNCTION__);
- fPMWorkQueue->release();
- fPMWorkQueue = 0;
- }
+ 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.
- if (!fPMWorkQueue)
- {
- PM_ERROR("[%s] %s: not ready (type %02lx)\n",
- getName(), __FUNCTION__, request->getType());
- goto done;
- }
- }
+ more = gIOPMWorkQueue->queuePMRequest(request, pwrMgt);
+ return more;
+ }
- fPMWorkQueue->queuePMRequest(request);
- return false; // do not signal more
+ // Calling PM without PMinit() is not allowed, fail the request.
-done:
- gIOPMFreeQueue->queuePMRequest( request );
- return false; // do not signal more
+ PM_LOG("%s: PM not initialized\n", getName());
+ fAdjustPowerScheduled = false;
+ more = gIOPMFreeQueue->queuePMRequest(request);
+ if (more) gIOPMWorkQueue->incrementProducerCount();
+ return more;
}
//*********************************************************************************
// [private] servicePMFreeQueue
//
-// Called by IOPMFreeQueue to recycle a completed request.
+// Called from IOPMCompletionQueue::checkForWork().
//*********************************************************************************
bool IOService::servicePMFreeQueue(
- IOPMRequest * request,
- IOPMRequestQueue * queue )
+ IOPMRequest * request,
+ IOPMCompletionQueue * queue )
{
- bool more = request->hasParentRequest();
+ bool more = request->getNextRequest();
+ IOPMRequest * root = request->getRootRequest();
+
+ if (root && (root != request))
+ more = true;
+ if (more)
+ gIOPMWorkQueue->incrementProducerCount();
+
releasePMRequest( request );
return more;
}
{
assert(request && queue);
- PM_TRACE("[- %02lx] %p [%p %s] State %ld, Busy %ld\n",
+ PM_LOG1("[- %02x] %p [%p %s] state %d, busy %d\n",
request->getType(), request, this, getName(),
fMachineState, gIOPMBusyCount);
- // Catch requests created by PM_idle_timer_expiration().
+ // Catch requests created by idleTimerExpired().
if ((request->getType() == kIOPMRequestTypeActivityTickle) &&
- (request->fArg1 == (void *) false))
+ (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();
+ }
else
- fActivityTimerStopped = true;
+ fIdleTimerStopped = true;
}
- gIOPMFreeQueue->queuePMRequest( request );
- return true;
+ // If the request is linked, then Work queue has already incremented its
+ // producer count.
+
+ return (gIOPMFreeQueue->queuePMRequest( request ));
}
//*********************************************************************************
// 5 = kDriverCallInformPreChange
// 6 = kDriverCallInformPostChange
// 7 = kDriverCallSetPowerState
- if (fDriverCallBusy) reason = 5 + fDriverCallReason;
+ if (fDriverCallBusy)
+ reason = 5 + fDriverCallReason;
break;
}
{
if (count)
{
- PM_TRACE("[B %02lx] %p [%p %s] State %ld, Reason %d\n",
+ PM_LOG1("[B %02x] %p [%p %s] state %d, reason %d\n",
request->getType(), request, this, getName(),
fMachineState, reason);
}
while (isPMBlocked(request, loop++) == false)
{
- PM_TRACE("[W %02lx] %p [%p %s] State %ld\n",
+ PM_LOG1("[W %02x] %p [%p %s] state %d\n",
request->getType(), request, this, getName(), fMachineState);
- fPMRequest = request;
+ gIOPMRequest = request;
+ gIOPMWorkCount++;
// Every PM machine states must be handled in one of the cases below.
break;
case kIOPM_OurChangeTellClientsPowerDown:
- // our change, was it vetoed?
+ // 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
- tellNoChangeDown(fHeadNoteState);
+ tellNoChangeDown(fHeadNotePowerState);
// mark the change note un-actioned
- fHeadNoteFlags |= IOPMNotDone;
+ fHeadNoteChangeFlags |= kIOPMNotDone;
// and we're done
- all_done();
+ OurChangeFinish();
}
break;
case kIOPM_OurChangeTellPriorityClientsPowerDown:
- // our change, should it be acted on still?
-#if SUPPORT_IDLE_CANCEL
+ // 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
tellChangeUp(fCurrentPowerState);
// mark the change note un-actioned
- fHeadNoteFlags |= IOPMNotDone;
+ fHeadNoteChangeFlags |= kIOPMNotDone;
// and we're done
- all_done();
+ OurChangeFinish();
}
else
-#endif
{
+ if (IS_ROOT_DOMAIN) {
+ PMEventDetails *details = PMEventDetails::eventDetails(
+ kIOPMEventTypeAppNotificationsFinished,
+ NULL,
+ 2, /* reason: 2 == TellPriorityClientsDone */
+ kIOReturnSuccess); /* result */
+
+ getPMRootDomain()->recordAndReleasePMEventGated( details );
+ }
// yes, we can continue
OurChangeTellPriorityClientsPowerDown();
}
OurChangeNotifyInterestedDriversDidChange();
break;
+ case kIOPM_OurChangeTellCapabilityDidChange:
+ OurChangeTellCapabilityDidChange();
+ break;
+
case kIOPM_OurChangeFinish:
OurChangeFinish();
break;
- case kIOPM_ParentDownTellPriorityClientsPowerDown:
- ParentDownTellPriorityClientsPowerDown();
+ case kIOPM_ParentChangeTellPriorityClientsPowerDown:
+ ParentChangeTellPriorityClientsPowerDown();
break;
- case kIOPM_ParentDownNotifyInterestedDriversWillChange:
- ParentDownNotifyInterestedDriversWillChange();
+ case kIOPM_ParentChangeNotifyInterestedDriversWillChange:
+ ParentChangeNotifyInterestedDriversWillChange();
break;
- case kIOPM_ParentDownNotifyDidChangeAndAcknowledgeChange:
- ParentDownNotifyDidChangeAndAcknowledgeChange();
+ case kIOPM_ParentChangeSetPowerState:
+ ParentChangeSetPowerState();
break;
- case kIOPM_ParentDownSetPowerState:
- ParentDownSetPowerState();
+ case kIOPM_ParentChangeWaitForPowerSettle:
+ ParentChangeWaitForPowerSettle();
break;
- case kIOPM_ParentDownWaitForPowerSettle:
- ParentDownWaitForPowerSettle();
+ case kIOPM_ParentChangeNotifyInterestedDriversDidChange:
+ ParentChangeNotifyInterestedDriversDidChange();
break;
- case kIOPM_ParentDownAcknowledgeChange:
- ParentDownAcknowledgeChange();
- break;
+ case kIOPM_ParentChangeTellCapabilityDidChange:
+ ParentChangeTellCapabilityDidChange();
+ break;
- case kIOPM_ParentUpSetPowerState:
- ParentUpSetPowerState();
+ case kIOPM_ParentChangeAcknowledgePowerChange:
+ ParentChangeAcknowledgePowerChange();
break;
- case kIOPM_ParentUpWaitForSettleTime:
- ParentUpWaitForSettleTime();
+ case kIOPM_DriverThreadCallDone:
+ if (fDriverCallReason == kDriverCallSetPowerState)
+ notifyControllingDriverDone();
+ else
+ notifyInterestedDriversDone();
break;
- case kIOPM_ParentUpNotifyInterestedDriversDidChange:
- ParentUpNotifyInterestedDriversDidChange();
+ case kIOPM_NotifyChildrenOrdered:
+ notifyChildrenOrdered();
break;
- case kIOPM_ParentUpAcknowledgePowerChange:
- ParentUpAcknowledgePowerChange();
+ case kIOPM_NotifyChildrenDelayed:
+ notifyChildrenDelayed();
break;
- case kIOPM_DriverThreadCallDone:
- if (fDriverCallReason == kDriverCallSetPowerState)
- notifyControllingDriverDone();
+ 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
- notifyInterestedDriversDone();
- break;
+ {
+ OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState);
+ PM_ERROR("%s: idle cancel\n", fName);
+ tellNoChangeDown(fHeadNotePowerState);
+ fHeadNoteChangeFlags |= kIOPMNotDone;
+ OurChangeFinish();
+ }
+ break;
- case kIOPM_NotifyChildrenDone:
- notifyChildrenDone();
+ 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();
+ }
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;
+
default:
- IOPanic("servicePMWorkQueue: unknown machine state");
+ panic("servicePMWorkQueue: unknown machine state %x",
+ fMachineState);
}
- fPMRequest = 0;
+ gIOPMRequest = 0;
if (fMachineState == kIOPM_Finished)
{
- //PM_TRACE("[%s] PM End: Request %p (type %02lx)\n",
- // getName(), request, request->getType());
done = true;
break;
}
break;
case kIOPMRequestTypeAdjustPowerState:
+ fAdjustPowerScheduled = false;
+ rebuildChildClampBits();
adjustPowerState();
break;
- case kIOPMRequestTypeMakeUsable:
- handleMakeUsable( request );
- break;
-
- case kIOPMRequestTypeTemporaryPowerClamp:
- fClampOn = true;
- handleMakeUsable( request );
- break;
-
case kIOPMRequestTypePowerDomainWillChange:
handlePowerDomainWillChangeTo( request );
break;
case kIOPMRequestTypePowerDomainDidChange:
+
handlePowerDomainDidChangeTo( request );
break;
- case kIOPMRequestTypeChangePowerStateTo:
- handleChangePowerStateTo( request );
- break;
-
- case kIOPMRequestTypeChangePowerStateToPriv:
- handleChangePowerStateToPriv( request );
+ case kIOPMRequestTypeRequestPowerState:
+ case kIOPMRequestTypeRequestPowerStateOverride:
+ handleRequestPowerState( request );
break;
case kIOPMRequestTypePowerOverrideOnPriv:
break;
case kIOPMRequestTypeActivityTickle:
- if (request)
- {
- bool setDeviceDesire = false;
+ handleActivityTickle( request );
+ break;
- if (request->fArg1)
- {
- // Power rise from activity tickle.
- unsigned long ticklePowerState = (unsigned long) request->fArg0;
- if ((fDeviceDesire < ticklePowerState) &&
- (ticklePowerState < fNumberOfPowerStates))
- {
- setDeviceDesire = true;
- fIdleTimerMinPowerState = ticklePowerState;
- }
- }
- else if (fDeviceDesire > fIdleTimerMinPowerState)
- {
- // Power drop from idle timer expiration.
- request->fArg0 = (void *) (fDeviceDesire - 1);
- setDeviceDesire = true;
- }
+ case kIOPMRequestTypeSynchronizePowerTree:
+ handleSynchronizePowerTree( request );
+ break;
- if (setDeviceDesire)
- {
- // handleChangePowerStateToPriv() does not check the
- // request type, as long as the args are appropriate
- // for kIOPMRequestTypeChangePowerStateToPriv.
+ case kIOPMRequestTypeSetIdleTimerPeriod:
+ {
+ fIdleTimerPeriod = (uintptr_t) request->fArg0;
- request->fArg1 = (void *) false;
- handleChangePowerStateToPriv( request );
- }
- }
- break;
+ if ((false == fLockedFlags.PMStop) && (fIdleTimerPeriod > 0))
+ {
+ fActivityTickleCount = 0;
+ clock_get_uptime(&fIdleTimerStartTime);
+ start_PM_idle_timer();
+ }
+ }
+ break;
default:
- IOPanic("executePMRequest: unknown request type");
+ panic("executePMRequest: unknown request type %x", request->getType());
}
}
bool more = false;
assert( request && queue );
- assert( request->isReply() );
+ assert( request->isReplyType() );
- PM_TRACE("[A %02lx] %p [%p %s] State %ld\n",
+ 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((unsigned long) request->fArg0, (int) request->fArg1))
+ if (responseValid((uint32_t)(uintptr_t) request->fArg0,
+ (int)(uintptr_t) request->fArg1))
{
if (kIOPMRequestTypeCancelPowerChange == request->getType())
- fDoNotPowerDown = true;
+ {
+ // 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();
- if ( fResponseArray )
- {
- fResponseArray->release();
- fResponseArray = NULL;
- }
+ cleanClientResponses(false);
more = true;
}
}
+ // 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:
// driver acked while setPowerState() call is in-flight.
// take this ack, return value from setPowerState() is irrelevant.
OUR_PMLog(kPMLogDriverAcknowledgeSet,
- (UInt32) this, fDriverTimer);
+ (uintptr_t) this, fDriverTimer);
fDriverTimer = 0;
}
else if (fDriverTimer > 0)
#if LOG_SETPOWER_TIMES
uint64_t nsec = computeTimeDeltaNS(&fDriverCallStartTime);
if (nsec > LOG_SETPOWER_TIMES)
- PM_DEBUG("%s::setPowerState(%p, %lu -> %lu) async took %d ms\n",
- fName, this, fCurrentPowerState, fHeadNoteState, NS_TO_MS(nsec));
+ 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, (UInt32) this, fDriverTimer);
+ OUR_PMLog(kPMLogDriverAcknowledgeSet, (uintptr_t) this, fDriverTimer);
fDriverTimer = 0;
more = true;
}
else
{
// unexpected ack
- OUR_PMLog(kPMLogAcknowledgeErr4, (UInt32) this, 0);
+ OUR_PMLog(kPMLogAcknowledgeErr4, (uintptr_t) this, 0);
}
break;
more = true;
break;
-#if SUPPORT_IDLE_CANCEL
case kIOPMRequestTypeIdleCancel:
if ((fMachineState == kIOPM_OurChangeTellClientsPowerDown)
- || (fMachineState == kIOPM_OurChangeTellPriorityClientsPowerDown))
+ || (fMachineState == kIOPM_OurChangeTellPriorityClientsPowerDown)
+ || (fMachineState == kIOPM_SyncTellClientsPowerDown)
+ || (fMachineState == kIOPM_SyncTellPriorityClientsPowerDown))
{
- OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, 0);
+ OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState);
+ PM_LOG2("%s: cancel from machine state %d\n",
+ getName(), fMachineState);
fDoNotPowerDown = true;
- if (fMachineState == kIOPM_OurChangeTellPriorityClientsPowerDown)
+ // Stop waiting for app replys.
+ if ((fMachineState == kIOPM_OurChangeTellPriorityClientsPowerDown) ||
+ (fMachineState == kIOPM_SyncTellPriorityClientsPowerDown))
cleanClientResponses(false);
more = true;
}
break;
-#endif
+
+ case kIOPMRequestTypeChildNotifyDelayCancel:
+ if (fMachineState == kIOPM_NotifyChildrenDelayed)
+ {
+ PM_LOG2("%s: delay notify cancelled\n", getName());
+ notifyChildrenDelayed();
+ }
+ break;
default:
- IOPanic("servicePMReplyQueue: unknown reply type");
+ panic("servicePMReplyQueue: unknown reply type %x",
+ request->getType());
}
- releasePMRequest( request );
+ more |= gIOPMFreeQueue->queuePMRequest(request);
+ if (more)
+ gIOPMWorkQueue->incrementProducerCount();
+
return more;
}
+//*********************************************************************************
+// [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;
+
+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);
+}
+
+//*********************************************************************************
+// [private] Debug helpers
+//*********************************************************************************
+
+const char * IOService::getIOMessageString( uint32_t msg )
+{
+#define MSG_ENTRY(x) {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 )
+ };
+
+ return IOFindNameForValue(msg, msgNames);
+}
+
+// MARK: -
+// MARK: IOPMRequest
+
//*********************************************************************************
// IOPMRequest Class
//
if (!IOCommand::init())
return false;
- fType = type;
- fTarget = target;
- fParent = 0;
- fChildCount = 0;
- fArg0 = fArg1 = fArg2 = 0;
+ fType = type;
+ fTarget = target;
+ fCompletionStatus = kIOReturnSuccess;
if (fTarget)
fTarget->retain();
void IOPMRequest::reset( void )
{
- assert( fChildCount == 0 );
+ assert( fWorkWaitCount == 0 );
+ assert( fFreeWaitCount == 0 );
+
+ detachNextRequest();
+ detachRootRequest();
fType = kIOPMRequestTypeInvalid;
- if (fParent)
+ if (fCompletionAction)
{
- fParent->fChildCount--;
- fParent = 0;
- }
+ fCompletionAction(fCompletionTarget, fCompletionParam, fCompletionStatus);
+ }
if (fTarget)
{
fTarget->release();
fTarget = 0;
- }
+ }
+}
+
+bool IOPMRequest::attachNextRequest( IOPMRequest * next )
+{
+ bool ok = false;
+
+ 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());
+#endif
+ ok = true;
+ }
+ return ok;
+}
+
+bool IOPMRequest::detachNextRequest( void )
+{
+ bool ok = false;
+
+ 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());
+#endif
+ fRequestNext = 0;
+ ok = true;
+ }
+ return ok;
+}
+
+bool IOPMRequest::attachRootRequest( IOPMRequest * root )
+{
+ bool ok = false;
+
+ 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());
+#endif
+ ok = true;
+ }
+ return ok;
+}
+
+bool IOPMRequest::detachRootRequest( void )
+{
+ bool ok = false;
+
+ 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());
+#endif
+ fRequestRoot = 0;
+ ok = true;
+ }
+ return ok;
}
+// MARK: -
+// MARK: IOPMRequestQueue
+
//*********************************************************************************
// IOPMRequestQueue Class
//
-// Global queues. As PM-aware drivers load and unload, their IOPMWorkQueue's are
-// created and deallocated. IOPMRequestQueue are created once and never released.
+// Global queues. Queues are created once and never released.
//*********************************************************************************
OSDefineMetaClassAndStructors( IOPMRequestQueue, IOEventSource );
return more;
}
-void IOPMRequestQueue::signalWorkAvailable( void )
-{
- IOEventSource::signalWorkAvailable();
-}
+// MARK: -
+// MARK: IOPMWorkQueue
//*********************************************************************************
// IOPMWorkQueue Class
//
-// Every object in the power plane that has handled a PM request, will have an
-// instance of IOPMWorkQueue allocated for it.
+// Queue of IOServicePM objects with busy IOPMRequest(s).
//*********************************************************************************
OSDefineMetaClassAndStructors( IOPMWorkQueue, IOEventSource );
queue_init(&fWorkQueue);
- fWorkAction = work;
- fRetireAction = retire;
+ fWorkAction = work;
+ fRetireAction = retire;
+ fConsumerCount = fProducerCount = 0;
return true;
}
-void IOPMWorkQueue::queuePMRequest( IOPMRequest * request )
+bool IOPMWorkQueue::queuePMRequest( IOPMRequest * request, IOServicePM * pwrMgt )
{
+ bool more = false;
+ bool empty;
+
assert( request );
+ assert( pwrMgt );
assert( onThread() );
+ assert( queue_next(&request->fCommandChain) ==
+ queue_prev(&request->fCommandChain) );
gIOPMBusyCount++;
- queue_enter(&fWorkQueue, request, IOPMRequest *, fCommandChain);
- checkForWork();
+
+ // 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::checkForWork( void )
+bool IOPMWorkQueue::checkRequestQueue( queue_head_t * queue, bool * empty )
{
IOPMRequest * request;
- IOService * target = (IOService *) owner;
- bool done;
+ IOService * target;
+ bool more = false;
+ bool done = false;
- while (!queue_empty(&fWorkQueue))
+ assert(!queue_empty(queue));
+ do {
+ request = (IOPMRequest *) queue_first(queue);
+ if (request->isWorkBlocked())
+ break; // cannot start, blocked on attached request
+
+ target = request->getTarget();
+ done = (*fWorkAction)( target, request, this );
+ if (!done)
+ break; // work started, blocked on PM state machine
+
+ assert(gIOPMBusyCount > 0);
+ if (gIOPMBusyCount)
+ gIOPMBusyCount--;
+
+ queue_remove_first(queue, request, IOPMRequest *, fCommandChain);
+ more |= (*fRetireAction)( target, request, this );
+ done = queue_empty(queue);
+ } while (!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++;
+ }
+
+ return more;
+}
+
+bool IOPMWorkQueue::checkForWork( void )
+{
+ IOServicePM * entry;
+ IOServicePM * next;
+ bool more = false;
+ bool empty;
+
+#if WORK_QUEUE_STATS
+ fStatCheckForWork++;
+#endif
+
+ // Each producer signal triggers a full iteration over
+ // all IOServicePM entries in the work queue.
+
+ while (fConsumerCount != fProducerCount)
+ {
+ PM_LOG3("IOPMWorkQueue: checkForWork %u %u\n",
+ fProducerCount, fConsumerCount);
+
+ fConsumerCount = fProducerCount;
+
+#if WORK_QUEUE_STATS
+ if (queue_empty(&fWorkQueue))
+ {
+ fStatQueueEmpty++;
+ break;
+ }
+ fStatScanEntries++;
+ uint32_t cachedWorkCount = gIOPMWorkCount;
+#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;
+ }
+
+#if WORK_QUEUE_STATS
+ if (cachedWorkCount == gIOPMWorkCount)
+ fStatNoWorkDone++;
+#endif
+ }
+
+ return more;
+}
+
+void IOPMWorkQueue::signalWorkAvailable( void )
+{
+ fProducerCount++;
+ IOEventSource::signalWorkAvailable();
+}
+
+void IOPMWorkQueue::incrementProducerCount( void )
+{
+ fProducerCount++;
+}
+
+// MARK: -
+// MARK: IOPMCompletionQueue
+
+//*********************************************************************************
+// IOPMCompletionQueue Class
+//*********************************************************************************
+
+OSDefineMetaClassAndStructors( IOPMCompletionQueue, IOEventSource );
+
+IOPMCompletionQueue *
+IOPMCompletionQueue::create( IOService * inOwner, Action inAction )
+{
+ IOPMCompletionQueue * me = OSTypeAlloc(IOPMCompletionQueue);
+ if (me && !me->init(inOwner, inAction))
{
- request = (IOPMRequest *) queue_first(&fWorkQueue);
- assert(request->getTarget() == target);
- if (request->hasChildRequest()) break;
- done = (*fWorkAction)( target, request, this );
- if (!done) break;
-
- assert(gIOPMBusyCount > 0);
- if (gIOPMBusyCount) gIOPMBusyCount--;
- queue_remove_first(&fWorkQueue, request, IOPMRequest *, fCommandChain);
- (*fRetireAction)( target, request, this );
+ me->release();
+ me = 0;
}
+ return me;
+}
- return false;
+bool IOPMCompletionQueue::init( IOService * inOwner, Action inAction )
+{
+ if (!inAction || !IOEventSource::init(inOwner, (IOEventSourceAction)inAction))
+ return false;
+
+ queue_init(&fQueue);
+ return true;
+}
+
+bool IOPMCompletionQueue::queuePMRequest( IOPMRequest * request )
+{
+ bool more;
+
+ assert(request);
+ // unblock dependent request
+ more = request->detachNextRequest();
+ queue_enter(&fQueue, request, IOPMRequest *, fCommandChain);
+ return more;
+}
+
+bool IOPMCompletionQueue::checkForWork( void )
+{
+ 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;
}
+// MARK: -
+// MARK: IOServicePM
+
OSDefineMetaClassAndStructors(IOServicePM, OSObject)
//*********************************************************************************
//*********************************************************************************
static void
-setPMProperty( OSDictionary * dict, const char * key, unsigned long value )
+setPMProperty( OSDictionary * dict, const char * key, uint64_t value )
{
OSNumber * num = OSNumber::withNumber(value, sizeof(value) * 8);
if (num)
}
}
-bool IOServicePM::serialize( OSSerialize * s ) const
+IOReturn IOServicePM::gatedSerialize( OSSerialize * s )
{
OSDictionary * dict;
bool ok = false;
+ int dictSize = 5;
+
+ if (IdleTimerPeriod)
+ dictSize += 4;
+
+#if WORK_QUEUE_STATS
+ if (gIOPMRootNode == ControllingDriver)
+ dictSize += 4;
+#endif
+
+ if (PowerClients)
+ dict = OSDictionary::withDictionary(
+ PowerClients, PowerClients->getCount() + dictSize);
+ else
+ dict = OSDictionary::withCapacity(dictSize);
- dict = OSDictionary::withCapacity(8);
if (dict)
{
- setPMProperty( dict, "CurrentPowerState", CurrentPowerState );
+ setPMProperty(dict, "CurrentPowerState", CurrentPowerState);
+ if (NumberOfPowerStates)
+ setPMProperty(dict, "MaxPowerState", NumberOfPowerStates-1);
if (DesiredPowerState != CurrentPowerState)
- setPMProperty( dict, "DesiredPowerState", DesiredPowerState );
+ setPMProperty(dict, "DesiredPowerState", DesiredPowerState);
if (kIOPM_Finished != MachineState)
- setPMProperty( dict, "MachineState", MachineState );
- if (ChildrenDesire)
- setPMProperty( dict, "ChildrenPowerState", ChildrenDesire );
- if (DeviceDesire)
- setPMProperty( dict, "DeviceChangePowerState", DeviceDesire );
- if (DriverDesire)
- setPMProperty( dict, "DriverChangePowerState", DriverDesire );
- if (DeviceOverrides)
- dict->setObject( "PowerOverrideOn", kOSBooleanTrue );
+ setPMProperty(dict, "MachineState", MachineState);
+ if (DeviceOverrideEnabled)
+ dict->setObject("PowerOverrideOn", kOSBooleanTrue);
+
+ if (IdleTimerPeriod)
+ {
+ AbsoluteTime now;
+ AbsoluteTime delta;
+ uint64_t nsecs;
+
+ clock_get_uptime(&now);
+
+ // The idle timer period in milliseconds.
+ setPMProperty(dict, "IdleTimerPeriod", IdleTimerPeriod * 1000ULL);
+
+ // The number of activity tickles recorded since device idle
+ 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(&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 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);
+ }
+#endif
ok = dict->serialize(s);
dict->release();
}
- return ok;
+ return (ok ? kIOReturnSuccess : kIOReturnNoMemory);
+}
+
+bool IOServicePM::serialize( OSSerialize * s ) const
+{
+ IOReturn ret = kIOReturnNotReady;
+
+ 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;
+}
+
projects / apple / xnu.git / blobdiff