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 */
58 int include(const char *filename);
60 /* interp_backslash.c */
61 char *backslash(char *str);
64 int parse(int *argc, char ***argv, char *str);
68 int bf_run(char *line);
71 int autoboot(int timeout, char *prompt);
72 void autoboot_maybe(void);
73 int getrootmount(char *rootdev);
74 int rel_open(const char *path, char **abspathp, int flags);
75 int rel_stat(const char *path, struct stat *st);
76 int chdir(const char *path);
79 char *unargv(int argc, char *argv[]);
80 void hexdump(caddr_t region, size_t len);
81 size_t strlenout(vm_offset_t str);
82 char *strdupout(vm_offset_t str);
83 void kern_bzero(vm_offset_t dest, size_t len);
84 int kern_pread(int fd, vm_offset_t dest, size_t len, off_t off);
85 void *alloc_pread(int fd, off_t off, size_t len);
88 int bcache_init(u_int nblks, size_t bsize);
89 void bcache_flush(void);
90 int bcache_strategy(void *devdata, int unit, int rw, daddr_t blk,
91 size_t size, char *buf, size_t *rsize);
98 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, char *buf, size_t *rsize);
103 * Modular console support.
110 #define C_PRESENTIN (1<<0)
111 #define C_PRESENTOUT (1<<1)
112 #define C_ACTIVEIN (1<<2)
113 #define C_ACTIVEOUT (1<<3)
114 void (* c_probe)(struct console *cp); /* set c_flags to match hardware */
115 int (* c_init)(int arg); /* reinit XXX may need more args */
116 void (* c_out)(int c); /* emit c */
117 int (* c_in)(void); /* wait for and return input */
118 int (* c_ready)(void); /* return nonzer if input waiting */
120 extern struct console *consoles[];
121 void cons_probe(void);
124 * Plug-and-play enumerator/configurator interface.
128 const char *pp_name; /* handler/bus name */
129 void (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
134 char *id_ident; /* ASCII identifier, actual format varies with bus/handler */
135 STAILQ_ENTRY(pnpident) id_link;
140 char *pi_desc; /* ASCII description, optional */
141 int pi_revision; /* optional revision (or -1) if not supported */
142 char *pi_module; /* module/args nominated to handle device */
143 int pi_argc; /* module arguments */
145 struct pnphandler *pi_handler; /* handler which detected this device */
146 STAILQ_HEAD(,pnpident) pi_ident; /* list of identifiers */
147 STAILQ_ENTRY(pnpinfo) pi_link;
150 STAILQ_HEAD(pnpinfo_stql, pnpinfo);
152 extern struct pnpinfo_stql pnp_devices;
154 extern struct pnphandler *pnphandlers[]; /* provided by MD code */
156 void pnp_addident(struct pnpinfo *pi, char *ident);
157 struct pnpinfo *pnp_allocinfo(void);
158 void pnp_freeinfo(struct pnpinfo *pi);
159 void pnp_addinfo(struct pnpinfo *pi);
160 char *pnp_eisaformat(u_int8_t *data);
163 * < 0 - No ISA in system
164 * == 0 - Maybe ISA, search for read data port
165 * > 0 - ISA in system, value is read data port address
167 extern int isapnp_readport;
170 * Preloaded file metadata header.
172 * Metadata are allocated on our heap, and copied into kernel space
173 * before executing the kernel.
179 struct file_metadata *md_next;
180 char md_data[1]; /* data are immediately appended */
183 struct preloaded_file;
188 char *m_name; /* module name */
189 int m_version; /* module version */
190 /* char *m_args;*/ /* arguments for the module */
191 struct preloaded_file *m_fp;
192 struct kernel_module *m_next;
196 * Preloaded file information. Depending on type, file can contain
197 * additional units called 'modules'.
199 * At least one file (the kernel) must be loaded in order to boot.
200 * The kernel is always loaded first.
202 * String fields (m_name, m_type) should be dynamically allocated.
204 struct preloaded_file
206 char *f_name; /* file name */
207 char *f_type; /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
208 char *f_args; /* arguments for the file */
209 struct file_metadata *f_metadata; /* metadata that will be placed in the module directory */
210 int f_loader; /* index of the loader that read the file */
211 vm_offset_t f_addr; /* load address */
212 size_t f_size; /* file size */
213 struct kernel_module *f_modules; /* list of modules if any */
214 struct preloaded_file *f_next; /* next file */
219 /* Load function must return EFTYPE if it can't handle the module supplied */
220 int (* l_load)(char *filename, u_int64_t dest, struct preloaded_file **result);
221 /* Only a loader that will load a kernel (first module) should have an exec handler */
222 int (* l_exec)(struct preloaded_file *mp);
225 extern struct file_format *file_formats[]; /* supplied by consumer */
226 extern struct preloaded_file *preloaded_files;
228 int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
229 int mod_loadkld(const char *name, int argc, char *argv[]);
231 struct preloaded_file *file_alloc(void);
232 struct preloaded_file *file_findfile(char *name, char *type);
233 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
234 void file_discard(struct preloaded_file *fp);
235 void file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p);
236 int file_addmodule(struct preloaded_file *fp, char *modname, int version,
237 struct kernel_module **newmp);
240 /* MI module loaders */
242 /* Relocation types. */
243 #define ELF_RELOC_REL 1
244 #define ELF_RELOC_RELA 2
246 /* Relocation offset for some architectures */
247 extern u_int64_t __elfN(relocation_offset);
250 typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx);
252 int __elfN(loadfile)(char *filename, u_int64_t dest, struct preloaded_file **result);
253 int __elfN(obj_loadfile)(char *filename, u_int64_t dest,
254 struct preloaded_file **result);
255 int __elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr,
256 const void *reldata, int reltype, Elf_Addr relbase,
257 Elf_Addr dataaddr, void *data, size_t len);
261 * Support for commands
263 struct bootblk_command
270 #define COMMAND_SET(tag, key, desc, func) \
271 static bootblk_cmd_t func; \
272 static struct bootblk_command _cmd_ ## tag = { key, desc, func }; \
273 DATA_SET(Xcommand_set, _cmd_ ## tag)
275 SET_DECLARE(Xcommand_set, struct bootblk_command);
278 * The intention of the architecture switch is to provide a convenient
279 * encapsulation of the interface between the bootstrap MI and MD code.
280 * MD code may selectively populate the switch at runtime based on the
281 * actual configuration of the target system.
285 /* Automatically load modules as required by detected hardware */
286 int (*arch_autoload)(void);
287 /* Locate the device for (name), return pointer to tail in (*path) */
288 int (*arch_getdev)(void **dev, const char *name, const char **path);
289 /* Copy from local address space to module address space, similar to bcopy() */
290 ssize_t (*arch_copyin)(const void *src, vm_offset_t dest,
292 /* Copy to local address space from module address space, similar to bcopy() */
293 ssize_t (*arch_copyout)(const vm_offset_t src, void *dest,
295 /* Read from file to module address space, same semantics as read() */
296 ssize_t (*arch_readin)(const int fd, vm_offset_t dest,
298 /* Perform ISA byte port I/O (only for systems with ISA) */
299 int (*arch_isainb)(int port);
300 void (*arch_isaoutb)(int port, int value);
302 extern struct arch_switch archsw;
304 /* This must be provided by the MD code, but should it be in the archsw? */
305 void delay(int delay);
307 void dev_cleanup(void);
309 time_t time(time_t *tloc);