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