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