1 /* 2 * Copyright (c) 1998-2020 Apple 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 #include <DriverKit/IOService.h> 57 #include <libkern/c++/OSPtr.h> 58 59 #if __cplusplus >= 201703L 60 extern "C++" { 61 #include <libkern/c++/OSSharedPtr.h> 62 } 63 #endif 64 65 extern "C" { 66 #include <kern/thread_call.h> 67 } 68 69 70 #ifndef UINT64_MAX 71 #define UINT64_MAX 18446744073709551615ULL 72 #endif 73 74 75 enum { 76 kIODefaultProbeScore = 0 77 }; 78 79 // masks for getState() 80 enum { 81 kIOServiceInactiveState = 0x00000001, 82 kIOServiceRegisteredState = 0x00000002, 83 kIOServiceMatchedState = 0x00000004, 84 kIOServiceFirstPublishState = 0x00000008, 85 kIOServiceFirstMatchState = 0x00000010, 86 kIOServiceReservedMatchState = 0x80000000, 87 #if XNU_KERNEL_PRIVATE 88 kIOServiceUserInvisibleMatchState = kIOServiceReservedMatchState, 89 #endif /* XNU_KERNEL_PRIVATE */ 90 }; 91 92 enum { 93 // options for registerService() 94 kIOServiceExclusive = 0x00000001, 95 96 // options for terminate() 97 kIOServiceRequired = 0x00000001, 98 kIOServiceTerminate = 0x00000004, 99 kIOServiceTerminateWithRematch = 0x00000010, 100 kIOServiceTerminateWithRematchCurrentDext = 0x00000020, 101 102 // options for registerService() & terminate() 103 kIOServiceSynchronous = 0x00000002, 104 // options for registerService() 105 kIOServiceAsynchronous = 0x00000008 106 }; 107 108 // options for open() 109 enum { 110 kIOServiceSeize = 0x00000001, 111 kIOServiceFamilyOpenOptions = 0xffff0000 112 }; 113 114 // options for close() 115 enum { 116 kIOServiceFamilyCloseOptions = 0xffff0000 117 }; 118 119 typedef void * IONotificationRef; 120 121 extern const IORegistryPlane * gIOServicePlane; 122 extern const IORegistryPlane * gIOPowerPlane; 123 124 extern const OSSymbol * gIOResourcesKey; 125 extern const OSSymbol * gIOResourceMatchKey; 126 extern const OSSymbol * gIOResourceMatchedKey; 127 extern const OSSymbol * gIOResourceIOKitKey; 128 129 extern const OSSymbol * gIOProviderClassKey; 130 extern const OSSymbol * gIONameMatchKey; 131 extern const OSSymbol * gIONameMatchedKey; 132 extern const OSSymbol * gIOPropertyMatchKey; 133 extern const OSSymbol * gIOPropertyExistsMatchKey; 134 extern const OSSymbol * gIOLocationMatchKey; 135 extern const OSSymbol * gIOParentMatchKey; 136 extern const OSSymbol * gIOPathMatchKey; 137 extern const OSSymbol * gIOMatchCategoryKey; 138 extern const OSSymbol * gIODefaultMatchCategoryKey; 139 extern const OSSymbol * gIOMatchedServiceCountKey; 140 extern const OSSymbol * gIOMatchedPersonalityKey; 141 extern const OSSymbol * gIORematchPersonalityKey; 142 extern const OSSymbol * gIORematchCountKey; 143 extern const OSSymbol * gIODEXTMatchCountKey; 144 145 extern const OSSymbol * gIOUserClientClassKey; 146 147 extern const OSSymbol * gIOUserClassKey; 148 extern const OSSymbol * gIOUserClassesKey; 149 extern const OSSymbol * gIOUserServerClassKey; 150 extern const OSSymbol * gIOUserServerNameKey; 151 extern const OSSymbol * gIOUserServerTagKey; 152 extern const OSSymbol * gIOUserUserClientKey; 153 extern const OSSymbol * gIOAssociatedServicesKey; 154 extern const OSSymbol * gIOUserServerPreserveUserspaceRebootKey; 155 156 extern const OSSymbol * gIOKitDebugKey; 157 extern const OSSymbol * gIOServiceKey; 158 159 extern const OSSymbol * gIOCommandPoolSizeKey; 160 161 extern const OSSymbol * gIOPublishNotification; 162 extern const OSSymbol * gIOFirstPublishNotification; 163 extern const OSSymbol * gIOMatchedNotification; 164 extern const OSSymbol * gIOFirstMatchNotification; 165 extern const OSSymbol * gIOTerminatedNotification; 166 extern const OSSymbol * gIOWillTerminateNotification; 167 168 extern const OSSymbol * gIOGeneralInterest; 169 extern const OSSymbol * gIOBusyInterest; 170 extern const OSSymbol * gIOOpenInterest; 171 extern const OSSymbol * gIOAppPowerStateInterest; 172 extern const OSSymbol * gIOPriorityPowerStateInterest; 173 extern const OSSymbol * gIOConsoleSecurityInterest; 174 175 extern const OSSymbol * gIODeviceMemoryKey; 176 extern const OSSymbol * gIOInterruptControllersKey; 177 extern const OSSymbol * gIOInterruptSpecifiersKey; 178 179 extern const OSSymbol * gIOSupportedPropertiesKey; 180 extern const OSSymbol * gIOUserServicePropertiesKey; 181 extern const OSSymbol * gIOCompatibilityMatchKey; 182 extern const OSSymbol * gIOCompatibilityPropertiesKey; 183 extern const OSSymbol * gIOPathKey; 184 185 extern const OSSymbol * gIOBSDKey; 186 extern const OSSymbol * gIOBSDNameKey; 187 extern const OSSymbol * gIOBSDMajorKey; 188 extern const OSSymbol * gIOBSDMinorKey; 189 extern const OSSymbol * gIOBSDUnitKey; 190 191 extern const OSSymbol * gIOUserClientEntitlementsKey; 192 extern const OSSymbol * gIODriverKitEntitlementKey; 193 extern const OSSymbol * gIOServiceDEXTEntitlementsKey; 194 extern const OSSymbol * gIODriverKitUserClientEntitlementsKey; 195 extern const OSSymbol * gIODriverKitUserClientEntitlementAllowAnyKey; 196 extern const OSSymbol * gIODriverKitRequiredEntitlementsKey; 197 extern const OSSymbol * gIODriverKitTestDriverEntitlementKey; 198 extern const OSSymbol * gIODriverKitUserClientEntitlementCommunicatesWithDriversKey; 199 extern const OSSymbol * gIODriverKitUserClientEntitlementAllowThirdPartyUserClientsKey; 200 extern const OSSymbol * gIOMatchDeferKey; 201 202 extern const OSSymbol * gIOAllCPUInitializedKey; 203 204 #if XNU_KERNEL_PRIVATE && !defined(IOServiceTrace) 205 206 #include <IOKit/IOTimeStamp.h> 207 #if (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD) 208 #define IOServiceTrace(csc, a, b, c, d) do { \ 209 if(kIOTraceIOService & gIOKitTrace) { \ 210 KERNEL_DEBUG_CONSTANT(IODBG_IOSERVICE(csc), a, b, c, d, 0); \ 211 } \ 212 } while(0) 213 #else /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD) */ 214 #define IOServiceTrace(csc, a, b, c, d) do { \ 215 (void)a; \ 216 (void)b; \ 217 (void)c; \ 218 (void)d; \ 219 } while (0) 220 #endif /* (KDEBUG_LEVEL >= KDEBUG_LEVEL_STANDARD) */ 221 222 #endif // XNU_KERNEL_PRIVATE && !IOServiceTrace 223 224 extern SInt32 IOServiceOrdering( const OSMetaClassBase * inObj1, const OSMetaClassBase * inObj2, void * ref ); 225 226 typedef void (*IOInterruptAction)( OSObject * target, void * refCon, 227 IOService * nub, int source ); 228 229 #ifdef __BLOCKS__ 230 typedef void (^IOInterruptActionBlock)(IOService * nub, int source); 231 typedef kern_return_t (^IOStateNotificationHandler)(void); 232 #endif /* __BLOCKS__ */ 233 234 typedef void * IOStateNotificationListenerRef; 235 class IOStateNotificationItem; 236 237 /*! @typedef IOServiceNotificationHandler 238 * @param target Reference supplied when the notification was registered. 239 * @param refCon Reference constant supplied when the notification was registered. 240 * @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. */ 241 242 typedef bool (*IOServiceNotificationHandler)( void * target, void * refCon, 243 IOService * newService ); 244 245 typedef bool (*IOServiceMatchingNotificationHandler)( void * target, void * refCon, 246 IOService * newService, 247 IONotifier * notifier ); 248 249 #ifdef __BLOCKS__ 250 typedef bool (^IOServiceMatchingNotificationHandlerBlock)(IOService * newService, 251 IONotifier * notifier ); 252 #endif /* __BLOCKS__ */ 253 254 255 /*! @typedef IOServiceInterestHandler 256 * @param target Reference supplied when the notification was registered. 257 * @param refCon Reference constant supplied when the notification was registered. 258 * @param messageType Type of the message - IOKit defined in IOKit/IOMessage.h or family specific. 259 * @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. 260 * @param messageArgument An argument for message, dependent on its type. 261 * @param argSize Non zero if the argument represents a struct of that size, used when delivering messages outside the kernel. */ 262 263 typedef IOReturn (*IOServiceInterestHandler)( void * target, void * refCon, 264 UInt32 messageType, IOService * provider, 265 void * messageArgument, vm_size_t argSize ); 266 267 #ifdef __BLOCKS__ 268 typedef IOReturn (^IOServiceInterestHandlerBlock)( uint32_t messageType, IOService * provider, 269 void * messageArgument, size_t argSize ); 270 #endif /* __BLOCKS__ */ 271 272 typedef void (*IOServiceApplierFunction)(IOService * service, void * context); 273 typedef void (*OSObjectApplierFunction)(OSObject * object, void * context); 274 #ifdef __BLOCKS__ 275 typedef void (^IOServiceApplierBlock)(IOService * service); 276 typedef void (^OSObjectApplierBlock)(OSObject * object); 277 #endif /* __BLOCKS__ */ 278 279 280 class IOUserClient; 281 class IOPlatformExpert; 282 class IOUserServerCheckInToken; 283 284 /*! @class IOService 285 * @abstract The base class for most I/O Kit families, devices, and drivers. 286 * @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. 287 * 288 * Types 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. 289 * 290 * Matching dictionaries are associated with IOService classes by the catalogue, as driver property tables, and also supplied by clients of the notification APIs. 291 * 292 * IOService 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). 293 * 294 * <br><br>Driver Instantiation by IOService<br><br> 295 * 296 * Drivers 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. 297 * 298 * When 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. 299 * 300 * Each entry in the list is then processed in order - for notifications, the notification is delivered, for driver property tables a lot more happens. 301 * 302 * The 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). 303 * 304 * When 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. 305 * 306 * For 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. 307 * 308 * The 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. 309 * 310 * After the drivers have all synchronously been started, the installed "matched" notifications that match the registered IOService are delivered. 311 * 312 * <br><br>Properties used by IOService<br><br> 313 * 314 * <code>kIOClassKey, extern const OSSymbol * gIOClassKey, "IOClass"</code> 315 * <br> 316 * <br> 317 * Class of the driver to instantiate on matching providers. 318 * <br> 319 * <br> 320 * <code>kIOProviderClassKey, extern const OSSymbol * gIOProviderClassKey, "IOProviderClass"</code> 321 * <br> 322 * <br> 323 * Class of the provider(s) to be considered for matching, checked with OSDynamicCast so subclasses will also match. 324 * <br> 325 * <br> 326 * <code>kIOProbeScoreKey, extern const OSSymbol * gIOProbeScoreKey, "IOProbeScore"</code> 327 * <br> 328 * <br> 329 * The probe score initially used to order multiple matching drivers. 330 * <br> 331 * <br> 332 * <code>kIOMatchCategoryKey, extern const OSSymbol * gIOMatchCategoryKey, "IOMatchCategory"</code> 333 * <br> 334 * <br> 335 * A 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. 336 * <br> 337 * <br> 338 * <code>kIONameMatchKey, extern const OSSymbol * gIONameMatchKey, "IONameMatch"</code> 339 * <br> 340 * A 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. 341 * <br> 342 * Examples 343 * <pre> 344 * @textblock 345 * <key>IONameMatch</key> 346 * <string>pci106b,7</string> 347 * @/textblock 348 * </pre> 349 * 350 * For a list of possible matching names, a serialized array of strings should used, eg. 351 * <pre> 352 * @textblock 353 * <key>IONameMatch</key> 354 * <array> 355 * <string>APPL,happy16</string> 356 * <string>pci106b,7</string> 357 * </array> 358 * @/textblock 359 * </pre> 360 * 361 * <br> 362 * <code>kIONameMatchedKey, extern const OSSymbol * gIONameMatchedKey, "IONameMatched"</code> 363 * <br> 364 * The 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. 365 * <br> 366 * <br> 367 * <code>kIOPropertyMatchKey, extern const OSSymbol * gIOPropertyMatchKey, "IOPropertyMatch"</code> 368 * <br> 369 * A dictionary of properties that each must exist in the matching IOService and compare successfully with the <code>isEqualTo</code> method. 370 * 371 * <pre> 372 * @textblock 373 * <key>IOPropertyMatch</key> 374 * <dictionary> 375 * <key>APPL,happy16</key> 376 * <string>APPL,meek8</string> 377 * </dictionary> 378 * @/textblock 379 * </pre> 380 * 381 * <br> 382 * <code>kIOUserClientClassKey, extern const OSSymbol * gIOUserClientClassKey, "IOUserClientClass"</code> 383 * <br> 384 * The 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. 385 * <br> 386 * <br> 387 * <code>kIOKitDebugKey, extern const OSSymbol * gIOKitDebugKey, "IOKitDebug"</code> 388 * <br> 389 * Set some debug flags for logging the driver loading process. Flags are defined in <code>IOKit/IOKitDebug.h</code>, but <code>65535</code> works well.*/ 390 391 struct IOInterruptAccountingData; 392 struct IOInterruptAccountingReporter; 393 struct OSObjectUserVars; 394 struct IOServiceStateChangeVars; 395 struct IOInterruptSourcePrivate; 396 397 class IOService : public IORegistryEntry 398 { 399 OSDeclareDefaultStructorsWithDispatch(IOService); 400 401 #if XNU_KERNEL_PRIVATE 402 public: 403 #else 404 protected: 405 #endif /* XNU_KERNEL_PRIVATE */ 406 /*! @struct ExpansionData 407 * @discussion This structure will be used to expand the capablilties of this class in the future. 408 */ 409 #if XNU_KERNEL_PRIVATE 410 struct ExpansionData { 411 uint64_t authorizationID; 412 /* 413 * Variables associated with interrupt accounting. Consists of an array 414 * (that pairs reporters with opaque "statistics" objects), the count for 415 * the array, and a lock to guard both of the former variables. The lock 416 * is necessary as IOReporting will not update reports in a manner that is 417 * synchonized with the service (i.e, on a workloop). 418 */ 419 IOLock interruptStatisticsLock; 420 IOInterruptAccountingReporter * interruptStatisticsArray; 421 int interruptStatisticsArrayCount; 422 423 OSObjectUserVars * uvars; 424 IOServiceStateChangeVars * svars; 425 426 IOInterruptSourcePrivate * interruptSourcesPrivate; 427 }; 428 #else 429 struct ExpansionData; 430 #endif 431 432 /*! @var reserved 433 * Reserved for future use. (Internal use only) */ 434 APPLE_KEXT_WSHADOW_PUSH; 435 ExpansionData * reserved; 436 APPLE_KEXT_WSHADOW_POP; 437 438 private: 439 IOService * __provider; 440 SInt32 __providerGeneration; 441 IOService * __owner; 442 IOOptionBits __state[2]; 443 uint64_t __timeBusy; 444 uint64_t __accumBusy; 445 IOServicePM * pwrMgt; 446 447 protected: 448 // TRUE once PMinit has been called 449 bool initialized; 450 451 public: 452 // DEPRECATED 453 void * pm_vars; 454 455 public: 456 /* methods available in Mac OS X 10.1 or later */ 457 /*! @function requestTerminate 458 * @abstract Passes a termination up the stack. 459 * @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. 460 * @param provider The terminated provider of this object. 461 * @param options Options originally passed to terminate, plus <code>kIOServiceRecursing</code>. 462 * @result <code>true</code> if this object should be terminated now that its provider has been. */ 463 464 virtual bool requestTerminate( IOService * provider, IOOptionBits options ); 465 466 /*! @function willTerminate 467 * @abstract Passes a termination up the stack. 468 * @discussion Notification that a provider has been terminated, sent before recursing up the stack, in root-to-leaf order. 469 * @param provider The terminated provider of this object. 470 * @param options Options originally passed to terminate. 471 * @result <code>true</code>. */ 472 473 virtual bool willTerminate( IOService * provider, IOOptionBits options ); 474 475 /*! @function didTerminate 476 * @abstract Passes a termination up the stack. 477 * @discussion Notification that a provider has been terminated, sent after recursing up the stack, in leaf-to-root order. 478 * @param provider The terminated provider of this object. 479 * @param options Options originally passed to terminate. 480 * @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>. 481 * @result <code>true</code>. */ 482 483 virtual bool didTerminate( IOService * provider, IOOptionBits options, bool * defer ); 484 485 /*! @function nextIdleTimeout 486 * @availability Mac OS X v10.4 and later 487 * @abstract Allows subclasses to customize idle power management behavior. 488 * @discussion Returns the next time that the device should idle into its next lower power state. Subclasses may override for custom idle behavior. 489 * 490 * A power managed driver might override this method to provide a more sophisticated idle power off algorithm than the one defined by power management. 491 * @param currentTime The current time 492 * @param lastActivity The time of last activity on this device 493 * @param powerState The device's current power state. 494 * @result Returns the next time the device should idle off (in seconds, relative to the current time). */ 495 496 virtual SInt32 nextIdleTimeout(AbsoluteTime currentTime, 497 AbsoluteTime lastActivity, unsigned int powerState); 498 499 /*! @function systemWillShutdown 500 * @availability Mac OS X v10.5 and later 501 * @abstract Notifies members of the power plane of system shutdown and restart. 502 * @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. 503 * 504 * 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. 505 * @param specifier <code>kIOMessageSystemWillPowerOff</code> or <code>kIOMessageSystemWillRestart</code>. */ 506 507 virtual void systemWillShutdown( IOOptionBits specifier ); 508 509 /*! @function copyClientWithCategory 510 * @availability Mac OS X v10.6 and later 511 * @param category An OSSymbol corresponding to an IOMatchCategory matching property. 512 * @result Returns a reference to the IOService child with the given category. The result should be released by the caller. 513 */ 514 515 virtual IOService * copyClientWithCategory( const OSSymbol * category ); 516 517 public: 518 /*! @function configureReport 519 * @abstract configure IOReporting channels 520 * @availability SPI on OS X v10.9 / iOS 7 and later 521 * 522 * @param channels - channels to configure 523 * @param action - enable/disable/size, etc 524 * @param result - action-specific returned value 525 * @param destination - action-specific default destination 526 */ 527 virtual IOReturn configureReport(IOReportChannelList *channels, 528 IOReportConfigureAction action, 529 void *result, 530 void *destination); 531 532 /*! @function updateReport 533 * @abstract request current data for the specified channels 534 * @availability SPI on OS X 10.9 / iOS 7 and later 535 * 536 * @param channels - channels to be updated 537 * @param action - type/style of update 538 * @param result - returned details about what was updated 539 * @param destination - destination for this update (action-specific) 540 */ 541 virtual IOReturn updateReport(IOReportChannelList *channels, 542 IOReportUpdateAction action, 543 void *result, 544 void *destination); 545 546 protected: 547 548 /* these are helper methods for DriverKit */ 549 IOReturn _ConfigureReport(IOReportChannelList *channels, 550 IOReportConfigureAction action, 551 void *result, 552 void *destination); 553 IOReturn _UpdateReport(IOReportChannelList *channels, 554 IOReportUpdateAction action, 555 void *result, 556 void *destination); 557 558 private: 559 #if __LP64__ 560 OSMetaClassDeclareReservedUsedX86(IOService, 0); 561 OSMetaClassDeclareReservedUsedX86(IOService, 1); 562 OSMetaClassDeclareReservedUnused(IOService, 2); 563 OSMetaClassDeclareReservedUnused(IOService, 3); 564 OSMetaClassDeclareReservedUnused(IOService, 4); 565 OSMetaClassDeclareReservedUnused(IOService, 5); 566 OSMetaClassDeclareReservedUnused(IOService, 6); 567 OSMetaClassDeclareReservedUnused(IOService, 7); 568 #else 569 OSMetaClassDeclareReservedUsedX86(IOService, 0); 570 OSMetaClassDeclareReservedUsedX86(IOService, 1); 571 OSMetaClassDeclareReservedUsedX86(IOService, 2); 572 OSMetaClassDeclareReservedUsedX86(IOService, 3); 573 OSMetaClassDeclareReservedUsedX86(IOService, 4); 574 OSMetaClassDeclareReservedUsedX86(IOService, 5); 575 OSMetaClassDeclareReservedUsedX86(IOService, 6); 576 OSMetaClassDeclareReservedUsedX86(IOService, 7); 577 #endif 578 579 OSMetaClassDeclareReservedUnused(IOService, 8); 580 OSMetaClassDeclareReservedUnused(IOService, 9); 581 OSMetaClassDeclareReservedUnused(IOService, 10); 582 OSMetaClassDeclareReservedUnused(IOService, 11); 583 OSMetaClassDeclareReservedUnused(IOService, 12); 584 OSMetaClassDeclareReservedUnused(IOService, 13); 585 OSMetaClassDeclareReservedUnused(IOService, 14); 586 OSMetaClassDeclareReservedUnused(IOService, 15); 587 OSMetaClassDeclareReservedUnused(IOService, 16); 588 OSMetaClassDeclareReservedUnused(IOService, 17); 589 OSMetaClassDeclareReservedUnused(IOService, 18); 590 OSMetaClassDeclareReservedUnused(IOService, 19); 591 OSMetaClassDeclareReservedUnused(IOService, 20); 592 OSMetaClassDeclareReservedUnused(IOService, 21); 593 OSMetaClassDeclareReservedUnused(IOService, 22); 594 OSMetaClassDeclareReservedUnused(IOService, 23); 595 OSMetaClassDeclareReservedUnused(IOService, 24); 596 OSMetaClassDeclareReservedUnused(IOService, 25); 597 OSMetaClassDeclareReservedUnused(IOService, 26); 598 OSMetaClassDeclareReservedUnused(IOService, 27); 599 OSMetaClassDeclareReservedUnused(IOService, 28); 600 OSMetaClassDeclareReservedUnused(IOService, 29); 601 OSMetaClassDeclareReservedUnused(IOService, 30); 602 OSMetaClassDeclareReservedUnused(IOService, 31); 603 OSMetaClassDeclareReservedUnused(IOService, 32); 604 OSMetaClassDeclareReservedUnused(IOService, 33); 605 OSMetaClassDeclareReservedUnused(IOService, 34); 606 OSMetaClassDeclareReservedUnused(IOService, 35); 607 OSMetaClassDeclareReservedUnused(IOService, 36); 608 OSMetaClassDeclareReservedUnused(IOService, 37); 609 OSMetaClassDeclareReservedUnused(IOService, 38); 610 OSMetaClassDeclareReservedUnused(IOService, 39); 611 OSMetaClassDeclareReservedUnused(IOService, 40); 612 OSMetaClassDeclareReservedUnused(IOService, 41); 613 OSMetaClassDeclareReservedUnused(IOService, 42); 614 OSMetaClassDeclareReservedUnused(IOService, 43); 615 OSMetaClassDeclareReservedUnused(IOService, 44); 616 OSMetaClassDeclareReservedUnused(IOService, 45); 617 OSMetaClassDeclareReservedUnused(IOService, 46); 618 OSMetaClassDeclareReservedUnused(IOService, 47); 619 620 public: 621 /*! @function getState 622 * @abstract Accessor for IOService state bits, not normally needed or used outside IOService. 623 * @result State bits for the IOService, eg. <code>kIOServiceInactiveState</code>, <code>kIOServiceRegisteredState</code>. */ 624 625 virtual IOOptionBits getState( void ) const; 626 627 /*! @function isInactive 628 * @abstract Checks if the IOService object has been terminated, and is in the process of being destroyed. 629 * @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. 630 * @result <code>true</code> if the IOService object has been terminated. */ 631 632 bool isInactive( void ) const; 633 634 /* Stack creation */ 635 636 /*! @function registerService 637 * @abstract Starts the registration process for a newly discovered IOService object. 638 * @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. 639 * @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. */ 640 641 virtual void registerService( IOOptionBits options = 0 ); 642 643 /*! @function probe 644 * @abstract During an IOService object's instantiation, probes a matched service to see if it can be used. 645 * @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. 646 * @param provider The registered IOService object that matches a driver personality's matching dictionary. 647 * @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. 648 * @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>. */ 649 650 virtual LIBKERN_RETURNS_NOT_RETAINED IOService * probe( IOService * provider, 651 SInt32 * score ); 652 653 /*! @function start 654 * @abstract During an IOService object's instantiation, starts the IOService object that has been selected to run on the provider. 655 * @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. 656 * @result <code>true</code> if the start was successful; <code>false</code> otherwise (which will cause the instance to be detached and usually freed). */ 657 658 virtual bool start( IOService * provider ); 659 660 /*! @function stop 661 * @abstract During an IOService termination, the stop method is called in its clients before they are detached & it is destroyed. 662 * @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. */ 663 664 virtual void stop( IOService * provider ); 665 666 /* Open / Close */ 667 668 /*! @function open 669 * @abstract Requests active access to a provider. 670 * @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. 671 * @param forClient Designates the client of the provider requesting the open. 672 * @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. 673 * @param arg Family specific arguments which are ignored by IOService. 674 * @result <code>true</code> if the open was successful; <code>false</code> otherwise. */ 675 676 virtual bool open( IOService * forClient, 677 IOOptionBits options = 0, 678 void * arg = NULL ); 679 680 /*! @function close 681 * @abstract Releases active access to a provider. 682 * @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. 683 * @param forClient Designates the client of the provider requesting the close. 684 * @param options Options available for the close. The provider family may implement options for close; IOService defines none. */ 685 686 virtual void close( IOService * forClient, 687 IOOptionBits options = 0 ); 688 689 /*! @function isOpen 690 * @abstract Determines whether a specific, or any, client has an IOService object open. 691 * @discussion Returns the open state of an IOService object with respect to the specified client, or when it is open by any client. 692 * @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. 693 * @result <code>true</code> if the specific, or any, client has the IOService object open. */ 694 695 virtual bool isOpen( const IOService * forClient = NULL ) const; 696 697 /*! @function handleOpen 698 * @abstract Controls the open / close behavior of an IOService object (overrideable by subclasses). 699 * @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. 700 * @param forClient Designates the client of the provider requesting the open. 701 * @param options Options for the open, may be interpreted by the implementor of <code>handleOpen</code>. 702 * @result <code>true</code>if the open was successful; <code>false</code> otherwise. */ 703 704 virtual bool handleOpen( IOService * forClient, 705 IOOptionBits options, 706 void * arg ); 707 708 /*! @function handleClose 709 * @abstract Controls the open / close behavior of an IOService object (overrideable by subclasses). 710 * @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. 711 * @param forClient Designates the client of the provider requesting the close. 712 * @param options Options for the close, may be interpreted by the implementor of @link handleOpen handleOpen@/link. */ 713 714 virtual void handleClose( IOService * forClient, 715 IOOptionBits options ); 716 717 /*! @function handleIsOpen 718 * @abstract Controls the open / close behavior of an IOService object (overrideable by subclasses). 719 * @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. 720 * @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. 721 * @result <code>true</code> if the specific, or any, client has the IOService object open. */ 722 723 virtual bool handleIsOpen( const IOService * forClient ) const; 724 725 /* Stacking change */ 726 727 /*! @function terminate 728 * @abstract Makes an IOService object inactive and begins its destruction. 729 * @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. 730 * @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. */ 731 732 virtual bool terminate( IOOptionBits options = 0 ); 733 734 /*! @function finalize 735 * @abstract Finalizes the destruction of an IOService object. 736 * @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. 737 * @param options The options passed to the @link terminate terminate@/link method of the IOService object are passed on to <code>finalize</code>. 738 * @result <code>true</code>. */ 739 740 virtual bool finalize( IOOptionBits options ); 741 742 /*! @function init 743 * @abstract Initializes generic IOService data structures (expansion data, etc). */ 744 virtual bool init( OSDictionary * dictionary = NULL ) APPLE_KEXT_OVERRIDE; 745 746 /*! @function init 747 * @abstract Initializes generic IOService data structures (expansion data, etc). */ 748 virtual bool init( IORegistryEntry * from, 749 const IORegistryPlane * inPlane ) APPLE_KEXT_OVERRIDE; 750 751 /*! @function free 752 * @abstract Frees data structures that were allocated when power management was initialized on this service. */ 753 754 virtual void free( void ) APPLE_KEXT_OVERRIDE; 755 756 /*! @function lockForArbitration 757 * @abstract Locks an IOService object against changes in state or ownership. 758 * @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. 759 * @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>. */ 760 761 virtual bool lockForArbitration( bool isSuccessRequired = true ); 762 763 /*! @function unlockForArbitration 764 * @abstract Unlocks an IOService obkect after a successful @link lockForArbitration lockForArbitration@/link. 765 * @discussion A thread granted exclusive access to an IOService object should release it with <code>unlockForArbitration</code>. */ 766 767 virtual void unlockForArbitration( void ); 768 769 #ifdef XNU_KERNEL_PRIVATE 770 static uint32_t isLockedForArbitration(IOService * service); 771 #endif /* XNU_KERNEL_PRIVATE */ 772 773 774 /*! @function terminateClient 775 * @abstract Passes a termination up the stack. 776 * @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. 777 * @param client The client of the terminated provider. 778 * @param options Options originally passed to @link terminate terminate@/link, plus <code>kIOServiceRecursing</code>. 779 * @result result of the terminate request on the client. */ 780 781 virtual bool terminateClient( IOService * client, IOOptionBits options ); 782 783 /* Busy state indicates discovery, matching or termination is in progress */ 784 785 /*! @function getBusyState 786 * @abstract Returns the <code>busyState</code> of an IOService object. 787 * @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. 788 * @result The <code>busyState</code> value. */ 789 790 virtual UInt32 getBusyState( void ); 791 792 /*! @function adjustBusy 793 * @abstract Adjusts the <code>busyState</code> of an IOService object. 794 * @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). 795 * @param delta The delta to be applied to the IOService object's <code>busyState</code>. */ 796 797 virtual void adjustBusy( SInt32 delta ); 798 799 #ifdef XNU_KERNEL_PRIVATE 800 /*! @function waitQuietWithOptions 801 * @abstract Waits for an IOService object's <code>busyState</code> to be zero. 802 * @discussion Blocks the caller until an IOService object is non busy. 803 * @param timeout The maximum time to wait in nanoseconds. Default is to wait forever. 804 * @param options Options to configure behavior of this call 805 * @result Returns an error code if Mach synchronization primitives fail, <code>kIOReturnTimeout</code>, or <code>kIOReturnSuccess</code>. */ 806 807 IOReturn waitQuietWithOptions(uint64_t timeout = UINT64_MAX, IOOptionBits options = 0); 808 #endif /* XNU_KERNEL_PRIVATE */ 809 810 APPLE_KEXT_COMPATIBILITY_VIRTUAL 811 IOReturn waitQuiet(mach_timespec_t * timeout) 812 APPLE_KEXT_DEPRECATED; 813 814 /*! @function waitQuiet 815 * @abstract Waits for an IOService object's <code>busyState</code> to be zero. 816 * @discussion Blocks the caller until an IOService object is non busy. 817 * @param timeout The maximum time to wait in nanoseconds. Default is to wait forever. 818 * @result Returns an error code if Mach synchronization primitives fail, <code>kIOReturnTimeout</code>, or <code>kIOReturnSuccess</code>. */ 819 820 IOReturn waitQuiet(uint64_t timeout = UINT64_MAX); 821 822 /* Matching */ 823 824 /*! @function matchPropertyTable 825 * @abstract Allows a registered IOService object to implement family specific matching. 826 * @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. 827 * @param table The dictionary of properties to be matched against. 828 * @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. 829 * @result <code>false</code> if the family considers the matching dictionary does not match in properties it understands; <code>true</code> otherwise. */ 830 831 virtual bool matchPropertyTable( OSDictionary * table, 832 SInt32 * score ); 833 834 virtual bool matchPropertyTable( OSDictionary * table ); 835 836 /*! @function matchLocation 837 * @abstract Allows a registered IOService object to direct location matching. 838 * @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. 839 * @param client The IOService object at which matching is taking place. 840 * @result Returns the IOService instance to be used for location matching. */ 841 842 virtual LIBKERN_RETURNS_NOT_RETAINED IOService * matchLocation( IOService * client ); 843 844 /* Resource service */ 845 846 /*! @function publishResource 847 * @abstract Uses the resource service to publish a property. 848 * @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. 849 * @param key An OSSymbol key that globally identifies the object. 850 * @param value The object to be published. */ 851 852 static void publishResource( const OSSymbol * key, OSObject * value = NULL ); 853 static void publishUserResource( const OSSymbol * key, OSObject * value = NULL ); 854 855 /*! @function publishResource 856 * @abstract Uses the resource service to publish a property. 857 * @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. 858 * @param key A C string key that globally identifies the object. 859 * @param value The object to be published. */ 860 861 static void publishResource( const char * key, OSObject * value = NULL ); 862 virtual bool addNeededResource( const char * key ); 863 864 /* Notifications */ 865 866 /*! @function addNotification 867 * @abstract Deprecated use addMatchingNotification(). Adds a persistant notification handler to be notified of IOService events. 868 * @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. 869 * @param type An OSSymbol identifying the type of notification and IOService state: 870 * <br> <code>gIOPublishNotification</code> Delivered when an IOService object is registered. 871 * <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. 872 * <br> <code>gIOMatchedNotification</code> Delivered when an IOService object has been matched with all client drivers, and they have been probed and started. 873 * <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. 874 * <br> <code>gIOWillTerminateNotification</code> Delivered after an IOService object has been terminated, during its finalize stage. Delivered after any matching on the service has finished. 875 * <br> <code>gIOTerminatedNotification</code> Delivered immediately when an IOService object has been terminated, making it inactive. 876 * @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. 877 * @param handler A C function callback to deliver notifications. 878 * @param target An instance reference for the callback's use. 879 * @param ref A reference constant for the callback's use. 880 * @param priority A constant ordering all notifications of a each type. 881 * @result An instance of an IONotifier object that can be used to control or destroy the notification request. */ 882 883 static OSPtr<IONotifier> addNotification( 884 const OSSymbol * type, OSDictionary * matching, 885 IOServiceNotificationHandler handler, 886 void * target, void * ref = NULL, 887 SInt32 priority = 0 ) 888 APPLE_KEXT_DEPRECATED; 889 890 /*! @function addMatchingNotification 891 * @abstract Adds a persistant notification handler to be notified of IOService events. 892 * @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. 893 * @param type An OSSymbol identifying the type of notification and IOService state: 894 * <br> <code>gIOPublishNotification</code> Delivered when an IOService object is registered. 895 * <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. 896 * <br> <code>gIOMatchedNotification</code> Delivered when an IOService object has been matched with all client drivers, and they have been probed and started. 897 * <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. 898 * <br> <code>gIOWillTerminateNotification</code> Delivered after an IOService object has been terminated, during its finalize stage. Delivered after any matching on the service has finished. 899 * <br> <code>gIOTerminatedNotification</code> Delivered immediately when an IOService object has been terminated, making it inactive. 900 * @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). 901 * @param handler A C function callback to deliver notifications. 902 * @param target An instance reference for the callback's use. 903 * @param ref A reference constant for the callback's use. 904 * @param priority A constant ordering all notifications of a each type. 905 * @result An instance of an IONotifier object that can be used to control or destroy the notification request. */ 906 907 static IONotifier * addMatchingNotification( 908 const OSSymbol * type, OSDictionary * matching, 909 IOServiceMatchingNotificationHandler handler, 910 void * target, void * ref = NULL, 911 SInt32 priority = 0 ); 912 913 914 #ifdef __BLOCKS__ 915 static IONotifier * addMatchingNotification( 916 const OSSymbol * type, OSDictionary * matching, 917 SInt32 priority, 918 IOServiceMatchingNotificationHandlerBlock handler); 919 #endif /* __BLOCKS__ */ 920 921 /*! @function waitForService 922 * @abstract Deprecated use waitForMatchingService(). Waits for a matching to service to be published. 923 * @discussion Provides a method of waiting for an IOService object matching the supplied matching dictionary to be registered and fully matched. 924 * @param matching The matching dictionary describing the desired IOService object. <code>waitForService</code> consumes one reference of the matching dictionary. 925 * @param timeout The maximum time to wait. 926 * @result A published IOService object matching the supplied dictionary. */ 927 928 static LIBKERN_RETURNS_NOT_RETAINED IOService * waitForService( 929 LIBKERN_CONSUMED OSDictionary * matching, 930 mach_timespec_t * timeout = NULL); 931 932 /*! @function waitForMatchingService 933 * @abstract Waits for a matching to service to be published. 934 * @discussion Provides a method of waiting for an IOService object matching the supplied matching dictionary to be registered and fully matched. 935 * @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.) 936 * @param timeout The maximum time to wait in nanoseconds. Default is to wait forever. 937 * @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.) */ 938 939 static OSPtr<IOService> waitForMatchingService( OSDictionary * matching, 940 uint64_t timeout = UINT64_MAX); 941 942 #ifdef XNU_KERNEL_PRIVATE 943 static IOService * waitForMatchingServiceWithToken( OSDictionary * matching, 944 uint64_t timeout, IOUserServerCheckInToken * token ); 945 #endif 946 947 /*! @function getMatchingServices 948 * @abstract Finds the set of current published IOService objects matching a matching dictionary. 949 * @discussion Provides a method of finding the current set of published IOService objects matching the supplied matching dictionary. 950 * @param matching The matching dictionary describing the desired IOService objects. 951 * @result An instance of an iterator over a set of IOService objects. To be released by the caller. */ 952 953 static OSPtr<OSIterator> getMatchingServices( OSDictionary * matching ); 954 955 /*! @function copyMatchingService 956 * @abstract Finds one of the current published IOService objects matching a matching dictionary. 957 * @discussion Provides a method to find one member of the set of published IOService objects matching the supplied matching dictionary. 958 * @param matching The matching dictionary describing the desired IOService object. 959 * @result The IOService object or NULL. To be released by the caller. */ 960 961 static OSPtr<IOService> copyMatchingService( OSDictionary * matching ); 962 963 public: 964 /* Helpers to make matching dictionaries for simple cases, 965 * they add keys to an existing dictionary, or create one. */ 966 967 /*! @function serviceMatching 968 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService class match. 969 * @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. 970 * @param className The class name, as a const C string. Class matching is successful on IOService objects of this class or any subclass. 971 * @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. 972 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 973 974 static OSPtr<OSDictionary> serviceMatching( const char * className, 975 OSDictionary * table = NULL ); 976 977 #if __cplusplus >= 201703L 978 /*! @function serviceMatching 979 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService class match. 980 * @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. 981 * @param className The class name, as a const C string. Class matching is successful on IOService objects of this class or any subclass. 982 * @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. 983 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 984 985 static OSSharedPtr<OSDictionary> serviceMatching( const char * className, 986 OSSharedPtr<OSDictionary> table); 987 #endif 988 989 /*! @function serviceMatching 990 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService class match. 991 * @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. 992 * @param className The class name, as an OSString (which includes OSSymbol). Class matching is successful on IOService objects of this class or any subclass. 993 * @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. 994 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 995 996 static OSPtr<OSDictionary> serviceMatching( const OSString * className, 997 OSDictionary * table = NULL ); 998 999 #if __cplusplus >= 201703L 1000 /*! @function serviceMatching 1001 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService class match. 1002 * @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. 1003 * @param className The class name, as an OSString (which includes OSSymbol). Class matching is successful on IOService objects of this class or any subclass. 1004 * @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. 1005 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 1006 1007 static OSSharedPtr<OSDictionary> serviceMatching( const OSString * className, 1008 OSSharedPtr<OSDictionary> table); 1009 #endif 1010 1011 /*! @function nameMatching 1012 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService name match. 1013 * @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. 1014 * @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. 1015 * @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. 1016 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 1017 1018 static OSPtr<OSDictionary> nameMatching( const char * name, 1019 OSDictionary * table = NULL ); 1020 1021 #if __cplusplus >= 201703L 1022 /*! @function nameMatching 1023 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService name match. 1024 * @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. 1025 * @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. 1026 * @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. 1027 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 1028 1029 static OSSharedPtr<OSDictionary> nameMatching( const char * name, 1030 OSSharedPtr<OSDictionary> table); 1031 #endif 1032 1033 /*! @function nameMatching 1034 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService name match. 1035 * @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. 1036 * @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. 1037 * @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. 1038 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 1039 1040 static OSPtr<OSDictionary> nameMatching( const OSString* name, 1041 OSDictionary * table = NULL ); 1042 1043 #if __cplusplus >= 201703L 1044 /*! @function nameMatching 1045 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService name match. 1046 * @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. 1047 * @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. 1048 * @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. 1049 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 1050 1051 static OSSharedPtr<OSDictionary> nameMatching( const OSString* name, 1052 OSSharedPtr<OSDictionary> table); 1053 #endif 1054 1055 /*! @function resourceMatching 1056 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify a resource service match. 1057 * @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. 1058 * @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. 1059 * @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. 1060 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 1061 1062 static OSPtr<OSDictionary> resourceMatching( const char * name, 1063 OSDictionary * table = NULL ); 1064 1065 #if __cplusplus >= 201703L 1066 /*! @function resourceMatching 1067 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify a resource service match. 1068 * @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. 1069 * @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. 1070 * @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. 1071 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 1072 1073 static OSSharedPtr<OSDictionary> resourceMatching( const char * name, 1074 OSSharedPtr<OSDictionary> table); 1075 #endif 1076 1077 /*! @function resourceMatching 1078 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify a resource service match. 1079 * @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. 1080 * @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. 1081 * @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. 1082 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 1083 1084 static OSPtr<OSDictionary> resourceMatching( const OSString * name, 1085 OSDictionary * table = NULL ); 1086 1087 #if __cplusplus >= 201703L 1088 /*! @function resourceMatching 1089 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify a resource service match. 1090 * @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. 1091 * @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. 1092 * @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. 1093 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 1094 1095 static OSSharedPtr<OSDictionary> resourceMatching( const OSString * name, 1096 OSSharedPtr<OSDictionary> table); 1097 #endif 1098 1099 1100 /*! @function propertyMatching 1101 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService phandle match. 1102 * @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. 1103 * @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. 1104 * @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. 1105 * @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. 1106 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 1107 1108 static OSPtr<OSDictionary> propertyMatching( const OSSymbol * key, const OSObject * value, 1109 OSDictionary * table = NULL ); 1110 1111 #if __cplusplus >= 201703L 1112 /*! @function propertyMatching 1113 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify an IOService phandle match. 1114 * @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. 1115 * @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. 1116 * @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. 1117 * @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. 1118 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 1119 1120 static OSSharedPtr<OSDictionary> propertyMatching( const OSSymbol * key, const OSObject * value, 1121 OSSharedPtr<OSDictionary> table); 1122 #endif 1123 1124 /*! @function registryEntryIDMatching 1125 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify a IORegistryEntryID match. 1126 * @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. 1127 * @param entryID The service's ID. Matching is successful on the IOService object that return that ID from the <code>IORegistryEntry::getRegistryEntryID()</code> method. 1128 * @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. 1129 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 1130 1131 static OSDictionary * registryEntryIDMatching( uint64_t entryID, 1132 OSDictionary * table = NULL ); 1133 1134 #if __cplusplus >= 201703L 1135 /*! @function registryEntryIDMatching 1136 * @abstract Creates a matching dictionary, or adds matching properties to an existing dictionary, that specify a IORegistryEntryID match. 1137 * @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. 1138 * @param entryID The service's ID. Matching is successful on the IOService object that return that ID from the <code>IORegistryEntry::getRegistryEntryID()</code> method. 1139 * @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. 1140 * @result The matching dictionary created, or passed in, is returned on success, or zero on failure. */ 1141 1142 static OSSharedPtr<OSDictionary> registryEntryIDMatching( uint64_t entryID, 1143 OSSharedPtr<OSDictionary> table); 1144 #endif 1145 1146 1147 /*! @function addLocation 1148 * @abstract Adds a location matching property to an existing dictionary. 1149 * @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. 1150 * @param table The matching properties are added to the specified dictionary, which must be non-zero. 1151 * @result The location matching dictionary created is returned on success, or zero on failure. */ 1152 1153 static OSPtr<OSDictionary> addLocation( OSDictionary * table ); 1154 1155 /* Helpers for matching dictionaries. */ 1156 1157 /*! @function compareProperty 1158 * @abstract Compares a property in a matching dictionary with an IOService object's property table. 1159 * @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. 1160 * @param matching The matching dictionary, which must be non-zero. 1161 * @param key The dictionary key specifying the property to be compared, as a C string. 1162 * @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. */ 1163 1164 virtual bool compareProperty( OSDictionary * matching, 1165 const char * key ); 1166 /*! @function compareProperty 1167 * @abstract Compares a property in a matching dictionary with an IOService object's property table. 1168 * @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. 1169 * @param matching The matching dictionary, which must be non-zero. 1170 * @param key The dictionary key specifying the property to be compared, as an OSString (which includes OSSymbol). 1171 * @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. */ 1172 1173 virtual bool compareProperty( OSDictionary * matching, 1174 const OSString * key ); 1175 1176 /*! @function compareProperties 1177 * @abstract Compares a set of properties in a matching dictionary with an IOService object's property table. 1178 * @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. 1179 * @param matching The matching dictionary, which must be non-zero. 1180 * @param keys A collection (eg. OSSet, OSArray, OSDictionary) which should contain OSStrings (or OSSymbols) that specify the property keys to be compared. 1181 * @result Success if <code>compareProperty</code> returns <code>true</code> for each key in the collection; otherwise failure. */ 1182 1183 virtual bool compareProperties( OSDictionary * matching, 1184 OSCollection * keys ); 1185 1186 /* Client / provider accessors */ 1187 1188 /*! @function attach 1189 * @abstract Attaches an IOService client to a provider in the I/O Registry. 1190 * @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. 1191 * @param provider The IOService object which will serve as this object's provider. 1192 * @result <code>false</code> if the provider is inactive or on a resource failure; otherwise <code>true</code>. */ 1193 1194 virtual bool attach( IOService * provider ); 1195 1196 /*! @function detach 1197 * @abstract Detaches an IOService client from a provider in the I/O Registry. 1198 * @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. 1199 * @param provider The IOService object to detach from. */ 1200 1201 virtual void detach( IOService * provider ); 1202 1203 /*! @function getProvider 1204 * @abstract Returns an IOService object's primary provider. 1205 * @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. 1206 * @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. */ 1207 1208 virtual IOService * getProvider( void ) const; 1209 1210 /*! @function getWorkLoop 1211 * @abstract Returns the current work loop or <code>provider->getWorkLoop</code>. 1212 * @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. 1213 * @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.*/ 1214 1215 virtual IOWorkLoop * getWorkLoop() const; 1216 1217 /*! @function getProviderIterator 1218 * @abstract Returns an iterator over an IOService object's providers. 1219 * @discussion For those few IOService objects that obtain service from multiple providers, this method supplies an iterator over a client's providers. 1220 * @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. */ 1221 1222 virtual OSPtr<OSIterator> getProviderIterator( void ) const; 1223 1224 /*! @function getOpenProviderIterator 1225 * @abstract Returns an iterator over an client's providers that are currently opened by the client. 1226 * @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. 1227 * @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. */ 1228 1229 virtual OSPtr<OSIterator> getOpenProviderIterator( void ) const; 1230 1231 /*! @function getClient 1232 * @abstract Returns an IOService object's primary client. 1233 * @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. 1234 * @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. */ 1235 1236 virtual IOService * getClient( void ) const; 1237 1238 /*! @function getClientIterator 1239 * @abstract Returns an iterator over an IOService object's clients. 1240 * @discussion For IOService objects that may have multiple clients, this method supplies an iterator over a provider's clients. 1241 * @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. */ 1242 1243 virtual OSPtr<OSIterator> getClientIterator( void ) const; 1244 1245 /*! @function getOpenClientIterator 1246 * @abstract Returns an iterator over a provider's clients that currently have opened the provider. 1247 * @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. 1248 * @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. */ 1249 1250 virtual OSPtr<OSIterator> getOpenClientIterator( void ) const; 1251 1252 /*! @function callPlatformFunction 1253 * @abstract Calls the platform function with the given name. 1254 * @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. 1255 * @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. 1256 * @param waitForFunction If <code>true</code>, <code>callPlatformFunction</code> will not return until the function has been called. 1257 * @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.*/ 1258 1259 virtual IOReturn callPlatformFunction( const OSSymbol * functionName, 1260 bool waitForFunction, 1261 void *param1, void *param2, 1262 void *param3, void *param4 ); 1263 1264 virtual IOReturn callPlatformFunction( const char * functionName, 1265 bool waitForFunction, 1266 void *param1, void *param2, 1267 void *param3, void *param4 ); 1268 1269 1270 /* Some accessors */ 1271 1272 /*! @function getPlatform 1273 * @abstract Returns a pointer to the platform expert instance for the computer. 1274 * @discussion This method provides an accessor to the platform expert instance for the computer. 1275 * @result A pointer to the IOPlatformExpert instance. It should not be released by the caller. */ 1276 1277 static IOPlatformExpert * getPlatform( void ); 1278 1279 /*! @function getPMRootDomain 1280 * @abstract Returns a pointer to the power management root domain instance for the computer. 1281 * @discussion This method provides an accessor to the power management root domain instance for the computer. 1282 * @result A pointer to the power management root domain instance. It should not be released by the caller. */ 1283 1284 static class IOPMrootDomain * getPMRootDomain( void ); 1285 1286 /*! @function getServiceRoot 1287 * @abstract Returns a pointer to the root of the service plane. 1288 * @discussion This method provides an accessor to the root of the service plane for the computer. 1289 * @result A pointer to the IOService instance at the root of the service plane. It should not be released by the caller. */ 1290 1291 static IOService * getServiceRoot( void ); 1292 1293 /*! @function getResourceService 1294 * @abstract Returns a pointer to the IOResources service. 1295 * @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. 1296 * @result A pointer to the IOResources instance. It should not be released by the caller. */ 1297 1298 static IOService * getResourceService( void ); 1299 1300 static IOService * getSystemStateNotificationService(void); 1301 1302 /* Allocate resources for a matched service */ 1303 1304 /*! @function getResources 1305 * @abstract Allocates any needed resources for a published IOService object before clients attach. 1306 * @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. 1307 * @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. */ 1308 1309 virtual IOReturn getResources( void ); 1310 1311 /* Device memory accessors */ 1312 1313 /*! @function getDeviceMemoryCount 1314 * @abstract Returns a count of the physical memory ranges available for a device. 1315 * @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. 1316 * @result An integer count of the number of ranges available. */ 1317 1318 virtual IOItemCount getDeviceMemoryCount( void ); 1319 1320 /*! @function getDeviceMemoryWithIndex 1321 * @abstract Returns an instance of IODeviceMemory representing one of a device's memory mapped ranges. 1322 * @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. 1323 * @param index An index into the array of ranges assigned to the device. 1324 * @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. */ 1325 1326 virtual IODeviceMemory * getDeviceMemoryWithIndex( unsigned int index ); 1327 1328 /*! @function mapDeviceMemoryWithIndex 1329 * @abstract Maps a physical range of a device. 1330 * @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. 1331 * @param index An index into the array of ranges assigned to the device. 1332 * @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. */ 1333 1334 virtual IOMemoryMap * mapDeviceMemoryWithIndex( unsigned int index, 1335 IOOptionBits options = 0 ); 1336 1337 /*! @function getDeviceMemory 1338 * @abstract Returns the array of IODeviceMemory objects representing a device's memory mapped ranges. 1339 * @discussion This method returns an array of IODeviceMemory objects representing the physical memory ranges allocated to a memory mapped device. 1340 * @result An OSArray of IODeviceMemory objects, or zero if none are available. The array is retained by the provider, so is valid while attached. */ 1341 1342 virtual OSArray * getDeviceMemory( void ); 1343 1344 /*! @function setDeviceMemory 1345 * @abstract Sets the array of IODeviceMemory objects representing a device's memory mapped ranges. 1346 * @discussion This method sets an array of IODeviceMemory objects representing the physical memory ranges allocated to a memory mapped device. 1347 * @param array An OSArray of IODeviceMemory objects, or zero if none are available. The array will be retained by the object. */ 1348 1349 virtual void setDeviceMemory( OSArray * array ); 1350 1351 /* Interrupt accessors */ 1352 1353 /*! @function registerInterrupt 1354 * @abstract Registers a C function interrupt handler for a device supplying interrupts. 1355 * @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. 1356 * @param source The index of the interrupt source in the device. 1357 * @param target An object instance to be passed to the interrupt handler. 1358 * @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. 1359 * @param refCon A reference constant for the handler's use. 1360 * @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. */ 1361 1362 virtual IOReturn registerInterrupt(int source, OSObject *target, 1363 IOInterruptAction handler, 1364 void *refCon = NULL); 1365 1366 #ifdef __BLOCKS__ 1367 /*! @function registerInterrupt 1368 * @abstract Registers a block handler for a device supplying interrupts. 1369 * @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. 1370 * @param source The index of the interrupt source in the device. 1371 * @param target An object instance to be passed to the interrupt handler. 1372 * @param handler The block to be invoked at primary interrupt time when the interrupt occurs. The handler should process the interrupt by clearing the interrupt, or by disabling the source. 1373 * @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. */ 1374 1375 IOReturn registerInterruptBlock(int source, OSObject *target, 1376 IOInterruptActionBlock handler); 1377 #endif /* __BLOCKS__ */ 1378 1379 /*! @function unregisterInterrupt 1380 * @abstract Removes a C function interrupt handler for a device supplying hardware interrupts. 1381 * @discussion This method removes a C function interrupt handler previously installed with @link registerInterrupt registerInterrupt@/link. 1382 * @param source The index of the interrupt source in the device. 1383 * @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */ 1384 1385 virtual IOReturn unregisterInterrupt(int source); 1386 1387 /*! @function addInterruptStatistics 1388 * @abstract Adds a statistics object to the IOService for the given interrupt. 1389 * @discussion This method associates a set of statistics and a reporter for those statistics with an interrupt for this IOService, so that we can interrogate the IOService for statistics pertaining to that interrupt. 1390 * @param statistics The IOInterruptAccountingData container we wish to associate the IOService with. 1391 * @param source The index of the interrupt source in the device. */ 1392 IOReturn addInterruptStatistics(IOInterruptAccountingData * statistics, int source); 1393 1394 /*! @function removeInterruptStatistics 1395 * @abstract Removes any statistics from the IOService for the given interrupt. 1396 * @discussion This method disassociates any IOInterruptAccountingData container we may have for the given interrupt from the IOService; this indicates that the the interrupt target (at the moment, likely an IOInterruptEventSource) is being destroyed. 1397 * @param source The index of the interrupt source in the device. */ 1398 IOReturn removeInterruptStatistics(int source); 1399 1400 /*! @function getInterruptType 1401 * @abstract Returns the type of interrupt used for a device supplying hardware interrupts. 1402 * @param source The index of the interrupt source in the device. 1403 * @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. 1404 * @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */ 1405 1406 virtual IOReturn getInterruptType(int source, int *interruptType); 1407 1408 /*! @function enableInterrupt 1409 * @abstract Enables a device interrupt. 1410 * @discussion It is the caller's responsiblity to keep track of the enable state of the interrupt source. 1411 * @param source The index of the interrupt source in the device. 1412 * @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */ 1413 1414 virtual IOReturn enableInterrupt(int source); 1415 1416 /*! @function disableInterrupt 1417 * @abstract Synchronously disables a device interrupt. 1418 * @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. 1419 * @param source The index of the interrupt source in the device. 1420 * @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */ 1421 1422 virtual IOReturn disableInterrupt(int source); 1423 1424 /*! @function causeInterrupt 1425 * @abstract Causes a device interrupt to occur. 1426 * @discussion Emulates a hardware interrupt, to be called from task level. 1427 * @param source The index of the interrupt source in the device. 1428 * @result An IOReturn code (<code>kIOReturnNoInterrupt</code> is returned if the source is not valid). */ 1429 1430 virtual IOReturn causeInterrupt(int source); 1431 1432 /*! @function requestProbe 1433 * @abstract Requests that hardware be re-scanned for devices. 1434 * @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. 1435 * @param options Family defined options, not interpreted by IOService. 1436 * @result An IOReturn code. */ 1437 1438 virtual IOReturn requestProbe( IOOptionBits options ); 1439 1440 /* Generic API for non-data-path upstream calls */ 1441 1442 /*! @function message 1443 * @abstract Receives a generic message delivered from an attached provider. 1444 * @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. 1445 * @param type A type defined in <code>IOMessage.h</code> or defined by the provider family. 1446 * @param provider The provider from which the message originates. 1447 * @param argument An argument defined by the provider family, not used by IOService. 1448 * @result An IOReturn code defined by the message type. */ 1449 1450 virtual IOReturn message( UInt32 type, IOService * provider, 1451 void * argument = NULL ); 1452 1453 /*! @function messageClient 1454 * @abstract Sends a generic message to an attached client. 1455 * @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. 1456 * @param messageType A type defined in <code>IOMessage.h</code> or defined by the provider family. 1457 * @param client A client of the IOService to send the message. 1458 * @param messageArgument An argument defined by the provider family, not used by IOService. 1459 * @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. 1460 * @result The return code from the client message call. */ 1461 1462 virtual IOReturn messageClient( UInt32 messageType, OSObject * client, 1463 void * messageArgument = NULL, vm_size_t argSize = 0 ); 1464 1465 /*! @function messageClients 1466 * @abstract Sends a generic message to all attached clients. 1467 * @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. 1468 * @param type A type defined in <code>IOMessage.h</code> or defined by the provider family. 1469 * @param argument An argument defined by the provider family, not used by IOService. 1470 * @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. 1471 * @result Any non-<code>kIOReturnSuccess</code> return codes returned by the clients, or <code>kIOReturnSuccess</code> if all return <code>kIOReturnSuccess</code>. */ 1472 1473 virtual IOReturn messageClients( UInt32 type, 1474 void * argument = NULL, vm_size_t argSize = 0 ); 1475 1476 virtual OSPtr<IONotifier> registerInterest( const OSSymbol * typeOfInterest, 1477 IOServiceInterestHandler handler, 1478 void * target, void * ref = NULL ); 1479 1480 #ifdef __BLOCKS__ 1481 OSPtr<IONotifier> registerInterest(const OSSymbol * typeOfInterest, 1482 IOServiceInterestHandlerBlock handler); 1483 #endif /* __BLOCKS__ */ 1484 1485 virtual void applyToProviders( IOServiceApplierFunction applier, 1486 void * context ); 1487 1488 virtual void applyToClients( IOServiceApplierFunction applier, 1489 void * context ); 1490 1491 #ifdef __BLOCKS__ 1492 void applyToProviders(IOServiceApplierBlock applier); 1493 void applyToClients(IOServiceApplierBlock applier); 1494 #endif /* __BLOCKS__ */ 1495 1496 virtual void applyToInterested( const OSSymbol * typeOfInterest, 1497 OSObjectApplierFunction applier, 1498 void * context ); 1499 1500 virtual IOReturn acknowledgeNotification( IONotificationRef notification, 1501 IOOptionBits response ); 1502 1503 /* User client create */ 1504 1505 /*! @function newUserClient 1506 * @abstract Creates a connection for a non kernel client. 1507 * @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. 1508 * @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"}. 1509 * @param securityID A token representing the access level for the task. 1510 * @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. 1511 * @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. 1512 * @param properties A dictionary of additional properties for the connection. 1513 * @result A return code to be passed back to the caller of <code>IOServiceOpen</code>. */ 1514 1515 virtual IOReturn newUserClient( task_t owningTask, void * securityID, 1516 UInt32 type, OSDictionary * properties, 1517 LIBKERN_RETURNS_RETAINED IOUserClient ** handler ); 1518 1519 virtual IOReturn newUserClient( task_t owningTask, void * securityID, 1520 UInt32 type, 1521 LIBKERN_RETURNS_RETAINED IOUserClient ** handler ); 1522 1523 IOReturn newUserClient( task_t owningTask, void * securityID, 1524 UInt32 type, OSDictionary * properties, 1525 OSSharedPtr<IOUserClient>& handler ); 1526 1527 IOReturn newUserClient( task_t owningTask, void * securityID, 1528 UInt32 type, 1529 OSSharedPtr<IOUserClient>& handler ); 1530 1531 /* Return code utilities */ 1532 1533 /*! @function stringFromReturn 1534 * @abstract Supplies a programmer-friendly string from an IOReturn code. 1535 * @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. 1536 * @param rtn The IOReturn code. 1537 * @result A pointer to a constant string, or zero if the return code is unknown. */ 1538 1539 virtual const char * stringFromReturn( IOReturn rtn ); 1540 1541 /*! @function errnoFromReturn 1542 * @abstract Translates an IOReturn code to a BSD <code>errno</code>. 1543 * @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. 1544 * @param rtn The IOReturn code. 1545 * @result The BSD <code>errno</code> or <code>EIO</code> if unknown. */ 1546 1547 virtual int errnoFromReturn( IOReturn rtn ); 1548 1549 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 1550 /* * * * * * * * * * end of IOService API * * * * * * * */ 1551 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 1552 1553 /* for IOInterruptController implementors */ 1554 1555 int _numInterruptSources; 1556 IOInterruptSource *_interruptSources; 1557 1558 /* overrides */ 1559 virtual bool serializeProperties( OSSerialize * s ) const APPLE_KEXT_OVERRIDE; 1560 1561 IOReturn requireMaxBusStall(UInt32 ns); 1562 IOReturn requireMaxInterruptDelay(uint32_t ns); 1563 1564 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 1565 /* * * * * * * * * * * * Internals * * * * * * * * * * * */ 1566 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * */ 1567 1568 #ifdef XNU_KERNEL_PRIVATE 1569 public: 1570 // called from other xnu components 1571 static void initialize( void ); 1572 static void setPlatform( IOPlatformExpert * platform); 1573 static void setPMRootDomain( class IOPMrootDomain * rootDomain ); 1574 static IOReturn catalogNewDrivers( OSOrderedSet * newTables ); 1575 uint64_t getAccumulatedBusyTime( void ); 1576 static void updateConsoleUsers(OSArray * consoleUsers, IOMessage systemMessage, 1577 bool afterUserspaceReboot = false); 1578 static void consoleLockTimer(thread_call_param_t p0, thread_call_param_t p1); 1579 void setTerminateDefer(IOService * provider, bool defer); 1580 uint64_t getAuthorizationID( void ); 1581 IOReturn setAuthorizationID( uint64_t authorizationID ); 1582 void cpusRunning(void); 1583 void scheduleFinalize(bool now); 1584 static void willShutdown(); 1585 static void startDeferredMatches(); 1586 static void iokitDaemonLaunched(); 1587 void resetRematchProperties(); 1588 bool hasUserServer() const; 1589 static void userSpaceWillReboot(); 1590 static void userSpaceDidReboot(); 1591 kern_return_t CopyProperties_Local(OSDictionary ** properties); 1592 1593 IOStateNotificationItem * stateNotificationItemCopy(OSString * itemName, OSDictionary * schema); 1594 kern_return_t stateNotificationListenerAdd(OSArray * items, 1595 IOStateNotificationListenerRef * outRef, 1596 IOStateNotificationHandler handler); 1597 kern_return_t stateNotificationListenerRemove(IOStateNotificationListenerRef ref); 1598 1599 private: 1600 static IOReturn waitMatchIdle( UInt32 ms ); 1601 static OSPtr<IONotifier> installNotification( 1602 const OSSymbol * type, OSDictionary * matching, 1603 IOServiceMatchingNotificationHandler handler, 1604 void * target, void * ref, 1605 SInt32 priority, 1606 LIBKERN_RETURNS_RETAINED OSIterator ** existing); 1607 #if !defined(__LP64__) 1608 static OSPtr<IONotifier> installNotification( 1609 const OSSymbol * type, OSDictionary * matching, 1610 IOServiceNotificationHandler handler, 1611 void * target, void * ref, 1612 SInt32 priority, 1613 LIBKERN_RETURNS_RETAINED OSIterator ** existing); 1614 #endif /* !defined(__LP64__) */ 1615 #endif 1616 1617 private: 1618 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1619 bool checkResources( void ); 1620 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1621 bool checkResource( OSObject * matching ); 1622 1623 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1624 void probeCandidates( LIBKERN_CONSUMED OSOrderedSet * matches ); 1625 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1626 bool startCandidate( IOService * candidate ); 1627 1628 public: 1629 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1630 IOService * getClientWithCategory( const OSSymbol * category ) 1631 APPLE_KEXT_DEPRECATED; 1632 // copyClientWithCategory is the public replacement 1633 1634 #ifdef XNU_KERNEL_PRIVATE 1635 /* Callable within xnu source only - but require vtable entries to be visible */ 1636 public: 1637 #else 1638 private: 1639 #endif 1640 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1641 bool passiveMatch( OSDictionary * matching, bool changesOK = false); 1642 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1643 void startMatching( IOOptionBits options = 0 ); 1644 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1645 void doServiceMatch( IOOptionBits options ); 1646 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1647 void doServiceTerminate( IOOptionBits options ); 1648 1649 bool hasParent(IOService * root); 1650 static void setRootMedia(IOService * root); 1651 static void publishHiddenMedia(IOService * parent); 1652 static bool publishHiddenMediaApplier(const OSObject * entry, void * context); 1653 bool canTerminateForReplacement(IOService * client); 1654 1655 private: 1656 1657 bool matchPassive(OSDictionary * table, uint32_t options); 1658 bool matchInternal(OSDictionary * table, uint32_t options, unsigned int * did); 1659 static bool instanceMatch(const OSObject * entry, void * context); 1660 1661 static OSPtr<OSObject> copyExistingServices( OSDictionary * matching, 1662 IOOptionBits inState, IOOptionBits options = 0 ); 1663 1664 static OSPtr<IONotifier> setNotification( 1665 const OSSymbol * type, OSDictionary * matching, 1666 IOServiceMatchingNotificationHandler handler, 1667 void * target, void * ref, 1668 SInt32 priority = 0 ); 1669 1670 static OSPtr<IONotifier> doInstallNotification( 1671 const OSSymbol * type, OSDictionary * matching, 1672 IOServiceMatchingNotificationHandler handler, 1673 void * target, void * ref, 1674 SInt32 priority, OSIterator ** existing ); 1675 1676 static bool syncNotificationHandler( void * target, void * ref, 1677 IOService * newService, IONotifier * notifier ); 1678 1679 static void userServerCheckInTokenCancellationHandler( 1680 IOUserServerCheckInToken * token, 1681 void * ref); 1682 1683 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1684 void deliverNotification( const OSSymbol * type, 1685 IOOptionBits orNewState, IOOptionBits andNewState ); 1686 1687 OSPtr<OSArray> copyNotifiers(const OSSymbol * type, 1688 IOOptionBits orNewState, IOOptionBits andNewState); 1689 1690 bool invokeNotifiers(OSArray * willSend[]); 1691 bool invokeNotifier( class _IOServiceNotifier * notify ); 1692 1693 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1694 void unregisterAllInterest( void ); 1695 1696 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1697 IOReturn waitForState( UInt32 mask, UInt32 value, 1698 mach_timespec_t * timeout = NULL ); 1699 1700 IOReturn waitForState( UInt32 mask, UInt32 value, uint64_t timeout ); 1701 1702 UInt32 _adjustBusy( SInt32 delta ); 1703 1704 bool terminatePhase1( IOOptionBits options = 0 ); 1705 void scheduleTerminatePhase2( IOOptionBits options = 0 ); 1706 void scheduleStop( IOService * provider ); 1707 1708 static void waitToBecomeTerminateThread( void ); 1709 static void __attribute__((__noreturn__)) terminateThread( void * arg, wait_result_t unused ); 1710 static void terminateWorker( IOOptionBits options ); 1711 static void actionWillTerminate( IOService * victim, IOOptionBits options, 1712 OSArray * doPhase2List, bool, void * ); 1713 static void actionDidTerminate( IOService * victim, IOOptionBits options, 1714 void *, void *, void *); 1715 1716 static void actionWillStop( IOService * victim, IOOptionBits options, 1717 void *, void *, void *); 1718 static void actionDidStop( IOService * victim, IOOptionBits options, 1719 void *, void *, void *); 1720 1721 static void actionFinalize( IOService * victim, IOOptionBits options, 1722 void *, void *, void *); 1723 static void actionStop( IOService * client, IOService * provider, 1724 void *, void *, void *); 1725 1726 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1727 IOReturn resolveInterrupt(IOService *nub, int source); 1728 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1729 IOReturn lookupInterrupt( 1730 int source, bool resolve, 1731 LIBKERN_RETURNS_NOT_RETAINED IOInterruptController * 1732 *interruptController); 1733 1734 #ifdef XNU_KERNEL_PRIVATE 1735 /* end xnu internals */ 1736 #endif 1737 1738 /* power management */ 1739 public: 1740 1741 /*! @function PMinit 1742 * @abstract Initializes power management for a driver. 1743 * @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. 1744 * Most calls to <code>PMinit</code> are followed by calls to @link joinPMtree joinPMtree@/link and @link registerPowerDriver registerPowerDriver@/link. */ 1745 1746 virtual void PMinit( void ); 1747 1748 /*! @function PMstop 1749 * @abstract Stop power managing the driver. 1750 * @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. 1751 * 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. */ 1752 1753 virtual void PMstop( void ); 1754 1755 /*! @function joinPMtree 1756 * @abstract Joins the driver into the power plane of the I/O Registry. 1757 * @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). 1758 * 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. 1759 * @param driver The driver to be added to the power plane, usually <code>this</code>. */ 1760 1761 virtual void joinPMtree( IOService * driver ); 1762 1763 /*! @function registerPowerDriver 1764 * @abstract Registers a set of power states that the driver supports. 1765 * @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. 1766 * 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. 1767 * @param controllingDriver A pointer to the calling driver, usually <code>this</code>. 1768 * @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>. 1769 * @param numberOfStates The number of power states in the array. 1770 * @result <code>IOPMNoErr</code>. All errors are logged via <code>kprintf</code>. */ 1771 1772 virtual IOReturn registerPowerDriver( 1773 IOService * controllingDriver, 1774 IOPMPowerState * powerStates, 1775 unsigned long numberOfStates ); 1776 1777 /*! @function registerInterestedDriver 1778 * @abstract Allows an IOService object to register interest in the changing power state of a power-managed IOService object. 1779 * @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. 1780 * The interested driver is retained until the power interest is removed by calling <code>deRegisterInterestedDriver</code>. 1781 * The interested driver should override @link powerStateWillChangeTo powerStateWillChangeTo@/link and @link powerStateDidChangeTo powerStateDidChangeTo@/link to receive these power change messages. 1782 * 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. 1783 * @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. 1784 * @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). */ 1785 1786 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1787 IOPMPowerFlags registerInterestedDriver( IOService * theDriver ); 1788 1789 /*! @function deRegisterInterestedDriver 1790 * @abstract De-registers power state interest from a previous call to <code>registerInterestedDriver</code>. 1791 * @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. 1792 * Most drivers do not need to override <code>deRegisterInterestedDriver</code>. 1793 * @param theDriver The interested driver previously passed into @link registerInterestedDriver registerInterestedDriver@/link. 1794 * @result A return code that can be ignored by the caller. */ 1795 1796 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1797 IOReturn deRegisterInterestedDriver( IOService * theDriver ); 1798 1799 /*! @function acknowledgePowerChange 1800 * @abstract Acknowledges an in-progress power state change. 1801 * @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>. 1802 * 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>. 1803 * @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. 1804 * @result <code>IOPMNoErr</code>. */ 1805 1806 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1807 IOReturn acknowledgePowerChange( IOService * whichDriver ); 1808 1809 /*! @function acknowledgeSetPowerState 1810 * @abstract Acknowledges the belated completion of a driver's <code>setPowerState</code> power state change. 1811 * @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>. 1812 * Any driver that does not return <code>kIOPMAckImplied</code> from its <code>setPowerState</code> implementation must later call <code>acknowledgeSetPowerState</code>. 1813 * @result <code>IOPMNoErr</code>. */ 1814 1815 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1816 IOReturn acknowledgeSetPowerState( void ); 1817 1818 /*! @function requestPowerDomainState 1819 * @abstract Tells a driver to adjust its power state. 1820 * @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1821 1822 virtual IOReturn requestPowerDomainState( 1823 IOPMPowerFlags desiredState, 1824 IOPowerConnection * whichChild, 1825 unsigned long specificationFlags ); 1826 1827 /*! @function makeUsable 1828 * @abstract Requests that a device become usable. 1829 * @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. 1830 * <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. 1831 * @result A return code that can be ignored by the caller. */ 1832 1833 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1834 IOReturn makeUsable( void ); 1835 1836 /*! @function temporaryPowerClampOn 1837 * @abstract A driver calls this method to hold itself in the highest power state until it has children. 1838 * @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. 1839 * @result A return code that can be ignored by the caller. */ 1840 1841 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1842 IOReturn temporaryPowerClampOn( void ); 1843 1844 /*! @function changePowerStateTo 1845 * @abstract Sets a driver's power state. 1846 * @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. 1847 * 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: 1848 * <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. 1849 * <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> 1850 * @param ordinal The number of the desired power state in the power state array. 1851 * @result A return code that can be ignored by the caller. */ 1852 1853 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1854 IOReturn changePowerStateTo( unsigned long ordinal ); 1855 1856 /*! @function currentCapability 1857 * @abstract Finds out the capability of a device's current power state. 1858 * @result A copy of the <code>capabilityFlags</code> field for the current power state in the power state array. */ 1859 1860 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1861 IOPMPowerFlags currentCapability( void ); 1862 1863 /*! @function currentPowerConsumption 1864 * @abstract Finds out the current power consumption of a device. 1865 * @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. 1866 * @result A copy of the <code>staticPower</code> field for the current power state in the power state array. */ 1867 1868 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1869 unsigned long currentPowerConsumption( void ); 1870 1871 /*! @function activityTickle 1872 * @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. 1873 * @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. 1874 * 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. 1875 * 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. 1876 * 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. 1877 * @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. 1878 * @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. 1879 * @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. */ 1880 1881 virtual bool activityTickle( 1882 unsigned long type, 1883 unsigned long stateNumber = 0 ); 1884 1885 /*! @function setAggressiveness 1886 * @abstract Broadcasts an aggressiveness factor from the parent of a driver to the driver. 1887 * @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. 1888 * A driver that has joined the power plane via @link joinPMtree joinPMtree@/link will receive <code>setAgressiveness</code> calls when aggressiveness factors change. 1889 * 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. 1890 * Most drivers do not need to implement <code>setAgressiveness</code>. 1891 * @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>.) 1892 * @param newLevel The aggressiveness factor's new value. 1893 * @result <code>IOPMNoErr</code>. */ 1894 1895 virtual IOReturn setAggressiveness( 1896 unsigned long type, 1897 unsigned long newLevel ); 1898 1899 /*! @function getAggressiveness 1900 * @abstract Returns the current aggressiveness value for the given type. 1901 * @param type The aggressiveness factor to query. 1902 * @param currentLevel Upon successful return, contains the value of aggressiveness factor <code>type</code>. 1903 * @result <code>kIOReturnSuccess</code> upon success; an I/O Kit error code otherwise. */ 1904 1905 virtual IOReturn getAggressiveness( 1906 unsigned long type, 1907 unsigned long * currentLevel ); 1908 1909 #ifndef __LP64__ 1910 /*! @function systemWake 1911 * @abstract Tells every driver in the power plane that the system is waking up. 1912 * @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1913 1914 virtual IOReturn systemWake( void ) 1915 APPLE_KEXT_DEPRECATED; 1916 1917 /*! @function temperatureCriticalForZone 1918 * @abstract Alerts a driver to a critical temperature in some thermal zone. 1919 * @discussion This call is unused by power management. It is not intended to be called or overridden. */ 1920 1921 virtual IOReturn temperatureCriticalForZone( IOService * whichZone ) 1922 APPLE_KEXT_DEPRECATED; 1923 1924 /*! @function youAreRoot 1925 * @abstract Informs power management which IOService object is the power plane root. 1926 * @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1927 1928 virtual IOReturn youAreRoot( void ) 1929 APPLE_KEXT_DEPRECATED; 1930 1931 /*! @function setPowerParent 1932 * @abstract This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1933 1934 virtual IOReturn setPowerParent( 1935 IOPowerConnection * parent, 1936 bool stateKnown, 1937 IOPMPowerFlags currentState ) 1938 APPLE_KEXT_DEPRECATED; 1939 #endif /* !__LP64__ */ 1940 1941 /*! @function addPowerChild 1942 * @abstract Informs a driver that it has a new child. 1943 * @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. 1944 * @param theChild A pointer to the child IOService object. */ 1945 1946 virtual IOReturn addPowerChild( IOService * theChild ); 1947 1948 /*! @function removePowerChild 1949 * @abstract Informs a power managed driver that one of its power plane childen is disappearing. 1950 * @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1951 1952 virtual IOReturn removePowerChild( IOPowerConnection * theChild ); 1953 1954 #ifndef __LP64__ 1955 /*! @function command_received 1956 * @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1957 1958 virtual void command_received( void *, void *, void *, void * ); 1959 #endif 1960 1961 /*! @function start_PM_idle_timer 1962 * @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1963 1964 APPLE_KEXT_COMPATIBILITY_VIRTUAL 1965 void start_PM_idle_timer( void ); 1966 1967 #ifndef __LP64__ 1968 /*! @function PM_idle_timer_expiration 1969 * @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1970 1971 virtual void PM_idle_timer_expiration( void ) 1972 APPLE_KEXT_DEPRECATED; 1973 1974 /*! @function PM_Clamp_Timer_Expired 1975 * @discussion This call is handled internally by power management. It is not intended to be overridden or called by drivers. */ 1976 1977 virtual void PM_Clamp_Timer_Expired( void ) 1978 APPLE_KEXT_DEPRECATED; 1979 #endif 1980 1981 /*! @function setIdleTimerPeriod 1982 * @abstract Sets or changes the idle timer period. 1983 * @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. 1984 * @param period The desired idle timer period in seconds. 1985 * @result <code>kIOReturnSuccess</code> upon success; an I/O Kit error code otherwise. */ 1986 1987 virtual IOReturn setIdleTimerPeriod( unsigned long period ); 1988 1989 #ifndef __LP64__ 1990 /*! @function getPMworkloop 1991 * @abstract Returns a pointer to the system-wide power management work loop. 1992 * @availability Deprecated in Mac OS X version 10.6. 1993 * @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. */ 1994 1995 virtual IOWorkLoop * getPMworkloop( void ) 1996 APPLE_KEXT_DEPRECATED; 1997 #endif 1998 1999 /*! @function getPowerState 2000 * @abstract Determines a device's power state. 2001 * @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. 2002 * @result The current power state's index into the device's power state array. */ 2003 2004 UInt32 getPowerState( void ); 2005 2006 /*! @function setPowerState 2007 * @abstract Requests a power managed driver to change the power state of its device. 2008 * @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. 2009 * 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. 2010 * @param powerStateOrdinal The number in the power state array of the state the driver is being instructed to switch to. 2011 * @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. 2012 * @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. */ 2013 2014 virtual IOReturn setPowerState( 2015 unsigned long powerStateOrdinal, 2016 IOService * whatDevice ); 2017 2018 #ifndef __LP64__ 2019 /*! @function clampPowerOn 2020 * @abstract Deprecated. Do not use. */ 2021 2022 virtual void clampPowerOn( unsigned long duration ); 2023 #endif 2024 2025 /*! @function maxCapabilityForDomainState 2026 * @abstract Determines a driver's highest power state possible for a given power domain state. 2027 * @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. 2028 * 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. 2029 * @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. 2030 * @result A state number. */ 2031 2032 virtual unsigned long maxCapabilityForDomainState( IOPMPowerFlags domainState ); 2033 2034 /*! @function initialPowerStateForDomainState 2035 * @abstract Determines which power state a device is in, given the current power domain state. 2036 * @discussion Power management calls this method once, when the driver is initializing power management. 2037 * 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. 2038 * @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. 2039 * @result A state number. */ 2040 2041 virtual unsigned long initialPowerStateForDomainState( IOPMPowerFlags domainState ); 2042 2043 /*! @function powerStateForDomainState 2044 * @abstract Determines what power state the device would be in for a given power domain state. 2045 * @discussion This call is unused by power management. Drivers should override <code>initialPowerStateForDomainState</code> and/or <code>maxCapabilityForDomainState</code> instead to change the default mapping of domain state to driver power state. 2046 * @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. 2047 * @result A state number. */ 2048 2049 virtual unsigned long powerStateForDomainState( IOPMPowerFlags domainState ); 2050 2051 /*! @function powerStateWillChangeTo 2052 * @abstract Informs interested parties that a device is about to change its power state. 2053 * @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. 2054 * <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. 2055 * @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). 2056 * @param stateNumber The number of the state in the state array that the device is switching to. 2057 * @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. 2058 * @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. */ 2059 2060 virtual IOReturn powerStateWillChangeTo( 2061 IOPMPowerFlags capabilities, 2062 unsigned long stateNumber, 2063 IOService * whatDevice ); 2064 2065 /*! @function powerStateDidChangeTo 2066 * @abstract Informs interested parties that a device has changed to a different power state. 2067 * @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. 2068 * <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. 2069 * @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). 2070 * @param stateNumber The number of the state in the state array that the device is switching to. 2071 * @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. 2072 * @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. */ 2073 2074 virtual IOReturn powerStateDidChangeTo( 2075 IOPMPowerFlags capabilities, 2076 unsigned long stateNumber, 2077 IOService * whatDevice ); 2078 2079 #ifndef __LP64__ 2080 /*! @function didYouWakeSystem 2081 * @abstract Asks a driver if its device is the one that just woke the system from sleep. 2082 * @availability Deprecated in Mac OS X version 10.6. 2083 * @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. 2084 * @result <code>true</code> if the driver's device woke the system and <code>false</code> otherwise. */ 2085 2086 virtual bool didYouWakeSystem( void ) 2087 APPLE_KEXT_DEPRECATED; 2088 2089 /*! @function newTemperature 2090 * @abstract Tells a power managed driver that the temperature in the thermal zone has changed. 2091 * @discussion This call is unused by power management. It is not intended to be called or overridden. */ 2092 2093 virtual IOReturn newTemperature( long currentTemp, IOService * whichZone ) 2094 APPLE_KEXT_DEPRECATED; 2095 #endif 2096 2097 virtual bool askChangeDown( unsigned long ); 2098 virtual bool tellChangeDown( unsigned long ); 2099 virtual void tellNoChangeDown( unsigned long ); 2100 virtual void tellChangeUp( unsigned long ); 2101 virtual IOReturn allowPowerChange( unsigned long refcon ); 2102 virtual IOReturn cancelPowerChange( unsigned long refcon ); 2103 2104 protected: 2105 /*! @function changePowerStateToPriv 2106 * @abstract Tells a driver's superclass to change the power state of its device. 2107 * @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. 2108 * 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. 2109 * 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. 2110 * @param ordinal The number of the desired power state in the power state array. 2111 * @result A return code that can be ignored by the caller. */ 2112 public: 2113 IOReturn changePowerStateToPriv( unsigned long ordinal ); 2114 2115 /*! @function powerOverrideOnPriv 2116 * @abstract Allows a driver to ignore its children's power management requests and only use changePowerStateToPriv to define its own power state. 2117 * @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. 2118 * @result A return code that can be ignored by the caller. */ 2119 2120 IOReturn powerOverrideOnPriv( void ); 2121 2122 /*! @function powerOverrideOffPriv 2123 * @abstract Allows a driver to disable a power override. 2124 * @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. 2125 * @result A return code that can be ignored by the caller. */ 2126 2127 IOReturn powerOverrideOffPriv( void ); 2128 2129 /*! @function powerChangeDone 2130 * @abstract Tells a driver when a power state change is complete. 2131 * @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. 2132 * @param stateNumber The number of the state in the state array that the device has switched from. */ 2133 2134 virtual void powerChangeDone( unsigned long stateNumber ); 2135 #ifdef XNU_KERNEL_PRIVATE 2136 /* Power management internals */ 2137 public: 2138 void idleTimerExpired( void ); 2139 void settleTimerExpired( void ); 2140 IOReturn synchronizePowerTree( IOOptionBits options = 0, IOService * notifyRoot = NULL ); 2141 bool assertPMDriverCall( IOPMDriverCallEntry * callEntry, IOOptionBits method, const IOPMinformee * inform = NULL, IOOptionBits options = 0 ); 2142 void deassertPMDriverCall( IOPMDriverCallEntry * callEntry ); 2143 IOReturn changePowerStateWithOverrideTo( IOPMPowerStateIndex ordinal, IOPMRequestTag tag ); 2144 IOReturn changePowerStateWithTagToPriv( IOPMPowerStateIndex ordinal, IOPMRequestTag tag ); 2145 IOReturn changePowerStateWithTagTo( IOPMPowerStateIndex ordinal, IOPMRequestTag tag ); 2146 IOReturn changePowerStateForRootDomain( IOPMPowerStateIndex ordinal ); 2147 IOReturn setIgnoreIdleTimer( bool ignore ); 2148 IOReturn quiescePowerTree( void * target, IOPMCompletionAction action, void * param ); 2149 IOPMPowerStateIndex getPowerStateForClient( const OSSymbol * client ); 2150 static const char * getIOMessageString( uint32_t msg ); 2151 static void setAdvisoryTickleEnable( bool enable ); 2152 void reset_watchdog_timer(IOService *obj, int timeout); 2153 void start_watchdog_timer( void ); 2154 void stop_watchdog_timer( void ); 2155 void start_watchdog_timer(uint64_t deadline); 2156 IOReturn registerInterestForNotifier( IONotifier *notify, const OSSymbol * typeOfInterest, 2157 IOServiceInterestHandler handler, void * target, void * ref ); 2158 2159 static IOWorkLoop * getIOPMWorkloop( void ); 2160 bool getBlockingDriverCall(thread_t *thread, const void **callMethod); 2161 void cancelIdlePowerDown(IOService * service); 2162 2163 protected: 2164 bool tellClientsWithResponse( int messageType ); 2165 void tellClients( int messageType ); 2166 void PMDebug( uint32_t event, uintptr_t param1, uintptr_t param2 ); 2167 2168 private: 2169 #ifndef __LP64__ 2170 void ack_timer_ticked( void ); 2171 IOReturn serializedAllowPowerChange2( unsigned long ); 2172 IOReturn serializedCancelPowerChange2( unsigned long ); 2173 IOReturn powerDomainWillChangeTo( IOPMPowerFlags, IOPowerConnection * ); 2174 IOReturn powerDomainDidChangeTo( IOPMPowerFlags, IOPowerConnection * ); 2175 #endif 2176 static void allocPMInitLock( void ); 2177 void PMfree( void ); 2178 bool tellChangeDown1( unsigned long ); 2179 bool tellChangeDown2( unsigned long ); 2180 IOReturn startPowerChange( IOPMPowerChangeFlags, IOPMPowerStateIndex, IOPMPowerFlags, IOPowerConnection *, IOPMPowerFlags ); 2181 void setParentInfo( IOPMPowerFlags, IOPowerConnection *, bool ); 2182 IOReturn notifyAll( uint32_t nextMS ); 2183 bool notifyChild( IOPowerConnection * child ); 2184 IOPMPowerStateIndex getPowerStateForDomainFlags( IOPMPowerFlags flags ); 2185 2186 // power change initiated by driver 2187 void OurChangeStart( void ); 2188 void OurSyncStart( void ); 2189 void OurChangeTellClientsPowerDown( void ); 2190 void OurChangeTellUserPMPolicyPowerDown( void ); 2191 void OurChangeTellPriorityClientsPowerDown( void ); 2192 void OurChangeTellCapabilityWillChange( void ); 2193 void OurChangeNotifyInterestedDriversWillChange( void ); 2194 void OurChangeSetPowerState( void ); 2195 void OurChangeWaitForPowerSettle( void ); 2196 void OurChangeNotifyInterestedDriversDidChange( void ); 2197 void OurChangeTellCapabilityDidChange( void ); 2198 void OurChangeFinish( void ); 2199 2200 // downward power change initiated by a power parent 2201 IOReturn ParentChangeStart( void ); 2202 void ParentChangeTellPriorityClientsPowerDown( void ); 2203 void ParentChangeTellCapabilityWillChange( void ); 2204 void ParentChangeNotifyInterestedDriversWillChange( void ); 2205 void ParentChangeSetPowerState( void ); 2206 void ParentChangeWaitForPowerSettle( void ); 2207 void ParentChangeNotifyInterestedDriversDidChange( void ); 2208 void ParentChangeTellCapabilityDidChange( void ); 2209 void ParentChangeAcknowledgePowerChange( void ); 2210 void ParentChangeRootChangeDown( void ); 2211 2212 void all_done( void ); 2213 void start_ack_timer( void ); 2214 void stop_ack_timer( void ); 2215 void start_ack_timer( UInt32 value, UInt32 scale ); 2216 void startSettleTimer( void ); 2217 void start_spindump_timer( const char * delay_type ); 2218 void stop_spindump_timer( void ); 2219 bool checkForDone( void ); 2220 bool responseValid( uint32_t x, int pid ); 2221 void computeDesiredState( unsigned long tempDesire, bool computeOnly ); 2222 void trackSystemSleepPreventers( IOPMPowerStateIndex, IOPMPowerStateIndex, IOPMPowerChangeFlags ); 2223 void tellSystemCapabilityChange( uint32_t nextMS ); 2224 void restartIdleTimer( void ); 2225 void startDriverCalloutTimer( void ); 2226 void stopDriverCalloutTimer( void ); 2227 2228 static void ack_timer_expired( thread_call_param_t, thread_call_param_t ); 2229 static void watchdog_timer_expired( thread_call_param_t arg0, thread_call_param_t arg1 ); 2230 static void spindump_timer_expired( thread_call_param_t arg0, thread_call_param_t arg1 ); 2231 static IOReturn actionAckTimerExpired(OSObject *, void *, void *, void *, void * ); 2232 static IOReturn actionSpinDumpTimerExpired(OSObject *, void *, void *, void *, void * ); 2233 2234 static IOReturn actionDriverCalloutDone(OSObject *, void *, void *, void *, void * ); 2235 static IOPMRequest * acquirePMRequest( IOService * target, IOOptionBits type, IOPMRequest * active = NULL ); 2236 static void releasePMRequest( IOPMRequest * request ); 2237 static void pmDriverCallout( IOService * from, thread_call_param_t ); 2238 static void pmDriverCalloutTimer( thread_call_param_t, thread_call_param_t ); 2239 static void pmTellAppWithResponse( OSObject * object, void * context ); 2240 static void pmTellClientWithResponse( OSObject * object, void * context ); 2241 static void pmTellCapabilityAppWithResponse( OSObject * object, void * arg ); 2242 static void pmTellCapabilityClientWithResponse( OSObject * object, void * arg ); 2243 static void submitPMRequest(LIBKERN_CONSUMED IOPMRequest * request ); 2244 static void submitPMRequests( IOPMRequest * requests[], IOItemCount count ); 2245 bool ackTimerTick( void ); 2246 void addPowerChild1( IOPMRequest * request ); 2247 void addPowerChild2( IOPMRequest * request ); 2248 void addPowerChild3( IOPMRequest * request ); 2249 void adjustPowerState( IOPMPowerStateIndex clamp = 0 ); 2250 void handlePMstop( IOPMRequest * request ); 2251 void handleRegisterPowerDriver( IOPMRequest * request ); 2252 bool handleAcknowledgePowerChange( IOPMRequest * request ); 2253 bool handleAcknowledgeSetPowerState( IOPMRequest * request ); 2254 void handlePowerDomainWillChangeTo( IOPMRequest * request ); 2255 void handlePowerDomainDidChangeTo( IOPMRequest * request ); 2256 void handleRequestPowerState( IOPMRequest * request ); 2257 void handlePowerOverrideChanged( IOPMRequest * request ); 2258 bool _activityTickle( unsigned long type, unsigned long stateNumber ); 2259 void handleDeferredActivityTickle( IOPMRequest * request ); 2260 void handleActivityTickle( IOPMRequest * request ); 2261 void handleInterestChanged( IOPMRequest * request ); 2262 void handleSynchronizePowerTree( IOPMRequest * request ); 2263 void executePMRequest( IOPMRequest * request ); 2264 bool actionPMWorkQueueInvoke( IOPMRequest * request, IOPMWorkQueue * queue ); 2265 bool actionPMWorkQueueRetire( IOPMRequest * request, IOPMWorkQueue * queue ); 2266 bool actionPMRequestQueue( IOPMRequest * request, IOPMRequestQueue * queue ); 2267 bool actionPMReplyQueue( IOPMRequest * request, IOPMRequestQueue * queue ); 2268 bool actionPMCompletionQueue( LIBKERN_CONSUMED IOPMRequest * request, IOPMCompletionQueue * queue ); 2269 bool notifyInterestedDrivers( void ); 2270 void notifyInterestedDriversDone( void ); 2271 bool notifyControllingDriver( void ); 2272 void notifyControllingDriverDone( void ); 2273 void driverSetPowerState( void ); 2274 void driverInformPowerChange( void ); 2275 bool isPMBlocked( IOPMRequest * request, int count ); 2276 void notifyChildren( void ); 2277 void notifyChildrenOrdered( void ); 2278 void notifyChildrenDelayed( void ); 2279 void notifyRootDomain( void ); 2280 void notifyRootDomainDone( void ); 2281 void cleanClientResponses( bool logErrors ); 2282 void updatePowerClient( const OSSymbol * client, IOPMPowerStateIndex powerState ); 2283 void removePowerClient( const OSSymbol * client ); 2284 IOReturn requestPowerState( const OSSymbol * client, IOPMPowerStateIndex state, IOPMRequestTag tag = 0 ); 2285 IOReturn requestDomainPower( IOPMPowerStateIndex ourPowerState, IOOptionBits options = 0 ); 2286 IOReturn configurePowerStatesReport( IOReportConfigureAction action, void *result ); 2287 IOReturn updatePowerStatesReport( IOReportConfigureAction action, void *result, void *destination ); 2288 IOReturn configureSimplePowerReport(IOReportConfigureAction action, void *result ); 2289 IOReturn updateSimplePowerReport( IOReportConfigureAction action, void *result, void *destination ); 2290 void waitForPMDriverCall( IOService * target = NULL ); 2291 #endif /* XNU_KERNEL_PRIVATE */ 2292 }; 2293 2294 #ifdef PRIVATE 2295 2296 class IOServiceCompatibility : public IOService 2297 { 2298 OSDeclareDefaultStructors(IOServiceCompatibility); 2299 }; 2300 2301 #endif /* PRIVATE */ 2302 2303 #endif /* ! _IOKIT_IOSERVICE_H */ 2304