Fully synchronize sys/boot from FreeBSD-5.x, but add / to the module path
[dragonfly.git] / sys / boot / common / bootstrap.h
CommitLineData
984263bc
MD
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 *
5ee58eed
MD
26 * $FreeBSD: src/sys/boot/common/bootstrap.h,v 1.38 2003/05/01 03:56:29 peter Exp $
27 * $DragonFly: src/sys/boot/common/bootstrap.h,v 1.3 2003/11/10 06:08:31 dillon Exp $
984263bc
MD
28 */
29
30#include <sys/types.h>
31#include <sys/queue.h>
5ee58eed 32#include <sys/linker_set.h>
984263bc
MD
33
34/*
35 * Generic device specifier; architecture-dependant
36 * versions may be larger, but should be allowed to
37 * overlap.
38 */
39struct devdesc
40{
41 struct devsw *d_dev;
42 int d_type;
43#define DEVT_NONE 0
44#define DEVT_DISK 1
45#define DEVT_NET 2
46#define DEVT_CD 3
47};
48
49/* Commands and return values; nonzero return sets command_errmsg != NULL */
50typedef int (bootblk_cmd_t)(int argc, char *argv[]);
51extern char *command_errmsg;
52extern char command_errbuf[]; /* XXX blah, length */
53#define CMD_OK 0
54#define CMD_ERROR 1
55
56/* interp.c */
57void interact(void);
58int include(const char *filename);
59
60/* interp_backslash.c */
61char *backslash(char *str);
62
63/* interp_parse.c */
64int parse(int *argc, char ***argv, char *str);
65
66/* interp_forth.c */
67void bf_init(void);
68int bf_run(char *line);
69
70/* boot.c */
71int autoboot(int timeout, char *prompt);
72void autoboot_maybe(void);
73int getrootmount(char *rootdev);
74
75/* misc.c */
76char *unargv(int argc, char *argv[]);
77void hexdump(caddr_t region, size_t len);
78size_t strlenout(vm_offset_t str);
79char *strdupout(vm_offset_t str);
80
81/* bcache.c */
82int bcache_init(u_int nblks, size_t bsize);
83void bcache_flush(void);
84int bcache_strategy(void *devdata, int unit, int rw, daddr_t blk,
85 size_t size, char *buf, size_t *rsize);
86
87/*
88 * Disk block cache
89 */
90struct bcache_devdata
91{
92 int (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, char *buf, size_t *rsize);
93 void *dv_devdata;
94};
95
96/*
97 * Modular console support.
98 */
99struct console
100{
101 const char *c_name;
102 const char *c_desc;
103 int c_flags;
104#define C_PRESENTIN (1<<0)
105#define C_PRESENTOUT (1<<1)
106#define C_ACTIVEIN (1<<2)
107#define C_ACTIVEOUT (1<<3)
108 void (* c_probe)(struct console *cp); /* set c_flags to match hardware */
109 int (* c_init)(int arg); /* reinit XXX may need more args */
110 void (* c_out)(int c); /* emit c */
111 int (* c_in)(void); /* wait for and return input */
112 int (* c_ready)(void); /* return nonzer if input waiting */
113};
114extern struct console *consoles[];
115void cons_probe(void);
116
117/*
118 * Plug-and-play enumerator/configurator interface.
119 */
120struct pnphandler
121{
122 const char *pp_name; /* handler/bus name */
123 void (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
124};
125
126struct pnpident
127{
128 char *id_ident; /* ASCII identifier, actual format varies with bus/handler */
129 STAILQ_ENTRY(pnpident) id_link;
130};
131
132struct pnpinfo
133{
134 char *pi_desc; /* ASCII description, optional */
135 int pi_revision; /* optional revision (or -1) if not supported */
136 char *pi_module; /* module/args nominated to handle device */
137 int pi_argc; /* module arguments */
138 char **pi_argv;
139 struct pnphandler *pi_handler; /* handler which detected this device */
140 STAILQ_HEAD(,pnpident) pi_ident; /* list of identifiers */
141 STAILQ_ENTRY(pnpinfo) pi_link;
142};
143
5ee58eed
MD
144STAILQ_HEAD(pnpinfo_stql, pnpinfo);
145
146extern struct pnpinfo_stql pnp_devices;
147
984263bc
MD
148extern struct pnphandler *pnphandlers[]; /* provided by MD code */
149
150void pnp_addident(struct pnpinfo *pi, char *ident);
151struct pnpinfo *pnp_allocinfo(void);
152void pnp_freeinfo(struct pnpinfo *pi);
153void pnp_addinfo(struct pnpinfo *pi);
154char *pnp_eisaformat(u_int8_t *data);
155
156/*
157 * < 0 - No ISA in system
158 * == 0 - Maybe ISA, search for read data port
159 * > 0 - ISA in system, value is read data port address
160 */
161extern int isapnp_readport;
162
163/*
5ee58eed 164 * Preloaded file metadata header.
984263bc
MD
165 *
166 * Metadata are allocated on our heap, and copied into kernel space
167 * before executing the kernel.
168 */
5ee58eed 169struct file_metadata
984263bc
MD
170{
171 size_t md_size;
172 u_int16_t md_type;
5ee58eed
MD
173 struct file_metadata *md_next;
174 char md_data[1]; /* data are immediately appended */
175};
176
177struct preloaded_file;
178struct mod_depend;
179
180struct kernel_module
181{
182 char *m_name; /* module name */
183 int m_version; /* module version */
184/* char *m_args;*/ /* arguments for the module */
185 struct preloaded_file *m_fp;
186 struct kernel_module *m_next;
984263bc
MD
187};
188
189/*
5ee58eed
MD
190 * Preloaded file information. Depending on type, file can contain
191 * additional units called 'modules'.
984263bc 192 *
5ee58eed 193 * At least one file (the kernel) must be loaded in order to boot.
984263bc
MD
194 * The kernel is always loaded first.
195 *
196 * String fields (m_name, m_type) should be dynamically allocated.
197 */
5ee58eed 198struct preloaded_file
984263bc 199{
5ee58eed
MD
200 char *f_name; /* file name */
201 char *f_type; /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
202 char *f_args; /* arguments for the file */
203 struct file_metadata *f_metadata; /* metadata that will be placed in the module directory */
204 int f_loader; /* index of the loader that read the file */
205 vm_offset_t f_addr; /* load address */
206 size_t f_size; /* file size */
207 struct kernel_module *f_modules; /* list of modules if any */
208 struct preloaded_file *f_next; /* next file */
984263bc
MD
209};
210
5ee58eed 211struct file_format
984263bc
MD
212{
213 /* Load function must return EFTYPE if it can't handle the module supplied */
5ee58eed 214 int (* l_load)(char *filename, u_int64_t dest, struct preloaded_file **result);
984263bc 215 /* Only a loader that will load a kernel (first module) should have an exec handler */
5ee58eed 216 int (* l_exec)(struct preloaded_file *mp);
984263bc 217};
984263bc 218
5ee58eed
MD
219extern struct file_format *file_formats[]; /* supplied by consumer */
220extern struct preloaded_file *preloaded_files;
984263bc 221
5ee58eed
MD
222int mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
223int mod_loadkld(const char *name, int argc, char *argv[]);
984263bc 224
5ee58eed
MD
225struct preloaded_file *file_alloc(void);
226struct preloaded_file *file_findfile(char *name, char *type);
227struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
228void file_discard(struct preloaded_file *fp);
229void file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p);
230int file_addmodule(struct preloaded_file *fp, char *modname, int version,
231 struct kernel_module **newmp);
984263bc 232
984263bc 233
5ee58eed
MD
234/* MI module loaders */
235#ifdef __elfN
236int __elfN(loadfile)(char *filename, u_int64_t dest, struct preloaded_file **result);
984263bc
MD
237#endif
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
5ee58eed 254SET_DECLARE(Xcommand_set, struct bootblk_command);
984263bc
MD
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);
5ee58eed
MD
287
288time_t time(time_t *tloc);