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 const char *c_name; 99 const 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 extern struct console *consoles[]; 124 int cons_inputdev(void); 125 void cons_probe(void); 126 void cons_mode(int); 127 void autoload_font(bool); 128 129 /* 130 * Plug-and-play enumerator/configurator interface. 131 */ 132 struct pnphandler 133 { 134 const char *pp_name; /* handler/bus name */ 135 /* enumerate PnP devices, add to chain */ 136 void (*pp_enumerate)(void); 137 }; 138 139 struct pnpident 140 { 141 /* ASCII identifier, actual format varies with bus/handler */ 142 char *id_ident; 143 STAILQ_ENTRY(pnpident) id_link; 144 }; 145 146 struct pnpinfo 147 { 148 /* ASCII description, optional */ 149 char *pi_desc; 150 /* optional revision (or -1) if not supported */ 151 int pi_revision; 152 /* module/args nominated to handle device */ 153 char *pi_module; 154 /* module arguments */ 155 int pi_argc; 156 char **pi_argv; 157 /* handler which detected this device */ 158 struct pnphandler *pi_handler; 159 /* list of identifiers */ 160 STAILQ_HEAD(, pnpident) pi_ident; 161 STAILQ_ENTRY(pnpinfo) pi_link; 162 }; 163 164 STAILQ_HEAD(pnpinfo_stql, pnpinfo); 165 166 extern struct pnphandler *pnphandlers[]; /* provided by MD code */ 167 168 void pnp_addident(struct pnpinfo *pi, char *ident); 169 struct pnpinfo *pnp_allocinfo(void); 170 void pnp_freeinfo(struct pnpinfo *pi); 171 void pnp_addinfo(struct pnpinfo *pi); 172 char *pnp_eisaformat(uint8_t *data); 173 174 /* 175 * < 0 - No ISA in system 176 * == 0 - Maybe ISA, search for read data port 177 * > 0 - ISA in system, value is read data port address 178 */ 179 extern int isapnp_readport; 180 181 /* 182 * Version information 183 */ 184 extern char bootprog_info[]; 185 186 /* 187 * Preloaded file metadata header. 188 * 189 * Metadata are allocated on our heap, and copied into kernel space 190 * before executing the kernel. 191 */ 192 struct file_metadata 193 { 194 size_t md_size; 195 uint16_t md_type; 196 struct file_metadata *md_next; 197 /* data are immediately appended */ 198 char md_data[1]; 199 }; 200 201 struct preloaded_file; 202 struct mod_depend; 203 204 struct kernel_module 205 { 206 char *m_name; /* module name */ 207 int m_version; /* module version */ 208 char *m_args; /* arguments for the module */ 209 struct preloaded_file *m_fp; 210 struct kernel_module *m_next; 211 }; 212 213 /* 214 * Preloaded file information. Depending on type, file can contain 215 * additional units called 'modules'. 216 * 217 * At least one file (the kernel) must be loaded in order to boot. 218 * The kernel is always loaded first. 219 * 220 * String fields (m_name, m_type) should be dynamically allocated. 221 */ 222 struct preloaded_file 223 { 224 char *f_name; /* file name */ 225 /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */ 226 char *f_type; 227 char *f_args; /* arguments for the file */ 228 /* metadata that will be placed in the module directory */ 229 struct file_metadata *f_metadata; 230 /* index of the loader that read the file */ 231 int f_loader; 232 vm_offset_t f_addr; /* load address */ 233 size_t f_size; /* file size */ 234 struct kernel_module *f_modules; /* list of modules if any */ 235 struct preloaded_file *f_next; /* next file */ 236 }; 237 238 struct file_format 239 { 240 /* 241 * Load function must return EFTYPE if it can't handle the module 242 * supplied. 243 */ 244 int (*l_load)(char *, uint64_t, struct preloaded_file **); 245 /* 246 * Only a loader that will load a kernel (first module) 247 * should have an exec handler. 248 */ 249 int (*l_exec)(struct preloaded_file *); 250 }; 251 252 extern struct file_format *file_formats[]; /* supplied by consumer */ 253 extern struct preloaded_file *preloaded_files; 254 255 int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]); 256 int mod_loadkld(const char *name, int argc, char *argv[]); 257 void unload(void); 258 259 struct preloaded_file *file_alloc(void); 260 struct preloaded_file *file_findfile(const char *name, const char *type); 261 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type); 262 struct preloaded_file *file_loadraw(const char *name, char *type, int argc, 263 char **argv, int insert); 264 void file_discard(struct preloaded_file *fp); 265 void file_addmetadata(struct preloaded_file *, int, size_t, void *); 266 int file_addmodule(struct preloaded_file *, char *, int, 267 struct kernel_module **); 268 void build_environment_module(void); 269 void build_font_module(void); 270 vm_offset_t bi_copyenv(vm_offset_t); 271 272 /* MI module loaders */ 273 #ifdef __elfN 274 /* Relocation types. */ 275 #define ELF_RELOC_REL 1 276 #define ELF_RELOC_RELA 2 277 278 /* Relocation offset for some architectures */ 279 extern uint64_t __elfN(relocation_offset); 280 281 struct elf_file; 282 typedef Elf_Addr(symaddr_fn)(struct elf_file *, Elf_Size); 283 284 int elf64_loadfile(char *, uint64_t, struct preloaded_file **); 285 int elf32_loadfile(char *, uint64_t, struct preloaded_file **); 286 int elf64_obj_loadfile(char *, uint64_t, struct preloaded_file **); 287 int elf32_obj_loadfile(char *, uint64_t, struct preloaded_file **); 288 int __elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr, 289 const void *reldata, int reltype, Elf_Addr relbase, 290 Elf_Addr dataaddr, void *data, size_t len); 291 int elf64_loadfile_raw(char *, uint64_t, struct preloaded_file **, int); 292 int elf32_loadfile_raw(char *, uint64_t, struct preloaded_file **, int); 293 int elf64_load_modmetadata(struct preloaded_file *, uint64_t); 294 int elf32_load_modmetadata(struct preloaded_file *, uint64_t); 295 #endif 296 297 /* 298 * Support for commands 299 */ 300 struct bootblk_command 301 { 302 const char *c_name; 303 const char *c_desc; 304 bootblk_cmd_t *c_fn; 305 }; 306 307 #define COMMAND_SET(tag, key, desc, func) \ 308 static bootblk_cmd_t func; \ 309 static struct bootblk_command _cmd_ ## tag = { key, desc, func }; \ 310 DATA_SET(Xcommand_set, _cmd_ ## tag) 311 312 SET_DECLARE(Xcommand_set, struct bootblk_command); 313 314 /* 315 * The intention of the architecture switch is to provide a convenient 316 * encapsulation of the interface between the bootstrap MI and MD code. 317 * MD code may selectively populate the switch at runtime based on the 318 * actual configuration of the target system. 319 */ 320 struct arch_switch 321 { 322 /* Automatically load modules as required by detected hardware */ 323 int (*arch_autoload)(void); 324 /* Locate the device for (name), return pointer to tail in (*path) */ 325 int (*arch_getdev)(void **dev, const char *name, const char **path); 326 /* 327 * Copy from local address space to module address space, 328 * similar to bcopy() 329 */ 330 ssize_t (*arch_copyin)(const void *src, vm_offset_t dest, 331 const size_t len); 332 /* 333 * Copy to local address space from module address space, 334 * similar to bcopy() 335 */ 336 ssize_t (*arch_copyout)(const vm_offset_t src, void *dest, 337 const size_t len); 338 /* Read from file to module address space, same semantics as read() */ 339 ssize_t (*arch_readin)(const int fd, vm_offset_t dest, 340 const size_t len); 341 /* Perform ISA byte port I/O (only for systems with ISA) */ 342 int (*arch_isainb)(int port); 343 void (*arch_isaoutb)(int port, int value); 344 345 /* 346 * Interface to adjust the load address according to the "object" 347 * being loaded. 348 */ 349 vm_offset_t (*arch_loadaddr)(uint_t type, void *data, vm_offset_t addr); 350 #define LOAD_ELF 1 /* data points to the ELF header. */ 351 #define LOAD_RAW 2 /* data points to the module file name. */ 352 #define LOAD_KERN 3 /* data points to the kernel file name. */ 353 #define LOAD_MEM 4 /* data points to int for buffer size. */ 354 /* 355 * Interface to release the load address. 356 */ 357 void (*arch_free_loadaddr)(vm_offset_t addr, size_t pages); 358 359 /* 360 * Interface to inform MD code about a loaded (ELF) segment. This 361 * can be used to flush caches and/or set up translations. 362 */ 363 #ifdef __elfN 364 void (*arch_loadseg)(Elf_Ehdr *eh, Elf_Phdr *ph, uint64_t delta); 365 #else 366 void (*arch_loadseg)(void *eh, void *ph, uint64_t delta); 367 #endif 368 369 /* Probe ZFS pool(s), if needed. */ 370 void (*arch_zfs_probe)(void); 371 372 /* Return the hypervisor name/type or NULL if not virtualized. */ 373 const char *(*arch_hypervisor)(void); 374 }; 375 extern struct arch_switch archsw; 376 377 /* This must be provided by the MD code, but should it be in the archsw? */ 378 void delay(int delay); 379 380 void dev_cleanup(void); 381 382 /* 383 * nvstore API. 384 */ 385 typedef int (nvstore_getter_cb_t)(void *, const char *, void **); 386 typedef int (nvstore_setter_cb_t)(void *, int, const char *, 387 const void *, size_t); 388 typedef int (nvstore_setter_str_cb_t)(void *, const char *, const char *, 389 const char *); 390 typedef int (nvstore_unset_cb_t)(void *, const char *); 391 typedef int (nvstore_print_cb_t)(void *, void *); 392 typedef int (nvstore_iterate_cb_t)(void *, int (*)(void *, void *)); 393 394 typedef struct nvs_callbacks { 395 nvstore_getter_cb_t *nvs_getter; 396 nvstore_setter_cb_t *nvs_setter; 397 nvstore_setter_str_cb_t *nvs_setter_str; 398 nvstore_unset_cb_t *nvs_unset; 399 nvstore_print_cb_t *nvs_print; 400 nvstore_iterate_cb_t *nvs_iterate; 401 } nvs_callbacks_t; 402 403 int nvstore_init(const char *, nvs_callbacks_t *, void *); 404 int nvstore_fini(const char *); 405 void *nvstore_get_store(const char *); 406 int nvstore_print(void *); 407 int nvstore_get_var(void *, const char *, void **); 408 int nvstore_set_var(void *, int, const char *, void *, size_t); 409 int nvstore_set_var_from_string(void *, const char *, const char *, 410 const char *); 411 int nvstore_unset_var(void *, const char *); 412 413 #define CTASSERT(x) _Static_assert(x, "compile-time assertion failed") 414 415 #endif /* !_BOOTSTRAP_H_ */ 416