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
31 #include <sys/types.h>
32 #include <sys/queue.h>
33 #include <sys/linker_set.h>
38 /* Commands and return values; nonzero return sets command_errmsg != NULL */
39 typedef int (bootblk_cmd_t)(int argc, char *argv[]);
40 #define COMMAND_ERRBUFSZ (256)
41 extern const char *command_errmsg;
42 extern char command_errbuf[COMMAND_ERRBUFSZ];
51 void interp_emit_prompt(void);
52 int interp_builtin_cmd(int argc, char *argv[]);
53 bool interp_has_builtin_cmd(const char *cmd);
55 /* Called by interp.c for interp_*.c embedded interpreters */
56 int interp_include(const char *); /* Execute commands from filename */
57 void interp_init(void); /* Initialize interpreater */
58 int interp_run(const char *); /* Run a single command */
60 /* interp_backslash.c */
61 char *backslash(const char *str);
64 int parse(int *argc, char ***argv, const char *str);
67 void autoboot_maybe(void);
68 int getrootmount(char *rootdev);
71 char *unargv(int argc, char *argv[]);
72 size_t strlenout(vm_offset_t str);
73 char *strdupout(vm_offset_t str);
74 void kern_bzero(vm_offset_t dest, size_t len);
75 int kern_pread(readin_handle_t fd, vm_offset_t dest, size_t len, off_t off);
76 void *alloc_pread(readin_handle_t fd, off_t off, size_t len);
79 void bcache_init(size_t nblks, size_t bsize);
80 void bcache_add_dev(int);
81 void *bcache_allocate(void);
82 void bcache_free(void *);
83 int bcache_strategy(void *devdata, int rw, daddr_t blk, size_t size,
84 char *buf, size_t *rsize);
91 int (*dv_strategy)(void *, int, daddr_t, size_t, char *, size_t *);
97 * Modular console support.
104 #define C_PRESENTIN (1<<0) /* console can provide input */
105 #define C_PRESENTOUT (1<<1) /* console can provide output */
106 #define C_ACTIVEIN (1<<2) /* user wants input from console */
107 #define C_ACTIVEOUT (1<<3) /* user wants output to console */
108 #define C_WIDEOUT (1<<4) /* c_out routine groks wide chars */
110 /* set c_flags to match hardware */
111 void (* c_probe)(struct console *cp);
112 /* reinit XXX may need more args */
113 int (* c_init)(int arg);
115 void (* c_out)(int c);
116 /* wait for and return input */
118 /* return nonzero if input waiting */
119 int (* c_ready)(void);
121 extern struct console *consoles[];
122 void cons_probe(void);
123 bool cons_update_mode(bool);
124 void autoload_font(bool);
126 extern int module_verbose;
128 MODULE_VERBOSE_SILENT, /* say nothing */
129 MODULE_VERBOSE_SIZE, /* print name and size */
130 MODULE_VERBOSE_TWIDDLE, /* show progress */
131 MODULE_VERBOSE_FULL, /* all we have */
135 * Plug-and-play enumerator/configurator interface.
139 const char *pp_name; /* handler/bus name */
140 void (*pp_enumerate)(void); /* enumerate PnP devices, add to chain */
145 /* ASCII identifier, actual format varies with bus/handler */
147 STAILQ_ENTRY(pnpident) id_link;
152 char *pi_desc; /* ASCII description, optional */
153 int pi_revision; /* optional revision (or -1) if not supported */
154 char *pi_module; /* module/args nominated to handle device */
155 int pi_argc; /* module arguments */
157 struct pnphandler *pi_handler; /* handler which detected this device */
158 STAILQ_HEAD(, pnpident) pi_ident; /* list of identifiers */
159 STAILQ_ENTRY(pnpinfo) pi_link;
162 STAILQ_HEAD(pnpinfo_stql, pnpinfo);
164 extern struct pnphandler *pnphandlers[]; /* provided by MD code */
166 void pnp_addident(struct pnpinfo *pi, char *ident);
167 struct pnpinfo *pnp_allocinfo(void);
168 void pnp_freeinfo(struct pnpinfo *pi);
169 void pnp_addinfo(struct pnpinfo *pi);
170 char *pnp_eisaformat(uint8_t *data);
173 * < 0 - No ISA in system
174 * == 0 - Maybe ISA, search for read data port
175 * > 0 - ISA in system, value is read data port address
177 extern int isapnp_readport;
180 * Version information
182 extern char bootprog_info[];
183 extern unsigned bootprog_rev;
186 * Interpreter information
188 extern const char bootprog_interp[];
189 #define INTERP_DEFINE(interpstr) \
190 const char bootprog_interp[] = "$Interpreter:" interpstr
194 * Preloaded file metadata header.
196 * Metadata are allocated on our heap, and copied into kernel space
197 * before executing the kernel.
203 vm_offset_t md_addr; /* Valid after copied to kernel space */
204 struct file_metadata *md_next;
205 char md_data[1]; /* data are immediately appended */
208 struct preloaded_file;
213 char *m_name; /* module name */
214 int m_version; /* module version */
215 /* char *m_args; */ /* arguments for the module */
216 struct preloaded_file *m_fp;
217 struct kernel_module *m_next;
221 * Preloaded file information. Depending on type, file can contain
222 * additional units called 'modules'.
224 * At least one file (the kernel) must be loaded in order to boot.
225 * The kernel is always loaded first.
227 * String fields (m_name, m_type) should be dynamically allocated.
229 struct preloaded_file
231 char *f_name; /* file name */
232 char *f_type; /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
233 char *f_args; /* arguments for the file */
234 /* metadata that will be placed in the module directory */
235 struct file_metadata *f_metadata;
236 int f_loader; /* index of the loader that read the file */
237 vm_offset_t f_addr; /* load address */
238 size_t f_size; /* file size */
239 struct kernel_module *f_modules; /* list of modules if any */
240 struct preloaded_file *f_next; /* next file */
242 bool f_kernphys_relocatable;
244 #if defined(__i386__)
245 bool f_tg_kernel_support;
252 * Load function must return EFTYPE if it can't handle
253 * the module supplied
255 int (*l_load)(char *, uint64_t, struct preloaded_file **);
257 * Only a loader that will load a kernel (first module)
258 * should have an exec handler
260 int (*l_exec)(struct preloaded_file *);
263 extern struct file_format *file_formats[]; /* supplied by consumer */
264 extern struct preloaded_file *preloaded_files;
266 int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
267 int mod_loadkld(const char *name, int argc, char *argv[]);
270 struct preloaded_file *file_alloc(void);
271 struct preloaded_file *file_findfile(const char *name, const char *type);
272 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
273 struct preloaded_file *file_loadraw(const char *name, char *type, int insert);
274 void file_discard(struct preloaded_file *fp);
275 void file_addmetadata(struct preloaded_file *, int, size_t, void *);
276 int file_addmodule(struct preloaded_file *, char *, int,
277 struct kernel_module **);
278 void file_removemetadata(struct preloaded_file *fp);
279 int file_addbuf(const char *name, const char *type, size_t len, void *buf);
280 int tslog_init(void);
281 int tslog_publish(void);
283 vm_offset_t build_font_module(vm_offset_t);
285 /* MI module loaders */
287 /* Relocation types. */
288 #define ELF_RELOC_REL 1
289 #define ELF_RELOC_RELA 2
291 /* Relocation offset for some architectures */
292 extern uint64_t __elfN(relocation_offset);
295 typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx);
297 int __elfN(loadfile)(char *, uint64_t, struct preloaded_file **);
298 int __elfN(obj_loadfile)(char *, uint64_t, struct preloaded_file **);
299 int __elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr,
300 const void *reldata, int reltype, Elf_Addr relbase,
301 Elf_Addr dataaddr, void *data, size_t len);
302 int __elfN(loadfile_raw)(char *, uint64_t, struct preloaded_file **, int);
303 int __elfN(load_modmetadata)(struct preloaded_file *, uint64_t);
307 * Support for commands
309 struct bootblk_command
316 #define COMMAND_SET(tag, key, desc, func) \
317 static bootblk_cmd_t func; \
318 static struct bootblk_command _cmd_ ## tag = { key, desc, func }; \
319 DATA_SET(Xcommand_set, _cmd_ ## tag)
321 SET_DECLARE(Xcommand_set, struct bootblk_command);
324 * The intention of the architecture switch is to provide a convenient
325 * encapsulation of the interface between the bootstrap MI and MD code.
326 * MD code may selectively populate the switch at runtime based on the
327 * actual configuration of the target system.
331 /* Automatically load modules as required by detected hardware */
332 int (*arch_autoload)(void);
333 /* Locate the device for (name), return pointer to tail in (*path) */
334 int (*arch_getdev)(void **dev, const char *name, const char **path);
336 * Copy from local address space to module address space,
339 ssize_t (*arch_copyin)(const void *, vm_offset_t, const size_t);
341 * Copy to local address space from module address space,
344 ssize_t (*arch_copyout)(const vm_offset_t, void *, const size_t);
345 /* Read from file to module address space, same semantics as read() */
346 ssize_t (*arch_readin)(readin_handle_t, vm_offset_t, const size_t);
347 /* Perform ISA byte port I/O (only for systems with ISA) */
348 int (*arch_isainb)(int port);
349 void (*arch_isaoutb)(int port, int value);
352 * Interface to adjust the load address according to the "object"
355 uint64_t (*arch_loadaddr)(u_int type, void *data, uint64_t addr);
356 #define LOAD_ELF 1 /* data points to the ELF header. */
357 #define LOAD_RAW 2 /* data points to the file name. */
360 * Interface to inform MD code about a loaded (ELF) segment. This
361 * can be used to flush caches and/or set up translations.
364 void (*arch_loadseg)(Elf_Ehdr *eh, Elf_Phdr *ph, uint64_t delta);
366 void (*arch_loadseg)(void *eh, void *ph, uint64_t delta);
369 /* Probe ZFS pool(s), if needed. */
370 void (*arch_zfs_probe)(void);
372 /* Return the hypervisor name/type or NULL if not virtualized. */
373 const char *(*arch_hypervisor)(void);
375 extern struct arch_switch archsw;
377 /* This must be provided by the MD code, but should it be in the archsw? */
378 void delay(int delay);
380 /* common code to set currdev variable. */
381 int gen_setcurrdev(struct env_var *ev, int flags, const void *value);
382 int mount_currdev(struct env_var *, int, const void *);
383 void set_currdev(const char *devname);
386 #define CTASSERT(x) _Static_assert(x, "compile-time assertion failed")
389 #endif /* !_BOOTSTRAP_H_ */