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 #include <sys/types.h>
  30 #include <sys/queue.h>
  31 #include <sys/linker_set.h>
  32
  33 /*
  34  * Generic device specifier; architecture-dependant
  35  * versions may be larger, but should be allowed to
  36  * overlap.
  37  */
  38 struct devdesc
  39 {
  40     struct devsw        *d_dev;
  41     int                 d_type;
  42 #define DEVT_NONE       0
  43 #define DEVT_DISK       1
  44 #define DEVT_NET        2
  45 #define DEVT_CD         3
  46 };
  47
  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 */
  52 #define CMD_OK          0
  53 #define CMD_ERROR       1
  54
  55 /* interp.c */
  56 void    interact(void);
  57 int     include(const char *filename);
  58
  59 /* interp_backslash.c */
  60 char    *backslash(char *str);
  61
  62 /* interp_parse.c */
  63 int     parse(int *argc, char ***argv, char *str);
  64
  65 /* interp_forth.c */
  66 void    bf_init(void);
  67 int     bf_run(char *line);
  68
  69 /* boot.c */
  70 int     autoboot(int timeout, char *prompt);
  71 void    autoboot_maybe(void);
  72 int     getrootmount(char *rootdev);
  73
  74 /* misc.c */
  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);
  79 void    kern_bzero(vm_offset_t dest, size_t len);
  80 int     kern_pread(int fd, vm_offset_t dest, size_t len, off_t off);
  81 void    *alloc_pread(int fd, off_t off, size_t len);
  82
  83 /* bcache.c */
  84 int     bcache_init(u_int nblks, size_t bsize);
  85 void    bcache_flush(void);
  86 int     bcache_strategy(void *devdata, int unit, int rw, daddr_t blk,
  87                         size_t size, char *buf, size_t *rsize);
  88
  89 /*
  90  * Disk block cache
  91  */
  92 struct bcache_devdata
  93 {
  94     int         (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, char *buf, size_t *rsize);
  95     void        *dv_devdata;
  96 };
  97
  98 /*
  99  * Modular console support.
 100  */
 101 struct console
 102 {
 103     const char  *c_name;
 104     const char  *c_desc;
 105     int         c_flags;
 106 #define C_PRESENTIN     (1<<0)
 107 #define C_PRESENTOUT    (1<<1)
 108 #define C_ACTIVEIN      (1<<2)
 109 #define C_ACTIVEOUT     (1<<3)
 110     void        (* c_probe)(struct console *cp);        /* set c_flags to match hardware */
 111     int         (* c_init)(int arg);                    /* reinit XXX may need more args */
 112     void        (* c_out)(int c);                       /* emit c */
 113     int         (* c_in)(void);                         /* wait for and return input */
 114     int         (* c_ready)(void);                      /* return nonzer if input waiting */
 115 };
 116 extern struct console   *consoles[];
 117 void            cons_probe(void);
 118
 119 /*
 120  * Plug-and-play enumerator/configurator interface.
 121  */
 122 struct pnphandler
 123 {
 124     const char  *pp_name;               /* handler/bus name */
 125     void        (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
 126 };
 127
 128 struct pnpident
 129 {
 130     char                        *id_ident;      /* ASCII identifier, actual format varies with bus/handler */
 131     STAILQ_ENTRY(pnpident)      id_link;
 132 };
 133
 134 struct pnpinfo
 135 {
 136     char                        *pi_desc;       /* ASCII description, optional */
 137     int                         pi_revision;    /* optional revision (or -1) if not supported */
 138     char                        *pi_module;     /* module/args nominated to handle device */
 139     int                         pi_argc;        /* module arguments */
 140     char                        **pi_argv;
 141     struct pnphandler           *pi_handler;    /* handler which detected this device */
 142     STAILQ_HEAD(,pnpident)      pi_ident;       /* list of identifiers */
 143     STAILQ_ENTRY(pnpinfo)       pi_link;
 144 };
 145
 146 STAILQ_HEAD(pnpinfo_stql, pnpinfo);
 147
 148 extern struct pnpinfo_stql pnp_devices;
 149
 150 extern struct pnphandler        *pnphandlers[];         /* provided by MD code */
 151
 152 void                    pnp_addident(struct pnpinfo *pi, char *ident);
 153 struct pnpinfo          *pnp_allocinfo(void);
 154 void                    pnp_freeinfo(struct pnpinfo *pi);
 155 void                    pnp_addinfo(struct pnpinfo *pi);
 156 char                    *pnp_eisaformat(u_int8_t *data);
 157
 158 /*
 159  *  < 0 - No ISA in system
 160  * == 0 - Maybe ISA, search for read data port
 161  *  > 0 - ISA in system, value is read data port address
 162  */
 163 extern int                      isapnp_readport;
 164
 165 /*
 166  * Preloaded file metadata header.
 167  *
 168  * Metadata are allocated on our heap, and copied into kernel space
 169  * before executing the kernel.
 170  */
 171 struct file_metadata
 172 {
 173     size_t                      md_size;
 174     u_int16_t                   md_type;
 175     struct file_metadata        *md_next;
 176     char                        md_data[1];     /* data are immediately appended */
 177 };
 178
 179 struct preloaded_file;
 180 struct mod_depend;
 181
 182 struct kernel_module
 183 {
 184     char                        *m_name;        /* module name */
 185     int                         m_version;      /* module version */
 186 /*    char                      *m_args;*/      /* arguments for the module */
 187     struct preloaded_file       *m_fp;
 188     struct kernel_module        *m_next;
 189 };
 190
 191 /*
 192  * Preloaded file information. Depending on type, file can contain
 193  * additional units called 'modules'.
 194  *
 195  * At least one file (the kernel) must be loaded in order to boot.
 196  * The kernel is always loaded first.
 197  *
 198  * String fields (m_name, m_type) should be dynamically allocated.
 199  */
 200 struct preloaded_file
 201 {
 202     char                        *f_name;        /* file name */
 203     char                        *f_type;        /* verbose file type, eg 'ELF kernel', 'pnptable', etc. */
 204     char                        *f_args;        /* arguments for the file */
 205     struct file_metadata        *f_metadata;    /* metadata that will be placed in the module directory */
 206     int                         f_loader;       /* index of the loader that read the file */
 207     vm_offset_t                 f_addr;         /* load address */
 208     size_t                      f_size;         /* file size */
 209     struct kernel_module        *f_modules;     /* list of modules if any */
 210     struct preloaded_file       *f_next;        /* next file */
 211 };
 212
 213 struct file_format
 214 {
 215     /* Load function must return EFTYPE if it can't handle the module supplied */
 216     int         (* l_load)(char *filename, u_int64_t dest, struct preloaded_file **result);
 217     /* Only a loader that will load a kernel (first module) should have an exec handler */
 218     int         (* l_exec)(struct preloaded_file *mp);
 219 };
 220
 221 extern struct file_format       *file_formats[];        /* supplied by consumer */
 222 extern struct preloaded_file    *preloaded_files;
 223
 224 int                     mod_load(char *name, struct mod_depend *verinfo, int argc, char *argv[]);
 225 int                     mod_loadkld(const char *name, int argc, char *argv[]);
 226
 227 struct preloaded_file *file_alloc(void);
 228 struct preloaded_file *file_findfile(char *name, char *type);
 229 struct file_metadata *file_findmetadata(struct preloaded_file *fp, int type);
 230 void file_discard(struct preloaded_file *fp);
 231 void file_addmetadata(struct preloaded_file *fp, int type, size_t size, void *p);
 232 int  file_addmodule(struct preloaded_file *fp, char *modname, int version,
 233         struct kernel_module **newmp);
 234
 235
 236 /* MI module loaders */
 237 #ifdef __elfN
 238 /* Relocation types. */
 239 #define ELF_RELOC_REL   1
 240 #define ELF_RELOC_RELA  2
 241
 242 struct elf_file;
 243 typedef Elf_Addr (symaddr_fn)(struct elf_file *ef, Elf_Size symidx);
 244
 245 int     __elfN(loadfile)(char *filename, u_int64_t dest, struct preloaded_file **result);
 246 int     __elfN(obj_loadfile)(char *filename, u_int64_t dest,
 247             struct preloaded_file **result);
 248 int     __elfN(reloc)(struct elf_file *ef, symaddr_fn *symaddr,
 249             const void *reldata, int reltype, Elf_Addr relbase,
 250             Elf_Addr dataaddr, void *data, size_t len);
 251 #endif
 252
 253 /*
 254  * Support for commands
 255  */
 256 struct bootblk_command
 257 {
 258     const char          *c_name;
 259     const char          *c_desc;
 260     bootblk_cmd_t       *c_fn;
 261 };
 262
 263 #define COMMAND_SET(tag, key, desc, func)                               \
 264     static bootblk_cmd_t func;                                          \
 265     static struct bootblk_command _cmd_ ## tag = { key, desc, func };   \
 266     DATA_SET(Xcommand_set, _cmd_ ## tag)
 267
 268 SET_DECLARE(Xcommand_set, struct bootblk_command);
 269
 270 /*
 271  * The intention of the architecture switch is to provide a convenient
 272  * encapsulation of the interface between the bootstrap MI and MD code.
 273  * MD code may selectively populate the switch at runtime based on the
 274  * actual configuration of the target system.
 275  */
 276 struct arch_switch
 277 {
 278     /* Automatically load modules as required by detected hardware */
 279     int         (*arch_autoload)(void);
 280     /* Locate the device for (name), return pointer to tail in (*path) */
 281     int         (*arch_getdev)(void **dev, const char *name, const char **path);
 282     /* Copy from local address space to module address space, similar to bcopy() */
 283     ssize_t     (*arch_copyin)(const void *src, vm_offset_t dest,
 284                                const size_t len);
 285     /* Copy to local address space from module address space, similar to bcopy() */
 286     ssize_t     (*arch_copyout)(const vm_offset_t src, void *dest,
 287                                 const size_t len);
 288     /* Read from file to module address space, same semantics as read() */
 289     ssize_t     (*arch_readin)(const int fd, vm_offset_t dest,
 290                                const size_t len);
 291     /* Perform ISA byte port I/O (only for systems with ISA) */
 292     int         (*arch_isainb)(int port);
 293     void        (*arch_isaoutb)(int port, int value);
 294 };
 295 extern struct arch_switch archsw;
 296
 297 /* This must be provided by the MD code, but should it be in the archsw? */
 298 void    delay(int delay);
 299
 300 void    dev_cleanup(void);
 301
 302 time_t  time(time_t *tloc);