xnu-6153.81.5.tar.gz

[apple/xnu.git] / iokit / Kernel / IOMapper.cpp

diff --git a/iokit/Kernel/IOMapper.cpp b/iokit/Kernel/IOMapper.cpp
index 56d412bf3e7c02c30f8363a3def1890dd8308265..cbf31f3d452a5c3718c375aa0ca572e7cdda35ff 100644 (file)
--- a/iokit/Kernel/IOMapper.cpp
+++ b/iokit/Kernel/IOMapper.cpp
@@ -1,8 +1,8 @@
 /*
 /*

- * Copyright (c) 1998-2004 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@

- * 
+ *

  * 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
  * 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


@@ -11,10 +11,10 @@
  * 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.
  * 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.

- * 
+ *

  * Please obtain a copy of the License at
  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  * 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,
  * 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,


@@ -22,14 +22,16 @@
  * 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.
  * 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_OSREFERENCE_LICENSE_HEADER_END@
  */
 #include <IOKit/IOLib.h>
 #include <IOKit/IOMapper.h>
  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  */
 #include <IOKit/IOLib.h>
 #include <IOKit/IOMapper.h>

+#include <IOKit/IODMACommand.h>

 #include <libkern/c++/OSData.h>
 #include <libkern/c++/OSData.h>

-
-#include "IOCopyMapper.h"
+#include <libkern/OSDebug.h>
+#include <mach_debug/zone_info.h>
+#include "IOKitKernelInternal.h"

 
 __BEGIN_DECLS
 extern ppnum_t pmap_find_phys(pmap_t pmap, addr64_t va);
 
 __BEGIN_DECLS
 extern ppnum_t pmap_find_phys(pmap_t pmap, addr64_t va);


@@ -38,7 +40,7 @@ __END_DECLS
 #define super IOService
 OSDefineMetaClassAndAbstractStructors(IOMapper, IOService);
 
 #define super IOService
 OSDefineMetaClassAndAbstractStructors(IOMapper, IOService);
 

-OSMetaClassDefineReservedUsed(IOMapper, 0);
+OSMetaClassDefineReservedUnused(IOMapper, 0);

 OSMetaClassDefineReservedUnused(IOMapper, 1);
 OSMetaClassDefineReservedUnused(IOMapper, 2);
 OSMetaClassDefineReservedUnused(IOMapper, 3);
 OSMetaClassDefineReservedUnused(IOMapper, 1);
 OSMetaClassDefineReservedUnused(IOMapper, 2);
 OSMetaClassDefineReservedUnused(IOMapper, 3);


@@ -58,183 +60,218 @@ OSMetaClassDefineReservedUnused(IOMapper, 15);
 IOMapper * IOMapper::gSystem = (IOMapper *) IOMapper::kUnknown;
 
 class IOMapperLock {
 IOMapper * IOMapper::gSystem = (IOMapper *) IOMapper::kUnknown;
 
 class IOMapperLock {

-    IOLock *fWaitLock;
+       IOLock *fWaitLock;

 public:
 public:

-    IOMapperLock() { fWaitLock = IOLockAlloc(); };
-    ~IOMapperLock() { IOLockFree(fWaitLock); };
-
-    void lock()   { IOLockLock(fWaitLock); };
-    void unlock() { IOLockUnlock(fWaitLock); };
-    void sleep(void *event)  { IOLockSleep(fWaitLock, event, THREAD_UNINT); };
-    void wakeup(void *event) { IOLockWakeup(fWaitLock, event, false); };
+       IOMapperLock()
+       {
+               fWaitLock = IOLockAlloc();
+       }
+       ~IOMapperLock()
+       {
+               IOLockFree(fWaitLock);
+       }
+
+       void
+       lock()
+       {
+               IOLockLock(fWaitLock);
+       }
+       void
+       unlock()
+       {
+               IOLockUnlock(fWaitLock);
+       }
+       void
+       sleep(void *event)
+       {
+               IOLockSleep(fWaitLock, event, THREAD_UNINT);
+       }
+       void
+       wakeup(void *event)
+       {
+               IOLockWakeup(fWaitLock, event, false);
+       }

 };
 
 static IOMapperLock sMapperLock;
 
 };
 
 static IOMapperLock sMapperLock;
 

-bool IOMapper::start(IOService *provider)
-{
-    if (!super::start(provider))
-        return false;
-
-    if (!initHardware(provider))
-        return false;
-
-    if (fIsSystem) { 
-        sMapperLock.lock();
-        IOMapper::gSystem = this;
-        sMapperLock.wakeup(&IOMapper::gSystem);
-        sMapperLock.unlock();
-    }
-
-    return true;
-}
-
-bool IOMapper::allocTable(IOByteCount size)
+bool
+IOMapper::start(IOService *provider)

 {
 {

-    assert(!fTable);
-
-    fTableSize = size;
-    fTableHandle = NewARTTable(size, &fTable, &fTablePhys);
-    return fTableHandle != 0;
-}
-
-void IOMapper::free()
-{
-    if (fTableHandle) {
-        FreeARTTable(fTableHandle, fTableSize);
-        fTableHandle = 0;
-    }
-
-    super::free();
+       OSObject * obj;
+       if (!super::start(provider)) {
+               return false;
+       }
+
+       if (!initHardware(provider)) {
+               return false;
+       }
+
+       fPageSize = getPageSize();
+
+       if (fIsSystem) {
+               sMapperLock.lock();
+               IOMapper::gSystem = this;
+               sMapperLock.wakeup(&IOMapper::gSystem);
+               sMapperLock.unlock();
+       }
+
+       if (provider) {
+               obj = provider->getProperty("iommu-id");
+               if (!obj) {
+                       obj = provider->getProperty("AAPL,phandle");
+               }
+               if (obj) {
+                       setProperty(gIOMapperIDKey, obj);
+               }
+       }
+       return true;

 }
 
 }
 

-void IOMapper::setMapperRequired(bool hasMapper)
+void
+IOMapper::free()

 {
 {

-    if (hasMapper)
-        IOMapper::gSystem = (IOMapper *) kHasMapper;
-    else {
-        sMapperLock.lock();
-        IOMapper::gSystem = (IOMapper *) kNoMapper;
-        sMapperLock.unlock();
-        sMapperLock.wakeup(&IOMapper::gSystem);
-    }
+       super::free();

 }
 
 }
 

-void IOMapper::waitForSystemMapper()
+void
+IOMapper::setMapperRequired(bool hasMapper)

 {
 {

-    sMapperLock.lock();
-    while ((vm_address_t) IOMapper::gSystem & kWaitMask)
-        sMapperLock.sleep(&IOMapper::gSystem);
-    sMapperLock.unlock();
+       if (hasMapper) {
+               IOMapper::gSystem = (IOMapper *) kHasMapper;
+       } else {
+               sMapperLock.lock();
+               IOMapper::gSystem = (IOMapper *) kNoMapper;
+               sMapperLock.unlock();
+               sMapperLock.wakeup(&IOMapper::gSystem);
+       }

 }
 
 }
 

-void IOMapper::iovmInsert(ppnum_t addr, IOItemCount offset,
-                            ppnum_t *pageList, IOItemCount pageCount)
+void
+IOMapper::waitForSystemMapper()

 {
 {

-    while (pageCount--)
-        iovmInsert(addr, offset++, *pageList++);
+       sMapperLock.lock();
+       while ((uintptr_t) IOMapper::gSystem & kWaitMask) {
+               OSReportWithBacktrace("waitForSystemMapper");
+               sMapperLock.sleep(&IOMapper::gSystem);
+       }
+       sMapperLock.unlock();

 }
 
 }
 

-void IOMapper::iovmInsert(ppnum_t addr, IOItemCount offset,
-                            upl_page_info_t *pageList, IOItemCount pageCount)
+IOMapper *
+IOMapper::copyMapperForDevice(IOService * device)

 {
 {

-    for (IOItemCount i = 0; i < pageCount; i++)
-        iovmInsert(addr, offset + i, pageList[i].phys_addr);
+       return copyMapperForDeviceWithIndex(device, 0);

 }
 
 }
 

-OSData * IOMapper::
-NewARTTable(IOByteCount size, void ** virtAddrP, ppnum_t *physAddrP)
+IOMapper *
+IOMapper::copyMapperForDeviceWithIndex(IOService * device, unsigned int index)

 {
 {

-    if (!virtAddrP || !physAddrP)
-       return 0;
-
-    kern_return_t kr;
-    vm_address_t address;
-
-    size = round_page_32(size);
-    kr = kmem_alloc_contig(kernel_map, &address, size, PAGE_MASK, 0);
-    if (kr)
-        return 0;
-
-    ppnum_t pagenum = pmap_find_phys(kernel_pmap, (addr64_t) address);
-    if (pagenum)
-       *physAddrP = pagenum;
-    else {
-       FreeARTTable((OSData *) address, size);
-       address = 0;
-    }
-
-    *virtAddrP = (void *) address;
-
-    return (OSData *) address;
-}
-
-void IOMapper::FreeARTTable(OSData *artHandle, IOByteCount size)
-{
-    vm_address_t address = (vm_address_t) artHandle;
-
-    size = round_page_32(size);
-    kmem_free(kernel_map, address, size);      // Just panic if address is 0
-}
-
-bool IOMapper::getBypassMask(addr64_t *maskP) const
-{
-    return false;
+       OSData *data;
+       OSObject * obj;
+       IOMapper * mapper = NULL;
+       OSDictionary * matching;
+
+       obj = device->copyProperty("iommu-parent");
+       if (!obj) {
+               return NULL;
+       }
+
+       if ((mapper = OSDynamicCast(IOMapper, obj))) {
+               goto found;
+       }
+
+       if ((data = OSDynamicCast(OSData, obj))) {
+               if (index >= data->getLength() / sizeof(UInt32)) {
+                       goto done;
+               }
+
+               data = OSData::withBytesNoCopy((UInt32 *)data->getBytesNoCopy() + index, sizeof(UInt32));
+               if (!data) {
+                       goto done;
+               }
+
+               matching = IOService::propertyMatching(gIOMapperIDKey, data);
+               data->release();
+       } else {
+               matching = IOService::propertyMatching(gIOMapperIDKey, obj);
+       }
+
+       if (matching) {
+               mapper = OSDynamicCast(IOMapper, IOService::waitForMatchingService(matching));
+               matching->release();
+       }
+
+done:
+       if (obj) {
+               obj->release();
+       }
+found:
+       if (mapper) {
+               if (!mapper->fAllocName) {
+                       char name[MACH_ZONE_NAME_MAX_LEN];
+                       char kmodname[KMOD_MAX_NAME];
+                       vm_tag_t tag;
+                       uint32_t kmodid;
+
+                       tag = IOMemoryTag(kernel_map);
+                       if (!(kmodid = vm_tag_get_kext(tag, &kmodname[0], KMOD_MAX_NAME))) {
+                               snprintf(kmodname, sizeof(kmodname), "%d", tag);
+                       }
+                       snprintf(name, sizeof(name), "%s.DMA.%s", kmodname, device->getName());
+                       mapper->fAllocName = kern_allocation_name_allocate(name, 16);
+               }
+       }
+
+       return mapper;

 }
 
 __BEGIN_DECLS
 
 // These are C accessors to the system mapper for non-IOKit clients
 }
 
 __BEGIN_DECLS
 
 // These are C accessors to the system mapper for non-IOKit clients

-ppnum_t IOMapperIOVMAlloc(unsigned pages)
+ppnum_t
+IOMapperIOVMAlloc(unsigned pages)

 {
 {

-    IOMapper::checkForSystemMapper();
-
-    if (IOMapper::gSystem)
-        return IOMapper::gSystem->iovmAlloc((IOItemCount) pages);
-    else
-        return 0;
-}
-
-void IOMapperIOVMFree(ppnum_t addr, unsigned pages)
-{
-    if (IOMapper::gSystem)
-        IOMapper::gSystem->iovmFree(addr, (IOItemCount) pages);
-}
-
-ppnum_t IOMapperInsertPage(ppnum_t addr, unsigned offset, ppnum_t page)
-{
-    if (IOMapper::gSystem) {
-        IOMapper::gSystem->iovmInsert(addr, (IOItemCount) offset, page);
-        return addr + offset;
-    }
-    else
-        return page;
+       IOReturn ret;
+       uint64_t dmaAddress, dmaLength;
+
+       IOMapper::checkForSystemMapper();
+
+       ret = kIOReturnUnsupported;
+       if (IOMapper::gSystem) {
+               ret = IOMapper::gSystem->iovmMapMemory(
+                       NULL, 0, ptoa_64(pages),
+                       (kIODMAMapReadAccess | kIODMAMapWriteAccess),
+                       NULL, NULL, NULL,
+                       &dmaAddress, &dmaLength);
+       }
+
+       if (kIOReturnSuccess == ret) {
+               return atop_64(dmaAddress);
+       }
+       return 0;

 }
 
 }
 

-void IOMapperInsertPPNPages(ppnum_t addr, unsigned offset,
-                            ppnum_t *pageList, unsigned pageCount)
+void
+IOMapperIOVMFree(ppnum_t addr, unsigned pages)

 {
 {

-    if (!IOMapper::gSystem)
-        panic("IOMapperInsertPPNPages no system mapper");
-    else
-        assert(!((vm_address_t) IOMapper::gSystem & 3));
-
-    IOMapper::gSystem->
-        iovmInsert(addr, (IOItemCount) offset, pageList, pageCount);
+       if (IOMapper::gSystem) {
+               IOMapper::gSystem->iovmUnmapMemory(NULL, NULL, ptoa_64(addr), ptoa_64(pages));
+       }

 }
 
 }
 

-void IOMapperInsertUPLPages(ppnum_t addr, unsigned offset,
-                            upl_page_info_t *pageList, unsigned pageCount)
+ppnum_t
+IOMapperInsertPage(ppnum_t addr, unsigned offset, ppnum_t page)

 {
 {

-    if (!IOMapper::gSystem)
-        panic("IOMapperInsertUPLPages no system mapper");
-    else
-        assert(!((vm_address_t) IOMapper::gSystem & 3));
-
-    IOMapper::gSystem->iovmInsert(addr,
-                                 (IOItemCount) offset,
-                                  pageList,
-                                  (IOItemCount) pageCount);
+       if (!IOMapper::gSystem) {
+               return page;
+       }
+       if (!addr) {
+               panic("!addr");
+       }
+       IOMapper::gSystem->iovmInsert((kIODMAMapReadAccess | kIODMAMapWriteAccess),
+           ptoa_64(addr), ptoa_64(offset), ptoa_64(page), ptoa_64(1));
+       return addr + offset;

 }
 
 /////////////////////////////////////////////////////////////////////////////
 }
 
 /////////////////////////////////////////////////////////////////////////////


@@ -247,120 +284,108 @@ void IOMapperInsertUPLPages(ppnum_t addr, unsigned offset,
 
 #include <machine/machine_routines.h>
 
 
 #include <machine/machine_routines.h>
 

-UInt8 IOMappedRead8(IOPhysicalAddress address)
+UInt8
+IOMappedRead8(IOPhysicalAddress address)

 {
 {

-    IOMapper::checkForSystemMapper();
-
-    if (IOMapper::gSystem) {
-        addr64_t addr = IOMapper::gSystem->mapAddr(address);
-        return (UInt8) ml_phys_read_byte_64(addr);
-    }
-    else
-        return (UInt8) ml_phys_read_byte((vm_offset_t) address);
+       IOMapper::checkForSystemMapper();
+
+       if (IOMapper::gSystem) {
+               addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
+               return (UInt8) ml_phys_read_byte_64(addr);
+       } else {
+               return (UInt8) ml_phys_read_byte((vm_offset_t) address);
+       }

 }
 
 }
 

-UInt16 IOMappedRead16(IOPhysicalAddress address)
+UInt16
+IOMappedRead16(IOPhysicalAddress address)

 {
 {

-    IOMapper::checkForSystemMapper();
-
-    if (IOMapper::gSystem) {
-        addr64_t addr = IOMapper::gSystem->mapAddr(address);
-        return (UInt16) ml_phys_read_half_64(addr);
-    }
-    else
-        return (UInt16) ml_phys_read_half((vm_offset_t) address);
+       IOMapper::checkForSystemMapper();
+
+       if (IOMapper::gSystem) {
+               addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
+               return (UInt16) ml_phys_read_half_64(addr);
+       } else {
+               return (UInt16) ml_phys_read_half((vm_offset_t) address);
+       }

 }
 
 }
 

-UInt32 IOMappedRead32(IOPhysicalAddress address)
+UInt32
+IOMappedRead32(IOPhysicalAddress address)

 {
 {

-    IOMapper::checkForSystemMapper();
-
-    if (IOMapper::gSystem) {
-        addr64_t addr = IOMapper::gSystem->mapAddr(address);
-       return (UInt32) ml_phys_read_word_64(addr);
-    }
-    else
-        return (UInt32) ml_phys_read_word((vm_offset_t) address);
+       IOMapper::checkForSystemMapper();
+
+       if (IOMapper::gSystem) {
+               addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
+               return (UInt32) ml_phys_read_word_64(addr);
+       } else {
+               return (UInt32) ml_phys_read_word((vm_offset_t) address);
+       }

 }
 
 }
 

-UInt64 IOMappedRead64(IOPhysicalAddress address)
+UInt64
+IOMappedRead64(IOPhysicalAddress address)

 {
 {

-    IOMapper::checkForSystemMapper();
-
-    if (IOMapper::gSystem) {
-        addr64_t addr = IOMapper::gSystem->mapAddr(address);
-        return (UInt64) ml_phys_read_double_64(addr);
-    }
-    else
-        return (UInt64) ml_phys_read_double((vm_offset_t) address);
+       IOMapper::checkForSystemMapper();
+
+       if (IOMapper::gSystem) {
+               addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
+               return (UInt64) ml_phys_read_double_64(addr);
+       } else {
+               return (UInt64) ml_phys_read_double((vm_offset_t) address);
+       }

 }
 
 }
 

-void IOMappedWrite8(IOPhysicalAddress address, UInt8 value)
+void
+IOMappedWrite8(IOPhysicalAddress address, UInt8 value)

 {
 {

-    IOMapper::checkForSystemMapper();
-
-    if (IOMapper::gSystem) {
-        addr64_t addr = IOMapper::gSystem->mapAddr(address);
-        ml_phys_write_byte_64(addr, value);
-    }
-    else
-        ml_phys_write_byte((vm_offset_t) address, value);
+       IOMapper::checkForSystemMapper();
+
+       if (IOMapper::gSystem) {
+               addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
+               ml_phys_write_byte_64(addr, value);
+       } else {
+               ml_phys_write_byte((vm_offset_t) address, value);
+       }

 }
 
 }
 

-void IOMappedWrite16(IOPhysicalAddress address, UInt16 value)
+void
+IOMappedWrite16(IOPhysicalAddress address, UInt16 value)

 {
 {

-    IOMapper::checkForSystemMapper();
-
-    if (IOMapper::gSystem) {
-        addr64_t addr = IOMapper::gSystem->mapAddr(address);
-        ml_phys_write_half_64(addr, value);
-    }
-    else
-        ml_phys_write_half((vm_offset_t) address, value);
+       IOMapper::checkForSystemMapper();
+
+       if (IOMapper::gSystem) {
+               addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
+               ml_phys_write_half_64(addr, value);
+       } else {
+               ml_phys_write_half((vm_offset_t) address, value);
+       }

 }
 
 }
 

-void IOMappedWrite32(IOPhysicalAddress address, UInt32 value)
+void
+IOMappedWrite32(IOPhysicalAddress address, UInt32 value)

 {
 {

-    IOMapper::checkForSystemMapper();
-
-    if (IOMapper::gSystem) {
-        addr64_t addr = IOMapper::gSystem->mapAddr(address);
-        ml_phys_write_word_64(addr, value);
-    }
-    else
-        ml_phys_write_word((vm_offset_t) address, value);
+       IOMapper::checkForSystemMapper();
+
+       if (IOMapper::gSystem) {
+               addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
+               ml_phys_write_word_64(addr, value);
+       } else {
+               ml_phys_write_word((vm_offset_t) address, value);
+       }

 }
 
 }
 

-void IOMappedWrite64(IOPhysicalAddress address, UInt64 value)
+void
+IOMappedWrite64(IOPhysicalAddress address, UInt64 value)

 {
 {

-    IOMapper::checkForSystemMapper();
-
-    if (IOMapper::gSystem) {
-        addr64_t addr = IOMapper::gSystem->mapAddr(address);
-        ml_phys_write_double_64(addr, value);
-    }
-    else
-        ml_phys_write_double((vm_offset_t) address, value);
+       IOMapper::checkForSystemMapper();
+
+       if (IOMapper::gSystem) {
+               addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
+               ml_phys_write_double_64(addr, value);
+       } else {
+               ml_phys_write_double((vm_offset_t) address, value);
+       }

 }
 
 }
 

-mach_vm_address_t IOMallocPhysical(mach_vm_size_t size, mach_vm_address_t mask)
-{
-    mach_vm_address_t address = 0;
-    if (gIOCopyMapper)
-    {
-       address = ptoa_64(gIOCopyMapper->iovmAlloc(atop_64(round_page(size))));
-    }
-
-    return (address);
-}
-
-void IOFreePhysical(mach_vm_address_t address, mach_vm_size_t size)
-{
-    if (gIOCopyMapper)
-    {
-       gIOCopyMapper->iovmFree(atop_64(address), atop_64(round_page(size)));
-    }
-}
-
-

 __END_DECLS
 __END_DECLS