xnu-4570.71.2.tar.gz

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

diff --git a/iokit/IOKit/IOInterruptEventSource.h b/iokit/IOKit/IOInterruptEventSource.h
index fe5d4ae12854c0406aea9cdcb76cc484b875a47f..6acde040b62d6ff8bfffea99a56ac55fd41a0b01 100644 (file)
--- a/iokit/IOKit/IOInterruptEventSource.h
+++ b/iokit/IOKit/IOInterruptEventSource.h
@@ -1,5 +1,5 @@
 /*
 /*

- * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2016 Apple Inc. All rights reserved.

  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 


@@ -42,6 +42,8 @@ HISTORY
 
 class IOService;
 
 
 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.
 /*! @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.


@@ -66,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. */
     @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 */
 
 /*! @defined IOInterruptEventAction
     @discussion Backward compatibilty define for the old non-class scoped type definition.  See $link IOInterruptEventSource::Action */


@@ -96,25 +98,29 @@ protected:
 /*! @struct ExpansionData
     @discussion This structure will be used to expand the capablilties of the IOWorkLoop in the future.
     */    
 /*! @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)  */
 
 /*! @var reserved
     Reserved for future use.  (Internal use only)  */

+    APPLE_KEXT_WSHADOW_PUSH;

     ExpansionData *reserved;
     ExpansionData *reserved;

+    APPLE_KEXT_WSHADOW_POP;

 
 /*! @function free
     @abstract Sub-class implementation of free method, disconnects from the interrupt source. */
 
 /*! @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. */
 
 /*! @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. */
 
 /*! @function setWorkLoop
     @abstract Sub-class implementation of setWorkLoop method. */

-    virtual void setWorkLoop(IOWorkLoop *inWorkLoop);
+    virtual void setWorkLoop(IOWorkLoop *inWorkLoop) APPLE_KEXT_OVERRIDE;

 
 public:
 
 
 public:
 


@@ -149,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. */
     @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. */
 
 /*! @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.
 
 /*! @function getProvider
     @abstract Get'ter for $link provider variable.


@@ -189,9 +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);
     @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);
 
 private:
     IOReturn registerInterruptHandler(IOService *inProvider, int inIntIndex);

+    void unregisterInterruptHandler(IOService *inProvider, int inIntIndex);

 
 private:
     OSMetaClassDeclareReservedUnused(IOInterruptEventSource, 0);
 
 private:
     OSMetaClassDeclareReservedUnused(IOInterruptEventSource, 0);