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