promlib.h revision 1.7
1/* $NetBSD: promlib.h,v 1.7 2003/02/26 14:25:20 pk 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 <machine/bsd_openprom.h> 48 49/* 50 * A set of methods to access the firmware. 51 * We use this to support various versions of Open Boot Prom 52 * or Open Firmware implementations. 53 */ 54struct promops { 55 int po_version; /* PROM version number */ 56#define PROM_OLDMON 0 57#define PROM_OBP_V0 1 58#define PROM_OBP_V2 2 59#define PROM_OBP_V3 3 60#define PROM_OPENFIRM 4 61 int po_revision; /* revision level */ 62 int po_stdin; /* stdio handles */ 63 int po_stdout; /* */ 64 void *po_bootcookie; 65 66 /* Access to boot arguments */ 67 char *(*po_bootpath) __P((void)); 68 char *(*po_bootfile) __P((void)); 69 char *(*po_bootargs) __P((void)); 70 71 /* I/O functions */ 72 int (*po_getchar) __P((void)); 73 int (*po_peekchar) __P((void)); 74 void (*po_putchar) __P((int)); 75 void (*po_putstr) __P((char *, int)); 76 int (*po_open) __P((char *)); 77 void (*po_close) __P((int)); 78 int (*po_read) __P((int, void *, int)); 79 int (*po_write) __P((int, void *, int)); 80 int (*po_seek) __P((int, u_quad_t)); 81 82 int (*po_instance_to_package) __P((int)); 83 84 /* Misc functions (common in OBP 0,2,3) */ 85 void (*po_halt) __P((void)) __attribute__((__noreturn__)); 86 void (*po_reboot) __P((char *)) __attribute__((__noreturn__)); 87 void (*po_abort) __P((void)); 88 void (*po_interpret) __P((char *)); 89 void (*po_setcallback) __P((void (*)__P((void)))); 90 int (*po_ticks) __P((void)); 91 void *po_tickdata; 92 93 /* sun4/sun4c only */ 94 void (*po_setcontext) __P((int ctxt, caddr_t va, int pmeg)); 95 96 /* MP functions (OBP v3 only) */ 97 int (*po_cpustart) __P((int, struct openprom_addr *, int, caddr_t)); 98 int (*po_cpustop) __P((int)); 99 int (*po_cpuidle) __P((int)); 100 int (*po_cpuresume) __P((int)); 101 102 /* Device node traversal (OBP v0, v2, v3; but not sun4) */ 103 int (*po_firstchild) __P((int)); 104 int (*po_nextsibling) __P((int)); 105 106 /* Device node properties */ 107 int (*po_getproplen) __P((int node, char *name)); 108 int (*po_getprop) __P((int node, char *name, void *, int)); 109 int (*po_setprop) __P((int node, char *name, const void *, int)); 110 char *(*po_nextprop) __P((int node, char *name)); 111 112 int (*po_finddevice) __P((char *name)); 113 114}; 115 116extern struct promops promops; 117 118/* 119 * Memory description array. 120 * Same as version 2 rom meminfo property. 121 */ 122struct memarr { 123 int zero; 124 u_int addr; 125 u_int len; 126}; 127int prom_makememarr(struct memarr *, int max, int which); 128#define MEMARR_AVAILPHYS 0 129#define MEMARR_TOTALPHYS 1 130 131 132void prom_init __P((void)); /* To setup promops */ 133 134/* Utility routines */ 135int prom_prop __P((int, char *, int, int *, void **)); 136int PROM_getprop __P((int, char *, int, int *, void **)); 137int PROM_getpropint __P((int node, char *name, int deflt)); 138char *PROM_getpropstring __P((int node, char *name)); 139char *PROM_getpropstringA __P((int node, char *name, char *, size_t)); 140void prom_printf __P((const char *, ...)); 141 142int prom_findroot __P((void)); 143int prom_findnode __P((int, const char *)); 144int prom_search __P((int, const char *)); 145int prom_opennode __P((char *)); 146int prom_node_has_property __P((int, const char *)); 147 148#define findroot() prom_findroot() 149#define findnode(node,name) prom_findnode(node,name) 150#define search_prom(node,name) prom_search(node,name) 151#define opennode(name) prom_opennode(name) 152#define node_has_property(node,prop) prom_node_has_property(node,prop) 153 154void prom_halt __P((void)) __attribute__((__noreturn__)); 155void prom_boot __P((char *)) __attribute__((__noreturn__)); 156 157#if defined(MULTIPROCESSOR) 158#define callrom() do { \ 159 mp_pause_cpus(); \ 160 prom_abort(); \ 161 mp_resume_cpus(); \ 162} while (0) 163#else 164#define callrom() prom_abort() 165#endif 166 167#define prom_version() (promops.po_version) 168#define prom_revision() (promops.po_revision) 169#define prom_stdin() (promops.po_stdin) 170#define prom_stdout() (promops.po_stdout) 171#define _prom_halt() ((*promops.po_halt)(/*void*/)) 172#define _prom_boot(a) ((*promops.po_reboot)(a)) 173#define prom_abort() ((*promops.po_abort)(/*void*/)) 174#define prom_interpret(a) ((*promops.po_interpret)(a)) 175#define prom_setcallback(f) ((*promops.po_setcallback)(f)) 176#define prom_setcontext(c,a,p) ((*promops.po_setcontext)(c,a,p)) 177#define prom_getbootpath() ((*promops.po_bootpath)(/*void*/)) 178#define prom_getbootfile() ((*promops.po_bootfile)(/*void*/)) 179#define prom_getbootargs() ((*promops.po_bootargs)(/*void*/)) 180#define prom_ticks() ((*promops.po_ticks)(/*void*/)) 181 182 183#define prom_open(name) ((*promops.po_open)(name)) 184#define prom_close(fd) ((*promops.po_close)(fd)) 185#define prom_instance_to_package(fd) \ 186 ((*promops.po_instance_to_package)(fd)) 187#define prom_read(fd,b,n) ((*promops.po_read)(fd,b,n)) 188#define prom_write(fd,b,n) ((*promops.po_write)(fd,b,n)) 189#define prom_seek(fd,o) ((*promops.po_seek)(fd,o)) 190#define prom_getchar() ((*promops.po_getchar)(/*void*/)) 191#define prom_peekchar() ((*promops.po_peekchar)(/*void*/)) 192#define prom_putchar(c) ((*promops.po_putchar)(c)) 193#define prom_putstr(b,n) ((*promops.po_putstr)(b,n)) 194 195/* Node traversal */ 196#define prom_firstchild(node) ((*promops.po_firstchild)(node)) 197#define prom_nextsibling(node) ((*promops.po_nextsibling)(node)) 198#define prom_proplen(node,name) ((*promops.po_getproplen)(node, name)) 199#define _prom_getprop(node, name, buf, len) \ 200 ((*promops.po_getprop)(node, name, buf, len)) 201#define prom_setprop(node, name, value, len) \ 202 ((*promops.po_setprop)(node, name, value, len)) 203#define prom_nextprop(node,name) ((*promops.po_nextprop)(node, name)) 204#define prom_finddevice(name) ((*promops.po_finddevice)(name)) 205 206#define firstchild(node) prom_firstchild(node) 207#define nextsibling(node) prom_nextsibling(node) 208#define PROM_getproplen(node,name) prom_proplen(node, name) 209 210 211/* MP stuff - not currently used */ 212#define prom_cpustart(m,a,c,pc) ((*promops.po_cpustart)(m,a,c,pc)) 213#define prom_cpustop(m) ((*promops.po_cpustop)(m)) 214#define prom_cpuidle(m) ((*promops.po_cpuidle)(m)) 215#define prom_cpuresume(m) ((*promops.po_cpuresume)(m)) 216 217extern void *romp; /* PROM-supplied argument (see locore) */ 218 219#endif /* _SPARC_PROMLIB_H_ */ 220