xnu-4570.51.1.tar.gz

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

diff --git a/iokit/IOKit/IOMemoryDescriptor.h b/iokit/IOKit/IOMemoryDescriptor.h
index 7b193afc0edb683e7f7e5e6b681f75eb13a78ce1..35c3305816d0fa46e8fa86ec655b0007d3c81ff9 100644 (file)
--- a/iokit/IOKit/IOMemoryDescriptor.h
+++ b/iokit/IOKit/IOMemoryDescriptor.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@
  * 
  *
  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
  * 


@@ -72,6 +72,7 @@ enum IODirection
 #define IODIRECTIONCOMPLETEWITHDATAVALIDDEFINED        1
      kIODirectionCompleteWithDataValid = 0x00000080,
 };
 #define IODIRECTIONCOMPLETEWITHDATAVALIDDEFINED        1
      kIODirectionCompleteWithDataValid = 0x00000080,
 };

+

 #ifdef __LP64__
 typedef IOOptionBits IODirection;
 #endif /* __LP64__ */
 #ifdef __LP64__
 typedef IOOptionBits IODirection;
 #endif /* __LP64__ */


@@ -109,10 +110,13 @@ enum {
 #endif
     kIOMemoryPersistent                = 0x00010000,
 #ifdef XNU_KERNEL_PRIVATE
 #endif
     kIOMemoryPersistent                = 0x00010000,
 #ifdef XNU_KERNEL_PRIVATE

-    kIOMemoryReserved6156215   = 0x00020000,
+    kIOMemoryMapCopyOnWrite    = 0x00020000,

 #endif
 #endif

+    kIOMemoryRemote            = 0x00040000,

     kIOMemoryThreadSafe                = 0x00100000,   // Shared with Buffer MD
     kIOMemoryClearEncrypt      = 0x00200000,   // Shared with Buffer MD
     kIOMemoryThreadSafe                = 0x00100000,   // Shared with Buffer MD
     kIOMemoryClearEncrypt      = 0x00200000,   // Shared with Buffer MD

+    kIOMemoryUseReserve        = 0x00800000,   // Shared with Buffer MD
+#define IOMEMORYUSERESERVEDEFINED      1

 
 #ifdef XNU_KERNEL_PRIVATE
     kIOMemoryBufferPurgeable   = 0x00400000,
 
 #ifdef XNU_KERNEL_PRIVATE
     kIOMemoryBufferPurgeable   = 0x00400000,


@@ -144,6 +148,7 @@ enum
     kIOMemoryPurgeableVolatileBehaviorLifo     = VM_PURGABLE_BEHAVIOR_LIFO,
     kIOMemoryPurgeableVolatileOrderingObsolete = VM_PURGABLE_ORDERING_OBSOLETE,
     kIOMemoryPurgeableVolatileOrderingNormal   = VM_PURGABLE_ORDERING_NORMAL,
     kIOMemoryPurgeableVolatileBehaviorLifo     = VM_PURGABLE_BEHAVIOR_LIFO,
     kIOMemoryPurgeableVolatileOrderingObsolete = VM_PURGABLE_ORDERING_OBSOLETE,
     kIOMemoryPurgeableVolatileOrderingNormal   = VM_PURGABLE_ORDERING_NORMAL,

+    kIOMemoryPurgeableFaultOnAccess            = VM_PURGABLE_DEBUG_FAULT,

 };
 enum 
 {
 };
 enum 
 {


@@ -201,6 +206,7 @@ enum  {
     kIOMDSetDMAInactive           = kIOMDDMAActive,
     kIOMDAddDMAMapSpec            = 0x04000000,
     kIOMDDMAMap                   = 0x05000000,
     kIOMDSetDMAInactive           = kIOMDDMAActive,
     kIOMDAddDMAMapSpec            = 0x04000000,
     kIOMDDMAMap                   = 0x05000000,

+    kIOMDDMAUnmap                 = 0x06000000,

     kIOMDDMACommandOperationMask  = 0xFF000000,
 };
 struct IOMDDMACharacteristics {
     kIOMDDMACommandOperationMask  = 0xFF000000,
 };
 struct IOMDDMACharacteristics {


@@ -228,8 +234,14 @@ struct IOMDDMAWalkSegmentArgs {
     UInt64 fOffset;                    // Input/Output offset
     UInt64 fIOVMAddr, fLength;         // Output variables
     UInt8 fMapped;                     // Input Variable, Require mapped IOVMA
     UInt64 fOffset;                    // Input/Output offset
     UInt64 fIOVMAddr, fLength;         // Output variables
     UInt8 fMapped;                     // Input Variable, Require mapped IOVMA

+    UInt64 fMappedBase;                        // Input base of mapping

 };
 typedef UInt8 IOMDDMAWalkSegmentState[128];
 };
 typedef UInt8 IOMDDMAWalkSegmentState[128];

+// fMapped:
+enum
+{
+       kIOMDDMAWalkMappedLocal = 2
+};

 
 #endif /* KERNEL_PRIVATE */
 
 
 #endif /* KERNEL_PRIVATE */
 


@@ -270,17 +282,22 @@ protected:
 #ifdef XNU_KERNEL_PRIVATE
 public:
     struct IOMemoryReference * _memRef;
 #ifdef XNU_KERNEL_PRIVATE
 public:
     struct IOMemoryReference * _memRef;

+    vm_tag_t _kernelTag;
+    vm_tag_t _userTag;
+    int16_t _dmaReferences;
+    uint16_t _internalFlags;
+    kern_allocation_name_t _mapName;

 protected:
 protected:

-#else
-    void * __iomd_reserved5;
-#endif
+#else /* XNU_KERNEL_PRIVATE */
+    void *             __iomd_reserved5;
+    uint16_t           __iomd_reserved1[4];
+    uintptr_t          __iomd_reserved2;
+#endif /* XNU_KERNEL_PRIVATE */

 
 

-#ifdef __LP64__
-    uint64_t           __iomd_reserved1;
-    uint64_t           __iomd_reserved2;
-    uint64_t           __iomd_reserved3;
-    uint64_t           __iomd_reserved4;
-#else /* !__LP64__ */
+    uintptr_t          __iomd_reserved3;
+    uintptr_t          __iomd_reserved4;
+
+#ifndef __LP64__

     IODirection         _direction;        /* use _flags instead */
 #endif /* !__LP64__ */
     IOByteCount         _length;           /* length of all ranges */
     IODirection         _direction;        /* use _flags instead */
 #endif /* !__LP64__ */
     IOByteCount         _length;           /* length of all ranges */


@@ -383,6 +400,19 @@ typedef IOOptionBits DMACommandOps;
        uint64_t                      length,
        uint64_t                    * mapAddress,
        uint64_t                    * mapLength);
        uint64_t                      length,
        uint64_t                    * mapAddress,
        uint64_t                    * mapLength);

+    IOReturn dmaUnmap(
+       IOMapper                    * mapper,
+       IODMACommand                * command,
+       uint64_t                      offset,
+       uint64_t                      mapAddress,
+       uint64_t                      mapLength);
+    void dmaMapRecord(
+       IOMapper                    * mapper,
+       IODMACommand                * command,
+       uint64_t                      mapLength);
+
+    void     setVMTags(vm_tag_t kernelTag, vm_tag_t userTag);
+    vm_tag_t getVMTag(vm_map_t map);

 #endif
        
 private:
 #endif
        
 private:


@@ -463,7 +493,7 @@ public:
     @abstract Create an IOMemoryDescriptor to describe one virtual range of the specified map.
     @discussion This method creates and initializes an IOMemoryDescriptor for memory consisting of a single virtual memory range mapped into the specified map.  This memory descriptor needs to be prepared before it can be used to extract data from the memory described.
     @param address The virtual address of the first byte in the memory.
     @abstract Create an IOMemoryDescriptor to describe one virtual range of the specified map.
     @discussion This method creates and initializes an IOMemoryDescriptor for memory consisting of a single virtual memory range mapped into the specified map.  This memory descriptor needs to be prepared before it can be used to extract data from the memory described.
     @param address The virtual address of the first byte in the memory.

-    @param withLength The length of memory.
+    @param length The length of memory.

     @param options
         kIOMemoryDirectionMask (options:direction)     This nibble indicates the I/O direction to be associated with the descriptor, which may affect the operation of the prepare and complete methods on some architectures. 
     @param task The task the virtual ranges are mapped into. Note that unlike IOMemoryDescriptor::withAddress(), kernel_task memory must be explicitly prepared when passed to this api. The task argument may be NULL to specify memory by physical address.
     @param options
         kIOMemoryDirectionMask (options:direction)     This nibble indicates the I/O direction to be associated with the descriptor, which may affect the operation of the prepare and complete methods on some architectures. 
     @param task The task the virtual ranges are mapped into. Note that unlike IOMemoryDescriptor::withAddress(), kernel_task memory must be explicitly prepared when passed to this api. The task argument may be NULL to specify memory by physical address.


@@ -598,6 +628,13 @@ public:
 
     virtual IOOptionBits getTag( void );
 
 
     virtual IOOptionBits getTag( void );
 

+/*! @function getFlags
+    @abstract Accessor to the retrieve the options the memory descriptor was created with.
+    @discussion Accessor to the retrieve the options the memory descriptor was created with, and flags with its state. These bits are defined by the kIOMemory* enum.
+    @result The flags bitfield. */
+
+    uint64_t getFlags(void);
+

 /*! @function readBytes
     @abstract Copy data from the memory descriptor's buffer to the specified buffer.
     @discussion This method copies data from the memory descriptor's memory at the given offset, to the caller's buffer.  The memory descriptor MUST have the kIODirectionOut direcction bit set  and be prepared.  kIODirectionOut means that this memory descriptor will be output to an external device, so readBytes is used to get memory into a local buffer for a PIO transfer to the device.
 /*! @function readBytes
     @abstract Copy data from the memory descriptor's buffer to the specified buffer.
     @discussion This method copies data from the memory descriptor's memory at the given offset, to the caller's buffer.  The memory descriptor MUST have the kIODirectionOut direcction bit set  and be prepared.  kIODirectionOut means that this memory descriptor will be output to an external device, so readBytes is used to get memory into a local buffer for a PIO transfer to the device.


@@ -784,7 +821,7 @@ public:
     IOMemoryDescriptor * fOwner;
     uint8_t             fUserClientUnmap;
 #if IOTRACKING
     IOMemoryDescriptor * fOwner;
     uint8_t             fUserClientUnmap;
 #if IOTRACKING

-    IOTracking           fTracking;
+    IOTrackingUser       fTracking;

 #endif
 #endif /* XNU_KERNEL_PRIVATE */
 
 #endif
 #endif /* XNU_KERNEL_PRIVATE */
 


@@ -884,22 +921,22 @@ public:
     @abstract Accessor to the virtual address of the first byte in the mapping.
     @discussion This method returns the virtual address of the first byte in the mapping.
     @result A virtual address. */
     @abstract Accessor to the virtual address of the first byte in the mapping.
     @discussion This method returns the virtual address of the first byte in the mapping.
     @result A virtual address. */

+    inline mach_vm_address_t   getAddress() __attribute__((always_inline));

 /*! @function getSize
     @abstract Accessor to the length of the mapping.
     @discussion This method returns the length of the mapping.
     @result A byte count. */
 /*! @function getSize
     @abstract Accessor to the length of the mapping.
     @discussion This method returns the length of the mapping.
     @result A byte count. */

-    inline mach_vm_address_t   getAddress() __attribute__((always_inline));

     inline mach_vm_size_t      getSize() __attribute__((always_inline));
 #else /* !__LP64__ */
 /*! @function getAddress
     @abstract Accessor to the virtual address of the first byte in the mapping.
     @discussion This method returns the virtual address of the first byte in the mapping.
     @result A virtual address. */
     inline mach_vm_size_t      getSize() __attribute__((always_inline));
 #else /* !__LP64__ */
 /*! @function getAddress
     @abstract Accessor to the virtual address of the first byte in the mapping.
     @discussion This method returns the virtual address of the first byte in the mapping.
     @result A virtual address. */

+    virtual mach_vm_address_t  getAddress();

 /*! @function getSize
     @abstract Accessor to the length of the mapping.
     @discussion This method returns the length of the mapping.
     @result A byte count. */
 /*! @function getSize
     @abstract Accessor to the length of the mapping.
     @discussion This method returns the length of the mapping.
     @result A byte count. */

-    virtual mach_vm_address_t  getAddress();

     virtual mach_vm_size_t     getSize();
 #endif /* !__LP64__ */
 
     virtual mach_vm_size_t     getSize();
 #endif /* !__LP64__ */