1 /*        $NetBSD: autoconf.h,v 1.51 2022/05/22 11:27:34 andvar Exp $ */
2 
3 /*-
4  * Copyright (c) 1997, 1998 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  *
19  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
21  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
23  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29  * POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /*
33  * Copyright (c) 1992, 1993
34  *        The Regents of the University of California.  All rights reserved.
35  *
36  * This software was developed by the Computer Systems Engineering group
37  * at Lawrence Berkeley Laboratory under DARPA contract BG 91-66 and
38  * contributed to Berkeley.
39  *
40  * All advertising materials mentioning features or use of this software
41  * must display the following acknowledgement:
42  *        This product includes software developed by the University of
43  *        California, Lawrence Berkeley Laboratory.
44  *
45  * Redistribution and use in source and binary forms, with or without
46  * modification, are permitted provided that the following conditions
47  * are met:
48  * 1. Redistributions of source code must retain the above copyright
49  *    notice, this list of conditions and the following disclaimer.
50  * 2. Redistributions in binary form must reproduce the above copyright
51  *    notice, this list of conditions and the following disclaimer in the
52  *    documentation and/or other materials provided with the distribution.
53  * 3. Neither the name of the University nor the names of its contributors
54  *    may be used to endorse or promote products derived from this software
55  *    without specific prior written permission.
56  *
57  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
58  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
59  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
60  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
61  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
62  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
63  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
64  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
65  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
66  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
67  * SUCH DAMAGE.
68  *
69  *        @(#)autoconf.h      8.2 (Berkeley) 9/30/93
70  */
71 
72 #ifndef   _MACHINE_AUTOCONF_H_
73 #define   _MACHINE_AUTOCONF_H_
74 
75 /*
76  * Autoconfiguration information.
77  */
78 
79 #include <sys/bus.h>
80 #include <machine/bsd_openprom.h>
81 #include <machine/promlib.h>
82 #include <dev/sbus/sbusvar.h>
83 
84 /*
85  * Most devices are configured according to information kept in
86  * the FORTH PROMs.  In particular, we extract the `name', `reg',
87  * and `address' properties of each device attached to the mainbus;
88  * other drives may also use this information.  The mainbus itself
89  * (which `is' the CPU, in some sense) gets just the node, with a
90  * fake name ("mainbus").
91  */
92 
93 /* Device register space description */
94 struct rom_reg {
95           uint32_t  rr_iospace;         /* register space (obio, etc) */
96           uint32_t  rr_paddr; /* register physical address */
97           uint32_t  rr_len;             /* register length */
98 };
99 
100 /* Interrupt information */
101 struct rom_intr {
102           uint32_t  int_pri;  /* priority (IPL) */
103           uint32_t  int_vec;  /* vector (always 0?) */
104 };
105 
106 /* Address translation across busses */
107 struct rom_range {            /* Only used on v3 PROMs */
108           uint32_t  cspace;             /* Client space */
109           uint32_t  coffset;  /* Client offset */
110           uint32_t  pspace;             /* Parent space */
111           uint32_t  poffset;  /* Parent offset */
112           uint32_t  size;               /* Size in bytes of this range */
113 };
114 
115 /* Attach arguments presented by mainbus_attach() */
116 struct mainbus_attach_args {
117           bus_space_tag_t     ma_bustag;          /* parent bus tag */
118           bus_dma_tag_t       ma_dmatag;
119           const char          *ma_name; /* PROM node name */
120           int                 ma_node;  /* PROM handle */
121           bus_addr_t          ma_paddr; /* register physical address */
122           bus_size_t          ma_size;  /* register physical size */
123           int                 ma_pri;             /* priority (IPL) */
124           void                *ma_promvaddr;      /* PROM virtual address, if any */
125 };
126 
127 /* Attach arguments presented to devices by obio_attach() (sun4 only) */
128 struct obio4_attach_args {
129           int                 oba_placeholder;/* obio/sbus attach args sharing */
130           bus_space_tag_t     oba_bustag;         /* parent bus tag */
131           bus_dma_tag_t       oba_dmatag;
132           bus_addr_t          oba_paddr;          /* register physical address */
133           int                 oba_pri;  /* interrupt priority (IPL) */
134 };
135 
136 union obio_attach_args {
137           /* sun4m obio space is treated like an sbus slot */
138           int                                     uoba_isobio4;
139           struct sbus_attach_args                 uoba_sbus;          /* Sbus view */
140           struct obio4_attach_args      uoba_oba4;          /* sun4 on-board view */
141 };
142 
143 /* obio specific bus flag */
144 #define OBIO_BUS_MAP_USE_ROM  BUS_SPACE_MAP_BUS1
145 
146 /* obio bus helper that finds ROM mappings; exported for autoconf.c */
147 int       obio_find_rom_map(bus_addr_t, int, bus_space_handle_t *);
148 
149 
150 /*
151  * The matchbyname function is useful in drivers that are matched
152  * by romaux name, i.e., all `mainbus attached' devices.  It expects
153  * its aux pointer to point to a pointer to the name (the address of
154  * a romaux structure suffices, for instance). (OBSOLETE)
155  */
156 int       matchbyname(device_t, cfdata_t, void *);
157 
158 /*
159  * `clockfreq' produces a printable representation of a clock frequency
160  * (this is just a frill).
161  */
162 char      *clockfreq(int freq);
163 
164 /* Openprom V2 style boot path */
165 struct bootpath {
166           char      name[16]; /* name of this node */
167           int       val[3];             /* up to three optional values */
168           device_t dev;       /* device that recognised this component */
169 };
170 
171 /* Parse a disk string into a dev_t, return device struct pointer */
172 device_t parsedisk(char *, int, int, dev_t *);
173 
174 /* Establish a mountroot_hook, for benefit of floppy drive, mostly. */
175 void      mountroot_hook_establish(void (*)(device_t), device_t);
176 
177 void      bootstrap(void);
178 int       romgetcursoraddr(int **, int **);
179 
180 /* Exported from autoconf.c for other consumers.  */
181 extern char         machine_model[100];
182 extern struct sparc_bus_dma_tag mainbus_dma_tag;
183 extern struct sparc_bus_space_tag mainbus_space_tag;
184 
185 #endif /* !_MACHINE_AUTOCONF_H_ */
186