xnu-6153.81.5.tar.gz

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

diff --git a/iokit/IOKit/IOInterruptController.h b/iokit/IOKit/IOInterruptController.h
index d389a79e3eeead3e78e3e1169fac48b5236cbbd2..53bdcf529dd3430932db8e52cb56782b30af6d3d 100644 (file)
--- a/iokit/IOKit/IOInterruptController.h
+++ b/iokit/IOKit/IOInterruptController.h
@@ -2,7 +2,7 @@
  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@

- * 
+ *

  * 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
  * 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


@@ -11,10 +11,10 @@
  * 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.
  * 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.

- * 
+ *

  * Please obtain a copy of the License at
  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  * 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,
  * 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,


@@ -22,14 +22,14 @@
  * 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.
  * 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_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
  * Copyright (c) 1999 Apple Computer, Inc.  All rights reserved.
  *
  *  DRI: Josh de Cesare
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 /*
  * Copyright (c) 1999 Apple Computer, Inc.  All rights reserved.
  *
  *  DRI: Josh de Cesare

- *  
+ *

  */
 
 
  */
 
 


@@ -44,17 +44,17 @@
 class IOSharedInterruptController;
 
 struct IOInterruptVector {
 class IOSharedInterruptController;
 
 struct IOInterruptVector {

-  volatile char               interruptActive;
-  volatile char               interruptDisabledSoft;
-  volatile char               interruptDisabledHard;
-  volatile char               interruptRegistered;
-  IOLock *                    interruptLock;
-  IOService *                 nub;
-  int                         source;
-  void *                      target;
-  IOInterruptHandler          handler;
-  void *                      refCon;
-  IOSharedInterruptController *sharedController;
+       volatile char               interruptActive;
+       volatile char               interruptDisabledSoft;
+       volatile char               interruptDisabledHard;
+       volatile char               interruptRegistered;
+       IOLock *                    interruptLock;
+       IOService *                 nub;
+       int                         source;
+       void *                      target;
+       IOInterruptHandler          handler;
+       void *                      refCon;
+       IOSharedInterruptController *sharedController;

 };
 
 typedef struct IOInterruptVector IOInterruptVector;
 };
 
 typedef struct IOInterruptVector IOInterruptVector;


@@ -67,88 +67,98 @@ typedef long IOInterruptVectorNumber;
 
 class IOInterruptController : public IOService
 {
 
 class IOInterruptController : public IOService
 {

-  OSDeclareAbstractStructors(IOInterruptController);
+       OSDeclareAbstractStructors(IOInterruptController);

 
 protected:
 
 protected:

-  IOInterruptVector *vectors;
-  IOSimpleLock      *controllerLock;
+       IOInterruptVector *vectors;
+       IOSimpleLock      *controllerLock;
+
+       struct ExpansionData { };
+       ExpansionData *ioic_reserved;

 
 

-  struct ExpansionData { };
-  ExpansionData *reserved;
+public:
+       virtual IOReturn registerInterrupt(IOService *nub, int source,
+           void *target,
+           IOInterruptHandler handler,
+           void *refCon);
+       virtual IOReturn unregisterInterrupt(IOService *nub, int source);
+
+       virtual IOReturn getInterruptType(IOService *nub, int source,
+           int *interruptType);
+
+       virtual IOReturn enableInterrupt(IOService *nub, int source);
+       virtual IOReturn disableInterrupt(IOService *nub, int source);
+       virtual IOReturn causeInterrupt(IOService *nub, int source);
+
+       virtual IOInterruptAction getInterruptHandlerAddress(void);
+       virtual IOReturn handleInterrupt(void *refCon, IOService *nub,
+           int source);
+
+// Methods to be overridden for simplifed interrupt controller subclasses.
+
+       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);
+       OSMetaClassDeclareReservedUnused(IOInterruptController, 2);
+       OSMetaClassDeclareReservedUnused(IOInterruptController, 3);
+       OSMetaClassDeclareReservedUnused(IOInterruptController, 4);
+       OSMetaClassDeclareReservedUnused(IOInterruptController, 5);

 
 public:
 
 public:

-  virtual IOReturn registerInterrupt(IOService *nub, int source,
-                                    void *target,
-                                    IOInterruptHandler handler,
-                                    void *refCon);
-  virtual IOReturn unregisterInterrupt(IOService *nub, int source);
-  
-  virtual IOReturn getInterruptType(IOService *nub, int source,
-                                   int *interruptType);
-  
-  virtual IOReturn enableInterrupt(IOService *nub, int source);
-  virtual IOReturn disableInterrupt(IOService *nub, int source);
-  virtual IOReturn causeInterrupt(IOService *nub, int source);
-  
-  virtual IOInterruptAction getInterruptHandlerAddress(void);
-  virtual IOReturn handleInterrupt(void *refCon, IOService *nub,
-                                  int source);
-  
-  // Methods to be overridden for simplifed interrupt controller subclasses.
-  
-  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);
-  OSMetaClassDeclareReservedUnused(IOInterruptController, 2);
-  OSMetaClassDeclareReservedUnused(IOInterruptController, 3);
-  OSMetaClassDeclareReservedUnused(IOInterruptController, 4);
-  OSMetaClassDeclareReservedUnused(IOInterruptController, 5);
+// 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);

 };
 
 
 class IOSharedInterruptController : public IOInterruptController
 {
 };
 
 
 class IOSharedInterruptController : public IOInterruptController
 {

-  OSDeclareDefaultStructors(IOSharedInterruptController);
-  
+       OSDeclareDefaultStructors(IOSharedInterruptController);
+

 private:
 private:

-  IOService         *provider;
-  int               numVectors;
-  int               vectorsRegistered;
-  int               vectorsEnabled;
-  volatile int      controllerDisabled;
-  bool              sourceIsLevel;
+       IOService         *provider;
+       int               numVectors;
+       int               vectorsRegistered;
+       int               vectorsEnabled;
+       volatile int      controllerDisabled;
+       bool              sourceIsLevel;

 
 

-  struct ExpansionData { };
-  ExpansionData *reserved;
+       struct ExpansionData { };
+       ExpansionData *iosic_reserved __unused;

 
 public:
 
 public:

-  virtual IOReturn initInterruptController(IOInterruptController *parentController, OSData *parentSource);
-  
-  virtual IOReturn registerInterrupt(IOService *nub, int source,
-                                     void *target,
-                                     IOInterruptHandler handler,
-                                     void *refCon) APPLE_KEXT_OVERRIDE;
-  virtual IOReturn unregisterInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
-  
-  virtual IOReturn getInterruptType(IOService *nub, int source,
-                                   int *interruptType) APPLE_KEXT_OVERRIDE;
-  
-  virtual IOReturn enableInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
-  virtual IOReturn disableInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
-  
-  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);
-  OSMetaClassDeclareReservedUnused(IOSharedInterruptController, 2);
-  OSMetaClassDeclareReservedUnused(IOSharedInterruptController, 3);
+       virtual IOReturn initInterruptController(IOInterruptController *parentController, OSData *parentSource);
+
+       virtual IOReturn registerInterrupt(IOService *nub, int source,
+           void *target,
+           IOInterruptHandler handler,
+           void *refCon) APPLE_KEXT_OVERRIDE;
+       virtual IOReturn unregisterInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
+
+       virtual IOReturn getInterruptType(IOService *nub, int source,
+           int *interruptType) APPLE_KEXT_OVERRIDE;
+
+       virtual IOReturn enableInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
+       virtual IOReturn disableInterrupt(IOService *nub, int source) APPLE_KEXT_OVERRIDE;
+
+       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);
+       OSMetaClassDeclareReservedUnused(IOSharedInterruptController, 2);
+       OSMetaClassDeclareReservedUnused(IOSharedInterruptController, 3);

 };
 
 
 };