iokit/Examples/drvGenericInterruptController/GenericInterruptController.h

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