2 * Copyright (c) 1991 Regents of the University of California.
5 * This code is derived from software contributed to Berkeley by
6 * the Systems Programming Group of the University of Utah Computer
7 * Science Department and William Jolitz of UUNET Technologies Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed by the University of
20 * California, Berkeley and its contributors.
21 * 4. Neither the name of the University nor the names of its contributors
22 * may be used to endorse or promote products derived from this software
23 * without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * Derived from hp300 version by Mike Hibler, this version by William
38 * Jolitz uses a recursive map [a pde points to the page directory] to
39 * map the page tables using the pagetables themselves. This is done to
40 * reduce the impact on kernel virtual memory for lots of sparse address
41 * space, and to reduce the cost of memory to each process.
43 * from: hp300: @(#)pmap.h 7.2 (Berkeley) 12/16/90
44 * from: @(#)pmap.h 7.4 (Berkeley) 5/12/91
45 * from: FreeBSD: src/sys/i386/include/pmap.h,v 1.70 2000/11/30
50 #ifndef _MACHINE_PMAP_H_
51 #define _MACHINE_PMAP_H_
53 #include <machine/pte.h>
54 #include <machine/cpuconf.h>
60 #define PTE_PAGETABLE 2
64 #include <sys/queue.h>
65 #include <sys/_lock.h>
66 #include <sys/_mutex.h>
68 #define PDESIZE sizeof(pd_entry_t) /* for assembly files */
69 #define PTESIZE sizeof(pt_entry_t) /* for assembly files */
73 #define vtophys(va) pmap_extract(pmap_kernel(), (vm_offset_t)(va))
74 #define pmap_kextract(va) pmap_extract(pmap_kernel(), (vm_offset_t)(va))
78 #define pmap_page_get_memattr(m) VM_MEMATTR_DEFAULT
79 #define pmap_page_is_mapped(m) (!TAILQ_EMPTY(&(m)->md.pv_list))
80 #define pmap_page_set_memattr(m, ma) (void)0
87 * This structure is used to hold a virtual<->physical address
88 * association and is used mostly by bootstrap code
91 SLIST_ENTRY(pv_addr) pv_list;
100 vm_offset_t pv_kva; /* first kernel VA mapping */
101 TAILQ_HEAD(,pv_entry) pv_list;
104 #define VM_MDPAGE_INIT(pg) \
106 TAILQ_INIT(&pg->pv_list); \
107 mtx_init(&(pg)->md_page.pvh_mtx, "MDPAGE Mutex", NULL, MTX_DEV);\
108 (pg)->mdpage.pvh_attrs = 0; \
109 } while (/*CONSTCOND*/0)
116 * The number of L2 descriptor tables which can be tracked by an l2_dtable.
117 * A bucket size of 16 provides for 16MB of contiguous virtual address
118 * space per l2_dtable. Most processes will, therefore, require only two or
119 * three of these to map their whole working set.
121 #define L2_BUCKET_LOG2 4
122 #define L2_BUCKET_SIZE (1 << L2_BUCKET_LOG2)
124 * Given the above "L2-descriptors-per-l2_dtable" constant, the number
125 * of l2_dtable structures required to track all possible page descriptors
126 * mappable by an L1 translation table is given by the following constants:
128 #define L2_LOG2 ((32 - L1_S_SHIFT) - L2_BUCKET_LOG2)
129 #define L2_SIZE (1 << L2_LOG2)
134 struct l1_ttable *pm_l1;
135 struct l2_dtable *pm_l2[L2_SIZE];
136 pd_entry_t *pm_pdir; /* KVA of page directory */
137 cpumask_t pm_active; /* active on cpus */
138 struct pmap_statistics pm_stats; /* pmap statictics */
139 TAILQ_HEAD(,pv_entry) pm_pvlist; /* list of mappings in pmap */
142 typedef struct pmap *pmap_t;
145 extern struct pmap kernel_pmap_store;
146 #define kernel_pmap (&kernel_pmap_store)
147 #define pmap_kernel() kernel_pmap
149 #define PMAP_ASSERT_LOCKED(pmap) \
150 mtx_assert(&(pmap)->pm_mtx, MA_OWNED)
151 #define PMAP_LOCK(pmap) mtx_lock(&(pmap)->pm_mtx)
152 #define PMAP_LOCK_DESTROY(pmap) mtx_destroy(&(pmap)->pm_mtx)
153 #define PMAP_LOCK_INIT(pmap) mtx_init(&(pmap)->pm_mtx, "pmap", \
154 NULL, MTX_DEF | MTX_DUPOK)
155 #define PMAP_OWNED(pmap) mtx_owned(&(pmap)->pm_mtx)
156 #define PMAP_MTX(pmap) (&(pmap)->pm_mtx)
157 #define PMAP_TRYLOCK(pmap) mtx_trylock(&(pmap)->pm_mtx)
158 #define PMAP_UNLOCK(pmap) mtx_unlock(&(pmap)->pm_mtx)
163 * For each vm_page_t, there is a list of all currently valid virtual
164 * mappings of that page. An entry is a pv_entry_t, the list is pv_list.
166 typedef struct pv_entry {
167 pmap_t pv_pmap; /* pmap where mapping lies */
168 vm_offset_t pv_va; /* virtual address for mapping */
169 TAILQ_ENTRY(pv_entry) pv_list;
170 TAILQ_ENTRY(pv_entry) pv_plist;
171 int pv_flags; /* flags (wired, etc...) */
176 boolean_t pmap_get_pde_pte(pmap_t, vm_offset_t, pd_entry_t **, pt_entry_t **);
179 * virtual address to page table entry and
180 * to physical address. Likewise for alternate address space.
181 * Note: these work recursively, thus vtopte of a pte will give
182 * the corresponding pde that in turn maps it.
186 * The current top of kernel VM.
188 extern vm_offset_t pmap_curmaxkvaddr;
192 void pmap_set_pcb_pagedir(pmap_t, struct pcb *);
193 /* Virtual address to page table entry */
194 static __inline pt_entry_t *
195 vtopte(vm_offset_t va)
200 if (pmap_get_pde_pte(pmap_kernel(), va, &pdep, &ptep) == FALSE)
205 extern vm_offset_t phys_avail[];
206 extern vm_offset_t virtual_avail;
207 extern vm_offset_t virtual_end;
209 void pmap_bootstrap(vm_offset_t, vm_offset_t, struct pv_addr *);
210 void pmap_kenter(vm_offset_t va, vm_paddr_t pa);
211 void pmap_kenter_nocache(vm_offset_t va, vm_paddr_t pa);
212 void *pmap_kenter_temp(vm_paddr_t pa, int i);
213 void pmap_kenter_user(vm_offset_t va, vm_paddr_t pa);
214 void pmap_kremove(vm_offset_t);
215 void *pmap_mapdev(vm_offset_t, vm_size_t);
216 void pmap_unmapdev(vm_offset_t, vm_size_t);
217 vm_page_t pmap_use_pt(pmap_t, vm_offset_t);
218 void pmap_debug(int);
219 void pmap_map_section(vm_offset_t, vm_offset_t, vm_offset_t, int, int);
220 void pmap_link_l2pt(vm_offset_t, vm_offset_t, struct pv_addr *);
221 vm_size_t pmap_map_chunk(vm_offset_t, vm_offset_t, vm_offset_t, vm_size_t, int, int);
223 pmap_map_entry(vm_offset_t l1pt, vm_offset_t va, vm_offset_t pa, int prot,
225 int pmap_fault_fixup(pmap_t, vm_offset_t, vm_prot_t, int);
228 * Definitions for MMU domains
230 #define PMAP_DOMAINS 15 /* 15 'user' domains (1-15) */
231 #define PMAP_DOMAIN_KERNEL 0 /* The kernel uses domain #0 */
234 * The new pmap ensures that page-tables are always mapping Write-Thru.
235 * Thus, on some platforms we can run fast and loose and avoid syncing PTEs
238 * Unfortunately, not all CPUs have a write-through cache mode. So we
239 * define PMAP_NEEDS_PTE_SYNC for C code to conditionally do PTE syncs,
240 * and if there is the chance for PTE syncs to be needed, we define
241 * PMAP_INCLUDE_PTE_SYNC so e.g. assembly code can include (and run)
244 extern int pmap_needs_pte_sync;
247 * These macros define the various bit masks in the PTE.
249 * We use these macros since we use different bits on different processor
252 #define L1_S_PROT_U (L1_S_AP(AP_U))
253 #define L1_S_PROT_W (L1_S_AP(AP_W))
254 #define L1_S_PROT_MASK (L1_S_PROT_U|L1_S_PROT_W)
256 #define L1_S_CACHE_MASK_generic (L1_S_B|L1_S_C)
257 #define L1_S_CACHE_MASK_xscale (L1_S_B|L1_S_C|L1_S_XSCALE_TEX(TEX_XSCALE_X)|\
258 L1_S_XSCALE_TEX(TEX_XSCALE_T))
260 #define L2_L_PROT_U (L2_AP(AP_U))
261 #define L2_L_PROT_W (L2_AP(AP_W))
262 #define L2_L_PROT_MASK (L2_L_PROT_U|L2_L_PROT_W)
264 #define L2_L_CACHE_MASK_generic (L2_B|L2_C)
265 #define L2_L_CACHE_MASK_xscale (L2_B|L2_C|L2_XSCALE_L_TEX(TEX_XSCALE_X) | \
266 L2_XSCALE_L_TEX(TEX_XSCALE_T))
268 #define L2_S_PROT_U_generic (L2_AP(AP_U))
269 #define L2_S_PROT_W_generic (L2_AP(AP_W))
270 #define L2_S_PROT_MASK_generic (L2_S_PROT_U|L2_S_PROT_W)
272 #define L2_S_PROT_U_xscale (L2_AP0(AP_U))
273 #define L2_S_PROT_W_xscale (L2_AP0(AP_W))
274 #define L2_S_PROT_MASK_xscale (L2_S_PROT_U|L2_S_PROT_W)
276 #define L2_S_CACHE_MASK_generic (L2_B|L2_C)
277 #define L2_S_CACHE_MASK_xscale (L2_B|L2_C|L2_XSCALE_T_TEX(TEX_XSCALE_X)| \
278 L2_XSCALE_T_TEX(TEX_XSCALE_X))
280 #define L1_S_PROTO_generic (L1_TYPE_S | L1_S_IMP)
281 #define L1_S_PROTO_xscale (L1_TYPE_S)
283 #define L1_C_PROTO_generic (L1_TYPE_C | L1_C_IMP2)
284 #define L1_C_PROTO_xscale (L1_TYPE_C)
286 #define L2_L_PROTO (L2_TYPE_L)
288 #define L2_S_PROTO_generic (L2_TYPE_S)
289 #define L2_S_PROTO_xscale (L2_TYPE_XSCALE_XS)
292 * User-visible names for the ones that vary with MMU class.
296 /* More than one MMU class configured; use variables. */
297 #define L2_S_PROT_U pte_l2_s_prot_u
298 #define L2_S_PROT_W pte_l2_s_prot_w
299 #define L2_S_PROT_MASK pte_l2_s_prot_mask
301 #define L1_S_CACHE_MASK pte_l1_s_cache_mask
302 #define L2_L_CACHE_MASK pte_l2_l_cache_mask
303 #define L2_S_CACHE_MASK pte_l2_s_cache_mask
305 #define L1_S_PROTO pte_l1_s_proto
306 #define L1_C_PROTO pte_l1_c_proto
307 #define L2_S_PROTO pte_l2_s_proto
309 #elif (ARM_MMU_GENERIC + ARM_MMU_SA1) != 0
310 #define L2_S_PROT_U L2_S_PROT_U_generic
311 #define L2_S_PROT_W L2_S_PROT_W_generic
312 #define L2_S_PROT_MASK L2_S_PROT_MASK_generic
314 #define L1_S_CACHE_MASK L1_S_CACHE_MASK_generic
315 #define L2_L_CACHE_MASK L2_L_CACHE_MASK_generic
316 #define L2_S_CACHE_MASK L2_S_CACHE_MASK_generic
318 #define L1_S_PROTO L1_S_PROTO_generic
319 #define L1_C_PROTO L1_C_PROTO_generic
320 #define L2_S_PROTO L2_S_PROTO_generic
322 #elif ARM_MMU_XSCALE == 1
323 #define L2_S_PROT_U L2_S_PROT_U_xscale
324 #define L2_S_PROT_W L2_S_PROT_W_xscale
325 #define L2_S_PROT_MASK L2_S_PROT_MASK_xscale
327 #define L1_S_CACHE_MASK L1_S_CACHE_MASK_xscale
328 #define L2_L_CACHE_MASK L2_L_CACHE_MASK_xscale
329 #define L2_S_CACHE_MASK L2_S_CACHE_MASK_xscale
331 #define L1_S_PROTO L1_S_PROTO_xscale
332 #define L1_C_PROTO L1_C_PROTO_xscale
333 #define L2_S_PROTO L2_S_PROTO_xscale
335 #endif /* ARM_NMMUS > 1 */
337 #ifdef SKYEYE_WORKAROUNDS
338 #define PMAP_NEEDS_PTE_SYNC 1
339 #define PMAP_INCLUDE_PTE_SYNC
341 #if (ARM_MMU_SA1 == 1) && (ARM_NMMUS == 1)
342 #define PMAP_NEEDS_PTE_SYNC 1
343 #define PMAP_INCLUDE_PTE_SYNC
344 #elif defined(CPU_XSCALE_81342)
345 #define PMAP_NEEDS_PTE_SYNC 1
346 #define PMAP_INCLUDE_PTE_SYNC
347 #elif (ARM_MMU_SA1 == 0)
348 #define PMAP_NEEDS_PTE_SYNC 0
353 * These macros return various bits based on kernel/user and protection.
354 * Note that the compiler will usually fold these at compile time.
356 #define L1_S_PROT(ku, pr) ((((ku) == PTE_USER) ? L1_S_PROT_U : 0) | \
357 (((pr) & VM_PROT_WRITE) ? L1_S_PROT_W : 0))
359 #define L2_L_PROT(ku, pr) ((((ku) == PTE_USER) ? L2_L_PROT_U : 0) | \
360 (((pr) & VM_PROT_WRITE) ? L2_L_PROT_W : 0))
362 #define L2_S_PROT(ku, pr) ((((ku) == PTE_USER) ? L2_S_PROT_U : 0) | \
363 (((pr) & VM_PROT_WRITE) ? L2_S_PROT_W : 0))
366 * Macros to test if a mapping is mappable with an L1 Section mapping
367 * or an L2 Large Page mapping.
369 #define L1_S_MAPPABLE_P(va, pa, size) \
370 ((((va) | (pa)) & L1_S_OFFSET) == 0 && (size) >= L1_S_SIZE)
372 #define L2_L_MAPPABLE_P(va, pa, size) \
373 ((((va) | (pa)) & L2_L_OFFSET) == 0 && (size) >= L2_L_SIZE)
376 * Provide a fallback in case we were not able to determine it at
379 #ifndef PMAP_NEEDS_PTE_SYNC
380 #define PMAP_NEEDS_PTE_SYNC pmap_needs_pte_sync
381 #define PMAP_INCLUDE_PTE_SYNC
384 #define PTE_SYNC(pte) \
386 if (PMAP_NEEDS_PTE_SYNC) { \
387 cpu_dcache_wb_range((vm_offset_t)(pte), sizeof(pt_entry_t));\
388 cpu_l2cache_wb_range((vm_offset_t)(pte), sizeof(pt_entry_t));\
390 } while (/*CONSTCOND*/0)
392 #define PTE_SYNC_RANGE(pte, cnt) \
394 if (PMAP_NEEDS_PTE_SYNC) { \
395 cpu_dcache_wb_range((vm_offset_t)(pte), \
396 (cnt) << 2); /* * sizeof(pt_entry_t) */ \
397 cpu_l2cache_wb_range((vm_offset_t)(pte), \
398 (cnt) << 2); /* * sizeof(pt_entry_t) */ \
400 } while (/*CONSTCOND*/0)
402 extern pt_entry_t pte_l1_s_cache_mode;
403 extern pt_entry_t pte_l1_s_cache_mask;
405 extern pt_entry_t pte_l2_l_cache_mode;
406 extern pt_entry_t pte_l2_l_cache_mask;
408 extern pt_entry_t pte_l2_s_cache_mode;
409 extern pt_entry_t pte_l2_s_cache_mask;
411 extern pt_entry_t pte_l1_s_cache_mode_pt;
412 extern pt_entry_t pte_l2_l_cache_mode_pt;
413 extern pt_entry_t pte_l2_s_cache_mode_pt;
415 extern pt_entry_t pte_l2_s_prot_u;
416 extern pt_entry_t pte_l2_s_prot_w;
417 extern pt_entry_t pte_l2_s_prot_mask;
419 extern pt_entry_t pte_l1_s_proto;
420 extern pt_entry_t pte_l1_c_proto;
421 extern pt_entry_t pte_l2_s_proto;
423 extern void (*pmap_copy_page_func)(vm_paddr_t, vm_paddr_t);
424 extern void (*pmap_zero_page_func)(vm_paddr_t, int, int);
426 #if (ARM_MMU_GENERIC + ARM_MMU_SA1) != 0 || defined(CPU_XSCALE_81342)
427 void pmap_copy_page_generic(vm_paddr_t, vm_paddr_t);
428 void pmap_zero_page_generic(vm_paddr_t, int, int);
430 void pmap_pte_init_generic(void);
431 #if defined(CPU_ARM8)
432 void pmap_pte_init_arm8(void);
434 #if defined(CPU_ARM9)
435 void pmap_pte_init_arm9(void);
436 #endif /* CPU_ARM9 */
437 #if defined(CPU_ARM10)
438 void pmap_pte_init_arm10(void);
439 #endif /* CPU_ARM10 */
440 #endif /* (ARM_MMU_GENERIC + ARM_MMU_SA1) != 0 */
442 #if /* ARM_MMU_SA1 == */1
443 void pmap_pte_init_sa1(void);
444 #endif /* ARM_MMU_SA1 == 1 */
446 #if ARM_MMU_XSCALE == 1
447 void pmap_copy_page_xscale(vm_paddr_t, vm_paddr_t);
448 void pmap_zero_page_xscale(vm_paddr_t, int, int);
450 void pmap_pte_init_xscale(void);
452 void xscale_setup_minidata(vm_offset_t, vm_offset_t, vm_offset_t);
454 void pmap_use_minicache(vm_offset_t, vm_size_t);
455 #endif /* ARM_MMU_XSCALE == 1 */
456 #if defined(CPU_XSCALE_81342)
457 #define ARM_HAVE_SUPERSECTIONS
462 #define l1pte_valid(pde) ((pde) != 0)
463 #define l1pte_section_p(pde) (((pde) & L1_TYPE_MASK) == L1_TYPE_S)
464 #define l1pte_page_p(pde) (((pde) & L1_TYPE_MASK) == L1_TYPE_C)
465 #define l1pte_fpage_p(pde) (((pde) & L1_TYPE_MASK) == L1_TYPE_F)
467 #define l2pte_index(v) (((v) & L2_ADDR_BITS) >> L2_S_SHIFT)
468 #define l2pte_valid(pte) ((pte) != 0)
469 #define l2pte_pa(pte) ((pte) & L2_S_FRAME)
470 #define l2pte_minidata(pte) (((pte) & \
471 (L2_B | L2_C | L2_XSCALE_T_TEX(TEX_XSCALE_X)))\
472 == (L2_C | L2_XSCALE_T_TEX(TEX_XSCALE_X)))
474 /* L1 and L2 page table macros */
475 #define pmap_pde_v(pde) l1pte_valid(*(pde))
476 #define pmap_pde_section(pde) l1pte_section_p(*(pde))
477 #define pmap_pde_page(pde) l1pte_page_p(*(pde))
478 #define pmap_pde_fpage(pde) l1pte_fpage_p(*(pde))
480 #define pmap_pte_v(pte) l2pte_valid(*(pte))
481 #define pmap_pte_pa(pte) l2pte_pa(*(pte))
484 * Flags that indicate attributes of pages or mappings of pages.
486 * The PVF_MOD and PVF_REF flags are stored in the mdpage for each
487 * page. PVF_WIRED, PVF_WRITE, and PVF_NC are kept in individual
488 * pv_entry's for each page. They live in the same "namespace" so
489 * that we can clear multiple attributes at a time.
491 * Note the "non-cacheable" flag generally means the page has
492 * multiple mappings in a given address space.
494 #define PVF_MOD 0x01 /* page is modified */
495 #define PVF_REF 0x02 /* page is referenced */
496 #define PVF_WIRED 0x04 /* mapping is wired */
497 #define PVF_WRITE 0x08 /* mapping is writable */
498 #define PVF_EXEC 0x10 /* mapping is executable */
499 #define PVF_NC 0x20 /* mapping is non-cacheable */
500 #define PVF_MWC 0x40 /* mapping is used multiple times in userland */
501 #define PVF_UNMAN 0x80 /* mapping is unmanaged */
503 void vector_page_setprot(int);
505 void pmap_update(pmap_t);
508 * This structure is used by machine-dependent code to describe
509 * static mappings of devices, created at bootstrap time.
512 vm_offset_t pd_va; /* virtual address */
513 vm_paddr_t pd_pa; /* physical address */
514 vm_size_t pd_size; /* size of region */
515 vm_prot_t pd_prot; /* protection code */
516 int pd_cache; /* cache attributes */
519 const struct pmap_devmap *pmap_devmap_find_pa(vm_paddr_t, vm_size_t);
520 const struct pmap_devmap *pmap_devmap_find_va(vm_offset_t, vm_size_t);
522 void pmap_devmap_bootstrap(vm_offset_t, const struct pmap_devmap *);
523 void pmap_devmap_register(const struct pmap_devmap *);
525 #define SECTION_CACHE 0x1
526 #define SECTION_PT 0x2
527 void pmap_kenter_section(vm_offset_t, vm_paddr_t, int flags);
528 #ifdef ARM_HAVE_SUPERSECTIONS
529 void pmap_kenter_supersection(vm_offset_t, uint64_t, int flags);
534 void pmap_postinit(void);
536 #ifdef ARM_USE_SMALL_ALLOC
537 void arm_add_smallalloc_pages(void *, void *, int, int);
538 vm_offset_t arm_ptovirt(vm_paddr_t);
539 void arm_init_smallalloc(void);
540 struct arm_small_page {
542 TAILQ_ENTRY(arm_small_page) pg_list;
547 #define ARM_NOCACHE_KVA_SIZE 0x1000000
548 extern vm_offset_t arm_nocache_startaddr;
549 void *arm_remap_nocache(void *, vm_size_t);
550 void arm_unmap_nocache(void *, vm_size_t);
552 extern vm_paddr_t dump_avail[];
557 #endif /* !_MACHINE_PMAP_H_ */