iokit/IOKit/ndrvsupport/IONDRVSupport.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 #ifndef __IONDRVSUPPORT__
  24 #define __IONDRVSUPPORT__
  25
  26 #include <libkern/OSTypes.h>
  27
  28 #pragma options align=mac68k
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 #define kIONDRVIgnoreKey        "AAPL,iokit-ignore-ndrv"
  35 #define kIONDRVForXKey          "AAPL,iokit-ndrv"
  36
  37 struct IOTVector {
  38     void *      pc;
  39     UInt32      toc;
  40 };
  41 typedef struct IOTVector IOTVector;
  42
  43 struct IONDRVInterruptSetMember {
  44         void *          setID;
  45         UInt32          member;
  46 };
  47 typedef struct IONDRVInterruptSetMember IONDRVInterruptSetMember;
  48
  49 typedef SInt32  (*IONDRVInterruptHandler)( IONDRVInterruptSetMember setMember, void *refCon, UInt32 theIntCount);
  50 typedef void    (*IONDRVInterruptEnabler)( IONDRVInterruptSetMember setMember, void *refCon);
  51 typedef Boolean (*IONDRVInterruptDisabler)( IONDRVInterruptSetMember setMember, void *refCon);
  52
  53 enum {
  54     kIONDRVFirstMemberNumber                    = 1,
  55     kIONDRVIsrIsComplete                        = 0,
  56     kIONDRVIsrIsNotComplete                     = -1,
  57     kIONDRVMemberNumberParent                   = -2
  58 };
  59
  60 enum {
  61     kIONDRVReturnToParentWhenComplete           = 0x00000001,
  62     kIONDRVReturnToParentWhenNotComplete        = 0x00000002
  63 };
  64
  65 enum {
  66     kIONDRVISTChipInterruptSource               = 0,
  67     kIONDRVISTOutputDMAInterruptSource          = 1,
  68     kIONDRVISTInputDMAInterruptSource           = 2,
  69     kIONDRVISTPropertyMemberCount               = 3
  70 };
  71
  72 #define kIONDRVISTPropertyName  "driver-ist"
  73
  74 IOReturn
  75 IONDRVInstallInterruptFunctions(void *  setID,
  76                                 UInt32  member,
  77                                 void *  refCon,
  78                                 IOTVector * handler,
  79                                 IOTVector * enabler,
  80                                 IOTVector * disabler );
  81
  82 typedef const IOTVector * (*IONDRVUndefinedSymbolHandler)( void * self,
  83                             const char * libraryName, const char * symbolName );
  84
  85 #pragma options align=reset
  86
  87 #ifdef __cplusplus
  88 }
  89 #endif
  90
  91 #endif /* __IONDRVSUPPORT__ */