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