xnu-4903.221.2.tar.gz

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

diff --git a/iokit/IOKit/IOInterruptController.h b/iokit/IOKit/IOInterruptController.h
index 4b4216b9bbb00f436bf1a8934543617de5e75d88..eca74ce9cb6a9353542fd1119cfb53683c52e033 100644 (file)
--- a/iokit/IOKit/IOInterruptController.h
+++ b/iokit/IOKit/IOInterruptController.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.
@@ -44,7 +50,7 @@ struct IOInterruptVector {
   volatile char               interruptRegistered;
   IOLock *                    interruptLock;
   IOService *                 nub;
-  long                        source;
+  int                         source;
   void *                      target;
   IOInterruptHandler          handler;
   void *                      refCon;
@@ -53,6 +59,11 @@ struct IOInterruptVector {
 
 typedef struct IOInterruptVector IOInterruptVector;
 
+#if __LP64__
+typedef int32_t IOInterruptVectorNumber;
+#else
+typedef long IOInterruptVectorNumber;
+#endif
 
 class IOInterruptController : public IOService
 {
@@ -63,7 +74,7 @@ protected:
   IOSimpleLock      *controllerLock;
 
   struct ExpansionData { };
-  ExpansionData *reserved;
+  ExpansionData *ioic_reserved;
 
 public:
   virtual IOReturn registerInterrupt(IOService *nub, int source,
@@ -85,12 +96,12 @@ public:
   
   // Methods to be overridden for simplifed interrupt controller subclasses.
   
-  virtual bool vectorCanBeShared(long vectorNumber, IOInterruptVector *vector);
-  virtual void initVector(long vectorNumber, IOInterruptVector *vector);
-  virtual int  getVectorType(long vectorNumber, IOInterruptVector *vector);
-  virtual void disableVectorHard(long vectorNumber, IOInterruptVector *vector);
-  virtual void enableVector(long vectorNumber, IOInterruptVector *vector);
-  virtual void causeVector(long vectorNumber, IOInterruptVector *vector);
+  virtual bool vectorCanBeShared(IOInterruptVectorNumber vectorNumber, IOInterruptVector *vector);
+  virtual void initVector(IOInterruptVectorNumber vectorNumber, IOInterruptVector *vector);
+  virtual int  getVectorType(IOInterruptVectorNumber vectorNumber, IOInterruptVector *vector);
+  virtual void disableVectorHard(IOInterruptVectorNumber vectorNumber, IOInterruptVector *vector);
+  virtual void enableVector(IOInterruptVectorNumber vectorNumber, IOInterruptVector *vector);
+  virtual void causeVector(IOInterruptVectorNumber vectorNumber, IOInterruptVector *vector);
 
   OSMetaClassDeclareReservedUnused(IOInterruptController, 0);
   OSMetaClassDeclareReservedUnused(IOInterruptController, 1);
@@ -98,6 +109,16 @@ public:
   OSMetaClassDeclareReservedUnused(IOInterruptController, 3);
   OSMetaClassDeclareReservedUnused(IOInterruptController, 4);
   OSMetaClassDeclareReservedUnused(IOInterruptController, 5);
+
+public:
+  // Generic methods (not to be overriden).
+
+  void timeStampSpuriousInterrupt(void);
+  void timeStampInterruptHandlerStart(IOInterruptVectorNumber vectorNumber, IOInterruptVector *vector);
+  void timeStampInterruptHandlerEnd(IOInterruptVectorNumber vectorNumber, IOInterruptVector *vector);
+
+private:
+  void timeStampInterruptHandlerInternal(bool isStart, IOInterruptVectorNumber vectorNumber, IOInterruptVector *vector);
 };
 
 
@@ -110,11 +131,11 @@ private:
   int               numVectors;
   int               vectorsRegistered;
   int               vectorsEnabled;
-  volatile long     controllerDisabled;
+  volatile int      controllerDisabled;
   bool              sourceIsLevel;
 
   struct ExpansionData { };
-  ExpansionData *reserved;
+  ExpansionData *iosic_reserved __unused;
 
 public:
   virtual IOReturn initInterruptController(IOInterruptController *parentController, OSData *parentSource);
@@ -122,17 +143,17 @@ public:
   virtual IOReturn registerInterrupt(IOService *nub, int source,
                                      void *target,
                                      IOInterruptHandler handler,
-                                     void *refCon);
-  virtual IOReturn unregisterInterrupt(IOService *nub, int source);
+                                     void *refCon) APPLE_KEXT_OVERRIDE;
+  virtual IOReturn unregisterInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
   
   virtual IOReturn getInterruptType(IOService *nub, int source,
-                                   int *interruptType);
+                                   int *interruptType) APPLE_KEXT_OVERRIDE;
   
-  virtual IOReturn enableInterrupt(IOService *nub, int source);
-  virtual IOReturn disableInterrupt(IOService *nub, int source);
+  virtual IOReturn enableInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
+  virtual IOReturn disableInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
   
-  virtual IOInterruptAction getInterruptHandlerAddress(void);
-  virtual IOReturn handleInterrupt(void *refCon, IOService *nub, int source);
+  virtual IOInterruptAction getInterruptHandlerAddress(void) APPLE_KEXT_OVERRIDE;
+  virtual IOReturn handleInterrupt(void *refCon, IOService *nub, int source) APPLE_KEXT_OVERRIDE;
 
   OSMetaClassDeclareReservedUnused(IOSharedInterruptController, 0);
   OSMetaClassDeclareReservedUnused(IOSharedInterruptController, 1);