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
26 * $FreeBSD: src/sys/boot/common/bootstrap.h,v 1.38 2003/05/01 03:56:29 peter Exp $
29 #include <sys/types.h>
30 #include <sys/queue.h>
31 #include <sys/linker_set.h>
36 * Generic device specifier; architecture-dependant
37 * versions may be larger, but should be allowed to
50 /* Commands and return values; nonzero return sets command_errmsg != NULL */
51 typedef int (bootblk_cmd_t
)(int argc
, char *argv
[]);
52 #define COMMAND_ERRBUFSZ (256)
53 extern char *command_errmsg
;
54 extern char command_errbuf
[COMMAND_ERRBUFSZ
];
55 extern int CurrentCondition
;
61 int include(const char *filename
);
63 /* interp_backslash.c */
64 char *backslash(char *str
);
67 int parse(int *argc
, char ***argv
, char *str
);
71 int bf_run(char *line
);
74 int autoboot(int timeout
, char *prompt
);
75 void autoboot_maybe(void);
76 int getrootmount(char *rootdev
);
77 int rel_open(const char *path
, char **abspathp
, int flags
);
78 int rel_stat(const char *path
, struct stat
*st
);
79 int chdir(const char *path
);
82 char *unargv(int argc
, char *argv
[]);
83 void hexdump(caddr_t region
, size_t len
);
84 size_t strlenout(vm_offset_t str
);
85 char *strdupout(vm_offset_t str
);
86 void kern_bzero(vm_offset_t dest
, size_t len
);
87 int kern_pread(int fd
, vm_offset_t dest
, size_t len
, off_t off
);
88 void *alloc_pread(int fd
, off_t off
, size_t len
);
91 int bcache_init(u_int nblks
, size_t bsize
);
92 void bcache_flush(void);
93 int bcache_strategy(void *devdata
, int unit
, int rw
, daddr_t blk
,
94 size_t size
, char *buf
, size_t *rsize
);
96 void slowprint(char c
);
101 struct bcache_devdata
103 int (*dv_strategy
)(void *devdata
, int rw
, daddr_t blk
, size_t size
, char *buf
, size_t *rsize
);
108 * Modular console support.
115 #define C_PRESENTIN (1<<0)
116 #define C_PRESENTOUT (1<<1)
117 #define C_ACTIVEIN (1<<2)
118 #define C_ACTIVEOUT (1<<3)
119 void (* c_probe
)(struct console
*cp
); /* set c_flags to match hardware */
120 int (* c_init
)(int arg
); /* reinit XXX may need more args */
121 void (* c_out
)(int c
); /* emit c */
122 int (* c_in
)(void); /* wait for and return input */
123 int (* c_ready
)(void); /* return nonzer if input waiting */
125 extern struct console
*consoles
[];
126 void cons_probe(void);
129 * Plug-and-play enumerator/configurator interface.
133 const char *pp_name
; /* handler/bus name */
134 void (* pp_enumerate
)(void); /* enumerate PnP devices, add to chain */
139 char *id_ident
; /* ASCII identifier, actual format varies with bus/handler */
140 STAILQ_ENTRY(pnpident
) id_link
;
145 char *pi_desc
; /* ASCII description, optional */
146 int pi_revision
; /* optional revision (or -1) if not supported */
147 char *pi_module
; /* module/args nominated to handle device */
148 int pi_argc
; /* module arguments */
150 struct pnphandler
*pi_handler
; /* handler which detected this device */
151 STAILQ_HEAD(,pnpident
) pi_ident
; /* list of identifiers */
152 STAILQ_ENTRY(pnpinfo
) pi_link
;
155 STAILQ_HEAD(pnpinfo_stql
, pnpinfo
);
157 extern struct pnpinfo_stql pnp_devices
;
159 extern struct pnphandler
*pnphandlers
[]; /* provided by MD code */
161 void pnp_addident(struct pnpinfo
*pi
, char *ident
);
162 struct pnpinfo
*pnp_allocinfo(void);
163 void pnp_freeinfo(struct pnpinfo
*pi
);
164 void pnp_addinfo(struct pnpinfo
*pi
);
165 char *pnp_eisaformat(u_int8_t
*data
);
168 * < 0 - No ISA in system
169 * == 0 - Maybe ISA, search for read data port
170 * > 0 - ISA in system, value is read data port address
172 extern int isapnp_readport
;
175 * Preloaded file metadata header.
177 * Metadata are allocated on our heap, and copied into kernel space
178 * before executing the kernel.
184 struct file_metadata
*md_next
;
185 char md_data
[1]; /* data are immediately appended */
188 struct preloaded_file
;
193 char *m_name
; /* module name */
194 int m_version
; /* module version */
195 /* char *m_args;*/ /* arguments for the module */
196 struct preloaded_file
*m_fp
;
197 struct kernel_module
*m_next
;
201 * Preloaded file information. Depending on type, file can contain
202 * additional units called 'modules'.
204 * At least one file (the kernel) must be loaded in order to boot.
205 * The kernel is always loaded first.
207 * String fields (m_name, m_type) should be dynamically allocated.
209 struct preloaded_file
211 char *f_name
; /* file name */
212 char *f_type
; /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
213 char *f_args
; /* arguments for the file */
214 struct file_metadata
*f_metadata
; /* metadata that will be placed in the module directory */
215 int f_loader
; /* index of the loader that read the file */
216 vm_offset_t f_addr
; /* load address */
217 size_t f_size
; /* file size */
218 struct kernel_module
*f_modules
; /* list of modules if any */
219 struct preloaded_file
*f_next
; /* next file */
224 /* Load function must return EFTYPE if it can't handle the module supplied */
225 int (* l_load
)(char *filename
, u_int64_t dest
, struct preloaded_file
**result
);
226 /* Only a loader that will load a kernel (first module) should have an exec handler */
227 int (* l_exec
)(struct preloaded_file
*mp
);
230 extern struct file_format
*file_formats
[]; /* supplied by consumer */
231 extern struct preloaded_file
*preloaded_files
;
233 int mod_load(char *name
, struct mod_depend
*verinfo
, int argc
, char *argv
[]);
234 int mod_loadkld(const char *name
, int argc
, char *argv
[]);
236 struct preloaded_file
*file_alloc(void);
237 struct preloaded_file
*file_findfile(char *name
, char *type
);
238 struct file_metadata
*file_findmetadata(struct preloaded_file
*fp
, int type
);
239 void file_discard(struct preloaded_file
*fp
);
240 void file_addmetadata(struct preloaded_file
*fp
, int type
, size_t size
, void *p
);
241 int file_addmodule(struct preloaded_file
*fp
, char *modname
, int version
,
242 struct kernel_module
**newmp
);
245 /* MI module loaders */
247 /* Relocation types. */
248 #define ELF_RELOC_REL 1
249 #define ELF_RELOC_RELA 2
251 /* Relocation offset for some architectures */
252 extern u_int64_t
__elfN(relocation_offset
);
255 typedef Elf_Addr (symaddr_fn
)(struct elf_file
*ef
, Elf_Size symidx
);
257 int __elfN(loadfile
)(char *filename
, u_int64_t dest
, struct preloaded_file
**result
);
258 int __elfN(obj_loadfile
)(char *filename
, u_int64_t dest
,
259 struct preloaded_file
**result
);
260 int __elfN(reloc
)(struct elf_file
*ef
, symaddr_fn
*symaddr
,
261 const void *reldata
, int reltype
, Elf_Addr relbase
,
262 Elf_Addr dataaddr
, void *data
, size_t len
);
266 * Support for commands
268 struct bootblk_command
276 #define COMMAND_SET(tag, key, desc, func) \
277 static bootblk_cmd_t func; \
278 static struct bootblk_command _cmd_ ## tag = { key, desc, func, 0 };\
279 DATA_SET(Xcommand_set, _cmd_ ## tag)
281 #define COMMAND_SET_COND(tag, key, desc, func) \
282 static bootblk_cmd_t func; \
283 static struct bootblk_command _cmd_ ## tag = { key, desc, func, 1 };\
284 DATA_SET(Xcommand_set, _cmd_ ## tag)
286 SET_DECLARE(Xcommand_set
, struct bootblk_command
);
289 * The intention of the architecture switch is to provide a convenient
290 * encapsulation of the interface between the bootstrap MI and MD code.
291 * MD code may selectively populate the switch at runtime based on the
292 * actual configuration of the target system.
296 /* Automatically load modules as required by detected hardware */
297 int (*arch_autoload
)(void);
298 /* Locate the device for (name), return pointer to tail in (*path) */
299 int (*arch_getdev
)(void **dev
, const char *name
, const char **path
);
300 /* Copy from local address space to module address space, similar to bcopy() */
301 ssize_t (*arch_copyin
)(const void *src
, vm_offset_t dest
,
303 /* Copy to local address space from module address space, similar to bcopy() */
304 ssize_t (*arch_copyout
)(const vm_offset_t src
, void *dest
,
306 /* Read from file to module address space, same semantics as read() */
307 ssize_t (*arch_readin
)(const int fd
, vm_offset_t dest
,
309 /* Perform ISA byte port I/O (only for systems with ISA) */
310 int (*arch_isainb
)(int port
);
311 void (*arch_isaoutb
)(int port
, int value
);
313 extern struct arch_switch archsw
;
315 /* This must be provided by the MD code, but should it be in the archsw? */
316 void delay(int delay
);
318 void dev_cleanup(void);
320 time_t time(time_t *tloc
);