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