1 /*- 2 * SPDX-License-Identifier: BSD-3-Clause AND BSD-4-Clause 3 * 4 * Copyright (C) 2006 Semihalf, Marian Balakowicz <m8@semihalf.com> 5 * All rights reserved. 6 * 7 * Adapted for Freescale's e500 core CPUs. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 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. The name of the author may not be used to endorse or promote products 18 * derived from this software without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 21 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 22 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN 23 * NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED 25 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 26 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 27 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 28 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 29 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 * 31 * $FreeBSD$ 32 */ 33 /*- 34 * Copyright (C) 1995, 1996 Wolfgang Solfrank. 35 * Copyright (C) 1995, 1996 TooLs GmbH. 36 * All rights reserved. 37 * 38 * Redistribution and use in source and binary forms, with or without 39 * modification, are permitted provided that the following conditions 40 * are met: 41 * 1. Redistributions of source code must retain the above copyright 42 * notice, this list of conditions and the following disclaimer. 43 * 2. Redistributions in binary form must reproduce the above copyright 44 * notice, this list of conditions and the following disclaimer in the 45 * documentation and/or other materials provided with the distribution. 46 * 3. All advertising materials mentioning features or use of this software 47 * must display the following acknowledgement: 48 * This product includes software developed by TooLs GmbH. 49 * 4. The name of TooLs GmbH may not be used to endorse or promote products 50 * derived from this software without specific prior written permission. 51 * 52 * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR 53 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 54 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 55 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 56 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 57 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 58 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 59 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 60 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 61 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 62 * 63 * from: $NetBSD: pmap.h,v 1.17 2000/03/30 16:18:24 jdolecek Exp $ 64 */ 65 66 #ifndef _MACHINE_PMAP_H_ 67 #define _MACHINE_PMAP_H_ 68 69 #include <sys/queue.h> 70 #include <sys/tree.h> 71 #include <sys/_cpuset.h> 72 #include <sys/_lock.h> 73 #include <sys/_mutex.h> 74 #include <machine/sr.h> 75 #include <machine/pte.h> 76 #include <machine/slb.h> 77 #include <machine/tlb.h> 78 #include <machine/vmparam.h> 79 80 struct pmap; 81 typedef struct pmap *pmap_t; 82 83 #if !defined(NPMAPS) 84 #define NPMAPS 32768 85 #endif /* !defined(NPMAPS) */ 86 87 struct slbtnode; 88 89 struct pvo_entry { 90 LIST_ENTRY(pvo_entry) pvo_vlink; /* Link to common virt page */ 91 #ifndef __powerpc64__ 92 LIST_ENTRY(pvo_entry) pvo_olink; /* Link to overflow entry */ 93 #endif 94 union { 95 RB_ENTRY(pvo_entry) pvo_plink; /* Link to pmap entries */ 96 SLIST_ENTRY(pvo_entry) pvo_dlink; /* Link to delete enty */ 97 }; 98 struct { 99 #ifndef __powerpc64__ 100 /* 32-bit fields */ 101 pte_t pte; 102 #endif 103 /* 64-bit fields */ 104 uintptr_t slot; 105 vm_paddr_t pa; 106 vm_prot_t prot; 107 } pvo_pte; 108 pmap_t pvo_pmap; /* Owning pmap */ 109 vm_offset_t pvo_vaddr; /* VA of entry */ 110 uint64_t pvo_vpn; /* Virtual page number */ 111 }; 112 LIST_HEAD(pvo_head, pvo_entry); 113 SLIST_HEAD(pvo_dlist, pvo_entry); 114 RB_HEAD(pvo_tree, pvo_entry); 115 int pvo_vaddr_compare(struct pvo_entry *, struct pvo_entry *); 116 RB_PROTOTYPE(pvo_tree, pvo_entry, pvo_plink, pvo_vaddr_compare); 117 118 /* Used by 32-bit PMAP */ 119 #define PVO_PTEGIDX_MASK 0x007UL /* which PTEG slot */ 120 #define PVO_PTEGIDX_VALID 0x008UL /* slot is valid */ 121 /* Used by 64-bit PMAP */ 122 #define PVO_HID 0x008UL /* PVO entry in alternate hash*/ 123 /* Used by both */ 124 #define PVO_WIRED 0x010UL /* PVO entry is wired */ 125 #define PVO_MANAGED 0x020UL /* PVO entry is managed */ 126 #define PVO_BOOTSTRAP 0x080UL /* PVO entry allocated during 127 bootstrap */ 128 #define PVO_DEAD 0x100UL /* waiting to be deleted */ 129 #define PVO_LARGE 0x200UL /* large page */ 130 #define PVO_VADDR(pvo) ((pvo)->pvo_vaddr & ~ADDR_POFF) 131 #define PVO_PTEGIDX_GET(pvo) ((pvo)->pvo_vaddr & PVO_PTEGIDX_MASK) 132 #define PVO_PTEGIDX_ISSET(pvo) ((pvo)->pvo_vaddr & PVO_PTEGIDX_VALID) 133 #define PVO_PTEGIDX_CLR(pvo) \ 134 ((void)((pvo)->pvo_vaddr &= ~(PVO_PTEGIDX_VALID|PVO_PTEGIDX_MASK))) 135 #define PVO_PTEGIDX_SET(pvo, i) \ 136 ((void)((pvo)->pvo_vaddr |= (i)|PVO_PTEGIDX_VALID)) 137 #define PVO_VSID(pvo) ((pvo)->pvo_vpn >> 16) 138 139 struct pmap { 140 struct pmap_statistics pm_stats; 141 struct mtx pm_mtx; 142 cpuset_t pm_active; 143 union { 144 struct { 145 146 #ifdef __powerpc64__ 147 struct slbtnode *pm_slb_tree_root; 148 struct slb **pm_slb; 149 int pm_slb_len; 150 #else 151 register_t pm_sr[16]; 152 #endif 153 154 struct pmap *pmap_phys; 155 struct pvo_tree pmap_pvo; 156 }; 157 struct { 158 /* TID to identify this pmap entries in TLB */ 159 tlbtid_t pm_tid[MAXCPU]; 160 161 #ifdef __powerpc64__ 162 /* 163 * Page table directory, 164 * array of pointers to page directories. 165 */ 166 pte_t ***pm_pp2d; 167 #else 168 /* 169 * Page table directory, 170 * array of pointers to page tables. 171 */ 172 pte_t **pm_pdir; 173 174 /* List of allocated ptbl bufs (ptbl kva regions). */ 175 TAILQ_HEAD(, ptbl_buf) pm_ptbl_list; 176 #endif 177 }; 178 }; 179 }; 180 181 struct pv_entry { 182 pmap_t pv_pmap; 183 vm_offset_t pv_va; 184 TAILQ_ENTRY(pv_entry) pv_link; 185 }; 186 typedef struct pv_entry *pv_entry_t; 187 188 struct md_page { 189 union { 190 struct { 191 volatile int32_t mdpg_attrs; 192 vm_memattr_t mdpg_cache_attrs; 193 struct pvo_head mdpg_pvoh; 194 }; 195 struct { 196 TAILQ_HEAD(, pv_entry) pv_list; 197 int pv_tracked; 198 }; 199 }; 200 }; 201 202 #ifdef AIM 203 #define pmap_page_get_memattr(m) ((m)->md.mdpg_cache_attrs) 204 #define pmap_page_is_mapped(m) (!LIST_EMPTY(&(m)->md.mdpg_pvoh)) 205 #else 206 #define pmap_page_get_memattr(m) VM_MEMATTR_DEFAULT 207 #define pmap_page_is_mapped(m) (!TAILQ_EMPTY(&(m)->md.pv_list)) 208 #endif 209 210 /* 211 * Return the VSID corresponding to a given virtual address. 212 * If no VSID is currently defined, it will allocate one, and add 213 * it to a free slot if available. 214 * 215 * NB: The PMAP MUST be locked already. 216 */ 217 uint64_t va_to_vsid(pmap_t pm, vm_offset_t va); 218 219 /* Lock-free, non-allocating lookup routines */ 220 uint64_t kernel_va_to_slbv(vm_offset_t va); 221 struct slb *user_va_to_slb_entry(pmap_t pm, vm_offset_t va); 222 223 uint64_t allocate_user_vsid(pmap_t pm, uint64_t esid, int large); 224 void free_vsid(pmap_t pm, uint64_t esid, int large); 225 void slb_insert_user(pmap_t pm, struct slb *slb); 226 void slb_insert_kernel(uint64_t slbe, uint64_t slbv); 227 228 struct slbtnode *slb_alloc_tree(void); 229 void slb_free_tree(pmap_t pm); 230 struct slb **slb_alloc_user_cache(void); 231 void slb_free_user_cache(struct slb **); 232 233 extern struct pmap kernel_pmap_store; 234 #define kernel_pmap (&kernel_pmap_store) 235 236 #ifdef _KERNEL 237 238 #define PMAP_LOCK(pmap) mtx_lock(&(pmap)->pm_mtx) 239 #define PMAP_LOCK_ASSERT(pmap, type) \ 240 mtx_assert(&(pmap)->pm_mtx, (type)) 241 #define PMAP_LOCK_DESTROY(pmap) mtx_destroy(&(pmap)->pm_mtx) 242 #define PMAP_LOCK_INIT(pmap) mtx_init(&(pmap)->pm_mtx, \ 243 (pmap == kernel_pmap) ? "kernelpmap" : \ 244 "pmap", NULL, MTX_DEF) 245 #define PMAP_LOCKED(pmap) mtx_owned(&(pmap)->pm_mtx) 246 #define PMAP_MTX(pmap) (&(pmap)->pm_mtx) 247 #define PMAP_TRYLOCK(pmap) mtx_trylock(&(pmap)->pm_mtx) 248 #define PMAP_UNLOCK(pmap) mtx_unlock(&(pmap)->pm_mtx) 249 250 #define pmap_page_is_write_mapped(m) (((m)->aflags & PGA_WRITEABLE) != 0) 251 252 void pmap_bootstrap(vm_offset_t, vm_offset_t); 253 void pmap_kenter(vm_offset_t va, vm_paddr_t pa); 254 void pmap_kenter_attr(vm_offset_t va, vm_paddr_t pa, vm_memattr_t); 255 void pmap_kremove(vm_offset_t); 256 void *pmap_mapdev(vm_paddr_t, vm_size_t); 257 void *pmap_mapdev_attr(vm_paddr_t, vm_size_t, vm_memattr_t); 258 void pmap_unmapdev(vm_offset_t, vm_size_t); 259 void pmap_page_set_memattr(vm_page_t, vm_memattr_t); 260 int pmap_change_attr(vm_offset_t, vm_size_t, vm_memattr_t); 261 int pmap_map_user_ptr(pmap_t pm, volatile const void *uaddr, 262 void **kaddr, size_t ulen, size_t *klen); 263 int pmap_decode_kernel_ptr(vm_offset_t addr, int *is_user, 264 vm_offset_t *decoded_addr); 265 void pmap_deactivate(struct thread *); 266 vm_paddr_t pmap_kextract(vm_offset_t); 267 int pmap_dev_direct_mapped(vm_paddr_t, vm_size_t); 268 boolean_t pmap_mmu_install(char *name, int prio); 269 270 #define vtophys(va) pmap_kextract((vm_offset_t)(va)) 271 272 extern vm_offset_t virtual_avail; 273 extern vm_offset_t virtual_end; 274 275 extern vm_offset_t msgbuf_phys; 276 277 extern int pmap_bootstrapped; 278 279 vm_offset_t pmap_early_io_map(vm_paddr_t pa, vm_size_t size); 280 void pmap_early_io_unmap(vm_offset_t va, vm_size_t size); 281 void pmap_track_page(pmap_t pmap, vm_offset_t va); 282 283 static inline int 284 pmap_vmspace_copy(pmap_t dst_pmap __unused, pmap_t src_pmap __unused) 285 { 286 287 return (0); 288 } 289 290 #endif 291 292 #endif /* !_MACHINE_PMAP_H_ */ 293