iokit/Drivers/platform/drvAppleOHare/OHare.h

   1 /*
   2  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * The contents of this file constitute Original Code as defined in and
   7  * are subject to the Apple Public Source License Version 1.1 (the
   8  * "License").  You may not use this file except in compliance with the
   9  * License.  Please obtain a copy of the License at
  10  * http://www.apple.com/publicsource and read it before using this file.
  11  *
  12  * This Original Code and all software distributed under the License are
  13  * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  14  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  15  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  16  * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
  17  * License for the specific language governing rights and limitations
  18  * under the License.
  19  *
  20  * @APPLE_LICENSE_HEADER_END@
  21  */
  22 /*
  23  * Copyright (c) 1999 Apple Computer, Inc.  All rights reserved.
  24  *
  25  *  DRI: Josh de Cesare
  26  *
  27  */
  28
  29 #ifndef _IOKIT_OHARE_H
  30 #define _IOKIT_OHARE_H
  31
  32 #include <IOKit/platform/AppleMacIO.h>
  33
  34 #include <IOKit/IOInterrupts.h>
  35 #include <IOKit/IOInterruptController.h>
  36
  37 #define kPrimaryOHare    (0)
  38 #define kSecondaryOHare  (1)
  39
  40 #define kNumVectors      (32)
  41
  42 #define kTypeLevelMask   (0x1FF00000)
  43
  44 #define kEventsOffset    (0x00020)
  45 #define kMaskOffset      (0x00024)
  46 #define kClearOffset     (0x00028)
  47 #define kLevelsOffset    (0x0002C)
  48
  49
  50 class OHareInterruptController;
  51
  52 class OHare : public AppleMacIO
  53 {
  54   OSDeclareDefaultStructors(OHare);
  55
  56 private:
  57   IOLogicalAddress         ohareBaseAddress;
  58   long                     ohareNum;
  59   OHareInterruptController *interruptController;
  60
  61   virtual OSSymbol *getInterruptControllerName(void);
  62
  63 public:
  64   virtual bool start(IOService *provider);
  65 };
  66
  67
  68 class OHareInterruptController : public IOInterruptController
  69 {
  70   OSDeclareDefaultStructors(OHareInterruptController);
  71
  72 private:
  73   IOService         *parentNub;
  74   IOLock            *taskLock;
  75   unsigned long     pendingEvents;
  76   unsigned long     eventsReg;
  77   unsigned long     maskReg;
  78   unsigned long     clearReg;
  79   unsigned long     levelsReg;
  80
  81 public:
  82   virtual IOReturn initInterruptController(IOService *provider,
  83                                            IOLogicalAddress interruptControllerBase);
  84
  85   virtual IOInterruptAction getInterruptHandlerAddress(void);
  86   virtual IOReturn handleInterrupt(void *refCon, IOService *nub, int source);
  87
  88   virtual bool vectorCanBeShared(long vectorNumber, IOInterruptVector *vector);
  89   virtual int  getVectorType(long vectorNumber, IOInterruptVector *vector);
  90   virtual void disableVectorHard(long vectorNumber, IOInterruptVector *vector);
  91   virtual void enableVector(long vectorNumber, IOInterruptVector *vector);
  92   virtual void causeVector(long vectorNumber, IOInterruptVector *vector);
  93 };
  94
  95
  96 #endif /* ! _IOKIT_OHARE_H */