[apple/xnu.git] / iokit / IOKit / IODeviceTreeSupport.h

/*
 * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1998 Apple Computer, Inc.  All rights reserved. 
 *
 * HISTORY
 *
 */

#ifndef _IOKIT_IODEVICETREE_H
#define _IOKIT_IODEVICETREE_H

#include <IOKit/IORegistryEntry.h>
#include <libkern/c++/OSData.h>

class IODeviceMemory;
class IOService;

extern const IORegistryPlane *	gIODTPlane;

extern const OSSymbol *		gIODTPHandleKey;

extern const OSSymbol *		gIODTCompatibleKey;
extern const OSSymbol * 	gIODTTypeKey;
extern const OSSymbol * 	gIODTModelKey;

extern const OSSymbol *		gIODTAAPLInterruptsKey;
extern const OSSymbol *		gIODTDefaultInterruptController;
extern const OSSymbol *		gIODTNWInterruptMappingKey;

IORegistryEntry * IODeviceTreeAlloc( void * dtTop );


bool IODTMatchNubWithKeys( IORegistryEntry * nub,
                                    const char * keys );

bool IODTCompareNubName( const IORegistryEntry * regEntry,
			 OSString * name, OSString ** matchingName );

enum {
    kIODTRecursive	= 0x00000001,
    kIODTExclusive	= 0x00000002
};

OSCollectionIterator * IODTFindMatchingEntries( IORegistryEntry * from,
			IOOptionBits options, const char * keys );

typedef SInt32 (*IODTCompareAddressCellFunc)
	(UInt32 cellCount, UInt32 left[], UInt32 right[]);
typedef void (*IODTNVLocationFunc)
	(IORegistryEntry * entry,
	UInt8 * busNum, UInt8 * deviceNum, UInt8 * functionNum );

void IODTSetResolving( IORegistryEntry * 	regEntry,
		IODTCompareAddressCellFunc	compareFunc,
		IODTNVLocationFunc		locationFunc );

bool IODTResolveAddressCell( IORegistryEntry * regEntry,
                             UInt32 cellsIn[],
                             IOPhysicalAddress * phys, IOPhysicalLength * len );

OSArray * IODTResolveAddressing( IORegistryEntry * regEntry,
			const char * addressPropertyName,
			IODeviceMemory * parent );

struct IONVRAMDescriptor {
    unsigned int format:4;
    unsigned int marker:1;
    unsigned int bridgeCount:3;
    unsigned int busNum:2;
    unsigned int bridgeDevices:6 * 5;
    unsigned int functionNum:3;
    unsigned int deviceNum:5;
} __attribute__((aligned(2), packed));

IOReturn IODTMakeNVDescriptor( IORegistryEntry * regEntry,
				IONVRAMDescriptor * hdr );

OSData * IODTFindSlotName( IORegistryEntry * regEntry, UInt32 deviceNumber );

const OSSymbol * IODTInterruptControllerName(
			IORegistryEntry * regEntry );

bool IODTMapInterrupts( IORegistryEntry * regEntry );

enum {
    kIODTInterruptShared = 0x00000001
};
IOReturn IODTGetInterruptOptions( IORegistryEntry * regEntry, int source, IOOptionBits * options );

#ifdef __cplusplus
extern "C" {
#endif

IOReturn IONDRVLibrariesInitialize( IOService * provider );

#ifdef __cplusplus
}
#endif

#endif /* _IOKIT_IODEVICETREE_H */
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	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
2d21ac55 A	46	extern const OSSymbol * gIODTPHandleKey;
2d21ac55 A	47
1c79356b A	48	extern const OSSymbol * gIODTCompatibleKey;
	49	extern const OSSymbol * gIODTTypeKey;
	50	extern const OSSymbol * gIODTModelKey;
	51
	52	extern const OSSymbol * gIODTAAPLInterruptsKey;
	53	extern const OSSymbol * gIODTDefaultInterruptController;
	54	extern const OSSymbol * gIODTNWInterruptMappingKey;
	55
	56	IORegistryEntry * IODeviceTreeAlloc( void * dtTop );
	57
	58
	59	bool IODTMatchNubWithKeys( IORegistryEntry * nub,
	60	const char * keys );
	61
	62	bool IODTCompareNubName( const IORegistryEntry * regEntry,
	63	OSString * name, OSString ** matchingName );
	64
	65	enum {
	66	kIODTRecursive = 0x00000001,
55e303ae	67	kIODTExclusive = 0x00000002
1c79356b A	68	};
	69
	70	OSCollectionIterator * IODTFindMatchingEntries( IORegistryEntry * from,
	71	IOOptionBits options, const char * keys );
	72
	73	typedef SInt32 (*IODTCompareAddressCellFunc)
	74	(UInt32 cellCount, UInt32 left[], UInt32 right[]);
	75	typedef void (*IODTNVLocationFunc)
	76	(IORegistryEntry * entry,
	77	UInt8 * busNum, UInt8 * deviceNum, UInt8 * functionNum );
	78
	79	void IODTSetResolving( IORegistryEntry * regEntry,
	80	IODTCompareAddressCellFunc compareFunc,
	81	IODTNVLocationFunc locationFunc );
	82
	83	bool IODTResolveAddressCell( IORegistryEntry * regEntry,
	84	UInt32 cellsIn[],
	85	IOPhysicalAddress * phys, IOPhysicalLength * len );
	86
	87	OSArray * IODTResolveAddressing( IORegistryEntry * regEntry,
	88	const char * addressPropertyName,
	89	IODeviceMemory * parent );
	90
1c79356b A	91	struct IONVRAMDescriptor {
	92	unsigned int format:4;
	93	unsigned int marker:1;
	94	unsigned int bridgeCount:3;
	95	unsigned int busNum:2;
	96	unsigned int bridgeDevices:6 * 5;
	97	unsigned int functionNum:3;
	98	unsigned int deviceNum:5;
b0d623f7	99	} __attribute__((aligned(2), packed));
1c79356b A	100
	101	IOReturn IODTMakeNVDescriptor( IORegistryEntry * regEntry,
	102	IONVRAMDescriptor * hdr );
	103
	104	OSData * IODTFindSlotName( IORegistryEntry * regEntry, UInt32 deviceNumber );
	105
	106	const OSSymbol * IODTInterruptControllerName(
	107	IORegistryEntry * regEntry );
	108
	109	bool IODTMapInterrupts( IORegistryEntry * regEntry );
	110
91447636 A	111	enum {
	112	kIODTInterruptShared = 0x00000001
	113	};
	114	IOReturn IODTGetInterruptOptions( IORegistryEntry * regEntry, int source, IOOptionBits * options );
	115
1c79356b A	116	#ifdef __cplusplus
	117	extern "C" {
	118	#endif
	119
	120	IOReturn IONDRVLibrariesInitialize( IOService * provider );
	121
	122	#ifdef __cplusplus
	123	}
	124	#endif
	125
	126	#endif /* _IOKIT_IODEVICETREE_H */
	127