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
29 #include <sys/types.h>
30 #include <sys/queue.h>
31 #include <sys/linker_set.h>
34 * Generic device specifier; architecture-dependant
35 * versions may be larger, but should be allowed to
51 /* Commands and return values; nonzero return sets command_errmsg != NULL */
52 typedef int (bootblk_cmd_t)(int argc, char *argv[]);
53 extern char *command_errmsg;
54 extern char command_errbuf[]; /* XXX blah, length */
60 int include(const char *filename);
62 /* interp_backslash.c */
63 char *backslash(char *str);
66 int parse(int *argc, char ***argv, char *str);
70 int bf_run(char *line);
73 int autoboot(int timeout, char *prompt);
74 void autoboot_maybe(void);
75 int getrootmount(char *rootdev);
78 char *unargv(int argc, char *argv[]);
79 void hexdump(caddr_t region, size_t len);
80 size_t strlenout(vm_offset_t str);
81 char *strdupout(vm_offset_t str);
82 void kern_bzero(vm_offset_t dest, size_t len);
83 int kern_pread(int fd, vm_offset_t dest, size_t len, off_t off);
84 void *alloc_pread(int fd, off_t off, size_t len);
87 int bcache_init(u_int nblks, size_t bsize);
88 void bcache_flush(void);
89 int bcache_strategy(void *devdata, int unit, int rw, daddr_t blk,
90 size_t size, char *buf, size_t *rsize);
97 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, char *buf, size_t *rsize);
102 * Modular console support.
109 #define C_PRESENTIN (1<<0)
110 #define C_PRESENTOUT (1<<1)
111 #define C_ACTIVEIN (1<<2)
112 #define C_ACTIVEOUT (1<<3)
113 void (* c_probe)(struct console *cp); /* set c_flags to match hardware */
114 int (* c_init)(int arg); /* reinit XXX may need more args */
115 void (* c_out)(int c); /* emit c */
116 int (* c_in)(void); /* wait for and return input */
117 int (* c_ready)(void); /* return nonzer if input waiting */
119 extern struct console *consoles[];
120 void cons_probe(void);
123 * Plug-and-play enumerator/configurator interface.
127 const char *pp_name; /* handler/bus name */
128 void (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
133 char *id_ident; /* ASCII identifier, actual format varies with bus/handler */
134 STAILQ_ENTRY(pnpident) id_link;
139 char *pi_desc; /* ASCII description, optional */
140 int pi_revision; /* optional revision (or -1) if not supported */
141 char *pi_module; /* module/args nominated to handle device */
142 int pi_argc; /* module arguments */
144 struct pnphandler *pi_handler; /* handler which detected this device */
145 STAILQ_HEAD(,pnpident) pi_ident; /* list of identifiers */
146 STAILQ_ENTRY(pnpinfo) pi_link;
149 STAILQ_HEAD(pnpinfo_stql, pnpinfo);
151 extern struct pnpinfo_stql pnp_devices;
153 extern struct pnphandler *pnphandlers[]; /* provided by MD code */
155 void pnp_addident(struct pnpinfo *pi, char *ident);
156 struct pnpinfo *pnp_allocinfo(void);
157 void pnp_freeinfo(struct pnpinfo *pi);
158 void pnp_addinfo(struct pnpinfo *pi);
159 char *pnp_eisaformat(u_int8_t *data);
162 * < 0 - No ISA in system
163 * == 0 - Maybe ISA, search for read data port
164 * > 0 - ISA in system, value is read data port address
166 extern int isapnp_readport;
169 * Preloaded file metadata header.
171 * Metadata are allocated on our heap, and copied into kernel space
172 * before executing the kernel.
178 struct file_metadata *md_next;
179 char md_data[1]; /* data are immediately appended */
182 struct preloaded_file;
187 char *m_name; /* module name */
188 int m_version; /* module version */
189 /* char *m_args;*/ /* arguments for the module */
190 struct preloaded_file *m_fp;
191 struct kernel_module *m_next;
195 * Preloaded file information. Depending on type, file can contain
196 * additional units called 'modules'.
198 * At least one file (the kernel) must be loaded in order to boot.
199 * The kernel is always loaded first.
201 * String fields (m_name, m_type) should be dynamically allocated.
203 struct preloaded_file
205 char *f_name; /* file name */
206 char *f_type; /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
207 char *f_args; /* arguments for the file */
208 struct file_metadata *f_metadata; /* metadata that will be placed in the module directory */
209 int f_loader; /* index of the loader that read the file */
210 vm_offset_t f_addr; /* load address */
211 size_t f_size; /* file size */
212 struct kernel_module *f_modules; /* list of modules if any */
213 struct preloaded_file *f_next; /* next file */
218 /* Load function must return EFTYPE if it can't handle the module supplied */
219 int (* l_load)(char *filename, u_int64_t dest, struct preloaded_file **result);
220 /* Only a loader that will load a kernel (first module) should have an exec handler */
221 int (* l_exec)(struct preloaded_file *mp);
224 extern struct file_format *file_formats[]; /* supplied by consumer */
225 extern struct preloaded_file *preloaded_files;
227 int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
228 int mod_loadkld(const char *name, int argc, char *argv[]);
230 struct preloaded_file *file_alloc(void);
231 struct preloaded_file *file_findfile(char *name, char *type);
232 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
233 void file_discard(struct preloaded_file *fp);
234 void file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p);
235 int file_addmodule(struct preloaded_file *fp, char *modname, int version,
236 struct kernel_module **newmp);
238 /* MI module loaders */
240 /* Relocation types. */
241 #define ELF_RELOC_REL 1
242 #define ELF_RELOC_RELA 2
244 /* Relocation offset for some architectures */
245 extern u_int64_t __elfN(relocation_offset);
248 typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx);
250 int __elfN(loadfile)(char *filename, u_int64_t dest, struct preloaded_file **result);
251 int __elfN(obj_loadfile)(char *filename, u_int64_t dest,
252 struct preloaded_file **result);
253 int __elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr,
254 const void *reldata, int reltype, Elf_Addr relbase,
255 Elf_Addr dataaddr, void *data, size_t len);
259 * Support for commands
261 struct bootblk_command
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)
273 SET_DECLARE(Xcommand_set, struct bootblk_command);
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.
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,
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,
293 /* Read from file to module address space, same semantics as read() */
294 ssize_t (*arch_readin)(const int fd, vm_offset_t dest,
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 /* Pass in initial kernel memory size */
300 void (*arch_maphint)(vm_offset_t va, size_t len);
302 extern struct arch_switch archsw;
304 /* This must be provided by the MD code, but should it be in the archsw? */
305 void delay(int delay);
307 void dev_cleanup(void);
309 time_t time(time_t *tloc);