iokit/IOKit/IOKitKeys.h

   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 // IOService class name
  57 #define kIOServiceClass                 "IOService"
  58
  59 // IOResources class name
  60 #define kIOResourcesClass               "IOResources"
  61
  62 // IOService driver probing property names
  63 #define kIOClassKey                     "IOClass"
  64 #define kIOProbeScoreKey                "IOProbeScore"
  65 #define kIOKitDebugKey                  "IOKitDebug"
  66
  67 // IOService matching property names
  68 #define kIOProviderClassKey             "IOProviderClass"
  69 #define kIONameMatchKey                 "IONameMatch"
  70 #define kIOPropertyMatchKey             "IOPropertyMatch"
  71 #define kIOPathMatchKey                 "IOPathMatch"
  72 #define kIOLocationMatchKey             "IOLocationMatch"
  73 #define kIOParentMatchKey               "IOParentMatch"
  74 #define kIOResourceMatchKey             "IOResourceMatch"
  75 #define kIOMatchedServiceCountKey       "IOMatchedServiceCountMatch"
  76
  77 #define kIONameMatchedKey               "IONameMatched"
  78
  79 #define kIOMatchCategoryKey             "IOMatchCategory"
  80 #define kIODefaultMatchCategoryKey      "IODefaultMatchCategory"
  81
  82 // IOService default user client class, for loadable user clients
  83 #define kIOUserClientClassKey           "IOUserClientClass"
  84
  85 // IOService notification types
  86 #define kIOPublishNotification          "IOServicePublish"
  87 #define kIOFirstPublishNotification     "IOServiceFirstPublish"
  88 #define kIOMatchedNotification          "IOServiceMatched"
  89 #define kIOFirstMatchNotification       "IOServiceFirstMatch"
  90 #define kIOTerminatedNotification       "IOServiceTerminate"
  91
  92 // IOService interest notification types
  93 #define kIOGeneralInterest              "IOGeneralInterest"
  94 #define kIOBusyInterest                 "IOBusyInterest"
  95 #define kIOAppPowerStateInterest        "IOAppPowerStateInterest"
  96 #define kIOPriorityPowerStateInterest   "IOPriorityPowerStateInterest"
  97
  98 // IOService interest notification types
  99 #define kIOCFPlugInTypesKey             "IOCFPlugInTypes"
 100
 101 // properties found in services that implement command pooling
 102 #define kIOCommandPoolSizeKey          "IOCommandPoolSize"          // (OSNumber)
 103
 104 // properties found in services that have transfer constraints
 105 #define kIOMaximumBlockCountReadKey        "IOMaximumBlockCountRead"        // (OSNumber)
 106 #define kIOMaximumBlockCountWriteKey       "IOMaximumBlockCountWrite"       // (OSNumber)
 107 #define kIOMaximumByteCountReadKey         "IOMaximumByteCountRead"         // (OSNumber)
 108 #define kIOMaximumByteCountWriteKey        "IOMaximumByteCountWrite"        // (OSNumber)
 109 #define kIOMaximumSegmentCountReadKey      "IOMaximumSegmentCountRead"      // (OSNumber)
 110 #define kIOMaximumSegmentCountWriteKey     "IOMaximumSegmentCountWrite"     // (OSNumber)
 111 #define kIOMaximumSegmentByteCountReadKey  "IOMaximumSegmentByteCountRead"  // (OSNumber)
 112 #define kIOMaximumSegmentByteCountWriteKey "IOMaximumSegmentByteCountWrite" // (OSNumber)
 113
 114 // properties found in services that wish to describe an icon
 115 //
 116 // IOIcon =
 117 // {
 118 //     CFBundleIdentifier   = "com.example.driver.example";
 119 //     IOBundleResourceFile = "example.icns";
 120 // };
 121 //
 122 // where IOBundleResourceFile is the filename of the resource
 123
 124 #define kIOIconKey               "IOIcon"               // (OSDictionary)
 125 #define kIOBundleResourceFileKey "IOBundleResourceFile" // (OSString)
 126
 127 #define kIOBusBadgeKey           "IOBusBadge"           // (OSDictionary)
 128 #define kIODeviceIconKey         "IODeviceIcon"         // (OSDictionary)
 129
 130 // property of root that describes the machine's serial number as a string
 131 #define kIOPlatformSerialNumberKey      "IOPlatformSerialNumber"        // (OSString)
 132
 133 // IODTNVRAM property keys
 134 #define kIONVRAMDeletePropertyKey       "IONVRAM-DELETE-PROPERTY"
 135 #define kIODTNVRAMPanicInfoKey          "aapl,panic-info"
 136
 137 // keys for complex boot information
 138 #define kIOBootDeviceKey          "IOBootDevice"                // dict | array of dicts
 139 #define kIOBootDevicePathKey      "IOBootDevicePath"    // arch-neutral OSString
 140 #define kIOBootDeviceSizeKey      "IOBootDeviceSize"    // OSNumber of bytes
 141
 142 #endif /* ! _IOKIT_IOKITKEYS_H */