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