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
32 #include <sys/types.h>
33 #include <sys/queue.h>
34 #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[]);
54 /* Called by interp.c for interp_*.c embedded interpreters */
55 int interp_include(const char *); /* Execute commands from filename */
56 void interp_init(void); /* Initialize interpreater */
57 int interp_run(const char *); /* Run a single command */
59 /* interp_backslash.c */
60 char *backslash(const char *str);
63 int parse(int *argc, char ***argv, const char *str);
66 void autoboot_maybe(void);
67 int getrootmount(char *rootdev);
70 char *unargv(int argc, char *argv[]);
71 size_t strlenout(vm_offset_t str);
72 char *strdupout(vm_offset_t str);
73 void kern_bzero(vm_offset_t dest, size_t len);
74 int kern_pread(readin_handle_t fd, vm_offset_t dest, size_t len, off_t off);
75 void *alloc_pread(readin_handle_t fd, off_t off, size_t len);
78 void bcache_init(size_t nblks, size_t bsize);
79 void bcache_add_dev(int);
80 void *bcache_allocate(void);
81 void bcache_free(void *);
82 int bcache_strategy(void *devdata, int rw, daddr_t blk, size_t size,
83 char *buf, size_t *rsize);
90 int (*dv_strategy)(void *, int, daddr_t, size_t, char *, size_t *);
96 * Modular console support.
103 #define C_PRESENTIN (1<<0) /* console can provide input */
104 #define C_PRESENTOUT (1<<1) /* console can provide output */
105 #define C_ACTIVEIN (1<<2) /* user wants input from console */
106 #define C_ACTIVEOUT (1<<3) /* user wants output to console */
107 #define C_WIDEOUT (1<<4) /* c_out routine groks wide chars */
109 /* set c_flags to match hardware */
110 void (* c_probe)(struct console *cp);
111 /* reinit XXX may need more args */
112 int (* c_init)(int arg);
114 void (* c_out)(int c);
115 /* wait for and return input */
117 /* return nonzero if input waiting */
118 int (* c_ready)(void);
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 /* ASCII identifier, actual format varies with bus/handler */
136 STAILQ_ENTRY(pnpident) id_link;
141 char *pi_desc; /* ASCII description, optional */
142 int pi_revision; /* optional revision (or -1) if not supported */
143 char *pi_module; /* module/args nominated to handle device */
144 int pi_argc; /* module arguments */
146 struct pnphandler *pi_handler; /* handler which detected this device */
147 STAILQ_HEAD(, pnpident) pi_ident; /* list of identifiers */
148 STAILQ_ENTRY(pnpinfo) pi_link;
151 STAILQ_HEAD(pnpinfo_stql, pnpinfo);
153 extern struct pnphandler *pnphandlers[]; /* provided by MD code */
155 void pnp_addident(struct pnpinfo *pi, char *ident);
156 struct pnpinfo *pnp_allocinfo(void);
157 void pnp_freeinfo(struct pnpinfo *pi);
158 void pnp_addinfo(struct pnpinfo *pi);
159 char *pnp_eisaformat(uint8_t *data);
162 * < 0 - No ISA in system
163 * == 0 - Maybe ISA, search for read data port
164 * > 0 - ISA in system, value is read data port address
166 extern int isapnp_readport;
169 * Version information
171 extern char bootprog_info[];
174 * Interpreter information
176 extern const char bootprog_interp[];
177 #define INTERP_DEFINE(interpstr) \
178 const char bootprog_interp[] = "$Interpreter:" interpstr
182 * Preloaded file metadata header.
184 * Metadata are allocated on our heap, and copied into kernel space
185 * before executing the kernel.
191 struct file_metadata *md_next;
192 char md_data[1]; /* data are immediately appended */
195 struct preloaded_file;
200 char *m_name; /* module name */
201 int m_version; /* module version */
202 /* char *m_args; */ /* arguments for the module */
203 struct preloaded_file *m_fp;
204 struct kernel_module *m_next;
208 * Preloaded file information. Depending on type, file can contain
209 * additional units called 'modules'.
211 * At least one file (the kernel) must be loaded in order to boot.
212 * The kernel is always loaded first.
214 * String fields (m_name, m_type) should be dynamically allocated.
216 struct preloaded_file
218 char *f_name; /* file name */
219 char *f_type; /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
220 char *f_args; /* arguments for the file */
221 /* metadata that will be placed in the module directory */
222 struct file_metadata *f_metadata;
223 int f_loader; /* index of the loader that read the file */
224 vm_offset_t f_addr; /* load address */
225 size_t f_size; /* file size */
226 struct kernel_module *f_modules; /* list of modules if any */
227 struct preloaded_file *f_next; /* next file */
233 * Load function must return EFTYPE if it can't handle
234 * the module supplied
236 int (*l_load)(char *, uint64_t, struct preloaded_file **);
238 * Only a loader that will load a kernel (first module)
239 * should have an exec handler
241 int (*l_exec)(struct preloaded_file *);
244 extern struct file_format *file_formats[]; /* supplied by consumer */
245 extern struct preloaded_file *preloaded_files;
247 int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
248 int mod_loadkld(const char *name, int argc, char *argv[]);
251 struct preloaded_file *file_alloc(void);
252 struct preloaded_file *file_findfile(const char *name, const char *type);
253 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
254 struct preloaded_file *file_loadraw(const char *name, char *type, int insert);
255 void file_discard(struct preloaded_file *fp);
256 void file_addmetadata(struct preloaded_file *, int, size_t, void *);
257 int file_addmodule(struct preloaded_file *, char *, int,
258 struct kernel_module **);
259 void file_removemetadata(struct preloaded_file *fp);
261 /* MI module loaders */
263 /* Relocation types. */
264 #define ELF_RELOC_REL 1
265 #define ELF_RELOC_RELA 2
267 /* Relocation offset for some architectures */
268 extern uint64_t __elfN(relocation_offset);
271 typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx);
273 int __elfN(loadfile)(char *, uint64_t, struct preloaded_file **);
274 int __elfN(obj_loadfile)(char *, uint64_t, struct preloaded_file **);
275 int __elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr,
276 const void *reldata, int reltype, Elf_Addr relbase,
277 Elf_Addr dataaddr, void *data, size_t len);
278 int __elfN(loadfile_raw)(char *, uint64_t, struct preloaded_file **, int);
279 int __elfN(load_modmetadata)(struct preloaded_file *, uint64_t);
283 * Support for commands
285 struct bootblk_command
292 #define COMMAND_SET(tag, key, desc, func) \
293 static bootblk_cmd_t func; \
294 static struct bootblk_command _cmd_ ## tag = { key, desc, func }; \
295 DATA_SET(Xcommand_set, _cmd_ ## tag)
297 SET_DECLARE(Xcommand_set, struct bootblk_command);
300 * The intention of the architecture switch is to provide a convenient
301 * encapsulation of the interface between the bootstrap MI and MD code.
302 * MD code may selectively populate the switch at runtime based on the
303 * actual configuration of the target system.
307 /* Automatically load modules as required by detected hardware */
308 int (*arch_autoload)(void);
309 /* Locate the device for (name), return pointer to tail in (*path) */
310 int (*arch_getdev)(void **dev, const char *name, const char **path);
312 * Copy from local address space to module address space,
315 ssize_t (*arch_copyin)(const void *, vm_offset_t, const size_t);
317 * Copy to local address space from module address space,
320 ssize_t (*arch_copyout)(const vm_offset_t, void *, const size_t);
321 /* Read from file to module address space, same semantics as read() */
322 ssize_t (*arch_readin)(readin_handle_t, vm_offset_t, const size_t);
323 /* Perform ISA byte port I/O (only for systems with ISA) */
324 int (*arch_isainb)(int port);
325 void (*arch_isaoutb)(int port, int value);
328 * Interface to adjust the load address according to the "object"
331 uint64_t (*arch_loadaddr)(u_int type, void *data, uint64_t addr);
332 #define LOAD_ELF 1 /* data points to the ELF header. */
333 #define LOAD_RAW 2 /* data points to the file name. */
336 * Interface to inform MD code about a loaded (ELF) segment. This
337 * can be used to flush caches and/or set up translations.
340 void (*arch_loadseg)(Elf_Ehdr *eh, Elf_Phdr *ph, uint64_t delta);
342 void (*arch_loadseg)(void *eh, void *ph, uint64_t delta);
345 /* Probe ZFS pool(s), if needed. */
346 void (*arch_zfs_probe)(void);
348 /* Return the hypervisor name/type or NULL if not virtualized. */
349 const char *(*arch_hypervisor)(void);
351 /* For kexec-type loaders, get ksegment structure */
352 void (*arch_kexec_kseg_get)(int *nseg, void **kseg);
354 extern struct arch_switch archsw;
356 /* This must be provided by the MD code, but should it be in the archsw? */
357 void delay(int delay);
359 void dev_cleanup(void);
364 typedef int (nvstore_getter_cb_t)(void *, const char *, void **);
365 typedef int (nvstore_setter_cb_t)(void *, int, const char *,
366 const void *, size_t);
367 typedef int (nvstore_setter_str_cb_t)(void *, const char *, const char *,
369 typedef int (nvstore_unset_cb_t)(void *, const char *);
370 typedef int (nvstore_print_cb_t)(void *, void *);
371 typedef int (nvstore_iterate_cb_t)(void *, int (*)(void *, void *));
373 typedef struct nvs_callbacks {
374 nvstore_getter_cb_t *nvs_getter;
375 nvstore_setter_cb_t *nvs_setter;
376 nvstore_setter_str_cb_t *nvs_setter_str;
377 nvstore_unset_cb_t *nvs_unset;
378 nvstore_print_cb_t *nvs_print;
379 nvstore_iterate_cb_t *nvs_iterate;
382 int nvstore_init(const char *, nvs_callbacks_t *, void *);
383 int nvstore_fini(const char *);
384 void *nvstore_get_store(const char *);
385 int nvstore_print(void *);
386 int nvstore_get_var(void *, const char *, void **);
387 int nvstore_set_var(void *, int, const char *, void *, size_t);
388 int nvstore_set_var_from_string(void *, const char *, const char *,
390 int nvstore_unset_var(void *, const char *);
393 #define CTASSERT(x) _Static_assert(x, "compile-time assertion failed")
396 #endif /* !_BOOTSTRAP_H_ */