#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/IOEventSource.h>
#include <IOKit/IOWorkLoop.h>
#include <IOKit/IOCommand.h>
#include <IOKit/pwr_mgt/IOPMlog.h>
#include <IOKit/pwr_mgt/IOPMinformee.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>
#include "IOServicePrivate.h"
#include "IOServicePMPrivate.h"
#include "IOKitKernelInternal.h"
static void settle_timer_expired(thread_call_param_t, thread_call_param_t);
static void idle_timer_expired(thread_call_param_t, thread_call_param_t);
static void tellKernelClientApplier(OSObject * object, void * arg);
static void tellAppClientApplier(OSObject * object, void * arg);
static uint64_t computeTimeDeltaNS( const AbsoluteTime * start )
{
AbsoluteTime now;
uint64_t nsec;
clock_get_uptime(&now);
SUB_ABSOLUTETIME(&now, start);
absolutetime_to_nanoseconds(now, &nsec);
return nsec;
}
#if PM_VARS_SUPPORT
OSDefineMetaClassAndStructors(IOPMprot, OSObject)
#endif
OSDefineMetaClassAndStructors( PMEventDetails, OSObject );
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;
}
#define PM_ERROR(x...) do { kprintf(x); IOLog(x); } while (false)
#define PM_LOG(x...) do { kprintf(x); } while (false)
#define PM_LOG1(x...) do { \
if (kIOLogDebugPower & gIOKitDebug) \
kprintf(x); } while (false)
#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 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_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 OUR_PMLog(t, a, b) \
do { gPlatform->PMLog( fName, t, a, b); } while(0)
#define NS_TO_MS(nsec) ((int)((nsec) / 1000000ULL))
#define NS_TO_US(nsec) ((int)((nsec) / 1000ULL))
#if CONFIG_EMBEDDED
#define SUPPORT_IDLE_CANCEL 1
#endif
#define kIOPMPowerStateMax 0xFFFFFFFF
#define IS_PM_ROOT (this == gIOPMRootNode)
#define IS_ROOT_DOMAIN (getPMRootDomain() == this)
#define IS_POWER_DROP (fHeadNotePowerState < fCurrentPowerState)
#define IS_POWER_RISE (fHeadNotePowerState > fCurrentPowerState)
#define LOG_SETPOWER_TIMES (50ULL * 1000ULL * 1000ULL)
#define LOG_APP_RESPONSE_TIMES (100ULL * 1000ULL * 1000ULL)
#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)
enum {
kIOPM_Finished = 0,
kIOPM_OurChangeTellClientsPowerDown = 1,
kIOPM_OurChangeTellPriorityClientsPowerDown = 2,
kIOPM_OurChangeNotifyInterestedDriversWillChange = 3,
kIOPM_OurChangeSetPowerState = 4,
kIOPM_OurChangeWaitForPowerSettle = 5,
kIOPM_OurChangeNotifyInterestedDriversDidChange = 6,
kIOPM_OurChangeTellCapabilityDidChange = 7,
kIOPM_OurChangeFinish = 8,
kIOPM_ParentChangeTellPriorityClientsPowerDown = 10,
kIOPM_ParentChangeNotifyInterestedDriversWillChange = 11,
kIOPM_ParentChangeSetPowerState = 12,
kIOPM_ParentChangeWaitForPowerSettle = 13,
kIOPM_ParentChangeNotifyInterestedDriversDidChange = 14,
kIOPM_ParentChangeTellCapabilityDidChange = 15,
kIOPM_ParentChangeAcknowledgePowerChange = 16,
kIOPM_NotifyChildrenStart = 17,
kIOPM_NotifyChildrenOrdered = 18,
kIOPM_NotifyChildrenDelayed = 19,
kIOPM_SyncTellClientsPowerDown = 20,
kIOPM_SyncTellPriorityClientsPowerDown = 21,
kIOPM_SyncNotifyWillChange = 22,
kIOPM_SyncNotifyDidChange = 23,
kIOPM_SyncTellCapabilityDidChange = 24,
kIOPM_SyncFinish = 25,
kIOPM_TellCapabilityChangeDone = 26,
kIOPM_DriverThreadCallDone = 27,
kIOPM_BadMachineState = 0xFFFFFFFF
};
void IOService::PMinit ( void )
{
if ( !initialized )
{
if ( !gIOPMInitialized )
{
gPlatform = getPlatform();
gIOPMWorkLoop = IOWorkLoop::workLoop();
if (gIOPMWorkLoop)
{
gIOPMRequestQueue = IOPMRequestQueue::create(
this, OSMemberFunctionCast(IOPMRequestQueue::Action,
this, &IOService::servicePMRequestQueue));
gIOPMReplyQueue = IOPMRequestQueue::create(
this, OSMemberFunctionCast(IOPMRequestQueue::Action,
this, &IOService::servicePMReplyQueue));
gIOPMWorkQueue = IOPMWorkQueue::create(
this,
OSMemberFunctionCast(IOPMWorkQueue::Action, this,
&IOService::servicePMRequest),
OSMemberFunctionCast(IOPMWorkQueue::Action, this,
&IOService::retirePMRequest));
gIOPMFreeQueue = IOPMCompletionQueue::create(
this, OSMemberFunctionCast(IOPMCompletionQueue::Action,
this, &IOService::servicePMFreeQueue));
if (gIOPMWorkLoop->addEventSource(gIOPMRequestQueue) !=
kIOReturnSuccess)
{
gIOPMRequestQueue->release();
gIOPMRequestQueue = 0;
}
if (gIOPMWorkLoop->addEventSource(gIOPMReplyQueue) !=
kIOReturnSuccess)
{
gIOPMReplyQueue->release();
gIOPMReplyQueue = 0;
}
if (gIOPMWorkLoop->addEventSource(gIOPMWorkQueue) !=
kIOReturnSuccess)
{
gIOPMWorkQueue->release();
gIOPMWorkQueue = 0;
}
if (gIOPMWorkLoop->addEventSource(gIOPMFreeQueue) !=
kIOReturnSuccess)
{
gIOPMFreeQueue->release();
gIOPMFreeQueue = 0;
}
gIOPMPowerClientDevice =
OSSymbol::withCStringNoCopy( "DevicePowerState" );
gIOPMPowerClientDriver =
OSSymbol::withCStringNoCopy( "DriverPowerState" );
gIOPMPowerClientChildProxy =
OSSymbol::withCStringNoCopy( "ChildProxyPowerState" );
gIOPMPowerClientChildren =
OSSymbol::withCStringNoCopy( "ChildrenPowerState" );
}
if (gIOPMRequestQueue && gIOPMReplyQueue && gIOPMFreeQueue)
gIOPMInitialized = true;
}
if (!gIOPMInitialized)
return;
pwrMgt = new IOServicePM;
pwrMgt->init();
setProperty(kPwrMgtKey, pwrMgt);
queue_init(&pwrMgt->WorkChain);
queue_init(&pwrMgt->RequestHead);
queue_init(&pwrMgt->PMDriverCallQueue);
fOwner = this;
fPMLock = IOLockAlloc();
fInterestedDrivers = new IOPMinformeeList;
fInterestedDrivers->initialize();
fDesiredPowerState = 0;
fDeviceDesire = 0;
fInitialPowerChange = true;
fInitialSetPowerState = true;
fPreviousRequestPowerFlags = 0;
fDeviceOverrideEnabled = false;
fMachineState = kIOPM_Finished;
fSavedMachineState = kIOPM_BadMachineState;
fIdleTimerMinPowerState = 0;
fActivityLock = IOLockAlloc();
fStrictTreeOrder = false;
fActivityTicklePowerState = -1;
fControllingDriver = NULL;
fPowerStates = NULL;
fNumberOfPowerStates = 0;
fCurrentPowerState = 0;
fParentsCurrentPowerFlags = 0;
fMaxPowerState = 0;
fName = getName();
fParentsKnowState = false;
fSerialNumber = 0;
fResponseArray = NULL;
fNotifyClientArray = NULL;
fCurrentPowerConsumption = kIOPMUnknown;
fOverrideMaxPowerState = kIOPMPowerStateMax;
if (!gIOPMRootNode && (getParentEntry(gIOPowerPlane) == getRegistryRoot()))
{
gIOPMRootNode = this;
fParentsKnowState = true;
}
fAckTimer = thread_call_allocate(
&IOService::ack_timer_expired, (thread_call_param_t)this);
fSettleTimer = thread_call_allocate(
&settle_timer_expired, (thread_call_param_t)this);
fIdleTimer = thread_call_allocate(
&idle_timer_expired, (thread_call_param_t)this);
fDriverCallEntry = thread_call_allocate(
(thread_call_func_t) &IOService::pmDriverCallout, this);
assert(fDriverCallEntry);
if (OSMemberFunctionCast(void (*)(void),
getResourceService(), &IOService::powerChangeDone) !=
OSMemberFunctionCast(void (*)(void),
this, &IOService::powerChangeDone))
{
fPCDFunctionOverride = true;
}
#if PM_VARS_SUPPORT
IOPMprot * prot = new IOPMprot;
if (prot)
{
prot->init();
prot->ourName = fName;
prot->thePlatform = gPlatform;
fPMVars = prot;
pm_vars = prot;
}
#else
pm_vars = (void *) (uintptr_t) true;
#endif
initialized = true;
}
}
void IOService::PMfree ( void )
{
initialized = false;
pm_vars = 0;
if ( pwrMgt )
{
assert(fMachineState == kIOPM_Finished);
assert(fInsertInterestSet == NULL);
assert(fRemoveInterestSet == NULL);
assert(fNotifyChildArray == NULL);
assert(queue_empty(&pwrMgt->RequestHead));
assert(queue_empty(&fPMDriverCallQueue));
if ( fSettleTimer ) {
thread_call_cancel(fSettleTimer);
thread_call_free(fSettleTimer);
fSettleTimer = NULL;
}
if ( fAckTimer ) {
thread_call_cancel(fAckTimer);
thread_call_free(fAckTimer);
fAckTimer = NULL;
}
if ( fIdleTimer ) {
thread_call_cancel(fIdleTimer);
thread_call_free(fIdleTimer);
fIdleTimer = NULL;
}
if ( fDriverCallEntry ) {
thread_call_free(fDriverCallEntry);
fDriverCallEntry = NULL;
}
if ( fPMLock ) {
IOLockFree(fPMLock);
fPMLock = NULL;
}
if ( fActivityLock ) {
IOLockFree(fActivityLock);
fActivityLock = NULL;
}
if ( fInterestedDrivers ) {
fInterestedDrivers->release();
fInterestedDrivers = NULL;
}
if (fDriverCallParamSlots && fDriverCallParamPtr) {
IODelete(fDriverCallParamPtr, DriverCallParam, fDriverCallParamSlots);
fDriverCallParamPtr = 0;
fDriverCallParamSlots = 0;
}
if ( fResponseArray ) {
fResponseArray->release();
fResponseArray = NULL;
}
if ( fNotifyClientArray ) {
fNotifyClientArray->release();
fNotifyClientArray = NULL;
}
if (fPowerStates && fNumberOfPowerStates) {
IODelete(fPowerStates, IOPMPSEntry, fNumberOfPowerStates);
fNumberOfPowerStates = 0;
fPowerStates = NULL;
}
if (fPowerClients) {
fPowerClients->release();
fPowerClients = 0;
}
#if PM_VARS_SUPPORT
if (fPMVars)
{
fPMVars->release();
fPMVars = 0;
}
#endif
pwrMgt->release();
pwrMgt = 0;
}
}
void IOService::joinPMtree ( IOService * driver )
{
IOPlatformExpert * platform;
platform = getPlatform();
assert(platform != 0);
platform->PMRegisterDevice(this, driver);
}
#ifndef __LP64__
IOReturn IOService::youAreRoot ( void )
{
return IOPMNoErr;
}
#endif
void IOService::PMstop ( void )
{
IOPMRequest * request;
if (!initialized)
return;
PM_LOCK();
if (fLockedFlags.PMStop)
{
PM_LOG2("%s: PMstop() already stopped\n", fName);
PM_UNLOCK();
return;
}
fLockedFlags.PMStop = true;
waitForPMDriverCall();
PM_UNLOCK();
request = acquirePMRequest( this, kIOPMRequestTypePMStop );
if (request)
{
PM_LOG2("%s: %p PMstop\n", getName(), this);
submitPMRequest( request );
}
}
void IOService::handlePMstop ( IOPMRequest * request )
{
OSIterator * iter;
OSObject * next;
IOPowerConnection * connection;
IOService * theChild;
IOService * theParent;
PM_ASSERT_IN_GATE();
PM_LOG2("%s: %p %s start\n", getName(), this, __FUNCTION__);
removeProperty(kPwrMgtKey);
iter = getParentIterator(gIOPowerPlane);
if ( iter )
{
while ( (next = iter->getNextObject()) )
{
if ( (connection = OSDynamicCast(IOPowerConnection, next)) )
{
theParent = (IOService *)connection->copyParentEntry(gIOPowerPlane);
if ( theParent )
{
theParent->removePowerChild(connection);
theParent->release();
}
}
}
iter->release();
}
detachAbove( gIOPowerPlane );
fParentsKnowState = false;
iter = getChildIterator(gIOPowerPlane);
if ( iter )
{
while ( (next = iter->getNextObject()) )
{
if ( (connection = OSDynamicCast(IOPowerConnection, next)) )
{
theChild = ((IOService *)(connection->copyChildEntry(gIOPowerPlane)));
if ( theChild )
{
connection->detachFromChild(theChild, gIOPowerPlane);
theChild->release();
}
detachFromChild(connection, gIOPowerPlane);
}
}
iter->release();
}
if ( fInterestedDrivers )
{
IOPMinformeeList * list = fInterestedDrivers;
IOPMinformee * item;
PM_LOCK();
while ((item = list->firstInList()))
{
list->removeFromList(item->whatObject);
}
PM_UNLOCK();
}
fIdleTimerPeriod = 0;
if (fIdleTimer && thread_call_cancel(fIdleTimer))
release();
PM_LOG2("%s: %p %s done\n", getName(), this, __FUNCTION__);
}
IOReturn IOService::addPowerChild ( IOService * child )
{
IOPowerConnection * connection = 0;
IOPMRequest * requests[3] = {0, 0, 0};
OSIterator * iter;
bool ok = true;
if (!child)
return kIOReturnBadArgument;
if (!initialized || !child->initialized)
return IOPMNotYetInitialized;
OUR_PMLog( kPMLogAddChild, (uintptr_t) child, 0 );
do {
iter = child->getParentIterator( gIOPowerPlane );
if ( iter )
{
IORegistryEntry * entry;
OSObject * next;
while ((next = iter->getNextObject()))
{
if ((entry = OSDynamicCast(IORegistryEntry, next)) &&
isChild(entry, gIOPowerPlane))
{
ok = false;
break;
}
}
iter->release();
}
if (!ok)
{
PM_LOG("%s: %s (%p) is already a child\n",
getName(), child->getName(), child);
break;
}
connection = new IOPowerConnection;
if (!connection)
break;
requests[0] = acquirePMRequest(
this,
kIOPMRequestTypeAddPowerChild1 );
requests[1] = acquirePMRequest(
child,
kIOPMRequestTypeAddPowerChild2 );
requests[2] = acquirePMRequest(
this,
kIOPMRequestTypeAddPowerChild3 );
if (!requests[0] || !requests[1] || !requests[2])
break;
requests[0]->attachNextRequest( requests[1] );
requests[1]->attachNextRequest( requests[2] );
connection->init();
connection->start(this);
connection->setAwaitingAck(false);
connection->setReadyFlag(false);
attachToChild( connection, gIOPowerPlane );
connection->attachToChild( child, gIOPowerPlane );
requests[0]->fArg0 = connection;
requests[1]->fArg0 = connection;
requests[2]->fArg0 = connection;
submitPMRequest( requests, 3 );
return kIOReturnSuccess;
}
while (false);
if (connection) connection->release();
if (requests[0]) releasePMRequest(requests[0]);
if (requests[1]) releasePMRequest(requests[1]);
if (requests[2]) releasePMRequest(requests[2]);
return kIOReturnSuccess;
}
void IOService::addPowerChild1 ( IOPMRequest * request )
{
unsigned long tempDesire = 0;
PM_ASSERT_IN_GATE();
OUR_PMLog( kPMLogMakeUsable, kPMLogMakeUsable, 0 );
if (fControllingDriver && inPlane(gIOPowerPlane) && fParentsKnowState)
{
tempDesire = fNumberOfPowerStates - 1;
}
if (tempDesire && (IS_PM_ROOT || (fMaxPowerState >= tempDesire)))
{
adjustPowerState(tempDesire);
}
}
void IOService::addPowerChild2 ( IOPMRequest * request )
{
IOPowerConnection * connection = (IOPowerConnection *) request->fArg0;
IOService * parent;
IOPMPowerFlags powerFlags;
bool knowsState;
unsigned long powerState;
unsigned long tempDesire;
PM_ASSERT_IN_GATE();
parent = (IOService *) connection->getParentEntry(gIOPowerPlane);
if (!parent || !inPlane(gIOPowerPlane))
{
PM_LOG("%s: addPowerChild2 not in power plane\n", getName());
return;
}
knowsState = (parent->fPowerStates) && (parent->fParentsKnowState);
powerState = parent->fCurrentPowerState;
if (knowsState)
powerFlags = parent->fPowerStates[powerState].outputPowerFlags;
else
powerFlags = 0;
OUR_PMLog(kPMLogSetParent, knowsState, powerFlags);
setParentInfo( powerFlags, connection, knowsState );
connection->setReadyFlag(true);
if ( fControllingDriver && fParentsKnowState )
{
fMaxPowerState = fControllingDriver->maxCapabilityForDomainState(fParentsCurrentPowerFlags);
tempDesire = fControllingDriver->initialPowerStateForDomainState(fParentsCurrentPowerFlags);
fPreviousRequestPowerFlags = (IOPMPowerFlags)(-1);
adjustPowerState(tempDesire);
}
getPMRootDomain()->tagPowerPlaneService(this, &fPMActions);
}
void IOService::addPowerChild3 ( IOPMRequest * request )
{
IOPowerConnection * connection = (IOPowerConnection *) request->fArg0;
IOService * child;
IOPMrootDomain * rootDomain = getPMRootDomain();
PM_ASSERT_IN_GATE();
child = (IOService *) connection->getChildEntry(gIOPowerPlane);
if (child && inPlane(gIOPowerPlane))
{
if (child->getProperty("IOPMStrictTreeOrder"))
{
PM_LOG1("%s: strict PM order enforced\n", getName());
fStrictTreeOrder = true;
}
if (rootDomain)
rootDomain->joinAggressiveness( child );
}
else
{
PM_LOG("%s: addPowerChild3 not in power plane\n", getName());
}
connection->release();
}
#ifndef __LP64__
IOReturn IOService::setPowerParent (
IOPowerConnection * theParent, bool stateKnown, IOPMPowerFlags powerFlags )
{
return kIOReturnUnsupported;
}
#endif
IOReturn IOService::removePowerChild ( IOPowerConnection * theNub )
{
IORegistryEntry * theChild;
PM_ASSERT_IN_GATE();
OUR_PMLog( kPMLogRemoveChild, 0, 0 );
theNub->retain();
theChild = theNub->copyChildEntry(gIOPowerPlane);
if ( theChild )
{
theNub->detachFromChild(theChild, gIOPowerPlane);
theChild->release();
}
detachFromChild(theNub, gIOPowerPlane);
if ( theNub->getAwaitingAck() )
{
theNub->setAwaitingAck(false);
if (fHeadNotePendingAcks != 0 )
{
fHeadNotePendingAcks--;
if ( fHeadNotePendingAcks == 0 )
{
stop_ack_timer();
gIOPMWorkQueue->incrementProducerCount();
}
}
}
theNub->release();
if (!fAdjustPowerScheduled)
{
IOPMRequest * request;
request = acquirePMRequest( this, kIOPMRequestTypeAdjustPowerState );
if (request)
{
submitPMRequest( request );
fAdjustPowerScheduled = true;
}
}
return IOPMNoErr;
}
IOReturn IOService::registerPowerDriver (
IOService * powerDriver,
IOPMPowerState * powerStates,
unsigned long numberOfStates )
{
IOPMRequest * request;
IOPMPSEntry * powerStatesCopy = 0;
if (!initialized)
return IOPMNotYetInitialized;
if (!powerStates || (numberOfStates < 2))
{
OUR_PMLog(kPMLogControllingDriverErr5, numberOfStates, 0);
return kIOReturnBadArgument;
}
if (!powerDriver || !powerDriver->initialized)
{
OUR_PMLog(kPMLogControllingDriverErr4, 0, 0);
return kIOReturnBadArgument;
}
if (powerStates[0].version != kIOPMPowerStateVersion1)
{
OUR_PMLog(kPMLogControllingDriverErr1, powerStates[0].version, 0);
return kIOReturnBadArgument;
}
do {
powerStatesCopy = IONew(IOPMPSEntry, numberOfStates);
if (!powerStatesCopy)
break;
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)
break;
powerDriver->retain();
request->fArg0 = (void *) powerDriver;
request->fArg1 = (void *) powerStatesCopy;
request->fArg2 = (void *) numberOfStates;
submitPMRequest( request );
return kIOReturnSuccess;
}
while (false);
if (powerStatesCopy)
IODelete(powerStatesCopy, IOPMPSEntry, numberOfStates);
return kIOReturnNoMemory;
}
void IOService::handleRegisterPowerDriver ( IOPMRequest * request )
{
IOService * powerDriver = (IOService *) request->fArg0;
IOPMPSEntry * powerStates = (IOPMPSEntry *) request->fArg1;
unsigned long numberOfStates = (unsigned long) request->fArg2;
unsigned long i;
IOService * root;
OSIterator * iter;
PM_ASSERT_IN_GATE();
assert(powerStates);
assert(powerDriver);
assert(numberOfStates > 1);
if ( !fNumberOfPowerStates )
{
OUR_PMLog(kPMLogControllingDriver,
(unsigned long) numberOfStates,
(unsigned long) kIOPMPowerStateVersion1);
fPowerStates = powerStates;
fNumberOfPowerStates = numberOfStates;
fControllingDriver = powerDriver;
fCurrentCapabilityFlags = fPowerStates[0].capabilityFlags;
fOutputPowerCharacterFlags = 0;
for ( i = 0; i < numberOfStates; i++ ) {
fOutputPowerCharacterFlags |= fPowerStates[i].outputPowerFlags;
}
root = getPlatform()->getProvider();
assert(root);
if (!root ||
((OSMemberFunctionCast(void (*)(void),
root, &IOService::powerStateDidChangeTo)) !=
((OSMemberFunctionCast(void (*)(void),
this, &IOService::powerStateDidChangeTo)))) ||
((OSMemberFunctionCast(void (*)(void),
root, &IOService::powerStateWillChangeTo)) !=
((OSMemberFunctionCast(void (*)(void),
this, &IOService::powerStateWillChangeTo)))))
{
if (fInterestedDrivers->findItem(powerDriver) == NULL)
{
PM_LOCK();
fInterestedDrivers->appendNewInformee(powerDriver);
PM_UNLOCK();
}
}
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;
fMaxPowerState = fControllingDriver->maxCapabilityForDomainState(fParentsCurrentPowerFlags);
tempDesire = fControllingDriver->initialPowerStateForDomainState(fParentsCurrentPowerFlags);
adjustPowerState(tempDesire);
}
}
else
{
OUR_PMLog(kPMLogControllingDriverErr2, numberOfStates, 0);
IODelete(powerStates, IOPMPSEntry, numberOfStates);
}
powerDriver->release();
}
IOPMPowerFlags IOService::registerInterestedDriver ( IOService * driver )
{
IOPMRequest * request;
bool signal;
if (!driver || !initialized || !fInterestedDrivers)
return 0;
PM_LOCK();
signal = (!fInsertInterestSet && !fRemoveInterestSet);
if (fInsertInterestSet == NULL)
fInsertInterestSet = OSSet::withCapacity(4);
if (fInsertInterestSet)
{
fInsertInterestSet->setObject(driver);
if (fRemoveInterestSet)
fRemoveInterestSet->removeObject(driver);
}
PM_UNLOCK();
if (signal)
{
request = acquirePMRequest( this, kIOPMRequestTypeInterestChanged );
if (request)
submitPMRequest( request );
}
OUR_PMLog(kPMLogInterestedDriver, kIOPMDeviceUsable, 2);
return kIOPMDeviceUsable;
}
IOReturn IOService::deRegisterInterestedDriver ( IOService * driver )
{
IOPMinformeeList * list;
IOPMinformee * item;
IOPMRequest * request;
bool signal;
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;
waitForPMDriverCall( driver );
}
}
PM_UNLOCK();
if (signal)
{
request = acquirePMRequest( this, kIOPMRequestTypeInterestChanged );
if (request)
submitPMRequest( request );
}
return IOPMNoErr;
}
void IOService::handleInterestChanged( IOPMRequest * request )
{
IOService * driver;
IOPMinformee * informee;
IOPMinformeeList * list = fInterestedDrivers;
PM_LOCK();
if (fInsertInterestSet)
{
while ((driver = (IOService *) fInsertInterestSet->getAnyObject()))
{
if (list->findItem(driver) == NULL)
{
informee = list->appendNewInformee(driver);
}
fInsertInterestSet->removeObject(driver);
}
fInsertInterestSet->release();
fInsertInterestSet = 0;
}
if (fRemoveInterestSet)
{
while ((driver = (IOService *) fRemoveInterestSet->getAnyObject()))
{
informee = list->findItem(driver);
if (informee)
{
if (fHeadNotePendingAcks && informee->timer)
{
informee->timer = 0;
fHeadNotePendingAcks--;
}
list->removeFromList(driver);
}
fRemoveInterestSet->removeObject(driver);
}
fRemoveInterestSet->release();
fRemoveInterestSet = 0;
}
PM_UNLOCK();
}
IOReturn IOService::acknowledgePowerChange ( IOService * whichObject )
{
IOPMRequest * request;
if (!initialized)
return IOPMNotYetInitialized;
if (!whichObject)
return kIOReturnBadArgument;
request = acquirePMRequest( this, kIOPMRequestTypeAckPowerChange );
if (!request)
return kIOReturnNoMemory;
whichObject->retain();
request->fArg0 = whichObject;
submitPMRequest( request );
return IOPMNoErr;
}
bool IOService::handleAcknowledgePowerChange ( IOPMRequest * request )
{
IOPMinformee * informee;
unsigned long childPower = kIOPMUnknown;
IOService * theChild;
IOService * whichObject;
bool all_acked = false;
PM_ASSERT_IN_GATE();
whichObject = (IOService *) request->fArg0;
assert(whichObject);
informee = fInterestedDrivers->findItem( whichObject );
if ( informee == NULL )
{
if ( !isChild(whichObject, gIOPowerPlane) )
{
OUR_PMLog(kPMLogAcknowledgeErr1, 0, 0);
goto no_err;
} else {
OUR_PMLog(kPMLogChildAcknowledge, fHeadNotePendingAcks, 0);
}
} else {
OUR_PMLog(kPMLogDriverAcknowledge, fHeadNotePendingAcks, 0);
}
if ( fHeadNotePendingAcks != 0 )
{
assert(fPowerStates != NULL);
if ( informee != NULL )
{
if ( informee->timer != 0 )
{
#if LOG_SETPOWER_TIMES
if (informee->timer > 0)
{
uint64_t nsec = computeTimeDeltaNS(&informee->startTime);
if (nsec > LOG_SETPOWER_TIMES)
PM_LOG("%s::powerState%sChangeTo(%p, %s, %lu -> %lu) async took %d ms\n",
informee->whatObject->getName(),
(fDriverCallReason == kDriverCallInformPreChange) ? "Will" : "Did",
informee->whatObject,
fName, fCurrentPowerState, fHeadNotePowerState, NS_TO_US(nsec));
uint16_t logType = (fDriverCallReason == kDriverCallInformPreChange)
? kIOPMEventTypePSWillChangeTo
: kIOPMEventTypePSDidChangeTo;
PMEventDetails *details = PMEventDetails::eventDetails(
logType,
fName,
(uintptr_t)this,
informee->whatObject->getName(),
0, 0, 0,
NS_TO_MS(nsec));
getPMRootDomain()->recordAndReleasePMEventGated( details );
}
#endif
informee->timer = 0;
fHeadNotePendingAcks--;
} else {
OUR_PMLog(kPMLogAcknowledgeErr2, 0, 0);
}
} else {
if ( ((IOPowerConnection *)whichObject)->getAwaitingAck() )
{
fHeadNotePendingAcks--;
((IOPowerConnection *)whichObject)->setAwaitingAck(false);
theChild = (IOService *)whichObject->copyChildEntry(gIOPowerPlane);
if ( theChild )
{
childPower = theChild->currentPowerConsumption();
theChild->release();
}
if ( childPower == kIOPMUnknown )
{
fHeadNotePowerArrayEntry->staticPower = kIOPMUnknown;
} else {
if (fHeadNotePowerArrayEntry->staticPower != kIOPMUnknown)
{
fHeadNotePowerArrayEntry->staticPower += childPower;
}
}
}
}
if ( fHeadNotePendingAcks == 0 ) {
stop_ack_timer();
all_acked = true;
}
} else {
OUR_PMLog(kPMLogAcknowledgeErr3, 0, 0); }
no_err:
if (whichObject)
whichObject->release();
return all_acked;
}
IOReturn IOService::acknowledgeSetPowerState ( void )
{
IOPMRequest * request;
if (!initialized)
return IOPMNotYetInitialized;
request = acquirePMRequest( this, kIOPMRequestTypeAckSetPowerState );
if (!request)
return kIOReturnNoMemory;
submitPMRequest( request );
return kIOReturnSuccess;
}
void IOService::adjustPowerState ( uint32_t clamp )
{
PM_ASSERT_IN_GATE();
computeDesiredState(clamp);
if (fControllingDriver && fParentsKnowState && inPlane(gIOPowerPlane))
{
IOPMPowerChangeFlags changeFlags = kIOPMSelfInitiated;
if (getPMRequestType() == kIOPMRequestTypeRequestPowerStateOverride)
changeFlags |= (kIOPMIgnoreChildren | kIOPMSkipAskPowerDown);
startPowerChange(
changeFlags,
fDesiredPowerState,
0,
0,
0);
}
}
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;
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;
}
void IOService::handleSynchronizePowerTree ( IOPMRequest * request )
{
PM_ASSERT_IN_GATE();
if (fControllingDriver && fParentsKnowState && inPlane(gIOPowerPlane) &&
(fCurrentPowerState == fNumberOfPowerStates - 1))
{
IOOptionBits options = (uintptr_t) request->fArg0;
startPowerChange(
kIOPMSelfInitiated | kIOPMSynchronize |
(options & kIOPMSyncNoChildNotify),
fCurrentPowerState,
0,
0,
0);
}
}
#ifndef __LP64__
IOReturn IOService::powerDomainWillChangeTo (
IOPMPowerFlags newPowerFlags,
IOPowerConnection * whichParent )
{
assert(false);
return kIOReturnUnsupported;
}
#endif
void IOService::handlePowerDomainWillChangeTo ( IOPMRequest * request )
{
IOPMPowerFlags parentPowerFlags = (IOPMPowerFlags) request->fArg0;
IOPowerConnection * whichParent = (IOPowerConnection *) request->fArg1;
IOPMPowerChangeFlags parentChangeFlags = (IOPMPowerChangeFlags)(uintptr_t) request->fArg2;
IOPMPowerChangeFlags myChangeFlags;
OSIterator * iter;
OSObject * next;
IOPowerConnection * connection;
IOPMPowerStateIndex newPowerState;
IOPMPowerFlags combinedPowerFlags;
bool savedParentsKnowState;
IOReturn result = IOPMAckImplied;
PM_ASSERT_IN_GATE();
OUR_PMLog(kPMLogWillChange, parentPowerFlags, 0);
if (!inPlane(gIOPowerPlane) || !whichParent || !whichParent->getAwaitingAck())
{
PM_LOG("%s::%s not in power tree\n", getName(), __FUNCTION__);
goto exit_no_ack;
}
savedParentsKnowState = fParentsKnowState;
combinedPowerFlags = 0;
iter = getParentIterator(gIOPowerPlane);
if ( iter )
{
while ( (next = iter->getNextObject()) )
{
if ( (connection = OSDynamicCast(IOPowerConnection, next)) )
{
if ( connection == whichParent )
combinedPowerFlags |= parentPowerFlags;
else
combinedPowerFlags |= connection->parentCurrentPowerFlags();
}
}
iter->release();
}
if ( fControllingDriver && !fInitialPowerChange )
{
newPowerState = fControllingDriver->maxCapabilityForDomainState(
combinedPowerFlags);
myChangeFlags = kIOPMParentInitiated | kIOPMDomainWillChange |
(parentChangeFlags & kIOPMSynchronize);
result = startPowerChange(
myChangeFlags,
newPowerState,
combinedPowerFlags,
whichParent,
parentPowerFlags);
}
if (parentChangeFlags & kIOPMDomainPowerDrop)
{
setParentInfo(parentPowerFlags, whichParent, true);
}
if (IOPMAckImplied == result)
{
IOService * parent;
parent = (IOService *) whichParent->copyParentEntry(gIOPowerPlane);
assert(parent);
if ( parent )
{
parent->acknowledgePowerChange( whichParent );
parent->release();
}
}
exit_no_ack:
if (whichParent) whichParent->release();
}
#ifndef __LP64__
IOReturn IOService::powerDomainDidChangeTo (
IOPMPowerFlags newPowerFlags,
IOPowerConnection * whichParent )
{
assert(false);
return kIOReturnUnsupported;
}
#endif
void IOService::handlePowerDomainDidChangeTo ( IOPMRequest * request )
{
IOPMPowerFlags parentPowerFlags = (IOPMPowerFlags) request->fArg0;
IOPowerConnection * whichParent = (IOPowerConnection *) request->fArg1;
IOPMPowerChangeFlags parentChangeFlags = (IOPMPowerChangeFlags)(uintptr_t) request->fArg2;
IOPMPowerChangeFlags myChangeFlags;
IOPMPowerStateIndex newPowerState;
IOPMPowerStateIndex initialDesire;
bool savedParentsKnowState;
IOReturn result = IOPMAckImplied;
PM_ASSERT_IN_GATE();
OUR_PMLog(kPMLogDidChange, parentPowerFlags, 0);
if (!inPlane(gIOPowerPlane) || !whichParent || !whichParent->getAwaitingAck())
{
PM_LOG("%s::%s not in power tree\n", getName(), __FUNCTION__);
goto exit_no_ack;
}
savedParentsKnowState = fParentsKnowState;
setParentInfo(parentPowerFlags, whichParent, true);
if ( fControllingDriver )
{
newPowerState = fControllingDriver->maxCapabilityForDomainState(
fParentsCurrentPowerFlags);
if (fInitialPowerChange)
{
initialDesire = fControllingDriver->initialPowerStateForDomainState(
fParentsCurrentPowerFlags);
computeDesiredState(initialDesire);
}
myChangeFlags = kIOPMParentInitiated | kIOPMDomainDidChange |
(parentChangeFlags & kIOPMSynchronize);
result = startPowerChange(
myChangeFlags,
newPowerState,
fParentsCurrentPowerFlags,
whichParent,
0);
}
if (IOPMAckImplied == result)
{
IOService * parent;
parent = (IOService *) whichParent->copyParentEntry(gIOPowerPlane);
assert(parent);
if ( parent )
{
parent->acknowledgePowerChange( whichParent );
parent->release();
}
}
if (!savedParentsKnowState && fParentsKnowState)
{
PM_LOG1("%s::powerDomainDidChangeTo parentsKnowState = true\n",
getName());
requestDomainPower( fDesiredPowerState );
}
exit_no_ack:
if (whichParent) whichParent->release();
}
void IOService::setParentInfo (
IOPMPowerFlags newPowerFlags,
IOPowerConnection * whichParent,
bool knowsState )
{
OSIterator * iter;
OSObject * next;
IOPowerConnection * conn;
PM_ASSERT_IN_GATE();
whichParent->setParentCurrentPowerFlags(newPowerFlags);
whichParent->setParentKnowsState(knowsState);
fParentsCurrentPowerFlags = 0;
fParentsKnowState = true;
iter = getParentIterator(gIOPowerPlane);
if ( iter )
{
while ( (next = iter->getNextObject()) )
{
if ( (conn = OSDynamicCast(IOPowerConnection, next)) )
{
fParentsKnowState &= conn->parentKnowsState();
fParentsCurrentPowerFlags |= conn->parentCurrentPowerFlags();
}
}
iter->release();
}
}
void IOService::rebuildChildClampBits ( void )
{
unsigned long i;
OSIterator * iter;
OSObject * next;
IOPowerConnection * connection;
unsigned long powerState;
for ( i = 0; i < fNumberOfPowerStates; i++ )
{
fPowerStates[i].capabilityFlags &= ~(kIOPMChildClamp | kIOPMChildClamp2);
}
if (!inPlane(gIOPowerPlane))
return;
iter = getChildIterator(gIOPowerPlane);
if ( iter )
{
while ( (next = iter->getNextObject()) )
{
if ( (connection = OSDynamicCast(IOPowerConnection, next)) )
{
if (connection->getReadyFlag() == false)
{
PM_LOG3("[%s] %s: connection not ready\n",
getName(), __FUNCTION__);
continue;
}
powerState = connection->getDesiredDomainState();
if (powerState < fNumberOfPowerStates)
{
if ( connection->getPreventIdleSleepFlag() )
fPowerStates[powerState].capabilityFlags |= kIOPMChildClamp;
if ( connection->getPreventSystemSleepFlag() )
fPowerStates[powerState].capabilityFlags |= kIOPMChildClamp2;
}
}
}
iter->release();
}
}
IOReturn IOService::requestPowerDomainState(
IOPMPowerFlags childRequestPowerFlags,
IOPowerConnection * childConnection,
unsigned long specification )
{
IOPMPowerStateIndex ps;
IOPMPowerFlags outputPowerFlags;
IOService * child;
IOPMRequest * subRequest;
bool preventIdle, preventSleep;
bool adjustPower = false;
if (!initialized)
return IOPMNotYetInitialized;
if (gIOPMWorkLoop->onThread() == false)
{
PM_LOG("%s::requestPowerDomainState\n", getName());
return kIOReturnSuccess;
}
OUR_PMLog(kPMLogRequestDomain, childRequestPowerFlags, specification);
if (!isChild(childConnection, gIOPowerPlane))
return kIOReturnNotAttached;
if (!fControllingDriver || !fNumberOfPowerStates)
return kIOReturnNotReady;
child = (IOService *) childConnection->getChildEntry(gIOPowerPlane);
assert(child);
preventIdle = ((childRequestPowerFlags & kIOPMPreventIdleSleep) != 0);
preventSleep = ((childRequestPowerFlags & kIOPMPreventSystemSleep) != 0);
childRequestPowerFlags &= ~(kIOPMPreventIdleSleep | kIOPMPreventSystemSleep);
outputPowerFlags = fPowerStates[fCurrentPowerState].outputPowerFlags;
if (fMachineState != kIOPM_Finished)
{
if (IS_POWER_DROP && !IS_ROOT_DOMAIN)
{
if ((fMachineState == kIOPM_OurChangeTellClientsPowerDown) ||
(fMachineState == kIOPM_OurChangeTellPriorityClientsPowerDown))
{
fDoNotPowerDown = true; adjustPower = true; PM_LOG1("%s: power drop cancelled in state %u by %s\n",
getName(), fMachineState, child->getName());
}
else
{
outputPowerFlags =
fPowerStates[fHeadNotePowerState].outputPowerFlags;
}
}
else if (IS_POWER_RISE)
{
outputPowerFlags = childConnection->parentCurrentPowerFlags();
}
}
child->fHeadNoteDomainTargetFlags |= outputPowerFlags;
for (ps = 0; ps < fNumberOfPowerStates; ps++)
{
if ((fPowerStates[ps].outputPowerFlags & childRequestPowerFlags) ==
(fOutputPowerCharacterFlags & childRequestPowerFlags))
break;
}
if (ps >= fNumberOfPowerStates)
{
ps = 0; }
if (!childConnection->childHasRequestedPower() ||
(ps != childConnection->getDesiredDomainState()) ||
(childConnection->getPreventIdleSleepFlag() != preventIdle) ||
(childConnection->getPreventSystemSleepFlag() != preventSleep))
adjustPower = true;
#if ENABLE_DEBUG_LOGS
if (adjustPower)
{
PM_LOG("requestPowerDomainState[%s]: %s, init %d, %u->%u\n",
getName(), child->getName(),
!childConnection->childHasRequestedPower(),
(uint32_t) childConnection->getDesiredDomainState(),
(uint32_t) ps);
}
#endif
#if SUPPORT_IDLE_CANCEL
bool attemptCancel = (preventIdle && !childConnection->getPreventIdleSleepFlag());
#endif
childConnection->setChildHasRequestedPower();
childConnection->setDesiredDomainState( ps );
childConnection->setPreventIdleSleepFlag( preventIdle );
childConnection->setPreventSystemSleepFlag( preventSleep );
if (adjustPower && !fDeviceOverrideEnabled &&
(!fAdjustPowerScheduled || gIOPMRequest->getRootRequest()))
{
subRequest = acquirePMRequest(
this, kIOPMRequestTypeAdjustPowerState, gIOPMRequest );
if (subRequest)
{
submitPMRequest( subRequest );
fAdjustPowerScheduled = true;
}
}
#if SUPPORT_IDLE_CANCEL
if (attemptCancel)
{
subRequest = acquirePMRequest( this, kIOPMRequestTypeIdleCancel );
if (subRequest)
{
submitPMRequest( subRequest );
}
}
#endif
return kIOReturnSuccess;
}
IOReturn IOService::temporaryPowerClampOn ( void )
{
return requestPowerState( gIOPMPowerClientChildProxy, kIOPMPowerStateMax );
}
IOReturn IOService::makeUsable ( void )
{
OUR_PMLog(kPMLogMakeUsable, 0, 0);
return requestPowerState( gIOPMPowerClientDevice, kIOPMPowerStateMax );
}
IOPMPowerFlags IOService::currentCapability ( void )
{
if (!initialized)
return IOPMNotPowerManaged;
return fCurrentCapabilityFlags;
}
IOReturn IOService::changePowerStateTo ( unsigned long ordinal )
{
OUR_PMLog(kPMLogChangeStateTo, ordinal, 0);
return requestPowerState( gIOPMPowerClientDriver, ordinal );
}
IOReturn IOService::changePowerStateToPriv ( unsigned long ordinal )
{
OUR_PMLog(kPMLogChangeStateToPriv, ordinal, 0);
return requestPowerState( gIOPMPowerClientDevice, ordinal );
}
IOReturn IOService::changePowerStateWithOverrideTo ( unsigned long ordinal )
{
IOPMRequest * request;
if (!initialized)
return kIOPMNotYetInitialized;
OUR_PMLog(kPMLogChangeStateToPriv, ordinal, 0);
request = acquirePMRequest( this, kIOPMRequestTypeRequestPowerStateOverride );
if (!request)
return kIOReturnNoMemory;
gIOPMPowerClientDevice->retain();
request->fArg0 = (void *) ordinal;
request->fArg1 = (void *) gIOPMPowerClientDevice;
request->fArg2 = 0;
#if NOT_READY
if (action)
request->installCompletionAction( action, target, param );
#endif
if (gIOPMWorkLoop->inGate() && (ordinal < fNumberOfPowerStates))
{
fTempClampPowerState = max(fTempClampPowerState, ordinal);
fTempClampCount++;
fOverrideMaxPowerState = ordinal;
request->fArg2 = (void *) (uintptr_t) true;
}
submitPMRequest( request );
return IOPMNoErr;
}
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
if (gIOPMWorkLoop->inGate() && (state < fNumberOfPowerStates))
{
fTempClampPowerState = max(fTempClampPowerState, state);
fTempClampCount++;
request->fArg2 = (void *) (uintptr_t) true;
}
submitPMRequest( request );
return IOPMNoErr;
}
void IOService::handleRequestPowerState ( IOPMRequest * request )
{
const OSSymbol * client = (const OSSymbol *) request->fArg1;
uint32_t state = (uint32_t)(uintptr_t) request->fArg0;
PM_ASSERT_IN_GATE();
if (request->fArg2)
{
assert(fTempClampCount != 0);
if (fTempClampCount) fTempClampCount--;
if (!fTempClampCount) fTempClampPowerState = 0;
}
if (fNumberOfPowerStates && (state >= fNumberOfPowerStates))
state = fNumberOfPowerStates - 1;
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();
}
void IOService::updatePowerClient( const OSSymbol * client, uint32_t powerState )
{
if (!fPowerClients)
fPowerClients = OSDictionary::withCapacity(4);
if (fPowerClients && client)
{
OSNumber * num = (OSNumber *) fPowerClients->getObject(client);
if (num)
num->setValue(powerState);
else
{
num = OSNumber::withNumber(powerState, 32);
if (num)
{
fPowerClients->setObject(client, num);
num->release();
}
}
}
}
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;
}
IOReturn IOService::powerOverrideOnPriv ( void )
{
IOPMRequest * request;
if (!initialized)
return IOPMNotYetInitialized;
if (gIOPMWorkLoop->inGate())
{
fDeviceOverrideEnabled = true;
return IOPMNoErr;
}
request = acquirePMRequest( this, kIOPMRequestTypePowerOverrideOnPriv );
if (!request)
return kIOReturnNoMemory;
submitPMRequest( request );
return IOPMNoErr;
}
IOReturn IOService::powerOverrideOffPriv ( void )
{
IOPMRequest * request;
if (!initialized)
return IOPMNotYetInitialized;
if (gIOPMWorkLoop->inGate())
{
fDeviceOverrideEnabled = false;
return IOPMNoErr;
}
request = acquirePMRequest( this, kIOPMRequestTypePowerOverrideOffPriv );
if (!request)
return kIOReturnNoMemory;
submitPMRequest( request );
return IOPMNoErr;
}
void IOService::handlePowerOverrideChanged ( IOPMRequest * request )
{
PM_ASSERT_IN_GATE();
if (request->getType() == kIOPMRequestTypePowerOverrideOnPriv)
{
OUR_PMLog(kPMLogOverrideOn, 0, 0);
fDeviceOverrideEnabled = true;
}
else
{
OUR_PMLog(kPMLogOverrideOff, 0, 0);
fDeviceOverrideEnabled = false;
}
adjustPowerState();
}
void IOService::computeDesiredState ( unsigned long localClamp )
{
OSIterator * iter;
OSObject * next;
IOPowerConnection * connection;
uint32_t desiredState = 0;
uint32_t newPowerState = 0;
bool hasChildren = false;
if (!fNumberOfPowerStates)
{
fDesiredPowerState = 0;
return;
}
iter = getChildIterator(gIOPowerPlane);
if (iter)
{
while ((next = iter->getNextObject()))
{
if ((connection = OSDynamicCast(IOPowerConnection, next)))
{
if (connection->getReadyFlag() == false)
{
PM_LOG3("[%s] %s: connection not ready\n",
getName(), __FUNCTION__);
continue;
}
if (connection->childHasRequestedPower())
hasChildren = true;
if (connection->getDesiredDomainState() > desiredState)
desiredState = connection->getDesiredDomainState();
}
}
iter->release();
}
if (hasChildren)
updatePowerClient(gIOPMPowerClientChildren, desiredState);
else
removePowerClient(gIOPMPowerClientChildren);
iter = OSCollectionIterator::withCollection(fPowerClients);
if (iter)
{
const OSSymbol * client;
while ((client = (const OSSymbol *) iter->getNextObject()))
{
if ((fDeviceOverrideEnabled ||
(getPMRequestType() == kIOPMRequestTypeRequestPowerStateOverride)) &&
((client == gIOPMPowerClientChildren) ||
(client == gIOPMPowerClientDriver)))
continue;
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();
}
newPowerState = max(newPowerState, localClamp);
newPowerState = max(newPowerState, fTempClampPowerState);
newPowerState = min(newPowerState, fOverrideMaxPowerState);
if (newPowerState >= fNumberOfPowerStates)
newPowerState = fNumberOfPowerStates - 1;
fDesiredPowerState = newPowerState;
PM_LOG1(" temp %u, clamp %u, current %u, new %u\n",
(uint32_t) localClamp, (uint32_t) fTempClampPowerState,
(uint32_t) fCurrentPowerState, newPowerState);
if (fDeviceDesire && fIdleTimerStopped)
{
fIdleTimerStopped = false;
fActivityTickleCount = 0;
clock_get_uptime(&fIdleTimerStartTime);
start_PM_idle_timer();
}
if ((getPMRequestType() != kIOPMRequestTypeActivityTickle) &&
(fActivityTicklePowerState != -1))
{
IOLockLock(fActivityLock);
fActivityTicklePowerState = -1;
IOLockUnlock(fActivityLock);
}
}
unsigned long IOService::currentPowerConsumption ( void )
{
if (!initialized)
return kIOPMUnknown;
return fCurrentPowerConsumption;
}
IOWorkLoop * IOService::getPMworkloop ( void )
{
return gIOPMWorkLoop;
}
#if NOT_YET
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()))
{
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()))
{
if ((connection = OSDynamicCast(IOPowerConnection, entry)))
{
parent = (IOService *) connection->copyParentEntry(gIOPowerPlane);
if (parent)
{
(*applier)(parent, context);
parent->release();
}
}
}
iter->release();
}
}
#endif
bool IOService::activityTickle ( unsigned long type, unsigned long stateNumber )
{
IOPMRequest * request;
bool noPowerChange = true;
if ( initialized && stateNumber && (type == kIOPMSuperclassPolicy1) )
{
IOLockLock(fActivityLock);
fDeviceWasActive = true;
fActivityTickleCount++;
clock_get_uptime(&fDeviceActiveTimestamp);
PM_ACTION_0(actionActivityTickle);
if (fActivityTicklePowerState < (long)stateNumber)
{
fActivityTicklePowerState = stateNumber;
noPowerChange = false;
request = acquirePMRequest( this, kIOPMRequestTypeActivityTickle );
if (request)
{
request->fArg0 = (void *) stateNumber; request->fArg1 = (void *) (uintptr_t) true; submitPMRequest(request);
}
}
IOLockUnlock(fActivityLock);
}
return noPowerChange;
}
void IOService::handleActivityTickle ( IOPMRequest * request )
{
uint32_t ticklePowerState = (uint32_t)(uintptr_t) request->fArg0;
bool adjustPower = false;
PM_ASSERT_IN_GATE();
if (request->fArg1)
{
if ((ticklePowerState > fDeviceDesire) &&
(ticklePowerState < fNumberOfPowerStates))
{
fIdleTimerMinPowerState = ticklePowerState;
adjustPower = true;
}
}
else if (fDeviceDesire > fIdleTimerMinPowerState)
{
ticklePowerState = fDeviceDesire - 1;
adjustPower = true;
}
if (adjustPower)
{
updatePowerClient(gIOPMPowerClientDevice, ticklePowerState);
adjustPowerState();
}
}
IOReturn IOService::setIdleTimerPeriod ( unsigned long period )
{
if (!initialized)
return IOPMNotYetInitialized;
OUR_PMLog(kPMLogSetIdleTimerPeriod, period, fIdleTimerPeriod);
IOPMRequest * request =
acquirePMRequest( this, kIOPMRequestTypeSetIdleTimerPeriod );
if (!request)
return kIOReturnNoMemory;
request->fArg0 = (void *) period;
submitPMRequest( request );
return kIOReturnSuccess;
}
SInt32 IOService::nextIdleTimeout(
AbsoluteTime currentTime,
AbsoluteTime lastActivity,
unsigned int powerState)
{
AbsoluteTime delta;
UInt64 delta_ns;
SInt32 delta_secs;
SInt32 delay_secs;
delta = currentTime;
SUB_ABSOLUTETIME(&delta, &lastActivity);
absolutetime_to_nanoseconds(delta, &delta_ns);
delta_secs = (SInt32)(delta_ns / NSEC_PER_SEC);
if (delta_secs < (int) fIdleTimerPeriod)
delay_secs = (int) fIdleTimerPeriod - delta_secs;
else
delay_secs = (int) fIdleTimerPeriod;
return (SInt32)delay_secs;
}
void IOService::start_PM_idle_timer ( void )
{
static const int maxTimeout = 100000;
static const int minTimeout = 1;
AbsoluteTime uptime, deadline;
SInt32 idle_in = 0;
boolean_t pending;
if (!initialized || !fIdleTimerPeriod)
return;
IOLockLock(fActivityLock);
clock_get_uptime(&uptime);
idle_in = nextIdleTimeout(uptime, fDeviceActiveTimestamp, fCurrentPowerState);
if (idle_in > maxTimeout)
{
idle_in = IOService::nextIdleTimeout(uptime,
fDeviceActiveTimestamp,
fCurrentPowerState);
} else if (idle_in < minTimeout) {
idle_in = fIdleTimerPeriod;
}
IOLockUnlock(fActivityLock);
retain();
clock_interval_to_absolutetime_interval(idle_in, kSecondScale, &deadline);
ADD_ABSOLUTETIME(&deadline, &uptime);
pending = thread_call_enter_delayed(fIdleTimer, deadline);
if (pending) release();
}
static void
idle_timer_expired (
thread_call_param_t arg0, thread_call_param_t arg1 )
{
IOService * me = (IOService *) arg0;
if (gIOPMWorkLoop)
gIOPMWorkLoop->runAction(
OSMemberFunctionCast(IOWorkLoop::Action, me,
&IOService::idleTimerExpired),
me);
me->release();
}
void IOService::idleTimerExpired( void )
{
IOPMRequest * request;
bool restartTimer = true;
if ( !initialized || !fIdleTimerPeriod || fLockedFlags.PMStop )
return;
IOLockLock(fActivityLock);
if (fDeviceWasActive)
{
fDeviceWasActive = false;
}
else
{
if (fActivityTicklePowerState > 0)
{
fActivityTicklePowerState--;
}
request = acquirePMRequest( this, kIOPMRequestTypeActivityTickle );
if (request)
{
request->fArg0 = (void *) 0; request->fArg1 = (void *) (uintptr_t) false; submitPMRequest( request );
restartTimer = false;
}
}
IOLockUnlock(fActivityLock);
if (restartTimer)
start_PM_idle_timer();
}
#ifndef __LP64__
void IOService::PM_idle_timer_expiration ( void )
{
}
void IOService::command_received ( void *statePtr , void *, void * , void * )
{
}
#endif
IOReturn IOService::setAggressiveness ( unsigned long type, unsigned long newLevel )
{
return kIOReturnSuccess;
}
IOReturn IOService::getAggressiveness ( unsigned long type, unsigned long * currentLevel )
{
IOPMrootDomain * rootDomain = getPMRootDomain();
if (!rootDomain)
return kIOReturnNotReady;
return rootDomain->getAggressiveness( type, currentLevel );
}
UInt32 IOService::getPowerState ( void )
{
if (!initialized)
return 0;
return fCurrentPowerState;
}
#ifndef __LP64__
IOReturn IOService::systemWake ( void )
{
OSIterator * iter;
OSObject * next;
IOPowerConnection * connection;
IOService * theChild;
iter = getChildIterator(gIOPowerPlane);
if ( iter )
{
while ( (next = iter->getNextObject()) )
{
if ( (connection = OSDynamicCast(IOPowerConnection, next)) )
{
if (connection->getReadyFlag() == false)
{
PM_LOG3("[%s] %s: connection not ready\n",
getName(), __FUNCTION__);
continue;
}
theChild = (IOService *)connection->copyChildEntry(gIOPowerPlane);
if ( theChild )
{
theChild->systemWake();
theChild->release();
}
}
}
iter->release();
}
if ( fControllingDriver != NULL )
{
if ( fControllingDriver->didYouWakeSystem() )
{
makeUsable();
}
}
return IOPMNoErr;
}
IOReturn IOService::temperatureCriticalForZone ( IOService * whichZone )
{
IOService * theParent;
IOService * theNub;
OUR_PMLog(kPMLogCriticalTemp, 0, 0);
if ( inPlane(gIOPowerPlane) && !IS_PM_ROOT )
{
theNub = (IOService *)copyParentEntry(gIOPowerPlane);
if ( theNub )
{
theParent = (IOService *)theNub->copyParentEntry(gIOPowerPlane);
theNub->release();
if ( theParent )
{
theParent->temperatureCriticalForZone(whichZone);
theParent->release();
}
}
}
return IOPMNoErr;
}
#endif
IOReturn IOService::startPowerChange(
IOPMPowerChangeFlags changeFlags,
IOPMPowerStateIndex powerState,
IOPMPowerFlags domainFlags,
IOPowerConnection * parentConnection,
IOPMPowerFlags parentFlags )
{
PM_ASSERT_IN_GATE();
assert( fMachineState == kIOPM_Finished );
assert( powerState < fNumberOfPowerStates );
if (powerState >= fNumberOfPowerStates)
return IOPMAckImplied;
fIsPreChange = true;
PM_ACTION_2(actionPowerChangeOverride, &powerState, &changeFlags);
fHeadNoteChangeFlags = changeFlags;
fHeadNotePowerState = powerState;
fHeadNotePowerArrayEntry = &fPowerStates[ powerState ];
fHeadNoteParentConnection = NULL;
if (changeFlags & kIOPMSelfInitiated)
{
if (changeFlags & kIOPMSynchronize)
OurSyncStart();
else
OurChangeStart();
return 0;
}
else
{
assert(changeFlags & kIOPMParentInitiated);
fHeadNoteDomainFlags = domainFlags;
fHeadNoteParentFlags = parentFlags;
fHeadNoteParentConnection = parentConnection;
return ParentChangeStart();
}
}
bool IOService::notifyInterestedDrivers ( void )
{
IOPMinformee * informee;
IOPMinformeeList * list = fInterestedDrivers;
DriverCallParam * param;
IOItemCount count;
PM_ASSERT_IN_GATE();
assert( fDriverCallParamCount == 0 );
assert( fHeadNotePendingAcks == 0 );
fHeadNotePendingAcks = 0;
count = list->numberOfItems();
if (!count)
goto done;
param = (DriverCallParam *) fDriverCallParamPtr;
if (count > fDriverCallParamSlots)
{
if (fDriverCallParamSlots)
{
assert(fDriverCallParamPtr);
IODelete(fDriverCallParamPtr, DriverCallParam, fDriverCallParamSlots);
fDriverCallParamPtr = 0;
fDriverCallParamSlots = 0;
}
param = IONew(DriverCallParam, count);
if (!param)
goto done;
fDriverCallParamPtr = (void *) param;
fDriverCallParamSlots = count;
}
informee = list->firstInList();
assert(informee);
for (IOItemCount i = 0; i < count; i++)
{
informee->timer = -1;
param[i].Target = informee;
informee->retain();
informee = list->nextInList( informee );
}
fDriverCallParamCount = count;
fHeadNotePendingAcks = count;
assert(!fDriverCallBusy);
fDriverCallBusy = true;
thread_call_enter( fDriverCallEntry );
return true;
done:
return false;
}
void IOService::notifyInterestedDriversDone ( void )
{
IOPMinformee * informee;
IOItemCount count;
DriverCallParam * param;
IOReturn result;
PM_ASSERT_IN_GATE();
assert( fDriverCallBusy == false );
assert( fMachineState == kIOPM_DriverThreadCallDone );
param = (DriverCallParam *) fDriverCallParamPtr;
count = fDriverCallParamCount;
if (param && count)
{
for (IOItemCount i = 0; i < count; i++, param++)
{
informee = (IOPMinformee *) param->Target;
result = param->Result;
if ((result == IOPMAckImplied) || (result < 0))
{
if (fHeadNotePendingAcks && informee->timer)
fHeadNotePendingAcks--;
informee->timer = 0;
}
else if (informee->timer)
{
assert(informee->timer == -1);
if (result < kMinAckTimeoutTicks)
result = kMinAckTimeoutTicks;
informee->timer = (result / (ACK_TIMER_PERIOD / ns_per_us)) + 1;
}
informee->release();
}
fDriverCallParamCount = 0;
if ( fHeadNotePendingAcks )
{
OUR_PMLog(kPMLogStartAckTimer, 0, 0);
start_ack_timer();
}
}
MS_POP();
if (!fHeadNotePendingAcks)
{
notifyChildren();
}
else
{
MS_PUSH(fMachineState);
fMachineState = kIOPM_NotifyChildrenStart;
PM_LOG2("%s: %u outstanding async interest\n",
getName(), fHeadNotePendingAcks);
}
}
void IOService::notifyChildren ( void )
{
OSIterator * iter;
OSObject * next;
IOPowerConnection * connection;
OSArray * children = 0;
IOPMrootDomain * rootDomain;
bool delayNotify = false;
if ((fHeadNotePowerState != fCurrentPowerState) &&
(IS_POWER_DROP == fIsPreChange) &&
((rootDomain = getPMRootDomain()) == this))
{
rootDomain->tracePoint( IS_POWER_DROP ?
kIOPMTracePointSleepPowerPlaneDrivers :
kIOPMTracePointWakePowerPlaneDrivers );
}
if (fStrictTreeOrder)
children = OSArray::withCapacity(8);
fHeadNotePowerArrayEntry->staticPower = 0;
iter = getChildIterator(gIOPowerPlane);
if ( iter )
{
while ((next = iter->getNextObject()))
{
if ((connection = OSDynamicCast(IOPowerConnection, next)))
{
if (connection->getReadyFlag() == false)
{
PM_LOG3("[%s] %s: connection not ready\n",
getName(), __FUNCTION__);
continue;
}
if (!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 );
}
}
iter->release();
}
if (children && (children->getCount() == 0))
{
children->release();
children = 0;
}
if (children)
{
assert(fNotifyChildArray == 0);
fNotifyChildArray = children;
MS_PUSH(fMachineState);
if (delayNotify)
{
fMachineState = kIOPM_NotifyChildrenDelayed;
PM_LOG2("%s: %d children in delayed array\n",
getName(), children->getCount());
}
else
{
fMachineState = kIOPM_NotifyChildrenOrdered;
}
}
}
void IOService::notifyChildrenOrdered ( void )
{
PM_ASSERT_IN_GATE();
assert(fNotifyChildArray);
assert(fMachineState == kIOPM_NotifyChildrenOrdered);
if (fNotifyChildArray->getCount())
{
IOPowerConnection * connection;
connection = (IOPowerConnection *) fNotifyChildArray->getObject(0);
fNotifyChildArray->removeObject(0);
notifyChild( connection );
}
else
{
fNotifyChildArray->release();
fNotifyChildArray = 0;
MS_POP(); }
}
void IOService::notifyChildrenDelayed ( void )
{
IOPowerConnection * connection;
PM_ASSERT_IN_GATE();
assert(fNotifyChildArray);
assert(fMachineState == kIOPM_NotifyChildrenDelayed);
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(); }
IOReturn IOService::notifyAll ( uint32_t nextMS )
{
PM_ASSERT_IN_GATE();
MS_PUSH(nextMS);
fMachineState = kIOPM_DriverThreadCallDone;
fDriverCallReason = fIsPreChange ?
kDriverCallInformPreChange : kDriverCallInformPostChange;
if (!notifyInterestedDrivers())
notifyInterestedDriversDone();
return IOPMWillAckLater;
}
IOReturn IOService::actionDriverCalloutDone (
OSObject * target,
void * arg0, void * arg1,
void * arg2, void * arg3 )
{
IOServicePM * pwrMgt = (IOServicePM *) arg0;
assert( fDriverCallBusy );
fDriverCallBusy = false;
assert(gIOPMWorkQueue);
gIOPMWorkQueue->signalWorkAvailable();
return kIOReturnSuccess;
}
void IOService::pmDriverCallout ( IOService * from )
{
assert(from);
switch (from->fDriverCallReason)
{
case kDriverCallSetPowerState:
from->driverSetPowerState();
break;
case kDriverCallInformPreChange:
case kDriverCallInformPostChange:
from->driverInformPowerChange();
break;
default:
panic("IOService::pmDriverCallout bad machine state %x",
from->fDriverCallReason);
}
gIOPMWorkLoop->runAction(actionDriverCalloutDone,
from,
(void *) from->pwrMgt );
}
void IOService::driverSetPowerState ( void )
{
IOPMPowerStateIndex powerState;
DriverCallParam * param;
IOPMDriverCallEntry callEntry;
AbsoluteTime end;
IOReturn result;
uint32_t oldPowerState = getPowerState();
assert( fDriverCallBusy );
assert( fDriverCallParamPtr );
assert( fDriverCallParamCount == 1 );
param = (DriverCallParam *) fDriverCallParamPtr;
powerState = fHeadNotePowerState;
if (assertPMDriverCall(&callEntry))
{
OUR_PMLog( kPMLogProgramHardware, (uintptr_t) this, powerState);
clock_get_uptime(&fDriverCallStartTime);
result = fControllingDriver->setPowerState( powerState, this );
clock_get_uptime(&end);
OUR_PMLog((UInt32) -kPMLogProgramHardware, (uintptr_t) this, (UInt32) result);
deassertPMDriverCall(&callEntry);
if (result < 0)
{
PM_LOG("%s::setPowerState(%p, %lu -> %lu) returned 0x%x\n",
fName, this, fCurrentPowerState, powerState, result);
}
#if LOG_SETPOWER_TIMES
if ((result == IOPMAckImplied) || (result < 0))
{
uint64_t nsec;
SUB_ABSOLUTETIME(&end, &fDriverCallStartTime);
absolutetime_to_nanoseconds(end, &nsec);
if (nsec > LOG_SETPOWER_TIMES)
PM_LOG("%s::setPowerState(%p, %lu -> %lu) took %d ms\n",
fName, this, fCurrentPowerState, powerState, NS_TO_MS(nsec));
PMEventDetails *details = PMEventDetails::eventDetails(
kIOPMEventTypeSetPowerStateImmediate, fName, (uintptr_t)this, NULL, (uint8_t)oldPowerState, (uint8_t)powerState, 0, NS_TO_US(nsec));
getPMRootDomain()->recordAndReleasePMEventGated( details );
}
#endif
}
else
result = kIOPMAckImplied;
param->Result = result;
}
void IOService::driverInformPowerChange ( void )
{
IOPMinformee * informee;
IOService * driver;
DriverCallParam * param;
IOPMDriverCallEntry callEntry;
IOPMPowerFlags powerFlags;
IOPMPowerStateIndex powerState;
AbsoluteTime end;
IOReturn result;
IOItemCount count;
assert( fDriverCallBusy );
assert( fDriverCallParamPtr );
assert( fDriverCallParamCount );
param = (DriverCallParam *) fDriverCallParamPtr;
count = fDriverCallParamCount;
powerFlags = fHeadNotePowerArrayEntry->capabilityFlags;
powerState = fHeadNotePowerState;
for (IOItemCount i = 0; i < count; i++)
{
informee = (IOPMinformee *) param->Target;
driver = informee->whatObject;
if (assertPMDriverCall(&callEntry, 0, informee))
{
if (fDriverCallReason == kDriverCallInformPreChange)
{
OUR_PMLog(kPMLogInformDriverPreChange, (uintptr_t) this, powerState);
clock_get_uptime(&informee->startTime);
result = driver->powerStateWillChangeTo(powerFlags, powerState, this);
clock_get_uptime(&end);
OUR_PMLog((UInt32)-kPMLogInformDriverPreChange, (uintptr_t) this, result);
}
else
{
OUR_PMLog(kPMLogInformDriverPostChange, (uintptr_t) this, powerState);
clock_get_uptime(&informee->startTime);
result = driver->powerStateDidChangeTo(powerFlags, powerState, this);
clock_get_uptime(&end);
OUR_PMLog((UInt32)-kPMLogInformDriverPostChange, (uintptr_t) this, result);
}
deassertPMDriverCall(&callEntry);
#if LOG_SETPOWER_TIMES
if ((result == IOPMAckImplied) || (result < 0))
{
uint64_t nsec;
SUB_ABSOLUTETIME(&end, &informee->startTime);
absolutetime_to_nanoseconds(end, &nsec);
if (nsec > LOG_SETPOWER_TIMES)
PM_LOG("%s::powerState%sChangeTo(%p, %s, %lu -> %lu) took %d ms\n",
driver->getName(),
(fDriverCallReason == kDriverCallInformPreChange) ? "Will" : "Did",
driver, fName, fCurrentPowerState, powerState, NS_TO_MS(nsec));
uint16_t logType = (fDriverCallReason == kDriverCallInformPreChange)
? kIOPMEventTypePSWillChangeTo
: kIOPMEventTypePSDidChangeTo;
PMEventDetails *details = PMEventDetails::eventDetails(
logType, fName, (uintptr_t)this, driver->getName(), (uint8_t)fCurrentPowerState, (uint8_t)fHeadNotePowerState, 0, NS_TO_US(nsec));
getPMRootDomain()->recordAndReleasePMEventGated( details );
}
#endif
}
else
result = kIOPMAckImplied;
param->Result = result;
param++;
}
}
bool IOService::notifyChild ( IOPowerConnection * theNub )
{
IOReturn ret = IOPMAckImplied;
unsigned long childPower;
IOService * theChild;
IOPMRequest * childRequest;
IOPMPowerChangeFlags requestArg2;
int requestType;
PM_ASSERT_IN_GATE();
theChild = (IOService *)(theNub->copyChildEntry(gIOPowerPlane));
if (!theChild)
{
assert(false);
return true;
}
fHeadNotePendingAcks++;
theNub->setAwaitingAck(true);
requestArg2 = fHeadNoteChangeFlags;
if (fHeadNotePowerState < fCurrentPowerState)
requestArg2 |= kIOPMDomainPowerDrop;
requestType = fIsPreChange ?
kIOPMRequestTypePowerDomainWillChange :
kIOPMRequestTypePowerDomainDidChange;
childRequest = acquirePMRequest( theChild, requestType );
if (childRequest)
{
theNub->retain();
childRequest->fArg0 = (void *) fHeadNotePowerArrayEntry->outputPowerFlags;
childRequest->fArg1 = (void *) theNub;
childRequest->fArg2 = (void *) requestArg2;
theChild->submitPMRequest( childRequest );
ret = IOPMWillAckLater;
}
else
{
ret = IOPMAckImplied;
fHeadNotePendingAcks--;
theNub->setAwaitingAck(false);
childPower = theChild->currentPowerConsumption();
if ( childPower == kIOPMUnknown )
{
fHeadNotePowerArrayEntry->staticPower = kIOPMUnknown;
} else {
if (fHeadNotePowerArrayEntry->staticPower != kIOPMUnknown )
fHeadNotePowerArrayEntry->staticPower += childPower;
}
}
theChild->release();
return (IOPMAckImplied == ret);
}
bool IOService::notifyControllingDriver ( void )
{
DriverCallParam * param;
PM_ASSERT_IN_GATE();
assert( fDriverCallParamCount == 0 );
assert( fControllingDriver );
if (fInitialSetPowerState)
{
if (fHeadNotePowerArrayEntry->capabilityFlags & kIOPMInitialDeviceState)
{
return false;
}
fInitialSetPowerState = false;
}
param = (DriverCallParam *) fDriverCallParamPtr;
if (!param)
{
param = IONew(DriverCallParam, 1);
if (!param)
return false;
fDriverCallParamPtr = (void *) param;
fDriverCallParamSlots = 1;
}
param->Target = fControllingDriver;
fDriverCallParamCount = 1;
fDriverTimer = -1;
assert(!fDriverCallBusy);
fDriverCallBusy = true;
thread_call_enter( fDriverCallEntry );
return true;
}
void IOService::notifyControllingDriverDone( void )
{
DriverCallParam * param;
IOReturn result;
PM_ASSERT_IN_GATE();
param = (DriverCallParam *) fDriverCallParamPtr;
assert( fDriverCallBusy == false );
assert( fMachineState == kIOPM_DriverThreadCallDone );
if (param && fDriverCallParamCount)
{
assert(fDriverCallParamCount == 1);
result = param->Result;
if ((result == IOPMAckImplied) || (result < 0))
{
fDriverTimer = 0;
}
else if (fDriverTimer)
{
assert(fDriverTimer == -1);
if (result < kMinAckTimeoutTicks)
result = kMinAckTimeoutTicks;
fDriverTimer = (result / (ACK_TIMER_PERIOD / ns_per_us)) + 1;
}
fDriverCallParamCount = 0;
if ( fDriverTimer )
{
OUR_PMLog(kPMLogStartAckTimer, 0, 0);
start_ack_timer();
}
}
MS_POP(); fIsPreChange = false;
}
void IOService::all_done ( void )
{
IOPMPowerStateIndex prevPowerState;
const IOPMPSEntry * powerStatePtr;
IOPMDriverCallEntry callEntry;
uint32_t prevMachineState = fMachineState;
bool callAction = false;
fMachineState = kIOPM_Finished;
if ((fHeadNoteChangeFlags & kIOPMSynchronize) &&
((prevMachineState == kIOPM_Finished) ||
(prevMachineState == kIOPM_SyncFinish)))
{
PM_ACTION_2(actionPowerChangeDone,
fHeadNotePowerState, fHeadNoteChangeFlags);
if (getPMRequestType() == kIOPMRequestTypeSynchronizePowerTree)
{
powerChangeDone(fCurrentPowerState);
}
return;
}
if ( fHeadNoteChangeFlags & kIOPMSelfInitiated )
{
if ( !( fHeadNoteChangeFlags & kIOPMNotDone) )
{
requestDomainPower(fHeadNotePowerState);
if ( fCurrentPowerState < fHeadNotePowerState )
{
tellChangeUp (fHeadNotePowerState);
}
prevPowerState = fCurrentPowerState;
fCurrentPowerState = fHeadNotePowerState;
#if PM_VARS_SUPPORT
fPMVars->myCurrentState = fCurrentPowerState;
#endif
OUR_PMLog(kPMLogChangeDone, fCurrentPowerState, 0);
PM_ACTION_2(actionPowerChangeDone,
fHeadNotePowerState, fHeadNoteChangeFlags);
callAction = true;
powerStatePtr = &fPowerStates[fCurrentPowerState];
fCurrentCapabilityFlags = powerStatePtr->capabilityFlags;
if (fCurrentCapabilityFlags & kIOPMStaticPowerValid)
fCurrentPowerConsumption = powerStatePtr->staticPower;
if (fPCDFunctionOverride && fParentsKnowState &&
assertPMDriverCall(&callEntry, kIOPMADC_NoInactiveCheck))
{
powerChangeDone(prevPowerState);
deassertPMDriverCall(&callEntry);
}
}
else if (getPMRequestType() == kIOPMRequestTypeRequestPowerStateOverride)
{
fOverrideMaxPowerState = kIOPMPowerStateMax;
}
}
if ( fHeadNoteChangeFlags & kIOPMParentInitiated)
{
if (((fHeadNoteChangeFlags & kIOPMDomainWillChange) &&
(fCurrentPowerState >= fHeadNotePowerState)) ||
((fHeadNoteChangeFlags & kIOPMDomainDidChange) &&
(fCurrentPowerState < fHeadNotePowerState)))
{
if ((fHeadNoteChangeFlags & kIOPMPowerSuppressed) &&
(fHeadNotePowerState != fCurrentPowerState) &&
(fHeadNotePowerState == fDesiredPowerState))
{
requestDomainPower(fHeadNotePowerState);
}
if ( fCurrentPowerState < fHeadNotePowerState )
{
tellChangeUp (fHeadNotePowerState);
}
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;
if (fPCDFunctionOverride && fParentsKnowState &&
assertPMDriverCall(&callEntry, kIOPMADC_NoInactiveCheck))
{
powerChangeDone(prevPowerState);
deassertPMDriverCall(&callEntry);
}
}
}
if (fCurrentPowerState >= fIdleTimerMinPowerState)
{
fIdleTimerMinPowerState = 0;
}
if (!callAction)
{
PM_ACTION_2(actionPowerChangeDone,
fHeadNotePowerState, fHeadNoteChangeFlags);
}
}
void IOService::OurChangeStart ( void )
{
PM_ASSERT_IN_GATE();
OUR_PMLog( kPMLogStartDeviceChange, fHeadNotePowerState, fCurrentPowerState );
if (!IS_PM_ROOT && (fMaxPowerState < fHeadNotePowerState))
{
fHeadNoteChangeFlags |= kIOPMNotDone;
requestDomainPower(fHeadNotePowerState);
OurChangeFinish();
return;
}
if (!fInitialPowerChange && (fHeadNotePowerState == fCurrentPowerState))
{
OurChangeFinish();
return;
}
fInitialPowerChange = false;
PM_ACTION_2(actionPowerChangeStart, fHeadNotePowerState, &fHeadNoteChangeFlags);
if (IS_POWER_DROP)
{
fDoNotPowerDown = false;
fMachineState = kIOPM_OurChangeTellClientsPowerDown;
fOutOfBandParameter = kNotifyApps;
askChangeDown(fHeadNotePowerState);
}
else
{
IOReturn ret;
ret = requestDomainPower( fHeadNotePowerState, kReserveDomainPower );
if (ret != kIOReturnSuccess)
{
fHeadNoteChangeFlags |= kIOPMNotDone;
OurChangeFinish();
return;
}
OurChangeTellCapabilityWillChange();
}
}
struct IOPMRequestDomainPowerContext {
IOService * child; IOPMPowerFlags requestPowerFlags; };
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();
}
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;
powerStateEntry = &fPowerStates[ourPowerState];
requestPowerFlags = powerStateEntry->inputPowerFlags;
if (powerStateEntry->capabilityFlags & (kIOPMChildClamp | kIOPMPreventIdleSleep))
requestPowerFlags |= kIOPMPreventIdleSleep;
if (powerStateEntry->capabilityFlags & (kIOPMChildClamp2 | kIOPMPreventSystemSleep))
requestPowerFlags |= kIOPMPreventSystemSleep;
if (((options & kReserveDomainPower) == 0) &&
(fPreviousRequestPowerFlags == requestPowerFlags))
{
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;
}
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;
fMachineState = kIOPM_SyncTellClientsPowerDown;
fOutOfBandParameter = kNotifyApps;
askChangeDown(fHeadNotePowerState);
}
else
{
tellSystemCapabilityChange( kIOPM_SyncNotifyWillChange );
}
}
void IOService::OurChangeTellClientsPowerDown ( void )
{
fMachineState = kIOPM_OurChangeTellPriorityClientsPowerDown;
tellChangeDown1(fHeadNotePowerState);
}
void IOService::OurChangeTellPriorityClientsPowerDown ( void )
{
fMachineState = kIOPM_OurChangeNotifyInterestedDriversWillChange;
tellChangeDown2(fHeadNotePowerState);
}
void IOService::OurChangeTellCapabilityWillChange ( void )
{
if (!IS_ROOT_DOMAIN)
return OurChangeNotifyInterestedDriversWillChange();
tellSystemCapabilityChange( kIOPM_OurChangeNotifyInterestedDriversWillChange );
}
void IOService::OurChangeNotifyInterestedDriversWillChange ( void )
{
IOPMrootDomain * rootDomain;
if ((rootDomain = getPMRootDomain()) == this)
{
if (IS_POWER_DROP)
{
rootDomain->tracePoint( kIOPMTracePointSleepWillChangeInterests );
PMEventDetails *details = PMEventDetails::eventDetails(
kIOPMEventTypeAppNotificationsFinished,
NULL,
100,
kIOReturnSuccess);
rootDomain->recordAndReleasePMEventGated( details );
}
else
rootDomain->tracePoint( kIOPMTracePointWakeWillChangeInterests );
}
notifyAll( kIOPM_OurChangeSetPowerState );
}
void IOService::OurChangeSetPowerState ( void )
{
MS_PUSH( kIOPM_OurChangeWaitForPowerSettle );
fMachineState = kIOPM_DriverThreadCallDone;
fDriverCallReason = kDriverCallSetPowerState;
if (notifyControllingDriver() == false)
notifyControllingDriverDone();
}
void IOService::OurChangeWaitForPowerSettle ( void )
{
fMachineState = kIOPM_OurChangeNotifyInterestedDriversDidChange;
startSettleTimer();
}
void IOService::OurChangeNotifyInterestedDriversDidChange ( void )
{
IOPMrootDomain * rootDomain;
if ((rootDomain = getPMRootDomain()) == this)
{
rootDomain->tracePoint( IS_POWER_DROP ?
kIOPMTracePointSleepDidChangeInterests :
kIOPMTracePointWakeDidChangeInterests );
}
notifyAll( kIOPM_OurChangeTellCapabilityDidChange );
}
void IOService::OurChangeTellCapabilityDidChange ( void )
{
if (!IS_ROOT_DOMAIN)
return OurChangeFinish();
getPMRootDomain()->tracePoint( IS_POWER_DROP ?
kIOPMTracePointSleepCapabilityClients :
kIOPMTracePointWakeCapabilityClients );
tellSystemCapabilityChange( kIOPM_OurChangeFinish );
}
void IOService::OurChangeFinish ( void )
{
all_done();
}
IOReturn IOService::ParentChangeStart ( void )
{
PM_ASSERT_IN_GATE();
OUR_PMLog( kPMLogStartParentChange, fHeadNotePowerState, fCurrentPowerState );
if ( fHeadNotePowerState < fCurrentPowerState )
{
setParentInfo( fHeadNoteParentFlags, fHeadNoteParentConnection, true );
PM_ACTION_2(actionPowerChangeStart, fHeadNotePowerState, &fHeadNoteChangeFlags);
fInitialPowerChange = false;
fMachineState = kIOPM_ParentChangeTellPriorityClientsPowerDown;
tellChangeDown1(fHeadNotePowerState);
return IOPMWillAckLater;
}
if ( fHeadNotePowerState > fCurrentPowerState )
{
if ( fDesiredPowerState > fCurrentPowerState )
{
if ( fDesiredPowerState < fHeadNotePowerState )
{
fHeadNotePowerState = fDesiredPowerState;
fHeadNotePowerArrayEntry = &fPowerStates[fDesiredPowerState];
OUR_PMLog(kPMLogAmendParentChange, fHeadNotePowerState, 0);
}
} else {
fHeadNotePowerState = fCurrentPowerState;
fHeadNotePowerArrayEntry = &fPowerStates[fCurrentPowerState];
OUR_PMLog(kPMLogAmendParentChange, fHeadNotePowerState, 0);
}
}
if ( fHeadNoteChangeFlags & kIOPMDomainDidChange )
{
if ( fHeadNotePowerState > fCurrentPowerState )
{
PM_ACTION_2(actionPowerChangeStart,
fHeadNotePowerState, &fHeadNoteChangeFlags);
fInitialPowerChange = false;
ParentChangeTellCapabilityWillChange();
return IOPMWillAckLater;
}
else if (fHeadNoteChangeFlags & kIOPMSynchronize)
{
fMachineState = kIOPM_SyncNotifyDidChange;
fDriverCallReason = kDriverCallInformPreChange;
notifyChildren();
return IOPMWillAckLater;
}
}
all_done();
return IOPMAckImplied;
}
void IOService::ParentChangeTellPriorityClientsPowerDown ( void )
{
fMachineState = kIOPM_ParentChangeNotifyInterestedDriversWillChange;
tellChangeDown2(fHeadNotePowerState);
}
void IOService::ParentChangeTellCapabilityWillChange ( void )
{
if (!IS_ROOT_DOMAIN)
return ParentChangeNotifyInterestedDriversWillChange();
tellSystemCapabilityChange( kIOPM_ParentChangeNotifyInterestedDriversWillChange );
}
void IOService::ParentChangeNotifyInterestedDriversWillChange ( void )
{
notifyAll( kIOPM_ParentChangeSetPowerState );
}
void IOService::ParentChangeSetPowerState ( void )
{
MS_PUSH( kIOPM_ParentChangeWaitForPowerSettle );
fMachineState = kIOPM_DriverThreadCallDone;
fDriverCallReason = kDriverCallSetPowerState;
if (notifyControllingDriver() == false)
notifyControllingDriverDone();
}
void IOService::ParentChangeWaitForPowerSettle ( void )
{
fMachineState = kIOPM_ParentChangeNotifyInterestedDriversDidChange;
startSettleTimer();
}
void IOService::ParentChangeNotifyInterestedDriversDidChange ( void )
{
notifyAll( kIOPM_ParentChangeTellCapabilityDidChange );
}
void IOService::ParentChangeTellCapabilityDidChange ( void )
{
if (!IS_ROOT_DOMAIN)
return ParentChangeAcknowledgePowerChange();
tellSystemCapabilityChange( kIOPM_ParentChangeAcknowledgePowerChange );
}
void IOService::ParentChangeAcknowledgePowerChange ( void )
{
IORegistryEntry * nub;
IOService * parent;
nub = fHeadNoteParentConnection;
nub->retain();
all_done();
parent = (IOService *)nub->copyParentEntry(gIOPowerPlane);
if ( parent )
{
parent->acknowledgePowerChange((IOService *)nub);
parent->release();
}
nub->release();
}
void IOService::settleTimerExpired( void )
{
fSettleTimeUS = 0;
gIOPMWorkQueue->signalWorkAvailable();
}
static void
settle_timer_expired( thread_call_param_t arg0, thread_call_param_t arg1 )
{
IOService * me = (IOService *) arg0;
if (gIOPMWorkLoop && gIOPMWorkQueue)
{
gIOPMWorkLoop->runAction(
OSMemberFunctionCast(IOWorkLoop::Action, me, &IOService::settleTimerExpired),
me);
}
me->release();
}
void IOService::startSettleTimer( void )
{
AbsoluteTime deadline;
IOPMPowerStateIndex i;
uint32_t settleTime = 0;
boolean_t pending;
PM_ASSERT_IN_GATE();
i = fCurrentPowerState;
if ( fHeadNotePowerState < fCurrentPowerState )
{
while ( i > fHeadNotePowerState )
{
settleTime += (uint32_t) fPowerStates[i].settleDownTime;
i--;
}
}
if ( fHeadNotePowerState > fCurrentPowerState )
{
while ( i < fHeadNotePowerState )
{
settleTime += (uint32_t) fPowerStates[i+1].settleUpTime;
i++;
}
}
if (settleTime)
{
retain();
clock_interval_to_deadline(settleTime, kMicrosecondScale, &deadline);
pending = thread_call_enter_delayed(fSettleTimer, deadline);
if (pending) release();
}
}
#ifndef __LP64__
void IOService::ack_timer_ticked ( void )
{
assert(false);
}
#endif
bool IOService::ackTimerTick( void )
{
IOPMinformee * nextObject;
bool done = false;
PM_ASSERT_IN_GATE();
switch (fMachineState) {
case kIOPM_OurChangeWaitForPowerSettle:
case kIOPM_ParentChangeWaitForPowerSettle:
if ( fDriverTimer > 0 )
{
fDriverTimer--;
if ( fDriverTimer == 0 )
{
uint64_t nsec = computeTimeDeltaNS(&fDriverCallStartTime);
OUR_PMLog(kPMLogCtrlDriverTardy, 0, 0);
setProperty(kIOPMTardyAckSPSKey, kOSBooleanTrue);
PM_ERROR("%s::setPowerState(%p, %lu -> %lu) timed out after %d ms\n",
fName, this, fCurrentPowerState, fHeadNotePowerState, NS_TO_MS(nsec));
#if LOG_SETPOWER_TIMES
PMEventDetails *details = PMEventDetails::eventDetails(
kIOPMEventTypeSetPowerStateDelayed, fName, (uintptr_t)this, NULL, (uint8_t)getPowerState(), 0, kIOReturnTimeout, NS_TO_US(nsec));
getPMRootDomain()->recordAndReleasePMEventGated( details );
#endif
if (gIOKitDebug & kIOLogDebugPower)
{
panic("%s::setPowerState(%p, %lu -> %lu) timed out after %d ms",
fName, this, fCurrentPowerState, fHeadNotePowerState, NS_TO_MS(nsec));
}
else
{
done = true;
}
} else {
start_ack_timer();
}
}
break;
case kIOPM_NotifyChildrenStart:
if ( fHeadNotePendingAcks != 0 )
{
nextObject = fInterestedDrivers->firstInList();
while ( nextObject != NULL )
{
if ( nextObject->timer > 0 )
{
nextObject->timer--;
if ( nextObject->timer == 0 )
{
uint64_t nsec = computeTimeDeltaNS(&nextObject->startTime);
OUR_PMLog(kPMLogIntDriverTardy, 0, 0);
nextObject->whatObject->setProperty(kIOPMTardyAckPSCKey, kOSBooleanTrue);
PM_ERROR("%s::powerState%sChangeTo(%p, %s, %lu -> %lu) timed out after %d ms\n",
nextObject->whatObject->getName(),
(fDriverCallReason == kDriverCallInformPreChange) ? "Will" : "Did",
nextObject->whatObject, fName, fCurrentPowerState, fHeadNotePowerState,
NS_TO_MS(nsec));
#if LOG_SETPOWER_TIMES
uint16_t logType = (fDriverCallReason == kDriverCallInformPreChange)
? kIOPMEventTypePSWillChangeTo
: kIOPMEventTypePSDidChangeTo;
PMEventDetails *details = PMEventDetails::eventDetails(
logType, fName, (uintptr_t)this, nextObject->whatObject->getName(), (uint8_t)fCurrentPowerState, (uint8_t)fHeadNotePowerState, kIOReturnTimeout, NS_TO_US(nsec));
getPMRootDomain()->recordAndReleasePMEventGated( details );
#endif
fHeadNotePendingAcks--;
}
}
nextObject = fInterestedDrivers->nextInList(nextObject);
}
if ( fHeadNotePendingAcks == 0 )
{
done = true;
} else {
start_ack_timer();
}
}
break;
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:
cleanClientResponses(true);
OUR_PMLog(kPMLogClientTardy, 0, 1);
done = true;
break;
default:
PM_LOG1("%s: unexpected ack timer tick (state = %d)\n",
getName(), fMachineState);
break;
}
return done;
}
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();
}
void IOService::stop_ack_timer ( void )
{
boolean_t pending;
pending = thread_call_cancel(fAckTimer);
if (pending) release();
}
IOReturn
IOService::actionAckTimerExpired (
OSObject * target,
void * arg0, void * arg1,
void * arg2, void * arg3 )
{
IOService * me = (IOService *) target;
bool done;
done = me->ackTimerTick();
if (done && gIOPMWorkQueue)
gIOPMWorkQueue->signalWorkAvailable();
return kIOReturnSuccess;
}
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();
}
void IOService::tellSystemCapabilityChange( uint32_t nextMS )
{
MS_PUSH( nextMS );
fMachineState = kIOPM_TellCapabilityChangeDone;
fOutOfBandMessage = kIOMessageSystemCapabilityChange;
if (fIsPreChange)
{
fOutOfBandParameter = kNotifyCapabilityChangeApps;
}
else
{
fOutOfBandParameter = kNotifyCapabilityChangePriority;
}
tellClientsWithResponse( fOutOfBandMessage );
}
bool IOService::askChangeDown ( unsigned long stateNum )
{
return tellClientsWithResponse( kIOMessageCanDevicePowerOff );
}
bool IOService::tellChangeDown1 ( unsigned long stateNum )
{
fOutOfBandParameter = kNotifyApps;
return tellChangeDown(stateNum);
}
bool IOService::tellChangeDown2 ( unsigned long stateNum )
{
fOutOfBandParameter = kNotifyPriority;
return tellChangeDown(stateNum);
}
bool IOService::tellChangeDown ( unsigned long stateNum )
{
return tellClientsWithResponse( kIOMessageDeviceWillPowerOff );
}
static void logAppTimeouts ( OSObject * object, void * arg )
{
IOPMInterestContext * context = (IOPMInterestContext *) arg;
OSObject * flag;
unsigned int clientIndex;
if (OSDynamicCast(_IOServiceInterestNotifier, object))
{
clientIndex = context->notifyClients->getNextIndexOfObject(object, 0);
if ((clientIndex != (unsigned int) -1) &&
(flag = context->responseArray->getObject(clientIndex)) &&
(flag != kOSBooleanTrue))
{
OSString * clientID = 0;
context->us->messageClient(context->messageType, object, &clientID);
PM_ERROR(context->errorLog, clientID ? clientID->getCStringNoCopy() : "");
IOService::getPMRootDomain()->pmStatsRecordApplicationResponse(
gIOPMStatsApplicationResponseTimedOut,
clientID ? clientID->getCStringNoCopy() : "",
0, (30*1000), -1);
if (clientID)
clientID->release();
}
}
}
void IOService::cleanClientResponses ( bool logErrors )
{
if (logErrors && fResponseArray)
{
switch ( fOutOfBandParameter ) {
case kNotifyApps:
case kNotifyCapabilityChangeApps:
if (fNotifyClientArray)
{
IOPMInterestContext context;
context.responseArray = fResponseArray;
context.notifyClients = fNotifyClientArray;
context.serialNumber = fSerialNumber;
context.messageType = kIOMessageCopyClientID;
context.notifyType = kNotifyApps;
context.isPreChange = fIsPreChange;
context.enableTracing = false;
context.us = this;
context.maxTimeRequested = 0;
context.stateNumber = fHeadNotePowerState;
context.stateFlags = fHeadNotePowerArrayEntry->capabilityFlags;
context.changeFlags = fHeadNoteChangeFlags;
context.errorLog = "PM notification timeout (%s)\n";
applyToInterested(gIOAppPowerStateInterest, logAppTimeouts, (void *) &context);
}
break;
default:
PM_ERROR("PM priority notification timeout\n");
if (gIOKitDebug & kIOLogDebugPower)
{
panic("PM priority notification timeout");
}
break;
}
}
if (fResponseArray)
{
fResponseArray->release();
fResponseArray = NULL;
}
if (fNotifyClientArray)
{
fNotifyClientArray->release();
fNotifyClientArray = NULL;
}
}
bool IOService::tellClientsWithResponse ( int messageType )
{
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 );
if (!fResponseArray)
goto exit;
fResponseArray->setCapacityIncrement(8);
if (++fSerialNumber == 0)
fSerialNumber++;
context.responseArray = fResponseArray;
context.notifyClients = 0;
context.serialNumber = fSerialNumber;
context.messageType = messageType;
context.notifyType = fOutOfBandParameter;
context.isPreChange = fIsPreChange;
context.enableTracing = false;
context.us = this;
context.maxTimeRequested = 0;
context.stateNumber = fHeadNotePowerState;
context.stateFlags = fHeadNotePowerArrayEntry->capabilityFlags;
context.changeFlags = fHeadNoteChangeFlags;
context.messageFilter = (isRootDomain) ?
OSMemberFunctionCast(
IOPMMessageFilter,
this,
&IOPMrootDomain::systemMessageFilter) : 0;
switch ( fOutOfBandParameter ) {
case kNotifyApps:
applyToInterested( gIOAppPowerStateInterest,
pmTellAppWithResponse, (void *) &context );
if (isRootDomain &&
(fMachineState != kIOPM_OurChangeTellClientsPowerDown) &&
(fMachineState != kIOPM_SyncTellClientsPowerDown))
{
context.notifyType = kNotifyCapabilityChangeApps;
context.messageType = kIOMessageSystemCapabilityChange;
applyToInterested( gIOAppPowerStateInterest,
pmTellCapabilityAppWithResponse, (void *) &context );
context.notifyType = fOutOfBandParameter;
context.messageType = messageType;
}
context.maxTimeRequested = k30seconds;
applyToInterested( gIOGeneralInterest,
pmTellClientWithResponse, (void *) &context );
fNotifyClientArray = context.notifyClients;
break;
case kNotifyPriority:
context.enableTracing = isRootDomain;
applyToInterested( gIOPriorityPowerStateInterest,
pmTellClientWithResponse, (void *) &context );
if (isRootDomain)
{
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;
}
if ( !checkForDone() )
{
OUR_PMLog(kPMLogStartAckTimer, context.maxTimeRequested, 0);
if (context.enableTracing)
getPMRootDomain()->traceDetail( context.maxTimeRequested / 1000 );
start_ack_timer( context.maxTimeRequested / 1000, kMillisecondScale );
return false;
}
exit:
if (fResponseArray)
{
fResponseArray->release();
fResponseArray = NULL;
}
if (fNotifyClientArray)
{
fNotifyClientArray->release();
fNotifyClientArray = NULL;
}
return true;
}
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)
{
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;
}
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)
{
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);
}
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 )
{
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
{
OUR_PMLog(kPMLogClientAcknowledge, msgRef, 0);
}
context->responseArray->setObject(msgIndex, replied);
}
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;
}
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)
{
OSString * clientID = 0;
context->us->messageClient(kIOMessageCopyClientID, object, &clientID);
PM_LOG("%s MESG App(%u) %s, wait %u, %s\n",
context->us->getName(),
msgIndex, getIOMessageString(msgType),
(replied != kOSBooleanTrue),
clientID ? clientID->getCStringNoCopy() : "");
if (clientID) clientID->release();
}
msgArg.notifyRef = msgRef;
msgArg.maxWaitForReply = 0;
if (replied == kOSBooleanTrue)
{
msgArg.notifyRef = 0;
context->responseArray->setObject(msgIndex, kOSBooleanTrue);
if (context->notifyClients)
context->notifyClients->setObject(msgIndex, kOSBooleanTrue);
}
else
{
#if LOG_APP_RESPONSE_TIMES
OSNumber * num;
clock_get_uptime(&now);
num = OSNumber::withNumber(AbsoluteTime_to_scalar(&now), sizeof(uint64_t) * 8);
if (num)
{
context->responseArray->setObject(msgIndex, num);
num->release();
}
else
#endif
context->responseArray->setObject(msgIndex, kOSBooleanFalse);
if (context->notifyClients)
context->notifyClients->setObject(msgIndex, object);
}
context->us->messageClient(msgType, object, (void *) &msgArg, sizeof(msgArg));
}
void IOService::pmTellCapabilityClientWithResponse(
OSObject * object, void * arg )
{
IOPMSystemCapabilityChangeParameters msgArg;
IOPMInterestContext * context = (IOPMInterestContext *) arg;
OSObject * replied = kOSBooleanTrue;
_IOServiceInterestNotifier * notifier;
uint32_t msgIndex, msgRef, msgType;
IOReturn retCode;
memset(&msgArg, 0, sizeof(msgArg));
if (context->messageFilter &&
!context->messageFilter(context->us, object, context, &msgArg, 0))
{
if ((kIOLogDebugPower & gIOKitDebug) &&
(OSDynamicCast(_IOServiceInterestNotifier, object)))
{
_IOServiceInterestNotifier *n = (_IOServiceInterestNotifier *) object;
PM_LOG("%s DROP Client %s, notifier %p, handler %p\n",
context->us->getName(),
getIOMessageString(context->messageType),
object, n->handler);
}
return;
}
notifier = OSDynamicCast(_IOServiceInterestNotifier, object);
msgType = context->messageType;
msgIndex = context->responseArray->getCount();
msgRef = ((context->serialNumber & 0xFFFF) << 16) + (msgIndex & 0xFFFF);
IOServicePM * pwrMgt = context->us->pwrMgt;
if (gIOKitDebug & kIOLogPower) {
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);
}
msgArg.notifyRef = msgRef;
msgArg.maxWaitForReply = 0;
if (context->enableTracing && (notifier != 0))
{
uint32_t detail = ((msgIndex & 0xff) << 24) |
((msgType & 0xfff) << 12) |
(((uintptr_t) notifier->handler) & 0xfff);
getPMRootDomain()->traceDetail( detail );
}
retCode = context->us->messageClient(
msgType, object, (void *) &msgArg, sizeof(msgArg));
if ( kIOReturnSuccess == retCode )
{
if ( 0 == msgArg.maxWaitForReply )
{
OUR_PMLog(kPMLogClientAcknowledge, msgRef, (uintptr_t) object);
}
else
{
replied = kOSBooleanFalse;
if ( msgArg.maxWaitForReply > context->maxTimeRequested )
{
if (msgArg.maxWaitForReply > kCapabilityClientMaxWait)
{
context->maxTimeRequested = kCapabilityClientMaxWait;
PM_ERROR("%s: client %p returned %u for %s\n",
context->us->getName(),
notifier ? (void *) notifier->handler : object,
msgArg.maxWaitForReply,
getIOMessageString(msgType));
}
else
context->maxTimeRequested = msgArg.maxWaitForReply;
}
}
}
else
{
OUR_PMLog(kPMLogClientAcknowledge, msgRef, 0);
}
context->responseArray->setObject(msgIndex, replied);
}
void IOService::tellNoChangeDown ( unsigned long )
{
return tellClients( kIOMessageDeviceWillNotPowerOff );
}
void IOService::tellChangeUp ( unsigned long )
{
return tellClients( kIOMessageDeviceHasPoweredOn );
}
void IOService::tellClients ( int messageType )
{
IOPMInterestContext context;
RD_LOG("tellClients( %s )\n", getIOMessageString(messageType));
memset(&context, 0, sizeof(context));
context.messageType = messageType;
context.isPreChange = fIsPreChange;
context.us = this;
context.stateNumber = fHeadNotePowerState;
context.stateFlags = fHeadNotePowerArrayEntry->capabilityFlags;
context.changeFlags = fHeadNoteChangeFlags;
context.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 );
}
static void tellKernelClientApplier ( OSObject * object, void * arg )
{
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.returnValue = 0;
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);
}
}
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)
{
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)
{
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();
}
context->us->messageClient(context->messageType, object, 0);
}
bool IOService::checkForDone ( void )
{
int i = 0;
OSObject * theFlag;
if ( fResponseArray == NULL )
{
return true;
}
for ( i = 0; ; i++ )
{
theFlag = fResponseArray->getObject(i);
if ( theFlag == NULL )
{
break;
}
if ( kOSBooleanTrue != theFlag )
{
return false;
}
}
return true;
}
bool IOService::responseValid ( uint32_t refcon, int pid )
{
UInt16 serialComponent;
UInt16 ordinalComponent;
OSObject * theFlag;
serialComponent = (refcon >> 16) & 0xFFFF;
ordinalComponent = (refcon & 0xFFFF);
if ( serialComponent != fSerialNumber )
{
return false;
}
if ( fResponseArray == NULL )
{
return false;
}
theFlag = fResponseArray->getObject(ordinalComponent);
if ( theFlag == 0 )
{
return false;
}
OSNumber * num;
if ((num = OSDynamicCast(OSNumber, theFlag)))
{
#if LOG_APP_RESPONSE_TIMES
AbsoluteTime now;
AbsoluteTime start;
uint64_t nsec;
OSString *name = IOCopyLogNameForPID(pid);
clock_get_uptime(&now);
AbsoluteTime_to_scalar(&start) = num->unsigned64BitValue();
SUB_ABSOLUTETIME(&now, &start);
absolutetime_to_nanoseconds(now, &nsec);
PMEventDetails *details = PMEventDetails::eventDetails(
kIOPMEventTypeAppResponse, name ? name->getCStringNoCopy() : "", (uintptr_t)pid, NULL, 0, 0, 0, NS_TO_US(nsec));
getPMRootDomain()->recordAndReleasePMEventGated( details );
if (kIOLogDebugPower & gIOKitDebug)
{
PM_LOG("Ack(%u) %u ms\n",
(uint32_t) ordinalComponent,
NS_TO_MS(nsec));
}
if (nsec > LOG_APP_RESPONSE_TIMES)
{
PM_LOG("PM response took %d ms (%s)\n", NS_TO_MS(nsec),
name ? name->getCStringNoCopy() : "");
if (nsec > LOG_APP_RESPONSE_MSG_TRACER)
{
getPMRootDomain()->pmStatsRecordApplicationResponse(
gIOPMStatsApplicationResponseSlow,
name ? name->getCStringNoCopy() : "", 0,
NS_TO_MS(nsec), pid);
}
}
if (name)
name->release();
#endif
theFlag = kOSBooleanFalse;
}
if ( kOSBooleanFalse == theFlag )
{
fResponseArray->replaceObject(ordinalComponent, kOSBooleanTrue);
}
return true;
}
IOReturn IOService::allowPowerChange ( unsigned long refcon )
{
IOPMRequest * request;
if ( !initialized )
{
return kIOReturnSuccess;
}
request = acquirePMRequest( this, kIOPMRequestTypeAllowPowerChange );
if (!request)
return kIOReturnNoMemory;
request->fArg0 = (void *) refcon;
request->fArg1 = (void *) proc_selfpid();
request->fArg2 = (void *) 0;
submitPMRequest( request );
return kIOReturnSuccess;
}
#ifndef __LP64__
IOReturn IOService::serializedAllowPowerChange2 ( unsigned long refcon )
{
return kIOReturnUnsupported;
}
#endif
IOReturn IOService::cancelPowerChange ( unsigned long refcon )
{
IOPMRequest * request;
OSString * name;
if ( !initialized )
{
return kIOReturnSuccess;
}
name = IOCopyLogNameForPID(proc_selfpid());
PM_ERROR("PM notification cancel (%s)\n", name ? name->getCStringNoCopy() : "");
request = acquirePMRequest( this, kIOPMRequestTypeCancelPowerChange );
if (!request)
{
if (name)
name->release();
return kIOReturnNoMemory;
}
request->fArg0 = (void *) refcon;
request->fArg1 = (void *) proc_selfpid();
request->fArg2 = (void *) name;
submitPMRequest( request );
return kIOReturnSuccess;
}
#ifndef __LP64__
IOReturn IOService::serializedCancelPowerChange2 ( unsigned long refcon )
{
return kIOReturnUnsupported;
}
void IOService::PM_Clamp_Timer_Expired ( void )
{
}
void IOService::clampPowerOn ( unsigned long duration )
{
}
#endif
IOReturn IOService::setPowerState (
unsigned long powerStateOrdinal, IOService * whatDevice )
{
return IOPMNoErr;
}
unsigned long IOService::maxCapabilityForDomainState ( IOPMPowerFlags domainState )
{
int i;
if (fNumberOfPowerStates == 0 )
{
return 0;
}
for ( i = fNumberOfPowerStates - 1; i >= 0; i-- )
{
if ( (domainState & fPowerStates[i].inputPowerFlags) ==
fPowerStates[i].inputPowerFlags )
{
return i;
}
}
return 0;
}
unsigned long IOService::initialPowerStateForDomainState ( IOPMPowerFlags domainState )
{
int i;
if (fNumberOfPowerStates == 0 )
{
return 0;
}
for ( i = fNumberOfPowerStates - 1; i >= 0; i-- )
{
if ( (domainState & fPowerStates[i].inputPowerFlags) ==
fPowerStates[i].inputPowerFlags )
{
return i;
}
}
return 0;
}
unsigned long IOService::powerStateForDomainState ( IOPMPowerFlags domainState )
{
int i;
if (fNumberOfPowerStates == 0 )
{
return 0;
}
for ( i = fNumberOfPowerStates - 1; i >= 0; i-- )
{
if ( (domainState & fPowerStates[i].inputPowerFlags) ==
fPowerStates[i].inputPowerFlags )
{
return i;
}
}
return 0;
}
#ifndef __LP64__
bool IOService::didYouWakeSystem ( void )
{
return false;
}
#endif
IOReturn IOService::powerStateWillChangeTo ( IOPMPowerFlags, unsigned long, IOService * )
{
return kIOPMAckImplied;
}
IOReturn IOService::powerStateDidChangeTo ( IOPMPowerFlags, unsigned long, IOService * )
{
return kIOPMAckImplied;
}
void IOService::powerChangeDone ( unsigned long )
{
}
#ifndef __LP64__
IOReturn IOService::newTemperature ( long currentTemp, IOService * whichZone )
{
return IOPMNoErr;
}
#endif
void IOService::systemWillShutdown( IOOptionBits specifier )
{
IOPMrootDomain * rootDomain = IOService::getPMRootDomain();
if (rootDomain)
rootDomain->acknowledgeSystemWillShutdown( this );
}
IOPMRequest *
IOService::acquirePMRequest( IOService * target, IOOptionBits requestType,
IOPMRequest * active )
{
IOPMRequest * request;
assert(target);
request = IOPMRequest::create();
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;
}
void IOService::releasePMRequest( IOPMRequest * request )
{
if (request)
{
request->reset();
request->release();
}
}
void IOService::submitPMRequest( IOPMRequest * request )
{
assert( request );
assert( gIOPMReplyQueue );
assert( gIOPMRequestQueue );
PM_LOG1("[+ %02lx] %p [%p %s] %p %p %p\n",
(long)request->getType(), request,
request->getTarget(), request->getTarget()->getName(),
request->fArg0, request->fArg1, request->fArg2);
if (request->isReplyType())
gIOPMReplyQueue->queuePMRequest( request );
else
gIOPMRequestQueue->queuePMRequest( request );
}
void IOService::submitPMRequest( IOPMRequest ** requests, IOItemCount count )
{
assert( requests );
assert( count > 0 );
assert( gIOPMRequestQueue );
for (IOItemCount i = 0; i < count; i++)
{
IOPMRequest * req = requests[i];
PM_LOG1("[+ %02lx] %p [%p %s] %p %p %p\n",
(long)req->getType(), req,
req->getTarget(), req->getTarget()->getName(),
req->fArg0, req->fArg1, req->fArg2);
}
gIOPMRequestQueue->queuePMRequestChain( requests, count );
}
bool IOService::servicePMRequestQueue(
IOPMRequest * request,
IOPMRequestQueue * queue )
{
bool more;
if (initialized)
{
more = gIOPMWorkQueue->queuePMRequest(request, pwrMgt);
return more;
}
PM_LOG("%s: PM not initialized\n", getName());
fAdjustPowerScheduled = false;
more = gIOPMFreeQueue->queuePMRequest(request);
if (more) gIOPMWorkQueue->incrementProducerCount();
return more;
}
bool IOService::servicePMFreeQueue(
IOPMRequest * request,
IOPMCompletionQueue * queue )
{
bool more = request->getNextRequest();
IOPMRequest * root = request->getRootRequest();
if (root && (root != request))
more = true;
if (more)
gIOPMWorkQueue->incrementProducerCount();
releasePMRequest( request );
return more;
}
bool IOService::retirePMRequest( IOPMRequest * request, IOPMWorkQueue * queue )
{
assert(request && queue);
PM_LOG1("[- %02x] %p [%p %s] state %d, busy %d\n",
request->getType(), request, this, getName(),
fMachineState, gIOPMBusyCount);
if ((request->getType() == kIOPMRequestTypeActivityTickle) &&
(request->fArg1 == (void *) (uintptr_t) false))
{
if (fDeviceDesire > 0)
{
fActivityTickleCount = 0;
clock_get_uptime(&fIdleTimerStartTime);
start_PM_idle_timer();
}
else
fIdleTimerStopped = true;
}
return (gIOPMFreeQueue->queuePMRequest( request ));
}
bool IOService::isPMBlocked ( IOPMRequest * request, int count )
{
int reason = 0;
do {
if (kIOPM_Finished == fMachineState)
break;
if (kIOPM_DriverThreadCallDone == fMachineState)
{
if (fDriverCallBusy)
reason = 5 + fDriverCallReason;
break;
}
if (fDriverTimer)
{
reason = 1; break;
}
if (fHeadNotePendingAcks)
{
reason = 2; break;
}
if (fResponseArray)
{
reason = 3; break;
}
if (fSettleTimeUS)
{
reason = 4; break;
}
} while (false);
fWaitReason = reason;
if (reason)
{
if (count)
{
PM_LOG1("[B %02x] %p [%p %s] state %d, reason %d\n",
request->getType(), request, this, getName(),
fMachineState, reason);
}
return true;
}
return false;
}
bool IOService::servicePMRequest( IOPMRequest * request, IOPMWorkQueue * queue )
{
bool done = false;
int loop = 0;
assert(request && queue);
while (isPMBlocked(request, loop++) == false)
{
PM_LOG1("[W %02x] %p [%p %s] state %d\n",
request->getType(), request, this, getName(), fMachineState);
gIOPMRequest = request;
gIOPMWorkCount++;
switch ( fMachineState )
{
case kIOPM_Finished:
executePMRequest( request );
break;
case kIOPM_OurChangeTellClientsPowerDown:
if (IS_ROOT_DOMAIN)
{
bool cancel = (bool) fDoNotPowerDown;
getPMRootDomain()->askChangeDownDone(
&fHeadNoteChangeFlags, &cancel);
fDoNotPowerDown = cancel;
}
if (!fDoNotPowerDown)
{
if (IS_ROOT_DOMAIN) {
PMEventDetails *details = PMEventDetails::eventDetails(
kIOPMEventTypeAppNotificationsFinished,
NULL,
0,
0);
getPMRootDomain()->recordAndReleasePMEventGated( details );
}
OurChangeTellClientsPowerDown();
}
else
{
if (IS_ROOT_DOMAIN) {
PMEventDetails *details = PMEventDetails::eventDetails(
kIOPMEventTypeSleepDone,
NULL,
1,
kIOReturnAborted);
getPMRootDomain()->recordAndReleasePMEventGated( details );
}
OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState);
PM_ERROR("%s: idle cancel\n", fName);
tellNoChangeDown(fHeadNotePowerState);
fHeadNoteChangeFlags |= kIOPMNotDone;
OurChangeFinish();
}
break;
case kIOPM_OurChangeTellPriorityClientsPowerDown:
if (fDoNotPowerDown)
{
if (IS_ROOT_DOMAIN) {
PMEventDetails *details = PMEventDetails::eventDetails(
kIOPMEventTypeSleepDone,
NULL,
2,
kIOReturnAborted);
getPMRootDomain()->recordAndReleasePMEventGated( details );
}
OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState);
PM_ERROR("%s: idle revert\n", fName);
tellChangeUp(fCurrentPowerState);
fHeadNoteChangeFlags |= kIOPMNotDone;
OurChangeFinish();
}
else
{
if (IS_ROOT_DOMAIN) {
PMEventDetails *details = PMEventDetails::eventDetails(
kIOPMEventTypeAppNotificationsFinished,
NULL,
2,
kIOReturnSuccess);
getPMRootDomain()->recordAndReleasePMEventGated( details );
}
OurChangeTellPriorityClientsPowerDown();
}
break;
case kIOPM_OurChangeNotifyInterestedDriversWillChange:
OurChangeNotifyInterestedDriversWillChange();
break;
case kIOPM_OurChangeSetPowerState:
OurChangeSetPowerState();
break;
case kIOPM_OurChangeWaitForPowerSettle:
OurChangeWaitForPowerSettle();
break;
case kIOPM_OurChangeNotifyInterestedDriversDidChange:
OurChangeNotifyInterestedDriversDidChange();
break;
case kIOPM_OurChangeTellCapabilityDidChange:
OurChangeTellCapabilityDidChange();
break;
case kIOPM_OurChangeFinish:
OurChangeFinish();
break;
case kIOPM_ParentChangeTellPriorityClientsPowerDown:
ParentChangeTellPriorityClientsPowerDown();
break;
case kIOPM_ParentChangeNotifyInterestedDriversWillChange:
ParentChangeNotifyInterestedDriversWillChange();
break;
case kIOPM_ParentChangeSetPowerState:
ParentChangeSetPowerState();
break;
case kIOPM_ParentChangeWaitForPowerSettle:
ParentChangeWaitForPowerSettle();
break;
case kIOPM_ParentChangeNotifyInterestedDriversDidChange:
ParentChangeNotifyInterestedDriversDidChange();
break;
case kIOPM_ParentChangeTellCapabilityDidChange:
ParentChangeTellCapabilityDidChange();
break;
case kIOPM_ParentChangeAcknowledgePowerChange:
ParentChangeAcknowledgePowerChange();
break;
case kIOPM_DriverThreadCallDone:
if (fDriverCallReason == kDriverCallSetPowerState)
notifyControllingDriverDone();
else
notifyInterestedDriversDone();
break;
case kIOPM_NotifyChildrenOrdered:
notifyChildrenOrdered();
break;
case kIOPM_NotifyChildrenDelayed:
notifyChildrenDelayed();
break;
case kIOPM_NotifyChildrenStart:
PM_LOG2("%s: kIOPM_NotifyChildrenStart done\n", getName());
MS_POP(); notifyChildren();
break;
case kIOPM_SyncTellClientsPowerDown:
if (IS_ROOT_DOMAIN)
{
bool cancel = (bool) fDoNotPowerDown;
getPMRootDomain()->askChangeDownDone(
&fHeadNoteChangeFlags, &cancel);
fDoNotPowerDown = cancel;
}
if (!fDoNotPowerDown)
{
fMachineState = kIOPM_SyncTellPriorityClientsPowerDown;
fOutOfBandParameter = kNotifyApps;
tellChangeDown(fHeadNotePowerState);
}
else
{
OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState);
PM_ERROR("%s: idle cancel\n", fName);
tellNoChangeDown(fHeadNotePowerState);
fHeadNoteChangeFlags |= kIOPMNotDone;
OurChangeFinish();
}
break;
case kIOPM_SyncTellPriorityClientsPowerDown:
if (!fDoNotPowerDown)
{
fMachineState = kIOPM_SyncNotifyWillChange;
fOutOfBandParameter = kNotifyPriority;
tellChangeDown(fHeadNotePowerState);
}
else
{
OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState);
PM_ERROR("%s: idle revert\n", fName);
tellChangeUp(fCurrentPowerState);
fHeadNoteChangeFlags |= kIOPMNotDone;
OurChangeFinish();
}
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(); continue;
}
fOutOfBandParameter = kNotifyCapabilityChangePriority;
}
else
{
if (fOutOfBandParameter == kNotifyCapabilityChangeApps)
{
MS_POP(); continue;
}
fOutOfBandParameter = kNotifyCapabilityChangeApps;
}
tellClientsWithResponse( fOutOfBandMessage );
break;
default:
panic("servicePMWorkQueue: unknown machine state %x",
fMachineState);
}
gIOPMRequest = 0;
if (fMachineState == kIOPM_Finished)
{
done = true;
break;
}
}
return done;
}
void IOService::executePMRequest( IOPMRequest * request )
{
assert( kIOPM_Finished == fMachineState );
switch (request->getType())
{
case kIOPMRequestTypePMStop:
handlePMstop( request );
break;
case kIOPMRequestTypeAddPowerChild1:
addPowerChild1( request );
break;
case kIOPMRequestTypeAddPowerChild2:
addPowerChild2( request );
break;
case kIOPMRequestTypeAddPowerChild3:
addPowerChild3( request );
break;
case kIOPMRequestTypeRegisterPowerDriver:
handleRegisterPowerDriver( request );
break;
case kIOPMRequestTypeAdjustPowerState:
fAdjustPowerScheduled = false;
rebuildChildClampBits();
adjustPowerState();
break;
case kIOPMRequestTypePowerDomainWillChange:
handlePowerDomainWillChangeTo( request );
break;
case kIOPMRequestTypePowerDomainDidChange:
handlePowerDomainDidChangeTo( request );
break;
case kIOPMRequestTypeRequestPowerState:
case kIOPMRequestTypeRequestPowerStateOverride:
handleRequestPowerState( request );
break;
case kIOPMRequestTypePowerOverrideOnPriv:
case kIOPMRequestTypePowerOverrideOffPriv:
handlePowerOverrideChanged( request );
break;
case kIOPMRequestTypeActivityTickle:
handleActivityTickle( request );
break;
case kIOPMRequestTypeSynchronizePowerTree:
handleSynchronizePowerTree( request );
break;
case kIOPMRequestTypeSetIdleTimerPeriod:
{
fIdleTimerPeriod = (uintptr_t) request->fArg0;
if ((false == fLockedFlags.PMStop) && (fIdleTimerPeriod > 0))
{
fActivityTickleCount = 0;
clock_get_uptime(&fIdleTimerStartTime);
start_PM_idle_timer();
}
}
break;
default:
panic("executePMRequest: unknown request type %x", request->getType());
}
}
bool IOService::servicePMReplyQueue( IOPMRequest * request, IOPMRequestQueue * queue )
{
bool more = false;
assert( request && queue );
assert( request->isReplyType() );
PM_LOG1("[A %02x] %p [%p %s] state %d\n",
request->getType(), request, this, getName(), fMachineState);
switch ( request->getType() )
{
case kIOPMRequestTypeAllowPowerChange:
case kIOPMRequestTypeCancelPowerChange:
if (responseValid((uint32_t)(uintptr_t) request->fArg0,
(int)(uintptr_t) request->fArg1))
{
if (kIOPMRequestTypeCancelPowerChange == request->getType())
{
if ((fHeadNoteChangeFlags & kIOPMSkipAskPowerDown) == 0)
{
fDoNotPowerDown = true;
OSString * name = (OSString *) request->fArg2;
getPMRootDomain()->pmStatsRecordApplicationResponse(
gIOPMStatsApplicationResponseCancel,
name ? name->getCStringNoCopy() : "", 0,
0, (int)(uintptr_t) request->fArg1);
}
}
if (checkForDone())
{
stop_ack_timer();
cleanClientResponses(false);
more = true;
}
}
if (request->getType() == kIOPMRequestTypeCancelPowerChange)
{
OSObject * obj = (OSObject *) request->fArg2;
if (obj) obj->release();
}
break;
case kIOPMRequestTypeAckPowerChange:
more = handleAcknowledgePowerChange( request );
break;
case kIOPMRequestTypeAckSetPowerState:
if (fDriverTimer == -1)
{
OUR_PMLog(kPMLogDriverAcknowledgeSet,
(uintptr_t) this, fDriverTimer);
fDriverTimer = 0;
}
else if (fDriverTimer > 0)
{
stop_ack_timer();
#if LOG_SETPOWER_TIMES
uint64_t nsec = computeTimeDeltaNS(&fDriverCallStartTime);
if (nsec > LOG_SETPOWER_TIMES)
PM_LOG("%s::setPowerState(%p, %lu -> %lu) async took %d ms\n",
fName, this, fCurrentPowerState, fHeadNotePowerState, NS_TO_MS(nsec));
PMEventDetails *details = PMEventDetails::eventDetails(
kIOPMEventTypeSetPowerStateDelayed, fName, (uintptr_t)this, NULL, (uint8_t)getPowerState(), (uint8_t)fHeadNotePowerState, 0, NS_TO_US(nsec));
getPMRootDomain()->recordAndReleasePMEventGated( details );
#endif
OUR_PMLog(kPMLogDriverAcknowledgeSet, (uintptr_t) this, fDriverTimer);
fDriverTimer = 0;
more = true;
}
else
{
OUR_PMLog(kPMLogAcknowledgeErr4, (uintptr_t) this, 0);
}
break;
case kIOPMRequestTypeInterestChanged:
handleInterestChanged( request );
more = true;
break;
case kIOPMRequestTypeIdleCancel:
if ((fMachineState == kIOPM_OurChangeTellClientsPowerDown)
|| (fMachineState == kIOPM_OurChangeTellPriorityClientsPowerDown)
|| (fMachineState == kIOPM_SyncTellClientsPowerDown)
|| (fMachineState == kIOPM_SyncTellPriorityClientsPowerDown))
{
OUR_PMLog(kPMLogIdleCancel, (uintptr_t) this, fMachineState);
PM_LOG2("%s: cancel from machine state %d\n",
getName(), fMachineState);
fDoNotPowerDown = true;
if ((fMachineState == kIOPM_OurChangeTellPriorityClientsPowerDown) ||
(fMachineState == kIOPM_SyncTellPriorityClientsPowerDown))
cleanClientResponses(false);
more = true;
}
break;
case kIOPMRequestTypeChildNotifyDelayCancel:
if (fMachineState == kIOPM_NotifyChildrenDelayed)
{
PM_LOG2("%s: delay notify cancelled\n", getName());
notifyChildrenDelayed();
}
break;
default:
panic("servicePMReplyQueue: unknown reply type %x",
request->getType());
}
more |= gIOPMFreeQueue->queuePMRequest(request);
if (more)
gIOPMWorkQueue->incrementProducerCount();
return more;
}
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)
{
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);
}
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);
}
OSDefineMetaClassAndStructors( IOPMRequest, IOCommand );
IOPMRequest * IOPMRequest::create( void )
{
IOPMRequest * me = OSTypeAlloc(IOPMRequest);
if (me && !me->init(0, kIOPMRequestTypeInvalid))
{
me->release();
me = 0;
}
return me;
}
bool IOPMRequest::init( IOService * target, IOOptionBits type )
{
if (!IOCommand::init())
return false;
fType = type;
fTarget = target;
fCompletionStatus = kIOReturnSuccess;
if (fTarget)
fTarget->retain();
return true;
}
void IOPMRequest::reset( void )
{
assert( fWorkWaitCount == 0 );
assert( fFreeWaitCount == 0 );
detachNextRequest();
detachRootRequest();
fType = kIOPMRequestTypeInvalid;
if (fCompletionAction)
{
fCompletionAction(fCompletionTarget, fCompletionParam, fCompletionStatus);
}
if (fTarget)
{
fTarget->release();
fTarget = 0;
}
}
bool IOPMRequest::attachNextRequest( IOPMRequest * next )
{
bool ok = false;
if (!fRequestNext)
{
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)
{
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;
}
OSDefineMetaClassAndStructors( IOPMRequestQueue, IOEventSource );
IOPMRequestQueue * IOPMRequestQueue::create( IOService * inOwner, Action inAction )
{
IOPMRequestQueue * me = OSTypeAlloc(IOPMRequestQueue);
if (me && !me->init(inOwner, inAction))
{
me->release();
me = 0;
}
return me;
}
bool IOPMRequestQueue::init( IOService * inOwner, Action inAction )
{
if (!inAction || !IOEventSource::init(inOwner, (IOEventSourceAction)inAction))
return false;
queue_init(&fQueue);
fLock = IOLockAlloc();
return (fLock != 0);
}
void IOPMRequestQueue::free( void )
{
if (fLock)
{
IOLockFree(fLock);
fLock = 0;
}
return IOEventSource::free();
}
void IOPMRequestQueue::queuePMRequest( IOPMRequest * request )
{
assert(request);
IOLockLock(fLock);
queue_enter(&fQueue, request, IOPMRequest *, fCommandChain);
IOLockUnlock(fLock);
if (workLoop) signalWorkAvailable();
}
void
IOPMRequestQueue::queuePMRequestChain( IOPMRequest ** requests, IOItemCount count )
{
IOPMRequest * next;
assert(requests && count);
IOLockLock(fLock);
while (count--)
{
next = *requests;
requests++;
queue_enter(&fQueue, next, IOPMRequest *, fCommandChain);
}
IOLockUnlock(fLock);
if (workLoop) signalWorkAvailable();
}
bool IOPMRequestQueue::checkForWork( void )
{
Action dqAction = (Action) action;
IOPMRequest * request;
IOService * target;
bool more = false;
IOLockLock( fLock );
while (!queue_empty(&fQueue))
{
queue_remove_first( &fQueue, request, IOPMRequest *, fCommandChain );
IOLockUnlock( fLock );
target = request->getTarget();
assert(target);
more |= (*dqAction)( target, request, this );
IOLockLock( fLock );
}
IOLockUnlock( fLock );
return more;
}
OSDefineMetaClassAndStructors( IOPMWorkQueue, IOEventSource );
IOPMWorkQueue *
IOPMWorkQueue::create( IOService * inOwner, Action work, Action retire )
{
IOPMWorkQueue * me = OSTypeAlloc(IOPMWorkQueue);
if (me && !me->init(inOwner, work, retire))
{
me->release();
me = 0;
}
return me;
}
bool IOPMWorkQueue::init( IOService * inOwner, Action work, Action retire )
{
if (!work || !retire ||
!IOEventSource::init(inOwner, (IOEventSourceAction)0))
return false;
queue_init(&fWorkQueue);
fWorkAction = work;
fRetireAction = retire;
fConsumerCount = fProducerCount = 0;
return true;
}
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++;
empty = queue_empty(&pwrMgt->RequestHead);
queue_enter(&pwrMgt->RequestHead, request, IOPMRequest *, fCommandChain);
if (empty)
{
more = checkRequestQueue(&pwrMgt->RequestHead, &empty);
if (!empty)
{
assert( queue_next(&pwrMgt->WorkChain) ==
queue_prev(&pwrMgt->WorkChain) );
queue_enter(&fWorkQueue, pwrMgt, IOServicePM *, WorkChain);
fQueueLength++;
PM_LOG3("IOPMWorkQueue: [%u] added %s@%p to queue\n",
fQueueLength, pwrMgt->Name, pwrMgt);
}
}
return more;
}
bool IOPMWorkQueue::checkRequestQueue( queue_head_t * queue, bool * empty )
{
IOPMRequest * request;
IOService * target;
bool more = false;
bool done = false;
assert(!queue_empty(queue));
do {
request = (IOPMRequest *) queue_first(queue);
if (request->isWorkBlocked())
break;
target = request->getTarget();
done = (*fWorkAction)( target, request, this );
if (!done)
break;
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)
{
fProducerCount++;
}
return more;
}
bool IOPMWorkQueue::checkForWork( void )
{
IOServicePM * entry;
IOServicePM * next;
bool more = false;
bool empty;
#if WORK_QUEUE_STATS
fStatCheckForWork++;
#endif
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);
next = (IOServicePM *) queue_next(&entry->WorkChain);
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++;
}
OSDefineMetaClassAndStructors( IOPMCompletionQueue, IOEventSource );
IOPMCompletionQueue *
IOPMCompletionQueue::create( IOService * inOwner, Action inAction )
{
IOPMCompletionQueue * me = OSTypeAlloc(IOPMCompletionQueue);
if (me && !me->init(inOwner, inAction))
{
me->release();
me = 0;
}
return me;
}
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);
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;
}
OSDefineMetaClassAndStructors(IOServicePM, OSObject)
static void
setPMProperty( OSDictionary * dict, const char * key, uint64_t value )
{
OSNumber * num = OSNumber::withNumber(value, sizeof(value) * 8);
if (num)
{
dict->setObject(key, num);
num->release();
}
}
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);
if (dict)
{
setPMProperty(dict, "CurrentPowerState", CurrentPowerState);
if (NumberOfPowerStates)
setPMProperty(dict, "MaxPowerState", NumberOfPowerStates-1);
if (DesiredPowerState != CurrentPowerState)
setPMProperty(dict, "DesiredPowerState", DesiredPowerState);
if (kIOPM_Finished != MachineState)
setPMProperty(dict, "MachineState", MachineState);
if (DeviceOverrideEnabled)
dict->setObject("PowerOverrideOn", kOSBooleanTrue);
if (IdleTimerPeriod)
{
AbsoluteTime now;
AbsoluteTime delta;
uint64_t nsecs;
clock_get_uptime(&now);
setPMProperty(dict, "IdleTimerPeriod", IdleTimerPeriod * 1000ULL);
setPMProperty(dict, "ActivityTickles", ActivityTickleCount);
if (AbsoluteTime_to_scalar(&DeviceActiveTimestamp))
{
delta = now;
SUB_ABSOLUTETIME(&delta, &DeviceActiveTimestamp);
absolutetime_to_nanoseconds(delta, &nsecs);
setPMProperty(dict, "TimeSinceLastTickle", NS_TO_MS(nsecs));
}
if (AbsoluteTime_to_scalar(&IdleTimerStartTime))
{
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 ? 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;
}