bootstrap.h revision 83321
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: head/sys/boot/common/bootstrap.h 83321 2001-09-11 01:09:24Z peter $ 27 */ 28 29#include <sys/types.h> 30#include <sys/queue.h> 31#include <sys/linker_set.h> 32 33/* 34 * Generic device specifier; architecture-dependant 35 * versions may be larger, but should be allowed to 36 * overlap. 37 */ 38struct devdesc 39{ 40 struct devsw *d_dev; 41 int d_type; 42#define DEVT_NONE 0 43#define DEVT_DISK 1 44#define DEVT_NET 2 45}; 46 47/* Commands and return values; nonzero return sets command_errmsg != NULL */ 48typedef int (bootblk_cmd_t)(int argc, char *argv[]); 49extern char *command_errmsg; 50extern char command_errbuf[]; /* XXX blah, length */ 51#define CMD_OK 0 52#define CMD_ERROR 1 53 54/* interp.c */ 55void interact(void); 56int include(const char *filename); 57 58/* interp_backslash.c */ 59char *backslash(char *str); 60 61/* interp_parse.c */ 62int parse(int *argc, char ***argv, char *str); 63 64/* interp_forth.c */ 65void bf_init(void); 66int bf_run(char *line); 67 68/* boot.c */ 69int autoboot(int timeout, char *prompt); 70void autoboot_maybe(void); 71int getrootmount(char *rootdev); 72 73/* misc.c */ 74char *unargv(int argc, char *argv[]); 75void hexdump(caddr_t region, size_t len); 76size_t strlenout(vm_offset_t str); 77char *strdupout(vm_offset_t str); 78 79/* bcache.c */ 80int bcache_init(u_int nblks, size_t bsize); 81void bcache_flush(void); 82int bcache_strategy(void *devdata, int unit, int rw, daddr_t blk, 83 size_t size, char *buf, size_t *rsize); 84 85/* 86 * Disk block cache 87 */ 88struct bcache_devdata 89{ 90 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, char *buf, size_t *rsize); 91 void *dv_devdata; 92}; 93 94/* 95 * Modular console support. 96 */ 97struct console 98{ 99 const char *c_name; 100 const char *c_desc; 101 int c_flags; 102#define C_PRESENTIN (1<<0) 103#define C_PRESENTOUT (1<<1) 104#define C_ACTIVEIN (1<<2) 105#define C_ACTIVEOUT (1<<3) 106 void (* c_probe)(struct console *cp); /* set c_flags to match hardware */ 107 int (* c_init)(int arg); /* reinit XXX may need more args */ 108 void (* c_out)(int c); /* emit c */ 109 int (* c_in)(void); /* wait for and return input */ 110 int (* c_ready)(void); /* return nonzer if input waiting */ 111}; 112extern struct console *consoles[]; 113void cons_probe(void); 114 115/* 116 * Plug-and-play enumerator/configurator interface. 117 */ 118struct pnphandler 119{ 120 const char *pp_name; /* handler/bus name */ 121 void (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */ 122}; 123 124struct pnpident 125{ 126 char *id_ident; /* ASCII identifier, actual format varies with bus/handler */ 127 STAILQ_ENTRY(pnpident) id_link; 128}; 129 130struct pnpinfo 131{ 132 char *pi_desc; /* ASCII description, optional */ 133 int pi_revision; /* optional revision (or -1) if not supported */ 134 char *pi_module; /* module/args nominated to handle device */ 135 int pi_argc; /* module arguments */ 136 char **pi_argv; 137 struct pnphandler *pi_handler; /* handler which detected this device */ 138 STAILQ_HEAD(,pnpident) pi_ident; /* list of identifiers */ 139 STAILQ_ENTRY(pnpinfo) pi_link; 140}; 141 142STAILQ_HEAD(pnpinfo_stql, pnpinfo); 143 144extern struct pnpinfo_stql pnp_devices; 145 146extern struct pnphandler *pnphandlers[]; /* provided by MD code */ 147 148void pnp_addident(struct pnpinfo *pi, char *ident); 149struct pnpinfo *pnp_allocinfo(void); 150void pnp_freeinfo(struct pnpinfo *pi); 151void pnp_addinfo(struct pnpinfo *pi); 152char *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 */ 159extern 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 */ 167struct 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 175struct preloaded_file; 176struct mod_depend; 177 178struct 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 */ 196struct 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 209struct file_format 210{ 211 /* Load function must return EFTYPE if it can't handle the module supplied */ 212 int (* l_load)(char *filename, vm_offset_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 217extern struct file_format *file_formats[]; /* supplied by consumer */ 218extern struct preloaded_file *preloaded_files; 219 220int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]); 221int mod_loadobj(char *type, char *name); 222int mod_loadkld(const char *name, int argc, char *argv[]); 223 224struct preloaded_file *file_alloc(void); 225struct preloaded_file *file_findfile(char *name, char *type); 226struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type); 227void file_discard(struct preloaded_file *fp); 228void file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p); 229int file_addmodule(struct preloaded_file *fp, char *modname, int version, 230 struct kernel_module **newmp); 231 232 233/* MI module loaders */ 234int aout_loadfile(char *filename, vm_offset_t dest, struct preloaded_file **result); 235vm_offset_t aout_findsym(char *name, struct preloaded_file *fp); 236 237int elf_loadfile(char *filename, vm_offset_t dest, struct preloaded_file **result); 238 239/* 240 * Support for commands 241 */ 242struct bootblk_command 243{ 244 const char *c_name; 245 const char *c_desc; 246 bootblk_cmd_t *c_fn; 247}; 248 249#define COMMAND_SET(tag, key, desc, func) \ 250 static bootblk_cmd_t func; \ 251 static struct bootblk_command _cmd_ ## tag = { key, desc, func }; \ 252 DATA_SET(Xcommand_set, _cmd_ ## tag) 253 254SET_DECLARE(Xcommand_set, struct bootblk_command); 255 256/* 257 * The intention of the architecture switch is to provide a convenient 258 * encapsulation of the interface between the bootstrap MI and MD code. 259 * MD code may selectively populate the switch at runtime based on the 260 * actual configuration of the target system. 261 */ 262struct arch_switch 263{ 264 /* Automatically load modules as required by detected hardware */ 265 int (*arch_autoload)(void); 266 /* Locate the device for (name), return pointer to tail in (*path) */ 267 int (*arch_getdev)(void **dev, const char *name, const char **path); 268 /* Copy from local address space to module address space, similar to bcopy() */ 269 ssize_t (*arch_copyin)(const void *src, vm_offset_t dest, 270 const size_t len); 271 /* Copy to local address space from module address space, similar to bcopy() */ 272 ssize_t (*arch_copyout)(const vm_offset_t src, void *dest, 273 const size_t len); 274 /* Read from file to module address space, same semantics as read() */ 275 ssize_t (*arch_readin)(const int fd, vm_offset_t dest, 276 const size_t len); 277 /* Perform ISA byte port I/O (only for systems with ISA) */ 278 int (*arch_isainb)(int port); 279 void (*arch_isaoutb)(int port, int value); 280}; 281extern struct arch_switch archsw; 282 283/* This must be provided by the MD code, but should it be in the archsw? */ 284void delay(int delay); 285 286void dev_cleanup(void); 287