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  * $DragonFly: src/sys/boot/common/bootstrap.h,v 1.2 2003/06/17 04:28:16 dillon Exp $
  28  */
  29
  30 #include <sys/types.h>
  31 #include <sys/queue.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
  80 /* bcache.c */
  81 int     bcache_init(u_int nblks, size_t bsize);
  82 void    bcache_flush(void);
  83 int     bcache_strategy(void *devdata, int unit, int rw, daddr_t blk,
  84                         size_t size, char *buf, size_t *rsize);
  85
  86 /*
  87  * Disk block cache
  88  */
  89 struct bcache_devdata
  90 {
  91     int         (*dv_strategy)(void *devdata, int rw, daddr_t blk, size_t size, char *buf, size_t *rsize);
  92     void        *dv_devdata;
  93 };
  94
  95 /*
  96  * Modular console support.
  97  */
  98 struct console
  99 {
 100     const char  *c_name;
 101     const char  *c_desc;
 102     int         c_flags;
 103 #define C_PRESENTIN     (1<<0)
 104 #define C_PRESENTOUT    (1<<1)
 105 #define C_ACTIVEIN      (1<<2)
 106 #define C_ACTIVEOUT     (1<<3)
 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 extern struct pnphandler        *pnphandlers[];         /* provided by MD code */
 144
 145 void                    pnp_addident(struct pnpinfo *pi, char *ident);
 146 struct pnpinfo          *pnp_allocinfo(void);
 147 void                    pnp_freeinfo(struct pnpinfo *pi);
 148 void                    pnp_addinfo(struct pnpinfo *pi);
 149 char                    *pnp_eisaformat(u_int8_t *data);
 150
 151 /*
 152  *  < 0 - No ISA in system
 153  * == 0 - Maybe ISA, search for read data port
 154  *  > 0 - ISA in system, value is read data port address
 155  */
 156 extern int                      isapnp_readport;
 157
 158 /*
 159  * Module metadata header.
 160  *
 161  * Metadata are allocated on our heap, and copied into kernel space
 162  * before executing the kernel.
 163  */
 164 struct module_metadata
 165 {
 166     size_t                      md_size;
 167     u_int16_t                   md_type;
 168     struct module_metadata      *md_next;
 169     char                        md_data[0];     /* data are immediately appended */
 170 };
 171
 172 /*
 173  * Loaded module information.
 174  *
 175  * At least one module (the kernel) must be loaded in order to boot.
 176  * The kernel is always loaded first.
 177  *
 178  * String fields (m_name, m_type) should be dynamically allocated.
 179  */
 180 struct loaded_module
 181 {
 182     char                        *m_name;        /* module name */
 183     char                        *m_type;        /* verbose module type, eg 'ELF kernel', 'pnptable', etc. */
 184     char                        *m_args;        /* arguments for the module */
 185     struct module_metadata      *m_metadata;    /* metadata that will be placed in the module directory */
 186     int                         m_loader;       /* index of the loader that read the file */
 187     vm_offset_t                 m_addr;         /* load address */
 188     size_t                      m_size;         /* module size */
 189     struct loaded_module        *m_next;        /* next module */
 190 };
 191
 192 struct module_format
 193 {
 194     /* Load function must return EFTYPE if it can't handle the module supplied */
 195     int         (* l_load)(char *filename, vm_offset_t dest, struct loaded_module **result);
 196     /* Only a loader that will load a kernel (first module) should have an exec handler */
 197     int         (* l_exec)(struct loaded_module *mp);
 198 };
 199 extern struct module_format     *module_formats[];      /* supplied by consumer */
 200 extern struct loaded_module     *loaded_modules;
 201 extern int                      mod_load(char *name, int argc, char *argv[]);
 202 extern int                      mod_loadobj(char *type, char *name);
 203 extern struct loaded_module     *mod_findmodule(char *name, char *type);
 204 extern void                     mod_addmetadata(struct loaded_module *mp, int type, size_t size, void *p);
 205 extern struct module_metadata   *mod_findmetadata(struct loaded_module *mp, int type);
 206 extern void                     mod_discard(struct loaded_module *mp);
 207 extern struct loaded_module     *mod_allocmodule(void);
 208
 209 /* MI module loaders */
 210 extern int              aout_loadmodule(char *filename, vm_offset_t dest, struct loaded_module **result);
 211 extern vm_offset_t      aout_findsym(char *name, struct loaded_module *mp);
 212 extern int      elf_loadmodule(char *filename, vm_offset_t dest, struct loaded_module **result);
 213
 214 #ifndef NEW_LINKER_SET
 215 #include <sys/linker_set.h>
 216
 217 /* XXX just for conversion's sake, until we move to the new linker set code */
 218
 219 #define SET_FOREACH(pvar, set)                          \
 220             for ((char*) pvar = set.ls_items;                   \
 221                  (char*) pvar < (char*) &set.ls_items[set.ls_length];   \
 222                  pvar++)
 223
 224 #else /* NEW_LINKER_SET */
 225
 226 /*
 227  * Private macros, not to be used outside this header file.
 228  */
 229 #define __MAKE_SET(set, sym)                                            \
 230         static void *__CONCAT(__setentry,__LINE__)                      \
 231         __attribute__((__section__("set_" #set),__unused__)) = &sym
 232 #define __SET_BEGIN(set)                                                \
 233         ({ extern void *__CONCAT(__start_set_,set);                     \
 234             &__CONCAT(__start_set_,set); })
 235 #define __SET_END(set)                                                  \
 236         ({ extern void *__CONCAT(__stop_set_,set);                      \
 237             &__CONCAT(__stop_set_,set); })
 238
 239 /*
 240  * Public macros.
 241  */
 242
 243 /* Add an entry to a set. */
 244 #define DATA_SET(set, sym) __MAKE_SET(set, sym)
 245
 246 /*
 247  * Iterate over all the elements of a set.
 248  *
 249  * Sets always contain addresses of things, and "pvar" points to words
 250  * containing those addresses.  Thus is must be declared as "type **pvar",
 251  * and the address of each set item is obtained inside the loop by "*pvar".
 252  */
 253 #define SET_FOREACH(pvar, set)                                          \
 254         for (pvar = (__typeof__(pvar))__SET_BEGIN(set);                 \
 255             pvar < (__typeof__(pvar))__SET_END(set); pvar++)
 256 #endif
 257
 258 /*
 259  * Support for commands
 260  */
 261 struct bootblk_command
 262 {
 263     const char          *c_name;
 264     const char          *c_desc;
 265     bootblk_cmd_t       *c_fn;
 266 };
 267
 268 #define COMMAND_SET(tag, key, desc, func)                               \
 269     static bootblk_cmd_t func;                                          \
 270     static struct bootblk_command _cmd_ ## tag = { key, desc, func };   \
 271     DATA_SET(Xcommand_set, _cmd_ ## tag)
 272
 273 extern struct linker_set Xcommand_set;
 274
 275 /*
 276  * The intention of the architecture switch is to provide a convenient
 277  * encapsulation of the interface between the bootstrap MI and MD code.
 278  * MD code may selectively populate the switch at runtime based on the
 279  * actual configuration of the target system.
 280  */
 281 struct arch_switch
 282 {
 283     /* Automatically load modules as required by detected hardware */
 284     int         (*arch_autoload)(void);
 285     /* Locate the device for (name), return pointer to tail in (*path) */
 286     int         (*arch_getdev)(void **dev, const char *name, const char **path);
 287     /* Copy from local address space to module address space, similar to bcopy() */
 288     ssize_t     (*arch_copyin)(const void *src, vm_offset_t dest,
 289                                const size_t len);
 290     /* Copy to local address space from module address space, similar to bcopy() */
 291     ssize_t     (*arch_copyout)(const vm_offset_t src, void *dest,
 292                                 const size_t len);
 293     /* Read from file to module address space, same semantics as read() */
 294     ssize_t     (*arch_readin)(const int fd, vm_offset_t dest,
 295                                const size_t len);
 296     /* Perform ISA byte port I/O (only for systems with ISA) */
 297     int         (*arch_isainb)(int port);
 298     void        (*arch_isaoutb)(int port, int value);
 299 };
 300 extern struct arch_switch archsw;
 301
 302 /* This must be provided by the MD code, but should it be in the archsw? */
 303 void    delay(int delay);
 304
 305 void    dev_cleanup(void);