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: src/sys/boot/common/bootstrap.h,v 1.24.2.4 2001/12/21 22:19:13 jhb Exp $
  27  */
  28
  29 #include <sys/types.h>
  30 #include <sys/queue.h>
  31
  32 /*
  33  * Generic device specifier; architecture-dependant
  34  * versions may be larger, but should be allowed to
  35  * overlap.
  36  */
  37 struct devdesc
  38 {
  39     struct devsw        *d_dev;
  40     int                 d_type;
  41 #define DEVT_NONE       0
  42 #define DEVT_DISK       1
  43 #define DEVT_NET        2
  44 #define DEVT_CD         3
  45 };
  46
  47 /* Commands and return values; nonzero return sets command_errmsg != NULL */
  48 typedef int     (bootblk_cmd_t)(int argc, char *argv[]);
  49 extern char     *command_errmsg;
  50 extern char     command_errbuf[];       /* XXX blah, length */
  51 #define CMD_OK          0
  52 #define CMD_ERROR       1
  53
  54 /* interp.c */
  55 void    interact(void);
  56 int     include(const char *filename);
  57
  58 /* interp_backslash.c */
  59 char    *backslash(char *str);
  60
  61 /* interp_parse.c */
  62 int     parse(int *argc, char ***argv, char *str);
  63
  64 /* interp_forth.c */
  65 void    bf_init(void);
  66 int     bf_run(char *line);
  67
  68 /* boot.c */
  69 int     autoboot(int timeout, char *prompt);
  70 void    autoboot_maybe(void);
  71 int     getrootmount(char *rootdev);
  72
  73 /* misc.c */
  74 char    *unargv(int argc, char *argv[]);
  75 void    hexdump(caddr_t region, size_t len);
  76 size_t  strlenout(vm_offset_t str);
  77 char    *strdupout(vm_offset_t str);
  78
  79 /* bcache.c */
  80 int     bcache_init(u_int nblks, size_t bsize);
  81 void    bcache_flush(void);
  82 int     bcache_strategy(void *devdata, int unit, int rw, daddr_t blk,
  83                         size_t size, char *buf, size_t *rsize);
  84
  85 /*
  86  * Disk block cache
  87  */
  88 struct bcache_devdata
  89 {
  90     int         (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, char *buf, size_t *rsize);
  91     void        *dv_devdata;
  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)
 103 #define C_PRESENTOUT    (1<<1)
 104 #define C_ACTIVEIN      (1<<2)
 105 #define C_ACTIVEOUT     (1<<3)
 106     void        (* c_probe)(struct console *cp);        /* set c_flags to match hardware */
 107     int         (* c_init)(int arg);                    /* reinit XXX may need more args */
 108     void        (* c_out)(int c);                       /* emit c */
 109     int         (* c_in)(void);                         /* wait for and return input */
 110     int         (* c_ready)(void);                      /* return nonzer if input waiting */
 111 };
 112 extern struct console   *consoles[];
 113 void            cons_probe(void);
 114
 115 /*
 116  * Plug-and-play enumerator/configurator interface.
 117  */
 118 struct pnphandler
 119 {
 120     const char  *pp_name;               /* handler/bus name */
 121     void        (* pp_enumerate)(void); /* enumerate PnP devices, add to chain */
 122 };
 123
 124 struct pnpident
 125 {
 126     char                        *id_ident;      /* ASCII identifier, actual format varies with bus/handler */
 127     STAILQ_ENTRY(pnpident)      id_link;
 128 };
 129
 130 struct pnpinfo
 131 {
 132     char                        *pi_desc;       /* ASCII description, optional */
 133     int                         pi_revision;    /* optional revision (or -1) if not supported */
 134     char                        *pi_module;     /* module/args nominated to handle device */
 135     int                         pi_argc;        /* module arguments */
 136     char                        **pi_argv;
 137     struct pnphandler           *pi_handler;    /* handler which detected this device */
 138     STAILQ_HEAD(,pnpident)      pi_ident;       /* list of identifiers */
 139     STAILQ_ENTRY(pnpinfo)       pi_link;
 140 };
 141
 142 extern struct pnphandler        *pnphandlers[];         /* provided by MD code */
 143
 144 void                    pnp_addident(struct pnpinfo *pi, char *ident);
 145 struct pnpinfo          *pnp_allocinfo(void);
 146 void                    pnp_freeinfo(struct pnpinfo *pi);
 147 void                    pnp_addinfo(struct pnpinfo *pi);
 148 char                    *pnp_eisaformat(u_int8_t *data);
 149
 150 /*
 151  *  < 0 - No ISA in system
 152  * == 0 - Maybe ISA, search for read data port
 153  *  > 0 - ISA in system, value is read data port address
 154  */
 155 extern int                      isapnp_readport;
 156
 157 /*
 158  * Module metadata header.
 159  *
 160  * Metadata are allocated on our heap, and copied into kernel space
 161  * before executing the kernel.
 162  */
 163 struct module_metadata
 164 {
 165     size_t                      md_size;
 166     u_int16_t                   md_type;
 167     struct module_metadata      *md_next;
 168     char                        md_data[0];     /* data are immediately appended */
 169 };
 170
 171 /*
 172  * Loaded module information.
 173  *
 174  * At least one module (the kernel) must be loaded in order to boot.
 175  * The kernel is always loaded first.
 176  *
 177  * String fields (m_name, m_type) should be dynamically allocated.
 178  */
 179 struct loaded_module
 180 {
 181     char                        *m_name;        /* module name */
 182     char                        *m_type;        /* verbose module type, eg 'ELF kernel', 'pnptable', etc. */
 183     char                        *m_args;        /* arguments for the module */
 184     struct module_metadata      *m_metadata;    /* metadata that will be placed in the module directory */
 185     int                         m_loader;       /* index of the loader that read the file */
 186     vm_offset_t                 m_addr;         /* load address */
 187     size_t                      m_size;         /* module size */
 188     struct loaded_module        *m_next;        /* next module */
 189 };
 190
 191 struct module_format
 192 {
 193     /* Load function must return EFTYPE if it can't handle the module supplied */
 194     int         (* l_load)(char *filename, vm_offset_t dest, struct loaded_module **result);
 195     /* Only a loader that will load a kernel (first module) should have an exec handler */
 196     int         (* l_exec)(struct loaded_module *mp);
 197 };
 198 extern struct module_format     *module_formats[];      /* supplied by consumer */
 199 extern struct loaded_module     *loaded_modules;
 200 extern int                      mod_load(char *name, int argc, char *argv[]);
 201 extern int                      mod_loadobj(char *type, char *name);
 202 extern struct loaded_module     *mod_findmodule(char *name, char *type);
 203 extern void                     mod_addmetadata(struct loaded_module *mp, int type, size_t size, void *p);
 204 extern struct module_metadata   *mod_findmetadata(struct loaded_module *mp, int type);
 205 extern void                     mod_discard(struct loaded_module *mp);
 206 extern struct loaded_module     *mod_allocmodule(void);
 207
 208 /* MI module loaders */
 209 extern int              aout_loadmodule(char *filename, vm_offset_t dest, struct loaded_module **result);
 210 extern vm_offset_t      aout_findsym(char *name, struct loaded_module *mp);
 211 extern int      elf_loadmodule(char *filename, vm_offset_t dest, struct loaded_module **result);
 212
 213 #ifndef NEW_LINKER_SET
 214 #include <sys/linker_set.h>
 215
 216 /* XXX just for conversion's sake, until we move to the new linker set code */
 217
 218 #define SET_FOREACH(pvar, set)                          \
 219             for ((char*) pvar = set.ls_items;                   \
 220                  (char*) pvar < (char*) &set.ls_items[set.ls_length];   \
 221                  pvar++)
 222
 223 #else /* NEW_LINKER_SET */
 224
 225 /*
 226  * Private macros, not to be used outside this header file.
 227  */
 228 #define __MAKE_SET(set, sym)                                            \
 229         static void *__CONCAT(__setentry,__LINE__)                      \
 230         __attribute__((__section__("set_" #set),__unused__)) = &sym
 231 #define __SET_BEGIN(set)                                                \
 232         ({ extern void *__CONCAT(__start_set_,set);                     \
 233             &__CONCAT(__start_set_,set); })
 234 #define __SET_END(set)                                                  \
 235         ({ extern void *__CONCAT(__stop_set_,set);                      \
 236             &__CONCAT(__stop_set_,set); })
 237
 238 /*
 239  * Public macros.
 240  */
 241
 242 /* Add an entry to a set. */
 243 #define DATA_SET(set, sym) __MAKE_SET(set, sym)
 244
 245 /*
 246  * Iterate over all the elements of a set.
 247  *
 248  * Sets always contain addresses of things, and "pvar" points to words
 249  * containing those addresses.  Thus is must be declared as "type **pvar",
 250  * and the address of each set item is obtained inside the loop by "*pvar".
 251  */
 252 #define SET_FOREACH(pvar, set)                                          \
 253         for (pvar = (__typeof__(pvar))__SET_BEGIN(set);                 \
 254             pvar < (__typeof__(pvar))__SET_END(set); pvar++)
 255 #endif
 256
 257 /*
 258  * Support for commands
 259  */
 260 struct bootblk_command
 261 {
 262     const char          *c_name;
 263     const char          *c_desc;
 264     bootblk_cmd_t       *c_fn;
 265 };
 266
 267 #define COMMAND_SET(tag, key, desc, func)                               \
 268     static bootblk_cmd_t func;                                          \
 269     static struct bootblk_command _cmd_ ## tag = { key, desc, func };   \
 270     DATA_SET(Xcommand_set, _cmd_ ## tag)
 271
 272 extern struct linker_set Xcommand_set;
 273
 274 /*
 275  * The intention of the architecture switch is to provide a convenient
 276  * encapsulation of the interface between the bootstrap MI and MD code.
 277  * MD code may selectively populate the switch at runtime based on the
 278  * actual configuration of the target system.
 279  */
 280 struct arch_switch
 281 {
 282     /* Automatically load modules as required by detected hardware */
 283     int         (*arch_autoload)(void);
 284     /* Locate the device for (name), return pointer to tail in (*path) */
 285     int         (*arch_getdev)(void **dev, const char *name, const char **path);
 286     /* Copy from local address space to module address space, similar to bcopy() */
 287     ssize_t     (*arch_copyin)(const void *src, vm_offset_t dest,
 288                                const size_t len);
 289     /* Copy to local address space from module address space, similar to bcopy() */
 290     ssize_t     (*arch_copyout)(const vm_offset_t src, void *dest,
 291                                 const size_t len);
 292     /* Read from file to module address space, same semantics as read() */
 293     ssize_t     (*arch_readin)(const int fd, vm_offset_t dest,
 294                                const size_t len);
 295     /* Perform ISA byte port I/O (only for systems with ISA) */
 296     int         (*arch_isainb)(int port);
 297     void        (*arch_isaoutb)(int port, int value);
 298 };
 299 extern struct arch_switch archsw;
 300
 301 /* This must be provided by the MD code, but should it be in the archsw? */
 302 void    delay(int delay);
 303
 304 void    dev_cleanup(void);