this repo has no description
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
41class IODeviceMemory;
42class IOService;
43
44extern const IORegistryPlane * gIODTPlane;
45
46extern const OSSymbol * gIODTPHandleKey;
47
48extern const OSSymbol * gIODTCompatibleKey;
49extern const OSSymbol * gIODTTypeKey;
50extern const OSSymbol * gIODTModelKey;
51extern const OSSymbol * gIODTTargetTypeKey;
52
53extern const OSSymbol * gIODTAAPLInterruptsKey;
54extern const OSSymbol * gIODTDefaultInterruptController;
55extern const OSSymbol * gIODTNWInterruptMappingKey;
56
57IORegistryEntry * IODeviceTreeAlloc( void * dtTop );
58
59
60bool IODTMatchNubWithKeys( IORegistryEntry * nub,
61 const char * keys );
62
63bool IODTCompareNubName( const IORegistryEntry * regEntry,
64 OSString * name, OSString ** matchingName );
65
66enum {
67 kIODTRecursive = 0x00000001,
68 kIODTExclusive = 0x00000002
69};
70
71OSCollectionIterator * IODTFindMatchingEntries( IORegistryEntry * from,
72 IOOptionBits options, const char * keys );
73
74typedef SInt32 (*IODTCompareAddressCellFunc)
75 (UInt32 cellCount, UInt32 left[], UInt32 right[]);
76
77typedef void (*IODTNVLocationFunc)
78 (IORegistryEntry * entry,
79 UInt8 * busNum, UInt8 * deviceNum, UInt8 * functionNum );
80
81void IODTSetResolving( IORegistryEntry * regEntry,
82 IODTCompareAddressCellFunc compareFunc,
83 IODTNVLocationFunc locationFunc );
84
85void IODTGetCellCounts( IORegistryEntry * regEntry,
86 UInt32 * sizeCount, UInt32 * addressCount);
87
88bool IODTResolveAddressCell( IORegistryEntry * regEntry,
89 UInt32 cellsIn[],
90 IOPhysicalAddress * phys, IOPhysicalLength * len );
91
92OSArray * IODTResolveAddressing( IORegistryEntry * regEntry,
93 const char * addressPropertyName,
94 IODeviceMemory * parent );
95
96struct IONVRAMDescriptor {
97 unsigned int format:4;
98 unsigned int marker:1;
99 unsigned int bridgeCount:3;
100 unsigned int busNum:2;
101 unsigned int bridgeDevices:6 * 5;
102 unsigned int functionNum:3;
103 unsigned int deviceNum:5;
104} __attribute__((aligned(2), packed));
105
106IOReturn IODTMakeNVDescriptor( IORegistryEntry * regEntry,
107 IONVRAMDescriptor * hdr );
108
109OSData * IODTFindSlotName( IORegistryEntry * regEntry, UInt32 deviceNumber );
110
111const OSSymbol * IODTInterruptControllerName(
112 IORegistryEntry * regEntry );
113
114bool IODTMapInterrupts( IORegistryEntry * regEntry );
115
116enum {
117 kIODTInterruptShared = 0x00000001
118};
119IOReturn IODTGetInterruptOptions( IORegistryEntry * regEntry, int source, IOOptionBits * options );
120
121#ifdef __cplusplus
122extern "C" {
123#endif
124
125IOReturn IONDRVLibrariesInitialize( IOService * provider );
126
127#ifdef __cplusplus
128}
129#endif
130
131#endif /* _IOKIT_IODEVICETREE_H */
132