1*1b191cb5SApple OSS Distributions /* 2*1b191cb5SApple OSS Distributions * Copyright (c) 1998-2019 Apple Inc. All rights reserved. 3*1b191cb5SApple OSS Distributions * 4*1b191cb5SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5*1b191cb5SApple OSS Distributions * 6*1b191cb5SApple OSS Distributions * This file contains Original Code and/or Modifications of Original Code 7*1b191cb5SApple OSS Distributions * as defined in and that are subject to the Apple Public Source License 8*1b191cb5SApple OSS Distributions * Version 2.0 (the 'License'). You may not use this file except in 9*1b191cb5SApple OSS Distributions * compliance with the License. The rights granted to you under the License 10*1b191cb5SApple OSS Distributions * may not be used to create, or enable the creation or redistribution of, 11*1b191cb5SApple OSS Distributions * unlawful or unlicensed copies of an Apple operating system, or to 12*1b191cb5SApple OSS Distributions * circumvent, violate, or enable the circumvention or violation of, any 13*1b191cb5SApple OSS Distributions * terms of an Apple operating system software license agreement. 14*1b191cb5SApple OSS Distributions * 15*1b191cb5SApple OSS Distributions * Please obtain a copy of the License at 16*1b191cb5SApple OSS Distributions * http://www.opensource.apple.com/apsl/ and read it before using this file. 17*1b191cb5SApple OSS Distributions * 18*1b191cb5SApple OSS Distributions * The Original Code and all software distributed under the License are 19*1b191cb5SApple OSS Distributions * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20*1b191cb5SApple OSS Distributions * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21*1b191cb5SApple OSS Distributions * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22*1b191cb5SApple OSS Distributions * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23*1b191cb5SApple OSS Distributions * Please see the License for the specific language governing rights and 24*1b191cb5SApple OSS Distributions * limitations under the License. 25*1b191cb5SApple OSS Distributions * 26*1b191cb5SApple OSS Distributions * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27*1b191cb5SApple OSS Distributions */ 28*1b191cb5SApple OSS Distributions 29*1b191cb5SApple OSS Distributions #ifndef _IOKIT_IOSERVICESTATENOTIFICATIONEVENTSOURCE_H 30*1b191cb5SApple OSS Distributions #define _IOKIT_IOSERVICESTATENOTIFICATIONEVENTSOURCE_H 31*1b191cb5SApple OSS Distributions 32*1b191cb5SApple OSS Distributions #include <libkern/c++/OSPtr.h> 33*1b191cb5SApple OSS Distributions #include <IOKit/IOEventSource.h> 34*1b191cb5SApple OSS Distributions 35*1b191cb5SApple OSS Distributions class IOService; 36*1b191cb5SApple OSS Distributions 37*1b191cb5SApple OSS Distributions 38*1b191cb5SApple OSS Distributions /*! @class IOServiceStateNotificationEventSource : public IOEventSource 39*1b191cb5SApple OSS Distributions * @abstract Event source for IOService state notification delivery to work-loop based drivers. 40*1b191cb5SApple OSS Distributions * @discussion For use with the IOService.iig IOService::StateNotification* APIs. 41*1b191cb5SApple OSS Distributions */ 42*1b191cb5SApple OSS Distributions 43*1b191cb5SApple OSS Distributions class IOServiceStateNotificationEventSource : public IOEventSource 44*1b191cb5SApple OSS Distributions { 45*1b191cb5SApple OSS Distributions OSDeclareDefaultStructors(IOServiceStateNotificationEventSource); 46*1b191cb5SApple OSS Distributions 47*1b191cb5SApple OSS Distributions public: 48*1b191cb5SApple OSS Distributions typedef void (^ActionBlock)(); 49*1b191cb5SApple OSS Distributions 50*1b191cb5SApple OSS Distributions protected: 51*1b191cb5SApple OSS Distributions IOService * fStateNotification; 52*1b191cb5SApple OSS Distributions IOStateNotificationListenerRef fListener; 53*1b191cb5SApple OSS Distributions bool fEnable; 54*1b191cb5SApple OSS Distributions bool fArmed; 55*1b191cb5SApple OSS Distributions 56*1b191cb5SApple OSS Distributions /*! @struct ExpansionData 57*1b191cb5SApple OSS Distributions * @discussion This structure will be used to expand the capablilties of the IOWorkLoop in the future. 58*1b191cb5SApple OSS Distributions */ 59*1b191cb5SApple OSS Distributions 60*1b191cb5SApple OSS Distributions /*! @var reserved 61*1b191cb5SApple OSS Distributions * Reserved for future use. (Internal use only) */ 62*1b191cb5SApple OSS Distributions APPLE_KEXT_WSHADOW_PUSH; 63*1b191cb5SApple OSS Distributions ExpansionData *reserved; 64*1b191cb5SApple OSS Distributions APPLE_KEXT_WSHADOW_POP; 65*1b191cb5SApple OSS Distributions 66*1b191cb5SApple OSS Distributions /*! @function free 67*1b191cb5SApple OSS Distributions * @abstract Sub-class implementation of free method, disconnects from the interrupt source. */ 68*1b191cb5SApple OSS Distributions virtual void free() APPLE_KEXT_OVERRIDE; 69*1b191cb5SApple OSS Distributions 70*1b191cb5SApple OSS Distributions /*! @function checkForWork 71*1b191cb5SApple OSS Distributions * @abstract Pure Virtual member function used by IOWorkLoop for issueing a client calls. 72*1b191cb5SApple OSS Distributions * @discussion This function called when the work-loop is ready to check for any work to do and then to call out the owner/action. 73*1b191cb5SApple OSS Distributions * @result Return true if this function needs to be called again before all its outstanding events have been processed. */ 74*1b191cb5SApple OSS Distributions virtual bool checkForWork() APPLE_KEXT_OVERRIDE; 75*1b191cb5SApple OSS Distributions 76*1b191cb5SApple OSS Distributions /*! @function setWorkLoop 77*1b191cb5SApple OSS Distributions * @abstract Sub-class implementation of setWorkLoop method. */ 78*1b191cb5SApple OSS Distributions virtual void setWorkLoop(IOWorkLoop *inWorkLoop) APPLE_KEXT_OVERRIDE; 79*1b191cb5SApple OSS Distributions 80*1b191cb5SApple OSS Distributions public: 81*1b191cb5SApple OSS Distributions 82*1b191cb5SApple OSS Distributions /*! 83*1b191cb5SApple OSS Distributions * @brief Create an IOServiceStateNotificationEventSource for notification of IOService state events sent by the StateNotificationSet() api. 84*1b191cb5SApple OSS Distributions * @param service The object hosting state, typically returned by IOService::CopySystemStateNotificationService(). 85*1b191cb5SApple OSS Distributions * @param items Array of state item names to be notified about. 86*1b191cb5SApple OSS Distributions * @param action Handler block to be invoked on the event source workloop when the notification fires. 87*1b191cb5SApple OSS Distributions * @return IOServiceStateNotificationEventSource with +1 retain, or NULL on failure. 88*1b191cb5SApple OSS Distributions */ 89*1b191cb5SApple OSS Distributions static OSPtr<IOServiceStateNotificationEventSource> 90*1b191cb5SApple OSS Distributions serviceStateNotificationEventSource(IOService *service, 91*1b191cb5SApple OSS Distributions OSArray * items, 92*1b191cb5SApple OSS Distributions ActionBlock action); 93*1b191cb5SApple OSS Distributions 94*1b191cb5SApple OSS Distributions /*! @function enable 95*1b191cb5SApple OSS Distributions * @abstract Enable event source. 96*1b191cb5SApple OSS Distributions * @discussion A subclass implementation is expected to respect the enabled 97*1b191cb5SApple OSS Distributions * state when checkForWork is called. Calling this function will cause the 98*1b191cb5SApple OSS Distributions * work-loop to be signalled so that a checkForWork is performed. */ 99*1b191cb5SApple OSS Distributions virtual void enable() APPLE_KEXT_OVERRIDE; 100*1b191cb5SApple OSS Distributions 101*1b191cb5SApple OSS Distributions /*! @function disable 102*1b191cb5SApple OSS Distributions * @abstract Disable event source. 103*1b191cb5SApple OSS Distributions * @discussion A subclass implementation is expected to respect the enabled 104*1b191cb5SApple OSS Distributions * state when checkForWork is called. */ 105*1b191cb5SApple OSS Distributions virtual void disable() APPLE_KEXT_OVERRIDE; 106*1b191cb5SApple OSS Distributions 107*1b191cb5SApple OSS Distributions private: 108*1b191cb5SApple OSS Distributions OSMetaClassDeclareReservedUnused(IOServiceStateNotificationEventSource, 0); 109*1b191cb5SApple OSS Distributions OSMetaClassDeclareReservedUnused(IOServiceStateNotificationEventSource, 1); 110*1b191cb5SApple OSS Distributions OSMetaClassDeclareReservedUnused(IOServiceStateNotificationEventSource, 2); 111*1b191cb5SApple OSS Distributions OSMetaClassDeclareReservedUnused(IOServiceStateNotificationEventSource, 3); 112*1b191cb5SApple OSS Distributions OSMetaClassDeclareReservedUnused(IOServiceStateNotificationEventSource, 4); 113*1b191cb5SApple OSS Distributions OSMetaClassDeclareReservedUnused(IOServiceStateNotificationEventSource, 5); 114*1b191cb5SApple OSS Distributions OSMetaClassDeclareReservedUnused(IOServiceStateNotificationEventSource, 6); 115*1b191cb5SApple OSS Distributions OSMetaClassDeclareReservedUnused(IOServiceStateNotificationEventSource, 7); 116*1b191cb5SApple OSS Distributions }; 117*1b191cb5SApple OSS Distributions 118*1b191cb5SApple OSS Distributions #endif /* !_IOKIT_IOSERVICESTATENOTIFICATIONEVENTSOURCE_H */ 119