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