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
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);
71 extern int getrootmount(char *rootdev);
74 extern char *unargv(int argc, char *argv[]);
75 extern void hexdump(caddr_t region, size_t len);
76 extern size_t strlenout(vm_offset_t str);
77 extern char *strdupout(vm_offset_t str);
80 extern int bcache_init(int nblks, size_t bsize);
87 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, void *buf, size_t *rsize);
92 * Modular console support.
99 #define C_PRESENTIN (1<<0)
100 #define C_PRESENTOUT (1<<1)
101 #define C_ACTIVEIN (1<<2)
102 #define C_ACTIVEOUT (1<<3)
103 void (* c_probe)(struct console *cp); /* set c_flags to match hardware */
104 int (* c_init)(int arg); /* reinit XXX may need more args */
105 void (* c_out)(int c); /* emit c */
106 int (* c_in)(void); /* wait for and return input */
107 int (* c_ready)(void); /* return nonzer if input waiting */
109 extern struct console *consoles[];
110 extern void cons_probe(void);
113 * Plug-and-play enumerator/configurator interface.
117 char *pp_name; /* handler/bus name */
118 void (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
123 char *id_ident; /* ASCII identifier, actual format varies with bus/handler */
124 STAILQ_ENTRY(pnpident) id_link;
129 char *pi_desc; /* ASCII description, optional */
130 int pi_revision; /* optional revision (or -1) if not supported */
131 char *pi_module; /* module/args nominated to handle device */
132 int pi_argc; /* module arguments */
134 struct pnphandler *pi_handler; /* handler which detected this device */
135 STAILQ_HEAD(,pnpident) pi_ident; /* list of identifiers */
136 STAILQ_ENTRY(pnpinfo) pi_link;
139 extern struct pnphandler *pnphandlers[]; /* provided by MD code */
141 extern void pnp_addident(struct pnpinfo *pi, char *ident);
142 extern struct pnpinfo *pnp_allocinfo(void);
143 extern void pnp_freeinfo(struct pnpinfo *pi);
144 extern void pnp_addinfo(struct pnpinfo *pi);
145 extern char *pnp_eisaformat(u_int8_t *data);
148 * < 0 - No ISA in system
149 * == 0 - Maybe ISA, search for read data port
150 * > 0 - ISA in system, value is read data port address
152 extern int isapnp_readport;
155 * Module metadata header.
157 * Metadata are allocated on our heap, and copied into kernel space
158 * before executing the kernel.
160 struct module_metadata
164 struct module_metadata *md_next;
165 char md_data[0]; /* data are immediately appended */
169 * Loaded module information.
171 * At least one module (the kernel) must be loaded in order to boot.
172 * The kernel is always loaded first.
174 * String fields (m_name, m_type) should be dynamically allocated.
178 char *m_name; /* module name */
179 char *m_type; /* verbose module type, eg 'ELF kernel', 'pnptable', etc. */
180 char *m_args; /* arguments for the module */
181 struct module_metadata *m_metadata; /* metadata that will be placed in the module directory */
182 int m_loader; /* index of the loader that read the file */
183 vm_offset_t m_addr; /* load address */
184 size_t m_size; /* module size */
185 struct loaded_module *m_next; /* next module */
190 /* Load function must return EFTYPE if it can't handle the module supplied */
191 int (* l_load)(char *filename, vm_offset_t dest, struct loaded_module **result);
192 /* Only a loader that will load a kernel (first module) should have an exec handler */
193 int (* l_exec)(struct loaded_module *mp);
195 extern struct module_format *module_formats[]; /* supplied by consumer */
196 extern struct loaded_module *loaded_modules;
197 extern int mod_load(char *name, int argc, char *argv[]);
198 extern int mod_loadobj(char *type, char *name);
199 extern struct loaded_module *mod_findmodule(char *name, char *type);
200 extern void mod_addmetadata(struct loaded_module *mp, int type, size_t size, void *p);
201 extern struct module_metadata *mod_findmetadata(struct loaded_module *mp, int type);
202 extern void mod_discard(struct loaded_module *mp);
203 extern struct loaded_module *mod_allocmodule(void);
206 /* MI module loaders */
207 extern int aout_loadmodule(char *filename, vm_offset_t dest, struct loaded_module **result);
208 extern vm_offset_t aout_findsym(char *name, struct loaded_module *mp);
210 extern int elf_loadmodule(char *filename, vm_offset_t dest, struct loaded_module **result);
212 #ifndef NEW_LINKER_SET
213 #include <sys/linker_set.h>
215 /* XXX just for conversion's sake, until we move to the new linker set code */
217 #define SET_FOREACH(pvar, set) \
218 for ((char*) pvar = set.ls_items; \
219 (char*) pvar < (char*) &set.ls_items[set.ls_length]; \
222 #else /* NEW_LINKER_SET */
225 * Private macros, not to be used outside this header file.
227 #define __MAKE_SET(set, sym) \
228 static void *__CONCAT(__setentry,__LINE__) \
229 __attribute__((__section__("set_" #set),__unused__)) = &sym
230 #define __SET_BEGIN(set) \
231 ({ extern void *__CONCAT(__start_set_,set); \
232 &__CONCAT(__start_set_,set); })
233 #define __SET_END(set) \
234 ({ extern void *__CONCAT(__stop_set_,set); \
235 &__CONCAT(__stop_set_,set); })
241 /* Add an entry to a set. */
242 #define DATA_SET(set, sym) __MAKE_SET(set, sym)
245 * Iterate over all the elements of a set.
247 * Sets always contain addresses of things, and "pvar" points to words
248 * containing those addresses. Thus is must be declared as "type **pvar",
249 * and the address of each set item is obtained inside the loop by "*pvar".
251 #define SET_FOREACH(pvar, set) \
252 for (pvar = (__typeof__(pvar))__SET_BEGIN(set); \
253 pvar < (__typeof__(pvar))__SET_END(set); pvar++)
257 * Support for commands
259 struct bootblk_command
266 #define COMMAND_SET(tag, key, desc, func) \
267 static bootblk_cmd_t func; \
268 static struct bootblk_command _cmd_ ## tag = { key, desc, func }; \
269 DATA_SET(Xcommand_set, _cmd_ ## tag);
271 extern struct linker_set Xcommand_set;
274 * The intention of the architecture switch is to provide a convenient
275 * encapsulation of the interface between the bootstrap MI and MD code.
276 * MD code may selectively populate the switch at runtime based on the
277 * actual configuration of the target system.
281 /* Automatically load modules as required by detected hardware */
282 int (* arch_autoload)();
283 /* Locate the device for (name), return pointer to tail in (*path) */
284 int (*arch_getdev)(void **dev, const char *name, const char **path);
285 /* Copy from local address space to module address space, similar to bcopy() */
286 int (*arch_copyin)(void *src, vm_offset_t dest, size_t len);
287 /* Copy to local address space from module address space, similar to bcopy() */
288 int (*arch_copyout)(vm_offset_t src, void *dest, size_t len);
289 /* Read from file to module address space, same semantics as read() */
290 int (*arch_readin)(int fd, vm_offset_t dest, size_t len);
291 /* Perform ISA byte port I/O (only for systems with ISA) */
292 int (*arch_isainb)(int port);
293 void (*arch_isaoutb)(int port, int value);
295 extern struct arch_switch archsw;
297 /* This must be provided by the MD code, but should it be in the archsw? */
298 extern void delay(int delay);