Loading...
iokit/Kernel/IOMapper.cpp xnu-12377.101.15 xnu-792.2.4
--- xnu/xnu-12377.101.15/iokit/Kernel/IOMapper.cpp
+++ xnu/xnu-792.2.4/iokit/Kernel/IOMapper.cpp
@@ -1,45 +1,27 @@
 /*
- * Copyright (c) 1998-2016 Apple Inc. All rights reserved.
+ * Copyright (c) 1998-2004 Apple Computer, Inc. All rights reserved.
  *
- * @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
- * 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.
- *
- * 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
+ * @APPLE_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 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, 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@
+ * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
+ * License for the specific language governing rights and limitations
+ * under the License.
+ * 
+ * @APPLE_LICENSE_HEADER_END@
  */
-
-#define IOKIT_ENABLE_SHARED_PTR
-
 #include <IOKit/IOLib.h>
 #include <IOKit/IOMapper.h>
-#include <IOKit/IODMACommand.h>
 #include <libkern/c++/OSData.h>
-#include <libkern/OSDebug.h>
-#include <mach_debug/zone_info.h>
-#include <vm/vm_iokit.h>
-#include "IOKitKernelInternal.h"
-
-__BEGIN_DECLS
-extern ppnum_t pmap_find_phys(pmap_t pmap, addr64_t va);
-__END_DECLS
 
 #define super IOService
 OSDefineMetaClassAndAbstractStructors(IOMapper, IOService);
@@ -64,219 +46,237 @@
 IOMapper * IOMapper::gSystem = (IOMapper *) IOMapper::kUnknown;
 
 class IOMapperLock {
-	IOLock *fWaitLock;
+    IOLock *fWaitLock;
 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;
 
-bool
-IOMapper::start(IOService *provider)
-{
-	OSSharedPtr<OSObject> obj;
-	if (!super::start(provider)) {
-		return false;
-	}
-
-	if (!initHardware(provider)) {
-		return false;
-	}
-
-	uint64_t pageSize = getPageSize();
-	assert(pageSize <= UINT_MAX);
-	fPageSize = (uint32_t) pageSize;
-
-	if (fIsSystem) {
-		sMapperLock.lock();
-		IOMapper::gSystem = this;
-		sMapperLock.wakeup(&IOMapper::gSystem);
-		sMapperLock.unlock();
-	}
-
-	if (provider) {
-		obj = provider->copyProperty("iommu-id");
-		if (!obj) {
-			obj = provider->copyProperty("AAPL,phandle");
-		}
-		if (obj) {
-			setProperty(gIOMapperIDKey, obj.get());
-		}
-	}
-	return true;
-}
-
-void
-IOMapper::free()
-{
-	super::free();
-}
-
-void
-IOMapper::setMapperRequired(bool hasMapper)
-{
-	if (hasMapper) {
-		IOMapper::gSystem = (IOMapper *) kHasMapper;
-	} else {
-		sMapperLock.lock();
-		IOMapper::gSystem = (IOMapper *) kNoMapper;
-		sMapperLock.unlock();
-		sMapperLock.wakeup(&IOMapper::gSystem);
-	}
-}
-
-void
-IOMapper::waitForSystemMapper()
-{
-	sMapperLock.lock();
-	while ((uintptr_t) IOMapper::gSystem & kWaitMask) {
-		OSReportWithBacktrace("waitForSystemMapper");
-		sMapperLock.sleep(&IOMapper::gSystem);
-	}
-	sMapperLock.unlock();
-}
-
-OSSharedPtr<IOMapper>
-IOMapper::copyMapperForDevice(IOService * device)
-{
-	return copyMapperForDeviceWithIndex(device, 0);
-}
-
-OSSharedPtr<IOMapper>
-IOMapper::copyMapperForDeviceWithIndex(IOService * device, unsigned int index)
-{
-	OSSharedPtr<OSData> data;
-	OSSharedPtr<OSObject> obj;
-	OSSharedPtr<IOMapper> mapper;
-	OSSharedPtr<OSDictionary> matching;
-
-	obj = device->copyProperty("iommu-parent");
-	if (!obj) {
-		return NULL;
-	}
-
-	if ((mapper = OSDynamicPtrCast<IOMapper>(obj))) {
-		goto found;
-	}
-
-	if ((data = OSDynamicPtrCast<OSData>(obj))) {
-		if (index >= data->getLength() / sizeof(UInt32)) {
-			goto found;
-		}
-
-		data = OSData::withValueNoCopy(*((UInt32 *)data->getBytesNoCopy() + index));
-		if (!data) {
-			goto found;
-		}
-
-		matching = IOService::propertyMatching(gIOMapperIDKey, data.get());
-	} else {
-		matching = IOService::propertyMatching(gIOMapperIDKey, obj.get());
-	}
-
-	if (matching) {
-		mapper = OSDynamicPtrCast<IOMapper>(IOService::waitForMatchingService(matching.get()));
-	}
-
-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;
+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)
+{
+    assert(!fTable);
+
+    fTableSize = size;
+    fTableHandle = NewARTTable(size, &fTable, &fTablePhys);
+    return fTableHandle != 0;
+}
+
+void IOMapper::free()
+{
+    if (fTableHandle) {
+        FreeARTTable(fTableHandle, fTableSize);
+        fTableHandle = 0;
+    }
+
+    super::free();
+}
+
+void IOMapper::setMapperRequired(bool hasMapper)
+{
+    if (hasMapper)
+        IOMapper::gSystem = (IOMapper *) kHasMapper;
+    else {
+        sMapperLock.lock();
+        IOMapper::gSystem = (IOMapper *) kNoMapper;
+        sMapperLock.unlock();
+        sMapperLock.wakeup(&IOMapper::gSystem);
+    }
+}
+
+void IOMapper::waitForSystemMapper()
+{
+    sMapperLock.lock();
+    while ((vm_address_t) IOMapper::gSystem & kWaitMask)
+        sMapperLock.sleep(&IOMapper::gSystem);
+    sMapperLock.unlock();
+}
+
+void IOMapper::iovmInsert(ppnum_t addr, IOItemCount offset,
+                            ppnum_t *pageList, IOItemCount pageCount)
+{
+    while (pageCount--)
+        iovmInsert(addr, offset++, *pageList++);
+}
+
+void IOMapper::iovmInsert(ppnum_t addr, IOItemCount offset,
+                            upl_page_info_t *pageList, IOItemCount pageCount)
+{
+    for (IOItemCount i = 0; i < pageCount; i++)
+        iovmInsert(addr, offset + i, pageList[i].phys_addr);
+}
+
+struct ARTTableData {
+    void *v;
+    upl_t u[0];
+};
+#define getARTDataP(data) ((ARTTableData *) (data)->getBytesNoCopy())
+
+OSData *
+IOMapper::NewARTTable(IOByteCount size,
+                      void ** virtAddrP, ppnum_t *physAddrP)
+{
+    OSData *ret;
+    kern_return_t kr;
+    vm_address_t startUpl;
+    ARTTableData *dataP;
+    unsigned int dataSize;
+    upl_page_info_t *pl = 0;
+
+    // Each UPL can deal with about one meg at the moment
+    size = round_page_32(size);
+    dataSize = sizeof(ARTTableData) + sizeof(upl_t) * size / (1024 * 1024);
+    ret = OSData::withCapacity(dataSize);
+    if (!ret)
+        return 0;
+
+    // Append 0's to the buffer, in-other-words reset to nulls.
+    ret->appendBytes(NULL, sizeof(ARTTableData));
+    dataP = getARTDataP(ret);
+
+    kr = kmem_alloc_contig(kernel_map, &startUpl, size, PAGE_MASK, 0);
+    if (kr)
+        return 0;
+
+    dataP->v = (void *) startUpl;
+
+    do {
+        upl_t iopl;
+        int upl_flags = UPL_SET_INTERNAL | UPL_SET_LITE
+                      | UPL_SET_IO_WIRE | UPL_COPYOUT_FROM;
+        vm_size_t iopl_size = size;
+
+        kr = vm_map_get_upl(kernel_map,
+                            (vm_map_offset_t)startUpl,
+                            &iopl_size,
+                            &iopl,
+                            0,
+                            0,
+                            &upl_flags,
+                            0);
+        if (kr) {
+            panic("IOMapper:vm_map_get_upl returned 0x%x\n");
+            goto bail;
+        }
+
+        if (!ret->appendBytes(&iopl, sizeof(upl_t)))
+            goto bail;
+            
+        startUpl += iopl_size;
+        size -= iopl_size;
+    } while(size);
+
+    // Need to re-establish the dataP as the OSData may have grown.
+    dataP = getARTDataP(ret);
+
+    // Now grab the page entry of the first page and get its phys addr
+    pl = UPL_GET_INTERNAL_PAGE_LIST(dataP->u[0]);
+    *physAddrP = pl->phys_addr;
+    *virtAddrP = dataP->v;
+
+    return ret;
+
+bail:
+    FreeARTTable(ret, size);
+    return 0;
+}
+
+void IOMapper::FreeARTTable(OSData *artHandle, IOByteCount size)
+{
+    assert(artHandle);
+
+    ARTTableData *dataP = getARTDataP(artHandle);
+
+    int numupls = ((artHandle->getLength() - sizeof(*dataP)) / sizeof(upl_t));
+    for (int i = 0; i < numupls; i++) {
+        upl_abort(dataP->u[i], 0);
+        upl_deallocate(dataP->u[i]);
+    }
+
+    if (dataP->v) {
+        size = round_page_32(size);
+        kmem_free(kernel_map, (vm_address_t) dataP->v, size);
+    }
+    artHandle->release();
 }
 
 __BEGIN_DECLS
 
 // These are C accessors to the system mapper for non-IOKit clients
-ppnum_t
-IOMapperIOVMAlloc(unsigned pages)
-{
-	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) {
-		uint64_t dmaAddressPage64;
-		dmaAddressPage64 = atop_64(dmaAddress);
-		if (dmaAddressPage64 > UINT_MAX) {
-			return 0;
-		}
-		return (ppnum_t) atop_64(dmaAddress);
-	}
-	return 0;
-}
-
-void
-IOMapperIOVMFree(ppnum_t addr, unsigned pages)
-{
-	if (IOMapper::gSystem) {
-		IOMapper::gSystem->iovmUnmapMemory(NULL, NULL, ptoa_64(addr), ptoa_64(pages));
-	}
-}
-
-ppnum_t
-IOMapperInsertPage(ppnum_t addr, unsigned offset, ppnum_t page)
-{
-	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;
+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;
+}
+
+void IOMapperInsertPPNPages(ppnum_t addr, unsigned offset,
+                            ppnum_t *pageList, unsigned pageCount)
+{
+    if (!IOMapper::gSystem)
+        panic("IOMapperInsertPPNPages no system mapper");
+    else
+        assert(!((vm_address_t) IOMapper::gSystem & 3));
+
+    IOMapper::gSystem->
+        iovmInsert(addr, (IOItemCount) offset, pageList, pageCount);
+}
+
+void IOMapperInsertUPLPages(ppnum_t addr, unsigned offset,
+                            upl_page_info_t *pageList, unsigned pageCount)
+{
+    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);
 }
 
 /////////////////////////////////////////////////////////////////////////////
@@ -289,108 +289,100 @@
 
 #include <machine/machine_routines.h>
 
-UInt8
-IOMappedRead8(IOPhysicalAddress 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)
-{
-	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)
-{
-	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)
-{
-	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)
-{
-	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)
-{
-	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)
-{
-	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)
-{
-	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);
-	}
+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);
+}
+
+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);
+}
+
+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);
+}
+
+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);
+}
+
+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);
+}
+
+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);
+}
+
+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);
+}
+
+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);
 }
 
 __END_DECLS