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