iokit/Examples/drvGenericInterruptController/GenericInterruptController.h

   1 /*
   2  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*
  24  * Copyright (c) 1999 Apple Computer, Inc.  All rights reserved.
  25  *
  26  *  DRI: Josh de Cesare
  27  *
  28  */
  29
  30 #ifndef _IOKIT_GENERICINTERRUPTCONTROLLER_H
  31 #define _IOKIT_GENERICINTERRUPTCONTROLLER_H
  32
  33 #include <IOKit/IOInterrupts.h>
  34 #include <IOKit/IOInterruptController.h>
  35
  36 class GenericInterruptController : public IOInterruptController
  37 {
  38   IODeclareDefaultStructors(GenericInterruptController);
  39
  40 public:
  41   // There should be a method to start or init the controller.
  42   // Its nature is up to you.
  43   virtual bool start(IOService *provider);
  44
  45   // Returns the type of a vector: level or edge.  This will probably get
  46   // replaced but a default method and a new method getVectorType.
  47   virtual IOReturn getInterruptType(IOService *nub, int source,
  48                                     int *interruptType);
  49
  50   // Returns a function pointer for the interrupt handler.
  51   // Sadly, egcs prevents this from being done by the base class.
  52   virtual IOInterruptAction getInterruptHandlerAddress(void);
  53
  54   // The actual interrupt handler.
  55   virtual IOReturn handleInterrupt(void *refCon,
  56                                    IOService *nub, int source);
  57
  58
  59   // Should return true if this vector can be shared.
  60   // The base class return false, so this method only need to be implemented
  61   // if the controller needs to support shared interrupts.
  62   // No other work is required to support shared interrupts.
  63   virtual bool vectorCanBeShared(long vectorNumber, IOInterruptVector *vector);
  64
  65   // Do any hardware initalization for this vector.  Leave the vector
  66   // hard disabled.
  67   virtual void initVector(long vectorNumber, IOInterruptVector *vector);
  68
  69   // Disable this vector at the hardware.
  70   virtual void disableVectorHard(long vectorNumber, IOInterruptVector *vector);
  71
  72   // Enable this vector at the hardware.
  73   virtual void enableVector(long vectorNumber, IOInterruptVector *vector);
  74
  75   // Cause an interrupt on this vector.
  76   virtual void causeVector(long vectorNumber, IOInterruptVector *vector);
  77 };
  78
  79 #endif /* ! _IOKIT_GENERICINTERRUPTCONTROLLER_H */