1/* 2 * Copyright (c) 1998-2011 Apple Computer, Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28/* 29 * Copyright (c) 1998,1999 Apple Computer, Inc. All rights reserved. 30 * 31 * HISTORY 32 * 33 */ 34/*! 35 @header 36 This header contains the definition of the IOService class. IOService is the sole direct subclass of IORegistryEntry and is the base class of almost all I/O Kit family superclasses. IOService defines methods that support the life cycle of I/O Kit drivers. For more information on IOService, see {@linkdoc //apple_ref/doc/uid/TP0000011 I/O Kit Fundamentals}. 37 38 @seealso //apple_ref/doc/header/IORegistryEntry.h IORegistryEntry 39*/ 40 41#ifndef _IOKIT_IOSERVICE_H 42#define _IOKIT_IOSERVICE_H 43 44#include <IOKit/IORegistryEntry.h> 45#include <IOKit/IOReturn.h> 46#include <IOKit/IODeviceMemory.h> 47#include <IOKit/IONotifier.h> 48#include <IOKit/IOLocks.h> 49 50#include <IOKit/IOKitDebug.h> 51#include <IOKit/IOInterrupts.h> 52 53#include <IOKit/pwr_mgt/IOPMpowerState.h> 54#include <IOKit/IOServicePM.h> 55#include <IOKit/IOReportTypes.h> 56 57extern "C" { 58#include <kern/thread_call.h> 59} 60 61#ifndef UINT64_MAX 62#define UINT64_MAX 18446744073709551615ULL 63#endif 64 65 66enum { 67 kIODefaultProbeScore = 0 68}; 69 70// masks for getState() 71enum { 72 kIOServiceInactiveState = 0x00000001, 73 kIOServiceRegisteredState = 0x00000002, 74 kIOServiceMatchedState = 0x00000004, 75 kIOServiceFirstPublishState = 0x00000008, 76 kIOServiceFirstMatchState = 0x00000010 77}; 78 79enum { 80 // options for registerService() 81 kIOServiceExclusive = 0x00000001, 82 83 // options for terminate() 84 kIOServiceRequired = 0x00000001, 85 kIOServiceTerminate = 0x00000004, 86 87 // options for registerService() & terminate() 88 kIOServiceSynchronous = 0x00000002, 89 // options for registerService() 90 kIOServiceAsynchronous = 0x00000008 91}; 92 93// options for open() 94enum { 95 kIOServiceSeize = 0x00000001, 96 kIOServiceFamilyOpenOptions = 0xffff0000 97}; 98 99// options for close() 100enum { 101 kIOServiceFamilyCloseOptions = 0xffff0000 102}; 103 104typedef void * IONotificationRef; 105 106extern const IORegistryPlane * gIOServicePlane; 107extern const IORegistryPlane * gIOPowerPlane; 108 109extern const OSSymbol * gIOResourcesKey; 110extern const OSSymbol * gIOResourceMatchKey; 111extern const OSSymbol * gIOProviderClassKey; 112extern const OSSymbol * gIONameMatchKey; 113extern const OSSymbol * gIONameMatchedKey; 114extern const OSSymbol * gIOPropertyMatchKey; 115extern const OSSymbol * gIOLocationMatchKey; 116extern const OSSymbol * gIOParentMatchKey; 117extern const OSSymbol * gIOPathMatchKey; 118extern const OSSymbol * gIOMatchCategoryKey; 119extern const OSSymbol * gIODefaultMatchCategoryKey; 120extern const OSSymbol * gIOMatchedServiceCountKey; 121 122extern const OSSymbol * gIOUserClientClassKey; 123extern const OSSymbol * gIOKitDebugKey; 124extern const OSSymbol * gIOServiceKey; 125 126extern const OSSymbol * gIOCommandPoolSizeKey; 127 128extern const OSSymbol * gIOPublishNotification; 129extern const OSSymbol * gIOFirstPublishNotification; 130extern const OSSymbol * gIOMatchedNotification; 131extern const OSSymbol * gIOFirstMatchNotification; 132extern const OSSymbol * gIOTerminatedNotification; 133 134extern const OSSymbol * gIOGeneralInterest; 135extern const OSSymbol * gIOBusyInterest; 136extern const OSSymbol * gIOOpenInterest; 137extern const OSSymbol * gIOAppPowerStateInterest; 138extern const OSSymbol * gIOPriorityPowerStateInterest; 139extern const OSSymbol * gIOConsoleSecurityInterest; 140 141extern const OSSymbol * gIODeviceMemoryKey; 142extern const OSSymbol * gIOInterruptControllersKey; 143extern const OSSymbol * gIOInterruptSpecifiersKey; 144 145extern SInt32 IOServiceOrdering( const OSMetaClassBase * inObj1, const OSMetaClassBase * inObj2, void * ref ); 146 147typedef void (*IOInterruptAction)( OSObject * target, void * refCon, 148 IOService * nub, int source ); 149 150/*! @typedef IOServiceNotificationHandler 151 @param target Reference supplied when the notification was registered. 152 @param refCon Reference constant supplied when the notification was registered. 153 @param newService The IOService object the notification is delivering. It is retained for the duration of the handler's invocation and doesn't need to be released by the handler. */ 154 155typedef bool (*IOServiceNotificationHandler)( void * target, void * refCon, 156 IOService * newService ); 157 158typedef bool (*IOServiceMatchingNotificationHandler)( void * target, void * refCon, 159 IOService * newService, 160 IONotifier * notifier ); 161 162/*! @typedef IOServiceInterestHandler 163 @param target Reference supplied when the notification was registered. 164 @param refCon Reference constant supplied when the notification was registered. 165 @param messageType Type of the message - IOKit defined in IOKit/IOMessage.h or family specific. 166 @param provider The IOService object who is delivering the notification. It is retained for the duration of the handler's invocation and doesn't need to be released by the handler. 167 @param messageArgument An argument for message, dependent on its type. 168 @param argSize Non zero if the argument represents a struct of that size, used when delivering messages outside the kernel. */ 169 170typedef IOReturn (*IOServiceInterestHandler)( void * target, void * refCon, 171 UInt32 messageType, IOService * provider, 172 void * messageArgument, vm_size_t argSize ); 173 174typedef void (*IOServiceApplierFunction)(IOService * service, void * context); 175typedef void (*OSObjectApplierFunction)(OSObject * object, void * context); 176 177class IOUserClient; 178class IOPlatformExpert; 179 180/*! @class IOService 181 @abstract The base class for most I/O Kit families, devices, and drivers. 182 @discussion The IOService base class defines APIs used to publish services, instantiate other services based on the existance of a providing service (ie. driver stacking), destroy a service and its dependent stack, notify interested parties of service state changes, and general utility functions useful across all families. 183 184Types of service are specified with a matching dictionary that describes properties of the service. For example, a matching dictionary might describe any IOUSBDevice (or subclass), an IOUSBDevice with a certain class code, or a IOPCIDevice with a set of matching names or device & vendor IDs. Since the matching dictionary is interpreted by the family which created the service, as well as generically by IOService, the list of properties considered for matching depends on the familiy. 185 186Matching dictionaries are associated with IOService classes by the catalogue, as driver property tables, and also supplied by clients of the notification APIs. 187 188IOService provides matching based on C++ class (via OSMetaClass dynamic casting), registry entry name, a registry path to the service (which includes device tree paths), a name assigned by BSD, or by its location (its point of attachment). 189 190<br><br>Driver Instantiation by IOService<br><br> 191 192Drivers are subclasses of IOService, and their availability is managed through the catalogue. They are instantiated based on the publication of an IOService they use (for example, an IOPCIDevice or IOUSBDevice), or when they are added to the catalogue and the IOService(s) they use are already available. 193 194When an IOService (the "provider") is published with the @link registerService registerService@/link method, the matching and probing process begins, which is always single threaded per provider. A list of matching dictionaries from the catalog and installed publish notification requests, that successfully match the IOService, is constructed, with ordering supplied by <code>kIOProbeScoreKey</code> ("IOProbeScore") property in the dictionary, or supplied with the notification. 195 196Each entry in the list is then processed in order - for notifications, the notification is delivered, for driver property tables a lot more happens. 197 198The driver class is instantiated and <code>init()</code> called with its property table. The new driver instance is then attached to the provider, and has its @link probe probe@/link method called with the provider as an argument. The default <code>probe</code> method does nothing but return success, but a driver may implement this method to interrogate the provider to make sure it can work with it. It may also modify its probe score at this time. After probe, the driver is detached and the next in the list is considered (ie. attached, probed, and detached). 199 200When the probing phase is complete, the list consists of successfully probed drivers, in order of their probe score (after adjustment during the @link probe probe@/link call). The list is then divided into categories based on the <code>kIOMatchCategoryKey</code> property ("IOMatchCategory"); drivers without a match category are all considered in one default category. Match categories allow multiple clients of a provider to be attached and started, though the provider may also enforce open/close semantics to gain active access to it. 201 202For each category, the highest scoring driver in that category is attached to the provider, and its @link start start@/link method called. If <code>start</code> is successful, the rest of the drivers in the same match category are discarded, otherwise the next highest scoring driver is started, and so on. 203 204The driver should only consider itself in action when the start method is called, meaning it has been selected for use on the provider, and consuming that particular match category. It should also be prepared to be allocated, probed and freed even if the probe was successful. 205 206After the drivers have all synchronously been started, the installed "matched" notifications that match the registered IOService are delivered. 207 208<br><br>Properties used by IOService<br><br> 209 210 <code>kIOClassKey, extern const OSSymbol * gIOClassKey, "IOClass"</code> 211<br> 212<br> 213Class of the driver to instantiate on matching providers. 214<br> 215<br> 216 <code>kIOProviderClassKey, extern const OSSymbol * gIOProviderClassKey, "IOProviderClass"</code> 217<br> 218<br> 219Class of the provider(s) to be considered for matching, checked with OSDynamicCast so subclasses will also match. 220<br> 221<br> 222 <code>kIOProbeScoreKey, extern const OSSymbol * gIOProbeScoreKey, "IOProbeScore"</code> 223<br> 224<br> 225The probe score initially used to order multiple matching drivers. 226<br> 227<br> 228 <code>kIOMatchCategoryKey, extern const OSSymbol * gIOMatchCategoryKey, "IOMatchCategory"</code> 229<br> 230<br> 231A string defining the driver category for matching purposes. All drivers with no <code>IOMatchCategory</code> property are considered to be in the same default category. Only one driver in a category can be started on each provider. 232<br> 233<br> 234 <code>kIONameMatchKey, extern const OSSymbol * gIONameMatchKey, "IONameMatch"</code> 235<br> 236A string or collection of strings that match the provider's name. The comparison is implemented with the @link //apple_ref/cpp/instm/IORegistryEntry/compareNames/virtualbool/(OSObject*,OSString**) IORegistryEntry::compareNames@/link method, which supports a single string, or any collection (OSArray, OSSet, OSDictionary etc.) of strings. IOService objects with device tree properties (eg. IOPCIDevice) will also be matched based on that standard's "compatible", "name", "device_type" properties. The matching name will be left in the driver's property table in the <code>kIONameMatchedKey</code> property. 237<br> 238Examples 239<pre> 240@textblock 241 <key>IONameMatch</key> 242 <string>pci106b,7</string> 243@/textblock 244</pre> 245 246For a list of possible matching names, a serialized array of strings should used, eg. 247<pre> 248@textblock 249 <key>IONameMatch</key> 250 <array> 251 <string>APPL,happy16</string> 252 <string>pci106b,7</string> 253 </array> 254@/textblock 255</pre> 256 257<br> 258 <code>kIONameMatchedKey, extern const OSSymbol * gIONameMatchedKey, "IONameMatched"</code> 259<br> 260The name successfully matched name from the <code>kIONameMatchKey</code> property will be left in the driver's property table as the <code>kIONameMatchedKey</code> property. 261<br> 262<br> 263 <code>kIOPropertyMatchKey, extern const OSSymbol * gIOPropertyMatchKey, "IOPropertyMatch"</code> 264<br> 265A dictionary of properties that each must exist in the matching IOService and compare successfully with the <code>isEqualTo</code> method. 266 267<pre> 268@textblock 269 <key>IOPropertyMatch</key> 270 <dictionary> 271 <key>APPL,happy16</key> 272 <string>APPL,meek8</string> 273 </dictionary> 274@/textblock 275</pre> 276 277<br> 278 <code>kIOUserClientClassKey, extern const OSSymbol * gIOUserClientClassKey, "IOUserClientClass"</code> 279<br> 280The class name that the service will attempt to allocate when a user client connection is requested. First the device nub is queried, then the nub's provider is queried by default. 281<br> 282<br> 283 <code>kIOKitDebugKey, extern const OSSymbol * gIOKitDebugKey, "IOKitDebug"</code> 284<br> 285Set some debug flags for logging the driver loading process. Flags are defined in <code>IOKit/IOKitDebug.h</code>, but <code>65535</code> works well.*/ 286 287class IOService : public IORegistryEntry 288{ 289 OSDeclareDefaultStructors(IOService) 290 291protected: 292/*! @struct ExpansionData 293 @discussion This structure will be used to expand the capablilties of this class in the future. 294 */ 295 struct ExpansionData { }; 296 297/*! @var reserved 298 Reserved for future use. (Internal use only) */ 299 ExpansionData * reserved; 300 301private: 302 IOService * __provider; 303 SInt32 __providerGeneration; 304 IOService * __owner; 305 IOOptionBits __state[2]; 306 uint64_t __timeBusy; 307 uint64_t __accumBusy; 308 IOServicePM * pwrMgt; 309 310protected: 311 // TRUE once PMinit has been called 312 bool initialized; 313 314public: 315 // DEPRECATED 316 void * pm_vars; 317 318public: 319 /* methods available in Mac OS X 10.1 or later */ 320/*! @function requestTerminate 321 @abstract Passes a termination up the stack. 322 @discussion When an IOService is made inactive the default behavior is to also make any of its clients that have it as their only provider also inactive, in this way recursing the termination up the driver stack. This method allows an IOService object to override this behavior. Returning <code>true</code> from this method when passed a just terminated provider will cause the client to also be terminated. 323 @param provider The terminated provider of this object. 324 @param options Options originally passed to terminate, plus <code>kIOServiceRecursing</code>. 325 @result <code>true</code> if this object should be terminated now that its provider has been. */ 326 327 virtual bool requestTerminate( IOService * provider, IOOptionBits options ); 328 329/*! @function willTerminate 330 @abstract Passes a termination up the stack. 331 @discussion Notification that a provider has been terminated, sent before recursing up the stack, in root-to-leaf order. 332 @param provider The terminated provider of this object. 333 @param options Options originally passed to terminate. 334 @result <code>true</code>. */ 335 336 virtual bool willTerminate( IOService * provider, IOOptionBits options ); 337 338/*! @function didTerminate 339 @abstract Passes a termination up the stack. 340 @discussion Notification that a provider has been terminated, sent after recursing up the stack, in leaf-to-root order. 341 @param provider The terminated provider of this object. 342 @param options Options originally passed to terminate. 343 @param defer If there is pending I/O that requires this object to persist, and the provider is not opened by this object set <code>defer</code> to <code>true</code> and call the <code>IOService::didTerminate()</code> implementation when the I/O completes. Otherwise, leave <code>defer</code> set to its default value of <code>false</code>. 344 @result <code>true</code>. */ 345 346 virtual bool didTerminate( IOService * provider, IOOptionBits options, bool * defer ); 347 348/*! @function nextIdleTimeout 349 @availability Mac OS X v10.4 and later 350 @abstract Allows subclasses to customize idle power management behavior. 351 @discussion Returns the next time that the device should idle into its next lower power state. Subclasses may override for custom idle behavior. 352 353 A power managed driver might override this method to provide a more sophisticated idle power off algorithm than the one defined by power management. 354 @param currentTime The current time 355 @param lastActivity The time of last activity on this device 356 @param powerState The device's current power state. 357 @result Returns the next time the device should idle off (in seconds, relative to the current time). */ 358 359 virtual SInt32 nextIdleTimeout(AbsoluteTime currentTime, 360 AbsoluteTime lastActivity, unsigned int powerState); 361 362/*! @function systemWillShutdown 363 @availability Mac OS X v10.5 and later 364 @abstract Notifies members of the power plane of system shutdown and restart. 365 @discussion This function is called for all members of the power plane in leaf-to-root order. If a subclass needs to wait for a pending I/O, then the call to <code>systemWillShutdown</code> should be postponed until the I/O completes. 366 367 Any power managed driver (which has called @link joinPMtree joinPMtree@/link to join the power plane) interested in taking action at system shutdown or restart should override this method. 368 @param specifier <code>kIOMessageSystemWillPowerOff</code> or <code>kIOMessageSystemWillRestart</code>. */ 369 370 virtual void systemWillShutdown( IOOptionBits specifier ); 371 372/*! @function copyClientWithCategory 373 @availability Mac OS X v10.6 and later 374 @param category An OSSymbol corresponding to an IOMatchCategory matching property. 375 @result Returns a reference to the IOService child with the given category. The result should be released by the caller. 376*/ 377 378 virtual IOService * copyClientWithCategory( const OSSymbol * category ); 379 380public: 381/*! @function configureReport 382 @abstract configure IOReporting channels 383 @availability SPI on OS X v10.9 / iOS 7 and later 384 385 @param channels - channels to configure 386 @param action - enable/disable/size, etc 387 @param result - action-specific returned value 388 @param destination - action-specific default destination 389*/ 390virtual IOReturn configureReport(IOReportChannelList *channels, 391 IOReportConfigureAction action, 392 void *result, 393 void *destination); 394 395/*! @function updateReport 396 @abstract request current data for the specified channels 397 @availability SPI on OS X 10.9 / iOS 7 and later 398 399 @param channels - channels to be updated 400 @param action - type/style of update 401 @param result - returned details about what was updated 402 @param destination - destination for this update (action-specific) 403*/ 404virtual IOReturn updateReport(IOReportChannelList *channels, 405 IOReportUpdateAction action, 406 void *result, 407 void *destination); 408 409private: 410#if __LP64__ 411 OSMetaClassDeclareReservedUsed(IOService, 0); 412 OSMetaClassDeclareReservedUsed(IOService, 1); 413 OSMetaClassDeclareReservedUnused(IOService, 2); 414 OSMetaClassDeclareReservedUnused(IOService, 3); 415 OSMetaClassDeclareReservedUnused(IOService, 4); 416 OSMetaClassDeclareReservedUnused(IOService, 5); 417 OSMetaClassDeclareReservedUnused(IOService, 6); 418 OSMetaClassDeclareReservedUnused(IOService, 7); 419#else 420 OSMetaClassDeclareReservedUsed(IOService, 0); 421 OSMetaClassDeclareReservedUsed(IOService, 1); 422 OSMetaClassDeclareReservedUsed(IOService, 2); 423 OSMetaClassDeclareReservedUsed(IOService, 3); 424 OSMetaClassDeclareReservedUsed(IOService, 4); 425 OSMetaClassDeclareReservedUsed(IOService, 5); 426 OSMetaClassDeclareReservedUsed(IOService, 6); 427 OSMetaClassDeclareReservedUsed(IOService, 7); 428#endif 429 430 OSMetaClassDeclareReservedUnused(IOService, 8); 431 OSMetaClassDeclareReservedUnused(IOService, 9); 432 OSMetaClassDeclareReservedUnused(IOService, 10); 433 OSMetaClassDeclareReservedUnused(IOService, 11); 434 OSMetaClassDeclareReservedUnused(IOService, 12); 435 OSMetaClassDeclareReservedUnused(IOService, 13); 436 OSMetaClassDeclareReservedUnused(IOService, 14); 437 OSMetaClassDeclareReservedUnused(IOService, 15); 438 OSMetaClassDeclareReservedUnused(IOService, 16); 439 OSMetaClassDeclareReservedUnused(IOService, 17); 440 OSMetaClassDeclareReservedUnused(IOService, 18); 441 OSMetaClassDeclareReservedUnused(IOService, 19); 442 OSMetaClassDeclareReservedUnused(IOService, 20); 443 OSMetaClassDeclareReservedUnused(IOService, 21); 444 OSMetaClassDeclareReservedUnused(IOService, 22); 445 OSMetaClassDeclareReservedUnused(IOService, 23); 446 OSMetaClassDeclareReservedUnused(IOService, 24); 447 OSMetaClassDeclareReservedUnused(IOService, 25); 448 OSMetaClassDeclareReservedUnused(IOService, 26); 449 OSMetaClassDeclareReservedUnused(IOService, 27); 450 OSMetaClassDeclareReservedUnused(IOService, 28); 451 OSMetaClassDeclareReservedUnused(IOService, 29); 452 OSMetaClassDeclareReservedUnused(IOService, 30); 453 OSMetaClassDeclareReservedUnused(IOService, 31); 454 OSMetaClassDeclareReservedUnused(IOService, 32); 455 OSMetaClassDeclareReservedUnused(IOService, 33); 456 OSMetaClassDeclareReservedUnused(IOService, 34); 457 OSMetaClassDeclareReservedUnused(IOService, 35); 458 OSMetaClassDeclareReservedUnused(IOService, 36); 459 OSMetaClassDeclareReservedUnused(IOService, 37); 460 OSMetaClassDeclareReservedUnused(IOService, 38); 461 OSMetaClassDeclareReservedUnused(IOService, 39); 462 OSMetaClassDeclareReservedUnused(IOService, 40); 463 OSMetaClassDeclareReservedUnused(IOService, 41); 464 OSMetaClassDeclareReservedUnused(IOService, 42); 465 OSMetaClassDeclareReservedUnused(IOService, 43); 466 OSMetaClassDeclareReservedUnused(IOService, 44); 467 OSMetaClassDeclareReservedUnused(IOService, 45); 468 OSMetaClassDeclareReservedUnused(IOService, 46); 469 OSMetaClassDeclareReservedUnused(IOService, 47); 470 471public: 472/*! @function getState 473 @abstract Accessor for IOService state bits, not normally needed or used outside IOService. 474 @result State bits for the IOService, eg. <code>kIOServiceInactiveState</code>, <code>kIOServiceRegisteredState</code>. */ 475 476 virtual IOOptionBits getState( void ) const; 477 478/*! @function isInactive 479 @abstract Checks if the IOService object has been terminated, and is in the process of being destroyed. 480 @discussion When an IOService object is successfully terminated, it is immediately made inactive, which blocks further attach()es, matching or notifications occuring on the object. It remains inactive until the last client closes, and is then finalized and destroyed. 481 @result <code>true</code> if the IOService object has been terminated. */ 482 483 bool isInactive( void ) const; 484 485 /* Stack creation */ 486 487/*! @function registerService 488 @abstract Starts the registration process for a newly discovered IOService object. 489 @discussion This function allows an IOService subclass to be published and made available to possible clients, by starting the registration process and delivering notifications to registered clients. The object should be completely setup and ready to field requests from clients before <code>registerService</code> is called. 490 @param options The default zero options mask is recommended and should be used in most cases. The registration process is usually asynchronous, with possible driver probing and notification occurring some time later. <code>kIOServiceSynchronous</code> may be passed to carry out the matching and notification process for currently registered clients before returning to the caller. */ 491 492 virtual void registerService( IOOptionBits options = 0 ); 493 494/*! @function probe 495 @abstract During an IOService object's instantiation, probes a matched service to see if it can be used. 496 @discussion The registration process for an IOService object (the provider) includes instantiating possible driver clients. The <code>probe</code> method is called in the client instance to check the matched service can be used before the driver is considered to be started. Since matching screens many possible providers, in many cases the <code>probe</code> method can be left unimplemented by IOService subclasses. The client is already attached to the provider when <code>probe</code> is called. 497 @param provider The registered IOService object that matches a driver personality's matching dictionary. 498 @param score Pointer to the current driver's probe score, which is used to order multiple matching drivers in the same match category. It defaults to the value of the <code>IOProbeScore</code> property in the drivers property table, or <code>kIODefaultProbeScore</code> if none is specified. The <code>probe</code> method may alter the score to affect start order. 499 @result An IOService instance or zero when the probe is unsuccessful. In almost all cases the value of <code>this</code> is returned on success. If another IOService object is returned, the probed instance is detached and freed, and the returned instance is used in its stead for <code>start</code>. */ 500 501 virtual IOService * probe( IOService * provider, 502 SInt32 * score ); 503 504/*! @function start 505 @abstract During an IOService object's instantiation, starts the IOService object that has been selected to run on the provider. 506 @discussion The <code>start</code> method of an IOService instance is called by its provider when it has been selected (due to its probe score and match category) as the winning client. The client is already attached to the provider when <code>start</code> is called.<br>Implementations of <code>start</code> must call <code>start</code> on their superclass at an appropriate point. If an implementation of <code>start</code> has already called <code>super::start</code> but subsequently determines that it will fail, it must call <code>super::stop</code> to balance the prior call to <code>super::start</code> and prevent reference leaks. 507 @result <code>true</code> if the start was successful; <code>false</code> otherwise (which will cause the instance to be detached and usually freed). */ 508 509 virtual bool start( IOService * provider ); 510 511/*! @function stop 512 @abstract During an IOService termination, the stop method is called in its clients before they are detached & it is destroyed. 513 @discussion The termination process for an IOService (the provider) will call stop in each of its clients, after they have closed the provider if they had it open, or immediately on termination. */ 514 515 virtual void stop( IOService * provider ); 516 517 /* Open / Close */ 518 519/*! @function open 520 @abstract Requests active access to a provider. 521 @discussion IOService provides generic open and close semantics to track clients of a provider that have established an active datapath. The use of <code>open</code> and @link close close@/link, and rules regarding ownership are family defined, and defined by the @link handleOpen handleOpen@/link and @link handleClose handleClose@/link methods in the provider. Some families will limit access to a provider based on its open state. 522 @param forClient Designates the client of the provider requesting the open. 523 @param options Options for the open. The provider family may implement options for open; IOService defines only <code>kIOServiceSeize</code> to request the device be withdrawn from its current owner. 524 @result <code>true</code> if the open was successful; <code>false</code> otherwise. */ 525 526 virtual bool open( IOService * forClient, 527 IOOptionBits options = 0, 528 void * arg = 0 ); 529 530/*! @function close 531 @abstract Releases active access to a provider. 532 @discussion IOService provides generic open and close semantics to track clients of a provider that have established an active datapath. The use of @link open open@/link and <code>close</code>, and rules regarding ownership are family defined, and defined by the @link handleOpen handleOpen@/link and @link handleClose handleClose@/link methods in the provider. 533 @param forClient Designates the client of the provider requesting the close. 534 @param options Options available for the close. The provider family may implement options for close; IOService defines none. 535 @param arg Family specific arguments which are ignored by IOService. */ 536 537 virtual void close( IOService * forClient, 538 IOOptionBits options = 0 ); 539 540/*! @function isOpen 541 @abstract Determines whether a specific, or any, client has an IOService object open. 542 @discussion Returns the open state of an IOService object with respect to the specified client, or when it is open by any client. 543 @param forClient If non-zero, <codeisOpen</code returns the open state for that client. If zero is passed, <codeisOpen</code returns the open state for all clients. 544 @result <codetrue</code if the specific, or any, client has the IOService object open. */ 545 546 virtual bool isOpen( const IOService * forClient = 0 ) const; 547 548/*! @function handleOpen 549 @abstract Controls the open / close behavior of an IOService object (overrideable by subclasses). 550 @discussion IOService calls this method in its subclasses in response to the @link open open@/link method, so the subclass may implement the request. The default implementation provides single owner access to an IOService object via <code>open</code>. The object is locked via @link lockForArbitration lockForArbitration@/link before <code>handleOpen</code> is called. 551 @param forClient Designates the client of the provider requesting the open. 552 @param options Options for the open, may be interpreted by the implementor of <code>handleOpen</code>. 553 @result <code>true</code>if the open was successful; <code>false</code> otherwise. */ 554 555 virtual bool handleOpen( IOService * forClient, 556 IOOptionBits options, 557 void * arg ); 558 559/*! @function handleClose 560 @abstract Controls the open / close behavior of an IOService object (overrideable by subclasses). 561 @discussion IOService calls this method in its subclasses in response to the @link close close@/link method, so the subclass may implement the request. The default implementation provides single owner access to an IOService object via @link open open@/link. The object is locked via @link lockForArbitration lockForArbitration@/link before <code>handleClose</code> is called. 562 @param forClient Designates the client of the provider requesting the close. 563 @param options Options for the close, may be interpreted by the implementor of @link handleOpen handleOpen@/link. */ 564 565 virtual void handleClose( IOService * forClient, 566 IOOptionBits options ); 567 568/*! @function handleIsOpen 569 @abstract Controls the open / close behavior of an IOService object (overrideable by subclasses). 570 @discussion IOService calls this method in its subclasses in response to the @link open open@/link method, so the subclass may implement the request. The default implementation provides single owner access to an IOService object via @link open open@/link. The object is locked via @link lockForArbitration lockForArbitration@/link before <code>handleIsOpen</code> is called. 571 @param forClient If non-zero, <code>isOpen</code> returns the open state for that client. If zero is passed, <code>isOpen</code> returns the open state for all clients. 572 @result <code>true</code> if the specific, or any, client has the IOService object open. */ 573 574 virtual bool handleIsOpen( const IOService * forClient ) const; 575 576 /* Stacking change */ 577 578/*! @function terminate 579 @abstract Makes an IOService object inactive and begins its destruction. 580 @discussion Registering an IOService object informs possible clients of its existance and instantiates drivers that may be used with it; <code>terminate</code> involves the opposite process of informing clients that an IOService object is no longer able to be used and will be destroyed. By default, if any client has the service open, <code>terminate</code> fails. If the <code>kIOServiceRequired</code> flag is passed however, <code>terminate</code> will be successful though further progress in the destruction of the IOService object will not proceed until the last client has closed it. The service will be made inactive immediately upon successful termination, and all its clients will be notified via their @link message message@/link method with a message of type <code>kIOMessageServiceIsTerminated</code>. Both these actions take place on the caller's thread. After the IOService object is made inactive, further matching or attach calls will fail on it. Each client has its @link stop stop@/link method called upon their close of an inactive IOService object , or on its termination if they do not have it open. After <code>stop</code>, @link detach detach@/link is called in each client. When all clients have been detached, the @link finalize finalize@/link method is called in the inactive service. The termination process is inherently asynchronous because it will be deferred until all clients have chosen to close. 581 @param options In most cases no options are needed. <code>kIOServiceSynchronous</code> may be passed to cause <code>terminate</code> to not return until the service is finalized. */ 582 583 virtual bool terminate( IOOptionBits options = 0 ); 584 585/*! @function finalize 586 @abstract Finalizes the destruction of an IOService object. 587 @discussion The <code>finalize</code> method is called in an inactive (ie. terminated) IOService object after the last client has detached. IOService's implementation will call @link stop stop@/link, @link close close@/link, and @link detach detach@/link on each provider. When <code>finalize</code> returns, the object's retain count will have no references generated by IOService's registration process. 588 @param options The options passed to the @link terminate terminate@/link method of the IOService object are passed on to <code>finalize</code>. 589 @result <code>true</code>. */ 590 591 virtual bool finalize( IOOptionBits options ); 592 593/*! @function free 594 @abstract Frees data structures that were allocated when power management was initialized on this service. */ 595 596 virtual void free( void ); 597 598/*! @function lockForArbitration 599 @abstract Locks an IOService object against changes in state or ownership. 600 @discussion The registration, termination and open / close functions of IOService use <code>lockForArbtration</code> to single-thread access to an IOService object. <code>lockForArbitration</code> grants recursive access to the same thread. 601 @param isSuccessRequired If a request for access to an IOService object should be denied if it is terminated, pass <code>false</code>, otherwise pass <code>true</code>. */ 602 603 virtual bool lockForArbitration( bool isSuccessRequired = true ); 604 605/*! @function unlockForArbitration 606 @abstract Unlocks an IOService obkect after a successful @link lockForArbitration lockForArbitration@/link. 607 @discussion A thread granted exclusive access to an IOService object should release it with <code>unlockForArbitration</code>. */ 608 609 virtual void unlockForArbitration( void ); 610 611/*! @function terminateClient 612 @abstract Passes a termination up the stack. 613 @discussion When an IOService object is made inactive the default behavior is to also make any of its clients that have it as their only provider inactive, in this way recursing the termination up the driver stack. This method allows a terminated IOService object to override this behavior. Note the client may also override this behavior by overriding its @link terminate terminate@/link method. 614 @param client The client of the terminated provider. 615 @param options Options originally passed to @link terminate terminate@/link, plus <code>kIOServiceRecursing</code>. 616 @result result of the terminate request on the client. */ 617 618 virtual bool terminateClient( IOService * client, IOOptionBits options ); 619 620 /* Busy state indicates discovery, matching or termination is in progress */ 621 622/*! @function getBusyState 623 @abstract Returns the <code>busyState</code> of an IOService object. 624 @discussion Many activities in IOService are asynchronous. When registration, matching, or termination is in progress on an IOService object, its <code>busyState</code> is increased by one. Change in <code>busyState</code> to or from zero also changes the IOService object's provider's <code>busyState</code> by one, which means that an IOService object is marked busy when any of the above activities is ocurring on it or any of its clients. 625 @result The <code>busyState</code> value. */ 626 627 virtual UInt32 getBusyState( void ); 628 629/*! @function adjustBusy 630 @abstract Adjusts the <code>busyState</code> of an IOService object. 631 @discussion Applies a delta to an IOService object's <code>busyState</code>. A change in the <code>busyState</code> to or from zero will change the IOService object's provider's <code>busyState</code> by one (in the same direction). 632 @param delta The delta to be applied to the IOService object's <code>busyState</code>. */ 633 634 virtual void adjustBusy( SInt32 delta ); 635 636 APPLE_KEXT_COMPATIBILITY_VIRTUAL 637 IOReturn waitQuiet(mach_timespec_t * timeout) 638 APPLE_KEXT_DEPRECATED; 639 640/*! @function waitQuiet 641 @abstract Waits for an IOService object's <code>busyState</code> to be zero. 642 @discussion Blocks the caller until an IOService object is non busy. 643 @param timeout The maximum time to wait in nanoseconds. Default is to wait forever. 644 @result Returns an error code if Mach synchronization primitives fail, <code>kIOReturnTimeout</code>, or <code>kIOReturnSuccess</code>. */ 645 646 IOReturn waitQuiet(uint64_t timeout = UINT64_MAX); 647 648 /* Matching */ 649 650/*! @function matchPropertyTable 651 @abstract Allows a registered IOService object to implement family specific matching. 652 @discussion All matching on an IOService object will call this method to allow a family writer to implement matching in addition to the generic methods provided by IOService. The implementer should examine the matching dictionary passed to see if it contains properties the family understands for matching, and use them to match with the IOService object if so. Note that since matching is also carried out by other parts of the I/O Kit, the matching dictionary may contain properties the family does not understand - these should not be considered matching failures. 653 @param table The dictionary of properties to be matched against. 654 @param score Pointer to the current driver's probe score, which is used to order multiple matching drivers in the same match category. It defaults to the value of the <code>IOProbeScore</code> property in the drivers property table, or <code>kIODefaultProbeScore</code> if none is specified. 655 @result <code>false</code> if the family considers the matching dictionary does not match in properties it understands; <code>true</code> otherwise. */ 656 657 virtual bool matchPropertyTable( OSDictionary * table, 658 SInt32 * score ); 659 660 virtual bool matchPropertyTable( OSDictionary * table ); 661 662/*! @function matchLocation 663 @abstract Allows a registered IOService object to direct location matching. 664 @discussion By default, a location matching property will be applied to an IOService object's provider. This method allows that behavior to be overridden by families. 665 @param client The IOService object at which matching is taking place. 666 @result Returns the IOService instance to be used for location matching. */ 667 668 virtual IOService * matchLocation( IOService * client ); 669 670 /* Resource service */ 671 672/*! @function publishResource 673 @abstract Uses the resource service to publish a property. 674 @discussion The resource service uses IOService's matching and notification to allow objects to be published and found by any I/O Kit client by a global name. <code>publishResource</code> makes an object available to anyone waiting for it or looking for it in the future. 675 @param key An OSSymbol key that globally identifies the object. 676 @param The object to be published. */ 677 678 static void publishResource( const OSSymbol * key, OSObject * value = 0 ); 679 680/*! @function publishResource 681 @abstract Uses the resource service to publish a property. 682 @discussion The resource service uses IOService object's matching and notification to allow objects to be published and found by any I/O Kit client by a global name. <code>publishResource</code> makes an object available to anyone waiting for it or looking for it in the future. 683 @param key A C string key that globally identifies the object. 684 @param The object to be published. */ 685 686 static void publishResource( const char * key, OSObject * value = 0 ); 687 virtual bool addNeededResource( const char * key ); 688 689 /* Notifications */ 690 691/*! @function addNotification 692 @abstract Deprecated use addMatchingNotification(). Adds a persistant notification handler to be notified of IOService events. 693 @discussion IOService will deliver notifications of changes in state of an IOService object to registered clients. The type of notification is specified by a symbol, for example <code>gIOMatchedNotification</code> or <code>gIOTerminatedNotification</code>, and notifications will only include IOService objects that match the supplied matching dictionary. Notifications are ordered by a priority set with <code>addNotification</code>. When the notification is installed, its handler will be called with each of any currently existing IOService objects that are in the correct state (eg. registered) and match the supplied matching dictionary, avoiding races between finding preexisting and new IOService events. The notification request is identified by an instance of an IONotifier object, through which it can be enabled, disabled, or removed. <code>addNotification</code> consumes a retain count on the matching dictionary when the notification is removed. 694 @param type An OSSymbol identifying the type of notification and IOService state: 695<br> <code>gIOPublishNotification</code> Delivered when an IOService object is registered. 696<br> <code>gIOFirstPublishNotification</code> Delivered when an IOService object is registered, but only once per IOService instance. Some IOService objects may be reregistered when their state is changed. 697<br> <code>gIOMatchedNotification</code> Delivered when an IOService object has been matched with all client drivers, and they have been probed and started. 698<br> <code>gIOFirstMatchNotification</code> Delivered when an IOService object has been matched with all client drivers, but only once per IOService instance. Some IOService objects may be reregistered when their state is changed. 699<br> <code>gIOTerminatedNotification</code> Delivered after an IOService object has been terminated, during its finalize stage. 700 @param matching A matching dictionary to restrict notifications to only matching IOService objects. The dictionary will be released when the notification is removed, consuming the passed-in reference. 701 @param handler A C function callback to deliver notifications. 702 @param target An instance reference for the callback's use. 703 @param ref A reference constant for the callback's use. 704 @param priority A constant ordering all notifications of a each type. 705 @result An instance of an IONotifier object that can be used to control or destroy the notification request. */ 706 707 static IONotifier * addNotification( 708 const OSSymbol * type, OSDictionary * matching, 709 IOServiceNotificationHandler handler, 710 void * target, void * ref = 0, 711 SInt32 priority = 0 ) 712 APPLE_KEXT_DEPRECATED; 713 714/*! @function addMatchingNotification 715 @abstract Adds a persistant notification handler to be notified of IOService events. 716 @discussion IOService will deliver notifications of changes in state of an IOService object to registered clients. The type of notification is specified by a symbol, for example <code>gIOMatchedNotification</code> or <code>gIOTerminatedNotification</code>, and notifications will only include IOService objects that match the supplied matching dictionary. Notifications are ordered by a priority set with <code>addNotification</code>. When the notification is installed, its handler will be called with each of any currently existing IOService objects that are in the correct state (eg. registered) and match the supplied matching dictionary, avoiding races between finding preexisting and new IOService events. The notification request is identified by an instance of an IONotifier object, through which it can be enabled, disabled, or removed. <code>addMatchingNotification</code> does not consume a reference on the matching dictionary when the notification is removed, unlike addNotification. 717 @param type An OSSymbol identifying the type of notification and IOService state: 718<br> <code>gIOPublishNotification</code> Delivered when an IOService object is registered. 719<br> <code>gIOFirstPublishNotification</code> Delivered when an IOService object is registered, but only once per IOService instance. Some IOService objects may be reregistered when their state is changed. 720<br> <code>gIOMatchedNotification</code> Delivered when an IOService object has been matched with all client drivers, and they have been probed and started. 721<br> <code>gIOFirstMatchNotification</code> Delivered when an IOService object has been matched with all client drivers, but only once per IOService instance. Some IOService objects may be reregistered when their state is changed. 722<br> <code>gIOTerminatedNotification</code> Delivered after an IOService object has been terminated, during its finalize stage. 723 @param matching A matching dictionary to restrict notifications to only matching IOService objects. The dictionary is retained while the notification is installed. (Differs from addNotification). 724 @param handler A C function callback to deliver notifications. 725 @param target An instance reference for the callback's use. 726 @param ref A reference constant for the callback's use. 727 @param priority A constant ordering all notifications of a each type. 728 @result An instance of an IONotifier object that can be used to control or destroy the notification request. */ 729 730 static IONotifier * addMatchingNotification( 731 const OSSymbol * type, OSDictionary * matching, 732 IOServiceMatchingNotificationHandler handler, 733 void * target, void * ref = 0, 734 SInt32 priority = 0 ); 735 736/*! @function waitForService 737 @abstract Deprecated use waitForMatchingService(). Waits for a matching to service to be published. 738 @discussion Provides a method of waiting for an IOService object matching the supplied matching dictionary to be registered and fully matched. 739 @param matching The matching dictionary describing the desired IOService object. <code>waitForService</code> consumes one reference of the matching dictionary. 740 @param timeout The maximum time to wait. 741 @result A published IOService object matching the supplied dictionary. */ 742 743 static IOService * waitForService( OSDictionary * matching, 744 mach_timespec_t * timeout = 0); 745 746/*! @function waitForMatchingService 747 @abstract Waits for a matching to service to be published. 748 @discussion Provides a method of waiting for an IOService object matching the supplied matching dictionary to be registered and fully matched. 749 @param matching The matching dictionary describing the desired IOService object. (Does not consume a reference of the matching dictionary - differs from waitForService() which does consume a reference on the matching dictionary.) 750 @param timeout The maximum time to wait in nanoseconds. Default is to wait forever. 751 @result A published IOService object matching the supplied dictionary. waitForMatchingService returns a reference to the IOService which should be released by the caller. (Differs from waitForService() which does not retain the returned object.) */ 752 753 static IOService * waitForMatchingService( OSDictionary * matching, 754 uint64_t timeout = UINT64_MAX); 755 756/*! @function getMatchingServices 757 @abstract Finds the set of current published IOService objects matching a matching dictionary. 758 @discussion Provides a method of finding the current set of published IOService objects matching the supplied matching dictionary. 759 @param matching The matching dictionary describing the desired IOService objects. 760 @result An instance of an iterator over a set of IOService objects. To be released by the caller. */ 761 762 static OSIterator * getMatchingServices( OSDictionary * matching ); 763 764/*! @function copyMatchingService 765 @abstract Finds one of the current published IOService objects matching a matching dictionary. 766 @discussion Provides a method to find one member of the set of published IOService objects matching the supplied matching dictionary. 767 @param matching The matching dictionary describing the desired IOService object. 768 @result The IOService object or NULL. To be released by the caller. */ 769 770 static IOService * copyMatchingService( OSDictionary * matching ); 771 772public: 773 /* Helpers to make matching dictionaries for simple cases, 774 * they add keys to an existing dictionary, or create one. */ 775 776/*! @function serviceMatching 777 @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService class match. 778 @discussion A very common matching criteria for IOService object is based on its class. <code>serviceMatching</code> creates a matching dictionary that specifies any IOService object of a class, or its subclasses. The class is specified by name, and an existing dictionary may be passed in, in which case the matching properties will be added to that dictionary rather than creating a new one. 779 @param className The class name, as a const C string. Class matching is successful on IOService objects of this class or any subclass. 780 @param table If zero, <code>serviceMatching</code> creates a matching dictionary and returns a reference to it, otherwise the matching properties are added to the specified dictionary. 781 @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 782 783 static OSDictionary * serviceMatching( const char * className, 784 OSDictionary * table = 0 ); 785 786/*! @function serviceMatching 787 @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService class match. 788 @discussion A very common matching criteria for IOService object is based on its class. <code>serviceMatching</code> creates a matching dictionary that specifies any IOService of a class, or its subclasses. The class is specified by name, and an existing dictionary may be passed in, in which case the matching properties will be added to that dictionary rather than creating a new one. 789 @param className The class name, as an OSString (which includes OSSymbol). Class matching is successful on IOService objects of this class or any subclass. 790 @param table If zero, <code>serviceMatching</code> creates a matching dictionary and returns a reference to it, otherwise the matching properties are added to the specified dictionary. 791 @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 792 793 static OSDictionary * serviceMatching( const OSString * className, 794 OSDictionary * table = 0 ); 795 796/*! @function nameMatching 797 @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService name match. 798 @discussion A very common matching criteria for IOService object is based on its name. <code>nameMatching</code> creates a matching dictionary that specifies any IOService object which responds successfully to the @link //apple_ref/cpp/instm/IORegistryEntry/compareName/virtualbool/(OSString*,OSString**) IORegistryEntry::compareName@/link method. An existing dictionary may be passed in, in which case the matching properties will be added to that dictionary rather than creating a new one. 799 @param name The service's name, as a const C string. Name matching is successful on IOService objects that respond successfully to the <code>IORegistryEntry::compareName</code> method. 800 @param table If zero, <code>nameMatching</code> creates a matching dictionary and returns a reference to it, otherwise the matching properties are added to the specified dictionary. 801 @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 802 803 static OSDictionary * nameMatching( const char * name, 804 OSDictionary * table = 0 ); 805 806/*! @function nameMatching 807 @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService name match. 808 @discussion A very common matching criteria for IOService object is based on its name. <code>nameMatching</code> creates a matching dictionary that specifies any IOService object which responds successfully to the @link //apple_ref/cpp/instm/IORegistryEntry/compareName/virtualbool/(OSString*,OSString**) IORegistryEntry::compareName@/link method. An existing dictionary may be passed in, in which case the matching properties will be added to that dictionary rather than creating a new one. 809 @param name The service's name, as an OSString (which includes OSSymbol). Name matching is successful on IOService objects that respond successfully to the <code>IORegistryEntry::compareName</code> method. 810 @param table If zero, <code>nameMatching</code> creates a matching dictionary and returns a reference to it, otherwise the matching properties are added to the specified dictionary. 811 @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 812 813 static OSDictionary * nameMatching( const OSString* name, 814 OSDictionary * table = 0 ); 815 816/*! @function resourceMatching 817 @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify a resource service match. 818 @discussion IOService maintains a resource service IOResources that allows objects to be published and found globally in the I/O Kit based on a name, using the standard IOService matching and notification calls. 819 @param name The resource name, as a const C string. Resource matching is successful when an object by that name has been published with the <code>publishResource</code> method. 820 @param table If zero, <code>resourceMatching</code> creates a matching dictionary and returns a reference to it, otherwise the matching properties are added to the specified dictionary. 821 @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 822 823 static OSDictionary * resourceMatching( const char * name, 824 OSDictionary * table = 0 ); 825 826/*! @function resourceMatching 827 @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify a resource service match. 828 @discussion IOService maintains a resource service IOResources that allows objects to be published and found globally in the I/O Kit based on a name, using the standard IOService matching and notification calls. 829 @param name The resource name, as an OSString (which includes OSSymbol). Resource matching is successful when an object by that name has been published with the <code>publishResource</code> method. 830 @param table If zero, <code>resourceMatching</code> creates a matching dictionary and returns a reference to it, otherwise the matching properties are added to the specified dictionary. 831 @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 832 833 static OSDictionary * resourceMatching( const OSString * name, 834 OSDictionary * table = 0 ); 835 836 837/*! @function propertyMatching 838 @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService phandle match. 839 @discussion TODO A very common matching criteria for IOService is based on its name. nameMatching will create a matching dictionary that specifies any IOService which respond successfully to the IORegistryEntry method compareName. An existing dictionary may be passed in, in which case the matching properties will be added to that dictionary rather than creating a new one. 840 @param key The service's phandle, as a const UInt32. PHandle matching is successful on IOService objects that respond successfully to the IORegistryEntry method compareName. 841 @param value The service's phandle, as a const UInt32. PHandle matching is successful on IOService's which respond successfully to the IORegistryEntry method compareName. 842 @param table If zero, nameMatching will create a matching dictionary and return a reference to it, otherwise the matching properties are added to the specified dictionary. 843 @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 844 845 static OSDictionary * propertyMatching( const OSSymbol * key, const OSObject * value, 846 OSDictionary * table = 0 ); 847 848/*! @function registryEntryIDMatching 849 @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify a IORegistryEntryID match. 850 @discussion <code>registryEntryIDMatching</code> creates a matching dictionary that specifies the IOService object with the assigned registry entry ID (returned by <code>IORegistryEntry::getRegistryEntryID()</code>). An existing dictionary may be passed in, in which case the matching properties will be added to that dictionary rather than creating a new one. 851 @param name The service's ID. Matching is successful on the IOService object that return that ID from the <code>IORegistryEntry::getRegistryEntryID()</code> method. 852 @param table If zero, <code>registryEntryIDMatching</code> creates a matching dictionary and returns a reference to it, otherwise the matching properties are added to the specified dictionary. 853 @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 854 855 static OSDictionary * registryEntryIDMatching( uint64_t entryID, 856 OSDictionary * table = 0 ); 857 858 859/*! @function addLocation 860 @abstract Adds a location matching property to an existing dictionary. 861 @discussion This function creates matching properties that specify the location of a IOService object, as an embedded matching dictionary. This matching will be successful on an IOService object that attached to an IOService object which matches this location matching dictionary. 862 @param table The matching properties are added to the specified dictionary, which must be non-zero. 863 @result The location matching dictionary created is returned on success, or zero on failure. */ 864 865 static OSDictionary * addLocation( OSDictionary * table ); 866 867 /* Helpers for matching dictionaries. */ 868 869/*! @function compareProperty 870 @abstract Compares a property in a matching dictionary with an IOService object's property table. 871 @discussion This is a helper function to aid in implementing @link matchPropertyTable matchPropertyTable@/link. If the property specified by <code>key</code> exists in the matching dictionary, it is compared with a property of the same name in the IOService object's property table. The comparison is performed with the <code>isEqualTo</code> method. If the property does not exist in the matching table, success is returned. If the property exists in the matching dictionary but not the IOService property table, failure is returned. 872 @param matching The matching dictionary, which must be non-zero. 873 @param key The dictionary key specifying the property to be compared, as a C string. 874 @result <code>true</code> if the property does not exist in the matching table. If the property exists in the matching dictionary but not the IOService property table, failure is returned. Otherwise the result of calling the property from the matching dictionary's <code>isEqualTo</code> method with the IOService property as an argument is returned. */ 875 876 virtual bool compareProperty( OSDictionary * matching, 877 const char * key ); 878/*! @function compareProperty 879 @abstract Compares a property in a matching dictionary with an IOService object's property table. 880 @discussion This is a helper function to aid in implementing @link matchPropertyTable matchPropertyTable@/link. If the property specified by <code>key</code> exists in the matching dictionary, it is compared with a property of the same name in the IOService object's property table. The comparison is performed with the <code>isEqualTo</code> method. If the property does not exist in the matching table, success is returned. If the property exists in the matching dictionary but not the IOService property table, failure is returned. 881 @param matching The matching dictionary, which must be non-zero. 882 @param key The dictionary key specifying the property to be compared, as an OSString (which includes OSSymbol). 883 @result <code>true</code> if the property does not exist in the matching table. If the property exists in the matching dictionary but not the IOService property table, failure is returned. Otherwise the result of calling the property from the matching dictionary's <code>isEqualTo</code> method with the IOService property as an argument is returned. */ 884 885 virtual bool compareProperty( OSDictionary * matching, 886 const OSString * key ); 887 888/*! @function compareProperties 889 @abstract Compares a set of properties in a matching dictionary with an IOService object's property table. 890 @discussion This is a helper function to aid in implementing @link matchPropertyTable matchPropertyTable@/link. A collection of dictionary keys specifies properties in a matching dictionary to be compared, with <code>compareProperty</code>, with an IOService object's property table, if <code>compareProperty</code> returns <code>true</code> for each key, success is returned; otherwise failure. 891 @param matching The matching dictionary, which must be non-zero. 892 @param keys A collection (eg. OSSet, OSArray, OSDictionary) which should contain OSStrings (or OSSymbols) that specify the property keys to be compared. 893 @result Success if <code>compareProperty</code> returns <code>true</code> for each key in the collection; otherwise failure. */ 894 895 virtual bool compareProperties( OSDictionary * matching, 896 OSCollection * keys ); 897 898 /* Client / provider accessors */ 899 900/*! @function attach 901 @abstract Attaches an IOService client to a provider in the I/O Registry. 902 @discussion This function called in an IOService client enters the client into the I/O Registry as a child of the provider in the service plane. The provider must be active or the attach will fail. Multiple attach calls to the same provider are no-ops and return success. A client may be attached to multiple providers. Entering an object into the I/O Registry retains both the client and provider until they are detached. 903 @param provider The IOService object which will serve as this object's provider. 904 @result <code>false</code> if the provider is inactive or on a resource failure; otherwise <code>true</code>. */ 905 906 virtual bool attach( IOService * provider ); 907 908/*! @function detach 909 @abstract Detaches an IOService client from a provider in the I/O Registry. 910 @discussion This function called in an IOService client removes the client as a child of the provider in the service plane of the I/O Registry. If the provider is not a parent of the client this is a no-op, otherwise the I/O Registry releases both the client and provider. 911 @param provider The IOService object to detach from. */ 912 913 virtual void detach( IOService * provider ); 914 915/*! @function getProvider 916 @abstract Returns an IOService object's primary provider. 917 @discussion This function called in an IOService client will return the provider to which it was first attached. Because the majority of IOService objects have only one provider, this is a useful simplification and also supports caching of the provider when the I/O Registry is unchanged. 918 @result The first provider of the client, or zero if the IOService object is not attached into the I/O Registry. The provider is retained while the client is attached, and should not be released by the caller. */ 919 920 virtual IOService * getProvider( void ) const; 921 922/*! @function getWorkLoop 923 @abstract Returns the current work loop or <code>provider->getWorkLoop</code>. 924 @discussion This function returns a valid work loop that a client can use to add an IOCommandGate to. The intention is that an IOService client has data that needs to be protected but doesn't want to pay the cost of a dedicated thread. This data has to be accessed from a provider's call-out context as well. So to achieve both of these goals the client creates an IOCommandGate to lock access to his data but he registers it with the provider's work loop, i.e. the work loop which will make the completion call-outs. This avoids a potential deadlock because the work loop gate uses a recursive lock, which allows the same lock to be held multiple times by a single thread. 925 @result A work loop, either the current work loop or it walks up the @link getProvider getProvider@/link chain calling <code>getWorkLoop</code>. Eventually it will reach a valid work loop-based driver or the root of the I/O tree, where it will return a system-wide work loop. Returns 0 if it fails to find (or create) a work loop.*/ 926 927 virtual IOWorkLoop * getWorkLoop() const; 928 929/*! @function getProviderIterator 930 @abstract Returns an iterator over an IOService object's providers. 931 @discussion For those few IOService objects that obtain service from multiple providers, this method supplies an iterator over a client's providers. 932 @result An iterator over the providers of the client, or zero if there is a resource failure. The iterator must be released when the iteration is finished. All objects returned by the iteration are retained while the iterator is valid, though they may no longer be attached during the iteration. */ 933 934 virtual OSIterator * getProviderIterator( void ) const; 935 936/*! @function getOpenProviderIterator 937 @abstract Returns an iterator over an client's providers that are currently opened by the client. 938 @discussion For those few IOService objects that obtain service from multiple providers, this method supplies an iterator over a client's providers, locking each in turn with @link lockForArbitration lockForArbitration@/link and returning those that have been opened by the client. 939 @result An iterator over the providers the client has open, or zero if there is a resource failure. The iterator must be released when the iteration is finished. All objects returned by the iteration are retained while the iterator is valid, and the current entry in the iteration is locked with <code>lockForArbitration</code>, protecting it from state changes. */ 940 941 virtual OSIterator * getOpenProviderIterator( void ) const; 942 943/*! @function getClient 944 @abstract Returns an IOService object's primary client. 945 @discussion This function called in an IOService provider will return the first client to attach to it. For IOService objects which have only only one client, this may be a useful simplification. 946 @result The first client of the provider, or zero if the IOService object is not attached into the I/O Registry. The client is retained while it is attached, and should not be released by the caller. */ 947 948 virtual IOService * getClient( void ) const; 949 950/*! @function getClientIterator 951 @abstract Returns an iterator over an IOService object's clients. 952 @discussion For IOService objects that may have multiple clients, this method supplies an iterator over a provider's clients. 953 @result An iterator over the clients of the provider, or zero if there is a resource failure. The iterator must be released when the iteration is finished. All objects returned by the iteration are retained while the iterator is valid, though they may no longer be attached during the iteration. */ 954 955 virtual OSIterator * getClientIterator( void ) const; 956 957/*! @function getOpenClientIterator 958 @abstract Returns an iterator over a provider's clients that currently have opened the provider. 959 @discussion For IOService objects that may have multiple clients, this method supplies an iterator over a provider's clients, locking each in turn with @link lockForArbitration lockForArbitration@/link and returning those that have opened the provider. 960 @result An iterator over the clients that have opened the provider, or zero if there is a resource failure. The iterator must be released when the iteration is finished. All objects returned by the iteration are retained while the iterator is valid, and the current entry in the iteration is locked with <code>lockForArbitration</code>, protecting it from state changes. */ 961 962 virtual OSIterator * getOpenClientIterator( void ) const; 963 964/*! @function callPlatformFunction 965 @abstract Calls the platform function with the given name. 966 @discussion The platform expert or other drivers may implement various functions to control hardware features. <code>callPlatformFunction</code> allows any IOService object to access these functions. Normally <code>callPlatformFunction</code> is called on a service's provider. The provider services the request or passes it to its provider. The system's IOPlatformExpert subclass catches functions it knows about and redirects them into other parts of the service plane. If the IOPlatformExpert subclass cannot execute the function, the base class is called. The IOPlatformExpert base class attempts to find a service to execute the function by looking up the function name in an IOResources name space. A service may publish a service using <code>publishResource(functionName, this)</code>. If no service can be found to execute the function an error is returned. 967 @param functionName Name of the function to be called. When <code>functionName</code> is a C string, <code>callPlatformFunction</code> converts the C string to an OSSymbol and calls the OSSymbol version of <code>callPlatformFunction</code>. This process can block and should not be used from an interrupt context. 968 @param waitForFunction If <code>true</code>, <code>callPlatformFunction</code> will not return until the function has been called. 969 @result An IOReturn code; <code>kIOReturnSuccess</code> if the function was successfully executed, <code>kIOReturnUnsupported</code> if a service to execute the function could not be found. Other return codes may be returned by the function.*/ 970 971 virtual IOReturn callPlatformFunction( const OSSymbol * functionName, 972 bool waitForFunction, 973 void *param1, void *param2, 974 void *param3, void *param4 ); 975 976 virtual IOReturn callPlatformFunction( const char * functionName, 977 bool waitForFunction, 978 void *param1, void *param2, 979 void *param3, void *param4 ); 980 981 982 /* Some accessors */ 983 984/*! @function getPlatform 985 @abstract Returns a pointer to the platform expert instance for the computer. 986 @discussion This method provides an accessor to the platform expert instance for the computer. 987 @result A pointer to the IOPlatformExpert instance. It should not be released by the caller. */ 988 989 static IOPlatformExpert * getPlatform( void ); 990 991/*! @function getPMRootDomain 992 @abstract Returns a pointer to the power management root domain instance for the computer. 993 @discussion This method provides an accessor to the power management root domain instance for the computer. 994 @result A pointer to the power management root domain instance. It should not be released by the caller. */ 995 996 static class IOPMrootDomain * getPMRootDomain( void ); 997 998/*! @function getServiceRoot 999 @abstract Returns a pointer to the root of the service plane. 1000 @discussion This method provides an accessor to the root of the service plane for the computer. 1001 @result A pointer to the IOService instance at the root of the service plane. It should not be released by the caller. */ 1002 1003 static IOService * getServiceRoot( void ); 1004 1005/*! @function getResourceService 1006 @abstract Returns a pointer to the IOResources service. 1007 @discussion IOService maintains a resource service IOResources that allows objects to be published and found globally in the I/O Kit based on a name, using the standard IOService matching and notification calls. 1008 @result A pointer to the IOResources instance. It should not be released by the caller. */ 1009 1010 static IOService * getResourceService( void ); 1011 1012 /* Allocate resources for a matched service */ 1013 1014/*! @function getResources 1015 @abstract Allocates any needed resources for a published IOService object before clients attach. 1016 @discussion This method is called during the registration process for an IOService object if there are successful driver matches, before any clients attach. It allows for lazy allocation of resources to an IOService object when a matching driver is found. 1017 @result An IOReturn code; <code>kIOReturnSuccess</code> is necessary for the IOService object to be successfully used, otherwise the registration process for the object is halted. */ 1018 1019 virtual IOReturn getResources( void ); 1020 1021 /* Device memory accessors */ 1022 1023/*! @function getDeviceMemoryCount 1024 @abstract Returns a count of the physical memory ranges available for a device. 1025 @discussion This method returns the count of physical memory ranges, each represented by an IODeviceMemory instance, that have been allocated for a memory mapped device. 1026 @result An integer count of the number of ranges available. */ 1027 1028 virtual IOItemCount getDeviceMemoryCount( void ); 1029 1030/*! @function getDeviceMemoryWithIndex 1031 @abstract Returns an instance of IODeviceMemory representing one of a device's memory mapped ranges. 1032 @discussion This method returns a pointer to an instance of IODeviceMemory for the physical memory range at the given index for a memory mapped device. 1033 @param index An index into the array of ranges assigned to the device. 1034 @result A pointer to an instance of IODeviceMemory, or zero if the index is beyond the count available. The IODeviceMemory is retained by the provider, so is valid while attached, or while any mappings to it exist. It should not be released by the caller. See also @link mapDeviceMemoryWithIndex mapDeviceMemoryWithIndex@/link, which creates a device memory mapping. */ 1035 1036 virtual IODeviceMemory * getDeviceMemoryWithIndex( unsigned int index ); 1037 1038/*! @function mapDeviceMemoryWithIndex 1039 @abstract Maps a physical range of a device. 1040 @discussion This method creates a mapping for the IODeviceMemory at the given index, with <code>IODeviceMemory::map(options)</code>. The mapping is represented by the returned instance of IOMemoryMap, which should not be released until the mapping is no longer required. 1041 @param index An index into the array of ranges assigned to the device. 1042 @result An instance of IOMemoryMap, or zero if the index is beyond the count available. The mapping should be released only when access to it is no longer required. */ 1043 1044 virtual IOMemoryMap * mapDeviceMemoryWithIndex( unsigned int index, 1045 IOOptionBits options = 0 ); 1046 1047/*! @function getDeviceMemory 1048 @abstract Returns the array of IODeviceMemory objects representing a device's memory mapped ranges. 1049 @discussion This method returns an array of IODeviceMemory objects representing the physical memory ranges allocated to a memory mapped device. 1050 @result An OSArray of IODeviceMemory objects, or zero if none are available. The array is retained by the provider, so is valid while attached. */ 1051 1052 virtual OSArray * getDeviceMemory( void ); 1053 1054/*! @function setDeviceMemory 1055 @abstract Sets the array of IODeviceMemory objects representing a device's memory mapped ranges. 1056 @discussion This method sets an array of IODeviceMemory objects representing the physical memory ranges allocated to a memory mapped device. 1057 @param array An OSArray of IODeviceMemory objects, or zero if none are available. The array will be retained by the object. */ 1058 1059 virtual void setDeviceMemory( OSArray * array ); 1060 1061 /* Interrupt accessors */ 1062 1063/*! @function registerInterrupt 1064 @abstract Registers a C function interrupt handler for a device supplying interrupts. 1065 @discussion This method installs a C function interrupt handler to be called at primary interrupt time for a device's interrupt. Only one handler may be installed per interrupt source. IOInterruptEventSource provides a work loop based abstraction for interrupt delivery that may be more appropriate for work loop based drivers. 1066 @param source The index of the interrupt source in the device. 1067 @param target An object instance to be passed to the interrupt handler. 1068 @param handler The C function to be called at primary interrupt time when the interrupt occurs. The handler should process the interrupt by clearing the interrupt, or by disabling the source. 1069 @param refCon A reference constant for the handler's use. 1070 @result An IOReturn code.<br><code>kIOReturnNoInterrupt</code> is returned if the source is not valid; <code>kIOReturnNoResources</code> is returned if the interrupt already has an installed handler. */ 1071 1072 virtual IOReturn registerInterrupt(int source, OSObject *target, 1073 IOInterruptAction handler, 1074 void *refCon = 0); 1075 1076/*! @function unregisterInterrupt 1077 @abstract Removes a C function interrupt handler for a device supplying hardware interrupts. 1078 @discussion This method removes a C function interrupt handler previously installed with @link registerInterrupt registerInterrupt@/link. 1079 @param source The index of the interrupt source in the device. 1080 @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */ 1081 1082 virtual IOReturn unregisterInterrupt(int source); 1083 1084/*! @function getInterruptType 1085 @abstract Returns the type of interrupt used for a device supplying hardware interrupts. 1086 @param source The index of the interrupt source in the device. 1087 @param interruptType The interrupt type for the interrupt source will be stored here by <code>getInterruptType</code>.<br> <code>kIOInterruptTypeEdge</code> will be returned for edge-trigggered sources.<br><code>kIOInterruptTypeLevel</code> will be returned for level-trigggered sources. 1088 @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */ 1089 1090 virtual IOReturn getInterruptType(int source, int *interruptType); 1091 1092/*! @function enableInterrupt 1093 @abstract Enables a device interrupt. 1094 @discussion It is the caller's responsiblity to keep track of the enable state of the interrupt source. 1095 @param source The index of the interrupt source in the device. 1096 @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */ 1097 1098 virtual IOReturn enableInterrupt(int source); 1099 1100/*! @function disableInterrupt 1101 @abstract Synchronously disables a device interrupt. 1102 @discussion If the interrupt routine is running, the call will block until the routine completes. It is the caller's responsiblity to keep track of the enable state of the interrupt source. 1103 @param source The index of the interrupt source in the device. 1104 @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */ 1105 1106 virtual IOReturn disableInterrupt(int source); 1107 1108/*! @function causeInterrupt 1109 @abstract Causes a device interrupt to occur. 1110 @discussion Emulates a hardware interrupt, to be called from task level. 1111 @param source The index of the interrupt source in the device. 1112 @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */ 1113 1114 virtual IOReturn causeInterrupt(int source); 1115 1116/*! @function requestProbe 1117 @abstract Requests that hardware be re-scanned for devices. 1118 @discussion For bus families that do not usually detect device addition or removal, this method represents an external request (eg. from a utility application) to rescan and publish or remove found devices. 1119 @param options Family defined options, not interpreted by IOService. 1120 @result An IOReturn code. */ 1121 1122 virtual IOReturn requestProbe( IOOptionBits options ); 1123 1124 /* Generic API for non-data-path upstream calls */ 1125 1126/*! @function message 1127 @abstract Receives a generic message delivered from an attached provider. 1128 @discussion A provider may deliver messages via the <code>message</code> method to its clients informing them of state changes, such as <code>kIOMessageServiceIsTerminated</code> or <code>kIOMessageServiceIsSuspended</code>. Certain messages are defined by the I/O Kit in <code>IOMessage.h</code> while others may be family dependent. This method is implemented in the client to receive messages. 1129 @param type A type defined in <code>IOMessage.h</code> or defined by the provider family. 1130 @param provider The provider from which the message originates. 1131 @param argument An argument defined by the provider family, not used by IOService. 1132 @result An IOReturn code defined by the message type. */ 1133 1134 virtual IOReturn message( UInt32 type, IOService * provider, 1135 void * argument = 0 ); 1136 1137/*! @function messageClient 1138 @abstract Sends a generic message to an attached client. 1139 @discussion A provider may deliver messages via the @link message message@/link method to its clients informing them of state changes, such as <code>kIOMessageServiceIsTerminated</code> or <code>kIOMessageServiceIsSuspended</code>. Certain messages are defined by the I/O Kit in <code>IOMessage.h</code> while others may be family dependent. This method may be called in the provider to send a message to the specified client, which may be useful for overrides. 1140 @param messageType A type defined in <code>IOMessage.h</code> or defined by the provider family. 1141 @param client A client of the IOService to send the message. 1142 @param messageArgument An argument defined by the provider family, not used by IOService. 1143 @param argSize Specifies the size of messageArgument, in bytes. If argSize is non-zero, messageArgument is treated as a pointer to argSize bytes of data. If argSize is 0 (the default), messageArgument is treated as an ordinal and passed by value. 1144 @result The return code from the client message call. */ 1145 1146 virtual IOReturn messageClient( UInt32 messageType, OSObject * client, 1147 void * messageArgument = 0, vm_size_t argSize = 0 ); 1148 1149/*! @function messageClients 1150 @abstract Sends a generic message to all attached clients. 1151 @discussion A provider may deliver messages via the @link message message@/link method to its clients informing them of state changes, such as <code>kIOMessageServiceIsTerminated</code> or <code>kIOMessageServiceIsSuspended</code>. Certain messages are defined by the I/O Kit in <code>IOMessage.h</code> while others may be family dependent. This method may be called in the provider to send a message to all the attached clients, via the @link messageClient messageClient@/link method. 1152 @param type A type defined in <code>IOMessage.h</code> or defined by the provider family. 1153 @param argument An argument defined by the provider family, not used by IOService. 1154 @param argSize Specifies the size of argument, in bytes. If argSize is non-zero, argument is treated as a pointer to argSize bytes of data. If argSize is 0 (the default), argument is treated as an ordinal and passed by value. 1155 @result Any non-<code>kIOReturnSuccess</code> return codes returned by the clients, or <code>kIOReturnSuccess</code> if all return <code>kIOReturnSuccess</code>. */ 1156 1157 virtual IOReturn messageClients( UInt32 type, 1158 void * argument = 0, vm_size_t argSize = 0 ); 1159 1160 virtual IONotifier * registerInterest( const OSSymbol * typeOfInterest, 1161 IOServiceInterestHandler handler, 1162 void * target, void * ref = 0 ); 1163 1164 virtual void applyToProviders( IOServiceApplierFunction applier, 1165 void * context ); 1166 1167 virtual void applyToClients( IOServiceApplierFunction applier, 1168 void * context ); 1169 1170 virtual void applyToInterested( const OSSymbol * typeOfInterest, 1171 OSObjectApplierFunction applier, 1172 void * context ); 1173 1174 virtual IOReturn acknowledgeNotification( IONotificationRef notification, 1175 IOOptionBits response ); 1176 1177 /* User client create */ 1178 1179/*! @function newUserClient 1180 @abstract Creates a connection for a non kernel client. 1181 @discussion A non kernel client may request a connection be opened via the @link //apple_ref/c/func/IOServiceOpen IOServiceOpen@/link library function, which will call this method in an IOService object. The rules and capabilities of user level clients are family dependent, and use the functions of the IOUserClient class for support. IOService's implementation returns <code>kIOReturnUnsupported</code>, so any family supporting user clients must implement this method. 1182 @param owningTask The Mach task of the client thread in the process of opening the user client. Note that in Mac OS X, each process is based on a Mach task and one or more Mach threads. For more information on the composition of a Mach task and its relationship with Mach threads, see {@linkdoc //apple_ref/doc/uid/TP30000905-CH209-TPXREF103 "Tasks and Threads"}. 1183 @param securityID A token representing the access level for the task. 1184 @param type A constant specifying the type of connection to be created, specified by the caller of @link //apple_ref/c/func/IOServiceOpen IOServiceOpen@/link and interpreted only by the family. 1185 @param handler An instance of an IOUserClient object to represent the connection, which will be released when the connection is closed, or zero if the connection was not opened. 1186 @param properties A dictionary of additional properties for the connection. 1187 @result A return code to be passed back to the caller of <code>IOServiceOpen</code>. */ 1188 1189 virtual IOReturn newUserClient( task_t owningTask, void * securityID, 1190 UInt32 type, OSDictionary * properties, 1191 IOUserClient ** handler ); 1192 1193 virtual IOReturn newUserClient( task_t owningTask, void * securityID, 1194 UInt32 type, IOUserClient ** handler ); 1195 1196 /* Return code utilities */ 1197 1198/*! @function stringFromReturn 1199 @abstract Supplies a programmer-friendly string from an IOReturn code. 1200 @discussion Strings are available for the standard return codes in <code>IOReturn.h</code> in IOService, while subclasses may implement this method to interpret family dependent return codes. 1201 @param rtn The IOReturn code. 1202 @result A pointer to a constant string, or zero if the return code is unknown. */ 1203 1204 virtual const char * stringFromReturn( IOReturn rtn ); 1205 1206/*! @function errnoFromReturn 1207 @abstract Translates an IOReturn code to a BSD <code>errno</code>. 1208 @discussion BSD defines its own return codes for its functions in <code>sys/errno.h</code>, and I/O Kit families may need to supply compliant results in BSD shims. Results are available for the standard return codes in <code>IOReturn.h</code> in IOService, while subclasses may implement this method to interpret family dependent return codes. 1209 @param rtn The IOReturn code. 1210 @result The BSD <code>errno</code> or <code>EIO</code> if unknown. */ 1211 1212 virtual int errnoFromReturn( IOReturn rtn ); 1213 1214 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 1215 /* * * * * * * * * * end of IOService API * * * * * * * */ 1216 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 1217 1218 /* for IOInterruptController implementors */ 1219 1220 int _numInterruptSources; 1221 IOInterruptSource *_interruptSources; 1222 1223 /* overrides */ 1224 virtual bool serializeProperties( OSSerialize * s ) const; 1225 1226#ifdef KERNEL_PRIVATE 1227 /* Apple only SPI to control CPU low power modes */ 1228 void setCPUSnoopDelay(UInt32 ns); 1229 UInt32 getCPUSnoopDelay(); 1230#endif 1231 void requireMaxBusStall(UInt32 ns); 1232 void requireMaxInterruptDelay(uint32_t ns); 1233 1234 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 1235 /* * * * * * * * * * * * Internals * * * * * * * * * * * */ 1236 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 1237 1238#ifdef XNU_KERNEL_PRIVATE 1239public: 1240 // called from other xnu components 1241 static void initialize( void ); 1242 static void setPlatform( IOPlatformExpert * platform); 1243 static void setPMRootDomain( class IOPMrootDomain * rootDomain ); 1244 static IOReturn catalogNewDrivers( OSOrderedSet * newTables ); 1245 uint64_t getAccumulatedBusyTime( void ); 1246 static void updateConsoleUsers(OSArray * consoleUsers, IOMessage systemMessage); 1247 static void consoleLockTimer(thread_call_param_t p0, thread_call_param_t p1); 1248 void setTerminateDefer(IOService * provider, bool defer); 1249 1250private: 1251 static IOReturn waitMatchIdle( UInt32 ms ); 1252 static IONotifier * installNotification( 1253 const OSSymbol * type, OSDictionary * matching, 1254 IOServiceMatchingNotificationHandler handler, 1255 void * target, void * ref, 1256 SInt32 priority, OSIterator ** existing ); 1257#if !defined(__LP64__) 1258 static IONotifier * installNotification( 1259 const OSSymbol * type, OSDictionary * matching, 1260 IOServiceNotificationHandler handler, 1261 void * target, void * ref, 1262 SInt32 priority, OSIterator ** existing); 1263#endif /* !defined(__LP64__) */ 1264#endif 1265 1266private: 1267 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1268 bool checkResources( void ); 1269 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1270 bool checkResource( OSObject * matching ); 1271 1272 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1273 void probeCandidates( OSOrderedSet * matches ); 1274 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1275 bool startCandidate( IOService * candidate ); 1276 1277public: 1278 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1279 IOService * getClientWithCategory( const OSSymbol * category ) 1280 APPLE_KEXT_DEPRECATED; 1281 // copyClientWithCategory is the public replacement 1282 1283#ifdef XNU_KERNEL_PRIVATE 1284 /* Callable within xnu source only - but require vtable entries to be visible */ 1285public: 1286#else 1287private: 1288#endif 1289 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1290 bool passiveMatch( OSDictionary * matching, bool changesOK = false); 1291 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1292 void startMatching( IOOptionBits options = 0 ); 1293 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1294 void doServiceMatch( IOOptionBits options ); 1295 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1296 void doServiceTerminate( IOOptionBits options ); 1297 1298private: 1299 1300 bool matchPassive(OSDictionary * table, uint32_t options); 1301 bool matchInternal(OSDictionary * table, uint32_t options, unsigned int * did); 1302 static bool instanceMatch(const OSObject * entry, void * context); 1303 1304 static OSObject * copyExistingServices( OSDictionary * matching, 1305 IOOptionBits inState, IOOptionBits options = 0 ); 1306 1307 static IONotifier * setNotification( 1308 const OSSymbol * type, OSDictionary * matching, 1309 IOServiceMatchingNotificationHandler handler, 1310 void * target, void * ref, 1311 SInt32 priority = 0 ); 1312 1313 static IONotifier * doInstallNotification( 1314 const OSSymbol * type, OSDictionary * matching, 1315 IOServiceMatchingNotificationHandler handler, 1316 void * target, void * ref, 1317 SInt32 priority, OSIterator ** existing ); 1318 1319 static bool syncNotificationHandler( void * target, void * ref, 1320 IOService * newService, IONotifier * notifier ); 1321 1322 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1323 void deliverNotification( const OSSymbol * type, 1324 IOOptionBits orNewState, IOOptionBits andNewState ); 1325 1326 bool invokeNotifer( class _IOServiceNotifier * notify ); 1327 1328 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1329 void unregisterAllInterest( void ); 1330 1331 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1332 IOReturn waitForState( UInt32 mask, UInt32 value, 1333 mach_timespec_t * timeout = 0 ); 1334 1335 IOReturn waitForState( UInt32 mask, UInt32 value, uint64_t timeout ); 1336 1337 UInt32 _adjustBusy( SInt32 delta ); 1338 1339 bool terminatePhase1( IOOptionBits options = 0 ); 1340 void scheduleTerminatePhase2( IOOptionBits options = 0 ); 1341 void scheduleStop( IOService * provider ); 1342 void scheduleFinalize( void ); 1343 static void terminateThread( void * arg, wait_result_t unused ); 1344 static void terminateWorker( IOOptionBits options ); 1345 static void actionWillTerminate( IOService * victim, IOOptionBits options, 1346 OSArray * doPhase2List, void*, void * ); 1347 static void actionDidTerminate( IOService * victim, IOOptionBits options, 1348 void *, void *, void *); 1349 static void actionFinalize( IOService * victim, IOOptionBits options, 1350 void *, void *, void *); 1351 static void actionStop( IOService * client, IOService * provider, 1352 void *, void *, void *); 1353 1354 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1355 IOReturn resolveInterrupt(IOService *nub, int source); 1356 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1357 IOReturn lookupInterrupt(int source, bool resolve, IOInterruptController **interruptController); 1358 1359#ifdef XNU_KERNEL_PRIVATE 1360 /* end xnu internals */ 1361#endif 1362 1363 /* power management */ 1364public: 1365 1366/*! @function PMinit 1367 @abstract Initializes power management for a driver. 1368 @discussion <code>PMinit</code> allocates and initializes the power management instance variables, and it should be called before accessing those variables or calling the power management methods. This method should be called inside the driver's <code>start</code> routine and must be paired with a call to @link PMstop PMstop@/link. 1369 Most calls to <code>PMinit</code> are followed by calls to @link joinPMtree joinPMtree@/link and @link registerPowerDriver registerPowerDriver@/link. */ 1370 1371 virtual void PMinit( void ); 1372 1373/*! @function PMstop 1374 @abstract Stop power managing the driver. 1375 @discussion Removes the driver from the power plane and stop its power management. This method is synchronous against any power management method invocations (e.g. <code>setPowerState</code> or <code>setAggressiveness</code>), so when this method returns it is guaranteed those power management methods will not be entered. Driver should not call any power management methods after this call. 1376 Calling <code>PMstop</code> cleans up for the three power management initialization calls: @link PMinit PMinit@/link, @link joinPMtree joinPMtree@/link, and @link registerPowerDriver registerPowerDriver@/link. */ 1377 1378 virtual void PMstop( void ); 1379 1380/*! @function joinPMtree 1381 @abstract Joins the driver into the power plane of the I/O Registry. 1382 @discussion A driver uses this method to call its nub when initializing (usually in its <code>start</code> routine after calling @link PMinit PMinit@/link), to be attached into the power management hierarchy (i.e., the power plane). A driver usually calls this method on the driver for the device that provides it power (this is frequently the nub). 1383 Before this call returns, the caller will probably be called at @link setPowerParent setPowerParent@/link and @link setAggressiveness setAggressiveness@/link and possibly at @link addPowerChild addPowerChild@/link as it is added to the hierarchy. This method may be overridden by a nub subclass. 1384 @param driver The driver to be added to the power plane, usually <code>this</code>. */ 1385 1386 virtual void joinPMtree( IOService * driver ); 1387 1388/*! @function registerPowerDriver 1389 @abstract Registers a set of power states that the driver supports. 1390 @discussion A driver defines its array of supported power states with power management in its power management initialization (its <code>start</code> routine). If successful, power management will call the driver to instruct it to change its power state through @link setPowerState setPowerState@/link. 1391 Most drivers do not need to override <code>registerPowerDriver</code>. A nub may override <code>registerPowerDriver</code> if it needs to arrange its children in the power plane differently than the default placement, but this is uncommon. 1392 @param controllingDriver A pointer to the calling driver, usually <code>this</code>. 1393 @param powerStates A driver-defined array of power states that the driver and device support. Power states are defined in <code>pwr_mgt/IOPMpowerState.h</code>. 1394 @param numberOfStates The number of power states in the array. 1395 @result </code>IOPMNoErr</code>. All errors are logged via <code>kprintf</code>. */ 1396 1397 virtual IOReturn registerPowerDriver( 1398 IOService * controllingDriver, 1399 IOPMPowerState * powerStates, 1400 unsigned long numberOfStates ); 1401 1402/*! @function registerInterestedDriver 1403 @abstract Allows an IOService object to register interest in the changing power state of a power-managed IOService object. 1404 @discussion Call <code>registerInterestedDriver</code> on the IOService object you are interested in receiving power state messages from, and pass a pointer to the interested driver (<code>this</code>) as an argument. 1405 The interested driver is retained until the power interest is removed by calling <code>deRegisterInterestedDriver</code>. 1406 The interested driver should override @link powerStateWillChangeTo powerStateWillChangeTo@/link and @link powerStateDidChangeTo powerStateDidChangeTo@/link to receive these power change messages. 1407 Interested drivers must acknowledge power changes in <code>powerStateWillChangeTo</code> or <code>powerStateDidChangeTo</code>, either via return value or later calls to @link acknowledgePowerChange acknowledgePowerChange@/link. 1408 @param theDriver The driver of interest adds this pointer to the list of interested drivers. It informs drivers on this list before and after the power change. 1409 @result Flags describing the capability of the device in its current power state. If the current power state is not yet defined, zero is returned (this is the case when the driver is not yet in the power domain hierarchy or hasn't fully registered with power management yet). */ 1410 1411 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1412 IOPMPowerFlags registerInterestedDriver( IOService * theDriver ); 1413 1414/*! @function deRegisterInterestedDriver 1415 @abstract De-registers power state interest from a previous call to <code>registerInterestedDriver</code>. 1416 @discussion The retain from <code>registerInterestedDriver</code> is released. This method is synchronous against any <code>powerStateWillChangeTo</code> or <code>powerStateDidChangeTo</code> call targeting the interested driver, so when this method returns it is guaranteed those interest handlers will not be entered. 1417 Most drivers do not need to override <code>deRegisterInterestedDriver</code>. 1418 @param theDriver The interested driver previously passed into @link registerInterestedDriver registerInterestedDriver@/link. 1419 @result A return code that can be ignored by the caller. */ 1420 1421 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1422 IOReturn deRegisterInterestedDriver( IOService * theDriver ); 1423 1424/*! @function acknowledgePowerChange 1425 @abstract Acknowledges an in-progress power state change. 1426 @discussion When power management informs an interested object (via @link powerStateWillChangeTo powerStateWillChangeTo@/link or @link powerStateDidChangeTo powerStateDidChangeTo@/link), the object can return an immediate acknowledgement via a return code, or it may return an indication that it will acknowledge later by calling <code>acknowledgePowerChange</code>. 1427 Interested objects are those that have registered as interested drivers, as well as power plane children of the power changing driver. A driver that calls @link registerInterestedDriver registerInterestedDriver@/link must call <code>acknowledgePowerChange</code>, or use an immediate acknowledgement return from <code>powerStateWillChangeTo</code> or <code>powerStateDidChangeTo</code>. 1428 @param whichDriver A pointer to the calling driver. The called object tracks all interested parties to ensure that all have acknowledged the power state change. 1429 @result <code>IOPMNoErr</code>. */ 1430 1431 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1432 IOReturn acknowledgePowerChange( IOService * whichDriver ); 1433 1434/*! @function acknowledgeSetPowerState 1435 @abstract Acknowledges the belated completion of a driver's <code>setPowerState</code> power state change. 1436 @discussion After power management instructs a driver to change its state via @link setPowerState setPowerState@/link, that driver must acknowledge the change when its device has completed its transition. The acknowledgement may be immediate, via a return code from <code>setPowerState</code>, or delayed, via this call to <code>acknowledgeSetPowerState</code>. 1437 Any driver that does not return <code>kIOPMAckImplied</code> from its <code>setPowerState</code> implementation must later call <code>acknowledgeSetPowerState</code>. 1438 @result <code>IOPMNoErr</code>. */ 1439 1440 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1441 IOReturn acknowledgeSetPowerState( void ); 1442 1443/*! @function requestPowerDomainState 1444 @abstract Tells a driver to adjust its power state. 1445 @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1446 1447 virtual IOReturn requestPowerDomainState( 1448 IOPMPowerFlags desiredState, 1449 IOPowerConnection * whichChild, 1450 unsigned long specificationFlags ); 1451 1452/*! @function makeUsable 1453 @abstract Requests that a device become usable. 1454 @discussion This method is called when some client of a device (or the device's own driver) is asking for the device to become usable. Power management responds by telling the object upon which this method is called to change to its highest power state. 1455 <code>makeUsable</code> is implemented using @link changePowerStateToPriv changePowerStateToPriv@/link. Subsequent requests for lower power, such as from <code>changePowerStateToPriv</code>, will pre-empt this request. 1456 @result A return code that can be ignored by the caller. */ 1457 1458 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1459 IOReturn makeUsable( void ); 1460 1461/*! @function temporaryPowerClampOn 1462 @abstract A driver calls this method to hold itself in the highest power state until it has children. 1463 @discussion Use <code>temporaryPowerClampOn</code> to hold your driver in its highest power state while waiting for child devices to attach. After children have attached, the clamp is released and the device's power state is controlled by the children's requirements. 1464 @result A return code that can be ignored by the caller. */ 1465 1466 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1467 IOReturn temporaryPowerClampOn( void ); 1468 1469/*! @function changePowerStateTo 1470 @abstract Sets a driver's power state. 1471 @discussion This function is one of several that are used to set a driver's power state. In most circumstances, however, you should call @link changePowerStateToPriv changePowerStateToPriv@/link instead. 1472 Calls to <code>changePowerStateTo</code>, <code>changePowerStateToPriv</code>, and a driver's power children all affect the power state of a driver. For legacy design reasons, they have overlapping functionality. Although you should call <code>changePowerStateToPriv</code> to change your device's power state, you might need to call <code>changePowerStateTo</code> in the following circumstances: 1473 <ul><li>If a driver will be using <code>changePowerStateToPriv</code> to change its power state, it should call <code>changePowerStateTo(0)</code> in its <code>start</code> routine to eliminate the influence <code>changePowerStateTo</code> has on power state calculations. 1474 <li>Call <code>changePowerStateTo</code> in conjunction with @link setIdleTimerPeriod setIdleTimerPeriod@/link and @link activityTickle activityTickle@/link to idle a driver into a low power state. For a driver with 3 power states, for example, <code>changePowerStateTo(1)</code> sets a minimum level of power state 1, such that the idle timer period may not set your device's power any lower than state 1.</ul> 1475 @param ordinal The number of the desired power state in the power state array. 1476 @result A return code that can be ignored by the caller. */ 1477 1478 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1479 IOReturn changePowerStateTo( unsigned long ordinal ); 1480 1481/*! @function currentCapability 1482 @abstract Finds out the capability of a device's current power state. 1483 @result A copy of the <code>capabilityFlags</code> field for the current power state in the power state array. */ 1484 1485 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1486 IOPMPowerFlags currentCapability( void ); 1487 1488/*! @function currentPowerConsumption 1489 @abstract Finds out the current power consumption of a device. 1490 @discussion Most Mac OS X power managed drivers do not report their power consumption via the <code>staticPower</code> field. Thus this call will not accurately reflect power consumption for most drivers. 1491 @result A copy of the <code>staticPower</code> field for the current power state in the power state array. */ 1492 1493 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1494 unsigned long currentPowerConsumption( void ); 1495 1496/*! @function activityTickle 1497 @abstract Informs power management when a power-managed device is in use, so that power management can track when it is idle and adjust its power state accordingly. 1498 @discussion The <code>activityTickle</code> method is provided for objects in the system (or for the driver itself) to tell a driver that its device is being used. 1499 The IOService superclass can manage idleness determination with a simple idle timer mechanism and this <code>activityTickle</code> call. To start this up, the driver calls its superclass's <code>setIdleTimerPeriod</code>. This starts a timer for the time interval specified in the call. When the timer expires, the superclass checks to see if there has been any activity since the last timer expiration. (It checks to see if <code>activityTickle</code> has been called). If there has been activity, it restarts the timer, and this process continues. When the timer expires, and there has been no device activity, the superclass lowers the device power state to the next lower state. This can continue until the device is in state zero. 1500 After the device has been powered down by at least one power state, a subsequent call to <code>activityTickle</code> causes the device to be switched to a higher state required for the activity. 1501 If the driver is managing the idleness determination totally on its own, the value of the <code>type</code> parameter should be <code>kIOPMSubclassPolicy</code>, and the driver should override the <code>activityTickle</code> method. The superclass IOService implementation of <code>activityTickle</code> does nothing with the <code>kIOPMSubclassPolicy</code> argument. 1502 @param type When <code>type</code> is <code>kIOPMSubclassPolicy</code>, <code>activityTickle</code> is not handled in IOService and should be intercepted by the subclass. When <code>type</code> is <code>kIOPMSuperclassPolicy1</code>, an activity flag is set and the device state is checked. If the device has been powered down, it is powered up again. 1503 @param stateNumber When <code>type</code> is <code>kIOPMSuperclassPolicy1</code>, <code>stateNumber</code> contains the desired power state ordinal for the activity. If the device is in a lower state, the superclass will switch it to this state. This is for devices that can handle some accesses in lower power states; the device is powered up only as far as it needs to be for the activity. 1504 @result When <code>type</code> is <code>kIOPMSuperclassPolicy1</code>, the superclass returns <code>true</code> if the device is currently in the state specified by <code>stateNumber</code>. If the device is in a lower state and must be powered up, the superclass returns <code>false</code>; in this case the superclass will initiate a power change to power the device up. */ 1505 1506 virtual bool activityTickle( 1507 unsigned long type, 1508 unsigned long stateNumber = 0 ); 1509 1510/*! @function setAggressiveness 1511 @abstract Broadcasts an aggressiveness factor from the parent of a driver to the driver. 1512 @discussion Implement <code>setAggressiveness</code> to receive a notification when an "aggressiveness Aggressiveness factors are a loose set of power management variables that contain values for system sleep timeout, display sleep timeout, whether the system is on battery or AC, and other power management features. There are several aggressiveness factors that can be broadcast and a driver may take action on whichever factors apply to it. 1513 A driver that has joined the power plane via @link joinPMtree joinPMtree@/link will receive <code>setAgressiveness</code> calls when aggressiveness factors change. 1514 A driver may override this call if it needs to do something with the new factor (such as change its idle timeout). If overridden, the driver must call its superclass's <code>setAgressiveness</code> method in its own <code>setAgressiveness</code> implementation. 1515 Most drivers do not need to implement <code>setAgressiveness</code>. 1516 @param type The aggressiveness factor type, such as <code>kPMMinutesToDim</code>, <code>kPMMinutesToSpinDown</code>, <code>kPMMinutesToSleep</code>, and <code>kPMPowerSource</code>. (Aggressiveness factors are defined in <code>pwr_mgt/IOPM.h</code>.) 1517 @param newLevel The aggressiveness factor's new value. 1518 @result <code>IOPMNoErr</code>. */ 1519 1520 virtual IOReturn setAggressiveness( 1521 unsigned long type, 1522 unsigned long newLevel ); 1523 1524/*! @function getAggressiveness 1525 @abstract Returns the current aggressiveness value for the given type. 1526 @param type The aggressiveness factor to query. 1527 @param currentLevel Upon successful return, contains the value of aggressiveness factor <code>type</code>. 1528 @result <code>kIOReturnSuccess</code> upon success; an I/O Kit error code otherwise. */ 1529 1530 virtual IOReturn getAggressiveness( 1531 unsigned long type, 1532 unsigned long * currentLevel ); 1533 1534#ifndef __LP64__ 1535/*! @function systemWake 1536 @abstract Tells every driver in the power plane that the system is waking up. 1537 @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1538 1539 virtual IOReturn systemWake( void ) 1540 APPLE_KEXT_DEPRECATED; 1541 1542/*! @function temperatureCriticalForZone 1543 @abstract Alerts a driver to a critical temperature in some thermal zone. 1544 @discussion This call is unused by power management. It is not intended to be called or overridden. */ 1545 1546 virtual IOReturn temperatureCriticalForZone( IOService * whichZone ) 1547 APPLE_KEXT_DEPRECATED; 1548 1549/*! @function youAreRoot 1550 @abstract Informs power management which IOService object is the power plane root. 1551 @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1552 1553 virtual IOReturn youAreRoot( void ) 1554 APPLE_KEXT_DEPRECATED; 1555 1556/*! @function setPowerParent 1557 @abstract This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1558 1559 virtual IOReturn setPowerParent( 1560 IOPowerConnection * parent, 1561 bool stateKnown, 1562 IOPMPowerFlags currentState ) 1563 APPLE_KEXT_DEPRECATED; 1564#endif /* !__LP64__ */ 1565 1566/*! @function addPowerChild 1567 @abstract Informs a driver that it has a new child. 1568 @discussion The Platform Expert uses this method to call a driver and introduce it to a new child. This call is handled internally by power management. It is not intended to be overridden or called by drivers. 1569 @param theChild A pointer to the child IOService object. */ 1570 1571 virtual IOReturn addPowerChild( IOService * theChild ); 1572 1573/*! @function removePowerChild 1574 @abstract Informs a power managed driver that one of its power plane childen is disappearing. 1575 @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1576 1577 virtual IOReturn removePowerChild( IOPowerConnection * theChild ); 1578 1579#ifndef __LP64__ 1580/*! @function command_received 1581 @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1582 1583 virtual void command_received( void *, void * , void * , void * ); 1584#endif 1585 1586/*! @function start_PM_idle_timer 1587 @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1588 1589 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1590 void start_PM_idle_timer( void ); 1591 1592#ifndef __LP64__ 1593/*! @function PM_idle_timer_expiration 1594 @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1595 1596 virtual void PM_idle_timer_expiration( void ) 1597 APPLE_KEXT_DEPRECATED; 1598 1599/*! @function PM_Clamp_Timer_Expired 1600 @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1601 1602 virtual void PM_Clamp_Timer_Expired( void ) 1603 APPLE_KEXT_DEPRECATED; 1604#endif 1605 1606/*! @function setIdleTimerPeriod 1607 @abstract Sets or changes the idle timer period. 1608 @discussion A driver using the idleness determination provided by IOService calls its superclass with this method to set or change the idle timer period. See @link activityTickle activityTickle@/link for a description of this type of idleness determination. 1609 @param period The desired idle timer period in seconds. 1610 @result <code>kIOReturnSuccess</code> upon success; an I/O Kit error code otherwise. */ 1611 1612 virtual IOReturn setIdleTimerPeriod( unsigned long ); 1613 1614#ifndef __LP64__ 1615/*! @function getPMworkloop 1616 @abstract Returns a pointer to the system-wide power management work loop. 1617 @availability Deprecated in Mac OS X version 10.6. 1618 @discussion Most drivers should create their own work loops to synchronize their code; drivers should not run arbitrary code on the power management work loop. */ 1619 1620 virtual IOWorkLoop * getPMworkloop( void ) 1621 APPLE_KEXT_DEPRECATED; 1622#endif 1623 1624/*! @function getPowerState 1625 @abstract Determines a device's power state. 1626 @discussion A device's "current power state" is updated at the end of each power state transition (e.g. transition from state 1 to state 0, or state 0 to state 2). This transition includes the time spent powering on or off any power plane children. Thus, if a child calls <code>getPowerState</code> on its power parent during system wake from sleep, the call will return the index to the device's off state rather than its on state. 1627 @result The current power state's index into the device's power state array. */ 1628 1629 UInt32 getPowerState( void ); 1630 1631/*! @function setPowerState 1632 @abstract Requests a power managed driver to change the power state of its device. 1633 @discussion A power managed driver must override <code>setPowerState</code> to take part in system power management. After a driver is registered with power management, the system uses <code>setPowerState</code> to power the device off and on for system sleep and wake. 1634 Calls to @link PMinit PMinit@/link and @link registerPowerDriver registerPowerDriver@/link enable power management to change a device's power state using <code>setPowerState</code>. <code>setPowerState</code> is called in a clean and separate thread context. 1635 @param powerStateOrdinal The number in the power state array of the state the driver is being instructed to switch to. 1636 @param whatDevice A pointer to the power management object which registered to manage power for this device. In most cases, <code>whatDevice</code> will be equal to your driver's own <code>this</code> pointer. 1637 @result The driver must return <code>IOPMAckImplied</code> if it has complied with the request when it returns. Otherwise if it has started the process of changing power state but not finished it, the driver should return a number of microseconds which is an upper limit of the time it will need to finish. Then, when it has completed the power switch, it should call @link acknowledgeSetPowerState acknowledgeSetPowerState@/link. */ 1638 1639 virtual IOReturn setPowerState( 1640 unsigned long powerStateOrdinal, 1641 IOService * whatDevice ); 1642 1643#ifndef __LP64__ 1644/*! @function clampPowerOn 1645 @abstract Deprecated. Do not use. */ 1646 1647 virtual void clampPowerOn( unsigned long duration ); 1648#endif 1649 1650/*! @function maxCapabilityForDomainState 1651 @abstract Determines a driver's highest power state possible for a given power domain state. 1652 @discussion This happens when the power domain is changing state and power management needs to determine which state the device is capable of in the new domain state. 1653 Most drivers do not need to implement this method, and can rely upon the default IOService implementation. The IOService implementation scans the power state array looking for the highest state whose <code>inputPowerRequirement</code> field exactly matches the value of the <code>domainState</code> parameter. If more intelligent determination is required, the driver itself should implement the method and override the superclass's implementation. 1654 @param domainState Flags that describe the character of "domain power"; they represent the <code>outputPowerCharacter</code> field of a state in the power domain's power state array. 1655 @result A state number. */ 1656 1657 virtual unsigned long maxCapabilityForDomainState( IOPMPowerFlags domainState ); 1658 1659/*! @function initialPowerStateForDomainState 1660 @abstract Determines which power state a device is in, given the current power domain state. 1661 @discussion Power management calls this method once, when the driver is initializing power management. 1662 Most drivers do not need to implement this method, and can rely upon the default IOService implementation. The IOService implementation scans the power state array looking for the highest state whose <code>inputPowerRequirement</code> field exactly matches the value of the <code>domainState</code> parameter. If more intelligent determination is required, the power managed driver should implement the method and override the superclass's implementation. 1663 @param domainState Flags that describe the character of "domain power"; they represent the <code>outputPowerCharacter</code> field of a state in the power domain's power state array. 1664 @result A state number. */ 1665 1666 virtual unsigned long initialPowerStateForDomainState( IOPMPowerFlags domainState ); 1667 1668/*! @function powerStateForDomainState 1669 @abstract Determines what power state the device would be in for a given power domain state. 1670 @discussion Power management calls a driver with this method to find out what power state the device would be in for a given power domain state. This happens when the power domain is changing state and power management needs to determine the effect of the change. 1671 Most drivers do not need to implement this method, and can rely upon the default IOService implementation. The IOService implementation scans the power state array looking for the highest state whose <code>inputPowerRequirement</code> field exactly matches the value of the <code>domainState</code> parameter. If more intelligent determination is required, the power managed driver should implement the method and override the superclass's implementation. 1672 @param domainState Flags that describe the character of "domain power"; they represent the <code>outputPowerCharacter</code> field of a state in the power domain's power state array. 1673 @result A state number. */ 1674 1675 virtual unsigned long powerStateForDomainState( IOPMPowerFlags domainState ); 1676 1677/*! @function powerStateWillChangeTo 1678 @abstract Informs interested parties that a device is about to change its power state. 1679 @discussion Power management informs interested parties that a device is about to change to a different power state. Interested parties are those that have registered for this notification via @link registerInterestedDriver registerInterestedDriver@/link. If you have called <code>registerInterestedDriver</code> on a power managed driver, you must implement <code>powerStateWillChangeTo</code> and @link powerStateDidChangeTo powerStateDidChangeTo@/link to receive the notifications. 1680 <code>powerStateWillChangeTo</code> is called in a clean and separate thread context. <code>powerStateWillChangeTo</code> is called before a power state transition takes place; <code>powerStateDidChangeTo</code> is called after the transition has completed. 1681 @param capabilities Flags that describe the capability of the device in the new power state (they come from the <code>capabilityFlags</code> field of the new state in the power state array). 1682 @param stateNumber The number of the state in the state array that the device is switching to. 1683 @param whatDevice A pointer to the driver that is changing. It can be used by a driver that is receiving power state change notifications for multiple devices to distinguish between them. 1684 @result The driver returns <code>IOPMAckImplied</code> if it has prepared for the power change when it returns. If it has started preparing but not finished, it should return a number of microseconds which is an upper limit of the time it will need to finish preparing. Then, when it has completed its preparations, it should call @link acknowledgePowerChange acknowledgePowerChange@/link. */ 1685 1686 virtual IOReturn powerStateWillChangeTo( 1687 IOPMPowerFlags capabilities, 1688 unsigned long stateNumber, 1689 IOService * whatDevice ); 1690 1691/*! @function powerStateDidChangeTo 1692 @abstract Informs interested parties that a device has changed to a different power state. 1693 @discussion Power management informs interested parties that a device has changed to a different power state. Interested parties are those that have registered for this notification via @link registerInterestedDriver registerInterestedDriver@/link. If you have called <code>registerInterestedDriver</code> on a power managed driver, you must implemnt @link powerStateWillChangeTo powerStateWillChangeTo@/link and <code>powerStateDidChangeTo</code> to receive the notifications. 1694 <code>powerStateDidChangeTo</code> is called in a clean and separate thread context. <code>powerStateWillChangeTo</code> is called before a power state transition takes place; <code>powerStateDidChangeTo</code> is called after the transition has completed. 1695 @param capabilities Flags that describe the capability of the device in the new power state (they come from the <code>capabilityFlags</code> field of the new state in the power state array). 1696 @param stateNumber The number of the state in the state array that the device is switching to. 1697 @param whatDevice A pointer to the driver that is changing. It can be used by a driver that is receiving power state change notifications for multiple devices to distinguish between them. 1698 @result The driver returns <code>IOPMAckImplied</code> if it has prepared for the power change when it returns. If it has started preparing but not finished, it should return a number of microseconds which is an upper limit of the time it will need to finish preparing. Then, when it has completed its preparations, it should call @link acknowledgePowerChange acknowledgePowerChange@/link. */ 1699 1700 virtual IOReturn powerStateDidChangeTo( 1701 IOPMPowerFlags capabilities, 1702 unsigned long stateNumber, 1703 IOService * whatDevice ); 1704 1705#ifndef __LP64__ 1706/*! @function didYouWakeSystem 1707 @abstract Asks a driver if its device is the one that just woke the system from sleep. 1708 @availability Deprecated in Mac OS X version 10.6. 1709 @discussion Power management calls a power managed driver with this method to ask if its device is the one that just woke the system from sleep. If a device is capable of waking the system from sleep, its driver should implement <code>didYouWakeSystem</code> and return <code>true</code> if its device was responsible for waking the system. 1710 @result <code>true</code> if the driver's device woke the system and <code>false</code> otherwise. */ 1711 1712 virtual bool didYouWakeSystem( void ) 1713 APPLE_KEXT_DEPRECATED; 1714 1715/*! @function newTemperature 1716 @abstract Tells a power managed driver that the temperature in the thermal zone has changed. 1717 @discussion This call is unused by power management. It is not intended to be called or overridden. */ 1718 1719 virtual IOReturn newTemperature( long currentTemp, IOService * whichZone ) 1720 APPLE_KEXT_DEPRECATED; 1721#endif 1722 1723 virtual bool askChangeDown( unsigned long ); 1724 virtual bool tellChangeDown( unsigned long ); 1725 virtual void tellNoChangeDown ( unsigned long ); 1726 virtual void tellChangeUp( unsigned long ); 1727 virtual IOReturn allowPowerChange( unsigned long refcon ); 1728 virtual IOReturn cancelPowerChange( unsigned long refcon ); 1729 1730protected: 1731/*! @function changePowerStateToPriv 1732 @abstract Tells a driver's superclass to change the power state of its device. 1733 @discussion A driver uses this method to tell its superclass to change the power state of the device. This is the recommended way to change the power state of a device. 1734 Three things affect driver power state: @link changePowerStateTo changePowerStateTo@/link, <code>changePowerStateToPriv</code>, and the desires of the driver's power plane children. Power management puts the device into the maximum state governed by those three entities. 1735 Drivers may eliminate the influence of the <code>changePowerStateTo</code> method on power state one of two ways. See @link powerOverrideOnPriv powerOverrideOnPriv@/link to ignore the method's influence, or call <code>changePowerStateTo(0)</code> in the driver's <code>start</code> routine to remove the <code>changePowerStateTo</code> method's power request. 1736 @param ordinal The number of the desired power state in the power state array. 1737 @result A return code that can be ignored by the caller. */ 1738 1739 IOReturn changePowerStateToPriv( unsigned long ordinal ); 1740 1741/*! @function powerOverrideOnPriv 1742 @abstract Allows a driver to ignore its children's power management requests and only use changePowerStateToPriv to define its own power state. 1743 @discussion Power management normally keeps a device at the highest state required by its requests via @link changePowerStateTo changePowerStateTo@/link, @link changePowerStateToPriv changePowerStateToPriv@/link, and its children. However, a driver may ensure a lower power state than otherwise required by itself and its children using <code>powerOverrideOnPriv</code>. When the override is on, power management keeps the device's power state in the state specified by <code>changePowerStateToPriv</code>. Turning on the override will initiate a power change if the driver's <code>changePowerStateToPriv</code> desired power state is different from the maximum of the <code>changePowerStateTo</code> desired power state and the children's desires. 1744 @result A return code that can be ignored by the caller. */ 1745 1746 IOReturn powerOverrideOnPriv( void ); 1747 1748/*! @function powerOverrideOffPriv 1749 @abstract Allows a driver to disable a power override. 1750 @discussion When a driver has enabled an override via @link powerOverrideOnPriv powerOverrideOnPriv@/link, it can disable it again by calling this method in its superclass. Disabling the override reverts to the default algorithm for determining a device's power state. The superclass will now keep the device at the highest state required by <code>changePowerStateTo</code>, <code>changePowerStateToPriv</code>, and its children. Turning off the override will initiate a power change if the driver's desired power state is different from the maximum of the power managed driver's desire and the children's desires. 1751 @result A return code that can be ignored by the caller. */ 1752 1753 IOReturn powerOverrideOffPriv( void ); 1754 1755/*! @function powerChangeDone 1756 @abstract Tells a driver when a power state change is complete. 1757 @discussion Power management uses this method to inform a driver when a power change is completely done, when all interested parties have acknowledged the @link powerStateDidChangeTo powerStateDidChangeTo@/link call. The default implementation of this method is null; the method is meant to be overridden by subclassed power managed drivers. A driver should use this method to find out if a power change it initiated is complete. 1758 @param stateNumber The number of the state in the state array that the device has switched from. */ 1759 1760 virtual void powerChangeDone( unsigned long stateNumber ); 1761#ifdef XNU_KERNEL_PRIVATE 1762 /* Power management internals */ 1763public: 1764 void idleTimerExpired( void ); 1765 void settleTimerExpired( void ); 1766 IOReturn synchronizePowerTree( IOOptionBits options = 0, IOService * notifyRoot = 0 ); 1767 bool assertPMDriverCall( IOPMDriverCallEntry * callEntry, IOOptionBits options = 0, IOPMinformee * inform = 0 ); 1768 void deassertPMDriverCall( IOPMDriverCallEntry * callEntry ); 1769 IOReturn changePowerStateWithOverrideTo( IOPMPowerStateIndex ordinal, IOPMRequestTag tag ); 1770 IOReturn changePowerStateForRootDomain( IOPMPowerStateIndex ordinal ); 1771 IOReturn setIgnoreIdleTimer( bool ignore ); 1772 uint32_t getPowerStateForClient( const OSSymbol * client ); 1773 static const char * getIOMessageString( uint32_t msg ); 1774 static void setAdvisoryTickleEnable( bool enable ); 1775 void reset_watchdog_timer( void ); 1776 void start_watchdog_timer ( void ); 1777 bool stop_watchdog_timer ( void ); 1778 1779#ifdef __LP64__ 1780 static IOWorkLoop * getPMworkloop( void ); 1781#endif 1782 1783protected: 1784 bool tellClientsWithResponse( int messageType ); 1785 void tellClients( int messageType ); 1786 void PMDebug( uint32_t event, uintptr_t param1, uintptr_t param2 ); 1787 1788private: 1789#ifndef __LP64__ 1790 void ack_timer_ticked ( void ); 1791 IOReturn serializedAllowPowerChange2 ( unsigned long ); 1792 IOReturn serializedCancelPowerChange2 ( unsigned long ); 1793 IOReturn powerDomainWillChangeTo( IOPMPowerFlags, IOPowerConnection * ); 1794 IOReturn powerDomainDidChangeTo( IOPMPowerFlags, IOPowerConnection * ); 1795#endif 1796 void PMfree( void ); 1797 bool tellChangeDown1 ( unsigned long ); 1798 bool tellChangeDown2 ( unsigned long ); 1799 IOReturn startPowerChange( IOPMPowerChangeFlags, IOPMPowerStateIndex, IOPMPowerFlags, IOPowerConnection *, IOPMPowerFlags ); 1800 void setParentInfo ( IOPMPowerFlags, IOPowerConnection *, bool ); 1801 IOReturn notifyAll ( uint32_t nextMS ); 1802 bool notifyChild ( IOPowerConnection * child ); 1803 IOPMPowerStateIndex getPowerStateForDomainFlags( IOPMPowerFlags flags ); 1804 1805 // power change initiated by driver 1806 void OurChangeStart( void ); 1807 void OurSyncStart ( void ); 1808 void OurChangeTellClientsPowerDown ( void ); 1809 void OurChangeTellUserPMPolicyPowerDown ( void ); 1810 void OurChangeTellPriorityClientsPowerDown ( void ); 1811 void OurChangeTellCapabilityWillChange ( void ); 1812 void OurChangeNotifyInterestedDriversWillChange ( void ); 1813 void OurChangeSetPowerState ( void ); 1814 void OurChangeWaitForPowerSettle ( void ); 1815 void OurChangeNotifyInterestedDriversDidChange ( void ); 1816 void OurChangeTellCapabilityDidChange ( void ); 1817 void OurChangeFinish ( void ); 1818 1819 // downward power change initiated by a power parent 1820 IOReturn ParentChangeStart( void ); 1821 void ParentChangeTellPriorityClientsPowerDown ( void ); 1822 void ParentChangeTellCapabilityWillChange ( void ); 1823 void ParentChangeNotifyInterestedDriversWillChange ( void ); 1824 void ParentChangeSetPowerState ( void ); 1825 void ParentChangeWaitForPowerSettle ( void ); 1826 void ParentChangeNotifyInterestedDriversDidChange ( void ); 1827 void ParentChangeTellCapabilityDidChange ( void ); 1828 void ParentChangeAcknowledgePowerChange ( void ); 1829 void ParentChangeRootChangeDown( void ); 1830 1831 void all_done ( void ); 1832 void start_ack_timer ( void ); 1833 void stop_ack_timer ( void ); 1834 void start_ack_timer( UInt32 value, UInt32 scale ); 1835 void startSettleTimer( void ); 1836 bool checkForDone ( void ); 1837 bool responseValid ( uint32_t x, int pid ); 1838 void computeDesiredState( unsigned long tempDesire, bool computeOnly ); 1839 void trackSystemSleepPreventers( IOPMPowerStateIndex, IOPMPowerStateIndex, IOPMPowerChangeFlags ); 1840 void tellSystemCapabilityChange( uint32_t nextMS ); 1841 void restartIdleTimer( void ); 1842 1843 static void ack_timer_expired( thread_call_param_t, thread_call_param_t ); 1844 static void watchdog_timer_expired ( thread_call_param_t arg0, thread_call_param_t arg1 ); 1845 static IOReturn actionAckTimerExpired(OSObject *, void *, void *, void *, void * ); 1846 static IOReturn watchdog_timer_expired ( OSObject *, void *, void *, void *, void * ); 1847 1848 static IOReturn actionDriverCalloutDone(OSObject *, void *, void *, void *, void * ); 1849 static IOPMRequest * acquirePMRequest( IOService * target, IOOptionBits type, IOPMRequest * active = 0 ); 1850 static void releasePMRequest( IOPMRequest * request ); 1851 static void pmDriverCallout( IOService * from ); 1852 static void pmTellAppWithResponse( OSObject * object, void * context ); 1853 static void pmTellClientWithResponse( OSObject * object, void * context ); 1854 static void pmTellCapabilityAppWithResponse ( OSObject * object, void * arg ); 1855 static void pmTellCapabilityClientWithResponse( OSObject * object, void * arg ); 1856 bool ackTimerTick( void ); 1857 void addPowerChild1( IOPMRequest * request ); 1858 void addPowerChild2( IOPMRequest * request ); 1859 void addPowerChild3( IOPMRequest * request ); 1860 void adjustPowerState( uint32_t clamp = 0 ); 1861 void handlePMstop( IOPMRequest * request ); 1862 void handleRegisterPowerDriver( IOPMRequest * request ); 1863 bool handleAcknowledgePowerChange( IOPMRequest * request ); 1864 void handlePowerDomainWillChangeTo( IOPMRequest * request ); 1865 void handlePowerDomainDidChangeTo( IOPMRequest * request ); 1866 void handleRequestPowerState( IOPMRequest * request ); 1867 void handlePowerOverrideChanged( IOPMRequest * request ); 1868 void handleActivityTickle( IOPMRequest * request ); 1869 void handleInterestChanged( IOPMRequest * request ); 1870 void handleSynchronizePowerTree( IOPMRequest * request ); 1871 void submitPMRequest( IOPMRequest * request ); 1872 void submitPMRequest( IOPMRequest ** request, IOItemCount count ); 1873 void executePMRequest( IOPMRequest * request ); 1874 bool servicePMRequest( IOPMRequest * request, IOPMWorkQueue * queue ); 1875 bool retirePMRequest( IOPMRequest * request, IOPMWorkQueue * queue ); 1876 bool servicePMRequestQueue( IOPMRequest * request, IOPMRequestQueue * queue ); 1877 bool servicePMReplyQueue( IOPMRequest * request, IOPMRequestQueue * queue ); 1878 bool servicePMFreeQueue( IOPMRequest * request, IOPMCompletionQueue * queue ); 1879 bool notifyInterestedDrivers( void ); 1880 void notifyInterestedDriversDone( void ); 1881 bool notifyControllingDriver( void ); 1882 void notifyControllingDriverDone( void ); 1883 void driverSetPowerState( void ); 1884 void driverInformPowerChange( void ); 1885 bool isPMBlocked( IOPMRequest * request, int count ); 1886 void notifyChildren( void ); 1887 void notifyChildrenOrdered( void ); 1888 void notifyChildrenDelayed( void ); 1889 void notifyRootDomain( void ); 1890 void notifyRootDomainDone( void ); 1891 void cleanClientResponses ( bool logErrors ); 1892 void updatePowerClient( const OSSymbol * client, uint32_t powerState ); 1893 void removePowerClient( const OSSymbol * client ); 1894 IOReturn requestPowerState( const OSSymbol * client, uint32_t state ); 1895 IOReturn requestDomainPower( IOPMPowerStateIndex ourPowerState, IOOptionBits options = 0 ); 1896 IOReturn configurePowerStatesReport( IOReportConfigureAction action, void *result ); 1897 IOReturn updatePowerStatesReport( IOReportConfigureAction action, void *result, void *destination ); 1898 IOReturn configureSimplePowerReport(IOReportConfigureAction action, void *result ); 1899 IOReturn updateSimplePowerReport( IOReportConfigureAction action, void *result, void *destination ); 1900 void waitForPMDriverCall( IOService * target = 0 ); 1901#endif /* XNU_KERNEL_PRIVATE */ 1902}; 1903 1904#endif /* ! _IOKIT_IOSERVICE_H */ 1905