2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2011 Nathan Whitehorn
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/kernel.h>
35 #include <sys/mutex.h>
36 #include <sys/systm.h>
40 #include <vm/vm_page.h>
43 #include <machine/bus.h>
44 #include <machine/md_var.h>
45 #include <machine/pcb.h>
46 #include <machine/rtas.h>
47 #include <machine/stdarg.h>
49 #include <dev/ofw/openfirm.h>
51 static MALLOC_DEFINE(M_RTAS, "rtas", "Run Time Abstraction Service");
53 static vm_offset_t rtas_bounce_phys;
54 static caddr_t rtas_bounce_virt;
55 static off_t rtas_bounce_offset;
56 static size_t rtas_bounce_size;
57 static uintptr_t rtas_private_data;
58 static struct mtx rtas_mtx;
59 static phandle_t rtas;
62 int rtascall(vm_offset_t callbuffer, uintptr_t rtas_privdat);
63 extern uintptr_t rtas_entry;
64 extern register_t rtasmsr;
67 * After the VM is up, allocate RTAS memory and instantiate it
70 static void rtas_setup(void *);
72 SYSINIT(rtas_setup, SI_SUB_KMEM, SI_ORDER_ANY, rtas_setup, NULL);
75 rtas_setup(void *junk)
78 cell_t rtas_size = 0, rtas_ptr;
82 rtas = OF_finddevice("/rtas");
87 OF_package_to_path(rtas, path, sizeof(path));
89 mtx_init(&rtas_mtx, "RTAS", NULL, MTX_SPIN);
91 /* RTAS must be called with everything turned off in MSR */
93 rtasmsr &= ~(PSL_IR | PSL_DR | PSL_EE | PSL_SE);
99 * Allocate rtas_size + one page of contiguous, wired physical memory
100 * that can fit into a 32-bit address space and accessed from real mode.
101 * This is used both to bounce arguments and for RTAS private data.
103 * It must be 4KB-aligned and not cross a 256 MB boundary.
106 OF_getencprop(rtas, "rtas-size", &rtas_size, sizeof(rtas_size));
107 rtas_size = round_page(rtas_size);
108 rtas_bounce_virt = contigmalloc(rtas_size + PAGE_SIZE, M_RTAS, 0, 0,
109 ulmin(platform_real_maxaddr(), BUS_SPACE_MAXADDR_32BIT),
110 4096, 256*1024*1024);
112 rtas_private_data = vtophys(rtas_bounce_virt);
113 rtas_bounce_virt += rtas_size; /* Actual bounce area */
114 rtas_bounce_phys = vtophys(rtas_bounce_virt);
115 rtas_bounce_size = PAGE_SIZE;
118 * Instantiate RTAS. We always use the 32-bit version.
121 if (OF_hasprop(rtas, "linux,rtas-entry") &&
122 OF_hasprop(rtas, "linux,rtas-base")) {
123 OF_getencprop(rtas, "linux,rtas-base", &rtas_ptr,
125 rtas_private_data = rtas_ptr;
126 OF_getencprop(rtas, "linux,rtas-entry", &rtas_ptr,
129 rtasi = OF_open(path);
132 printf("Error initializing RTAS: could not open "
137 result = OF_call_method("instantiate-rtas", rtasi, 1, 1,
138 (cell_t)rtas_private_data, &rtas_ptr);
144 printf("Error initializing RTAS (%d)\n", result);
149 rtas_entry = (uintptr_t)(rtas_ptr);
153 rtas_real_map(const void *buf, size_t len)
157 mtx_assert(&rtas_mtx, MA_OWNED);
160 * Make sure the bounce page offset satisfies any reasonable
161 * alignment constraint.
163 rtas_bounce_offset += sizeof(register_t) -
164 (rtas_bounce_offset % sizeof(register_t));
166 if (rtas_bounce_offset + len > rtas_bounce_size) {
167 panic("Oversize RTAS call!");
172 memcpy(rtas_bounce_virt + rtas_bounce_offset, buf, len);
176 phys = rtas_bounce_phys + rtas_bounce_offset;
177 rtas_bounce_offset += len;
183 rtas_real_unmap(cell_t physaddr, void *buf, size_t len)
185 mtx_assert(&rtas_mtx, MA_OWNED);
190 memcpy(buf, rtas_bounce_virt + (physaddr - rtas_bounce_phys), len);
193 /* Check if we have RTAS */
200 /* Call an RTAS method by token */
202 rtas_call_method(cell_t token, int nargs, int nreturns, ...)
205 jmp_buf env, *oldfaultbuf;
211 cell_t args_n_results[12];
215 if (!rtas_exists() || nargs + nreturns > 12)
219 va_start(ap, nreturns);
221 mtx_lock_spin(&rtas_mtx);
222 rtas_bounce_offset = 0;
225 args.nreturns = nreturns;
227 for (n = 0; n < nargs; n++)
228 args.args_n_results[n] = va_arg(ap, cell_t);
230 argsptr = rtas_real_map(&args, sizeof(args));
232 /* Get rid of any stale machine checks that have been waiting. */
233 __asm __volatile ("sync; isync");
234 oldfaultbuf = curthread->td_pcb->pcb_onfault;
235 curthread->td_pcb->pcb_onfault = &env;
237 __asm __volatile ("sync");
238 result = rtascall(argsptr, rtas_private_data);
239 __asm __volatile ("sync; isync");
241 result = RTAS_HW_ERROR;
243 curthread->td_pcb->pcb_onfault = oldfaultbuf;
244 __asm __volatile ("sync");
246 rtas_real_unmap(argsptr, &args, sizeof(args));
247 mtx_unlock_spin(&rtas_mtx);
252 for (n = nargs; n < nargs + nreturns; n++)
253 *va_arg(ap, cell_t *) = args.args_n_results[n];
257 /* Look up an RTAS token */
259 rtas_token_lookup(const char *method)
266 if (OF_getencprop(rtas, method, &token, sizeof(token)) == -1)