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