2 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
26 * $Id: bootstrap.h,v 1.20 1999/02/04 17:06:45 dcs Exp $
29 #include <sys/types.h>
30 #include <sys/queue.h>
33 extern struct console vidconsole;
34 #define MARK(s, c) {vidconsole.c_out(s); vidconsole.c_out(c); while (!vidconsole.c_ready()) ; vidconsole.c_in();}
37 * Generic device specifier; architecture-dependant
38 * versions may be larger, but should be allowed to
50 /* Commands and return values; nonzero return sets command_errmsg != NULL */
51 typedef int (bootblk_cmd_t)(int argc, char *argv[]);
52 extern char *command_errmsg;
53 extern char command_errbuf[]; /* XXX blah, length */
58 extern void interact(void);
59 extern int include(char *filename);
62 extern int parse(int *argc, char ***argv, char *str);
65 extern void bf_init(void);
66 extern int bf_run(char *line);
69 extern int autoboot(int delay, char *prompt);
70 extern void autoboot_maybe(void);
73 extern char *unargv(int argc, char *argv[]);
74 extern void hexdump(caddr_t region, size_t len);
75 extern size_t strlenout(vm_offset_t str);
76 extern char *strdupout(vm_offset_t str);
79 extern int bcache_init(int nblks, size_t bsize);
86 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, void *buf, size_t *rsize);
91 * Modular console support.
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 */
108 extern struct console *consoles[];
109 extern void cons_probe(void);
112 * Plug-and-play enumerator/configurator interface.
116 char *pp_name; /* handler/bus name */
117 void (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
122 char *id_ident; /* ASCII identifier, actual format varies with bus/handler */
123 STAILQ_ENTRY(pnpident) id_link;
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 */
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;
138 extern struct pnphandler *pnphandlers[]; /* provided by MD code */
140 extern void pnp_addident(struct pnpinfo *pi, char *ident);
141 extern struct pnpinfo *pnp_allocinfo(void);
142 extern void pnp_freeinfo(struct pnpinfo *pi);
143 extern void pnp_addinfo(struct pnpinfo *pi);
144 extern char *pnp_eisaformat(u_int8_t *data);
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
151 extern int isapnp_readport;
154 * Module metadata header.
156 * Metadata are allocated on our heap, and copied into kernel space
157 * before executing the kernel.
159 struct module_metadata
163 struct module_metadata *md_next;
164 char md_data[0]; /* data are immediately appended */
168 * Loaded module information.
170 * At least one module (the kernel) must be loaded in order to boot.
171 * The kernel is always loaded first.
173 * String fields (m_name, m_type) should be dynamically allocated.
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 */
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);
194 extern struct module_format *module_formats[]; /* supplied by consumer */
195 extern struct loaded_module *loaded_modules;
196 extern int mod_load(char *name, int argc, char *argv[]);
197 extern int mod_loadobj(char *type, char *name);
198 extern struct loaded_module *mod_findmodule(char *name, char *type);
199 extern void mod_addmetadata(struct loaded_module *mp, int type, size_t size, void *p);
200 extern struct module_metadata *mod_findmetadata(struct loaded_module *mp, int type);
201 extern void mod_discard(struct loaded_module *mp);
202 extern struct loaded_module *mod_allocmodule(void);
205 /* MI module loaders */
206 extern int aout_loadmodule(char *filename, vm_offset_t dest, struct loaded_module **result);
207 extern vm_offset_t aout_findsym(char *name, struct loaded_module *mp);
209 extern int elf_loadmodule(char *filename, vm_offset_t dest, struct loaded_module **result);
211 #ifndef NEW_LINKER_SET
212 #include <sys/linker_set.h>
214 /* XXX just for conversion's sake, until we move to the new linker set code */
216 #define SET_FOREACH(pvar, set) \
217 for ((char*) pvar = set.ls_items; \
218 (char*) pvar < (char*) &set.ls_items[set.ls_length]; \
221 #else /* NEW_LINKER_SET */
224 * Private macros, not to be used outside this header file.
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); })
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)
247 * Iterate over all the elements of a set.
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".
253 #define SET_FOREACH(pvar, set) \
254 for (pvar = (__typeof__(pvar))__SET_BEGIN(set); \
255 pvar < (__typeof__(pvar))__SET_END(set); pvar++)
259 * Support for commands
261 struct bootblk_command
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);
273 extern struct linker_set Xcommand_set;
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.
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);
297 extern struct arch_switch archsw;
299 /* This must be provided by the MD code, but should it be in the archsw? */
300 extern void delay(int delay);