1 /*- 2 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org> 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 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. 13 * 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 24 * SUCH DAMAGE. 25 * 26 * $FreeBSD$ 27 */ 28 29 #ifndef _BOOTSTRAP_H_ 30 #define _BOOTSTRAP_H_ 31 32 #include <sys/types.h> 33 #include <sys/queue.h> 34 #include <sys/linker_set.h> 35 #include <stdbool.h> 36 37 #include "readin.h" 38 39 /* Commands and return values; nonzero return sets command_errmsg != NULL */ 40 typedef int (bootblk_cmd_t)(int argc, char *argv[]); 41 #define COMMAND_ERRBUFSZ (256) 42 extern const char *command_errmsg; 43 extern char command_errbuf[COMMAND_ERRBUFSZ]; 44 #define CMD_OK 0 45 #define CMD_WARN 1 46 #define CMD_ERROR 2 47 #define CMD_CRIT 3 48 #define CMD_FATAL 4 49 50 /* interp.c */ 51 void interact(void); 52 void interp_emit_prompt(void); 53 int interp_builtin_cmd(int argc, char *argv[]); 54 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 */ 59 60 /* interp_backslash.c */ 61 char *backslash(const char *str); 62 63 /* interp_parse.c */ 64 int parse(int *argc, char ***argv, const char *str); 65 66 /* boot.c */ 67 void autoboot_maybe(void); 68 int getrootmount(char *rootdev); 69 70 /* misc.c */ 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); 77 78 /* bcache.c */ 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); 85 86 /* 87 * Disk block cache 88 */ 89 struct bcache_devdata 90 { 91 int (*dv_strategy)(void *, int, daddr_t, size_t, char *, size_t *); 92 void *dv_devdata; 93 void *dv_cache; 94 }; 95 96 /* 97 * Modular console support. 98 */ 99 struct console 100 { 101 const char *c_name; 102 const char *c_desc; 103 int c_flags; 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 */ 109 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); 114 /* emit c */ 115 void (* c_out)(int c); 116 /* wait for and return input */ 117 int (* c_in)(void); 118 /* return nonzero if input waiting */ 119 int (* c_ready)(void); 120 }; 121 extern struct console *consoles[]; 122 void cons_probe(void); 123 bool cons_update_mode(bool); 124 void autoload_font(bool); 125 126 /* 127 * Plug-and-play enumerator/configurator interface. 128 */ 129 struct pnphandler 130 { 131 const char *pp_name; /* handler/bus name */ 132 void (*pp_enumerate)(void); /* enumerate PnP devices, add to chain */ 133 }; 134 135 struct pnpident 136 { 137 /* ASCII identifier, actual format varies with bus/handler */ 138 char *id_ident; 139 STAILQ_ENTRY(pnpident) id_link; 140 }; 141 142 struct pnpinfo 143 { 144 char *pi_desc; /* ASCII description, optional */ 145 int pi_revision; /* optional revision (or -1) if not supported */ 146 char *pi_module; /* module/args nominated to handle device */ 147 int pi_argc; /* module arguments */ 148 char **pi_argv; 149 struct pnphandler *pi_handler; /* handler which detected this device */ 150 STAILQ_HEAD(, pnpident) pi_ident; /* list of identifiers */ 151 STAILQ_ENTRY(pnpinfo) pi_link; 152 }; 153 154 STAILQ_HEAD(pnpinfo_stql, pnpinfo); 155 156 extern struct pnphandler *pnphandlers[]; /* provided by MD code */ 157 158 void pnp_addident(struct pnpinfo *pi, char *ident); 159 struct pnpinfo *pnp_allocinfo(void); 160 void pnp_freeinfo(struct pnpinfo *pi); 161 void pnp_addinfo(struct pnpinfo *pi); 162 char *pnp_eisaformat(uint8_t *data); 163 164 /* 165 * < 0 - No ISA in system 166 * == 0 - Maybe ISA, search for read data port 167 * > 0 - ISA in system, value is read data port address 168 */ 169 extern int isapnp_readport; 170 171 /* 172 * Version information 173 */ 174 extern char bootprog_info[]; 175 176 /* 177 * Interpreter information 178 */ 179 extern const char bootprog_interp[]; 180 #define INTERP_DEFINE(interpstr) \ 181 const char bootprog_interp[] = "$Interpreter:" interpstr 182 183 184 /* 185 * Preloaded file metadata header. 186 * 187 * Metadata are allocated on our heap, and copied into kernel space 188 * before executing the kernel. 189 */ 190 struct file_metadata 191 { 192 size_t md_size; 193 uint16_t md_type; 194 struct file_metadata *md_next; 195 char md_data[1]; /* data are immediately appended */ 196 }; 197 198 struct preloaded_file; 199 struct mod_depend; 200 201 struct kernel_module 202 { 203 char *m_name; /* module name */ 204 int m_version; /* module version */ 205 /* char *m_args; */ /* arguments for the module */ 206 struct preloaded_file *m_fp; 207 struct kernel_module *m_next; 208 }; 209 210 /* 211 * Preloaded file information. Depending on type, file can contain 212 * additional units called 'modules'. 213 * 214 * At least one file (the kernel) must be loaded in order to boot. 215 * The kernel is always loaded first. 216 * 217 * String fields (m_name, m_type) should be dynamically allocated. 218 */ 219 struct preloaded_file 220 { 221 char *f_name; /* file name */ 222 char *f_type; /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */ 223 char *f_args; /* arguments for the file */ 224 /* metadata that will be placed in the module directory */ 225 struct file_metadata *f_metadata; 226 int f_loader; /* index of the loader that read the file */ 227 vm_offset_t f_addr; /* load address */ 228 size_t f_size; /* file size */ 229 struct kernel_module *f_modules; /* list of modules if any */ 230 struct preloaded_file *f_next; /* next file */ 231 }; 232 233 struct file_format 234 { 235 /* 236 * Load function must return EFTYPE if it can't handle 237 * the module supplied 238 */ 239 int (*l_load)(char *, uint64_t, struct preloaded_file **); 240 /* 241 * Only a loader that will load a kernel (first module) 242 * should have an exec handler 243 */ 244 int (*l_exec)(struct preloaded_file *); 245 }; 246 247 extern struct file_format *file_formats[]; /* supplied by consumer */ 248 extern struct preloaded_file *preloaded_files; 249 250 int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]); 251 int mod_loadkld(const char *name, int argc, char *argv[]); 252 void unload(void); 253 254 struct preloaded_file *file_alloc(void); 255 struct preloaded_file *file_findfile(const char *name, const char *type); 256 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type); 257 struct preloaded_file *file_loadraw(const char *name, char *type, int insert); 258 void file_discard(struct preloaded_file *fp); 259 void file_addmetadata(struct preloaded_file *, int, size_t, void *); 260 int file_addmodule(struct preloaded_file *, char *, int, 261 struct kernel_module **); 262 void file_removemetadata(struct preloaded_file *fp); 263 264 vm_offset_t build_font_module(vm_offset_t); 265 266 /* MI module loaders */ 267 #ifdef __elfN 268 /* Relocation types. */ 269 #define ELF_RELOC_REL 1 270 #define ELF_RELOC_RELA 2 271 272 /* Relocation offset for some architectures */ 273 extern uint64_t __elfN(relocation_offset); 274 275 struct elf_file; 276 typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx); 277 278 int __elfN(loadfile)(char *, uint64_t, struct preloaded_file **); 279 int __elfN(obj_loadfile)(char *, uint64_t, struct preloaded_file **); 280 int __elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr, 281 const void *reldata, int reltype, Elf_Addr relbase, 282 Elf_Addr dataaddr, void *data, size_t len); 283 int __elfN(loadfile_raw)(char *, uint64_t, struct preloaded_file **, int); 284 int __elfN(load_modmetadata)(struct preloaded_file *, uint64_t); 285 #endif 286 287 /* 288 * Support for commands 289 */ 290 struct bootblk_command 291 { 292 const char *c_name; 293 const char *c_desc; 294 bootblk_cmd_t *c_fn; 295 }; 296 297 #define COMMAND_SET(tag, key, desc, func) \ 298 static bootblk_cmd_t func; \ 299 static struct bootblk_command _cmd_ ## tag = { key, desc, func }; \ 300 DATA_SET(Xcommand_set, _cmd_ ## tag) 301 302 SET_DECLARE(Xcommand_set, struct bootblk_command); 303 304 /* 305 * The intention of the architecture switch is to provide a convenient 306 * encapsulation of the interface between the bootstrap MI and MD code. 307 * MD code may selectively populate the switch at runtime based on the 308 * actual configuration of the target system. 309 */ 310 struct arch_switch 311 { 312 /* Automatically load modules as required by detected hardware */ 313 int (*arch_autoload)(void); 314 /* Locate the device for (name), return pointer to tail in (*path) */ 315 int (*arch_getdev)(void **dev, const char *name, const char **path); 316 /* 317 * Copy from local address space to module address space, 318 * similar to bcopy() 319 */ 320 ssize_t (*arch_copyin)(const void *, vm_offset_t, const size_t); 321 /* 322 * Copy to local address space from module address space, 323 * similar to bcopy() 324 */ 325 ssize_t (*arch_copyout)(const vm_offset_t, void *, const size_t); 326 /* Read from file to module address space, same semantics as read() */ 327 ssize_t (*arch_readin)(readin_handle_t, vm_offset_t, const size_t); 328 /* Perform ISA byte port I/O (only for systems with ISA) */ 329 int (*arch_isainb)(int port); 330 void (*arch_isaoutb)(int port, int value); 331 332 /* 333 * Interface to adjust the load address according to the "object" 334 * being loaded. 335 */ 336 uint64_t (*arch_loadaddr)(u_int type, void *data, uint64_t addr); 337 #define LOAD_ELF 1 /* data points to the ELF header. */ 338 #define LOAD_RAW 2 /* data points to the file name. */ 339 340 /* 341 * Interface to inform MD code about a loaded (ELF) segment. This 342 * can be used to flush caches and/or set up translations. 343 */ 344 #ifdef __elfN 345 void (*arch_loadseg)(Elf_Ehdr *eh, Elf_Phdr *ph, uint64_t delta); 346 #else 347 void (*arch_loadseg)(void *eh, void *ph, uint64_t delta); 348 #endif 349 350 /* Probe ZFS pool(s), if needed. */ 351 void (*arch_zfs_probe)(void); 352 353 /* Return the hypervisor name/type or NULL if not virtualized. */ 354 const char *(*arch_hypervisor)(void); 355 356 /* For kexec-type loaders, get ksegment structure */ 357 void (*arch_kexec_kseg_get)(int *nseg, void **kseg); 358 }; 359 extern struct arch_switch archsw; 360 361 /* This must be provided by the MD code, but should it be in the archsw? */ 362 void delay(int delay); 363 364 void dev_cleanup(void); 365 366 /* 367 * nvstore API. 368 */ 369 typedef int (nvstore_getter_cb_t)(void *, const char *, void **); 370 typedef int (nvstore_setter_cb_t)(void *, int, const char *, 371 const void *, size_t); 372 typedef int (nvstore_setter_str_cb_t)(void *, const char *, const char *, 373 const char *); 374 typedef int (nvstore_unset_cb_t)(void *, const char *); 375 typedef int (nvstore_print_cb_t)(void *, void *); 376 typedef int (nvstore_iterate_cb_t)(void *, int (*)(void *, void *)); 377 378 typedef struct nvs_callbacks { 379 nvstore_getter_cb_t *nvs_getter; 380 nvstore_setter_cb_t *nvs_setter; 381 nvstore_setter_str_cb_t *nvs_setter_str; 382 nvstore_unset_cb_t *nvs_unset; 383 nvstore_print_cb_t *nvs_print; 384 nvstore_iterate_cb_t *nvs_iterate; 385 } nvs_callbacks_t; 386 387 int nvstore_init(const char *, nvs_callbacks_t *, void *); 388 int nvstore_fini(const char *); 389 void *nvstore_get_store(const char *); 390 int nvstore_print(void *); 391 int nvstore_get_var(void *, const char *, void **); 392 int nvstore_set_var(void *, int, const char *, void *, size_t); 393 int nvstore_set_var_from_string(void *, const char *, const char *, 394 const char *); 395 int nvstore_unset_var(void *, const char *); 396 397 #ifndef CTASSERT 398 #define CTASSERT(x) _Static_assert(x, "compile-time assertion failed") 399 #endif 400 401 #endif /* !_BOOTSTRAP_H_ */ 402