[apple/xnu.git] / iokit / IOKit / IOKitKeys.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) 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"

// registry ID number
#define kIORegistryEntryIDKey		"IORegistryEntryID"

// 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"

// key to find IOMappers
#define kIOMapperIDKey				"IOMapperID"

#define kIOUserClientCrossEndianKey		"IOUserClientCrossEndian"
#define kIOUserClientCrossEndianCompatibleKey	"IOUserClientCrossEndianCompatible"
#define kIOUserClientSharedInstanceKey		"IOUserClientSharedInstance"
// diagnostic string describing the creating task
#define kIOUserClientCreatorKey		"IOUserClientCreator"

// 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"

#define kIOPlatformDeviceMessageKey     "IOPlatformDeviceMessage"

// 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 kIOMaximumByteCountReadKey              "IOMaximumByteCountRead"              // (OSNumber)
#define kIOMaximumByteCountWriteKey             "IOMaximumByteCountWrite"             // (OSNumber)
#define kIOMaximumSegmentCountReadKey           "IOMaximumSegmentCountRead"           // (OSNumber)
#define kIOMaximumSegmentCountWriteKey          "IOMaximumSegmentCountWrite"          // (OSNumber)
#define kIOMaximumSegmentByteCountReadKey       "IOMaximumSegmentByteCountRead"       // (OSNumber)
#define kIOMaximumSegmentByteCountWriteKey      "IOMaximumSegmentByteCountWrite"      // (OSNumber)
#define kIOMinimumSegmentAlignmentByteCountKey  "IOMinimumSegmentAlignmentByteCount"  // (OSNumber)
#define kIOMaximumSegmentAddressableBitCountKey "IOMaximumSegmentAddressableBitCount" // (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)

// property of root that describes the machine's serial number as a string
#define kIOPlatformSerialNumberKey	"IOPlatformSerialNumber"	// (OSString)

// property of root that describes the machine's UUID as a string
#define kIOPlatformUUIDKey	"IOPlatformUUID"	// (OSString)

// IODTNVRAM property keys
#define kIONVRAMDeletePropertyKey	"IONVRAM-DELETE-PROPERTY"
#define kIONVRAMSyncNowPropertyKey	"IONVRAM-SYNCNOW-PROPERTY"
#define kIODTNVRAMPanicInfoKey		"aapl,panic-info"

// keys for complex boot information
#define kIOBootDeviceKey          "IOBootDevice"		// dict | array of dicts
#define kIOBootDevicePathKey      "IOBootDevicePath"	// arch-neutral OSString
#define kIOBootDeviceSizeKey      "IOBootDeviceSize"	// OSNumber of bytes

// keys for OS Version information
#define kOSBuildVersionKey		"OS Build Version"

#endif /* ! _IOKIT_IOKITKEYS_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) 1999 Apple Computer, Inc. All rights reserved.
	30	*
	31	* Common symbol definitions for IOKit.
	32	*
	33	* HISTORY
	34	*
	35	*/
	36
	37
	38	#ifndef _IOKIT_IOKITKEYS_H
	39	#define _IOKIT_IOKITKEYS_H
	40
	41	// properties found in the registry root
	42	#define kIOKitBuildVersionKey "IOKitBuildVersion"
	43	#define kIOKitDiagnosticsKey "IOKitDiagnostics"
	44	// a dictionary keyed by plane name
	45	#define kIORegistryPlanesKey "IORegistryPlanes"
	46	#define kIOCatalogueKey "IOCatalogue"
	47
	48	// registry plane names
	49	#define kIOServicePlane "IOService"
	50	#define kIOPowerPlane "IOPower"
	51	#define kIODeviceTreePlane "IODeviceTree"
	52	#define kIOAudioPlane "IOAudio"
	53	#define kIOFireWirePlane "IOFireWire"
	54	#define kIOUSBPlane "IOUSB"
	55
b0d623f7 A	56	// registry ID number
	57	#define kIORegistryEntryIDKey "IORegistryEntryID"
	58
1c79356b A	59	// IOService class name
	60	#define kIOServiceClass "IOService"
	61
	62	// IOResources class name
	63	#define kIOResourcesClass "IOResources"
	64
	65	// IOService driver probing property names
	66	#define kIOClassKey "IOClass"
	67	#define kIOProbeScoreKey "IOProbeScore"
	68	#define kIOKitDebugKey "IOKitDebug"
	69
	70	// IOService matching property names
	71	#define kIOProviderClassKey "IOProviderClass"
	72	#define kIONameMatchKey "IONameMatch"
	73	#define kIOPropertyMatchKey "IOPropertyMatch"
	74	#define kIOPathMatchKey "IOPathMatch"
	75	#define kIOLocationMatchKey "IOLocationMatch"
9bccf70c	76	#define kIOParentMatchKey "IOParentMatch"
1c79356b A	77	#define kIOResourceMatchKey "IOResourceMatch"
	78	#define kIOMatchedServiceCountKey "IOMatchedServiceCountMatch"
	79
	80	#define kIONameMatchedKey "IONameMatched"
	81
	82	#define kIOMatchCategoryKey "IOMatchCategory"
	83	#define kIODefaultMatchCategoryKey "IODefaultMatchCategory"
	84
	85	// IOService default user client class, for loadable user clients
	86	#define kIOUserClientClassKey "IOUserClientClass"
	87
b0d623f7 A	88	// key to find IOMappers
	89	#define kIOMapperIDKey "IOMapperID"
	90
0c530ab8 A	91	#define kIOUserClientCrossEndianKey "IOUserClientCrossEndian"
	92	#define kIOUserClientCrossEndianCompatibleKey "IOUserClientCrossEndianCompatible"
	93	#define kIOUserClientSharedInstanceKey "IOUserClientSharedInstance"
b0d623f7 A	94	// diagnostic string describing the creating task
b0d623f7 A	95	#define kIOUserClientCreatorKey "IOUserClientCreator"
0c530ab8	96
1c79356b A	97	// IOService notification types
	98	#define kIOPublishNotification "IOServicePublish"
	99	#define kIOFirstPublishNotification "IOServiceFirstPublish"
	100	#define kIOMatchedNotification "IOServiceMatched"
	101	#define kIOFirstMatchNotification "IOServiceFirstMatch"
	102	#define kIOTerminatedNotification "IOServiceTerminate"
	103
	104	// IOService interest notification types
	105	#define kIOGeneralInterest "IOGeneralInterest"
	106	#define kIOBusyInterest "IOBusyInterest"
	107	#define kIOAppPowerStateInterest "IOAppPowerStateInterest"
0b4e3aa0	108	#define kIOPriorityPowerStateInterest "IOPriorityPowerStateInterest"
1c79356b	109
0c530ab8 A	110	#define kIOPlatformDeviceMessageKey "IOPlatformDeviceMessage"
0c530ab8 A	111
1c79356b A	112	// IOService interest notification types
	113	#define kIOCFPlugInTypesKey "IOCFPlugInTypes"
	114
	115	// properties found in services that implement command pooling
0b4e3aa0 A	116	#define kIOCommandPoolSizeKey "IOCommandPoolSize" // (OSNumber)
	117
	118	// properties found in services that have transfer constraints
0c530ab8 A	119	#define kIOMaximumBlockCountReadKey "IOMaximumBlockCountRead" // (OSNumber)
	120	#define kIOMaximumBlockCountWriteKey "IOMaximumBlockCountWrite" // (OSNumber)
	121	#define kIOMaximumByteCountReadKey "IOMaximumByteCountRead" // (OSNumber)
	122	#define kIOMaximumByteCountWriteKey "IOMaximumByteCountWrite" // (OSNumber)
	123	#define kIOMaximumSegmentCountReadKey "IOMaximumSegmentCountRead" // (OSNumber)
	124	#define kIOMaximumSegmentCountWriteKey "IOMaximumSegmentCountWrite" // (OSNumber)
	125	#define kIOMaximumSegmentByteCountReadKey "IOMaximumSegmentByteCountRead" // (OSNumber)
	126	#define kIOMaximumSegmentByteCountWriteKey "IOMaximumSegmentByteCountWrite" // (OSNumber)
	127	#define kIOMinimumSegmentAlignmentByteCountKey "IOMinimumSegmentAlignmentByteCount" // (OSNumber)
	128	#define kIOMaximumSegmentAddressableBitCountKey "IOMaximumSegmentAddressableBitCount" // (OSNumber)
1c79356b	129
9bccf70c A	130	// properties found in services that wish to describe an icon
	131	//
	132	// IOIcon =
	133	// {
	134	// CFBundleIdentifier = "com.example.driver.example";
	135	// IOBundleResourceFile = "example.icns";
	136	// };
	137	//
	138	// where IOBundleResourceFile is the filename of the resource
	139
	140	#define kIOIconKey "IOIcon" // (OSDictionary)
	141	#define kIOBundleResourceFileKey "IOBundleResourceFile" // (OSString)
1c79356b	142
9bccf70c A	143	#define kIOBusBadgeKey "IOBusBadge" // (OSDictionary)
	144	#define kIODeviceIconKey "IODeviceIcon" // (OSDictionary)
	145
55e303ae A	146	// property of root that describes the machine's serial number as a string
	147	#define kIOPlatformSerialNumberKey "IOPlatformSerialNumber" // (OSString)
	148
2d21ac55 A	149	// property of root that describes the machine's UUID as a string
	150	#define kIOPlatformUUIDKey "IOPlatformUUID" // (OSString)
	151
91447636 A	152	// IODTNVRAM property keys
91447636 A	153	#define kIONVRAMDeletePropertyKey "IONVRAM-DELETE-PROPERTY"
6d2010ae	154	#define kIONVRAMSyncNowPropertyKey "IONVRAM-SYNCNOW-PROPERTY"
91447636 A	155	#define kIODTNVRAMPanicInfoKey "aapl,panic-info"
	156
	157	// keys for complex boot information
	158	#define kIOBootDeviceKey "IOBootDevice" // dict \| array of dicts
	159	#define kIOBootDevicePathKey "IOBootDevicePath" // arch-neutral OSString
	160	#define kIOBootDeviceSizeKey "IOBootDeviceSize" // OSNumber of bytes
	161
2d21ac55 A	162	// keys for OS Version information
	163	#define kOSBuildVersionKey "OS Build Version"
	164
9bccf70c	165	#endif /* ! _IOKIT_IOKITKEYS_H */