xref: /netbsd-src/sys/arch/arm/acpi/acpi_machdep.c (revision 82d56013d7b633d116a93943de88e08335357a7c)
1 /* $NetBSD: acpi_machdep.c,v 1.22 2021/04/24 23:36:25 thorpej Exp $ */
2 
3 /*-
4  * Copyright (c) 2018 The NetBSD Foundation, Inc.
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to The NetBSD Foundation
8  * by Jared McNeill <jmcneill@invisible.ca>.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #include "pci.h"
33 
34 #include <sys/cdefs.h>
35 __KERNEL_RCSID(0, "$NetBSD: acpi_machdep.c,v 1.22 2021/04/24 23:36:25 thorpej Exp $");
36 
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/bus.h>
40 #include <sys/cpu.h>
41 #include <sys/device.h>
42 #include <sys/kmem.h>
43 
44 #include <uvm/uvm_extern.h>
45 
46 #include <dev/fdt/fdtvar.h>
47 
48 #include <dev/acpi/acpica.h>
49 #include <dev/acpi/acpivar.h>
50 #if NPCI > 0
51 #include <dev/acpi/acpi_mcfg.h>
52 #endif
53 
54 #include <arm/arm/efi_runtime.h>
55 
56 #include <arm/pic/picvar.h>
57 
58 #include <arm/locore.h>
59 
60 #include <machine/acpi_machdep.h>
61 
62 extern struct bus_space arm_generic_bs_tag;
63 extern struct arm32_bus_dma_tag acpi_coherent_dma_tag;
64 extern struct arm32_bus_dma_tag arm_generic_dma_tag;
65 
66 bus_dma_tag_t	arm_acpi_dma32_tag(struct acpi_softc *, struct acpi_devnode *);
67 bus_dma_tag_t	arm_acpi_dma64_tag(struct acpi_softc *, struct acpi_devnode *);
68 
69 static int
70 acpi_md_pmapflags(paddr_t pa)
71 {
72 	int len;
73 
74 	const int chosen = OF_finddevice("/chosen");
75 	if (chosen == -1)
76 		return 0;
77 
78 	const uint32_t *map = fdtbus_get_prop(chosen, "netbsd,uefi-memmap", &len);
79 	if (map == NULL)
80 		return 0;
81 
82 	while (len >= 28) {
83 		const uint32_t type = be32dec(&map[0]);
84 		const uint64_t phys_start = be64dec(&map[1]);
85 		const uint64_t num_pages = be64dec(&map[3]);
86 		const uint64_t attr = be64dec(&map[5]);
87 
88 		if (pa >= phys_start && pa < phys_start + (num_pages * EFI_PAGE_SIZE)) {
89 			switch (type) {
90 			case EFI_MD_TYPE_RECLAIM:
91 				/* ACPI table memory */
92 				return PMAP_WRITE_BACK;
93 
94 			case EFI_MD_TYPE_IOMEM:
95 			case EFI_MD_TYPE_IOPORT:
96 				return PMAP_DEV;
97 
98 			default:
99 				if ((attr & EFI_MD_ATTR_WB) != 0)
100 					return PMAP_WRITE_BACK;
101 				else if ((attr & EFI_MD_ATTR_WC) != 0)
102 					return PMAP_WRITE_COMBINE;
103 				else if ((attr & EFI_MD_ATTR_WT) != 0)
104 					return 0;	/* XXX */
105 
106 				return PMAP_DEV;
107 			}
108 		}
109 
110 		map += 7;
111 		len -= 28;
112 	}
113 
114 	/* Not found; assume device memory */
115 	return PMAP_DEV;
116 }
117 
118 ACPI_STATUS
119 acpi_md_OsInitialize(void)
120 {
121 	return AE_OK;
122 }
123 
124 ACPI_PHYSICAL_ADDRESS
125 acpi_md_OsGetRootPointer(void)
126 {
127 	uint64_t pa;
128 
129 	const int chosen = OF_finddevice("/chosen");
130 	if (chosen == -1)
131 		return 0;
132 
133 	if (of_getprop_uint64(chosen, "netbsd,acpi-root-table", &pa) != 0)
134 		return 0;
135 
136 	return (ACPI_PHYSICAL_ADDRESS)pa;
137 }
138 
139 ACPI_STATUS
140 acpi_md_OsInstallInterruptHandler(UINT32 irq, ACPI_OSD_HANDLER handler, void *context,
141     void **cookiep, const char *xname)
142 {
143 	return AE_NOT_IMPLEMENTED;
144 }
145 
146 void
147 acpi_md_OsRemoveInterruptHandler(void *cookie)
148 {
149 	intr_disestablish(cookie);
150 }
151 
152 ACPI_STATUS
153 acpi_md_OsMapMemory(ACPI_PHYSICAL_ADDRESS pa, UINT32 size, void **vap)
154 {
155 	paddr_t spa, epa, curpa;
156 	vaddr_t va, curva;
157 
158 	spa = trunc_page(pa);
159 	epa = round_page(pa + size);
160 
161 	va = uvm_km_alloc(kernel_map, epa - spa, 0, UVM_KMF_VAONLY);
162 	if (va == 0)
163 		return AE_NO_MEMORY;
164 
165 	const int pmapflags = acpi_md_pmapflags(spa);
166 
167 	aprint_debug("%s: 0x%lx 0x%x flags = %#x\n", __func__, pa, size, pmapflags);
168 
169 	for (curpa = spa, curva = va; curpa < epa; curpa += PAGE_SIZE, curva += PAGE_SIZE)
170 		pmap_kenter_pa(curva, curpa, VM_PROT_READ | VM_PROT_WRITE, pmapflags);
171 	pmap_update(pmap_kernel());
172 
173 	*vap = (void *)(va + (pa - spa));
174 
175 	return AE_OK;
176 }
177 
178 void
179 acpi_md_OsUnmapMemory(void *va, UINT32 size)
180 {
181 	vaddr_t ova;
182 	vsize_t osz;
183 
184 	ova = trunc_page((vaddr_t)va);
185 	osz = round_page((vaddr_t)va + size) - ova;
186 
187 	pmap_kremove(ova, osz);
188 	pmap_update(pmap_kernel());
189 	uvm_km_free(kernel_map, ova, osz, UVM_KMF_VAONLY);
190 }
191 
192 ACPI_STATUS
193 acpi_md_OsGetPhysicalAddress(void *va, ACPI_PHYSICAL_ADDRESS *pap)
194 {
195 	paddr_t pa;
196 
197 	if (!pmap_extract(pmap_kernel(), (vaddr_t)va, &pa))
198 		return AE_ERROR;
199 
200 	*pap = pa;
201 
202 	return AE_OK;
203 }
204 
205 BOOLEAN
206 acpi_md_OsReadable(void *va, UINT32 len)
207 {
208 	vaddr_t sva, eva;
209 	pt_entry_t *pte;
210 
211 	sva = trunc_page((vaddr_t)va);
212 	eva = round_page((vaddr_t)va + len);
213 
214 	if (sva < VM_MIN_KERNEL_ADDRESS)
215 		return FALSE;
216 
217 	for (; sva < eva; sva += PAGE_SIZE) {
218 		pte = kvtopte(sva);
219 		if ((*pte & (LX_BLKPAG_AF|LX_BLKPAG_AP)) != (LX_BLKPAG_AF|LX_BLKPAG_AP_RO))
220 			return FALSE;
221 	}
222 
223 	return TRUE;
224 }
225 
226 BOOLEAN
227 acpi_md_OsWritable(void *va, UINT32 len)
228 {
229 	vaddr_t sva, eva;
230 	pt_entry_t *pte;
231 
232 	sva = trunc_page((vaddr_t)va);
233 	eva = round_page((vaddr_t)va + len);
234 
235 	if (sva < VM_MIN_KERNEL_ADDRESS)
236 		return FALSE;
237 
238 	for (; sva < eva; sva += PAGE_SIZE) {
239 		pte = kvtopte(sva);
240 		if ((*pte & (LX_BLKPAG_AF|LX_BLKPAG_AP)) != (LX_BLKPAG_AF|LX_BLKPAG_AP_RW))
241 			return FALSE;
242 	}
243 
244 	return TRUE;
245 }
246 
247 void
248 acpi_md_OsEnableInterrupt(void)
249 {
250 	cpsie(I32_bit);
251 }
252 
253 void
254 acpi_md_OsDisableInterrupt(void)
255 {
256 	cpsid(I32_bit);
257 }
258 
259 void *
260 acpi_md_intr_establish(uint32_t irq, int ipl, int type, int (*handler)(void *), void *arg, bool mpsafe, const char *xname)
261 {
262 	return intr_establish_xname(irq, ipl, type | (mpsafe ? IST_MPSAFE : 0), handler, arg, xname);
263 }
264 
265 void
266 acpi_md_intr_mask(void *ih)
267 {
268 	intr_mask(ih);
269 }
270 
271 void
272 acpi_md_intr_unmask(void *ih)
273 {
274 	intr_unmask(ih);
275 }
276 
277 void
278 acpi_md_intr_disestablish(void *ih)
279 {
280 	intr_disestablish(ih);
281 }
282 
283 int
284 acpi_md_sleep(int state)
285 {
286 	printf("ERROR: ACPI sleep not implemented on this platform\n");
287 	return -1;
288 }
289 
290 uint32_t
291 acpi_md_pdc(void)
292 {
293 	return 0;
294 }
295 
296 uint32_t
297 acpi_md_ncpus(void)
298 {
299 	return kcpuset_countset(kcpuset_attached);
300 }
301 
302 static ACPI_STATUS
303 acpi_md_madt_probe_cpu(ACPI_SUBTABLE_HEADER *hdrp, void *aux)
304 {
305 	struct acpi_softc * const sc = aux;
306 
307 	if (hdrp->Type == ACPI_MADT_TYPE_GENERIC_INTERRUPT)
308 		config_found(sc->sc_dev, hdrp, NULL,
309 		    CFARG_IATTR, "acpimadtbus",
310 		    CFARG_EOL);
311 
312 	return AE_OK;
313 }
314 
315 static ACPI_STATUS
316 acpi_md_madt_probe_gic(ACPI_SUBTABLE_HEADER *hdrp, void *aux)
317 {
318 	struct acpi_softc * const sc = aux;
319 
320 	if (hdrp->Type == ACPI_MADT_TYPE_GENERIC_DISTRIBUTOR)
321 		config_found(sc->sc_dev, hdrp, NULL,
322 		    CFARG_IATTR, "acpimadtbus",
323 		    CFARG_EOL);
324 
325 	return AE_OK;
326 }
327 
328 static ACPI_STATUS
329 acpi_md_gtdt_probe(ACPI_GTDT_HEADER *hdrp, void *aux)
330 {
331 	struct acpi_softc * const sc = aux;
332 
333 	config_found(sc->sc_dev, hdrp, NULL,
334 	    CFARG_IATTR, "acpigtdtbus",
335 	    CFARG_EOL);
336 
337 	return AE_OK;
338 }
339 
340 #if NPCI > 0
341 static struct bus_space acpi_md_mcfg_bs_tag;
342 
343 static int
344 acpi_md_mcfg_bs_map(void *t, bus_addr_t bpa, bus_size_t size, int flag,
345     bus_space_handle_t *bshp)
346 {
347 	return arm_generic_bs_tag.bs_map(t, bpa, size,
348 	    flag | _ARM_BUS_SPACE_MAP_STRONGLY_ORDERED, bshp);
349 }
350 #endif
351 
352 void
353 acpi_md_callback(struct acpi_softc *sc)
354 {
355 #if NPCI > 0
356 	acpi_md_mcfg_bs_tag = arm_generic_bs_tag;
357 	acpi_md_mcfg_bs_tag.bs_map = acpi_md_mcfg_bs_map;
358 	acpimcfg_init(&acpi_md_mcfg_bs_tag, NULL);
359 #endif
360 
361 	if (acpi_madt_map() != AE_OK)
362 		panic("Failed to map MADT");
363 	acpi_madt_walk(acpi_md_madt_probe_cpu, sc);
364 	acpi_madt_walk(acpi_md_madt_probe_gic, sc);
365 	acpi_madt_unmap();
366 
367 	if (acpi_gtdt_map() != AE_OK)
368 		panic("Failed to map GTDT");
369 	acpi_gtdt_walk(acpi_md_gtdt_probe, sc);
370 	acpi_gtdt_unmap();
371 }
372 
373 static const char * const module_hid[] = {
374 	"ACPI0004",	/* Module device */
375 	NULL
376 };
377 
378 static ACPI_HANDLE
379 arm_acpi_dma_module(struct acpi_softc *sc, struct acpi_devnode *ad)
380 {
381 	ACPI_HANDLE tmp;
382 	ACPI_STATUS rv;
383 
384 	/*
385 	 * Search up the tree for a module device with a _DMA method.
386 	 */
387 	for (; ad != NULL; ad = ad->ad_parent) {
388 		if (ad->ad_devinfo->Type != ACPI_TYPE_DEVICE)
389 			continue;
390 		if (!acpi_match_hid(ad->ad_devinfo, module_hid))
391 			continue;
392 		rv = AcpiGetHandle(ad->ad_handle, "_DMA", &tmp);
393 		if (ACPI_SUCCESS(rv))
394 			return ad->ad_handle;
395 	}
396 
397 	return NULL;
398 }
399 
400 static void
401 arm_acpi_dma_init_ranges(struct acpi_softc *sc, struct acpi_devnode *ad,
402     struct arm32_bus_dma_tag *dmat, uint32_t flags)
403 {
404 	struct acpi_resources res;
405 	struct acpi_mem *mem;
406 	ACPI_HANDLE module;
407 	ACPI_STATUS rv;
408 	int n;
409 
410 	module = arm_acpi_dma_module(sc, ad->ad_parent);
411 	if (module == NULL) {
412 default_tag:
413 		/* No translation required */
414 		dmat->_nranges = 1;
415 		dmat->_ranges = kmem_zalloc(sizeof(*dmat->_ranges), KM_SLEEP);
416 		dmat->_ranges[0].dr_sysbase = 0;
417 		dmat->_ranges[0].dr_busbase = 0;
418 		dmat->_ranges[0].dr_len = UINTPTR_MAX;
419 		dmat->_ranges[0].dr_flags = flags;
420 		return;
421 	}
422 
423 	rv = acpi_resource_parse(sc->sc_dev, module, "_DMA", &res,
424 	    &acpi_resource_parse_ops_quiet);
425 	if (ACPI_FAILURE(rv)) {
426 		aprint_error_dev(sc->sc_dev,
427 		    "failed to parse _DMA on %s: %s\n",
428 		    acpi_name(module), AcpiFormatException(rv));
429 		goto default_tag;
430 	}
431 	if (res.ar_nmem == 0) {
432 		acpi_resource_cleanup(&res);
433 		goto default_tag;
434 	}
435 
436 	dmat->_nranges = res.ar_nmem;
437 	dmat->_ranges = kmem_zalloc(sizeof(*dmat->_ranges) * res.ar_nmem,
438 	    KM_SLEEP);
439 
440 	for (n = 0; n < res.ar_nmem; n++) {
441 		mem = acpi_res_mem(&res, n);
442 		dmat->_ranges[n].dr_busbase = mem->ar_base;
443 		dmat->_ranges[n].dr_sysbase = mem->ar_xbase;
444 		dmat->_ranges[n].dr_len = mem->ar_length;
445 		dmat->_ranges[n].dr_flags = flags;
446 
447 		aprint_debug_dev(sc->sc_dev,
448 		    "%s: DMA sys %#lx-%#lx bus %#lx-%#lx%s\n",
449 		    acpi_name(ad->ad_handle),
450 		    dmat->_ranges[n].dr_sysbase,
451 		    dmat->_ranges[n].dr_sysbase + dmat->_ranges[n].dr_len - 1,
452 		    dmat->_ranges[n].dr_busbase,
453 		    dmat->_ranges[n].dr_busbase + dmat->_ranges[n].dr_len - 1,
454 		    flags ? " (coherent)" : "");
455 	}
456 
457 	acpi_resource_cleanup(&res);
458 }
459 
460 static uint32_t
461 arm_acpi_dma_flags(struct acpi_softc *sc, struct acpi_devnode *ad)
462 {
463 	ACPI_INTEGER cca = 1;	/* default cache coherent */
464 	ACPI_STATUS rv;
465 
466 	for (; ad != NULL; ad = ad->ad_parent) {
467 		if (ad->ad_devinfo->Type != ACPI_TYPE_DEVICE)
468 			continue;
469 
470 		rv = acpi_eval_integer(ad->ad_handle, "_CCA", &cca);
471 		if (ACPI_SUCCESS(rv))
472 			break;
473 	}
474 
475 	return cca ? _BUS_DMAMAP_COHERENT : 0;
476 }
477 
478 bus_dma_tag_t
479 arm_acpi_dma32_tag(struct acpi_softc *sc, struct acpi_devnode *ad)
480 {
481 	bus_dma_tag_t dmat64, dmat32;
482 	int error;
483 
484 	if (ad->ad_dmat != NULL)
485 		return ad->ad_dmat;
486 
487 	dmat64 = arm_acpi_dma64_tag(sc, ad);
488 
489 	const uint32_t flags = arm_acpi_dma_flags(sc, ad);
490 	error = bus_dmatag_subregion(dmat64, 0, UINT32_MAX, &dmat32, flags);
491 	if (error != 0)
492 		panic("arm_acpi_dma32_tag: bus_dmatag_subregion returned %d",
493 		    error);
494 
495 	return dmat32;
496 }
497 __strong_alias(acpi_get_dma_tag,arm_acpi_dma32_tag);
498 
499 bus_dma_tag_t
500 arm_acpi_dma64_tag(struct acpi_softc *sc, struct acpi_devnode *ad)
501 {
502 	struct arm32_bus_dma_tag *dmat;
503 
504 	if (ad->ad_dmat64 != NULL)
505 		return ad->ad_dmat64;
506 
507 	dmat = kmem_alloc(sizeof(*dmat), KM_SLEEP);
508 	*dmat = arm_generic_dma_tag;
509 
510 	const uint32_t flags = arm_acpi_dma_flags(sc, ad);
511 	arm_acpi_dma_init_ranges(sc, ad, dmat, flags);
512 
513 	return dmat;
514 }
515 __strong_alias(acpi_get_dma64_tag,arm_acpi_dma64_tag);
516