1/*-
2 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
| 1/*-
2 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
13 *
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24 * SUCH DAMAGE.
25 *
|
26 * $Id: bootstrap.h,v 1.19 1999/01/22 23:50:13 msmith Exp $
| 26 * $Id: bootstrap.h,v 1.20 1999/02/04 17:06:45 dcs Exp $
|
27 */
28
29#include <sys/types.h>
30#include <sys/queue.h>
31
32/* XXX debugging */
33extern struct console vidconsole;
34#define MARK(s, c) {vidconsole.c_out(s); vidconsole.c_out(c); while (!vidconsole.c_ready()) ; vidconsole.c_in();}
35
36/*
37 * Generic device specifier; architecture-dependant
38 * versions may be larger, but should be allowed to
39 * overlap.
40 */
41struct devdesc
42{
43 struct devsw *d_dev;
44 int d_type;
45#define DEVT_NONE 0
46#define DEVT_DISK 1
47#define DEVT_NET 2
48};
49
50/* Commands and return values; nonzero return sets command_errmsg != NULL */
51typedef int (bootblk_cmd_t)(int argc, char *argv[]);
52extern char *command_errmsg;
53extern char command_errbuf[]; /* XXX blah, length */
54#define CMD_OK 0
55#define CMD_ERROR 1
56
57/* interp.c */
58extern void interact(void);
59extern int include(char *filename);
60
61/* interp_parse.c */
62extern int parse(int *argc, char ***argv, char *str);
63
64/* interp_forth.c */
65extern void bf_init(void);
66extern int bf_run(char *line);
67
68/* boot.c */
69extern int autoboot(int delay, char *prompt);
70extern void autoboot_maybe(void);
71
72/* misc.c */
73extern char *unargv(int argc, char *argv[]);
74extern void hexdump(caddr_t region, size_t len);
75extern size_t strlenout(vm_offset_t str);
76extern char *strdupout(vm_offset_t str);
77
78/* bcache.c */
79extern int bcache_init(int nblks, size_t bsize);
80
81/*
82 * Disk block cache
83 */
84struct bcache_devdata
85{
86 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, void *buf, size_t *rsize);
87 void *dv_devdata;
88};
89
90/*
91 * Modular console support.
92 */
93struct console
94{
95 char *c_name;
96 char *c_desc;
97 int c_flags;
98#define C_PRESENTIN (1<<0)
99#define C_PRESENTOUT (1<<1)
100#define C_ACTIVEIN (1<<2)
101#define C_ACTIVEOUT (1<<3)
102 void (* c_probe)(struct console *cp); /* set c_flags to match hardware */
103 int (* c_init)(int arg); /* reinit XXX may need more args */
104 void (* c_out)(int c); /* emit c */
105 int (* c_in)(void); /* wait for and return input */
106 int (* c_ready)(void); /* return nonzer if input waiting */
107};
108extern struct console *consoles[];
109extern void cons_probe(void);
110
111/*
112 * Plug-and-play enumerator/configurator interface.
113 */
114struct pnphandler
115{
116 char *pp_name; /* handler/bus name */
117 void (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
118};
119
120struct pnpident
121{
122 char *id_ident; /* ASCII identifier, actual format varies with bus/handler */
123 STAILQ_ENTRY(pnpident) id_link;
124};
125
126struct pnpinfo
127{
128 char *pi_desc; /* ASCII description, optional */
129 int pi_revision; /* optional revision (or -1) if not supported */
130 char *pi_module; /* module/args nominated to handle device */
131 int pi_argc; /* module arguments */
132 char **pi_argv;
133 struct pnphandler *pi_handler; /* handler which detected this device */
134 STAILQ_HEAD(,pnpident) pi_ident; /* list of identifiers */
135 STAILQ_ENTRY(pnpinfo) pi_link;
136};
137
138extern struct pnphandler *pnphandlers[]; /* provided by MD code */
139
140extern void pnp_addident(struct pnpinfo *pi, char *ident);
141extern struct pnpinfo *pnp_allocinfo(void);
142extern void pnp_freeinfo(struct pnpinfo *pi);
143extern void pnp_addinfo(struct pnpinfo *pi);
144extern char *pnp_eisaformat(u_int8_t *data);
145
146/*
147 * < 0 - No ISA in system
148 * == 0 - Maybe ISA, search for read data port
149 * > 0 - ISA in system, value is read data port address
150 */
151extern int isapnp_readport;
152
153/*
154 * Module metadata header.
155 *
156 * Metadata are allocated on our heap, and copied into kernel space
157 * before executing the kernel.
158 */
159struct module_metadata
160{
161 size_t md_size;
162 u_int16_t md_type;
163 struct module_metadata *md_next;
164 char md_data[0]; /* data are immediately appended */
165};
166
167/*
168 * Loaded module information.
169 *
170 * At least one module (the kernel) must be loaded in order to boot.
171 * The kernel is always loaded first.
172 *
173 * String fields (m_name, m_type) should be dynamically allocated.
174 */
175struct loaded_module
176{
177 char *m_name; /* module name */
178 char *m_type; /* verbose module type, eg 'ELF kernel', 'pnptable', etc. */
179 char *m_args; /* arguments for the module */
180 struct module_metadata *m_metadata; /* metadata that will be placed in the module directory */
181 int m_loader; /* index of the loader that read the file */
182 vm_offset_t m_addr; /* load address */
183 size_t m_size; /* module size */
184 struct loaded_module *m_next; /* next module */
185};
186
187struct module_format
188{
189 /* Load function must return EFTYPE if it can't handle the module supplied */
190 int (* l_load)(char *filename, vm_offset_t dest, struct loaded_module **result);
191 /* Only a loader that will load a kernel (first module) should have an exec handler */
192 int (* l_exec)(struct loaded_module *mp);
193};
194extern struct module_format *module_formats[]; /* supplied by consumer */
195extern struct loaded_module *loaded_modules;
196extern int mod_load(char *name, int argc, char *argv[]);
197extern int mod_loadobj(char *type, char *name);
198extern struct loaded_module *mod_findmodule(char *name, char *type);
199extern void mod_addmetadata(struct loaded_module *mp, int type, size_t size, void *p);
200extern struct module_metadata *mod_findmetadata(struct loaded_module *mp, int type);
201extern void mod_discard(struct loaded_module *mp);
202extern struct loaded_module *mod_allocmodule(void);
203
204
205/* MI module loaders */
206extern int aout_loadmodule(char *filename, vm_offset_t dest, struct loaded_module **result);
207extern vm_offset_t aout_findsym(char *name, struct loaded_module *mp);
208
209extern int elf_loadmodule(char *filename, vm_offset_t dest, struct loaded_module **result);
210
211#ifndef NEW_LINKER_SET
212#include <sys/linker_set.h>
213
214/* XXX just for conversion's sake, until we move to the new linker set code */
215
216#define SET_FOREACH(pvar, set) \
| 27 */
28
29#include <sys/types.h>
30#include <sys/queue.h>
31
32/* XXX debugging */
33extern struct console vidconsole;
34#define MARK(s, c) {vidconsole.c_out(s); vidconsole.c_out(c); while (!vidconsole.c_ready()) ; vidconsole.c_in();}
35
36/*
37 * Generic device specifier; architecture-dependant
38 * versions may be larger, but should be allowed to
39 * overlap.
40 */
41struct devdesc
42{
43 struct devsw *d_dev;
44 int d_type;
45#define DEVT_NONE 0
46#define DEVT_DISK 1
47#define DEVT_NET 2
48};
49
50/* Commands and return values; nonzero return sets command_errmsg != NULL */
51typedef int (bootblk_cmd_t)(int argc, char *argv[]);
52extern char *command_errmsg;
53extern char command_errbuf[]; /* XXX blah, length */
54#define CMD_OK 0
55#define CMD_ERROR 1
56
57/* interp.c */
58extern void interact(void);
59extern int include(char *filename);
60
61/* interp_parse.c */
62extern int parse(int *argc, char ***argv, char *str);
63
64/* interp_forth.c */
65extern void bf_init(void);
66extern int bf_run(char *line);
67
68/* boot.c */
69extern int autoboot(int delay, char *prompt);
70extern void autoboot_maybe(void);
71
72/* misc.c */
73extern char *unargv(int argc, char *argv[]);
74extern void hexdump(caddr_t region, size_t len);
75extern size_t strlenout(vm_offset_t str);
76extern char *strdupout(vm_offset_t str);
77
78/* bcache.c */
79extern int bcache_init(int nblks, size_t bsize);
80
81/*
82 * Disk block cache
83 */
84struct bcache_devdata
85{
86 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, void *buf, size_t *rsize);
87 void *dv_devdata;
88};
89
90/*
91 * Modular console support.
92 */
93struct console
94{
95 char *c_name;
96 char *c_desc;
97 int c_flags;
98#define C_PRESENTIN (1<<0)
99#define C_PRESENTOUT (1<<1)
100#define C_ACTIVEIN (1<<2)
101#define C_ACTIVEOUT (1<<3)
102 void (* c_probe)(struct console *cp); /* set c_flags to match hardware */
103 int (* c_init)(int arg); /* reinit XXX may need more args */
104 void (* c_out)(int c); /* emit c */
105 int (* c_in)(void); /* wait for and return input */
106 int (* c_ready)(void); /* return nonzer if input waiting */
107};
108extern struct console *consoles[];
109extern void cons_probe(void);
110
111/*
112 * Plug-and-play enumerator/configurator interface.
113 */
114struct pnphandler
115{
116 char *pp_name; /* handler/bus name */
117 void (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
118};
119
120struct pnpident
121{
122 char *id_ident; /* ASCII identifier, actual format varies with bus/handler */
123 STAILQ_ENTRY(pnpident) id_link;
124};
125
126struct pnpinfo
127{
128 char *pi_desc; /* ASCII description, optional */
129 int pi_revision; /* optional revision (or -1) if not supported */
130 char *pi_module; /* module/args nominated to handle device */
131 int pi_argc; /* module arguments */
132 char **pi_argv;
133 struct pnphandler *pi_handler; /* handler which detected this device */
134 STAILQ_HEAD(,pnpident) pi_ident; /* list of identifiers */
135 STAILQ_ENTRY(pnpinfo) pi_link;
136};
137
138extern struct pnphandler *pnphandlers[]; /* provided by MD code */
139
140extern void pnp_addident(struct pnpinfo *pi, char *ident);
141extern struct pnpinfo *pnp_allocinfo(void);
142extern void pnp_freeinfo(struct pnpinfo *pi);
143extern void pnp_addinfo(struct pnpinfo *pi);
144extern char *pnp_eisaformat(u_int8_t *data);
145
146/*
147 * < 0 - No ISA in system
148 * == 0 - Maybe ISA, search for read data port
149 * > 0 - ISA in system, value is read data port address
150 */
151extern int isapnp_readport;
152
153/*
154 * Module metadata header.
155 *
156 * Metadata are allocated on our heap, and copied into kernel space
157 * before executing the kernel.
158 */
159struct module_metadata
160{
161 size_t md_size;
162 u_int16_t md_type;
163 struct module_metadata *md_next;
164 char md_data[0]; /* data are immediately appended */
165};
166
167/*
168 * Loaded module information.
169 *
170 * At least one module (the kernel) must be loaded in order to boot.
171 * The kernel is always loaded first.
172 *
173 * String fields (m_name, m_type) should be dynamically allocated.
174 */
175struct loaded_module
176{
177 char *m_name; /* module name */
178 char *m_type; /* verbose module type, eg 'ELF kernel', 'pnptable', etc. */
179 char *m_args; /* arguments for the module */
180 struct module_metadata *m_metadata; /* metadata that will be placed in the module directory */
181 int m_loader; /* index of the loader that read the file */
182 vm_offset_t m_addr; /* load address */
183 size_t m_size; /* module size */
184 struct loaded_module *m_next; /* next module */
185};
186
187struct module_format
188{
189 /* Load function must return EFTYPE if it can't handle the module supplied */
190 int (* l_load)(char *filename, vm_offset_t dest, struct loaded_module **result);
191 /* Only a loader that will load a kernel (first module) should have an exec handler */
192 int (* l_exec)(struct loaded_module *mp);
193};
194extern struct module_format *module_formats[]; /* supplied by consumer */
195extern struct loaded_module *loaded_modules;
196extern int mod_load(char *name, int argc, char *argv[]);
197extern int mod_loadobj(char *type, char *name);
198extern struct loaded_module *mod_findmodule(char *name, char *type);
199extern void mod_addmetadata(struct loaded_module *mp, int type, size_t size, void *p);
200extern struct module_metadata *mod_findmetadata(struct loaded_module *mp, int type);
201extern void mod_discard(struct loaded_module *mp);
202extern struct loaded_module *mod_allocmodule(void);
203
204
205/* MI module loaders */
206extern int aout_loadmodule(char *filename, vm_offset_t dest, struct loaded_module **result);
207extern vm_offset_t aout_findsym(char *name, struct loaded_module *mp);
208
209extern int elf_loadmodule(char *filename, vm_offset_t dest, struct loaded_module **result);
210
211#ifndef NEW_LINKER_SET
212#include <sys/linker_set.h>
213
214/* XXX just for conversion's sake, until we move to the new linker set code */
215
216#define SET_FOREACH(pvar, set) \
|
217 for (pvar = set.ls_items; \
218 pvar < set.ls_items + set.ls_length; \
| 217 for ((char*) pvar = set.ls_items; \
218 (char*) pvar < (char*) &set.ls_items[set.ls_length]; \
|
219 pvar++)
220
221#else /* NEW_LINKER_SET */
222
223/*
224 * Private macros, not to be used outside this header file.
225 */
226#define __MAKE_SET(set, sym) \
227 static void *__CONCAT(__setentry,__LINE__) \
228 __attribute__((__section__("set_" #set),__unused__)) = &sym
229#define __SET_BEGIN(set) \
230 ({ extern void *__CONCAT(__start_set_,set); \
231 &__CONCAT(__start_set_,set); })
232#define __SET_END(set) \
233 ({ extern void *__CONCAT(__stop_set_,set); \
234 &__CONCAT(__stop_set_,set); })
235
236/*
237 * Public macros.
238 */
239
240/* Add an entry to a set. */
241#define TEXT_SET(set, sym) __MAKE_SET(set, sym)
242#define DATA_SET(set, sym) __MAKE_SET(set, sym)
243#define BSS_SET(set, sym) __MAKE_SET(set, sym)
244#define ABS_SET(set, sym) __MAKE_SET(set, sym)
245
246/*
247 * Iterate over all the elements of a set.
248 *
249 * Sets always contain addresses of things, and "pvar" points to words
250 * containing those addresses. Thus is must be declared as "type **pvar",
251 * and the address of each set item is obtained inside the loop by "*pvar".
252 */
253#define SET_FOREACH(pvar, set) \
254 for (pvar = (__typeof__(pvar))__SET_BEGIN(set); \
255 pvar < (__typeof__(pvar))__SET_END(set); pvar++)
256#endif
257
258/*
259 * Support for commands
260 */
261struct bootblk_command
262{
263 const char *c_name;
264 const char *c_desc;
265 bootblk_cmd_t *c_fn;
266};
267
268#define COMMAND_SET(tag, key, desc, func) \
269 static bootblk_cmd_t func; \
270 static struct bootblk_command _cmd_ ## tag = { key, desc, func }; \
271 DATA_SET(Xcommand_set, _cmd_ ## tag);
272
273extern struct linker_set Xcommand_set;
274
275/*
276 * The intention of the architecture switch is to provide a convenient
277 * encapsulation of the interface between the bootstrap MI and MD code.
278 * MD code may selectively populate the switch at runtime based on the
279 * actual configuration of the target system.
280 */
281struct arch_switch
282{
283 /* Automatically load modules as required by detected hardware */
284 int (* arch_autoload)();
285 /* Locate the device for (name), return pointer to tail in (*path) */
286 int (*arch_getdev)(void **dev, const char *name, const char **path);
287 /* Copy from local address space to module address space, similar to bcopy() */
288 int (*arch_copyin)(void *src, vm_offset_t dest, size_t len);
289 /* Copy to local address space from module address space, similar to bcopy() */
290 int (*arch_copyout)(vm_offset_t src, void *dest, size_t len);
291 /* Read from file to module address space, same semantics as read() */
292 int (*arch_readin)(int fd, vm_offset_t dest, size_t len);
293 /* Perform ISA byte port I/O (only for systems with ISA) */
294 int (*arch_isainb)(int port);
295 void (*arch_isaoutb)(int port, int value);
296};
297extern struct arch_switch archsw;
298
299/* This must be provided by the MD code, but should it be in the archsw? */
300extern void delay(int delay);
| 219 pvar++)
220
221#else /* NEW_LINKER_SET */
222
223/*
224 * Private macros, not to be used outside this header file.
225 */
226#define __MAKE_SET(set, sym) \
227 static void *__CONCAT(__setentry,__LINE__) \
228 __attribute__((__section__("set_" #set),__unused__)) = &sym
229#define __SET_BEGIN(set) \
230 ({ extern void *__CONCAT(__start_set_,set); \
231 &__CONCAT(__start_set_,set); })
232#define __SET_END(set) \
233 ({ extern void *__CONCAT(__stop_set_,set); \
234 &__CONCAT(__stop_set_,set); })
235
236/*
237 * Public macros.
238 */
239
240/* Add an entry to a set. */
241#define TEXT_SET(set, sym) __MAKE_SET(set, sym)
242#define DATA_SET(set, sym) __MAKE_SET(set, sym)
243#define BSS_SET(set, sym) __MAKE_SET(set, sym)
244#define ABS_SET(set, sym) __MAKE_SET(set, sym)
245
246/*
247 * Iterate over all the elements of a set.
248 *
249 * Sets always contain addresses of things, and "pvar" points to words
250 * containing those addresses. Thus is must be declared as "type **pvar",
251 * and the address of each set item is obtained inside the loop by "*pvar".
252 */
253#define SET_FOREACH(pvar, set) \
254 for (pvar = (__typeof__(pvar))__SET_BEGIN(set); \
255 pvar < (__typeof__(pvar))__SET_END(set); pvar++)
256#endif
257
258/*
259 * Support for commands
260 */
261struct bootblk_command
262{
263 const char *c_name;
264 const char *c_desc;
265 bootblk_cmd_t *c_fn;
266};
267
268#define COMMAND_SET(tag, key, desc, func) \
269 static bootblk_cmd_t func; \
270 static struct bootblk_command _cmd_ ## tag = { key, desc, func }; \
271 DATA_SET(Xcommand_set, _cmd_ ## tag);
272
273extern struct linker_set Xcommand_set;
274
275/*
276 * The intention of the architecture switch is to provide a convenient
277 * encapsulation of the interface between the bootstrap MI and MD code.
278 * MD code may selectively populate the switch at runtime based on the
279 * actual configuration of the target system.
280 */
281struct arch_switch
282{
283 /* Automatically load modules as required by detected hardware */
284 int (* arch_autoload)();
285 /* Locate the device for (name), return pointer to tail in (*path) */
286 int (*arch_getdev)(void **dev, const char *name, const char **path);
287 /* Copy from local address space to module address space, similar to bcopy() */
288 int (*arch_copyin)(void *src, vm_offset_t dest, size_t len);
289 /* Copy to local address space from module address space, similar to bcopy() */
290 int (*arch_copyout)(vm_offset_t src, void *dest, size_t len);
291 /* Read from file to module address space, same semantics as read() */
292 int (*arch_readin)(int fd, vm_offset_t dest, size_t len);
293 /* Perform ISA byte port I/O (only for systems with ISA) */
294 int (*arch_isainb)(int port);
295 void (*arch_isaoutb)(int port, int value);
296};
297extern struct arch_switch archsw;
298
299/* This must be provided by the MD code, but should it be in the archsw? */
300extern void delay(int delay);
|