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) 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
56// registry ID number
57#define kIORegistryEntryIDKey "IORegistryEntryID"
58// property name to get array of property names
59#define kIORegistryEntryPropertyKeysKey "IORegistryEntryPropertyKeys"
60
61// IOService class name
62#define kIOServiceClass "IOService"
63
64// IOResources class name
65#define kIOResourcesClass "IOResources"
66
67// IOService driver probing property names
68#define kIOClassKey "IOClass"
69#define kIOProbeScoreKey "IOProbeScore"
70#define kIOKitDebugKey "IOKitDebug"
71
72// IOService matching property names
73#define kIOProviderClassKey "IOProviderClass"
74#define kIONameMatchKey "IONameMatch"
75#define kIOPropertyMatchKey "IOPropertyMatch"
76#define kIOPropertyExistsMatchKey "IOPropertyExistsMatch"
77#define kIOPathMatchKey "IOPathMatch"
78#define kIOLocationMatchKey "IOLocationMatch"
79#define kIOParentMatchKey "IOParentMatch"
80#define kIOResourceMatchKey "IOResourceMatch"
81#define kIOResourceMatchedKey "IOResourceMatched"
82#define kIOMatchedServiceCountKey "IOMatchedServiceCountMatch"
83
84#define kIONameMatchedKey "IONameMatched"
85
86#define kIOMatchCategoryKey "IOMatchCategory"
87#define kIODefaultMatchCategoryKey "IODefaultMatchCategory"
88
89// IOService default user client class, for loadable user clients
90#define kIOUserClientClassKey "IOUserClientClass"
91
92// key to find IOMappers
93#define kIOMapperIDKey "IOMapperID"
94
95#define kIOUserClientCrossEndianKey "IOUserClientCrossEndian"
96#define kIOUserClientCrossEndianCompatibleKey "IOUserClientCrossEndianCompatible"
97#define kIOUserClientSharedInstanceKey "IOUserClientSharedInstance"
98// diagnostic string describing the creating task
99#define kIOUserClientCreatorKey "IOUserClientCreator"
100
101// IOService notification types
102#define kIOPublishNotification "IOServicePublish"
103#define kIOFirstPublishNotification "IOServiceFirstPublish"
104#define kIOMatchedNotification "IOServiceMatched"
105#define kIOFirstMatchNotification "IOServiceFirstMatch"
106#define kIOTerminatedNotification "IOServiceTerminate"
107#define kIOWillTerminateNotification "IOServiceWillTerminate"
108
109// IOService interest notification types
110#define kIOGeneralInterest "IOGeneralInterest"
111#define kIOBusyInterest "IOBusyInterest"
112#define kIOAppPowerStateInterest "IOAppPowerStateInterest"
113#define kIOPriorityPowerStateInterest "IOPriorityPowerStateInterest"
114
115#define kIOPlatformDeviceMessageKey "IOPlatformDeviceMessage"
116
117// IOService interest notification types
118#define kIOCFPlugInTypesKey "IOCFPlugInTypes"
119
120// properties found in services that implement command pooling
121#define kIOCommandPoolSizeKey "IOCommandPoolSize" // (OSNumber)
122
123// properties found in services that implement priority
124#define kIOMaximumPriorityCountKey "IOMaximumPriorityCount" // (OSNumber)
125
126// properties found in services that have transfer constraints
127#define kIOMaximumBlockCountReadKey "IOMaximumBlockCountRead" // (OSNumber)
128#define kIOMaximumBlockCountWriteKey "IOMaximumBlockCountWrite" // (OSNumber)
129#define kIOMaximumByteCountReadKey "IOMaximumByteCountRead" // (OSNumber)
130#define kIOMaximumByteCountWriteKey "IOMaximumByteCountWrite" // (OSNumber)
131#define kIOMaximumSegmentCountReadKey "IOMaximumSegmentCountRead" // (OSNumber)
132#define kIOMaximumSegmentCountWriteKey "IOMaximumSegmentCountWrite" // (OSNumber)
133#define kIOMaximumSegmentByteCountReadKey "IOMaximumSegmentByteCountRead" // (OSNumber)
134#define kIOMaximumSegmentByteCountWriteKey "IOMaximumSegmentByteCountWrite" // (OSNumber)
135#define kIOMinimumSegmentAlignmentByteCountKey "IOMinimumSegmentAlignmentByteCount" // (OSNumber)
136#define kIOMaximumSegmentAddressableBitCountKey "IOMaximumSegmentAddressableBitCount" // (OSNumber)
137#define kIOMinimumSaturationByteCountKey "IOMinimumSaturationByteCount" // (OSNumber)
138#define kIOMaximumSwapWriteKey "IOMaximumSwapWrite" // (OSNumber)
139
140// properties found in services that wish to describe an icon
141//
142// IOIcon =
143// {
144// CFBundleIdentifier = "com.example.driver.example";
145// IOBundleResourceFile = "example.icns";
146// };
147//
148// where IOBundleResourceFile is the filename of the resource
149
150#define kIOIconKey "IOIcon" // (OSDictionary)
151#define kIOBundleResourceFileKey "IOBundleResourceFile" // (OSString)
152
153#define kIOBusBadgeKey "IOBusBadge" // (OSDictionary)
154#define kIODeviceIconKey "IODeviceIcon" // (OSDictionary)
155
156// property of root that describes the machine's serial number as a string
157#define kIOPlatformSerialNumberKey "IOPlatformSerialNumber" // (OSString)
158
159// property of root that describes the machine's UUID as a string
160#define kIOPlatformUUIDKey "IOPlatformUUID" // (OSString)
161
162// IODTNVRAM property keys
163#define kIONVRAMDeletePropertyKey "IONVRAM-DELETE-PROPERTY"
164#define kIONVRAMSyncNowPropertyKey "IONVRAM-SYNCNOW-PROPERTY"
165#define kIONVRAMActivateCSRConfigPropertyKey "IONVRAM-ARMCSR-PROPERTY"
166#define kIODTNVRAMPanicInfoKey "aapl,panic-info"
167
168// keys for complex boot information
169#define kIOBootDeviceKey "IOBootDevice" // dict | array of dicts
170#define kIOBootDevicePathKey "IOBootDevicePath" // arch-neutral OSString
171#define kIOBootDeviceSizeKey "IOBootDeviceSize" // OSNumber of bytes
172
173// keys for OS Version information
174#define kOSBuildVersionKey "OS Build Version"
175
176#endif /* ! _IOKIT_IOKITKEYS_H */
177