xref: /freebsd-11-stable/sys/dev/ofw/openfirm.c (revision 4ab2e064d7950be84256d671a7ae93f87cc6aa36)
1 /*	$NetBSD: Locore.c,v 1.7 2000/08/20 07:04:59 tsubai Exp $	*/
2 
3 /*-
4  * Copyright (C) 1995, 1996 Wolfgang Solfrank.
5  * Copyright (C) 1995, 1996 TooLs GmbH.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
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.
21  *
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.
32  */
33 /*-
34  * Copyright (C) 2000 Benno Rice.
35  * All rights reserved.
36  *
37  * Redistribution and use in source and binary forms, with or without
38  * modification, are permitted provided that the following conditions
39  * are met:
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.
45  *
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.
56  */
57 
58 #include <sys/cdefs.h>
59 __FBSDID("$FreeBSD$");
60 
61 #include "opt_platform.h"
62 
63 #include <sys/param.h>
64 #include <sys/kernel.h>
65 #include <sys/lock.h>
66 #include <sys/malloc.h>
67 #include <sys/mutex.h>
68 #include <sys/queue.h>
69 #include <sys/systm.h>
70 #include <sys/endian.h>
71 
72 #include <machine/stdarg.h>
73 
74 #include <dev/ofw/ofwvar.h>
75 #include <dev/ofw/openfirm.h>
76 
77 #include "ofw_if.h"
78 
79 static void OF_putchar(int c, void *arg);
80 
81 MALLOC_DEFINE(M_OFWPROP, "openfirm", "Open Firmware properties");
82 
83 static ihandle_t stdout;
84 
85 static ofw_def_t	*ofw_def_impl = NULL;
86 static ofw_t		ofw_obj;
87 static struct ofw_kobj	ofw_kernel_obj;
88 static struct kobj_ops	ofw_kernel_kops;
89 
90 struct xrefinfo {
91 	phandle_t	xref;
92 	phandle_t 	node;
93 	device_t  	dev;
94 	SLIST_ENTRY(xrefinfo) next_entry;
95 };
96 
97 static SLIST_HEAD(, xrefinfo) xreflist = SLIST_HEAD_INITIALIZER(xreflist);
98 static struct mtx xreflist_lock;
99 static boolean_t xref_init_done;
100 
101 #define	FIND_BY_XREF	0
102 #define	FIND_BY_NODE	1
103 #define	FIND_BY_DEV	2
104 
105 /*
106  * xref-phandle-device lookup helper routines.
107  *
108  * As soon as we are able to use malloc(), walk the node tree and build a list
109  * of info that cross-references node handles, xref handles, and device_t
110  * instances.  This list exists primarily to allow association of a device_t
111  * with an xref handle, but it is also used to speed up translation between xref
112  * and node handles.  Before malloc() is available we have to recursively search
113  * the node tree each time we want to translate between a node and xref handle.
114  * Afterwards we can do the translations by searching this much shorter list.
115  */
116 static void
xrefinfo_create(phandle_t node)117 xrefinfo_create(phandle_t node)
118 {
119 	struct xrefinfo * xi;
120 	phandle_t child, xref;
121 
122 	/*
123 	 * Recursively descend from parent, looking for nodes with a property
124 	 * named either "phandle", "ibm,phandle", or "linux,phandle".  For each
125 	 * such node found create an entry in the xreflist.
126 	 */
127 	for (child = OF_child(node); child != 0; child = OF_peer(child)) {
128 		xrefinfo_create(child);
129 		if (OF_getencprop(child, "phandle", &xref, sizeof(xref)) ==
130 		    -1 && OF_getencprop(child, "ibm,phandle", &xref,
131 		    sizeof(xref)) == -1 && OF_getencprop(child,
132 		    "linux,phandle", &xref, sizeof(xref)) == -1)
133 			continue;
134 		xi = malloc(sizeof(*xi), M_OFWPROP, M_WAITOK | M_ZERO);
135 		xi->node = child;
136 		xi->xref = xref;
137 		SLIST_INSERT_HEAD(&xreflist, xi, next_entry);
138 	}
139 }
140 
141 static void
xrefinfo_init(void * unsed)142 xrefinfo_init(void *unsed)
143 {
144 
145 	/*
146 	 * There is no locking during this init because it runs much earlier
147 	 * than any of the clients/consumers of the xref list data, but we do
148 	 * initialize the mutex that will be used for access later.
149 	 */
150 	mtx_init(&xreflist_lock, "OF xreflist lock", NULL, MTX_DEF);
151 	xrefinfo_create(OF_peer(0));
152 	xref_init_done = true;
153 }
154 SYSINIT(xrefinfo, SI_SUB_KMEM, SI_ORDER_ANY, xrefinfo_init, NULL);
155 
156 static struct xrefinfo *
xrefinfo_find(uintptr_t key,int find_by)157 xrefinfo_find(uintptr_t key, int find_by)
158 {
159 	struct xrefinfo *rv, *xi;
160 
161 	rv = NULL;
162 	mtx_lock(&xreflist_lock);
163 	SLIST_FOREACH(xi, &xreflist, next_entry) {
164 		if ((find_by == FIND_BY_XREF && (phandle_t)key == xi->xref) ||
165 		    (find_by == FIND_BY_NODE && (phandle_t)key == xi->node) ||
166 		    (find_by == FIND_BY_DEV && key == (uintptr_t)xi->dev)) {
167 			rv = xi;
168 			break;
169 		}
170 	}
171 	mtx_unlock(&xreflist_lock);
172 	return (rv);
173 }
174 
175 static struct xrefinfo *
xrefinfo_add(phandle_t node,phandle_t xref,device_t dev)176 xrefinfo_add(phandle_t node, phandle_t xref, device_t dev)
177 {
178 	struct xrefinfo *xi;
179 
180 	xi = malloc(sizeof(*xi), M_OFWPROP, M_WAITOK);
181 	xi->node = node;
182 	xi->xref = xref;
183 	xi->dev  = dev;
184 	mtx_lock(&xreflist_lock);
185 	SLIST_INSERT_HEAD(&xreflist, xi, next_entry);
186 	mtx_unlock(&xreflist_lock);
187 	return (xi);
188 }
189 
190 /*
191  * OFW install routines.  Highest priority wins, equal priority also
192  * overrides allowing last-set to win.
193  */
194 SET_DECLARE(ofw_set, ofw_def_t);
195 
196 boolean_t
OF_install(char * name,int prio)197 OF_install(char *name, int prio)
198 {
199 	ofw_def_t *ofwp, **ofwpp;
200 	static int curr_prio = 0;
201 
202 	/* Allow OF layer to be uninstalled */
203 	if (name == NULL) {
204 		ofw_def_impl = NULL;
205 		return (FALSE);
206 	}
207 
208 	/*
209 	 * Try and locate the OFW kobj corresponding to the name.
210 	 */
211 	SET_FOREACH(ofwpp, ofw_set) {
212 		ofwp = *ofwpp;
213 
214 		if (ofwp->name &&
215 		    !strcmp(ofwp->name, name) &&
216 		    prio >= curr_prio) {
217 			curr_prio = prio;
218 			ofw_def_impl = ofwp;
219 			return (TRUE);
220 		}
221 	}
222 
223 	return (FALSE);
224 }
225 
226 /* Initializer */
227 int
OF_init(void * cookie)228 OF_init(void *cookie)
229 {
230 	phandle_t chosen;
231 	int rv;
232 
233 	if (ofw_def_impl == NULL)
234 		return (-1);
235 
236 	ofw_obj = &ofw_kernel_obj;
237 	/*
238 	 * Take care of compiling the selected class, and
239 	 * then statically initialize the OFW object.
240 	 */
241 	kobj_class_compile_static(ofw_def_impl, &ofw_kernel_kops);
242 	kobj_init_static((kobj_t)ofw_obj, ofw_def_impl);
243 
244 	rv = OFW_INIT(ofw_obj, cookie);
245 
246 	if ((chosen = OF_finddevice("/chosen")) != -1)
247 		if (OF_getencprop(chosen, "stdout", &stdout,
248 		    sizeof(stdout)) == -1)
249 			stdout = -1;
250 
251 	return (rv);
252 }
253 
254 static void
OF_putchar(int c,void * arg __unused)255 OF_putchar(int c, void *arg __unused)
256 {
257 	char cbuf;
258 
259 	if (c == '\n') {
260 		cbuf = '\r';
261 		OF_write(stdout, &cbuf, 1);
262 	}
263 
264 	cbuf = c;
265 	OF_write(stdout, &cbuf, 1);
266 }
267 
268 void
OF_printf(const char * fmt,...)269 OF_printf(const char *fmt, ...)
270 {
271 	va_list	va;
272 
273 	va_start(va, fmt);
274 	(void)kvprintf(fmt, OF_putchar, NULL, 10, va);
275 	va_end(va);
276 }
277 
278 /*
279  * Generic functions
280  */
281 
282 /* Test to see if a service exists. */
283 int
OF_test(const char * name)284 OF_test(const char *name)
285 {
286 
287 	if (ofw_def_impl == NULL)
288 		return (-1);
289 
290 	return (OFW_TEST(ofw_obj, name));
291 }
292 
293 int
OF_interpret(const char * cmd,int nreturns,...)294 OF_interpret(const char *cmd, int nreturns, ...)
295 {
296 	va_list ap;
297 	cell_t slots[16];
298 	int i = 0;
299 	int status;
300 
301 	if (ofw_def_impl == NULL)
302 		return (-1);
303 
304 	status = OFW_INTERPRET(ofw_obj, cmd, nreturns, slots);
305 	if (status == -1)
306 		return (status);
307 
308 	va_start(ap, nreturns);
309 	while (i < nreturns)
310 		*va_arg(ap, cell_t *) = slots[i++];
311 	va_end(ap);
312 
313 	return (status);
314 }
315 
316 /*
317  * Device tree functions
318  */
319 
320 /* Return the next sibling of this node or 0. */
321 phandle_t
OF_peer(phandle_t node)322 OF_peer(phandle_t node)
323 {
324 
325 	if (ofw_def_impl == NULL)
326 		return (0);
327 
328 	return (OFW_PEER(ofw_obj, node));
329 }
330 
331 /* Return the first child of this node or 0. */
332 phandle_t
OF_child(phandle_t node)333 OF_child(phandle_t node)
334 {
335 
336 	if (ofw_def_impl == NULL)
337 		return (0);
338 
339 	return (OFW_CHILD(ofw_obj, node));
340 }
341 
342 /* Return the parent of this node or 0. */
343 phandle_t
OF_parent(phandle_t node)344 OF_parent(phandle_t node)
345 {
346 
347 	if (ofw_def_impl == NULL)
348 		return (0);
349 
350 	return (OFW_PARENT(ofw_obj, node));
351 }
352 
353 /* Return the package handle that corresponds to an instance handle. */
354 phandle_t
OF_instance_to_package(ihandle_t instance)355 OF_instance_to_package(ihandle_t instance)
356 {
357 
358 	if (ofw_def_impl == NULL)
359 		return (-1);
360 
361 	return (OFW_INSTANCE_TO_PACKAGE(ofw_obj, instance));
362 }
363 
364 /* Get the length of a property of a package. */
365 ssize_t
OF_getproplen(phandle_t package,const char * propname)366 OF_getproplen(phandle_t package, const char *propname)
367 {
368 
369 	if (ofw_def_impl == NULL)
370 		return (-1);
371 
372 	return (OFW_GETPROPLEN(ofw_obj, package, propname));
373 }
374 
375 /* Check existence of a property of a package. */
376 int
OF_hasprop(phandle_t package,const char * propname)377 OF_hasprop(phandle_t package, const char *propname)
378 {
379 
380 	return (OF_getproplen(package, propname) >= 0 ? 1 : 0);
381 }
382 
383 /* Get the value of a property of a package. */
384 ssize_t
OF_getprop(phandle_t package,const char * propname,void * buf,size_t buflen)385 OF_getprop(phandle_t package, const char *propname, void *buf, size_t buflen)
386 {
387 
388 	if (ofw_def_impl == NULL)
389 		return (-1);
390 
391 	return (OFW_GETPROP(ofw_obj, package, propname, buf, buflen));
392 }
393 
394 ssize_t
OF_getencprop(phandle_t node,const char * propname,pcell_t * buf,size_t len)395 OF_getencprop(phandle_t node, const char *propname, pcell_t *buf, size_t len)
396 {
397 	ssize_t retval;
398 	int i;
399 
400 	KASSERT(len % 4 == 0, ("Need a multiple of 4 bytes"));
401 
402 	retval = OF_getprop(node, propname, buf, len);
403 	if (retval <= 0)
404 		return (retval);
405 
406 	for (i = 0; i < len/4; i++)
407 		buf[i] = be32toh(buf[i]);
408 
409 	return (retval);
410 }
411 
412 /*
413  * Recursively search the node and its parent for the given property, working
414  * downward from the node to the device tree root.  Returns the value of the
415  * first match.
416  */
417 ssize_t
OF_searchprop(phandle_t node,const char * propname,void * buf,size_t len)418 OF_searchprop(phandle_t node, const char *propname, void *buf, size_t len)
419 {
420 	ssize_t rv;
421 
422 	for (; node != 0; node = OF_parent(node))
423 		if ((rv = OF_getprop(node, propname, buf, len)) != -1)
424 			return (rv);
425 	return (-1);
426 }
427 
428 ssize_t
OF_searchencprop(phandle_t node,const char * propname,void * buf,size_t len)429 OF_searchencprop(phandle_t node, const char *propname, void *buf, size_t len)
430 {
431 	ssize_t rv;
432 
433 	for (; node != 0; node = OF_parent(node))
434 		if ((rv = OF_getencprop(node, propname, buf, len)) != -1)
435 			return (rv);
436 	return (-1);
437 }
438 
439 /*
440  * Store the value of a property of a package into newly allocated memory
441  * (using the M_OFWPROP malloc pool and M_WAITOK).  elsz is the size of a
442  * single element, the number of elements is return in number.
443  */
444 ssize_t
OF_getprop_alloc(phandle_t package,const char * propname,int elsz,void ** buf)445 OF_getprop_alloc(phandle_t package, const char *propname, int elsz, void **buf)
446 {
447 	int len;
448 
449 	*buf = NULL;
450 	if ((len = OF_getproplen(package, propname)) == -1 ||
451 	    len % elsz != 0)
452 		return (-1);
453 
454 	*buf = malloc(len, M_OFWPROP, M_WAITOK);
455 	if (OF_getprop(package, propname, *buf, len) == -1) {
456 		free(*buf, M_OFWPROP);
457 		*buf = NULL;
458 		return (-1);
459 	}
460 	return (len / elsz);
461 }
462 
463 ssize_t
OF_getencprop_alloc(phandle_t package,const char * name,int elsz,void ** buf)464 OF_getencprop_alloc(phandle_t package, const char *name, int elsz, void **buf)
465 {
466 	ssize_t retval;
467 	pcell_t *cell;
468 	int i;
469 
470 	retval = OF_getprop_alloc(package, name, elsz, buf);
471 	if (retval == -1)
472 		return (-1);
473  	if (retval * elsz % 4 != 0) {
474 		free(*buf, M_OFWPROP);
475 		*buf = NULL;
476 		return (-1);
477 	}
478 
479 	cell = *buf;
480 	for (i = 0; i < retval * elsz / 4; i++)
481 		cell[i] = be32toh(cell[i]);
482 
483 	return (retval);
484 }
485 
486 /* Free buffer allocated by OF_getencprop_alloc or OF_getprop_alloc */
OF_prop_free(void * buf)487 void OF_prop_free(void *buf)
488 {
489 
490 	free(buf, M_OFWPROP);
491 }
492 
493 /* Get the next property of a package. */
494 int
OF_nextprop(phandle_t package,const char * previous,char * buf,size_t size)495 OF_nextprop(phandle_t package, const char *previous, char *buf, size_t size)
496 {
497 
498 	if (ofw_def_impl == NULL)
499 		return (-1);
500 
501 	return (OFW_NEXTPROP(ofw_obj, package, previous, buf, size));
502 }
503 
504 /* Set the value of a property of a package. */
505 int
OF_setprop(phandle_t package,const char * propname,const void * buf,size_t len)506 OF_setprop(phandle_t package, const char *propname, const void *buf, size_t len)
507 {
508 
509 	if (ofw_def_impl == NULL)
510 		return (-1);
511 
512 	return (OFW_SETPROP(ofw_obj, package, propname, buf,len));
513 }
514 
515 /* Convert a device specifier to a fully qualified pathname. */
516 ssize_t
OF_canon(const char * device,char * buf,size_t len)517 OF_canon(const char *device, char *buf, size_t len)
518 {
519 
520 	if (ofw_def_impl == NULL)
521 		return (-1);
522 
523 	return (OFW_CANON(ofw_obj, device, buf, len));
524 }
525 
526 /* Return a package handle for the specified device. */
527 phandle_t
OF_finddevice(const char * device)528 OF_finddevice(const char *device)
529 {
530 
531 	if (ofw_def_impl == NULL)
532 		return (-1);
533 
534 	return (OFW_FINDDEVICE(ofw_obj, device));
535 }
536 
537 /* Return the fully qualified pathname corresponding to an instance. */
538 ssize_t
OF_instance_to_path(ihandle_t instance,char * buf,size_t len)539 OF_instance_to_path(ihandle_t instance, char *buf, size_t len)
540 {
541 
542 	if (ofw_def_impl == NULL)
543 		return (-1);
544 
545 	return (OFW_INSTANCE_TO_PATH(ofw_obj, instance, buf, len));
546 }
547 
548 /* Return the fully qualified pathname corresponding to a package. */
549 ssize_t
OF_package_to_path(phandle_t package,char * buf,size_t len)550 OF_package_to_path(phandle_t package, char *buf, size_t len)
551 {
552 
553 	if (ofw_def_impl == NULL)
554 		return (-1);
555 
556 	return (OFW_PACKAGE_TO_PATH(ofw_obj, package, buf, len));
557 }
558 
559 /* Look up effective phandle (see FDT/PAPR spec) */
560 static phandle_t
OF_child_xref_phandle(phandle_t parent,phandle_t xref)561 OF_child_xref_phandle(phandle_t parent, phandle_t xref)
562 {
563 	phandle_t child, rxref;
564 
565 	/*
566 	 * Recursively descend from parent, looking for a node with a property
567 	 * named either "phandle", "ibm,phandle", or "linux,phandle" that
568 	 * matches the xref we are looking for.
569 	 */
570 
571 	for (child = OF_child(parent); child != 0; child = OF_peer(child)) {
572 		rxref = OF_child_xref_phandle(child, xref);
573 		if (rxref != -1)
574 			return (rxref);
575 
576 		if (OF_getencprop(child, "phandle", &rxref, sizeof(rxref)) ==
577 		    -1 && OF_getencprop(child, "ibm,phandle", &rxref,
578 		    sizeof(rxref)) == -1 && OF_getencprop(child,
579 		    "linux,phandle", &rxref, sizeof(rxref)) == -1)
580 			continue;
581 
582 		if (rxref == xref)
583 			return (child);
584 	}
585 
586 	return (-1);
587 }
588 
589 phandle_t
OF_node_from_xref(phandle_t xref)590 OF_node_from_xref(phandle_t xref)
591 {
592 	struct xrefinfo *xi;
593 	phandle_t node;
594 
595 	if (xref_init_done) {
596 		if ((xi = xrefinfo_find(xref, FIND_BY_XREF)) == NULL)
597 			return (xref);
598 		return (xi->node);
599 	}
600 
601 	if ((node = OF_child_xref_phandle(OF_peer(0), xref)) == -1)
602 		return (xref);
603 	return (node);
604 }
605 
606 phandle_t
OF_xref_from_node(phandle_t node)607 OF_xref_from_node(phandle_t node)
608 {
609 	struct xrefinfo *xi;
610 	phandle_t xref;
611 
612 	if (xref_init_done) {
613 		if ((xi = xrefinfo_find(node, FIND_BY_NODE)) == NULL)
614 			return (node);
615 		return (xi->xref);
616 	}
617 
618 	if (OF_getencprop(node, "phandle", &xref, sizeof(xref)) == -1 &&
619 	    OF_getencprop(node, "ibm,phandle", &xref, sizeof(xref)) == -1 &&
620 	    OF_getencprop(node, "linux,phandle", &xref, sizeof(xref)) == -1)
621 		return (node);
622 	return (xref);
623 }
624 
625 device_t
OF_device_from_xref(phandle_t xref)626 OF_device_from_xref(phandle_t xref)
627 {
628 	struct xrefinfo *xi;
629 
630 	if (xref_init_done) {
631 		if ((xi = xrefinfo_find(xref, FIND_BY_XREF)) == NULL)
632 			return (NULL);
633 		return (xi->dev);
634 	}
635 	panic("Attempt to find device before xreflist_init");
636 }
637 
638 phandle_t
OF_xref_from_device(device_t dev)639 OF_xref_from_device(device_t dev)
640 {
641 	struct xrefinfo *xi;
642 
643 	if (xref_init_done) {
644 		if ((xi = xrefinfo_find((uintptr_t)dev, FIND_BY_DEV)) == NULL)
645 			return (0);
646 		return (xi->xref);
647 	}
648 	panic("Attempt to find xref before xreflist_init");
649 }
650 
651 int
OF_device_register_xref(phandle_t xref,device_t dev)652 OF_device_register_xref(phandle_t xref, device_t dev)
653 {
654 	struct xrefinfo *xi;
655 
656 	/*
657 	 * If the given xref handle doesn't already exist in the list then we
658 	 * add a list entry.  In theory this can only happen on a system where
659 	 * nodes don't contain phandle properties and xref and node handles are
660 	 * synonymous, so the xref handle is added as the node handle as well.
661 	 */
662 	if (xref_init_done) {
663 		if ((xi = xrefinfo_find(xref, FIND_BY_XREF)) == NULL)
664 			xrefinfo_add(xref, xref, dev);
665 		else
666 			xi->dev = dev;
667 		return (0);
668 	}
669 	panic("Attempt to register device before xreflist_init");
670 }
671 
672 /*  Call the method in the scope of a given instance. */
673 int
OF_call_method(const char * method,ihandle_t instance,int nargs,int nreturns,...)674 OF_call_method(const char *method, ihandle_t instance, int nargs, int nreturns,
675     ...)
676 {
677 	va_list ap;
678 	cell_t args_n_results[12];
679 	int n, status;
680 
681 	if (nargs > 6 || ofw_def_impl == NULL)
682 		return (-1);
683 	va_start(ap, nreturns);
684 	for (n = 0; n < nargs; n++)
685 		args_n_results[n] = va_arg(ap, cell_t);
686 
687 	status = OFW_CALL_METHOD(ofw_obj, instance, method, nargs, nreturns,
688 	    args_n_results);
689 	if (status != 0)
690 		return (status);
691 
692 	for (; n < nargs + nreturns; n++)
693 		*va_arg(ap, cell_t *) = args_n_results[n];
694 	va_end(ap);
695 	return (0);
696 }
697 
698 /*
699  * Device I/O functions
700  */
701 
702 /* Open an instance for a device. */
703 ihandle_t
OF_open(const char * device)704 OF_open(const char *device)
705 {
706 
707 	if (ofw_def_impl == NULL)
708 		return (0);
709 
710 	return (OFW_OPEN(ofw_obj, device));
711 }
712 
713 /* Close an instance. */
714 void
OF_close(ihandle_t instance)715 OF_close(ihandle_t instance)
716 {
717 
718 	if (ofw_def_impl == NULL)
719 		return;
720 
721 	OFW_CLOSE(ofw_obj, instance);
722 }
723 
724 /* Read from an instance. */
725 ssize_t
OF_read(ihandle_t instance,void * addr,size_t len)726 OF_read(ihandle_t instance, void *addr, size_t len)
727 {
728 
729 	if (ofw_def_impl == NULL)
730 		return (-1);
731 
732 	return (OFW_READ(ofw_obj, instance, addr, len));
733 }
734 
735 /* Write to an instance. */
736 ssize_t
OF_write(ihandle_t instance,const void * addr,size_t len)737 OF_write(ihandle_t instance, const void *addr, size_t len)
738 {
739 
740 	if (ofw_def_impl == NULL)
741 		return (-1);
742 
743 	return (OFW_WRITE(ofw_obj, instance, addr, len));
744 }
745 
746 /* Seek to a position. */
747 int
OF_seek(ihandle_t instance,uint64_t pos)748 OF_seek(ihandle_t instance, uint64_t pos)
749 {
750 
751 	if (ofw_def_impl == NULL)
752 		return (-1);
753 
754 	return (OFW_SEEK(ofw_obj, instance, pos));
755 }
756 
757 /*
758  * Memory functions
759  */
760 
761 /* Claim an area of memory. */
762 void *
OF_claim(void * virt,size_t size,u_int align)763 OF_claim(void *virt, size_t size, u_int align)
764 {
765 
766 	if (ofw_def_impl == NULL)
767 		return ((void *)-1);
768 
769 	return (OFW_CLAIM(ofw_obj, virt, size, align));
770 }
771 
772 /* Release an area of memory. */
773 void
OF_release(void * virt,size_t size)774 OF_release(void *virt, size_t size)
775 {
776 
777 	if (ofw_def_impl == NULL)
778 		return;
779 
780 	OFW_RELEASE(ofw_obj, virt, size);
781 }
782 
783 /*
784  * Control transfer functions
785  */
786 
787 /* Suspend and drop back to the Open Firmware interface. */
788 void
OF_enter()789 OF_enter()
790 {
791 
792 	if (ofw_def_impl == NULL)
793 		return;
794 
795 	OFW_ENTER(ofw_obj);
796 }
797 
798 /* Shut down and drop back to the Open Firmware interface. */
799 void
OF_exit()800 OF_exit()
801 {
802 
803 	if (ofw_def_impl == NULL)
804 		panic("OF_exit: Open Firmware not available");
805 
806 	/* Should not return */
807 	OFW_EXIT(ofw_obj);
808 
809 	for (;;)			/* just in case */
810 		;
811 }
812