xnu-4903.241.1.tar.gz

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

diff --git a/iokit/IOKit/IOBufferMemoryDescriptor.h b/iokit/IOKit/IOBufferMemoryDescriptor.h
index 391a0460ed3666bb34886e129f5141782b5bf5aa..4b218498bbb407ea5a21bba72316c3c17b6bb638 100644 (file)
--- a/iokit/IOKit/IOBufferMemoryDescriptor.h
+++ b/iokit/IOKit/IOBufferMemoryDescriptor.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998-2000 Apple Computer, Inc. All rights reserved.
+ * Copyright (c) 1998-2016 Apple Inc. All rights reserved.
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 
@@ -34,6 +34,7 @@ enum {
     kIOMemoryPhysicallyContiguous      = 0x00000010,
     kIOMemoryPageable                  = 0x00000020,
     kIOMemoryPurgeable                 = 0x00000040,
+    kIOMemoryHostPhysicallyContiguous          = 0x00000080,
     kIOMemorySharingTypeMask           = 0x000f0000,
     kIOMemoryUnshared                  = 0x00000000,
     kIOMemoryKernelUserShared          = 0x00010000,
@@ -44,9 +45,12 @@ enum {
 #endif
                                        | kIOMemoryThreadSafe
                                        | kIOMemoryClearEncrypt
+                                       | kIOMemoryMapperNone
+                                       | kIOMemoryUseReserve
 };
 
-#define _IOBUFFERMEMORYDESCRIPTOR_INTASKWITHOPTIONS_   1
+#define _IOBUFFERMEMORYDESCRIPTOR_INTASKWITHOPTIONS_           1
+#define _IOBUFFERMEMORYDESCRIPTOR_HOSTPHYSICALLYCONTIGUOUS_    1
 /*!
     @class IOBufferMemoryDescriptor
     @abstract Provides a simple memory descriptor that allocates its own buffer memory.
@@ -66,6 +70,7 @@ private:
 
 /*! @var reserved
     Reserved for future use.  (Internal use only)  */
+    APPLE_KEXT_WSHADOW_PUSH;
     ExpansionData * reserved;
 
 protected:
@@ -76,6 +81,7 @@ protected:
 private:
     uintptr_t           _internalReserved;
     unsigned             _internalFlags;
+    APPLE_KEXT_WSHADOW_POP;
 
 private:
 #ifndef __LP64__
@@ -86,6 +92,7 @@ private:
                               task_t       inTask) APPLE_KEXT_DEPRECATED; /* use withOptions() instead */
 #endif /* !__LP64__ */
 
+public:
     virtual bool initWithPhysicalMask(
                                task_t            inTask,
                                IOOptionBits      options,
@@ -116,7 +123,7 @@ private:
     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 15);
 
 protected:
-    virtual void free();
+    virtual void free() APPLE_KEXT_OVERRIDE;
 
 public:
 
@@ -146,7 +153,11 @@ public:
     kIOMemoryPhysicallyContiguous - pass to request memory be physically contiguous. This option is heavily discouraged. The request may fail if memory is fragmented, may cause large amounts of paging activity, and may take a very long time to execute.<br>
     kIOMemoryPageable - pass to request memory be non-wired - the default for kernel allocated memory is wired.<br>
     kIOMemoryPurgeable - pass to request memory that may later have its purgeable state set with IOMemoryDescriptor::setPurgeable. Only supported for kIOMemoryPageable allocations.<br>
-    kIOMemoryKernelUserShared - pass to request memory that will be mapped into both the kernel and client applications.
+    kIOMemoryKernelUserShared - pass to request memory that will be mapped into both the kernel and client applications.<br>
+    kIOMapInhibitCache - allocate memory with inhibited cache setting. <br>            
+    kIOMapWriteThruCache - allocate memory with writethru cache setting. <br>          
+    kIOMapCopybackCache - allocate memory with copyback cache setting. <br>            
+    kIOMapWriteCombineCache - allocate memory with writecombined cache setting.
     @param capacity The number of bytes to allocate.
     @param alignment The minimum required alignment of the buffer in bytes - 1 is the default for no required alignment. For example, pass 256 to get memory allocated at an address with bits 0-7 zero.
     @result Returns an instance of class IOBufferMemoryDescriptor to be released by the caller, which will free the memory desriptor and associated buffer. */
@@ -164,9 +175,13 @@ public:
     @param options Options for the allocation:<br>
     kIODirectionOut, kIODirectionIn - set the direction of the I/O transfer.<br>
     kIOMemoryPhysicallyContiguous - pass to request memory be physically contiguous. This option is heavily discouraged. The request may fail if memory is fragmented, may cause large amounts of paging activity, and may take a very long time to execute.<br>
-    kIOMemoryKernelUserShared - pass to request memory that will be mapped into both the kernel and client applications.
+    kIOMemoryKernelUserShared - pass to request memory that will be mapped into both the kernel and client applications.<br>
+    kIOMapInhibitCache - allocate memory with inhibited cache setting. <br>            
+    kIOMapWriteThruCache - allocate memory with writethru cache setting. <br>          
+    kIOMapCopybackCache - allocate memory with copyback cache setting. <br>            
+    kIOMapWriteCombineCache - allocate memory with writecombined cache setting.
     @param capacity The number of bytes to allocate.
-    @param mask The buffer will be allocated with pages such that physical addresses will only have bits set present in physicalMask. For example, pass 0x00000000FFFFFFFFULL for a buffer to be accessed by hardware that has 32 address bits.
+    @param physicalMask The buffer will be allocated with pages such that physical addresses will only have bits set present in physicalMask. For example, pass 0x00000000FFFFFFFFULL for a buffer to be accessed by hardware that has 32 address bits.
     @result Returns an instance of class IOBufferMemoryDescriptor to be released by the caller, which will free the memory desriptor and associated buffer. */
 
     static IOBufferMemoryDescriptor * inTaskWithPhysicalMask(
@@ -258,7 +273,7 @@ public:
 
 #ifndef __LP64__
     virtual void * getVirtualSegment(IOByteCount offset,
-                                       IOByteCount * length) APPLE_KEXT_DEPRECATED; /* use getBytesNoCopy() instead */
+                                       IOByteCount * length) APPLE_KEXT_OVERRIDE APPLE_KEXT_DEPRECATED; /* use getBytesNoCopy() instead */
 #endif /* !__LP64__ */
 };