usr/src/boot/sys/boot/common/bootstrap.h

   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  *
  26  * $FreeBSD$
  27  */
  28
  29 #ifndef _BOOTSTRAP_H_
  30 #define _BOOTSTRAP_H_
  31
  32 #include <sys/types.h>
  33 #include <sys/queue.h>
  34 #include <sys/linker_set.h>
  35
  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 const char       *command_errmsg;
  40 extern char     command_errbuf[COMMAND_ERRBUFSZ];
  41 #define CMD_OK          0
  42 #define CMD_WARN        1
  43 #define CMD_ERROR       2
  44 #define CMD_CRIT        3
  45 #define CMD_FATAL       4
  46
  47 /* interp.c */
  48 void    interact(const char *rc);
  49 int     include(const char *filename);
  50
  51 /* interp_backslash.c */
  52 char    *backslash(char *str);
  53
  54 /* interp_parse.c */
  55 int     parse(int *argc, char ***argv, char *str);
  56
  57 /* interp_forth.c */
  58 void    bf_init(char *rc);
  59 int     bf_run(char *line);
  60
  61 /* boot.c */
  62 int     autoboot(int timeout, char *prompt);
  63 void    autoboot_maybe(void);
  64 int     getrootmount(char *rootdev);
  65
  66 /* misc.c */
  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);
  74
  75 /* bcache.c */
  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,
  81     size_t offset, size_t size, char *buf, size_t *rsize);
  82
  83 /*
  84  * Disk block cache
  85  */
  86 struct bcache_devdata
  87 {
  88     int         (*dv_strategy)(void *devdata, int rw, daddr_t blk,
  89                     size_t offset, size_t size, char *buf, size_t *rsize);
  90     void        *dv_devdata;
  91     void        *dv_cache;
  92 };
  93
  94 /*
  95  * Modular console support.
  96  */
  97 struct console
  98 {
  99     const char  *c_name;
 100     const char  *c_desc;
 101     int         c_flags;
 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_MODERAW       (1<<4)      /* raw mode */
 107     void        (*c_probe)(struct console *);   /* set c_flags to match hardware */
 108     int         (*c_init)(struct console *, int);       /* reinit XXX may need more args */
 109     void        (*c_out)(struct console *, int);        /* emit c */
 110     int         (*c_in)(struct console *);      /* wait for and return input */
 111     int         (*c_ready)(struct console *);   /* return nonzer if input waiting */
 112     void        *private;               /* private data */
 113 };
 114 extern struct console   *consoles[];
 115 void            cons_probe(void);
 116 void            cons_mode(int);
 117
 118 /*
 119  * Plug-and-play enumerator/configurator interface.
 120  */
 121 struct pnphandler
 122 {
 123     const char  *pp_name;               /* handler/bus name */
 124     void        (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
 125 };
 126
 127 struct pnpident
 128 {
 129     char                        *id_ident;      /* ASCII identifier, actual format varies with bus/handler */
 130     STAILQ_ENTRY(pnpident)      id_link;
 131 };
 132
 133 struct pnpinfo
 134 {
 135     char                        *pi_desc;       /* ASCII description, optional */
 136     int                         pi_revision;    /* optional revision (or -1) if not supported */
 137     char                        *pi_module;     /* module/args nominated to handle device */
 138     int                         pi_argc;        /* module arguments */
 139     char                        **pi_argv;
 140     struct pnphandler           *pi_handler;    /* handler which detected this device */
 141     STAILQ_HEAD(,pnpident)      pi_ident;       /* list of identifiers */
 142     STAILQ_ENTRY(pnpinfo)       pi_link;
 143 };
 144
 145 STAILQ_HEAD(pnpinfo_stql, pnpinfo);
 146
 147 extern struct pnpinfo_stql pnp_devices;
 148
 149 extern struct pnphandler        *pnphandlers[];         /* provided by MD code */
 150
 151 void                    pnp_addident(struct pnpinfo *pi, char *ident);
 152 struct pnpinfo          *pnp_allocinfo(void);
 153 void                    pnp_freeinfo(struct pnpinfo *pi);
 154 void                    pnp_addinfo(struct pnpinfo *pi);
 155 char                    *pnp_eisaformat(u_int8_t *data);
 156
 157 /*
 158  *  < 0 - No ISA in system
 159  * == 0 - Maybe ISA, search for read data port
 160  *  > 0 - ISA in system, value is read data port address
 161  */
 162 extern int                      isapnp_readport;
 163
 164 /*
 165  * Preloaded file metadata header.
 166  *
 167  * Metadata are allocated on our heap, and copied into kernel space
 168  * before executing the kernel.
 169  */
 170 struct file_metadata
 171 {
 172     size_t                      md_size;
 173     u_int16_t                   md_type;
 174     struct file_metadata        *md_next;
 175     char                        md_data[1];     /* data are immediately appended */
 176 };
 177
 178 struct preloaded_file;
 179 struct mod_depend;
 180
 181 struct kernel_module
 182 {
 183     char                        *m_name;        /* module name */
 184     int                         m_version;      /* module version */
 185     char                        *m_args;        /* arguments for the module */
 186     struct preloaded_file       *m_fp;
 187     struct kernel_module        *m_next;
 188 };
 189
 190 /*
 191  * Preloaded file information. Depending on type, file can contain
 192  * additional units called 'modules'.
 193  *
 194  * At least one file (the kernel) must be loaded in order to boot.
 195  * The kernel is always loaded first.
 196  *
 197  * String fields (m_name, m_type) should be dynamically allocated.
 198  */
 199 struct preloaded_file
 200 {
 201     char                        *f_name;        /* file name */
 202     char                        *f_type;        /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
 203     char                        *f_args;        /* arguments for the file */
 204     struct file_metadata        *f_metadata;    /* metadata that will be placed in the module directory */
 205     int                         f_loader;       /* index of the loader that read the file */
 206     vm_offset_t                 f_addr;         /* load address */
 207     size_t                      f_size;         /* file size */
 208     struct kernel_module        *f_modules;     /* list of modules if any */
 209     struct preloaded_file       *f_next;        /* next file */
 210 };
 211
 212 struct file_format
 213 {
 214     /* Load function must return EFTYPE if it can't handle the module supplied */
 215     int         (* l_load)(char *filename, u_int64_t dest, struct preloaded_file **result);
 216     /* Only a loader that will load a kernel (first module) should have an exec handler */
 217     int         (* l_exec)(struct preloaded_file *mp);
 218 };
 219
 220 extern struct file_format       *file_formats[];        /* supplied by consumer */
 221 extern struct preloaded_file    *preloaded_files;
 222
 223 int                     mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
 224 int                     mod_loadkld(const char *name, int argc, char *argv[]);
 225 void                    unload(void);
 226
 227 struct preloaded_file *file_alloc(void);
 228 struct preloaded_file *file_findfile(const char *name, const char *type);
 229 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
 230 struct preloaded_file *file_loadraw(const char *name, char *type, int argc,
 231         char **argv, int insert);
 232 void file_discard(struct preloaded_file *fp);
 233 void file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p);
 234 int  file_addmodule(struct preloaded_file *fp, char *modname, int version,
 235         struct kernel_module **newmp);
 236
 237 /* MI module loaders */
 238 #ifdef __elfN
 239 /* Relocation types. */
 240 #define ELF_RELOC_REL   1
 241 #define ELF_RELOC_RELA  2
 242
 243 /* Relocation offset for some architectures */
 244 extern u_int64_t __elfN(relocation_offset);
 245
 246 struct elf_file;
 247 typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx);
 248
 249 int     __elfN(loadfile)(char *filename, u_int64_t dest, struct preloaded_file **result);
 250 int     __elfN(obj_loadfile)(char *filename, u_int64_t dest,
 251             struct preloaded_file **result);
 252 int     __elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr,
 253             const void *reldata, int reltype, Elf_Addr relbase,
 254             Elf_Addr dataaddr, void *data, size_t len);
 255 int __elfN(loadfile_raw)(char *filename, u_int64_t dest,
 256             struct preloaded_file **result, int multiboot);
 257 int __elfN(load_modmetadata)(struct preloaded_file *fp, u_int64_t dest);
 258 #endif
 259
 260 /*
 261  * Support for commands
 262  */
 263 struct bootblk_command
 264 {
 265     const char          *c_name;
 266     const char          *c_desc;
 267     bootblk_cmd_t       *c_fn;
 268 };
 269
 270 #define COMMAND_SET(tag, key, desc, func)                               \
 271     static bootblk_cmd_t func;                                          \
 272     static struct bootblk_command _cmd_ ## tag = { key, desc, func };   \
 273     DATA_SET(Xcommand_set, _cmd_ ## tag)
 274
 275 SET_DECLARE(Xcommand_set, struct bootblk_command);
 276
 277 /*
 278  * The intention of the architecture switch is to provide a convenient
 279  * encapsulation of the interface between the bootstrap MI and MD code.
 280  * MD code may selectively populate the switch at runtime based on the
 281  * actual configuration of the target system.
 282  */
 283 struct arch_switch
 284 {
 285     /* Automatically load modules as required by detected hardware */
 286     int         (*arch_autoload)(void);
 287     /* Locate the device for (name), return pointer to tail in (*path) */
 288     int         (*arch_getdev)(void **dev, const char *name, const char **path);
 289     /* Copy from local address space to module address space, similar to bcopy() */
 290     ssize_t     (*arch_copyin)(const void *src, vm_offset_t dest,
 291                                const size_t len);
 292     /* Copy to local address space from module address space, similar to bcopy() */
 293     ssize_t     (*arch_copyout)(const vm_offset_t src, void *dest,
 294                                 const size_t len);
 295     /* Read from file to module address space, same semantics as read() */
 296     ssize_t     (*arch_readin)(const int fd, vm_offset_t dest,
 297                                const size_t len);
 298     /* Perform ISA byte port I/O (only for systems with ISA) */
 299     int         (*arch_isainb)(int port);
 300     void        (*arch_isaoutb)(int port, int value);
 301
 302     /*
 303      * Interface to adjust the load address according to the "object"
 304      * being loaded.
 305      */
 306     uint64_t    (*arch_loadaddr)(u_int type, void *data, uint64_t addr);
 307 #define LOAD_ELF        1       /* data points to the ELF header. */
 308 #define LOAD_RAW        2       /* data points to the file name. */
 309
 310     /*
 311      * Interface to inform MD code about a loaded (ELF) segment. This
 312      * can be used to flush caches and/or set up translations.
 313      */
 314 #ifdef __elfN
 315     void        (*arch_loadseg)(Elf_Ehdr *eh, Elf_Phdr *ph, uint64_t delta);
 316 #else
 317     void        (*arch_loadseg)(void *eh, void *ph, uint64_t delta);
 318 #endif
 319
 320     /* Probe ZFS pool(s), if needed. */
 321     void        (*arch_zfs_probe)(void);
 322 };
 323 extern struct arch_switch archsw;
 324
 325 /* This must be provided by the MD code, but should it be in the archsw? */
 326 void    delay(int delay);
 327
 328 void    dev_cleanup(void);
 329
 330 #ifndef CTASSERT                /* Allow lint to override */
 331 #define CTASSERT(x)             _CTASSERT(x, __LINE__)
 332 #define _CTASSERT(x, y)         __CTASSERT(x, y)
 333 #define __CTASSERT(x, y)        typedef char __assert ## y[(x) ? 1 : -1]
 334 #endif
 335
 336 #endif /* !_BOOTSTRAP_H_ */