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$ 58 */ 59 60 #ifndef _OPENFIRM_H_ 61 #define _OPENFIRM_H_ 62 63 /* 64 * Prototypes for Open Firmware Interface Routines 65 */ 66 67 typedef unsigned long cell_t; 68 69 typedef unsigned int ihandle_t; 70 typedef unsigned int phandle_t; 71 72 #ifdef _KERNEL 73 #include <sys/cdefs.h> 74 #include <sys/types.h> 75 #include <sys/malloc.h> 76 77 #define p1275_ptr2cell(p) ((cell_t)((uintptr_t)((void *)(p)))) 78 #define p1275_int2cell(i) ((cell_t)((int)(i))) 79 #define p1275_uint2cell(u) ((cell_t)((unsigned int)(u))) 80 #define p1275_size2cell(u) ((cell_t)((size_t)(u))) 81 #define p1275_phandle2cell(ph) ((cell_t)((unsigned int)((phandle_t)(ph)))) 82 #define p1275_dnode2cell(d) ((cell_t)((unsigned int)((pnode_t)(d)))) 83 #define p1275_ihandle2cell(ih) ((cell_t)((unsigned int)((ihandle_t)(ih)))) 84 #define p1275_ull2cell_high(ll) (0LL) 85 #define p1275_ull2cell_low(ll) ((cell_t)(ll)) 86 #define p1275_uintptr2cell(i) ((cell_t)((uintptr_t)(i))) 87 88 #define p1275_cell2ptr(p) ((void *)((cell_t)(p))) 89 #define p1275_cell2int(i) ((int)((cell_t)(i))) 90 #define p1275_cell2uint(u) ((unsigned int)((cell_t)(u))) 91 #define p1275_cell2size(u) ((size_t)((cell_t)(u))) 92 #define p1275_cell2phandle(ph) ((phandle_t)((cell_t)(ph))) 93 #define p1275_cell2dnode(d) ((pnode_t)((cell_t)(d))) 94 #define p1275_cell2ihandle(ih) ((ihandle_t)((cell_t)(ih))) 95 #define p1275_cells2ull(h, l) ((unsigned long long)(cell_t)(l)) 96 #define p1275_cell2uintptr(i) ((uintptr_t)((cell_t)(i))) 97 98 MALLOC_DECLARE(M_OFWPROP); 99 100 /* 101 * Stuff that is used by the Open Firmware code. 102 */ 103 void set_openfirm_callback(int (*)(void *)); 104 int openfirmware(void *); 105 106 /* 107 * This isn't actually an Open Firmware function, but it seemed like the right 108 * place for it to go. 109 */ 110 void OF_init(int (*openfirm)(void *)); 111 112 /* Generic functions */ 113 int OF_test(char *); 114 void OF_helloworld(void); 115 void OF_printf(const char *, ...); 116 117 /* Device tree functions */ 118 phandle_t OF_peer(phandle_t); 119 phandle_t OF_child(phandle_t); 120 phandle_t OF_parent(phandle_t); 121 phandle_t OF_instance_to_package(ihandle_t); 122 int OF_getproplen(phandle_t, char *); 123 int OF_getprop(phandle_t, char *, void *, int); 124 int OF_getprop_alloc(phandle_t package, char *propname, int elsz, 125 void **buf); 126 int OF_nextprop(phandle_t, char *, char *); 127 int OF_setprop(phandle_t, char *, void *, int); 128 int OF_canon(const char *, char *, int); 129 phandle_t OF_finddevice(const char *); 130 int OF_instance_to_path(ihandle_t, char *, int); 131 int OF_package_to_path(phandle_t, char *, int); 132 int OF_call_method(char *, ihandle_t, int, int, ...); 133 134 /* Device I/O functions */ 135 ihandle_t OF_open(char *); 136 void OF_close(ihandle_t); 137 int OF_read(ihandle_t, void *, int); 138 int OF_write(ihandle_t, void *, int); 139 int OF_seek(ihandle_t, u_quad_t); 140 141 /* Memory functions */ 142 void *OF_claim(void *, u_int, u_int); 143 void OF_release(void *, u_int); 144 145 /* Control transfer functions */ 146 void OF_boot(char *); 147 void OF_enter(void); 148 void OF_exit(void) __attribute__((noreturn)); 149 void OF_chain(void *, u_int, 150 void (*)(void *, u_int, void *, void *, u_int), void *, u_int); 151 152 /* User interface functions */ 153 int OF_interpret(char *, int, ...); 154 #if 0 155 void *OF_set_callback(void *); 156 void OF_set_symbol_lookup(void *, void *); 157 #endif 158 159 /* Time function */ 160 int OF_milliseconds(void); 161 162 /* sun4v additions */ 163 void OF_set_mmfsa_traptable(void *tba_addr, uint64_t mmfsa_ra); 164 int OF_translate_virt(vm_offset_t va, int *valid, vm_paddr_t *physaddr, int *mode); 165 vm_paddr_t OF_vtophys(vm_offset_t va); 166 167 #endif /* _KERNEL */ 168 #endif /* _OPENFIRM_H_ */ 169