xref: /netbsd-src/sys/arch/sparc/include/autoconf.h (revision ae1bfcddc410612bc8c58b807e1830becb69a24c)
1 /*
2  * Copyright (c) 1992, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This software was developed by the Computer Systems Engineering group
6  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
7  * contributed to Berkeley.
8  *
9  * All advertising materials mentioning features or use of this software
10  * must display the following acknowledgement:
11  *	This product includes software developed by the University of
12  *	California, Lawrence Berkeley Laboratory.
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions
16  * are met:
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice, this list of conditions and the following disclaimer.
19  * 2. Redistributions in binary form must reproduce the above copyright
20  *    notice, this list of conditions and the following disclaimer in the
21  *    documentation and/or other materials provided with the distribution.
22  * 3. All advertising materials mentioning features or use of this software
23  *    must display the following acknowledgement:
24  *	This product includes software developed by the University of
25  *	California, Berkeley and its contributors.
26  * 4. Neither the name of the University nor the names of its contributors
27  *    may be used to endorse or promote products derived from this software
28  *    without specific prior written permission.
29  *
30  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
31  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
32  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
33  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
34  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
35  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
36  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
37  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
38  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
39  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
40  * SUCH DAMAGE.
41  *
42  *	@(#)autoconf.h	8.2 (Berkeley) 9/30/93
43  *
44  * from: Header: autoconf.h,v 1.11 93/09/28 05:26:41 leres Exp (LBL)
45  * $Id: autoconf.h,v 1.3 1994/05/19 08:23:00 deraadt Exp $
46  */
47 
48 /*
49  * Autoconfiguration information.
50  */
51 
52 /*
53  * Most devices are configured according to information kept in
54  * the FORTH PROMs.  In particular, we extract the `name', `reg',
55  * and `address' properties of each device attached to the mainbus;
56  * other drives may also use this information.  The mainbus itself
57  * (which `is' the CPU, in some sense) gets just the node, with a
58  * fake name ("mainbus").
59  */
60 #define	RA_MAXINTR	8		/* max interrupts per device */
61 struct romaux {
62 	const char *ra_name;		/* name from FORTH PROM */
63 	int	ra_node;		/* FORTH PROM node ID */
64 	int	ra_iospace;		/* register space (obio, etc) */
65 	void	*ra_paddr;		/* register physical address */
66 	int	ra_len;			/* register length */
67 	void	*ra_vaddr;		/* ROM mapped virtual address, or 0 */
68 	struct rom_intr {		/* interrupt information: */
69 		int	int_pri;		/* priority (IPL) */
70 		int	int_vec;		/* vector (always 0?) */
71 	} ra_intr[RA_MAXINTR];
72 	int	ra_nintr;		/* number of interrupt info elements */
73 	struct	bootpath *ra_bp;	/* used for locating boot device */
74 };
75 
76 /*
77  * The various getprop* functions obtain `properties' from the ROMs.
78  * getprop() obtains a property as a byte-sequence, and returns its
79  * length; the others convert or make some other guarantee.
80  */
81 int	getprop __P((int node, char *name, void *buf, int bufsiz));
82 char	*getpropstring __P((int node, char *name));
83 int	getpropint __P((int node, char *name, int deflt));
84 
85 /* Frequently used options node */
86 extern int optionsnode;
87 
88 /*
89  * The romprop function gets physical and virtual addresses from the PROM
90  * and fills in a romaux.  It returns 1 on success, 0 if the physical
91  * address is not available as a "reg" property.
92  */
93 int	romprop __P((struct romaux *ra, const char *name, int node));
94 
95 /*
96  * The matchbyname function is useful in drivers that are matched
97  * by romaux name, i.e., all `mainbus attached' devices.  It expects
98  * its aux pointer to point to a pointer to the name (the address of
99  * a romaux structure suffices, for instance).
100  */
101 int	matchbyname __P((struct device *, struct cfdata *cf, void *aux));
102 
103 /*
104  * `clockfreq' produces a printable representation of a clock frequency
105  * (this is just a frill).
106  */
107 char	*clockfreq __P((int freq));
108 
109 /*
110  * mapiodev maps an I/O device to a virtual address, returning the address.
111  * mapdev does the real work: you can supply a special virtual address and
112  * it will use that instead of creating one, but you must only do this if
113  * you get it from ../sparc/vaddrs.h.
114  */
115 void	*mapdev __P((void *pa, int va, int size));
116 #define	mapiodev(pa, size)	mapdev(pa, 0, size)
117 
118 /*
119  * Memory description arrays.  Shared between pmap.c and autoconf.c; no
120  * one else should use this (except maybe mem.c, e.g., if we fix the VM to
121  * handle discontiguous physical memory).
122  */
123 struct memarr {
124 	u_int	addr;
125 	u_int	len;
126 };
127 int	makememarr(struct memarr *, int max, int which);
128 #define	MEMARR_AVAILPHYS	0
129 #define	MEMARR_TOTALPHYS	1
130 
131 /* Pass a string to the FORTH interpreter.  May fail silently. */
132 void	rominterpret __P((char *));
133 
134 /* Openprom V2 style boot path */
135 struct bootpath {
136 	char	name[8];		/* name of this node */
137 	int	val[2];			/* up to two optional values */
138 };
139 
140 struct device *bootdv;			/* found during autoconfiguration */
141 
142 /* Parse a disk string into a dev_t, return device struct pointer */
143 struct	device *parsedisk __P((char *, int, int, dev_t *));
144