2 * Copyright (c) 1998 Michael Smith <msmith@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
32 #include <sys/types.h>
33 #include <sys/queue.h>
34 #include <sys/linker_set.h>
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];
48 void interact(const char *rc);
49 int include(const char *filename);
51 /* interp_backslash.c */
52 char *backslash(char *str);
55 int parse(int *argc, char ***argv, char *str);
58 void bf_init(const char *rc);
59 int bf_run(char *line);
62 int autoboot(int timeout, char *prompt);
63 void autoboot_maybe(void);
64 int getrootmount(char *rootdev);
67 char *unargv(int argc, char *argv[]);
68 void hexdump(caddr_t region, size_t len);
69 size_t strlenout(vm_offset_t str);
70 char *strdupout(vm_offset_t str);
71 void kern_bzero(vm_offset_t dest, size_t len);
72 int kern_pread(int fd, vm_offset_t dest, size_t len, off_t off);
73 void *alloc_pread(int fd, off_t off, size_t len);
76 void bcache_init(u_int nblks, size_t bsize);
77 void bcache_add_dev(int);
78 void *bcache_allocate(void);
79 void bcache_free(void *);
80 int bcache_strategy(void *devdata, int rw, daddr_t blk, size_t size,
81 char *buf, size_t *rsize);
88 int (*dv_strategy)(void *devdata, int rw, daddr_t blk,
89 size_t size, char *buf, size_t *rsize);
95 * Modular console support.
102 #define C_PRESENTIN (1<<0) /* console can provide input */
103 #define C_PRESENTOUT (1<<1) /* console can provide output */
104 #define C_ACTIVEIN (1<<2) /* user wants input from console */
105 #define C_ACTIVEOUT (1<<3) /* user wants output to console */
106 #define C_WIDEOUT (1<<4) /* c_out routine groks wide chars */
107 void (* c_probe)(struct console *cp); /* set c_flags to match hardware */
108 int (* c_init)(int arg); /* reinit XXX may need more args */
109 void (* c_out)(int c); /* emit c */
110 int (* c_in)(void); /* wait for and return input */
111 int (* c_ready)(void); /* return nonzer if input waiting */
113 extern struct console *consoles[];
114 void cons_probe(void);
117 * Plug-and-play enumerator/configurator interface.
121 const char *pp_name; /* handler/bus name */
122 void (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
127 char *id_ident; /* ASCII identifier, actual format varies with bus/handler */
128 STAILQ_ENTRY(pnpident) id_link;
133 char *pi_desc; /* ASCII description, optional */
134 int pi_revision; /* optional revision (or -1) if not supported */
135 char *pi_module; /* module/args nominated to handle device */
136 int pi_argc; /* module arguments */
138 struct pnphandler *pi_handler; /* handler which detected this device */
139 STAILQ_HEAD(,pnpident) pi_ident; /* list of identifiers */
140 STAILQ_ENTRY(pnpinfo) pi_link;
143 STAILQ_HEAD(pnpinfo_stql, pnpinfo);
145 extern struct pnphandler *pnphandlers[]; /* provided by MD code */
147 void pnp_addident(struct pnpinfo *pi, char *ident);
148 struct pnpinfo *pnp_allocinfo(void);
149 void pnp_freeinfo(struct pnpinfo *pi);
150 void pnp_addinfo(struct pnpinfo *pi);
151 char *pnp_eisaformat(u_int8_t *data);
154 * < 0 - No ISA in system
155 * == 0 - Maybe ISA, search for read data port
156 * > 0 - ISA in system, value is read data port address
158 extern int isapnp_readport;
161 * Preloaded file metadata header.
163 * Metadata are allocated on our heap, and copied into kernel space
164 * before executing the kernel.
170 struct file_metadata *md_next;
171 char md_data[1]; /* data are immediately appended */
174 struct preloaded_file;
179 char *m_name; /* module name */
180 int m_version; /* module version */
181 /* char *m_args;*/ /* arguments for the module */
182 struct preloaded_file *m_fp;
183 struct kernel_module *m_next;
187 * Preloaded file information. Depending on type, file can contain
188 * additional units called 'modules'.
190 * At least one file (the kernel) must be loaded in order to boot.
191 * The kernel is always loaded first.
193 * String fields (m_name, m_type) should be dynamically allocated.
195 struct preloaded_file
197 char *f_name; /* file name */
198 char *f_type; /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
199 char *f_args; /* arguments for the file */
200 struct file_metadata *f_metadata; /* metadata that will be placed in the module directory */
201 int f_loader; /* index of the loader that read the file */
202 vm_offset_t f_addr; /* load address */
203 size_t f_size; /* file size */
204 struct kernel_module *f_modules; /* list of modules if any */
205 struct preloaded_file *f_next; /* next file */
210 /* Load function must return EFTYPE if it can't handle the module supplied */
211 int (* l_load)(char *filename, u_int64_t dest, struct preloaded_file **result);
212 /* Only a loader that will load a kernel (first module) should have an exec handler */
213 int (* l_exec)(struct preloaded_file *mp);
216 extern struct file_format *file_formats[]; /* supplied by consumer */
217 extern struct preloaded_file *preloaded_files;
219 int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
220 int mod_loadkld(const char *name, int argc, char *argv[]);
223 struct preloaded_file *file_alloc(void);
224 struct preloaded_file *file_findfile(const char *name, const char *type);
225 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
226 struct preloaded_file *file_loadraw(const char *name, char *type, int insert);
227 void file_discard(struct preloaded_file *fp);
228 void file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p);
229 int file_addmodule(struct preloaded_file *fp, char *modname, int version,
230 struct kernel_module **newmp);
231 void file_removemetadata(struct preloaded_file *fp);
233 /* MI module loaders */
235 /* Relocation types. */
236 #define ELF_RELOC_REL 1
237 #define ELF_RELOC_RELA 2
239 /* Relocation offset for some architectures */
240 extern u_int64_t __elfN(relocation_offset);
243 typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx);
245 int __elfN(loadfile)(char *filename, u_int64_t dest, struct preloaded_file **result);
246 int __elfN(obj_loadfile)(char *filename, u_int64_t dest,
247 struct preloaded_file **result);
248 int __elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr,
249 const void *reldata, int reltype, Elf_Addr relbase,
250 Elf_Addr dataaddr, void *data, size_t len);
251 int __elfN(loadfile_raw)(char *filename, u_int64_t dest,
252 struct preloaded_file **result, int multiboot);
253 int __elfN(load_modmetadata)(struct preloaded_file *fp, u_int64_t dest);
257 * Support for commands
259 struct bootblk_command
266 #define COMMAND_SET(tag, key, desc, func) \
267 static bootblk_cmd_t func; \
268 static struct bootblk_command _cmd_ ## tag = { key, desc, func }; \
269 DATA_SET(Xcommand_set, _cmd_ ## tag)
271 SET_DECLARE(Xcommand_set, struct bootblk_command);
274 * The intention of the architecture switch is to provide a convenient
275 * encapsulation of the interface between the bootstrap MI and MD code.
276 * MD code may selectively populate the switch at runtime based on the
277 * actual configuration of the target system.
281 /* Automatically load modules as required by detected hardware */
282 int (*arch_autoload)(void);
283 /* Locate the device for (name), return pointer to tail in (*path) */
284 int (*arch_getdev)(void **dev, const char *name, const char **path);
285 /* Copy from local address space to module address space, similar to bcopy() */
286 ssize_t (*arch_copyin)(const void *src, vm_offset_t dest,
288 /* Copy to local address space from module address space, similar to bcopy() */
289 ssize_t (*arch_copyout)(const vm_offset_t src, void *dest,
291 /* Read from file to module address space, same semantics as read() */
292 ssize_t (*arch_readin)(const int fd, vm_offset_t dest,
294 /* Perform ISA byte port I/O (only for systems with ISA) */
295 int (*arch_isainb)(int port);
296 void (*arch_isaoutb)(int port, int value);
299 * Interface to adjust the load address according to the "object"
302 uint64_t (*arch_loadaddr)(u_int type, void *data, uint64_t addr);
303 #define LOAD_ELF 1 /* data points to the ELF header. */
304 #define LOAD_RAW 2 /* data points to the file name. */
307 * Interface to inform MD code about a loaded (ELF) segment. This
308 * can be used to flush caches and/or set up translations.
311 void (*arch_loadseg)(Elf_Ehdr *eh, Elf_Phdr *ph, uint64_t delta);
313 void (*arch_loadseg)(void *eh, void *ph, uint64_t delta);
316 /* Probe ZFS pool(s), if needed. */
317 void (*arch_zfs_probe)(void);
319 extern struct arch_switch archsw;
321 /* This must be provided by the MD code, but should it be in the archsw? */
322 void delay(int delay);
324 void dev_cleanup(void);
326 time_t time(time_t *tloc);
328 #ifndef CTASSERT /* Allow lint to override */
329 #define CTASSERT(x) _CTASSERT(x, __LINE__)
330 #define _CTASSERT(x, y) __CTASSERT(x, y)
331 #define __CTASSERT(x, y) typedef char __assert ## y[(x) ? 1 : -1]
334 #endif /* !_BOOTSTRAP_H_ */