xref: /freebsd/sys/arm64/arm64/efirt_machdep.c (revision 1323ec57)
1 /*-
2  * Copyright (c) 2004 Marcel Moolenaar
3  * Copyright (c) 2001 Doug Rabson
4  * Copyright (c) 2016 The FreeBSD Foundation
5  * Copyright (c) 2017 Andrew Turner
6  * All rights reserved.
7  *
8  * Portions of this software were developed by Konstantin Belousov
9  * under sponsorship from the FreeBSD Foundation.
10  *
11  * This software was developed by SRI International and the University of
12  * Cambridge Computer Laboratory under DARPA/AFRL contract FA8750-10-C-0237
13  * ("CTSRD"), as part of the DARPA CRASH research programme.
14  *
15  * Redistribution and use in source and binary forms, with or without
16  * modification, are permitted provided that the following conditions
17  * are met:
18  * 1. Redistributions of source code must retain the above copyright
19  *    notice, this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  *    notice, this list of conditions and the following disclaimer in the
22  *    documentation and/or other materials provided with the distribution.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  */
36 
37 #include <sys/cdefs.h>
38 __FBSDID("$FreeBSD$");
39 
40 #include <sys/param.h>
41 #include <sys/efi.h>
42 #include <sys/kernel.h>
43 #include <sys/linker.h>
44 #include <sys/lock.h>
45 #include <sys/mutex.h>
46 #include <sys/proc.h>
47 #include <sys/rwlock.h>
48 #include <sys/systm.h>
49 #include <sys/vmmeter.h>
50 
51 #include <machine/metadata.h>
52 #include <machine/pcb.h>
53 #include <machine/pte.h>
54 #include <machine/vfp.h>
55 #include <machine/vmparam.h>
56 
57 #include <vm/vm.h>
58 #include <vm/pmap.h>
59 #include <vm/vm_map.h>
60 #include <vm/vm_object.h>
61 #include <vm/vm_page.h>
62 #include <vm/vm_pager.h>
63 
64 static vm_object_t obj_1t1_pt;
65 static vm_pindex_t efi_1t1_idx;
66 static pd_entry_t *efi_l0;
67 static uint64_t efi_ttbr0;
68 
69 void
70 efi_destroy_1t1_map(void)
71 {
72 	vm_page_t m;
73 
74 	if (obj_1t1_pt != NULL) {
75 		VM_OBJECT_RLOCK(obj_1t1_pt);
76 		TAILQ_FOREACH(m, &obj_1t1_pt->memq, listq)
77 			m->ref_count = VPRC_OBJREF;
78 		vm_wire_sub(obj_1t1_pt->resident_page_count);
79 		VM_OBJECT_RUNLOCK(obj_1t1_pt);
80 		vm_object_deallocate(obj_1t1_pt);
81 	}
82 
83 	obj_1t1_pt = NULL;
84 	efi_1t1_idx = 0;
85 	efi_l0 = NULL;
86 	efi_ttbr0 = 0;
87 }
88 
89 static vm_page_t
90 efi_1t1_page(void)
91 {
92 
93 	return (vm_page_grab(obj_1t1_pt, efi_1t1_idx++, VM_ALLOC_NOBUSY |
94 	    VM_ALLOC_WIRED | VM_ALLOC_ZERO));
95 }
96 
97 static pt_entry_t *
98 efi_1t1_l3(vm_offset_t va)
99 {
100 	pd_entry_t *l0, *l1, *l2;
101 	pt_entry_t *l3;
102 	vm_pindex_t l0_idx, l1_idx, l2_idx;
103 	vm_page_t m;
104 	vm_paddr_t mphys;
105 
106 	l0_idx = pmap_l0_index(va);
107 	l0 = &efi_l0[l0_idx];
108 	if (*l0 == 0) {
109 		m = efi_1t1_page();
110 		mphys = VM_PAGE_TO_PHYS(m);
111 		*l0 = mphys | L0_TABLE;
112 	} else {
113 		mphys = *l0 & ~ATTR_MASK;
114 	}
115 
116 	l1 = (pd_entry_t *)PHYS_TO_DMAP(mphys);
117 	l1_idx = pmap_l1_index(va);
118 	l1 += l1_idx;
119 	if (*l1 == 0) {
120 		m = efi_1t1_page();
121 		mphys = VM_PAGE_TO_PHYS(m);
122 		*l1 = mphys | L1_TABLE;
123 	} else {
124 		mphys = *l1 & ~ATTR_MASK;
125 	}
126 
127 	l2 = (pd_entry_t *)PHYS_TO_DMAP(mphys);
128 	l2_idx = pmap_l2_index(va);
129 	l2 += l2_idx;
130 	if (*l2 == 0) {
131 		m = efi_1t1_page();
132 		mphys = VM_PAGE_TO_PHYS(m);
133 		*l2 = mphys | L2_TABLE;
134 	} else {
135 		mphys = *l2 & ~ATTR_MASK;
136 	}
137 
138 	l3 = (pt_entry_t *)PHYS_TO_DMAP(mphys);
139 	l3 += pmap_l3_index(va);
140 	KASSERT(*l3 == 0, ("%s: Already mapped: va %#jx *pt %#jx", __func__,
141 	    va, *l3));
142 
143 	return (l3);
144 }
145 
146 /*
147  * Map a physical address from EFI runtime space into KVA space.  Returns 0 to
148  * indicate a failed mapping so that the caller may handle error.
149  */
150 vm_offset_t
151 efi_phys_to_kva(vm_paddr_t paddr)
152 {
153 	vm_offset_t vaddr;
154 
155 	if (PHYS_IN_DMAP(paddr)) {
156 		vaddr = PHYS_TO_DMAP(paddr);
157 		if (pmap_klookup(vaddr, NULL))
158 			return (vaddr);
159 	}
160 
161 	/* TODO: Map memory not in the DMAP */
162 
163 	return (0);
164 }
165 
166 /*
167  * Create the 1:1 virtual to physical map for EFI
168  */
169 bool
170 efi_create_1t1_map(struct efi_md *map, int ndesc, int descsz)
171 {
172 	struct efi_md *p;
173 	pt_entry_t *l3, l3_attr;
174 	vm_offset_t va;
175 	vm_page_t efi_l0_page;
176 	uint64_t idx;
177 	int i, mode;
178 
179 	obj_1t1_pt = vm_pager_allocate(OBJT_PHYS, NULL, L0_ENTRIES +
180 	    L0_ENTRIES * Ln_ENTRIES + L0_ENTRIES * Ln_ENTRIES * Ln_ENTRIES +
181 	    L0_ENTRIES * Ln_ENTRIES * Ln_ENTRIES * Ln_ENTRIES,
182 	    VM_PROT_ALL, 0, NULL);
183 	VM_OBJECT_WLOCK(obj_1t1_pt);
184 	efi_l0_page = efi_1t1_page();
185 	VM_OBJECT_WUNLOCK(obj_1t1_pt);
186 	efi_l0 = (pd_entry_t *)PHYS_TO_DMAP(VM_PAGE_TO_PHYS(efi_l0_page));
187 	efi_ttbr0 = ASID_TO_OPERAND(ASID_RESERVED_FOR_EFI) |
188 	    VM_PAGE_TO_PHYS(efi_l0_page);
189 
190 	for (i = 0, p = map; i < ndesc; i++, p = efi_next_descriptor(p,
191 	    descsz)) {
192 		if ((p->md_attr & EFI_MD_ATTR_RT) == 0)
193 			continue;
194 		if (p->md_virt != 0 && p->md_virt != p->md_phys) {
195 			if (bootverbose)
196 				printf("EFI Runtime entry %d is mapped\n", i);
197 			goto fail;
198 		}
199 		if ((p->md_phys & EFI_PAGE_MASK) != 0) {
200 			if (bootverbose)
201 				printf("EFI Runtime entry %d is not aligned\n",
202 				    i);
203 			goto fail;
204 		}
205 		if (p->md_phys + p->md_pages * EFI_PAGE_SIZE < p->md_phys ||
206 		    p->md_phys + p->md_pages * EFI_PAGE_SIZE >=
207 		    VM_MAXUSER_ADDRESS) {
208 			printf("EFI Runtime entry %d is not in mappable for RT:"
209 			    "base %#016jx %#jx pages\n",
210 			    i, (uintmax_t)p->md_phys,
211 			    (uintmax_t)p->md_pages);
212 			goto fail;
213 		}
214 		if ((p->md_attr & EFI_MD_ATTR_WB) != 0)
215 			mode = VM_MEMATTR_WRITE_BACK;
216 		else if ((p->md_attr & EFI_MD_ATTR_WT) != 0)
217 			mode = VM_MEMATTR_WRITE_THROUGH;
218 		else if ((p->md_attr & EFI_MD_ATTR_WC) != 0)
219 			mode = VM_MEMATTR_WRITE_COMBINING;
220 		else
221 			mode = VM_MEMATTR_DEVICE;
222 
223 		printf("MAP %lx mode %x pages %lu\n", p->md_phys, mode, p->md_pages);
224 
225 		l3_attr = ATTR_DEFAULT | ATTR_S1_IDX(mode) |
226 		    ATTR_S1_AP(ATTR_S1_AP_RW) | ATTR_S1_nG | L3_PAGE;
227 		if (mode == VM_MEMATTR_DEVICE || p->md_attr & EFI_MD_ATTR_XP)
228 			l3_attr |= ATTR_S1_XN;
229 
230 		VM_OBJECT_WLOCK(obj_1t1_pt);
231 		for (va = p->md_phys, idx = 0; idx < p->md_pages;
232 		    idx += (PAGE_SIZE / EFI_PAGE_SIZE), va += PAGE_SIZE) {
233 			l3 = efi_1t1_l3(va);
234 			*l3 = va | l3_attr;
235 		}
236 		VM_OBJECT_WUNLOCK(obj_1t1_pt);
237 	}
238 
239 	return (true);
240 fail:
241 	efi_destroy_1t1_map();
242 	return (false);
243 }
244 
245 int
246 efi_arch_enter(void)
247 {
248 
249 	CRITICAL_ASSERT(curthread);
250 
251 	/*
252 	 * Temporarily switch to EFI's page table.  However, we leave curpmap
253 	 * unchanged in order to prevent its ASID from being reclaimed before
254 	 * we switch back to its page table in efi_arch_leave().
255 	 */
256 	set_ttbr0(efi_ttbr0);
257 	if (PCPU_GET(bcast_tlbi_workaround) != 0)
258 		invalidate_local_icache();
259 
260 	return (0);
261 }
262 
263 void
264 efi_arch_leave(void)
265 {
266 
267 	/*
268 	 * Restore the pcpu pointer. Some UEFI implementations trash it and
269 	 * we don't store it before calling into them. To fix this we need
270 	 * to restore it after returning to the kernel context. As reading
271 	 * curpmap will access x18 we need to restore it before loading
272 	 * the pmap pointer.
273 	 */
274 	__asm __volatile(
275 	    "mrs x18, tpidr_el1	\n"
276 	);
277 	set_ttbr0(pmap_to_ttbr0(PCPU_GET(curpmap)));
278 	if (PCPU_GET(bcast_tlbi_workaround) != 0)
279 		invalidate_local_icache();
280 }
281 
282 int
283 efi_rt_arch_call(struct efirt_callinfo *ec)
284 {
285 
286 	panic("not implemented");
287 }
288