openfirm.h revision 186133
1/* $NetBSD: openfirm.h,v 1.1 1998/05/15 10:16:00 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 * $FreeBSD: head/sys/dev/ofw/openfirm.h 186133 2008-12-15 18:20:59Z nwhitehorn $ 58 */ 59 60#ifndef _OPENFIRM_H_ 61#define _OPENFIRM_H_ 62 63/* 64 * Prototypes for Open Firmware Interface Routines 65 */ 66 67typedef unsigned long cell_t; 68 69typedef unsigned int ihandle_t; 70typedef unsigned int phandle_t; 71 72#ifdef _KERNEL 73#include <sys/cdefs.h> 74#include <sys/types.h> 75#include <sys/malloc.h> 76 77MALLOC_DECLARE(M_OFWPROP); 78 79/* 80 * Other than in Open Firmware calls, the size of a bus cell seems to be 81 * always the same. 82 */ 83typedef u_int32_t pcell_t; 84 85/* 86 * Stuff that is used by the Open Firmware code. 87 */ 88void set_openfirm_callback(int (*)(void *)); 89int openfirmware(void *); 90 91/* 92 * This isn't actually an Open Firmware function, but it seemed like the right 93 * place for it to go. 94 */ 95void OF_init(int (*openfirm)(void *)); 96 97/* Generic functions */ 98int OF_test(char *); 99void OF_printf(const char *, ...); 100 101/* Device tree functions */ 102phandle_t OF_peer(phandle_t); 103phandle_t OF_child(phandle_t); 104phandle_t OF_parent(phandle_t); 105phandle_t OF_instance_to_package(ihandle_t); 106int OF_getproplen(phandle_t, char *); 107int OF_getprop(phandle_t, char *, void *, int); 108int OF_getprop_alloc(phandle_t package, char *propname, int elsz, 109 void **buf); 110int OF_nextprop(phandle_t, char *, char *); 111int OF_setprop(phandle_t, char *, void *, int); 112int OF_canon(const char *, char *, int); 113phandle_t OF_finddevice(const char *); 114int OF_instance_to_path(ihandle_t, char *, int); 115int OF_package_to_path(phandle_t, char *, int); 116int OF_call_method(char *, ihandle_t, int, int, ...); 117 118/* Device I/O functions */ 119ihandle_t OF_open(char *); 120void OF_close(ihandle_t); 121int OF_read(ihandle_t, void *, int); 122int OF_write(ihandle_t, void *, int); 123int OF_seek(ihandle_t, u_quad_t); 124 125/* Memory functions */ 126void *OF_claim(void *, u_int, u_int); 127void OF_release(void *, u_int); 128 129/* Control transfer functions */ 130void OF_boot(char *); 131void OF_enter(void); 132void OF_exit(void) __attribute__((noreturn)); 133void OF_chain(void *, u_int, 134 void (*)(void *, u_int, void *, void *, u_int), void *, u_int); 135 136/* User interface functions */ 137int OF_interpret(char *, int, ...); 138 139/* Time function */ 140int OF_milliseconds(void); 141 142#endif /* _KERNEL */ 143#endif /* _OPENFIRM_H_ */ 144