iokit/IOKit/IODeviceTreeSupport.h

   1 /*
   2  * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_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 License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /*
  29  * Copyright (c) 1998 Apple Computer, Inc.  All rights reserved.
  30  *
  31  * HISTORY
  32  *
  33  */
  34
  35 #ifndef _IOKIT_IODEVICETREE_H
  36 #define _IOKIT_IODEVICETREE_H
  37
  38 #include <IOKit/IORegistryEntry.h>
  39 #include <libkern/c++/OSData.h>
  40
  41 class IODeviceMemory;
  42 class IOService;
  43
  44 extern const IORegistryPlane *  gIODTPlane;
  45
  46 extern const OSSymbol *         gIODTPHandleKey;
  47
  48 extern const OSSymbol *         gIODTCompatibleKey;
  49 extern const OSSymbol *         gIODTTypeKey;
  50 extern const OSSymbol *         gIODTModelKey;
  51 extern const OSSymbol *         gIODTTargetTypeKey;
  52
  53 extern const OSSymbol *         gIODTAAPLInterruptsKey;
  54 extern const OSSymbol *         gIODTDefaultInterruptController;
  55 extern const OSSymbol *         gIODTNWInterruptMappingKey;
  56
  57 LIBKERN_RETURNS_NOT_RETAINED IORegistryEntry * IODeviceTreeAlloc( void * dtTop );
  58
  59
  60 bool IODTMatchNubWithKeys( IORegistryEntry * nub,
  61     const char * keys );
  62
  63 bool IODTCompareNubName( const IORegistryEntry * regEntry,
  64     OSString * name,
  65     LIBKERN_RETURNS_RETAINED_ON_NONZERO OSString ** matchingName );
  66
  67 enum {
  68         kIODTRecursive      = 0x00000001,
  69         kIODTExclusive      = 0x00000002
  70 };
  71
  72 OSCollectionIterator * IODTFindMatchingEntries( IORegistryEntry * from,
  73     IOOptionBits options, const char * keys );
  74
  75 #if !defined(__arm64__)
  76 typedef SInt32 (*IODTCompareAddressCellFunc)
  77 (UInt32 cellCount, UInt32 left[], UInt32 right[]);
  78 #else
  79 typedef SInt64 (*IODTCompareAddressCellFunc)
  80 (UInt32 cellCount, UInt32 left[], UInt32 right[]);
  81 #endif
  82
  83 typedef void (*IODTNVLocationFunc)
  84 (IORegistryEntry * entry,
  85     UInt8 * busNum, UInt8 * deviceNum, UInt8 * functionNum );
  86
  87 void IODTSetResolving( IORegistryEntry *        regEntry,
  88     IODTCompareAddressCellFunc      compareFunc,
  89     IODTNVLocationFunc              locationFunc );
  90
  91 void IODTGetCellCounts( IORegistryEntry * regEntry,
  92     UInt32 * sizeCount, UInt32 * addressCount);
  93
  94 bool IODTResolveAddressCell( IORegistryEntry * regEntry,
  95     UInt32 cellsIn[],
  96     IOPhysicalAddress * phys, IOPhysicalLength * len );
  97
  98 LIBKERN_RETURNS_NOT_RETAINED OSArray *
  99 IODTResolveAddressing( IORegistryEntry * regEntry,
 100     const char * addressPropertyName,
 101     IODeviceMemory * parent );
 102
 103 struct IONVRAMDescriptor {
 104         unsigned int format:4;
 105         unsigned int marker:1;
 106         unsigned int bridgeCount:3;
 107         unsigned int busNum:2;
 108         unsigned int bridgeDevices:6 * 5;
 109         unsigned int functionNum:3;
 110         unsigned int deviceNum:5;
 111 } __attribute__((aligned(2), packed));
 112
 113 IOReturn IODTMakeNVDescriptor( IORegistryEntry * regEntry,
 114     IONVRAMDescriptor * hdr );
 115
 116 LIBKERN_RETURNS_NOT_RETAINED OSData *
 117 IODTFindSlotName( IORegistryEntry * regEntry, UInt32 deviceNumber );
 118
 119 const OSSymbol * IODTInterruptControllerName(
 120         IORegistryEntry * regEntry );
 121
 122 bool IODTMapInterrupts( IORegistryEntry * regEntry );
 123
 124 enum {
 125         kIODTInterruptShared = 0x00000001
 126 };
 127 IOReturn IODTGetInterruptOptions( IORegistryEntry * regEntry, int source, IOOptionBits * options );
 128
 129 #ifdef __cplusplus
 130 extern "C" {
 131 #endif
 132
 133 IOReturn IONDRVLibrariesInitialize( IOService * provider );
 134
 135 #ifdef __cplusplus
 136 }
 137 #endif
 138
 139 #endif /* _IOKIT_IODEVICETREE_H */