]> git.saurik.com Git - apple/xnu.git/blobdiff - iokit/IOKit/IOBufferMemoryDescriptor.h
xnu-4903.241.1.tar.gz
[apple/xnu.git] / iokit / IOKit / IOBufferMemoryDescriptor.h
index f42f66489733d327bc891fd03a8a7539a9be835e..4b218498bbb407ea5a21bba72316c3c17b6bb638 100644 (file)
@@ -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,
@@ -43,9 +44,13 @@ enum {
                                        | kIOMemoryAutoPrepare
 #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.
@@ -65,6 +70,7 @@ private:
 
 /*! @var reserved
     Reserved for future use.  (Internal use only)  */
+    APPLE_KEXT_WSHADOW_PUSH;
     ExpansionData * reserved;
 
 protected:
@@ -72,16 +78,21 @@ protected:
     vm_size_t            _capacity;
     vm_offset_t                 _alignment;
     IOOptionBits        _options;
-    IOPhysicalAddress *  _physAddrs;
-    unsigned             _physSegCount;
+private:
+    uintptr_t           _internalReserved;
+    unsigned             _internalFlags;
+    APPLE_KEXT_WSHADOW_POP;
 
 private:
+#ifndef __LP64__
     virtual bool initWithOptions(
                                IOOptionBits options,
                                vm_size_t    capacity,
                                vm_offset_t  alignment,
-                              task_t       inTask);
+                              task_t       inTask) APPLE_KEXT_DEPRECATED; /* use withOptions() instead */
+#endif /* !__LP64__ */
 
+public:
     virtual bool initWithPhysicalMask(
                                task_t            inTask,
                                IOOptionBits      options,
@@ -89,8 +100,13 @@ private:
                                mach_vm_address_t alignment,
                                mach_vm_address_t physicalMask);
 
+#ifdef __LP64__
+    OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 0);
+    OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 1);
+#else /* !__LP64__ */
     OSMetaClassDeclareReservedUsed(IOBufferMemoryDescriptor, 0);
     OSMetaClassDeclareReservedUsed(IOBufferMemoryDescriptor, 1);
+#endif /* !__LP64__ */
     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 2);
     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 3);
     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 4);
@@ -107,39 +123,7 @@ private:
     OSMetaClassDeclareReservedUnused(IOBufferMemoryDescriptor, 15);
 
 protected:
-    virtual void free();
-
-    virtual bool initWithAddress( void *      address,       /* not supported */
-                                  IOByteCount withLength,
-                                  IODirection withDirection );
-
-    virtual bool initWithAddress( vm_address_t address,      /* not supported */
-                                  IOByteCount  withLength,
-                                  IODirection  withDirection,
-                                  task_t       withTask );
-
-    virtual bool initWithPhysicalAddress( 
-                                  IOPhysicalAddress address, /* not supported */
-                                  IOByteCount       withLength,
-                                  IODirection       withDirection );
-
-    virtual bool initWithPhysicalRanges( 
-                                  IOPhysicalRange * ranges,  /* not supported */
-                                  UInt32            withCount,
-                                  IODirection       withDirection,
-                                  bool              asReference = false );
-
-    virtual bool initWithRanges(  IOVirtualRange * ranges,   /* not supported */
-                                  UInt32           withCount,
-                                  IODirection      withDirection,
-                                  task_t           withTask,
-                                  bool             asReference = false );
-
-    IOGeneralMemoryDescriptor::withAddress;                  /* not supported */
-    IOGeneralMemoryDescriptor::withPhysicalAddress;          /* not supported */
-    IOGeneralMemoryDescriptor::withPhysicalRanges;           /* not supported */
-    IOGeneralMemoryDescriptor::withRanges;                   /* not supported */
-    IOGeneralMemoryDescriptor::withSubRange;                 /* not supported */
+    virtual void free() APPLE_KEXT_OVERRIDE;
 
 public:
 
@@ -150,9 +134,11 @@ public:
      * hold capacity bytes.  The descriptor's length is initially set to the
      * capacity.
      */
+#ifndef __LP64__
     virtual bool initWithOptions(   IOOptionBits options,
                                     vm_size_t    capacity,
-                                    vm_offset_t  alignment);
+                                    vm_offset_t  alignment) APPLE_KEXT_DEPRECATED; /* use withOptions() instead */
+#endif /* !__LP64__ */
 
     static IOBufferMemoryDescriptor * withOptions(  IOOptionBits options,
                                                     vm_size_t    capacity,
@@ -167,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. */
@@ -185,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(
@@ -207,16 +201,12 @@ public:
                                      vm_size_t    capacity,
                                      IODirection  withDirection,
                                      bool         withContiguousMemory = false);
-    /*
-     * initWithBytes:
-     *
-     * Initialize a new IOBufferMemoryDescriptor preloaded with bytes (copied).
-     * The descriptor's length and capacity are set to the input buffer's size.
-     */
+#ifndef __LP64__
     virtual bool initWithBytes(const void * bytes,
                                vm_size_t    withLength,
                                IODirection  withDirection,
-                               bool         withContiguousMemory = false);
+                               bool         withContiguousMemory = false) APPLE_KEXT_DEPRECATED; /* use withBytes() instead */
+#endif /* !__LP64__ */
 
     /*
      * withBytes:
@@ -281,8 +271,10 @@ public:
      */
     virtual bool appendBytes(const void *bytes, vm_size_t withLength);
 
-    /* DEPRECATED */ virtual void * getVirtualSegment(IOByteCount offset,
-    /* DEPRECATED */                                   IOByteCount * length);
+#ifndef __LP64__
+    virtual void * getVirtualSegment(IOByteCount offset,
+                                       IOByteCount * length) APPLE_KEXT_OVERRIDE APPLE_KEXT_DEPRECATED; /* use getBytesNoCopy() instead */
+#endif /* !__LP64__ */
 };
 
 #endif /* !_IOBUFFERMEMORYDESCRIPTOR_H */