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
48 /* Commands and return values; nonzero return sets command_errmsg != NULL */
49 typedef int (bootblk_cmd_t)(int argc, char *argv[]);
50 extern char *command_errmsg;
51 extern char command_errbuf[]; /* XXX blah, length */
57 int include(const char *filename);
59 /* interp_backslash.c */
60 char *backslash(char *str);
63 int parse(int *argc, char ***argv, char *str);
67 int bf_run(char *line);
70 int autoboot(int timeout, char *prompt);
71 void autoboot_maybe(void);
72 int getrootmount(char *rootdev);
75 char *unargv(int argc, char *argv[]);
76 void hexdump(caddr_t region, size_t len);
77 size_t strlenout(vm_offset_t str);
78 char *strdupout(vm_offset_t str);
81 int bcache_init(u_int nblks, size_t bsize);
82 void bcache_flush(void);
83 int bcache_strategy(void *devdata, int unit, int rw, daddr_t blk,
84 size_t size, char *buf, size_t *rsize);
91 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, char *buf, size_t *rsize);
96 * Modular console support.
103 #define C_PRESENTIN (1<<0)
104 #define C_PRESENTOUT (1<<1)
105 #define C_ACTIVEIN (1<<2)
106 #define C_ACTIVEOUT (1<<3)
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 pnpinfo_stql pnp_devices;
147 extern struct pnphandler *pnphandlers[]; /* provided by MD code */
149 void pnp_addident(struct pnpinfo *pi, char *ident);
150 struct pnpinfo *pnp_allocinfo(void);
151 void pnp_freeinfo(struct pnpinfo *pi);
152 void pnp_addinfo(struct pnpinfo *pi);
153 char *pnp_eisaformat(u_int8_t *data);
156 * < 0 - No ISA in system
157 * == 0 - Maybe ISA, search for read data port
158 * > 0 - ISA in system, value is read data port address
160 extern int isapnp_readport;
163 * Preloaded file metadata header.
165 * Metadata are allocated on our heap, and copied into kernel space
166 * before executing the kernel.
172 struct file_metadata *md_next;
173 char md_data[1]; /* data are immediately appended */
176 struct preloaded_file;
181 char *m_name; /* module name */
182 int m_version; /* module version */
183 /* char *m_args;*/ /* arguments for the module */
184 struct preloaded_file *m_fp;
185 struct kernel_module *m_next;
189 * Preloaded file information. Depending on type, file can contain
190 * additional units called 'modules'.
192 * At least one file (the kernel) must be loaded in order to boot.
193 * The kernel is always loaded first.
195 * String fields (m_name, m_type) should be dynamically allocated.
197 struct preloaded_file
199 char *f_name; /* file name */
200 char *f_type; /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
201 char *f_args; /* arguments for the file */
202 struct file_metadata *f_metadata; /* metadata that will be placed in the module directory */
203 int f_loader; /* index of the loader that read the file */
204 vm_offset_t f_addr; /* load address */
205 size_t f_size; /* file size */
206 struct kernel_module *f_modules; /* list of modules if any */
207 struct preloaded_file *f_next; /* next file */
212 /* Load function must return EFTYPE if it can't handle the module supplied */
213 int (* l_load)(char *filename, vm_offset_t dest, struct preloaded_file **result);
214 /* Only a loader that will load a kernel (first module) should have an exec handler */
215 int (* l_exec)(struct preloaded_file *mp);
218 extern struct file_format *file_formats[]; /* supplied by consumer */
219 extern struct preloaded_file *preloaded_files;
221 int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
222 int mod_loadkld(const char *name, int argc, char *argv[]);
224 struct preloaded_file *file_alloc(void);
225 struct preloaded_file *file_findfile(char *name, char *type);
226 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
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);
233 /* MI module loaders */
234 int aout_loadfile(char *filename, vm_offset_t dest, struct preloaded_file **result);
235 vm_offset_t aout_findsym(char *name, struct preloaded_file *fp);
237 int elf_loadfile(char *filename, vm_offset_t dest, struct preloaded_file **result);
240 * Support for commands
242 struct bootblk_command
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)
254 SET_DECLARE(Xcommand_set, struct bootblk_command);
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.
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,
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,
274 /* Read from file to module address space, same semantics as read() */
275 ssize_t (*arch_readin)(const int fd, vm_offset_t dest,
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);
281 extern struct arch_switch archsw;
283 /* This must be provided by the MD code, but should it be in the archsw? */
284 void delay(int delay);
286 void dev_cleanup(void);
288 time_t time(time_t *tloc);