]> git.saurik.com Git - apple/xnu.git/blobdiff - iokit/IOKit/IOTypes.h
xnu-3248.50.21.tar.gz
[apple/xnu.git] / iokit / IOKit / IOTypes.h
index 6a5f344f22146954a9fa20862b3c67ea3d147115..6d21a129446b711c836c122c9d5e4d018e1e53f9 100644 (file)
@@ -1,31 +1,30 @@
 /*
- * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2012 Apple Computer, Inc. All rights reserved.
  *
- * @APPLE_LICENSE_HEADER_START@
+ * @APPLE_OSREFERENCE_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 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.
  * 
- * This Original Code and all software distributed under the License are
- * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
+ * 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 OR NON-INFRINGEMENT.  Please see the
- * License for the specific language governing rights and limitations
- * under the License.
+ * 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_LICENSE_HEADER_END@
- */
-/*
- * Copyright (c) 1998 Apple Computer, Inc.  All rights reserved. 
- *
- * HISTORY
- *
+ * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
-
 #ifndef        __IOKIT_IOTYPES_H
 #define __IOKIT_IOTYPES_H
 
@@ -47,71 +46,88 @@ extern "C" {
 #endif
 
 #ifndef        NULL
+#if defined (__cplusplus)
 #define        NULL    0
+#else
+#define NULL ((void *)0)
+#endif
 #endif
        
 /*
  * Simple data types.
  */
-#ifndef __MACTYPES__   /* CF MacTypes.h */
-#ifndef __TYPES__      /* guess... Mac Types.h */
-
+#include <stdbool.h>
 #include <libkern/OSTypes.h>
 
-#ifndef __cplusplus
-#if !TYPE_BOOL
-#ifdef KERNEL
-typedef int    bool;
-enum {
-    false      = 0,
-    true       = 1
-};
-#endif
-#endif
+#if KERNEL
+#include <libkern/OSBase.h>
 #endif
 
-#endif /* __TYPES__ */
-#endif /* __MACTYPES__ */
-
 typedef UInt32         IOOptionBits;
 typedef SInt32         IOFixed;
 typedef UInt32         IOVersion;
 typedef UInt32         IOItemCount;
 typedef UInt32         IOCacheMode;
 
-typedef UInt32         IOByteCount;
+typedef UInt32         IOByteCount32;
+typedef UInt64         IOByteCount64;
+
+typedef UInt32 IOPhysicalAddress32;
+typedef UInt64 IOPhysicalAddress64;
+typedef UInt32 IOPhysicalLength32;
+typedef UInt64 IOPhysicalLength64;
 
-typedef vm_address_t    IOVirtualAddress;
-typedef IOVirtualAddress IOLogicalAddress;
+#if !defined(__arm__) && !defined(__i386__)
+typedef mach_vm_address_t      IOVirtualAddress;
+#else
+typedef vm_address_t           IOVirtualAddress;
+#endif
+
+#if !defined(__arm__) && !defined(__i386__) && !(defined(__x86_64__) && !defined(KERNEL))
+typedef IOByteCount64          IOByteCount;
+#else
+typedef IOByteCount32          IOByteCount;
+#endif
 
-#if 0
+typedef IOVirtualAddress    IOLogicalAddress;
 
-typedef UInt64 IOPhysicalAddress;
-typedef UInt64 IOPhysicalLength;
+#if !defined(__arm__) && !defined(__i386__) && !(defined(__x86_64__) && !defined(KERNEL))
+
+typedef IOPhysicalAddress64     IOPhysicalAddress;
+typedef IOPhysicalLength64      IOPhysicalLength;
 #define IOPhysical32( hi, lo )         ((UInt64) lo + ((UInt64)(hi) << 32))
 #define IOPhysSize     64
 
 #else
 
-typedef UInt32 IOPhysicalAddress;
-typedef UInt32 IOPhysicalLength;
+typedef IOPhysicalAddress32     IOPhysicalAddress;
+typedef IOPhysicalLength32      IOPhysicalLength;
 #define IOPhysical32( hi, lo )         (lo)
 #define IOPhysSize     32
 
 #endif
 
-#if __cplusplus
-struct IOVirtualRange
+
+typedef struct
 {
-    IOVirtualAddress   address;
+    IOPhysicalAddress  address;
     IOByteCount                length;
-};
-#else
+} IOPhysicalRange;
+
 typedef struct 
 {
     IOVirtualAddress   address;
     IOByteCount                length;
 } IOVirtualRange;
+
+#if !defined(__arm__) && !defined(__i386__)
+typedef IOVirtualRange IOAddressRange;
+#else
+typedef struct 
+{
+    mach_vm_address_t  address;
+    mach_vm_size_t     length;
+} IOAddressRange;
 #endif
 
 /*
@@ -142,7 +158,12 @@ typedef unsigned int       IOAlignment;
 #ifndef __IOKIT_PORTS_DEFINED__
 #define __IOKIT_PORTS_DEFINED__
 #ifdef KERNEL
+#ifdef __cplusplus
+class OSObject;
+typedef OSObject * io_object_t;
+#else
 typedef struct OSObject * io_object_t;
+#endif
 #else /* KERNEL */
 typedef mach_port_t    io_object_t;
 #endif /* KERNEL */
@@ -151,11 +172,12 @@ typedef mach_port_t       io_object_t;
 #include <device/device_types.h>
 
 typedef io_object_t    io_connect_t;
+typedef io_object_t    io_enumerator_t;
 typedef io_object_t    io_iterator_t;
 typedef io_object_t    io_registry_entry_t;
 typedef io_object_t    io_service_t;
 
-typedef io_object_t    io_enumerator_t;
+#define        IO_OBJECT_NULL  ((io_object_t) 0)
 
 #endif /* MACH_KERNEL */
 
@@ -168,26 +190,36 @@ enum {
     kIODefaultCache            = 0,
     kIOInhibitCache            = 1,
     kIOWriteThruCache          = 2,
-    kIOCopybackCache           = 3
+    kIOCopybackCache           = 3,
+    kIOWriteCombineCache       = 4,
+    kIOCopybackInnerCache      = 5
 };
 
 // IOMemory mapping options
 enum {
     kIOMapAnywhere             = 0x00000001,
 
-    kIOMapCacheMask            = 0x00000300,
+    kIOMapCacheMask            = 0x00000700,
     kIOMapCacheShift           = 8,
-    kIOMapDefaultCache         = kIODefaultCache   << kIOMapCacheShift,
-    kIOMapInhibitCache         = kIOInhibitCache   << kIOMapCacheShift,
-    kIOMapWriteThruCache       = kIOWriteThruCache << kIOMapCacheShift,
-    kIOMapCopybackCache                = kIOCopybackCache  << kIOMapCacheShift,
+    kIOMapDefaultCache         = kIODefaultCache       << kIOMapCacheShift,
+    kIOMapInhibitCache         = kIOInhibitCache       << kIOMapCacheShift,
+    kIOMapWriteThruCache       = kIOWriteThruCache     << kIOMapCacheShift,
+    kIOMapCopybackCache                = kIOCopybackCache      << kIOMapCacheShift,
+    kIOMapWriteCombineCache    = kIOWriteCombineCache  << kIOMapCacheShift,
+    kIOMapCopybackInnerCache   = kIOCopybackInnerCache << kIOMapCacheShift,
 
     kIOMapUserOptionsMask      = 0x00000fff,
 
     kIOMapReadOnly             = 0x00001000,
 
     kIOMapStatic               = 0x01000000,
-    kIOMapReference            = 0x02000000
+    kIOMapReference            = 0x02000000,
+    kIOMapUnique               = 0x04000000,
+#ifdef XNU_KERNEL_PRIVATE
+    kIOMap64Bit                        = 0x08000000,
+#endif
+    kIOMapPrefault             = 0x10000000,
+    kIOMapOverwrite     = 0x20000000
 };
 
 /*! @enum Scale Factors
@@ -195,30 +227,26 @@ enum {
     @constant kNanosecondScale Scale factor for nanosecond based times.
     @constant kMicrosecondScale Scale factor for microsecond based times.
     @constant kMillisecondScale Scale factor for millisecond based times.
+    @constant kTickScale Scale factor for the standard (100Hz) tick.
     @constant kSecondScale Scale factor for second based times. */
 
 enum {
     kNanosecondScale  = 1,
     kMicrosecondScale = 1000,
     kMillisecondScale = 1000 * 1000,
-    kSecondScale      = 1000 * 1000 * 1000
+    kSecondScale      = 1000 * 1000 * 1000,
+    kTickScale        = (kSecondScale / 100)
+};
+
+enum {
+    kIOConnectMethodVarOutputSize = -3
 };
 
 /* compatibility types */
 
 #ifndef KERNEL
-/*
- * Machine-independent caching specification.
- */
-typedef enum {
-        IO_CacheOff,                    // cache inhibit
-        IO_WriteThrough,
-        IO_CopyBack
-} IOCache;
 
-//typedef char OSString[64];
 typedef unsigned int IODeviceNumber;
-typedef unsigned int IOObjectNumber;
 
 #endif