X-Git-Url: https://git.saurik.com/apple/xnu.git/blobdiff_plain/378393581903b274cb7a4d18e0d978071a6b592d..a39ff7e25e19b3a8c3020042a3872ca9ec9659f1:/iokit/IOKit/IOMapper.h diff --git a/iokit/IOKit/IOMapper.h b/iokit/IOKit/IOMapper.h index 83bdfd570..4fe1ccf43 100644 --- a/iokit/IOKit/IOMapper.h +++ b/iokit/IOKit/IOMapper.h @@ -1,23 +1,29 @@ /* - * Copyright (c) 1998-2003 Apple Computer, Inc. All rights reserved. + * Copyright (c) 1998-2016 Apple Inc. All rights reserved. * - * @APPLE_LICENSE_HEADER_START@ + * @APPLE_OSREFERENCE_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 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. * - * This Original Code and all software distributed under the License are - * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER + * 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, * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, - * FITNESS FOR A PARTICULAR PURPOSE 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_LICENSE_HEADER_END@ + * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ */ #ifndef __IOKIT_IOMAPPER_H @@ -32,27 +38,28 @@ __BEGIN_DECLS // These are C accessors to the system mapper for non-IOKit clients ppnum_t IOMapperIOVMAlloc(unsigned pages); void IOMapperIOVMFree(ppnum_t addr, unsigned pages); - ppnum_t IOMapperInsertPage(ppnum_t addr, unsigned offset, ppnum_t page); -void IOMapperInsertPPNPages(ppnum_t addr, unsigned offset, - ppnum_t *pageList, unsigned pageCount); -void IOMapperInsertUPLPages(ppnum_t addr, unsigned offset, - upl_page_info_t *pageList, unsigned pageCount); + __END_DECLS #if __cplusplus #include #include +#include class OSData; +extern const OSSymbol * gIOMapperIDKey; + class IOMapper : public IOService { OSDeclareAbstractStructors(IOMapper); // Give the platform expert access to setMapperRequired(); friend class IOPlatformExpert; + friend class IOMemoryDescriptor; + friend class IOGeneralMemoryDescriptor; private: enum SystemMapperState { @@ -62,47 +69,62 @@ private: kWaitMask = 3, }; protected: - void *fTable; - ppnum_t fTablePhys; - IOItemCount fTableSize; - OSData *fTableHandle; +#ifdef XNU_KERNEL_PRIVATE + uint64_t __reservedA[6]; + kern_allocation_name_t fAllocName; + uint32_t __reservedB; + uint32_t fPageSize; +#else + uint64_t __reserved[8]; +#endif bool fIsSystem; - virtual bool start(IOService *provider); - virtual void free(); - static void setMapperRequired(bool hasMapper); static void waitForSystemMapper(); virtual bool initHardware(IOService *provider) = 0; - virtual bool allocTable(IOByteCount size); - public: - // Static routines capable of allocating tables that are physically - // contiguous in real memory space. - static OSData * NewARTTable(IOByteCount size, - void ** virtAddrP, ppnum_t *physAddrP); - static void FreeARTTable(OSData *handle, IOByteCount size); - + virtual bool start(IOService *provider) APPLE_KEXT_OVERRIDE; + virtual void free() APPLE_KEXT_OVERRIDE; // To get access to the system mapper IOMapper::gSystem static IOMapper *gSystem; - virtual ppnum_t iovmAlloc(IOItemCount pages) = 0; - virtual void iovmFree(ppnum_t addr, IOItemCount pages) = 0; - - virtual void iovmInsert(ppnum_t addr, IOItemCount offset, ppnum_t page) = 0; - virtual void iovmInsert(ppnum_t addr, IOItemCount offset, - ppnum_t *pageList, IOItemCount pageCount); - virtual void iovmInsert(ppnum_t addr, IOItemCount offset, - upl_page_info_t *pageList, IOItemCount pageCount); static void checkForSystemMapper() - { if ((vm_address_t) gSystem & kWaitMask) waitForSystemMapper(); }; + { if ((uintptr_t) gSystem & kWaitMask) waitForSystemMapper(); } + + static IOMapper * copyMapperForDevice(IOService * device); + static IOMapper * copyMapperForDeviceWithIndex(IOService * device, unsigned int index); + + // { subclasses + + virtual uint64_t getPageSize(void) const = 0; + + virtual IOReturn iovmMapMemory(IOMemoryDescriptor * memory, + uint64_t descriptorOffset, + uint64_t length, + uint32_t mapOptions, + const IODMAMapSpecification * mapSpecification, + IODMACommand * dmaCommand, + const IODMAMapPageList * pageList, + uint64_t * mapAddress, + uint64_t * mapLength) = 0; + + virtual IOReturn iovmUnmapMemory(IOMemoryDescriptor * memory, + IODMACommand * dmaCommand, + uint64_t mapAddress, + uint64_t mapLength) = 0; + + virtual IOReturn iovmInsert(uint32_t options, + uint64_t mapAddress, + uint64_t offset, + uint64_t physicalAddress, + uint64_t length) = 0; + + virtual uint64_t mapToPhysicalAddress(uint64_t mappedAddress) = 0; - // Function will panic if the given address is not found in a valid - // iovm mapping. - virtual addr64_t mapAddr(IOPhysicalAddress addr) = 0; + // } private: OSMetaClassDeclareReservedUnused(IOMapper, 0);