promlib.h revision 1.9
1/* $NetBSD: promlib.h,v 1.9 2003/06/23 11:01:38 martin Exp $ */ 2 3/*- 4 * Copyright (c) 1999 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Paul Kranenburg. 9 * 10 * Redistribution and use in source and binary forms, with or without 11 * modification, are permitted provided that the following conditions 12 * are met: 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 2. Redistributions in binary form must reproduce the above copyright 16 * notice, this list of conditions and the following disclaimer in the 17 * documentation and/or other materials provided with the distribution. 18 * 3. All advertising materials mentioning features or use of this software 19 * must display the following acknowledgement: 20 * This product includes software developed by the NetBSD 21 * Foundation, Inc. and its contributors. 22 * 4. Neither the name of The NetBSD Foundation nor the names of its 23 * contributors may be used to endorse or promote products derived 24 * from this software without specific prior written permission. 25 * 26 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 27 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 28 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 29 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 30 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 31 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 32 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 33 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 34 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 35 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 36 * POSSIBILITY OF SUCH DAMAGE. 37 */ 38 39/* 40 * OPENPROM functions. These are here mainly to hide the OPENPROM interface 41 * from the rest of the kernel. 42 */ 43 44#ifndef _SPARC_PROMLIB_H_ 45#define _SPARC_PROMLIB_H_ 46 47#include "opt_multiprocessor.h" 48 49#include <machine/idprom.h> 50#include <machine/bsd_openprom.h> 51#include <machine/openfirm.h> 52 53/* 54 * A set of methods to access the firmware. 55 * We use this to support various versions of Open Boot Prom 56 * or Open Firmware implementations. 57 */ 58struct promops { 59 int po_version; /* PROM version number */ 60#define PROM_OLDMON 0 61#define PROM_OBP_V0 1 62#define PROM_OBP_V2 2 63#define PROM_OBP_V3 3 64#define PROM_OPENFIRM 4 65 int po_revision; /* revision level */ 66 int po_stdin; /* stdio handles */ 67 int po_stdout; /* */ 68 void *po_bootcookie; 69 70 /* Access to boot arguments */ 71 char *(*po_bootpath) __P((void)); 72 char *(*po_bootfile) __P((void)); 73 char *(*po_bootargs) __P((void)); 74 75 /* I/O functions */ 76 int (*po_getchar) __P((void)); 77 int (*po_peekchar) __P((void)); 78 void (*po_putchar) __P((int)); 79 void (*po_putstr) __P((char *, int)); 80 int (*po_open) __P((char *)); 81 void (*po_close) __P((int)); 82 int (*po_read) __P((int, void *, int)); 83 int (*po_write) __P((int, void *, int)); 84 int (*po_seek) __P((int, u_quad_t)); 85 86 int (*po_instance_to_package) __P((int)); 87 88 /* Misc functions (common in OBP 0,2,3) */ 89 void (*po_halt) __P((void)) __attribute__((__noreturn__)); 90 void (*po_reboot) __P((char *)) __attribute__((__noreturn__)); 91 void (*po_abort) __P((void)); 92 void (*po_interpret) __P((char *)); 93 void (*po_setcallback) __P((void (*)__P((void)))); 94 int (*po_ticks) __P((void)); 95 void *po_tickdata; 96 97 /* sun4/sun4c only */ 98 void (*po_setcontext) __P((int ctxt, caddr_t va, int pmeg)); 99 100 /* MP functions (OBP v3 only) */ 101 int (*po_cpustart) __P((int, struct openprom_addr *, int, caddr_t)); 102 int (*po_cpustop) __P((int)); 103 int (*po_cpuidle) __P((int)); 104 int (*po_cpuresume) __P((int)); 105 106 /* Device node traversal (OBP v0, v2, v3; but not sun4) */ 107 int (*po_firstchild) __P((int)); 108 int (*po_nextsibling) __P((int)); 109 110 /* Device node properties */ 111 int (*po_getproplen) __P((int node, char *name)); 112 int (*po_getprop) __P((int node, char *name, void *, int)); 113 int (*po_setprop) __P((int node, char *name, const void *, int)); 114 char *(*po_nextprop) __P((int node, char *name)); 115 116 int (*po_finddevice) __P((char *name)); 117 118}; 119 120extern struct promops promops; 121 122/* 123 * Memory description array. 124 * Same as version 2 rom meminfo property. 125 */ 126struct memarr { 127 int zero; 128 u_int addr; 129 u_int len; 130}; 131int prom_makememarr(struct memarr *, int max, int which); 132#define MEMARR_AVAILPHYS 0 133#define MEMARR_TOTALPHYS 1 134 135struct idprom *prom_getidprom(void); 136void prom_getether(u_char *); 137 138void prom_init __P((void)); /* To setup promops */ 139 140/* Utility routines */ 141int prom_prop __P((int, char *, int, int *, void **)); 142int PROM_getprop __P((int, char *, int, int *, void **)); 143int PROM_getpropint __P((int node, char *name, int deflt)); 144char *PROM_getpropstring __P((int node, char *name)); 145char *PROM_getpropstringA __P((int node, char *name, char *, size_t)); 146void prom_printf __P((const char *, ...)); 147 148int prom_findroot __P((void)); 149int prom_findnode __P((int, const char *)); 150int prom_search __P((int, const char *)); 151int prom_opennode __P((char *)); 152int prom_node_has_property __P((int, const char *)); 153 154#define findroot() prom_findroot() 155#define findnode(node,name) prom_findnode(node,name) 156#define search_prom(node,name) prom_search(node,name) 157#define opennode(name) prom_opennode(name) 158#define node_has_property(node,prop) prom_node_has_property(node,prop) 159 160void prom_halt __P((void)) __attribute__((__noreturn__)); 161void prom_boot __P((char *)) __attribute__((__noreturn__)); 162 163#if defined(MULTIPROCESSOR) 164#define callrom() do { \ 165 mp_pause_cpus(); \ 166 prom_abort(); \ 167 mp_resume_cpus(); \ 168} while (0) 169#else 170#define callrom() prom_abort() 171#endif 172 173#define prom_version() (promops.po_version) 174#define prom_revision() (promops.po_revision) 175#define prom_stdin() (promops.po_stdin) 176#define prom_stdout() (promops.po_stdout) 177#define _prom_halt() ((*promops.po_halt)(/*void*/)) 178#define _prom_boot(a) ((*promops.po_reboot)(a)) 179#define prom_abort() ((*promops.po_abort)(/*void*/)) 180#define prom_interpret(a) ((*promops.po_interpret)(a)) 181#define prom_setcallback(f) ((*promops.po_setcallback)(f)) 182#define prom_setcontext(c,a,p) ((*promops.po_setcontext)(c,a,p)) 183#define prom_getbootpath() ((*promops.po_bootpath)(/*void*/)) 184#define prom_getbootfile() ((*promops.po_bootfile)(/*void*/)) 185#define prom_getbootargs() ((*promops.po_bootargs)(/*void*/)) 186#define prom_ticks() ((*promops.po_ticks)(/*void*/)) 187 188 189#define prom_open(name) ((*promops.po_open)(name)) 190#define prom_close(fd) ((*promops.po_close)(fd)) 191#define prom_instance_to_package(fd) \ 192 ((*promops.po_instance_to_package)(fd)) 193#define prom_read(fd,b,n) ((*promops.po_read)(fd,b,n)) 194#define prom_write(fd,b,n) ((*promops.po_write)(fd,b,n)) 195#define prom_seek(fd,o) ((*promops.po_seek)(fd,o)) 196#define prom_getchar() ((*promops.po_getchar)(/*void*/)) 197#define prom_peekchar() ((*promops.po_peekchar)(/*void*/)) 198#define prom_putchar(c) ((*promops.po_putchar)(c)) 199#define prom_putstr(b,n) ((*promops.po_putstr)(b,n)) 200 201/* Node traversal */ 202#define prom_firstchild(node) ((*promops.po_firstchild)(node)) 203#define prom_nextsibling(node) ((*promops.po_nextsibling)(node)) 204#define prom_proplen(node,name) ((*promops.po_getproplen)(node, name)) 205#define _prom_getprop(node, name, buf, len) \ 206 ((*promops.po_getprop)(node, name, buf, len)) 207#define prom_setprop(node, name, value, len) \ 208 ((*promops.po_setprop)(node, name, value, len)) 209#define prom_nextprop(node,name) ((*promops.po_nextprop)(node, name)) 210#define prom_finddevice(name) ((*promops.po_finddevice)(name)) 211 212#define firstchild(node) prom_firstchild(node) 213#define nextsibling(node) prom_nextsibling(node) 214#define PROM_getproplen(node,name) prom_proplen(node, name) 215 216 217/* MP stuff - not currently used */ 218#define prom_cpustart(m,a,c,pc) ((*promops.po_cpustart)(m,a,c,pc)) 219#define prom_cpustop(m) ((*promops.po_cpustop)(m)) 220#define prom_cpuidle(m) ((*promops.po_cpuidle)(m)) 221#define prom_cpuresume(m) ((*promops.po_cpuresume)(m)) 222 223extern void *romp; /* PROM-supplied argument (see locore) */ 224 225#endif /* _SPARC_PROMLIB_H_ */ 226