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

/*
 * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This 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 OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * Copyright (c) 1999 Apple Computer, Inc.  All rights reserved. 
 *
 * Common symbol definitions for IOKit. 
 *
 * HISTORY
 *
 */


#ifndef _IOKIT_IOKITKEYS_H
#define _IOKIT_IOKITKEYS_H

// properties found in the registry root
#define kIOKitBuildVersionKey		"IOKitBuildVersion"
#define kIOKitDiagnosticsKey		"IOKitDiagnostics"
	// a dictionary keyed by plane name
#define kIORegistryPlanesKey		"IORegistryPlanes"
#define kIOCatalogueKey			"IOCatalogue"

// registry plane names
#define kIOServicePlane			"IOService"
#define kIOPowerPlane			"IOPower"
#define kIODeviceTreePlane		"IODeviceTree"
#define kIOAudioPlane			"IOAudio"
#define kIOFireWirePlane		"IOFireWire"
#define kIOUSBPlane			"IOUSB"

// IOService class name
#define kIOServiceClass			"IOService"

// IOResources class name
#define kIOResourcesClass		"IOResources"

// IOService driver probing property names
#define kIOClassKey			"IOClass"
#define kIOProbeScoreKey		"IOProbeScore"
#define kIOKitDebugKey			"IOKitDebug"

// IOService matching property names
#define kIOProviderClassKey		"IOProviderClass"
#define kIONameMatchKey			"IONameMatch"
#define kIOPropertyMatchKey		"IOPropertyMatch"
#define kIOPathMatchKey			"IOPathMatch"
#define kIOLocationMatchKey		"IOLocationMatch"
#define kIOParentMatchKey		"IOParentMatch"
#define kIOResourceMatchKey		"IOResourceMatch"
#define kIOMatchedServiceCountKey	"IOMatchedServiceCountMatch"

#define kIONameMatchedKey		"IONameMatched"

#define kIOMatchCategoryKey		"IOMatchCategory"
#define kIODefaultMatchCategoryKey	"IODefaultMatchCategory"

// IOService default user client class, for loadable user clients
#define kIOUserClientClassKey		"IOUserClientClass"

// IOService notification types
#define kIOPublishNotification		"IOServicePublish"
#define kIOFirstPublishNotification	"IOServiceFirstPublish"
#define kIOMatchedNotification		"IOServiceMatched"
#define kIOFirstMatchNotification	"IOServiceFirstMatch"
#define kIOTerminatedNotification	"IOServiceTerminate"

// IOService interest notification types
#define kIOGeneralInterest		"IOGeneralInterest"
#define kIOBusyInterest			"IOBusyInterest"
#define kIOAppPowerStateInterest	"IOAppPowerStateInterest"
#define kIOPriorityPowerStateInterest	"IOPriorityPowerStateInterest"

// IOService interest notification types
#define kIOCFPlugInTypesKey		"IOCFPlugInTypes"

// properties found in services that implement command pooling
#define kIOCommandPoolSizeKey	       "IOCommandPoolSize"          // (OSNumber)

// properties found in services that have transfer constraints
#define kIOMaximumBlockCountReadKey    "IOMaximumBlockCountRead"    // (OSNumber)
#define kIOMaximumBlockCountWriteKey   "IOMaximumBlockCountWrite"   // (OSNumber)
#define kIOMaximumSegmentCountReadKey  "IOMaximumSegmentCountRead"  // (OSNumber)
#define kIOMaximumSegmentCountWriteKey "IOMaximumSegmentCountWrite" // (OSNumber)

// properties found in services that wish to describe an icon
//
// IOIcon = 
// {
//     CFBundleIdentifier   = "com.example.driver.example";
//     IOBundleResourceFile = "example.icns";
// };
//
// where IOBundleResourceFile is the filename of the resource

#define kIOIconKey               "IOIcon"               // (OSDictionary)
#define kIOBundleResourceFileKey "IOBundleResourceFile" // (OSString)

#define kIOBusBadgeKey           "IOBusBadge"           // (OSDictionary)
#define kIODeviceIconKey         "IODeviceIcon"         // (OSDictionary)

#endif /* ! _IOKIT_IOKITKEYS_H */
Commit	Line	Data
1c79356b A	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	* Common symbol definitions for IOKit.
	26	*
	27	* HISTORY
	28	*
	29	*/
	30
	31
	32	#ifndef _IOKIT_IOKITKEYS_H
	33	#define _IOKIT_IOKITKEYS_H
	34
	35	// properties found in the registry root
	36	#define kIOKitBuildVersionKey "IOKitBuildVersion"
	37	#define kIOKitDiagnosticsKey "IOKitDiagnostics"
	38	// a dictionary keyed by plane name
	39	#define kIORegistryPlanesKey "IORegistryPlanes"
	40	#define kIOCatalogueKey "IOCatalogue"
	41
	42	// registry plane names
	43	#define kIOServicePlane "IOService"
	44	#define kIOPowerPlane "IOPower"
	45	#define kIODeviceTreePlane "IODeviceTree"
	46	#define kIOAudioPlane "IOAudio"
	47	#define kIOFireWirePlane "IOFireWire"
	48	#define kIOUSBPlane "IOUSB"
	49
	50	// IOService class name
	51	#define kIOServiceClass "IOService"
	52
	53	// IOResources class name
	54	#define kIOResourcesClass "IOResources"
	55
	56	// IOService driver probing property names
	57	#define kIOClassKey "IOClass"
	58	#define kIOProbeScoreKey "IOProbeScore"
	59	#define kIOKitDebugKey "IOKitDebug"
	60
	61	// IOService matching property names
	62	#define kIOProviderClassKey "IOProviderClass"
	63	#define kIONameMatchKey "IONameMatch"
	64	#define kIOPropertyMatchKey "IOPropertyMatch"
65	#define kIOPathMatchKey "IOPathMatch"
66	#define kIOLocationMatchKey "IOLocationMatch"
9bccf70c	67	#define kIOParentMatchKey "IOParentMatch"
1c79356b A	68	#define kIOResourceMatchKey "IOResourceMatch"
	69	#define kIOMatchedServiceCountKey "IOMatchedServiceCountMatch"
	70
	71	#define kIONameMatchedKey "IONameMatched"
	72
	73	#define kIOMatchCategoryKey "IOMatchCategory"
	74	#define kIODefaultMatchCategoryKey "IODefaultMatchCategory"
	75
	76	// IOService default user client class, for loadable user clients
	77	#define kIOUserClientClassKey "IOUserClientClass"
	78
	79	// IOService notification types
	80	#define kIOPublishNotification "IOServicePublish"
	81	#define kIOFirstPublishNotification "IOServiceFirstPublish"
	82	#define kIOMatchedNotification "IOServiceMatched"
	83	#define kIOFirstMatchNotification "IOServiceFirstMatch"
	84	#define kIOTerminatedNotification "IOServiceTerminate"
	85
	86	// IOService interest notification types
	87	#define kIOGeneralInterest "IOGeneralInterest"
	88	#define kIOBusyInterest "IOBusyInterest"
	89	#define kIOAppPowerStateInterest "IOAppPowerStateInterest"
0b4e3aa0	90	#define kIOPriorityPowerStateInterest "IOPriorityPowerStateInterest"
1c79356b A	91
	92	// IOService interest notification types
	93	#define kIOCFPlugInTypesKey "IOCFPlugInTypes"
	94
	95	// properties found in services that implement command pooling
0b4e3aa0 A	96	#define kIOCommandPoolSizeKey "IOCommandPoolSize" // (OSNumber)
	97
	98	// properties found in services that have transfer constraints
	99	#define kIOMaximumBlockCountReadKey "IOMaximumBlockCountRead" // (OSNumber)
	100	#define kIOMaximumBlockCountWriteKey "IOMaximumBlockCountWrite" // (OSNumber)
	101	#define kIOMaximumSegmentCountReadKey "IOMaximumSegmentCountRead" // (OSNumber)
	102	#define kIOMaximumSegmentCountWriteKey "IOMaximumSegmentCountWrite" // (OSNumber)
1c79356b	103
9bccf70c A	104	// properties found in services that wish to describe an icon
	105	//
	106	// IOIcon =
	107	// {
	108	// CFBundleIdentifier = "com.example.driver.example";
	109	// IOBundleResourceFile = "example.icns";
	110	// };
	111	//
	112	// where IOBundleResourceFile is the filename of the resource
	113
	114	#define kIOIconKey "IOIcon" // (OSDictionary)
	115	#define kIOBundleResourceFileKey "IOBundleResourceFile" // (OSString)
1c79356b	116
9bccf70c A	117	#define kIOBusBadgeKey "IOBusBadge" // (OSDictionary)
	118	#define kIODeviceIconKey "IODeviceIcon" // (OSDictionary)
	119
	120	#endif /* ! _IOKIT_IOKITKEYS_H */