openfirm.h revision 194138
1249259Sdim/* $NetBSD: openfirm.h,v 1.1 1998/05/15 10:16:00 tsubai Exp $ */ 2249259Sdim 3249259Sdim/*- 4249259Sdim * Copyright (C) 1995, 1996 Wolfgang Solfrank. 5249259Sdim * Copyright (C) 1995, 1996 TooLs GmbH. 6249259Sdim * All rights reserved. 7249259Sdim * 8249259Sdim * Redistribution and use in source and binary forms, with or without 9249259Sdim * modification, are permitted provided that the following conditions 10249259Sdim * are met: 11249259Sdim * 1. Redistributions of source code must retain the above copyright 12249259Sdim * notice, this list of conditions and the following disclaimer. 13249259Sdim * 2. Redistributions in binary form must reproduce the above copyright 14249259Sdim * notice, this list of conditions and the following disclaimer in the 15249259Sdim * documentation and/or other materials provided with the distribution. 16249259Sdim * 3. All advertising materials mentioning features or use of this software 17249259Sdim * must display the following acknowledgement: 18249259Sdim * This product includes software developed by TooLs GmbH. 19249259Sdim * 4. The name of TooLs GmbH may not be used to endorse or promote products 20249259Sdim * derived from this software without specific prior written permission. 21249259Sdim * 22249259Sdim * THIS SOFTWARE IS PROVIDED BY TOOLS GMBH ``AS IS'' AND ANY EXPRESS OR 23249259Sdim * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 24249259Sdim * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 25249259Sdim * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 26249259Sdim * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 27249259Sdim * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 28249259Sdim * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 29249259Sdim * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 30249259Sdim * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 31249259Sdim * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 32249259Sdim */ 33249259Sdim/* 34249259Sdim * Copyright (C) 2000 Benno Rice. 35249259Sdim * All rights reserved. 36249259Sdim * 37249259Sdim * Redistribution and use in source and binary forms, with or without 38249259Sdim * modification, are permitted provided that the following conditions 39249259Sdim * are met: 40249259Sdim * 1. Redistributions of source code must retain the above copyright 41249259Sdim * notice, this list of conditions and the following disclaimer. 42249259Sdim * 2. Redistributions in binary form must reproduce the above copyright 43249259Sdim * notice, this list of conditions and the following disclaimer in the 44249259Sdim * documentation and/or other materials provided with the distribution. 45249259Sdim * 46249259Sdim * THIS SOFTWARE IS PROVIDED BY Benno Rice ``AS IS'' AND ANY EXPRESS OR 47249259Sdim * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 48249259Sdim * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 49249259Sdim * IN NO EVENT SHALL TOOLS GMBH BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 50249259Sdim * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 51249259Sdim * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; 52249259Sdim * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 53249259Sdim * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 54249259Sdim * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF 55249259Sdim * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 56249259Sdim * 57 * $FreeBSD: head/sys/dev/ofw/openfirm.h 194138 2009-06-14 00:05:38Z marius $ 58 */ 59 60#ifndef _DEV_OPENFIRM_H_ 61#define _DEV_OPENFIRM_H_ 62 63#include <sys/types.h> 64 65/* 66 * Prototypes for Open Firmware Interface Routines 67 */ 68 69typedef uint32_t ihandle_t; 70typedef uint32_t phandle_t; 71typedef uint32_t pcell_t; 72 73#ifdef _KERNEL 74#include <sys/malloc.h> 75 76#include <machine/ofw_machdep.h> 77 78MALLOC_DECLARE(M_OFWPROP); 79 80/* 81 * Open Firmware interface initialization. OF_install installs the named 82 * interface as the Open Firmware access mechanism, OF_init initializes it. 83 */ 84 85boolean_t OF_install(char *name, int prio); 86void OF_init(void *cookie); 87 88/* 89 * Known Open Firmware interface names 90 */ 91 92#define OFW_STD_DIRECT "ofw_std" /* Standard OF interface */ 93#define OFW_STD_REAL "ofw_real" /* Real-mode OF interface */ 94#define OFW_FDT "ofw_fdt" /* Flattened Device Tree */ 95 96/* Generic functions */ 97int OF_test(const char *name); 98void OF_printf(const char *fmt, ...); 99 100/* Device tree functions */ 101phandle_t OF_peer(phandle_t node); 102phandle_t OF_child(phandle_t node); 103phandle_t OF_parent(phandle_t node); 104ssize_t OF_getproplen(phandle_t node, const char *propname); 105ssize_t OF_getprop(phandle_t node, const char *propname, void *buf, 106 size_t len); 107ssize_t OF_searchprop(phandle_t node, const char *propname, void *buf, 108 size_t len); 109ssize_t OF_getprop_alloc(phandle_t node, const char *propname, 110 int elsz, void **buf); 111int OF_nextprop(phandle_t node, const char *propname, char *buf, 112 size_t len); 113int OF_setprop(phandle_t node, const char *name, const void *buf, 114 size_t len); 115ssize_t OF_canon(const char *path, char *buf, size_t len); 116phandle_t OF_finddevice(const char *path); 117ssize_t OF_package_to_path(phandle_t node, char *buf, size_t len); 118 119/* Device I/O functions */ 120ihandle_t OF_open(const char *path); 121void OF_close(ihandle_t instance); 122ssize_t OF_read(ihandle_t instance, void *buf, size_t len); 123ssize_t OF_write(ihandle_t instance, const void *buf, size_t len); 124int OF_seek(ihandle_t instance, uint64_t where); 125 126phandle_t OF_instance_to_package(ihandle_t instance); 127ssize_t OF_instance_to_path(ihandle_t instance, char *buf, size_t len); 128int OF_call_method(const char *method, ihandle_t instance, 129 int nargs, int nreturns, ...); 130 131/* Memory functions */ 132void *OF_claim(void *virtrequest, size_t size, u_int align); 133void OF_release(void *virt, size_t size); 134 135/* Control transfer functions */ 136void OF_enter(void); 137void OF_exit(void) __attribute__((noreturn)); 138 139/* User interface functions */ 140int OF_interpret(const char *cmd, int nreturns, ...); 141 142#endif /* _KERNEL */ 143#endif /* _DEV_OPENFIRM_H_ */ 144