]> git.saurik.com Git - apple/xnu.git/blame - iokit/Kernel/IOMapper.cpp
xnu-1228.15.4.tar.gz
[apple/xnu.git] / iokit / Kernel / IOMapper.cpp
CommitLineData
55e303ae 1/*
91447636 2 * Copyright (c) 1998-2004 Apple Computer, Inc. All rights reserved.
55e303ae 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
55e303ae 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.
8f6c56a5 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.
17 *
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.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
55e303ae
A
27 */
28#include <IOKit/IOLib.h>
29#include <IOKit/IOMapper.h>
30#include <libkern/c++/OSData.h>
31
0c530ab8
A
32#include "IOCopyMapper.h"
33
34__BEGIN_DECLS
35extern ppnum_t pmap_find_phys(pmap_t pmap, addr64_t va);
36__END_DECLS
37
55e303ae
A
38#define super IOService
39OSDefineMetaClassAndAbstractStructors(IOMapper, IOService);
40
0c530ab8 41OSMetaClassDefineReservedUsed(IOMapper, 0);
55e303ae
A
42OSMetaClassDefineReservedUnused(IOMapper, 1);
43OSMetaClassDefineReservedUnused(IOMapper, 2);
44OSMetaClassDefineReservedUnused(IOMapper, 3);
45OSMetaClassDefineReservedUnused(IOMapper, 4);
46OSMetaClassDefineReservedUnused(IOMapper, 5);
47OSMetaClassDefineReservedUnused(IOMapper, 6);
48OSMetaClassDefineReservedUnused(IOMapper, 7);
49OSMetaClassDefineReservedUnused(IOMapper, 8);
50OSMetaClassDefineReservedUnused(IOMapper, 9);
51OSMetaClassDefineReservedUnused(IOMapper, 10);
52OSMetaClassDefineReservedUnused(IOMapper, 11);
53OSMetaClassDefineReservedUnused(IOMapper, 12);
54OSMetaClassDefineReservedUnused(IOMapper, 13);
55OSMetaClassDefineReservedUnused(IOMapper, 14);
56OSMetaClassDefineReservedUnused(IOMapper, 15);
57
58IOMapper * IOMapper::gSystem = (IOMapper *) IOMapper::kUnknown;
59
60class IOMapperLock {
61 IOLock *fWaitLock;
62public:
63 IOMapperLock() { fWaitLock = IOLockAlloc(); };
64 ~IOMapperLock() { IOLockFree(fWaitLock); };
65
66 void lock() { IOLockLock(fWaitLock); };
67 void unlock() { IOLockUnlock(fWaitLock); };
68 void sleep(void *event) { IOLockSleep(fWaitLock, event, THREAD_UNINT); };
69 void wakeup(void *event) { IOLockWakeup(fWaitLock, event, false); };
70};
71
72static IOMapperLock sMapperLock;
73
74bool IOMapper::start(IOService *provider)
75{
76 if (!super::start(provider))
77 return false;
78
79 if (!initHardware(provider))
80 return false;
81
82 if (fIsSystem) {
83 sMapperLock.lock();
84 IOMapper::gSystem = this;
85 sMapperLock.wakeup(&IOMapper::gSystem);
86 sMapperLock.unlock();
87 }
88
89 return true;
90}
91
92bool IOMapper::allocTable(IOByteCount size)
93{
94 assert(!fTable);
95
96 fTableSize = size;
97 fTableHandle = NewARTTable(size, &fTable, &fTablePhys);
98 return fTableHandle != 0;
99}
100
101void IOMapper::free()
102{
103 if (fTableHandle) {
104 FreeARTTable(fTableHandle, fTableSize);
105 fTableHandle = 0;
106 }
107
108 super::free();
109}
110
111void IOMapper::setMapperRequired(bool hasMapper)
112{
113 if (hasMapper)
114 IOMapper::gSystem = (IOMapper *) kHasMapper;
115 else {
116 sMapperLock.lock();
117 IOMapper::gSystem = (IOMapper *) kNoMapper;
118 sMapperLock.unlock();
119 sMapperLock.wakeup(&IOMapper::gSystem);
120 }
121}
122
123void IOMapper::waitForSystemMapper()
124{
125 sMapperLock.lock();
126 while ((vm_address_t) IOMapper::gSystem & kWaitMask)
127 sMapperLock.sleep(&IOMapper::gSystem);
128 sMapperLock.unlock();
129}
130
131void IOMapper::iovmInsert(ppnum_t addr, IOItemCount offset,
132 ppnum_t *pageList, IOItemCount pageCount)
133{
134 while (pageCount--)
135 iovmInsert(addr, offset++, *pageList++);
136}
137
138void IOMapper::iovmInsert(ppnum_t addr, IOItemCount offset,
139 upl_page_info_t *pageList, IOItemCount pageCount)
140{
141 for (IOItemCount i = 0; i < pageCount; i++)
142 iovmInsert(addr, offset + i, pageList[i].phys_addr);
143}
144
0c530ab8
A
145OSData * IOMapper::
146NewARTTable(IOByteCount size, void ** virtAddrP, ppnum_t *physAddrP)
6601e61a 147{
0c530ab8
A
148 if (!virtAddrP || !physAddrP)
149 return 0;
150
55e303ae 151 kern_return_t kr;
0c530ab8 152 vm_address_t address;
55e303ae 153
55e303ae 154 size = round_page_32(size);
2d21ac55 155 kr = kmem_alloc_contig(kernel_map, &address, size, PAGE_MASK, 0, 0);
0c530ab8 156 if (kr)
55e303ae
A
157 return 0;
158
0c530ab8
A
159 ppnum_t pagenum = pmap_find_phys(kernel_pmap, (addr64_t) address);
160 if (pagenum)
161 *physAddrP = pagenum;
162 else {
163 FreeARTTable((OSData *) address, size);
164 address = 0;
165 }
55e303ae 166
0c530ab8 167 *virtAddrP = (void *) address;
55e303ae 168
0c530ab8 169 return (OSData *) address;
55e303ae
A
170}
171
172void IOMapper::FreeARTTable(OSData *artHandle, IOByteCount size)
173{
0c530ab8 174 vm_address_t address = (vm_address_t) artHandle;
21362eb3 175
0c530ab8
A
176 size = round_page_32(size);
177 kmem_free(kernel_map, address, size); // Just panic if address is 0
178}
6601e61a 179
0c530ab8
A
180bool IOMapper::getBypassMask(addr64_t *maskP) const
181{
182 return false;
55e303ae
A
183}
184
185__BEGIN_DECLS
186
187// These are C accessors to the system mapper for non-IOKit clients
188ppnum_t IOMapperIOVMAlloc(unsigned pages)
189{
190 IOMapper::checkForSystemMapper();
191
192 if (IOMapper::gSystem)
193 return IOMapper::gSystem->iovmAlloc((IOItemCount) pages);
194 else
195 return 0;
196}
197
198void IOMapperIOVMFree(ppnum_t addr, unsigned pages)
199{
200 if (IOMapper::gSystem)
201 IOMapper::gSystem->iovmFree(addr, (IOItemCount) pages);
202}
203
204ppnum_t IOMapperInsertPage(ppnum_t addr, unsigned offset, ppnum_t page)
205{
206 if (IOMapper::gSystem) {
207 IOMapper::gSystem->iovmInsert(addr, (IOItemCount) offset, page);
208 return addr + offset;
209 }
210 else
211 return page;
212}
213
214void IOMapperInsertPPNPages(ppnum_t addr, unsigned offset,
215 ppnum_t *pageList, unsigned pageCount)
216{
217 if (!IOMapper::gSystem)
218 panic("IOMapperInsertPPNPages no system mapper");
219 else
220 assert(!((vm_address_t) IOMapper::gSystem & 3));
221
222 IOMapper::gSystem->
223 iovmInsert(addr, (IOItemCount) offset, pageList, pageCount);
224}
225
226void IOMapperInsertUPLPages(ppnum_t addr, unsigned offset,
227 upl_page_info_t *pageList, unsigned pageCount)
228{
229 if (!IOMapper::gSystem)
230 panic("IOMapperInsertUPLPages no system mapper");
231 else
232 assert(!((vm_address_t) IOMapper::gSystem & 3));
233
234 IOMapper::gSystem->iovmInsert(addr,
235 (IOItemCount) offset,
236 pageList,
237 (IOItemCount) pageCount);
238}
239
240/////////////////////////////////////////////////////////////////////////////
241//
242//
243// IOLib.h APIs
244//
245//
246/////////////////////////////////////////////////////////////////////////////
247
248#include <machine/machine_routines.h>
249
250UInt8 IOMappedRead8(IOPhysicalAddress address)
251{
252 IOMapper::checkForSystemMapper();
253
254 if (IOMapper::gSystem) {
255 addr64_t addr = IOMapper::gSystem->mapAddr(address);
256 return (UInt8) ml_phys_read_byte_64(addr);
257 }
258 else
259 return (UInt8) ml_phys_read_byte((vm_offset_t) address);
260}
261
262UInt16 IOMappedRead16(IOPhysicalAddress address)
263{
264 IOMapper::checkForSystemMapper();
265
266 if (IOMapper::gSystem) {
267 addr64_t addr = IOMapper::gSystem->mapAddr(address);
268 return (UInt16) ml_phys_read_half_64(addr);
269 }
270 else
271 return (UInt16) ml_phys_read_half((vm_offset_t) address);
272}
273
274UInt32 IOMappedRead32(IOPhysicalAddress address)
275{
276 IOMapper::checkForSystemMapper();
277
278 if (IOMapper::gSystem) {
279 addr64_t addr = IOMapper::gSystem->mapAddr(address);
280 return (UInt32) ml_phys_read_word_64(addr);
281 }
282 else
283 return (UInt32) ml_phys_read_word((vm_offset_t) address);
284}
285
286UInt64 IOMappedRead64(IOPhysicalAddress address)
287{
288 IOMapper::checkForSystemMapper();
289
290 if (IOMapper::gSystem) {
291 addr64_t addr = IOMapper::gSystem->mapAddr(address);
292 return (UInt64) ml_phys_read_double_64(addr);
293 }
294 else
295 return (UInt64) ml_phys_read_double((vm_offset_t) address);
296}
297
298void IOMappedWrite8(IOPhysicalAddress address, UInt8 value)
299{
300 IOMapper::checkForSystemMapper();
301
302 if (IOMapper::gSystem) {
303 addr64_t addr = IOMapper::gSystem->mapAddr(address);
304 ml_phys_write_byte_64(addr, value);
305 }
306 else
307 ml_phys_write_byte((vm_offset_t) address, value);
308}
309
310void IOMappedWrite16(IOPhysicalAddress address, UInt16 value)
311{
312 IOMapper::checkForSystemMapper();
313
314 if (IOMapper::gSystem) {
315 addr64_t addr = IOMapper::gSystem->mapAddr(address);
316 ml_phys_write_half_64(addr, value);
317 }
318 else
319 ml_phys_write_half((vm_offset_t) address, value);
320}
321
322void IOMappedWrite32(IOPhysicalAddress address, UInt32 value)
323{
324 IOMapper::checkForSystemMapper();
325
326 if (IOMapper::gSystem) {
327 addr64_t addr = IOMapper::gSystem->mapAddr(address);
328 ml_phys_write_word_64(addr, value);
329 }
330 else
331 ml_phys_write_word((vm_offset_t) address, value);
332}
333
334void IOMappedWrite64(IOPhysicalAddress address, UInt64 value)
335{
336 IOMapper::checkForSystemMapper();
337
338 if (IOMapper::gSystem) {
339 addr64_t addr = IOMapper::gSystem->mapAddr(address);
340 ml_phys_write_double_64(addr, value);
341 }
342 else
343 ml_phys_write_double((vm_offset_t) address, value);
344}
345
0c530ab8
A
346mach_vm_address_t IOMallocPhysical(mach_vm_size_t size, mach_vm_address_t mask)
347{
348 mach_vm_address_t address = 0;
349 if (gIOCopyMapper)
350 {
351 address = ptoa_64(gIOCopyMapper->iovmAlloc(atop_64(round_page(size))));
352 }
0c530ab8
A
353 return (address);
354}
355
356void IOFreePhysical(mach_vm_address_t address, mach_vm_size_t size)
357{
358 if (gIOCopyMapper)
359 {
360 gIOCopyMapper->iovmFree(atop_64(address), atop_64(round_page(size)));
361 }
362}
363
364
55e303ae 365__END_DECLS