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 * $FreeBSD: src/sys/boot/common/bootstrap.h,v 1.38 2003/05/01 03:56:29 peter Exp $
27 * $DragonFly: src/sys/boot/common/bootstrap.h,v 1.4 2008/09/02 17:21:12 dillon Exp $
30 #include <sys/types.h>
31 #include <sys/queue.h>
32 #include <sys/linker_set.h>
35 * Generic device specifier; architecture-dependant
36 * versions may be larger, but should be allowed to
49 /* Commands and return values; nonzero return sets command_errmsg != NULL */
50 typedef int (bootblk_cmd_t)(int argc, char *argv[]);
51 extern char *command_errmsg;
52 extern char command_errbuf[]; /* XXX blah, length */
53 extern int CurrentCondition;
59 int include(const char *filename);
61 /* interp_backslash.c */
62 char *backslash(char *str);
65 int parse(int *argc, char ***argv, char *str);
69 int bf_run(char *line);
72 int autoboot(int timeout, char *prompt);
73 void autoboot_maybe(void);
74 int getrootmount(char *rootdev);
75 int rel_open(const char *path, char **abspathp, int flags);
76 int rel_stat(const char *path, struct stat *st);
77 int chdir(const char *path);
80 char *unargv(int argc, char *argv[]);
81 void hexdump(caddr_t region, size_t len);
82 size_t strlenout(vm_offset_t str);
83 char *strdupout(vm_offset_t str);
84 void kern_bzero(vm_offset_t dest, size_t len);
85 int kern_pread(int fd, vm_offset_t dest, size_t len, off_t off);
86 void *alloc_pread(int fd, off_t off, size_t len);
89 int bcache_init(u_int nblks, size_t bsize);
90 void bcache_flush(void);
91 int bcache_strategy(void *devdata, int unit, int rw, daddr_t blk,
92 size_t size, char *buf, size_t *rsize);
94 void slowprint(char c);
101 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, char *buf, size_t *rsize);
106 * Modular console support.
113 #define C_PRESENTIN (1<<0)
114 #define C_PRESENTOUT (1<<1)
115 #define C_ACTIVEIN (1<<2)
116 #define C_ACTIVEOUT (1<<3)
117 void (* c_probe)(struct console *cp); /* set c_flags to match hardware */
118 int (* c_init)(int arg); /* reinit XXX may need more args */
119 void (* c_out)(int c); /* emit c */
120 int (* c_in)(void); /* wait for and return input */
121 int (* c_ready)(void); /* return nonzer if input waiting */
123 extern struct console *consoles[];
124 void cons_probe(void);
127 * Plug-and-play enumerator/configurator interface.
131 const char *pp_name; /* handler/bus name */
132 void (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
137 char *id_ident; /* ASCII identifier, actual format varies with bus/handler */
138 STAILQ_ENTRY(pnpident) id_link;
143 char *pi_desc; /* ASCII description, optional */
144 int pi_revision; /* optional revision (or -1) if not supported */
145 char *pi_module; /* module/args nominated to handle device */
146 int pi_argc; /* module arguments */
148 struct pnphandler *pi_handler; /* handler which detected this device */
149 STAILQ_HEAD(,pnpident) pi_ident; /* list of identifiers */
150 STAILQ_ENTRY(pnpinfo) pi_link;
153 STAILQ_HEAD(pnpinfo_stql, pnpinfo);
155 extern struct pnpinfo_stql pnp_devices;
157 extern struct pnphandler *pnphandlers[]; /* provided by MD code */
159 void pnp_addident(struct pnpinfo *pi, char *ident);
160 struct pnpinfo *pnp_allocinfo(void);
161 void pnp_freeinfo(struct pnpinfo *pi);
162 void pnp_addinfo(struct pnpinfo *pi);
163 char *pnp_eisaformat(u_int8_t *data);
166 * < 0 - No ISA in system
167 * == 0 - Maybe ISA, search for read data port
168 * > 0 - ISA in system, value is read data port address
170 extern int isapnp_readport;
173 * Preloaded file metadata header.
175 * Metadata are allocated on our heap, and copied into kernel space
176 * before executing the kernel.
182 struct file_metadata *md_next;
183 char md_data[1]; /* data are immediately appended */
186 struct preloaded_file;
191 char *m_name; /* module name */
192 int m_version; /* module version */
193 /* char *m_args;*/ /* arguments for the module */
194 struct preloaded_file *m_fp;
195 struct kernel_module *m_next;
199 * Preloaded file information. Depending on type, file can contain
200 * additional units called 'modules'.
202 * At least one file (the kernel) must be loaded in order to boot.
203 * The kernel is always loaded first.
205 * String fields (m_name, m_type) should be dynamically allocated.
207 struct preloaded_file
209 char *f_name; /* file name */
210 char *f_type; /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
211 char *f_args; /* arguments for the file */
212 struct file_metadata *f_metadata; /* metadata that will be placed in the module directory */
213 int f_loader; /* index of the loader that read the file */
214 vm_offset_t f_addr; /* load address */
215 size_t f_size; /* file size */
216 struct kernel_module *f_modules; /* list of modules if any */
217 struct preloaded_file *f_next; /* next file */
222 /* Load function must return EFTYPE if it can't handle the module supplied */
223 int (* l_load)(char *filename, u_int64_t dest, struct preloaded_file **result);
224 /* Only a loader that will load a kernel (first module) should have an exec handler */
225 int (* l_exec)(struct preloaded_file *mp);
228 extern struct file_format *file_formats[]; /* supplied by consumer */
229 extern struct preloaded_file *preloaded_files;
231 int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
232 int mod_loadkld(const char *name, int argc, char *argv[]);
234 struct preloaded_file *file_alloc(void);
235 struct preloaded_file *file_findfile(char *name, char *type);
236 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
237 void file_discard(struct preloaded_file *fp);
238 void file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p);
239 int file_addmodule(struct preloaded_file *fp, char *modname, int version,
240 struct kernel_module **newmp);
243 /* MI module loaders */
245 /* Relocation types. */
246 #define ELF_RELOC_REL 1
247 #define ELF_RELOC_RELA 2
249 /* Relocation offset for some architectures */
250 extern u_int64_t __elfN(relocation_offset);
253 typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx);
255 int __elfN(loadfile)(char *filename, u_int64_t dest, struct preloaded_file **result);
256 int __elfN(obj_loadfile)(char *filename, u_int64_t dest,
257 struct preloaded_file **result);
258 int __elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr,
259 const void *reldata, int reltype, Elf_Addr relbase,
260 Elf_Addr dataaddr, void *data, size_t len);
264 * Support for commands
266 struct bootblk_command
274 #define COMMAND_SET(tag, key, desc, func) \
275 static bootblk_cmd_t func; \
276 static struct bootblk_command _cmd_ ## tag = { key, desc, func, 0 };\
277 DATA_SET(Xcommand_set, _cmd_ ## tag)
279 #define COMMAND_SET_COND(tag, key, desc, func) \
280 static bootblk_cmd_t func; \
281 static struct bootblk_command _cmd_ ## tag = { key, desc, func, 1 };\
282 DATA_SET(Xcommand_set, _cmd_ ## tag)
284 SET_DECLARE(Xcommand_set, struct bootblk_command);
287 * The intention of the architecture switch is to provide a convenient
288 * encapsulation of the interface between the bootstrap MI and MD code.
289 * MD code may selectively populate the switch at runtime based on the
290 * actual configuration of the target system.
294 /* Automatically load modules as required by detected hardware */
295 int (*arch_autoload)(void);
296 /* Locate the device for (name), return pointer to tail in (*path) */
297 int (*arch_getdev)(void **dev, const char *name, const char **path);
298 /* Copy from local address space to module address space, similar to bcopy() */
299 ssize_t (*arch_copyin)(const void *src, vm_offset_t dest,
301 /* Copy to local address space from module address space, similar to bcopy() */
302 ssize_t (*arch_copyout)(const vm_offset_t src, void *dest,
304 /* Read from file to module address space, same semantics as read() */
305 ssize_t (*arch_readin)(const int fd, vm_offset_t dest,
307 /* Perform ISA byte port I/O (only for systems with ISA) */
308 int (*arch_isainb)(int port);
309 void (*arch_isaoutb)(int port, int value);
311 extern struct arch_switch archsw;
313 /* This must be provided by the MD code, but should it be in the archsw? */
314 void delay(int delay);
316 void dev_cleanup(void);
318 time_t time(time_t *tloc);