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