1 /* $NetBSD: Locore.c,v 1.7 2000/08/20 07:04:59 tsubai Exp $ */
4 * Copyright (C) 1995, 1996 Wolfgang Solfrank.
5 * Copyright (C) 1995, 1996 TooLs GmbH.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. All advertising materials mentioning features or use of this software
17 * must display the following acknowledgement:
18 * This product includes software developed by TooLs GmbH.
19 * 4. The name of TooLs GmbH may not be used to endorse or promote products
20 * derived from this software without specific prior written permission.
22 * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR
23 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
26 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
28 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
29 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
30 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
31 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 * Copyright (C) 2000 Benno Rice.
35 * All rights reserved.
37 * Redistribution and use in source and binary forms, with or without
38 * modification, are permitted provided that the following conditions
40 * 1. Redistributions of source code must retain the above copyright
41 * notice, this list of conditions and the following disclaimer.
42 * 2. Redistributions in binary form must reproduce the above copyright
43 * notice, this list of conditions and the following disclaimer in the
44 * documentation and/or other materials provided with the distribution.
46 * THIS SOFTWARE IS PROVIDED BY Benno Rice ``AS IS'' AND ANY EXPRESS OR
47 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
48 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
49 * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
50 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
51 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
52 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
53 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
54 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
55 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
58 #include <sys/cdefs.h>
59 __FBSDID("$FreeBSD$");
61 #include "opt_platform.h"
63 #include <sys/param.h>
64 #include <sys/kernel.h>
65 #include <sys/malloc.h>
66 #include <sys/systm.h>
67 #include <sys/endian.h>
69 #include <machine/stdarg.h>
71 #include <dev/ofw/ofwvar.h>
72 #include <dev/ofw/openfirm.h>
76 static void OF_putchar(int c, void *arg);
78 MALLOC_DEFINE(M_OFWPROP, "openfirm", "Open Firmware properties");
80 static ihandle_t stdout;
82 static ofw_def_t *ofw_def_impl = NULL;
84 static struct ofw_kobj ofw_kernel_obj;
85 static struct kobj_ops ofw_kernel_kops;
91 SLIST_ENTRY(xrefinfo) next_entry;
94 static SLIST_HEAD(, xrefinfo) xreflist = SLIST_HEAD_INITIALIZER(xreflist);
95 static boolean_t xref_init_done;
97 #define FIND_BY_XREF 0
98 #define FIND_BY_NODE 1
102 * xref-phandle-device lookup helper routines.
104 * As soon as we are able to use malloc(), walk the node tree and build a list
105 * of info that cross-references node handles, xref handles, and device_t
106 * instances. This list exists primarily to allow association of a device_t
107 * with an xref handle, but it is also used to speed up translation between xref
108 * and node handles. Before malloc() is available we have to recursively search
109 * the node tree each time we want to translate between a node and xref handle.
110 * Afterwards we can do the translations by searching this much shorter list.
113 xrefinfo_create(phandle_t node)
115 struct xrefinfo * xi;
116 phandle_t child, xref;
119 * Recursively descend from parent, looking for nodes with a property
120 * named either "phandle", "ibm,phandle", or "linux,phandle". For each
121 * such node found create an entry in the xreflist.
123 for (child = OF_child(node); child != 0; child = OF_peer(child)) {
124 xrefinfo_create(child);
125 if (OF_getencprop(child, "phandle", &xref, sizeof(xref)) ==
126 -1 && OF_getencprop(child, "ibm,phandle", &xref,
127 sizeof(xref)) == -1 && OF_getencprop(child,
128 "linux,phandle", &xref, sizeof(xref)) == -1)
130 xi = malloc(sizeof(*xi), M_OFWPROP, M_WAITOK | M_ZERO);
133 SLIST_INSERT_HEAD(&xreflist, xi, next_entry);
138 xrefinfo_init(void *unsed)
141 xrefinfo_create(OF_peer(0));
142 xref_init_done = true;
144 SYSINIT(xrefinfo, SI_SUB_KMEM, SI_ORDER_ANY, xrefinfo_init, NULL);
146 static struct xrefinfo *
147 xrefinfo_find(phandle_t phandle, int find_by)
149 struct xrefinfo * xi;
151 SLIST_FOREACH(xi, &xreflist, next_entry) {
152 if (find_by == FIND_BY_XREF && phandle == xi->xref)
154 else if (find_by == FIND_BY_NODE && phandle == xi->node)
156 else if (find_by == FIND_BY_DEV && phandle == (uintptr_t)xi->dev)
163 * OFW install routines. Highest priority wins, equal priority also
164 * overrides allowing last-set to win.
166 SET_DECLARE(ofw_set, ofw_def_t);
169 OF_install(char *name, int prio)
171 ofw_def_t *ofwp, **ofwpp;
172 static int curr_prio = 0;
175 * Try and locate the OFW kobj corresponding to the name.
177 SET_FOREACH(ofwpp, ofw_set) {
181 !strcmp(ofwp->name, name) &&
194 OF_init(void *cookie)
199 if (ofw_def_impl == NULL)
202 ofw_obj = &ofw_kernel_obj;
204 * Take care of compiling the selected class, and
205 * then statically initialize the OFW object.
207 kobj_class_compile_static(ofw_def_impl, &ofw_kernel_kops);
208 kobj_init_static((kobj_t)ofw_obj, ofw_def_impl);
210 rv = OFW_INIT(ofw_obj, cookie);
212 if ((chosen = OF_finddevice("/chosen")) != -1)
213 if (OF_getencprop(chosen, "stdout", &stdout,
214 sizeof(stdout)) == -1)
221 OF_putchar(int c, void *arg __unused)
227 OF_write(stdout, &cbuf, 1);
231 OF_write(stdout, &cbuf, 1);
235 OF_printf(const char *fmt, ...)
240 (void)kvprintf(fmt, OF_putchar, NULL, 10, va);
248 /* Test to see if a service exists. */
250 OF_test(const char *name)
253 if (ofw_def_impl == NULL)
256 return (OFW_TEST(ofw_obj, name));
260 OF_interpret(const char *cmd, int nreturns, ...)
267 if (ofw_def_impl == NULL)
270 status = OFW_INTERPRET(ofw_obj, cmd, nreturns, slots);
274 va_start(ap, nreturns);
276 *va_arg(ap, cell_t *) = slots[i++];
283 * Device tree functions
286 /* Return the next sibling of this node or 0. */
288 OF_peer(phandle_t node)
291 if (ofw_def_impl == NULL)
294 return (OFW_PEER(ofw_obj, node));
297 /* Return the first child of this node or 0. */
299 OF_child(phandle_t node)
302 if (ofw_def_impl == NULL)
305 return (OFW_CHILD(ofw_obj, node));
308 /* Return the parent of this node or 0. */
310 OF_parent(phandle_t node)
313 if (ofw_def_impl == NULL)
316 return (OFW_PARENT(ofw_obj, node));
319 /* Return the package handle that corresponds to an instance handle. */
321 OF_instance_to_package(ihandle_t instance)
324 if (ofw_def_impl == NULL)
327 return (OFW_INSTANCE_TO_PACKAGE(ofw_obj, instance));
330 /* Get the length of a property of a package. */
332 OF_getproplen(phandle_t package, const char *propname)
335 if (ofw_def_impl == NULL)
338 return (OFW_GETPROPLEN(ofw_obj, package, propname));
341 /* Check existence of a property of a package. */
343 OF_hasprop(phandle_t package, const char *propname)
346 return (OF_getproplen(package, propname) >= 0 ? 1 : 0);
349 /* Get the value of a property of a package. */
351 OF_getprop(phandle_t package, const char *propname, void *buf, size_t buflen)
354 if (ofw_def_impl == NULL)
357 return (OFW_GETPROP(ofw_obj, package, propname, buf, buflen));
361 OF_getencprop(phandle_t node, const char *propname, pcell_t *buf, size_t len)
366 KASSERT(len % 4 == 0, ("Need a multiple of 4 bytes"));
368 retval = OF_getprop(node, propname, buf, len);
369 for (i = 0; i < len/4; i++)
370 buf[i] = be32toh(buf[i]);
376 * Recursively search the node and its parent for the given property, working
377 * downward from the node to the device tree root. Returns the value of the
381 OF_searchprop(phandle_t node, const char *propname, void *buf, size_t len)
385 for (; node != 0; node = OF_parent(node))
386 if ((rv = OF_getprop(node, propname, buf, len)) != -1)
392 OF_searchencprop(phandle_t node, const char *propname, void *buf, size_t len)
396 for (; node != 0; node = OF_parent(node))
397 if ((rv = OF_getencprop(node, propname, buf, len)) != -1)
403 * Store the value of a property of a package into newly allocated memory
404 * (using the M_OFWPROP malloc pool and M_WAITOK). elsz is the size of a
405 * single element, the number of elements is return in number.
408 OF_getprop_alloc(phandle_t package, const char *propname, int elsz, void **buf)
413 if ((len = OF_getproplen(package, propname)) == -1 ||
417 *buf = malloc(len, M_OFWPROP, M_WAITOK);
418 if (OF_getprop(package, propname, *buf, len) == -1) {
419 free(*buf, M_OFWPROP);
427 OF_getencprop_alloc(phandle_t package, const char *name, int elsz, void **buf)
433 retval = OF_getprop_alloc(package, name, elsz, buf);
434 if (retval == -1 || retval*elsz % 4 != 0)
438 for (i = 0; i < retval*elsz/4; i++)
439 cell[i] = be32toh(cell[i]);
444 /* Get the next property of a package. */
446 OF_nextprop(phandle_t package, const char *previous, char *buf, size_t size)
449 if (ofw_def_impl == NULL)
452 return (OFW_NEXTPROP(ofw_obj, package, previous, buf, size));
455 /* Set the value of a property of a package. */
457 OF_setprop(phandle_t package, const char *propname, const void *buf, size_t len)
460 if (ofw_def_impl == NULL)
463 return (OFW_SETPROP(ofw_obj, package, propname, buf,len));
466 /* Convert a device specifier to a fully qualified pathname. */
468 OF_canon(const char *device, char *buf, size_t len)
471 if (ofw_def_impl == NULL)
474 return (OFW_CANON(ofw_obj, device, buf, len));
477 /* Return a package handle for the specified device. */
479 OF_finddevice(const char *device)
482 if (ofw_def_impl == NULL)
485 return (OFW_FINDDEVICE(ofw_obj, device));
488 /* Return the fully qualified pathname corresponding to an instance. */
490 OF_instance_to_path(ihandle_t instance, char *buf, size_t len)
493 if (ofw_def_impl == NULL)
496 return (OFW_INSTANCE_TO_PATH(ofw_obj, instance, buf, len));
499 /* Return the fully qualified pathname corresponding to a package. */
501 OF_package_to_path(phandle_t package, char *buf, size_t len)
504 if (ofw_def_impl == NULL)
507 return (OFW_PACKAGE_TO_PATH(ofw_obj, package, buf, len));
510 /* Look up effective phandle (see FDT/PAPR spec) */
512 OF_child_xref_phandle(phandle_t parent, phandle_t xref)
514 phandle_t child, rxref;
517 * Recursively descend from parent, looking for a node with a property
518 * named either "phandle", "ibm,phandle", or "linux,phandle" that
519 * matches the xref we are looking for.
522 for (child = OF_child(parent); child != 0; child = OF_peer(child)) {
523 rxref = OF_child_xref_phandle(child, xref);
527 if (OF_getencprop(child, "phandle", &rxref, sizeof(rxref)) ==
528 -1 && OF_getencprop(child, "ibm,phandle", &rxref,
529 sizeof(rxref)) == -1 && OF_getencprop(child,
530 "linux,phandle", &rxref, sizeof(rxref)) == -1)
541 OF_node_from_xref(phandle_t xref)
546 if (xref_init_done) {
547 if ((xi = xrefinfo_find(xref, FIND_BY_XREF)) == NULL)
552 if ((node = OF_child_xref_phandle(OF_peer(0), xref)) == -1)
558 xref_from_node(phandle_t node, phandle_t notfoundvalue)
563 if (xref_init_done) {
564 if ((xi = xrefinfo_find(node, FIND_BY_NODE)) == NULL)
565 return (notfoundvalue);
569 if (OF_getencprop(node, "phandle", &xref, sizeof(xref)) ==
570 -1 && OF_getencprop(node, "ibm,phandle", &xref,
571 sizeof(xref)) == -1 && OF_getencprop(node,
572 "linux,phandle", &xref, sizeof(xref)) == -1)
573 return (notfoundvalue);
578 OF_xref_from_node(phandle_t node)
581 return (xref_from_node(node, node));
585 OF_xref_from_node_strict(phandle_t node)
588 return (xref_from_node(node, -1));
592 OF_device_from_xref(phandle_t xref)
596 if (xref_init_done) {
597 if ((xi = xrefinfo_find(xref, FIND_BY_XREF)) == NULL)
601 panic("Attempt to find device before xreflist_init");
605 OF_xref_from_device(device_t dev)
609 if (xref_init_done) {
610 if ((xi = xrefinfo_find((uintptr_t)dev, FIND_BY_DEV)) == NULL)
614 panic("Attempt to find xref before xreflist_init");
618 OF_device_register_xref(phandle_t xref, device_t dev)
622 if (xref_init_done) {
623 if ((xi = xrefinfo_find(xref, FIND_BY_XREF)) == NULL)
628 panic("Attempt to register device before xreflist_init");
631 /* Call the method in the scope of a given instance. */
633 OF_call_method(const char *method, ihandle_t instance, int nargs, int nreturns,
637 cell_t args_n_results[12];
640 if (nargs > 6 || ofw_def_impl == NULL)
642 va_start(ap, nreturns);
643 for (n = 0; n < nargs; n++)
644 args_n_results[n] = va_arg(ap, cell_t);
646 status = OFW_CALL_METHOD(ofw_obj, instance, method, nargs, nreturns,
651 for (; n < nargs + nreturns; n++)
652 *va_arg(ap, cell_t *) = args_n_results[n];
658 * Device I/O functions
661 /* Open an instance for a device. */
663 OF_open(const char *device)
666 if (ofw_def_impl == NULL)
669 return (OFW_OPEN(ofw_obj, device));
672 /* Close an instance. */
674 OF_close(ihandle_t instance)
677 if (ofw_def_impl == NULL)
680 OFW_CLOSE(ofw_obj, instance);
683 /* Read from an instance. */
685 OF_read(ihandle_t instance, void *addr, size_t len)
688 if (ofw_def_impl == NULL)
691 return (OFW_READ(ofw_obj, instance, addr, len));
694 /* Write to an instance. */
696 OF_write(ihandle_t instance, const void *addr, size_t len)
699 if (ofw_def_impl == NULL)
702 return (OFW_WRITE(ofw_obj, instance, addr, len));
705 /* Seek to a position. */
707 OF_seek(ihandle_t instance, uint64_t pos)
710 if (ofw_def_impl == NULL)
713 return (OFW_SEEK(ofw_obj, instance, pos));
720 /* Claim an area of memory. */
722 OF_claim(void *virt, size_t size, u_int align)
725 if (ofw_def_impl == NULL)
728 return (OFW_CLAIM(ofw_obj, virt, size, align));
731 /* Release an area of memory. */
733 OF_release(void *virt, size_t size)
736 if (ofw_def_impl == NULL)
739 OFW_RELEASE(ofw_obj, virt, size);
743 * Control transfer functions
746 /* Suspend and drop back to the Open Firmware interface. */
751 if (ofw_def_impl == NULL)
757 /* Shut down and drop back to the Open Firmware interface. */
762 if (ofw_def_impl == NULL)
763 panic("OF_exit: Open Firmware not available");
765 /* Should not return */
768 for (;;) /* just in case */