2 * Copyright (c) 2013 Ian Lepore <ian@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 #include <sys/cdefs.h>
28 __FBSDID("$FreeBSD$");
31 * Routines for mapping device memory.
33 * This is used on both arm and arm64.
38 #include <sys/param.h>
39 #include <sys/systm.h>
41 #include <vm/vm_extern.h>
44 #include <machine/acle-compat.h>
46 #include <machine/armreg.h>
47 #include <machine/devmap.h>
48 #include <machine/vmparam.h>
50 static const struct arm_devmap_entry *devmap_table;
51 static boolean_t devmap_bootstrap_done = false;
53 #if defined(__aarch64__)
54 #define MAX_VADDR VM_MAX_KERNEL_ADDRESS
55 #elif defined(__arm__)
56 #define MAX_VADDR ARM_VECTORS_HIGH
60 * The allocated-kva (akva) devmap table and metadata. Platforms can call
61 * arm_devmap_add_entry() to add static device mappings to this table using
62 * automatically allocated virtual addresses carved out of the top of kva space.
63 * Allocation begins immediately below the ARM_VECTORS_HIGH address.
65 #define AKVA_DEVMAP_MAX_ENTRIES 32
66 static struct arm_devmap_entry akva_devmap_entries[AKVA_DEVMAP_MAX_ENTRIES];
67 static u_int akva_devmap_idx;
68 static vm_offset_t akva_devmap_vaddr = MAX_VADDR;
71 extern int early_boot;
75 * Print the contents of the static mapping table using the provided printf-like
76 * output function (which will be either printf or db_printf).
79 devmap_dump_table(int (*prfunc)(const char *, ...))
81 const struct arm_devmap_entry *pd;
83 if (devmap_table == NULL || devmap_table[0].pd_size == 0) {
84 prfunc("No static device mappings.\n");
88 prfunc("Static device mappings:\n");
89 for (pd = devmap_table; pd->pd_size != 0; ++pd) {
90 prfunc(" 0x%08x - 0x%08x mapped at VA 0x%08x\n",
91 pd->pd_pa, pd->pd_pa + pd->pd_size - 1, pd->pd_va);
96 * Print the contents of the static mapping table. Used for bootverbose.
99 arm_devmap_print_table()
101 devmap_dump_table(printf);
105 * Return the "last" kva address used by the registered devmap table. It's
106 * actually the lowest address used by the static mappings, i.e., the address of
107 * the first unusable byte of KVA.
110 arm_devmap_lastaddr()
112 const struct arm_devmap_entry *pd;
115 if (akva_devmap_idx > 0)
116 return (akva_devmap_vaddr);
119 for (pd = devmap_table; pd != NULL && pd->pd_size != 0; ++pd) {
120 if (lowaddr > pd->pd_va)
128 * Add an entry to the internal "akva" static devmap table using the given
129 * physical address and size and a virtual address allocated from the top of
130 * kva. This automatically registers the akva table on the first call, so all a
131 * platform has to do is call this routine to install as many mappings as it
132 * needs and when initarm() calls arm_devmap_bootstrap() it will pick up all the
133 * entries in the akva table automatically.
136 arm_devmap_add_entry(vm_paddr_t pa, vm_size_t sz)
138 struct arm_devmap_entry *m;
140 if (devmap_bootstrap_done)
141 panic("arm_devmap_add_entry() after arm_devmap_bootstrap()");
143 if (akva_devmap_idx == (AKVA_DEVMAP_MAX_ENTRIES - 1))
144 panic("AKVA_DEVMAP_MAX_ENTRIES is too small");
146 if (akva_devmap_idx == 0)
147 arm_devmap_register_table(akva_devmap_entries);
150 * Allocate virtual address space from the top of kva downwards. If the
151 * range being mapped is aligned and sized to 1MB boundaries then also
152 * align the virtual address to the next-lower 1MB boundary so that we
153 * end up with a nice efficient section mapping.
156 if ((pa & 0x000fffff) == 0 && (sz & 0x000fffff) == 0) {
157 akva_devmap_vaddr = trunc_1mpage(akva_devmap_vaddr - sz);
161 akva_devmap_vaddr = trunc_page(akva_devmap_vaddr - sz);
163 m = &akva_devmap_entries[akva_devmap_idx++];
164 m->pd_va = akva_devmap_vaddr;
170 * Register the given table as the one to use in arm_devmap_bootstrap().
173 arm_devmap_register_table(const struct arm_devmap_entry *table)
176 devmap_table = table;
180 * Map all of the static regions in the devmap table, and remember the devmap
181 * table so the mapdev, ptov, and vtop functions can do lookups later.
183 * If a non-NULL table pointer is given it is used unconditionally, otherwise
184 * the previously-registered table is used. This smooths transition from legacy
185 * code that fills in a local table then calls this function passing that table,
186 * and newer code that uses arm_devmap_register_table() in platform-specific
187 * code, then lets the common initarm() call this function with a NULL pointer.
190 arm_devmap_bootstrap(vm_offset_t l1pt, const struct arm_devmap_entry *table)
192 const struct arm_devmap_entry *pd;
194 devmap_bootstrap_done = true;
197 * If given a table pointer, use it. Otherwise, if a table was
198 * previously registered, use it. Otherwise, no work to do.
201 devmap_table = table;
202 else if (devmap_table == NULL)
205 for (pd = devmap_table; pd->pd_size != 0; ++pd) {
208 pmap_preboot_map_attr(pd->pd_pa, pd->pd_va, pd->pd_size,
209 VM_PROT_READ | VM_PROT_WRITE, VM_MEMATTR_DEVICE);
211 pmap_map_chunk(l1pt, pd->pd_va, pd->pd_pa, pd->pd_size,
212 VM_PROT_READ | VM_PROT_WRITE, PTE_DEVICE);
214 #elif defined(__aarch64__)
215 pmap_kenter_device(pd->pd_va, pd->pd_size, pd->pd_pa);
221 * Look up the given physical address in the static mapping data and return the
222 * corresponding virtual address, or NULL if not found.
225 arm_devmap_ptov(vm_paddr_t pa, vm_size_t size)
227 const struct arm_devmap_entry *pd;
229 if (devmap_table == NULL)
232 for (pd = devmap_table; pd->pd_size != 0; ++pd) {
233 if (pa >= pd->pd_pa && pa + size <= pd->pd_pa + pd->pd_size)
234 return ((void *)(pd->pd_va + (pa - pd->pd_pa)));
241 * Look up the given virtual address in the static mapping data and return the
242 * corresponding physical address, or DEVMAP_PADDR_NOTFOUND if not found.
245 arm_devmap_vtop(void * vpva, vm_size_t size)
247 const struct arm_devmap_entry *pd;
250 if (devmap_table == NULL)
251 return (DEVMAP_PADDR_NOTFOUND);
253 va = (vm_offset_t)vpva;
254 for (pd = devmap_table; pd->pd_size != 0; ++pd) {
255 if (va >= pd->pd_va && va + size <= pd->pd_va + pd->pd_size)
256 return ((vm_paddr_t)(pd->pd_pa + (va - pd->pd_va)));
259 return (DEVMAP_PADDR_NOTFOUND);
263 * Map a set of physical memory pages into the kernel virtual address space.
264 * Return a pointer to where it is mapped.
266 * This uses a pre-established static mapping if one exists for the requested
267 * range, otherwise it allocates kva space and maps the physical pages into it.
269 * This routine is intended to be used for mapping device memory, NOT real
270 * memory; the mapping type is inherently VM_MEMATTR_DEVICE in
271 * pmap_kenter_device().
274 pmap_mapdev(vm_offset_t pa, vm_size_t size)
276 vm_offset_t va, offset;
279 /* First look in the static mapping table. */
280 if ((rva = arm_devmap_ptov(pa, size)) != NULL)
283 offset = pa & PAGE_MASK;
285 size = round_page(size + offset);
289 akva_devmap_vaddr = trunc_page(akva_devmap_vaddr - size);
290 va = akva_devmap_vaddr;
291 KASSERT(va >= VM_MAX_KERNEL_ADDRESS - L2_SIZE,
292 ("Too many early devmap mappings"));
295 va = kva_alloc(size);
297 panic("pmap_mapdev: Couldn't alloc kernel virtual memory");
299 pmap_kenter_device(va, size, pa);
301 return ((void *)(va + offset));
305 * Unmap device memory and free the kva space.
308 pmap_unmapdev(vm_offset_t va, vm_size_t size)
312 /* Nothing to do if we find the mapping in the static table. */
313 if (arm_devmap_vtop((void*)va, size) != DEVMAP_PADDR_NOTFOUND)
316 offset = va & PAGE_MASK;
318 size = round_page(size + offset);
320 pmap_kremove_device(va, size);
327 DB_SHOW_COMMAND(devmap, db_show_devmap)
329 devmap_dump_table(db_printf);