]> git.saurik.com Git - apple/xnu.git/blame - iokit/Kernel/IOMapper.cpp
xnu-7195.101.1.tar.gz
[apple/xnu.git] / iokit / Kernel / IOMapper.cpp
CommitLineData
55e303ae 1/*
39037602 2 * Copyright (c) 1998-2016 Apple Inc. All rights reserved.
55e303ae 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
0a7de745 5 *
2d21ac55
A
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
0a7de745 14 *
2d21ac55
A
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
0a7de745 17 *
2d21ac55
A
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
0a7de745 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
55e303ae 27 */
f427ee49
A
28
29#define IOKIT_ENABLE_SHARED_PTR
30
55e303ae
A
31#include <IOKit/IOLib.h>
32#include <IOKit/IOMapper.h>
b0d623f7 33#include <IOKit/IODMACommand.h>
55e303ae 34#include <libkern/c++/OSData.h>
99c3a104 35#include <libkern/OSDebug.h>
5ba3f43e 36#include <mach_debug/zone_info.h>
3e170ce0 37#include "IOKitKernelInternal.h"
55e303ae 38
0c530ab8
A
39__BEGIN_DECLS
40extern ppnum_t pmap_find_phys(pmap_t pmap, addr64_t va);
41__END_DECLS
42
55e303ae
A
43#define super IOService
44OSDefineMetaClassAndAbstractStructors(IOMapper, IOService);
45
3e170ce0
A
46OSMetaClassDefineReservedUnused(IOMapper, 0);
47OSMetaClassDefineReservedUnused(IOMapper, 1);
48OSMetaClassDefineReservedUnused(IOMapper, 2);
49OSMetaClassDefineReservedUnused(IOMapper, 3);
55e303ae
A
50OSMetaClassDefineReservedUnused(IOMapper, 4);
51OSMetaClassDefineReservedUnused(IOMapper, 5);
52OSMetaClassDefineReservedUnused(IOMapper, 6);
53OSMetaClassDefineReservedUnused(IOMapper, 7);
54OSMetaClassDefineReservedUnused(IOMapper, 8);
55OSMetaClassDefineReservedUnused(IOMapper, 9);
56OSMetaClassDefineReservedUnused(IOMapper, 10);
57OSMetaClassDefineReservedUnused(IOMapper, 11);
58OSMetaClassDefineReservedUnused(IOMapper, 12);
59OSMetaClassDefineReservedUnused(IOMapper, 13);
60OSMetaClassDefineReservedUnused(IOMapper, 14);
61OSMetaClassDefineReservedUnused(IOMapper, 15);
62
63IOMapper * IOMapper::gSystem = (IOMapper *) IOMapper::kUnknown;
64
65class IOMapperLock {
0a7de745 66 IOLock *fWaitLock;
55e303ae 67public:
0a7de745
A
68 IOMapperLock()
69 {
70 fWaitLock = IOLockAlloc();
71 }
72 ~IOMapperLock()
73 {
74 IOLockFree(fWaitLock);
75 }
76
77 void
78 lock()
79 {
80 IOLockLock(fWaitLock);
81 }
82 void
83 unlock()
84 {
85 IOLockUnlock(fWaitLock);
86 }
87 void
88 sleep(void *event)
89 {
90 IOLockSleep(fWaitLock, event, THREAD_UNINT);
91 }
92 void
93 wakeup(void *event)
94 {
95 IOLockWakeup(fWaitLock, event, false);
96 }
55e303ae
A
97};
98
99static IOMapperLock sMapperLock;
100
0a7de745
A
101bool
102IOMapper::start(IOService *provider)
55e303ae 103{
f427ee49 104 OSSharedPtr<OSObject> obj;
0a7de745
A
105 if (!super::start(provider)) {
106 return false;
107 }
108
109 if (!initHardware(provider)) {
110 return false;
111 }
112
f427ee49
A
113 uint64_t pageSize = getPageSize();
114 assert(pageSize <= UINT_MAX);
115 fPageSize = (uint32_t) pageSize;
0a7de745
A
116
117 if (fIsSystem) {
118 sMapperLock.lock();
119 IOMapper::gSystem = this;
120 sMapperLock.wakeup(&IOMapper::gSystem);
121 sMapperLock.unlock();
122 }
123
124 if (provider) {
f427ee49 125 obj = provider->copyProperty("iommu-id");
0a7de745 126 if (!obj) {
f427ee49 127 obj = provider->copyProperty("AAPL,phandle");
0a7de745
A
128 }
129 if (obj) {
f427ee49 130 setProperty(gIOMapperIDKey, obj.get());
0a7de745
A
131 }
132 }
133 return true;
55e303ae
A
134}
135
0a7de745
A
136void
137IOMapper::free()
55e303ae 138{
0a7de745 139 super::free();
55e303ae
A
140}
141
0a7de745
A
142void
143IOMapper::setMapperRequired(bool hasMapper)
55e303ae 144{
0a7de745
A
145 if (hasMapper) {
146 IOMapper::gSystem = (IOMapper *) kHasMapper;
147 } else {
148 sMapperLock.lock();
149 IOMapper::gSystem = (IOMapper *) kNoMapper;
150 sMapperLock.unlock();
151 sMapperLock.wakeup(&IOMapper::gSystem);
152 }
55e303ae
A
153}
154
0a7de745
A
155void
156IOMapper::waitForSystemMapper()
55e303ae 157{
0a7de745
A
158 sMapperLock.lock();
159 while ((uintptr_t) IOMapper::gSystem & kWaitMask) {
99c3a104 160 OSReportWithBacktrace("waitForSystemMapper");
0a7de745
A
161 sMapperLock.sleep(&IOMapper::gSystem);
162 }
163 sMapperLock.unlock();
55e303ae
A
164}
165
f427ee49 166OSSharedPtr<IOMapper>
0a7de745 167IOMapper::copyMapperForDevice(IOService * device)
b0d623f7 168{
0a7de745 169 return copyMapperForDeviceWithIndex(device, 0);
39236c6e
A
170}
171
f427ee49 172OSSharedPtr<IOMapper>
0a7de745 173IOMapper::copyMapperForDeviceWithIndex(IOService * device, unsigned int index)
39236c6e 174{
f427ee49
A
175 OSSharedPtr<OSData> data;
176 OSSharedPtr<OSObject> obj;
177 OSSharedPtr<IOMapper> mapper;
178 OSSharedPtr<OSDictionary> matching;
0a7de745
A
179
180 obj = device->copyProperty("iommu-parent");
181 if (!obj) {
182 return NULL;
183 }
184
f427ee49 185 if ((mapper = OSDynamicPtrCast<IOMapper>(obj))) {
0a7de745
A
186 goto found;
187 }
188
f427ee49 189 if ((data = OSDynamicPtrCast<OSData>(obj))) {
0a7de745 190 if (index >= data->getLength() / sizeof(UInt32)) {
f427ee49 191 goto found;
0a7de745
A
192 }
193
194 data = OSData::withBytesNoCopy((UInt32 *)data->getBytesNoCopy() + index, sizeof(UInt32));
195 if (!data) {
f427ee49 196 goto found;
0a7de745
A
197 }
198
f427ee49 199 matching = IOService::propertyMatching(gIOMapperIDKey, data.get());
0a7de745 200 } else {
f427ee49 201 matching = IOService::propertyMatching(gIOMapperIDKey, obj.get());
0a7de745
A
202 }
203
204 if (matching) {
f427ee49 205 mapper = OSDynamicPtrCast<IOMapper>(IOService::waitForMatchingService(matching.get()));
0a7de745 206 }
39236c6e 207
5ba3f43e 208found:
0a7de745
A
209 if (mapper) {
210 if (!mapper->fAllocName) {
211 char name[MACH_ZONE_NAME_MAX_LEN];
212 char kmodname[KMOD_MAX_NAME];
213 vm_tag_t tag;
214 uint32_t kmodid;
215
216 tag = IOMemoryTag(kernel_map);
217 if (!(kmodid = vm_tag_get_kext(tag, &kmodname[0], KMOD_MAX_NAME))) {
218 snprintf(kmodname, sizeof(kmodname), "%d", tag);
219 }
220 snprintf(name, sizeof(name), "%s.DMA.%s", kmodname, device->getName());
221 mapper->fAllocName = kern_allocation_name_allocate(name, 16);
222 }
223 }
224
225 return mapper;
b0d623f7
A
226}
227
55e303ae
A
228__BEGIN_DECLS
229
230// These are C accessors to the system mapper for non-IOKit clients
0a7de745
A
231ppnum_t
232IOMapperIOVMAlloc(unsigned pages)
55e303ae 233{
0a7de745
A
234 IOReturn ret;
235 uint64_t dmaAddress, dmaLength;
236
237 IOMapper::checkForSystemMapper();
238
239 ret = kIOReturnUnsupported;
240 if (IOMapper::gSystem) {
241 ret = IOMapper::gSystem->iovmMapMemory(
242 NULL, 0, ptoa_64(pages),
243 (kIODMAMapReadAccess | kIODMAMapWriteAccess),
244 NULL, NULL, NULL,
245 &dmaAddress, &dmaLength);
246 }
247
248 if (kIOReturnSuccess == ret) {
f427ee49
A
249 uint64_t dmaAddressPage64;
250 dmaAddressPage64 = atop_64(dmaAddress);
251 if (dmaAddressPage64 > UINT_MAX) {
252 return 0;
253 }
254 return (ppnum_t) atop_64(dmaAddress);
0a7de745
A
255 }
256 return 0;
55e303ae
A
257}
258
0a7de745
A
259void
260IOMapperIOVMFree(ppnum_t addr, unsigned pages)
55e303ae 261{
0a7de745
A
262 if (IOMapper::gSystem) {
263 IOMapper::gSystem->iovmUnmapMemory(NULL, NULL, ptoa_64(addr), ptoa_64(pages));
264 }
55e303ae
A
265}
266
0a7de745
A
267ppnum_t
268IOMapperInsertPage(ppnum_t addr, unsigned offset, ppnum_t page)
55e303ae 269{
0a7de745
A
270 if (!IOMapper::gSystem) {
271 return page;
272 }
273 if (!addr) {
274 panic("!addr");
275 }
276 IOMapper::gSystem->iovmInsert((kIODMAMapReadAccess | kIODMAMapWriteAccess),
277 ptoa_64(addr), ptoa_64(offset), ptoa_64(page), ptoa_64(1));
278 return addr + offset;
55e303ae
A
279}
280
281/////////////////////////////////////////////////////////////////////////////
282//
283//
284// IOLib.h APIs
285//
286//
287/////////////////////////////////////////////////////////////////////////////
288
289#include <machine/machine_routines.h>
290
0a7de745
A
291UInt8
292IOMappedRead8(IOPhysicalAddress address)
55e303ae 293{
0a7de745
A
294 IOMapper::checkForSystemMapper();
295
296 if (IOMapper::gSystem) {
297 addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
298 return (UInt8) ml_phys_read_byte_64(addr);
299 } else {
300 return (UInt8) ml_phys_read_byte((vm_offset_t) address);
301 }
55e303ae
A
302}
303
0a7de745
A
304UInt16
305IOMappedRead16(IOPhysicalAddress address)
55e303ae 306{
0a7de745
A
307 IOMapper::checkForSystemMapper();
308
309 if (IOMapper::gSystem) {
310 addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
311 return (UInt16) ml_phys_read_half_64(addr);
312 } else {
313 return (UInt16) ml_phys_read_half((vm_offset_t) address);
314 }
55e303ae
A
315}
316
0a7de745
A
317UInt32
318IOMappedRead32(IOPhysicalAddress address)
55e303ae 319{
0a7de745
A
320 IOMapper::checkForSystemMapper();
321
322 if (IOMapper::gSystem) {
323 addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
324 return (UInt32) ml_phys_read_word_64(addr);
325 } else {
326 return (UInt32) ml_phys_read_word((vm_offset_t) address);
327 }
55e303ae
A
328}
329
0a7de745
A
330UInt64
331IOMappedRead64(IOPhysicalAddress address)
55e303ae 332{
0a7de745
A
333 IOMapper::checkForSystemMapper();
334
335 if (IOMapper::gSystem) {
336 addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
337 return (UInt64) ml_phys_read_double_64(addr);
338 } else {
339 return (UInt64) ml_phys_read_double((vm_offset_t) address);
340 }
55e303ae
A
341}
342
0a7de745
A
343void
344IOMappedWrite8(IOPhysicalAddress address, UInt8 value)
55e303ae 345{
0a7de745
A
346 IOMapper::checkForSystemMapper();
347
348 if (IOMapper::gSystem) {
349 addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
350 ml_phys_write_byte_64(addr, value);
351 } else {
352 ml_phys_write_byte((vm_offset_t) address, value);
353 }
55e303ae
A
354}
355
0a7de745
A
356void
357IOMappedWrite16(IOPhysicalAddress address, UInt16 value)
55e303ae 358{
0a7de745
A
359 IOMapper::checkForSystemMapper();
360
361 if (IOMapper::gSystem) {
362 addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
363 ml_phys_write_half_64(addr, value);
364 } else {
365 ml_phys_write_half((vm_offset_t) address, value);
366 }
55e303ae
A
367}
368
0a7de745
A
369void
370IOMappedWrite32(IOPhysicalAddress address, UInt32 value)
55e303ae 371{
0a7de745
A
372 IOMapper::checkForSystemMapper();
373
374 if (IOMapper::gSystem) {
375 addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
376 ml_phys_write_word_64(addr, value);
377 } else {
378 ml_phys_write_word((vm_offset_t) address, value);
379 }
55e303ae
A
380}
381
0a7de745
A
382void
383IOMappedWrite64(IOPhysicalAddress address, UInt64 value)
55e303ae 384{
0a7de745
A
385 IOMapper::checkForSystemMapper();
386
387 if (IOMapper::gSystem) {
388 addr64_t addr = IOMapper::gSystem->mapToPhysicalAddress(address);
389 ml_phys_write_double_64(addr, value);
390 } else {
391 ml_phys_write_double((vm_offset_t) address, value);
392 }
55e303ae
A
393}
394
395__END_DECLS