xnu-1504.15.3.tar.gz

[apple/xnu.git] / iokit / IOKit / IOTimerEventSource.h

diff --git a/iokit/IOKit/IOTimerEventSource.h b/iokit/IOKit/IOTimerEventSource.h
index fd73358217760ab2a9e9d24e47247d32a2216573..7cc0d38c356d8ab1a97fa5d9e7313cd538910be7 100644 (file)
--- a/iokit/IOKit/IOTimerEventSource.h
+++ b/iokit/IOKit/IOTimerEventSource.h
@@ -1,23 +1,29 @@
 /*
  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
- * The contents of this file constitute Original Code as defined in and
- * are subject to the Apple Public Source License Version 1.1 (the
- * "License").  You may not use this file except in compliance with the
- * License.  Please obtain a copy of the License at
- * http://www.apple.com/publicsource and read it before using this file.
+ * This file contains Original Code and/or Modifications of Original Code
+ * as defined in and that are subject to the Apple Public Source License
+ * Version 2.0 (the 'License'). You may not use this file except in
+ * compliance with the License. The rights granted to you under the License
+ * may not be used to create, or enable the creation or redistribution of,
+ * unlawful or unlicensed copies of an Apple operating system, or to
+ * circumvent, violate, or enable the circumvention or violation of, any
+ * terms of an Apple operating system software license agreement.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * Please obtain a copy of the License at
+ * http://www.opensource.apple.com/apsl/ and read it before using this file.
+ * 
+ * The Original Code and all software distributed under the License are
+ * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
+ * Please see the License for the specific language governing rights and
+ * limitations under the License.
  * 
- * @APPLE_LICENSE_HEADER_END@
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
  * Copyright (c) 1999 Apple Computer, Inc.  All rights reserved. 
@@ -62,9 +68,13 @@ protected:
     AbsoluteTime abstime;
 
 /*! @struct ExpansionData
-    @discussion This structure will be used to expand the capablilties of the IOWorkLoop in the future.
+    @discussion This structure is private to the IOTimerEventSource implementation.
     */    
-    struct ExpansionData { };
+    struct ExpansionData
+    {
+        SInt32      calloutGeneration;
+        IOWorkLoop * workLoop;
+    };
 
 /*! @var reserved
     Reserved for future use.  (Internal use only)  */
@@ -89,6 +99,8 @@ protected:
     @abstract Have to implement it is mandatory in $link IOEventSource, but IOTimerEventSources don't actually use this work-loop mechanism. */
     virtual bool checkForWork();
 
+    virtual void setWorkLoop(IOWorkLoop *workLoop);
+
 public:
 
 /*! @typedef Action
@@ -147,11 +159,10 @@ public:
     virtual IOReturn setTimeout(UInt32 interval,
                                UInt32 scale_factor = kNanosecondScale);
 
-/*! @function setTimeout
-    @abstract Setup a callback at after the delay in decrementer ticks.         See wakeAtTime(AbsoluteTime).
-    @param interval Delay from now to wake up.
-    @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
-    virtual IOReturn setTimeout(mach_timespec_t interval);
+#if !defined(__LP64__)
+    virtual IOReturn setTimeout(mach_timespec_t interval)
+       APPLE_KEXT_DEPRECATED;
+#endif
 
 /*! @function setTimeout
     @abstract Setup a callback at after the delay in decrementer ticks.         See wakeAtTime(AbsoluteTime).
@@ -185,11 +196,10 @@ public:
     virtual IOReturn wakeAtTime(UInt32 abstime,
                                UInt32 scale_factor = kNanosecondScale);
 
-/*! @function wakeAtTime
-    @abstract Setup a callback at this absolute time.  See wakeAtTime(AbsoluteTime).
-    @param abstime mach_timespec_t of the desired callout time.
-    @result kIOReturnSuccess if everything is fine, kIOReturnNoResources if action hasn't been declared. */
-    virtual IOReturn wakeAtTime(mach_timespec_t abstime);
+#if !defined(__LP64__)
+    virtual IOReturn wakeAtTime(mach_timespec_t abstime)
+       APPLE_KEXT_DEPRECATED;
+#endif
 
 /*! @function wakeAtTime
     @abstract Setup a callback at this absolute time.
@@ -203,6 +213,9 @@ public:
     @discussion Clear down any oustanding calls.  By the time this function completes it is guaranteed that the action will not be called again. */
    virtual void cancelTimeout();
 
+private:
+    static void timeoutAndRelease(void *self, void *wl);
+
 private:
     OSMetaClassDeclareReservedUnused(IOTimerEventSource, 0);
     OSMetaClassDeclareReservedUnused(IOTimerEventSource, 1);