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