X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/de355530ae67247cbd0da700edb3a2a1dae884c2..d26ffc64f583ab2d29df48f13518685602bc8832:/iokit/IOKit/IOInterruptEventSource.h
diff --git a/iokit/IOKit/IOInterruptEventSource.h b/iokit/IOKit/IOInterruptEventSource.h
index 9fff5fecb..6acde040b 100644
--- a/iokit/IOKit/IOInterruptEventSource.h
+++ b/iokit/IOKit/IOInterruptEventSource.h
@@ -1,23 +1,29 @@
/*
- * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2016 Apple 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) 1998 Apple Computer, Inc. All rights reserved.
@@ -36,11 +42,13 @@ HISTORY
class IOService;
+struct IOInterruptAccountingData;
+
/*! @class IOInterruptEventSource : public IOEventSource
@abstract Event source for interrupt delivery to work-loop based drivers.
@discussion The IOInterruptEventSource is a generic object that delivers calls interrupt routines in it's client in a guaranteed single-threaded manner. IOInterruptEventSource is part of the IOKit $link IOWorkLoop infrastructure where the semantic that one and only one action method is executing within a work-loops event chain.
-When the action method is called in the client member function will receive 2 arguments, (IOEventSource *) sender and (int) count, See $link IOInterruptEventSource::Action. Where sender will be reference to the interrupt that occured and the count will be computed by the difference between the $link producerCount and $link consumerCount. This number may not be reliable as no attempt is made to adjust for around the world type problems but is provided for general information and statistic gathering.
+When the action method is called in the client member function will receive 2 arguments, (IOEventSource *) sender and (int) count, See $link IOInterruptEventSource::Action. Where sender will be reference to the interrupt that occurred and the count will be computed by the difference between the $link producerCount and $link consumerCount. This number may not be reliable as no attempt is made to adjust for around the world type problems but is provided for general information and statistic gathering.
In general a client will use the factory member function to create and initialise the event source and then add it to their work-loop. It is the work loop's responsiblity to maintain the new event source in it's event chain. See $link IOWorkLoop.
@@ -60,7 +68,7 @@ public:
@param owner Pointer to client instance.
@param sender Pointer to generation interrupt event source.
@param count Number of interrupts seen before delivery. */
- typedef void (*Action)(OSObject *, IOInterruptEventSource *, int count);
+ typedef void (*Action)(OSObject *owner, IOInterruptEventSource *sender, int count);
/*! @defined IOInterruptEventAction
@discussion Backward compatibilty define for the old non-class scoped type definition. See $link IOInterruptEventSource::Action */
@@ -90,21 +98,29 @@ protected:
/*! @struct ExpansionData
@discussion This structure will be used to expand the capablilties of the IOWorkLoop in the future.
*/
- struct ExpansionData { };
+ struct ExpansionData {
+ IOInterruptAccountingData * statistics;
+ };
/*! @var reserved
Reserved for future use. (Internal use only) */
+ APPLE_KEXT_WSHADOW_PUSH;
ExpansionData *reserved;
+ APPLE_KEXT_WSHADOW_POP;
/*! @function free
@abstract Sub-class implementation of free method, disconnects from the interrupt source. */
- virtual void free();
+ virtual void free() APPLE_KEXT_OVERRIDE;
/*! @function checkForWork
@abstract Pure Virtual member function used by IOWorkLoop for issueing a client calls.
@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.
@result Return true if this function needs to be called again before all its outstanding events have been processed. */
- virtual bool checkForWork();
+ virtual bool checkForWork() APPLE_KEXT_OVERRIDE;
+
+/*! @function setWorkLoop
+ @abstract Sub-class implementation of setWorkLoop method. */
+ virtual void setWorkLoop(IOWorkLoop *inWorkLoop) APPLE_KEXT_OVERRIDE;
public:
@@ -139,13 +155,13 @@ successfully. */
@discussion A subclass implementation is expected to respect the enabled
state when checkForWork is called. Calling this function will cause the
work-loop to be signalled so that a checkForWork is performed. */
- virtual void enable();
+ virtual void enable() APPLE_KEXT_OVERRIDE;
/*! @function disable
@abstract Disable event source.
@discussion A subclass implementation is expected to respect the enabled
state when checkForWork is called. */
- virtual void disable();
+ virtual void disable() APPLE_KEXT_OVERRIDE;
/*! @function getProvider
@abstract Get'ter for $link provider variable.
@@ -179,6 +195,21 @@ state when checkForWork is called. */
@param nub Where did the interrupt originate from
@param ind What is this interrupts index within 'nub'. */
virtual void disableInterruptOccurred(void *, IOService *nub, int ind);
+
+/*! @function warmCPU
+ @abstract Tries to reduce latency for an interrupt which will be received near a specified time.
+ @discussion Warms up a CPU in advance of an interrupt so that the interrupt may be serviced with predictable latency.
+ The warm-up is not periodic; callers should call warmCPU once in advance of each interrupt. It is recommended that
+ requests be issues in serial (i.e. each after the target for the previous call has elapsed), as there is a systemwide
+ cap on the number of outstanding requests. This routine may be disruptive to the system if used with very small intervals
+ between requests; it should be used only in cases where interrupt latency is absolutely critical, and tens or hundreds of
+ milliseconds between targets is the expected time scale. NOTE: it is not safe to call this method with interrupts disabled.
+ @param abstime Time at which interrupt is expected. */
+ IOReturn warmCPU(uint64_t abstime);
+
+private:
+ IOReturn registerInterruptHandler(IOService *inProvider, int inIntIndex);
+ void unregisterInterruptHandler(IOService *inProvider, int inIntIndex);
private:
OSMetaClassDeclareReservedUnused(IOInterruptEventSource, 0);